1508180 - Use uppercase names for high-order macros to please clang-format

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, defect)

Description

[Ted Campbell [:tcampbell]]

One pattern of failures I see is when using function-like macros that do no use uppercase names or trailing semi-colons.

Examples:
https://github.com/sylvestre/gecko-dev/blob/master/mfbt/RecordReplay.h#L399
https://github.com/sylvestre/gecko-dev/blob/master/js/src/frontend/ParseNode.h#L526

I have a few patches which simply change casing to significantly improve the clang-format result without needing to |clang-format off|.

Comment 1

[Ted Campbell [:tcampbell]]

Attachment: Bug 1508180 - Use uppercase names for high-order macros in js/ r?jandem

This pleases clang-format and makes many of these behave better when
auto formatted. Special cases may still be marked |clang-format off| in
later commits.

Comment 2

[Ted Campbell [:tcampbell]]

Attachment: Bug 1508180 - Use uppercase names for high-order macros in dom/ r?mccr8

Depends on D12231

Comment 3

[Ted Campbell [:tcampbell]]

Attachment: Bug 1508180 - Use uppercase macro names in mfbt/RecordReplay.h r?bhackett

Use uppercase names for MOZ_MAKERECORDREPLAYWRAPPER* so that
clang-format doesn't get confused and think these are return value types
of functions.

Depends on D12232

Comment 4

[Ted Campbell [:tcampbell]]

Attachment: Bug 1508180 - Use uppercase high-order macro names in xptinfo. r?nika

This makes clang-format stop mangling the macros.

Depends on D12233

Comment 5

[Ted Campbell [:tcampbell]]

Attachment: Bug 1508180 - Use uppercase high-order macro names in profiler. r?mstange

Depends on D12234

Comment 6

[Ted Campbell [:tcampbell]]

These changes should only change casing and all other naming and formatting is untouched.
Try in progress: https://treeherder.mozilla.org/#/jobs?repo=try&revision=70accb1a4b0e104551319f5c79539a9bdde22721

Comment 7

[Ted Campbell [:tcampbell]]

Updated js/ patch to fix various python scripts that were using regex to find |macro|.
New try run: https://treeherder.mozilla.org/#/jobs?repo=try&revision=882ecb7ff7b13ba6d1f9c67f26f7a458218b59bd

Comment 8

[Ted Campbell [:tcampbell]]

Landing part 1 immediately to avoid it rotting.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c8dd8f4166c9
Use uppercase names for high-order macros in js/ r=jandem

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b020ea6c58e5
Use uppercase names for high-order macros in dom/ r=mccr8
https://hg.mozilla.org/integration/autoland/rev/b4ac72eabda0
Use uppercase macro names in mfbt/RecordReplay.h r=bhackett
https://hg.mozilla.org/integration/autoland/rev/ffed3e597810
Use uppercase high-order macro names in xptinfo. r=nika
https://hg.mozilla.org/integration/autoland/rev/0c683a3e80d8
Use uppercase high-order macro names in profiler. r=mstange

Comment 11

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/c8dd8f4166c9
https://hg.mozilla.org/mozilla-central/rev/b020ea6c58e5
https://hg.mozilla.org/mozilla-central/rev/b4ac72eabda0
https://hg.mozilla.org/mozilla-central/rev/ffed3e597810
https://hg.mozilla.org/mozilla-central/rev/0c683a3e80d8

Comment 12

[(no longer active)]

Attachment: ESR patch (part 1)

[ESR Uplift Approval Request]

If this is not a sec:{high,crit} bug, please state case for ESR consideration: This is required for easier backporting of patches after the reformatting of ESR using clang-format.

User impact if declined: Declining this will negatively impact our developers' ability to easily backport their patches to ESR in the future.

Fix Landed on Version: 65

Risk to taking this patch: Low

Why is the change risky/not risky? (and alternatives if risky): This just changes the case of the names used in a C++ macro, virtually risk free.

String or UUID changes made by this patch: None

Comment 13

[(no longer active)]

Attachment: ESR patch (part 2)

Please see comment 12.

Comment 14

[(no longer active)]

Attachment: ESR patch (part 3)

Comment 15

[(no longer active)]

Attachment: ESR patch (part 4)

Comment 16

[(no longer active)]

Attachment: ESR patch (part 5)

Comment 17

[(no longer active)]

Attachment: ESR patch (part 1)

Please see comment 12.

Comment 18

[Liz Henry (:lizzard Please n-i to RyanVM, jcristau, or pascal)]

Comment on attachment 9030989 [details] [diff] [review]
ESR patch (part 1)

OK for uplift to ESR60 as part of the clang-format project.

Comment 19

[(no longer active)]

https://hg.mozilla.org/releases/mozilla-esr60/rev/1771e117ecae
https://hg.mozilla.org/releases/mozilla-esr60/rev/ceb0a1655f01
https://hg.mozilla.org/releases/mozilla-esr60/rev/92d2ea3e3faa