RenderSVGResource::applyResource() should take a const RenderStyle&.
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGResourceClipper.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Rob Buis <buis@kde.org>
4  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
5  * Copyright (C) 2011 Dirk Schulze <krit@webkit.org>
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include "config.h"
24
25 #if ENABLE(SVG)
26 #include "RenderSVGResourceClipper.h"
27
28 #include "AffineTransform.h"
29 #include "ElementIterator.h"
30 #include "FloatRect.h"
31 #include "Frame.h"
32 #include "FrameView.h"
33 #include "GraphicsContext.h"
34 #include "HitTestRequest.h"
35 #include "HitTestResult.h"
36 #include "ImageBuffer.h"
37 #include "IntRect.h"
38 #include "RenderObject.h"
39 #include "RenderSVGResource.h"
40 #include "RenderStyle.h"
41 #include "RenderView.h"
42 #include "SVGClipPathElement.h"
43 #include "SVGElement.h"
44 #include "SVGGraphicsElement.h"
45 #include "SVGNames.h"
46 #include "SVGRenderSupport.h"
47 #include "SVGRenderingContext.h"
48 #include "SVGResources.h"
49 #include "SVGResourcesCache.h"
50 #include "SVGUnitTypes.h"
51 #include "SVGUseElement.h"
52
53 namespace WebCore {
54
55 RenderSVGResourceType RenderSVGResourceClipper::s_resourceType = ClipperResourceType;
56
57 RenderSVGResourceClipper::RenderSVGResourceClipper(SVGClipPathElement& element, PassRef<RenderStyle> style)
58     : RenderSVGResourceContainer(element, std::move(style))
59 {
60 }
61
62 RenderSVGResourceClipper::~RenderSVGResourceClipper()
63 {
64 }
65
66 void RenderSVGResourceClipper::removeAllClientsFromCache(bool markForInvalidation)
67 {
68     m_clipBoundaries = FloatRect();
69     m_clipper.clear();
70
71     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
72 }
73
74 void RenderSVGResourceClipper::removeClientFromCache(RenderObject* client, bool markForInvalidation)
75 {
76     ASSERT(client);
77     m_clipper.remove(client);
78
79     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
80 }
81
82 bool RenderSVGResourceClipper::applyResource(RenderElement& renderer, const RenderStyle&, GraphicsContext*& context, unsigned short resourceMode)
83 {
84     ASSERT(context);
85     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
86
87     return applyClippingToContext(renderer, renderer.objectBoundingBox(), renderer.repaintRectInLocalCoordinates(), context);
88 }
89
90 bool RenderSVGResourceClipper::pathOnlyClipping(GraphicsContext* context, const AffineTransform& animatedLocalTransform, const FloatRect& objectBoundingBox)
91 {
92     // If the current clip-path gets clipped itself, we have to fallback to masking.
93     if (!style().svgStyle()->clipperResource().isEmpty())
94         return false;
95     WindRule clipRule = RULE_NONZERO;
96     Path clipPath = Path();
97
98     // If clip-path only contains one visible shape or path, we can use path-based clipping. Invisible
99     // shapes don't affect the clipping and can be ignored. If clip-path contains more than one
100     // visible shape, the additive clipping may not work, caused by the clipRule. EvenOdd
101     // as well as NonZero can cause self-clipping of the elements.
102     // See also http://www.w3.org/TR/SVG/painting.html#FillRuleProperty
103     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
104         RenderObject* renderer = childNode->renderer();
105         if (!renderer)
106             continue;
107         // Only shapes or paths are supported for direct clipping. We need to fallback to masking for texts.
108         if (renderer->isSVGText())
109             return false;
110         if (!childNode->isSVGElement() || !toSVGElement(childNode)->isSVGGraphicsElement())
111             continue;
112         SVGGraphicsElement* styled = toSVGGraphicsElement(childNode);
113         const RenderStyle& style = renderer->style();
114         if (style.display() == NONE || style.visibility() != VISIBLE)
115              continue;
116         const SVGRenderStyle* svgStyle = style.svgStyle();
117         // Current shape in clip-path gets clipped too. Fallback to masking.
118         if (!svgStyle->clipperResource().isEmpty())
119             return false;
120         // Fallback to masking, if there is more than one clipping path.
121         if (clipPath.isEmpty()) {
122             styled->toClipPath(clipPath);
123             clipRule = svgStyle->clipRule();
124         } else
125             return false;
126     }
127     // Only one visible shape/path was found. Directly continue clipping and transform the content to userspace if necessary.
128     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
129         AffineTransform transform;
130         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
131         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
132         clipPath.transform(transform);
133     }
134
135     // Transform path by animatedLocalTransform.
136     clipPath.transform(animatedLocalTransform);
137
138     // The SVG specification wants us to clip everything, if clip-path doesn't have a child.
139     if (clipPath.isEmpty())
140         clipPath.addRect(FloatRect());
141     context->clipPath(clipPath, clipRule);
142     return true;
143 }
144
145 bool RenderSVGResourceClipper::applyClippingToContext(RenderElement& renderer, const FloatRect& objectBoundingBox,
146                                                       const FloatRect& repaintRect, GraphicsContext* context)
147 {
148     bool missingClipperData = !m_clipper.contains(&renderer);
149     if (missingClipperData)
150         m_clipper.set(&renderer, std::make_unique<ClipperData>());
151
152     bool shouldCreateClipData = false;
153     AffineTransform animatedLocalTransform = clipPathElement().animatedLocalTransform();
154     ClipperData* clipperData = m_clipper.get(&renderer);
155     if (!clipperData->clipMaskImage) {
156         if (pathOnlyClipping(context, animatedLocalTransform, objectBoundingBox))
157             return true;
158         shouldCreateClipData = true;
159     }
160
161     AffineTransform absoluteTransform;
162     SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(&renderer, absoluteTransform);
163
164     if (shouldCreateClipData && !repaintRect.isEmpty()) {
165         if (!SVGRenderingContext::createImageBuffer(repaintRect, absoluteTransform, clipperData->clipMaskImage, ColorSpaceDeviceRGB, Unaccelerated))
166             return false;
167
168         GraphicsContext* maskContext = clipperData->clipMaskImage->context();
169         ASSERT(maskContext);
170
171         maskContext->concatCTM(animatedLocalTransform);
172
173         // clipPath can also be clipped by another clipPath.
174         SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(this);
175         RenderSVGResourceClipper* clipper;
176         bool succeeded;
177         if (resources && (clipper = resources->clipper())) {
178             GraphicsContextStateSaver stateSaver(*maskContext);
179
180             if (!clipper->applyClippingToContext(*this, objectBoundingBox, repaintRect, maskContext))
181                 return false;
182
183             succeeded = drawContentIntoMaskImage(clipperData, objectBoundingBox);
184             // The context restore applies the clipping on non-CG platforms.
185         } else
186             succeeded = drawContentIntoMaskImage(clipperData, objectBoundingBox);
187
188         if (!succeeded)
189             clipperData->clipMaskImage.clear();
190     }
191
192     if (!clipperData->clipMaskImage)
193         return false;
194
195     SVGRenderingContext::clipToImageBuffer(context, absoluteTransform, repaintRect, clipperData->clipMaskImage, missingClipperData);
196     return true;
197 }
198
199 bool RenderSVGResourceClipper::drawContentIntoMaskImage(ClipperData* clipperData, const FloatRect& objectBoundingBox)
200 {
201     ASSERT(clipperData);
202     ASSERT(clipperData->clipMaskImage);
203
204     GraphicsContext* maskContext = clipperData->clipMaskImage->context();
205     ASSERT(maskContext);
206
207     AffineTransform maskContentTransformation;
208     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
209         maskContentTransformation.translate(objectBoundingBox.x(), objectBoundingBox.y());
210         maskContentTransformation.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
211         maskContext->concatCTM(maskContentTransformation);
212     }
213
214     // Switch to a paint behavior where all children of this <clipPath> will be rendered using special constraints:
215     // - fill-opacity/stroke-opacity/opacity set to 1
216     // - masker/filter not applied when rendering the children
217     // - fill is set to the initial fill paint server (solid, black)
218     // - stroke is set to the initial stroke paint server (none)
219     PaintBehavior oldBehavior = view().frameView().paintBehavior();
220     view().frameView().setPaintBehavior(oldBehavior | PaintBehaviorRenderingSVGMask);
221
222     // Draw all clipPath children into a global mask.
223     auto children = childrenOfType<SVGElement>(clipPathElement());
224     for (auto it = children.begin(), end = children.end(); it != end; ++it) {
225         SVGElement& child = *it;
226         auto renderer = child.renderer();
227         if (!renderer)
228             continue;
229         if (renderer->needsLayout()) {
230             view().frameView().setPaintBehavior(oldBehavior);
231             return false;
232         }
233         const RenderStyle& style = renderer->style();
234         if (style.display() == NONE || style.visibility() != VISIBLE)
235             continue;
236
237         WindRule newClipRule = style.svgStyle()->clipRule();
238         bool isUseElement = child.hasTagName(SVGNames::useTag);
239         if (isUseElement) {
240             SVGUseElement& useElement = toSVGUseElement(child);
241             renderer = useElement.rendererClipChild();
242             if (!renderer)
243                 continue;
244             if (!useElement.hasAttribute(SVGNames::clip_ruleAttr))
245                 newClipRule = renderer->style().svgStyle()->clipRule();
246         }
247
248         // Only shapes, paths and texts are allowed for clipping.
249         if (!renderer->isSVGShape() && !renderer->isSVGText())
250             continue;
251
252         maskContext->setFillRule(newClipRule);
253
254         // In the case of a <use> element, we obtained its renderere above, to retrieve its clipRule.
255         // We have to pass the <use> renderer itself to renderSubtreeToImageBuffer() to apply it's x/y/transform/etc. values when rendering.
256         // So if isUseElement is true, refetch the childNode->renderer(), as renderer got overriden above.
257         SVGRenderingContext::renderSubtreeToImageBuffer(clipperData->clipMaskImage.get(), isUseElement ? *child.renderer() : *renderer, maskContentTransformation);
258     }
259
260     view().frameView().setPaintBehavior(oldBehavior);
261     return true;
262 }
263
264 void RenderSVGResourceClipper::calculateClipContentRepaintRect()
265 {
266     // This is a rough heuristic to appraise the clip size and doesn't consider clip on clip.
267     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
268         RenderObject* renderer = childNode->renderer();
269         if (!childNode->isSVGElement() || !renderer)
270             continue;
271         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
272             continue;
273         const RenderStyle& style = renderer->style();
274         if (style.display() == NONE || style.visibility() != VISIBLE)
275              continue;
276         m_clipBoundaries.unite(renderer->localToParentTransform().mapRect(renderer->repaintRectInLocalCoordinates()));
277     }
278     m_clipBoundaries = clipPathElement().animatedLocalTransform().mapRect(m_clipBoundaries);
279 }
280
281 bool RenderSVGResourceClipper::hitTestClipContent(const FloatRect& objectBoundingBox, const FloatPoint& nodeAtPoint)
282 {
283     FloatPoint point = nodeAtPoint;
284     if (!SVGRenderSupport::pointInClippingArea(this, point))
285         return false;
286
287     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
288         AffineTransform transform;
289         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
290         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
291         point = transform.inverse().mapPoint(point);
292     }
293
294     point = clipPathElement().animatedLocalTransform().inverse().mapPoint(point);
295
296     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
297         RenderObject* renderer = childNode->renderer();
298         if (!childNode->isSVGElement() || !renderer)
299             continue;
300         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
301             continue;
302         IntPoint hitPoint;
303         HitTestResult result(hitPoint);
304         if (renderer->nodeAtFloatPoint(HitTestRequest(HitTestRequest::SVGClipContent | HitTestRequest::DisallowShadowContent), result, point, HitTestForeground))
305             return true;
306     }
307
308     return false;
309 }
310
311 FloatRect RenderSVGResourceClipper::resourceBoundingBox(const RenderObject& object)
312 {
313     // Resource was not layouted yet. Give back the boundingBox of the object.
314     if (selfNeedsLayout())
315         return object.objectBoundingBox();
316     
317     if (m_clipBoundaries.isEmpty())
318         calculateClipContentRepaintRect();
319
320     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
321         FloatRect objectBoundingBox = object.objectBoundingBox();
322         AffineTransform transform;
323         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
324         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
325         return transform.mapRect(m_clipBoundaries);
326     }
327
328     return m_clipBoundaries;
329 }
330
331 }
332
333 #endif // ENABLE(SVG)