Tables don't repaginate properly when the pagination height changes or the pagination...
[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 #ifndef RenderTable_h
26 #define RenderTable_h
27
28 #include "CSSPropertyNames.h"
29 #include "CollapsedBorderValue.h"
30 #include "RenderBlock.h"
31 #include <memory>
32 #include <wtf/HashMap.h>
33 #include <wtf/Vector.h>
34
35 namespace WebCore {
36
37 class RenderTableCol;
38 class RenderTableCaption;
39 class RenderTableCell;
40 class RenderTableSection;
41 class TableLayout;
42
43 enum SkipEmptySectionsValue { DoNotSkipEmptySections, SkipEmptySections };
44
45 class RenderTable : public RenderBlock {
46 public:
47     RenderTable(Element&, Ref<RenderStyle>&&);
48     RenderTable(Document&, Ref<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     int hBorderSpacing() const { return m_hSpacing; }
54     int vBorderSpacing() const { return m_vSpacing; }
55     
56     bool collapseBorders() const { return style().borderCollapse(); }
57
58     virtual LayoutUnit borderStart() const override { return m_borderStart; }
59     virtual LayoutUnit borderEnd() const override { return m_borderEnd; }
60     virtual LayoutUnit borderBefore() const override;
61     virtual LayoutUnit borderAfter() const override;
62
63     virtual LayoutUnit borderLeft() const override
64     {
65         if (style().isHorizontalWritingMode())
66             return style().isLeftToRightDirection() ? borderStart() : borderEnd();
67         return style().isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
68     }
69
70     virtual LayoutUnit borderRight() const override
71     {
72         if (style().isHorizontalWritingMode())
73             return style().isLeftToRightDirection() ? borderEnd() : borderStart();
74         return style().isFlippedBlocksWritingMode() ? borderBefore() : borderAfter();
75     }
76
77     virtual LayoutUnit borderTop() const override
78     {
79         if (style().isHorizontalWritingMode())
80             return style().isFlippedBlocksWritingMode() ? borderAfter() : borderBefore();
81         return style().isLeftToRightDirection() ? borderStart() : borderEnd();
82     }
83
84     virtual 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     int outerBorderBefore() const;
94     int outerBorderAfter() const;
95     int outerBorderStart() const;
96     int outerBorderEnd() const;
97
98     int outerBorderLeft() const
99     {
100         if (style().isHorizontalWritingMode())
101             return style().isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
102         return style().isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
103     }
104
105     int outerBorderRight() const
106     {
107         if (style().isHorizontalWritingMode())
108             return style().isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
109         return style().isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
110     }
111
112     int outerBorderTop() const
113     {
114         if (style().isHorizontalWritingMode())
115             return style().isFlippedBlocksWritingMode() ? outerBorderAfter() : outerBorderBefore();
116         return style().isLeftToRightDirection() ? outerBorderStart() : outerBorderEnd();
117     }
118
119     int outerBorderBottom() const
120     {
121         if (style().isHorizontalWritingMode())
122             return style().isFlippedBlocksWritingMode() ? outerBorderBefore() : outerBorderAfter();
123         return style().isLeftToRightDirection() ? outerBorderEnd() : outerBorderStart();
124     }
125
126     int calcBorderStart() const;
127     int calcBorderEnd() const;
128     void recalcBordersInRowDirection();
129
130     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0) override 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<int>& columnPositions() const { return m_columnPos; }
149     void setColumnPosition(unsigned index, int 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; }
158     RenderTableSection* footer() const { return m_foot; }
159     RenderTableSection* firstBody() const { return m_firstBody; }
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     // Override paddingStart/End to return pixel values to match behavor of RenderTableCell.
207     virtual LayoutUnit paddingEnd() const override final { return static_cast<int>(RenderBlock::paddingEnd()); }
208     virtual LayoutUnit paddingStart() const override final { return static_cast<int>(RenderBlock::paddingStart()); }
209
210     LayoutUnit bordersPaddingAndSpacingInRowDirection() const
211     {
212         // 'border-spacing' only applies to separate borders (see 17.6.1 The separated borders model).
213         return borderStart() + borderEnd() + (collapseBorders() ? LayoutUnit() : (paddingStart() + paddingEnd() + borderSpacingInRowDirection()));
214     }
215
216     // Return the first column or column-group.
217     RenderTableCol* firstColumn() const;
218
219     RenderTableCol* colElement(unsigned col, bool* startEdge = 0, bool* endEdge = 0) const
220     {
221         // The common case is to not have columns, make that case fast.
222         if (!m_hasColElements)
223             return 0;
224         return slowColElement(col, startEdge, endEdge);
225     }
226
227     bool needsSectionRecalc() const { return m_needsSectionRecalc; }
228     void setNeedsSectionRecalc()
229     {
230         if (documentBeingDestroyed())
231             return;
232         m_needsSectionRecalc = true;
233         setNeedsLayout();
234     }
235
236     RenderTableSection* sectionAbove(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
237     RenderTableSection* sectionBelow(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
238
239     RenderTableCell* cellAbove(const RenderTableCell*) const;
240     RenderTableCell* cellBelow(const RenderTableCell*) const;
241     RenderTableCell* cellBefore(const RenderTableCell*) const;
242     RenderTableCell* cellAfter(const RenderTableCell*) const;
243  
244     typedef Vector<CollapsedBorderValue> CollapsedBorderValues;
245     void invalidateCollapsedBorders()
246     {
247         m_collapsedBordersValid = false;
248         m_collapsedBorders.clear();
249     }
250     const CollapsedBorderValue* currentBorderValue() const { return m_currentBorder; }
251     
252     bool hasSections() const { return m_head || m_foot || m_firstBody; }
253
254     void recalcSectionsIfNeeded() const
255     {
256         if (m_needsSectionRecalc)
257             recalcSections();
258     }
259
260     static RenderTable* createAnonymousWithParentRenderer(const RenderObject*);
261     virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject* parent) const override
262     {
263         return createAnonymousWithParentRenderer(parent);
264     }
265
266     const BorderValue& tableStartBorderAdjoiningCell(const RenderTableCell*) const;
267     const BorderValue& tableEndBorderAdjoiningCell(const RenderTableCell*) const;
268
269     void addCaption(const RenderTableCaption*);
270     void removeCaption(const RenderTableCaption*);
271     void addColumn(const RenderTableCol*);
272     void removeColumn(const RenderTableCol*);
273
274     LayoutUnit offsetTopForColumn(const RenderTableCol&) const;
275     LayoutUnit offsetLeftForColumn(const RenderTableCol&) const;
276     LayoutUnit offsetWidthForColumn(const RenderTableCol&) const;
277     LayoutUnit offsetHeightForColumn(const RenderTableCol&) const;
278     
279     virtual void markForPaginationRelayoutIfNeeded() override final;
280     
281 protected:
282     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override final;
283     virtual void simplifiedNormalFlowLayout() override final;
284
285 private:
286     virtual const char* renderName() const override { return "RenderTable"; }
287
288     virtual bool isTable() const override final { return true; }
289
290     virtual bool avoidsFloats() const override final { return true; }
291
292     virtual void paint(PaintInfo&, const LayoutPoint&) override final;
293     virtual void paintObject(PaintInfo&, const LayoutPoint&) override final;
294     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override final;
295     virtual void paintMask(PaintInfo&, const LayoutPoint&) override final;
296     virtual void layout() override final;
297     virtual void computeIntrinsicLogicalWidths(LayoutUnit& minWidth, LayoutUnit& maxWidth) const override final;
298     virtual void computePreferredLogicalWidths() override;
299     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
300
301     virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const override final;
302     virtual int firstLineBaseline() const override;
303     virtual int inlineBlockBaseline(LineDirectionMode) const override final;
304
305     RenderTableCol* slowColElement(unsigned col, bool* startEdge, bool* endEdge) const;
306
307     void updateColumnCache() const;
308     void invalidateCachedColumns();
309
310     void invalidateCachedColumnOffsets();
311
312     virtual RenderBlock* firstLineBlock() const override final;
313     virtual void updateFirstLetter() override final;
314     
315     virtual void updateLogicalWidth() override final;
316
317     LayoutUnit convertStyleLogicalWidthToComputedWidth(const Length& styleLogicalWidth, LayoutUnit availableWidth);
318     LayoutUnit convertStyleLogicalHeightToComputedHeight(const Length& styleLogicalHeight);
319
320     virtual LayoutRect overflowClipRect(const LayoutPoint& location, RenderRegion*, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize, PaintPhase = PaintPhaseBlockBackground) override final;
321     virtual LayoutRect overflowClipRectForChildLayers(const LayoutPoint& location, RenderRegion* region, OverlayScrollbarSizeRelevancy relevancy) override { return RenderBox::overflowClipRect(location, region, relevancy); }
322
323     virtual void addOverflowFromChildren() override final;
324
325     void subtractCaptionRect(LayoutRect&) const;
326
327     void recalcCollapsedBorders();
328     void recalcSections() const;
329     void layoutCaption(RenderTableCaption*);
330
331     void distributeExtraLogicalHeight(int extraLogicalHeight);
332
333     mutable Vector<int> m_columnPos;
334     mutable Vector<ColumnStruct> m_columns;
335     mutable Vector<RenderTableCaption*> m_captions;
336     mutable Vector<RenderTableCol*> m_columnRenderers;
337
338     unsigned effectiveIndexOfColumn(const RenderTableCol&) const;
339     typedef HashMap<const RenderTableCol*, unsigned> EffectiveColumnIndexMap;
340     mutable EffectiveColumnIndexMap m_effectiveColumnIndexMap;
341
342     mutable RenderTableSection* m_head;
343     mutable RenderTableSection* m_foot;
344     mutable RenderTableSection* m_firstBody;
345
346     std::unique_ptr<TableLayout> m_tableLayout;
347
348     CollapsedBorderValues m_collapsedBorders;
349     const CollapsedBorderValue* m_currentBorder;
350     bool m_collapsedBordersValid : 1;
351
352     mutable bool m_hasColElements : 1;
353     mutable bool m_needsSectionRecalc : 1;
354
355     bool m_columnLogicalWidthChanged : 1;
356     mutable bool m_columnRenderersValid: 1;
357     mutable bool m_hasCellColspanThatDeterminesTableWidth : 1;
358
359     bool hasCellColspanThatDeterminesTableWidth() const
360     {
361         for (unsigned c = 0; c < numEffCols(); c++) {
362             if (m_columns[c].span > 1)
363                 return true;
364         }
365         return false;
366     }
367
368     short m_hSpacing;
369     short m_vSpacing;
370     int m_borderStart;
371     int m_borderEnd;
372     mutable LayoutUnit m_columnOffsetTop;
373     mutable LayoutUnit m_columnOffsetHeight;
374 };
375
376 inline RenderTableSection* RenderTable::topSection() const
377 {
378     ASSERT(!needsSectionRecalc());
379     if (m_head)
380         return m_head;
381     if (m_firstBody)
382         return m_firstBody;
383     return m_foot;
384 }
385
386 } // namespace WebCore
387
388 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderTable, isTable())
389
390 #endif // RenderTable_h