0f296b9ef18b086e935e8ef4311f7f12070b3b78
[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() || isInShadowTree())
413         return;
414     clearResourceReferences();
415     if (!inDocument())
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         invalidateDependentShadowTrees();
436     }
437
438     ASSERT(!m_needsShadowTreeRecreation);
439 }
440
441 void SVGUseElement::buildShadowAndInstanceTree(SVGElement* target)
442 {
443     ASSERT(!m_targetElementInstance);
444
445     // Do not build the shadow/instance tree for <use> elements living in a shadow tree.
446     // The will be expanded soon anyway - see expandUseElementsInShadowTree().
447     if (isInShadowTree())
448         return;
449
450     // Do not allow self-referencing.
451     // 'target' may be null, if it's a non SVG namespaced element.
452     if (!target || target == this)
453         return;
454
455     // Why a seperated instance/shadow tree? SVG demands it:
456     // The instance tree is accesable from JavaScript, and has to
457     // expose a 1:1 copy of the referenced tree, whereas internally we need
458     // to alter the tree for correct "use-on-symbol", "use-on-svg" support.
459
460     // Build instance tree. Create root SVGElementInstance object for the first sub-tree node.
461     //
462     // Spec: If the 'use' element references a simple graphics element such as a 'rect', then there is only a
463     // single SVGElementInstance object, and the correspondingElement attribute on this SVGElementInstance object
464     // is the SVGRectElement that corresponds to the referenced 'rect' element.
465     m_targetElementInstance = SVGElementInstance::create(this, this, target);
466
467     // Eventually enter recursion to build SVGElementInstance objects for the sub-tree children
468     bool foundProblem = false;
469     buildInstanceTree(target, m_targetElementInstance.get(), foundProblem, false);
470
471     if (instanceTreeIsLoading(m_targetElementInstance.get()))
472         return;
473
474     // SVG specification does not say a word about <use> & cycles. My view on this is: just ignore it!
475     // Non-appearing <use> content is easier to debug, then half-appearing content.
476     if (foundProblem) {
477         clearResourceReferences();
478         return;
479     }
480
481     // Assure instance tree building was successfull
482     ASSERT(m_targetElementInstance);
483     ASSERT(!m_targetElementInstance->shadowTreeElement());
484     ASSERT(m_targetElementInstance->correspondingUseElement() == this);
485     ASSERT(m_targetElementInstance->directUseElement() == this);
486     ASSERT(m_targetElementInstance->correspondingElement() == target);
487
488     ShadowRoot* shadowTreeRootElement = shadow()->oldestShadowRoot();
489     ASSERT(shadowTreeRootElement);
490
491     // Build shadow tree from instance tree
492     // This also handles the special cases: <use> on <symbol>, <use> on <svg>.
493     buildShadowTree(target, m_targetElementInstance.get());
494
495     // Expand all <use> elements in the shadow tree.
496     // Expand means: replace the actual <use> element by what it references.
497     expandUseElementsInShadowTree(shadowTreeRootElement);
498
499     // Expand all <symbol> elements in the shadow tree.
500     // Expand means: replace the actual <symbol> element by the <svg> element.
501     expandSymbolElementsInShadowTree(shadowTreeRootElement);
502
503     // Now that the shadow tree is completly expanded, we can associate
504     // shadow tree elements <-> instances in the instance tree.
505     associateInstancesWithShadowTreeElements(shadowTreeRootElement->firstChild(), m_targetElementInstance.get());
506
507     // If no shadow tree element is present, this means that the reference root
508     // element was removed, as it is disallowed (ie. <use> on <foreignObject>)
509     // Do NOT leave an inconsistent instance tree around, instead destruct it.
510     if (!m_targetElementInstance->shadowTreeElement()) {
511         clearResourceReferences();
512         return;
513     }
514
515     ASSERT(m_targetElementInstance->shadowTreeElement()->parentNode() == shadowTreeRootElement);
516
517     // Transfer event listeners assigned to the referenced element to our shadow tree elements.
518     transferEventListenersToShadowTree(m_targetElementInstance.get());
519
520     // Update relative length information.
521     updateRelativeLengthsInformation();
522
523     // Eventually dump instance tree
524 #ifdef DUMP_INSTANCE_TREE
525     String text;
526     unsigned int depth = 0;
527
528     dumpInstanceTree(depth, text, m_targetElementInstance.get());
529     fprintf(stderr, "\nDumping <use> instance tree:\n%s\n", text.latin1().data());
530 #endif
531
532     // Eventually dump shadow tree
533 #ifdef DUMP_SHADOW_TREE
534     RefPtr<XMLSerializer> serializer = XMLSerializer::create();
535     String markup = serializer->serializeToString(shadowTreeRootElement, ASSERT_NO_EXCEPTION);
536     fprintf(stderr, "Dumping <use> shadow tree markup:\n%s\n", markup.latin1().data());
537 #endif
538 }
539
540 RenderObject* SVGUseElement::createRenderer(RenderArena* arena, RenderStyle*)
541 {
542     return new (arena) RenderSVGTransformableContainer(this);
543 }
544
545 static bool isDirectReference(const Node* node)
546 {
547     return node->hasTagName(SVGNames::pathTag)
548            || node->hasTagName(SVGNames::rectTag)
549            || node->hasTagName(SVGNames::circleTag)
550            || node->hasTagName(SVGNames::ellipseTag)
551            || node->hasTagName(SVGNames::polygonTag)
552            || node->hasTagName(SVGNames::polylineTag)
553            || node->hasTagName(SVGNames::textTag);
554 }
555
556 void SVGUseElement::toClipPath(Path& path)
557 {
558     ASSERT(path.isEmpty());
559
560     Node* n = m_targetElementInstance ? m_targetElementInstance->shadowTreeElement() : 0;
561     if (!n)
562         return;
563
564     if (n->isSVGElement() && static_cast<SVGElement*>(n)->isStyledTransformable()) {
565         if (!isDirectReference(n))
566             // Spec: Indirect references are an error (14.3.5)
567             document()->accessSVGExtensions()->reportError("Not allowed to use indirect reference in <clip-path>");
568         else {
569             static_cast<SVGStyledTransformableElement*>(n)->toClipPath(path);
570             // FIXME: Avoid manual resolution of x/y here. Its potentially harmful.
571             SVGLengthContext lengthContext(this);
572             path.translate(FloatSize(x().value(lengthContext), y().value(lengthContext)));
573             path.transform(animatedLocalTransform());
574         }
575     }
576 }
577
578 RenderObject* SVGUseElement::rendererClipChild() const
579 {
580     Node* n = m_targetElementInstance ? m_targetElementInstance->shadowTreeElement() : 0;
581     if (!n)
582         return 0;
583
584     if (n->isSVGElement() && isDirectReference(n))
585         return static_cast<SVGElement*>(n)->renderer();
586
587     return 0;
588 }
589
590 void SVGUseElement::buildInstanceTree(SVGElement* target, SVGElementInstance* targetInstance, bool& foundProblem, bool foundUse)
591 {
592     ASSERT(target);
593     ASSERT(targetInstance);
594
595     // Spec: If the referenced object is itself a 'use', or if there are 'use' subelements within the referenced
596     // object, the instance tree will contain recursive expansion of the indirect references to form a complete tree.
597     bool targetHasUseTag = target->hasTagName(SVGNames::useTag);
598     SVGElement* newTarget = 0;
599     if (targetHasUseTag) {
600         foundProblem = hasCycleUseReferencing(static_cast<SVGUseElement*>(target), targetInstance, newTarget);
601         if (foundProblem)
602             return;
603
604         // We only need to track first degree <use> dependencies. Indirect references are handled
605         // as the invalidation bubbles up the dependency chain.
606         if (!foundUse) {
607             ASSERT(document());
608             document()->accessSVGExtensions()->addElementReferencingTarget(this, target);
609             foundUse = true;
610         }
611     } else if (isDisallowedElement(target)) {
612         foundProblem = true;
613         return;
614     }
615
616     // A general description from the SVG spec, describing what buildInstanceTree() actually does.
617     //
618     // Spec: If the 'use' element references a 'g' which contains two 'rect' elements, then the instance tree
619     // contains three SVGElementInstance objects, a root SVGElementInstance object whose correspondingElement
620     // is the SVGGElement object for the 'g', and then two child SVGElementInstance objects, each of which has
621     // its correspondingElement that is an SVGRectElement object.
622
623     for (Node* node = target->firstChild(); node; node = node->nextSibling()) {
624         SVGElement* element = 0;
625         if (node->isSVGElement())
626             element = static_cast<SVGElement*>(node);
627
628         // Skip any non-svg nodes or any disallowed element.
629         if (!element || isDisallowedElement(element))
630             continue;
631
632         // Create SVGElementInstance object, for both container/non-container nodes.
633         RefPtr<SVGElementInstance> instance = SVGElementInstance::create(this, 0, element);
634         SVGElementInstance* instancePtr = instance.get();
635         targetInstance->appendChild(instance.release());
636
637         // Enter recursion, appending new instance tree nodes to the "instance" object.
638         buildInstanceTree(element, instancePtr, foundProblem, foundUse);
639         if (foundProblem)
640             return;
641     }
642
643     if (!targetHasUseTag || !newTarget)
644         return;
645
646     RefPtr<SVGElementInstance> newInstance = SVGElementInstance::create(this, static_cast<SVGUseElement*>(target), newTarget);
647     SVGElementInstance* newInstancePtr = newInstance.get();
648     targetInstance->appendChild(newInstance.release());
649     buildInstanceTree(newTarget, newInstancePtr, foundProblem, foundUse);
650 }
651
652 bool SVGUseElement::hasCycleUseReferencing(SVGUseElement* use, SVGElementInstance* targetInstance, SVGElement*& newTarget)
653 {
654     Element* targetElement = SVGURIReference::targetElementFromIRIString(use->href(), referencedDocument());
655     newTarget = 0;
656     if (targetElement && targetElement->isSVGElement())
657         newTarget = static_cast<SVGElement*>(targetElement);
658
659     if (!newTarget)
660         return false;
661
662     // Shortcut for self-references
663     if (newTarget == this)
664         return true;
665
666     AtomicString targetId = newTarget->getIdAttribute();
667     SVGElementInstance* instance = targetInstance->parentNode();
668     while (instance) {
669         SVGElement* element = instance->correspondingElement();
670
671         // FIXME: This should probably be using getIdAttribute instead of idForStyleResolution.
672         if (element->hasID() && element->idForStyleResolution() == targetId && element->document() == newTarget->document())
673             return true;
674
675         instance = instance->parentNode();
676     }
677     return false;
678 }
679
680 static inline void removeDisallowedElementsFromSubtree(Element* subtree)
681 {
682     ASSERT(!subtree->inDocument());
683     Element* element = ElementTraversal::firstWithin(subtree);
684     while (element) {
685         if (isDisallowedElement(element)) {
686             Element* next = ElementTraversal::nextSkippingChildren(element, subtree);
687             // The subtree is not in document so this won't generate events that could mutate the tree.
688             element->parentNode()->removeChild(element);
689             element = next;
690         } else
691             element = ElementTraversal::next(element, subtree);
692     }
693 }
694
695 void SVGUseElement::buildShadowTree(SVGElement* target, SVGElementInstance* targetInstance)
696 {
697     // For instance <use> on <foreignObject> (direct case).
698     if (isDisallowedElement(target))
699         return;
700
701     RefPtr<Element> newChild = targetInstance->correspondingElement()->cloneElementWithChildren();
702
703     // We don't walk the target tree element-by-element, and clone each element,
704     // but instead use cloneElementWithChildren(). This is an optimization for the common
705     // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
706     // Though if there are disallowed elements in the subtree, we have to remove them.
707     // For instance: <use> on <g> containing <foreignObject> (indirect case).
708     if (subtreeContainsDisallowedElement(newChild.get()))
709         removeDisallowedElementsFromSubtree(newChild.get());
710
711     shadow()->oldestShadowRoot()->appendChild(newChild.release());
712 }
713
714 void SVGUseElement::expandUseElementsInShadowTree(Node* element)
715 {
716     // Why expand the <use> elements in the shadow tree here, and not just
717     // do this directly in buildShadowTree, if we encounter a <use> element?
718     //
719     // Short answer: Because we may miss to expand some elements. Ie. if a <symbol>
720     // contains <use> tags, we'd miss them. So once we're done with settin' up the
721     // actual shadow tree (after the special case modification for svg/symbol) we have
722     // to walk it completely and expand all <use> elements.
723     if (element->hasTagName(SVGNames::useTag)) {
724         SVGUseElement* use = static_cast<SVGUseElement*>(element);
725         ASSERT(!use->cachedDocumentIsStillLoading());
726
727         Element* targetElement = SVGURIReference::targetElementFromIRIString(use->href(), referencedDocument());
728         SVGElement* target = 0;
729         if (targetElement && targetElement->isSVGElement())
730             target = static_cast<SVGElement*>(targetElement);
731
732         // Don't ASSERT(target) here, it may be "pending", too.
733         // Setup sub-shadow tree root node
734         RefPtr<SVGGElement> cloneParent = SVGGElement::create(SVGNames::gTag, referencedDocument());
735         use->cloneChildNodes(cloneParent.get());
736
737         // Spec: In the generated content, the 'use' will be replaced by 'g', where all attributes from the
738         // 'use' element except for x, y, width, height and xlink:href are transferred to the generated 'g' element.
739         transferUseAttributesToReplacedElement(use, cloneParent.get());
740
741         if (target && !isDisallowedElement(target)) {
742             RefPtr<Element> newChild = target->cloneElementWithChildren();
743             ASSERT(newChild->isSVGElement());
744             cloneParent->appendChild(newChild.release());
745         }
746
747         // We don't walk the target tree element-by-element, and clone each element,
748         // but instead use cloneElementWithChildren(). This is an optimization for the common
749         // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
750         // Though if there are disallowed elements in the subtree, we have to remove them.
751         // For instance: <use> on <g> containing <foreignObject> (indirect case).
752         if (subtreeContainsDisallowedElement(cloneParent.get()))
753             removeDisallowedElementsFromSubtree(cloneParent.get());
754
755         RefPtr<Node> replacingElement(cloneParent.get());
756
757         // Replace <use> with referenced content.
758         ASSERT(use->parentNode());
759         use->parentNode()->replaceChild(cloneParent.release(), use);
760
761         // Expand the siblings because the *element* is replaced and we will
762         // lose the sibling chain when we are back from recursion.
763         element = replacingElement.get();
764         for (RefPtr<Node> sibling = element->nextSibling(); sibling; sibling = sibling->nextSibling())
765             expandUseElementsInShadowTree(sibling.get());
766     }
767
768     for (RefPtr<Node> child = element->firstChild(); child; child = child->nextSibling())
769         expandUseElementsInShadowTree(child.get());
770 }
771
772 void SVGUseElement::expandSymbolElementsInShadowTree(Node* element)
773 {
774     if (element->hasTagName(SVGNames::symbolTag)) {
775         // Spec: The referenced 'symbol' and its contents are deep-cloned into the generated tree,
776         // with the exception that the 'symbol' is replaced by an 'svg'. This generated 'svg' will
777         // always have explicit values for attributes width and height. If attributes width and/or
778         // height are provided on the 'use' element, then these attributes will be transferred to
779         // the generated 'svg'. If attributes width and/or height are not specified, the generated
780         // 'svg' element will use values of 100% for these attributes.
781         RefPtr<SVGSVGElement> svgElement = SVGSVGElement::create(SVGNames::svgTag, referencedDocument());
782
783         // Transfer all data (attributes, etc.) from <symbol> to the new <svg> element.
784         svgElement->cloneDataFromElement(*toElement(element));
785
786         // Only clone symbol children, and add them to the new <svg> element
787         for (Node* child = element->firstChild(); child; child = child->nextSibling()) {
788             RefPtr<Node> newChild = child->cloneNode(true);
789             svgElement->appendChild(newChild.release());
790         }
791
792         // We don't walk the target tree element-by-element, and clone each element,
793         // but instead use cloneNode(deep=true). This is an optimization for the common
794         // case where <use> doesn't contain disallowed elements (ie. <foreignObject>).
795         // Though if there are disallowed elements in the subtree, we have to remove them.
796         // For instance: <use> on <g> containing <foreignObject> (indirect case).
797         if (subtreeContainsDisallowedElement(svgElement.get()))
798             removeDisallowedElementsFromSubtree(svgElement.get());
799
800         RefPtr<Node> replacingElement(svgElement.get());
801
802         // Replace <symbol> with <svg>.
803         element->parentNode()->replaceChild(svgElement.release(), element);
804
805         // Expand the siblings because the *element* is replaced and we will
806         // lose the sibling chain when we are back from recursion.
807         element = replacingElement.get();
808         for (RefPtr<Node> sibling = element->nextSibling(); sibling; sibling = sibling->nextSibling())
809             expandSymbolElementsInShadowTree(sibling.get());
810     }
811
812     for (RefPtr<Node> child = element->firstChild(); child; child = child->nextSibling())
813         expandSymbolElementsInShadowTree(child.get());
814 }
815
816 void SVGUseElement::transferEventListenersToShadowTree(SVGElementInstance* target)
817 {
818     if (!target)
819         return;
820
821     SVGElement* originalElement = target->correspondingElement();
822     ASSERT(originalElement);
823
824     if (SVGElement* shadowTreeElement = target->shadowTreeElement()) {
825         if (EventTargetData* data = originalElement->eventTargetData())
826             data->eventListenerMap.copyEventListenersNotCreatedFromMarkupToTarget(shadowTreeElement);
827     }
828
829     for (SVGElementInstance* instance = target->firstChild(); instance; instance = instance->nextSibling())
830         transferEventListenersToShadowTree(instance);
831 }
832
833 void SVGUseElement::associateInstancesWithShadowTreeElements(Node* target, SVGElementInstance* targetInstance)
834 {
835     if (!target || !targetInstance)
836         return;
837
838     SVGElement* originalElement = targetInstance->correspondingElement();
839
840     if (originalElement->hasTagName(SVGNames::useTag)) {
841         // <use> gets replaced by <g>
842         ASSERT(target->nodeName() == SVGNames::gTag);
843     } else if (originalElement->hasTagName(SVGNames::symbolTag)) {
844         // <symbol> gets replaced by <svg>
845         ASSERT(target->nodeName() == SVGNames::svgTag);
846     } else
847         ASSERT(target->nodeName() == originalElement->nodeName());
848
849     SVGElement* element = 0;
850     if (target->isSVGElement())
851         element = static_cast<SVGElement*>(target);
852
853     ASSERT(!targetInstance->shadowTreeElement());
854     targetInstance->setShadowTreeElement(element);
855     element->setCorrespondingElement(originalElement);
856
857     Node* node = target->firstChild();
858     for (SVGElementInstance* instance = targetInstance->firstChild(); node && instance; instance = instance->nextSibling()) {
859         // Skip any non-svg elements in shadow tree
860         while (node && !node->isSVGElement())
861            node = node->nextSibling();
862
863         if (!node)
864             break;
865
866         associateInstancesWithShadowTreeElements(node, instance);
867         node = node->nextSibling();
868     }
869 }
870
871 SVGElementInstance* SVGUseElement::instanceForShadowTreeElement(Node* element) const
872 {
873     if (!m_targetElementInstance) {
874         ASSERT(!inDocument());
875         return 0;
876     }
877
878     return instanceForShadowTreeElement(element, m_targetElementInstance.get());
879 }
880
881 SVGElementInstance* SVGUseElement::instanceForShadowTreeElement(Node* element, SVGElementInstance* instance) const
882 {
883     ASSERT(element);
884     ASSERT(instance);
885
886     // We're dispatching a mutation event during shadow tree construction
887     // this instance hasn't yet been associated to a shadowTree element.
888     if (!instance->shadowTreeElement())
889         return 0;
890
891     if (element == instance->shadowTreeElement())
892         return instance;
893
894     for (SVGElementInstance* current = instance->firstChild(); current; current = current->nextSibling()) {
895         if (SVGElementInstance* search = instanceForShadowTreeElement(element, current))
896             return search;
897     }
898
899     return 0;
900 }
901
902 void SVGUseElement::invalidateShadowTree()
903 {
904     if (!renderer() || m_needsShadowTreeRecreation)
905         return;
906     m_needsShadowTreeRecreation = true;
907     setNeedsStyleRecalc();
908     invalidateDependentShadowTrees();
909 }
910
911 void SVGUseElement::invalidateDependentShadowTrees()
912 {
913     // Recursively invalidate dependent <use> shadow trees
914     const HashSet<SVGElementInstance*>& instances = instancesForElement();
915     const HashSet<SVGElementInstance*>::const_iterator end = instances.end();
916     for (HashSet<SVGElementInstance*>::const_iterator it = instances.begin(); it != end; ++it) {
917         if (SVGUseElement* element = (*it)->correspondingUseElement()) {
918             ASSERT(element->inDocument());
919             element->invalidateShadowTree();
920         }
921     }
922 }
923
924 void SVGUseElement::transferUseAttributesToReplacedElement(SVGElement* from, SVGElement* to) const
925 {
926     ASSERT(from);
927     ASSERT(to);
928
929     to->cloneDataFromElement(*from);
930
931     to->removeAttribute(SVGNames::xAttr);
932     to->removeAttribute(SVGNames::yAttr);
933     to->removeAttribute(SVGNames::widthAttr);
934     to->removeAttribute(SVGNames::heightAttr);
935     to->removeAttribute(XLinkNames::hrefAttr);
936 }
937
938 bool SVGUseElement::selfHasRelativeLengths() const
939 {
940     if (x().isRelative()
941      || y().isRelative()
942      || width().isRelative()
943      || height().isRelative())
944         return true;
945
946     if (!m_targetElementInstance)
947         return false;
948
949     SVGElement* element = m_targetElementInstance->correspondingElement();
950     if (!element || !element->isStyled())
951         return false;
952
953     return static_cast<SVGStyledElement*>(element)->hasRelativeLengths();
954 }
955
956 void SVGUseElement::notifyFinished(CachedResource* resource)
957 {
958     if (!inDocument())
959         return;
960
961     invalidateShadowTree();
962     if (resource->errorOccurred())
963         dispatchEvent(Event::create(eventNames().errorEvent, false, false));
964     else if (!resource->wasCanceled())
965         SVGExternalResourcesRequired::dispatchLoadEvent(this);
966 }
967
968 bool SVGUseElement::cachedDocumentIsStillLoading()
969 {
970     if (m_cachedDocument && m_cachedDocument->isLoading())
971         return true;
972     return false;
973 }
974
975 bool SVGUseElement::instanceTreeIsLoading(SVGElementInstance* targetElementInstance)
976 {
977     for (SVGElementInstance* instance = targetElementInstance->firstChild(); instance; instance = instance->nextSibling()) {
978         if (SVGUseElement* use = instance->correspondingUseElement()) {
979              if (use->cachedDocumentIsStillLoading())
980                  return true;
981         }
982         if (instance->hasChildNodes())
983             instanceTreeIsLoading(instance);
984     }
985     return false;
986 }
987
988 void SVGUseElement::finishParsingChildren()
989 {
990     SVGStyledTransformableElement::finishParsingChildren();
991     SVGExternalResourcesRequired::finishParsingChildren();
992     if (m_wasInsertedByParser) {
993         buildPendingResource();
994         m_wasInsertedByParser = false;
995     }
996 }
997
998 void SVGUseElement::setCachedDocument(CachedResourceHandle<CachedSVGDocument> cachedDocument)
999 {
1000     if (m_cachedDocument == cachedDocument)
1001         return;
1002
1003     if (m_cachedDocument)
1004         m_cachedDocument->removeClient(this);
1005
1006     m_cachedDocument = cachedDocument;
1007     if (m_cachedDocument)
1008         m_cachedDocument->addClient(this);
1009 }
1010
1011 }
1012
1013 #endif // ENABLE(SVG)