Use -webkit-clip-path shapes to clip SVG elements
[WebKit-https.git] / Source / WebCore / rendering / svg / SVGRenderingContext.cpp
1 /*
2  * Copyright (C) 2007, 2008 Rob Buis <buis@kde.org>
3  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
4  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2009 Google, Inc.  All rights reserved.
6  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
7  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #include "config.h"
26
27 #if ENABLE(SVG)
28 #include "SVGRenderingContext.h"
29
30 #include "BasicShapes.h"
31 #include "Frame.h"
32 #include "FrameView.h"
33 #include "RenderSVGResource.h"
34 #include "RenderSVGResourceClipper.h"
35 #include "RenderSVGResourceFilter.h"
36 #include "RenderSVGResourceMasker.h"
37 #include "SVGResources.h"
38 #include "SVGResourcesCache.h"
39
40 static int kMaxImageBufferSize = 4096;
41
42 namespace WebCore {
43
44 static inline bool isRenderingMaskImage(RenderObject* object)
45 {
46     if (object->frame() && object->frame()->view())
47         return object->frame()->view()->paintBehavior() & PaintBehaviorRenderingSVGMask;
48     return false;
49 }
50
51 SVGRenderingContext::~SVGRenderingContext()
52 {
53     // Fast path if we don't need to restore anything.
54     if (!(m_renderingFlags & ActionsNeeded))
55         return;
56
57     ASSERT(m_object && m_paintInfo);
58
59 #if ENABLE(FILTERS)
60     if (m_renderingFlags & EndFilterLayer) {
61         ASSERT(m_filter);
62         m_filter->postApplyResource(static_cast<RenderSVGShape*>(m_object), m_paintInfo->context, ApplyToDefaultMode, 0, 0);
63         m_paintInfo->context = m_savedContext;
64     }
65 #endif
66
67     if (m_renderingFlags & EndOpacityLayer)
68         m_paintInfo->context->endTransparencyLayer();
69
70     if (m_renderingFlags & EndShadowLayer)
71         m_paintInfo->context->endTransparencyLayer();
72
73     if (m_renderingFlags & RestoreGraphicsContext)
74         m_paintInfo->context->restore();
75 }
76
77 void SVGRenderingContext::prepareToRenderSVGContent(RenderObject* object, PaintInfo& paintInfo, NeedsGraphicsContextSave needsGraphicsContextSave)
78 {
79     ASSERT(object);
80
81 #ifndef NDEBUG
82     // This function must not be called twice!
83     ASSERT(!(m_renderingFlags & PrepareToRenderSVGContentWasCalled));
84     m_renderingFlags |= PrepareToRenderSVGContentWasCalled;
85 #endif
86
87     m_object = object;
88     m_paintInfo = &paintInfo;
89 #if ENABLE(FILTERS)
90     m_filter = 0;
91 #endif
92
93     // We need to save / restore the context even if the initialization failed.
94     if (needsGraphicsContextSave == SaveGraphicsContext) {
95         m_paintInfo->context->save();
96         m_renderingFlags |= RestoreGraphicsContext;
97     }
98
99     RenderStyle* style = m_object->style();
100     ASSERT(style);
101
102     const SVGRenderStyle* svgStyle = style->svgStyle();
103     ASSERT(svgStyle);
104
105     // Setup transparency layers before setting up SVG resources!
106     bool isRenderingMask = isRenderingMaskImage(m_object);
107     float opacity = isRenderingMask ? 1 : style->opacity();
108     const ShadowData* shadow = svgStyle->shadow();
109     if (opacity < 1 || shadow) {
110         FloatRect repaintRect = m_object->repaintRectInLocalCoordinates();
111
112         if (opacity < 1) {
113             m_paintInfo->context->clip(repaintRect);
114             m_paintInfo->context->beginTransparencyLayer(opacity);
115             m_renderingFlags |= EndOpacityLayer;
116         }
117
118         if (shadow) {
119             m_paintInfo->context->clip(repaintRect);
120             m_paintInfo->context->setShadow(IntSize(roundToInt(shadow->x()), roundToInt(shadow->y())), shadow->blur(), shadow->color(), style->colorSpace());
121             m_paintInfo->context->beginTransparencyLayer(1);
122             m_renderingFlags |= EndShadowLayer;
123         }
124     }
125
126     BasicShape* clipShape = style->clipPath();
127     if (clipShape) {
128         // FIXME: Investigate if it is better to store and update a Path object in RenderStyle.
129         // https://bugs.webkit.org/show_bug.cgi?id=95619
130         Path clipPath;
131         clipShape->path(clipPath, object->objectBoundingBox());
132         m_paintInfo->context->clipPath(clipPath, clipShape->windRule());
133     }
134
135     SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(m_object);
136     if (!resources) {
137 #if ENABLE(FILTERS)
138         if (svgStyle->hasFilter())
139             return;
140 #endif
141         m_renderingFlags |= RenderingPrepared;
142         return;
143     }
144
145     if (!isRenderingMask) {
146         if (RenderSVGResourceMasker* masker = resources->masker()) {
147             if (!masker->applyResource(m_object, style, m_paintInfo->context, ApplyToDefaultMode))
148                 return;
149         }
150     }
151
152     RenderSVGResourceClipper* clipper = resources->clipper();
153     if (!clipShape && clipper) {
154         if (!clipper->applyResource(m_object, style, m_paintInfo->context, ApplyToDefaultMode))
155             return;
156     }
157
158 #if ENABLE(FILTERS)
159     if (!isRenderingMask) {
160         m_filter = resources->filter();
161         if (m_filter) {
162             m_savedContext = m_paintInfo->context;
163             // Return with false here may mean that we don't need to draw the content
164             // (because it was either drawn before or empty) but we still need to apply the filter.
165             m_renderingFlags |= EndFilterLayer;
166             if (!m_filter->applyResource(m_object, style, m_paintInfo->context, ApplyToDefaultMode))
167                 return;
168         }
169     }
170 #endif
171
172     m_renderingFlags |= RenderingPrepared;
173 }
174
175 static AffineTransform& currentContentTransformation()
176 {
177     DEFINE_STATIC_LOCAL(AffineTransform, s_currentContentTransformation, ());
178     return s_currentContentTransformation;
179 }
180
181 float SVGRenderingContext::calculateScreenFontSizeScalingFactor(const RenderObject* renderer)
182 {
183     ASSERT(renderer);
184
185     AffineTransform ctm;
186     calculateTransformationToOutermostSVGCoordinateSystem(renderer, ctm);
187     return narrowPrecisionToFloat(sqrt((pow(ctm.xScale(), 2) + pow(ctm.yScale(), 2)) / 2));
188 }
189
190 void SVGRenderingContext::calculateTransformationToOutermostSVGCoordinateSystem(const RenderObject* renderer, AffineTransform& absoluteTransform)
191 {
192     const RenderObject* current = renderer;
193     ASSERT(current);
194
195     absoluteTransform = currentContentTransformation();
196     while (current) {
197         absoluteTransform = current->localToParentTransform() * absoluteTransform;
198         if (current->isSVGRoot())
199             break;
200         current = current->parent();
201     }
202 }
203
204 bool SVGRenderingContext::createImageBuffer(const FloatRect& targetRect, const AffineTransform& absoluteTransform, OwnPtr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
205 {
206     IntRect paintRect = calculateImageBufferRect(targetRect, absoluteTransform);
207     // Don't create empty ImageBuffers.
208     if (paintRect.isEmpty())
209         return false;
210
211     IntSize clampedSize = clampedAbsoluteSize(paintRect.size());
212     OwnPtr<ImageBuffer> image = ImageBuffer::create(clampedSize, 1, colorSpace, renderingMode);
213     if (!image)
214         return false;
215
216     GraphicsContext* imageContext = image->context();
217     ASSERT(imageContext);
218
219     imageContext->scale(FloatSize(static_cast<float>(clampedSize.width()) / paintRect.width(),
220                                   static_cast<float>(clampedSize.height()) / paintRect.height()));
221     imageContext->translate(-paintRect.x(), -paintRect.y());
222     imageContext->concatCTM(absoluteTransform);
223
224     imageBuffer = image.release();
225     return true;
226 }
227
228 bool SVGRenderingContext::createImageBufferForPattern(const FloatRect& absoluteTargetRect, const FloatRect& clampedAbsoluteTargetRect, OwnPtr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
229 {
230     IntSize imageSize(roundedIntSize(clampedAbsoluteTargetRect.size()));
231     IntSize unclampedImageSize(roundedIntSize(absoluteTargetRect.size()));
232
233     // Don't create empty ImageBuffers.
234     if (imageSize.isEmpty())
235         return false;
236
237     OwnPtr<ImageBuffer> image = ImageBuffer::create(imageSize, 1, colorSpace, renderingMode);
238     if (!image)
239         return false;
240
241     GraphicsContext* imageContext = image->context();
242     ASSERT(imageContext);
243
244     // Compensate rounding effects, as the absolute target rect is using floating-point numbers and the image buffer size is integer.
245     imageContext->scale(FloatSize(unclampedImageSize.width() / absoluteTargetRect.width(), unclampedImageSize.height() / absoluteTargetRect.height()));
246
247     imageBuffer = image.release();
248     return true;
249 }
250
251 void SVGRenderingContext::renderSubtreeToImageBuffer(ImageBuffer* image, RenderObject* item, const AffineTransform& subtreeContentTransformation)
252 {
253     ASSERT(item);
254     ASSERT(image);
255     ASSERT(image->context());
256
257     PaintInfo info(image->context(), PaintInfo::infiniteRect(), PaintPhaseForeground, 0, 0, 0, 0);
258
259     AffineTransform& contentTransformation = currentContentTransformation();
260     AffineTransform savedContentTransformation = contentTransformation;
261     contentTransformation = subtreeContentTransformation * contentTransformation;
262
263     ASSERT(!item->needsLayout());
264     item->paint(info, IntPoint());
265
266     contentTransformation = savedContentTransformation;
267 }
268
269 void SVGRenderingContext::clipToImageBuffer(GraphicsContext* context, const AffineTransform& absoluteTransform, const FloatRect& targetRect, OwnPtr<ImageBuffer>& imageBuffer, bool safeToClear)
270 {
271     ASSERT(context);
272     ASSERT(imageBuffer);
273
274     FloatRect absoluteTargetRect = calculateImageBufferRect(targetRect, absoluteTransform);
275
276     // The mask image has been created in the absolute coordinate space, as the image should not be scaled.
277     // So the actual masking process has to be done in the absolute coordinate space as well.
278     context->concatCTM(absoluteTransform.inverse());
279     context->clipToImageBuffer(imageBuffer.get(), absoluteTargetRect);
280     context->concatCTM(absoluteTransform);
281
282     // When nesting resources, with objectBoundingBox as content unit types, there's no use in caching the
283     // resulting image buffer as the parent resource already caches the result.
284     if (safeToClear && !currentContentTransformation().isIdentity())
285         imageBuffer.clear();
286 }
287
288 FloatRect SVGRenderingContext::clampedAbsoluteTargetRect(const FloatRect& absoluteTargetRect)
289 {
290     const FloatSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
291     return FloatRect(absoluteTargetRect.location(), absoluteTargetRect.size().shrunkTo(maxImageBufferSize));
292 }
293
294 IntSize SVGRenderingContext::clampedAbsoluteSize(const IntSize& absoluteSize)
295 {
296     const IntSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
297     return absoluteSize.shrunkTo(maxImageBufferSize);
298 }
299
300 void SVGRenderingContext::clear2DRotation(AffineTransform& transform)
301 {
302     AffineTransform::DecomposedType decomposition;
303     transform.decompose(decomposition);
304     decomposition.angle = 0;
305     transform.recompose(decomposition);
306 }
307
308 }
309
310 #endif