Load event must be fired only for the SVG structurally external elements and the...
[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 "SVGExternalResourcesRequired.h"
27 #include "SVGGraphicsElement.h"
28 #include "SVGURIReference.h"
29
30 namespace WebCore {
31
32 class CachedSVGDocument;
33 class SVGGElement;
34
35 class SVGUseElement final : public SVGGraphicsElement, public SVGExternalResourcesRequired, public SVGURIReference, private CachedSVGDocumentClient {
36     WTF_MAKE_ISO_ALLOCATED(SVGUseElement);
37 public:
38     static Ref<SVGUseElement> create(const QualifiedName&, Document&);
39     virtual ~SVGUseElement();
40
41     void invalidateShadowTree();
42     bool shadowTreeNeedsUpdate() const { return m_shadowTreeNeedsUpdate; }
43     void updateShadowTree();
44
45     RenderElement* rendererClipChild() const;
46
47     const SVGLengthValue& x() const { return m_x->currentValue(); }
48     const SVGLengthValue& y() const { return m_y->currentValue(); }
49     const SVGLengthValue& width() const { return m_width->currentValue(); }
50     const SVGLengthValue& height() const { return m_height->currentValue(); }
51
52     SVGAnimatedLength& xAnimated() { return m_x; }
53     SVGAnimatedLength& yAnimated() { return m_y; }
54     SVGAnimatedLength& widthAnimated() { return m_width; }
55     SVGAnimatedLength& heightAnimated() { return m_height; }
56
57 private:
58     SVGUseElement(const QualifiedName&, Document&);
59
60     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
61     void didFinishInsertingNode() final;
62     void removedFromAncestor(RemovalType, ContainerNode&) override;
63     void buildPendingResource() override;
64
65     using PropertyRegistry = SVGPropertyOwnerRegistry<SVGUseElement, SVGGraphicsElement, SVGExternalResourcesRequired, SVGURIReference>;
66     const SVGPropertyRegistry& propertyRegistry() const final { return m_propertyRegistry; }
67
68     void parseAttribute(const QualifiedName&, const AtomString&) override;
69     void svgAttributeChanged(const QualifiedName&) override;
70
71     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
72     Path toClipPath() override;
73     bool selfHasRelativeLengths() const override;
74     void notifyFinished(CachedResource&) final;
75
76     Document* externalDocument() const;
77     void updateExternalDocument();
78
79     SVGElement* findTarget(String* targetID = nullptr) const;
80
81     void cloneTarget(ContainerNode&, SVGElement& target) const;
82     RefPtr<SVGElement> targetClone() const;
83
84     void expandUseElementsInShadowTree() const;
85     void expandSymbolElementsInShadowTree() const;
86     void transferEventListenersToShadowTree() const;
87     void transferSizeAttributesToTargetClone(SVGElement&) const;
88
89     void clearShadowTree();
90     void invalidateDependentShadowTrees();
91
92     bool haveLoadedRequiredResources() override { return SVGURIReference::haveLoadedRequiredResources(); }
93     void setHaveFiredLoadEvent(bool haveFiredLoadEvent) override { m_haveFiredLoadEvent = haveFiredLoadEvent; }
94     bool haveFiredLoadEvent() const override { return m_haveFiredLoadEvent; }
95     void setErrorOccurred(bool errorOccurred) override { m_errorOccurred = errorOccurred; }
96     bool errorOccurred() const override { return m_errorOccurred; }
97     Timer* loadEventTimer() override { return &m_loadEventTimer; }
98
99     bool isValid() const override { return SVGTests::isValid(); }
100
101     PropertyRegistry m_propertyRegistry { *this };
102     Ref<SVGAnimatedLength> m_x { SVGAnimatedLength::create(this, SVGLengthMode::Width) };
103     Ref<SVGAnimatedLength> m_y { SVGAnimatedLength::create(this, SVGLengthMode::Height) };
104     Ref<SVGAnimatedLength> m_width { SVGAnimatedLength::create(this, SVGLengthMode::Width) };
105     Ref<SVGAnimatedLength> m_height { SVGAnimatedLength::create(this, SVGLengthMode::Height) };
106
107     bool m_haveFiredLoadEvent { false };
108     bool m_errorOccurred { false };
109     bool m_shadowTreeNeedsUpdate { true };
110     CachedResourceHandle<CachedSVGDocument> m_externalDocument;
111     Timer m_loadEventTimer;
112 };
113
114 }