99134b2109229480728574d9bc10b4f1739a4624
[WebKit-https.git] / Source / WebCore / svg / SVGElement.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2008 Rob Buis <buis@kde.org>
4  * Copyright (C) 2008 Apple Inc. All rights reserved.
5  * Copyright (C) 2008 Alp Toker <alp@atoker.com>
6  * Copyright (C) 2009 Cameron McCormack <cam@mcc.id.au>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25
26 #if ENABLE(SVG)
27 #include "SVGElement.h"
28
29 #include "Attribute.h"
30 #include "CSSCursorImageValue.h"
31 #include "DOMImplementation.h"
32 #include "Document.h"
33 #include "Event.h"
34 #include "EventListener.h"
35 #include "EventNames.h"
36 #include "FrameView.h"
37 #include "HTMLNames.h"
38 #include "RegisteredEventListener.h"
39 #include "RenderObject.h"
40 #include "SVGCursorElement.h"
41 #include "SVGDocumentExtensions.h"
42 #include "SVGElementInstance.h"
43 #include "SVGElementRareData.h"
44 #include "SVGNames.h"
45 #include "SVGSVGElement.h"
46 #include "SVGStyledLocatableElement.h"
47 #include "SVGTextElement.h"
48 #include "SVGURIReference.h"
49 #include "SVGUseElement.h"
50 #include "ScriptEventListener.h"
51 #include "XMLNames.h"
52
53 namespace WebCore {
54
55 using namespace HTMLNames;
56
57 SVGElement::SVGElement(const QualifiedName& tagName, Document* document)
58     : StyledElement(tagName, document, CreateSVGElement)
59 {
60 }
61
62 PassRefPtr<SVGElement> SVGElement::create(const QualifiedName& tagName, Document* document)
63 {
64     return adoptRef(new SVGElement(tagName, document));
65 }
66
67 SVGElement::~SVGElement()
68 {
69     if (!hasRareSVGData())
70         ASSERT(!SVGElementRareData::rareDataMap().contains(this));
71     else {
72         SVGElementRareData::SVGElementRareDataMap& rareDataMap = SVGElementRareData::rareDataMap();
73         SVGElementRareData::SVGElementRareDataMap::iterator it = rareDataMap.find(this);
74         ASSERT(it != rareDataMap.end());
75
76         SVGElementRareData* rareData = it->second;
77         if (SVGCursorElement* cursorElement = rareData->cursorElement())
78             cursorElement->removeClient(this);
79         if (CSSCursorImageValue* cursorImageValue = rareData->cursorImageValue())
80             cursorImageValue->removeReferencedElement(this);
81
82         delete rareData;
83         rareDataMap.remove(it);
84     }
85 }
86
87 SVGElementRareData* SVGElement::rareSVGData() const
88 {
89     ASSERT(hasRareSVGData());
90     return SVGElementRareData::rareDataFromMap(this);
91 }
92
93 SVGElementRareData* SVGElement::ensureRareSVGData()
94 {
95     if (hasRareSVGData())
96         return rareSVGData();
97
98     ASSERT(!SVGElementRareData::rareDataMap().contains(this));
99     SVGElementRareData* data = new SVGElementRareData;
100     SVGElementRareData::rareDataMap().set(this, data);
101     setHasRareSVGData();
102     return data;
103 }
104
105 bool SVGElement::isSupported(StringImpl* feature, StringImpl* version) const
106 {
107     return DOMImplementation::hasFeature(feature, version);
108 }
109
110 String SVGElement::xmlbase() const
111 {
112     return getAttribute(XMLNames::baseAttr);
113 }
114
115 void SVGElement::setXmlbase(const String& value, ExceptionCode&)
116 {
117     setAttribute(XMLNames::baseAttr, value);
118 }
119
120 SVGSVGElement* SVGElement::ownerSVGElement() const
121 {
122     ContainerNode* n = parentOrHostNode();
123     while (n) {
124         if (n->hasTagName(SVGNames::svgTag))
125             return static_cast<SVGSVGElement*>(n);
126
127         n = n->parentOrHostNode();
128     }
129
130     return 0;
131 }
132
133 SVGElement* SVGElement::viewportElement() const
134 {
135     // This function needs shadow tree support - as RenderSVGContainer uses this function
136     // to determine the "overflow" property. <use> on <symbol> wouldn't work otherwhise.
137     ContainerNode* n = parentOrHostNode();
138     while (n) {
139         if (n->hasTagName(SVGNames::svgTag) || n->hasTagName(SVGNames::imageTag) || n->hasTagName(SVGNames::symbolTag))
140             return static_cast<SVGElement*>(n);
141
142         n = n->parentOrHostNode();
143     }
144
145     return 0;
146 }
147
148 SVGDocumentExtensions* SVGElement::accessDocumentSVGExtensions() const
149 {
150     // This function is provided for use by SVGAnimatedProperty to avoid
151     // global inclusion of Document.h in SVG code.
152     return document() ? document()->accessSVGExtensions() : 0;
153 }
154  
155 void SVGElement::mapInstanceToElement(SVGElementInstance* instance)
156 {
157     ASSERT(instance);
158
159     HashSet<SVGElementInstance*>& instances = ensureRareSVGData()->elementInstances();
160     ASSERT(!instances.contains(instance));
161
162     instances.add(instance);
163 }
164  
165 void SVGElement::removeInstanceMapping(SVGElementInstance* instance)
166 {
167     ASSERT(instance);
168     ASSERT(hasRareSVGData());
169
170     HashSet<SVGElementInstance*>& instances = rareSVGData()->elementInstances();
171     ASSERT(instances.contains(instance));
172
173     instances.remove(instance);
174 }
175
176 const HashSet<SVGElementInstance*>& SVGElement::instancesForElement() const
177 {
178     if (!hasRareSVGData()) {
179         DEFINE_STATIC_LOCAL(HashSet<SVGElementInstance*>, emptyInstances, ());
180         return emptyInstances;
181     }
182     return rareSVGData()->elementInstances();
183 }
184
185 bool SVGElement::boundingBox(FloatRect& rect, SVGLocatable::StyleUpdateStrategy styleUpdateStrategy) const
186 {
187     if (isStyledLocatable()) {
188         rect = static_cast<const SVGStyledLocatableElement*>(this)->getBBox(styleUpdateStrategy);
189         return true;
190     }
191     if (hasTagName(SVGNames::textTag)) {
192         rect = static_cast<const SVGTextElement*>(this)->getBBox(styleUpdateStrategy);
193         return true;
194     }
195     return false;
196 }
197
198 void SVGElement::setCursorElement(SVGCursorElement* cursorElement)
199 {
200     SVGElementRareData* rareData = ensureRareSVGData();
201     if (SVGCursorElement* oldCursorElement = rareData->cursorElement()) {
202         if (cursorElement == oldCursorElement)
203             return;
204         oldCursorElement->removeReferencedElement(this);
205     }
206     rareData->setCursorElement(cursorElement);
207 }
208
209 void SVGElement::cursorElementRemoved() 
210 {
211     ASSERT(hasRareSVGData());
212     rareSVGData()->setCursorElement(0);
213 }
214
215 void SVGElement::setCursorImageValue(CSSCursorImageValue* cursorImageValue)
216 {
217     SVGElementRareData* rareData = ensureRareSVGData();
218     if (CSSCursorImageValue* oldCursorImageValue = rareData->cursorImageValue()) {
219         if (cursorImageValue == oldCursorImageValue)
220             return;
221         oldCursorImageValue->removeReferencedElement(this);
222     }
223     rareData->setCursorImageValue(cursorImageValue);
224 }
225
226 void SVGElement::cursorImageValueRemoved()
227 {
228     ASSERT(hasRareSVGData());
229     rareSVGData()->setCursorImageValue(0);
230 }
231
232 void SVGElement::parseMappedAttribute(Attribute* attr)
233 {
234     // standard events
235     if (attr->name() == onloadAttr)
236         setAttributeEventListener(eventNames().loadEvent, createAttributeEventListener(this, attr));
237     else if (attr->name() == onclickAttr)
238         setAttributeEventListener(eventNames().clickEvent, createAttributeEventListener(this, attr));
239     else if (attr->name() == onmousedownAttr)
240         setAttributeEventListener(eventNames().mousedownEvent, createAttributeEventListener(this, attr));
241     else if (attr->name() == onmousemoveAttr)
242         setAttributeEventListener(eventNames().mousemoveEvent, createAttributeEventListener(this, attr));
243     else if (attr->name() == onmouseoutAttr)
244         setAttributeEventListener(eventNames().mouseoutEvent, createAttributeEventListener(this, attr));
245     else if (attr->name() == onmouseoverAttr)
246         setAttributeEventListener(eventNames().mouseoverEvent, createAttributeEventListener(this, attr));
247     else if (attr->name() == onmouseupAttr)
248         setAttributeEventListener(eventNames().mouseupEvent, createAttributeEventListener(this, attr));
249     else if (attr->name() == SVGNames::onfocusinAttr)
250         setAttributeEventListener(eventNames().focusinEvent, createAttributeEventListener(this, attr));
251     else if (attr->name() == SVGNames::onfocusoutAttr)
252         setAttributeEventListener(eventNames().focusoutEvent, createAttributeEventListener(this, attr));
253     else if (attr->name() == SVGNames::onactivateAttr)
254         setAttributeEventListener(eventNames().DOMActivateEvent, createAttributeEventListener(this, attr));
255     else
256         StyledElement::parseMappedAttribute(attr);
257 }
258
259 AttributeToPropertyTypeMap& SVGElement::attributeToPropertyTypeMap()
260 {
261     DEFINE_STATIC_LOCAL(AttributeToPropertyTypeMap, s_attributeToPropertyTypeMap, ());
262     return s_attributeToPropertyTypeMap;
263 }
264
265 AnimatedAttributeType SVGElement::animatedPropertyTypeForAttribute(const QualifiedName& attrName)
266 {
267     AttributeToPropertyTypeMap& animatedAttributeMap = attributeToPropertyTypeMap();
268     if (animatedAttributeMap.isEmpty())
269         fillAttributeToPropertyTypeMap();
270     if (animatedAttributeMap.contains(attrName))
271         return animatedAttributeMap.get(attrName);
272     if (isStyled())
273         return static_cast<SVGStyledElement*>(this)->animatedPropertyTypeForCSSProperty(attrName);
274
275     return AnimatedUnknown;
276 }
277
278 bool SVGElement::haveLoadedRequiredResources()
279 {
280     Node* child = firstChild();
281     while (child) {
282         if (child->isSVGElement() && !static_cast<SVGElement*>(child)->haveLoadedRequiredResources())
283             return false;
284         child = child->nextSibling();
285     }
286     return true;
287 }
288
289 static bool hasLoadListener(Node* node)
290 {
291     if (node->hasEventListeners(eventNames().loadEvent))
292         return true;
293
294     for (node = node->parentNode(); node && node->isElementNode(); node = node->parentNode()) {
295         const EventListenerVector& entry = node->getEventListeners(eventNames().loadEvent);
296         for (size_t i = 0; i < entry.size(); ++i) {
297             if (entry[i].useCapture)
298                 return true;
299         }
300     }
301
302     return false;
303 }
304
305 void SVGElement::sendSVGLoadEventIfPossible(bool sendParentLoadEvents)
306 {
307     RefPtr<SVGElement> currentTarget = this;
308     while (currentTarget && currentTarget->haveLoadedRequiredResources()) {
309         RefPtr<Node> parent;
310         if (sendParentLoadEvents)
311             parent = currentTarget->parentNode(); // save the next parent to dispatch too incase dispatching the event changes the tree
312         if (hasLoadListener(currentTarget.get())) {
313             RefPtr<Event> event = Event::create(eventNames().loadEvent, false, false);
314             event->setTarget(currentTarget);
315             currentTarget->dispatchGenericEvent(event.release());
316         }
317         currentTarget = (parent && parent->isSVGElement()) ? static_pointer_cast<SVGElement>(parent) : 0;
318     }
319 }
320
321 void SVGElement::finishParsingChildren()
322 {
323     StyledElement::finishParsingChildren();
324
325     // finishParsingChildren() is called when the close tag is reached for an element (e.g. </svg>)
326     // we send SVGLoad events here if we can, otherwise they'll be sent when any required loads finish
327     sendSVGLoadEventIfPossible();
328 }
329
330 bool SVGElement::childShouldCreateRenderer(Node* child) const
331 {
332     if (child->isSVGElement())
333         return static_cast<SVGElement*>(child)->isValid();
334     return false;
335 }
336
337 void SVGElement::insertedIntoDocument()
338 {
339     StyledElement::insertedIntoDocument();
340
341     if (!needsPendingResourceHandling())
342         return;
343
344     SVGDocumentExtensions* extensions = document()->accessSVGExtensions();
345     String resourceId = getIdAttribute();
346     if (!extensions->isPendingResource(resourceId))
347         return;
348     
349     OwnPtr<SVGDocumentExtensions::SVGPendingElements> clients(extensions->removePendingResource(resourceId));
350     if (clients->isEmpty())
351         return;
352
353     const SVGDocumentExtensions::SVGPendingElements::const_iterator end = clients->end();
354     for (SVGDocumentExtensions::SVGPendingElements::const_iterator it = clients->begin(); it != end; ++it)
355         (*it)->buildPendingResource();
356 }
357
358 void SVGElement::attributeChanged(Attribute* attr, bool preserveDecls)
359 {
360     ASSERT(attr);
361     if (!attr)
362         return;
363
364     StyledElement::attributeChanged(attr, preserveDecls);
365
366     // When an animated SVG property changes through SVG DOM, svgAttributeChanged() is called, not attributeChanged().
367     // Next time someone tries to access the XML attributes, the synchronization code starts. During that synchronization
368     // SVGAnimatedPropertySynchronizer may call NamedNodeMap::removeAttribute(), which in turn calls attributeChanged().
369     // At this point we're not allowed to call svgAttributeChanged() again - it may lead to extra work being done, or crashes
370     // see bug https://bugs.webkit.org/show_bug.cgi?id=40994.
371     if (isSynchronizingSVGAttributes())
372         return;
373
374     // Changes to the style attribute are processed lazily (see Element::getAttribute() and related methods),
375     // so we don't want changes to the style attribute to result in extra work here.
376     if (attr->name() != HTMLNames::styleAttr)
377         svgAttributeChanged(attr->name());
378 }
379
380 void SVGElement::updateAnimatedSVGAttribute(const QualifiedName& name) const
381 {
382     if (isSynchronizingSVGAttributes() || areSVGAttributesValid())
383         return;
384
385     setIsSynchronizingSVGAttributes();
386
387     const_cast<SVGElement*>(this)->synchronizeProperty(name);
388     if (name == anyQName())
389         setAreSVGAttributesValid();
390
391     clearIsSynchronizingSVGAttributes();
392 }
393
394 }
395
396 #endif // ENABLE(SVG)