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