Closed Bug 1609847 Opened 4 years ago Closed 4 years ago

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

Categories

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

task

Tracking

()

RESOLVED FIXED
mozilla74
Tracking Status
firefox74 --- fixed

People

(Reporter: TYLin, Assigned: TYLin)

Details

Attachments

(4 files)

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.

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"

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

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

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

Assignee: nobody → aethanyc
Status: NEW → ASSIGNED
Pushed by aethanyc@gmail.com:
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
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: