https://bugs.webkit.org/show_bug.cgi?id=85265
[WebKit-https.git] / Source / WebCore / svg / SVGUseElement.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006, 2007 Rob Buis <buis@kde.org>
4  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
5  * Copyright (C) 2011 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
6  * Copyright (C) 2012 University of Szeged
7  * Copyright (C) 2012 Renata Hodovan <reni@webkit.org>
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #include "config.h"
26
27 #if ENABLE(SVG)
28 #include "SVGUseElement.h"
29
30 #include "Attribute.h"
31 #include "CachedResourceLoader.h"
32 #include "Document.h"
33 #include "ElementShadow.h"
34 #include "Event.h"
35 #include "EventListener.h"
36 #include "HTMLNames.h"
37 #include "NodeRenderStyle.h"
38 #include "RegisteredEventListener.h"
39 #include "RenderSVGResource.h"
40 #include "RenderSVGTransformableContainer.h"
41 #include "ShadowRoot.h"
42 #include "SVGElementInstance.h"
43 #include "SVGElementRareData.h"
44 #include "SVGElementInstanceList.h"
45 #include "SVGGElement.h"
46 #include "SVGLengthContext.h"
47 #include "SVGNames.h"
48 #include "SVGSMILElement.h"
49 #include "SVGSVGElement.h"
50 #include "SVGSymbolElement.h"
51 #include "StyleResolver.h"
52 #include "XLinkNames.h"
53 #include "XMLDocumentParser.h"
54 #include "XMLSerializer.h"
55
56 // Dump SVGElementInstance object tree - useful to debug instanceRoot problems
57 // #define DUMP_INSTANCE_TREE
58
59 // Dump the deep-expanded shadow tree (where the renderers are built from)
60 // #define DUMP_SHADOW_TREE
61
62 namespace WebCore {
63
64 // Animated property definitions
65 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::xAttr, X, x)
66 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::yAttr, Y, y)
67 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::widthAttr, Width, width)
68 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::heightAttr, Height, height)
69 DEFINE_ANIMATED_STRING(SVGUseElement, XLinkNames::hrefAttr, Href, href)
70 DEFINE_ANIMATED_BOOLEAN(SVGUseElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
71
72 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGUseElement)
73     REGISTER_LOCAL_ANIMATED_PROPERTY(x)
74     REGISTER_LOCAL_ANIMATED_PROPERTY(y)
75     REGISTER_LOCAL_ANIMATED_PROPERTY(width)
76     REGISTER_LOCAL_ANIMATED_PROPERTY(height)
77     REGISTER_LOCAL_ANIMATED_PROPERTY(href)
78     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
79     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGStyledTransformableElement)
80     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGTests)
81 END_REGISTER_ANIMATED_PROPERTIES
82
83 inline SVGUseElement::SVGUseElement(const QualifiedName& tagName, Document* document, bool wasInsertedByParser)
84     : SVGStyledTransformableElement(tagName, document)
85     , m_x(LengthModeWidth)
86     , m_y(LengthModeHeight)
87     , m_width(LengthModeWidth)
88     , m_height(LengthModeHeight)
89     , m_wasInsertedByParser(wasInsertedByParser)
90     , m_haveFiredLoadEvent(false)
91     , m_needsShadowTreeRecreation(false)
92 {
93     ASSERT(hasTagName(SVGNames::useTag));
94     registerAnimatedPropertiesForSVGUseElement();
95
96     setHasCustomWillOrDidRecalcStyle();
97 }
98
99 PassRefPtr<SVGUseElement> SVGUseElement::create(const QualifiedName& tagName, Document* document, bool wasInsertedByParser)
100 {
101     // Always build a #shadow-root for SVGUseElement.
102     RefPtr<SVGUseElement> use = adoptRef(new SVGUseElement(tagName, document, wasInsertedByParser));
103     use->ensureShadowRoot();
104     return use.release();
105 }
106
107 SVGUseElement::~SVGUseElement()
108 {
109     if (m_cachedDocument)
110         m_cachedDocument->removeClient(this);
111 }
112
113 SVGElementInstance* SVGUseElement::instanceRoot()
114 {
115     // If there is no element instance tree, force immediate SVGElementInstance tree
116     // creation by asking the document to invoke our recalcStyle function - as we can't
117     // wait for the lazy creation to happen if e.g. JS wants to access the instanceRoot
118     // object right after creating the element on-the-fly
119     if (!m_targetElementInstance)
120         document()->updateLayoutIgnorePendingStylesheets();
121
122     return m_targetElementInstance.get();
123 }
124
125 SVGElementInstance* SVGUseElement::animatedInstanceRoot() const
126 {
127     // FIXME: Implement me.
128     return 0;
129 }
130
131 bool SVGUseElement::isSupportedAttribute(const QualifiedName& attrName)
132 {
133     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
134     if (supportedAttributes.isEmpty()) {
135         SVGTests::addSupportedAttributes(supportedAttributes);
136         SVGLangSpace::addSupportedAttributes(supportedAttributes);
137         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
138         SVGURIReference::addSupportedAttributes(supportedAttributes);
139         supportedAttributes.add(SVGNames::xAttr);
140         supportedAttributes.add(SVGNames::yAttr);
141         supportedAttributes.add(SVGNames::widthAttr);
142         supportedAttributes.add(SVGNames::heightAttr);
143     }
144     return supportedAttributes.contains<QualifiedName, SVGAttributeHashTranslator>(attrName);
145 }
146
147 void SVGUseElement::parseAttribute(Attribute* attr)
148 {
149     SVGParsingError parseError = NoError;
150
151     if (!isSupportedAttribute(attr->name()))
152         SVGStyledTransformableElement::parseAttribute(attr);
153     else if (attr->name() == SVGNames::xAttr)
154         setXBaseValue(SVGLength::construct(LengthModeWidth, attr->value(), parseError));
155     else if (attr->name() == SVGNames::yAttr)
156         setYBaseValue(SVGLength::construct(LengthModeHeight, attr->value(), parseError));
157     else if (attr->name() == SVGNames::widthAttr)
158         setWidthBaseValue(SVGLength::construct(LengthModeWidth, attr->value(), parseError, ForbidNegativeLengths));
159     else if (attr->name() == SVGNames::heightAttr)
160         setHeightBaseValue(SVGLength::construct(LengthModeHeight, attr->value(), parseError, ForbidNegativeLengths));
161     else if (SVGTests::parseAttribute(attr)
162              || SVGLangSpace::parseAttribute(attr)
163              || SVGExternalResourcesRequired::parseAttribute(attr)
164              || SVGURIReference::parseAttribute(attr)) {
165     } else
166         ASSERT_NOT_REACHED();
167
168     reportAttributeParsingError(parseError, attr);
169 }
170
171 static inline bool isWellFormedDocument(Document* document)
172 {
173     if (document->isSVGDocument() || document->isXHTMLDocument())
174         return static_cast<XMLDocumentParser*>(document->parser())->wellFormed();
175     return true;
176 }
177
178 Node::InsertionNotificationRequest SVGUseElement::insertedInto(Node* rootParent)
179 {
180     // This functions exists to assure assumptions made in the code regarding SVGElementInstance creation/destruction are satisfied.
181     SVGStyledTransformableElement::insertedInto(rootParent);
182     if (!rootParent->inDocument())
183         return InsertionDone;
184     ASSERT(!m_targetElementInstance || !isWellFormedDocument(document()));
185     ASSERT(!hasPendingResources() || !isWellFormedDocument(document()));
186     if (!m_wasInsertedByParser)
187         buildPendingResource();
188     SVGExternalResourcesRequired::insertedIntoDocument(this);
189     return InsertionDone;
190 }
191
192 void SVGUseElement::removedFrom(Node* rootParent)
193 {
194     SVGStyledTransformableElement::removedFrom(rootParent);
195     if (rootParent->inDocument())
196         clearResourceReferences();
197 }
198
199 Document* SVGUseElement::referencedDocument() const
200 {
201     if (!isExternalURIReference(href(), document()))
202         return document();
203     return externalDocument();
204 }
205
206 Document* SVGUseElement::externalDocument() const
207 {
208     if (m_cachedDocument && m_cachedDocument->isLoaded()) {
209         // Gracefully handle error condition.
210         if (m_cachedDocument->errorOccurred())
211             return 0;
212         ASSERT(m_cachedDocument->document());
213         return m_cachedDocument->document();
214     }
215     return 0;
216 }
217
218 void SVGUseElement::svgAttributeChanged(const QualifiedName& attrName)
219 {
220     if (!isSupportedAttribute(attrName)) {
221         SVGStyledTransformableElement::svgAttributeChanged(attrName);
222         return;
223     }
224
225     SVGElementInstance::InvalidationGuard invalidationGuard(this);
226
227     RenderObject* renderer = this->renderer();
228     if (attrName == SVGNames::xAttr
229         || attrName == SVGNames::yAttr
230         || attrName == SVGNames::widthAttr
231         || attrName == SVGNames::heightAttr) {
232         updateRelativeLengthsInformation();
233         if (renderer)
234             RenderSVGResource::markForLayoutAndParentResourceInvalidation(renderer);
235         return;
236     }
237
238     if (SVGTests::handleAttributeChange(this, attrName))
239         return;
240
241     if (SVGExternalResourcesRequired::handleAttributeChange(this, attrName))
242         return;
243
244     if (SVGURIReference::isKnownAttribute(attrName)) {
245         bool isExternalReference = isExternalURIReference(href(), document());
246         if (isExternalReference) {
247             KURL url = document()->completeURL(href());
248             if (url.hasFragmentIdentifier()) {
249                 ResourceRequest request(url.string());
250                 m_cachedDocument = document()->cachedResourceLoader()->requestSVGDocument(request);
251                 if (m_cachedDocument)
252                     m_cachedDocument->addClient(this);
253             }
254         }
255
256         if (m_cachedDocument && !isExternalReference) {
257             m_cachedDocument->removeClient(this);
258             m_cachedDocument = 0;
259         }
260         if (!m_wasInsertedByParser)
261             buildPendingResource();
262         return;
263     }
264
265     if (!renderer)
266         return;
267
268     if (SVGLangSpace::isKnownAttribute(attrName)
269         || SVGExternalResourcesRequired::isKnownAttribute(attrName)) {
270         invalidateShadowTree();
271         return;
272     }
273
274     ASSERT_NOT_REACHED();
275 }
276
277 bool SVGUseElement::willRecalcStyle(StyleChange)
278 {
279     if (!m_wasInsertedByParser && m_needsShadowTreeRecreation && renderer() && needsStyleRecalc())
280         buildPendingResource();
281     return true;
282 }
283
284 #ifdef DUMP_INSTANCE_TREE
285 static void dumpInstanceTree(unsigned int& depth, String& text, SVGElementInstance* targetInstance)
286 {
287     SVGElement* element = targetInstance->correspondingElement();
288     ASSERT(element);
289
290     if (element->hasTagName(SVGNames::useTag)) {
291         if (static_cast<SVGUseElement*>(element)->cachedDocumentIsStillLoading())
292             return;
293     }
294
295     SVGElement* shadowTreeElement = targetInstance->shadowTreeElement();
296     ASSERT(shadowTreeElement);
297
298     SVGUseElement* directUseElement = targetInstance->directUseElement();
299     String directUseElementName = directUseElement ? directUseElement->nodeName() : "null";
300
301     String elementId = element->getIdAttribute();
302     String elementNodeName = element->nodeName();
303     String shadowTreeElementNodeName = shadowTreeElement->nodeName();
304     String parentNodeName = element->parentNode() ? element->parentNode()->nodeName() : "null";
305     String firstChildNodeName = element->firstChild() ? element->firstChild()->nodeName() : "null";
306
307     for (unsigned int i = 0; i < depth; ++i)
308         text += "  ";
309
310     text += String::format("SVGElementInstance this=%p, (parentNode=%s (%p), firstChild=%s (%p), correspondingElement=%s (%p), directUseElement=%s (%p), shadowTreeElement=%s (%p), id=%s)\n",
311                            targetInstance, parentNodeName.latin1().data(), element->parentNode(), firstChildNodeName.latin1().data(), element->firstChild(),
312                            elementNodeName.latin1().data(), element, directUseElementName.latin1().data(), directUseElement, shadowTreeElementNodeName.latin1().data(), shadowTreeElement, elementId.latin1().data());
313
314     for (unsigned int i = 0; i < depth; ++i)
315         text += "  ";
316
317     const HashSet<SVGElementInstance*>& elementInstances = element->instancesForElement();
318     text += "Corresponding element is associated with " + String::number(elementInstances.size()) + " instance(s):\n";
319
320     const HashSet<SVGElementInstance*>::const_iterator end = elementInstances.end();
321     for (HashSet<SVGElementInstance*>::const_iterator it = elementInstances.begin(); it != end; ++it) {
322         for (unsigned int i = 0; i < depth; ++i)
323             text += "  ";
324
325         text += String::format(" -> SVGElementInstance this=%p, (refCount: %i, shadowTreeElement in document? %i)\n",
326                                *it, (*it)->refCount(), (*it)->shadowTreeElement()->inDocument());
327     }
328
329     ++depth;
330
331     for (SVGElementInstance* instance = targetInstance->firstChild(); instance; instance = instance->nextSibling())
332         dumpInstanceTree(depth, text, instance);
333
334     --depth;
335 }
336 #endif
337
338 static bool isDisallowedElement(Node* node)
339 {
340     // Spec: "Any 'svg', 'symbol', 'g', graphics element or other 'use' is potentially a template object that can be re-used
341     // (i.e., "instanced") in the SVG document via a 'use' element."
342     // "Graphics Element" is defined as 'circle', 'ellipse', 'image', 'line', 'path', 'polygon', 'polyline', 'rect', 'text'
343     // Excluded are anything that is used by reference or that only make sense to appear once in a document.
344     // We must also allow the shadow roots of other use elements.
345     if (node->isShadowRoot() || node->isTextNode())
346         return false;
347
348     if (!node->isSVGElement())
349         return true;
350
351     Element* element = static_cast<Element*>(node);
352
353     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, allowedElementTags, ());
354     if (allowedElementTags.isEmpty()) {
355         allowedElementTags.add(SVGNames::aTag);
356         allowedElementTags.add(SVGNames::circleTag);
357         allowedElementTags.add(SVGNames::descTag);
358         allowedElementTags.add(SVGNames::ellipseTag);
359         allowedElementTags.add(SVGNames::gTag);
360         allowedElementTags.add(SVGNames::imageTag);
361         allowedElementTags.add(SVGNames::lineTag);
362         allowedElementTags.add(SVGNames::metadataTag);
363         allowedElementTags.add(SVGNames::pathTag);
364         allowedElementTags.add(SVGNames::polygonTag);
365         allowedElementTags.add(SVGNames::polylineTag);
366         allowedElementTags.add(SVGNames::rectTag);
367         allowedElementTags.add(SVGNames::svgTag);
368         allowedElementTags.add(SVGNames::switchTag);
369         allowedElementTags.add(SVGNames::symbolTag);
370         allowedElementTags.add(SVGNames::textTag);
371         allowedElementTags.add(SVGNames::textPathTag);
372         allowedElementTags.add(SVGNames::titleTag);
373         allowedElementTags.add(SVGNames::trefTag);
374         allowedElementTags.add(SVGNames::tspanTag);
375         allowedElementTags.add(SVGNames::useTag);
376     }
377     return !allowedElementTags.contains<QualifiedName, SVGAttributeHashTranslator>(element->tagQName());
378 }
379
380 static bool subtreeContainsDisallowedElement(Node* start)
381 {
382     if (isDisallowedElement(start))
383         return true;
384
385     for (Node* cur = start->firstChild(); cur; cur = cur->nextSibling()) {
386         if (subtreeContainsDisallowedElement(cur))
387             return true;
388     }
389
390     return false;
391 }
392
393 void SVGUseElement::clearResourceReferences()
394 {
395     // FIXME: We should try to optimize this, to at least allow partial reclones.
396     if (ShadowRoot* shadowTreeRootElement =  shadow()->oldestShadowRoot())
397         shadowTreeRootElement->removeAllChildren();
398
399     if (m_targetElementInstance) {
400         m_targetElementInstance->detach();
401         m_targetElementInstance = 0;
402     }
403
404     m_needsShadowTreeRecreation = false;
405 }
406
407 void SVGUseElement::buildPendingResource()
408 {
409     if (!referencedDocument())
410         return;
411     clearResourceReferences();
412     if (!inDocument())
413         return;
414
415     String id;
416     Element* target = SVGURIReference::targetElementFromIRIString(href(), document(), &id, externalDocument());
417     if (!target) {
418         // If we can't find the target of an external element, just give up.
419         // We can't observe if the target somewhen enters the external document, nor should we do it.
420         if (externalDocument())
421             return;
422         if (hasPendingResources() || id.isEmpty())
423             return;
424
425         ASSERT(!hasPendingResources());
426         referencedDocument()->accessSVGExtensions()->addPendingResource(id, this);
427         ASSERT(hasPendingResources());
428         return;
429     }
430
431     if (target->isSVGElement())
432         buildShadowAndInstanceTree(static_cast<SVGElement*>(target));
433     ASSERT(!m_needsShadowTreeRecreation);
434 }
435
436 void SVGUseElement::buildShadowAndInstanceTree(SVGElement* target)
437 {
438     ASSERT(!m_targetElementInstance);
439
440     // Do not build the shadow/instance tree for <use> elements living in a shadow tree.
441     // The will be expanded soon anyway - see expandUseElementsInShadowTree().
442     if (isInShadowTree())
443         return;
444
445     // Do not allow self-referencing.
446     // 'target' may be null, if it's a non SVG namespaced element.
447     if (!target || target == this)
448         return;
449
450     // Why a seperated instance/shadow tree? SVG demands it:
451     // The instance tree is accesable from JavaScript, and has to
452     // expose a 1:1 copy of the referenced tree, whereas internally we need
453     // to alter the tree for correct "use-on-symbol", "use-on-svg" support.
454
455     // Build instance tree. Create root SVGElementInstance object for the first sub-tree node.
456     //
457     // Spec: If the 'use' element references a simple graphics element such as a 'rect', then there is only a
458     // single SVGElementInstance object, and the correspondingElement attribute on this SVGElementInstance object
459     // is the SVGRectElement that corresponds to the referenced 'rect' element.
460     m_targetElementInstance = SVGElementInstance::create(this, this, target);
461
462     // Eventually enter recursion to build SVGElementInstance objects for the sub-tree children
463     bool foundProblem = false;
464     buildInstanceTree(target, m_targetElementInstance.get(), foundProblem);
465
466     if (instanceTreeIsLoading(m_targetElementInstance.get()))
467         return;
468
469     // SVG specification does not say a word about <use> & cycles. My view on this is: just ignore it!
470     // Non-appearing <use> content is easier to debug, then half-appearing content.
471     if (foundProblem) {
472         clearResourceReferences();
473         return;
474     }
475
476     // Assure instance tree building was successfull
477     ASSERT(m_targetElementInstance);
478     ASSERT(!m_targetElementInstance->shadowTreeElement());
479     ASSERT(m_targetElementInstance->correspondingUseElement() == this);
480     ASSERT(m_targetElementInstance->directUseElement() == this);
481     ASSERT(m_targetElementInstance->correspondingElement() == target);
482
483     ShadowRoot* shadowTreeRootElement = shadow()->oldestShadowRoot();
484     ASSERT(shadowTreeRootElement);
485
486     // Build shadow tree from instance tree
487     // This also handles the special cases: <use> on <symbol>, <use> on <svg>.
488     buildShadowTree(target, m_targetElementInstance.get());
489
490     // Expand all <use> elements in the shadow tree.
491     // Expand means: replace the actual <use> element by what it references.
492     expandUseElementsInShadowTree(shadowTreeRootElement);
493
494     // Expand all <symbol> elements in the shadow tree.
495     // Expand means: replace the actual <symbol> element by the <svg> element.
496     expandSymbolElementsInShadowTree(shadowTreeRootElement);
497
498     // Now that the shadow tree is completly expanded, we can associate
499     // shadow tree elements <-> instances in the instance tree.
500     associateInstancesWithShadowTreeElements(shadowTreeRootElement->firstChild(), m_targetElementInstance.get());
501
502     // If no shadow tree element is present, this means that the reference root
503     // element was removed, as it is disallowed (ie. <use> on <foreignObject>)
504     // Do NOT leave an inconsistent instance tree around, instead destruct it.
505     if (!m_targetElementInstance->shadowTreeElement()) {
506         clearResourceReferences();
507         return;
508     }
509
510     ASSERT(m_targetElementInstance->shadowTreeElement()->parentNode() == shadowTreeRootElement);
511
512     // Transfer event listeners assigned to the referenced element to our shadow tree elements.
513     transferEventListenersToShadowTree(m_targetElementInstance.get());
514
515     // Update relative length information.
516     updateRelativeLengthsInformation();
517
518     // Eventually dump instance tree
519 #ifdef DUMP_INSTANCE_TREE
520     String text;
521     unsigned int depth = 0;
522
523     dumpInstanceTree(depth, text, m_targetElementInstance.get());
524     fprintf(stderr, "\nDumping <use> instance tree:\n%s\n", text.latin1().data());
525 #endif
526
527     // Eventually dump shadow tree
528 #ifdef DUMP_SHADOW_TREE
529     RefPtr<XMLSerializer> serializer = XMLSerializer::create();
530     String markup = serializer->serializeToString(shadowTreeRootElement, ASSERT_NO_EXCEPTION);
531     fprintf(stderr, "Dumping <use> shadow tree markup:\n%s\n", markup.latin1().data());
532 #endif
533 }
534
535 RenderObject* SVGUseElement::createRenderer(RenderArena* arena, RenderStyle*)
536 {
537     return new (arena) RenderSVGTransformableContainer(this);
538 }
539
540 static bool isDirectReference(const Node* node)
541 {
542     return node->hasTagName(SVGNames::pathTag)
543            || node->hasTagName(SVGNames::rectTag)
544            || node->hasTagName(SVGNames::circleTag)
545            || node->hasTagName(SVGNames::ellipseTag)
546            || node->hasTagName(SVGNames::polygonTag)
547            || node->hasTagName(SVGNames::polylineTag)
548            || node->hasTagName(SVGNames::textTag);
549 }
550
551 void SVGUseElement::toClipPath(Path& path)
552 {
553     ASSERT(path.isEmpty());
554
555     Node* n = m_targetElementInstance ? m_targetElementInstance->shadowTreeElement() : 0;
556     if (!n)
557         return;
558
559     if (n->isSVGElement() && static_cast<SVGElement*>(n)->isStyledTransformable()) {
560         if (!isDirectReference(n))
561             // Spec: Indirect references are an error (14.3.5)
562             document()->accessSVGExtensions()->reportError("Not allowed to use indirect reference in <clip-path>");
563         else {
564             static_cast<SVGStyledTransformableElement*>(n)->toClipPath(path);
565             // FIXME: Avoid manual resolution of x/y here. Its potentially harmful.
566             SVGLengthContext lengthContext(this);
567             path.translate(FloatSize(x().value(lengthContext), y().value(lengthContext)));
568             path.transform(animatedLocalTransform());
569         }
570     }
571 }
572
573 RenderObject* SVGUseElement::rendererClipChild() const
574 {
575     Node* n = m_targetElementInstance ? m_targetElementInstance->shadowTreeElement() : 0;
576     if (!n)
577         return 0;
578
579     if (n->isSVGElement() && isDirectReference(n))
580         return static_cast<SVGElement*>(n)->renderer();
581
582     return 0;
583 }
584
585 void SVGUseElement::buildInstanceTree(SVGElement* target, SVGElementInstance* targetInstance, bool& foundProblem)
586 {
587     ASSERT(target);
588     ASSERT(targetInstance);
589
590     // Spec: If the referenced object is itself a 'use', or if there are 'use' subelements within the referenced
591     // object, the instance tree will contain recursive expansion of the indirect references to form a complete tree.
592     bool targetHasUseTag = target->hasTagName(SVGNames::useTag);
593     SVGElement* newTarget = 0;
594     if (targetHasUseTag) {
595         foundProblem = hasCycleUseReferencing(static_cast<SVGUseElement*>(target), targetInstance, newTarget);
596         if (foundProblem)
597             return;
598     } else if (isDisallowedElement(target)) {
599         foundProblem = true;
600         return;
601     }
602
603     // A general description from the SVG spec, describing what buildInstanceTree() actually does.
604     //
605     // Spec: If the 'use' element references a 'g' which contains two 'rect' elements, then the instance tree
606     // contains three SVGElementInstance objects, a root SVGElementInstance object whose correspondingElement
607     // is the SVGGElement object for the 'g', and then two child SVGElementInstance objects, each of which has
608     // its correspondingElement that is an SVGRectElement object.
609
610     for (Node* node = target->firstChild(); node; node = node->nextSibling()) {
611         SVGElement* element = 0;
612         if (node->isSVGElement())
613             element = static_cast<SVGElement*>(node);
614
615         // Skip any non-svg nodes or any disallowed element.
616         if (!element || isDisallowedElement(element))
617             continue;
618
619         // Create SVGElementInstance object, for both container/non-container nodes.
620         RefPtr<SVGElementInstance> instance = SVGElementInstance::create(this, 0, element);
621         SVGElementInstance* instancePtr = instance.get();
622         targetInstance->appendChild(instance.release());
623
624         // Enter recursion, appending new instance tree nodes to the "instance" object.
625         buildInstanceTree(element, instancePtr, foundProblem);
626         if (foundProblem)
627             return;
628     }
629
630     if (!targetHasUseTag || !newTarget)
631         return;
632
633     RefPtr<SVGElementInstance> newInstance = SVGElementInstance::create(this, static_cast<SVGUseElement*>(target), newTarget);
634     SVGElementInstance* newInstancePtr = newInstance.get();
635     targetInstance->appendChild(newInstance.release());
636     buildInstanceTree(newTarget, newInstancePtr, foundProblem);
637 }
638
639 bool SVGUseElement::hasCycleUseReferencing(SVGUseElement* use, SVGElementInstance* targetInstance, SVGElement*& newTarget)
640 {
641     Element* targetElement = SVGURIReference::targetElementFromIRIString(use->href(), referencedDocument());
642     newTarget = 0;
643     if (targetElement && targetElement->isSVGElement())
644         newTarget = static_cast<SVGElement*>(targetElement);
645
646     if (!newTarget)
647         return false;
648
649     // Shortcut for self-references
650     if (newTarget == this)
651         return true;
652
653     AtomicString targetId = newTarget->getIdAttribute();
654     SVGElementInstance* instance = targetInstance->parentNode();
655     while (instance) {
656         SVGElement* element = instance->correspondingElement();
657
658         // FIXME: This should probably be using getIdAttribute instead of idForStyleResolution.
659         if (element->hasID() && element->idForStyleResolution() == targetId && element->document() == newTarget->document())
660             return true;
661
662         instance = instance->parentNode();
663     }
664     return false;
665 }
666
667 static inline void removeDisallowedElementsFromSubtree(Node* subtree)
668 {
669     ASSERT(!subtree->inDocument());
670     Node* node = subtree->firstChild();
671     while (node) {
672         if (isDisallowedElement(node)) {
673             Node* next = node->traverseNextSibling(subtree);
674             // The subtree is not in document so this won't generate events that could mutate the tree.
675             node->parentNode()->removeChild(node);
676             node = next;
677         } else
678             node = node->traverseNextNode(subtree);
679     }
680 }
681
682 void SVGUseElement::buildShadowTree(SVGElement* target, SVGElementInstance* targetInstance)
683 {
684     // For instance <use> on <foreignObject> (direct case).
685     if (isDisallowedElement(target))
686         return;
687
688     RefPtr<Element> newChild = targetInstance->correspondingElement()->cloneElementWithChildren();
689
690     // We don't walk the target tree element-by-element, and clone each element,
691     // but instead use cloneElementWithChildren(). This is an optimization for the common
692     // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
693     // Though if there are disallowed elements in the subtree, we have to remove them.
694     // For instance: <use> on <g> containing <foreignObject> (indirect case).
695     if (subtreeContainsDisallowedElement(newChild.get()))
696         removeDisallowedElementsFromSubtree(newChild.get());
697
698     shadow()->oldestShadowRoot()->appendChild(newChild.release());
699 }
700
701 void SVGUseElement::expandUseElementsInShadowTree(Node* element)
702 {
703     // Why expand the <use> elements in the shadow tree here, and not just
704     // do this directly in buildShadowTree, if we encounter a <use> element?
705     //
706     // Short answer: Because we may miss to expand some elements. Ie. if a <symbol>
707     // contains <use> tags, we'd miss them. So once we're done with settin' up the
708     // actual shadow tree (after the special case modification for svg/symbol) we have
709     // to walk it completely and expand all <use> elements.
710     if (element->hasTagName(SVGNames::useTag)) {
711         SVGUseElement* use = static_cast<SVGUseElement*>(element);
712         ASSERT(!use->cachedDocumentIsStillLoading());
713
714         Element* targetElement = SVGURIReference::targetElementFromIRIString(use->href(), referencedDocument());
715         SVGElement* target = 0;
716         if (targetElement && targetElement->isSVGElement())
717             target = static_cast<SVGElement*>(targetElement);
718
719         // Don't ASSERT(target) here, it may be "pending", too.
720         // Setup sub-shadow tree root node
721         RefPtr<SVGGElement> cloneParent = SVGGElement::create(SVGNames::gTag, referencedDocument());
722         use->cloneChildNodes(cloneParent.get());
723
724         // Spec: In the generated content, the 'use' will be replaced by 'g', where all attributes from the
725         // 'use' element except for x, y, width, height and xlink:href are transferred to the generated 'g' element.
726         transferUseAttributesToReplacedElement(use, cloneParent.get());
727
728         if (target && !isDisallowedElement(target)) {
729             RefPtr<Element> newChild = target->cloneElementWithChildren();
730             ASSERT(newChild->isSVGElement());
731             cloneParent->appendChild(newChild.release());
732         }
733
734         // We don't walk the target tree element-by-element, and clone each element,
735         // but instead use cloneElementWithChildren(). This is an optimization for the common
736         // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
737         // Though if there are disallowed elements in the subtree, we have to remove them.
738         // For instance: <use> on <g> containing <foreignObject> (indirect case).
739         if (subtreeContainsDisallowedElement(cloneParent.get()))
740             removeDisallowedElementsFromSubtree(cloneParent.get());
741
742         RefPtr<Node> replacingElement(cloneParent.get());
743
744         // Replace <use> with referenced content.
745         ASSERT(use->parentNode());
746         use->parentNode()->replaceChild(cloneParent.release(), use);
747
748         // Expand the siblings because the *element* is replaced and we will
749         // lose the sibling chain when we are back from recursion.
750         element = replacingElement.get();
751         for (RefPtr<Node> sibling = element->nextSibling(); sibling; sibling = sibling->nextSibling())
752             expandUseElementsInShadowTree(sibling.get());
753     }
754
755     for (RefPtr<Node> child = element->firstChild(); child; child = child->nextSibling())
756         expandUseElementsInShadowTree(child.get());
757 }
758
759 void SVGUseElement::expandSymbolElementsInShadowTree(Node* element)
760 {
761     if (element->hasTagName(SVGNames::symbolTag)) {
762         // Spec: The referenced 'symbol' and its contents are deep-cloned into the generated tree,
763         // with the exception that the 'symbol' is replaced by an 'svg'. This generated 'svg' will
764         // always have explicit values for attributes width and height. If attributes width and/or
765         // height are provided on the 'use' element, then these attributes will be transferred to
766         // the generated 'svg'. If attributes width and/or height are not specified, the generated
767         // 'svg' element will use values of 100% for these attributes.
768         RefPtr<SVGSVGElement> svgElement = SVGSVGElement::create(SVGNames::svgTag, referencedDocument());
769
770         // Transfer all attributes from <symbol> to the new <svg> element
771         svgElement->setAttributesFromElement(*toElement(element));
772
773         // Only clone symbol children, and add them to the new <svg> element
774         for (Node* child = element->firstChild(); child; child = child->nextSibling()) {
775             RefPtr<Node> newChild = child->cloneNode(true);
776             svgElement->appendChild(newChild.release());
777         }
778
779         // We don't walk the target tree element-by-element, and clone each element,
780         // but instead use cloneNode(deep=true). This is an optimization for the common
781         // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
782         // Though if there are disallowed elements in the subtree, we have to remove them.
783         // For instance: <use> on <g> containing <foreignObject> (indirect case).
784         if (subtreeContainsDisallowedElement(svgElement.get()))
785             removeDisallowedElementsFromSubtree(svgElement.get());
786
787         RefPtr<Node> replacingElement(svgElement.get());
788
789         // Replace <symbol> with <svg>.
790         element->parentNode()->replaceChild(svgElement.release(), element);
791
792         // Expand the siblings because the *element* is replaced and we will
793         // lose the sibling chain when we are back from recursion.
794         element = replacingElement.get();
795         for (RefPtr<Node> sibling = element->nextSibling(); sibling; sibling = sibling->nextSibling())
796             expandSymbolElementsInShadowTree(sibling.get());
797     }
798
799     for (RefPtr<Node> child = element->firstChild(); child; child = child->nextSibling())
800         expandSymbolElementsInShadowTree(child.get());
801 }
802
803 void SVGUseElement::transferEventListenersToShadowTree(SVGElementInstance* target)
804 {
805     if (!target)
806         return;
807
808     SVGElement* originalElement = target->correspondingElement();
809     ASSERT(originalElement);
810
811     if (SVGElement* shadowTreeElement = target->shadowTreeElement()) {
812         if (EventTargetData* data = originalElement->eventTargetData())
813             data->eventListenerMap.copyEventListenersNotCreatedFromMarkupToTarget(shadowTreeElement);
814     }
815
816     for (SVGElementInstance* instance = target->firstChild(); instance; instance = instance->nextSibling())
817         transferEventListenersToShadowTree(instance);
818 }
819
820 void SVGUseElement::associateInstancesWithShadowTreeElements(Node* target, SVGElementInstance* targetInstance)
821 {
822     if (!target || !targetInstance)
823         return;
824
825     SVGElement* originalElement = targetInstance->correspondingElement();
826
827     if (originalElement->hasTagName(SVGNames::useTag)) {
828         // <use> gets replaced by <g>
829         ASSERT(target->nodeName() == SVGNames::gTag);
830     } else if (originalElement->hasTagName(SVGNames::symbolTag)) {
831         // <symbol> gets replaced by <svg>
832         ASSERT(target->nodeName() == SVGNames::svgTag);
833     } else
834         ASSERT(target->nodeName() == originalElement->nodeName());
835
836     SVGElement* element = 0;
837     if (target->isSVGElement())
838         element = static_cast<SVGElement*>(target);
839
840     ASSERT(!targetInstance->shadowTreeElement());
841     targetInstance->setShadowTreeElement(element);
842     element->setCorrespondingElement(originalElement);
843
844     Node* node = target->firstChild();
845     for (SVGElementInstance* instance = targetInstance->firstChild(); node && instance; instance = instance->nextSibling()) {
846         // Skip any non-svg elements in shadow tree
847         while (node && !node->isSVGElement())
848            node = node->nextSibling();
849
850         if (!node)
851             break;
852
853         associateInstancesWithShadowTreeElements(node, instance);
854         node = node->nextSibling();
855     }
856 }
857
858 SVGElementInstance* SVGUseElement::instanceForShadowTreeElement(Node* element) const
859 {
860     if (!m_targetElementInstance) {
861         ASSERT(!inDocument());
862         return 0;
863     }
864
865     return instanceForShadowTreeElement(element, m_targetElementInstance.get());
866 }
867
868 SVGElementInstance* SVGUseElement::instanceForShadowTreeElement(Node* element, SVGElementInstance* instance) const
869 {
870     ASSERT(element);
871     ASSERT(instance);
872
873     // We're dispatching a mutation event during shadow tree construction
874     // this instance hasn't yet been associated to a shadowTree element.
875     if (!instance->shadowTreeElement())
876         return 0;
877
878     if (element == instance->shadowTreeElement())
879         return instance;
880
881     for (SVGElementInstance* current = instance->firstChild(); current; current = current->nextSibling()) {
882         if (SVGElementInstance* search = instanceForShadowTreeElement(element, current))
883             return search;
884     }
885
886     return 0;
887 }
888
889 void SVGUseElement::invalidateShadowTree()
890 {
891     if (!renderer() || m_needsShadowTreeRecreation)
892         return;
893     m_needsShadowTreeRecreation = true;
894     setNeedsStyleRecalc();
895 }
896
897 void SVGUseElement::transferUseAttributesToReplacedElement(SVGElement* from, SVGElement* to) const
898 {
899     ASSERT(from);
900     ASSERT(to);
901
902     to->setAttributesFromElement(*from);
903
904     to->removeAttribute(SVGNames::xAttr);
905     to->removeAttribute(SVGNames::yAttr);
906     to->removeAttribute(SVGNames::widthAttr);
907     to->removeAttribute(SVGNames::heightAttr);
908     to->removeAttribute(XLinkNames::hrefAttr);
909 }
910
911 bool SVGUseElement::selfHasRelativeLengths() const
912 {
913     if (x().isRelative()
914      || y().isRelative()
915      || width().isRelative()
916      || height().isRelative())
917         return true;
918
919     if (!m_targetElementInstance)
920         return false;
921
922     SVGElement* element = m_targetElementInstance->correspondingElement();
923     if (!element || !element->isStyled())
924         return false;
925
926     return static_cast<SVGStyledElement*>(element)->hasRelativeLengths();
927 }
928
929 void SVGUseElement::notifyFinished(CachedResource* resource)
930 {
931     if (!inDocument())
932         return;
933
934     invalidateShadowTree();
935     if (resource->errorOccurred())
936         dispatchEvent(Event::create(eventNames().errorEvent, false, false));
937     else if (!resource->wasCanceled())
938         SVGExternalResourcesRequired::dispatchLoadEvent(this);
939 }
940
941 bool SVGUseElement::cachedDocumentIsStillLoading()
942 {
943     if (m_cachedDocument && m_cachedDocument->isLoading())
944         return true;
945     return false;
946 }
947
948 bool SVGUseElement::instanceTreeIsLoading(SVGElementInstance* targetElementInstance)
949 {
950     for (SVGElementInstance* instance = targetElementInstance->firstChild(); instance; instance = instance->nextSibling()) {
951         if (SVGUseElement* use = instance->correspondingUseElement()) {
952              if (use->cachedDocumentIsStillLoading())
953                  return true;
954         }
955         if (instance->hasChildNodes())
956             instanceTreeIsLoading(instance);
957     }
958     return false;
959 }
960
961 void SVGUseElement::finishParsingChildren()
962 {
963     SVGStyledTransformableElement::finishParsingChildren();
964     SVGExternalResourcesRequired::finishParsingChildren();
965     if (m_wasInsertedByParser) {
966         buildPendingResource();
967         m_wasInsertedByParser = false;
968     }
969 }
970
971 }
972
973 #endif // ENABLE(SVG)