e3d13587431526eee746d4d3146aaf837b3730c8
[WebKit-https.git] / Source / WebCore / svg / SVGElement.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2007 Rob Buis <buis@kde.org>
4  * Copyright (C) 2009-2016 Apple Inc. All rights reserved.
5  * Copyright (C) 2013 Samsung Electronics. 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 #pragma once
24
25 #include "SVGAnimatedString.h"
26 #include "SVGLangSpace.h"
27 #include "SVGLocatable.h"
28 #include "SVGNames.h"
29 #include "SVGParsingError.h"
30 #include "SVGPropertyInfo.h"
31 #include "StyledElement.h"
32 #include <wtf/HashMap.h>
33 #include <wtf/HashSet.h>
34
35 namespace WebCore {
36
37 class AffineTransform;
38 class CSSStyleDeclaration;
39 class DeprecatedCSSOMValue;
40 class Document;
41 class SVGAttributeToPropertyMap;
42 class SVGDocumentExtensions;
43 class SVGElementRareData;
44 class SVGSVGElement;
45 class SVGUseElement;
46
47 void mapAttributeToCSSProperty(HashMap<AtomicStringImpl*, CSSPropertyID>* propertyNameToIdMap, const QualifiedName& attrName);
48
49 class SVGElement : public StyledElement, public SVGLangSpace {
50     WTF_MAKE_ISO_ALLOCATED(SVGElement);
51 public:
52     bool isOutermostSVGSVGElement() const;
53
54     SVGSVGElement* ownerSVGElement() const;
55     SVGElement* viewportElement() const;
56
57     String title() const override;
58     static bool isAnimatableCSSProperty(const QualifiedName&);
59     bool isPresentationAttributeWithSVGDOM(const QualifiedName&);
60     bool isKnownAttribute(const QualifiedName&);
61     RefPtr<DeprecatedCSSOMValue> getPresentationAttribute(const String& name);
62     virtual bool supportsMarkers() const { return false; }
63     bool hasRelativeLengths() const { return !m_elementsWithRelativeLengths.isEmpty(); }
64     virtual bool needsPendingResourceHandling() const { return true; }
65     bool instanceUpdatesBlocked() const;
66     void setInstanceUpdatesBlocked(bool);
67     virtual AffineTransform localCoordinateSpaceTransform(SVGLocatable::CTMScope) const;
68
69     virtual bool isSVGGraphicsElement() const { return false; }
70     virtual bool isFilterEffect() const { return false; }
71     virtual bool isGradientStop() const { return false; }
72     virtual bool isTextContent() const { return false; }
73     virtual bool isSMILElement() const { return false; }
74
75     // For SVGTests
76     virtual bool isValid() const { return true; }
77
78     virtual void svgAttributeChanged(const QualifiedName&);
79
80     Vector<AnimatedPropertyType> animatedPropertyTypesForAttribute(const QualifiedName&);
81
82     void sendSVGLoadEventIfPossible(bool sendParentLoadEvents = false);
83     void sendSVGLoadEventIfPossibleAsynchronously();
84     void svgLoadEventTimerFired();
85     virtual Timer* svgLoadEventTimer();
86
87     virtual AffineTransform* supplementalTransform() { return nullptr; }
88
89     void invalidateSVGAttributes() { ensureUniqueElementData().setAnimatedSVGAttributesAreDirty(true); }
90     void invalidateSVGPresentationAttributeStyle()
91     {
92         ensureUniqueElementData().setPresentationAttributeStyleIsDirty(true);
93         // Trigger style recalculation for "elements as resource" (e.g. referenced by feImage).
94         invalidateStyle();
95     }
96
97     // The instances of an element are clones made in shadow trees to implement <use>.
98     const HashSet<SVGElement*>& instances() const;
99
100     bool getBoundingBox(FloatRect&, SVGLocatable::StyleUpdateStrategy = SVGLocatable::AllowStyleUpdate);
101
102     SVGElement* correspondingElement() const;
103     RefPtr<SVGUseElement> correspondingUseElement() const;
104
105     void setCorrespondingElement(SVGElement*);
106
107     void synchronizeAnimatedSVGAttribute(const QualifiedName&) const;
108     static void synchronizeAllAnimatedSVGAttribute(SVGElement*);
109  
110     std::optional<ElementStyle> resolveCustomStyle(const RenderStyle& parentStyle, const RenderStyle* shadowHostStyle) override;
111
112     static void synchronizeRequiredFeatures(SVGElement* contextElement);
113     static void synchronizeRequiredExtensions(SVGElement* contextElement);
114     static void synchronizeSystemLanguage(SVGElement* contextElement);
115
116     virtual void synchronizeRequiredFeatures() { }
117     virtual void synchronizeRequiredExtensions() { }
118     virtual void synchronizeSystemLanguage() { }
119
120     static QualifiedName animatableAttributeForName(const AtomicString&);
121 #ifndef NDEBUG
122     bool isAnimatableAttribute(const QualifiedName&) const;
123 #endif
124
125     MutableStyleProperties* animatedSMILStyleProperties() const;
126     MutableStyleProperties& ensureAnimatedSMILStyleProperties();
127     void setUseOverrideComputedStyle(bool);
128
129     virtual bool haveLoadedRequiredResources();
130
131     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) override;
132     bool removeEventListener(const AtomicString& eventType, EventListener&, const ListenerOptions&) override;
133     bool hasFocusEventListeners() const;
134
135     bool hasTagName(const SVGQualifiedName& name) const { return hasLocalName(name.localName()); }
136     int tabIndex() const override;
137
138     void callClearTarget() { clearTarget(); }
139
140     class InstanceUpdateBlocker;
141
142 protected:
143     SVGElement(const QualifiedName&, Document&);
144     virtual ~SVGElement();
145
146     bool isMouseFocusable() const override;
147     bool supportsFocus() const override { return false; }
148
149     bool rendererIsNeeded(const RenderStyle&) override;
150     void parseAttribute(const QualifiedName&, const AtomicString&) override;
151
152     void finishParsingChildren() override;
153     void attributeChanged(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue, AttributeModificationReason = ModifiedDirectly) override;
154     bool childShouldCreateRenderer(const Node&) const override;
155
156     SVGElementRareData& ensureSVGRareData();
157
158     void reportAttributeParsingError(SVGParsingError, const QualifiedName&, const AtomicString&);
159     static CSSPropertyID cssPropertyIdForSVGAttributeName(const QualifiedName&);
160
161     bool isPresentationAttribute(const QualifiedName&) const override;
162     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
163     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
164     void removedFromAncestor(RemovalType, ContainerNode&) override;
165     void childrenChanged(const ChildChange&) override;
166     virtual bool selfHasRelativeLengths() const { return false; }
167     void updateRelativeLengthsInformation() { updateRelativeLengthsInformation(selfHasRelativeLengths(), this); }
168     void updateRelativeLengthsInformation(bool hasRelativeLengths, SVGElement*);
169
170     void willRecalcStyle(Style::Change) override;
171
172     class InstanceInvalidationGuard;
173
174 private:
175     const RenderStyle* computedStyle(PseudoId = PseudoId::None) final;
176
177     virtual void clearTarget() { }
178
179     void buildPendingResourcesIfNeeded();
180     void accessKeyAction(bool sendMouseEvents) override;
181
182 #ifndef NDEBUG
183     virtual bool filterOutAnimatableAttribute(const QualifiedName&) const;
184 #endif
185
186     void invalidateInstances();
187
188     std::unique_ptr<SVGElementRareData> m_svgRareData;
189
190     HashSet<SVGElement*> m_elementsWithRelativeLengths;
191
192     BEGIN_DECLARE_ANIMATED_PROPERTIES_BASE(SVGElement)
193         DECLARE_ANIMATED_STRING(ClassName, className)
194     END_DECLARE_ANIMATED_PROPERTIES
195
196 };
197
198 class SVGElement::InstanceInvalidationGuard {
199 public:
200     InstanceInvalidationGuard(SVGElement&);
201     ~InstanceInvalidationGuard();
202 private:
203     SVGElement& m_element;
204 };
205
206 class SVGElement::InstanceUpdateBlocker {
207 public:
208     InstanceUpdateBlocker(SVGElement&);
209     ~InstanceUpdateBlocker();
210 private:
211     SVGElement& m_element;
212 };
213
214 struct SVGAttributeHashTranslator {
215     static unsigned hash(const QualifiedName& key)
216     {
217         if (key.hasPrefix()) {
218             QualifiedNameComponents components = { nullAtom().impl(), key.localName().impl(), key.namespaceURI().impl() };
219             return hashComponents(components);
220         }
221         return DefaultHash<QualifiedName>::Hash::hash(key);
222     }
223     static bool equal(const QualifiedName& a, const QualifiedName& b) { return a.matches(b); }
224 };
225
226 inline SVGElement::InstanceInvalidationGuard::InstanceInvalidationGuard(SVGElement& element)
227     : m_element(element)
228 {
229 }
230
231 inline SVGElement::InstanceInvalidationGuard::~InstanceInvalidationGuard()
232 {
233     m_element.invalidateInstances();
234 }
235
236 inline SVGElement::InstanceUpdateBlocker::InstanceUpdateBlocker(SVGElement& element)
237     : m_element(element)
238 {
239     m_element.setInstanceUpdatesBlocked(true);
240 }
241
242 inline SVGElement::InstanceUpdateBlocker::~InstanceUpdateBlocker()
243 {
244     m_element.setInstanceUpdatesBlocked(false);
245 }
246
247 inline bool Node::hasTagName(const SVGQualifiedName& name) const
248 {
249     return isSVGElement() && downcast<SVGElement>(*this).hasTagName(name);
250 }
251
252 } // namespace WebCore
253
254 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::SVGElement)
255     static bool isType(const WebCore::Node& node) { return node.isSVGElement(); }
256 SPECIALIZE_TYPE_TRAITS_END()
257
258 #include "SVGElementTypeHelpers.h"