src/third_party/WebKit/Source/core/dom/MutationObserver.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 MutationObserver_h
  32 #define MutationObserver_h
  33
  34 #include "bindings/core/v8/ScriptWrappable.h"
  35 #include "platform/heap/Handle.h"
  36 #include "wtf/HashSet.h"
  37 #include "wtf/PassOwnPtr.h"
  38 #include "wtf/PassRefPtr.h"
  39 #include "wtf/RefCounted.h"
  40 #include "wtf/RefPtr.h"
  41 #include "wtf/Vector.h"
  42
  43 namespace blink {
  44
  45 class Dictionary;
  46 class ExceptionState;
  47 class MutationCallback;
  48 class MutationObserver;
  49 class MutationObserverInit;
  50 class MutationObserverRegistration;
  51 class MutationRecord;
  52 class Node;
  53
  54 typedef unsigned char MutationObserverOptions;
  55 typedef unsigned char MutationRecordDeliveryOptions;
  56
  57 typedef WillBeHeapHashSet<RefPtrWillBeMember<MutationObserver> > MutationObserverSet;
  58 typedef WillBeHeapHashSet<RawPtrWillBeWeakMember<MutationObserverRegistration> > MutationObserverRegistrationSet;
  59 typedef WillBeHeapVector<RefPtrWillBeMember<MutationObserver> > MutationObserverVector;
  60 typedef WillBeHeapVector<RefPtrWillBeMember<MutationRecord> > MutationRecordVector;
  61
  62 class MutationObserver FINAL : public RefCountedWillBeGarbageCollectedFinalized<MutationObserver>, public ScriptWrappable {
  63     DEFINE_WRAPPERTYPEINFO();
  64 public:
  65     enum MutationType {
  66         ChildList = 1 << 0,
  67         Attributes = 1 << 1,
  68         CharacterData = 1 << 2,
  69
  70         AllMutationTypes = ChildList | Attributes | CharacterData
  71     };
  72
  73     enum ObservationFlags  {
  74         Subtree = 1 << 3,
  75         AttributeFilter = 1 << 4
  76     };
  77
  78     enum DeliveryFlags {
  79         AttributeOldValue = 1 << 5,
  80         CharacterDataOldValue = 1 << 6,
  81     };
  82
  83     static PassRefPtrWillBeRawPtr<MutationObserver> create(PassOwnPtr<MutationCallback>);
  84     static void resumeSuspendedObservers();
  85     static void deliverMutations();
  86
  87     ~MutationObserver();
  88
  89     void observe(Node*, const MutationObserverInit&, ExceptionState&);
  90     WillBeHeapVector<RefPtrWillBeMember<MutationRecord> > takeRecords();
  91     void disconnect();
  92     void observationStarted(MutationObserverRegistration*);
  93     void observationEnded(MutationObserverRegistration*);
  94     void enqueueMutationRecord(PassRefPtrWillBeRawPtr<MutationRecord>);
  95     void setHasTransientRegistration();
  96     bool canDeliver();
  97
  98     WillBeHeapHashSet<RawPtrWillBeMember<Node> > getObservedNodes() const;
  99
 100     void trace(Visitor*);
 101
 102 private:
 103     struct ObserverLessThan;
 104
 105     explicit MutationObserver(PassOwnPtr<MutationCallback>);
 106     void deliver();
 107
 108     OwnPtr<MutationCallback> m_callback;
 109     MutationRecordVector m_records;
 110     MutationObserverRegistrationSet m_registrations;
 111     unsigned m_priority;
 112 };
 113
 114 } // namespace blink
 115
 116 #endif // MutationObserver_h