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