a16c909e04a674d2faeb6266c3bb612c61ee67ff
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGResourceGradient.cpp
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2008 Eric Seidel <eric@webkit.org>
4  * Copyright (C) 2008 Dirk Schulze <krit@webkit.org>
5  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include "config.h"
24 #include "RenderSVGResourceGradient.h"
25
26 #include "GradientAttributes.h"
27 #include "GraphicsContext.h"
28 #include "RenderSVGText.h"
29 #include "SVGRenderingContext.h"
30
31 namespace WebCore {
32
33 RenderSVGResourceGradient::RenderSVGResourceGradient(SVGGradientElement& node, Ref<RenderStyle>&& style)
34     : RenderSVGResourceContainer(node, WTFMove(style))
35     , m_shouldCollectGradientAttributes(true)
36 #if USE(CG)
37     , m_savedContext(0)
38 #endif
39 {
40 }
41
42 void RenderSVGResourceGradient::removeAllClientsFromCache(bool markForInvalidation)
43 {
44     m_gradientMap.clear();
45     m_shouldCollectGradientAttributes = true;
46     markAllClientsForInvalidation(markForInvalidation ? RepaintInvalidation : ParentOnlyInvalidation);
47 }
48
49 void RenderSVGResourceGradient::removeClientFromCache(RenderElement& client, bool markForInvalidation)
50 {
51     m_gradientMap.remove(&client);
52     markClientForInvalidation(client, markForInvalidation ? RepaintInvalidation : ParentOnlyInvalidation);
53 }
54
55 #if USE(CG)
56 static inline bool createMaskAndSwapContextForTextGradient(GraphicsContext*& context, GraphicsContext*& savedContext, std::unique_ptr<ImageBuffer>& imageBuffer, RenderObject* object)
57 {
58     auto* textRootBlock = RenderSVGText::locateRenderSVGTextAncestor(*object);
59     ASSERT(textRootBlock);
60
61     AffineTransform absoluteTransform = SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(*textRootBlock);
62     FloatRect repaintRect = textRootBlock->repaintRectInLocalCoordinates();
63
64     auto maskImage = SVGRenderingContext::createImageBuffer(repaintRect, absoluteTransform, ColorSpaceSRGB, context->renderingMode());
65     if (!maskImage)
66         return false;
67
68     GraphicsContext& maskImageContext = maskImage->context();
69     ASSERT(maskImage);
70     savedContext = context;
71     context = &maskImageContext;
72     imageBuffer = WTFMove(maskImage);
73     return true;
74 }
75
76 static inline AffineTransform clipToTextMask(GraphicsContext& context, std::unique_ptr<ImageBuffer>& imageBuffer, FloatRect& targetRect, RenderObject* object, bool boundingBoxMode, const AffineTransform& gradientTransform)
77 {
78     auto* textRootBlock = RenderSVGText::locateRenderSVGTextAncestor(*object);
79     ASSERT(textRootBlock);
80
81     AffineTransform absoluteTransform = SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(*textRootBlock);
82
83     targetRect = textRootBlock->repaintRectInLocalCoordinates();
84
85     SVGRenderingContext::clipToImageBuffer(context, absoluteTransform, targetRect, imageBuffer, false);
86
87     AffineTransform matrix;
88     if (boundingBoxMode) {
89         FloatRect maskBoundingBox = textRootBlock->objectBoundingBox();
90         matrix.translate(maskBoundingBox.x(), maskBoundingBox.y());
91         matrix.scaleNonUniform(maskBoundingBox.width(), maskBoundingBox.height());
92     }
93     matrix *= gradientTransform;
94     return matrix;
95 }
96 #endif
97
98 bool RenderSVGResourceGradient::applyResource(RenderElement& renderer, const RenderStyle& style, GraphicsContext*& context, unsigned short resourceMode)
99 {
100     ASSERT(context);
101     ASSERT(resourceMode != ApplyToDefaultMode);
102
103     // Be sure to synchronize all SVG properties on the gradientElement _before_ processing any further.
104     // Otherwhise the call to collectGradientAttributes() in createTileImage(), may cause the SVG DOM property
105     // synchronization to kick in, which causes removeAllClientsFromCache() to be called, which in turn deletes our
106     // GradientData object! Leaving out the line below will cause svg/dynamic-updates/SVG*GradientElement-svgdom* to crash.
107     if (m_shouldCollectGradientAttributes) {
108         gradientElement().synchronizeAnimatedSVGAttribute(anyQName());
109         if (!collectGradientAttributes())
110             return false;
111
112         m_shouldCollectGradientAttributes = false;
113     }
114
115     // Spec: When the geometry of the applicable element has no width or height and objectBoundingBox is specified,
116     // then the given effect (e.g. a gradient or a filter) will be ignored.
117     FloatRect objectBoundingBox = renderer.objectBoundingBox();
118     if (gradientUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX && objectBoundingBox.isEmpty())
119         return false;
120
121     auto& gradientData = m_gradientMap.add(&renderer, nullptr).iterator->value;
122     if (!gradientData)
123         gradientData = std::make_unique<GradientData>();
124
125     bool isPaintingText = resourceMode & ApplyToTextMode;
126
127     // Create gradient object
128     if (!gradientData->gradient) {
129         buildGradient(gradientData.get());
130
131         // CG platforms will handle the gradient space transform for text after applying the
132         // resource, so don't apply it here. For non-CG platforms, we want the text bounding
133         // box applied to the gradient space transform now, so the gradient shader can use it.
134 #if USE(CG)
135         if (gradientUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX && !objectBoundingBox.isEmpty() && !isPaintingText) {
136 #else
137         if (gradientUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX && !objectBoundingBox.isEmpty()) {
138 #endif
139             gradientData->userspaceTransform.translate(objectBoundingBox.x(), objectBoundingBox.y());
140             gradientData->userspaceTransform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
141         }
142
143         AffineTransform gradientTransform;
144         calculateGradientTransform(gradientTransform);
145
146         gradientData->userspaceTransform *= gradientTransform;
147         if (isPaintingText) {
148             // Depending on font scaling factor, we may need to rescale the gradient here since
149             // text painting removes the scale factor from the context.
150             AffineTransform additionalTextTransform;
151             if (shouldTransformOnTextPainting(renderer, additionalTextTransform))
152                 gradientData->userspaceTransform *= additionalTextTransform;
153         }
154         gradientData->gradient->setGradientSpaceTransform(gradientData->userspaceTransform);
155     }
156
157     if (!gradientData->gradient)
158         return false;
159
160     // Draw gradient
161     context->save();
162
163     if (isPaintingText) {
164 #if USE(CG)
165         if (!createMaskAndSwapContextForTextGradient(context, m_savedContext, m_imageBuffer, &renderer)) {
166             context->restore();
167             return false;
168         }
169 #endif
170
171         context->setTextDrawingMode(resourceMode & ApplyToFillMode ? TextModeFill : TextModeStroke);
172     }
173
174     const SVGRenderStyle& svgStyle = style.svgStyle();
175
176     if (resourceMode & ApplyToFillMode) {
177         context->setAlpha(svgStyle.fillOpacity());
178         context->setFillGradient(*gradientData->gradient);
179         context->setFillRule(svgStyle.fillRule());
180     } else if (resourceMode & ApplyToStrokeMode) {
181         if (svgStyle.vectorEffect() == VE_NON_SCALING_STROKE)
182             gradientData->gradient->setGradientSpaceTransform(transformOnNonScalingStroke(&renderer, gradientData->userspaceTransform));
183         context->setAlpha(svgStyle.strokeOpacity());
184         context->setStrokeGradient(*gradientData->gradient);
185         SVGRenderSupport::applyStrokeStyleToContext(context, style, renderer);
186     }
187
188     return true;
189 }
190
191 void RenderSVGResourceGradient::postApplyResource(RenderElement& renderer, GraphicsContext*& context, unsigned short resourceMode, const Path* path, const RenderSVGShape* shape)
192 {
193     ASSERT(context);
194     ASSERT(resourceMode != ApplyToDefaultMode);
195
196     if (resourceMode & ApplyToTextMode) {
197 #if USE(CG)
198         // CG requires special handling for gradient on text
199         GradientData* gradientData;
200         if (m_savedContext && (gradientData = m_gradientMap.get(&renderer))) {
201             // Restore on-screen drawing context
202             context = m_savedContext;
203             m_savedContext = 0;
204
205             AffineTransform gradientTransform;
206             calculateGradientTransform(gradientTransform);
207
208             FloatRect targetRect;
209             gradientData->gradient->setGradientSpaceTransform(clipToTextMask(*context, m_imageBuffer, targetRect, &renderer, gradientUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX, gradientTransform));
210             context->setFillGradient(*gradientData->gradient);
211
212             context->fillRect(targetRect);
213             m_imageBuffer.reset();
214         }
215 #else
216         UNUSED_PARAM(renderer);
217 #endif
218     } else {
219         if (resourceMode & ApplyToFillMode) {
220             if (path)
221                 context->fillPath(*path);
222             else if (shape)
223                 shape->fillShape(*context);
224         }
225         if (resourceMode & ApplyToStrokeMode) {
226             if (path)
227                 context->strokePath(*path);
228             else if (shape)
229                 shape->strokeShape(*context);
230         }
231     }
232
233     context->restore();
234 }
235
236 void RenderSVGResourceGradient::addStops(GradientData* gradientData, const Vector<Gradient::ColorStop>& stops) const
237 {
238     ASSERT(gradientData->gradient);
239
240     const Vector<Gradient::ColorStop>::const_iterator end = stops.end();
241     for (Vector<Gradient::ColorStop>::const_iterator it = stops.begin(); it != end; ++it)
242         gradientData->gradient->addColorStop(*it);
243 }
244
245 GradientSpreadMethod RenderSVGResourceGradient::platformSpreadMethodFromSVGType(SVGSpreadMethodType method) const
246 {
247     switch (method) {
248     case SVGSpreadMethodUnknown:
249     case SVGSpreadMethodPad:
250         return SpreadMethodPad;
251     case SVGSpreadMethodReflect:
252         return SpreadMethodReflect;
253     case SVGSpreadMethodRepeat:
254         return SpreadMethodRepeat;
255     }
256
257     ASSERT_NOT_REACHED();
258     return SpreadMethodPad;
259 }
260
261 }