2011-05-21 Nikolas Zimmermann <nzimmermann@rim.com>
[WebKit-https.git] / Source / WebCore / svg / SVGPathElement.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2007 Rob Buis <buis@kde.org>
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 "SVGPathElement.h"
25
26 #include "Attribute.h"
27 #include "RenderSVGPath.h"
28 #include "RenderSVGResource.h"
29 #include "SVGElementInstance.h"
30 #include "SVGNames.h"
31 #include "SVGPathParserFactory.h"
32 #include "SVGPathSegArc.h"
33 #include "SVGPathSegClosePath.h"
34 #include "SVGPathSegCurvetoCubic.h"
35 #include "SVGPathSegCurvetoCubicSmooth.h"
36 #include "SVGPathSegCurvetoQuadratic.h"
37 #include "SVGPathSegCurvetoQuadraticSmooth.h"
38 #include "SVGPathSegLineto.h"
39 #include "SVGPathSegLinetoHorizontal.h"
40 #include "SVGPathSegLinetoVertical.h"
41 #include "SVGPathSegList.h"
42 #include "SVGPathSegListBuilder.h"
43 #include "SVGPathSegListPropertyTearOff.h"
44 #include "SVGPathSegMoveto.h"
45 #include "SVGSVGElement.h"
46
47 namespace WebCore {
48
49 // Animated property definitions
50 DEFINE_ANIMATED_NUMBER(SVGPathElement, SVGNames::pathLengthAttr, PathLength, pathLength)
51 DEFINE_ANIMATED_BOOLEAN(SVGPathElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
52
53 inline SVGPathElement::SVGPathElement(const QualifiedName& tagName, Document* document)
54     : SVGStyledTransformableElement(tagName, document)
55     , m_pathByteStream(SVGPathByteStream::create())
56     , m_pathSegList(PathSegUnalteredRole)
57 {
58     ASSERT(hasTagName(SVGNames::pathTag));
59 }
60
61 PassRefPtr<SVGPathElement> SVGPathElement::create(const QualifiedName& tagName, Document* document)
62 {
63     return adoptRef(new SVGPathElement(tagName, document));
64 }
65
66 float SVGPathElement::getTotalLength()
67 {
68     float totalLength = 0;
69     SVGPathParserFactory::self()->getTotalLengthOfSVGPathByteStream(m_pathByteStream.get(), totalLength);
70     return totalLength;
71 }
72
73 FloatPoint SVGPathElement::getPointAtLength(float length)
74 {
75     FloatPoint point;
76     SVGPathParserFactory::self()->getPointAtLengthOfSVGPathByteStream(m_pathByteStream.get(), length, point);
77     return point;
78 }
79
80 unsigned long SVGPathElement::getPathSegAtLength(float length)
81 {
82     unsigned long pathSeg = 0;
83     SVGPathParserFactory::self()->getSVGPathSegAtLengthFromSVGPathByteStream(m_pathByteStream.get(), length, pathSeg);
84     return pathSeg;
85 }
86
87 PassRefPtr<SVGPathSegClosePath> SVGPathElement::createSVGPathSegClosePath(SVGPathSegRole role)
88 {
89     return SVGPathSegClosePath::create(this, role);
90 }
91
92 PassRefPtr<SVGPathSegMovetoAbs> SVGPathElement::createSVGPathSegMovetoAbs(float x, float y, SVGPathSegRole role)
93 {
94     return SVGPathSegMovetoAbs::create(this, role, x, y);
95 }
96
97 PassRefPtr<SVGPathSegMovetoRel> SVGPathElement::createSVGPathSegMovetoRel(float x, float y, SVGPathSegRole role)
98 {
99     return SVGPathSegMovetoRel::create(this, role, x, y);
100 }
101
102 PassRefPtr<SVGPathSegLinetoAbs> SVGPathElement::createSVGPathSegLinetoAbs(float x, float y, SVGPathSegRole role)
103 {
104     return SVGPathSegLinetoAbs::create(this, role, x, y);
105 }
106
107 PassRefPtr<SVGPathSegLinetoRel> SVGPathElement::createSVGPathSegLinetoRel(float x, float y, SVGPathSegRole role)
108 {
109     return SVGPathSegLinetoRel::create(this, role, x, y);
110 }
111
112 PassRefPtr<SVGPathSegCurvetoCubicAbs> SVGPathElement::createSVGPathSegCurvetoCubicAbs(float x, float y, float x1, float y1, float x2, float y2, SVGPathSegRole role)
113 {
114     return SVGPathSegCurvetoCubicAbs::create(this, role, x, y, x1, y1, x2, y2);
115 }
116
117 PassRefPtr<SVGPathSegCurvetoCubicRel> SVGPathElement::createSVGPathSegCurvetoCubicRel(float x, float y, float x1, float y1, float x2, float y2, SVGPathSegRole role)
118 {
119     return SVGPathSegCurvetoCubicRel::create(this, role, x, y, x1, y1, x2, y2);
120 }
121
122 PassRefPtr<SVGPathSegCurvetoQuadraticAbs> SVGPathElement::createSVGPathSegCurvetoQuadraticAbs(float x, float y, float x1, float y1, SVGPathSegRole role)
123 {
124     return SVGPathSegCurvetoQuadraticAbs::create(this, role, x, y, x1, y1);
125 }
126
127 PassRefPtr<SVGPathSegCurvetoQuadraticRel> SVGPathElement::createSVGPathSegCurvetoQuadraticRel(float x, float y, float x1, float y1, SVGPathSegRole role)
128 {
129     return SVGPathSegCurvetoQuadraticRel::create(this, role, x, y, x1, y1);
130 }
131
132 PassRefPtr<SVGPathSegArcAbs> SVGPathElement::createSVGPathSegArcAbs(float x, float y, float r1, float r2, float angle, bool largeArcFlag, bool sweepFlag, SVGPathSegRole role)
133 {
134     return SVGPathSegArcAbs::create(this, role, x, y, r1, r2, angle, largeArcFlag, sweepFlag);
135 }
136
137 PassRefPtr<SVGPathSegArcRel> SVGPathElement::createSVGPathSegArcRel(float x, float y, float r1, float r2, float angle, bool largeArcFlag, bool sweepFlag, SVGPathSegRole role)
138 {
139     return SVGPathSegArcRel::create(this, role, x, y, r1, r2, angle, largeArcFlag, sweepFlag);
140 }
141
142 PassRefPtr<SVGPathSegLinetoHorizontalAbs> SVGPathElement::createSVGPathSegLinetoHorizontalAbs(float x, SVGPathSegRole role)
143 {
144     return SVGPathSegLinetoHorizontalAbs::create(this, role, x);
145 }
146
147 PassRefPtr<SVGPathSegLinetoHorizontalRel> SVGPathElement::createSVGPathSegLinetoHorizontalRel(float x, SVGPathSegRole role)
148 {
149     return SVGPathSegLinetoHorizontalRel::create(this, role, x);
150 }
151
152 PassRefPtr<SVGPathSegLinetoVerticalAbs> SVGPathElement::createSVGPathSegLinetoVerticalAbs(float y, SVGPathSegRole role)
153 {
154     return SVGPathSegLinetoVerticalAbs::create(this, role, y);
155 }
156
157 PassRefPtr<SVGPathSegLinetoVerticalRel> SVGPathElement::createSVGPathSegLinetoVerticalRel(float y, SVGPathSegRole role)
158 {
159     return SVGPathSegLinetoVerticalRel::create(this, role, y);
160 }
161
162 PassRefPtr<SVGPathSegCurvetoCubicSmoothAbs> SVGPathElement::createSVGPathSegCurvetoCubicSmoothAbs(float x, float y, float x2, float y2, SVGPathSegRole role)
163 {
164     return SVGPathSegCurvetoCubicSmoothAbs::create(this, role, x, y, x2, y2);
165 }
166
167 PassRefPtr<SVGPathSegCurvetoCubicSmoothRel> SVGPathElement::createSVGPathSegCurvetoCubicSmoothRel(float x, float y, float x2, float y2, SVGPathSegRole role)
168 {
169     return SVGPathSegCurvetoCubicSmoothRel::create(this, role, x, y, x2, y2);
170 }
171
172 PassRefPtr<SVGPathSegCurvetoQuadraticSmoothAbs> SVGPathElement::createSVGPathSegCurvetoQuadraticSmoothAbs(float x, float y, SVGPathSegRole role)
173 {
174     return SVGPathSegCurvetoQuadraticSmoothAbs::create(this, role, x, y);
175 }
176
177 PassRefPtr<SVGPathSegCurvetoQuadraticSmoothRel> SVGPathElement::createSVGPathSegCurvetoQuadraticSmoothRel(float x, float y, SVGPathSegRole role)
178 {
179     return SVGPathSegCurvetoQuadraticSmoothRel::create(this, role, x, y);
180 }
181
182 bool SVGPathElement::isSupportedAttribute(const QualifiedName& attrName)
183 {
184     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
185     if (supportedAttributes.isEmpty()) {
186         SVGTests::addSupportedAttributes(supportedAttributes);
187         SVGLangSpace::addSupportedAttributes(supportedAttributes);
188         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
189         supportedAttributes.add(SVGNames::dAttr);
190         supportedAttributes.add(SVGNames::pathLengthAttr);
191     }
192     return supportedAttributes.contains(attrName);
193 }
194
195 void SVGPathElement::parseMappedAttribute(Attribute* attr)
196 {
197     if (!isSupportedAttribute(attr->name())) {
198         SVGStyledTransformableElement::parseMappedAttribute(attr);
199         return;
200     }
201
202     if (attr->name() == SVGNames::dAttr) {
203         SVGPathParserFactory* factory = SVGPathParserFactory::self();
204         if (!factory->buildSVGPathByteStreamFromString(attr->value(), m_pathByteStream, UnalteredParsing))
205             document()->accessSVGExtensions()->reportError("Problem parsing d=\"" + attr->value() + "\"");
206         return;
207     }
208
209     if (attr->name() == SVGNames::pathLengthAttr) {
210         setPathLengthBaseValue(attr->value().toFloat());
211         if (pathLengthBaseValue() < 0)
212             document()->accessSVGExtensions()->reportError("A negative value for path attribute <pathLength> is not allowed");
213         return;
214     }
215
216     if (SVGTests::parseMappedAttribute(attr))
217         return;
218     if (SVGLangSpace::parseMappedAttribute(attr))
219         return;
220     if (SVGExternalResourcesRequired::parseMappedAttribute(attr))
221         return;
222
223     ASSERT_NOT_REACHED();
224 }
225
226 void SVGPathElement::svgAttributeChanged(const QualifiedName& attrName)
227 {
228     if (!isSupportedAttribute(attrName)) {
229         SVGStyledTransformableElement::svgAttributeChanged(attrName);
230         return;
231     }
232
233     SVGElementInstance::InvalidationGuard invalidationGuard(this);
234     
235     if (SVGTests::handleAttributeChange(this, attrName))
236         return;
237
238     RenderSVGPath* renderer = static_cast<RenderSVGPath*>(this->renderer());
239
240     if (attrName == SVGNames::dAttr) {
241         if (m_animatablePathSegList) {
242             SVGPathSegList newList(PathSegUnalteredRole);
243             SVGPathParserFactory* factory = SVGPathParserFactory::self();
244             factory->buildSVGPathSegListFromByteStream(m_pathByteStream.get(), this, newList, UnalteredParsing);
245             m_pathSegList.value = newList;
246         }
247
248         if (renderer)
249             renderer->setNeedsPathUpdate();
250     }
251
252     if (renderer)
253         RenderSVGResource::markForLayoutAndParentResourceInvalidation(renderer);
254 }
255
256 void SVGPathElement::synchronizeProperty(const QualifiedName& attrName)
257 {
258     if (attrName == anyQName()) {
259         synchronizeD();
260         synchronizePathLength();
261         synchronizeExternalResourcesRequired();
262         SVGTests::synchronizeProperties(this, attrName);
263         SVGStyledTransformableElement::synchronizeProperty(attrName);
264         return;
265     }
266
267     if (!isSupportedAttribute(attrName)) {
268         SVGStyledTransformableElement::synchronizeProperty(attrName);
269         return;
270     }
271
272     if (attrName == SVGNames::dAttr) {
273         synchronizeD();
274         return;
275     }
276
277     if (attrName == SVGNames::pathLengthAttr) {
278         synchronizePathLength();
279         return;
280     }
281
282     if (SVGExternalResourcesRequired::isKnownAttribute(attrName)) {
283         synchronizeExternalResourcesRequired();
284         return;
285     }
286
287     if (SVGTests::isKnownAttribute(attrName)) {
288         SVGTests::synchronizeProperties(this, attrName);
289         return;
290     }
291
292     ASSERT_NOT_REACHED();
293 }
294
295 void SVGPathElement::synchronizeD()
296 {
297     if (!m_pathSegList.shouldSynchronize)
298         return;
299
300     SVGAnimatedPropertySynchronizer<true>::synchronize(this, SVGNames::dAttr, m_pathSegList.value.valueAsString());
301 }
302
303 AttributeToPropertyTypeMap& SVGPathElement::attributeToPropertyTypeMap()
304 {
305     DEFINE_STATIC_LOCAL(AttributeToPropertyTypeMap, s_attributeToPropertyTypeMap, ());
306     return s_attributeToPropertyTypeMap;
307 }
308
309 void SVGPathElement::fillAttributeToPropertyTypeMap()
310 {
311     AttributeToPropertyTypeMap& attributeToPropertyTypeMap = this->attributeToPropertyTypeMap();
312
313     SVGStyledTransformableElement::fillPassedAttributeToPropertyTypeMap(attributeToPropertyTypeMap);
314     attributeToPropertyTypeMap.set(SVGNames::dAttr, AnimatedPath);
315     attributeToPropertyTypeMap.set(SVGNames::pathLengthAttr, AnimatedNumber);
316 }
317
318 SVGPathSegListPropertyTearOff* SVGPathElement::pathSegList()
319 {
320     if (!m_animatablePathSegList) {
321         m_pathSegList.shouldSynchronize = true;
322
323         SVGPathParserFactory* factory = SVGPathParserFactory::self();
324         factory->buildSVGPathSegListFromByteStream(m_pathByteStream.get(), this, m_pathSegList.value, UnalteredParsing);
325
326         m_animatablePathSegList = SVGAnimatedProperty::lookupOrCreateWrapper<SVGAnimatedPathSegListPropertyTearOff, SVGPathSegList>
327                                  (this, SVGNames::dAttr, SVGNames::dAttr.localName(), m_pathSegList.value);
328     }
329
330     return static_cast<SVGPathSegListPropertyTearOff*>(m_animatablePathSegList->baseVal(PathSegUnalteredRole));
331 }
332
333 SVGPathSegListPropertyTearOff* SVGPathElement::normalizedPathSegList()
334 {
335     // FIXME: https://bugs.webkit.org/show_bug.cgi?id=15412 - Implement normalized path segment lists!
336     return 0;
337 }
338
339 SVGPathSegListPropertyTearOff* SVGPathElement::animatedPathSegList()
340 {
341     if (!m_animatablePathSegList) {
342         m_pathSegList.shouldSynchronize = true;
343
344         SVGPathParserFactory* factory = SVGPathParserFactory::self();
345         factory->buildSVGPathSegListFromByteStream(m_pathByteStream.get(), this, m_pathSegList.value, UnalteredParsing);
346
347         m_animatablePathSegList = SVGAnimatedProperty::lookupOrCreateWrapper<SVGAnimatedPathSegListPropertyTearOff, SVGPathSegList>
348                                  (this, SVGNames::dAttr, SVGNames::dAttr.localName(), m_pathSegList.value);
349     }
350
351     return static_cast<SVGPathSegListPropertyTearOff*>(m_animatablePathSegList->animVal(PathSegUnalteredRole));
352 }
353
354 SVGPathSegListPropertyTearOff* SVGPathElement::animatedNormalizedPathSegList()
355 {
356     // FIXME: https://bugs.webkit.org/show_bug.cgi?id=15412 - Implement normalized path segment lists!
357     return 0;
358 }
359
360 void SVGPathElement::toPathData(Path& path) const
361 {
362     ASSERT(path.isEmpty());
363
364     SVGPathParserFactory* factory = SVGPathParserFactory::self();
365     factory->buildPathFromByteStream(m_pathByteStream.get(), path);
366 }
367
368 void SVGPathElement::pathSegListChanged(SVGPathSegRole role)
369 {
370     SVGPathParserFactory* factory = SVGPathParserFactory::self();
371
372     switch (role) {
373     case PathSegNormalizedRole:
374         // FIXME: https://bugs.webkit.org/show_bug.cgi?id=15412 - Implement normalized path segment lists!
375         break;
376     case PathSegUnalteredRole:
377         m_pathByteStream->clear();
378         factory->buildSVGPathByteStreamFromSVGPathSegList(m_pathSegList.value, m_pathByteStream, UnalteredParsing);
379         break;
380     case PathSegUndefinedRole:
381         return;
382     }
383
384     invalidateSVGAttributes();
385
386     RenderSVGPath* renderer = static_cast<RenderSVGPath*>(this->renderer());
387     if (!renderer)
388         return;
389
390     renderer->setNeedsPathUpdate();
391     RenderSVGResource::markForLayoutAndParentResourceInvalidation(renderer);
392 }
393
394 }
395
396 #endif // ENABLE(SVG)