Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGImage.cpp
1 /*
2  * Copyright (C) 2006 Alexander Kellett <lypanov@kde.org>
3  * Copyright (C) 2006 Apple Inc.
4  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
5  * Copyright (C) 2007, 2008, 2009 Rob Buis <buis@kde.org>
6  * Copyright (C) 2009 Google, Inc.
7  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
8  * Copyright (C) 2010 Patrick Gansterer <paroga@paroga.com>
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 "RenderSVGImage.h"
28
29 #include "FloatQuad.h"
30 #include "GraphicsContext.h"
31 #include "HitTestResult.h"
32 #include "LayoutRepainter.h"
33 #include "PointerEventsHitRules.h"
34 #include "RenderImageResource.h"
35 #include "RenderLayer.h"
36 #include "RenderSVGResource.h"
37 #include "RenderSVGResourceFilter.h"
38 #include "SVGImageElement.h"
39 #include "SVGRenderingContext.h"
40 #include "SVGResources.h"
41 #include "SVGResourcesCache.h"
42 #include <wtf/StackStats.h>
43
44 namespace WebCore {
45
46 RenderSVGImage::RenderSVGImage(SVGImageElement& element, RenderStyle&& style)
47     : RenderSVGModelObject(element, WTFMove(style))
48     , m_needsBoundariesUpdate(true)
49     , m_needsTransformUpdate(true)
50     , m_imageResource(std::make_unique<RenderImageResource>())
51 {
52     imageResource().initialize(*this);
53 }
54
55 RenderSVGImage::~RenderSVGImage() = default;
56
57 void RenderSVGImage::willBeDestroyed()
58 {
59     imageResource().shutdown();
60     RenderSVGModelObject::willBeDestroyed();
61 }
62
63 SVGImageElement& RenderSVGImage::imageElement() const
64 {
65     return downcast<SVGImageElement>(RenderSVGModelObject::element());
66 }
67
68 bool RenderSVGImage::updateImageViewport()
69 {
70     FloatRect oldBoundaries = m_objectBoundingBox;
71     bool updatedViewport = false;
72
73     SVGLengthContext lengthContext(&imageElement());
74     m_objectBoundingBox = FloatRect(imageElement().x().value(lengthContext), imageElement().y().value(lengthContext), imageElement().width().value(lengthContext), imageElement().height().value(lengthContext));
75
76     URL imageSourceURL = document().completeURL(imageElement().imageSourceURL());
77
78     // Images with preserveAspectRatio=none should force non-uniform scaling. This can be achieved
79     // by setting the image's container size to its intrinsic size.
80     // See: http://www.w3.org/TR/SVG/single-page.html, 7.8 The â€˜preserveAspectRatio’ attribute.
81     if (imageElement().preserveAspectRatio().align() == SVGPreserveAspectRatioValue::SVG_PRESERVEASPECTRATIO_NONE) {
82         if (CachedImage* cachedImage = imageResource().cachedImage()) {
83             LayoutSize intrinsicSize = cachedImage->imageSizeForRenderer(nullptr, style().effectiveZoom());
84             if (intrinsicSize != imageResource().imageSize(style().effectiveZoom())) {
85                 imageResource().setContainerContext(roundedIntSize(intrinsicSize), imageSourceURL);
86                 updatedViewport = true;
87             }
88         }
89     }
90
91     if (oldBoundaries != m_objectBoundingBox) {
92         if (!updatedViewport)
93             imageResource().setContainerContext(enclosingIntRect(m_objectBoundingBox).size(), imageSourceURL);
94         updatedViewport = true;
95         m_needsBoundariesUpdate = true;
96     }
97
98     return updatedViewport;
99 }
100
101 void RenderSVGImage::layout()
102 {
103     StackStats::LayoutCheckPoint layoutCheckPoint;
104     ASSERT(needsLayout());
105
106     LayoutRepainter repainter(*this, SVGRenderSupport::checkForSVGRepaintDuringLayout(*this) && selfNeedsLayout());
107     updateImageViewport();
108
109     bool transformOrBoundariesUpdate = m_needsTransformUpdate || m_needsBoundariesUpdate;
110     if (m_needsTransformUpdate) {
111         m_localTransform = imageElement().animatedLocalTransform();
112         m_needsTransformUpdate = false;
113     }
114
115     if (m_needsBoundariesUpdate) {
116         m_repaintBoundingBoxExcludingShadow = m_objectBoundingBox;
117         SVGRenderSupport::intersectRepaintRectWithResources(*this, m_repaintBoundingBoxExcludingShadow);
118
119         m_repaintBoundingBox = m_repaintBoundingBoxExcludingShadow;
120         SVGRenderSupport::intersectRepaintRectWithShadows(*this, m_repaintBoundingBox);
121
122         m_needsBoundariesUpdate = false;
123     }
124
125     // Invalidate all resources of this client if our layout changed.
126     if (everHadLayout() && selfNeedsLayout())
127         SVGResourcesCache::clientLayoutChanged(*this);
128
129     // If our bounds changed, notify the parents.
130     if (transformOrBoundariesUpdate)
131         RenderSVGModelObject::setNeedsBoundariesUpdate();
132
133     repainter.repaintAfterLayout();
134     clearNeedsLayout();
135 }
136
137 void RenderSVGImage::paint(PaintInfo& paintInfo, const LayoutPoint&)
138 {
139     if (paintInfo.context().paintingDisabled() || paintInfo.phase != PaintPhaseForeground
140         || style().visibility() == HIDDEN || !imageResource().cachedImage())
141         return;
142
143     FloatRect boundingBox = repaintRectInLocalCoordinates();
144     if (!SVGRenderSupport::paintInfoIntersectsRepaintRect(boundingBox, m_localTransform, paintInfo))
145         return;
146
147     PaintInfo childPaintInfo(paintInfo);
148     GraphicsContextStateSaver stateSaver(childPaintInfo.context());
149     childPaintInfo.applyTransform(m_localTransform);
150
151     if (childPaintInfo.phase == PaintPhaseForeground) {
152         SVGRenderingContext renderingContext(*this, childPaintInfo);
153
154         if (renderingContext.isRenderingPrepared()) {
155             if (style().svgStyle().bufferedRendering() == BR_STATIC && renderingContext.bufferForeground(m_bufferedForeground))
156                 return;
157
158             paintForeground(childPaintInfo);
159         }
160     }
161
162     if (style().outlineWidth())
163         paintOutline(childPaintInfo, IntRect(boundingBox));
164 }
165
166 void RenderSVGImage::paintForeground(PaintInfo& paintInfo)
167 {
168     RefPtr<Image> image = imageResource().image();
169     if (!image)
170         return;
171
172     FloatRect destRect = m_objectBoundingBox;
173     FloatRect srcRect(0, 0, image->width(), image->height());
174
175     imageElement().preserveAspectRatio().transformRect(destRect, srcRect);
176
177     paintInfo.context().drawImage(*image, destRect, srcRect);
178 }
179
180 void RenderSVGImage::invalidateBufferedForeground()
181 {
182     m_bufferedForeground.reset();
183 }
184
185 bool RenderSVGImage::nodeAtFloatPoint(const HitTestRequest& request, HitTestResult& result, const FloatPoint& pointInParent, HitTestAction hitTestAction)
186 {
187     // We only draw in the forground phase, so we only hit-test then.
188     if (hitTestAction != HitTestForeground)
189         return false;
190
191     PointerEventsHitRules hitRules(PointerEventsHitRules::SVG_IMAGE_HITTESTING, request, style().pointerEvents());
192     bool isVisible = (style().visibility() == VISIBLE);
193     if (isVisible || !hitRules.requireVisible) {
194         FloatPoint localPoint = localToParentTransform().inverse().value_or(AffineTransform()).mapPoint(pointInParent);
195             
196         if (!SVGRenderSupport::pointInClippingArea(*this, localPoint))
197             return false;
198
199         if (hitRules.canHitFill) {
200             if (m_objectBoundingBox.contains(localPoint)) {
201                 updateHitTestResult(result, LayoutPoint(localPoint));
202                 if (result.addNodeToListBasedTestResult(&imageElement(), request, localPoint) == HitTestProgress::Stop)
203                     return true;
204             }
205         }
206     }
207
208     return false;
209 }
210
211 void RenderSVGImage::imageChanged(WrappedImagePtr, const IntRect*)
212 {
213     // The image resource defaults to nullImage until the resource arrives.
214     // This empty image may be cached by SVG resources which must be invalidated.
215     if (auto* resources = SVGResourcesCache::cachedResourcesForRenderer(*this))
216         resources->removeClientFromCache(*this);
217
218     // Eventually notify parent resources, that we've changed.
219     RenderSVGResource::markForLayoutAndParentResourceInvalidation(*this, false);
220
221     // Update the SVGImageCache sizeAndScales entry in case image loading finished after layout.
222     // (https://bugs.webkit.org/show_bug.cgi?id=99489)
223     m_objectBoundingBox = FloatRect();
224     updateImageViewport();
225
226     invalidateBufferedForeground();
227
228     repaint();
229 }
230
231 void RenderSVGImage::addFocusRingRects(Vector<LayoutRect>& rects, const LayoutPoint&, const RenderLayerModelObject*)
232 {
233     // this is called from paint() after the localTransform has already been applied
234     LayoutRect contentRect = LayoutRect(repaintRectInLocalCoordinates());
235     if (!contentRect.isEmpty())
236         rects.append(contentRect);
237 }
238
239 } // namespace WebCore