157c3d7a7866736a666300cdb117016e62d9a373
[WebKit-https.git] / Source / WebCore / svg / SVGTextContentElement.h
1 /*
2  * Copyright (C) 2004, 2005, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2008 Rob Buis <buis@kde.org>
4  * Copyright (C) 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 "SVGAnimatedBoolean.h"
25 #include "SVGAnimatedEnumeration.h"
26 #include "SVGAnimatedLength.h"
27 #include "SVGExternalResourcesRequired.h"
28 #include "SVGGraphicsElement.h"
29
30 namespace WebCore {
31
32 struct DOMPointInit;
33
34 enum SVGLengthAdjustType {
35     SVGLengthAdjustUnknown,
36     SVGLengthAdjustSpacing,
37     SVGLengthAdjustSpacingAndGlyphs
38 };
39
40 template<> struct SVGPropertyTraits<SVGLengthAdjustType> {
41     static unsigned highestEnumValue() { return SVGLengthAdjustSpacingAndGlyphs; }
42
43     static String toString(SVGLengthAdjustType type)
44     {
45         switch (type) {
46         case SVGLengthAdjustUnknown:
47             return emptyString();
48         case SVGLengthAdjustSpacing:
49             return "spacing"_s;
50         case SVGLengthAdjustSpacingAndGlyphs:
51             return "spacingAndGlyphs"_s;
52         }
53
54         ASSERT_NOT_REACHED();
55         return emptyString();
56     }
57
58     static SVGLengthAdjustType fromString(const String& value)
59     {
60         if (value == "spacingAndGlyphs")
61             return SVGLengthAdjustSpacingAndGlyphs;
62         if (value == "spacing")
63             return SVGLengthAdjustSpacing;
64         return SVGLengthAdjustUnknown;
65     }
66 };
67
68 class SVGTextContentElement : public SVGGraphicsElement, public SVGExternalResourcesRequired {
69     WTF_MAKE_ISO_ALLOCATED(SVGTextContentElement);
70 public:
71     enum {
72         LENGTHADJUST_UNKNOWN = SVGLengthAdjustUnknown,
73         LENGTHADJUST_SPACING = SVGLengthAdjustSpacing,
74         LENGTHADJUST_SPACINGANDGLYPHS = SVGLengthAdjustSpacingAndGlyphs
75     };
76
77     unsigned getNumberOfChars();
78     float getComputedTextLength();
79     ExceptionOr<float> getSubStringLength(unsigned charnum, unsigned nchars);
80     ExceptionOr<Ref<SVGPoint>> getStartPositionOfChar(unsigned charnum);
81     ExceptionOr<Ref<SVGPoint>> getEndPositionOfChar(unsigned charnum);
82     ExceptionOr<Ref<SVGRect>> getExtentOfChar(unsigned charnum);
83     ExceptionOr<float> getRotationOfChar(unsigned charnum);
84     int getCharNumAtPosition(DOMPointInit&&);
85     ExceptionOr<void> selectSubString(unsigned charnum, unsigned nchars);
86
87     static SVGTextContentElement* elementFromRenderer(RenderObject*);
88     const SVGLengthValue& specifiedTextLength() { return m_specifiedTextLength; }
89
90     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGTextContentElement, SVGGraphicsElement, SVGExternalResourcesRequired>;
91     static AttributeOwnerProxy::AttributeRegistry& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
92
93     const SVGLengthValue& textLength() const { return m_textLength.currentValue(attributeOwnerProxy()); }
94     SVGLengthAdjustType lengthAdjust() const { return m_lengthAdjust.currentValue(attributeOwnerProxy()); }
95
96     RefPtr<SVGAnimatedLength> textLengthAnimated() { return m_textLength.animatedProperty(attributeOwnerProxy()); }
97     RefPtr<SVGAnimatedEnumeration> lengthAdjustAnimated() { return m_lengthAdjust.animatedProperty(attributeOwnerProxy()); }
98
99 protected:
100     SVGTextContentElement(const QualifiedName&, Document&);
101
102     bool isValid() const override { return SVGTests::isValid(); }
103
104     void parseAttribute(const QualifiedName&, const AtomicString&) override;
105     bool isPresentationAttribute(const QualifiedName&) const override;
106     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
107     void svgAttributeChanged(const QualifiedName&) override;
108
109     bool selfHasRelativeLengths() const override;
110
111 private:
112     bool isTextContent() const final { return true; }
113     const SVGAttributeOwnerProxy& attributeOwnerProxy() const override { return m_attributeOwnerProxy; }
114
115     static void registerAttributes();
116     static bool isKnownAttribute(const QualifiedName& attributeName) { return AttributeOwnerProxy::isKnownAttribute(attributeName); }
117
118     class SVGAnimatedCustomLengthAttribute : public SVGAnimatedLengthAttribute {
119     public:
120         using SVGAnimatedLengthAttribute::operator=;
121
122         SVGAnimatedCustomLengthAttribute(SVGTextContentElement& element, SVGLengthMode lengthMode)
123             : SVGAnimatedLengthAttribute(lengthMode)
124             , m_element(element)
125         {
126         }
127
128         void synchronize(Element&, const QualifiedName& attributeName)
129         {
130             if (!shouldSynchronize())
131                 return;
132             String string(SVGPropertyTraits<SVGLengthValue>::toString(m_element.m_specifiedTextLength));
133             static_cast<Element&>(m_element).setSynchronizedLazyAttribute(attributeName, string);
134         }
135
136         RefPtr<SVGAnimatedLength> animatedProperty(const SVGAttributeOwnerProxy& attributeOwnerProxy)
137         {
138             static NeverDestroyed<SVGLengthValue> defaultTextLength(LengthModeOther);
139             if (m_element.m_specifiedTextLength == defaultTextLength)
140                 m_element.m_textLength.value().newValueSpecifiedUnits(LengthTypeNumber, m_element.getComputedTextLength());
141
142             setShouldSynchronize(true);
143             return static_reference_cast<SVGAnimatedLength>(attributeOwnerProxy.lookupOrCreateAnimatedProperty(*this).releaseNonNull());
144         }
145
146     private:
147         SVGTextContentElement& m_element;
148     };
149
150     using SVGAnimatedCustomLengthAttributeAccessor = SVGAnimatedAttributeAccessor<SVGTextContentElement, SVGAnimatedCustomLengthAttribute, AnimatedLength>;
151
152     AttributeOwnerProxy m_attributeOwnerProxy { *this };
153     SVGAnimatedCustomLengthAttribute m_textLength { *this, LengthModeOther };
154     SVGAnimatedEnumerationAttribute<SVGLengthAdjustType> m_lengthAdjust { SVGLengthAdjustSpacing };
155     SVGLengthValue m_specifiedTextLength { LengthModeOther };
156 };
157
158 } // namespace WebCore
159
160 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::SVGTextContentElement)
161     static bool isType(const WebCore::SVGElement& element) { return element.isTextContent(); }
162     static bool isType(const WebCore::Node& node) { return is<WebCore::SVGElement>(node) && isType(downcast<WebCore::SVGElement>(node)); }
163 SPECIALIZE_TYPE_TRAITS_END()