1637130 - rename visual overflow to ink overflow

Status: RESOLVED FIXED

(Core :: Layout, task)

Description

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

There are a number of methods in layout code that refer to the two types of overflow: visual overflow and scrollable overflow. See, for example, the methods of nsOverflowAreas or similar methods on nsIFrame or on ReflowOutput.

Since we created the names for those methods, the spec has come up with terms for these: ink overflow and scrollable overflow. The spec terminology matches for scrollable overflow, but not for visual/ink overflow.

We should rename visual overflow to ink overflow so that our code matches the spec and we don't have to use two terms.

Comment 1

[Ting-Yu Lin [:TYLin] (PDT, UTC-7)]

Attachment: Bug 1637130 - Rename visual overflow to ink overflow.

This patch is generated by:

# Rename the nsOverflowType enum.
rg -l "eVisualOverflow" layout/ gfx/ | xargs sed -i "s/eVisualOverflow/eInkOverflow/g"

# Rename and drop the "Get" prefix from various functions.
rg -l "GetVisualOverflowRect" layout/ gfx/ | xargs sed -i "s/GetVisualOverflowRect/InkOverflowRect/g"
rg -l "GetPreEffectsVisualOverflowRect" layout/ gfx/ | xargs sed -i "s/GetPreEffectsVisualOverflowRect/PreEffectsInkOverflowRect/g"
rg -l "GetVisualOverflowFromDeltas" layout/ gfx/ | xargs sed -i "s/GetVisualOverflowFromDeltas/InkOverflowFromDeltas/g"
rg -l "GetScrollableOverflowRect" layout/ gfx/ | xargs sed -i "s/GetScrollableOverflowRect/ScrollableOverflowRect/g"

# Rename, drop the "Get" prefix, and change the suffix "Area" to
# "Rect" because they return nsRect for nsLineBox.
rg -l "GetVisualOverflowArea" layout/ gfx/ | xargs sed -i "s/GetVisualOverflowArea/InkOverflowRect/g"
rg -l "GetScrollableOverflowArea" layout/ gfx/ | xargs sed -i "s/GetScrollableOverflowArea/ScrollableOverflowRect/g"

# Rename rest of the functions and variables.
rg -l "VisualOverflow" layout/ gfx/ | xargs sed -i "s/VisualOverflow/InkOverflow/g"
rg -l "visual overflow" layout/ gfx/ | xargs sed -i "s/visual overflow/ink overflow/g"
rg -l "visualOverflow" layout/ gfx/ | xargs sed -i "s/visualOverflow/inkOverflow/g"
rg -l "visOverflow" layout/ gfx/ | xargs sed -i "s/visOverflow/inkOverflow/g"
rg -l "vis-overflow" layout/ gfx/ python/ | xargs sed -i "s/vis-overflow/ink-overflow/g"

./mach clang-format

Comment 2

[Ting-Yu Lin [:TYLin] (PDT, UTC-7)]

Attachment: Bug 1637130 - Update the comment for overflow areas in nsLineBox.

The combined overflow area has been split into ink and scrollable
overflow areas in bug 542595. Drop the old comment.

Depends on D84231

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/887e986df7b3
Rename visual overflow to ink overflow. r=dbaron
https://hg.mozilla.org/integration/autoland/rev/dbd8cf9a9c82
Update the comment for overflow areas in nsLineBox. r=dbaron

Comment 4

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/887e986df7b3
https://hg.mozilla.org/mozilla-central/rev/dbd8cf9a9c82