Cleanup RenderTable*::createAnonymous*
[WebKit-https.git] / Source / WebCore / rendering / RenderTableCell.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, 2007, 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 RenderTableCell_h
26 #define RenderTableCell_h
27
28 #include "RenderBlockFlow.h"
29 #include "RenderTableRow.h"
30 #include "RenderTableSection.h"
31
32 namespace WebCore {
33
34 // These is limited by the size of RenderTableCell::m_column bitfield.
35 static const unsigned unsetColumnIndex = 0x1FFFFFF;
36 static const unsigned maxColumnIndex = 0x1FFFFFE; // 33554430
37
38 enum IncludeBorderColorOrNot { DoNotIncludeBorderColor, IncludeBorderColor };
39
40 class RenderTableCell final : public RenderBlockFlow {
41 public:
42     RenderTableCell(Element&, RenderStyle&&);
43     RenderTableCell(Document&, RenderStyle&&);
44     
45     unsigned colSpan() const;
46     unsigned rowSpan() const;
47
48     // Called from HTMLTableCellElement.
49     void colSpanOrRowSpanChanged();
50
51     void setCol(unsigned column);
52     unsigned col() const;
53
54     RenderTableCell* nextCell() const;
55     RenderTableCell* previousCell() const;
56
57     RenderTableRow* row() const { return downcast<RenderTableRow>(parent()); }
58     RenderTableSection* section() const;
59     RenderTable* table() const;
60     unsigned rowIndex() const;
61     Length styleOrColLogicalWidth() const;
62     LayoutUnit logicalHeightForRowSizing() const;
63
64     void setCellLogicalWidth(LayoutUnit constrainedLogicalWidth);
65
66     LayoutUnit borderLeft() const override;
67     LayoutUnit borderRight() const override;
68     LayoutUnit borderTop() const override;
69     LayoutUnit borderBottom() const override;
70     LayoutUnit borderStart() const override;
71     LayoutUnit borderEnd() const override;
72     LayoutUnit borderBefore() const override;
73     LayoutUnit borderAfter() const override;
74
75     void collectBorderValues(RenderTable::CollapsedBorderValues&) const;
76     static void sortBorderValues(RenderTable::CollapsedBorderValues&);
77
78     void layout() override;
79
80     void paint(PaintInfo&, const LayoutPoint&) override;
81
82     void paintCollapsedBorders(PaintInfo&, const LayoutPoint&);
83     void paintBackgroundsBehindCell(PaintInfo&, const LayoutPoint&, RenderElement* backgroundObject);
84
85     LayoutUnit cellBaselinePosition() const;
86     bool isBaselineAligned() const;
87
88     void computeIntrinsicPadding(LayoutUnit rowHeight);
89     void clearIntrinsicPadding() { setIntrinsicPadding(0, 0); }
90
91     LayoutUnit intrinsicPaddingBefore() const { return m_intrinsicPaddingBefore; }
92     LayoutUnit intrinsicPaddingAfter() const { return m_intrinsicPaddingAfter; }
93
94     LayoutUnit paddingTop() const override;
95     LayoutUnit paddingBottom() const override;
96     LayoutUnit paddingLeft() const override;
97     LayoutUnit paddingRight() const override;
98     
99     // FIXME: For now we just assume the cell has the same block flow direction as the table. It's likely we'll
100     // create an extra anonymous RenderBlock to handle mixing directionality anyway, in which case we can lock
101     // the block flow directionality of the cells to the table's directionality.
102     LayoutUnit paddingBefore() const override;
103     LayoutUnit paddingAfter() const override;
104
105     void setOverrideLogicalContentHeightFromRowHeight(LayoutUnit);
106
107     void scrollbarsChanged(bool horizontalScrollbarChanged, bool verticalScrollbarChanged) override;
108
109     bool cellWidthChanged() const { return m_cellWidthChanged; }
110     void setCellWidthChanged(bool b = true) { m_cellWidthChanged = b; }
111
112     static std::unique_ptr<RenderTableCell> createAnonymousWithParentRenderer(const RenderTableRow&);
113     std::unique_ptr<RenderBox> createAnonymousBoxWithSameTypeAs(const RenderBox&) const override;
114
115     // This function is used to unify which table part's style we use for computing direction and
116     // writing mode. Writing modes are not allowed on row group and row but direction is.
117     // This means we can safely use the same style in all cases to simplify our code.
118     // FIXME: Eventually this function should replaced by style() once we support direction
119     // on all table parts and writing-mode on cells.
120     const RenderStyle& styleForCellFlow() const { return row()->style(); }
121
122     const BorderValue& borderAdjoiningTableStart() const;
123     const BorderValue& borderAdjoiningTableEnd() const;
124     const BorderValue& borderAdjoiningCellBefore(const RenderTableCell&);
125     const BorderValue& borderAdjoiningCellAfter(const RenderTableCell&);
126
127     using RenderBlockFlow::nodeAtPoint;
128 #ifndef NDEBUG
129     bool isFirstOrLastCellInRow() const { return !table()->cellAfter(this) || !table()->cellBefore(this); }
130 #endif
131     
132     LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override;
133
134     void invalidateHasEmptyCollapsedBorders();
135     void setHasEmptyCollapsedBorder(CollapsedBorderSide, bool empty) const;
136
137 protected:
138     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
139     void computePreferredLogicalWidths() override;
140
141 private:
142     static std::unique_ptr<RenderTableCell> createTableCellWithStyle(Document&, const RenderStyle&);
143
144     const char* renderName() const override { return (isAnonymous() || isPseudoElement()) ? "RenderTableCell (anonymous)" : "RenderTableCell"; }
145
146     bool isTableCell() const override { return true; }
147
148     void willBeRemovedFromTree() override;
149
150     void updateLogicalWidth() override;
151
152     void paintBoxDecorations(PaintInfo&, const LayoutPoint&) override;
153     void paintMask(PaintInfo&, const LayoutPoint&) override;
154
155     bool boxShadowShouldBeAppliedToBackground(const LayoutPoint& paintOffset, BackgroundBleedAvoidance, InlineFlowBox*) const override;
156
157     LayoutSize offsetFromContainer(RenderElement&, const LayoutPoint&, bool* offsetDependsOnPoint = 0) const override;
158     LayoutRect computeRectForRepaint(const LayoutRect&, const RenderLayerModelObject* repaintContainer, RepaintContext = { }) const override;
159
160     LayoutUnit borderHalfLeft(bool outer) const;
161     LayoutUnit borderHalfRight(bool outer) const;
162     LayoutUnit borderHalfTop(bool outer) const;
163     LayoutUnit borderHalfBottom(bool outer) const;
164
165     LayoutUnit borderHalfStart(bool outer) const;
166     LayoutUnit borderHalfEnd(bool outer) const;
167     LayoutUnit borderHalfBefore(bool outer) const;
168     LayoutUnit borderHalfAfter(bool outer) const;
169
170     void setIntrinsicPaddingBefore(LayoutUnit p) { m_intrinsicPaddingBefore = p; }
171     void setIntrinsicPaddingAfter(LayoutUnit p) { m_intrinsicPaddingAfter = p; }
172     void setIntrinsicPadding(LayoutUnit before, LayoutUnit after) { setIntrinsicPaddingBefore(before); setIntrinsicPaddingAfter(after); }
173
174     bool hasStartBorderAdjoiningTable() const;
175     bool hasEndBorderAdjoiningTable() const;
176
177     CollapsedBorderValue collapsedStartBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
178     CollapsedBorderValue collapsedEndBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
179     CollapsedBorderValue collapsedBeforeBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
180     CollapsedBorderValue collapsedAfterBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
181
182     CollapsedBorderValue cachedCollapsedLeftBorder(const RenderStyle&) const;
183     CollapsedBorderValue cachedCollapsedRightBorder(const RenderStyle&) const;
184     CollapsedBorderValue cachedCollapsedTopBorder(const RenderStyle&) const;
185     CollapsedBorderValue cachedCollapsedBottomBorder(const RenderStyle&) const;
186
187     CollapsedBorderValue computeCollapsedStartBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
188     CollapsedBorderValue computeCollapsedEndBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
189     CollapsedBorderValue computeCollapsedBeforeBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
190     CollapsedBorderValue computeCollapsedAfterBorder(IncludeBorderColorOrNot = IncludeBorderColor) const;
191
192     Length logicalWidthFromColumns(RenderTableCol* firstColForThisCell, Length widthFromStyle) const;
193
194     void updateColAndRowSpanFlags();
195
196     unsigned parseRowSpanFromDOM() const;
197     unsigned parseColSpanFromDOM() const;
198
199     void nextSibling() const = delete;
200     void previousSibling() const = delete;
201
202     // Note MSVC will only pack members if they have identical types, hence we use unsigned instead of bool here.
203     unsigned m_column : 25;
204     unsigned m_cellWidthChanged : 1;
205     unsigned m_hasColSpan: 1;
206     unsigned m_hasRowSpan: 1;
207     mutable unsigned m_hasEmptyCollapsedBeforeBorder: 1;
208     mutable unsigned m_hasEmptyCollapsedAfterBorder: 1;
209     mutable unsigned m_hasEmptyCollapsedStartBorder: 1;
210     mutable unsigned m_hasEmptyCollapsedEndBorder: 1;
211     LayoutUnit m_intrinsicPaddingBefore { 0 };
212     LayoutUnit m_intrinsicPaddingAfter { 0 };
213 };
214
215 inline RenderTableCell* RenderTableCell::nextCell() const
216 {
217     return downcast<RenderTableCell>(RenderBlockFlow::nextSibling());
218 }
219
220 inline RenderTableCell* RenderTableCell::previousCell() const
221 {
222     return downcast<RenderTableCell>(RenderBlockFlow::previousSibling());
223 }
224
225 inline unsigned RenderTableCell::colSpan() const
226 {
227     if (!m_hasColSpan)
228         return 1;
229     return parseColSpanFromDOM();
230 }
231
232 inline unsigned RenderTableCell::rowSpan() const
233 {
234     if (!m_hasRowSpan)
235         return 1;
236     return parseRowSpanFromDOM();
237 }
238
239 inline void RenderTableCell::setCol(unsigned column)
240 {
241     if (UNLIKELY(column > maxColumnIndex))
242         column = maxColumnIndex;
243     m_column = column;
244 }
245
246 inline unsigned RenderTableCell::col() const
247 {
248     ASSERT(m_column != unsetColumnIndex);
249     return m_column;
250 }
251
252 inline RenderTableSection* RenderTableCell::section() const
253 {
254     RenderTableRow* row = this->row();
255     if (!row)
256         return nullptr;
257     return downcast<RenderTableSection>(row->parent());
258 }
259
260 inline RenderTable* RenderTableCell::table() const
261 {
262     RenderTableSection* section = this->section();
263     if (!section)
264         return nullptr;
265     return downcast<RenderTable>(section->parent());
266 }
267
268 inline unsigned RenderTableCell::rowIndex() const
269 {
270     // This function shouldn't be called on a detached cell.
271     ASSERT(row());
272     return row()->rowIndex();
273 }
274
275 inline Length RenderTableCell::styleOrColLogicalWidth() const
276 {
277     Length styleWidth = style().logicalWidth();
278     if (!styleWidth.isAuto())
279         return styleWidth;
280     if (RenderTableCol* firstColumn = table()->colElement(col()))
281         return logicalWidthFromColumns(firstColumn, styleWidth);
282     return styleWidth;
283 }
284
285 inline LayoutUnit RenderTableCell::logicalHeightForRowSizing() const
286 {
287     // FIXME: This function does too much work, and is very hot during table layout!
288     LayoutUnit adjustedLogicalHeight = logicalHeight() - (intrinsicPaddingBefore() + intrinsicPaddingAfter());
289     LayoutUnit styleLogicalHeight = valueForLength(style().logicalHeight(), 0);
290     // In strict mode, box-sizing: content-box do the right thing and actually add in the border and padding.
291     // Call computedCSSPadding* directly to avoid including implicitPadding.
292     if (!document().inQuirksMode() && style().boxSizing() != BORDER_BOX)
293         styleLogicalHeight += computedCSSPaddingBefore() + computedCSSPaddingAfter() + borderBefore() + borderAfter();
294     return std::max(styleLogicalHeight, adjustedLogicalHeight);
295 }
296
297 inline bool RenderTableCell::isBaselineAligned() const
298 {
299     EVerticalAlign va = style().verticalAlign();
300     return va == BASELINE || va == TEXT_BOTTOM || va == TEXT_TOP || va == SUPER || va == SUB || va == LENGTH;
301 }
302
303 inline const BorderValue& RenderTableCell::borderAdjoiningTableStart() const
304 {
305     ASSERT(isFirstOrLastCellInRow());
306     if (isDirectionSame(section(), table()))
307         return style().borderStart();
308
309     return style().borderEnd();
310 }
311
312 inline const BorderValue& RenderTableCell::borderAdjoiningTableEnd() const
313 {
314     ASSERT(isFirstOrLastCellInRow());
315     if (isDirectionSame(section(), table()))
316         return style().borderEnd();
317
318     return style().borderStart();
319 }
320
321 inline const BorderValue& RenderTableCell::borderAdjoiningCellBefore(const RenderTableCell& cell)
322 {
323     ASSERT_UNUSED(cell, table()->cellAfter(&cell) == this);
324     // FIXME: https://webkit.org/b/79272 - Add support for mixed directionality at the cell level.
325     return style().borderStart();
326 }
327
328 inline const BorderValue& RenderTableCell::borderAdjoiningCellAfter(const RenderTableCell& cell)
329 {
330     ASSERT_UNUSED(cell, table()->cellBefore(&cell) == this);
331     // FIXME: https://webkit.org/b/79272 - Add support for mixed directionality at the cell level.
332     return style().borderEnd();
333 }
334
335 inline RenderTableCell* RenderTableRow::firstCell() const
336 {
337     return downcast<RenderTableCell>(RenderBox::firstChild());
338 }
339
340 inline RenderTableCell* RenderTableRow::lastCell() const
341 {
342     return downcast<RenderTableCell>(RenderBox::lastChild());
343 }
344
345 inline void RenderTableCell::setHasEmptyCollapsedBorder(CollapsedBorderSide side, bool empty) const
346 {
347     switch (side) {
348     case CBSAfter: {
349         m_hasEmptyCollapsedAfterBorder = empty;
350         break;
351     }
352     case CBSBefore: {
353         m_hasEmptyCollapsedBeforeBorder = empty;
354         break;
355     }
356     case CBSStart: {
357         m_hasEmptyCollapsedStartBorder = empty;
358         break;
359     }
360     case CBSEnd: {
361         m_hasEmptyCollapsedEndBorder = empty;
362         break;
363     }
364     }
365     if (empty)
366         table()->collapsedEmptyBorderIsPresent();
367 }
368
369 inline void RenderTableCell::invalidateHasEmptyCollapsedBorders()
370 {
371     m_hasEmptyCollapsedBeforeBorder = false;
372     m_hasEmptyCollapsedAfterBorder = false;
373     m_hasEmptyCollapsedStartBorder = false;
374     m_hasEmptyCollapsedEndBorder = false;
375 }
376
377 inline std::unique_ptr<RenderBox> RenderTableCell::createAnonymousBoxWithSameTypeAs(const RenderBox& renderer) const
378 {
379     return RenderTableCell::createTableCellWithStyle(renderer.document(), renderer.style());
380 }
381
382 } // namespace WebCore
383
384 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderTableCell, isTableCell())
385
386 #endif // RenderTableCell_h