Use "= default" to denote default constructor or destructor
[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 #include "RenderSVGResourceClipper.h"
25
26 #include "ElementIterator.h"
27 #include "Frame.h"
28 #include "FrameView.h"
29 #include "HitTestRequest.h"
30 #include "HitTestResult.h"
31 #include "IntRect.h"
32 #include "RenderObject.h"
33 #include "RenderStyle.h"
34 #include "RenderView.h"
35 #include "SVGNames.h"
36 #include "SVGRenderingContext.h"
37 #include "SVGResources.h"
38 #include "SVGResourcesCache.h"
39 #include "SVGUseElement.h"
40
41 namespace WebCore {
42
43 RenderSVGResourceClipper::RenderSVGResourceClipper(SVGClipPathElement& element, RenderStyle&& style)
44     : RenderSVGResourceContainer(element, WTFMove(style))
45 {
46 }
47
48 RenderSVGResourceClipper::~RenderSVGResourceClipper() = default;
49
50 void RenderSVGResourceClipper::removeAllClientsFromCache(bool markForInvalidation)
51 {
52     m_clipBoundaries = FloatRect();
53     m_clipper.clear();
54
55     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
56 }
57
58 void RenderSVGResourceClipper::removeClientFromCache(RenderElement& client, bool markForInvalidation)
59 {
60     m_clipper.remove(&client);
61
62     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
63 }
64
65 bool RenderSVGResourceClipper::applyResource(RenderElement& renderer, const RenderStyle&, GraphicsContext*& context, OptionSet<RenderSVGResourceMode> resourceMode)
66 {
67     ASSERT(context);
68     ASSERT_UNUSED(resourceMode, resourceMode == RenderSVGResourceMode::ApplyToDefault);
69
70     return applyClippingToContext(renderer, renderer.objectBoundingBox(), renderer.repaintRectInLocalCoordinates(), *context);
71 }
72
73 bool RenderSVGResourceClipper::pathOnlyClipping(GraphicsContext& context, const AffineTransform& animatedLocalTransform, const FloatRect& objectBoundingBox)
74 {
75     // If the current clip-path gets clipped itself, we have to fallback to masking.
76     if (!style().svgStyle().clipperResource().isEmpty())
77         return false;
78     WindRule clipRule = RULE_NONZERO;
79     Path clipPath = Path();
80
81     // If clip-path only contains one visible shape or path, we can use path-based clipping. Invisible
82     // shapes don't affect the clipping and can be ignored. If clip-path contains more than one
83     // visible shape, the additive clipping may not work, caused by the clipRule. EvenOdd
84     // as well as NonZero can cause self-clipping of the elements.
85     // See also http://www.w3.org/TR/SVG/painting.html#FillRuleProperty
86     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
87         RenderObject* renderer = childNode->renderer();
88         if (!renderer)
89             continue;
90         // Only shapes or paths are supported for direct clipping. We need to fallback to masking for texts.
91         if (renderer->isSVGText())
92             return false;
93         if (!childNode->isSVGElement() || !downcast<SVGElement>(*childNode).isSVGGraphicsElement())
94             continue;
95         SVGGraphicsElement& styled = downcast<SVGGraphicsElement>(*childNode);
96         const RenderStyle& style = renderer->style();
97         if (style.display() == NONE || style.visibility() != VISIBLE)
98              continue;
99         const SVGRenderStyle& svgStyle = style.svgStyle();
100         // Current shape in clip-path gets clipped too. Fallback to masking.
101         if (!svgStyle.clipperResource().isEmpty())
102             return false;
103         // Fallback to masking, if there is more than one clipping path.
104         if (clipPath.isEmpty()) {
105             styled.toClipPath(clipPath);
106             clipRule = svgStyle.clipRule();
107         } else
108             return false;
109     }
110     // Only one visible shape/path was found. Directly continue clipping and transform the content to userspace if necessary.
111     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
112         AffineTransform transform;
113         transform.translate(objectBoundingBox.location());
114         transform.scale(objectBoundingBox.size());
115         clipPath.transform(transform);
116     }
117
118     // Transform path by animatedLocalTransform.
119     clipPath.transform(animatedLocalTransform);
120
121     // The SVG specification wants us to clip everything, if clip-path doesn't have a child.
122     if (clipPath.isEmpty())
123         clipPath.addRect(FloatRect());
124     context.clipPath(clipPath, clipRule);
125     return true;
126 }
127
128 bool RenderSVGResourceClipper::applyClippingToContext(RenderElement& renderer, const FloatRect& objectBoundingBox, const FloatRect& repaintRect, GraphicsContext& context)
129 {
130     ClipperMaskImage& clipperMaskImage = addRendererToClipper(renderer);
131     bool shouldCreateClipperMaskImage = !clipperMaskImage;
132
133     AffineTransform animatedLocalTransform = clipPathElement().animatedLocalTransform();
134
135     if (shouldCreateClipperMaskImage && pathOnlyClipping(context, animatedLocalTransform, objectBoundingBox))
136         return true;
137
138     AffineTransform absoluteTransform = SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(renderer);
139
140     if (shouldCreateClipperMaskImage && !repaintRect.isEmpty()) {
141         // FIXME (149469): This image buffer should not be unconditionally unaccelerated. Making it match the context breaks nested clipping, though.
142         clipperMaskImage = SVGRenderingContext::createImageBuffer(repaintRect, absoluteTransform, ColorSpaceSRGB, Unaccelerated);
143         if (!clipperMaskImage)
144             return false;
145
146         GraphicsContext& maskContext = clipperMaskImage->context();
147         maskContext.concatCTM(animatedLocalTransform);
148
149         // clipPath can also be clipped by another clipPath.
150         auto* resources = SVGResourcesCache::cachedResourcesForRenderer(*this);
151         RenderSVGResourceClipper* clipper;
152         bool succeeded;
153         if (resources && (clipper = resources->clipper())) {
154             GraphicsContextStateSaver stateSaver(maskContext);
155
156             if (!clipper->applyClippingToContext(*this, objectBoundingBox, repaintRect, maskContext))
157                 return false;
158
159             succeeded = drawContentIntoMaskImage(clipperMaskImage, objectBoundingBox);
160             // The context restore applies the clipping on non-CG platforms.
161         } else
162             succeeded = drawContentIntoMaskImage(clipperMaskImage, objectBoundingBox);
163
164         if (!succeeded)
165             clipperMaskImage.reset();
166     }
167
168     if (!clipperMaskImage)
169         return false;
170
171     SVGRenderingContext::clipToImageBuffer(context, absoluteTransform, repaintRect, clipperMaskImage, shouldCreateClipperMaskImage);
172     return true;
173 }
174
175 bool RenderSVGResourceClipper::drawContentIntoMaskImage(const ClipperMaskImage& clipperMaskImage, const FloatRect& objectBoundingBox)
176 {
177     ASSERT(clipperMaskImage);
178
179     GraphicsContext& maskContext = clipperMaskImage->context();
180
181     AffineTransform maskContentTransformation;
182     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
183         maskContentTransformation.translate(objectBoundingBox.location());
184         maskContentTransformation.scale(objectBoundingBox.size());
185         maskContext.concatCTM(maskContentTransformation);
186     }
187
188     // Switch to a paint behavior where all children of this <clipPath> will be rendered using special constraints:
189     // - fill-opacity/stroke-opacity/opacity set to 1
190     // - masker/filter not applied when rendering the children
191     // - fill is set to the initial fill paint server (solid, black)
192     // - stroke is set to the initial stroke paint server (none)
193     PaintBehavior oldBehavior = view().frameView().paintBehavior();
194     view().frameView().setPaintBehavior(oldBehavior | PaintBehaviorRenderingSVGMask);
195
196     // Draw all clipPath children into a global mask.
197     for (auto& child : childrenOfType<SVGElement>(clipPathElement())) {
198         auto renderer = child.renderer();
199         if (!renderer)
200             continue;
201         if (renderer->needsLayout()) {
202             view().frameView().setPaintBehavior(oldBehavior);
203             return false;
204         }
205         const RenderStyle& style = renderer->style();
206         if (style.display() == NONE || style.visibility() != VISIBLE)
207             continue;
208
209         WindRule newClipRule = style.svgStyle().clipRule();
210         bool isUseElement = child.hasTagName(SVGNames::useTag);
211         if (isUseElement) {
212             SVGUseElement& useElement = downcast<SVGUseElement>(child);
213             renderer = useElement.rendererClipChild();
214             if (!renderer)
215                 continue;
216             if (!useElement.hasAttributeWithoutSynchronization(SVGNames::clip_ruleAttr))
217                 newClipRule = renderer->style().svgStyle().clipRule();
218         }
219
220         // Only shapes, paths and texts are allowed for clipping.
221         if (!renderer->isSVGShape() && !renderer->isSVGText())
222             continue;
223
224         maskContext.setFillRule(newClipRule);
225
226         // In the case of a <use> element, we obtained its renderere above, to retrieve its clipRule.
227         // We have to pass the <use> renderer itself to renderSubtreeToImageBuffer() to apply it's x/y/transform/etc. values when rendering.
228         // So if isUseElement is true, refetch the childNode->renderer(), as renderer got overriden above.
229         SVGRenderingContext::renderSubtreeToImageBuffer(clipperMaskImage.get(), isUseElement ? *child.renderer() : *renderer, maskContentTransformation);
230     }
231
232     view().frameView().setPaintBehavior(oldBehavior);
233     return true;
234 }
235
236 void RenderSVGResourceClipper::calculateClipContentRepaintRect()
237 {
238     // This is a rough heuristic to appraise the clip size and doesn't consider clip on clip.
239     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
240         RenderObject* renderer = childNode->renderer();
241         if (!childNode->isSVGElement() || !renderer)
242             continue;
243         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
244             continue;
245         const RenderStyle& style = renderer->style();
246         if (style.display() == NONE || style.visibility() != VISIBLE)
247              continue;
248         m_clipBoundaries.unite(renderer->localToParentTransform().mapRect(renderer->repaintRectInLocalCoordinates()));
249     }
250     m_clipBoundaries = clipPathElement().animatedLocalTransform().mapRect(m_clipBoundaries);
251 }
252
253 ClipperMaskImage& RenderSVGResourceClipper::addRendererToClipper(const RenderObject& object)
254 {
255     return m_clipper.add(&object, ClipperMaskImage()).iterator->value;
256 }
257
258 bool RenderSVGResourceClipper::hitTestClipContent(const FloatRect& objectBoundingBox, const FloatPoint& nodeAtPoint)
259 {
260     FloatPoint point = nodeAtPoint;
261     if (!SVGRenderSupport::pointInClippingArea(*this, point))
262         return false;
263
264     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
265         AffineTransform transform;
266         transform.translate(objectBoundingBox.location());
267         transform.scale(objectBoundingBox.size());
268         point = transform.inverse().value_or(AffineTransform()).mapPoint(point);
269     }
270
271     point = clipPathElement().animatedLocalTransform().inverse().value_or(AffineTransform()).mapPoint(point);
272
273     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
274         RenderObject* renderer = childNode->renderer();
275         if (!childNode->isSVGElement() || !renderer)
276             continue;
277         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
278             continue;
279         IntPoint hitPoint;
280         HitTestResult result(hitPoint);
281         if (renderer->nodeAtFloatPoint(HitTestRequest(HitTestRequest::SVGClipContent | HitTestRequest::DisallowUserAgentShadowContent), result, point, HitTestForeground))
282             return true;
283     }
284
285     return false;
286 }
287
288 FloatRect RenderSVGResourceClipper::resourceBoundingBox(const RenderObject& object)
289 {
290     // Resource was not layouted yet. Give back the boundingBox of the object.
291     if (selfNeedsLayout()) {
292         addRendererToClipper(object);
293         return object.objectBoundingBox();
294     }
295     
296     if (m_clipBoundaries.isEmpty())
297         calculateClipContentRepaintRect();
298
299     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
300         FloatRect objectBoundingBox = object.objectBoundingBox();
301         AffineTransform transform;
302         transform.translate(objectBoundingBox.location());
303         transform.scale(objectBoundingBox.size());
304         return transform.mapRect(m_clipBoundaries);
305     }
306
307     return m_clipBoundaries;
308 }
309
310 }