Use enum classes and OptionSets for PaintPhase and PaintBehavior
[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  * Copyright (C) 2018 Adobe Systems Incorporated. All rights reserved.
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  */
25
26 #include "config.h"
27 #include "SVGRenderingContext.h"
28
29 #include "BasicShapes.h"
30 #include "Frame.h"
31 #include "FrameView.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().contains(PaintBehavior::RenderingSVGMask);
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, RenderSVGResourceMode::ApplyToDefault, nullptr, nullptr);
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 = nullptr;
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     auto& 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(), BlendMode::Normal);
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());
132             m_paintInfo->context().beginTransparencyLayer(1);
133             m_renderingFlags |= EndShadowLayer;
134         }
135     }
136
137     ClipPathOperation* clipPathOperation = style.clipPath();
138     bool hasCSSClipping = is<ShapeClipPathOperation>(clipPathOperation) || is<BoxClipPathOperation>(clipPathOperation);
139     if (hasCSSClipping)
140         SVGRenderSupport::clipContextToCSSClippingArea(m_paintInfo->context(), renderer);
141
142     auto* resources = SVGResourcesCache::cachedResourcesForRenderer(*m_renderer);
143     if (!resources) {
144         if (style.hasReferenceFilterOnly())
145             return;
146
147         m_renderingFlags |= RenderingPrepared;
148         return;
149     }
150
151     if (!isRenderingMask) {
152         if (RenderSVGResourceMasker* masker = resources->masker()) {
153             GraphicsContext* contextPtr = &m_paintInfo->context();
154             bool result = masker->applyResource(*m_renderer, style, contextPtr, RenderSVGResourceMode::ApplyToDefault);
155             m_paintInfo->setContext(*contextPtr);
156             if (!result)
157                 return;
158         }
159     }
160
161     RenderSVGResourceClipper* clipper = resources->clipper();
162     if (!hasCSSClipping && clipper) {
163         GraphicsContext* contextPtr = &m_paintInfo->context();
164         bool result = clipper->applyResource(*m_renderer, style, contextPtr, RenderSVGResourceMode::ApplyToDefault);
165         m_paintInfo->setContext(*contextPtr);
166         if (!result)
167             return;
168     }
169
170     if (!isRenderingMask) {
171         m_filter = resources->filter();
172         if (m_filter) {
173             m_savedContext = &m_paintInfo->context();
174             m_savedPaintRect = m_paintInfo->rect;
175             // Return with false here may mean that we don't need to draw the content
176             // (because it was either drawn before or empty) but we still need to apply the filter.
177             m_renderingFlags |= EndFilterLayer;
178             GraphicsContext* contextPtr = &m_paintInfo->context();
179             bool result = m_filter->applyResource(*m_renderer, style, contextPtr, RenderSVGResourceMode::ApplyToDefault);
180             m_paintInfo->setContext(*contextPtr);
181             if (!result)
182                 return;
183
184             // Since we're caching the resulting bitmap and do not invalidate it on repaint rect
185             // changes, we need to paint the whole filter region. Otherwise, elements not visible
186             // at the time of the initial paint (due to scrolling, window size, etc.) will never
187             // be drawn.
188             m_paintInfo->rect = IntRect(m_filter->drawingRegion(m_renderer));
189         }
190     }
191
192     m_renderingFlags |= RenderingPrepared;
193 }
194
195 static AffineTransform& currentContentTransformation()
196 {
197     static NeverDestroyed<AffineTransform> s_currentContentTransformation;
198     return s_currentContentTransformation;
199 }
200
201 float SVGRenderingContext::calculateScreenFontSizeScalingFactor(const RenderObject& renderer)
202 {
203     AffineTransform ctm = calculateTransformationToOutermostCoordinateSystem(renderer);
204     return narrowPrecisionToFloat(sqrt((pow(ctm.xScale(), 2) + pow(ctm.yScale(), 2)) / 2));
205 }
206
207 AffineTransform SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(const RenderObject& renderer)
208 {
209     AffineTransform absoluteTransform = currentContentTransformation();
210
211     float deviceScaleFactor = renderer.document().deviceScaleFactor();
212     // Walk up the render tree, accumulating SVG transforms.
213     const RenderObject* ancestor = &renderer;
214     while (ancestor) {
215         absoluteTransform = ancestor->localToParentTransform() * absoluteTransform;
216         if (ancestor->isSVGRoot())
217             break;
218         ancestor = ancestor->parent();
219     }
220
221     // Continue walking up the layer tree, accumulating CSS transforms.
222     RenderLayer* layer = ancestor ? ancestor->enclosingLayer() : nullptr;
223     while (layer) {
224         if (TransformationMatrix* layerTransform = layer->transform())
225             absoluteTransform = layerTransform->toAffineTransform() * absoluteTransform;
226
227         // We can stop at compositing layers, to match the backing resolution.
228         if (layer->isComposited())
229             break;
230
231         layer = layer->parent();
232     }
233
234     absoluteTransform.scale(deviceScaleFactor);
235     return absoluteTransform;
236 }
237
238 std::unique_ptr<ImageBuffer> SVGRenderingContext::createImageBuffer(const FloatRect& targetRect, const AffineTransform& absoluteTransform, ColorSpace colorSpace, RenderingMode renderingMode)
239 {
240     IntRect paintRect = calculateImageBufferRect(targetRect, absoluteTransform);
241     // Don't create empty ImageBuffers.
242     if (paintRect.isEmpty())
243         return nullptr;
244
245     FloatSize scale;
246     FloatSize clampedSize = ImageBuffer::clampedSize(paintRect.size(), scale);
247
248     auto imageBuffer = ImageBuffer::create(clampedSize, renderingMode, 1, colorSpace);
249     if (!imageBuffer)
250         return nullptr;
251
252     AffineTransform transform;
253     transform.scale(scale).translate(-paintRect.location()).multiply(absoluteTransform);
254
255     GraphicsContext& imageContext = imageBuffer->context();
256     imageContext.concatCTM(transform);
257
258     return imageBuffer;
259 }
260
261 std::unique_ptr<ImageBuffer> SVGRenderingContext::createImageBuffer(const FloatRect& targetRect, const FloatRect& clampedRect, ColorSpace colorSpace, RenderingMode renderingMode)
262 {
263     IntSize clampedSize = roundedIntSize(clampedRect.size());
264     FloatSize unclampedSize = roundedIntSize(targetRect.size());
265
266     // Don't create empty ImageBuffers.
267     if (clampedSize.isEmpty())
268         return nullptr;
269
270     auto imageBuffer = ImageBuffer::create(clampedSize, renderingMode, 1, colorSpace);
271     if (!imageBuffer)
272         return nullptr;
273
274     GraphicsContext& imageContext = imageBuffer->context();
275
276     // Compensate rounding effects, as the absolute target rect is using floating-point numbers and the image buffer size is integer.
277     imageContext.scale(unclampedSize / targetRect.size());
278
279     return imageBuffer;
280 }
281
282 void SVGRenderingContext::renderSubtreeToImageBuffer(ImageBuffer* image, RenderElement& item, const AffineTransform& subtreeContentTransformation)
283 {
284     ASSERT(image);
285
286     // Rendering into a buffer implies we're being used for masking, clipping, patterns or filters. In each of these
287     // cases we don't want to paint the selection.
288     PaintInfo info(image->context(), LayoutRect::infiniteRect(), PaintPhase::Foreground, PaintBehavior::SkipSelectionHighlight);
289
290     AffineTransform& contentTransformation = currentContentTransformation();
291     AffineTransform savedContentTransformation = contentTransformation;
292     contentTransformation = subtreeContentTransformation * contentTransformation;
293
294     ASSERT(!item.needsLayout());
295     item.paint(info, { });
296
297     contentTransformation = savedContentTransformation;
298 }
299
300 void SVGRenderingContext::clipToImageBuffer(GraphicsContext& context, const AffineTransform& absoluteTransform, const FloatRect& targetRect, std::unique_ptr<ImageBuffer>& imageBuffer, bool safeToClear)
301 {
302     if (!imageBuffer)
303         return;
304
305     FloatRect absoluteTargetRect = calculateImageBufferRect(targetRect, absoluteTransform);
306
307     // The mask image has been created in the absolute coordinate space, as the image should not be scaled.
308     // So the actual masking process has to be done in the absolute coordinate space as well.
309     context.concatCTM(absoluteTransform.inverse().value_or(AffineTransform()));
310     context.clipToImageBuffer(*imageBuffer, absoluteTargetRect);
311     context.concatCTM(absoluteTransform);
312
313     // When nesting resources, with objectBoundingBox as content unit types, there's no use in caching the
314     // resulting image buffer as the parent resource already caches the result.
315     if (safeToClear && !currentContentTransformation().isIdentity())
316         imageBuffer.reset();
317 }
318
319 void SVGRenderingContext::clear2DRotation(AffineTransform& transform)
320 {
321     AffineTransform::DecomposedType decomposition;
322     transform.decompose(decomposition);
323     decomposition.angle = 0;
324     transform.recompose(decomposition);
325 }
326
327 bool SVGRenderingContext::bufferForeground(std::unique_ptr<ImageBuffer>& imageBuffer)
328 {
329     ASSERT(m_paintInfo);
330     ASSERT(is<RenderSVGImage>(*m_renderer));
331     FloatRect boundingBox = m_renderer->objectBoundingBox();
332
333     // Invalidate an existing buffer if the scale is not correct.
334     if (imageBuffer) {
335         AffineTransform transform = m_paintInfo->context().getCTM(GraphicsContext::DefinitelyIncludeDeviceScale);
336         IntSize expandedBoundingBox = expandedIntSize(boundingBox.size());
337         IntSize bufferSize(static_cast<int>(ceil(expandedBoundingBox.width() * transform.xScale())), static_cast<int>(ceil(expandedBoundingBox.height() * transform.yScale())));
338         if (bufferSize != imageBuffer->internalSize())
339             imageBuffer.reset();
340     }
341
342     // Create a new buffer and paint the foreground into it.
343     if (!imageBuffer) {
344         if ((imageBuffer = ImageBuffer::createCompatibleBuffer(expandedIntSize(boundingBox.size()), ColorSpaceSRGB, m_paintInfo->context()))) {
345             GraphicsContext& bufferedRenderingContext = imageBuffer->context();
346             bufferedRenderingContext.translate(-boundingBox.location());
347             PaintInfo bufferedInfo(*m_paintInfo);
348             bufferedInfo.setContext(bufferedRenderingContext);
349             downcast<RenderSVGImage>(*m_renderer).paintForeground(bufferedInfo);
350         } else
351             return false;
352     }
353
354     m_paintInfo->context().drawImageBuffer(*imageBuffer, boundingBox);
355     return true;
356 }
357
358 }