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