Introduce RenderTreeBuilder
[WebKit-https.git] / Source / WebCore / rendering / RenderTable.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, 2010, 2014 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 "CSSPropertyNames.h"
28 #include "CollapsedBorderValue.h"
29 #include "RenderBlock.h"
30 #include <memory>
31 #include <wtf/HashMap.h>
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 class RenderTableCol;
37 class RenderTableCaption;
38 class RenderTableCell;
39 class RenderTableSection;
40 class TableLayout;
41
42 enum SkipEmptySectionsValue { DoNotSkipEmptySections, SkipEmptySections };
43
44 class RenderTable : public RenderBlock {
45     WTF_MAKE_ISO_ALLOCATED(RenderTable);
46 public:
47     RenderTable(Element&, RenderStyle&&);
48     RenderTable(Document&, RenderStyle&&);
49     virtual ~RenderTable();
50
51     // Per CSS 3 writing-mode: "The first and second values of the 'border-spacing' property represent spacing between columns
52     // and rows respectively, not necessarily the horizontal and vertical spacing respectively".
53     LayoutUnit hBorderSpacing() const { return m_hSpacing; }
54     LayoutUnit vBorderSpacing() const { return m_vSpacing; }
55     
56     bool collapseBorders() const { return style().borderCollapse(); }
57
58     LayoutUnit borderStart() const override { return m_borderStart; }
59     LayoutUnit borderEnd() const override { return m_borderEnd; }
60     LayoutUnit borderBefore() const override;
61     LayoutUnit borderAfter() const override;
62
63     LayoutUnit borderLeft() const override
64     {
65         if (style().isHorizontalWritingMode())
66             return style().isLeftToRightDirection() ? borderStart() : borderEnd();
67         return style().isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
68     }
69
70     LayoutUnit borderRight() const override
71     {
72         if (style().isHorizontalWritingMode())
73             return style().isLeftToRightDirection() ? borderEnd() : borderStart();
74         return style().isFlippedBlocksWritingMode() ? borderBefore() : borderAfter();
75     }
76
77     LayoutUnit borderTop() const override
78     {
79         if (style().isHorizontalWritingMode())
80             return style().isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
81         return style().isLeftToRightDirection() ? borderStart() : borderEnd();
82     }
83
84     LayoutUnit borderBottom() const override
85     {
86         if (style().isHorizontalWritingMode())
87             return style().isFlippedBlocksWritingMode() ? borderBefore() : borderAfter();
88         return style().isLeftToRightDirection() ? borderEnd() : borderStart();
89     }
90
91     Color bgColor() const { return style().visitedDependentColor(CSSPropertyBackgroundColor); }
92
93     LayoutUnit outerBorderBefore() const;
94     LayoutUnit outerBorderAfter() const;
95     LayoutUnit outerBorderStart() const;
96     LayoutUnit outerBorderEnd() const;
97
98     LayoutUnit outerBorderLeft() const
99     {
100         if (style().isHorizontalWritingMode())
101             return style().isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
102         return style().isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
103     }
104
105     LayoutUnit outerBorderRight() const
106     {
107         if (style().isHorizontalWritingMode())
108             return style().isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
109         return style().isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
110     }
111
112     LayoutUnit outerBorderTop() const
113     {
114         if (style().isHorizontalWritingMode())
115             return style().isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
116         return style().isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
117     }
118
119     LayoutUnit outerBorderBottom() const
120     {
121         if (style().isHorizontalWritingMode())
122             return style().isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
123         return style().isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
124     }
125
126     LayoutUnit calcBorderStart() const;
127     LayoutUnit calcBorderEnd() const;
128     void recalcBordersInRowDirection();
129
130     void addChild(RenderTreeBuilder&, RenderPtr<RenderObject> child, RenderObject* beforeChild = 0) final;
131
132     struct ColumnStruct {
133         explicit ColumnStruct(unsigned initialSpan = 1)
134             : span(initialSpan)
135         {
136         }
137
138         unsigned span;
139     };
140
141     void forceSectionsRecalc()
142     {
143         setNeedsSectionRecalc();
144         recalcSections();
145     }
146
147     const Vector<ColumnStruct>& columns() const { return m_columns; }
148     const Vector<LayoutUnit>& columnPositions() const { return m_columnPos; }
149     void setColumnPosition(unsigned index, LayoutUnit position)
150     {
151         // Note that if our horizontal border-spacing changed, our position will change but not
152         // our column's width. In practice, horizontal border-spacing won't change often.
153         m_columnLogicalWidthChanged |= m_columnPos[index] != position;
154         m_columnPos[index] = position;
155     }
156
157     RenderTableSection* header() const { return m_head.get(); }
158     RenderTableSection* footer() const { return m_foot.get(); }
159     RenderTableSection* firstBody() const { return m_firstBody.get(); }
160
161     // This function returns 0 if the table has no section.
162     RenderTableSection* topSection() const;
163     RenderTableSection* bottomSection() const;
164
165     // This function returns 0 if the table has no non-empty sections.
166     RenderTableSection* topNonEmptySection() const;
167
168     unsigned lastColumnIndex() const { return numEffCols() - 1; }
169
170     void splitColumn(unsigned position, unsigned firstSpan);
171     void appendColumn(unsigned span);
172     unsigned numEffCols() const { return m_columns.size(); }
173     unsigned spanOfEffCol(unsigned effCol) const { return m_columns[effCol].span; }
174     
175     unsigned colToEffCol(unsigned column) const
176     {
177         if (!m_hasCellColspanThatDeterminesTableWidth)
178             return column;
179
180         unsigned effColumn = 0;
181         unsigned numColumns = numEffCols();
182         for (unsigned c = 0; effColumn < numColumns && c + m_columns[effColumn].span - 1 < column; ++effColumn)
183             c += m_columns[effColumn].span;
184         return effColumn;
185     }
186     
187     unsigned effColToCol(unsigned effCol) const
188     {
189         if (!m_hasCellColspanThatDeterminesTableWidth)
190             return effCol;
191
192         unsigned c = 0;
193         for (unsigned i = 0; i < effCol; i++)
194             c += m_columns[i].span;
195         return c;
196     }
197
198     LayoutUnit borderSpacingInRowDirection() const
199     {
200         if (unsigned effectiveColumnCount = numEffCols())
201             return (effectiveColumnCount + 1) * hBorderSpacing();
202
203         return 0;
204     }
205
206     LayoutUnit bordersPaddingAndSpacingInRowDirection() const
207     {
208         // 'border-spacing' only applies to separate borders (see 17.6.1 The separated borders model).
209         return borderStart() + borderEnd() + (collapseBorders() ? LayoutUnit() : (paddingStart() + paddingEnd() + borderSpacingInRowDirection()));
210     }
211
212     // Return the first column or column-group.
213     RenderTableCol* firstColumn() const;
214
215     RenderTableCol* colElement(unsigned col, bool* startEdge = 0, bool* endEdge = 0) const
216     {
217         // The common case is to not have columns, make that case fast.
218         if (!m_hasColElements)
219             return 0;
220         return slowColElement(col, startEdge, endEdge);
221     }
222
223     bool needsSectionRecalc() const { return m_needsSectionRecalc; }
224     void setNeedsSectionRecalc()
225     {
226         if (renderTreeBeingDestroyed())
227             return;
228         m_needsSectionRecalc = true;
229         setNeedsLayout();
230     }
231
232     RenderTableSection* sectionAbove(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
233     RenderTableSection* sectionBelow(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
234
235     RenderTableCell* cellAbove(const RenderTableCell*) const;
236     RenderTableCell* cellBelow(const RenderTableCell*) const;
237     RenderTableCell* cellBefore(const RenderTableCell*) const;
238     RenderTableCell* cellAfter(const RenderTableCell*) const;
239  
240     typedef Vector<CollapsedBorderValue> CollapsedBorderValues;
241     bool collapsedBordersAreValid() const { return m_collapsedBordersValid; }
242     void invalidateCollapsedBorders(RenderTableCell* cellWithStyleChange = nullptr);
243     void collapsedEmptyBorderIsPresent() { m_collapsedEmptyBorderIsPresent = true; }
244     const CollapsedBorderValue* currentBorderValue() const { return m_currentBorder; }
245     
246     bool hasSections() const { return m_head || m_foot || m_firstBody; }
247
248     void recalcSectionsIfNeeded() const
249     {
250         if (m_needsSectionRecalc)
251             recalcSections();
252     }
253
254     static RenderPtr<RenderTable> createAnonymousWithParentRenderer(const RenderElement&);
255     RenderPtr<RenderBox> createAnonymousBoxWithSameTypeAs(const RenderBox& renderer) const override;
256
257     const BorderValue& tableStartBorderAdjoiningCell(const RenderTableCell&) const;
258     const BorderValue& tableEndBorderAdjoiningCell(const RenderTableCell&) const;
259
260     void addCaption(RenderTableCaption&);
261     void removeCaption(RenderTableCaption&);
262     void addColumn(const RenderTableCol*);
263     void removeColumn(const RenderTableCol*);
264
265     LayoutUnit offsetTopForColumn(const RenderTableCol&) const;
266     LayoutUnit offsetLeftForColumn(const RenderTableCol&) const;
267     LayoutUnit offsetWidthForColumn(const RenderTableCol&) const;
268     LayoutUnit offsetHeightForColumn(const RenderTableCol&) const;
269     
270     void markForPaginationRelayoutIfNeeded() final;
271     
272 protected:
273     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) final;
274     void simplifiedNormalFlowLayout() final;
275
276 private:
277     static RenderPtr<RenderTable> createTableWithStyle(Document&, const RenderStyle&);
278
279     const char* renderName() const override { return "RenderTable"; }
280
281     bool isTable() const final { return true; }
282
283     bool avoidsFloats() const final { return true; }
284
285     void paint(PaintInfo&, const LayoutPoint&) final;
286     void paintObject(PaintInfo&, const LayoutPoint&) final;
287     void paintBoxDecorations(PaintInfo&, const LayoutPoint&) final;
288     void paintMask(PaintInfo&, const LayoutPoint&) final;
289     void layout() final;
290     void computeIntrinsicLogicalWidths(LayoutUnit& minWidth, LayoutUnit& maxWidth) const final;
291     void computePreferredLogicalWidths() override;
292     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
293
294     int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const final;
295     std::optional<int> firstLineBaseline() const override;
296     std::optional<int> inlineBlockBaseline(LineDirectionMode) const final;
297
298     RenderTableCol* slowColElement(unsigned col, bool* startEdge, bool* endEdge) const;
299
300     void updateColumnCache() const;
301     void invalidateCachedColumns();
302
303     void invalidateCachedColumnOffsets();
304
305     RenderBlock* firstLineBlock() const final;
306     
307     void updateLogicalWidth() final;
308
309     LayoutUnit convertStyleLogicalWidthToComputedWidth(const Length& styleLogicalWidth, LayoutUnit availableWidth);
310     LayoutUnit convertStyleLogicalHeightToComputedHeight(const Length& styleLogicalHeight);
311
312     LayoutRect overflowClipRect(const LayoutPoint& location, RenderFragmentContainer*, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize, PaintPhase = PaintPhaseBlockBackground) final;
313     LayoutRect overflowClipRectForChildLayers(const LayoutPoint& location, RenderFragmentContainer* fragment, OverlayScrollbarSizeRelevancy relevancy) override { return RenderBox::overflowClipRect(location, fragment, relevancy); }
314
315     void addOverflowFromChildren() final;
316
317     void adjustBorderBoxRectForPainting(LayoutRect&) override;
318
319     void recalcCollapsedBorders();
320     void recalcSections() const;
321     enum class BottomCaptionLayoutPhase { Yes, No };
322     void layoutCaptions(BottomCaptionLayoutPhase = BottomCaptionLayoutPhase::No);
323     void layoutCaption(RenderTableCaption&);
324
325     void distributeExtraLogicalHeight(LayoutUnit extraLogicalHeight);
326
327     mutable Vector<LayoutUnit> m_columnPos;
328     mutable Vector<ColumnStruct> m_columns;
329     mutable Vector<WeakPtr<RenderTableCaption>> m_captions;
330     mutable Vector<WeakPtr<RenderTableCol>> m_columnRenderers;
331
332     unsigned effectiveIndexOfColumn(const RenderTableCol&) const;
333     typedef HashMap<const RenderTableCol*, unsigned> EffectiveColumnIndexMap;
334     mutable EffectiveColumnIndexMap m_effectiveColumnIndexMap;
335
336     mutable WeakPtr<RenderTableSection> m_head;
337     mutable WeakPtr<RenderTableSection> m_foot;
338     mutable WeakPtr<RenderTableSection> m_firstBody;
339
340     std::unique_ptr<TableLayout> m_tableLayout;
341
342     CollapsedBorderValues m_collapsedBorders;
343     const CollapsedBorderValue* m_currentBorder;
344     bool m_collapsedBordersValid : 1;
345     bool m_collapsedEmptyBorderIsPresent : 1;
346
347     mutable bool m_hasColElements : 1;
348     mutable bool m_needsSectionRecalc : 1;
349
350     bool m_columnLogicalWidthChanged : 1;
351     mutable bool m_columnRenderersValid: 1;
352     mutable bool m_hasCellColspanThatDeterminesTableWidth : 1;
353
354     bool hasCellColspanThatDeterminesTableWidth() const
355     {
356         for (unsigned c = 0; c < numEffCols(); c++) {
357             if (m_columns[c].span > 1)
358                 return true;
359         }
360         return false;
361     }
362
363     LayoutUnit m_hSpacing;
364     LayoutUnit m_vSpacing;
365     LayoutUnit m_borderStart;
366     LayoutUnit m_borderEnd;
367     mutable LayoutUnit m_columnOffsetTop;
368     mutable LayoutUnit m_columnOffsetHeight;
369     bool m_inRecursiveSectionMovedWithPagination { false };
370 };
371
372 inline RenderTableSection* RenderTable::topSection() const
373 {
374     ASSERT(!needsSectionRecalc());
375     if (m_head)
376         return m_head.get();
377     if (m_firstBody)
378         return m_firstBody.get();
379     return m_foot.get();
380 }
381
382 inline bool isDirectionSame(const RenderBox* tableItem, const RenderBox* otherTableItem) { return tableItem && otherTableItem ? tableItem->style().direction() == otherTableItem->style().direction() : true; }
383
384 inline RenderPtr<RenderBox> RenderTable::createAnonymousBoxWithSameTypeAs(const RenderBox& renderer) const
385 {
386     return RenderTable::createTableWithStyle(renderer.document(), renderer.style());
387 }
388
389 } // namespace WebCore
390
391 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderTable, isTable())