# Table Reflow Internals
Tech Talk

Aug 5, 2002

Chris Karnaze

# Overview

- Review of reflow
- Table frames
- Table reflow
- Intro to paginated reflow
- Table paginated reflow

# Review of Reflow

- Reflow process starts when
  - An html document starts loading (the frame tree contains only viewport, scroll(s), canvas, html, body).
  - The initial chunk of an xml doc is loaded.
  - The initial chunk of an html doc (or a subsequent chunk of an xml doc) is loaded. The container posts a dirty reflow command with itself as the target.
  - Content is inserted, appended, or deleted through the DOM. The container posts a dirty reflow command with itself as the target.
  - Style changes through the DOM - javascript, browser change font (CTRL+/-), a preference changes, etc.

# Review of Reflow

- Reflow starts with pres shell
  - Which reflows the reflow root (usually the view port frame),
  - Which reflows it children, etc.
- Ususally it starts when the pres shell processes its queue of reflow commands.
- The reflower
  - Positions reflowee (if it can) before actually reflowing in case views are involved (e.g. absolutely positioned elements)
  - Reflows reflowee and passes a reflow state (in) and a reflow metrics (in/out)

# Review of Reflow

- The reflow state:
  - Is a node in a tree structurally equivalent to the frame tree of reflow participants
  - contains:
    - reflow type,
    - avail size,
    - various computed values,
    - resolved style structs
    - possible request for preferred size and more.

# Review of Reflow

- the reflow metrics contains:
  - max element size (if requested) - the minimum size it can be
  - preferred size (if requested) - the size it would like to be given no size constraints.
  - desired size - the size it would like to be given the avail size. This is equivalent to preferred size if the avail size is not constrained.

# Review of Reflow

- The reflowee sets various sizes in the reflow metrics after (possibly) reflowing some or all of its children which reflows it children, etc.
- The reflowee returns a reflow status which indicates
  - if it is complete, and thus not have to continue (split)
  - breaking status (in the case of some inline frames)
  - if there is truncation (it can't fit in the space and can't split). This is just a convience mechanism.

# Kinds of reflows

- Initial - reflowee's first reflow must be of this type (reflower's responsibility).
- Resize - reflowee gets a change in available space only. Similar to initial, except it can reoccur.
- Incremental - has a reflow path (tree) where each node has a command with a target frame,
  reflow command types are:

- dirty - something changed inside a target (e.g. it gains, loses children)
- style changed - a target changed stylisticly (recall, size is a style property)
- content changed - a target's content changed (e.g. a text run)
- user defined - currently only used for fixed positioned frames

# Kinds of reflows

- Incremental reflow (continued)
  - reflower not allowed to change available size of reflowee
  - reflow commands get coalesced to streamline processing
- Style change
  - a target changed stylistic if there is a target, otherwise every frame may need to respond
  - parent of target usually turns it into an incremental reflow with a style changed command type

# Table Frames

|  |  |  | nsTableOuter Frame |  |
|  |  | ↙ |  | ↘
|  | nsTable Frame |  |  |  | nsTableCaption Frame
| ↙ |  | ↘ |  |  | ↓
nsTableCol GroupFrame |  |  |  | nsTableRow GroupFrame |  | nsBlockFrame
↓ |  |  |  | ↓
nsTableCol Frame |  |  |  | nsTableRow Frame
|  |  |  | ↓
|  |  |  | nsTableCell Frame
|  |  |  | ↓
|  |  |  | nsBlock Frame

# Table Reflow

- Outer table reflows table and caption (if present)
- Table reflows row groups in multiple passes

- Pass 1 - unconstrained width, height and requests max elem width.
- The table figures out the column widths (balances) given the style width constraints on the table, col groups, cols, cells the preferred and max element sizes of the cells (from the pass 1 reflow), and considers colspans
- Pass 2 - cell widths are constrained by the column widths (heights are only constrained in paginated mode).

# Table Reflow

- Table reflows row groups (continued)

- The row group figures out the row heights given the its style height constraints its rows and cells and the actual heights of its rows and cells from the pass 2 reflow
- If the table has a style height, it allocates extra height to its row groups, rows and cells.

- In each pass, row groups reflow rows which reflow cells which reflow cell blocks

