Tighten typing in SVGResourcesCycleSolver a bit.
[WebKit-https.git] / Source / WebCore / rendering / svg / SVGResourcesCache.cpp
1 /*
2  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include "config.h"
21 #include "SVGResourcesCache.h"
22
23 #if ENABLE(SVG)
24 #include "HTMLNames.h"
25 #include "RenderSVGResourceContainer.h"
26 #include "SVGDocumentExtensions.h"
27 #include "SVGElement.h"
28 #include "SVGResources.h"
29 #include "SVGResourcesCycleSolver.h"
30
31 namespace WebCore {
32
33 SVGResourcesCache::SVGResourcesCache()
34 {
35 }
36
37 SVGResourcesCache::~SVGResourcesCache()
38 {
39 }
40
41 void SVGResourcesCache::addResourcesFromRenderer(RenderElement& renderer, const RenderStyle& style)
42 {
43     ASSERT(!m_cache.contains(&renderer));
44
45     const SVGRenderStyle& svgStyle = style.svgStyle();
46
47     // Build a list of all resources associated with the passed RenderObject
48     OwnPtr<SVGResources> newResources = adoptPtr(new SVGResources);
49     if (!newResources->buildCachedResources(renderer, svgStyle))
50         return;
51
52     // Put object in cache.
53     SVGResources& resources = *m_cache.add(&renderer, newResources.release()).iterator->value;
54
55     // Run cycle-detection _afterwards_, so self-references can be caught as well.
56     SVGResourcesCycleSolver solver(renderer, resources);
57     solver.resolveCycles();
58
59     // Walk resources and register the render object at each resources.
60     HashSet<RenderSVGResourceContainer*> resourceSet;
61     resources.buildSetOfResources(resourceSet);
62
63     for (auto it = resourceSet.begin(), end = resourceSet.end(); it != end; ++it)
64         (*it)->addClient(&renderer);
65 }
66
67 void SVGResourcesCache::removeResourcesFromRenderer(RenderElement& renderer)
68 {
69     OwnPtr<SVGResources> resources = m_cache.take(&renderer);
70     if (!resources)
71         return;
72
73     // Walk resources and register the render object at each resources.
74     HashSet<RenderSVGResourceContainer*> resourceSet;
75     resources->buildSetOfResources(resourceSet);
76
77     for (auto it = resourceSet.begin(), end = resourceSet.end(); it != end; ++it)
78         (*it)->removeClient(&renderer);
79 }
80
81 static inline SVGResourcesCache* resourcesCacheFromRenderObject(const RenderObject& renderer)
82 {
83     SVGDocumentExtensions* extensions = renderer.document().accessSVGExtensions();
84     ASSERT(extensions);
85
86     SVGResourcesCache* cache = extensions->resourcesCache();
87     ASSERT(cache);
88
89     return cache;
90 }
91
92 SVGResources* SVGResourcesCache::cachedResourcesForRenderObject(const RenderObject* renderer)
93 {
94     ASSERT(renderer);
95     return resourcesCacheFromRenderObject(*renderer)->m_cache.get(renderer);
96 }
97
98 void SVGResourcesCache::clientLayoutChanged(RenderElement& renderer)
99 {
100     SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(&renderer);
101     if (!resources)
102         return;
103
104     // Invalidate the resources if either the RenderElement itself changed,
105     // or we have filter resources, which could depend on the layout of children.
106     if (renderer.selfNeedsLayout())
107         resources->removeClientFromCache(&renderer);
108 }
109
110 static inline bool rendererCanHaveResources(RenderObject& renderer)
111 {
112     return renderer.node() && renderer.node()->isSVGElement() && !renderer.isSVGInlineText();
113 }
114
115 void SVGResourcesCache::clientStyleChanged(RenderElement& renderer, StyleDifference diff, const RenderStyle& newStyle)
116 {
117     if (diff == StyleDifferenceEqual || !renderer.parent())
118         return;
119
120     // In this case the proper SVGFE*Element will decide whether the modified CSS properties require a relayout or repaint.
121     if (renderer.isSVGResourceFilterPrimitive() && (diff == StyleDifferenceRepaint || diff == StyleDifferenceRepaintIfTextOrBorderOrOutline))
122         return;
123
124     // Dynamic changes of CSS properties like 'clip-path' may require us to recompute the associated resources for a renderer.
125     // FIXME: Avoid passing in a useless StyleDifference, but instead compare oldStyle/newStyle to see which resources changed
126     // to be able to selectively rebuild individual resources, instead of all of them.
127     if (rendererCanHaveResources(renderer)) {
128         SVGResourcesCache* cache = resourcesCacheFromRenderObject(renderer);
129         cache->removeResourcesFromRenderer(renderer);
130         cache->addResourcesFromRenderer(renderer, newStyle);
131     }
132
133     RenderSVGResource::markForLayoutAndParentResourceInvalidation(&renderer, false);
134
135     if (renderer.element() && !renderer.element()->isSVGElement())
136         renderer.element()->setNeedsStyleRecalc(SyntheticStyleChange);
137 }
138
139 void SVGResourcesCache::clientWasAddedToTree(RenderObject& renderer)
140 {
141     if (renderer.isAnonymous())
142         return;
143
144     RenderSVGResource::markForLayoutAndParentResourceInvalidation(&renderer, false);
145
146     if (!rendererCanHaveResources(renderer))
147         return;
148     RenderElement& elementRenderer = toRenderElement(renderer);
149     SVGResourcesCache* cache = resourcesCacheFromRenderObject(elementRenderer);
150     cache->addResourcesFromRenderer(elementRenderer, elementRenderer.style());
151 }
152
153 void SVGResourcesCache::clientWillBeRemovedFromTree(RenderObject& renderer)
154 {
155     if (renderer.isAnonymous())
156         return;
157
158     RenderSVGResource::markForLayoutAndParentResourceInvalidation(&renderer, false);
159
160     if (!rendererCanHaveResources(renderer))
161         return;
162     RenderElement& elementRenderer = toRenderElement(renderer);
163     SVGResourcesCache* cache = resourcesCacheFromRenderObject(elementRenderer);
164     cache->removeResourcesFromRenderer(elementRenderer);
165 }
166
167 void SVGResourcesCache::clientDestroyed(RenderElement& renderer)
168 {
169     SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(&renderer);
170     if (resources)
171         resources->removeClientFromCache(&renderer);
172
173     SVGResourcesCache* cache = resourcesCacheFromRenderObject(renderer);
174     cache->removeResourcesFromRenderer(renderer);
175 }
176
177 void SVGResourcesCache::resourceDestroyed(RenderSVGResourceContainer& resource)
178 {
179     SVGResourcesCache* cache = resourcesCacheFromRenderObject(resource);
180
181     // The resource itself may have clients, that need to be notified.
182     cache->removeResourcesFromRenderer(resource);
183
184     for (auto it = cache->m_cache.begin(), end = cache->m_cache.end(); it != end; ++it) {
185         it->value->resourceDestroyed(resource);
186
187         // Mark users of destroyed resources as pending resolution based on the id of the old resource.
188         Element& resourceElement = resource.element();
189         Element* clientElement = toElement(it->key->node());
190         SVGDocumentExtensions* extensions = clientElement->document().accessSVGExtensions();
191
192         extensions->addPendingResource(resourceElement.getIdAttribute(), clientElement);
193     }
194 }
195
196 }
197
198 #endif