Generate toFooElement() functions from tagname data.
[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 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 #if ENABLE(SVG)
27 #include "CSSPropertyNames.h"
28 #include "SVGAnimatedString.h"
29 #include "SVGElementTypeHelpers.h"
30 #include "SVGLangSpace.h"
31 #include "SVGLocatable.h"
32 #include "SVGParsingError.h"
33 #include "SVGPropertyInfo.h"
34 #include "StyledElement.h"
35 #include "Timer.h"
36 #include <wtf/HashMap.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/PassRefPtr.h>
39
40 namespace WebCore {
41
42 class AffineTransform;
43 class CSSCursorImageValue;
44 class CSSStyleDeclaration;
45 class CSSValue;
46 class Document;
47 class SVGAttributeToPropertyMap;
48 class SVGCursorElement;
49 class SVGDocumentExtensions;
50 class SVGElementInstance;
51 class SVGElementRareData;
52 class SVGSVGElement;
53
54 void mapAttributeToCSSProperty(HashMap<AtomicStringImpl*, CSSPropertyID>* propertyNameToIdMap, const QualifiedName& attrName);
55
56 class SVGElement : public StyledElement, public SVGLangSpace {
57 public:
58     bool isOutermostSVGSVGElement() const;
59
60     String xmlbase() const;
61     void setXmlbase(const String&, ExceptionCode&);
62
63     SVGSVGElement* ownerSVGElement() const;
64     SVGElement* viewportElement() const;
65
66     virtual String title() const OVERRIDE;
67     static bool isAnimatableCSSProperty(const QualifiedName&);
68     bool isKnownAttribute(const QualifiedName&);
69     PassRefPtr<CSSValue> getPresentationAttribute(const String& name);
70     virtual bool supportsMarkers() const { return false; }
71     bool hasRelativeLengths() const { return !m_elementsWithRelativeLengths.isEmpty(); }
72     virtual bool needsPendingResourceHandling() const { return true; }
73     bool instanceUpdatesBlocked() const;
74     void setInstanceUpdatesBlocked(bool);
75     virtual AffineTransform localCoordinateSpaceTransform(SVGLocatable::CTMScope) const;
76
77     SVGDocumentExtensions* accessDocumentSVGExtensions();
78
79     virtual bool isSVGGraphicsElement() const { return false; }
80     virtual bool isSVGSVGElement() const { return false; }
81     virtual bool isFilterEffect() const { return false; }
82     virtual bool isGradientStop() const { return false; }
83     virtual bool isTextContent() const { return false; }
84
85     // For SVGTests
86     virtual bool isValid() const { return true; }
87
88     virtual void svgAttributeChanged(const QualifiedName&);
89
90     virtual void animatedPropertyTypeForAttribute(const QualifiedName&, Vector<AnimatedPropertyType>&);
91
92     void sendSVGLoadEventIfPossible(bool sendParentLoadEvents = false);
93     void sendSVGLoadEventIfPossibleAsynchronously();
94     void svgLoadEventTimerFired(Timer<SVGElement>*);
95     virtual Timer<SVGElement>* svgLoadEventTimer();
96
97     virtual AffineTransform* supplementalTransform() { return 0; }
98
99     void invalidateSVGAttributes() { ensureUniqueElementData().m_animatedSVGAttributesAreDirty = true; }
100
101     const HashSet<SVGElementInstance*>& instancesForElement() const;
102
103     bool getBoundingBox(FloatRect&, SVGLocatable::StyleUpdateStrategy = SVGLocatable::AllowStyleUpdate);
104
105     void setCursorElement(SVGCursorElement*);
106     void cursorElementRemoved();
107     void setCursorImageValue(CSSCursorImageValue*);
108     void cursorImageValueRemoved();
109
110     SVGElement* correspondingElement();
111     void setCorrespondingElement(SVGElement*);
112
113     void synchronizeAnimatedSVGAttribute(const QualifiedName&) const;
114  
115     virtual PassRefPtr<RenderStyle> customStyleForRenderer() 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 #ifndef NDEBUG
126     bool isAnimatableAttribute(const QualifiedName&) const;
127 #endif
128
129     MutableStylePropertySet* animatedSMILStyleProperties() const;
130     MutableStylePropertySet& ensureAnimatedSMILStyleProperties();
131     void setUseOverrideComputedStyle(bool);
132
133     virtual bool haveLoadedRequiredResources();
134
135     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) OVERRIDE;
136     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) OVERRIDE;
137
138 #if ENABLE(CSS_REGIONS)
139     virtual bool shouldMoveToFlowThread(const RenderStyle&) const OVERRIDE;
140 #endif
141
142 protected:
143     SVGElement(const QualifiedName&, Document*);
144     virtual ~SVGElement();
145
146     virtual bool rendererIsNeeded(const RenderStyle&);
147     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
148
149     virtual void finishParsingChildren();
150     virtual void attributeChanged(const QualifiedName&, const AtomicString&, AttributeModificationReason = ModifiedDirectly) OVERRIDE;
151     virtual bool childShouldCreateRenderer(const Node*) const OVERRIDE;
152     
153     virtual void removedFrom(ContainerNode*) OVERRIDE;
154
155     SVGElementRareData* svgRareData() const;
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&, MutableStylePropertySet*) OVERRIDE;
163     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
164     virtual void childrenChanged(const ChildChange&) OVERRIDE;
165     virtual bool selfHasRelativeLengths() const { return false; }
166     void updateRelativeLengthsInformation() { updateRelativeLengthsInformation(selfHasRelativeLengths(), this); }
167     void updateRelativeLengthsInformation(bool hasRelativeLengths, SVGElement*);
168
169 private:
170     friend class SVGElementInstance;
171
172     // FIXME: Author shadows should be allowed
173     // https://bugs.webkit.org/show_bug.cgi?id=77938
174     virtual bool areAuthorShadowsAllowed() const OVERRIDE { return false; }
175
176     RenderStyle* computedStyle(PseudoId = NOPSEUDO);
177     virtual RenderStyle* virtualComputedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO) { return computedStyle(pseudoElementSpecifier); }
178     virtual bool willRecalcStyle(Style::Change);
179
180     virtual bool isSupported(StringImpl* feature, StringImpl* version) const;
181
182     void mapInstanceToElement(SVGElementInstance*);
183     void removeInstanceMapping(SVGElementInstance*);
184
185     void buildPendingResourcesIfNeeded();
186     virtual bool isKeyboardFocusable(KeyboardEvent*) const OVERRIDE;
187     virtual bool isMouseFocusable() const OVERRIDE;
188
189     HashSet<SVGElement*> m_elementsWithRelativeLengths;
190
191     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGElement)
192         DECLARE_ANIMATED_STRING(ClassName, className)
193     END_DECLARE_ANIMATED_PROPERTIES
194
195 };
196
197 struct SVGAttributeHashTranslator {
198     static unsigned hash(const QualifiedName& key)
199     {
200         if (key.hasPrefix()) {
201             QualifiedNameComponents components = { nullAtom.impl(), key.localName().impl(), key.namespaceURI().impl() };
202             return hashComponents(components);
203         }
204         return DefaultHash<QualifiedName>::Hash::hash(key);
205     }
206     static bool equal(const QualifiedName& a, const QualifiedName& b) { return a.matches(b); }
207 };
208
209 inline SVGElement* toSVGElement(Node* node)
210 {
211     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isSVGElement());
212     return static_cast<SVGElement*>(node);
213 }
214
215 inline const SVGElement* toSVGElement(const Node* node)
216 {
217     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isSVGElement());
218     return static_cast<const SVGElement*>(node);
219 }
220
221 template <> inline bool isElementOfType<SVGElement>(const Element* element) { return element->isSVGElement(); }
222
223 }
224
225 #endif
226 #endif