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