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