Unreviewed, rolling out r97863.
[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 "FloatRect.h"
30 #include "GraphicsContext.h"
31 #include "HitTestRequest.h"
32 #include "HitTestResult.h"
33 #include "ImageBuffer.h"
34 #include "IntRect.h"
35 #include "RenderObject.h"
36 #include "RenderSVGResource.h"
37 #include "RenderStyle.h"
38 #include "SVGClipPathElement.h"
39 #include "SVGElement.h"
40 #include "SVGImageBufferTools.h"
41 #include "SVGNames.h"
42 #include "SVGRenderSupport.h"
43 #include "SVGResources.h"
44 #include "SVGStyledElement.h"
45 #include "SVGStyledTransformableElement.h"
46 #include "SVGUnitTypes.h"
47 #include "SVGUseElement.h"
48 #include <wtf/UnusedParam.h>
49
50 namespace WebCore {
51
52 RenderSVGResourceType RenderSVGResourceClipper::s_resourceType = ClipperResourceType;
53
54 RenderSVGResourceClipper::RenderSVGResourceClipper(SVGClipPathElement* node)
55     : RenderSVGResourceContainer(node)
56     , m_invalidationBlocked(false)
57 {
58 }
59
60 RenderSVGResourceClipper::~RenderSVGResourceClipper()
61 {
62     if (m_clipper.isEmpty())
63         return;
64
65     deleteAllValues(m_clipper);
66     m_clipper.clear();
67 }
68
69 void RenderSVGResourceClipper::removeAllClientsFromCache(bool markForInvalidation)
70 {
71     if (m_invalidationBlocked)
72         return;
73
74     m_clipBoundaries = FloatRect();
75     if (!m_clipper.isEmpty()) {
76         deleteAllValues(m_clipper);
77         m_clipper.clear();
78     }
79
80     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
81 }
82
83 void RenderSVGResourceClipper::removeClientFromCache(RenderObject* client, bool markForInvalidation)
84 {
85     ASSERT(client);
86     if (m_invalidationBlocked)
87         return;
88
89     if (m_clipper.contains(client))
90         delete m_clipper.take(client);
91
92     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
93 }
94
95 bool RenderSVGResourceClipper::applyResource(RenderObject* object, RenderStyle*, GraphicsContext*& context, unsigned short resourceMode)
96 {
97     ASSERT(object);
98     ASSERT(context);
99 #ifndef NDEBUG
100     ASSERT(resourceMode == ApplyToDefaultMode);
101 #else
102     UNUSED_PARAM(resourceMode);
103 #endif
104
105     return applyClippingToContext(object, object->objectBoundingBox(), object->repaintRectInLocalCoordinates(), context);
106 }
107
108 bool RenderSVGResourceClipper::pathOnlyClipping(GraphicsContext* context, const AffineTransform& animatedLocalTransform, const FloatRect& objectBoundingBox)
109 {
110     // If the current clip-path gets clipped itself, we have to fallback to masking.
111     if (!style()->svgStyle()->clipperResource().isEmpty())
112         return false;
113     WindRule clipRule = RULE_NONZERO;
114     Path clipPath = Path();
115
116     // If clip-path only contains one visible shape or path, we can use path-based clipping. Invisible
117     // shapes don't affect the clipping and can be ignored. If clip-path contains more than one
118     // visible shape, the additive clipping may not work, caused by the clipRule. EvenOdd
119     // as well as NonZero can cause self-clipping of the elements.
120     // See also http://www.w3.org/TR/SVG/painting.html#FillRuleProperty
121     for (Node* childNode = node()->firstChild(); childNode; childNode = childNode->nextSibling()) {
122         RenderObject* renderer = childNode->renderer();
123         if (!renderer)
124             continue;
125         // Only shapes or paths are supported for direct clipping. We need to fallback to masking for texts.
126         if (renderer->isSVGText())
127             return false;
128         if (!childNode->isSVGElement() || !static_cast<SVGElement*>(childNode)->isStyledTransformable())
129             continue;
130         SVGStyledTransformableElement* styled = static_cast<SVGStyledTransformableElement*>(childNode);
131         RenderStyle* style = renderer->style();
132         if (!style || style->display() == NONE || style->visibility() != VISIBLE)
133              continue;
134         const SVGRenderStyle* svgStyle = style->svgStyle();
135         // Current shape in clip-path gets clipped too. Fallback to masking.
136         if (!svgStyle->clipperResource().isEmpty())
137             return false;
138         // Fallback to masking, if there is more than one clipping path.
139         if (clipPath.isEmpty()) {
140             styled->toClipPath(clipPath);
141             clipRule = svgStyle->clipRule();
142         } else
143             return false;
144     }
145     // Only one visible shape/path was found. Directly continue clipping and transform the content to userspace if necessary.
146     if (static_cast<SVGClipPathElement*>(node())->clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
147         AffineTransform transform;
148         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
149         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
150         clipPath.transform(transform);
151     }
152
153     // Transform path by animatedLocalTransform.
154     clipPath.transform(animatedLocalTransform);
155
156     // The SVG specification wants us to clip everything, if clip-path doesn't have a child.
157     if (clipPath.isEmpty())
158         clipPath.addRect(FloatRect());
159     context->clipPath(clipPath, clipRule);
160     return true;
161 }
162
163 bool RenderSVGResourceClipper::applyClippingToContext(RenderObject* object, const FloatRect& objectBoundingBox,
164                                                       const FloatRect& repaintRect, GraphicsContext* context)
165 {
166     if (!m_clipper.contains(object))
167         m_clipper.set(object, new ClipperData);
168
169     bool shouldCreateClipData = false;
170     AffineTransform animatedLocalTransform = static_cast<SVGClipPathElement*>(node())->animatedLocalTransform();
171     ClipperData* clipperData = m_clipper.get(object);
172     if (!clipperData->clipMaskImage) {
173         if (pathOnlyClipping(context, animatedLocalTransform, objectBoundingBox))
174             return true;
175         shouldCreateClipData = true;
176     }
177
178     AffineTransform absoluteTransform;
179     SVGImageBufferTools::calculateTransformationToOutermostSVGCoordinateSystem(object, absoluteTransform);
180
181     FloatRect absoluteTargetRect = absoluteTransform.mapRect(repaintRect);
182     FloatRect clampedAbsoluteTargetRect = SVGImageBufferTools::clampedAbsoluteTargetRect(absoluteTargetRect);
183
184     if (shouldCreateClipData && !clampedAbsoluteTargetRect.isEmpty()) {
185         if (!SVGImageBufferTools::createImageBuffer(absoluteTargetRect, clampedAbsoluteTargetRect, clipperData->clipMaskImage, ColorSpaceDeviceRGB))
186             return false;
187
188         GraphicsContext* maskContext = clipperData->clipMaskImage->context();
189         ASSERT(maskContext);
190
191         // The save/restore pair is needed for clipToImageBuffer - it doesn't work without it on non-Cg platforms.
192         GraphicsContextStateSaver stateSaver(*maskContext);
193         maskContext->translate(-clampedAbsoluteTargetRect.x(), -clampedAbsoluteTargetRect.y());
194         maskContext->concatCTM(animatedLocalTransform);
195         maskContext->concatCTM(absoluteTransform);
196
197         // clipPath can also be clipped by another clipPath.
198         if (SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(this)) {
199             if (RenderSVGResourceClipper* clipper = resources->clipper()) {
200                 if (!clipper->applyClippingToContext(this, objectBoundingBox, repaintRect, maskContext))
201                     return false;
202             }
203         }
204
205         drawContentIntoMaskImage(clipperData, objectBoundingBox);
206     }
207
208     if (!clipperData->clipMaskImage)
209         return false;
210
211     SVGImageBufferTools::clipToImageBuffer(context, absoluteTransform, clampedAbsoluteTargetRect, clipperData->clipMaskImage);
212     return true;
213 }
214
215 bool RenderSVGResourceClipper::drawContentIntoMaskImage(ClipperData* clipperData, const FloatRect& objectBoundingBox)
216 {
217     ASSERT(clipperData);
218     ASSERT(clipperData->clipMaskImage);
219
220     GraphicsContext* maskContext = clipperData->clipMaskImage->context();
221     ASSERT(maskContext);
222
223     AffineTransform maskContentTransformation;
224     SVGClipPathElement* clipPath = static_cast<SVGClipPathElement*>(node());
225     if (clipPath->clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
226         maskContentTransformation.translate(objectBoundingBox.x(), objectBoundingBox.y());
227         maskContentTransformation.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
228         maskContext->concatCTM(maskContentTransformation);
229     }
230
231     // Draw all clipPath children into a global mask.
232     for (Node* childNode = node()->firstChild(); childNode; childNode = childNode->nextSibling()) {
233         RenderObject* renderer = childNode->renderer();
234         if (!childNode->isSVGElement() || !static_cast<SVGElement*>(childNode)->isStyled() || !renderer)
235             continue;
236         RenderStyle* style = renderer->style();
237         if (!style || style->display() == NONE || style->visibility() != VISIBLE)
238             continue;
239
240         WindRule newClipRule = style->svgStyle()->clipRule();
241         bool isUseElement = renderer->isSVGShadowTreeRootContainer();
242         if (isUseElement) {
243             SVGUseElement* useElement = static_cast<SVGUseElement*>(childNode);
244             renderer = useElement->rendererClipChild();
245             if (!renderer)
246                 continue;
247             if (!useElement->hasAttribute(SVGNames::clip_ruleAttr))
248                 newClipRule = renderer->style()->svgStyle()->clipRule();
249         }
250
251         // Only shapes, paths and texts are allowed for clipping.
252         if (!renderer->isSVGPath() && !renderer->isSVGText())
253             continue;
254
255         // Save the old RenderStyle of the current object for restoring after drawing
256         // it to the MaskImage. The new intermediate RenderStyle needs to inherit from
257         // the old one.
258         RefPtr<RenderStyle> oldRenderStyle = renderer->style();
259         RefPtr<RenderStyle> newRenderStyle = RenderStyle::clone(oldRenderStyle.get());
260         SVGRenderStyle* svgStyle = newRenderStyle.get()->accessSVGStyle();
261         svgStyle->setFillPaint(SVGRenderStyle::initialFillPaintType(), SVGRenderStyle::initialFillPaintColor(), SVGRenderStyle::initialFillPaintUri());
262         svgStyle->setStrokePaint(SVGRenderStyle::initialStrokePaintType(), SVGRenderStyle::initialStrokePaintColor(), SVGRenderStyle::initialStrokePaintUri());
263         svgStyle->setFillRule(newClipRule);
264         newRenderStyle.get()->setOpacity(1);
265         svgStyle->setFillOpacity(1);
266         svgStyle->setStrokeOpacity(1);
267         svgStyle->setFilterResource(String());
268         svgStyle->setMaskerResource(String());
269
270         // The setStyle() call results in a styleDidChange() call, which in turn invalidations the resources.
271         // As we're mutating the resource on purpose, block updates until we've resetted the style again.
272         m_invalidationBlocked = true;
273         renderer->setStyle(newRenderStyle.release());
274
275         // In the case of a <use> element, we obtained its renderere above, to retrieve its clipRule.
276         // We have to pass the <use> renderer itself to renderSubtreeToImageBuffer() to apply it's x/y/transform/etc. values when rendering.
277         // So if isUseElement is true, refetch the childNode->renderer(), as renderer got overriden above.
278         SVGImageBufferTools::renderSubtreeToImageBuffer(clipperData->clipMaskImage.get(), isUseElement ? childNode->renderer() : renderer, maskContentTransformation);
279
280         renderer->setStyle(oldRenderStyle.release());
281         m_invalidationBlocked = false;
282     }
283
284     return true;
285 }
286
287 void RenderSVGResourceClipper::calculateClipContentRepaintRect()
288 {
289     // This is a rough heuristic to appraise the clip size and doesn't consider clip on clip.
290     for (Node* childNode = node()->firstChild(); childNode; childNode = childNode->nextSibling()) {
291         RenderObject* renderer = childNode->renderer();
292         if (!childNode->isSVGElement() || !static_cast<SVGElement*>(childNode)->isStyled() || !renderer)
293             continue;
294         if (!renderer->isSVGPath() && !renderer->isSVGText() && !renderer->isSVGShadowTreeRootContainer())
295             continue;
296         RenderStyle* style = renderer->style();
297         if (!style || style->display() == NONE || style->visibility() != VISIBLE)
298              continue;
299         m_clipBoundaries.unite(renderer->localToParentTransform().mapRect(renderer->repaintRectInLocalCoordinates()));
300     }
301     m_clipBoundaries = static_cast<SVGClipPathElement*>(node())->animatedLocalTransform().mapRect(m_clipBoundaries);
302 }
303
304 bool RenderSVGResourceClipper::hitTestClipContent(const FloatRect& objectBoundingBox, const FloatPoint& nodeAtPoint)
305 {
306     FloatPoint point = nodeAtPoint;
307     if (!SVGRenderSupport::pointInClippingArea(this, point))
308         return false;
309
310     SVGClipPathElement* clipPathElement = static_cast<SVGClipPathElement*>(node());
311     if (clipPathElement->clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
312         AffineTransform transform;
313         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
314         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
315         point = transform.inverse().mapPoint(point);
316     }
317
318     point = clipPathElement->animatedLocalTransform().inverse().mapPoint(point);
319
320     for (Node* childNode = node()->firstChild(); childNode; childNode = childNode->nextSibling()) {
321         RenderObject* renderer = childNode->renderer();
322         if (!childNode->isSVGElement() || !static_cast<SVGElement*>(childNode)->isStyled() || !renderer)
323             continue;
324         if (!renderer->isSVGPath() && !renderer->isSVGText() && !renderer->isSVGShadowTreeRootContainer())
325             continue;
326         IntPoint hitPoint;
327         HitTestResult result(hitPoint);
328         if (renderer->nodeAtFloatPoint(HitTestRequest(HitTestRequest::SVGClipContent), result, point, HitTestForeground))
329             return true;
330     }
331
332     return false;
333 }
334
335 FloatRect RenderSVGResourceClipper::resourceBoundingBox(RenderObject* object)
336 {
337     // Resource was not layouted yet. Give back the boundingBox of the object.
338     if (selfNeedsLayout())
339         return object->objectBoundingBox();
340     
341     if (m_clipBoundaries.isEmpty())
342         calculateClipContentRepaintRect();
343
344     if (static_cast<SVGClipPathElement*>(node())->clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
345         FloatRect objectBoundingBox = object->objectBoundingBox();
346         AffineTransform transform;
347         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
348         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
349         return transform.mapRect(m_clipBoundaries);
350     }
351
352     return m_clipBoundaries;
353 }
354
355 }
356
357 #endif // ENABLE(SVG)