# Debugging facilities in HTML-table code

## Reflow

The most efficient tool to claim that html-table code is the victim and not the source of layout bugs is a frame reflow debug log. Look there especially how the maxElementsize (MES) and desired size are propagated.

## Block Reflow

Another way to debug the reflow process is implemented inside nsBlockFrame.cpp. It can be invoked by

`set GECKO_BLOCK_DEBUG_FLAGS=reflow`

The available options are:

- `reflow`
- `really-noisy-reflow`
- `max-element-size`
- `space-manager`
- `verify-lines`
- `damage-repair`
- `lame-paint-metrics`
- `lame-reflow-metrics`
- `disable-resize-opt`

These options can be combined with a comma separated list Messages generated by the `reflow` switch:

- `Block(div)(1)@00BE5AC4: reflowing dirty lines computedWidth=9000 computedHeight=1500`
  - this message is generated inside of
    `nsresult nsBlockFrame::ReflowDirtyLines(nsBlockReflowState& aState)`
  - it first shows the Block ID and Address
  - and then the computed width and Height from the HTMLReflowState.

## DEBUG_TABLE_STRATEGY

The table layout strategy can be visualized by defining in the makefiles the constant DEBUG_TABLE_STRATEGY. If one takes for instance the following table

rendering | code
--- | ---
cell 1 | cell 2 | cell 3 | cell 4
    <table border width="300">
    <colgroup>
    <col>
    <col width="50%">
    <col width="1*">
    <col>
    </colgroup>
    	<tr>
    	      <td style="width:80px">cell 1</td>
                <td>cell 2</td>
                <td>cell 3</td>
                <td>cell 4</td>
    	</tr>
    </table>

it will produce the following log at the entrance of `AssignNonPctColWidths`:

    AssignNonPctColWidths en max=4500 count=0
    ***START TABLE DUMP***
    mColWidths=-1 -1 -1 -1

     col frame cache ->
    0=00B93138 1=00B931F0 2=024DD728 3=024DD780
     **START COL DUMP** colIndex=0 isAnonymous=0 constraint=0
      widths=-1 -1 -1 -1 -1 -1 -1 -1 -1 -1  **END COL DUMP**
     **START COL DUMP** colIndex=1 isAnonymous=0 constraint=0
      widths=-1 -1 -1 -1 -1 -1 -1 -1 -1 -1  **END COL DUMP**
     **START COL DUMP** colIndex=2 isAnonymous=0 constraint=0
      widths=-1 -1 -1 -1 -1 -1 -1 -1 -1 -1  **END COL DUMP**
     **START COL DUMP** colIndex=3 isAnonymous=0 constraint=0
      widths=-1 -1 -1 -1 -1 -1 -1 -1 -1 -1  **END COL DUMP**
    ***END TABLE DUMP***

The en stands for entrance (ex for leaving a routine). The first line of the data dump shows that no width has yet been assigned to the columns mColWidths=-1 -1 -1 -1, `-1` stands for:

    #define WIDTH_NOT_SET   -1

This is followed by a reference to the column frame pointers:

    col frame cache ->
    0=00B93138 1=00B931F0 2=024DD728 3=024DD780

This is followed by the information which width has been set for each column. The index of the column, whether it is anonymous and what kind of constrained has been appliedcolIndex=0 isAnonymous=0 constraint=0. The following constraint types are known:

      eNoConstraint          = 0,
      ePixelConstraint       = 1,      // pixel width
      ePercentConstraint     = 2,      // percent width
      eProportionConstraint  = 3,      // 1*, 2*, etc. cols attribute assigns 1*
      e0ProportionConstraint = 4       // 0*, means to force to min width

After this follows the width information for each column:

    widths=-1 -1 -1 -1 -1 -1 -1 -1 -1 -1

The table code knows ten different width's:

    #define NUM_WIDTHS       10
    #define NUM_MAJOR_WIDTHS 3 // MIN, DES, FIX
    #define MIN_CON          0 // minimum width required of the content + padding
    #define DES_CON          1 // desired width of the content + padding
    #define FIX              2 // fixed width either from the content or cell, col, etc. + padding
    #define MIN_ADJ          3 // minimum width + padding due to col spans
    #define DES_ADJ          4 // desired width + padding due to col spans
    #define FIX_ADJ          5 // fixed width + padding due to col spans
    #define PCT              6 // percent width of cell or col
    #define PCT_ADJ          7 // percent width of cell or col from percent colspan
    #define MIN_PRO          8 // desired width due to proportional <col>s or cols attribute
    #define FINAL            9 // width after the table has been balanced, considering all of the others

