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