a273c261827a7d986faa13296d569c4e99692a14
[WebKit-https.git] / Source / WebCore / dom / ShadowRoot.h
1 /*
2  * Copyright (C) 2011 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Neither the name of Google Inc. nor the names of its
11  * contributors may be used to endorse or promote products derived from
12  * this software without specific prior written permission.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "Document.h"
30 #include "DocumentFragment.h"
31 #include "Element.h"
32 #include "ShadowRootMode.h"
33
34 namespace WebCore {
35
36 class HTMLSlotElement;
37 class SlotAssignment;
38
39 class ShadowRoot final : public DocumentFragment, public TreeScope {
40     WTF_MAKE_ISO_ALLOCATED(ShadowRoot);
41 public:
42     static Ref<ShadowRoot> create(Document& document, ShadowRootMode type)
43     {
44         return adoptRef(*new ShadowRoot(document, type));
45     }
46
47     static Ref<ShadowRoot> create(Document& document, std::unique_ptr<SlotAssignment>&& assignment)
48     {
49         return adoptRef(*new ShadowRoot(document, WTFMove(assignment)));
50     }
51
52     virtual ~ShadowRoot();
53
54     using TreeScope::rootNode;
55
56     Style::Scope& styleScope();
57
58     bool resetStyleInheritance() const { return m_resetStyleInheritance; }
59     void setResetStyleInheritance(bool);
60
61     Element* host() const { return m_host; }
62     void setHost(Element* host) { m_host = host; }
63
64     String innerHTML() const;
65     ExceptionOr<void> setInnerHTML(const String&);
66
67     Element* activeElement() const;
68
69     ShadowRootMode mode() const { return m_type; }
70
71     void removeAllEventListeners() override;
72
73     HTMLSlotElement* findAssignedSlot(const Node&);
74
75     void addSlotElementByName(const AtomicString&, HTMLSlotElement&);
76     void removeSlotElementByName(const AtomicString&, HTMLSlotElement&);
77     void slotFallbackDidChange(HTMLSlotElement&);
78
79     void didRemoveAllChildrenOfShadowHost();
80     void didChangeDefaultSlot();
81     void hostChildElementDidChange(const Element&);
82     void hostChildElementDidChangeSlotAttribute(Element&, const AtomicString& oldValue, const AtomicString& newValue);
83
84     const Vector<Node*>* assignedNodesForSlot(const HTMLSlotElement&);
85
86     void moveShadowRootToNewParentScope(TreeScope&, Document&);
87     void moveShadowRootToNewDocument(Document&);
88
89 protected:
90     ShadowRoot(Document&, ShadowRootMode);
91
92     ShadowRoot(Document&, std::unique_ptr<SlotAssignment>&&);
93
94     // FIXME: This shouldn't happen. https://bugs.webkit.org/show_bug.cgi?id=88834
95     bool isOrphan() const { return !m_host; }
96
97 private:
98     bool childTypeAllowed(NodeType) const override;
99
100     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
101
102     Node::InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
103     void removedFromAncestor(RemovalType, ContainerNode& insertionPoint) override;
104
105     bool m_resetStyleInheritance { false };
106     ShadowRootMode m_type { ShadowRootMode::UserAgent };
107
108     Element* m_host { nullptr };
109
110     std::unique_ptr<Style::Scope> m_styleScope;
111     std::unique_ptr<SlotAssignment> m_slotAssignment;
112 };
113
114 inline Element* ShadowRoot::activeElement() const
115 {
116     return treeScope().focusedElementInScope();
117 }
118
119 inline ShadowRoot* Node::shadowRoot() const
120 {
121     if (!is<Element>(*this))
122         return nullptr;
123     return downcast<Element>(*this).shadowRoot();
124 }
125
126 inline ContainerNode* Node::parentOrShadowHostNode() const
127 {
128     ASSERT(isMainThreadOrGCThread());
129     if (is<ShadowRoot>(*this))
130         return downcast<ShadowRoot>(*this).host();
131     return parentNode();
132 }
133
134 inline bool hasShadowRootParent(const Node& node)
135 {
136     return node.parentNode() && node.parentNode()->isShadowRoot();
137 }
138
139 Vector<ShadowRoot*> assignedShadowRootsIfSlotted(const Node&);
140
141 } // namespace WebCore
142
143 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ShadowRoot)
144     static bool isType(const WebCore::Node& node) { return node.isShadowRoot(); }
145 SPECIALIZE_TYPE_TRAITS_END()