Rename some line box functions to be just about lines
[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 RenderTableRow;
34
35 enum CollapsedBorderSide {
36     CBSBefore,
37     CBSAfter,
38     CBSStart,
39     CBSEnd
40 };
41
42 // Helper class for paintObject.
43 class CellSpan {
44 public:
45     CellSpan(unsigned start, unsigned end)
46         : m_start(start)
47         , m_end(end)
48     {
49     }
50
51     unsigned start() const { return m_start; }
52     unsigned end() const { return m_end; }
53
54     unsigned& start() { return m_start; }
55     unsigned& end() { return m_end; }
56
57 private:
58     unsigned m_start;
59     unsigned m_end;
60 };
61
62 class RenderTableCell;
63 class RenderTableRow;
64
65 class RenderTableSection FINAL : public RenderBox {
66 public:
67     explicit RenderTableSection(Element&);
68     explicit RenderTableSection(Document&);
69     virtual ~RenderTableSection();
70
71     RenderTableRow* firstRow() const;
72     RenderTableRow* lastRow() const;
73
74     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0) OVERRIDE;
75
76     virtual int firstLineBaseline() 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     int outerBorderLeft(const RenderStyle* styleForCellFlow) const
170     {
171     if (styleForCellFlow->isHorizontalWritingMode())
172         return styleForCellFlow->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
173     return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
174     }
175
176     int outerBorderRight(const RenderStyle* styleForCellFlow) const
177     {
178     if (styleForCellFlow->isHorizontalWritingMode())
179         return styleForCellFlow->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
180     return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
181     }
182
183     int outerBorderTop(const RenderStyle* styleForCellFlow) const
184     {
185     if (styleForCellFlow->isHorizontalWritingMode())
186         return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
187     return styleForCellFlow->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
188     }
189
190     int outerBorderBottom(const RenderStyle* styleForCellFlow) const
191     {
192     if (styleForCellFlow->isHorizontalWritingMode())
193         return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
194     return styleForCellFlow->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
195     }
196
197     unsigned numRows() const { return m_grid.size(); }
198     unsigned numColumns() const;
199     void recalcCells();
200     void recalcCellsIfNeeded()
201     {
202         if (m_needsCellRecalc)
203             recalcCells();
204     }
205
206     bool needsCellRecalc() const { return m_needsCellRecalc; }
207     void setNeedsCellRecalc();
208
209     LayoutUnit rowBaseline(unsigned row) { return m_grid[row].baseline; }
210
211     void rowLogicalHeightChanged(unsigned rowIndex);
212
213     void removeCachedCollapsedBorders(const RenderTableCell*);
214     void setCachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide, CollapsedBorderValue);
215     CollapsedBorderValue& cachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide);
216
217     // distributeExtraLogicalHeightToRows methods return the *consumed* extra logical height.
218     // FIXME: We may want to introduce a structure holding the in-flux layout information.
219     int distributeExtraLogicalHeightToRows(int extraLogicalHeight);
220
221     static RenderTableSection* createAnonymousWithParentRenderer(const RenderObject*);
222     virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject* parent) const OVERRIDE
223     {
224         return createAnonymousWithParentRenderer(parent);
225     }
226     
227     virtual void paint(PaintInfo&, const LayoutPoint&) OVERRIDE;
228
229 protected:
230     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) OVERRIDE;
231
232 private:
233     virtual const char* renderName() const OVERRIDE { return (isAnonymous() || isPseudoElement()) ? "RenderTableSection (anonymous)" : "RenderTableSection"; }
234
235     virtual bool canHaveChildren() const OVERRIDE { return true; }
236
237     virtual bool isTableSection() const OVERRIDE { return true; }
238
239     virtual void willBeRemovedFromTree() OVERRIDE;
240
241     virtual void layout() OVERRIDE;
242
243     void paintCell(RenderTableCell*, PaintInfo&, const LayoutPoint&);
244     virtual void paintObject(PaintInfo&, const LayoutPoint&) OVERRIDE;
245     void paintRowGroupBorder(const PaintInfo&, bool antialias, LayoutRect, BoxSide, CSSPropertyID borderColor, EBorderStyle, EBorderStyle tableBorderStyle);
246     void paintRowGroupBorderIfRequired(const PaintInfo&, const LayoutPoint& paintOffset, unsigned row, unsigned col, BoxSide, RenderTableCell* = 0);
247     int offsetLeftForRowGroupBorder(RenderTableCell*, const LayoutRect& rowGroupRect, unsigned row);
248
249     int offsetTopForRowGroupBorder(RenderTableCell*, BoxSide borderSide, unsigned row);
250     int verticalRowGroupBorderHeight(RenderTableCell*, const LayoutRect& rowGroupRect, unsigned row);
251     int horizontalRowGroupBorderWidth(RenderTableCell*, const LayoutRect& rowGroupRect, unsigned row, unsigned column);
252
253     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0) OVERRIDE;
254
255     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;
256
257     void ensureRows(unsigned);
258
259     void distributeExtraLogicalHeightToPercentRows(int& extraLogicalHeight, int totalPercent);
260     void distributeExtraLogicalHeightToAutoRows(int& extraLogicalHeight, unsigned autoRowsCount);
261     void distributeRemainingExtraLogicalHeight(int& extraLogicalHeight);
262
263     bool hasOverflowingCell() const { return m_overflowingCells.size() || m_forceSlowPaintPathWithOverflowingCell; }
264     void computeOverflowFromCells(unsigned totalRows, unsigned nEffCols);
265
266     CellSpan fullTableRowSpan() const { return CellSpan(0, m_grid.size()); }
267     CellSpan fullTableColumnSpan() const { return CellSpan(0, table()->columns().size()); }
268
269     // Flip the rect so it aligns with the coordinates used by the rowPos and columnPos vectors.
270     LayoutRect logicalRectForWritingModeAndDirection(const LayoutRect&) const;
271
272     CellSpan dirtiedRows(const LayoutRect& repaintRect) const;
273     CellSpan dirtiedColumns(const LayoutRect& repaintRect) const;
274
275     // These two functions take a rectangle as input that has been flipped by logicalRectForWritingModeAndDirection.
276     // The returned span of rows or columns is end-exclusive, and empty if start==end.
277     CellSpan spannedRows(const LayoutRect& flippedRect) const;
278     CellSpan spannedColumns(const LayoutRect& flippedRect) const;
279
280     void setLogicalPositionForCell(RenderTableCell*, unsigned effectiveColumn) const;
281
282     void firstChild() const WTF_DELETED_FUNCTION;
283     void lastChild() const WTF_DELETED_FUNCTION;
284
285     Vector<RowStruct> m_grid;
286     Vector<int> m_rowPos;
287
288     // the current insertion position
289     unsigned m_cCol;
290     unsigned m_cRow;
291
292     int m_outerBorderStart;
293     int m_outerBorderEnd;
294     int m_outerBorderBefore;
295     int m_outerBorderAfter;
296
297     bool m_needsCellRecalc;
298
299     // This HashSet holds the overflowing cells for faster painting.
300     // If we have more than gMaxAllowedOverflowingCellRatio * total cells, it will be empty
301     // and m_forceSlowPaintPathWithOverflowingCell will be set to save memory.
302     HashSet<RenderTableCell*> m_overflowingCells;
303     bool m_forceSlowPaintPathWithOverflowingCell;
304
305     bool m_hasMultipleCellLevels;
306
307     // This map holds the collapsed border values for cells with collapsed borders.
308     // It is held at RenderTableSection level to spare memory consumption by table cells.
309     HashMap<pair<const RenderTableCell*, int>, CollapsedBorderValue > m_cellsCollapsedBorders;
310 };
311
312 inline RenderTableSection* toRenderTableSection(RenderObject* object)
313 {
314     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isTableSection());
315     return static_cast<RenderTableSection*>(object);
316 }
317
318 inline const RenderTableSection* toRenderTableSection(const RenderObject* object)
319 {
320     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isTableSection());
321     return static_cast<const RenderTableSection*>(object);
322 }
323
324 // This will catch anyone doing an unnecessary cast.
325 void toRenderTableSection(const RenderTableSection*);
326
327 } // namespace WebCore
328
329 #endif // RenderTableSection_h