1508064 - FOR_EACH_* macros in js/ get mangled by clang-format

Status: RESOLVED FIXED

(Core :: JavaScript Engine, enhancement)

Description

[Ted Campbell [:tcampbell]]

We use this macro pattern a lot in js/ and should probably wrap them with // clang-format off/on blocks.

This seems like precedent for tabular data: https://hg.mozilla.org/mozilla-central/rev/7807742373e1

A question I still have is once 4-space tabs become 2-space tabs, will we change the formatting in this blocks? The reasonable compromise would be to leave it alone until the next time someone does something like reformat the width of a column.

This query is a good starting point. Some of these become crazy in under clang-format (eg JS_FOR_PROTOTYPES).
https://searchfox.org/mozilla-central/search?q=%23define.*FOR_EACH&case=true&regexp=true&path=js

Comment 1

[Ted Campbell [:tcampbell]]

FOR_EACH_SIZE in js/public/MemoryMetrics.h are particularly broken.

Comment 2

[Ted Campbell [:tcampbell]]

Aha! If we use uppercase macro arguments for re-expansion in these lists, the formatting is actually sane.

Comment 3

[Ted Campbell [:tcampbell]]

Moved uppercasing to Bug 1508180 since it touches different components. This bug will instead focus on the cases that still need |clang-format off|.

Comment 4

[Ted Campbell [:tcampbell]]

Attachment: Bug 1508064 - Simplify JS_FOR_PROTOTYPES. r?jandem

Add JS_FOR_PROTOTYPES_ macro that takes REAL_IF_SAB, etc helpers to
handle conditional proto keys. This is easier to read and avoids macro
expansion issues confusing clang-format.

Comment 5

[Ted Campbell [:tcampbell]]

Attachment: Bug 1508064 - Use clang-format off in parts of js/ r?jandem

Protect tabular macros or struct initializers that can mangled by
clang-format.

Depends on D12238

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a50839e59152
Simplify JS_FOR_PROTOTYPES. r=jandem
https://hg.mozilla.org/integration/autoland/rev/1963c82b5abf
Use clang-format off in parts of js/ r=jandem

Comment 7

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/a50839e59152
https://hg.mozilla.org/mozilla-central/rev/1963c82b5abf

Comment 8

[(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 is reworking a C++ macro, shouldn't be making a functional change.  The patch has also baked on trunk for a while.

String or UUID changes made by this patch: None

Comment 9

[(no longer active)]

Attachment: ESR patch (part 2)

[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): comment only

String or UUID changes made by this patch: None

Comment 10

[(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: See comment 8 (attached the wrong file!)

User impact if declined: 

Fix Landed on Version: 

Risk to taking this patch: Low

Why is the change risky/not risky? (and alternatives if risky): 

String or UUID changes made by this patch:

Comment 11

[Jan de Mooij [:jandem]]

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

Review of attachment 9030770 [details] [diff] [review]:
-----------------------------------------------------------------

Same patch just with SIMD instead of BigInt AFAICT, LGTM.

Comment 12

[Liz Henry (:lizzard) (relman/hg->git project)]

Comment on attachment 9030759 [details] [diff] [review]
ESR patch (part 2)

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

Comment 13

[(no longer active)]

https://hg.mozilla.org/releases/mozilla-esr60/rev/8866133256b6
https://hg.mozilla.org/releases/mozilla-esr60/rev/e86416f205c4