cad83c9cfbc5dd9914b049a8603c52382dcc38af
[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 #include "SVGDocumentExtensions.h"
24
25 #include "DOMWindow.h"
26 #include "Document.h"
27 #include "EventListener.h"
28 #include "Frame.h"
29 #include "FrameLoader.h"
30 #include "SMILTimeContainer.h"
31 #include "SVGElement.h"
32 #include "SVGResourcesCache.h"
33 #include "SVGSMILElement.h"
34 #include "SVGSVGElement.h"
35 #include "ScriptableDocumentParser.h"
36 #include "ShadowRoot.h"
37 #include "XLinkNames.h"
38 #include <wtf/text/AtomicString.h>
39
40 namespace WebCore {
41
42 SVGDocumentExtensions::SVGDocumentExtensions(Document* document)
43     : m_document(document)
44     , m_resourcesCache(std::make_unique<SVGResourcesCache>())
45 {
46 }
47
48 SVGDocumentExtensions::~SVGDocumentExtensions()
49 {
50 }
51
52 void SVGDocumentExtensions::addTimeContainer(SVGSVGElement* element)
53 {
54     m_timeContainers.add(element);
55 }
56
57 void SVGDocumentExtensions::removeTimeContainer(SVGSVGElement* element)
58 {
59     m_timeContainers.remove(element);
60 }
61
62 void SVGDocumentExtensions::addResource(const AtomicString& id, RenderSVGResourceContainer* resource)
63 {
64     ASSERT(resource);
65
66     if (id.isEmpty())
67         return;
68
69     // Replaces resource if already present, to handle potential id changes
70     m_resources.set(id, resource);
71 }
72
73 void SVGDocumentExtensions::removeResource(const AtomicString& id)
74 {
75     if (id.isEmpty())
76         return;
77
78     m_resources.remove(id);
79 }
80
81 RenderSVGResourceContainer* SVGDocumentExtensions::resourceById(const AtomicString& id) const
82 {
83     if (id.isEmpty())
84         return 0;
85
86     return m_resources.get(id);
87 }
88
89 void SVGDocumentExtensions::startAnimations()
90 {
91     // FIXME: Eventually every "Time Container" will need a way to latch on to some global timer
92     // starting animations for a document will do this "latching"
93     // FIXME: We hold a ref pointers to prevent a shadow tree from getting removed out from underneath us.
94     // In the future we should refactor the use-element to avoid this. See https://webkit.org/b/53704
95     Vector<RefPtr<SVGSVGElement>> timeContainers;
96     timeContainers.appendRange(m_timeContainers.begin(), m_timeContainers.end());
97     for (auto& element : timeContainers)
98         element->timeContainer().begin();
99 }
100
101 void SVGDocumentExtensions::pauseAnimations()
102 {
103     for (auto& container : m_timeContainers)
104         container->pauseAnimations();
105     m_areAnimationsPaused = true;
106 }
107
108 void SVGDocumentExtensions::unpauseAnimations()
109 {
110     for (auto& container : m_timeContainers)
111         container->unpauseAnimations();
112     m_areAnimationsPaused = false;
113 }
114
115 void SVGDocumentExtensions::dispatchSVGLoadEventToOutermostSVGElements()
116 {
117     Vector<RefPtr<SVGSVGElement>> timeContainers;
118     timeContainers.appendRange(m_timeContainers.begin(), m_timeContainers.end());
119
120     for (auto& container : timeContainers) {
121         if (!container->isOutermostSVGSVGElement())
122             continue;
123         container->sendSVGLoadEventIfPossible();
124     }
125 }
126
127 static void reportMessage(Document* document, MessageLevel level, const String& message)
128 {
129     if (document->frame())
130         document->addConsoleMessage(MessageSource::Rendering, level, message);
131 }
132
133 void SVGDocumentExtensions::reportWarning(const String& message)
134 {
135     reportMessage(m_document, MessageLevel::Warning, "Warning: " + message);
136 }
137
138 void SVGDocumentExtensions::reportError(const String& message)
139 {
140     reportMessage(m_document, MessageLevel::Error, "Error: " + message);
141 }
142
143 void SVGDocumentExtensions::addPendingResource(const AtomicString& id, Element* element)
144 {
145     ASSERT(element);
146
147     if (id.isEmpty())
148         return;
149
150     auto result = m_pendingResources.add(id, nullptr);
151     if (result.isNewEntry)
152         result.iterator->value = std::make_unique<PendingElements>();
153     result.iterator->value->add(element);
154
155     element->setHasPendingResources();
156 }
157
158 bool SVGDocumentExtensions::isIdOfPendingResource(const AtomicString& id) const
159 {
160     if (id.isEmpty())
161         return false;
162
163     return m_pendingResources.contains(id);
164 }
165
166 bool SVGDocumentExtensions::isElementWithPendingResources(Element* element) const
167 {
168     // This algorithm takes time proportional to the number of pending resources and need not.
169     // If performance becomes an issue we can keep a counted set of elements and answer the question efficiently.
170     ASSERT(element);
171     for (auto& elements : m_pendingResources.values()) {
172         ASSERT(elements);
173
174         if (elements->contains(element))
175             return true;
176     }
177     return false;
178 }
179
180 bool SVGDocumentExtensions::isPendingResource(Element* element, const AtomicString& id) const
181 {
182     ASSERT(element);
183
184     if (!isIdOfPendingResource(id))
185         return false;
186
187     return m_pendingResources.get(id)->contains(element);
188 }
189
190 void SVGDocumentExtensions::clearHasPendingResourcesIfPossible(Element* element)
191 {
192     if (!isElementWithPendingResources(element))
193         element->clearHasPendingResources();
194 }
195
196 void SVGDocumentExtensions::removeElementFromPendingResources(Element* element)
197 {
198     ASSERT(element);
199
200     // Remove the element from pending resources.
201     if (!m_pendingResources.isEmpty() && element->hasPendingResources()) {
202         Vector<AtomicString> toBeRemoved;
203         for (auto& resource : m_pendingResources) {
204             PendingElements* elements = resource.value.get();
205             ASSERT(elements);
206             ASSERT(!elements->isEmpty());
207
208             elements->remove(element);
209             if (elements->isEmpty())
210                 toBeRemoved.append(resource.key);
211         }
212
213         clearHasPendingResourcesIfPossible(element);
214
215         // We use the removePendingResource function here because it deals with set lifetime correctly.
216         for (auto& resource : toBeRemoved)
217             removePendingResource(resource);
218     }
219
220     // Remove the element from pending resources that were scheduled for removal.
221     if (!m_pendingResourcesForRemoval.isEmpty()) {
222         Vector<AtomicString> toBeRemoved;
223         for (auto& resource : m_pendingResourcesForRemoval) {
224             PendingElements* elements = resource.value.get();
225             ASSERT(elements);
226             ASSERT(!elements->isEmpty());
227
228             elements->remove(element);
229             if (elements->isEmpty())
230                 toBeRemoved.append(resource.key);
231         }
232
233         // We use the removePendingResourceForRemoval function here because it deals with set lifetime correctly.
234         for (auto& resource : toBeRemoved)
235             removePendingResourceForRemoval(resource);
236     }
237 }
238
239 std::unique_ptr<SVGDocumentExtensions::PendingElements> SVGDocumentExtensions::removePendingResource(const AtomicString& id)
240 {
241     ASSERT(m_pendingResources.contains(id));
242     return m_pendingResources.take(id);
243 }
244
245 std::unique_ptr<SVGDocumentExtensions::PendingElements> SVGDocumentExtensions::removePendingResourceForRemoval(const AtomicString& id)
246 {
247     ASSERT(m_pendingResourcesForRemoval.contains(id));
248     return m_pendingResourcesForRemoval.take(id);
249 }
250
251 void SVGDocumentExtensions::markPendingResourcesForRemoval(const AtomicString& id)
252 {
253     if (id.isEmpty())
254         return;
255
256     ASSERT(!m_pendingResourcesForRemoval.contains(id));
257
258     std::unique_ptr<PendingElements> existing = m_pendingResources.take(id);
259     if (existing && !existing->isEmpty())
260         m_pendingResourcesForRemoval.add(id, WTFMove(existing));
261 }
262
263 Element* SVGDocumentExtensions::removeElementFromPendingResourcesForRemovalMap(const AtomicString& id)
264 {
265     if (id.isEmpty())
266         return 0;
267
268     PendingElements* resourceSet = m_pendingResourcesForRemoval.get(id);
269     if (!resourceSet || resourceSet->isEmpty())
270         return 0;
271
272     auto firstElement = resourceSet->begin();
273     Element* element = *firstElement;
274
275     resourceSet->remove(firstElement);
276
277     if (resourceSet->isEmpty())
278         removePendingResourceForRemoval(id);
279
280     return element;
281 }
282
283 HashSet<SVGElement*>* SVGDocumentExtensions::setOfElementsReferencingTarget(SVGElement* referencedElement) const
284 {
285     ASSERT(referencedElement);
286     const auto it = m_elementDependencies.find(referencedElement);
287     if (it == m_elementDependencies.end())
288         return 0;
289     return it->value.get();
290 }
291
292 void SVGDocumentExtensions::addElementReferencingTarget(SVGElement* referencingElement, SVGElement* referencedElement)
293 {
294     ASSERT(referencingElement);
295     ASSERT(referencedElement);
296
297     if (HashSet<SVGElement*>* elements = m_elementDependencies.get(referencedElement)) {
298         elements->add(referencingElement);
299         return;
300     }
301
302     auto elements = std::make_unique<HashSet<SVGElement*>>();
303     elements->add(referencingElement);
304     m_elementDependencies.set(referencedElement, WTFMove(elements));
305 }
306
307 void SVGDocumentExtensions::removeAllTargetReferencesForElement(SVGElement* referencingElement)
308 {
309     Vector<SVGElement*> toBeRemoved;
310
311     for (auto& dependency : m_elementDependencies) {
312         SVGElement* referencedElement = dependency.key;
313         HashSet<SVGElement*>& referencingElements = *dependency.value;
314         referencingElements.remove(referencingElement);
315         if (referencingElements.isEmpty())
316             toBeRemoved.append(referencedElement);
317     }
318
319     for (auto& element : toBeRemoved)
320         m_elementDependencies.remove(element);
321 }
322
323 void SVGDocumentExtensions::rebuildElements()
324 {
325     Vector<SVGElement*> shadowRebuildElements = WTFMove(m_rebuildElements);
326     for (auto* element : shadowRebuildElements)
327         element->svgAttributeChanged(XLinkNames::hrefAttr);
328 }
329
330 void SVGDocumentExtensions::clearTargetDependencies(SVGElement& referencedElement)
331 {
332     auto it = m_elementDependencies.find(&referencedElement);
333     if (it == m_elementDependencies.end())
334         return;
335     ASSERT(it->key == &referencedElement);
336     HashSet<SVGElement*>* referencingElements = it->value.get();
337     for (auto* element : *referencingElements) {
338         m_rebuildElements.append(element);
339         element->callClearTarget();
340     }
341 }
342
343 void SVGDocumentExtensions::rebuildAllElementReferencesForTarget(SVGElement& referencedElement)
344 {
345     auto it = m_elementDependencies.find(&referencedElement);
346     if (it == m_elementDependencies.end())
347         return;
348     ASSERT(it->key == &referencedElement);
349
350     HashSet<SVGElement*>* referencingElements = it->value.get();
351     Vector<SVGElement*> elementsToRebuild;
352     elementsToRebuild.reserveInitialCapacity(referencingElements->size());
353     for (auto* element : *referencingElements)
354         elementsToRebuild.uncheckedAppend(element);
355
356     for (auto* element : elementsToRebuild)
357         element->svgAttributeChanged(XLinkNames::hrefAttr);
358 }
359
360 void SVGDocumentExtensions::removeAllElementReferencesForTarget(SVGElement* referencedElement)
361 {
362     m_elementDependencies.remove(referencedElement);
363     m_rebuildElements.removeFirst(referencedElement);
364 }
365
366 #if ENABLE(SVG_FONTS)
367 void SVGDocumentExtensions::registerSVGFontFaceElement(SVGFontFaceElement* element)
368 {
369     m_svgFontFaceElements.add(element);
370 }
371
372 void SVGDocumentExtensions::unregisterSVGFontFaceElement(SVGFontFaceElement* element)
373 {
374     ASSERT(m_svgFontFaceElements.contains(element));
375     m_svgFontFaceElements.remove(element);
376 }
377 #endif
378
379 }