Remove the SVG elements' attributes macros
[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-2018 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 public:
40     static Ref<SVGUseElement> create(const QualifiedName&, Document&);
41     virtual ~SVGUseElement();
42
43     void invalidateShadowTree();
44     bool shadowTreeNeedsUpdate() const { return m_shadowTreeNeedsUpdate; }
45     void updateShadowTree();
46
47     RenderElement* rendererClipChild() const;
48
49     const SVGLengthValue& x() const { return m_x.currentValue(attributeOwnerProxy()); }
50     const SVGLengthValue& y() const { return m_y.currentValue(attributeOwnerProxy()); }
51     const SVGLengthValue& width() const { return m_width.currentValue(attributeOwnerProxy()); }
52     const SVGLengthValue& height() const { return m_height.currentValue(attributeOwnerProxy()); }
53
54     RefPtr<SVGAnimatedLength> xAnimated() { return m_x.animatedProperty(attributeOwnerProxy()); }
55     RefPtr<SVGAnimatedLength> yAnimated() { return m_y.animatedProperty(attributeOwnerProxy()); }
56     RefPtr<SVGAnimatedLength> widthAnimated() { return m_width.animatedProperty(attributeOwnerProxy()); }
57     RefPtr<SVGAnimatedLength> heightAnimated() { return m_height.animatedProperty(attributeOwnerProxy()); }
58
59 private:
60     SVGUseElement(const QualifiedName&, Document&);
61
62     bool isValid() const override;
63     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
64     void didFinishInsertingNode() final;
65     void removedFromAncestor(RemovalType, ContainerNode&) override;
66     void buildPendingResource() override;
67
68     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGUseElement, SVGGraphicsElement, SVGExternalResourcesRequired, SVGURIReference>;
69     static AttributeOwnerProxy::AttributeRegistry& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
70     static bool isKnownAttribute(const QualifiedName& attributeName) { return AttributeOwnerProxy::isKnownAttribute(attributeName); }
71     static void registerAttributes();
72
73     const SVGAttributeOwnerProxy& attributeOwnerProxy() const final { return m_attributeOwnerProxy; }
74     void parseAttribute(const QualifiedName&, const AtomicString&) override;
75     void svgAttributeChanged(const QualifiedName&) override;
76
77     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
78     Path toClipPath() override;
79     bool haveLoadedRequiredResources() override;
80     void finishParsingChildren() override;
81     bool selfHasRelativeLengths() const override;
82     void setHaveFiredLoadEvent(bool) override;
83     bool haveFiredLoadEvent() const override;
84     Timer* svgLoadEventTimer() override;
85     void notifyFinished(CachedResource&) final;
86
87     Document* externalDocument() const;
88     void updateExternalDocument();
89
90     SVGElement* findTarget(String* targetID = nullptr) const;
91
92     void cloneTarget(ContainerNode&, SVGElement& target) const;
93     RefPtr<SVGElement> targetClone() const;
94
95     void expandUseElementsInShadowTree() const;
96     void expandSymbolElementsInShadowTree() const;
97     void transferEventListenersToShadowTree() const;
98     void transferSizeAttributesToTargetClone(SVGElement&) const;
99
100     void clearShadowTree();
101     void invalidateDependentShadowTrees();
102
103     AttributeOwnerProxy m_attributeOwnerProxy { *this };
104     SVGAnimatedLengthAttribute m_x { LengthModeWidth };
105     SVGAnimatedLengthAttribute m_y { LengthModeHeight };
106     SVGAnimatedLengthAttribute m_width { LengthModeWidth };
107     SVGAnimatedLengthAttribute m_height { LengthModeHeight };
108
109     bool m_haveFiredLoadEvent { false };
110     bool m_shadowTreeNeedsUpdate { true };
111     CachedResourceHandle<CachedSVGDocument> m_externalDocument;
112     Timer m_svgLoadEventTimer;
113 };
114
115 }