<table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Issue</th>
<td>
<a href=https://github.com/llvm/llvm-project/issues/113807>113807</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>
clang-format: Inconsistent macro formatting with num literal
</td>
</tr>
<tr>
<th>Labels</th>
<td>
clang-format
</td>
</tr>
<tr>
<th>Assignees</th>
<td>
</td>
</tr>
<tr>
<th>Reporter</th>
<td>
MaJerle
</td>
</tr>
</table>
<pre>
I've noticed that depending on the parenthesis and type of variable vs litaral you do the macro, the formatting will not be always the same.
I often use macro like:
```c
//Get lower 10-bits only
#define MY_MACRO(num) ((num) & 0x3FFUL)
```
Which will be formatted as
```c
#define MY_MACRO(num) ((num)&0x3FFUL)
```
I've put together few examples below. It seems that clang-format will put the spaces between ampersand in most of the cases, but not in the case when:
- there are parenthesis in the full macro scope (outer parenthesis). If you don't have them, then space is added. Not having them is generally bad, but that's beyond the point here IMO.
- there is a variable without its own parenthesis
```c
#define MY_MACRO(flag) (config) & 0x1234 // No outer parenthesis
#define MY_MACRO(flag) ((config)&0x1234) // <- see here
#define MY_MACRO(flag) (config) & (0x1234)
#define MY_MACRO(flag) ((config) & (0x1234))
#define MY_MACRO(flag) (config) & flag
#define MY_MACRO(flag) ((config)&flag) // <- see here
#define MY_MACRO(flag) (config) & (flag)
#define MY_MACRO(flag) ((config) & (flag))
#define MY_MACRO(flag) ((config)->var & 0x1234)
#define MY_MACRO(flag) ((config)->var & (0x1234))
#define MY_MACRO(flag) ((config)->var & flag)
#define MY_MACRO(flag) ((config)->var & (flag))
#define MY_MACRO(flag) ((config).var & 0x1234)
#define MY_MACRO(flag) ((config).var & (0x1234))
#define MY_MACRO(flag) ((config).var & flag)
#define MY_MACRO(flag) ((config).var & (flag))
#define MY_MACRO(flag) (config & 0x1234)
#define MY_MACRO(flag) (config & (0x1234))
#define MY_MACRO(flag) (config & flag)
#define MY_MACRO(flag) (config & (flag))
#define MY_MACRO(flag) (config->var & 0x1234)
#define MY_MACRO(flag) (config->var & (0x1234))
#define MY_MACRO(flag) (config->var & flag)
#define MY_MACRO(flag) (config->var & (flag))
#define MY_MACRO(flag) (config.var & 0x1234)
#define MY_MACRO(flag) (config.var & (0x1234))
#define MY_MACRO(flag) (config.var & flag)
#define MY_MACRO(flag) (config.var & (flag))
```
Expectation
```c
#define MY_MACRO(flag) (config) & 0x1234
#define MY_MACRO(flag) ((config) & 0x1234) // <- see here, with spaces
#define MY_MACRO(flag) (config) & (0x1234)
#define MY_MACRO(flag) ((config) & (0x1234))
#define MY_MACRO(flag) (config) & flag
#define MY_MACRO(flag) ((config) & flag) // <- see here, with spaces
#define MY_MACRO(flag) (config) & (flag)
#define MY_MACRO(flag) ((config) & (flag))
#define MY_MACRO(flag) ((config)->var & 0x1234)
#define MY_MACRO(flag) ((config)->var & (0x1234))
#define MY_MACRO(flag) ((config)->var & flag)
#define MY_MACRO(flag) ((config)->var & (flag))
#define MY_MACRO(flag) ((config).var & 0x1234)
#define MY_MACRO(flag) ((config).var & (0x1234))
#define MY_MACRO(flag) ((config).var & flag)
#define MY_MACRO(flag) ((config).var & (flag))
#define MY_MACRO(flag) (config & 0x1234)
#define MY_MACRO(flag) (config & (0x1234))
#define MY_MACRO(flag) (config & flag)
#define MY_MACRO(flag) (config & (flag))
#define MY_MACRO(flag) (config->var & 0x1234)
#define MY_MACRO(flag) (config->var & (0x1234))
#define MY_MACRO(flag) (config->var & flag)
#define MY_MACRO(flag) (config->var & (flag))
#define MY_MACRO(flag) (config.var & 0x1234)
#define MY_MACRO(flag) (config.var & (0x1234))
#define MY_MACRO(flag) (config.var & flag)
#define MY_MACRO(flag) (config.var & (flag))
```
My full format file
```
---
Language: Cpp
# BasedOnStyle: LLVM
AccessModifierOffset: -2
AlignAfterOpenBracket: Align
AlignArrayOfStructures: None
AlignConsecutiveMacros:
Enabled: true
AcrossEmptyLines: true
AcrossComments: true
AlignConsecutiveAssignments: None
AlignConsecutiveBitFields:
Enabled: true
AcrossEmptyLines: true
AcrossComments: true
AlignConsecutiveDeclarations: None
AlignEscapedNewlines: Right
AlignOperands: Align
SortIncludes: true
InsertBraces: true # Control statements must have curly brackets
AlignTrailingComments: true
AllowAllArgumentsOnNextLine: true
AllowAllParametersOfDeclarationOnNextLine: true
AllowShortEnumsOnASingleLine: true
AllowShortBlocksOnASingleLine: Empty
AllowShortCaseLabelsOnASingleLine: true
AllowShortFunctionsOnASingleLine: All
AllowShortLambdasOnASingleLine: All
AllowShortIfStatementsOnASingleLine: Never
AllowShortLoopsOnASingleLine: false
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: AllDefinitions
AlwaysBreakBeforeMultilineStrings: false
AlwaysBreakTemplateDeclarations: Yes
AttributeMacros:
- __capability
BinPackArguments: true
BinPackParameters: true
BraceWrapping:
AfterCaseLabel: false
AfterClass: false
AfterControlStatement: Never
AfterEnum: false
AfterFunction: false
AfterNamespace: false
AfterObjCDeclaration: false
AfterStruct: false
AfterUnion: false
AfterExternBlock: false
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
IndentBraces: false
SplitEmptyFunction: true
SplitEmptyRecord: true
SplitEmptyNamespace: true
BreakBeforeBinaryOperators: NonAssignment
BreakBeforeConceptDeclarations: true
BreakBeforeBraces: Attach
BreakBeforeInheritanceComma: false
BreakInheritanceList: BeforeColon
BreakBeforeTernaryOperators: true
BreakConstructorInitializersBeforeComma: false
BreakConstructorInitializers: BeforeColon
BreakAfterJavaFieldAnnotations: false
BreakStringLiterals: true
ColumnLimit: 120
CommentPragmas: "^ IWYU pragma:"
QualifierAlignment: Leave
CompactNamespaces: false
ConstructorInitializerIndentWidth: 4
ContinuationIndentWidth: 4
Cpp11BracedListStyle: true
DeriveLineEnding: true
DerivePointerAlignment: false
DisableFormat: false
EmptyLineAfterAccessModifier: Never
EmptyLineBeforeAccessModifier: LogicalBlock
ExperimentalAutoDetectBinPacking: false
PackConstructorInitializers: BinPack
BasedOnStyle: ""
ConstructorInitializerAllOnOneLineOrOnePerLine: false
AllowAllConstructorInitializersOnNextLine: true
FixNamespaceComments: true
ForEachMacros:
- foreach
- Q_FOREACH
- BOOST_FOREACH
IfMacros:
- KJ_IF_MAYBE
IncludeBlocks: Preserve
IncludeCategories:
- Regex: "^<(.*)>"
Priority: 0
- Regex: '^"(.*)"'
Priority: 1
- Regex: "(.*)"
Priority: 2
IncludeIsMainRegex: "(Test)?$"
IncludeIsMainSourceRegex: ""
IndentAccessModifiers: false
IndentCaseLabels: true
IndentCaseBlocks: false
IndentGotoLabels: true
IndentPPDirectives: None
IndentExternBlock: AfterExternBlock
IndentRequires: true
IndentWidth: 4
IndentWrappedFunctionNames: false
InsertTrailingCommas: None
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: true
LambdaBodyIndentation: Signature
MacroBlockBegin: ""
MacroBlockEnd: ""
MaxEmptyLinesToKeep: 1
NamespaceIndentation: None
ObjCBinPackProtocolList: Auto
ObjCBlockIndentWidth: 2
ObjCBreakBeforeNestedBlockParam: true
ObjCSpaceAfterProperty: false
ObjCSpaceBeforeProtocolList: true
PenaltyBreakAssignment: 50
PenaltyBreakBeforeFirstCallParameter: 9
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakOpenParenthesis: 0
PenaltyBreakString: 1000
PenaltyBreakTemplateDeclaration: 10
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 60
PenaltyIndentedWhitespace: 0
PointerAlignment: Left
PPIndentWidth: -1
ReferenceAlignment: Pointer
ReflowComments: false
RemoveBracesLLVM: false
SeparateDefinitionBlocks: Always
ShortNamespaceLines: 1
SortJavaStaticImport: Before
SortUsingDeclarations: true
SpaceAfterCStyleCast: false
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: true
SpaceBeforeAssignmentOperators: true
SpaceBeforeCaseColon: false
SpaceBeforeParens: ControlStatements
SpaceBeforeParensOptions:
AfterControlStatements: true
AfterForeachMacros: true
AfterFunctionDefinitionName: false
AfterFunctionDeclarationName: false
AfterIfMacros: true
AfterOverloadedOperator: false
BeforeNonEmptyParentheses: false
SpaceAroundPointerQualifiers: Default
SpaceBeforeRangeBasedForLoopColon: true
SpaceInEmptyBlock: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 1
SpacesInAngles: Never
SpacesInConditionalStatement: false
SpacesInContainerLiterals: true
SpacesInCStyleCastParentheses: false
SpacesInLineCommentPrefix:
Minimum: 1
Maximum: -1
SpacesInParentheses: false
SpacesInSquareBrackets: false
SpaceBeforeSquareBrackets: false
BitFieldColonSpacing: Both
Standard: Latest
StatementAttributeLikeMacros:
- Q_EMIT
StatementMacros:
- Q_UNUSED
- QT_REQUIRE_VERSION
TabWidth: 8
UseCRLF: false
UseTab: Never
WhitespaceSensitiveMacros:
- STRINGIZE
- PP_STRINGIZE
- BOOST_PP_STRINGIZE
- NS_SWIFT_NAME
- CF_SWIFT_NAME
SpaceBeforeCpp11BracedList: false
SpaceBeforeCtorInitializerColon: true
SpaceBeforeInheritanceColon: true
---
```
</pre>
<img width="1px" height="1px" alt="" src="http://email.email.llvm.org/o/eJzsWluT2jgW_jXuFxUUmL4-9IOhYdYTbgF6urIvXcI-NprIkkeSodlfvyX5fiHJdGe3tmpTNZMEnU9HR-d-BFhKEjKAR-tmbN08XeFEHbh4XODfQVC42nP__Oha9t0REOOKeOAjdcAK-RAD8wkLEWdIHQDFWABTB5BEIsx8pM4xIB6gIxYE7ymgo0SUKCwwRWeeIJ-bbRH2BLfsifkQcBFhpTTXE6FUn4j2gDA94bM0CIkj6FuDJ2vgpH-6iAcKGEpkxgtR8hWskVMFWbeD9D8v-2zPLHv2GyhE-QkEGg56e6Ik4oyec8TIh4AwQIsvrwtnsllZ9j1LIst-QJZ9X_1wiwZvo9nseW7ZD43jqjK8HIh3SK-1L24KPsLykoyXJaiJYNm3PyRAZsU4UUjxENQBBArghOANRzEFifZA-amPXIUkQCRTO3sUs7CXiptKbxhoU8TYM7vUCYAhHMUgpLY8YSjiUmnja5yHJUht4X2ijEUJK9bR6QCsYayepgpAWNSdKtsWJJRmlpYej0HrgicKRBVs2Q995AaZozHLvlPogI-gOUSZt7H0Bkj7q--D30dLblDa_TROU0JgIDClZ7THfn4JrRjLvtN3P3Pt6tr9OWEKGcHdxapfv4o-ogyEE1EHnihkPO7EanJ_02k7HCKgOMx80uMsIGHpk0N7dI1ST0dLjto6-iGuVcbG0zTblGY4W6NJT_uLufp7BLXs-4Lp3xepzeJHudRZGMJ7FFJSfpo6Mtr7lZEzeA-PnjWaHrGo-NCH2bzLPJeYvVs5DYk-oqP-T1BQ_6dpp_9h1fQ_oJeUyXu0Udn5gQD--zevn_u--34gStoMPnD7d0dGpxTv08V7o6Gx-wNaeF8EtM9v3b-rjZq-xeAprAhnP7tavzPjf6cm2xPTcWT92v9bia76xX9QP79q9q-a_atm_6rZv2r2_2LNXpzTZ4PsGSMgFDprdza193rpP-aYhQkOwRo5aBLHhYhojCX4K7ZVZ2qIaD7_Y5GSHc8DKRfcJwEBsQoCCUpDenZGpyRkTqBArGJgY4G9rynAEKoYIfB5FWyVSDyVCJAatOQMKpgJZxK8RJEjLLAnuCyeUhCaMryn4OtdSiSQLzsaJqdRrM5zwlKubfqERxEw1aA2z3TM22EBvCzcmKgZAer_l-V7Ao9iYVq1LgGn0sMx-Es40fykDQkPqgJZxSAwM3JXDbTlQrnMo4nfFNBlEoTSZi0pSLvMhDMlOEVSYQVGdhQlMnuV8hJBz2ifOoOsnL8TmFDCwkv3pfzkUOqIMDHkFVvCm9J66wauscARKBByFVSU881t2wMXasqSSK6YsyUspPAt5Jhy72sbagzaxE6whDneA_0x1rOEecaWLbRDaRM8x9Hexz8EdYNtYZQWfglHEC3mnMdtaICpLIQ-4bMcC8BfTaw_6aRGtPAbUIlgu3MMTY-s76jjHEpLFrK1YwwBF7BIqNLeAlslCAvlZZl2EMUUq1aAfMn7X0cpQfaJaqeVHnp99XCM94SS3KJjwtbY-1q4Yd2AGbX0vQZZx8qLwHFMWFg5yGih8JDGXXIyxbJ5zYyShlth2IYps_3arbs5577WTV3iCMy40E1e7f-cVFTbKWCa17v3P7OLJ0_fFAhmgqwJSJ1ggpV3aO1NaVO90k1Kw2XM_XM325cDoe29LvOBVbJdjbiNKVEm7qvKrOTyErABj4tWKSjpNX1XXafw_TFhWJxNulZc5Nm-LFCtDRPOPIhVMwK6mRcXdJTC3qEFcNkBBFGYeaAzNW7owiArmDmRxvK5JDR_Sqiw3IFo3aghnK50xou4cHVmwJT8C4TMuV6Q48Kuy_IYv_sdH7Ep4Q5jXJX6anJPU8-cKBCYNoSecJpEbE4iYm4_tAf5uilua4HDCJs9lm1bN1Pkvnx5RrFZ1onBzlqozwmmprsyJTKP7jngY3FQFGNPFV7TlLRbBakzvxBfmfi5LrCKsMTc-AIijodD4yK-NmzRFJYXfwJBjqZMTM1Xpl3UNSdMNa5UEfmJSN0uzUwD26AVzZKxVL0BbeS9Apqauo2d85B4mKYJpnjvEkSLhKmTKP4ECjyVJfXsMhVh9Oq3XCzdl3lMo43WFs6N3M3DoXTFVszociVWDNYgOstv2u9cEORSvzMjb4XPdHdcMy6m2Dt0VEWtziI16IXPr7PVZupM_lEujVer7a6-7AYdvD79_urOXhfOl_E07ypNr5n2VlqitQAJ4gg18gQrCLkgUOe2gRDeyqiyRhPLvu9btqNnptG00DhCCK0F4ULX9ZGDBp0s7jQLbaeChf5w181ieEGK2ubOnXbtZq5cYMIaLHYglbnCzLKvC0a1HVueCA_q-wqcjuV6ADTzRIopu9Rmq59TS7u0Nv_GFb-8eb1-IgI8Pas0BpSU3qj2rQ6gAt3AXwkR7XGkK2Nlq7rnAj8vzsbzW3fQ00x1CMENOXVd2HqCxOpzwlXKoJKJS7I-zY1iLpoh9QkgLsc9R-0OsFVYqFVQqrVEl31KeomiwdqSkGE9J2cTv44qw2AMIWFN65fkKfPbxLdSoB3XAlacucgQDQFKnej2L296BVfc4zSv-DqBVkBagIaJ7Aq57AaWIBX4Bm_66LpSNHirRTIOshY8BqGajVwBSjk2JSu5rYFhqs5p7S8bqJGDbgZtRMptRoRUE1yZMDX-oQ3P0qqmjgYd7AyjOUip_691CVXUKga2rvySocxWVVTaixgmg66zOqagFFyDTt90ipgcsMBedi_NrsmxnNdWzFVydWJ5fbmtA1N7g_9yIKpsanNMRxcwhyBrX9frhrP0Mp_cQAACmAe1jRmzAkL5qVrVKr6xgYgfszbXPGXVyVuItX6gHEHL0EynygynZ-MiPornm2H5aGLygY4ZL80FZddZYp4lYeHlvrx09IlpHCZYNhuiEpK1M0t-GZJ7wSc4n1pDSCVgylC40JNXsLoopG10x6lZ_Gn3NRyao6q8gF3FuTbqM3Bre_PFzMyzaXtSNBsdiKwOlEbWlvz2dFyx0mVwpcWpnppOykcQlGMf_FypF-bTJWcmJxdR36pVqUUFT5ifOX4xJxjoEwQ4oaql3A1mIZhOdMbFnPO4MFzDtG4qQdfsXaV_R8JsPOt62BtWYS5zWEiztqBs4HPihDPfGAnX3zhaxxmowoTpRrlrKitgRTR97wauSW3F1AYBeas45YIwEqXPKkX7t8Bv-VqvccvvH7b9K8HpDG4eRy9G1Ddx-Qu0Ma7elFWGMVdZz75VmPk4TQBzrHRzma-n6i3exObka9e72OfX6cLdNTZ14p6Xz9vpU2Vl97qZfn52N9PXP6abrbtaprQd3hep_j5depYw2cxnjds9S9jhfcNVygKzBSZJ55cEPbTdbdzlb-4_p-XSev3aXM1nlw4S6qHl9nX74s52r0tnUVmezFrL1RxZH5sv23VSn94uhWfHS0wLWHyzU3zjc-U_jvyH0QO-gsfh3WgwGN3ejh6uDo-efbu_3Q-9m4HtPQwGo_3N0A5u98GNp5eub6_Ioz2wr4cD-244uh7dPPQhGA38m-v74Q1-CGDkWdcDiDChfUqPUZ-L8IpImcDjcDi6H9xdUTMVmJ9d23b1V7ZmTHu6Eo96X2-fhNK6HlAilSw5KaIoPNZ2jRzkMo8zSaQCprKfyNZ-Ua0OiCURomkeQFeJoI8HpWLjEeanESFRh2Tf93hk2TN9WvZXLxb8T_CUZc_MJaRlz7J7HB_tfwcAAP__bLxD7w">