[SVG] Update of element referenced by multiple 'use' nodes is absurdly slow
[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     void invalidateDependentShadowTrees();
54
55     RenderObject* rendererClipChild() const;
56
57 private:
58     SVGUseElement(const QualifiedName&, Document*, bool wasInsertedByParser);
59
60     virtual bool isValid() const { return SVGTests::isValid(); }
61     virtual bool supportsFocus() const { return true; }
62
63     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
64     virtual void removedFrom(ContainerNode*) OVERRIDE;
65     virtual void buildPendingResource();
66
67     bool isSupportedAttribute(const QualifiedName&);
68     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
69     virtual void svgAttributeChanged(const QualifiedName&);
70
71     virtual bool willRecalcStyle(StyleChange);
72
73     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
74     virtual void toClipPath(Path&);
75
76     void clearResourceReferences();
77     void buildShadowAndInstanceTree(SVGElement* target);
78     void detachInstance();
79
80     virtual bool haveLoadedRequiredResources() { return SVGExternalResourcesRequired::haveLoadedRequiredResources(); }
81
82     virtual void finishParsingChildren();
83     virtual bool selfHasRelativeLengths() const;
84
85     // Instance tree handling
86     void buildInstanceTree(SVGElement* target, SVGElementInstance* targetInstance, bool& foundCycle, bool foundUse);
87     bool hasCycleUseReferencing(SVGUseElement*, SVGElementInstance* targetInstance, SVGElement*& newTarget);
88
89     // Shadow tree handling
90     void buildShadowTree(SVGElement* target, SVGElementInstance* targetInstance);
91
92     void expandUseElementsInShadowTree(Node* element);
93     void expandSymbolElementsInShadowTree(Node* element);
94
95     // "Tree connector" 
96     void associateInstancesWithShadowTreeElements(Node* target, SVGElementInstance* targetInstance);
97     SVGElementInstance* instanceForShadowTreeElement(Node* element, SVGElementInstance* instance) const;
98
99     void transferUseAttributesToReplacedElement(SVGElement* from, SVGElement* to) const;
100     void transferEventListenersToShadowTree(SVGElementInstance* target);
101
102     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGUseElement)
103         DECLARE_ANIMATED_LENGTH(X, x)
104         DECLARE_ANIMATED_LENGTH(Y, y)
105         DECLARE_ANIMATED_LENGTH(Width, width)
106         DECLARE_ANIMATED_LENGTH(Height, height)
107         DECLARE_ANIMATED_STRING(Href, href)
108         DECLARE_ANIMATED_BOOLEAN(ExternalResourcesRequired, externalResourcesRequired)
109     END_DECLARE_ANIMATED_PROPERTIES
110
111     bool cachedDocumentIsStillLoading();
112     Document* externalDocument() const;
113     bool instanceTreeIsLoading(SVGElementInstance*);
114     virtual void notifyFinished(CachedResource*);
115     Document* referencedDocument() const;
116     void setCachedDocument(CachedResourceHandle<CachedSVGDocument>);
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     virtual Timer<SVGElement>* svgLoadEventTimer() OVERRIDE { return &m_svgLoadEventTimer; }
128
129     bool m_wasInsertedByParser;
130     bool m_haveFiredLoadEvent;
131     bool m_needsShadowTreeRecreation;
132     RefPtr<SVGElementInstance> m_targetElementInstance;
133     CachedResourceHandle<CachedSVGDocument> m_cachedDocument;
134     Timer<SVGElement> m_svgLoadEventTimer;
135 };
136
137 }
138
139 #endif
140 #endif