Make renderer constructors take Element where possible
[WebKit-https.git] / Source / WebCore / rendering / RenderTableSection.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 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 RenderTableSection_h
26 #define RenderTableSection_h
27
28 #include "RenderTable.h"
29 #include <wtf/Vector.h>
30
31 namespace WebCore {
32
33 enum CollapsedBorderSide {
34     CBSBefore,
35     CBSAfter,
36     CBSStart,
37     CBSEnd
38 };
39
40 // Helper class for paintObject.
41 class CellSpan {
42 public:
43     CellSpan(unsigned start, unsigned end)
44         : m_start(start)
45         , m_end(end)
46     {
47     }
48
49     unsigned start() const { return m_start; }
50     unsigned end() const { return m_end; }
51
52     unsigned& start() { return m_start; }
53     unsigned& end() { return m_end; }
54
55 private:
56     unsigned m_start;
57     unsigned m_end;
58 };
59
60 class RenderTableCell;
61 class RenderTableRow;
62
63 class RenderTableSection : public RenderBox {
64 public:
65     RenderTableSection(Element*);
66     virtual ~RenderTableSection();
67
68     RenderObject* firstChild() const { ASSERT(children() == virtualChildren()); return children()->firstChild(); }
69     RenderObject* lastChild() const { ASSERT(children() == virtualChildren()); return children()->lastChild(); }
70
71     const RenderObjectChildList* children() const { return &m_children; }
72     RenderObjectChildList* children() { return &m_children; }
73
74     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0);
75
76     virtual int firstLineBoxBaseline() const OVERRIDE;
77
78     void addCell(RenderTableCell*, RenderTableRow* row);
79
80     int calcRowLogicalHeight();
81     void layoutRows();
82
83     RenderTable* table() const { return toRenderTable(parent()); }
84
85     struct CellStruct {
86         Vector<RenderTableCell*, 1> cells; 
87         bool inColSpan; // true for columns after the first in a colspan
88
89         CellStruct()
90             : inColSpan(false)
91         {
92         }
93
94         RenderTableCell* primaryCell()
95         {
96             return hasCells() ? cells[cells.size() - 1] : 0;
97         }
98
99         const RenderTableCell* primaryCell() const
100         {
101             return hasCells() ? cells[cells.size() - 1] : 0;
102         }
103
104         bool hasCells() const { return cells.size() > 0; }
105
106         void reportMemoryUsage(MemoryObjectInfo*) const;
107     };
108
109     typedef Vector<CellStruct> Row;
110
111     struct RowStruct {
112         RowStruct()
113             : rowRenderer(0)
114             , baseline()
115         {
116         }
117
118         void reportMemoryUsage(MemoryObjectInfo*) const;
119
120         Row row;
121         RenderTableRow* rowRenderer;
122         LayoutUnit baseline;
123         Length logicalHeight;
124     };
125
126     const BorderValue& borderAdjoiningTableStart() const
127     {
128         if (hasSameDirectionAs(table()))
129             return style()->borderStart();
130
131         return style()->borderEnd();
132     }
133
134     const BorderValue& borderAdjoiningTableEnd() const
135     {
136         if (hasSameDirectionAs(table()))
137             return style()->borderEnd();
138
139         return style()->borderStart();
140     }
141
142     const BorderValue& borderAdjoiningStartCell(const RenderTableCell*) const;
143     const BorderValue& borderAdjoiningEndCell(const RenderTableCell*) const;
144
145     const RenderTableCell* firstRowCellAdjoiningTableStart() const;
146     const RenderTableCell* firstRowCellAdjoiningTableEnd() const;
147
148     CellStruct& cellAt(unsigned row,  unsigned col) { return m_grid[row].row[col]; }
149     const CellStruct& cellAt(unsigned row, unsigned col) const { return m_grid[row].row[col]; }
150     RenderTableCell* primaryCellAt(unsigned row, unsigned col)
151     {
152         CellStruct& c = m_grid[row].row[col];
153         return c.primaryCell();
154     }
155
156     void appendColumn(unsigned pos);
157     void splitColumn(unsigned pos, unsigned first);
158
159     int calcOuterBorderBefore() const;
160     int calcOuterBorderAfter() const;
161     int calcOuterBorderStart() const;
162     int calcOuterBorderEnd() const;
163     void recalcOuterBorder();
164
165     int outerBorderBefore() const { return m_outerBorderBefore; }
166     int outerBorderAfter() const { return m_outerBorderAfter; }
167     int outerBorderStart() const { return m_outerBorderStart; }
168     int outerBorderEnd() const { return m_outerBorderEnd; }
169
170     unsigned numRows() const { return m_grid.size(); }
171     unsigned numColumns() const;
172     void recalcCells();
173     void recalcCellsIfNeeded()
174     {
175         if (m_needsCellRecalc)
176             recalcCells();
177     }
178
179     bool needsCellRecalc() const { return m_needsCellRecalc; }
180     void setNeedsCellRecalc();
181
182     LayoutUnit rowBaseline(unsigned row) { return m_grid[row].baseline; }
183
184     void rowLogicalHeightChanged(unsigned rowIndex);
185
186     void removeCachedCollapsedBorders(const RenderTableCell*);
187     void setCachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide, CollapsedBorderValue);
188     CollapsedBorderValue& cachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide);
189
190     // distributeExtraLogicalHeightToRows methods return the *consumed* extra logical height.
191     // FIXME: We may want to introduce a structure holding the in-flux layout information.
192     int distributeExtraLogicalHeightToRows(int extraLogicalHeight);
193
194     static RenderTableSection* createAnonymousWithParentRenderer(const RenderObject*);
195     virtual RenderBox* createAnonymousBoxWithSameTypeAs(const RenderObject* parent) const OVERRIDE
196     {
197         return createAnonymousWithParentRenderer(parent);
198     }
199     
200     virtual void paint(PaintInfo&, const LayoutPoint&) OVERRIDE;
201
202     virtual void reportMemoryUsage(MemoryObjectInfo*) const OVERRIDE;
203
204 protected:
205     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
206
207 private:
208     virtual RenderObjectChildList* virtualChildren() { return children(); }
209     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
210
211     virtual const char* renderName() const { return (isAnonymous() || isPseudoElement()) ? "RenderTableSection (anonymous)" : "RenderTableSection"; }
212
213     virtual bool isTableSection() const { return true; }
214
215     virtual void willBeRemovedFromTree() OVERRIDE;
216
217     virtual void layout();
218
219     virtual void paintCell(RenderTableCell*, PaintInfo&, const LayoutPoint&);
220     virtual void paintObject(PaintInfo&, const LayoutPoint&);
221
222     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0);
223
224     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) OVERRIDE;
225
226     void ensureRows(unsigned);
227
228     void distributeExtraLogicalHeightToPercentRows(int& extraLogicalHeight, int totalPercent);
229     void distributeExtraLogicalHeightToAutoRows(int& extraLogicalHeight, unsigned autoRowsCount);
230     void distributeRemainingExtraLogicalHeight(int& extraLogicalHeight);
231
232     bool hasOverflowingCell() const { return m_overflowingCells.size() || m_forceSlowPaintPathWithOverflowingCell; }
233
234     CellSpan fullTableRowSpan() const { return CellSpan(0, m_grid.size()); }
235     CellSpan fullTableColumnSpan() const { return CellSpan(0, table()->columns().size()); }
236
237     // Flip the rect so it aligns with the coordinates used by the rowPos and columnPos vectors.
238     LayoutRect logicalRectForWritingModeAndDirection(const LayoutRect&) const;
239
240     CellSpan dirtiedRows(const LayoutRect& repaintRect) const;
241     CellSpan dirtiedColumns(const LayoutRect& repaintRect) const;
242
243     // These two functions take a rectangle as input that has been flipped by logicalRectForWritingModeAndDirection.
244     // The returned span of rows or columns is end-exclusive, and empty if start==end.
245     CellSpan spannedRows(const LayoutRect& flippedRect) const;
246     CellSpan spannedColumns(const LayoutRect& flippedRect) const;
247
248     void setLogicalPositionForCell(RenderTableCell*, unsigned effectiveColumn) const;
249
250     RenderObjectChildList m_children;
251
252     Vector<RowStruct> m_grid;
253     Vector<int> m_rowPos;
254
255     // the current insertion position
256     unsigned m_cCol;
257     unsigned m_cRow;
258
259     int m_outerBorderStart;
260     int m_outerBorderEnd;
261     int m_outerBorderBefore;
262     int m_outerBorderAfter;
263
264     bool m_needsCellRecalc;
265
266     // This HashSet holds the overflowing cells for faster painting.
267     // If we have more than gMaxAllowedOverflowingCellRatio * total cells, it will be empty
268     // and m_forceSlowPaintPathWithOverflowingCell will be set to save memory.
269     HashSet<RenderTableCell*> m_overflowingCells;
270     bool m_forceSlowPaintPathWithOverflowingCell;
271
272     bool m_hasMultipleCellLevels;
273
274     // This map holds the collapsed border values for cells with collapsed borders.
275     // It is held at RenderTableSection level to spare memory consumption by table cells.
276     HashMap<pair<const RenderTableCell*, int>, CollapsedBorderValue > m_cellsCollapsedBorders;
277 };
278
279 inline RenderTableSection* toRenderTableSection(RenderObject* object)
280 {
281     ASSERT(!object || object->isTableSection());
282     return static_cast<RenderTableSection*>(object);
283 }
284
285 inline const RenderTableSection* toRenderTableSection(const RenderObject* object)
286 {
287     ASSERT(!object || object->isTableSection());
288     return static_cast<const RenderTableSection*>(object);
289 }
290
291 // This will catch anyone doing an unnecessary cast.
292 void toRenderTableSection(const RenderTableSection*);
293
294 } // namespace WebCore
295
296 #endif // RenderTableSection_h