Cleanup RenderTable*::createAnonymous*
[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 enum CollapsedBorderSide {
37     CBSBefore,
38     CBSAfter,
39     CBSStart,
40     CBSEnd
41 };
42
43 // Helper class for paintObject.
44 struct CellSpan {
45 public:
46     CellSpan(unsigned start, unsigned end)
47         : start(start)
48         , end(end)
49     {
50     }
51
52     unsigned start;
53     unsigned end;
54 };
55
56 class RenderTableSection final : public RenderBox {
57 public:
58     RenderTableSection(Element&, RenderStyle&&);
59     RenderTableSection(Document&, RenderStyle&&);
60     virtual ~RenderTableSection();
61
62     RenderTableRow* firstRow() const;
63     RenderTableRow* lastRow() const;
64
65     void addChild(RenderObject* child, RenderObject* beforeChild = 0) override;
66
67     Optional<int> firstLineBaseline() const override;
68
69     void addCell(RenderTableCell*, RenderTableRow* row);
70
71     LayoutUnit calcRowLogicalHeight();
72     void layoutRows();
73     void computeOverflowFromCells();
74
75     RenderTable* table() const { return downcast<RenderTable>(parent()); }
76
77     struct CellStruct {
78         Vector<RenderTableCell*, 1> cells; 
79         bool inColSpan { false }; // true for columns after the first in a colspan
80
81         RenderTableCell* primaryCell() { return hasCells() ? cells[cells.size() - 1] : 0; }
82         const RenderTableCell* primaryCell() const { return hasCells() ? cells[cells.size() - 1] : 0; }
83         bool hasCells() const { return cells.size() > 0; }
84     };
85
86     typedef Vector<CellStruct> Row;
87     struct RowStruct {
88         Row row;
89         RenderTableRow* rowRenderer { nullptr };
90         LayoutUnit baseline;
91         Length logicalHeight;
92     };
93
94     const BorderValue& borderAdjoiningTableStart() const;
95     const BorderValue& borderAdjoiningTableEnd() const;
96     const BorderValue& borderAdjoiningStartCell(const RenderTableCell&) const;
97     const BorderValue& borderAdjoiningEndCell(const RenderTableCell&) const;
98
99     const RenderTableCell* firstRowCellAdjoiningTableStart() const;
100     const RenderTableCell* firstRowCellAdjoiningTableEnd() const;
101
102     CellStruct& cellAt(unsigned row,  unsigned col);
103     const CellStruct& cellAt(unsigned row, unsigned col) const;
104     RenderTableCell* primaryCellAt(unsigned row, unsigned col);
105     RenderTableRow* rowRendererAt(unsigned row) const;
106
107     void appendColumn(unsigned pos);
108     void splitColumn(unsigned pos, unsigned first);
109
110     LayoutUnit calcOuterBorderBefore() const;
111     LayoutUnit calcOuterBorderAfter() const;
112     LayoutUnit calcOuterBorderStart() const;
113     LayoutUnit calcOuterBorderEnd() const;
114     void recalcOuterBorder();
115
116     LayoutUnit outerBorderBefore() const { return m_outerBorderBefore; }
117     LayoutUnit outerBorderAfter() const { return m_outerBorderAfter; }
118     LayoutUnit outerBorderStart() const { return m_outerBorderStart; }
119     LayoutUnit outerBorderEnd() const { return m_outerBorderEnd; }
120
121     LayoutUnit outerBorderLeft(const RenderStyle* styleForCellFlow) const;
122     LayoutUnit outerBorderRight(const RenderStyle* styleForCellFlow) const;
123     LayoutUnit outerBorderTop(const RenderStyle* styleForCellFlow) const;
124     LayoutUnit outerBorderBottom(const RenderStyle* styleForCellFlow) const;
125
126     unsigned numRows() const;
127     unsigned numColumns() const;
128     void recalcCells();
129     void recalcCellsIfNeeded();
130
131     bool needsCellRecalc() const { return m_needsCellRecalc; }
132     void setNeedsCellRecalc();
133
134     LayoutUnit rowBaseline(unsigned row);
135     void rowLogicalHeightChanged(unsigned rowIndex);
136
137     void clearCachedCollapsedBorders();
138     void removeCachedCollapsedBorders(const RenderTableCell&);
139     void setCachedCollapsedBorder(const RenderTableCell&, CollapsedBorderSide, CollapsedBorderValue);
140     CollapsedBorderValue cachedCollapsedBorder(const RenderTableCell&, CollapsedBorderSide);
141
142     // distributeExtraLogicalHeightToRows methods return the *consumed* extra logical height.
143     // FIXME: We may want to introduce a structure holding the in-flux layout information.
144     LayoutUnit distributeExtraLogicalHeightToRows(LayoutUnit extraLogicalHeight);
145
146     static std::unique_ptr<RenderTableSection> createAnonymousWithParentRenderer(const RenderTable&);
147     std::unique_ptr<RenderBox> createAnonymousBoxWithSameTypeAs(const RenderBox&) const override;
148     
149     void paint(PaintInfo&, const LayoutPoint&) override;
150
151 protected:
152     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
153
154 private:
155     static std::unique_ptr<RenderTableSection> createTableSectionWithStyle(Document&, const RenderStyle&);
156
157     enum ShouldIncludeAllIntersectingCells {
158         IncludeAllIntersectingCells,
159         DoNotIncludeAllIntersectingCells
160     };
161
162     const char* renderName() const override { return (isAnonymous() || isPseudoElement()) ? "RenderTableSection (anonymous)" : "RenderTableSection"; }
163
164     bool canHaveChildren() const override { return true; }
165
166     bool isTableSection() const override { return true; }
167
168     void willBeRemovedFromTree() override;
169
170     void layout() override;
171
172     void paintCell(RenderTableCell*, PaintInfo&, const LayoutPoint&);
173     void paintObject(PaintInfo&, const LayoutPoint&) override;
174     void paintRowGroupBorder(const PaintInfo&, bool antialias, LayoutRect, BoxSide, CSSPropertyID borderColor, EBorderStyle, EBorderStyle tableBorderStyle);
175     void paintRowGroupBorderIfRequired(const PaintInfo&, const LayoutPoint& paintOffset, unsigned row, unsigned col, BoxSide, RenderTableCell* = 0);
176     LayoutUnit offsetLeftForRowGroupBorder(RenderTableCell*, const LayoutRect& rowGroupRect, unsigned row);
177
178     LayoutUnit offsetTopForRowGroupBorder(RenderTableCell*, BoxSide borderSide, unsigned row);
179     LayoutUnit verticalRowGroupBorderHeight(RenderTableCell*, const LayoutRect& rowGroupRect, unsigned row);
180     LayoutUnit horizontalRowGroupBorderWidth(RenderTableCell*, const LayoutRect& rowGroupRect, unsigned row, unsigned column);
181
182     void imageChanged(WrappedImagePtr, const IntRect* = 0) override;
183
184     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
185
186     void ensureRows(unsigned);
187
188     void distributeExtraLogicalHeightToPercentRows(LayoutUnit& extraLogicalHeight, int totalPercent);
189     void distributeExtraLogicalHeightToAutoRows(LayoutUnit& extraLogicalHeight, unsigned autoRowsCount);
190     void distributeRemainingExtraLogicalHeight(LayoutUnit& extraLogicalHeight);
191
192     bool hasOverflowingCell() const { return m_overflowingCells.size() || m_forceSlowPaintPathWithOverflowingCell; }
193     void computeOverflowFromCells(unsigned totalRows, unsigned nEffCols);
194
195     CellSpan fullTableRowSpan() const;
196     CellSpan fullTableColumnSpan() const { return CellSpan(0, table()->columns().size()); }
197
198     // Flip the rect so it aligns with the coordinates used by the rowPos and columnPos vectors.
199     LayoutRect logicalRectForWritingModeAndDirection(const LayoutRect&) const;
200
201     CellSpan dirtiedRows(const LayoutRect& repaintRect) const;
202     CellSpan dirtiedColumns(const LayoutRect& repaintRect) const;
203
204     // These two functions take a rectangle as input that has been flipped by logicalRectForWritingModeAndDirection.
205     // The returned span of rows or columns is end-exclusive, and empty if start==end.
206     // The IncludeAllIntersectingCells argument is used to determine which cells to include when
207     // an edge of the flippedRect lies exactly on a cell boundary. Using IncludeAllIntersectingCells
208     // will return both cells, and using DoNotIncludeAllIntersectingCells will return only the cell
209     // that hittesting should return.
210     CellSpan spannedRows(const LayoutRect& flippedRect, ShouldIncludeAllIntersectingCells) const;
211     CellSpan spannedColumns(const LayoutRect& flippedRect, ShouldIncludeAllIntersectingCells) const;
212
213     void setLogicalPositionForCell(RenderTableCell*, unsigned effectiveColumn) const;
214
215     void firstChild() const = delete;
216     void lastChild() const = delete;
217
218     Vector<RowStruct> m_grid;
219     Vector<LayoutUnit> m_rowPos;
220
221     // the current insertion position
222     unsigned m_cCol { 0 };
223     unsigned m_cRow  { 0 };
224
225     LayoutUnit m_outerBorderStart;
226     LayoutUnit m_outerBorderEnd;
227     LayoutUnit m_outerBorderBefore;
228     LayoutUnit m_outerBorderAfter;
229
230     bool m_needsCellRecalc  { false };
231
232     // This HashSet holds the overflowing cells for faster painting.
233     // If we have more than gMaxAllowedOverflowingCellRatio * total cells, it will be empty
234     // and m_forceSlowPaintPathWithOverflowingCell will be set to save memory.
235     HashSet<RenderTableCell*> m_overflowingCells;
236     bool m_forceSlowPaintPathWithOverflowingCell { false };
237
238     bool m_hasMultipleCellLevels { false };
239
240     // This map holds the collapsed border values for cells with collapsed borders.
241     // It is held at RenderTableSection level to spare memory consumption by table cells.
242     HashMap<std::pair<const RenderTableCell*, int>, CollapsedBorderValue > m_cellsCollapsedBorders;
243 };
244
245 inline const BorderValue& RenderTableSection::borderAdjoiningTableStart() const
246 {
247     if (isDirectionSame(this, table()))
248         return style().borderStart();
249     return style().borderEnd();
250 }
251
252 inline const BorderValue& RenderTableSection::borderAdjoiningTableEnd() const
253 {
254     if (isDirectionSame(this, table()))
255         return style().borderEnd();
256     return style().borderStart();
257 }
258
259 inline RenderTableSection::CellStruct& RenderTableSection::cellAt(unsigned row,  unsigned col)
260 {
261     recalcCellsIfNeeded();
262     return m_grid[row].row[col];
263 }
264
265 inline const RenderTableSection::CellStruct& RenderTableSection::cellAt(unsigned row, unsigned col) const
266 {
267     ASSERT(!m_needsCellRecalc);
268     return m_grid[row].row[col];
269 }
270
271 inline RenderTableCell* RenderTableSection::primaryCellAt(unsigned row, unsigned col)
272 {
273     recalcCellsIfNeeded();
274     CellStruct& c = m_grid[row].row[col];
275     return c.primaryCell();
276 }
277
278 inline RenderTableRow* RenderTableSection::rowRendererAt(unsigned row) const
279 {
280     ASSERT(!m_needsCellRecalc);
281     return m_grid[row].rowRenderer;
282 }
283
284 inline LayoutUnit RenderTableSection::outerBorderLeft(const RenderStyle* styleForCellFlow) const
285 {
286     if (styleForCellFlow->isHorizontalWritingMode())
287         return styleForCellFlow->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
288     return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
289 }
290
291 inline LayoutUnit RenderTableSection::outerBorderRight(const RenderStyle* styleForCellFlow) const
292 {
293     if (styleForCellFlow->isHorizontalWritingMode())
294         return styleForCellFlow->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
295     return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
296 }
297
298 inline LayoutUnit RenderTableSection::outerBorderTop(const RenderStyle* styleForCellFlow) const
299 {
300     if (styleForCellFlow->isHorizontalWritingMode())
301         return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
302     return styleForCellFlow->isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
303 }
304
305 inline LayoutUnit RenderTableSection::outerBorderBottom(const RenderStyle* styleForCellFlow) const
306 {
307     if (styleForCellFlow->isHorizontalWritingMode())
308         return styleForCellFlow->isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
309     return styleForCellFlow->isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
310 }
311
312 inline unsigned RenderTableSection::numRows() const
313 {
314     ASSERT(!m_needsCellRecalc);
315     return m_grid.size();
316 }
317
318 inline void RenderTableSection::recalcCellsIfNeeded()
319 {
320     if (m_needsCellRecalc)
321         recalcCells();
322 }
323
324 inline LayoutUnit RenderTableSection::rowBaseline(unsigned row)
325 {
326     recalcCellsIfNeeded();
327     return m_grid[row].baseline;
328 }
329
330 inline CellSpan RenderTableSection::fullTableRowSpan() const
331 {
332     ASSERT(!m_needsCellRecalc);
333     return CellSpan(0, m_grid.size());
334 }
335
336 inline std::unique_ptr<RenderBox> RenderTableSection::createAnonymousBoxWithSameTypeAs(const RenderBox& renderer) const
337 {
338     return RenderTableSection::createTableSectionWithStyle(renderer.document(), renderer.style());
339 }
340
341 } // namespace WebCore
342
343 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderTableSection, isTableSection())
344
345 #endif // RenderTableSection_h