Define the type of SVGPropertyOwnerRegistry for all SVG elements
[WebKit-https.git] / Source / WebCore / svg / SVGExternalResourcesRequired.h
1 /*
2  * Copyright (C) 2004, 2005, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005 Rob Buis <buis@kde.org>
4  * Copyright (C) 2018-2019 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 "QualifiedName.h"
25 #include "SVGAttributeOwnerProxyImpl.h"
26 #include "SVGPropertyOwnerRegistry.h"
27 #include <wtf/HashSet.h>
28
29 namespace WebCore {
30
31 class SVGElement;
32
33 // Notes on a SVG 1.1 spec discrepancy:
34 // The SVG DOM defines the attribute externalResourcesRequired as being of type SVGAnimatedBoolean, whereas the 
35 // SVG language definition says that externalResourcesRequired is not animated. Because the SVG language definition
36 // states that externalResourcesRequired cannot be animated, the animVal will always be the same as the baseVal.
37 // FIXME: When implementing animVal support, make sure that animVal==baseVal for externalResourcesRequired
38 class SVGExternalResourcesRequired {
39     WTF_MAKE_NONCOPYABLE(SVGExternalResourcesRequired);
40 public:
41     virtual ~SVGExternalResourcesRequired() = default;
42
43     void parseAttribute(const QualifiedName&, const AtomicString&);
44     void svgAttributeChanged(const QualifiedName&);
45
46     static void addSupportedAttributes(HashSet<QualifiedName>&);
47
48     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGExternalResourcesRequired>;
49     static auto& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
50
51     using PropertyRegistry = SVGPropertyOwnerRegistry<SVGExternalResourcesRequired>;
52
53     auto externalResourcesRequiredAnimated() { return m_externalResourcesRequired.animatedProperty(attributeOwnerProxy()); }
54
55     bool externalResourcesRequired() const { return m_externalResourcesRequired.value(); }
56     void setExternalResourcesRequired(bool externalResourcesRequired) { m_externalResourcesRequired.setValue(externalResourcesRequired); }
57
58 protected:
59     SVGExternalResourcesRequired(SVGElement* contextElement);
60
61     static bool isKnownAttribute(const QualifiedName& attributeName)
62     {
63         return AttributeOwnerProxy::isKnownAttribute(attributeName) || PropertyRegistry::isKnownAttribute(attributeName);
64     }
65
66     virtual void setHaveFiredLoadEvent(bool) { }
67     virtual bool isParserInserted() const { return false; }
68     virtual bool haveFiredLoadEvent() const { return false; }
69
70     void dispatchLoadEvent();
71     void insertedIntoDocument();
72     void finishParsingChildren();
73     bool haveLoadedRequiredResources() const;
74
75 private:
76     static void registerAttributes();
77     AttributeOwnerProxy attributeOwnerProxy() { return { *this, m_contextElement }; }
78     
79     SVGElement& m_contextElement;
80     SVGAnimatedBooleanAttribute m_externalResourcesRequired;
81 };
82
83 } // namespace WebCore