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