e34ec010a4979d2b30c491d1da691b4be4398dee
[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 public:
41     static Ref<ShadowRoot> create(Document& document, ShadowRootMode type)
42     {
43         return adoptRef(*new ShadowRoot(document, type));
44     }
45
46     static Ref<ShadowRoot> create(Document& document, std::unique_ptr<SlotAssignment>&& assignment)
47     {
48         return adoptRef(*new ShadowRoot(document, WTFMove(assignment)));
49     }
50
51     virtual ~ShadowRoot();
52
53     using TreeScope::rootNode;
54
55     Style::Scope& styleScope();
56
57     bool resetStyleInheritance() const { return m_resetStyleInheritance; }
58     void setResetStyleInheritance(bool);
59
60     Element* host() const { return m_host; }
61     void setHost(Element* host) { m_host = host; }
62
63     String innerHTML() const;
64     ExceptionOr<void> setInnerHTML(const String&);
65
66     Element* activeElement() const;
67
68     ShadowRootMode mode() const { return m_type; }
69
70     void removeAllEventListeners() override;
71
72     HTMLSlotElement* findAssignedSlot(const Node&);
73
74     void addSlotElementByName(const AtomicString&, HTMLSlotElement&);
75     void removeSlotElementByName(const AtomicString&, HTMLSlotElement&);
76
77     void didRemoveAllChildrenOfShadowHost();
78     void didChangeDefaultSlot();
79     void hostChildElementDidChange(const Element&);
80     void hostChildElementDidChangeSlotAttribute(const AtomicString& oldValue, const AtomicString& newValue);
81
82     const Vector<Node*>* assignedNodesForSlot(const HTMLSlotElement&);
83
84 protected:
85     ShadowRoot(Document&, ShadowRootMode);
86
87     ShadowRoot(Document&, std::unique_ptr<SlotAssignment>&&);
88
89     // FIXME: This shouldn't happen. https://bugs.webkit.org/show_bug.cgi?id=88834
90     bool isOrphan() const { return !m_host; }
91
92 private:
93     bool childTypeAllowed(NodeType) const override;
94
95     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
96
97     Node::InsertionNotificationRequest insertedInto(ContainerNode& insertionPoint) override;
98     void removedFrom(ContainerNode& insertionPoint) override;
99     void didMoveToNewDocument(Document& oldDocument) override;
100
101     bool m_resetStyleInheritance { false };
102     ShadowRootMode m_type { ShadowRootMode::UserAgent };
103
104     Element* m_host { nullptr };
105
106     std::unique_ptr<Style::Scope> m_styleScope;
107
108     std::unique_ptr<SlotAssignment> m_slotAssignment;
109 };
110
111 inline Element* ShadowRoot::activeElement() const
112 {
113     return treeScope().focusedElementInScope();
114 }
115
116 inline ShadowRoot* Node::shadowRoot() const
117 {
118     if (!is<Element>(*this))
119         return nullptr;
120     return downcast<Element>(*this).shadowRoot();
121 }
122
123 inline ContainerNode* Node::parentOrShadowHostNode() const
124 {
125     ASSERT(isMainThreadOrGCThread());
126     if (is<ShadowRoot>(*this))
127         return downcast<ShadowRoot>(*this).host();
128     return parentNode();
129 }
130
131 inline bool hasShadowRootParent(const Node& node)
132 {
133     return node.parentNode() && node.parentNode()->isShadowRoot();
134 }
135
136 Vector<ShadowRoot*> assignedShadowRootsIfSlotted(const Node&);
137
138 } // namespace WebCore
139
140 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ShadowRoot)
141     static bool isType(const WebCore::Node& node) { return node.isShadowRoot(); }
142 SPECIALIZE_TYPE_TRAITS_END()