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