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