Optimize hasTagName when called on an HTMLElement
[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, 2014 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 #ifndef SVGElement_h
24 #define SVGElement_h
25
26 #include "CSSPropertyNames.h"
27 #include "SVGAnimatedString.h"
28 #include "SVGElementTypeHelpers.h"
29 #include "SVGLangSpace.h"
30 #include "SVGLocatable.h"
31 #include "SVGParsingError.h"
32 #include "SVGPropertyInfo.h"
33 #include "StyledElement.h"
34 #include "Timer.h"
35 #include <wtf/HashMap.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/PassRefPtr.h>
38
39 namespace WebCore {
40
41 class AffineTransform;
42 class CSSCursorImageValue;
43 class CSSStyleDeclaration;
44 class CSSValue;
45 class Document;
46 class SVGAttributeToPropertyMap;
47 class SVGCursorElement;
48 class SVGDocumentExtensions;
49 class SVGElementInstance;
50 class SVGElementRareData;
51 class SVGSVGElement;
52
53 void mapAttributeToCSSProperty(HashMap<AtomicStringImpl*, CSSPropertyID>* propertyNameToIdMap, const QualifiedName& attrName);
54
55 class SVGElement : public StyledElement, public SVGLangSpace {
56 public:
57     bool isOutermostSVGSVGElement() const;
58
59     String xmlbase() const;
60     void setXmlbase(const String&, ExceptionCode&);
61
62     SVGSVGElement* ownerSVGElement() const;
63     SVGElement* viewportElement() const;
64
65     virtual String title() const override;
66     static bool isAnimatableCSSProperty(const QualifiedName&);
67     bool isKnownAttribute(const QualifiedName&);
68     PassRefPtr<CSSValue> getPresentationAttribute(const String& name);
69     virtual bool supportsMarkers() const { return false; }
70     bool hasRelativeLengths() const { return !m_elementsWithRelativeLengths.isEmpty(); }
71     virtual bool needsPendingResourceHandling() const { return true; }
72     bool instanceUpdatesBlocked() const;
73     void setInstanceUpdatesBlocked(bool);
74     virtual AffineTransform localCoordinateSpaceTransform(SVGLocatable::CTMScope) const;
75
76     SVGDocumentExtensions* accessDocumentSVGExtensions();
77
78     virtual bool isSVGGraphicsElement() const { return false; }
79     virtual bool isFilterEffect() const { return false; }
80     virtual bool isGradientStop() const { return false; }
81     virtual bool isTextContent() const { return false; }
82     virtual bool isSMILElement() const { return false; }
83
84     // For SVGTests
85     virtual bool isValid() const { return true; }
86
87     virtual void svgAttributeChanged(const QualifiedName&);
88
89     virtual void animatedPropertyTypeForAttribute(const QualifiedName&, Vector<AnimatedPropertyType>&);
90
91     void sendSVGLoadEventIfPossible(bool sendParentLoadEvents = false);
92     void sendSVGLoadEventIfPossibleAsynchronously();
93     void svgLoadEventTimerFired(Timer<SVGElement>*);
94     virtual Timer<SVGElement>* svgLoadEventTimer();
95
96     virtual AffineTransform* supplementalTransform() { return 0; }
97
98     void invalidateSVGAttributes() { ensureUniqueElementData().setAnimatedSVGAttributesAreDirty(true); }
99
100     const HashSet<SVGElementInstance*>& instancesForElement() const;
101
102     bool getBoundingBox(FloatRect&, SVGLocatable::StyleUpdateStrategy = SVGLocatable::AllowStyleUpdate);
103
104     void setCursorElement(SVGCursorElement*);
105     void cursorElementRemoved();
106     void setCursorImageValue(CSSCursorImageValue*);
107     void cursorImageValueRemoved();
108
109     SVGElement* correspondingElement();
110     void setCorrespondingElement(SVGElement*);
111
112     void synchronizeAnimatedSVGAttribute(const QualifiedName&) const;
113     static void synchronizeAllAnimatedSVGAttribute(SVGElement*);
114  
115     virtual PassRefPtr<RenderStyle> customStyleForRenderer(RenderStyle& parentStyle) override;
116
117     static void synchronizeRequiredFeatures(SVGElement* contextElement);
118     static void synchronizeRequiredExtensions(SVGElement* contextElement);
119     static void synchronizeSystemLanguage(SVGElement* contextElement);
120
121     virtual void synchronizeRequiredFeatures() { }
122     virtual void synchronizeRequiredExtensions() { }
123     virtual void synchronizeSystemLanguage() { }
124
125     static QualifiedName animatableAttributeForName(const AtomicString&);
126 #ifndef NDEBUG
127     bool isAnimatableAttribute(const QualifiedName&) const;
128 #endif
129
130     MutableStyleProperties* animatedSMILStyleProperties() const;
131     MutableStyleProperties& ensureAnimatedSMILStyleProperties();
132     void setUseOverrideComputedStyle(bool);
133
134     virtual bool haveLoadedRequiredResources();
135
136     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) override;
137     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) override;
138
139 #if ENABLE(CSS_REGIONS)
140     virtual bool shouldMoveToFlowThread(const RenderStyle&) const override;
141 #endif
142
143     bool hasTagName(const SVGQualifiedName& name) const { return hasLocalName(name.localName()); }
144
145 protected:
146     SVGElement(const QualifiedName&, Document&);
147     virtual ~SVGElement();
148
149     virtual bool rendererIsNeeded(const RenderStyle&) override;
150     virtual void parseAttribute(const QualifiedName&, const AtomicString&) override;
151
152     virtual void finishParsingChildren() override;
153     virtual void attributeChanged(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue, AttributeModificationReason = ModifiedDirectly) override;
154     virtual 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     virtual bool isPresentationAttribute(const QualifiedName&) const override;
162     virtual void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
163     virtual InsertionNotificationRequest insertedInto(ContainerNode&) override;
164     virtual void removedFrom(ContainerNode&) override;
165     virtual 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 private:
171     friend class SVGElementInstance;
172
173     virtual RenderStyle* computedStyle(PseudoId = NOPSEUDO) override final;
174     virtual bool willRecalcStyle(Style::Change) override;
175
176     virtual bool isSupported(StringImpl* feature, StringImpl* version) const;
177
178     void mapInstanceToElement(SVGElementInstance*);
179     void removeInstanceMapping(SVGElementInstance*);
180
181     void buildPendingResourcesIfNeeded();
182     virtual bool isKeyboardFocusable(KeyboardEvent*) const override;
183     virtual bool isMouseFocusable() const override;
184     virtual void accessKeyAction(bool sendMouseEvents) override;
185
186 #ifndef NDEBUG
187     virtual bool filterOutAnimatableAttribute(const QualifiedName&) const;
188 #endif
189
190     std::unique_ptr<SVGElementRareData> m_svgRareData;
191
192     HashSet<SVGElement*> m_elementsWithRelativeLengths;
193
194     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGElement)
195         DECLARE_ANIMATED_STRING(ClassName, className)
196     END_DECLARE_ANIMATED_PROPERTIES
197
198 };
199
200 struct SVGAttributeHashTranslator {
201     static unsigned hash(const QualifiedName& key)
202     {
203         if (key.hasPrefix()) {
204             QualifiedNameComponents components = { nullAtom.impl(), key.localName().impl(), key.namespaceURI().impl() };
205             return hashComponents(components);
206         }
207         return DefaultHash<QualifiedName>::Hash::hash(key);
208     }
209     static bool equal(const QualifiedName& a, const QualifiedName& b) { return a.matches(b); }
210 };
211
212 void isSVGElement(const SVGElement&); // Catch unnecessary runtime check of type known at compile time.
213 inline bool isSVGElement(const Node& node) { return node.isSVGElement(); }
214 template <> inline bool isElementOfType<const SVGElement>(const Element& element) { return element.isSVGElement(); }
215
216 NODE_TYPE_CASTS(SVGElement)
217
218 inline bool Node::hasTagName(const SVGQualifiedName& name) const
219 {
220     return isSVGElement() && toSVGElement(*this).hasTagName(name);
221 }
222
223 }
224
225 #endif