Remove RenderObjectChildList
[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 enum CollapsedBorderSide {
34     CBSBefore,
35     CBSAfter,
36     CBSStart,
37     CBSEnd
38 };
39
40 // Helper class for paintObject.
41 class CellSpan {
42 public:
43     CellSpan(unsigned start, unsigned end)
44         : m_start(start)
45         , m_end(end)
46     {
47     }
48
49     unsigned start() const { return m_start; }
50     unsigned end() const { return m_end; }
51
52     unsigned& start() { return m_start; }
53     unsigned& end() { return m_end; }
54
55 private:
56     unsigned m_start;
57     unsigned m_end;
58 };
59
60 class RenderTableCell;
61 class RenderTableRow;
62
63 class RenderTableSection FINAL : public RenderBox {
64 public:
65     explicit RenderTableSection(Element*);
66     virtual ~RenderTableSection();
67
68     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0) OVERRIDE;
69
70     virtual int firstLineBoxBaseline() const OVERRIDE;
71
72     void addCell(RenderTableCell*, RenderTableRow* row);
73
74     int calcRowLogicalHeight();
75     void layoutRows();
76     void computeOverflowFromCells();
77
78     RenderTable* table() const { return toRenderTable(parent()); }
79
80     struct CellStruct {
81         Vector<RenderTableCell*, 1> cells; 
82         bool inColSpan; // true for columns after the first in a colspan
83
84         CellStruct()
85             : inColSpan(false)
86         {
87         }
88
89         RenderTableCell* primaryCell()
90         {
91             return hasCells() ? cells[cells.size() - 1] : 0;
92         }
93
94         const RenderTableCell* primaryCell() const
95         {
96             return hasCells() ? cells[cells.size() - 1] : 0;
97         }
98
99         bool hasCells() const { return cells.size() > 0; }
100     };
101
102     typedef Vector<CellStruct> Row;
103
104     struct RowStruct {
105         RowStruct()
106             : rowRenderer(0)
107             , baseline()
108         {
109         }
110
111         Row row;
112         RenderTableRow* rowRenderer;
113         LayoutUnit baseline;
114         Length logicalHeight;
115     };
116
117     const BorderValue& borderAdjoiningTableStart() const
118     {
119         if (hasSameDirectionAs(table()))
120             return style()->borderStart();
121
122         return style()->borderEnd();
123     }
124
125     const BorderValue& borderAdjoiningTableEnd() const
126     {
127         if (hasSameDirectionAs(table()))
128             return style()->borderEnd();
129
130         return style()->borderStart();
131     }
132
133     const BorderValue& borderAdjoiningStartCell(const RenderTableCell*) const;
134     const BorderValue& borderAdjoiningEndCell(const RenderTableCell*) const;
135
136     const RenderTableCell* firstRowCellAdjoiningTableStart() const;
137     const RenderTableCell* firstRowCellAdjoiningTableEnd() const;
138
139     CellStruct& cellAt(unsigned row,  unsigned col) { return m_grid[row].row[col]; }
140     const CellStruct& cellAt(unsigned row, unsigned col) const { return m_grid[row].row[col]; }
141     RenderTableCell* primaryCellAt(unsigned row, unsigned col)
142     {
143         CellStruct& c = m_grid[row].row[col];
144         return c.primaryCell();
145     }
146
147     RenderTableRow* rowRendererAt(unsigned row) const { return m_grid[row].rowRenderer; }
148
149     void appendColumn(unsigned pos);
150     void splitColumn(unsigned pos, unsigned first);
151
152     int calcOuterBorderBefore() const;
153     int calcOuterBorderAfter() const;
154     int calcOuterBorderStart() const;
155     int calcOuterBorderEnd() const;
156     void recalcOuterBorder();
157
158     int outerBorderBefore() const { return m_outerBorderBefore; }
159     int outerBorderAfter() const { return m_outerBorderAfter; }
160     int outerBorderStart() const { return m_outerBorderStart; }
161     int outerBorderEnd() const { return m_outerBorderEnd; }
162
163     unsigned numRows() const { return m_grid.size(); }
164     unsigned numColumns() const;
165     void recalcCells();
166     void recalcCellsIfNeeded()
167     {
168         if (m_needsCellRecalc)
169             recalcCells();
170     }
171
172     bool needsCellRecalc() const { return m_needsCellRecalc; }
173     void setNeedsCellRecalc();
174
175     LayoutUnit rowBaseline(unsigned row) { return m_grid[row].baseline; }
176
177     void rowLogicalHeightChanged(unsigned rowIndex);
178
179     void removeCachedCollapsedBorders(const RenderTableCell*);
180     void setCachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide, CollapsedBorderValue);
181     CollapsedBorderValue& cachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide);
182
183     // distributeExtraLogicalHeightToRows methods return the *consumed* extra logical height.
184     // FIXME: We may want to introduce a structure holding the in-flux layout information.
185     int distributeExtraLogicalHeightToRows(int extraLogicalHeight);
186
187     static RenderTableSection* createAnonymousWithParentRenderer(const RenderObject*);
188     virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject* parent) const OVERRIDE
189     {
190         return createAnonymousWithParentRenderer(parent);
191     }
192     
193     virtual void paint(PaintInfo&, const LayoutPoint&) OVERRIDE;
194
195 protected:
196     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) OVERRIDE;
197
198 private:
199     virtual const char* renderName() const OVERRIDE { return (isAnonymous() || isPseudoElement()) ? "RenderTableSection (anonymous)" : "RenderTableSection"; }
200
201     virtual bool canHaveChildren() const OVERRIDE { return true; }
202
203     virtual bool isTableSection() const OVERRIDE { return true; }
204
205     virtual void willBeRemovedFromTree() OVERRIDE;
206
207     virtual void layout() OVERRIDE;
208
209     void paintCell(RenderTableCell*, PaintInfo&, const LayoutPoint&);
210     virtual void paintObject(PaintInfo&, const LayoutPoint&) OVERRIDE;
211
212     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) OVERRIDE;
213
214     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;
215
216     void ensureRows(unsigned);
217
218     void distributeExtraLogicalHeightToPercentRows(int& extraLogicalHeight, int totalPercent);
219     void distributeExtraLogicalHeightToAutoRows(int& extraLogicalHeight, unsigned autoRowsCount);
220     void distributeRemainingExtraLogicalHeight(int& extraLogicalHeight);
221
222     bool hasOverflowingCell() const { return m_overflowingCells.size() || m_forceSlowPaintPathWithOverflowingCell; }
223     void computeOverflowFromCells(unsigned totalRows, unsigned nEffCols);
224
225     CellSpan fullTableRowSpan() const { return CellSpan(0, m_grid.size()); }
226     CellSpan fullTableColumnSpan() const { return CellSpan(0, table()->columns().size()); }
227
228     // Flip the rect so it aligns with the coordinates used by the rowPos and columnPos vectors.
229     LayoutRect logicalRectForWritingModeAndDirection(const LayoutRect&) const;
230
231     CellSpan dirtiedRows(const LayoutRect& repaintRect) const;
232     CellSpan dirtiedColumns(const LayoutRect& repaintRect) const;
233
234     // These two functions take a rectangle as input that has been flipped by logicalRectForWritingModeAndDirection.
235     // The returned span of rows or columns is end-exclusive, and empty if start==end.
236     CellSpan spannedRows(const LayoutRect& flippedRect) const;
237     CellSpan spannedColumns(const LayoutRect& flippedRect) const;
238
239     void setLogicalPositionForCell(RenderTableCell*, unsigned effectiveColumn) const;
240
241     Vector<RowStruct> m_grid;
242     Vector<int> m_rowPos;
243
244     // the current insertion position
245     unsigned m_cCol;
246     unsigned m_cRow;
247
248     int m_outerBorderStart;
249     int m_outerBorderEnd;
250     int m_outerBorderBefore;
251     int m_outerBorderAfter;
252
253     bool m_needsCellRecalc;
254
255     // This HashSet holds the overflowing cells for faster painting.
256     // If we have more than gMaxAllowedOverflowingCellRatio * total cells, it will be empty
257     // and m_forceSlowPaintPathWithOverflowingCell will be set to save memory.
258     HashSet<RenderTableCell*> m_overflowingCells;
259     bool m_forceSlowPaintPathWithOverflowingCell;
260
261     bool m_hasMultipleCellLevels;
262
263     // This map holds the collapsed border values for cells with collapsed borders.
264     // It is held at RenderTableSection level to spare memory consumption by table cells.
265     HashMap<pair<const RenderTableCell*, int>, CollapsedBorderValue > m_cellsCollapsedBorders;
266 };
267
268 inline RenderTableSection* toRenderTableSection(RenderObject* object)
269 {
270     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isTableSection());
271     return static_cast<RenderTableSection*>(object);
272 }
273
274 inline const RenderTableSection* toRenderTableSection(const RenderObject* object)
275 {
276     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isTableSection());
277     return static_cast<const RenderTableSection*>(object);
278 }
279
280 // This will catch anyone doing an unnecessary cast.
281 void toRenderTableSection(const RenderTableSection*);
282
283 } // namespace WebCore
284
285 #endif // RenderTableSection_h