1609847 - Remove "Get" prefix for simple accessors in flex container and other helper classes

Status: RESOLVED FIXED

(Core :: Layout: Flexbox, task, P3)

Description

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

Per mats' review comment in https://phabricator.services.mozilla.com/D59047#inline-365662,

Get is really only motivated on methods that return pointers, or perhaps something else that needs to be tested for validity before it's used, or to avoid a naming conflict

I agree with this, but for consistency with other existing accessors, I still add "Get" prefix to the new accessors in bug 1155772.

Let's remove the "Get" prefix for simple accessors in this bug.

Comment 1

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

Attachment: Bug 1609847 - Remove "Get" prefix for methods in FlexItem.

This patch is generated by the following script and clang-format.

#!/bin/bash

function rename() {
    echo "Renaming $1 to $2"
    rg -l "$1" layout/generic/nsFlexContainerFrame.cpp | xargs sed -i -e "s/$1/$2/g"
}

# Names in FlexItem
rename "GetFlexBaseSize()" "FlexBaseSize()"

rename "GetMainMinSize()" "MainMinSize()"
rename "GetMainMaxSize()" "MainMaxSize()"
rename "GetMainSize()" "MainSize()"
rename "GetMainPosition()" "MainPosition()"

rename "GetCrossMinSize()" "CrossMinSize()"
rename "GetCrossMaxSize()" "CrossMaxSize()"
rename "GetCrossSize()" "CrossSize()"
rename "GetCrossPosition()" "CrossPosition()"

rename "GetOuterMainSize()" "OuterMainSize()"
rename "GetOuterCrossSize()" "OuterCrossSize()"
rename "GetBaselineOffsetFromOuterCrossEdge" "BaselineOffsetFromOuterCrossEdge"
rename "GetShareOfWeightSoFar()" "ShareOfWeightSoFar()"

rename "GetAlignSelfFlags()" "AlignSelfFlags()"
rename "GetAlignSelf()" "AlignSelf()"
rename "GetFlexFactor()" "FlexFactor()"

rename "GetWeight()" "Weight()"
rename "GetMargin()" "Margin()"
rename "GetPhysicalMargin()" "PhysicalMargin()"

rename "GetMarginComponentForSide()" "MarginComponentForSide()"
rename "GetMarginSizeInMainAxis()" "MarginSizeInMainAxis()"
rename "GetMarginSizeInCrossAxis()" "MarginSizeInCrossAxis()"
rename "GetBorderPaddingSizeInMainAxis()" "BorderPaddingSizeInMainAxis()"
rename "GetBorderPaddingSizeInCrossAxis()" "BorderPaddingSizeInCrossAxis()"
rename "GetMarginBorderPaddingSizeInMainAxis()" "MarginBorderPaddingSizeInMainAxis()"
rename "GetMarginBorderPaddingSizeInCrossAxis()" "MarginBorderPaddingSizeInCrossAxis()"

rename "GetNumAutoMarginsInMainAxis" "NumAutoMarginsInMainAxis"
rename "GetNumAutoMarginsInCrossAxis" "NumAutoMarginsInCrossAxis"
rename "GetNumAutoMarginsInAxis" "NumAutoMarginsInAxis"

Comment 2

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

Attachment: Bug 1609847 - Remove "Get" prefix for methods in FlexLine.

This patch is generated by these steps.

1. Manually remove unused GetNumItems() because FlexLine::NumItems() is already defined.
2. Apply the following script.
3. Apply clang-format.

#!/bin/bash

function rename() {
    echo "Renaming $1 to $2"
    rg -l "$1" layout/generic/nsFlexContainerFrame.cpp | xargs sed -i -e "s/$1/$2/g"
}

# Names in FlexLine
rename "GetSumOfGaps" "SumOfGaps"
rename "GetTotalOuterHypotheticalMainSize" "TotalOuterHypotheticalMainSize"
rename "GetLineCrossSize" "LineCrossSize"
rename "GetFirstBaselineOffset" "FirstBaselineOffset"
rename "GetLastBaselineOffset" "LastBaselineOffset"
rename "GetMainGapSize" "MainGapSize"

Depends on D60798

Comment 3

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

Attachment: Bug 1609847 - Remove "Get" prefix for methods in FlexboxAxisTracker.

This patch is generated by the following script and clang-format.

#!/bin/bash

function rename() {
    echo "Renaming $1 to $2"
    rg -l "$1" layout/generic/nsFlexContainerFrame.cpp | xargs sed -i -e "s/$1/$2/g"
}

# Names in FlexboxAxisTracker
rename "GetMainComponent" "MainComponent"
rename "GetCrossComponent" "CrossComponent"
rename "GetMarginSizeInMainAxis" "MarginSizeInMainAxis"
rename "GetMarginSizeInCrossAxis" "MarginSizeInCrossAxis"

Depends on D60799

Comment 4

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

Attachment: Bug 1609847 - Remove "Get" prefix for methods in PositionTracker.

This patch is generated by the following script and clang-format.

#!/bin/bash

function rename() {
    echo "Renaming $1 to $2"
    rg -l "$1" layout/generic/nsFlexContainerFrame.cpp | xargs sed -i -e "s/$1/$2/g"
}

# Names in PositionTracker
rename "GetPosition" "Position"
rename "GetAxis" "Axis"

Depends on D60800

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/67c2cb45b083
Remove "Get" prefix for methods in FlexItem. r=dholbert
https://hg.mozilla.org/integration/autoland/rev/49b9c6805390
Remove "Get" prefix for methods in FlexLine. r=dholbert
https://hg.mozilla.org/integration/autoland/rev/2a9404fb69ba
Remove "Get" prefix for methods in FlexboxAxisTracker. r=dholbert
https://hg.mozilla.org/integration/autoland/rev/e05e11bccda7
Remove "Get" prefix for methods in PositionTracker. r=dholbert

Comment 6

[Narcis Beleuzu [:NarcisB]]

https://hg.mozilla.org/mozilla-central/rev/67c2cb45b083
https://hg.mozilla.org/mozilla-central/rev/49b9c6805390
https://hg.mozilla.org/mozilla-central/rev/2a9404fb69ba
https://hg.mozilla.org/mozilla-central/rev/e05e11bccda7