Generate more SVG type checks and conversions.
[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 isFilterEffect() const { return false; }
81     virtual bool isGradientStop() const { return false; }
82     virtual bool isTextContent() 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().m_animatedSVGAttributesAreDirty = 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  
114     virtual PassRefPtr<RenderStyle> customStyleForRenderer() OVERRIDE;
115
116     static void synchronizeRequiredFeatures(SVGElement* contextElement);
117     static void synchronizeRequiredExtensions(SVGElement* contextElement);
118     static void synchronizeSystemLanguage(SVGElement* contextElement);
119
120     virtual void synchronizeRequiredFeatures() { }
121     virtual void synchronizeRequiredExtensions() { }
122     virtual void synchronizeSystemLanguage() { }
123
124 #ifndef NDEBUG
125     bool isAnimatableAttribute(const QualifiedName&) const;
126 #endif
127
128     MutableStylePropertySet* animatedSMILStyleProperties() const;
129     MutableStylePropertySet& ensureAnimatedSMILStyleProperties();
130     void setUseOverrideComputedStyle(bool);
131
132     virtual bool haveLoadedRequiredResources();
133
134     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) OVERRIDE;
135     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) OVERRIDE;
136
137 #if ENABLE(CSS_REGIONS)
138     virtual bool shouldMoveToFlowThread(const RenderStyle&) const OVERRIDE;
139 #endif
140
141 protected:
142     SVGElement(const QualifiedName&, Document*);
143     virtual ~SVGElement();
144
145     virtual bool rendererIsNeeded(const RenderStyle&);
146     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
147
148     virtual void finishParsingChildren();
149     virtual void attributeChanged(const QualifiedName&, const AtomicString&, AttributeModificationReason = ModifiedDirectly) OVERRIDE;
150     virtual bool childShouldCreateRenderer(const Node*) const OVERRIDE;
151     
152     virtual void removedFrom(ContainerNode*) OVERRIDE;
153
154     SVGElementRareData* svgRareData() const;
155     SVGElementRareData& ensureSVGRareData();
156
157     void reportAttributeParsingError(SVGParsingError, const QualifiedName&, const AtomicString&);
158     static CSSPropertyID cssPropertyIdForSVGAttributeName(const QualifiedName&);
159
160     virtual bool isPresentationAttribute(const QualifiedName&) const OVERRIDE;
161     virtual void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStylePropertySet*) OVERRIDE;
162     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
163     virtual void childrenChanged(const ChildChange&) OVERRIDE;
164     virtual bool selfHasRelativeLengths() const { return false; }
165     void updateRelativeLengthsInformation() { updateRelativeLengthsInformation(selfHasRelativeLengths(), this); }
166     void updateRelativeLengthsInformation(bool hasRelativeLengths, SVGElement*);
167
168 private:
169     friend class SVGElementInstance;
170
171     // FIXME: Author shadows should be allowed
172     // https://bugs.webkit.org/show_bug.cgi?id=77938
173     virtual bool areAuthorShadowsAllowed() const OVERRIDE { return false; }
174
175     RenderStyle* computedStyle(PseudoId = NOPSEUDO);
176     virtual RenderStyle* virtualComputedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO) { return computedStyle(pseudoElementSpecifier); }
177     virtual bool willRecalcStyle(Style::Change);
178
179     virtual bool isSupported(StringImpl* feature, StringImpl* version) const;
180
181     void mapInstanceToElement(SVGElementInstance*);
182     void removeInstanceMapping(SVGElementInstance*);
183
184     void buildPendingResourcesIfNeeded();
185     virtual bool isKeyboardFocusable(KeyboardEvent*) const OVERRIDE;
186     virtual bool isMouseFocusable() const OVERRIDE;
187
188     HashSet<SVGElement*> m_elementsWithRelativeLengths;
189
190     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGElement)
191         DECLARE_ANIMATED_STRING(ClassName, className)
192     END_DECLARE_ANIMATED_PROPERTIES
193
194 };
195
196 struct SVGAttributeHashTranslator {
197     static unsigned hash(const QualifiedName& key)
198     {
199         if (key.hasPrefix()) {
200             QualifiedNameComponents components = { nullAtom.impl(), key.localName().impl(), key.namespaceURI().impl() };
201             return hashComponents(components);
202         }
203         return DefaultHash<QualifiedName>::Hash::hash(key);
204     }
205     static bool equal(const QualifiedName& a, const QualifiedName& b) { return a.matches(b); }
206 };
207
208 inline SVGElement* toSVGElement(Node* node)
209 {
210     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isSVGElement());
211     return static_cast<SVGElement*>(node);
212 }
213
214 inline const SVGElement* toSVGElement(const Node* node)
215 {
216     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isSVGElement());
217     return static_cast<const SVGElement*>(node);
218 }
219
220 void toSVGElement(const SVGElement*);
221
222 template <> inline bool isElementOfType<SVGElement>(const Element* element) { return element->isSVGElement(); }
223
224 }
225
226 #endif
227 #endif