Clean up ContainerNode::childrenChanged
[WebKit-https.git] / Source / WebCore / html / shadow / InsertionPoint.h
1 /*
2  * Copyright (C) 2012 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  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef InsertionPoint_h
32 #define InsertionPoint_h
33
34 #include "ContentDistributor.h"
35 #include "HTMLElement.h"
36 #include "HTMLNames.h"
37 #include "ShadowRoot.h"
38 #include <wtf/Forward.h>
39
40 namespace WebCore {
41
42 class InsertionPoint : public HTMLElement {
43 public:
44     enum Type {
45         InternalType,
46         HTMLContentElementType
47     };
48
49     enum MatchType {
50         AlwaysMatches,
51         NeverMatches,
52     };
53
54     virtual ~InsertionPoint();
55
56     bool hasDistribution() const { return m_hasDistribution; }
57     void setHasDistribution() { m_hasDistribution = true; }
58     void clearDistribution() { m_hasDistribution = false; }
59     bool isActive() const;
60
61     virtual MatchType matchTypeFor(Node*) const { return AlwaysMatches; }
62     virtual Type insertionPointType() const { return InternalType; }
63
64     virtual void willAttachRenderers() OVERRIDE;
65     virtual void willDetachRenderers() OVERRIDE;
66
67     bool shouldUseFallbackElements() const;
68
69     Node* firstDistributed() const;
70     Node* lastDistributed() const;
71     Node* nextDistributedTo(const Node*) const;
72     Node* previousDistributedTo(const Node*) const;
73
74 protected:
75     InsertionPoint(const QualifiedName&, Document*);
76     virtual bool rendererIsNeeded(const RenderStyle&) OVERRIDE;
77     virtual void childrenChanged(const ChildChange&) OVERRIDE;
78     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
79     virtual void removedFrom(ContainerNode*) OVERRIDE;
80     virtual bool isInsertionPointNode() const OVERRIDE { return true; }
81
82 private:
83
84     bool m_hasDistribution;
85 };
86
87 inline InsertionPoint* toInsertionPoint(Node* node)
88 {
89     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isInsertionPoint());
90     return static_cast<InsertionPoint*>(node);
91 }
92
93 inline const InsertionPoint* toInsertionPoint(const Node* node)
94 {
95     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isInsertionPoint());
96     return static_cast<const InsertionPoint*>(node);
97 }
98
99 inline bool isActiveInsertionPoint(const Node* node)
100 {
101     return node && node->isInsertionPoint() && toInsertionPoint(node)->isActive();
102 }
103
104 inline Node* parentNodeForDistribution(const Node* node)
105 {
106     ASSERT(node);
107
108     if (Node* parent = node->parentNode()) {
109         if (parent->isInsertionPoint() && toInsertionPoint(parent)->shouldUseFallbackElements())
110             return parent->parentNode();
111         return parent;
112     }
113
114     return 0;
115 }
116
117 inline Element* parentElementForDistribution(const Node* node)
118 {
119     if (Node* parent = parentNodeForDistribution(node)) {
120         if (parent->isElementNode())
121             return toElement(parent);
122     }
123
124     return 0;
125 }
126
127 inline ShadowRoot* shadowRootOfParentForDistribution(const Node* node)
128 {
129     ASSERT(node);
130     if (Element* parent = parentElementForDistribution(node))
131         return parent->shadowRoot();
132
133     return 0;
134 }
135
136 InsertionPoint* findInsertionPointOf(const Node*);
137
138 inline bool hasShadowRootOrActiveInsertionPointParent(const Node* node)
139 {
140     return hasShadowRootParent(node)
141         || isActiveInsertionPoint(findInsertionPointOf(node))
142         || isActiveInsertionPoint(node->parentNode());
143 }
144
145 } // namespace WebCore
146
147 #endif // InsertionPoint_h