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