Rename getAssignedNodes to assignedNodes and support flattened option
[WebKit-https.git] / Source / WebCore / html / HTMLSlotElement.cpp
1 /*
2  * Copyright (C) 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "HTMLSlotElement.h"
28
29 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
30
31 #include "Dictionary.h"
32 #include "ElementChildIterator.h"
33 #include "Event.h"
34 #include "EventNames.h"
35 #include "HTMLNames.h"
36 #include "ShadowRoot.h"
37
38 namespace WebCore {
39
40 using namespace HTMLNames;
41
42 Ref<HTMLSlotElement> HTMLSlotElement::create(const QualifiedName& tagName, Document& document)
43 {
44     return adoptRef(*new HTMLSlotElement(tagName, document));
45 }
46
47 HTMLSlotElement::HTMLSlotElement(const QualifiedName& tagName, Document& document)
48     : HTMLElement(tagName, document)
49 {
50     ASSERT(hasTagName(slotTag));
51 }
52
53 HTMLSlotElement::InsertionNotificationRequest HTMLSlotElement::insertedInto(ContainerNode& insertionPoint)
54 {
55     auto insertionResult = HTMLElement::insertedInto(insertionPoint);
56     ASSERT_UNUSED(insertionResult, insertionResult == InsertionDone);
57
58     // This function could be called when this element's shadow root's host or its ancestor is inserted.
59     // This element is new to the shadow tree (and its tree scope) only if the parent into which this element
60     // or its ancestor is inserted belongs to the same tree scope as this element's.
61     if (insertionPoint.isInShadowTree() && isInShadowTree() && &insertionPoint.treeScope() == &treeScope()) {
62         if (auto shadowRoot = containingShadowRoot())
63             shadowRoot->addSlotElementByName(fastGetAttribute(nameAttr), *this);
64     }
65
66     return InsertionDone;
67 }
68
69 void HTMLSlotElement::removedFrom(ContainerNode& insertionPoint)
70 {
71     // ContainerNode::removeBetween always sets the removed chid's tree scope to Document's but InShadowRoot flag is unset in Node::removedFrom.
72     // So if InShadowRoot flag is set but this element's tree scope is Document's, this element has just been removed from a shadow root.
73     if (insertionPoint.isInShadowTree() && isInShadowTree() && &treeScope() == &document()) {
74         auto* oldShadowRoot = insertionPoint.containingShadowRoot();
75         ASSERT(oldShadowRoot);
76         oldShadowRoot->removeSlotElementByName(fastGetAttribute(nameAttr), *this);
77     }
78
79     HTMLElement::removedFrom(insertionPoint);
80 }
81
82 void HTMLSlotElement::attributeChanged(const QualifiedName& name, const AtomicString& oldValue, const AtomicString& newValue, AttributeModificationReason reason)
83 {
84     HTMLElement::attributeChanged(name, oldValue, newValue, reason);
85
86     if (isInShadowTree() && name == nameAttr) {
87         if (auto* shadowRoot = containingShadowRoot()) {
88             shadowRoot->removeSlotElementByName(oldValue, *this);
89             shadowRoot->addSlotElementByName(newValue, *this);
90         }
91     }
92 }
93
94 const Vector<Node*>* HTMLSlotElement::assignedNodes() const
95 {
96     auto* shadowRoot = containingShadowRoot();
97     if (!shadowRoot)
98         return nullptr;
99
100     return shadowRoot->assignedNodesForSlot(*this);
101 }
102
103 static void flattenAssignedNodes(Vector<Node*>& nodes, const Vector<Node*>& assignedNodes)
104 {
105     for (Node* node : assignedNodes) {
106         if (is<HTMLSlotElement>(*node)) {
107             if (auto* innerAssignedNodes = downcast<HTMLSlotElement>(*node).assignedNodes())
108                 flattenAssignedNodes(nodes, *innerAssignedNodes);
109             continue;
110         }
111         nodes.append(node);
112     }
113 }
114
115 const Vector<Node*> HTMLSlotElement::assignedNodesForBindings(const Dictionary& options) const
116 {
117     bool shouldFlatten = false;
118     options.get("flatten", shouldFlatten);
119
120     Vector<Node*> nodes;
121     auto* assignedNodes = this->assignedNodes();
122     if (!assignedNodes)
123         return nodes;
124
125     if (shouldFlatten)
126         flattenAssignedNodes(nodes, *assignedNodes);
127     else
128         nodes = *assignedNodes;
129
130     return nodes;
131 }
132
133 void HTMLSlotElement::enqueueSlotChangeEvent()
134 {
135     if (m_hasEnqueuedSlotChangeEvent)
136         return;
137
138     bool bubbles = false;
139     bool cancelable = false;
140     auto event = Event::create(eventNames().slotchangeEvent, bubbles, cancelable);
141     event->setTarget(this);
142     document().enqueueSlotchangeEvent(WTFMove(event));
143
144     m_hasEnqueuedSlotChangeEvent = true;
145 }
146
147 bool HTMLSlotElement::dispatchEvent(Event& event)
148 {
149     if (event.type() == eventNames().slotchangeEvent)
150         m_hasEnqueuedSlotChangeEvent = false;
151     return HTMLElement::dispatchEvent(event);
152 }
153
154 }
155
156 #endif