Stop abusing RenderTableSection::needsRecalcCells logic
[WebKit-https.git] / Source / WebCore / rendering / RenderTableSection.h
1 /*
2  * Copyright (C) 1997 Martin Jones (mjones@kde.org)
3  *           (C) 1997 Torben Weis (weis@kde.org)
4  *           (C) 1998 Waldo Bastian (bastian@kde.org)
5  *           (C) 1999 Lars Knoll (knoll@kde.org)
6  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
7  * Copyright (C) 2003, 2004, 2005, 2006, 2009 Apple Inc. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #ifndef RenderTableSection_h
26 #define RenderTableSection_h
27
28 #include "RenderTable.h"
29 #include <wtf/Vector.h>
30
31 namespace WebCore {
32
33 class RenderTableCell;
34 class RenderTableRow;
35
36 class RenderTableSection : public RenderBox {
37 public:
38     RenderTableSection(Node*);
39     virtual ~RenderTableSection();
40
41     const RenderObjectChildList* children() const { return &m_children; }
42     RenderObjectChildList* children() { return &m_children; }
43
44     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0);
45
46     virtual LayoutUnit firstLineBoxBaseline() const;
47
48     void addCell(RenderTableCell*, RenderTableRow* row);
49
50     void setCellLogicalWidths();
51     LayoutUnit calcRowLogicalHeight();
52     LayoutUnit layoutRows(LayoutUnit logicalHeight);
53
54     RenderTable* table() const { return toRenderTable(parent()); }
55
56     struct CellStruct {
57         Vector<RenderTableCell*, 1> cells; 
58         bool inColSpan; // true for columns after the first in a colspan
59
60         CellStruct():
61           inColSpan(false) {}
62         
63         RenderTableCell* primaryCell()
64         {
65             return hasCells() ? cells[cells.size() - 1] : 0;
66         }
67
68         const RenderTableCell* primaryCell() const
69         {
70             return hasCells() ? cells[cells.size() - 1] : 0;
71         }
72
73         bool hasCells() const { return cells.size() > 0; }
74     };
75
76     typedef Vector<CellStruct> Row;
77
78     struct RowStruct {
79         Row row;
80         RenderTableRow* rowRenderer;
81         LayoutUnit baseline;
82         Length logicalHeight;
83     };
84
85     CellStruct& cellAt(int row,  int col) { return m_grid[row].row[col]; }
86     const CellStruct& cellAt(int row, int col) const { return m_grid[row].row[col]; }
87     RenderTableCell* primaryCellAt(int row, int col)
88     {
89         CellStruct& c = m_grid[row].row[col];
90         return c.primaryCell();
91     }
92
93     void appendColumn(int pos);
94     void splitColumn(unsigned pos, int first);
95
96     LayoutUnit calcOuterBorderBefore() const;
97     LayoutUnit calcOuterBorderAfter() const;
98     LayoutUnit calcOuterBorderStart() const;
99     LayoutUnit calcOuterBorderEnd() const;
100     void recalcOuterBorder();
101
102     LayoutUnit outerBorderBefore() const { return m_outerBorderBefore; }
103     LayoutUnit outerBorderAfter() const { return m_outerBorderAfter; }
104     LayoutUnit outerBorderStart() const { return m_outerBorderStart; }
105     LayoutUnit outerBorderEnd() const { return m_outerBorderEnd; }
106
107     unsigned numRows() const { return m_grid.size(); }
108     unsigned numColumns() const;
109     void recalcCells();
110     void recalcCellsIfNeeded()
111     {
112         if (m_needsCellRecalc)
113             recalcCells();
114     }
115
116     bool needsCellRecalc() const { return m_needsCellRecalc; }
117     void setNeedsCellRecalc();
118
119     LayoutUnit getBaseline(int row) { return m_grid[row].baseline; }
120
121     void rowLogicalHeightChanged(unsigned rowIndex);
122
123     unsigned rowIndexForRenderer(const RenderTableRow*) const;
124
125 protected:
126     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
127
128 private:
129     virtual RenderObjectChildList* virtualChildren() { return children(); }
130     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
131
132     virtual const char* renderName() const { return isAnonymous() ? "RenderTableSection (anonymous)" : "RenderTableSection"; }
133
134     virtual bool isTableSection() const { return true; }
135
136     virtual void willBeDestroyed();
137
138     virtual void layout();
139
140     virtual void removeChild(RenderObject* oldChild);
141
142     virtual void paint(PaintInfo&, const LayoutPoint&);
143     virtual void paintCell(RenderTableCell*, PaintInfo&, const LayoutPoint&);
144     virtual void paintObject(PaintInfo&, const LayoutPoint&);
145
146     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0);
147
148     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
149
150     bool ensureRows(unsigned);
151     void fillRowsWithDefaultStartingAtPosition(unsigned);
152
153     bool hasOverflowingCell() const { return m_overflowingCells.size() || m_forceSlowPaintPathWithOverflowingCell; }
154
155     RenderObjectChildList m_children;
156
157     Vector<RowStruct> m_grid;
158     Vector<LayoutUnit> m_rowPos;
159
160     // the current insertion position
161     unsigned m_cCol;
162     unsigned m_cRow;
163
164     LayoutUnit m_outerBorderStart;
165     LayoutUnit m_outerBorderEnd;
166     LayoutUnit m_outerBorderBefore;
167     LayoutUnit m_outerBorderAfter;
168
169     bool m_needsCellRecalc;
170
171     // This HashSet holds the overflowing cells for faster painting.
172     // If we have more than gMaxAllowedOverflowingCellRatio * total cells, it will be empty
173     // and m_forceSlowPaintPathWithOverflowingCell will be set to save memory.
174     HashSet<RenderTableCell*> m_overflowingCells;
175     bool m_forceSlowPaintPathWithOverflowingCell;
176
177     bool m_hasMultipleCellLevels;
178 };
179
180 inline RenderTableSection* toRenderTableSection(RenderObject* object)
181 {
182     ASSERT(!object || object->isTableSection());
183     return static_cast<RenderTableSection*>(object);
184 }
185
186 inline const RenderTableSection* toRenderTableSection(const RenderObject* object)
187 {
188     ASSERT(!object || object->isTableSection());
189     return static_cast<const RenderTableSection*>(object);
190 }
191
192 // This will catch anyone doing an unnecessary cast.
193 void toRenderTableSection(const RenderTableSection*);
194
195 } // namespace WebCore
196
197 #endif // RenderTableSection_h