ContentDistribution should be only used for details elements
[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
41 class ShadowRoot : public DocumentFragment, public TreeScope {
42 public:
43     enum ShadowRootType {
44         UserAgentShadowRoot = 0,
45     };
46
47     static Ref<ShadowRoot> create(Document& document, ShadowRootType type)
48     {
49         return adoptRef(*new ShadowRoot(document, type));
50     }
51
52     virtual ~ShadowRoot();
53
54     bool resetStyleInheritance() const { return m_resetStyleInheritance; }
55     void setResetStyleInheritance(bool);
56
57     Element* host() const { return m_host; }
58     void setHost(Element* host) { m_host = host; }
59
60     String innerHTML() const;
61     void setInnerHTML(const String&, ExceptionCode&);
62
63     Element* activeElement() const;
64
65     ShadowRootType type() const { return static_cast<ShadowRootType>(m_type); }
66
67     PassRefPtr<Node> cloneNode(bool, ExceptionCode&);
68
69     virtual void removeAllEventListeners() override;
70
71     virtual ContentDistributor* distributor() { return nullptr; }
72
73 protected:
74     ShadowRoot(Document&, ShadowRootType);
75
76     // FIXME: This shouldn't happen. https://bugs.webkit.org/show_bug.cgi?id=88834
77     bool isOrphan() const { return !m_host; }
78
79 private:
80     virtual bool childTypeAllowed(NodeType) const override;
81
82     virtual Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
83
84     unsigned m_resetStyleInheritance : 1;
85     unsigned m_type : 1;
86
87     Element* m_host;
88 };
89
90 inline Element* ShadowRoot::activeElement() const
91 {
92     return treeScope().focusedElement();
93 }
94
95 inline ShadowRoot* Node::shadowRoot() const
96 {
97     if (!is<Element>(*this))
98         return nullptr;
99     return downcast<Element>(*this).shadowRoot();
100 }
101
102 inline ContainerNode* Node::parentOrShadowHostNode() const
103 {
104     ASSERT(isMainThreadOrGCThread());
105     if (is<ShadowRoot>(*this))
106         return downcast<ShadowRoot>(*this).host();
107     return parentNode();
108 }
109
110 inline bool hasShadowRootParent(const Node& node)
111 {
112     return node.parentNode() && node.parentNode()->isShadowRoot();
113 }
114
115 } // namespace WebCore
116
117 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ShadowRoot)
118     static bool isType(const WebCore::Node& node) { return node.isShadowRoot(); }
119 SPECIALIZE_TYPE_TRAITS_END()
120
121 #endif