SVGUseElement should not use Element::ensureShadowRoot().
[WebKit-https.git] / Source / WebCore / svg / SVGUseElement.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2007 Rob Buis <buis@kde.org>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef SVGUseElement_h
22 #define SVGUseElement_h
23
24 #if ENABLE(SVG)
25 #include "CachedSVGDocument.h"
26 #include "SVGAnimatedBoolean.h"
27 #include "SVGAnimatedLength.h"
28 #include "SVGExternalResourcesRequired.h"
29 #include "SVGLangSpace.h"
30 #include "SVGStyledTransformableElement.h"
31 #include "SVGTests.h"
32 #include "SVGURIReference.h"
33
34 namespace WebCore {
35
36 class CachedSVGDocument;
37 class SVGElementInstance;
38
39 class SVGUseElement : public SVGStyledTransformableElement,
40                       public SVGTests,
41                       public SVGLangSpace,
42                       public SVGExternalResourcesRequired,
43                       public SVGURIReference,
44                       public CachedSVGDocumentClient {
45 public:
46     static PassRefPtr<SVGUseElement> create(const QualifiedName&, Document*, bool wasInsertedByParser);
47     virtual ~SVGUseElement();
48
49     SVGElementInstance* instanceRoot();
50     SVGElementInstance* animatedInstanceRoot() const;
51     SVGElementInstance* instanceForShadowTreeElement(Node*) const;
52     void invalidateShadowTree();
53
54     RenderObject* rendererClipChild() const;
55
56 private:
57     SVGUseElement(const QualifiedName&, Document*, bool wasInsertedByParser);
58
59     void createShadowSubtree();
60
61     virtual bool isValid() const { return SVGTests::isValid(); }
62     virtual bool supportsFocus() const { return true; }
63
64     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
65     virtual void removedFrom(ContainerNode*) OVERRIDE;
66     virtual void buildPendingResource();
67
68     bool isSupportedAttribute(const QualifiedName&);
69     virtual void parseAttribute(const Attribute&) OVERRIDE;
70     virtual void svgAttributeChanged(const QualifiedName&);
71
72     virtual bool willRecalcStyle(StyleChange);
73
74     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
75     virtual void toClipPath(Path&);
76
77     void clearResourceReferences();
78     void buildShadowAndInstanceTree(SVGElement* target);
79     void detachInstance();
80
81     virtual bool haveLoadedRequiredResources() { return SVGExternalResourcesRequired::haveLoadedRequiredResources(); }
82
83     virtual void finishParsingChildren();
84     virtual bool selfHasRelativeLengths() const;
85
86     // Instance tree handling
87     void buildInstanceTree(SVGElement* target, SVGElementInstance* targetInstance, bool& foundCycle);
88     bool hasCycleUseReferencing(SVGUseElement*, SVGElementInstance* targetInstance, SVGElement*& newTarget);
89
90     // Shadow tree handling
91     void buildShadowTree(SVGElement* target, SVGElementInstance* targetInstance);
92
93     void expandUseElementsInShadowTree(Node* element);
94     void expandSymbolElementsInShadowTree(Node* element);
95
96     // "Tree connector" 
97     void associateInstancesWithShadowTreeElements(Node* target, SVGElementInstance* targetInstance);
98     SVGElementInstance* instanceForShadowTreeElement(Node* element, SVGElementInstance* instance) const;
99
100     void transferUseAttributesToReplacedElement(SVGElement* from, SVGElement* to) const;
101     void transferEventListenersToShadowTree(SVGElementInstance* target);
102
103     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGUseElement)
104         DECLARE_ANIMATED_LENGTH(X, x)
105         DECLARE_ANIMATED_LENGTH(Y, y)
106         DECLARE_ANIMATED_LENGTH(Width, width)
107         DECLARE_ANIMATED_LENGTH(Height, height)
108         DECLARE_ANIMATED_STRING(Href, href)
109         DECLARE_ANIMATED_BOOLEAN(ExternalResourcesRequired, externalResourcesRequired)
110     END_DECLARE_ANIMATED_PROPERTIES
111
112     bool cachedDocumentIsStillLoading();
113     Document* externalDocument() const;
114     bool instanceTreeIsLoading(SVGElementInstance*);
115     virtual void notifyFinished(CachedResource*);
116     Document* referencedDocument() const;
117
118     // SVGTests
119     virtual void synchronizeRequiredFeatures() { SVGTests::synchronizeRequiredFeatures(this); }
120     virtual void synchronizeRequiredExtensions() { SVGTests::synchronizeRequiredExtensions(this); }
121     virtual void synchronizeSystemLanguage() { SVGTests::synchronizeSystemLanguage(this); }
122
123     // SVGExternalResourcesRequired
124     virtual void setHaveFiredLoadEvent(bool haveFiredLoadEvent) { m_haveFiredLoadEvent = haveFiredLoadEvent; }
125     virtual bool isParserInserted() const { return m_wasInsertedByParser; }
126     virtual bool haveFiredLoadEvent() const { return m_haveFiredLoadEvent; }
127
128     bool m_wasInsertedByParser;
129     bool m_haveFiredLoadEvent;
130     bool m_needsShadowTreeRecreation;
131     RefPtr<SVGElementInstance> m_targetElementInstance;
132     CachedResourceHandle<CachedSVGDocument> m_cachedDocument;
133 };
134
135 }
136
137 #endif
138 #endif