bd446b859d404e29b179a5e5619ece7e9929c839
[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     virtual ~InsertionPoint();
45
46     bool hasDistribution() const { return !m_distribution.isEmpty(); }
47     void setDistribution(ContentDistribution& distribution) { m_distribution.swap(distribution); }
48     void clearDistribution() { m_distribution.clear(); }
49     bool isShadowBoundary() const;
50     bool isActive() const;
51
52     PassRefPtr<NodeList> distributedNodes() const;
53
54     virtual const AtomicString& select() const = 0;
55     virtual bool isSelectValid() const = 0;
56     virtual bool doesSelectFromHostChildren() const = 0;
57
58     virtual void attach();
59     virtual void detach();
60     virtual bool isInsertionPoint() const OVERRIDE { return true; }
61
62     size_t indexOf(Node* node) const { return m_distribution.find(node); }
63     bool contains(const Node* node) const { return m_distribution.contains(const_cast<Node*>(node)) || (node->isShadowRoot() && toShadowRoot(node)->assignedTo() == this); }
64     size_t size() const { return m_distribution.size(); }
65     Node* at(size_t index)  const { return m_distribution.at(index).get(); }
66     Node* first() const { return m_distribution.isEmpty() ? 0 : m_distribution.first().get(); }
67     Node* last() const { return m_distribution.isEmpty() ? 0 : m_distribution.last().get(); }
68     Node* nextTo(const Node*) const;
69     Node* previousTo(const Node*) const;
70
71 protected:
72     InsertionPoint(const QualifiedName&, Document*);
73     virtual bool rendererIsNeeded(const NodeRenderingContext&) OVERRIDE;
74     virtual void childrenChanged(bool changedByParser, Node* beforeChange, Node* afterChange, int childCountDelta) OVERRIDE;
75     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
76     virtual void removedFrom(ContainerNode*) OVERRIDE;
77
78 private:
79     ContentDistribution m_distribution;
80 };
81
82 inline bool isInsertionPoint(const Node* node)
83 {
84     if (!node)
85         return false;
86
87     if (node->isHTMLElement() && toHTMLElement(node)->isInsertionPoint())
88         return true;
89
90     return false;
91 }
92
93 inline InsertionPoint* toInsertionPoint(Node* node)
94 {
95     ASSERT(isInsertionPoint(node));
96     return static_cast<InsertionPoint*>(node);
97 }
98
99 inline const InsertionPoint* toInsertionPoint(const Node* node)
100 {
101     ASSERT(isInsertionPoint(node));
102     return static_cast<const InsertionPoint*>(node);
103 }
104
105 inline bool isActiveInsertionPoint(const Node* node)
106 {
107     return isInsertionPoint(node) && toInsertionPoint(node)->isActive();
108 }
109
110 inline bool isLowerEncapsulationBoundary(Node* node)
111 {
112     if (!isInsertionPoint(node))
113         return false;
114     return toInsertionPoint(node)->isShadowBoundary();
115 }
116
117 } // namespace WebCore
118
119 #endif // InsertionPoint_h