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