michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

michael@0: michael@0:

Table Reflow Internals
Tech Talk

michael@0:

Aug 5, 2002

michael@0:

Chris Karnaze

michael@0: michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Overview

michael@0:

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Review of Reflow

michael@0:

Reflow process starts when michael@0:
- 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 michael@0: dirty reflow command with itself as the target.
- Content is inserted, appended, or deleted through the DOM. The container posts a dirty reflow command michael@0: with itself as the target.
- Style changes through the DOM - javascript, browser change font (CTRL+/-), a preference changes, etc.
michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Review of Reflow

michael@0:

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Review of Reflow

michael@0:

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Review of Reflow

michael@0:

the reflow metrics contains: michael@0:
- 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 michael@0: is equivalent to preferred size if the avail size is not constrained.
michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Review of Reflow

michael@0:

The reflowee sets various sizes in the reflow metrics after (possibly) reflowing some or all of its children michael@0: which reflows it children, etc.
The reflowee returns a reflow status which indicates michael@0:
- 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.
michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0: michael@0:

Kinds of reflows

michael@0:

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Kinds of reflows

michael@0:

Incremental reflow (continued) michael@0:
- reflower not allowed to change available size of reflowee
- reflow commands get coalesced to streamline processing
michael@0:
Style change michael@0:
- 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
michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table Frames

michael@0:
michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

			michael@0:
			michael@0:	nsTableOuter Frame
			↙		↘
		nsTable Frame				nsTableCaption Frame
	↙		↘			↓
nsTableCol GroupFrame				nsTableRow GroupFrame		nsBlockFrame
↓				↓
nsTableCol Frame				nsTableRow Frame
				↓
				nsTableCell Frame
				↓
				nsBlock Frame

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table Reflow

michael@0:

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 michael@0: on the table, col groups, cols, cells the preferred and max element sizes of the cells michael@0: (from the pass 1 reflow), and considers colspans
Pass 2 - cell widths are constrained by the column widths (heights are only michael@0: constrained in paginated mode).

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table Reflow

michael@0:

Table reflows row groups (continued)

The row group figures out the row heights given the its style height constraints michael@0: 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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table Reflow Example

michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

michael@0:

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

michael@0:

michael@0: <table width=300>
michael@0:   <tr>
michael@0:     <td>foo</td>
michael@0:     <td>bar zap</td>
michael@0:   </tr>
michael@0: </table>
michael@0:

michael@0:
michael@0:
michael@0:

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table reflow optimizations

michael@0:

If the table is already balanced, pass 1 constrains the width (like a normal pass 2) based on the current michael@0: 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) michael@0: 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

michael@0: michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table incremental reflow

michael@0:

Outer table is a target when a caption is added or removed (dirty) or the table or caption margin michael@0: 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 michael@0: stylistically (style changed).
In the dirty cases, a target posted the reflow command in AppendFrames, InsertFrames, or DeleteFrame.

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table incremental reflow

michael@0:

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 michael@0: it needs to rebalance
When a target is inside the cell's block, the cell michael@0: 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.

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Special height reflow

michael@0:

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 michael@0: 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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Special Reflow Example

michael@0: michael@0: michael@0: michael@0: michael@0:

michael@0:

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

michael@0:

michael@0: michael@0: michael@0: michael@0: michael@0:

This cell's width is constrained michael@0: by the table and image widths.

Its height michael@0: is hard to determine.

The image needs to be as high as the cell. michael@0:

michael@0: michael@0:

michael@0:

michael@0: michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Special height reflow

michael@0:

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Special height reflow

michael@0:

Optimizations

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Intro to paginated reflow

michael@0:

When a reflowee's available height is constrained, it may not fit and need to either michael@0: 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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Pagination Illustration

michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

nsSimplePageSequence

michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

nsPageFrame

michael@0: michael@0: michael@0: michael@0: michael@0:

nsPageContentFrame

michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

areaFrame (html)

michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

blockFrame (body)

michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

nsTableOuterFrame

michael@0:

michael@0:
michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

michael@0: michael@0: michael@0: michael@0: michael@0:

michael@0: michael@0: michael@0: michael@0: michael@0: michael@0:

nsTableOuterFrame

michael@0:

blockFrame (body)

michael@0:

areaFrame (html)

michael@0:

nsPageContentFrame continued

michael@0:

nsPageFrame continued

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Intro to paginated reflow

michael@0:

The page sequence starts with one page and reflows it. If the page is incomplete then the page sequence michael@0: creates a continuation for the page and sets it as the page's next sibling (it is also the page's michael@0: 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, michael@0: because the table didn't fit) becacause a line contained something that didn't fit, etc.

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Intro to paginated reflow

michael@0:

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Intro to paginated reflow

michael@0:

Special assumptions michael@0:
- There are only initial and (possibly) resize reflows. Incremental michael@0: and style change reflows are not allowed.
- Multiple resize reflows may be necessary (e.g. a child is truncated and gets reflowed on a michael@0: 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 michael@0: to "pull up" children from a continuation.
michael@0:

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table paginated reflow

michael@0:

The block containing the outer table reflows it. If it is incomplete, the block will michael@0:
- 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.
michael@0:
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 michael@0: does this once

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table paginated reflow

michael@0:

The table does a pass 2 reflow constraining both avail heights and widths. If a row group is incomplete, the table michael@0:
- creates a continuation for the row group
- puts the continuation in its overflow frames property
michael@0:
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 michael@0: will be a pass 3 reflow then this should (bug) happen at that time instead.

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table paginated reflow

michael@0:

The row group (continued)

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

michael@0:

michael@0: < michael@0: > michael@0:

michael@0:

Table paginated reflow

michael@0:

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

michael@0:

Table Reflow InternalsTech Talk

Overview

Review of Reflow

Review of Reflow

Review of Reflow

Review of Reflow

Review of Reflow

Kinds of reflows

Kinds of reflows

Table Frames

Table Reflow

Table Reflow

Table Reflow Example

Table reflow optimizations

Table incremental reflow

Table incremental reflow

Special height reflow

Special Reflow Example

Special height reflow

Special height reflow

Intro to paginated reflow

Pagination Illustration

Intro to paginated reflow

Intro to paginated reflow

Intro to paginated reflow

Table paginated reflow

Table paginated reflow

Table paginated reflow

Table paginated reflow

Table Reflow Internals
Tech Talk