a27d95beff2c46f73b52e8a73f6ca817e240683d
[WebKit-https.git] / WebCore / dom / ContainerNode.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2009 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef ContainerNode_h
25 #define ContainerNode_h
26
27 #include "Node.h"
28 #include "FloatPoint.h"
29
30 namespace WebCore {
31     
32 typedef void (*NodeCallback)(Node*);
33
34 namespace Private { 
35     template<class GenericNode, class GenericNodeContainer>
36     void addChildNodesToDeletionQueue(GenericNode*& head, GenericNode*& tail, GenericNodeContainer* container);
37 };
38
39 class ContainerNode : public Node {
40 public:
41     virtual ~ContainerNode();
42
43     Node* firstChild() const { return m_firstChild; }
44     Node* lastChild() const { return m_lastChild; }
45
46     virtual bool insertBefore(PassRefPtr<Node> newChild, Node* refChild, ExceptionCode&, bool shouldLazyAttach = false);
47     virtual bool replaceChild(PassRefPtr<Node> newChild, Node* oldChild, ExceptionCode&, bool shouldLazyAttach = false);
48     virtual bool removeChild(Node* child, ExceptionCode&);
49     virtual bool appendChild(PassRefPtr<Node> newChild, ExceptionCode&, bool shouldLazyAttach = false);
50
51     virtual ContainerNode* legacyParserAddChild(PassRefPtr<Node>);
52     virtual void parserAddChild(PassRefPtr<Node>);
53
54     bool hasChildNodes() const { return m_firstChild; }
55     virtual void attach();
56     virtual void detach();
57     virtual void willRemove();
58     virtual IntRect getRect() const;
59     virtual void setFocus(bool = true);
60     virtual void setActive(bool active = true, bool pause = false);
61     virtual void setHovered(bool = true);
62     unsigned childNodeCount() const;
63     Node* childNode(unsigned index) const;
64
65     virtual void insertedIntoDocument();
66     virtual void removedFromDocument();
67     virtual void insertedIntoTree(bool deep);
68     virtual void removedFromTree(bool deep);
69     virtual void childrenChanged(bool createdByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
70
71     virtual bool removeChildren();
72
73     void removeAllChildren();
74
75     void cloneChildNodes(ContainerNode* clone);
76     
77     bool dispatchBeforeLoadEvent(const String& sourceURL);
78
79     static void queuePostAttachCallback(NodeCallback, Node*);
80     static bool postAttachCallbacksAreSuspended();
81     
82 protected:
83     ContainerNode(Document*, ConstructionType = CreateContainer);
84
85     void suspendPostAttachCallbacks();
86     void resumePostAttachCallbacks();
87
88     template<class GenericNode, class GenericNodeContainer>
89     friend void appendChildToContainer(GenericNode* child, GenericNodeContainer* container);
90
91     template<class GenericNode, class GenericNodeContainer>
92     friend void Private::addChildNodesToDeletionQueue(GenericNode*& head, GenericNode*& tail, GenericNodeContainer* container);
93
94     void setFirstChild(Node* child) { m_firstChild = child; }
95     void setLastChild(Node* child) { m_lastChild = child; }
96
97 private:
98     // FIXME: This should take a PassRefPtr.
99     void addChildCommon(Node*);
100
101     static void dispatchPostAttachCallbacks();
102
103     bool getUpperLeftCorner(FloatPoint&) const;
104     bool getLowerRightCorner(FloatPoint&) const;
105
106     Node* m_firstChild;
107     Node* m_lastChild;
108 };
109
110 inline ContainerNode::ContainerNode(Document* document, ConstructionType type)
111     : Node(document, type)
112     , m_firstChild(0)
113     , m_lastChild(0)
114 {
115 }
116
117 inline unsigned Node::containerChildNodeCount() const
118 {
119     ASSERT(isContainerNode());
120     return static_cast<const ContainerNode*>(this)->childNodeCount();
121 }
122
123 inline Node* Node::containerChildNode(unsigned index) const
124 {
125     ASSERT(isContainerNode());
126     return static_cast<const ContainerNode*>(this)->childNode(index);
127 }
128
129 inline Node* Node::containerFirstChild() const
130 {
131     ASSERT(isContainerNode());
132     return static_cast<const ContainerNode*>(this)->firstChild();
133 }
134
135 inline Node* Node::containerLastChild() const
136 {
137     ASSERT(isContainerNode());
138     return static_cast<const ContainerNode*>(this)->lastChild();
139 }
140
141 } // namespace WebCore
142
143 #endif // ContainerNode_h