In the last log snippet none of these width's has been set. Leaving AssignNonPctColWidths shows that already to all columns a width of 360 twips has been assigned

    AssignNonPctColWidths ex
    ***START TABLE DUMP***
    mColWidths=360 360 360 360

     col frame cache ->
    0=00B93138 1=00B931F0 2=024DD728 3=024DD780
     **START COL DUMP** colIndex=0 isAnonymous=0 constraint=0
      widths=360 540 1230 -1 -1 -1 -1 -1 -1 360  **END COL DUMP**
     **START COL DUMP** colIndex=1 isAnonymous=0 constraint=0
      widths=360 540 -1 -1 -1 -1 -1 -1 -1 360  **END COL DUMP**
     **START COL DUMP** colIndex=2 isAnonymous=0 constraint=3
      widths=360 540 -1 -1 -1 -1 -1 -1 540 360  **END COL DUMP**
     **START COL DUMP** colIndex=3 isAnonymous=0 constraint=0
      widths=360 540 -1 -1 -1 -1 -1 -1 -1 360  **END COL DUMP**
    ***END TABLE DUMP***

The first column has already the minimum content width, the table column can't shrink below that, the desired content width of 540 twips, that's the space to layout `cell 1` without wrapping the text and the 1230 which correspond to the `style="width:80px"` at the first cell. At this step the final size is 360 twips.

MIN_CON | DES_CON | FIX | MIN_ADJ | DES_ADJ | FIX_ADJ | PCT | PCT_ADJ | MIN_PRO | FINAL
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
360 | 540 | 1230 | -1 | -1 | -1 | -1 | -1 | -1 | 360

There was no change till the entrance of `BalanceColumnWidths`

    BalanceColumnWidths en count=1
    ***START TABLE DUMP***
    mColWidths=360 360 360 360

     col frame cache ->
    0=00B93138 1=00B931F0 2=024DD728 3=024DD780
     **START COL DUMP** colIndex=0 isAnonymous=0 constraint=0
      widths=360 540 1230 -1 -1 -1 -1 -1 -1 360  **END COL DUMP**
     **START COL DUMP** colIndex=1 isAnonymous=0 constraint=0
      widths=360 540 -1 -1 -1 -1 -1 -1 -1 360  **END COL DUMP**
     **START COL DUMP** colIndex=2 isAnonymous=0 constraint=3
      widths=360 540 -1 -1 -1 -1 -1 -1 540 360  **END COL DUMP**
     **START COL DUMP** colIndex=3 isAnonymous=0 constraint=0
      widths=360 540 -1 -1 -1 -1 -1 -1 -1 360  **END COL DUMP**
    ***END TABLE DUMP***

But at the end the final distribution between the columns has been reached.

    BalanceColumnWidths ex
    ***START TABLE DUMP***
    mColWidths=1230 2160 465 465

     col frame cache ->
    0=00B93138 1=00B931F0 2=024DD728 3=024DD780
     **START COL DUMP** colIndex=0 isAnonymous=0 constraint=0
      widths=360 540 1230 -1 -1 -1 -1 -1 -1 1230  **END COL DUMP**
     **START COL DUMP** colIndex=1 isAnonymous=0 constraint=0
      widths=360 540 -1 -1 -1 -1 2160 -1 -1 2160  **END COL DUMP**
     **START COL DUMP** colIndex=2 isAnonymous=0 constraint=3
      widths=360 540 -1 -1 -1 -1 -1 -1 540 465  **END COL DUMP**
     **START COL DUMP** colIndex=3 isAnonymous=0 constraint=0
      widths=360 540 -1 -1 -1 -1 -1 -1 -1 465  **END COL DUMP**
    ***END TABLE DUMP***

The column dump is implemented in `nsTableColFrame.cpp` in the routine: `void nsTableColFrame::Dump(int32_t aIndent)`.

## DEBUG_TABLE_REFLOW_TIMING

needs to be written

author: Bernd Mielke
2002-06-05