third_party/WebKit/Source/core/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 "core/dom/MutationObserver.h"
  35 #include "platform/heap/Handle.h"
  36 #include "wtf/HashSet.h"
  37 #include "wtf/text/AtomicString.h"
  38 #include "wtf/text/AtomicStringHash.h"
  39
  40 namespace blink {
  41
  42 class QualifiedName;
  43
  44 class MutationObserverRegistration final : public NoBaseWillBeGarbageCollectedFinalized<MutationObserverRegistration> {
  45     WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED(MutationObserverRegistration);
  46 public:
  47     static PassOwnPtrWillBeRawPtr<MutationObserverRegistration> create(MutationObserver&, Node*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
  48     ~MutationObserverRegistration();
  49
  50     void resetObservation(MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
  51     void observedSubtreeNodeWillDetach(Node&);
  52     void clearTransientRegistrations();
  53     bool hasTransientRegistrations() const { return m_transientRegistrationNodes && !m_transientRegistrationNodes->isEmpty(); }
  54     void unregister();
  55
  56     bool shouldReceiveMutationFrom(Node&, MutationObserver::MutationType, const QualifiedName* attributeName) const;
  57     bool isSubtree() const { return m_options & MutationObserver::Subtree; }
  58
  59     MutationObserver& observer() const { return *m_observer; }
  60     MutationRecordDeliveryOptions deliveryOptions() const { return m_options & (MutationObserver::AttributeOldValue | MutationObserver::CharacterDataOldValue); }
  61     MutationObserverOptions mutationTypes() const { return m_options & MutationObserver::AllMutationTypes; }
  62
  63     void addRegistrationNodesToSet(WillBeHeapHashSet<RawPtrWillBeMember<Node>>&) const;
  64
  65     DECLARE_TRACE();
  66
  67     void dispose();
  68
  69 private:
  70     MutationObserverRegistration(MutationObserver&, Node*, MutationObserverOptions, const HashSet<AtomicString>& attributeFilter);
  71
  72     RefPtrWillBeMember<MutationObserver> m_observer;
  73     RawPtrWillBeWeakMember<Node> m_registrationNode;
  74     RefPtrWillBeMember<Node> m_registrationNodeKeepAlive;
  75     typedef WillBeHeapHashSet<RefPtrWillBeMember<Node>> NodeHashSet;
  76     OwnPtrWillBeMember<NodeHashSet> m_transientRegistrationNodes;
  77
  78     MutationObserverOptions m_options;
  79     HashSet<AtomicString> m_attributeFilter;
  80 };
  81
  82 } // namespace blink
  83
  84 #endif // MutationObserverRegistration_h