SVGRenderingContext should wrap a RenderElement.
[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 "Page.h"
34 #include "RenderLayer.h"
35 #include "RenderSVGImage.h"
36 #include "RenderSVGResource.h"
37 #include "RenderSVGResourceClipper.h"
38 #include "RenderSVGResourceFilter.h"
39 #include "RenderSVGResourceMasker.h"
40 #include "RenderView.h"
41 #include "SVGResources.h"
42 #include "SVGResourcesCache.h"
43
44 static int kMaxImageBufferSize = 4096;
45
46 namespace WebCore {
47
48 static inline bool isRenderingMaskImage(const RenderObject& object)
49 {
50     return object.view().frameView().paintBehavior() & PaintBehaviorRenderingSVGMask;
51 }
52
53 SVGRenderingContext::~SVGRenderingContext()
54 {
55     // Fast path if we don't need to restore anything.
56     if (!(m_renderingFlags & ActionsNeeded))
57         return;
58
59     ASSERT(m_renderer && m_paintInfo);
60
61 #if ENABLE(FILTERS)
62     if (m_renderingFlags & EndFilterLayer) {
63         ASSERT(m_filter);
64         m_filter->postApplyResource(m_renderer, m_paintInfo->context, ApplyToDefaultMode, 0, 0);
65         m_paintInfo->context = m_savedContext;
66         m_paintInfo->rect = m_savedPaintRect;
67     }
68 #endif
69
70     if (m_renderingFlags & EndOpacityLayer)
71         m_paintInfo->context->endTransparencyLayer();
72
73     if (m_renderingFlags & EndShadowLayer)
74         m_paintInfo->context->endTransparencyLayer();
75
76     if (m_renderingFlags & RestoreGraphicsContext)
77         m_paintInfo->context->restore();
78 }
79
80 void SVGRenderingContext::prepareToRenderSVGContent(RenderElement& renderer, PaintInfo& paintInfo, NeedsGraphicsContextSave needsGraphicsContextSave)
81 {
82 #ifndef NDEBUG
83     // This function must not be called twice!
84     ASSERT(!(m_renderingFlags & PrepareToRenderSVGContentWasCalled));
85     m_renderingFlags |= PrepareToRenderSVGContentWasCalled;
86 #endif
87
88     m_renderer = &renderer;
89     m_paintInfo = &paintInfo;
90 #if ENABLE(FILTERS)
91     m_filter = 0;
92 #endif
93
94     // We need to save / restore the context even if the initialization failed.
95     if (needsGraphicsContextSave == SaveGraphicsContext) {
96         m_paintInfo->context->save();
97         m_renderingFlags |= RestoreGraphicsContext;
98     }
99
100     RenderStyle* style = m_renderer->style();
101     ASSERT(style);
102
103     const SVGRenderStyle* svgStyle = style->svgStyle();
104     ASSERT(svgStyle);
105
106     // Setup transparency layers before setting up SVG resources!
107     bool isRenderingMask = isRenderingMaskImage(*m_renderer);
108     float opacity = isRenderingMask ? 1 : style->opacity();
109     const ShadowData* shadow = svgStyle->shadow();
110     if (opacity < 1 || shadow) {
111         FloatRect repaintRect = m_renderer->repaintRectInLocalCoordinates();
112
113         if (opacity < 1) {
114             m_paintInfo->context->clip(repaintRect);
115             m_paintInfo->context->beginTransparencyLayer(opacity);
116             m_renderingFlags |= EndOpacityLayer;
117         }
118
119         if (shadow) {
120             m_paintInfo->context->clip(repaintRect);
121             m_paintInfo->context->setShadow(IntSize(roundToInt(shadow->x()), roundToInt(shadow->y())), shadow->radius(), shadow->color(), style->colorSpace());
122             m_paintInfo->context->beginTransparencyLayer(1);
123             m_renderingFlags |= EndShadowLayer;
124         }
125     }
126
127     ClipPathOperation* clipPathOperation = style->clipPath();
128     if (clipPathOperation && clipPathOperation->type() == ClipPathOperation::SHAPE) {
129         ShapeClipPathOperation* clipPath = static_cast<ShapeClipPathOperation*>(clipPathOperation);
130         m_paintInfo->context->clipPath(clipPath->path(renderer.objectBoundingBox()), clipPath->windRule());
131     }
132
133     SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(m_renderer);
134     if (!resources) {
135 #if ENABLE(FILTERS)
136         if (svgStyle->hasFilter())
137             return;
138 #endif
139         m_renderingFlags |= RenderingPrepared;
140         return;
141     }
142
143     if (!isRenderingMask) {
144         if (RenderSVGResourceMasker* masker = resources->masker()) {
145             if (!masker->applyResource(m_renderer, style, m_paintInfo->context, ApplyToDefaultMode))
146                 return;
147         }
148     }
149
150     RenderSVGResourceClipper* clipper = resources->clipper();
151     if (!clipPathOperation && clipper) {
152         if (!clipper->applyResource(m_renderer, style, m_paintInfo->context, ApplyToDefaultMode))
153             return;
154     }
155
156 #if ENABLE(FILTERS)
157     if (!isRenderingMask) {
158         m_filter = resources->filter();
159         if (m_filter) {
160             m_savedContext = m_paintInfo->context;
161             m_savedPaintRect = m_paintInfo->rect;
162             // Return with false here may mean that we don't need to draw the content
163             // (because it was either drawn before or empty) but we still need to apply the filter.
164             m_renderingFlags |= EndFilterLayer;
165             if (!m_filter->applyResource(m_renderer, style, m_paintInfo->context, ApplyToDefaultMode))
166                 return;
167
168             // Since we're caching the resulting bitmap and do not invalidate it on repaint rect
169             // changes, we need to paint the whole filter region. Otherwise, elements not visible
170             // at the time of the initial paint (due to scrolling, window size, etc.) will never
171             // be drawn.
172             m_paintInfo->rect = IntRect(m_filter->drawingRegion(m_renderer));
173         }
174     }
175 #endif
176
177     m_renderingFlags |= RenderingPrepared;
178 }
179
180 static AffineTransform& currentContentTransformation()
181 {
182     DEFINE_STATIC_LOCAL(AffineTransform, s_currentContentTransformation, ());
183     return s_currentContentTransformation;
184 }
185
186 float SVGRenderingContext::calculateScreenFontSizeScalingFactor(const RenderObject* renderer)
187 {
188     ASSERT(renderer);
189
190     AffineTransform ctm;
191     calculateTransformationToOutermostCoordinateSystem(renderer, ctm);
192     return narrowPrecisionToFloat(sqrt((pow(ctm.xScale(), 2) + pow(ctm.yScale(), 2)) / 2));
193 }
194
195 void SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(const RenderObject* renderer, AffineTransform& absoluteTransform)
196 {
197     ASSERT(renderer);
198     absoluteTransform = currentContentTransformation();
199
200     float deviceScaleFactor = 1;
201     if (Page* page = renderer->document().page())
202         deviceScaleFactor = page->deviceScaleFactor();
203
204     // Walk up the render tree, accumulating SVG transforms.
205     while (renderer) {
206         absoluteTransform = renderer->localToParentTransform() * absoluteTransform;
207         if (renderer->isSVGRoot())
208             break;
209         renderer = renderer->parent();
210     }
211
212     // Continue walking up the layer tree, accumulating CSS transforms.
213     RenderLayer* layer = renderer ? renderer->enclosingLayer() : 0;
214     while (layer) {
215         if (TransformationMatrix* layerTransform = layer->transform())
216             absoluteTransform = layerTransform->toAffineTransform() * absoluteTransform;
217
218         // We can stop at compositing layers, to match the backing resolution.
219         if (layer->isComposited())
220             break;
221
222         layer = layer->parent();
223     }
224
225     absoluteTransform.scale(deviceScaleFactor);
226 }
227
228 bool SVGRenderingContext::createImageBuffer(const FloatRect& targetRect, const AffineTransform& absoluteTransform, OwnPtr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
229 {
230     IntRect paintRect = calculateImageBufferRect(targetRect, absoluteTransform);
231     // Don't create empty ImageBuffers.
232     if (paintRect.isEmpty())
233         return false;
234
235     IntSize clampedSize = clampedAbsoluteSize(paintRect.size());
236     OwnPtr<ImageBuffer> image = ImageBuffer::create(clampedSize, 1, colorSpace, renderingMode);
237     if (!image)
238         return false;
239
240     GraphicsContext* imageContext = image->context();
241     ASSERT(imageContext);
242
243     imageContext->scale(FloatSize(static_cast<float>(clampedSize.width()) / paintRect.width(),
244                                   static_cast<float>(clampedSize.height()) / paintRect.height()));
245     imageContext->translate(-paintRect.x(), -paintRect.y());
246     imageContext->concatCTM(absoluteTransform);
247
248     imageBuffer = image.release();
249     return true;
250 }
251
252 bool SVGRenderingContext::createImageBufferForPattern(const FloatRect& absoluteTargetRect, const FloatRect& clampedAbsoluteTargetRect, OwnPtr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
253 {
254     IntSize imageSize(roundedIntSize(clampedAbsoluteTargetRect.size()));
255     IntSize unclampedImageSize(roundedIntSize(absoluteTargetRect.size()));
256
257     // Don't create empty ImageBuffers.
258     if (imageSize.isEmpty())
259         return false;
260
261     OwnPtr<ImageBuffer> image = ImageBuffer::create(imageSize, 1, colorSpace, renderingMode);
262     if (!image)
263         return false;
264
265     GraphicsContext* imageContext = image->context();
266     ASSERT(imageContext);
267
268     // Compensate rounding effects, as the absolute target rect is using floating-point numbers and the image buffer size is integer.
269     imageContext->scale(FloatSize(unclampedImageSize.width() / absoluteTargetRect.width(), unclampedImageSize.height() / absoluteTargetRect.height()));
270
271     imageBuffer = image.release();
272     return true;
273 }
274
275 void SVGRenderingContext::renderSubtreeToImageBuffer(ImageBuffer* image, RenderElement& item, const AffineTransform& subtreeContentTransformation)
276 {
277     ASSERT(image);
278     ASSERT(image->context());
279
280     PaintInfo info(image->context(), PaintInfo::infiniteRect(), PaintPhaseForeground, PaintBehaviorNormal);
281
282     AffineTransform& contentTransformation = currentContentTransformation();
283     AffineTransform savedContentTransformation = contentTransformation;
284     contentTransformation = subtreeContentTransformation * contentTransformation;
285
286     ASSERT(!item.needsLayout());
287     item.paint(info, IntPoint());
288
289     contentTransformation = savedContentTransformation;
290 }
291
292 void SVGRenderingContext::clipToImageBuffer(GraphicsContext* context, const AffineTransform& absoluteTransform, const FloatRect& targetRect, OwnPtr<ImageBuffer>& imageBuffer, bool safeToClear)
293 {
294     ASSERT(context);
295     ASSERT(imageBuffer);
296
297     FloatRect absoluteTargetRect = calculateImageBufferRect(targetRect, absoluteTransform);
298
299     // The mask image has been created in the absolute coordinate space, as the image should not be scaled.
300     // So the actual masking process has to be done in the absolute coordinate space as well.
301     context->concatCTM(absoluteTransform.inverse());
302     context->clipToImageBuffer(imageBuffer.get(), absoluteTargetRect);
303     context->concatCTM(absoluteTransform);
304
305     // When nesting resources, with objectBoundingBox as content unit types, there's no use in caching the
306     // resulting image buffer as the parent resource already caches the result.
307     if (safeToClear && !currentContentTransformation().isIdentity())
308         imageBuffer.clear();
309 }
310
311 FloatRect SVGRenderingContext::clampedAbsoluteTargetRect(const FloatRect& absoluteTargetRect)
312 {
313     const FloatSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
314     return FloatRect(absoluteTargetRect.location(), absoluteTargetRect.size().shrunkTo(maxImageBufferSize));
315 }
316
317 IntSize SVGRenderingContext::clampedAbsoluteSize(const IntSize& absoluteSize)
318 {
319     const IntSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
320     return absoluteSize.shrunkTo(maxImageBufferSize);
321 }
322
323 void SVGRenderingContext::clear2DRotation(AffineTransform& transform)
324 {
325     AffineTransform::DecomposedType decomposition;
326     transform.decompose(decomposition);
327     decomposition.angle = 0;
328     transform.recompose(decomposition);
329 }
330
331 bool SVGRenderingContext::bufferForeground(OwnPtr<ImageBuffer>& imageBuffer)
332 {
333     ASSERT(m_paintInfo);
334     ASSERT(m_renderer->isSVGImage());
335     FloatRect boundingBox = m_renderer->objectBoundingBox();
336
337     // Invalidate an existing buffer if the scale is not correct.
338     if (imageBuffer) {
339         AffineTransform transform = m_paintInfo->context->getCTM(GraphicsContext::DefinitelyIncludeDeviceScale);
340         IntSize expandedBoundingBox = expandedIntSize(boundingBox.size());
341         IntSize bufferSize(static_cast<int>(ceil(expandedBoundingBox.width() * transform.xScale())), static_cast<int>(ceil(expandedBoundingBox.height() * transform.yScale())));
342         if (bufferSize != imageBuffer->internalSize())
343             imageBuffer.clear();
344     }
345
346     // Create a new buffer and paint the foreground into it.
347     if (!imageBuffer) {
348         if ((imageBuffer = m_paintInfo->context->createCompatibleBuffer(expandedIntSize(boundingBox.size()), true))) {
349             GraphicsContext* bufferedRenderingContext = imageBuffer->context();
350             bufferedRenderingContext->translate(-boundingBox.x(), -boundingBox.y());
351             PaintInfo bufferedInfo(*m_paintInfo);
352             bufferedInfo.context = bufferedRenderingContext;
353             toRenderSVGImage(m_renderer)->paintForeground(bufferedInfo);
354         } else
355             return false;
356     }
357
358     m_paintInfo->context->drawImageBuffer(imageBuffer.get(), ColorSpaceDeviceRGB, boundingBox);
359     return true;
360 }
361
362 }
363
364 #endif