1ff26b1702df044d733ee38974e89a284388484c
[WebKit-https.git] / Source / WebCore / dom / MutationObserver.cpp
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 #include "config.h"
32
33 #include "MutationObserver.h"
34
35 #include "Dictionary.h"
36 #include "Document.h"
37 #include "ExceptionCode.h"
38 #include "MutationCallback.h"
39 #include "MutationObserverRegistration.h"
40 #include "MutationRecord.h"
41 #include "Node.h"
42 #include <algorithm>
43 #include <wtf/HashSet.h>
44 #include <wtf/MainThread.h>
45 #include <wtf/Vector.h>
46
47 namespace WebCore {
48
49 static unsigned s_observerPriority = 0;
50
51 PassRefPtr<MutationObserver> MutationObserver::create(PassRefPtr<MutationCallback> callback)
52 {
53     ASSERT(isMainThread());
54     return adoptRef(new MutationObserver(callback));
55 }
56
57 MutationObserver::MutationObserver(PassRefPtr<MutationCallback> callback)
58     : m_callback(callback)
59     , m_priority(s_observerPriority++)
60 {
61 }
62
63 MutationObserver::~MutationObserver()
64 {
65     ASSERT(m_registrations.isEmpty());
66 }
67
68 bool MutationObserver::validateOptions(MutationObserverOptions options)
69 {
70     return (options & (Attributes | CharacterData | ChildList))
71         && ((options & Attributes) || !(options & AttributeOldValue))
72         && ((options & Attributes) || !(options & AttributeFilter))
73         && ((options & CharacterData) || !(options & CharacterDataOldValue));
74 }
75
76 void MutationObserver::observe(Node* node, const Dictionary& optionsDictionary, ExceptionCode& ec)
77 {
78     if (!node) {
79         ec = NOT_FOUND_ERR;
80         return;
81     }
82
83     static const struct {
84         const char* name;
85         MutationObserverOptions value;
86     } booleanOptions[] = {
87         { "childList", ChildList },
88         { "attributes", Attributes },
89         { "characterData", CharacterData },
90         { "subtree", Subtree },
91         { "attributeOldValue", AttributeOldValue },
92         { "characterDataOldValue", CharacterDataOldValue }
93     };
94     MutationObserverOptions options = 0;
95     for (unsigned i = 0; i < sizeof(booleanOptions) / sizeof(booleanOptions[0]); ++i) {
96         bool value = false;
97         if (optionsDictionary.get(booleanOptions[i].name, value) && value)
98             options |= booleanOptions[i].value;
99     }
100
101     HashSet<AtomicString> attributeFilter;
102     if (optionsDictionary.get("attributeFilter", attributeFilter))
103         options |= AttributeFilter;
104
105     if (!validateOptions(options)) {
106         ec = SYNTAX_ERR;
107         return;
108     }
109
110     node->registerMutationObserver(this, options, attributeFilter);
111 }
112
113 Vector<RefPtr<MutationRecord> > MutationObserver::takeRecords()
114 {
115     Vector<RefPtr<MutationRecord> > records;
116     records.swap(m_records);
117     return records;
118 }
119
120 void MutationObserver::disconnect()
121 {
122     m_records.clear();
123     HashSet<MutationObserverRegistration*> registrations(m_registrations);
124     for (HashSet<MutationObserverRegistration*>::iterator iter = registrations.begin(); iter != registrations.end(); ++iter)
125         MutationObserverRegistration::unregisterAndDelete(*iter);
126 }
127
128 void MutationObserver::observationStarted(MutationObserverRegistration* registration)
129 {
130     ASSERT(!m_registrations.contains(registration));
131     m_registrations.add(registration);
132 }
133
134 void MutationObserver::observationEnded(MutationObserverRegistration* registration)
135 {
136     ASSERT(m_registrations.contains(registration));
137     m_registrations.remove(registration);
138 }
139
140 typedef HashSet<RefPtr<MutationObserver> > MutationObserverSet;
141
142 static MutationObserverSet& activeMutationObservers()
143 {
144     DEFINE_STATIC_LOCAL(MutationObserverSet, activeObservers, ());
145     return activeObservers;
146 }
147
148 static MutationObserverSet& suspendedMutationObservers()
149 {
150     DEFINE_STATIC_LOCAL(MutationObserverSet, suspendedObservers, ());
151     return suspendedObservers;
152 }
153
154 void MutationObserver::enqueueMutationRecord(PassRefPtr<MutationRecord> mutation)
155 {
156     ASSERT(isMainThread());
157     m_records.append(mutation);
158     activeMutationObservers().add(this);
159 }
160
161 void MutationObserver::setHasTransientRegistration()
162 {
163     ASSERT(isMainThread());
164     activeMutationObservers().add(this);
165 }
166
167 HashSet<Node*> MutationObserver::getObservedNodes() const
168 {
169     HashSet<Node*> observedNodes;
170     for (HashSet<MutationObserverRegistration*>::const_iterator iter = m_registrations.begin(); iter != m_registrations.end(); ++iter)
171         (*iter)->addRegistrationNodesToSet(observedNodes);
172     return observedNodes;
173 }
174
175 bool MutationObserver::canDeliver()
176 {
177     return !m_callback->scriptExecutionContext()->activeDOMObjectsAreSuspended();
178 }
179
180 void MutationObserver::deliver()
181 {
182     ASSERT(canDeliver());
183
184     // Calling clearTransientRegistrations() can modify m_registrations, so it's necessary
185     // to make a copy of the transient registrations before operating on them.
186     Vector<MutationObserverRegistration*, 1> transientRegistrations;
187     for (HashSet<MutationObserverRegistration*>::iterator iter = m_registrations.begin(); iter != m_registrations.end(); ++iter) {
188         if ((*iter)->hasTransientRegistrations())
189             transientRegistrations.append(*iter);
190     }
191     for (size_t i = 0; i < transientRegistrations.size(); ++i)
192         transientRegistrations[i]->clearTransientRegistrations();
193
194     if (m_records.isEmpty())
195         return;
196
197     Vector<RefPtr<MutationRecord> > records;
198     records.swap(m_records);
199
200     m_callback->call(records, this);
201 }
202
203 void MutationObserver::deliverAllMutations()
204 {
205     ASSERT(isMainThread());
206     static bool deliveryInProgress = false;
207     if (deliveryInProgress)
208         return;
209     deliveryInProgress = true;
210
211     if (!suspendedMutationObservers().isEmpty()) {
212         Vector<RefPtr<MutationObserver> > suspended;
213         copyToVector(suspendedMutationObservers(), suspended);
214         for (size_t i = 0; i < suspended.size(); ++i) {
215             if (!suspended[i]->canDeliver())
216                 continue;
217
218             suspendedMutationObservers().remove(suspended[i]);
219             activeMutationObservers().add(suspended[i]);
220         }
221     }
222
223     while (!activeMutationObservers().isEmpty()) {
224         Vector<RefPtr<MutationObserver> > observers;
225         copyToVector(activeMutationObservers(), observers);
226         activeMutationObservers().clear();
227         std::sort(observers.begin(), observers.end(), [](const RefPtr<MutationObserver>& lhs, const RefPtr<MutationObserver>& rhs) {
228             return lhs->m_priority < rhs->m_priority;
229         });
230
231         for (size_t i = 0; i < observers.size(); ++i) {
232             if (observers[i]->canDeliver())
233                 observers[i]->deliver();
234             else
235                 suspendedMutationObservers().add(observers[i]);
236         }
237     }
238
239     deliveryInProgress = false;
240 }
241
242 } // namespace WebCore