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