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