Remove "virtual" from all lines that have both "virtual" and "override".
[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 AuthorStyleSheets;
40 class HTMLSlotElement;
41 class SlotAssignment;
42
43 class ShadowRoot final : 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 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
57     static Ref<ShadowRoot> create(Document& document, std::unique_ptr<SlotAssignment>&& assignment)
58     {
59         return adoptRef(*new ShadowRoot(document, WTFMove(assignment)));
60     }
61 #endif
62
63     virtual ~ShadowRoot();
64
65     StyleResolver& styleResolver();
66     AuthorStyleSheets& authorStyleSheets();
67     
68     void updateStyle();
69     void resetStyleResolver();
70
71     bool resetStyleInheritance() const { return m_resetStyleInheritance; }
72     void setResetStyleInheritance(bool);
73
74     Element* host() const { return m_host; }
75     void setHost(Element* host) { m_host = host; }
76
77     String innerHTML() const;
78     void setInnerHTML(const String&, ExceptionCode&);
79
80     Element* activeElement() const;
81
82     Type type() const { return m_type; }
83
84     void removeAllEventListeners() override;
85
86 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
87     HTMLSlotElement* findAssignedSlot(const Node&);
88
89     void addSlotElementByName(const AtomicString&, HTMLSlotElement&);
90     void removeSlotElementByName(const AtomicString&, HTMLSlotElement&);
91
92     void invalidateSlotAssignments();
93     void invalidateDefaultSlotAssignments();
94
95     const Vector<Node*>* assignedNodesForSlot(const HTMLSlotElement&);
96 #endif
97
98 protected:
99     ShadowRoot(Document&, Type);
100
101 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
102     ShadowRoot(Document&, std::unique_ptr<SlotAssignment>&&);
103 #endif
104
105     // FIXME: This shouldn't happen. https://bugs.webkit.org/show_bug.cgi?id=88834
106     bool isOrphan() const { return !m_host; }
107
108 private:
109     bool childTypeAllowed(NodeType) const override;
110
111     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
112
113     bool m_resetStyleInheritance { false };
114     Type m_type { Type::UserAgent };
115
116     Element* m_host { nullptr };
117
118     std::unique_ptr<StyleResolver> m_styleResolver;
119     std::unique_ptr<AuthorStyleSheets> m_authorStyleSheets;
120
121 #if ENABLE(SHADOW_DOM) || ENABLE(DETAILS_ELEMENT)
122     std::unique_ptr<SlotAssignment> m_slotAssignment;
123 #endif
124 };
125
126 inline Element* ShadowRoot::activeElement() const
127 {
128     return treeScope().focusedElement();
129 }
130
131 inline ShadowRoot* Node::shadowRoot() const
132 {
133     if (!is<Element>(*this))
134         return nullptr;
135     return downcast<Element>(*this).shadowRoot();
136 }
137
138 inline ContainerNode* Node::parentOrShadowHostNode() const
139 {
140     ASSERT(isMainThreadOrGCThread());
141     if (is<ShadowRoot>(*this))
142         return downcast<ShadowRoot>(*this).host();
143     return parentNode();
144 }
145
146 inline bool hasShadowRootParent(const Node& node)
147 {
148     return node.parentNode() && node.parentNode()->isShadowRoot();
149 }
150
151 } // namespace WebCore
152
153 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ShadowRoot)
154     static bool isType(const WebCore::Node& node) { return node.isShadowRoot(); }
155 SPECIALIZE_TYPE_TRAITS_END()
156
157 #endif