Centralize and clean-up table column iteration
[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     int getColumnPos(unsigned col) const { return m_columnPos[col]; }
49
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     Vector<ColumnStruct>& columns() { return m_columns; }
139     Vector<int>& columnPositions() { return m_columnPos; }
140     RenderTableSection* header() const { return m_head; }
141     RenderTableSection* footer() const { return m_foot; }
142     RenderTableSection* firstBody() const { return m_firstBody; }
143
144     // This function returns 0 if the table has no section.
145     RenderTableSection* topSection() const;
146
147     // This function returns 0 if the table has no non-empty sections.
148     RenderTableSection* topNonEmptySection() const;
149
150     void splitColumn(unsigned position, unsigned firstSpan);
151     void appendColumn(unsigned span);
152     unsigned numEffCols() const { return m_columns.size(); }
153     unsigned spanOfEffCol(unsigned effCol) const { return m_columns[effCol].span; }
154     
155     unsigned colToEffCol(unsigned column) const
156     {
157         unsigned effColumn = 0;
158         unsigned numColumns = numEffCols();
159         for (unsigned c = 0; effColumn < numColumns && c + m_columns[effColumn].span - 1 < column; ++effColumn)
160             c += m_columns[effColumn].span;
161         return effColumn;
162     }
163     
164     unsigned effColToCol(unsigned effCol) const
165     {
166         unsigned c = 0;
167         for (unsigned i = 0; i < effCol; i++)
168             c += m_columns[i].span;
169         return c;
170     }
171
172     LayoutUnit bordersPaddingAndSpacingInRowDirection() const
173     {
174         return borderStart() + borderEnd() +
175                (collapseBorders() ? ZERO_LAYOUT_UNIT : (paddingStart() + paddingEnd() + static_cast<LayoutUnit>(numEffCols() + 1) * hBorderSpacing()));
176     }
177
178     // Return the first column or column-group.
179     RenderTableCol* firstColumn() const;
180
181     RenderTableCol* colElement(unsigned col, bool* startEdge = 0, bool* endEdge = 0) const;
182
183     bool needsSectionRecalc() const { return m_needsSectionRecalc; }
184     void setNeedsSectionRecalc()
185     {
186         if (documentBeingDestroyed())
187             return;
188         m_needsSectionRecalc = true;
189         setNeedsLayout(true);
190     }
191
192     RenderTableSection* sectionAbove(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
193     RenderTableSection* sectionBelow(const RenderTableSection*, SkipEmptySectionsValue = DoNotSkipEmptySections) const;
194
195     RenderTableCell* cellAbove(const RenderTableCell*) const;
196     RenderTableCell* cellBelow(const RenderTableCell*) const;
197     RenderTableCell* cellBefore(const RenderTableCell*) const;
198     RenderTableCell* cellAfter(const RenderTableCell*) const;
199  
200     typedef Vector<CollapsedBorderValue> CollapsedBorderValues;
201     void invalidateCollapsedBorders()
202     {
203         m_collapsedBordersValid = false;
204         m_collapsedBorders.clear();
205     }
206     const CollapsedBorderValue* currentBorderValue() const { return m_currentBorder; }
207     
208     bool hasSections() const { return m_head || m_foot || m_firstBody; }
209
210     void recalcSectionsIfNeeded() const
211     {
212         if (m_needsSectionRecalc)
213             recalcSections();
214     }
215
216     static RenderTable* createAnonymousWithParentRenderer(const RenderObject*);
217     virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject* parent) const OVERRIDE
218     {
219         return createAnonymousWithParentRenderer(parent);
220     }
221
222 protected:
223     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
224
225 private:
226     virtual const char* renderName() const { return "RenderTable"; }
227
228     virtual bool isTable() const { return true; }
229
230     virtual bool avoidsFloats() const { return true; }
231
232     virtual void removeChild(RenderObject* oldChild);
233
234     virtual void paint(PaintInfo&, const LayoutPoint&);
235     virtual void paintObject(PaintInfo&, const LayoutPoint&);
236     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
237     virtual void paintMask(PaintInfo&, const LayoutPoint&);
238     virtual void layout();
239     virtual void computePreferredLogicalWidths();
240     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
241     
242     virtual LayoutUnit firstLineBoxBaseline() const OVERRIDE;
243     virtual LayoutUnit lastLineBoxBaseline() const OVERRIDE;
244
245     virtual RenderBlock* firstLineBlock() const;
246     virtual void updateFirstLetter();
247     
248     virtual void setCellLogicalWidths();
249
250     virtual void computeLogicalWidth();
251
252     LayoutUnit convertStyleLogicalWidthToComputedWidth(const Length& styleLogicalWidth, LayoutUnit availableWidth);
253
254     virtual LayoutRect overflowClipRect(const LayoutPoint& location, RenderRegion*, OverlayScrollbarSizeRelevancy = IgnoreOverlayScrollbarSize);
255
256     virtual void addOverflowFromChildren();
257
258     void subtractCaptionRect(LayoutRect&) const;
259
260     void recalcCollapsedBorders();
261     void recalcSections() const;
262     void layoutCaption(RenderTableCaption*);
263
264     void distributeExtraLogicalHeight(int extraLogicalHeight);
265
266     mutable Vector<int> m_columnPos;
267     mutable Vector<ColumnStruct> m_columns;
268     mutable Vector<RenderTableCaption*> m_captions;
269
270     mutable RenderTableSection* m_head;
271     mutable RenderTableSection* m_foot;
272     mutable RenderTableSection* m_firstBody;
273
274     OwnPtr<TableLayout> m_tableLayout;
275
276     CollapsedBorderValues m_collapsedBorders;
277     const CollapsedBorderValue* m_currentBorder;
278     bool m_collapsedBordersValid : 1;
279     
280     mutable bool m_hasColElements : 1;
281     mutable bool m_needsSectionRecalc : 1;
282     
283     short m_hSpacing;
284     short m_vSpacing;
285     int m_borderStart;
286     int m_borderEnd;
287 };
288
289 inline RenderTableSection* RenderTable::topSection() const
290 {
291     ASSERT(!needsSectionRecalc());
292     if (m_head)
293         return m_head;
294     if (m_firstBody)
295         return m_firstBody;
296     return m_foot;
297 }
298
299 inline RenderTable* toRenderTable(RenderObject* object)
300 {
301     ASSERT(!object || object->isTable());
302     return static_cast<RenderTable*>(object);
303 }
304
305 inline const RenderTable* toRenderTable(const RenderObject* object)
306 {
307     ASSERT(!object || object->isTable());
308     return static_cast<const RenderTable*>(object);
309 }
310
311 // This will catch anyone doing an unnecessary cast.
312 void toRenderTable(const RenderTable*);
313
314 } // namespace WebCore
315
316 #endif // RenderTable_h