Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebCore / svg / SVGImageElement.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Rob Buis <buis@kde.org>
4  * Copyright (C) 2006 Alexander Kellett <lypanov@kde.org>
5  * Copyright (C) 2014 Adobe Systems Incorporated. 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 "SVGImageElement.h"
25
26 #include "CSSPropertyNames.h"
27 #include "RenderImageResource.h"
28 #include "RenderSVGImage.h"
29 #include "RenderSVGResource.h"
30 #include "SVGNames.h"
31 #include "XLinkNames.h"
32 #include <wtf/NeverDestroyed.h>
33
34 namespace WebCore {
35
36 // Animated property definitions
37 DEFINE_ANIMATED_LENGTH(SVGImageElement, SVGNames::xAttr, X, x)
38 DEFINE_ANIMATED_LENGTH(SVGImageElement, SVGNames::yAttr, Y, y)
39 DEFINE_ANIMATED_LENGTH(SVGImageElement, SVGNames::widthAttr, Width, width)
40 DEFINE_ANIMATED_LENGTH(SVGImageElement, SVGNames::heightAttr, Height, height)
41 DEFINE_ANIMATED_PRESERVEASPECTRATIO(SVGImageElement, SVGNames::preserveAspectRatioAttr, PreserveAspectRatio, preserveAspectRatio)
42 DEFINE_ANIMATED_STRING(SVGImageElement, XLinkNames::hrefAttr, Href, href)
43 DEFINE_ANIMATED_BOOLEAN(SVGImageElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
44
45 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGImageElement)
46     REGISTER_LOCAL_ANIMATED_PROPERTY(x)
47     REGISTER_LOCAL_ANIMATED_PROPERTY(y)
48     REGISTER_LOCAL_ANIMATED_PROPERTY(width)
49     REGISTER_LOCAL_ANIMATED_PROPERTY(height)
50     REGISTER_LOCAL_ANIMATED_PROPERTY(preserveAspectRatio)
51     REGISTER_LOCAL_ANIMATED_PROPERTY(href)
52     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
53     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGGraphicsElement)
54 END_REGISTER_ANIMATED_PROPERTIES
55
56 inline SVGImageElement::SVGImageElement(const QualifiedName& tagName, Document& document)
57     : SVGGraphicsElement(tagName, document)
58     , m_x(LengthModeWidth)
59     , m_y(LengthModeHeight)
60     , m_width(LengthModeWidth)
61     , m_height(LengthModeHeight)
62     , m_imageLoader(*this)
63 {
64     registerAnimatedPropertiesForSVGImageElement();
65 }
66
67 Ref<SVGImageElement> SVGImageElement::create(const QualifiedName& tagName, Document& document)
68 {
69     return adoptRef(*new SVGImageElement(tagName, document));
70 }
71
72 bool SVGImageElement::hasSingleSecurityOrigin() const
73 {
74     auto* renderer = downcast<RenderSVGImage>(this->renderer());
75     if (!renderer || !renderer->imageResource().cachedImage())
76         return true;
77     auto* image = renderer->imageResource().cachedImage()->image();
78     return !image || image->hasSingleSecurityOrigin();
79 }
80
81 bool SVGImageElement::isSupportedAttribute(const QualifiedName& attrName)
82 {
83     static const auto supportedAttributes = makeNeverDestroyed([] {
84         HashSet<QualifiedName> set;
85         SVGLangSpace::addSupportedAttributes(set);
86         SVGExternalResourcesRequired::addSupportedAttributes(set);
87         SVGURIReference::addSupportedAttributes(set);
88         set.add({ SVGNames::xAttr, SVGNames::yAttr, SVGNames::widthAttr, SVGNames::heightAttr, SVGNames::preserveAspectRatioAttr });
89         return set;
90     }());
91     return supportedAttributes.get().contains<SVGAttributeHashTranslator>(attrName);
92 }
93
94 void SVGImageElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
95 {
96     if (name == SVGNames::preserveAspectRatioAttr) {
97         SVGPreserveAspectRatioValue preserveAspectRatio;
98         preserveAspectRatio.parse(value);
99         setPreserveAspectRatioBaseValue(preserveAspectRatio);
100         return;
101     }
102
103     SVGParsingError parseError = NoError;
104
105     if (name == SVGNames::xAttr)
106         setXBaseValue(SVGLengthValue::construct(LengthModeWidth, value, parseError));
107     else if (name == SVGNames::yAttr)
108         setYBaseValue(SVGLengthValue::construct(LengthModeHeight, value, parseError));
109     else if (name == SVGNames::widthAttr)
110         setWidthBaseValue(SVGLengthValue::construct(LengthModeWidth, value, parseError, ForbidNegativeLengths));
111     else if (name == SVGNames::heightAttr)
112         setHeightBaseValue(SVGLengthValue::construct(LengthModeHeight, value, parseError, ForbidNegativeLengths));
113
114     reportAttributeParsingError(parseError, name, value);
115
116     SVGGraphicsElement::parseAttribute(name, value);
117     SVGExternalResourcesRequired::parseAttribute(name, value);
118     SVGURIReference::parseAttribute(name, value);
119 }
120
121 void SVGImageElement::svgAttributeChanged(const QualifiedName& attrName)
122 {
123     if (!isSupportedAttribute(attrName)) {
124         SVGGraphicsElement::svgAttributeChanged(attrName);
125         return;
126     }
127
128     InstanceInvalidationGuard guard(*this);
129
130     if (attrName == SVGNames::widthAttr
131         || attrName == SVGNames::heightAttr) {
132         invalidateSVGPresentationAttributeStyle();
133         return;
134     }
135
136     bool isLengthAttribute = attrName == SVGNames::xAttr
137                           || attrName == SVGNames::yAttr
138                           || attrName == SVGNames::widthAttr
139                           || attrName == SVGNames::heightAttr;
140
141     if (isLengthAttribute)
142         updateRelativeLengthsInformation();
143
144     if (SVGURIReference::isKnownAttribute(attrName)) {
145         m_imageLoader.updateFromElementIgnoringPreviousError();
146         return;
147     }
148
149     auto* renderer = this->renderer();
150     if (!renderer)
151         return;
152
153     if (isLengthAttribute) {
154         if (downcast<RenderSVGImage>(*renderer).updateImageViewport())
155             RenderSVGResource::markForLayoutAndParentResourceInvalidation(*renderer);
156         return;
157     }
158
159     if (attrName == SVGNames::preserveAspectRatioAttr
160         || SVGLangSpace::isKnownAttribute(attrName)
161         || SVGExternalResourcesRequired::isKnownAttribute(attrName)) {
162         RenderSVGResource::markForLayoutAndParentResourceInvalidation(*renderer);
163         return;
164     }
165
166     ASSERT_NOT_REACHED();
167 }
168
169 RenderPtr<RenderElement> SVGImageElement::createElementRenderer(RenderStyle&& style, const RenderTreePosition&)
170 {
171     return createRenderer<RenderSVGImage>(*this, WTFMove(style));
172 }
173
174 bool SVGImageElement::haveLoadedRequiredResources()
175 {
176     return !externalResourcesRequiredBaseValue() || !m_imageLoader.hasPendingActivity();
177 }
178
179 void SVGImageElement::didAttachRenderers()
180 {
181     if (auto* imageObj = downcast<RenderSVGImage>(renderer())) {
182         if (imageObj->imageResource().cachedImage())
183             return;
184
185         imageObj->imageResource().setCachedImage(m_imageLoader.image());
186     }
187 }
188
189 Node::InsertionNotificationRequest SVGImageElement::insertedInto(ContainerNode& rootParent)
190 {
191     SVGGraphicsElement::insertedInto(rootParent);
192     if (!rootParent.isConnected())
193         return InsertionDone;
194     // Update image loader, as soon as we're living in the tree.
195     // We can only resolve base URIs properly, after that!
196     m_imageLoader.updateFromElement();
197     return InsertionDone;
198 }
199
200 const AtomicString& SVGImageElement::imageSourceURL() const
201 {
202     return getAttribute(XLinkNames::hrefAttr);
203 }
204
205 void SVGImageElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
206 {
207     SVGGraphicsElement::addSubresourceAttributeURLs(urls);
208
209     addSubresourceURL(urls, document().completeURL(href()));
210 }
211
212 void SVGImageElement::didMoveToNewDocument(Document& oldDocument, Document& newDocument)
213 {
214     m_imageLoader.elementDidMoveToNewDocument();
215     SVGGraphicsElement::didMoveToNewDocument(oldDocument, newDocument);
216 }
217
218 }