f299aa9ffa4a171b539ebbdbca73e856b873c04e
[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 MatchType {
45         AlwaysMatches,
46         NeverMatches,
47     };
48
49     virtual ~InsertionPoint();
50
51     bool hasDistribution() const { return m_hasDistribution; }
52     void setHasDistribution() { m_hasDistribution = true; }
53     void clearDistribution() { m_hasDistribution = false; }
54     bool isActive() const;
55
56     virtual MatchType matchTypeFor(Node*) const { return AlwaysMatches; }
57
58     virtual void willAttachRenderers() OVERRIDE;
59     virtual void willDetachRenderers() OVERRIDE;
60
61     bool shouldUseFallbackElements() const;
62
63     Node* firstDistributed() const;
64     Node* lastDistributed() const;
65     Node* nextDistributedTo(const Node*) const;
66     Node* previousDistributedTo(const Node*) const;
67
68 protected:
69     InsertionPoint(const QualifiedName&, Document&);
70     virtual bool rendererIsNeeded(const RenderStyle&) OVERRIDE;
71     virtual void childrenChanged(const ChildChange&) OVERRIDE;
72     virtual InsertionNotificationRequest insertedInto(ContainerNode&) OVERRIDE;
73     virtual void removedFrom(ContainerNode&) OVERRIDE;
74     virtual bool isInsertionPointNode() const OVERRIDE { return true; }
75
76 private:
77
78     bool m_hasDistribution;
79 };
80
81 inline InsertionPoint* toInsertionPoint(Node* node)
82 {
83     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isInsertionPoint());
84     return static_cast<InsertionPoint*>(node);
85 }
86
87 inline const InsertionPoint* toInsertionPoint(const Node* node)
88 {
89     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isInsertionPoint());
90     return static_cast<const InsertionPoint*>(node);
91 }
92
93 inline bool isActiveInsertionPoint(const Node* node)
94 {
95     return node && node->isInsertionPoint() && toInsertionPoint(node)->isActive();
96 }
97
98 inline Node* parentNodeForDistribution(const Node* node)
99 {
100     ASSERT(node);
101
102     if (Node* parent = node->parentNode()) {
103         if (parent->isInsertionPoint() && toInsertionPoint(parent)->shouldUseFallbackElements())
104             return parent->parentNode();
105         return parent;
106     }
107
108     return 0;
109 }
110
111 inline Element* parentElementForDistribution(const Node* node)
112 {
113     if (Node* parent = parentNodeForDistribution(node)) {
114         if (parent->isElementNode())
115             return toElement(parent);
116     }
117
118     return 0;
119 }
120
121 inline ShadowRoot* shadowRootOfParentForDistribution(const Node* node)
122 {
123     ASSERT(node);
124     if (Element* parent = parentElementForDistribution(node))
125         return parent->shadowRoot();
126
127     return 0;
128 }
129
130 InsertionPoint* findInsertionPointOf(const Node*);
131
132 inline bool hasShadowRootOrActiveInsertionPointParent(const Node& node)
133 {
134     return hasShadowRootParent(node)
135         || isActiveInsertionPoint(findInsertionPointOf(&node))
136         || isActiveInsertionPoint(node.parentNode());
137 }
138
139 } // namespace WebCore
140
141 #endif // InsertionPoint_h