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