ea936a4dc82ebaa4a6ad925ea7acc6834f9407d0
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGResourcePattern.cpp
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #include "config.h"
22 #include "RenderSVGResourcePattern.h"
23
24 #include "ElementIterator.h"
25 #include "FrameView.h"
26 #include "GraphicsContext.h"
27 #include "RenderSVGRoot.h"
28 #include "SVGFitToViewBox.h"
29 #include "SVGRenderingContext.h"
30 #include "SVGResources.h"
31 #include "SVGResourcesCache.h"
32
33 namespace WebCore {
34
35 RenderSVGResourcePattern::RenderSVGResourcePattern(SVGPatternElement& element, RenderStyle&& style)
36     : RenderSVGResourceContainer(element, WTFMove(style))
37     , m_shouldCollectPatternAttributes(true)
38 {
39 }
40
41 SVGPatternElement& RenderSVGResourcePattern::patternElement() const
42 {
43     return downcast<SVGPatternElement>(RenderSVGResourceContainer::element());
44 }
45
46 void RenderSVGResourcePattern::removeAllClientsFromCache(bool markForInvalidation)
47 {
48     m_patternMap.clear();
49     m_shouldCollectPatternAttributes = true;
50     markAllClientsForInvalidation(markForInvalidation ? RepaintInvalidation : ParentOnlyInvalidation);
51 }
52
53 void RenderSVGResourcePattern::removeClientFromCache(RenderElement& client, bool markForInvalidation)
54 {
55     m_patternMap.remove(&client);
56     markClientForInvalidation(client, markForInvalidation ? RepaintInvalidation : ParentOnlyInvalidation);
57 }
58
59 void RenderSVGResourcePattern::collectPatternAttributes(PatternAttributes& attributes) const
60 {
61     const RenderSVGResourcePattern* current = this;
62
63     while (current) {
64         const SVGPatternElement& pattern = current->patternElement();
65         pattern.collectPatternAttributes(attributes);
66
67         auto* resources = SVGResourcesCache::cachedResourcesForRenderer(*current);
68         current = resources ? downcast<RenderSVGResourcePattern>(resources->linkedResource()) : nullptr;
69     }
70 }
71
72 PatternData* RenderSVGResourcePattern::buildPattern(RenderElement& renderer, unsigned short resourceMode, GraphicsContext& context)
73 {
74     ASSERT(!m_shouldCollectPatternAttributes);
75
76     PatternData* currentData = m_patternMap.get(&renderer);
77     if (currentData && currentData->pattern)
78         return currentData;
79
80     // If we couldn't determine the pattern content element root, stop here.
81     if (!m_attributes.patternContentElement())
82         return nullptr;
83
84     // An empty viewBox disables rendering.
85     if (m_attributes.hasViewBox() && m_attributes.viewBox().isEmpty())
86         return nullptr;
87
88     // Compute all necessary transformations to build the tile image & the pattern.
89     FloatRect tileBoundaries;
90     AffineTransform tileImageTransform;
91     if (!buildTileImageTransform(renderer, m_attributes, patternElement(), tileBoundaries, tileImageTransform))
92         return nullptr;
93
94     AffineTransform absoluteTransformIgnoringRotation = SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(renderer);
95
96     // Ignore 2D rotation, as it doesn't affect the size of the tile.
97     SVGRenderingContext::clear2DRotation(absoluteTransformIgnoringRotation);
98     FloatRect absoluteTileBoundaries = absoluteTransformIgnoringRotation.mapRect(tileBoundaries);
99     FloatRect clampedAbsoluteTileBoundaries;
100
101     // Scale the tile size to match the scale level of the patternTransform.
102     absoluteTileBoundaries.scale(static_cast<float>(m_attributes.patternTransform().xScale()),
103         static_cast<float>(m_attributes.patternTransform().yScale()));
104
105     // Build tile image.
106     auto tileImage = createTileImage(m_attributes, tileBoundaries, absoluteTileBoundaries, tileImageTransform, clampedAbsoluteTileBoundaries, context.renderingMode());
107     if (!tileImage)
108         return nullptr;
109
110     const IntSize tileImageSize = tileImage->logicalSize();
111
112     RefPtr<Image> copiedImage = ImageBuffer::sinkIntoImage(WTFMove(tileImage));
113     if (!copiedImage)
114         return nullptr;
115
116     // Build pattern.
117     auto patternData = std::make_unique<PatternData>();
118     patternData->pattern = Pattern::create(copiedImage, true, true);
119
120     // Compute pattern space transformation.
121
122     patternData->transform.translate(tileBoundaries.x(), tileBoundaries.y());
123     patternData->transform.scale(tileBoundaries.width() / tileImageSize.width(), tileBoundaries.height() / tileImageSize.height());
124
125     AffineTransform patternTransform = m_attributes.patternTransform();
126     if (!patternTransform.isIdentity())
127         patternData->transform = patternTransform * patternData->transform;
128
129     // Account for text drawing resetting the context to non-scaled, see SVGInlineTextBox::paintTextWithShadows.
130     if (resourceMode & ApplyToTextMode) {
131         AffineTransform additionalTextTransformation;
132         if (shouldTransformOnTextPainting(renderer, additionalTextTransformation))
133             patternData->transform *= additionalTextTransformation;
134     }
135     patternData->pattern->setPatternSpaceTransform(patternData->transform);
136
137     // Various calls above may trigger invalidations in some fringe cases (ImageBuffer allocation
138     // failures in the SVG image cache for example). To avoid having our PatternData deleted by
139     // removeAllClientsFromCache(), we only make it visible in the cache at the very end.
140     return m_patternMap.set(&renderer, WTFMove(patternData)).iterator->value.get();
141 }
142
143 bool RenderSVGResourcePattern::applyResource(RenderElement& renderer, const RenderStyle& style, GraphicsContext*& context, unsigned short resourceMode)
144 {
145     ASSERT(context);
146     ASSERT(resourceMode != ApplyToDefaultMode);
147
148     if (m_shouldCollectPatternAttributes) {
149         patternElement().synchronizeAnimatedSVGAttribute(anyQName());
150
151         m_attributes = PatternAttributes();
152         collectPatternAttributes(m_attributes);
153         m_shouldCollectPatternAttributes = false;
154     }
155     
156     // Spec: When the geometry of the applicable element has no width or height and objectBoundingBox is specified,
157     // then the given effect (e.g. a gradient or a filter) will be ignored.
158     FloatRect objectBoundingBox = renderer.objectBoundingBox();
159     if (m_attributes.patternUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX && objectBoundingBox.isEmpty())
160         return false;
161
162     PatternData* patternData = buildPattern(renderer, resourceMode, *context);
163     if (!patternData)
164         return false;
165
166     // Draw pattern
167     context->save();
168
169     const SVGRenderStyle& svgStyle = style.svgStyle();
170
171     if (resourceMode & ApplyToFillMode) {
172         context->setAlpha(svgStyle.fillOpacity());
173         context->setFillPattern(*patternData->pattern);
174         context->setFillRule(svgStyle.fillRule());
175     } else if (resourceMode & ApplyToStrokeMode) {
176         if (svgStyle.vectorEffect() == VE_NON_SCALING_STROKE)
177             patternData->pattern->setPatternSpaceTransform(transformOnNonScalingStroke(&renderer, patternData->transform));
178         context->setAlpha(svgStyle.strokeOpacity());
179         context->setStrokePattern(*patternData->pattern);
180         SVGRenderSupport::applyStrokeStyleToContext(context, style, renderer);
181     }
182
183     if (resourceMode & ApplyToTextMode) {
184         if (resourceMode & ApplyToFillMode) {
185             context->setTextDrawingMode(TextModeFill);
186
187 #if USE(CG)
188             context->applyFillPattern();
189 #endif
190         } else if (resourceMode & ApplyToStrokeMode) {
191             context->setTextDrawingMode(TextModeStroke);
192
193 #if USE(CG)
194             context->applyStrokePattern();
195 #endif
196         }
197     }
198
199     return true;
200 }
201
202 void RenderSVGResourcePattern::postApplyResource(RenderElement&, GraphicsContext*& context, unsigned short resourceMode, const Path* path, const RenderSVGShape* shape)
203 {
204     ASSERT(context);
205     ASSERT(resourceMode != ApplyToDefaultMode);
206
207     if (resourceMode & ApplyToFillMode) {
208         if (path)
209             context->fillPath(*path);
210         else if (shape)
211             shape->fillShape(*context);
212     }
213     if (resourceMode & ApplyToStrokeMode) {
214         if (path)
215             context->strokePath(*path);
216         else if (shape)
217             shape->strokeShape(*context);
218     }
219
220     context->restore();
221 }
222
223 static inline FloatRect calculatePatternBoundaries(const PatternAttributes& attributes,
224                                                    const FloatRect& objectBoundingBox,
225                                                    const SVGPatternElement& patternElement)
226 {
227     return SVGLengthContext::resolveRectangle(&patternElement, attributes.patternUnits(), objectBoundingBox, attributes.x(), attributes.y(), attributes.width(), attributes.height());
228 }
229
230 bool RenderSVGResourcePattern::buildTileImageTransform(RenderElement& renderer,
231                                                        const PatternAttributes& attributes,
232                                                        const SVGPatternElement& patternElement,
233                                                        FloatRect& patternBoundaries,
234                                                        AffineTransform& tileImageTransform) const
235 {
236     FloatRect objectBoundingBox = renderer.objectBoundingBox();
237     patternBoundaries = calculatePatternBoundaries(attributes, objectBoundingBox, patternElement); 
238     if (patternBoundaries.width() <= 0 || patternBoundaries.height() <= 0)
239         return false;
240
241     AffineTransform viewBoxCTM = SVGFitToViewBox::viewBoxToViewTransform(attributes.viewBox(), attributes.preserveAspectRatio(), patternBoundaries.width(), patternBoundaries.height());
242
243     // Apply viewBox/objectBoundingBox transformations.
244     if (!viewBoxCTM.isIdentity())
245         tileImageTransform = viewBoxCTM;
246     else if (attributes.patternContentUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX)
247         tileImageTransform.scale(objectBoundingBox.width(), objectBoundingBox.height());
248
249     return true;
250 }
251
252 std::unique_ptr<ImageBuffer> RenderSVGResourcePattern::createTileImage(const PatternAttributes& attributes, const FloatRect& tileBoundaries, const FloatRect& absoluteTileBoundaries, const AffineTransform& tileImageTransform, FloatRect& clampedAbsoluteTileBoundaries, RenderingMode renderingMode) const
253 {
254     clampedAbsoluteTileBoundaries = ImageBuffer::clampedRect(absoluteTileBoundaries);
255     auto tileImage = SVGRenderingContext::createImageBuffer(absoluteTileBoundaries, clampedAbsoluteTileBoundaries, ColorSpaceSRGB, renderingMode);
256     if (!tileImage)
257         return nullptr;
258
259     GraphicsContext& tileImageContext = tileImage->context();
260
261     // The image buffer represents the final rendered size, so the content has to be scaled (to avoid pixelation).
262     tileImageContext.scale(FloatSize(clampedAbsoluteTileBoundaries.width() / tileBoundaries.width(),
263                                       clampedAbsoluteTileBoundaries.height() / tileBoundaries.height()));
264
265     // Apply tile image transformations.
266     if (!tileImageTransform.isIdentity())
267         tileImageContext.concatCTM(tileImageTransform);
268
269     AffineTransform contentTransformation;
270     if (attributes.patternContentUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX)
271         contentTransformation = tileImageTransform;
272
273     // Draw the content into the ImageBuffer.
274     for (auto& child : childrenOfType<SVGElement>(*attributes.patternContentElement())) {
275         if (!child.renderer())
276             continue;
277         if (child.renderer()->needsLayout())
278             return nullptr;
279         SVGRenderingContext::renderSubtreeToImageBuffer(tileImage.get(), *child.renderer(), contentTransformation);
280     }
281
282     return tileImage;
283 }
284
285 }