Define the type of SVGPropertyOwnerRegistry for all SVG elements
[WebKit-https.git] / Source / WebCore / svg / SVGTextPathElement.h
1 /*
2  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2018-2019 Apple Inc. All rights reserved.
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 #pragma once
22
23 #include "SVGNames.h"
24 #include "SVGTextContentElement.h"
25 #include "SVGURIReference.h"
26
27 namespace WebCore {
28
29 enum SVGTextPathMethodType {
30     SVGTextPathMethodUnknown = 0,
31     SVGTextPathMethodAlign,
32     SVGTextPathMethodStretch
33 };
34
35 enum SVGTextPathSpacingType {
36     SVGTextPathSpacingUnknown = 0,
37     SVGTextPathSpacingAuto,
38     SVGTextPathSpacingExact
39 };
40
41 template<>
42 struct SVGPropertyTraits<SVGTextPathMethodType> {
43     static unsigned highestEnumValue() { return SVGTextPathMethodStretch; }
44
45     static String toString(SVGTextPathMethodType type)
46     {
47         switch (type) {
48         case SVGTextPathMethodUnknown:
49             return emptyString();
50         case SVGTextPathMethodAlign:
51             return "align"_s;
52         case SVGTextPathMethodStretch:
53             return "stretch"_s;
54         }
55     
56         ASSERT_NOT_REACHED();
57         return emptyString();
58     }
59
60     static SVGTextPathMethodType fromString(const String& value)
61     {
62         if (value == "align")
63             return SVGTextPathMethodAlign;
64         if (value == "stretch")
65             return SVGTextPathMethodStretch;
66         return SVGTextPathMethodUnknown;
67     }
68 };
69
70 template<>
71 struct SVGPropertyTraits<SVGTextPathSpacingType> {
72     static unsigned highestEnumValue() { return SVGTextPathSpacingExact; }
73
74     static String toString(SVGTextPathSpacingType type)
75     {
76         switch (type) {
77         case SVGTextPathSpacingUnknown:
78             return emptyString();
79         case SVGTextPathSpacingAuto:
80             return "auto"_s;
81         case SVGTextPathSpacingExact:
82             return "exact"_s;
83         }
84
85         ASSERT_NOT_REACHED();
86         return emptyString();
87     }
88
89     static SVGTextPathSpacingType fromString(const String& value)
90     {
91         if (value == "auto")
92             return SVGTextPathSpacingAuto;
93         if (value == "exact")
94             return SVGTextPathSpacingExact;
95         return SVGTextPathSpacingUnknown;
96     }
97 };
98
99 class SVGTextPathElement final : public SVGTextContentElement, public SVGURIReference {
100     WTF_MAKE_ISO_ALLOCATED(SVGTextPathElement);
101 public:
102     // Forward declare enumerations in the W3C naming scheme, for IDL generation.
103     enum {
104         TEXTPATH_METHODTYPE_UNKNOWN = SVGTextPathMethodUnknown,
105         TEXTPATH_METHODTYPE_ALIGN = SVGTextPathMethodAlign,
106         TEXTPATH_METHODTYPE_STRETCH = SVGTextPathMethodStretch,
107         TEXTPATH_SPACINGTYPE_UNKNOWN = SVGTextPathSpacingUnknown,
108         TEXTPATH_SPACINGTYPE_AUTO = SVGTextPathSpacingAuto,
109         TEXTPATH_SPACINGTYPE_EXACT = SVGTextPathSpacingExact
110     };
111
112     static Ref<SVGTextPathElement> create(const QualifiedName&, Document&);
113
114     const SVGLengthValue& startOffset() const { return m_startOffset.currentValue(attributeOwnerProxy()); }
115     SVGTextPathMethodType method() const { return m_method.currentValue(attributeOwnerProxy()); }
116     SVGTextPathSpacingType spacing() const { return m_spacing.currentValue(attributeOwnerProxy()); }
117
118     RefPtr<SVGAnimatedLength> startOffsetAnimated() { return m_startOffset.animatedProperty(attributeOwnerProxy()); }
119     RefPtr<SVGAnimatedEnumeration> methodAnimated() { return m_method.animatedProperty(attributeOwnerProxy()); }
120     RefPtr<SVGAnimatedEnumeration> spacingAnimated() { return m_spacing.animatedProperty(attributeOwnerProxy()); }
121
122 protected:
123     void didFinishInsertingNode() override;
124
125 private:
126     SVGTextPathElement(const QualifiedName&, Document&);
127     virtual ~SVGTextPathElement();
128
129     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGTextPathElement, SVGTextContentElement, SVGURIReference>;
130     static AttributeOwnerProxy::AttributeRegistry& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
131     static void registerAttributes();
132     const SVGAttributeOwnerProxy& attributeOwnerProxy() const final { return m_attributeOwnerProxy; }
133
134     using PropertyRegistry = SVGPropertyOwnerRegistry<SVGTextPathElement, SVGTextContentElement, SVGURIReference>;
135     const SVGPropertyRegistry& propertyRegistry() const final { return m_propertyRegistry; }
136
137     static bool isKnownAttribute(const QualifiedName& attributeName)
138     {
139         return AttributeOwnerProxy::isKnownAttribute(attributeName) || PropertyRegistry::isKnownAttribute(attributeName);
140     }
141
142     void parseAttribute(const QualifiedName&, const AtomicString&) override;
143     void svgAttributeChanged(const QualifiedName&) override;
144
145     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
146     bool childShouldCreateRenderer(const Node&) const override;
147     bool rendererIsNeeded(const RenderStyle&) override;
148
149     void clearResourceReferences();
150     void buildPendingResource() override;
151     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
152     void removedFromAncestor(RemovalType, ContainerNode&) override;
153
154     bool selfHasRelativeLengths() const override;
155
156     AttributeOwnerProxy m_attributeOwnerProxy { *this };
157     PropertyRegistry m_propertyRegistry { *this };
158     SVGAnimatedLengthAttribute m_startOffset { LengthModeOther };
159     SVGAnimatedEnumerationAttribute<SVGTextPathMethodType> m_method { SVGTextPathMethodAlign };
160     SVGAnimatedEnumerationAttribute<SVGTextPathSpacingType> m_spacing { SVGTextPathSpacingExact };
161 };
162
163 } // namespace WebCore