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