Unify SVG's animation and target tracking systems.
[WebKit-https.git] / Source / WebCore / svg / SVGDocumentExtensions.cpp
1 /*
2  * Copyright (C) 2006 Apple Inc. All rights reserved.
3  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
4  * Copyright (C) 2007 Rob Buis <buis@kde.org>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "config.h"
23
24 #if ENABLE(SVG)
25 #include "SVGDocumentExtensions.h"
26
27 #include "Console.h"
28 #include "DOMWindow.h"
29 #include "Document.h"
30 #include "EventListener.h"
31 #include "Frame.h"
32 #include "FrameLoader.h"
33 #include "Page.h"
34 #include "SMILTimeContainer.h"
35 #include "SVGElement.h"
36 #include "SVGResourcesCache.h"
37 #include "SVGSMILElement.h"
38 #include "SVGSVGElement.h"
39 #include "ScriptableDocumentParser.h"
40 #include "XLinkNames.h"
41 #include <wtf/text/AtomicString.h>
42
43 namespace WebCore {
44
45 SVGDocumentExtensions::SVGDocumentExtensions(Document* document)
46     : m_document(document)
47     , m_resourcesCache(adoptPtr(new SVGResourcesCache))
48 {
49 }
50
51 SVGDocumentExtensions::~SVGDocumentExtensions()
52 {
53     deleteAllValues(m_pendingResources);
54     deleteAllValues(m_pendingResourcesForRemoval);
55 }
56
57 void SVGDocumentExtensions::addTimeContainer(SVGSVGElement* element)
58 {
59     m_timeContainers.add(element);
60 }
61
62 void SVGDocumentExtensions::removeTimeContainer(SVGSVGElement* element)
63 {
64     m_timeContainers.remove(element);
65 }
66
67 void SVGDocumentExtensions::addResource(const AtomicString& id, RenderSVGResourceContainer* resource)
68 {
69     ASSERT(resource);
70
71     if (id.isEmpty())
72         return;
73
74     // Replaces resource if already present, to handle potential id changes
75     m_resources.set(id, resource);
76 }
77
78 void SVGDocumentExtensions::removeResource(const AtomicString& id)
79 {
80     if (id.isEmpty() || !m_resources.contains(id))
81         return;
82
83     m_resources.remove(id);
84 }
85
86 RenderSVGResourceContainer* SVGDocumentExtensions::resourceById(const AtomicString& id) const
87 {
88     if (id.isEmpty())
89         return 0;
90
91     return m_resources.get(id);
92 }
93
94 void SVGDocumentExtensions::startAnimations()
95 {
96     // FIXME: Eventually every "Time Container" will need a way to latch on to some global timer
97     // starting animations for a document will do this "latching"
98     // FIXME: We hold a ref pointers to prevent a shadow tree from getting removed out from underneath us.
99     // In the future we should refactor the use-element to avoid this. See https://webkit.org/b/53704
100     Vector<RefPtr<SVGSVGElement> > timeContainers;
101     timeContainers.appendRange(m_timeContainers.begin(), m_timeContainers.end());
102     Vector<RefPtr<SVGSVGElement> >::iterator end = timeContainers.end();
103     for (Vector<RefPtr<SVGSVGElement> >::iterator itr = timeContainers.begin(); itr != end; ++itr)
104         (*itr)->timeContainer()->begin();
105 }
106     
107 void SVGDocumentExtensions::pauseAnimations()
108 {
109     HashSet<SVGSVGElement*>::iterator end = m_timeContainers.end();
110     for (HashSet<SVGSVGElement*>::iterator itr = m_timeContainers.begin(); itr != end; ++itr)
111         (*itr)->pauseAnimations();
112 }
113
114 void SVGDocumentExtensions::unpauseAnimations()
115 {
116     HashSet<SVGSVGElement*>::iterator end = m_timeContainers.end();
117     for (HashSet<SVGSVGElement*>::iterator itr = m_timeContainers.begin(); itr != end; ++itr)
118         (*itr)->unpauseAnimations();
119 }
120
121 void SVGDocumentExtensions::dispatchSVGLoadEventToOutermostSVGElements()
122 {
123     Vector<RefPtr<SVGSVGElement> > timeContainers;
124     timeContainers.appendRange(m_timeContainers.begin(), m_timeContainers.end());
125
126     Vector<RefPtr<SVGSVGElement> >::iterator end = timeContainers.end();
127     for (Vector<RefPtr<SVGSVGElement> >::iterator it = timeContainers.begin(); it != end; ++it) {
128         SVGSVGElement* outerSVG = (*it).get();
129         if (!outerSVG->isOutermostSVGSVGElement())
130             continue;
131         outerSVG->sendSVGLoadEventIfPossible();
132     }
133 }
134
135 static void reportMessage(Document* document, MessageLevel level, const String& message)
136 {
137     if (document->frame())
138         document->addConsoleMessage(JSMessageSource, LogMessageType, level, message);
139 }
140
141 void SVGDocumentExtensions::reportWarning(const String& message)
142 {
143     reportMessage(m_document, WarningMessageLevel, "Warning: " + message);
144 }
145
146 void SVGDocumentExtensions::reportError(const String& message)
147 {
148     reportMessage(m_document, ErrorMessageLevel, "Error: " + message);
149 }
150
151 void SVGDocumentExtensions::addPendingResource(const AtomicString& id, SVGElement* element)
152 {
153     ASSERT(element);
154
155     if (id.isEmpty())
156         return;
157
158     // The HashMap add function leaves the map alone and returns a pointer to the element in the
159     // map if the element already exists. So we add with a value of 0, and it either finds the
160     // existing element or adds a new one in a single operation. The ".iterator->value" idiom gets
161     // us to the iterator from add's result, and then to the value inside the hash table.
162     SVGPendingElements*& set = m_pendingResources.add(id, 0).iterator->value;
163     if (!set)
164         set = new SVGPendingElements;
165     set->add(element);
166
167     element->setHasPendingResources();
168 }
169
170 bool SVGDocumentExtensions::hasPendingResource(const AtomicString& id) const
171 {
172     if (id.isEmpty())
173         return false;
174
175     return m_pendingResources.contains(id);
176 }
177
178 bool SVGDocumentExtensions::isElementPendingResources(SVGElement* element) const
179 {
180     // This algorithm takes time proportional to the number of pending resources and need not.
181     // If performance becomes an issue we can keep a counted set of elements and answer the question efficiently.
182
183     ASSERT(element);
184
185     HashMap<AtomicString, SVGPendingElements*>::const_iterator end = m_pendingResources.end();
186     for (HashMap<AtomicString, SVGPendingElements*>::const_iterator it = m_pendingResources.begin(); it != end; ++it) {
187         SVGPendingElements* elements = it->value;
188         ASSERT(elements);
189
190         if (elements->contains(element))
191             return true;
192     }
193     return false;
194 }
195
196 bool SVGDocumentExtensions::isElementPendingResource(SVGElement* element, const AtomicString& id) const
197 {
198     ASSERT(element);
199
200     if (!hasPendingResource(id))
201         return false;
202
203     return m_pendingResources.get(id)->contains(element);
204 }
205
206 void SVGDocumentExtensions::removeElementFromPendingResources(SVGElement* element)
207 {
208     ASSERT(element);
209
210     // Remove the element from pending resources.
211     if (!m_pendingResources.isEmpty() && element->hasPendingResources()) {
212         Vector<AtomicString> toBeRemoved;
213         HashMap<AtomicString, SVGPendingElements*>::iterator end = m_pendingResources.end();
214         for (HashMap<AtomicString, SVGPendingElements*>::iterator it = m_pendingResources.begin(); it != end; ++it) {
215             SVGPendingElements* elements = it->value;
216             ASSERT(elements);
217             ASSERT(!elements->isEmpty());
218
219             elements->remove(element);
220             if (elements->isEmpty())
221                 toBeRemoved.append(it->key);
222         }
223
224         element->clearHasPendingResourcesIfPossible();
225
226         // We use the removePendingResource function here because it deals with set lifetime correctly.
227         Vector<AtomicString>::iterator vectorEnd = toBeRemoved.end();
228         for (Vector<AtomicString>::iterator it = toBeRemoved.begin(); it != vectorEnd; ++it)
229             removePendingResource(*it);
230     }
231
232     // Remove the element from pending resources that were scheduled for removal.
233     if (!m_pendingResourcesForRemoval.isEmpty()) {
234         Vector<AtomicString> toBeRemoved;
235         HashMap<AtomicString, SVGPendingElements*>::iterator end = m_pendingResourcesForRemoval.end();
236         for (HashMap<AtomicString, SVGPendingElements*>::iterator it = m_pendingResourcesForRemoval.begin(); it != end; ++it) {
237             SVGPendingElements* elements = it->value;
238             ASSERT(elements);
239             ASSERT(!elements->isEmpty());
240
241             elements->remove(element);
242             if (elements->isEmpty())
243                 toBeRemoved.append(it->key);
244         }
245
246         // We use the removePendingResourceForRemoval function here because it deals with set lifetime correctly.
247         Vector<AtomicString>::iterator vectorEnd = toBeRemoved.end();
248         for (Vector<AtomicString>::iterator it = toBeRemoved.begin(); it != vectorEnd; ++it)
249             removePendingResourceForRemoval(*it);
250     }
251 }
252
253 PassOwnPtr<SVGDocumentExtensions::SVGPendingElements> SVGDocumentExtensions::removePendingResource(const AtomicString& id)
254 {
255     ASSERT(m_pendingResources.contains(id));
256     return adoptPtr(m_pendingResources.take(id));
257 }
258
259 PassOwnPtr<SVGDocumentExtensions::SVGPendingElements> SVGDocumentExtensions::removePendingResourceForRemoval(const AtomicString& id)
260 {
261     ASSERT(m_pendingResourcesForRemoval.contains(id));
262     return adoptPtr(m_pendingResourcesForRemoval.take(id));
263 }
264
265 void SVGDocumentExtensions::markPendingResourcesForRemoval(const AtomicString& id)
266 {
267     if (id.isEmpty())
268         return;
269
270     ASSERT(!m_pendingResourcesForRemoval.contains(id));
271
272     SVGPendingElements* existing = m_pendingResources.take(id);
273     if (existing && !existing->isEmpty())
274         m_pendingResourcesForRemoval.add(id, existing);
275 }
276
277 SVGElement* SVGDocumentExtensions::removeElementFromPendingResourcesForRemoval(const AtomicString& id)
278 {
279     if (id.isEmpty())
280         return 0;
281
282     SVGPendingElements* resourceSet = m_pendingResourcesForRemoval.get(id);
283     if (!resourceSet || resourceSet->isEmpty())
284         return 0;
285
286     SVGPendingElements::iterator firstElement = resourceSet->begin();
287     SVGElement* element = *firstElement;
288
289     resourceSet->remove(firstElement);
290
291     if (resourceSet->isEmpty())
292         removePendingResourceForRemoval(id);
293
294     return element;
295 }
296
297 HashSet<SVGElement*>* SVGDocumentExtensions::setOfElementsReferencingTarget(SVGElement* referencedElement) const
298 {
299     ASSERT(referencedElement);
300     const HashMap<SVGElement*, OwnPtr<HashSet<SVGElement*> > >::const_iterator it = m_elementDependencies.find(referencedElement);
301     if (it == m_elementDependencies.end())
302         return 0;
303     return it->value.get();
304 }
305
306 void SVGDocumentExtensions::addElementReferencingTarget(SVGElement* referencingElement, SVGElement* referencedElement)
307 {
308     ASSERT(referencingElement);
309     ASSERT(referencedElement);
310
311     if (HashSet<SVGElement*>* elements = m_elementDependencies.get(referencedElement)) {
312         elements->add(referencingElement);
313         return;
314     }
315
316     OwnPtr<HashSet<SVGElement*> > elements = adoptPtr(new HashSet<SVGElement*>);
317     elements->add(referencingElement);
318     m_elementDependencies.set(referencedElement, elements.release());
319 }
320
321 void SVGDocumentExtensions::removeAllTargetReferencesForElement(SVGElement* referencingElement)
322 {
323     Vector<SVGElement*> toBeRemoved;
324
325     HashMap<SVGElement*, OwnPtr<HashSet<SVGElement*> > >::iterator end = m_elementDependencies.end();
326     for (HashMap<SVGElement*, OwnPtr<HashSet<SVGElement*> > >::iterator it = m_elementDependencies.begin(); it != end; ++it) {
327         SVGElement* referencedElement = it->key;
328         HashSet<SVGElement*>* referencingElements = it->value.get();
329         HashSet<SVGElement*>::iterator setIt = referencingElements->find(referencingElement);
330         if (setIt == referencingElements->end())
331             continue;
332
333         referencingElements->remove(setIt);
334         if (referencingElements->isEmpty())
335             toBeRemoved.append(referencedElement);
336     }
337
338     Vector<SVGElement*>::iterator vectorEnd = toBeRemoved.end();
339     for (Vector<SVGElement*>::iterator it = toBeRemoved.begin(); it != vectorEnd; ++it)
340         m_elementDependencies.remove(*it);
341 }
342
343 void SVGDocumentExtensions::removeAllElementReferencesForTarget(SVGElement* referencedElement)
344 {
345     ASSERT(referencedElement);
346     HashMap<SVGElement*, OwnPtr<HashSet<SVGElement*> > >::iterator it = m_elementDependencies.find(referencedElement);
347     if (it == m_elementDependencies.end())
348         return;
349     ASSERT(it->key == referencedElement);
350     Vector<SVGElement*> toBeNotified;
351
352     HashSet<SVGElement*>* referencingElements = it->value.get();
353     HashSet<SVGElement*>::iterator setEnd = referencingElements->end();
354     for (HashSet<SVGElement*>::iterator setIt = referencingElements->begin(); setIt != setEnd; ++setIt)
355         toBeNotified.append(*setIt);
356
357     // Force rebuilding the referencingElement so it knows about this change.
358     Vector<SVGElement*>::iterator vectorEnd = toBeNotified.end();
359     for (Vector<SVGElement*>::iterator vectorIt = toBeNotified.begin(); vectorIt != vectorEnd; ++vectorIt) {
360         // Before rebuilding referencingElement ensure it was not removed from under us.
361         if (HashSet<SVGElement*>* referencingElements = setOfElementsReferencingTarget(referencedElement)) {
362             if (referencingElements->contains(*vectorIt))
363                 (*vectorIt)->svgAttributeChanged(XLinkNames::hrefAttr);
364         }
365     }
366
367     m_elementDependencies.remove(referencedElement);
368 }
369
370 #if ENABLE(SVG_FONTS)
371 void SVGDocumentExtensions::registerSVGFontFaceElement(SVGFontFaceElement* element)
372 {
373     m_svgFontFaceElements.add(element);
374 }
375
376 void SVGDocumentExtensions::unregisterSVGFontFaceElement(SVGFontFaceElement* element)
377 {
378     ASSERT(m_svgFontFaceElements.contains(element));
379     m_svgFontFaceElements.remove(element);
380 }
381 #endif
382
383 }
384
385 #endif