58b48c64b5b8953a9a2a29ad8fbb4ee3c4104c2b
[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 "Document.h"
31 #include "DocumentFragment.h"
32 #include "Element.h"
33 #include "ExceptionCode.h"
34 #include "TreeScope.h"
35 #include <wtf/DoublyLinkedList.h>
36
37 namespace WebCore {
38
39 class Document;
40 class HTMLContentElement;
41 class HTMLContentSelector;
42 class InsertionPoint;
43 class ShadowTree;
44
45 class ShadowRoot : public DocumentFragment, public TreeScope, public DoublyLinkedListNode<ShadowRoot> {
46     friend class WTF::DoublyLinkedListNode<ShadowRoot>;
47 public:
48     static PassRefPtr<ShadowRoot> create(Element*, ExceptionCode&);
49
50     // FIXME: We will support multiple shadow subtrees, however current implementation does not work well
51     // if a shadow root is dynamically created. So we prohibit multiple shadow subtrees
52     // in several elements for a while.
53     // See https://bugs.webkit.org/show_bug.cgi?id=77503 and related bugs.
54     enum ShadowRootCreationPurpose {
55         CreatingUserAgentShadowRoot,
56         CreatingAuthorShadowRoot,
57     };
58     static PassRefPtr<ShadowRoot> create(Element*, ShadowRootCreationPurpose, ExceptionCode& = ASSERT_NO_EXCEPTION);
59
60     void recalcShadowTreeStyle(StyleChange);
61
62     void setNeedsReattachHostChildrenAndShadow();
63     void clearNeedsReattachHostChildrenAndShadow();
64     bool needsReattachHostChildrenAndShadow();
65
66     InsertionPoint* insertionPointFor(Node*) const;
67     void hostChildrenChanged();
68
69     virtual bool applyAuthorSheets() const;
70     void setApplyAuthorSheets(bool);
71
72     Element* host() const { return shadowHost(); }
73     ShadowTree* tree() const;
74
75     String innerHTML() const;
76     void setInnerHTML(const String&, ExceptionCode&);
77
78     Element* activeElement() const;
79
80     ShadowRoot* youngerShadowRoot() const { return prev(); }
81     ShadowRoot* olderShadowRoot() const { return next(); }
82
83     bool isYoungest() const { return !youngerShadowRoot(); }
84     bool isOldest() const { return !olderShadowRoot(); }
85
86     bool hasInsertionPoint() const;
87
88     virtual void attach();
89
90     bool isUsedForRendering() const;
91     InsertionPoint* assignedTo() const;
92     void setAssignedTo(InsertionPoint*);
93
94 private:
95     ShadowRoot(Document*);
96     virtual ~ShadowRoot();
97
98     virtual String nodeName() const;
99     virtual PassRefPtr<Node> cloneNode(bool deep);
100     virtual bool childTypeAllowed(NodeType) const;
101
102     ShadowRoot* m_prev;
103     ShadowRoot* m_next;
104     bool m_applyAuthorSheets : 1;
105     InsertionPoint* m_insertionPointAssignedTo;
106 };
107
108 inline InsertionPoint* ShadowRoot::assignedTo() const
109 {
110     return m_insertionPointAssignedTo;
111 }
112
113 inline void ShadowRoot::setAssignedTo(InsertionPoint* insertionPoint)
114 {
115     ASSERT(!m_insertionPointAssignedTo || !insertionPoint);
116     m_insertionPointAssignedTo = insertionPoint;
117 }
118
119 inline bool ShadowRoot::isUsedForRendering() const
120 {
121     return isYoungest() || assignedTo();
122 }
123
124 inline Element* ShadowRoot::activeElement() const
125 {
126     if (Node* node = treeScope()->focusedNode())
127         return node->isElementNode() ? toElement(node) : 0;
128     return 0;
129 }
130
131 inline const ShadowRoot* toShadowRoot(const Node* node)
132 {
133     ASSERT(!node || node->isShadowRoot());
134     return static_cast<const ShadowRoot*>(node);
135 }
136
137 inline ShadowRoot* toShadowRoot(Node* node)
138 {
139     return const_cast<ShadowRoot*>(toShadowRoot(static_cast<const Node*>(node)));
140 }
141
142 inline ShadowRoot* toShadowRoot(TreeScope* scope)
143 {
144     ASSERT(!scope || scope->isShadowRoot());
145     return static_cast<ShadowRoot*>(scope);
146 }
147
148 // Put this TreeScope method here to inline it.
149 inline bool TreeScope::isShadowRoot() const
150 {
151     return m_rootNode->isShadowRoot();
152 }
153
154 } // namespace
155
156 #endif