Bug 15799: textPath element does not re-render when referenced path changes
[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
23 #if ENABLE(SVG)
24 #include "SVGTextPathElement.h"
25
26 #include "Attribute.h"
27 #include "NodeRenderingContext.h"
28 #include "RenderSVGResource.h"
29 #include "RenderSVGTextPath.h"
30 #include "SVGElementInstance.h"
31 #include "SVGNames.h"
32
33 namespace WebCore {
34
35 // Animated property definitions
36 DEFINE_ANIMATED_LENGTH(SVGTextPathElement, SVGNames::startOffsetAttr, StartOffset, startOffset)
37 DEFINE_ANIMATED_ENUMERATION(SVGTextPathElement, SVGNames::methodAttr, Method, method, SVGTextPathMethodType)
38 DEFINE_ANIMATED_ENUMERATION(SVGTextPathElement, SVGNames::spacingAttr, Spacing, spacing, SVGTextPathSpacingType)
39 DEFINE_ANIMATED_STRING(SVGTextPathElement, XLinkNames::hrefAttr, Href, href)
40
41 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGTextPathElement)
42     REGISTER_LOCAL_ANIMATED_PROPERTY(startOffset)
43     REGISTER_LOCAL_ANIMATED_PROPERTY(method)
44     REGISTER_LOCAL_ANIMATED_PROPERTY(spacing)
45     REGISTER_LOCAL_ANIMATED_PROPERTY(href)
46     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGTextContentElement)
47 END_REGISTER_ANIMATED_PROPERTIES
48
49 inline SVGTextPathElement::SVGTextPathElement(const QualifiedName& tagName, Document* document)
50     : SVGTextContentElement(tagName, document)
51     , m_startOffset(LengthModeOther)
52     , m_method(SVGTextPathMethodAlign)
53     , m_spacing(SVGTextPathSpacingExact)
54 {
55     ASSERT(hasTagName(SVGNames::textPathTag));
56     registerAnimatedPropertiesForSVGTextPathElement();
57 }
58
59 PassRefPtr<SVGTextPathElement> SVGTextPathElement::create(const QualifiedName& tagName, Document* document)
60 {
61     return adoptRef(new SVGTextPathElement(tagName, document));
62 }
63
64 SVGTextPathElement::~SVGTextPathElement()
65 {
66     clearResourceReferences();
67 }
68
69 void SVGTextPathElement::clearResourceReferences()
70 {
71     ASSERT(document());
72     document()->accessSVGExtensions()->removeAllTargetReferencesForElement(this);
73 }
74
75 bool SVGTextPathElement::isSupportedAttribute(const QualifiedName& attrName)
76 {
77     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
78     if (supportedAttributes.isEmpty()) {
79         SVGURIReference::addSupportedAttributes(supportedAttributes);
80         supportedAttributes.add(SVGNames::startOffsetAttr);
81         supportedAttributes.add(SVGNames::methodAttr);
82         supportedAttributes.add(SVGNames::spacingAttr);
83     }
84     return supportedAttributes.contains<QualifiedName, SVGAttributeHashTranslator>(attrName);
85 }
86
87 void SVGTextPathElement::parseAttribute(const Attribute& attribute)
88 {
89     SVGParsingError parseError = NoError;
90     const AtomicString& value = attribute.value();
91
92     if (!isSupportedAttribute(attribute.name()))
93         SVGTextContentElement::parseAttribute(attribute);
94     else if (attribute.name() == SVGNames::startOffsetAttr)
95         setStartOffsetBaseValue(SVGLength::construct(LengthModeOther, value, parseError));
96     else if (attribute.name() == SVGNames::methodAttr) {
97         SVGTextPathMethodType propertyValue = SVGPropertyTraits<SVGTextPathMethodType>::fromString(value);
98         if (propertyValue > 0)
99             setMethodBaseValue(propertyValue);
100     } else if (attribute.name() == SVGNames::spacingAttr) {
101         SVGTextPathSpacingType propertyValue = SVGPropertyTraits<SVGTextPathSpacingType>::fromString(value);
102         if (propertyValue > 0)
103             setSpacingBaseValue(propertyValue);
104     } else if (SVGURIReference::parseAttribute(attribute)) {
105     } else
106         ASSERT_NOT_REACHED();
107
108     reportAttributeParsingError(parseError, attribute);
109 }
110
111 void SVGTextPathElement::svgAttributeChanged(const QualifiedName& attrName)
112 {
113     if (!isSupportedAttribute(attrName)) {
114         SVGTextContentElement::svgAttributeChanged(attrName);
115         return;
116     }
117
118     SVGElementInstance::InvalidationGuard invalidationGuard(this);
119
120     if (SVGURIReference::isKnownAttribute(attrName)) {
121         buildPendingResource();
122         return;
123     }
124
125     if (attrName == SVGNames::startOffsetAttr)
126         updateRelativeLengthsInformation();
127
128     if (RenderObject* object = renderer())
129         RenderSVGResource::markForLayoutAndParentResourceInvalidation(object);
130 }
131
132 RenderObject* SVGTextPathElement::createRenderer(RenderArena* arena, RenderStyle*)
133 {
134     return new (arena) RenderSVGTextPath(this);
135 }
136
137 bool SVGTextPathElement::childShouldCreateRenderer(const NodeRenderingContext& childContext) const
138 {
139     if (childContext.node()->isTextNode()
140         || childContext.node()->hasTagName(SVGNames::aTag)
141         || childContext.node()->hasTagName(SVGNames::trefTag)
142         || childContext.node()->hasTagName(SVGNames::tspanTag))
143         return true;
144
145     return false;
146 }
147
148 bool SVGTextPathElement::rendererIsNeeded(const NodeRenderingContext& context)
149 {
150     if (parentNode()
151         && (parentNode()->hasTagName(SVGNames::aTag)
152             || parentNode()->hasTagName(SVGNames::textTag)))
153         return StyledElement::rendererIsNeeded(context);
154
155     return false;
156 }
157
158 void SVGTextPathElement::buildPendingResource()
159 {
160     clearResourceReferences();
161     if (!inDocument())
162         return;
163
164     String id;
165     Element* target = SVGURIReference::targetElementFromIRIString(href(), document(), &id);
166     if (!target) {
167         if (hasPendingResources() || id.isEmpty())
168             return;
169
170         document()->accessSVGExtensions()->addPendingResource(id, this);
171         ASSERT(hasPendingResources());
172     } else if (target->isSVGElement()) {
173         // Register us with the target in the dependencies map. Any change of hrefElement
174         // that leads to relayout/repainting now informs us, so we can react to it.
175         document()->accessSVGExtensions()->addElementReferencingTarget(this, static_cast<SVGElement*>(target));
176     }
177 }
178
179 Node::InsertionNotificationRequest SVGTextPathElement::insertedInto(ContainerNode* rootParent)
180 {
181     SVGTextContentElement::insertedInto(rootParent);
182     buildPendingResource();
183     return InsertionDone;
184 }
185
186 void SVGTextPathElement::removedFrom(ContainerNode* rootParent)
187 {
188     SVGTextContentElement::removedFrom(rootParent);
189     if (rootParent->inDocument())
190         clearResourceReferences();
191 }
192
193 bool SVGTextPathElement::selfHasRelativeLengths() const
194 {
195     return startOffset().isRelative()
196         || SVGTextContentElement::selfHasRelativeLengths();
197 }
198
199 }
200
201 #endif // ENABLE(SVG)