069ad287fd70b148b66821749c50447131cee16d
[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  * Copyright (C) 2015 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 #pragma once
23
24 #include "CachedResourceHandle.h"
25 #include "CachedSVGDocumentClient.h"
26 #include "SVGAnimatedBoolean.h"
27 #include "SVGAnimatedLength.h"
28 #include "SVGExternalResourcesRequired.h"
29 #include "SVGGraphicsElement.h"
30 #include "SVGURIReference.h"
31
32 namespace WebCore {
33
34 class CachedSVGDocument;
35 class SVGGElement;
36
37 class SVGUseElement final : public SVGGraphicsElement, public SVGExternalResourcesRequired, public SVGURIReference, private CachedSVGDocumentClient {
38     WTF_MAKE_ISO_ALLOCATED(SVGUseElement);
39
40     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGUseElement)
41         DECLARE_ANIMATED_LENGTH(X, x)
42         DECLARE_ANIMATED_LENGTH(Y, y)
43         DECLARE_ANIMATED_LENGTH(Width, width)
44         DECLARE_ANIMATED_LENGTH(Height, height)
45         DECLARE_ANIMATED_STRING_OVERRIDE(Href, href)
46         DECLARE_ANIMATED_BOOLEAN_OVERRIDE(ExternalResourcesRequired, externalResourcesRequired)
47     END_DECLARE_ANIMATED_PROPERTIES
48
49 public:
50     static Ref<SVGUseElement> create(const QualifiedName&, Document&);
51     virtual ~SVGUseElement();
52
53     void invalidateShadowTree();
54     bool shadowTreeNeedsUpdate() const { return m_shadowTreeNeedsUpdate; }
55     void updateShadowTree();
56
57     RenderElement* rendererClipChild() const;
58
59 private:
60     SVGUseElement(const QualifiedName&, Document&);
61
62     bool isValid() const override;
63     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
64     void removedFromAncestor(RemovalType, ContainerNode&) override;
65     void buildPendingResource() override;
66     void parseAttribute(const QualifiedName&, const AtomicString&) override;
67     void svgAttributeChanged(const QualifiedName&) override;
68     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
69     Path toClipPath() override;
70     bool haveLoadedRequiredResources() override;
71     void finishParsingChildren() override;
72     bool selfHasRelativeLengths() const override;
73     void setHaveFiredLoadEvent(bool) override;
74     bool haveFiredLoadEvent() const override;
75     Timer* svgLoadEventTimer() override;
76     void notifyFinished(CachedResource&) final;
77
78     Document* externalDocument() const;
79     void updateExternalDocument();
80
81     SVGElement* findTarget(String* targetID = nullptr) const;
82
83     void cloneTarget(ContainerNode&, SVGElement& target) const;
84     RefPtr<SVGElement> targetClone() const;
85
86     void expandUseElementsInShadowTree() const;
87     void expandSymbolElementsInShadowTree() const;
88     void transferEventListenersToShadowTree() const;
89     void transferSizeAttributesToTargetClone(SVGElement&) const;
90
91     void clearShadowTree();
92     void invalidateDependentShadowTrees();
93
94     bool m_haveFiredLoadEvent { false };
95     bool m_shadowTreeNeedsUpdate { true };
96     CachedResourceHandle<CachedSVGDocument> m_externalDocument;
97     Timer m_svgLoadEventTimer;
98 };
99
100 }