Source/WebCore/dom/MutationObserverRegistration.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef MutationObserverRegistration_h
  32 #define MutationObserverRegistration_h
  33
  34 #include "MutationObserver.h"
  35 #include <wtf/HashSet.h>
  36 #include <wtf/text/AtomicString.h>
  37 #include <wtf/text/AtomicStringHash.h>
  38
  39 namespace WebCore {
  40
  41 class QualifiedName;
  42
  43 class MutationObserverRegistration {
  44 public:
  45     static PassOwnPtr<MutationObserverRegistration> create(PassRefPtr<MutationObserver>, Node*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
  46     ~MutationObserverRegistration();
  47
  48     void resetObservation(MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
  49     void observedSubtreeNodeWillDetach(Node*);
  50     void clearTransientRegistrations();
  51     bool hasTransientRegistrations() const { return m_transientRegistrationNodes && !m_transientRegistrationNodes->isEmpty(); }
  52     void unregister();
  53
  54     bool shouldReceiveMutationFrom(Node*, MutationObserver::MutationType, const QualifiedName* attributeName) const;
  55     bool isSubtree() const { return m_options & MutationObserver::Subtree; }
  56
  57     MutationObserver* observer() const { return m_observer.get(); }
  58     MutationRecordDeliveryOptions deliveryOptions() const { return m_options & (MutationObserver::AttributeOldValue | MutationObserver::CharacterDataOldValue); }
  59     MutationObserverOptions mutationTypes() const { return m_options & MutationObserver::AllMutationTypes; }
  60
  61     void addRegistrationNodesToSet(HashSet<Node*>&) const;
  62
  63 private:
  64     MutationObserverRegistration(PassRefPtr<MutationObserver>, Node*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
  65
  66     RefPtr<MutationObserver> m_observer;
  67     Node* m_registrationNode;
  68     RefPtr<Node> m_registrationNodeKeepAlive;
  69     typedef HashSet<RefPtr<Node> > NodeHashSet;
  70     OwnPtr<NodeHashSet> m_transientRegistrationNodes;
  71
  72     MutationObserverOptions m_options;
  73     HashSet<AtomicString> m_attributeFilter;
  74 };
  75
  76 } // namespace WebCore
  77
  78 #endif // MutationObserverRegistration_h