1588017 - Clean up the naming for IntrinsicISizeOffsetData

Status: RESOLVED FIXED

(Core :: Layout, task, P5)

Description

[Ting-Yu Lin [:TYLin] (UTC-8)]

The IntrinsicISizeOffsetData is defined as follows.

  struct IntrinsicISizeOffsetData {
    nscoord hPadding, hBorder, hMargin;

    IntrinsicISizeOffsetData() : hPadding(0), hBorder(0), hMargin(0) {}
  };

It is used as the return type by both IntrinsicISizeOffsets and IntrinsicBSizeOffsets.

So it might be better to

1. Change the name to IntrinsicSizeOffsetData by replacing ISize as Size
2. Get rid of the 'h'-prefix in the fields.

Comment 1

[Daniel Holbert [:dholbert] (blocking needinfo/review, due to AFK on parental leave, returning Jan 21)]

We should also clean up the code-comments around this type & associated functions.
Code snippet:
https://searchfox.org/mozilla-central/rev/1fe0cf575841dbf3b7e159e88ba03260cd1354c0/layout/generic/nsIFrame.h#2360-2381

The first comment there wants to move down to be adjacent to the function decl rather than the type.

And the type should get its own new short comment that refers to the functions below it & that (importantly) indicates that it represents margin/border/padding intrinsic-size-data for a single axis. (In our type names, the word "size" usually means a 2-dimensional size. Here, the "I" in "ISize" originally indicated that it was single-axis; so now that we'll be removing the "I", we'll want to add a brief note to make it clear that this is indeed a single-axis thing.)

Comment 2

[Daniel Holbert [:dholbert] (blocking needinfo/review, due to AFK on parental leave, returning Jan 21)]

(And in that above-linked code snippet, "horizontal" should be replaced with "isize" - that "horizontal" word is a relic from before we supported writing-modes.)

Comment 3

[Emily McDonough [:alaskanemily]]

Attachment: Bug 1588017 - Clean up nsIFrame::IntrinsicISizeOffsetData

Update the comments, name, and fields to show it is agnostic of isize/bsize.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/189852a9cf2a
Clean up nsIFrame::IntrinsicISizeOffsetData r=TYLin,dholbert

Comment 5

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/189852a9cf2a