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