0b72cf6ff02a8ab8df507ea607634b133797dfcb
[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 "CachedResourceRequest.h"
33 #include "Document.h"
34 #include "ElementShadow.h"
35 #include "Event.h"
36 #include "EventListener.h"
37 #include "HTMLNames.h"
38 #include "NodeRenderStyle.h"
39 #include "NodeTraversal.h"
40 #include "RegisteredEventListener.h"
41 #include "RenderSVGResource.h"
42 #include "RenderSVGTransformableContainer.h"
43 #include "ShadowRoot.h"
44 #include "SVGElementInstance.h"
45 #include "SVGElementRareData.h"
46 #include "SVGElementInstanceList.h"
47 #include "SVGGElement.h"
48 #include "SVGLengthContext.h"
49 #include "SVGNames.h"
50 #include "SVGSMILElement.h"
51 #include "SVGSVGElement.h"
52 #include "SVGSymbolElement.h"
53 #include "StyleResolver.h"
54 #include "XLinkNames.h"
55 #include "XMLDocumentParser.h"
56 #include "XMLSerializer.h"
57
58 // Dump SVGElementInstance object tree - useful to debug instanceRoot problems
59 // #define DUMP_INSTANCE_TREE
60
61 // Dump the deep-expanded shadow tree (where the renderers are built from)
62 // #define DUMP_SHADOW_TREE
63
64 namespace WebCore {
65
66 // Animated property definitions
67 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::xAttr, X, x)
68 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::yAttr, Y, y)
69 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::widthAttr, Width, width)
70 DEFINE_ANIMATED_LENGTH(SVGUseElement, SVGNames::heightAttr, Height, height)
71 DEFINE_ANIMATED_STRING(SVGUseElement, XLinkNames::hrefAttr, Href, href)
72 DEFINE_ANIMATED_BOOLEAN(SVGUseElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
73
74 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGUseElement)
75     REGISTER_LOCAL_ANIMATED_PROPERTY(x)
76     REGISTER_LOCAL_ANIMATED_PROPERTY(y)
77     REGISTER_LOCAL_ANIMATED_PROPERTY(width)
78     REGISTER_LOCAL_ANIMATED_PROPERTY(height)
79     REGISTER_LOCAL_ANIMATED_PROPERTY(href)
80     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
81     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGStyledTransformableElement)
82     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGTests)
83 END_REGISTER_ANIMATED_PROPERTIES
84
85 inline SVGUseElement::SVGUseElement(const QualifiedName& tagName, Document* document, bool wasInsertedByParser)
86     : SVGStyledTransformableElement(tagName, document)
87     , m_x(LengthModeWidth)
88     , m_y(LengthModeHeight)
89     , m_width(LengthModeWidth)
90     , m_height(LengthModeHeight)
91     , m_wasInsertedByParser(wasInsertedByParser)
92     , m_haveFiredLoadEvent(false)
93     , m_needsShadowTreeRecreation(false)
94     , m_svgLoadEventTimer(this, &SVGElement::svgLoadEventTimerFired)
95 {
96     ASSERT(hasCustomStyleCallbacks());
97     ASSERT(hasTagName(SVGNames::useTag));
98     registerAnimatedPropertiesForSVGUseElement();
99 }
100
101 PassRefPtr<SVGUseElement> SVGUseElement::create(const QualifiedName& tagName, Document* document, bool wasInsertedByParser)
102 {
103     // Always build a #shadow-root for SVGUseElement.
104     RefPtr<SVGUseElement> use = adoptRef(new SVGUseElement(tagName, document, wasInsertedByParser));
105     use->ensureUserAgentShadowRoot();
106     return use.release();
107 }
108
109 SVGUseElement::~SVGUseElement()
110 {
111     setCachedDocument(0);
112
113     clearResourceReferences();
114 }
115
116 SVGElementInstance* SVGUseElement::instanceRoot()
117 {
118     // If there is no element instance tree, force immediate SVGElementInstance tree
119     // creation by asking the document to invoke our recalcStyle function - as we can't
120     // wait for the lazy creation to happen if e.g. JS wants to access the instanceRoot
121     // object right after creating the element on-the-fly
122     if (!m_targetElementInstance)
123         document()->updateLayoutIgnorePendingStylesheets();
124
125     return m_targetElementInstance.get();
126 }
127
128 SVGElementInstance* SVGUseElement::animatedInstanceRoot() const
129 {
130     // FIXME: Implement me.
131     return 0;
132 }
133
134 bool SVGUseElement::isSupportedAttribute(const QualifiedName& attrName)
135 {
136     DEFINE_STATIC_LOCAL(HashSet<QualifiedName>, supportedAttributes, ());
137     if (supportedAttributes.isEmpty()) {
138         SVGTests::addSupportedAttributes(supportedAttributes);
139         SVGLangSpace::addSupportedAttributes(supportedAttributes);
140         SVGExternalResourcesRequired::addSupportedAttributes(supportedAttributes);
141         SVGURIReference::addSupportedAttributes(supportedAttributes);
142         supportedAttributes.add(SVGNames::xAttr);
143         supportedAttributes.add(SVGNames::yAttr);
144         supportedAttributes.add(SVGNames::widthAttr);
145         supportedAttributes.add(SVGNames::heightAttr);
146     }
147     return supportedAttributes.contains<QualifiedName, SVGAttributeHashTranslator>(attrName);
148 }
149
150 void SVGUseElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
151 {
152     SVGParsingError parseError = NoError;
153
154     if (!isSupportedAttribute(name))
155         SVGStyledTransformableElement::parseAttribute(name, value);
156     else if (name == SVGNames::xAttr)
157         setXBaseValue(SVGLength::construct(LengthModeWidth, value, parseError));
158     else if (name == SVGNames::yAttr)
159         setYBaseValue(SVGLength::construct(LengthModeHeight, value, parseError));
160     else if (name == SVGNames::widthAttr)
161         setWidthBaseValue(SVGLength::construct(LengthModeWidth, value, parseError, ForbidNegativeLengths));
162     else if (name == SVGNames::heightAttr)
163         setHeightBaseValue(SVGLength::construct(LengthModeHeight, value, parseError, ForbidNegativeLengths));
164     else if (SVGTests::parseAttribute(name, value)
165              || SVGLangSpace::parseAttribute(name, value)
166              || SVGExternalResourcesRequired::parseAttribute(name, value)
167              || SVGURIReference::parseAttribute(name, value)) {
168     } else
169         ASSERT_NOT_REACHED();
170
171     reportAttributeParsingError(parseError, name, value);
172 }
173
174 static inline bool isWellFormedDocument(Document* document)
175 {
176     if (document->isSVGDocument() || document->isXHTMLDocument())
177         return static_cast<XMLDocumentParser*>(document->parser())->wellFormed();
178     return true;
179 }
180
181 Node::InsertionNotificationRequest SVGUseElement::insertedInto(ContainerNode* rootParent)
182 {
183     // This functions exists to assure assumptions made in the code regarding SVGElementInstance creation/destruction are satisfied.
184     SVGStyledTransformableElement::insertedInto(rootParent);
185     if (!rootParent->inDocument())
186         return InsertionDone;
187     ASSERT(!m_targetElementInstance || !isWellFormedDocument(document()));
188     ASSERT(!hasPendingResources() || !isWellFormedDocument(document()));
189     if (!m_wasInsertedByParser)
190         buildPendingResource();
191     SVGExternalResourcesRequired::insertedIntoDocument(this);
192     return InsertionDone;
193 }
194
195 void SVGUseElement::removedFrom(ContainerNode* rootParent)
196 {
197     SVGStyledTransformableElement::removedFrom(rootParent);
198     if (rootParent->inDocument())
199         clearResourceReferences();
200 }
201
202 Document* SVGUseElement::referencedDocument() const
203 {
204     if (!isExternalURIReference(href(), document()))
205         return document();
206     return externalDocument();
207 }
208
209 Document* SVGUseElement::externalDocument() const
210 {
211     if (m_cachedDocument && m_cachedDocument->isLoaded()) {
212         // Gracefully handle error condition.
213         if (m_cachedDocument->errorOccurred())
214             return 0;
215         ASSERT(m_cachedDocument->document());
216         return m_cachedDocument->document();
217     }
218     return 0;
219 }
220
221 void SVGUseElement::svgAttributeChanged(const QualifiedName& attrName)
222 {
223     if (!isSupportedAttribute(attrName)) {
224         SVGStyledTransformableElement::svgAttributeChanged(attrName);
225         return;
226     }
227
228     SVGElementInstance::InvalidationGuard invalidationGuard(this);
229
230     RenderObject* renderer = this->renderer();
231     if (attrName == SVGNames::xAttr
232         || attrName == SVGNames::yAttr
233         || attrName == SVGNames::widthAttr
234         || attrName == SVGNames::heightAttr) {
235         updateRelativeLengthsInformation();
236         if (renderer)
237             RenderSVGResource::markForLayoutAndParentResourceInvalidation(renderer);
238         return;
239     }
240
241     if (SVGTests::handleAttributeChange(this, attrName))
242         return;
243
244     if (SVGExternalResourcesRequired::handleAttributeChange(this, attrName))
245         return;
246
247     if (SVGURIReference::isKnownAttribute(attrName)) {
248         bool isExternalReference = isExternalURIReference(href(), document());
249         if (isExternalReference) {
250             KURL url = document()->completeURL(href());
251             if (url.hasFragmentIdentifier()) {
252                 CachedResourceRequest request(ResourceRequest(url.string()));
253                 request.setInitiator(this);
254                 setCachedDocument(document()->cachedResourceLoader()->requestSVGDocument(request));
255             }
256         } else
257             setCachedDocument(0);
258
259         if (!m_wasInsertedByParser)
260             buildPendingResource();
261
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->removeChildren();
398
399     if (m_targetElementInstance) {
400         m_targetElementInstance->detach();
401         m_targetElementInstance = 0;
402     }
403
404     m_needsShadowTreeRecreation = false;
405
406     ASSERT(document());
407     document()->accessSVGExtensions()->removeAllTargetReferencesForElement(this);
408 }
409
410 void SVGUseElement::buildPendingResource()
411 {
412     if (!referencedDocument())
413         return;
414     clearResourceReferences();
415     if (!inDocument() || isInShadowTree())
416         return;
417
418     String id;
419     Element* target = SVGURIReference::targetElementFromIRIString(href(), document(), &id, externalDocument());
420     if (!target || !target->inDocument()) {
421         // If we can't find the target of an external element, just give up.
422         // We can't observe if the target somewhen enters the external document, nor should we do it.
423         if (externalDocument())
424             return;
425         if (id.isEmpty())
426             return;
427
428         referencedDocument()->accessSVGExtensions()->addPendingResource(id, this);
429         ASSERT(hasPendingResources());
430         return;
431     }
432
433     if (target->isSVGElement())
434         buildShadowAndInstanceTree(static_cast<SVGElement*>(target));
435     ASSERT(!m_needsShadowTreeRecreation);
436 }
437
438 void SVGUseElement::buildShadowAndInstanceTree(SVGElement* target)
439 {
440     ASSERT(!m_targetElementInstance);
441
442     // Do not build the shadow/instance tree for <use> elements living in a shadow tree.
443     // The will be expanded soon anyway - see expandUseElementsInShadowTree().
444     if (isInShadowTree())
445         return;
446
447     // Do not allow self-referencing.
448     // 'target' may be null, if it's a non SVG namespaced element.
449     if (!target || target == this)
450         return;
451
452     // Why a seperated instance/shadow tree? SVG demands it:
453     // The instance tree is accesable from JavaScript, and has to
454     // expose a 1:1 copy of the referenced tree, whereas internally we need
455     // to alter the tree for correct "use-on-symbol", "use-on-svg" support.
456
457     // Build instance tree. Create root SVGElementInstance object for the first sub-tree node.
458     //
459     // Spec: If the 'use' element references a simple graphics element such as a 'rect', then there is only a
460     // single SVGElementInstance object, and the correspondingElement attribute on this SVGElementInstance object
461     // is the SVGRectElement that corresponds to the referenced 'rect' element.
462     m_targetElementInstance = SVGElementInstance::create(this, this, target);
463
464     // Eventually enter recursion to build SVGElementInstance objects for the sub-tree children
465     bool foundProblem = false;
466     buildInstanceTree(target, m_targetElementInstance.get(), foundProblem, false);
467
468     if (instanceTreeIsLoading(m_targetElementInstance.get()))
469         return;
470
471     // SVG specification does not say a word about <use> & cycles. My view on this is: just ignore it!
472     // Non-appearing <use> content is easier to debug, then half-appearing content.
473     if (foundProblem) {
474         clearResourceReferences();
475         return;
476     }
477
478     // Assure instance tree building was successfull
479     ASSERT(m_targetElementInstance);
480     ASSERT(!m_targetElementInstance->shadowTreeElement());
481     ASSERT(m_targetElementInstance->correspondingUseElement() == this);
482     ASSERT(m_targetElementInstance->directUseElement() == this);
483     ASSERT(m_targetElementInstance->correspondingElement() == target);
484
485     ShadowRoot* shadowTreeRootElement = shadow()->oldestShadowRoot();
486     ASSERT(shadowTreeRootElement);
487
488     // Build shadow tree from instance tree
489     // This also handles the special cases: <use> on <symbol>, <use> on <svg>.
490     buildShadowTree(target, m_targetElementInstance.get());
491
492     // Expand all <use> elements in the shadow tree.
493     // Expand means: replace the actual <use> element by what it references.
494     expandUseElementsInShadowTree(shadowTreeRootElement);
495
496     // Expand all <symbol> elements in the shadow tree.
497     // Expand means: replace the actual <symbol> element by the <svg> element.
498     expandSymbolElementsInShadowTree(shadowTreeRootElement);
499
500     // Now that the shadow tree is completly expanded, we can associate
501     // shadow tree elements <-> instances in the instance tree.
502     associateInstancesWithShadowTreeElements(shadowTreeRootElement->firstChild(), m_targetElementInstance.get());
503
504     // If no shadow tree element is present, this means that the reference root
505     // element was removed, as it is disallowed (ie. <use> on <foreignObject>)
506     // Do NOT leave an inconsistent instance tree around, instead destruct it.
507     if (!m_targetElementInstance->shadowTreeElement()) {
508         clearResourceReferences();
509         return;
510     }
511
512     ASSERT(m_targetElementInstance->shadowTreeElement()->parentNode() == shadowTreeRootElement);
513
514     // Transfer event listeners assigned to the referenced element to our shadow tree elements.
515     transferEventListenersToShadowTree(m_targetElementInstance.get());
516
517     // Update relative length information.
518     updateRelativeLengthsInformation();
519
520     // Rebuild all dependent use elements.
521     ASSERT(document());
522     document()->accessSVGExtensions()->rebuildAllElementReferencesForTarget(this);
523
524     // Eventually dump instance tree
525 #ifdef DUMP_INSTANCE_TREE
526     String text;
527     unsigned int depth = 0;
528
529     dumpInstanceTree(depth, text, m_targetElementInstance.get());
530     fprintf(stderr, "\nDumping <use> instance tree:\n%s\n", text.latin1().data());
531 #endif
532
533     // Eventually dump shadow tree
534 #ifdef DUMP_SHADOW_TREE
535     RefPtr<XMLSerializer> serializer = XMLSerializer::create();
536     String markup = serializer->serializeToString(shadowTreeRootElement, ASSERT_NO_EXCEPTION);
537     fprintf(stderr, "Dumping <use> shadow tree markup:\n%s\n", markup.latin1().data());
538 #endif
539 }
540
541 RenderObject* SVGUseElement::createRenderer(RenderArena* arena, RenderStyle*)
542 {
543     return new (arena) RenderSVGTransformableContainer(this);
544 }
545
546 static bool isDirectReference(const Node* node)
547 {
548     return node->hasTagName(SVGNames::pathTag)
549            || node->hasTagName(SVGNames::rectTag)
550            || node->hasTagName(SVGNames::circleTag)
551            || node->hasTagName(SVGNames::ellipseTag)
552            || node->hasTagName(SVGNames::polygonTag)
553            || node->hasTagName(SVGNames::polylineTag)
554            || node->hasTagName(SVGNames::textTag);
555 }
556
557 void SVGUseElement::toClipPath(Path& path)
558 {
559     ASSERT(path.isEmpty());
560
561     Node* n = m_targetElementInstance ? m_targetElementInstance->shadowTreeElement() : 0;
562     if (!n)
563         return;
564
565     if (n->isSVGElement() && static_cast<SVGElement*>(n)->isStyledTransformable()) {
566         if (!isDirectReference(n))
567             // Spec: Indirect references are an error (14.3.5)
568             document()->accessSVGExtensions()->reportError("Not allowed to use indirect reference in <clip-path>");
569         else {
570             static_cast<SVGStyledTransformableElement*>(n)->toClipPath(path);
571             // FIXME: Avoid manual resolution of x/y here. Its potentially harmful.
572             SVGLengthContext lengthContext(this);
573             path.translate(FloatSize(x().value(lengthContext), y().value(lengthContext)));
574             path.transform(animatedLocalTransform());
575         }
576     }
577 }
578
579 RenderObject* SVGUseElement::rendererClipChild() const
580 {
581     Node* n = m_targetElementInstance ? m_targetElementInstance->shadowTreeElement() : 0;
582     if (!n)
583         return 0;
584
585     if (n->isSVGElement() && isDirectReference(n))
586         return static_cast<SVGElement*>(n)->renderer();
587
588     return 0;
589 }
590
591 void SVGUseElement::buildInstanceTree(SVGElement* target, SVGElementInstance* targetInstance, bool& foundProblem, bool foundUse)
592 {
593     ASSERT(target);
594     ASSERT(targetInstance);
595
596     // Spec: If the referenced object is itself a 'use', or if there are 'use' subelements within the referenced
597     // object, the instance tree will contain recursive expansion of the indirect references to form a complete tree.
598     bool targetHasUseTag = target->hasTagName(SVGNames::useTag);
599     SVGElement* newTarget = 0;
600     if (targetHasUseTag) {
601         foundProblem = hasCycleUseReferencing(static_cast<SVGUseElement*>(target), targetInstance, newTarget);
602         if (foundProblem)
603             return;
604
605         // We only need to track first degree <use> dependencies. Indirect references are handled
606         // as the invalidation bubbles up the dependency chain.
607         if (!foundUse) {
608             ASSERT(document());
609             document()->accessSVGExtensions()->addElementReferencingTarget(this, target);
610             foundUse = true;
611         }
612     } else if (isDisallowedElement(target)) {
613         foundProblem = true;
614         return;
615     }
616
617     // A general description from the SVG spec, describing what buildInstanceTree() actually does.
618     //
619     // Spec: If the 'use' element references a 'g' which contains two 'rect' elements, then the instance tree
620     // contains three SVGElementInstance objects, a root SVGElementInstance object whose correspondingElement
621     // is the SVGGElement object for the 'g', and then two child SVGElementInstance objects, each of which has
622     // its correspondingElement that is an SVGRectElement object.
623
624     for (Node* node = target->firstChild(); node; node = node->nextSibling()) {
625         SVGElement* element = 0;
626         if (node->isSVGElement())
627             element = static_cast<SVGElement*>(node);
628
629         // Skip any non-svg nodes or any disallowed element.
630         if (!element || isDisallowedElement(element))
631             continue;
632
633         // Create SVGElementInstance object, for both container/non-container nodes.
634         RefPtr<SVGElementInstance> instance = SVGElementInstance::create(this, 0, element);
635         SVGElementInstance* instancePtr = instance.get();
636         targetInstance->appendChild(instance.release());
637
638         // Enter recursion, appending new instance tree nodes to the "instance" object.
639         buildInstanceTree(element, instancePtr, foundProblem, foundUse);
640         if (foundProblem)
641             return;
642     }
643
644     if (!targetHasUseTag || !newTarget)
645         return;
646
647     RefPtr<SVGElementInstance> newInstance = SVGElementInstance::create(this, static_cast<SVGUseElement*>(target), newTarget);
648     SVGElementInstance* newInstancePtr = newInstance.get();
649     targetInstance->appendChild(newInstance.release());
650     buildInstanceTree(newTarget, newInstancePtr, foundProblem, foundUse);
651 }
652
653 bool SVGUseElement::hasCycleUseReferencing(SVGUseElement* use, SVGElementInstance* targetInstance, SVGElement*& newTarget)
654 {
655     Element* targetElement = SVGURIReference::targetElementFromIRIString(use->href(), referencedDocument());
656     newTarget = 0;
657     if (targetElement && targetElement->isSVGElement())
658         newTarget = static_cast<SVGElement*>(targetElement);
659
660     if (!newTarget)
661         return false;
662
663     // Shortcut for self-references
664     if (newTarget == this)
665         return true;
666
667     AtomicString targetId = newTarget->getIdAttribute();
668     SVGElementInstance* instance = targetInstance->parentNode();
669     while (instance) {
670         SVGElement* element = instance->correspondingElement();
671
672         // FIXME: This should probably be using getIdAttribute instead of idForStyleResolution.
673         if (element->hasID() && element->idForStyleResolution() == targetId && element->document() == newTarget->document())
674             return true;
675
676         instance = instance->parentNode();
677     }
678     return false;
679 }
680
681 static inline void removeDisallowedElementsFromSubtree(Element* subtree)
682 {
683     ASSERT(!subtree->inDocument());
684     Element* element = ElementTraversal::firstWithin(subtree);
685     while (element) {
686         if (isDisallowedElement(element)) {
687             Element* next = ElementTraversal::nextSkippingChildren(element, subtree);
688             // The subtree is not in document so this won't generate events that could mutate the tree.
689             element->parentNode()->removeChild(element);
690             element = next;
691         } else
692             element = ElementTraversal::next(element, subtree);
693     }
694 }
695
696 void SVGUseElement::buildShadowTree(SVGElement* target, SVGElementInstance* targetInstance)
697 {
698     // For instance <use> on <foreignObject> (direct case).
699     if (isDisallowedElement(target))
700         return;
701
702     RefPtr<Element> newChild = targetInstance->correspondingElement()->cloneElementWithChildren();
703
704     // We don't walk the target tree element-by-element, and clone each element,
705     // but instead use cloneElementWithChildren(). This is an optimization for the common
706     // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
707     // Though if there are disallowed elements in the subtree, we have to remove them.
708     // For instance: <use> on <g> containing <foreignObject> (indirect case).
709     if (subtreeContainsDisallowedElement(newChild.get()))
710         removeDisallowedElementsFromSubtree(newChild.get());
711
712     shadow()->oldestShadowRoot()->appendChild(newChild.release());
713 }
714
715 void SVGUseElement::expandUseElementsInShadowTree(Node* element)
716 {
717     // Why expand the <use> elements in the shadow tree here, and not just
718     // do this directly in buildShadowTree, if we encounter a <use> element?
719     //
720     // Short answer: Because we may miss to expand some elements. Ie. if a <symbol>
721     // contains <use> tags, we'd miss them. So once we're done with settin' up the
722     // actual shadow tree (after the special case modification for svg/symbol) we have
723     // to walk it completely and expand all <use> elements.
724     if (element->hasTagName(SVGNames::useTag)) {
725         SVGUseElement* use = static_cast<SVGUseElement*>(element);
726         ASSERT(!use->cachedDocumentIsStillLoading());
727
728         Element* targetElement = SVGURIReference::targetElementFromIRIString(use->href(), referencedDocument());
729         SVGElement* target = 0;
730         if (targetElement && targetElement->isSVGElement())
731             target = static_cast<SVGElement*>(targetElement);
732
733         // Don't ASSERT(target) here, it may be "pending", too.
734         // Setup sub-shadow tree root node
735         RefPtr<SVGGElement> cloneParent = SVGGElement::create(SVGNames::gTag, referencedDocument());
736         use->cloneChildNodes(cloneParent.get());
737
738         // Spec: In the generated content, the 'use' will be replaced by 'g', where all attributes from the
739         // 'use' element except for x, y, width, height and xlink:href are transferred to the generated 'g' element.
740         transferUseAttributesToReplacedElement(use, cloneParent.get());
741
742         if (target && !isDisallowedElement(target)) {
743             RefPtr<Element> newChild = target->cloneElementWithChildren();
744             ASSERT(newChild->isSVGElement());
745             cloneParent->appendChild(newChild.release());
746         }
747
748         // We don't walk the target tree element-by-element, and clone each element,
749         // but instead use cloneElementWithChildren(). This is an optimization for the common
750         // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
751         // Though if there are disallowed elements in the subtree, we have to remove them.
752         // For instance: <use> on <g> containing <foreignObject> (indirect case).
753         if (subtreeContainsDisallowedElement(cloneParent.get()))
754             removeDisallowedElementsFromSubtree(cloneParent.get());
755
756         RefPtr<Node> replacingElement(cloneParent.get());
757
758         // Replace <use> with referenced content.
759         ASSERT(use->parentNode());
760         use->parentNode()->replaceChild(cloneParent.release(), use);
761
762         // Expand the siblings because the *element* is replaced and we will
763         // lose the sibling chain when we are back from recursion.
764         element = replacingElement.get();
765         for (RefPtr<Node> sibling = element->nextSibling(); sibling; sibling = sibling->nextSibling())
766             expandUseElementsInShadowTree(sibling.get());
767     }
768
769     for (RefPtr<Node> child = element->firstChild(); child; child = child->nextSibling())
770         expandUseElementsInShadowTree(child.get());
771 }
772
773 void SVGUseElement::expandSymbolElementsInShadowTree(Node* element)
774 {
775     if (element->hasTagName(SVGNames::symbolTag)) {
776         // Spec: The referenced 'symbol' and its contents are deep-cloned into the generated tree,
777         // with the exception that the 'symbol' is replaced by an 'svg'. This generated 'svg' will
778         // always have explicit values for attributes width and height. If attributes width and/or
779         // height are provided on the 'use' element, then these attributes will be transferred to
780         // the generated 'svg'. If attributes width and/or height are not specified, the generated
781         // 'svg' element will use values of 100% for these attributes.
782         RefPtr<SVGSVGElement> svgElement = SVGSVGElement::create(SVGNames::svgTag, referencedDocument());
783
784         // Transfer all data (attributes, etc.) from <symbol> to the new <svg> element.
785         svgElement->cloneDataFromElement(*toElement(element));
786
787         // Only clone symbol children, and add them to the new <svg> element
788         for (Node* child = element->firstChild(); child; child = child->nextSibling()) {
789             RefPtr<Node> newChild = child->cloneNode(true);
790             svgElement->appendChild(newChild.release());
791         }
792
793         // We don't walk the target tree element-by-element, and clone each element,
794         // but instead use cloneNode(deep=true). This is an optimization for the common
795         // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
796         // Though if there are disallowed elements in the subtree, we have to remove them.
797         // For instance: <use> on <g> containing <foreignObject> (indirect case).
798         if (subtreeContainsDisallowedElement(svgElement.get()))
799             removeDisallowedElementsFromSubtree(svgElement.get());
800
801         RefPtr<Node> replacingElement(svgElement.get());
802
803         // Replace <symbol> with <svg>.
804         element->parentNode()->replaceChild(svgElement.release(), element);
805
806         // Expand the siblings because the *element* is replaced and we will
807         // lose the sibling chain when we are back from recursion.
808         element = replacingElement.get();
809         for (RefPtr<Node> sibling = element->nextSibling(); sibling; sibling = sibling->nextSibling())
810             expandSymbolElementsInShadowTree(sibling.get());
811     }
812
813     for (RefPtr<Node> child = element->firstChild(); child; child = child->nextSibling())
814         expandSymbolElementsInShadowTree(child.get());
815 }
816
817 void SVGUseElement::transferEventListenersToShadowTree(SVGElementInstance* target)
818 {
819     if (!target)
820         return;
821
822     SVGElement* originalElement = target->correspondingElement();
823     ASSERT(originalElement);
824
825     if (SVGElement* shadowTreeElement = target->shadowTreeElement()) {
826         if (EventTargetData* data = originalElement->eventTargetData())
827             data->eventListenerMap.copyEventListenersNotCreatedFromMarkupToTarget(shadowTreeElement);
828     }
829
830     for (SVGElementInstance* instance = target->firstChild(); instance; instance = instance->nextSibling())
831         transferEventListenersToShadowTree(instance);
832 }
833
834 void SVGUseElement::associateInstancesWithShadowTreeElements(Node* target, SVGElementInstance* targetInstance)
835 {
836     if (!target || !targetInstance)
837         return;
838
839     SVGElement* originalElement = targetInstance->correspondingElement();
840
841     if (originalElement->hasTagName(SVGNames::useTag)) {
842         // <use> gets replaced by <g>
843         ASSERT(target->nodeName() == SVGNames::gTag);
844     } else if (originalElement->hasTagName(SVGNames::symbolTag)) {
845         // <symbol> gets replaced by <svg>
846         ASSERT(target->nodeName() == SVGNames::svgTag);
847     } else
848         ASSERT(target->nodeName() == originalElement->nodeName());
849
850     SVGElement* element = 0;
851     if (target->isSVGElement())
852         element = static_cast<SVGElement*>(target);
853
854     ASSERT(!targetInstance->shadowTreeElement());
855     targetInstance->setShadowTreeElement(element);
856     element->setCorrespondingElement(originalElement);
857
858     Node* node = target->firstChild();
859     for (SVGElementInstance* instance = targetInstance->firstChild(); node && instance; instance = instance->nextSibling()) {
860         // Skip any non-svg elements in shadow tree
861         while (node && !node->isSVGElement())
862            node = node->nextSibling();
863
864         if (!node)
865             break;
866
867         associateInstancesWithShadowTreeElements(node, instance);
868         node = node->nextSibling();
869     }
870 }
871
872 SVGElementInstance* SVGUseElement::instanceForShadowTreeElement(Node* element) const
873 {
874     if (!m_targetElementInstance) {
875         ASSERT(!inDocument());
876         return 0;
877     }
878
879     return instanceForShadowTreeElement(element, m_targetElementInstance.get());
880 }
881
882 SVGElementInstance* SVGUseElement::instanceForShadowTreeElement(Node* element, SVGElementInstance* instance) const
883 {
884     ASSERT(element);
885     ASSERT(instance);
886
887     // We're dispatching a mutation event during shadow tree construction
888     // this instance hasn't yet been associated to a shadowTree element.
889     if (!instance->shadowTreeElement())
890         return 0;
891
892     if (element == instance->shadowTreeElement())
893         return instance;
894
895     for (SVGElementInstance* current = instance->firstChild(); current; current = current->nextSibling()) {
896         if (SVGElementInstance* search = instanceForShadowTreeElement(element, current))
897             return search;
898     }
899
900     return 0;
901 }
902
903 void SVGUseElement::invalidateShadowTree()
904 {
905     if (!renderer() || m_needsShadowTreeRecreation)
906         return;
907     m_needsShadowTreeRecreation = true;
908     setNeedsStyleRecalc();
909 }
910
911 void SVGUseElement::transferUseAttributesToReplacedElement(SVGElement* from, SVGElement* to) const
912 {
913     ASSERT(from);
914     ASSERT(to);
915
916     to->cloneDataFromElement(*from);
917
918     to->removeAttribute(SVGNames::xAttr);
919     to->removeAttribute(SVGNames::yAttr);
920     to->removeAttribute(SVGNames::widthAttr);
921     to->removeAttribute(SVGNames::heightAttr);
922     to->removeAttribute(XLinkNames::hrefAttr);
923 }
924
925 bool SVGUseElement::selfHasRelativeLengths() const
926 {
927     if (x().isRelative()
928      || y().isRelative()
929      || width().isRelative()
930      || height().isRelative())
931         return true;
932
933     if (!m_targetElementInstance)
934         return false;
935
936     SVGElement* element = m_targetElementInstance->correspondingElement();
937     if (!element || !element->isStyled())
938         return false;
939
940     return static_cast<SVGStyledElement*>(element)->hasRelativeLengths();
941 }
942
943 void SVGUseElement::notifyFinished(CachedResource* resource)
944 {
945     if (!inDocument())
946         return;
947
948     invalidateShadowTree();
949     if (resource->errorOccurred())
950         dispatchEvent(Event::create(eventNames().errorEvent, false, false));
951     else if (!resource->wasCanceled())
952         SVGExternalResourcesRequired::dispatchLoadEvent(this);
953 }
954
955 bool SVGUseElement::cachedDocumentIsStillLoading()
956 {
957     if (m_cachedDocument && m_cachedDocument->isLoading())
958         return true;
959     return false;
960 }
961
962 bool SVGUseElement::instanceTreeIsLoading(SVGElementInstance* targetElementInstance)
963 {
964     for (SVGElementInstance* instance = targetElementInstance->firstChild(); instance; instance = instance->nextSibling()) {
965         if (SVGUseElement* use = instance->correspondingUseElement()) {
966              if (use->cachedDocumentIsStillLoading())
967                  return true;
968         }
969         if (instance->hasChildNodes())
970             instanceTreeIsLoading(instance);
971     }
972     return false;
973 }
974
975 void SVGUseElement::finishParsingChildren()
976 {
977     SVGStyledTransformableElement::finishParsingChildren();
978     SVGExternalResourcesRequired::finishParsingChildren();
979     if (m_wasInsertedByParser) {
980         buildPendingResource();
981         m_wasInsertedByParser = false;
982     }
983 }
984
985 void SVGUseElement::setCachedDocument(CachedResourceHandle<CachedSVGDocument> cachedDocument)
986 {
987     if (m_cachedDocument == cachedDocument)
988         return;
989
990     if (m_cachedDocument)
991         m_cachedDocument->removeClient(this);
992
993     m_cachedDocument = cachedDocument;
994     if (m_cachedDocument)
995         m_cachedDocument->addClient(this);
996 }
997
998 }
999
1000 #endif // ENABLE(SVG)