6e817de40a45dbb080767bcd4591caef9329194b
[WebKit.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*);
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*);
58
59     virtual bool isValid() const { return SVGTests::isValid(); }
60     virtual bool supportsFocus() const { return true; }
61
62     virtual void insertedIntoDocument();
63     virtual void removedFromDocument();
64     virtual void buildPendingResource();
65
66     bool isSupportedAttribute(const QualifiedName&);
67     virtual void parseAttribute(Attribute*) OVERRIDE;
68     virtual void svgAttributeChanged(const QualifiedName&);
69
70     virtual bool willRecalcStyle(StyleChange);
71
72     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
73     virtual void toClipPath(Path&);
74
75     void clearResourceReferences();
76     void buildShadowAndInstanceTree(SVGElement* target);
77     void detachInstance();
78
79     virtual bool selfHasRelativeLengths() const;
80
81     // Instance tree handling
82     void buildInstanceTree(SVGElement* target, SVGElementInstance* targetInstance, bool& foundCycle);
83     bool hasCycleUseReferencing(SVGUseElement*, SVGElementInstance* targetInstance, SVGElement*& newTarget);
84
85     // Shadow tree handling
86     void buildShadowTree(SVGElement* target, SVGElementInstance* targetInstance);
87
88     void expandUseElementsInShadowTree(Node* element);
89     void expandSymbolElementsInShadowTree(Node* element);
90
91     // "Tree connector" 
92     void associateInstancesWithShadowTreeElements(Node* target, SVGElementInstance* targetInstance);
93     SVGElementInstance* instanceForShadowTreeElement(Node* element, SVGElementInstance* instance) const;
94
95     void transferUseAttributesToReplacedElement(SVGElement* from, SVGElement* to) const;
96     void transferEventListenersToShadowTree(SVGElementInstance* target);
97
98     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGUseElement)
99         DECLARE_ANIMATED_LENGTH(X, x)
100         DECLARE_ANIMATED_LENGTH(Y, y)
101         DECLARE_ANIMATED_LENGTH(Width, width)
102         DECLARE_ANIMATED_LENGTH(Height, height)
103         DECLARE_ANIMATED_STRING(Href, href)
104         DECLARE_ANIMATED_BOOLEAN(ExternalResourcesRequired, externalResourcesRequired)
105     END_DECLARE_ANIMATED_PROPERTIES
106
107     bool cachedDocumentIsStillLoading();
108     Document* externalDocument() const;
109     bool instanceTreeIsLoading(SVGElementInstance*);
110     virtual void notifyFinished(CachedResource*);
111     Document* referencedDocument() const;
112
113     // SVGTests
114     virtual void synchronizeRequiredFeatures() { SVGTests::synchronizeRequiredFeatures(this); }
115     virtual void synchronizeRequiredExtensions() { SVGTests::synchronizeRequiredExtensions(this); }
116     virtual void synchronizeSystemLanguage() { SVGTests::synchronizeSystemLanguage(this); }
117
118     bool m_needsShadowTreeRecreation;
119     RefPtr<SVGElementInstance> m_targetElementInstance;
120     CachedResourceHandle<CachedSVGDocument> m_cachedDocument;
121 };
122
123 }
124
125 #endif
126 #endif