# Table Reflow Example

    tblO 030176CC r=0 a=8940,UC c=0,0 cnt=429
      tbl 030178C4 r=0 a=8940,UC c=4470,UC cnt=430
       rowG 03017A7C r=0 a=UC,UC c=UC,UC cnt=431
        row 03017C08 r=0 a=UC,UC c=UC,UC cnt=432
         cell 03017DA8 r=0 a=UC,UC c=UC,UC cnt=433
          block 03017E08 r=0 a=UC,UC c=UC,UC cnt=434
          block 03017E08 d=870,300 me=480
         cell 03017DA8 d=930,360 me=540
         cell 0301A8CC r=0 a=UC,UC c=UC,UC cnt=436
          block 0301A92C r=0 a=UC,UC c=UC,UC cnt=437
          block 0301A92C d=1335,300 me=465
         cell 0301A8CC d=1395,360 me=525
        row 03017C08 d=UC,360
       rowG 03017A7C d=UC,360
       rowG 03017A7C r=2 a=4470,UC c=4470,UC cnt=442
        row 03017C08 r=2 a=4470,UC c=4470,UC cnt=443
         cell 03017DA8 r=2 a=1755,UC c=1695,UC cnt=444
          block 03017E08 r=2 a=1695,UC c=1695,UC cnt=445
          block 03017E08 d=1695,300
         cell 03017DA8 d=1755,360
         cell 0301A8CC r=2 a=2625,UC c=2565,UC cnt=446
          block 0301A92C r=2 a=2565,UC c=2565,UC cnt=447
          block 0301A92C d=2565,300
         cell 0301A8CC d=2625,360
        row 03017C08 d=4470,360
       rowG 03017A7C d=4470,360
      tbl 030178C4 d=4500,450
     tblO 030176CC d=4500,450

     frame reflow debugging gives instructions
     for turning this on.

    <table width=300>
      <tr>
        <td>foo</td>
        <td>bar zap</td>
      </tr>
    </table>

    Key:

      r  = reflow reason,
           0 (initial),
           2 (resize)
      a  = avail w, h
      c  = computed w, h
      d  = desired w, h
      me = max elem w

# Table reflow optimizations

- If the table is already balanced, pass 1 constrains the width (like a normal pass 2) based on the current column widths. The pass 2 will get skipped if the table doesn't need to rebalance.
- Nested table reflowed with an unconstrained width (i.e. an ancestor is doing a pass 1 reflow) will only do a pass 1 reflow on its children
- Outer table caches last avail width and avoids reflowing children if resize reflow is the same as previous
- Table caches max element, preferred widths in case they are requested and it isn't rebalanced
- Cell caches prior avail width. if this doesn't change, the row may not have to reflow the cell

# Table incremental reflow

- Outer table is a target when a caption is added or removed (dirty) or the table or caption margin changes (style changed).
- Caption is a target when it changes stylistically (style changed).
- Table, row group, row, col group, col is a target when a child is added or removed (dirty) or it changes stylistically (style changed).
- In the dirty cases, a target posted the reflow command in AppendFrames, InsertFrames, or DeleteFrame.

# Table incremental reflow

- In the style change cases where a target is between the table and the cell, the table is told to rebalance.
- When a target is the cell or below and the cell changes size, the row tells the table so it can decide if it needs to rebalance
- When a target is inside the cell's block, the cell requests max element, preferred sizes of its block in case they change
- After the table reflows the row group(s) containing the targets, if it rebalances, it then does a pass 2 reflow.

# Special height reflow

- When there is a % height frame inside a cell without a computed height

- the frame will never get a chance to size based on the final cell height
- in paginated mode when there is a height on the table, the table doesn't allocate extra height to rows until after it does a pass 2 reflow and then it is too late

- This can be fixed by doing a special 3rd pass reflow

# Special Reflow Example

    <table border=2 width=300>
      <tr>
        <td>
          This cell's width is
          constrained by the
          table and image widths.
          Its exact height is
          hard to determine.
        </td>
        <td>
          <img src=raptor.jpg
           width=200 height=100%>
        </td>
      </tr>
    </table>

This cell's width is constrained by the table and image widths. Its height is hard to determine. The image needs to be as high as the cell. |

