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