File: LayoutTableSection.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (484 lines) | stat: -rw-r--r-- 17,429 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
/*
 * Copyright (C) 1997 Martin Jones (mjones@kde.org)
 *           (C) 1997 Torben Weis (weis@kde.org)
 *           (C) 1998 Waldo Bastian (bastian@kde.org)
 *           (C) 1999 Lars Knoll (knoll@kde.org)
 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
 * Copyright (C) 2003, 2004, 2005, 2006, 2009, 2013 Apple Inc. All rights
 * reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef LayoutTableSection_h
#define LayoutTableSection_h

#include "core/CoreExport.h"
#include "core/layout/LayoutTable.h"
#include "core/layout/LayoutTableBoxComponent.h"
#include "wtf/Vector.h"

namespace blink {

// This variable is used to balance the memory consumption vs the paint
// invalidation time on big tables.
const float gMaxAllowedOverflowingCellRatioForFastPaintPath = 0.1f;

// Helper class for paintObject.
class CellSpan {
  STACK_ALLOCATED();

 public:
  CellSpan(unsigned start, unsigned end) : m_start(start), m_end(end) {}

  unsigned start() const { return m_start; }
  unsigned end() const { return m_end; }

  void decreaseStart() { --m_start; }
  void increaseEnd() { ++m_end; }

  void ensureConsistency(const unsigned);

 private:
  unsigned m_start;
  unsigned m_end;
};

class LayoutTableCell;
class LayoutTableRow;

// LayoutTableSection is used to represent table row group (display:
// table-row-group), header group (display: table-header-group) and footer group
// (display: table-footer-group).
//
// The object holds the internal representation of the rows (m_grid). See
// recalcCells() below for some extra explanation.
//
// A lot of the complexity in this class is related to handling rowspan, colspan
// or just non-regular tables.
//
// Example of rowspan / colspan leading to overlapping cells (rowspan and
// colspan are overlapping):
// <table>
//   <tr>
//       <td>first row</td>
//       <td rowspan="2">rowspan</td>
//     </tr>
//    <tr>
//        <td colspan="2">colspan</td>
//     </tr>
// </table>
//
// Example of non-regular table (missing one cell in the first row):
// <!DOCTYPE html>
// <table>
//   <tr><td>First row only child.</td></tr>
//   <tr>
//     <td>Second row first child</td>
//     <td>Second row second child</td>
//   </tr>
// </table>
//
// LayoutTableSection is responsible for laying out LayoutTableRows and
// LayoutTableCells (see layoutRows()). However it is not their containing
// block, the enclosing LayoutTable (this object's parent()) is. This is why
// this class inherits from LayoutTableBoxComponent and not LayoutBlock.
class CORE_EXPORT LayoutTableSection final : public LayoutTableBoxComponent {
 public:
  explicit LayoutTableSection(Element*);
  ~LayoutTableSection() override;

  LayoutTableRow* firstRow() const;
  LayoutTableRow* lastRow() const;

  void addChild(LayoutObject* child,
                LayoutObject* beforeChild = nullptr) override;

  int firstLineBoxBaseline() const override;

  void addCell(LayoutTableCell*, LayoutTableRow*);

  int calcRowLogicalHeight();
  void layoutRows();
  void computeOverflowFromCells();
  bool recalcChildOverflowAfterStyleChange();

  void markAllCellsWidthsDirtyAndOrNeedsLayout(LayoutTable::WhatToMarkAllCells);

  LayoutTable* table() const { return toLayoutTable(parent()); }

  typedef Vector<LayoutTableCell*, 2> SpanningLayoutTableCells;

  // CellStruct represents the cells that occupy an (N, M) position in the
  // table grid.
  struct CellStruct {
    DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();

   public:
    // All the cells that fills this grid "slot".
    // Due to colspan / rowpsan, it is possible to have overlapping cells
    // (see class comment about an example).
    // This Vector is sorted in DOM order.
    Vector<LayoutTableCell*, 1> cells;
    bool inColSpan;  // true for columns after the first in a colspan

    CellStruct();
    ~CellStruct();

    // This is the cell in the grid "slot" that is on top of the others
    // (aka the last cell in DOM order for this slot).
    //
    // This is the cell originating from this slot if it exists.
    //
    // The concept of a primary cell is dubious at most as it doesn't
    // correspond to a DOM or rendering concept. Also callers should be
    // careful about assumptions about it. For example, even though the
    // primary cell is visibly the top most, it is not guaranteed to be
    // the only one visible for this slot due to different visual
    // overflow rectangles.
    LayoutTableCell* primaryCell() {
      return hasCells() ? cells[cells.size() - 1] : 0;
    }

    const LayoutTableCell* primaryCell() const {
      return hasCells() ? cells[cells.size() - 1] : 0;
    }

    bool hasCells() const { return cells.size() > 0; }
  };

  // The index is effective column index.
  typedef Vector<CellStruct> Row;

  struct RowStruct {
    DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();

   public:
    RowStruct() : rowLayoutObject(nullptr), baseline(-1) {}

    Row row;
    LayoutTableRow* rowLayoutObject;
    int baseline;
    Length logicalHeight;
  };

  struct SpanningRowsHeight {
    STACK_ALLOCATED();
    WTF_MAKE_NONCOPYABLE(SpanningRowsHeight);

   public:
    SpanningRowsHeight()
        : totalRowsHeight(0),
          spanningCellHeightIgnoringBorderSpacing(0),
          isAnyRowWithOnlySpanningCells(false) {}

    Vector<int> rowHeight;
    int totalRowsHeight;
    int spanningCellHeightIgnoringBorderSpacing;
    bool isAnyRowWithOnlySpanningCells;
  };

  const BorderValue& borderAdjoiningTableStart() const {
    if (hasSameDirectionAs(table()))
      return style()->borderStart();

    return style()->borderEnd();
  }

  const BorderValue& borderAdjoiningTableEnd() const {
    if (hasSameDirectionAs(table()))
      return style()->borderEnd();

    return style()->borderStart();
  }

  const BorderValue& borderAdjoiningStartCell(const LayoutTableCell*) const;
  const BorderValue& borderAdjoiningEndCell(const LayoutTableCell*) const;

  const LayoutTableCell* firstRowCellAdjoiningTableStart() const;
  const LayoutTableCell* firstRowCellAdjoiningTableEnd() const;

  CellStruct& cellAt(unsigned row, unsigned effectiveColumn) {
    return m_grid[row].row[effectiveColumn];
  }
  const CellStruct& cellAt(unsigned row, unsigned effectiveColumn) const {
    return m_grid[row].row[effectiveColumn];
  }
  LayoutTableCell* primaryCellAt(unsigned row, unsigned effectiveColumn) {
    if (effectiveColumn >= numCols(row))
      return nullptr;
    CellStruct& c = m_grid[row].row[effectiveColumn];
    return c.primaryCell();
  }
  const LayoutTableCell* primaryCellAt(unsigned row,
                                       unsigned effectiveColumn) const {
    return const_cast<LayoutTableSection*>(this)->primaryCellAt(
        row, effectiveColumn);
  }

  unsigned numCols(unsigned row) const { return m_grid[row].row.size(); }

  // Returns null for cells with a rowspan that exceed the last row. Possibly
  // others.
  LayoutTableRow* rowLayoutObjectAt(unsigned row) {
    return m_grid[row].rowLayoutObject;
  }
  const LayoutTableRow* rowLayoutObjectAt(unsigned row) const {
    return m_grid[row].rowLayoutObject;
  }

  void appendEffectiveColumn(unsigned pos);
  void splitEffectiveColumn(unsigned pos, unsigned first);

  enum BlockBorderSide { BorderBefore, BorderAfter };
  int calcBlockDirectionOuterBorder(BlockBorderSide) const;
  enum InlineBorderSide { BorderStart, BorderEnd };
  int calcInlineDirectionOuterBorder(InlineBorderSide) const;
  void recalcOuterBorder();

  int outerBorderBefore() const { return m_outerBorderBefore; }
  int outerBorderAfter() const { return m_outerBorderAfter; }
  int outerBorderStart() const { return m_outerBorderStart; }
  int outerBorderEnd() const { return m_outerBorderEnd; }

  unsigned numRows() const {
    DCHECK(!needsCellRecalc());
    return m_grid.size();
  }
  unsigned numEffectiveColumns() const;

  // recalcCells() is used when we are not sure about the section's structure
  // and want to do an expensive (but safe) reconstruction of m_grid from
  // scratch.
  // An example of this is inserting a new cell in the middle of an existing
  // row or removing a row.
  //
  // Accessing m_grid when m_needsCellRecalc is set is UNSAFE as pointers can
  // be left dangling. Thus care should be taken in the code to check
  // m_needsCellRecalc before accessing m_grid.
  void recalcCells();
  void recalcCellsIfNeeded() {
    if (m_needsCellRecalc)
      recalcCells();
  }

  bool needsCellRecalc() const { return m_needsCellRecalc; }
  void setNeedsCellRecalc();

  int rowBaseline(unsigned row) { return m_grid[row].baseline; }

  void rowLogicalHeightChanged(LayoutTableRow*);

  // distributeExtraLogicalHeightToRows methods return the *consumed* extra
  // logical height.
  // FIXME: We may want to introduce a structure holding the in-flux layout
  // information.
  int distributeExtraLogicalHeightToRows(int extraLogicalHeight);

  static LayoutTableSection* createAnonymousWithParent(const LayoutObject*);
  LayoutBox* createAnonymousBoxWithSameTypeAs(
      const LayoutObject* parent) const override {
    return createAnonymousWithParent(parent);
  }

  void paint(const PaintInfo&, const LayoutPoint&) const override;

  // Flip the rect so it aligns with the coordinates used by the rowPos and
  // columnPos vectors.
  LayoutRect logicalRectForWritingModeAndDirection(const LayoutRect&) const;

  CellSpan dirtiedRows(const LayoutRect& visualRect) const;
  CellSpan dirtiedEffectiveColumns(const LayoutRect& visualRect) const;
  const HashSet<LayoutTableCell*>& overflowingCells() const {
    return m_overflowingCells;
  }
  bool hasMultipleCellLevels() const { return m_hasMultipleCellLevels; }

  const char* name() const override { return "LayoutTableSection"; }

  // Whether a section has opaque background depends on many factors, e.g.
  // border spacing, border collapsing, missing cells, etc. For simplicity,
  // just conservatively assume all table sections are not opaque.
  bool foregroundIsKnownToBeOpaqueInRect(const LayoutRect&,
                                         unsigned) const override {
    return false;
  }
  bool backgroundIsKnownToBeOpaqueInRect(const LayoutRect&) const override {
    return false;
  }

  int paginationStrutForRow(LayoutTableRow*, LayoutUnit logicalOffset) const;

  bool mapToVisualRectInAncestorSpace(
      const LayoutBoxModelObject* ancestor,
      LayoutRect&,
      VisualRectFlags = DefaultVisualRectFlags) const override;

  bool isRepeatingHeaderGroup() const;

 protected:
  void styleDidChange(StyleDifference, const ComputedStyle* oldStyle) override;
  bool nodeAtPoint(HitTestResult&,
                   const HitTestLocation& locationInContainer,
                   const LayoutPoint& accumulatedOffset,
                   HitTestAction) override;

 private:
  bool isOfType(LayoutObjectType type) const override {
    return type == LayoutObjectTableSection || LayoutBox::isOfType(type);
  }

  void willBeRemovedFromTree() override;

  void layout() override;

  int borderSpacingForRow(unsigned row) const {
    return m_grid[row].rowLayoutObject ? table()->vBorderSpacing() : 0;
  }

  void ensureRows(unsigned numRows) {
    if (numRows > m_grid.size())
      m_grid.grow(numRows);
  }

  void ensureCols(unsigned rowIndex, unsigned numCols) {
    if (numCols > this->numCols(rowIndex))
      m_grid[rowIndex].row.grow(numCols);
  }

  bool rowHasOnlySpanningCells(unsigned);
  unsigned calcRowHeightHavingOnlySpanningCells(unsigned,
                                                int&,
                                                unsigned,
                                                unsigned&,
                                                Vector<int>&);
  void updateRowsHeightHavingOnlySpanningCells(LayoutTableCell*,
                                               struct SpanningRowsHeight&,
                                               unsigned&,
                                               Vector<int>&);

  void populateSpanningRowsHeightFromCell(LayoutTableCell*,
                                          struct SpanningRowsHeight&);
  void distributeExtraRowSpanHeightToPercentRows(LayoutTableCell*,
                                                 float,
                                                 int&,
                                                 Vector<int>&);
  void distributeWholeExtraRowSpanHeightToPercentRows(LayoutTableCell*,
                                                      float,
                                                      int&,
                                                      Vector<int>&);
  void distributeExtraRowSpanHeightToAutoRows(LayoutTableCell*,
                                              int,
                                              int&,
                                              Vector<int>&);
  void distributeExtraRowSpanHeightToRemainingRows(LayoutTableCell*,
                                                   int,
                                                   int&,
                                                   Vector<int>&);
  void distributeRowSpanHeightToRows(SpanningLayoutTableCells& rowSpanCells);

  void distributeExtraLogicalHeightToPercentRows(int& extraLogicalHeight,
                                                 int totalPercent);
  void distributeExtraLogicalHeightToAutoRows(int& extraLogicalHeight,
                                              unsigned autoRowsCount);
  void distributeRemainingExtraLogicalHeight(int& extraLogicalHeight);

  void updateBaselineForCell(LayoutTableCell*,
                             unsigned row,
                             int& baselineDescent);

  bool hasOverflowingCell() const {
    return m_overflowingCells.size() || m_forceSlowPaintPathWithOverflowingCell;
  }

  void computeOverflowFromCells(unsigned totalRows, unsigned nEffCols);

  CellSpan fullTableRowSpan() const { return CellSpan(0, m_grid.size()); }
  CellSpan fullTableEffectiveColumnSpan() const {
    return CellSpan(0, table()->numEffectiveColumns());
  }

  // These two functions take a rectangle as input that has been flipped by
  // logicalRectForWritingModeAndDirection.
  // The returned span of rows or columns is end-exclusive, and empty if
  // start==end.
  CellSpan spannedRows(const LayoutRect& flippedRect) const;
  CellSpan spannedEffectiveColumns(const LayoutRect& flippedRect) const;

  void setLogicalPositionForCell(LayoutTableCell*,
                                 unsigned effectiveColumn) const;

  void relayoutCellIfFlexed(LayoutTableCell&, int rowIndex, int rowHeight);

  int logicalHeightForRow(const LayoutTableRow&) const;

  // Honor breaking restrictions inside the table row, and adjust position and
  // size accordingly.
  void adjustRowForPagination(LayoutTableRow&, SubtreeLayoutScope&);

  // The representation of the rows and their cells (CellStruct).
  Vector<RowStruct> m_grid;

  // The logical offset of each row from the top of the section.
  //
  // Note that this Vector has one more entry than the number of rows so that
  // we can keep track of the final size of the section. That is,
  // m_rowPos[m_grid.size()] is a valid entry.
  //
  // To know a row's height at |rowIndex|, use the formula:
  // m_rowPos[rowIndex + 1] - m_rowPos[rowIndex]
  Vector<int> m_rowPos;

  // The current insertion position in the grid.
  // The position is used when inserting a new cell into the section to
  // know where it should be inserted and expand our internal structure.
  //
  // The reason for them is that we process cells as we discover them
  // during parsing or during recalcCells (ie in DOM order). This means
  // that we can discover changes in the structure later (e.g. due to
  // colspans, extra cells, ...).
  //
  // Do not use outside of recalcCells and addChild.
  unsigned m_cCol;
  unsigned m_cRow;

  int m_outerBorderStart;
  int m_outerBorderEnd;
  int m_outerBorderBefore;
  int m_outerBorderAfter;

  bool m_needsCellRecalc;

  // This HashSet holds the overflowing cells for faster painting.
  // If we have more than gMaxAllowedOverflowingCellRatio * total cells, it will
  // be empty and m_forceSlowPaintPathWithOverflowingCell will be set to save
  // memory.
  HashSet<LayoutTableCell*> m_overflowingCells;
  bool m_forceSlowPaintPathWithOverflowingCell;

  // This boolean tracks if we have cells overlapping due to rowspan / colspan
  // (see class comment above about when it could appear).
  //
  // The use is to disable a painting optimization where we just paint the
  // invalidated cells.
  bool m_hasMultipleCellLevels;
};

DEFINE_LAYOUT_OBJECT_TYPE_CASTS(LayoutTableSection, isTableSection());

}  // namespace blink

#endif  // LayoutTableSection_h