2009-11-13 Carol Szabo <carol.szabo@nokia.com>
[WebKit-https.git] / WebCore / rendering / CounterNode.h
1 /*
2  * Copyright (C) 2005 Allan Sandfeld Jensen (kde@carewolf.com)
3  * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20 */
21
22 #ifndef CounterNode_h
23 #define CounterNode_h
24
25 #include <wtf/Noncopyable.h>
26
27 // This implements a counter tree that is used for finding parents in counters() lookup,
28 // and for propagating count changes when nodes are added or removed.
29
30 // Parents represent unique counters and their scope, which are created either explicitly
31 // by "counter-reset" style rules or implicitly by referring to a counter that is not in scope.
32 // Such nodes are tagged as "reset" nodes, although they are not all due to "counter-reset".
33
34 // Not that render tree children are often counter tree siblings due to counter scoping rules.
35
36 namespace WebCore {
37
38 class AtomicString;
39 class RenderObject;
40
41 class CounterNode : public Noncopyable {
42 public:
43     CounterNode(RenderObject*, bool isReset, int value);
44
45     bool isReset() const { return m_isReset; }
46     int value() const { return m_value; }
47     int countInParent() const { return m_countInParent; }
48     RenderObject* renderer() const { return m_renderer; }
49
50     CounterNode* parent() const { return m_parent; }
51     CounterNode* previousSibling() const { return m_previousSibling; }
52     CounterNode* nextSibling() const { return m_nextSibling; }
53     CounterNode* firstChild() const { return m_firstChild; }
54     CounterNode* lastChild() const { return m_lastChild; }
55     CounterNode* lastDescendant() const;
56     CounterNode* previousInPreOrder() const;
57     CounterNode* nextInPreOrder(const CounterNode* stayWithin = 0) const;
58     CounterNode* nextInPreOrderAfterChildren(const CounterNode* stayWithin = 0) const;
59
60     void insertAfter(CounterNode* newChild, CounterNode* beforeChild, const AtomicString& identifier);
61     void removeChild(CounterNode*, const AtomicString& identifier);
62
63 private:
64     int computeCountInParent() const;
65     void recount(const AtomicString& identifier);
66     void resetRenderer(const AtomicString& identifier) const;
67     void resetRenderers(const AtomicString& identifier) const;
68
69     bool m_isReset;
70     int m_value;
71     int m_countInParent;
72     RenderObject* m_renderer;
73
74     CounterNode* m_parent;
75     CounterNode* m_previousSibling;
76     CounterNode* m_nextSibling;
77     CounterNode* m_firstChild;
78     CounterNode* m_lastChild;
79 };
80
81 } // namespace WebCore
82
83 #ifndef NDEBUG
84 // Outside the WebCore namespace for ease of invocation from gdb.
85 void showTree(const WebCore::CounterNode*);
86 #endif
87
88 #endif // CounterNode_h