如何通过.clang-format配置解决X宏的缩进异常问题

问题场景 #

我采用C风格X宏实现双向枚举，原始代码如下：

namespace ns
{
#define CFG_INT_TABLE                                                          \
    X(CFG_1, "cfg_1", invalid_int_value),                                      \
    X(CFG_2, "cfg_2", invalid_int_value),                                      \
    X(CFG_3, "cfg_3", 10)

#define X(a,b,c) a
    enum class IntegerConfigs : int
    {
        CFG_INT_TABLE,
        TOTAL_ELEMENTS
    }
#undef X

#define X(a,b,c) b
   array ...
#undef X
    [...]
}

运行clang-format后，宏定义的后续行被自动添加额外缩进，格式变为：

#define CFG_INT_TABLE                                                           \
    X(CFG_1, "cfg_1", invalid_int_value),                                       \
        X(CFG_2, "cfg_2", invalid_int_value),                                   \
        X(CFG_3, "cfg_3", 10)

我希望仅通过修改.clang-format配置文件解决该缩进问题，不改动代码本身。当前使用的.clang-format配置如下：

BasedOnStyle: GNU
AccessModifierOffset: -2
ColumnLimit: 100
IndentWidth: 4
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
FixNamespaceComments: true
SpaceBeforeParens: ControlStatements
AllowShortFunctionsOnASingleLine: Empty
NamespaceIndentation: All
BreakConstructorInitializers: AfterColon
ReferenceAlignment: Left
BreakBeforeBraces: Custom
Standard: c++20
AlwaysBreakTemplateDeclarations: Yes
BinPackArguments: false
BinPackParameters: false
BraceWrapping:
  AfterClass: true
  AfterControlStatement: false
  AfterEnum: true
  AfterFunction: true
  AfterNamespace: true
  AfterStruct: true
  AfterUnion: true
  BeforeCatch: false
  BeforeElse: false
  IndentBraces: false

解决方案 #

在现有.clang-format配置中添加以下选项，即可解决多行X宏的额外缩进问题：

关键配置项 #

# 禁用预处理器指令后续行的缩进
IndentPPDirectives: None
# 取消宏块的识别，避免被当作块结构缩进
MacroBlockBegin: ""
MacroBlockEnd: ""

选项说明 #

• IndentPPDirectives: 设置为None时，预处理器宏的后续换行内容会保持和宏定义起始行一致的缩进级别，不会被自动增加缩进。
• MacroBlockBegin/End: 清空这两个选项后，clang-format不会将多行宏识别为需要嵌套缩进的块结构，从而避免额外缩进。

修改后的完整.clang-format配置示例：

BasedOnStyle: GNU
AccessModifierOffset: -2
ColumnLimit: 100
IndentWidth: 4
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
FixNamespaceComments: true
SpaceBeforeParens: ControlStatements
AllowShortFunctionsOnASingleLine: Empty
NamespaceIndentation: All
BreakConstructorInitializers: AfterColon
ReferenceAlignment: Left
BreakBeforeBraces: Custom
Standard: c++20
AlwaysBreakTemplateDeclarations: Yes
BinPackArguments: false
BinPackParameters: false
BraceWrapping:
  AfterClass: true
  AfterControlStatement: false
  AfterEnum: true
  AfterFunction: true
  AfterNamespace: true
  AfterStruct: true
  AfterUnion: true
  BeforeCatch: false
  BeforeElse: false
  IndentBraces: false
# 新增解决宏缩进的配置
IndentPPDirectives: None
MacroBlockBegin: ""
MacroBlockEnd: ""

内容的提问来源于stack exchange，提问作者Wolf