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