9c3cd1030f718be7cd1ab1f13c2a32bfd1736aa1
[WebKit-https.git] / Source / WebCore / svg / SVGTextPathElement.cpp
1 /*
2  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2010 Rob Buis <rwlbuis@gmail.com>
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 #include "config.h"
22 #include "SVGTextPathElement.h"
23
24 #include "RenderSVGResource.h"
25 #include "RenderSVGTextPath.h"
26 #include "SVGNames.h"
27 #include "XLinkNames.h"
28 #include <wtf/NeverDestroyed.h>
29
30 namespace WebCore {
31
32 // Animated property definitions
33 DEFINE_ANIMATED_LENGTH(SVGTextPathElement, SVGNames::startOffsetAttr, StartOffset, startOffset)
34 DEFINE_ANIMATED_ENUMERATION(SVGTextPathElement, SVGNames::methodAttr, Method, method, SVGTextPathMethodType)
35 DEFINE_ANIMATED_ENUMERATION(SVGTextPathElement, SVGNames::spacingAttr, Spacing, spacing, SVGTextPathSpacingType)
36 DEFINE_ANIMATED_STRING(SVGTextPathElement, XLinkNames::hrefAttr, Href, href)
37
38 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGTextPathElement)
39     REGISTER_LOCAL_ANIMATED_PROPERTY(startOffset)
40     REGISTER_LOCAL_ANIMATED_PROPERTY(method)
41     REGISTER_LOCAL_ANIMATED_PROPERTY(spacing)
42     REGISTER_LOCAL_ANIMATED_PROPERTY(href)
43     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGTextContentElement)
44 END_REGISTER_ANIMATED_PROPERTIES
45
46 inline SVGTextPathElement::SVGTextPathElement(const QualifiedName& tagName, Document& document)
47     : SVGTextContentElement(tagName, document)
48     , m_startOffset(LengthModeOther)
49     , m_method(SVGTextPathMethodAlign)
50     , m_spacing(SVGTextPathSpacingExact)
51 {
52     ASSERT(hasTagName(SVGNames::textPathTag));
53     registerAnimatedPropertiesForSVGTextPathElement();
54 }
55
56 Ref<SVGTextPathElement> SVGTextPathElement::create(const QualifiedName& tagName, Document& document)
57 {
58     return adoptRef(*new SVGTextPathElement(tagName, document));
59 }
60
61 SVGTextPathElement::~SVGTextPathElement()
62 {
63     clearResourceReferences();
64 }
65
66 void SVGTextPathElement::clearResourceReferences()
67 {
68     document().accessSVGExtensions().removeAllTargetReferencesForElement(this);
69 }
70
71 bool SVGTextPathElement::isSupportedAttribute(const QualifiedName& attrName)
72 {
73     static NeverDestroyed<HashSet<QualifiedName>> supportedAttributes;
74     if (supportedAttributes.get().isEmpty()) {
75         SVGURIReference::addSupportedAttributes(supportedAttributes);
76         supportedAttributes.get().add(SVGNames::startOffsetAttr);
77         supportedAttributes.get().add(SVGNames::methodAttr);
78         supportedAttributes.get().add(SVGNames::spacingAttr);
79     }
80     return supportedAttributes.get().contains<SVGAttributeHashTranslator>(attrName);
81 }
82
83 void SVGTextPathElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
84 {
85     SVGParsingError parseError = NoError;
86
87     if (name == SVGNames::startOffsetAttr)
88         setStartOffsetBaseValue(SVGLength::construct(LengthModeOther, value, parseError));
89     else if (name == SVGNames::methodAttr) {
90         SVGTextPathMethodType propertyValue = SVGPropertyTraits<SVGTextPathMethodType>::fromString(value);
91         if (propertyValue > 0)
92             setMethodBaseValue(propertyValue);
93     } else if (name == SVGNames::spacingAttr) {
94         SVGTextPathSpacingType propertyValue = SVGPropertyTraits<SVGTextPathSpacingType>::fromString(value);
95         if (propertyValue > 0)
96             setSpacingBaseValue(propertyValue);
97     }
98
99     reportAttributeParsingError(parseError, name, value);
100
101     SVGTextContentElement::parseAttribute(name, value);
102     SVGURIReference::parseAttribute(name, value);
103 }
104
105 void SVGTextPathElement::svgAttributeChanged(const QualifiedName& attrName)
106 {
107     if (!isSupportedAttribute(attrName)) {
108         SVGTextContentElement::svgAttributeChanged(attrName);
109         return;
110     }
111
112     InstanceInvalidationGuard guard(*this);
113
114     if (SVGURIReference::isKnownAttribute(attrName)) {
115         buildPendingResource();
116         return;
117     }
118
119     if (attrName == SVGNames::startOffsetAttr)
120         updateRelativeLengthsInformation();
121
122     if (auto renderer = this->renderer())
123         RenderSVGResource::markForLayoutAndParentResourceInvalidation(*renderer);
124 }
125
126 RenderPtr<RenderElement> SVGTextPathElement::createElementRenderer(Ref<RenderStyle>&& style, const RenderTreePosition&)
127 {
128     return createRenderer<RenderSVGTextPath>(*this, WTFMove(style));
129 }
130
131 bool SVGTextPathElement::childShouldCreateRenderer(const Node& child) const
132 {
133     if (child.isTextNode()
134         || child.hasTagName(SVGNames::aTag)
135         || child.hasTagName(SVGNames::trefTag)
136         || child.hasTagName(SVGNames::tspanTag))
137         return true;
138
139     return false;
140 }
141
142 bool SVGTextPathElement::rendererIsNeeded(const RenderStyle& style)
143 {
144     if (parentNode()
145         && (parentNode()->hasTagName(SVGNames::aTag)
146             || parentNode()->hasTagName(SVGNames::textTag)))
147         return StyledElement::rendererIsNeeded(style);
148
149     return false;
150 }
151
152 void SVGTextPathElement::buildPendingResource()
153 {
154     clearResourceReferences();
155     if (!inDocument())
156         return;
157
158     String id;
159     Element* target = SVGURIReference::targetElementFromIRIString(href(), document(), &id);
160     if (!target) {
161         // Do not register as pending if we are already pending this resource.
162         if (document().accessSVGExtensions().isPendingResource(this, id))
163             return;
164
165         if (!id.isEmpty()) {
166             document().accessSVGExtensions().addPendingResource(id, this);
167             ASSERT(hasPendingResources());
168         }
169     } else if (target->hasTagName(SVGNames::pathTag)) {
170         // Register us with the target in the dependencies map. Any change of hrefElement
171         // that leads to relayout/repainting now informs us, so we can react to it.
172         document().accessSVGExtensions().addElementReferencingTarget(this, downcast<SVGElement>(target));
173     }
174 }
175
176 Node::InsertionNotificationRequest SVGTextPathElement::insertedInto(ContainerNode& rootParent)
177 {
178     SVGTextContentElement::insertedInto(rootParent);
179     return InsertionShouldCallFinishedInsertingSubtree;
180 }
181
182 void SVGTextPathElement::finishedInsertingSubtree()
183 {
184     buildPendingResource();
185 }
186
187 void SVGTextPathElement::removedFrom(ContainerNode& rootParent)
188 {
189     SVGTextContentElement::removedFrom(rootParent);
190     if (rootParent.inDocument())
191         clearResourceReferences();
192 }
193
194 bool SVGTextPathElement::selfHasRelativeLengths() const
195 {
196     return startOffset().isRelative()
197         || SVGTextContentElement::selfHasRelativeLengths();
198 }
199
200 }