Source/WebCore:
[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 #ifndef ShadowRoot_h
28 #define ShadowRoot_h
29
30 #include "ContainerNode.h"
31 #include "Document.h"
32 #include "DocumentFragment.h"
33 #include "Element.h"
34 #include "ExceptionCode.h"
35 #include "TreeScope.h"
36
37 namespace WebCore {
38
39 class ContentDistributor;
40 class HTMLSlotElement;
41 class SlotAssignment;
42
43 class ShadowRoot : public DocumentFragment, public TreeScope {
44 public:
45     enum class Type : uint8_t {
46         UserAgent = 0,
47         Closed,
48         Open,
49     };
50
51     static Ref<ShadowRoot> create(Document& document, Type type)
52     {
53         return adoptRef(*new ShadowRoot(document, type));
54     }
55
56     virtual ~ShadowRoot();
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     void setInnerHTML(const String&, ExceptionCode&);
66
67     Element* activeElement() const;
68
69     Type type() const { return m_type; }
70
71     PassRefPtr<Node> cloneNode(bool, ExceptionCode&);
72
73     virtual void removeAllEventListeners() override;
74
75     virtual ContentDistributor* distributor() { return nullptr; }
76
77 #if ENABLE(SHADOW_DOM)
78     HTMLSlotElement* findAssignedSlot(const Node&);
79
80     void addSlotElementByName(const AtomicString&, HTMLSlotElement&);
81     void removeSlotElementByName(const AtomicString&, HTMLSlotElement&);
82
83     void invalidateSlotAssignments();
84
85     const Vector<Node*>* assignedNodesForSlot(const HTMLSlotElement&);
86 #endif
87
88 protected:
89     ShadowRoot(Document&, Type);
90
91     // FIXME: This shouldn't happen. https://bugs.webkit.org/show_bug.cgi?id=88834
92     bool isOrphan() const { return !m_host; }
93
94 private:
95     virtual bool childTypeAllowed(NodeType) const override;
96
97     virtual Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
98
99     bool m_resetStyleInheritance : 1;
100     Type m_type;
101
102     Element* m_host;
103
104 #if ENABLE(SHADOW_DOM)
105     std::unique_ptr<SlotAssignment> m_slotAssignments;
106 #endif
107 };
108
109 inline Element* ShadowRoot::activeElement() const
110 {
111     return treeScope().focusedElement();
112 }
113
114 inline ShadowRoot* Node::shadowRoot() const
115 {
116     if (!is<Element>(*this))
117         return nullptr;
118     return downcast<Element>(*this).shadowRoot();
119 }
120
121 inline ContainerNode* Node::parentOrShadowHostNode() const
122 {
123     ASSERT(isMainThreadOrGCThread());
124     if (is<ShadowRoot>(*this))
125         return downcast<ShadowRoot>(*this).host();
126     return parentNode();
127 }
128
129 inline bool hasShadowRootParent(const Node& node)
130 {
131     return node.parentNode() && node.parentNode()->isShadowRoot();
132 }
133
134 } // namespace WebCore
135
136 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ShadowRoot)
137     static bool isType(const WebCore::Node& node) { return node.isShadowRoot(); }
138 SPECIALIZE_TYPE_TRAITS_END()
139
140 #endif