compareBorders() is called too often during painting
[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 class RenderTableCell;
41 class RenderTableRow;
42
43 class RenderTableSection : public RenderBox {
44 public:
45     RenderTableSection(Node*);
46     virtual ~RenderTableSection();
47
48     const RenderObjectChildList* children() const { return &m_children; }
49     RenderObjectChildList* children() { return &m_children; }
50
51     virtual void addChild(RenderObject* child, RenderObject* beforeChild = 0);
52
53     virtual LayoutUnit firstLineBoxBaseline() const;
54
55     void addCell(RenderTableCell*, RenderTableRow* row);
56
57     void setCellLogicalWidths();
58     LayoutUnit calcRowLogicalHeight();
59     LayoutUnit layoutRows(LayoutUnit logicalHeight);
60
61     RenderTable* table() const { return toRenderTable(parent()); }
62
63     struct CellStruct {
64         Vector<RenderTableCell*, 1> cells; 
65         bool inColSpan; // true for columns after the first in a colspan
66
67         CellStruct()
68             : inColSpan(false)
69         {
70         }
71
72         RenderTableCell* primaryCell()
73         {
74             return hasCells() ? cells[cells.size() - 1] : 0;
75         }
76
77         const RenderTableCell* primaryCell() const
78         {
79             return hasCells() ? cells[cells.size() - 1] : 0;
80         }
81
82         bool hasCells() const { return cells.size() > 0; }
83     };
84
85     typedef Vector<CellStruct> Row;
86
87     struct RowStruct {
88         RowStruct()
89             : rowRenderer(0)
90             , baseline(0)
91         {
92         }
93
94         Row row;
95         RenderTableRow* rowRenderer;
96         LayoutUnit baseline;
97         Length logicalHeight;
98     };
99
100     CellStruct& cellAt(unsigned row,  unsigned col) { return m_grid[row].row[col]; }
101     const CellStruct& cellAt(unsigned row, unsigned col) const { return m_grid[row].row[col]; }
102     RenderTableCell* primaryCellAt(unsigned row, unsigned col)
103     {
104         CellStruct& c = m_grid[row].row[col];
105         return c.primaryCell();
106     }
107
108     void appendColumn(unsigned pos);
109     void splitColumn(unsigned pos, unsigned first);
110
111     LayoutUnit calcOuterBorderBefore() const;
112     LayoutUnit calcOuterBorderAfter() const;
113     LayoutUnit calcOuterBorderStart() const;
114     LayoutUnit calcOuterBorderEnd() const;
115     void recalcOuterBorder();
116
117     LayoutUnit outerBorderBefore() const { return m_outerBorderBefore; }
118     LayoutUnit outerBorderAfter() const { return m_outerBorderAfter; }
119     LayoutUnit outerBorderStart() const { return m_outerBorderStart; }
120     LayoutUnit outerBorderEnd() const { return m_outerBorderEnd; }
121
122     unsigned numRows() const { return m_grid.size(); }
123     unsigned numColumns() const;
124     void recalcCells();
125     void recalcCellsIfNeeded()
126     {
127         if (m_needsCellRecalc)
128             recalcCells();
129     }
130
131     bool needsCellRecalc() const { return m_needsCellRecalc; }
132     void setNeedsCellRecalc();
133
134     LayoutUnit getBaseline(unsigned row) { return m_grid[row].baseline; }
135
136     void rowLogicalHeightChanged(unsigned rowIndex);
137
138     unsigned rowIndexForRenderer(const RenderTableRow*) const;
139
140     void removeCachedCollapsedBorders(const RenderTableCell*);
141     void setCachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide, CollapsedBorderValue);
142     CollapsedBorderValue& cachedCollapsedBorder(const RenderTableCell*, CollapsedBorderSide);
143
144 protected:
145     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
146
147 private:
148     virtual RenderObjectChildList* virtualChildren() { return children(); }
149     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
150
151     virtual const char* renderName() const { return isAnonymous() ? "RenderTableSection (anonymous)" : "RenderTableSection"; }
152
153     virtual bool isTableSection() const { return true; }
154
155     virtual void willBeDestroyed();
156
157     virtual void layout();
158
159     virtual void removeChild(RenderObject* oldChild);
160
161     virtual void paint(PaintInfo&, const LayoutPoint&);
162     virtual void paintCell(RenderTableCell*, PaintInfo&, const LayoutPoint&);
163     virtual void paintObject(PaintInfo&, const LayoutPoint&);
164
165     virtual void imageChanged(WrappedImagePtr, const IntRect* = 0);
166
167     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
168
169     void ensureRows(unsigned);
170
171     bool hasOverflowingCell() const { return m_overflowingCells.size() || m_forceSlowPaintPathWithOverflowingCell; }
172
173     RenderObjectChildList m_children;
174
175     Vector<RowStruct> m_grid;
176     Vector<LayoutUnit> m_rowPos;
177
178     // the current insertion position
179     unsigned m_cCol;
180     unsigned m_cRow;
181
182     LayoutUnit m_outerBorderStart;
183     LayoutUnit m_outerBorderEnd;
184     LayoutUnit m_outerBorderBefore;
185     LayoutUnit m_outerBorderAfter;
186
187     bool m_needsCellRecalc;
188
189     // This HashSet holds the overflowing cells for faster painting.
190     // If we have more than gMaxAllowedOverflowingCellRatio * total cells, it will be empty
191     // and m_forceSlowPaintPathWithOverflowingCell will be set to save memory.
192     HashSet<RenderTableCell*> m_overflowingCells;
193     bool m_forceSlowPaintPathWithOverflowingCell;
194
195     bool m_hasMultipleCellLevels;
196
197     // This map holds the collapsed border values for cells with collapsed borders.
198     // It is held at RenderTableSection level to spare memory consumption by table cells.
199     HashMap<pair<const RenderTableCell*, int>, CollapsedBorderValue > m_cellsCollapsedBorders;
200 };
201
202 inline RenderTableSection* toRenderTableSection(RenderObject* object)
203 {
204     ASSERT(!object || object->isTableSection());
205     return static_cast<RenderTableSection*>(object);
206 }
207
208 inline const RenderTableSection* toRenderTableSection(const RenderObject* object)
209 {
210     ASSERT(!object || object->isTableSection());
211     return static_cast<const RenderTableSection*>(object);
212 }
213
214 // This will catch anyone doing an unnecessary cast.
215 void toRenderTableSection(const RenderTableSection*);
216
217 } // namespace WebCore
218
219 #endif // RenderTableSection_h