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