[CSS Shadow Parts] Support 'exportparts' attribute
[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 #pragma once
28
29 #include "Document.h"
30 #include "DocumentFragment.h"
31 #include "Element.h"
32 #include "ShadowRootMode.h"
33 #include <wtf/HashMap.h>
34
35 namespace WebCore {
36
37 class HTMLSlotElement;
38 class SlotAssignment;
39 class StyleSheetList;
40
41 class ShadowRoot final : public DocumentFragment, public TreeScope {
42     WTF_MAKE_ISO_ALLOCATED(ShadowRoot);
43 public:
44     static Ref<ShadowRoot> create(Document& document, ShadowRootMode type)
45     {
46         return adoptRef(*new ShadowRoot(document, type));
47     }
48
49     static Ref<ShadowRoot> create(Document& document, std::unique_ptr<SlotAssignment>&& assignment)
50     {
51         return adoptRef(*new ShadowRoot(document, WTFMove(assignment)));
52     }
53
54     virtual ~ShadowRoot();
55
56     using TreeScope::rootNode;
57
58     Style::Scope& styleScope();
59     StyleSheetList& styleSheets();
60
61     bool resetStyleInheritance() const { return m_resetStyleInheritance; }
62     void setResetStyleInheritance(bool);
63
64     Element* host() const { return m_host; }
65     void setHost(Element* host) { m_host = host; }
66
67     String innerHTML() const;
68     ExceptionOr<void> setInnerHTML(const String&);
69
70     Element* activeElement() const;
71
72     ShadowRootMode mode() const { return m_type; }
73     bool shouldFireSlotchangeEvent() const { return m_type != ShadowRootMode::UserAgent && !m_hasBegunDeletingDetachedChildren; }
74
75     void removeAllEventListeners() override;
76
77     HTMLSlotElement* findAssignedSlot(const Node&);
78
79     void renameSlotElement(HTMLSlotElement&, const AtomString& oldName, const AtomString& newName);
80     void addSlotElementByName(const AtomString&, HTMLSlotElement&);
81     void removeSlotElementByName(const AtomString&, HTMLSlotElement&, ContainerNode& oldParentOfRemovedTree);
82     void slotFallbackDidChange(HTMLSlotElement&);
83     void resolveSlotsBeforeNodeInsertionOrRemoval();
84     void willRemoveAllChildren(ContainerNode&);
85
86     void didRemoveAllChildrenOfShadowHost();
87     void didChangeDefaultSlot();
88     void hostChildElementDidChange(const Element&);
89     void hostChildElementDidChangeSlotAttribute(Element&, const AtomString& oldValue, const AtomString& newValue);
90
91     const Vector<Node*>* assignedNodesForSlot(const HTMLSlotElement&);
92
93     void moveShadowRootToNewParentScope(TreeScope&, Document&);
94     void moveShadowRootToNewDocument(Document&);
95
96     const HashMap<AtomString, AtomString>& partMappings() const;
97     void invalidatePartMappings();
98
99 protected:
100     ShadowRoot(Document&, ShadowRootMode);
101
102     ShadowRoot(Document&, std::unique_ptr<SlotAssignment>&&);
103
104 private:
105     bool childTypeAllowed(NodeType) const override;
106
107     Ref<Node> cloneNodeInternal(Document&, CloningOperation) override;
108
109     Node::InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
110     void removedFromAncestor(RemovalType, ContainerNode& insertionPoint) override;
111
112     void childrenChanged(const ChildChange&) override;
113
114     bool m_resetStyleInheritance { false };
115     bool m_hasBegunDeletingDetachedChildren { false };
116     ShadowRootMode m_type { ShadowRootMode::UserAgent };
117
118     Element* m_host { nullptr };
119     RefPtr<StyleSheetList> m_styleSheetList;
120
121     std::unique_ptr<Style::Scope> m_styleScope;
122     std::unique_ptr<SlotAssignment> m_slotAssignment;
123     mutable Optional<HashMap<AtomString, AtomString>> m_partMappings;
124 };
125
126 inline Element* ShadowRoot::activeElement() const
127 {
128     return treeScope().focusedElementInScope();
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 Vector<ShadowRoot*> assignedShadowRootsIfSlotted(const Node&);
152
153 } // namespace WebCore
154
155 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ShadowRoot)
156     static bool isType(const WebCore::Node& node) { return node.isShadowRoot(); }
157 SPECIALIZE_TYPE_TRAITS_END()