db74c2941856fe6323b021723d935baa86d07865
[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 Rob Buis <buis@kde.org>
4  * Copyright (C) 2009 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef SVGElement_h
23 #define SVGElement_h
24
25 #if ENABLE(SVG)
26 #include "SVGLocatable.h"
27 #include "SVGParsingError.h"
28 #include "SVGPropertyInfo.h"
29 #include "StyledElement.h"
30 #include "Timer.h"
31 #include <wtf/HashMap.h>
32
33 namespace WebCore {
34
35 class AffineTransform;
36 class CSSCursorImageValue;
37 class Document;
38 class SVGAttributeToPropertyMap;
39 class SVGCursorElement;
40 class SVGDocumentExtensions;
41 class SVGElementInstance;
42 class SVGElementRareData;
43 class SVGSVGElement;
44
45 class SVGElement : public StyledElement {
46 public:
47     static PassRefPtr<SVGElement> create(const QualifiedName&, Document*);
48     virtual ~SVGElement();
49
50     bool isOutermostSVGSVGElement() const;
51
52     String xmlbase() const;
53     void setXmlbase(const String&, ExceptionCode&);
54
55     SVGSVGElement* ownerSVGElement() const;
56     SVGElement* viewportElement() const;
57
58     SVGDocumentExtensions* accessDocumentSVGExtensions();
59
60     virtual bool isSVGStyledElement() const { return false; }
61     virtual bool isStyledTransformable() const { return false; }
62     virtual bool isStyledLocatable() const { return false; }
63     virtual bool isSVGSVGElement() const { return false; }
64     virtual bool isFilterEffect() const { return false; }
65     virtual bool isGradientStop() const { return false; }
66     virtual bool isTextContent() const { return false; }
67
68     // For SVGTests
69     virtual bool isValid() const { return true; }
70
71     virtual void svgAttributeChanged(const QualifiedName&) { }
72
73     virtual void animatedPropertyTypeForAttribute(const QualifiedName&, Vector<AnimatedPropertyType>&);
74
75     void sendSVGLoadEventIfPossible(bool sendParentLoadEvents = false);
76     void sendSVGLoadEventIfPossibleAsynchronously();
77     void svgLoadEventTimerFired(Timer<SVGElement>*);
78     virtual Timer<SVGElement>* svgLoadEventTimer();
79
80     virtual AffineTransform* supplementalTransform() { return 0; }
81
82     void invalidateSVGAttributes() { ensureUniqueElementData()->m_animatedSVGAttributesAreDirty = true; }
83
84     const HashSet<SVGElementInstance*>& instancesForElement() const;
85
86     bool getBoundingBox(FloatRect&, SVGLocatable::StyleUpdateStrategy = SVGLocatable::AllowStyleUpdate);
87
88     void setCursorElement(SVGCursorElement*);
89     void cursorElementRemoved();
90     void setCursorImageValue(CSSCursorImageValue*);
91     void cursorImageValueRemoved();
92
93     SVGElement* correspondingElement();
94     void setCorrespondingElement(SVGElement*);
95
96     void synchronizeAnimatedSVGAttribute(const QualifiedName&) const;
97  
98     virtual PassRefPtr<RenderStyle> customStyleForRenderer() OVERRIDE;
99
100     static void synchronizeRequiredFeatures(SVGElement* contextElement);
101     static void synchronizeRequiredExtensions(SVGElement* contextElement);
102     static void synchronizeSystemLanguage(SVGElement* contextElement);
103
104     virtual void synchronizeRequiredFeatures() { }
105     virtual void synchronizeRequiredExtensions() { }
106     virtual void synchronizeSystemLanguage() { }
107
108     virtual SVGAttributeToPropertyMap& localAttributeToPropertyMap();
109
110 #ifndef NDEBUG
111     bool isAnimatableAttribute(const QualifiedName&) const;
112 #endif
113
114     StylePropertySet* animatedSMILStyleProperties() const;
115     StylePropertySet* ensureAnimatedSMILStyleProperties();
116     void setUseOverrideComputedStyle(bool);
117
118     virtual bool haveLoadedRequiredResources();
119
120     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) OVERRIDE;
121     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) OVERRIDE;
122
123 protected:
124     SVGElement(const QualifiedName&, Document*, ConstructionType = CreateSVGElement);
125
126     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
127
128     virtual void finishParsingChildren();
129     virtual void attributeChanged(const QualifiedName&, const AtomicString&, AttributeModificationReason = ModifiedDirectly) OVERRIDE;
130     virtual bool childShouldCreateRenderer(const NodeRenderingContext&) const OVERRIDE;
131     
132     virtual void removedFrom(ContainerNode*) OVERRIDE;
133
134     SVGElementRareData* svgRareData() const;
135     SVGElementRareData* ensureSVGRareData();
136
137     void reportAttributeParsingError(SVGParsingError, const QualifiedName&, const AtomicString&);
138
139 private:
140     friend class SVGElementInstance;
141
142     // FIXME: Author shadows should be allowed
143     // https://bugs.webkit.org/show_bug.cgi?id=77938
144     virtual bool areAuthorShadowsAllowed() const OVERRIDE { return false; }
145
146     RenderStyle* computedStyle(PseudoId = NOPSEUDO);
147     virtual RenderStyle* virtualComputedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO) { return computedStyle(pseudoElementSpecifier); }
148     virtual bool willRecalcStyle(StyleChange);
149
150     virtual bool rendererIsNeeded(const NodeRenderingContext&) { return false; }
151
152     virtual bool isSupported(StringImpl* feature, StringImpl* version) const;
153
154     void mapInstanceToElement(SVGElementInstance*);
155     void removeInstanceMapping(SVGElementInstance*);
156
157 };
158
159 struct SVGAttributeHashTranslator {
160     static unsigned hash(const QualifiedName& key)
161     {
162         if (key.hasPrefix()) {
163             QualifiedNameComponents components = { nullAtom.impl(), key.localName().impl(), key.namespaceURI().impl() };
164             return hashComponents(components);
165         }
166         return DefaultHash<QualifiedName>::Hash::hash(key);
167     }
168     static bool equal(const QualifiedName& a, const QualifiedName& b) { return a.matches(b); }
169 };
170
171 inline SVGElement* toSVGElement(Node* node)
172 {
173     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isSVGElement());
174     return static_cast<SVGElement*>(node);
175 }
176
177 inline const SVGElement* toSVGElement(const Node* node)
178 {
179     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isSVGElement());
180     return static_cast<const SVGElement*>(node);
181 }
182
183 }
184
185 #endif
186 #endif