# Special height reflow

- The reflow state holds an observer and initiator
- Observer

- is the table cell used as the height basis
- set by frame without computed height in DidReflow
- gives its block a computed height during 3rd pass
- doesn't change height during 3rd pass

- Initiator

- is the table containing the observer
- starts the 3rd pass reflow and sets a bit in the reflow state
- gives its block a computed height during 3rd pass
- could also be inside a cell which is an observer

# Special height reflow

- Optimizations

- only frames needing 3rd pass actually get it
- frames gettting a 3rd pass only get it once

# Intro to paginated reflow

- When a reflowee's available height is constrained, it may not fit and need to either split/continue on the next page, or start on the next page.

- If it can continue, it returns an incomplete status.
- If it can't continue it returns a complete status.

- A continuation may also need to be continued
- Continuations are linked together by prevInFlow and nextInFlow pointers

# Pagination Illustration

nsSimplePageSequence

nsPageFrame

nsPageContentFrame

areaFrame (html)

blockFrame (body)

nsTableOuterFrame

nsTableOuterFrame

blockFrame (body)

areaFrame (html)

nsPageContentFrame continued

nsPageFrame continued

# Intro to paginated reflow

- The page sequence starts with one page and reflows it. If the page is incomplete then the page sequence creates a continuation for the page and sets it as the page's next sibling (it is also the page's nextInFlow).
- The page was incomplete because the page content was incomplete because the doc root was incomplete
- The doc root was incomplete because it contained lines that didn't fit (or if it was mapped to a table, because the table didn't fit) becacause a line contained something that didn't fit, etc.

# Intro to paginated reflow

- If the reflowee is incomplete, the reflower has the responsiblity to:
  - Create a continuation for the reflowee
  - Ensure that the continuation gets put in the frame hierarchy at the right place and gets reflowed at the right time.
  - Typically, a reflower accomplishes this by putting the continuation (c) on an overflow list which the reflower owns. When the reflower's continuation gets reflowed, it takes c and its siblings as children and reflows them.
- If the reflowee is complete, truncated (it didn't fit), not at the top of page, the reflower should put the reflowee on its overflow list and return an incomplete status.

# Intro to paginated reflow

- Special assumptions
  - There are only initial and (possibly) resize reflows. Incremental and style change reflows are not allowed.
  - Multiple resize reflows may be necessary (e.g. a child is truncated and gets reflowed on a subsequent page) but they should not change the available width from the last time.
  - Multiple resize reflows may require special handling if a frame split previously. It may need to "pull up" children from a continuation.

# Table paginated reflow

- The block containing the outer table reflows it. If it is incomplete, the block will
  - create a continuation for the outer table (which also creates a continuation for the table).
  - put the continuation on a new line and place that line on its overflow lines property.
- The outer table reflows the table and just returns the status of the table.
- The table does a pass 1 reflow and balances. If it is incomplete,

- it will become the first-in-flow
- it will be the only frame among its continuations to ever balance or calc the cell map, and it only does this once

# Table paginated reflow

- The table does a pass 2 reflow constraining both avail heights and widths. If a row group is incomplete, the table
  - creates a continuation for the row group
  - puts the continuation in its overflow frames property
- What follows only applies during the pass 2 reflow.
- The row group

- reflows all of its rows with unconstrained heights and calculates the row heights,
- figures out which row falls on a page boundary and reflows it with a constrained height. If there will be a pass 3 reflow then this should (bug) happen at that time instead.

# Table paginated reflow

- The row group (continued)

- creates a continuation for the incomplete row (which also creates continuations for all of its cells and all of the cell blocks)
- puts the continuation in its overflow frames property. If the row was truncated and not top of page, the row is put in the overflow frames property.

# Table paginated reflow

- The row and cells (getting the constrained height reflow) just reflow their children with a constrained height. They don't need an overflow list for continued children because the continuations were created when the row group created the row's continutation.
- A cell is incomplete because its block is incomplete. The block uses the overflow lines mechanism (mentioned above) for its continued children
- There are two splitting scenarios for a table
  - An incomplete cells block causes the cell, row, row group, table, outer table to be incomplete
  - A truncated row or a row that started too far down the page causes the row group, table, outer table to be incomplete.