Skip to content

Latest commit

 

History

History
5844 lines (4090 loc) · 155 KB

ClangFormatStyleOptions.rst

File metadata and controls

5844 lines (4090 loc) · 155 KB
Raw
.versionbadge { background-color: #1c913d; height: 20px; display: inline-block; min-width: 120px; text-align: center; border-radius: 5px; color: #FFFFFF; font-family: "Verdana,Geneva,DejaVu Sans,sans-serif"; }

Clang-Format Style Options

ClangFormatStyleOptions describes configurable formatting style options supported by LibFormat and ClangFormat.

When using clang-format command line utility or clang::format::reformat(...) functions from code, one can either use one of the predefined styles (LLVM, Google, Chromium, Mozilla, WebKit, Microsoft) or create a custom style by configuring specific style options.

Configuring Style with clang-format

clang-format supports two ways to provide custom style options: directly specify style configuration in the -style= command line option or use -style=file and put style configuration in the .clang-format or _clang-format file in the project directory.

When using -style=file, clang-format for each input file will try to find the .clang-format file located in the closest parent directory of the input file. When the standard input is used, the search is started from the current directory.

When using -style=file:<format_file_path>, clang-format for each input file will use the format file located at <format_file_path>. The path may be absolute or relative to the working directory.

The .clang-format file uses YAML format:

key1: value1
key2: value2
# A comment.
...

The configuration file can consist of several sections each having different Language: parameter denoting the programming language this section of the configuration is targeted at. See the description of the Language option below for the list of supported languages. The first section may have no language set, it will set the default style options for all languages. Configuration sections for specific language will override options set in the default section.

When clang-format formats a file, it auto-detects the language using the file name. When formatting standard input or a file that doesn't have the extension corresponding to its language, -assume-filename= option can be used to override the file name clang-format uses to detect the language.

An example of a configuration file for multiple languages:

---
# We'll use defaults from the LLVM style, but with 4 columns indentation.
BasedOnStyle: LLVM
IndentWidth: 4
---
Language: Cpp
# Force pointers to the type for C++.
DerivePointerAlignment: false
PointerAlignment: Left
---
Language: JavaScript
# Use 100 columns for JS.
ColumnLimit: 100
---
Language: Proto
# Don't format .proto files.
DisableFormat: true
---
Language: CSharp
# Use 100 columns for C#.
ColumnLimit: 100
...

An easy way to get a valid .clang-format file containing all configuration options of a certain predefined style is:

clang-format -style=llvm -dump-config > .clang-format

When specifying configuration in the -style= option, the same configuration is applied for all input files. The format of the configuration is:

-style='{key1: value1, key2: value2, ...}'

Disabling Formatting on a Piece of Code

Clang-format understands also special comments that switch formatting in a delimited range. The code between a comment // clang-format off or /* clang-format off */ up to a comment // clang-format on or /* clang-format on */ will not be formatted. The comments themselves will be formatted (aligned) normally. Also, a colon (:) and additional text may follow // clang-format off or // clang-format on to explain why clang-format is turned off or back on.

int formatted_code;
// clang-format off
    void    unformatted_code  ;
// clang-format on
void formatted_code_again;

Configuring Style in Code

When using clang::format::reformat(...) functions, the format is specified by supplying the clang::format::FormatStyle structure.

Configurable Format Style Options

This section lists the supported style options. Value type is specified for each option. For enumeration types possible values are specified both as a C++ enumeration member (with a prefix, e.g. LS_Auto), and as a value usable in the configuration (without a prefix: Auto).

BasedOnStyle (String) ¶ <BasedOnStyle>

The style used for all options not specifically set in the configuration.

This option is supported only in the clang-format configuration (both within -style='{...}' and the .clang-format file).

Possible values:

  • LLVM A style complying with the LLVM coding standards
  • Google A style complying with Google's C++ style guide
  • Chromium A style complying with Chromium's style guide
  • Mozilla A style complying with Mozilla's style guide
  • WebKit A style complying with WebKit's style guide
  • Microsoft A style complying with Microsoft's style guide
  • GNU A style complying with the GNU coding standards

  • InheritParentConfig Not a real style, but allows to use the .clang-format file from the parent directory (or its parent if there is none). If there is no parent file found it falls back to the fallback style, and applies the changes to that.

    With this option you can overwrite some parts of your main style for your subdirectories. This is also possible through the command line, e.g.: --style={BasedOnStyle: InheritParentConfig, ColumnLimit: 20}

AccessModifierOffset (Integer) clang-format 3.3 ¶ <AccessModifierOffset>

The extra indent or outdent of access modifiers, e.g. public:.

AlignAfterOpenBracket (BracketAlignmentStyle) clang-format 3.8 ¶ <AlignAfterOpenBracket>

If true, horizontally aligns arguments after an open bracket.

This applies to round brackets (parentheses), angle brackets and square brackets.

Possible values:

AlignArrayOfStructures (ArrayInitializerAlignmentStyle) clang-format 13 ¶ <AlignArrayOfStructures>

if not None, when using initialization for an array of structs aligns the fields into columns.

Note

As of clang-format 15 this option only applied to arrays with equal number of columns per row.

Possible values:

AlignConsecutiveAssignments (AlignConsecutiveStyle) clang-format 3.8 ¶ <AlignConsecutiveAssignments>

Style of aligning consecutive assignments.

Consecutive will result in formattings like:

int a            = 1;
int somelongname = 2;
double c         = 3;

Nested configuration flags:

Alignment options.

They can also be read as a whole for compatibility. The choices are: - None - Consecutive - AcrossEmptyLines - AcrossComments - AcrossEmptyLinesAndComments

For example, to align across empty lines and not across comments, either of these work.

AlignConsecutiveMacros: AcrossEmptyLines

AlignConsecutiveMacros:
  Enabled: true
  AcrossEmptyLines: true
  AcrossComments: false
AlignConsecutiveBitFields (AlignConsecutiveStyle) clang-format 11 ¶ <AlignConsecutiveBitFields>

Style of aligning consecutive bit fields.

Consecutive will align the bitfield separators of consecutive lines. This will result in formattings like:

int aaaa : 1;
int b    : 12;
int ccc  : 8;

Nested configuration flags:

Alignment options.

They can also be read as a whole for compatibility. The choices are: - None - Consecutive - AcrossEmptyLines - AcrossComments - AcrossEmptyLinesAndComments

For example, to align across empty lines and not across comments, either of these work.

AlignConsecutiveMacros: AcrossEmptyLines

AlignConsecutiveMacros:
  Enabled: true
  AcrossEmptyLines: true
  AcrossComments: false
AlignConsecutiveDeclarations (AlignConsecutiveStyle) clang-format 3.8 ¶ <AlignConsecutiveDeclarations>

Style of aligning consecutive declarations.

Consecutive will align the declaration names of consecutive lines. This will result in formattings like:

int         aaaa = 12;
float       b = 23;
std::string ccc;

Nested configuration flags:

Alignment options.

They can also be read as a whole for compatibility. The choices are: - None - Consecutive - AcrossEmptyLines - AcrossComments - AcrossEmptyLinesAndComments

For example, to align across empty lines and not across comments, either of these work.

AlignConsecutiveMacros: AcrossEmptyLines

AlignConsecutiveMacros:
  Enabled: true
  AcrossEmptyLines: true
  AcrossComments: false
AlignConsecutiveMacros (AlignConsecutiveStyle) clang-format 9 ¶ <AlignConsecutiveMacros>

Style of aligning consecutive macro definitions.

Consecutive will result in formattings like:

#define SHORT_NAME       42
#define LONGER_NAME      0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x)           (x * x)
#define bar(y, z)        (y + z)

Nested configuration flags:

Alignment options.

They can also be read as a whole for compatibility. The choices are: - None - Consecutive - AcrossEmptyLines - AcrossComments - AcrossEmptyLinesAndComments

For example, to align across empty lines and not across comments, either of these work.

AlignConsecutiveMacros: AcrossEmptyLines

AlignConsecutiveMacros:
  Enabled: true
  AcrossEmptyLines: true
  AcrossComments: false
AlignConsecutiveShortCaseStatements (ShortCaseStatementsAlignmentStyle) clang-format 17 ¶ <AlignConsecutiveShortCaseStatements>

Style of aligning consecutive short case labels. Only applies if AllowShortCaseLabelsOnASingleLine is true.

# Example of usage:
AlignConsecutiveShortCaseStatements:
  Enabled: true
  AcrossEmptyLines: true
  AcrossComments: true
  AlignCaseColons: false

Nested configuration flags:

Alignment options.

AlignEscapedNewlines (EscapedNewlineAlignmentStyle) clang-format 5 ¶ <AlignEscapedNewlines>

Options for aligning backslashes in escaped newlines.

Possible values:

AlignOperands (OperandAlignmentStyle) clang-format 3.5 ¶ <AlignOperands>

If true, horizontally align operands of binary and ternary expressions.

Possible values:

  • OAS_DontAlign (in configuration: DontAlign) Do not align operands of binary and ternary expressions. The wrapped lines are indented ContinuationIndentWidth spaces from the start of the line.

  • OAS_Align (in configuration: Align) Horizontally align operands of binary and ternary expressions.

    Specifically, this aligns operands of a single expression that needs to be split over multiple lines, e.g.:

    int aaa = bbbbbbbbbbbbbbb +
          ccccccccccccccc;

    When BreakBeforeBinaryOperators is set, the wrapped operator is aligned with the operand on the first line.

    int aaa = bbbbbbbbbbbbbbb
          + ccccccccccccccc;

  • OAS_AlignAfterOperator (in configuration: AlignAfterOperator) Horizontally align operands of binary and ternary expressions.

    This is similar to AO_Align, except when BreakBeforeBinaryOperators is set, the operator is un-indented so that the wrapped operand is aligned with the operand on the first line.

    int aaa = bbbbbbbbbbbbbbb
        + ccccccccccccccc;
AlignTrailingComments (TrailingCommentsAlignmentStyle) clang-format 3.7 ¶ <AlignTrailingComments>

Control of trailing comments.

Note

As of clang-format 16 this option is not a bool but can be set to the options. Conventional bool options still can be parsed as before.

# Example of usage:
AlignTrailingComments:
  Kind: Always
  OverEmptyLines: 2

Nested configuration flags:

Alignment options

AllowAllArgumentsOnNextLine (Boolean) clang-format 9 ¶ <AllowAllArgumentsOnNextLine>

If a function call or braced initializer list doesn't fit on a line, allow putting all arguments onto the next line, even if BinPackArguments is false.

true:
callFunction(
    a, b, c, d);

false:
callFunction(a,
             b,
             c,
             d);
AllowAllConstructorInitializersOnNextLine (Boolean) clang-format 9 ¶ <AllowAllConstructorInitializersOnNextLine>

This option is deprecated. See NextLine of PackConstructorInitializers.

AllowAllParametersOfDeclarationOnNextLine (Boolean) clang-format 3.3 ¶ <AllowAllParametersOfDeclarationOnNextLine>

If the function declaration doesn't fit on a line, allow putting all parameters of a function declaration onto the next line even if BinPackParameters is false.

true:
void myFunction(
    int a, int b, int c, int d, int e);

false:
void myFunction(int a,
                int b,
                int c,
                int d,
                int e);
AllowBreakBeforeNoexceptSpecifier (BreakBeforeNoexceptSpecifierStyle) clang-format 18 ¶ <AllowBreakBeforeNoexceptSpecifier>

Controls if there could be a line break before a noexcept specifier.

Possible values:

AllowShortBlocksOnASingleLine (ShortBlockStyle) clang-format 3.5 ¶ <AllowShortBlocksOnASingleLine>

Dependent on the value, while (true) { continue; } can be put on a single line.

Possible values:

AllowShortCaseLabelsOnASingleLine (Boolean) clang-format 3.6 ¶ <AllowShortCaseLabelsOnASingleLine>

If true, short case labels will be contracted to a single line.

true:                                   false:
switch (a) {                    vs.     switch (a) {
case 1: x = 1; break;                   case 1:
case 2: return;                           x = 1;
}                                         break;
                                        case 2:
                                          return;
                                        }
AllowShortEnumsOnASingleLine (Boolean) clang-format 11 ¶ <AllowShortEnumsOnASingleLine>

Allow short enums on a single line.

true:
enum { A, B } myEnum;

false:
enum {
  A,
  B
} myEnum;
AllowShortFunctionsOnASingleLine (ShortFunctionStyle) clang-format 3.5 ¶ <AllowShortFunctionsOnASingleLine>

Dependent on the value, int f() { return 0; } can be put on a single line.

Possible values:

AllowShortIfStatementsOnASingleLine (ShortIfStyle) clang-format 3.3 ¶ <AllowShortIfStatementsOnASingleLine>

Dependent on the value, if (a) return; can be put on a single line.

Possible values:

AllowShortLambdasOnASingleLine (ShortLambdaStyle) clang-format 9 ¶ <AllowShortLambdasOnASingleLine>

Dependent on the value, auto lambda []() { return 0; } can be put on a single line.

Possible values:

AllowShortLoopsOnASingleLine (Boolean) clang-format 3.7 ¶ <AllowShortLoopsOnASingleLine>

If true, while (true) continue; can be put on a single line.

AlwaysBreakAfterDefinitionReturnType (DefinitionReturnTypeBreakingStyle) clang-format 3.7 ¶ <AlwaysBreakAfterDefinitionReturnType>

The function definition return type breaking style to use. This option is deprecated and is retained for backwards compatibility.

Possible values:

  • DRTBS_None (in configuration: None) Break after return type automatically. PenaltyReturnTypeOnItsOwnLine is taken into account.
  • DRTBS_All (in configuration: All) Always break after the return type.
  • DRTBS_TopLevel (in configuration: TopLevel) Always break after the return types of top-level functions.
AlwaysBreakAfterReturnType (ReturnTypeBreakingStyle) clang-format 3.8 ¶ <AlwaysBreakAfterReturnType>

The function declaration return type breaking style to use.

Possible values:

AlwaysBreakBeforeMultilineStrings (Boolean) clang-format 3.4 ¶ <AlwaysBreakBeforeMultilineStrings>

If true, always break before multiline string literals.

This flag is mean to make cases where there are multiple multiline strings in a file look more consistent. Thus, it will only take effect if wrapping the string at that point leads to it being indented ContinuationIndentWidth spaces from the start of the line.

true:                                  false:
aaaa =                         vs.     aaaa = "bbbb"
    "bbbb"                                    "cccc";
    "cccc";
AlwaysBreakTemplateDeclarations (BreakTemplateDeclarationsStyle) clang-format 3.4 ¶ <AlwaysBreakTemplateDeclarations>

The template declaration breaking style to use.

Possible values:

AttributeMacros (List of Strings) clang-format 12 ¶ <AttributeMacros>

A vector of strings that should be interpreted as attributes/qualifiers instead of identifiers. This can be useful for language extensions or static analyzer annotations.

For example:

x = (char *__capability)&y;
int function(void) __unused;
void only_writes_to_buffer(char *__output buffer);

In the .clang-format configuration file, this can be configured like:

AttributeMacros: ['__capability', '__output', '__unused']
BinPackArguments (Boolean) clang-format 3.7 ¶ <BinPackArguments>

If false, a function call's arguments will either be all on the same line or will have one line each.

true:
void f() {
  f(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaa,
    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);
}

false:
void f() {
  f(aaaaaaaaaaaaaaaaaaaa,
    aaaaaaaaaaaaaaaaaaaa,
    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);
}
BinPackParameters (Boolean) clang-format 3.7 ¶ <BinPackParameters>

If false, a function declaration's or function definition's parameters will either all be on the same line or will have one line each.

true:
void f(int aaaaaaaaaaaaaaaaaaaa, int aaaaaaaaaaaaaaaaaaaa,
       int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}

false:
void f(int aaaaaaaaaaaaaaaaaaaa,
       int aaaaaaaaaaaaaaaaaaaa,
       int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}
BitFieldColonSpacing (BitFieldColonSpacingStyle) clang-format 12 ¶ <BitFieldColonSpacing>

The BitFieldColonSpacingStyle to use for bitfields.

Possible values:

  • BFCS_Both (in configuration: Both) Add one space on each side of the :

    unsigned bf : 2;

  • BFCS_None (in configuration: None) Add no space around the : (except when needed for AlignConsecutiveBitFields).

    unsigned bf:2;

  • BFCS_Before (in configuration: Before) Add space before the : only

    unsigned bf :2;

  • BFCS_After (in configuration: After) Add space after the : only (space may be added before if needed for AlignConsecutiveBitFields).

    unsigned bf: 2;
BraceWrapping (BraceWrappingFlags) clang-format 3.8 ¶ <BraceWrapping>

Control of individual brace wrapping cases.

If BreakBeforeBraces is set to BS_Custom, use this to specify how each individual brace case should be handled. Otherwise, this is ignored.

# Example of usage:
BreakBeforeBraces: Custom
BraceWrapping:
  AfterEnum: true
  AfterStruct: false
  SplitEmptyFunction: false

Nested configuration flags:

Precise control over the wrapping of braces.

# Should be declared this way:
BreakBeforeBraces: Custom
BraceWrapping:
    AfterClass: true
BracedInitializerIndentWidth (Unsigned) clang-format 17 ¶ <BracedInitializerIndentWidth>

The number of columns to use to indent the contents of braced init lists. If unset, ContinuationIndentWidth is used.

AlignAfterOpenBracket: AlwaysBreak
BracedInitializerIndentWidth: 2

void f() {
  SomeClass c{
    "foo",
    "bar",
    "baz",
  };
  auto s = SomeStruct{
    .foo = "foo",
    .bar = "bar",
    .baz = "baz",
  };
  SomeArrayT a[3] = {
    {
      foo,
      bar,
    },
    {
      foo,
      bar,
    },
    SomeArrayT{},
  };
}
BreakAfterAttributes (AttributeBreakingStyle) clang-format 16 ¶ <BreakAfterAttributes>

Break after a group of C++11 attributes before a function declaration/definition name.

Possible values:

BreakAfterJavaFieldAnnotations (Boolean) clang-format 3.8 ¶ <BreakAfterJavaFieldAnnotations>

Break after each annotation on a field in Java files.

true:                                  false:
@Partial                       vs.     @Partial @Mock DataLoad loader;
@Mock
DataLoad loader;
BreakArrays (Boolean) clang-format 16 ¶ <BreakArrays>

If true, clang-format will always break after a Json array [ otherwise it will scan until the closing ] to determine if it should add newlines between elements (prettier compatible).

Note

This is currently only for formatting JSON.

true:                                  false:
[                          vs.      [1, 2, 3, 4]
  1,
  2,
  3,
  4
]
BreakBeforeBinaryOperators (BinaryOperatorStyle) clang-format 3.6 ¶ <BreakBeforeBinaryOperators>

The way to wrap binary operators.

Possible values:

BreakBeforeBraces (BraceBreakingStyle) clang-format 3.7 ¶ <BreakBeforeBraces>

The brace breaking style to use.

Possible values:

BreakBeforeConceptDeclarations (BreakBeforeConceptDeclarationsStyle) clang-format 12 ¶ <BreakBeforeConceptDeclarations>

The concept declaration style to use.

Possible values:

  • BBCDS_Never (in configuration: Never) Keep the template declaration line together with concept.

    template <typename T> concept C = ...;
  • BBCDS_Allowed (in configuration: Allowed) Breaking between template declaration and concept is allowed. The actual behavior depends on the content and line breaking rules and penalties.

  • BBCDS_Always (in configuration: Always) Always break before concept, putting it in the line after the template declaration.

    template <typename T>
concept C = ...;
BreakBeforeInlineASMColon (BreakBeforeInlineASMColonStyle) clang-format 16 ¶ <BreakBeforeInlineASMColon>

The inline ASM colon style to use.

Possible values:

BreakBeforeTernaryOperators (Boolean) clang-format 3.7 ¶ <BreakBeforeTernaryOperators>

If true, ternary operators will be placed after line breaks.

true:
veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription
    ? firstValue
    : SecondValueVeryVeryVeryVeryLong;

false:
veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ?
    firstValue :
    SecondValueVeryVeryVeryVeryLong;
BreakConstructorInitializers (BreakConstructorInitializersStyle) clang-format 5 ¶ <BreakConstructorInitializers>

The break constructor initializers style to use.

Possible values:

BreakInheritanceList (BreakInheritanceListStyle) clang-format 7 ¶ <BreakInheritanceList>

The inheritance list style to use.

Possible values:

  • BILS_BeforeColon (in configuration: BeforeColon) Break inheritance list before the colon and after the commas.

    class Foo
    : Base1,
      Base2
{};

  • BILS_BeforeComma (in configuration: BeforeComma) Break inheritance list before the colon and commas, and align the commas with the colon.

    class Foo
    : Base1
    , Base2
{};

  • BILS_AfterColon (in configuration: AfterColon) Break inheritance list after the colon and commas.

    class Foo :
    Base1,
    Base2
{};

  • BILS_AfterComma (in configuration: AfterComma) Break inheritance list only after the commas.

    class Foo : Base1,
            Base2
{};
BreakStringLiterals (Boolean) clang-format 3.9 ¶ <BreakStringLiterals>

Allow breaking string literals when formatting.

In C, C++, and Objective-C:

true:
const char* x = "veryVeryVeryVeryVeryVe"
                "ryVeryVeryVeryVeryVery"
                "VeryLongString";

false:
const char* x =
    "veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";

In C# and Java:

true:
string x = "veryVeryVeryVeryVeryVe" +
           "ryVeryVeryVeryVeryVery" +
           "VeryLongString";

false:
string x =
    "veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";

C# interpolated strings are not broken.

In Verilog:

true:
string x = {"veryVeryVeryVeryVeryVe",
            "ryVeryVeryVeryVeryVery",
            "VeryLongString"};

false:
string x =
    "veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";
ColumnLimit (Unsigned) clang-format 3.7 ¶ <ColumnLimit>

The column limit.

A column limit of 0 means that there is no column limit. In this case, clang-format will respect the input's line breaking decisions within statements unless they contradict other rules.

CommentPragmas (String) clang-format 3.7 ¶ <CommentPragmas>

A regular expression that describes comments with special meaning, which should not be split into lines or otherwise changed.

// CommentPragmas: '^ FOOBAR pragma:'
// Will leave the following line unaffected
#include <vector> // FOOBAR pragma: keep
CompactNamespaces (Boolean) clang-format 5 ¶ <CompactNamespaces>

If true, consecutive namespace declarations will be on the same line. If false, each namespace is declared on a new line.

true:
namespace Foo { namespace Bar {
}}

false:
namespace Foo {
namespace Bar {
}
}

If it does not fit on a single line, the overflowing namespaces get wrapped:

namespace Foo { namespace Bar {
namespace Extra {
}}}
ConstructorInitializerAllOnOneLineOrOnePerLine (Boolean) clang-format 3.7 ¶ <ConstructorInitializerAllOnOneLineOrOnePerLine>

This option is deprecated. See CurrentLine of PackConstructorInitializers.

ConstructorInitializerIndentWidth (Unsigned) clang-format 3.7 ¶ <ConstructorInitializerIndentWidth>

The number of characters to use for indentation of constructor initializer lists as well as inheritance lists.

ContinuationIndentWidth (Unsigned) clang-format 3.7 ¶ <ContinuationIndentWidth>

Indent width for line continuations.

ContinuationIndentWidth: 2

int i =         //  VeryVeryVeryVeryVeryLongComment
  longFunction( // Again a long comment
    arg);
Cpp11BracedListStyle (Boolean) clang-format 3.4 ¶ <Cpp11BracedListStyle>

If true, format braced lists as best suited for C++11 braced lists.

Important differences: - No spaces inside the braced list. - No line break before the closing brace. - Indentation with the continuation indent, not with the block indent.

Fundamentally, C++11 braced lists are formatted exactly like function calls would be formatted in their place. If the braced list follows a name (e.g. a type or variable name), clang-format formats as if the {} were the parentheses of a function call with that name. If there is no name, a zero-length name is assumed.

true:                                  false:
vector<int> x{1, 2, 3, 4};     vs.     vector<int> x{ 1, 2, 3, 4 };
vector<T> x{{}, {}, {}, {}};           vector<T> x{ {}, {}, {}, {} };
f(MyMap[{composite, key}]);            f(MyMap[{ composite, key }]);
new int[3]{1, 2, 3};                   new int[3]{ 1, 2, 3 };
DeriveLineEnding (Boolean) clang-format 10 ¶ <DeriveLineEnding>

This option is deprecated. See DeriveLF and DeriveCRLF of LineEnding.

DerivePointerAlignment (Boolean) clang-format 3.7 ¶ <DerivePointerAlignment>

If true, analyze the formatted file for the most common alignment of & and *. Pointer and reference alignment styles are going to be updated according to the preferences found in the file. PointerAlignment is then used only as fallback.

DisableFormat (Boolean) clang-format 3.7 ¶ <DisableFormat>

Disables formatting completely.

EmptyLineAfterAccessModifier (EmptyLineAfterAccessModifierStyle) clang-format 13 ¶ <EmptyLineAfterAccessModifier>

Defines when to put an empty line after access modifiers. EmptyLineBeforeAccessModifier configuration handles the number of empty lines between two access modifiers.

Possible values:

EmptyLineBeforeAccessModifier (EmptyLineBeforeAccessModifierStyle) clang-format 12 ¶ <EmptyLineBeforeAccessModifier>

Defines in which cases to put empty line before access modifiers.

Possible values:

ExperimentalAutoDetectBinPacking (Boolean) clang-format 3.7 ¶ <ExperimentalAutoDetectBinPacking>

If true, clang-format detects whether function calls and definitions are formatted with one parameter per line.

Each call can be bin-packed, one-per-line or inconclusive. If it is inconclusive, e.g. completely on one line, but a decision needs to be made, clang-format analyzes whether there are other bin-packed cases in the input file and act accordingly.

Note

This is an experimental flag, that might go away or be renamed. Do not use this in config files, etc. Use at your own risk.

FixNamespaceComments (Boolean) clang-format 5 ¶ <FixNamespaceComments>

If true, clang-format adds missing namespace end comments for namespaces and fixes invalid existing ones. This doesn't affect short namespaces, which are controlled by ShortNamespaceLines.

true:                                  false:
namespace longNamespace {      vs.     namespace longNamespace {
void foo();                            void foo();
void bar();                            void bar();
} // namespace a                       }
namespace shortNamespace {             namespace shortNamespace {
void baz();                            void baz();
}                                      }
ForEachMacros (List of Strings) clang-format 3.7 ¶ <ForEachMacros>

A vector of macros that should be interpreted as foreach loops instead of as function calls.

These are expected to be macros of the form:

FOREACH(<variable-declaration>, ...)
  <loop-body>

In the .clang-format configuration file, this can be configured like:

ForEachMacros: ['RANGES_FOR', 'FOREACH']

For example: BOOST_FOREACH.

IfMacros (List of Strings) clang-format 13 ¶ <IfMacros>

A vector of macros that should be interpreted as conditionals instead of as function calls.

These are expected to be macros of the form:

IF(...)
  <conditional-body>
else IF(...)
  <conditional-body>

In the .clang-format configuration file, this can be configured like:

IfMacros: ['IF']

For example: KJ_IF_MAYBE

IncludeBlocks (IncludeBlocksStyle) clang-format 6 ¶ <IncludeBlocks>

Dependent on the value, multiple #include blocks can be sorted as one and divided based on category.

Possible values:

IncludeCategories (List of IncludeCategories) clang-format 3.8 ¶ <IncludeCategories>

Regular expressions denoting the different #include categories used for ordering #includes.

POSIX extended regular expressions are supported.

These regular expressions are matched against the filename of an include (including the <> or "") in order. The value belonging to the first matching regular expression is assigned and #includes are sorted first according to increasing category number and then alphabetically within each category.

If none of the regular expressions match, INT_MAX is assigned as category. The main header for a source file automatically gets category 0. so that it is generally kept at the beginning of the #includes (https://llvm.org/docs/CodingStandards.html#include-style). However, you can also assign negative priorities if you have certain headers that always need to be first.

There is a third and optional field SortPriority which can used while IncludeBlocks = IBS_Regroup to define the priority in which #includes should be ordered. The value of Priority defines the order of #include blocks and also allows the grouping of #includes of different priority. SortPriority is set to the value of Priority as default if it is not assigned.

Each regular expression can be marked as case sensitive with the field CaseSensitive, per default it is not.

To configure this in the .clang-format file, use:

IncludeCategories:
  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
    Priority:        2
    SortPriority:    2
    CaseSensitive:   true
  - Regex:           '^((<|")(gtest|gmock|isl|json)/)'
    Priority:        3
  - Regex:           '<[[:alnum:].]+>'
    Priority:        4
  - Regex:           '.*'
    Priority:        1
    SortPriority:    0
IncludeIsMainRegex (String) clang-format 3.9 ¶ <IncludeIsMainRegex>

Specify a regular expression of suffixes that are allowed in the file-to-main-include mapping.

When guessing whether a #include is the "main" include (to assign category 0, see above), use this regex of allowed suffixes to the header stem. A partial match is done, so that: - "" means "arbitrary suffix" - "$" means "no suffix"

For example, if configured to "(_test)?$", then a header a.h would be seen as the "main" include in both a.cc and a_test.cc.

IncludeIsMainSourceRegex (String) clang-format 10 ¶ <IncludeIsMainSourceRegex>

Specify a regular expression for files being formatted that are allowed to be considered "main" in the file-to-main-include mapping.

By default, clang-format considers files as "main" only when they end with: .c, .cc, .cpp, .c++, .cxx, .m or .mm extensions. For these files a guessing of "main" include takes place (to assign category 0, see above). This config option allows for additional suffixes and extensions for files to be considered as "main".

For example, if this option is configured to (Impl\.hpp)$, then a file ClassImpl.hpp is considered "main" (in addition to Class.c, Class.cc, Class.cpp and so on) and "main include file" logic will be executed (with IncludeIsMainRegex setting also being respected in later phase). Without this option set, ClassImpl.hpp would not have the main include file put on top before any other include.

IndentAccessModifiers (Boolean) clang-format 13 ¶ <IndentAccessModifiers>

Specify whether access modifiers should have their own indentation level.

When false, access modifiers are indented (or outdented) relative to the record members, respecting the AccessModifierOffset. Record members are indented one level below the record. When true, access modifiers get their own indentation level. As a consequence, record members are always indented 2 levels below the record, regardless of the access modifier presence. Value of the AccessModifierOffset is ignored.

false:                                 true:
class C {                      vs.     class C {
  class D {                                class D {
    void bar();                                void bar();
  protected:                                 protected:
    D();                                       D();
  };                                       };
public:                                  public:
  C();                                     C();
};                                     };
void foo() {                           void foo() {
  return 1;                              return 1;
}                                      }
IndentCaseBlocks (Boolean) clang-format 11 ¶ <IndentCaseBlocks>

Indent case label blocks one level from the case label.

When false, the block following the case label uses the same indentation level as for the case label, treating the case label the same as an if-statement. When true, the block gets indented as a scope block.

false:                                 true:
switch (fool) {                vs.     switch (fool) {
case 1: {                              case 1:
  bar();                                 {
} break;                                   bar();
default: {                               }
  plop();                                break;
}                                      default:
}                                        {
                                           plop();
                                         }
                                       }
IndentCaseLabels (Boolean) clang-format 3.3 ¶ <IndentCaseLabels>

Indent case labels one level from the switch statement.

When false, use the same indentation level as for the switch statement. Switch statement body is always indented one level more than case labels (except the first block following the case label, which itself indents the code - unless IndentCaseBlocks is enabled).

false:                                 true:
switch (fool) {                vs.     switch (fool) {
case 1:                                  case 1:
  bar();                                   bar();
  break;                                   break;
default:                                 default:
  plop();                                  plop();
}                                      }
IndentExternBlock (IndentExternBlockStyle) clang-format 11 ¶ <IndentExternBlock>

IndentExternBlockStyle is the type of indenting of extern blocks.

Possible values:

IndentGotoLabels (Boolean) clang-format 10 ¶ <IndentGotoLabels>

Indent goto labels.

When false, goto labels are flushed left.

true:                                  false:
int f() {                      vs.     int f() {
  if (foo()) {                           if (foo()) {
  label1:                              label1:
    bar();                                 bar();
  }                                      }
label2:                                label2:
  return 1;                              return 1;
}                                      }
IndentPPDirectives (PPDirectiveIndentStyle) clang-format 6 ¶ <IndentPPDirectives>

The preprocessor directive indenting style to use.

Possible values:

IndentRequiresClause (Boolean) clang-format 15 ¶ <IndentRequiresClause>

Indent the requires clause in a template. This only applies when RequiresClausePosition is OwnLine, or WithFollowing.

In clang-format 12, 13 and 14 it was named IndentRequires.

true:
template <typename It>
  requires Iterator<It>
void sort(It begin, It end) {
  //....
}

false:
template <typename It>
requires Iterator<It>
void sort(It begin, It end) {
  //....
}
IndentWidth (Unsigned) clang-format 3.7 ¶ <IndentWidth>

The number of columns to use for indentation.

IndentWidth: 3

void f() {
   someFunction();
   if (true, false) {
      f();
   }
}
IndentWrappedFunctionNames (Boolean) clang-format 3.7 ¶ <IndentWrappedFunctionNames>

Indent if a function definition or declaration is wrapped after the type.

true:
LoooooooooooooooooooooooooooooooooooooooongReturnType
    LoooooooooooooooooooooooooooooooongFunctionDeclaration();

false:
LoooooooooooooooooooooooooooooooooooooooongReturnType
LoooooooooooooooooooooooooooooooongFunctionDeclaration();
InsertBraces (Boolean) clang-format 15 ¶ <InsertBraces>

Insert braces after control statements (if, else, for, do, and while) in C++ unless the control statements are inside macro definitions or the braces would enclose preprocessor directives.

Warning

Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.

false:                                    true:

if (isa<FunctionDecl>(D))        vs.      if (isa<FunctionDecl>(D)) {
  handleFunctionDecl(D);                    handleFunctionDecl(D);
else if (isa<VarDecl>(D))                 } else if (isa<VarDecl>(D)) {
  handleVarDecl(D);                         handleVarDecl(D);
else                                      } else {
  return;                                   return;
                                          }

while (i--)                      vs.      while (i--) {
  for (auto *A : D.attrs())                 for (auto *A : D.attrs()) {
    handleAttr(A);                            handleAttr(A);
                                            }
                                          }

do                               vs.      do {
  --i;                                      --i;
while (i);                                } while (i);
InsertNewlineAtEOF (Boolean) clang-format 16 ¶ <InsertNewlineAtEOF>

Insert a newline at end of file if missing.

InsertTrailingCommas (TrailingCommaStyle) clang-format 11 ¶ <InsertTrailingCommas>

If set to TCS_Wrapped will insert trailing commas in container literals (arrays and objects) that wrap across multiple lines. It is currently only available for JavaScript and disabled by default TCS_None. InsertTrailingCommas cannot be used together with BinPackArguments as inserting the comma disables bin-packing.

TSC_Wrapped:
const someArray = [
aaaaaaaaaaaaaaaaaaaaaaaaaa,
aaaaaaaaaaaaaaaaaaaaaaaaaa,
aaaaaaaaaaaaaaaaaaaaaaaaaa,
//                        ^ inserted
]

Possible values:

  • TCS_None (in configuration: None) Do not insert trailing commas.
  • TCS_Wrapped (in configuration: Wrapped) Insert trailing commas in container literals that were wrapped over multiple lines. Note that this is conceptually incompatible with bin-packing, because the trailing comma is used as an indicator that a container should be formatted one-per-line (i.e. not bin-packed). So inserting a trailing comma counteracts bin-packing.
IntegerLiteralSeparator (IntegerLiteralSeparatorStyle) clang-format 16 ¶ <IntegerLiteralSeparator>

Format integer literal separators (' for C++ and _ for C#, Java, and JavaScript).

Nested configuration flags:

Separator format of integer literals of different bases.

If negative, remove separators. If 0, leave the literal as is. If positive, insert separators between digits starting from the rightmost digit.

For example, the config below will leave separators in binary literals alone, insert separators in decimal literals to separate the digits into groups of 3, and remove separators in hexadecimal literals.

IntegerLiteralSeparator:
  Binary: 0
  Decimal: 3
  Hex: -1

You can also specify a minimum number of digits (BinaryMinDigits, DecimalMinDigits, and HexMinDigits) the integer literal must have in order for the separators to be inserted.

  • int8_t Binary Format separators in binary literals.

    /* -1: */ b = 0b100111101101;
/*  0: */ b = 0b10011'11'0110'1;
/*  3: */ b = 0b100'111'101'101;
/*  4: */ b = 0b1001'1110'1101;

  • int8_t BinaryMinDigits Format separators in binary literals with a minimum number of digits.

    // Binary: 3
// BinaryMinDigits: 7
b1 = 0b101101;
b2 = 0b1'101'101;

  • int8_t Decimal Format separators in decimal literals.

    /* -1: */ d = 18446744073709550592ull;
/*  0: */ d = 184467'440737'0'95505'92ull;
/*  3: */ d = 18'446'744'073'709'550'592ull;

  • int8_t DecimalMinDigits Format separators in decimal literals with a minimum number of digits.

    // Decimal: 3
// DecimalMinDigits: 5
d1 = 2023;
d2 = 10'000;

  • int8_t Hex Format separators in hexadecimal literals.

    /* -1: */ h = 0xDEADBEEFDEADBEEFuz;
/*  0: */ h = 0xDEAD'BEEF'DE'AD'BEE'Fuz;
/*  2: */ h = 0xDE'AD'BE'EF'DE'AD'BE'EFuz;

  • int8_t HexMinDigits Format separators in hexadecimal literals with a minimum number of digits.

    // Hex: 2
// HexMinDigits: 6
h1 = 0xABCDE;
h2 = 0xAB'CD'EF;
JavaImportGroups (List of Strings) clang-format 8 ¶ <JavaImportGroups>

A vector of prefixes ordered by the desired groups for Java imports.

One group's prefix can be a subset of another - the longest prefix is always matched. Within a group, the imports are ordered lexicographically. Static imports are grouped separately and follow the same group rules. By default, static imports are placed before non-static imports, but this behavior is changed by another option, SortJavaStaticImport.

In the .clang-format configuration file, this can be configured like in the following yaml example. This will result in imports being formatted as in the Java example below.

JavaImportGroups: ['com.example', 'com', 'org']
import static com.example.function1;

import static com.test.function2;

import static org.example.function3;

import com.example.ClassA;
import com.example.Test;
import com.example.a.ClassB;

import com.test.ClassC;

import org.example.ClassD;
JavaScriptQuotes (JavaScriptQuoteStyle) clang-format 3.9 ¶ <JavaScriptQuotes>

The JavaScriptQuoteStyle to use for JavaScript strings.

Possible values:

  • JSQS_Leave (in configuration: Leave) Leave string quotes as they are.

    string1 = "foo";
string2 = 'bar';

  • JSQS_Single (in configuration: Single) Always use single quotes.

    string1 = 'foo';
string2 = 'bar';

  • JSQS_Double (in configuration: Double) Always use double quotes.

    string1 = "foo";
string2 = "bar";
JavaScriptWrapImports (Boolean) clang-format 3.9 ¶ <JavaScriptWrapImports>

Whether to wrap JavaScript import/export statements.

true:
import {
    VeryLongImportsAreAnnoying,
    VeryLongImportsAreAnnoying,
    VeryLongImportsAreAnnoying,
} from 'some/module.js'

false:
import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,} from "some/module.js"
KeepEmptyLinesAtEOF (Boolean) clang-format 17 ¶ <KeepEmptyLinesAtEOF>

Keep empty lines (up to MaxEmptyLinesToKeep) at end of file.

KeepEmptyLinesAtTheStartOfBlocks (Boolean) clang-format 3.7 ¶ <KeepEmptyLinesAtTheStartOfBlocks>

If true, the empty line at the start of blocks is kept.

true:                                  false:
if (foo) {                     vs.     if (foo) {
                                         bar();
  bar();                               }
}
LambdaBodyIndentation (LambdaBodyIndentationKind) clang-format 13 ¶ <LambdaBodyIndentation>

The indentation style of lambda bodies. Signature (the default) causes the lambda body to be indented one additional level relative to the indentation level of the signature. OuterScope forces the lambda body to be indented one additional level relative to the parent scope containing the lambda signature.

Possible values:

Language (LanguageKind) clang-format 3.5 ¶ <Language>

Language, this format style is targeted at.

Possible values:

  • LK_None (in configuration: None) Do not use.
  • LK_Cpp (in configuration: Cpp) Should be used for C, C++.
  • LK_CSharp (in configuration: CSharp) Should be used for C#.
  • LK_Java (in configuration: Java) Should be used for Java.
  • LK_JavaScript (in configuration: JavaScript) Should be used for JavaScript.
  • LK_Json (in configuration: Json) Should be used for JSON.
  • LK_ObjC (in configuration: ObjC) Should be used for Objective-C, Objective-C++.
  • LK_Proto (in configuration: Proto) Should be used for Protocol Buffers (https://developers.google.com/protocol-buffers/).
  • LK_TableGen (in configuration: TableGen) Should be used for TableGen code.
  • LK_TextProto (in configuration: TextProto) Should be used for Protocol Buffer messages in text format (https://developers.google.com/protocol-buffers/).
  • LK_Verilog (in configuration: Verilog) Should be used for Verilog and SystemVerilog. https://standards.ieee.org/ieee/1800/6700/ https://sci-hub.st/10.1109/IEEESTD.2018.8299595
LineEnding (LineEndingStyle) clang-format 16 ¶ <LineEnding>

Line ending style (\n or \r\n) to use.

Possible values:

  • LE_LF (in configuration: LF) Use \n.
  • LE_CRLF (in configuration: CRLF) Use \r\n.
  • LE_DeriveLF (in configuration: DeriveLF) Use \n unless the input has more lines ending in \r\n.
  • LE_DeriveCRLF (in configuration: DeriveCRLF) Use \r\n unless the input has more lines ending in \n.
MacroBlockBegin (String) clang-format 3.7 ¶ <MacroBlockBegin>

A regular expression matching macros that start a block.

# With:
MacroBlockBegin: "^NS_MAP_BEGIN|\
NS_TABLE_HEAD$"
MacroBlockEnd: "^\
NS_MAP_END|\
NS_TABLE_.*_END$"

NS_MAP_BEGIN
  foo();
NS_MAP_END

NS_TABLE_HEAD
  bar();
NS_TABLE_FOO_END

# Without:
NS_MAP_BEGIN
foo();
NS_MAP_END

NS_TABLE_HEAD
bar();
NS_TABLE_FOO_END
MacroBlockEnd (String) clang-format 3.7 ¶ <MacroBlockEnd>

A regular expression matching macros that end a block.

Macros (List of Strings) clang-format 17 ¶ <Macros>

A list of macros of the form <definition>=<expansion> .

Code will be parsed with macros expanded, in order to determine how to interpret and format the macro arguments.

For example, the code:

A(a*b);

will usually be interpreted as a call to a function A, and the multiplication expression will be formatted as a * b.

If we specify the macro definition:

Macros:
- A(x)=x

the code will now be parsed as a declaration of the variable b of type a*, and formatted as a* b (depending on pointer-binding rules).

Features and restrictions:
  • Both function-like macros and object-like macros are supported.
  • Macro arguments must be used exactly once in the expansion.
  • No recursive expansion; macros referencing other macros will be ignored.
  • Overloading by arity is supported: for example, given the macro definitions A=x, A()=y, A(a)=a
A; -> x;
A(); -> y;
A(z); -> z;
A(a, b); // will not be expanded.
MaxEmptyLinesToKeep (Unsigned) clang-format 3.7 ¶ <MaxEmptyLinesToKeep>

The maximum number of consecutive empty lines to keep.

MaxEmptyLinesToKeep: 1         vs.     MaxEmptyLinesToKeep: 0
int f() {                              int f() {
  int = 1;                                 int i = 1;
                                           i = foo();
  i = foo();                               return i;
                                       }
  return i;
}
NamespaceIndentation (NamespaceIndentationKind) clang-format 3.7 ¶ <NamespaceIndentation>

The indentation used for namespaces.

Possible values:

NamespaceMacros (List of Strings) clang-format 9 ¶ <NamespaceMacros>

A vector of macros which are used to open namespace blocks.

These are expected to be macros of the form:

NAMESPACE(<namespace-name>, ...) {
  <namespace-content>
}

For example: TESTSUITE

ObjCBinPackProtocolList (BinPackStyle) clang-format 7 ¶ <ObjCBinPackProtocolList>

Controls bin-packing Objective-C protocol conformance list items into as few lines as possible when they go over ColumnLimit.

If Auto (the default), delegates to the value in BinPackParameters. If that is true, bin-packs Objective-C protocol conformance list items into as few lines as possible whenever they go over ColumnLimit.

If Always, always bin-packs Objective-C protocol conformance list items into as few lines as possible whenever they go over ColumnLimit.

If Never, lays out Objective-C protocol conformance list items onto individual lines whenever they go over ColumnLimit.

Always (or Auto, if BinPackParameters=true):
@interface ccccccccccccc () <
    ccccccccccccc, ccccccccccccc,
    ccccccccccccc, ccccccccccccc> {
}

Never (or Auto, if BinPackParameters=false):
@interface ddddddddddddd () <
    ddddddddddddd,
    ddddddddddddd,
    ddddddddddddd,
    ddddddddddddd> {
}

Possible values:

  • BPS_Auto (in configuration: Auto) Automatically determine parameter bin-packing behavior.
  • BPS_Always (in configuration: Always) Always bin-pack parameters.
  • BPS_Never (in configuration: Never) Never bin-pack parameters.
ObjCBlockIndentWidth (Unsigned) clang-format 3.7 ¶ <ObjCBlockIndentWidth>

The number of characters to use for indentation of ObjC blocks.

ObjCBlockIndentWidth: 4

[operation setCompletionBlock:^{
    [self onOperationDone];
}];
ObjCBreakBeforeNestedBlockParam (Boolean) clang-format 11 ¶ <ObjCBreakBeforeNestedBlockParam>

Break parameters list into lines when there is nested block parameters in a function call.

false:
 - (void)_aMethod
 {
     [self.test1 t:self w:self callback:^(typeof(self) self, NSNumber
     *u, NSNumber *v) {
         u = c;
     }]
 }
 true:
 - (void)_aMethod
 {
    [self.test1 t:self
                 w:self
        callback:^(typeof(self) self, NSNumber *u, NSNumber *v) {
             u = c;
         }]
 }
ObjCSpaceAfterProperty (Boolean) clang-format 3.7 ¶ <ObjCSpaceAfterProperty>

Add a space after @property in Objective-C, i.e. use @property (readonly) instead of @property(readonly).

ObjCSpaceBeforeProtocolList (Boolean) clang-format 3.7 ¶ <ObjCSpaceBeforeProtocolList>

Add a space in front of an Objective-C protocol list, i.e. use Foo <Protocol> instead of Foo<Protocol>.

PPIndentWidth (Integer) clang-format 13 ¶ <PPIndentWidth>

The number of columns to use for indentation of preprocessor statements. When set to -1 (default) IndentWidth is used also for preprocessor statements.

PPIndentWidth: 1

#ifdef __linux__
# define FOO
#else
# define BAR
#endif
PackConstructorInitializers (PackConstructorInitializersStyle) clang-format 14 ¶ <PackConstructorInitializers>

The pack constructor initializers style to use.

Possible values:

PenaltyBreakAssignment (Unsigned) clang-format 5 ¶ <PenaltyBreakAssignment>

The penalty for breaking around an assignment operator.

PenaltyBreakBeforeFirstCallParameter (Unsigned) clang-format 3.7 ¶ <PenaltyBreakBeforeFirstCallParameter>

The penalty for breaking a function call after call(.

PenaltyBreakComment (Unsigned) clang-format 3.7 ¶ <PenaltyBreakComment>

The penalty for each line break introduced inside a comment.

PenaltyBreakFirstLessLess (Unsigned) clang-format 3.7 ¶ <PenaltyBreakFirstLessLess>

The penalty for breaking before the first <<.

PenaltyBreakOpenParenthesis (Unsigned) clang-format 14 ¶ <PenaltyBreakOpenParenthesis>

The penalty for breaking after (.

PenaltyBreakString (Unsigned) clang-format 3.7 ¶ <PenaltyBreakString>

The penalty for each line break introduced inside a string literal.

PenaltyBreakTemplateDeclaration (Unsigned) clang-format 7 ¶ <PenaltyBreakTemplateDeclaration>

The penalty for breaking after template declaration.

PenaltyExcessCharacter (Unsigned) clang-format 3.7 ¶ <PenaltyExcessCharacter>

The penalty for each character outside of the column limit.

PenaltyIndentedWhitespace (Unsigned) clang-format 12 ¶ <PenaltyIndentedWhitespace>

Penalty for each character of whitespace indentation (counted relative to leading non-whitespace column).

PenaltyReturnTypeOnItsOwnLine (Unsigned) clang-format 3.7 ¶ <PenaltyReturnTypeOnItsOwnLine>

Penalty for putting the return type of a function onto its own line.

PointerAlignment (PointerAlignmentStyle) clang-format 3.7 ¶ <PointerAlignment>

Pointer and reference alignment style.

Possible values:

  • PAS_Left (in configuration: Left) Align pointer to the left.

    int* a;

  • PAS_Right (in configuration: Right) Align pointer to the right.

    int *a;

  • PAS_Middle (in configuration: Middle) Align pointer in the middle.

    int * a;
QualifierAlignment (QualifierAlignmentStyle) clang-format 14 ¶ <QualifierAlignment>

Different ways to arrange specifiers and qualifiers (e.g. const/volatile).

Warning

Setting QualifierAlignment to something other than Leave, COULD lead to incorrect code formatting due to incorrect decisions made due to clang-formats lack of complete semantic information. As such extra care should be taken to review code changes made by the use of this option.

Possible values:

  • QAS_Leave (in configuration: Leave) Don't change specifiers/qualifiers to either Left or Right alignment (default).

    int const a;
const int *a;

  • QAS_Left (in configuration: Left) Change specifiers/qualifiers to be left-aligned.

    const int a;
const int *a;

  • QAS_Right (in configuration: Right) Change specifiers/qualifiers to be right-aligned.

    int const a;
int const *a;

  • QAS_Custom (in configuration: Custom) Change specifiers/qualifiers to be aligned based on QualifierOrder. With:

    QualifierOrder: ['inline', 'static', 'type', 'const']
    int const a;
int const *a;
QualifierOrder (List of Strings) clang-format 14 ¶ <QualifierOrder>

The order in which the qualifiers appear. Order is an array that can contain any of the following:

  • const
  • inline
  • static
  • friend
  • constexpr
  • volatile
  • restrict
  • type

Note

it MUST contain 'type'.

Items to the left of 'type' will be placed to the left of the type and aligned in the order supplied. Items to the right of 'type' will be placed to the right of the type and aligned in the order supplied.

QualifierOrder: ['inline', 'static', 'type', 'const', 'volatile' ]
RawStringFormats (List of RawStringFormats) clang-format 6 ¶ <RawStringFormats>

Defines hints for detecting supported languages code blocks in raw strings.

A raw string with a matching delimiter or a matching enclosing function name will be reformatted assuming the specified language based on the style for that language defined in the .clang-format file. If no style has been defined in the .clang-format file for the specific language, a predefined style given by 'BasedOnStyle' is used. If 'BasedOnStyle' is not found, the formatting is based on llvm style. A matching delimiter takes precedence over a matching enclosing function name for determining the language of the raw string contents.

If a canonical delimiter is specified, occurrences of other delimiters for the same language will be updated to the canonical if possible.

There should be at most one specification per language and each delimiter and enclosing function should not occur in multiple specifications.

To configure this in the .clang-format file, use:

RawStringFormats:
  - Language: TextProto
      Delimiters:
        - 'pb'
        - 'proto'
      EnclosingFunctions:
        - 'PARSE_TEXT_PROTO'
      BasedOnStyle: google
  - Language: Cpp
      Delimiters:
        - 'cc'
        - 'cpp'
      BasedOnStyle: llvm
      CanonicalDelimiter: 'cc'
ReferenceAlignment (ReferenceAlignmentStyle) clang-format 13 ¶ <ReferenceAlignment>

Reference alignment style (overrides PointerAlignment for references).

Possible values:

  • RAS_Pointer (in configuration: Pointer) Align reference like PointerAlignment.

  • RAS_Left (in configuration: Left) Align reference to the left.

    int& a;

  • RAS_Right (in configuration: Right) Align reference to the right.

    int &a;

  • RAS_Middle (in configuration: Middle) Align reference in the middle.

    int & a;
ReflowComments (Boolean) clang-format 3.8 ¶ <ReflowComments>

If true, clang-format will attempt to re-flow comments. That is it will touch a comment and reflow long comments into new lines, trying to obey the ColumnLimit.

false:
// veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information
/* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information */

true:
// veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of
// information
/* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of
 * information */
RemoveBracesLLVM (Boolean) clang-format 14 ¶ <RemoveBracesLLVM>

Remove optional braces of control statements (if, else, for, and while) in C++ according to the LLVM coding style.

Warning

This option will be renamed and expanded to support other styles.

Warning

Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.

false:                                     true:

if (isa<FunctionDecl>(D)) {        vs.     if (isa<FunctionDecl>(D))
  handleFunctionDecl(D);                     handleFunctionDecl(D);
} else if (isa<VarDecl>(D)) {              else if (isa<VarDecl>(D))
  handleVarDecl(D);                          handleVarDecl(D);
}

if (isa<VarDecl>(D)) {             vs.     if (isa<VarDecl>(D)) {
  for (auto *A : D.attrs()) {                for (auto *A : D.attrs())
    if (shouldProcessAttr(A)) {                if (shouldProcessAttr(A))
      handleAttr(A);                             handleAttr(A);
    }                                      }
  }
}

if (isa<FunctionDecl>(D)) {        vs.     if (isa<FunctionDecl>(D))
  for (auto *A : D.attrs()) {                for (auto *A : D.attrs())
    handleAttr(A);                             handleAttr(A);
  }
}

if (auto *D = (T)(D)) {            vs.     if (auto *D = (T)(D)) {
  if (shouldProcess(D)) {                    if (shouldProcess(D))
    handleVarDecl(D);                          handleVarDecl(D);
  } else {                                   else
    markAsIgnored(D);                          markAsIgnored(D);
  }                                        }
}

if (a) {                           vs.     if (a)
  b();                                       b();
} else {                                   else if (c)
  if (c) {                                   d();
    d();                                   else
  } else {                                   e();
    e();
  }
}
RemoveParentheses (RemoveParenthesesStyle) clang-format 17 ¶ <RemoveParentheses>

Remove redundant parentheses.

Warning

Setting this option to any value other than Leave could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.

Possible values:

RemoveSemicolon (Boolean) clang-format 16 ¶ <RemoveSemicolon>

Remove semicolons after the closing brace of a non-empty function.

Warning

Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.

false:                                     true:

int max(int a, int b) {                    int max(int a, int b) {
  return a > b ? a : b;                      return a > b ? a : b;
};                                         }
RequiresClausePosition (RequiresClausePositionStyle) clang-format 15 ¶ <RequiresClausePosition>

The position of the requires clause.

Possible values:

RequiresExpressionIndentation (RequiresExpressionIndentationKind) clang-format 16 ¶ <RequiresExpressionIndentation>

The indentation used for requires expression bodies.

Possible values:

SeparateDefinitionBlocks (SeparateDefinitionStyle) clang-format 14 ¶ <SeparateDefinitionBlocks>

Specifies the use of empty lines to separate definition blocks, including classes, structs, enums, and functions.

Never                  v.s.     Always
#include <cstring>              #include <cstring>
struct Foo {
  int a, b, c;                  struct Foo {
};                                int a, b, c;
namespace Ns {                  };
class Bar {
public:                         namespace Ns {
  struct Foobar {               class Bar {
    int a;                      public:
    int b;                        struct Foobar {
  };                                int a;
private:                            int b;
  int t;                          };
  int method1() {
    // ...                      private:
  }                               int t;
  enum List {
    ITEM1,                        int method1() {
    ITEM2                           // ...
  };                              }
  template<typename T>
  int method2(T x) {              enum List {
    // ...                          ITEM1,
  }                                 ITEM2
  int i, j, k;                    };
  int method3(int par) {
    // ...                        template<typename T>
  }                               int method2(T x) {
};                                  // ...
class C {};                       }
}
                                  int i, j, k;

                                  int method3(int par) {
                                    // ...
                                  }
                                };

                                class C {};
                                }

Possible values:

  • SDS_Leave (in configuration: Leave) Leave definition blocks as they are.
  • SDS_Always (in configuration: Always) Insert an empty line between definition blocks.
  • SDS_Never (in configuration: Never) Remove any empty line between definition blocks.
ShortNamespaceLines (Unsigned) clang-format 13 ¶ <ShortNamespaceLines>

The maximal number of unwrapped lines that a short namespace spans. Defaults to 1.

This determines the maximum length of short namespaces by counting unwrapped lines (i.e. containing neither opening nor closing namespace brace) and makes "FixNamespaceComments" omit adding end comments for those.

ShortNamespaceLines: 1     vs.     ShortNamespaceLines: 0
namespace a {                      namespace a {
  int foo;                           int foo;
}                                  } // namespace a

ShortNamespaceLines: 1     vs.     ShortNamespaceLines: 0
namespace b {                      namespace b {
  int foo;                           int foo;
  int bar;                           int bar;
} // namespace b                   } // namespace b
SortIncludes (SortIncludesOptions) clang-format 3.8 ¶ <SortIncludes>

Controls if and how clang-format will sort #includes.

Possible values:

SortJavaStaticImport (SortJavaStaticImportOptions) clang-format 12 ¶ <SortJavaStaticImport>

When sorting Java imports, by default static imports are placed before non-static imports. If JavaStaticImportAfterImport is After, static imports are placed after non-static imports.

Possible values:

  • SJSIO_Before (in configuration: Before) Static imports are placed before non-static imports.

    import static org.example.function1;

import org.example.ClassA;

  • SJSIO_After (in configuration: After) Static imports are placed after non-static imports.

    import org.example.ClassA;

import static org.example.function1;
SortUsingDeclarations (SortUsingDeclarationsOptions) clang-format 5 ¶ <SortUsingDeclarations>

Controls if and how clang-format will sort using declarations.

Possible values:

SpaceAfterCStyleCast (Boolean) clang-format 3.5 ¶ <SpaceAfterCStyleCast>

If true, a space is inserted after C style casts.

true:                                  false:
(int) i;                       vs.     (int)i;
SpaceAfterLogicalNot (Boolean) clang-format 9 ¶ <SpaceAfterLogicalNot>

If true, a space is inserted after the logical not operator (!).

true:                                  false:
! someExpression();            vs.     !someExpression();
SpaceAfterTemplateKeyword (Boolean) clang-format 4 ¶ <SpaceAfterTemplateKeyword>

If true, a space will be inserted after the 'template' keyword.

true:                                  false:
template <int> void foo();     vs.     template<int> void foo();
SpaceAroundPointerQualifiers (SpaceAroundPointerQualifiersStyle) clang-format 12 ¶ <SpaceAroundPointerQualifiers>

Defines in which cases to put a space before or after pointer qualifiers

Possible values:

SpaceBeforeAssignmentOperators (Boolean) clang-format 3.7 ¶ <SpaceBeforeAssignmentOperators>

If false, spaces will be removed before assignment operators.

true:                                  false:
int a = 5;                     vs.     int a= 5;
a += 42;                               a+= 42;
SpaceBeforeCaseColon (Boolean) clang-format 12 ¶ <SpaceBeforeCaseColon>

If false, spaces will be removed before case colon.

true:                                   false
switch (x) {                    vs.     switch (x) {
  case 1 : break;                         case 1: break;
}                                       }
SpaceBeforeCpp11BracedList (Boolean) clang-format 7 ¶ <SpaceBeforeCpp11BracedList>

If true, a space will be inserted before a C++11 braced list used to initialize an object (after the preceding identifier or type).

true:                                  false:
Foo foo { bar };               vs.     Foo foo{ bar };
Foo {};                                Foo{};
vector<int> { 1, 2, 3 };               vector<int>{ 1, 2, 3 };
new int[3] { 1, 2, 3 };                new int[3]{ 1, 2, 3 };
SpaceBeforeCtorInitializerColon (Boolean) clang-format 7 ¶ <SpaceBeforeCtorInitializerColon>

If false, spaces will be removed before constructor initializer colon.

true:                                  false:
Foo::Foo() : a(a) {}                   Foo::Foo(): a(a) {}
SpaceBeforeInheritanceColon (Boolean) clang-format 7 ¶ <SpaceBeforeInheritanceColon>

If false, spaces will be removed before inheritance colon.

true:                                  false:
class Foo : Bar {}             vs.     class Foo: Bar {}
SpaceBeforeJsonColon (Boolean) clang-format 17 ¶ <SpaceBeforeJsonColon>

If true, a space will be added before a JSON colon. For other languages, e.g. JavaScript, use SpacesInContainerLiterals instead.

true:                                  false:
{                                      {
  "key" : "value"              vs.       "key": "value"
}                                      }
SpaceBeforeParens (SpaceBeforeParensStyle) clang-format 3.5 ¶ <SpaceBeforeParens>

Defines in which cases to put a space before opening parentheses.

Possible values:

  • SBPO_Never (in configuration: Never) Never put a space before opening parentheses.

    void f() {
  if(true) {
    f();
  }
}

  • SBPO_ControlStatements (in configuration: ControlStatements) Put a space before opening parentheses only after control statement keywords (for/if/while...).

    void f() {
  if (true) {
    f();
  }
}

  • SBPO_ControlStatementsExceptControlMacros (in configuration: ControlStatementsExceptControlMacros) Same as SBPO_ControlStatements except this option doesn't apply to ForEach and If macros. This is useful in projects where ForEach/If macros are treated as function calls instead of control statements. SBPO_ControlStatementsExceptForEachMacros remains an alias for backward compatibility.

    void f() {
  Q_FOREACH(...) {
    f();
  }
}

  • SBPO_NonEmptyParentheses (in configuration: NonEmptyParentheses) Put a space before opening parentheses only if the parentheses are not empty i.e. '()'

    void() {
  if (true) {
    f();
    g (x, y, z);
  }
}

  • SBPO_Always (in configuration: Always) Always put a space before opening parentheses, except when it's prohibited by the syntax rules (in function-like macro definitions) or when determined by other style rules (after unary operators, opening parentheses, etc.)

    void f () {
  if (true) {
    f ();
  }
}
  • SBPO_Custom (in configuration: Custom) Configure each individual space before parentheses in SpaceBeforeParensOptions.
SpaceBeforeParensOptions (SpaceBeforeParensCustom) clang-format 14 ¶ <SpaceBeforeParensOptions>

Control of individual space before parentheses.

If SpaceBeforeParens is set to Custom, use this to specify how each individual space before parentheses case should be handled. Otherwise, this is ignored.

# Example of usage:
SpaceBeforeParens: Custom
SpaceBeforeParensOptions:
  AfterControlStatements: true
  AfterFunctionDefinitionName: true

Nested configuration flags:

Precise control over the spacing before parentheses.

# Should be declared this way:
SpaceBeforeParens: Custom
SpaceBeforeParensOptions:
  AfterControlStatements: true
  AfterFunctionDefinitionName: true
SpaceBeforeRangeBasedForLoopColon (Boolean) clang-format 7 ¶ <SpaceBeforeRangeBasedForLoopColon>

If false, spaces will be removed before range-based for loop colon.

true:                                  false:
for (auto v : values) {}       vs.     for(auto v: values) {}
SpaceBeforeSquareBrackets (Boolean) clang-format 10 ¶ <SpaceBeforeSquareBrackets>

If true, spaces will be before [. Lambdas will not be affected. Only the first [ will get a space added.

true:                                  false:
int a [5];                    vs.      int a[5];
int a [5][5];                 vs.      int a[5][5];
SpaceInEmptyBlock (Boolean) clang-format 10 ¶ <SpaceInEmptyBlock>

If true, spaces will be inserted into {}.

true:                                false:
void f() { }                   vs.   void f() {}
while (true) { }                     while (true) {}
SpaceInEmptyParentheses (Boolean) clang-format 3.7 ¶ <SpaceInEmptyParentheses>

If true, spaces may be inserted into (). This option is deprecated. See InEmptyParentheses of SpacesInParensOptions.

SpacesBeforeTrailingComments (Unsigned) clang-format 3.7 ¶ <SpacesBeforeTrailingComments>

The number of spaces before trailing line comments (// - comments).

This does not affect trailing block comments (/* - comments) as those commonly have different usage patterns and a number of special cases. In the case of Verilog, it doesn't affect a comment right after the opening parenthesis in the port or parameter list in a module header, because it is probably for the port on the following line instead of the parenthesis it follows.

SpacesBeforeTrailingComments: 3
void f() {
  if (true) {   // foo1
    f();        // bar
  }             // foo
}
SpacesInAngles (SpacesInAnglesStyle) clang-format 3.4 ¶ <SpacesInAngles>

The SpacesInAnglesStyle to use for template argument lists.

Possible values:

SpacesInCStyleCastParentheses (Boolean) clang-format 3.7 ¶ <SpacesInCStyleCastParentheses>

If true, spaces may be inserted into C style casts. This option is deprecated. See InCStyleCasts of SpacesInParensOptions.

SpacesInConditionalStatement (Boolean) clang-format 10 ¶ <SpacesInConditionalStatement>

If true, spaces will be inserted around if/for/switch/while conditions. This option is deprecated. See InConditionalStatements of SpacesInParensOptions.

SpacesInContainerLiterals (Boolean) clang-format 3.7 ¶ <SpacesInContainerLiterals>

If true, spaces are inserted inside container literals (e.g. ObjC and Javascript array and dict literals). For JSON, use SpaceBeforeJsonColon instead.

true:                                  false:
var arr = [ 1, 2, 3 ];         vs.     var arr = [1, 2, 3];
f({a : 1, b : 2, c : 3});              f({a: 1, b: 2, c: 3});
SpacesInLineCommentPrefix (SpacesInLineComment) clang-format 13 ¶ <SpacesInLineCommentPrefix>

How many spaces are allowed at the start of a line comment. To disable the maximum set it to -1, apart from that the maximum takes precedence over the minimum.

Minimum = 1
Maximum = -1
// One space is forced

//  but more spaces are possible

Minimum = 0
Maximum = 0
//Forces to start every comment directly after the slashes

Note that in line comment sections the relative indent of the subsequent lines is kept, that means the following:

before:                                   after:
Minimum: 1
//if (b) {                                // if (b) {
//  return true;                          //   return true;
//}                                       // }

Maximum: 0
/// List:                                 ///List:
///  - Foo                                /// - Foo
///    - Bar                              ///   - Bar

This option has only effect if ReflowComments is set to true.

Nested configuration flags:

Control of spaces within a single line comment.

  • unsigned Minimum The minimum number of spaces at the start of the comment.
  • unsigned Maximum The maximum number of spaces at the start of the comment.
SpacesInParens (SpacesInParensStyle) clang-format 17 ¶ <SpacesInParens>

Defines in which cases spaces will be inserted after ( and before ).

Possible values:

  • SIPO_Never (in configuration: Never) Never put a space in parentheses.

    void f() {
  if(true) {
    f();
  }
}
  • SIPO_Custom (in configuration: Custom) Configure each individual space in parentheses in SpacesInParensOptions.
SpacesInParensOptions (SpacesInParensCustom) clang-format 17 ¶ <SpacesInParensOptions>

Control of individual spaces in parentheses.

If SpacesInParens is set to Custom, use this to specify how each individual space in parentheses case should be handled. Otherwise, this is ignored.

# Example of usage:
SpacesInParens: Custom
SpacesInParensOptions:
  InConditionalStatements: true
  InEmptyParentheses: true

Nested configuration flags:

Precise control over the spacing in parentheses.

# Should be declared this way:
SpacesInParens: Custom
SpacesInParensOptions:
  InConditionalStatements: true
  Other: true
SpacesInParentheses (Boolean) clang-format 3.7 ¶ <SpacesInParentheses>

If true, spaces will be inserted after ( and before ). This option is deprecated. The previous behavior is preserved by using SpacesInParens with Custom and by setting all SpacesInParensOptions to true except for InCStyleCasts and InEmptyParentheses.

SpacesInSquareBrackets (Boolean) clang-format 3.7 ¶ <SpacesInSquareBrackets>

If true, spaces will be inserted after [ and before ]. Lambdas without arguments or unspecified size array declarations will not be affected.

true:                                  false:
int a[ 5 ];                    vs.     int a[5];
std::unique_ptr<int[]> foo() {} // Won't be affected
Standard (LanguageStandard) clang-format 3.7 ¶ <Standard>

Parse and format C++ constructs compatible with this standard.

c++03:                                 latest:
vector<set<int> > x;           vs.     vector<set<int>> x;

Possible values:

  • LS_Cpp03 (in configuration: c++03) Parse and format as C++03. Cpp03 is a deprecated alias for c++03
  • LS_Cpp11 (in configuration: c++11) Parse and format as C++11.
  • LS_Cpp14 (in configuration: c++14) Parse and format as C++14.
  • LS_Cpp17 (in configuration: c++17) Parse and format as C++17.
  • LS_Cpp20 (in configuration: c++20) Parse and format as C++20.
  • LS_Latest (in configuration: Latest) Parse and format using the latest supported language version. Cpp11 is a deprecated alias for Latest
  • LS_Auto (in configuration: Auto) Automatic detection based on the input.
StatementAttributeLikeMacros (List of Strings) clang-format 12 ¶ <StatementAttributeLikeMacros>

Macros which are ignored in front of a statement, as if they were an attribute. So that they are not parsed as identifier, for example for Qts emit.

AlignConsecutiveDeclarations: true
StatementAttributeLikeMacros: []
unsigned char data = 'x';
emit          signal(data); // This is parsed as variable declaration.

AlignConsecutiveDeclarations: true
StatementAttributeLikeMacros: [emit]
unsigned char data = 'x';
emit signal(data); // Now it's fine again.
StatementMacros (List of Strings) clang-format 8 ¶ <StatementMacros>

A vector of macros that should be interpreted as complete statements.

Typical macros are expressions, and require a semi-colon to be added; sometimes this is not the case, and this allows to make clang-format aware of such cases.

For example: Q_UNUSED

TabWidth (Unsigned) clang-format 3.7 ¶ <TabWidth>

The number of columns used for tab stops.

TypeNames (List of Strings) clang-format 17 ¶ <TypeNames>

A vector of non-keyword identifiers that should be interpreted as type names.

A *, &, or && between a type name and another non-keyword identifier is annotated as a pointer or reference token instead of a binary operator.

TypenameMacros (List of Strings) clang-format 9 ¶ <TypenameMacros>

A vector of macros that should be interpreted as type declarations instead of as function calls.

These are expected to be macros of the form:

STACK_OF(...)

In the .clang-format configuration file, this can be configured like:

TypenameMacros: ['STACK_OF', 'LIST']

For example: OpenSSL STACK_OF, BSD LIST_ENTRY.

UseCRLF (Boolean) clang-format 10 ¶ <UseCRLF>

This option is deprecated. See LF and CRLF of LineEnding.

UseTab (UseTabStyle) clang-format 3.7 ¶ <UseTab>

The way to use tab characters in the resulting file.

Possible values:

  • UT_Never (in configuration: Never) Never use tab.
  • UT_ForIndentation (in configuration: ForIndentation) Use tabs only for indentation.
  • UT_ForContinuationAndIndentation (in configuration: ForContinuationAndIndentation) Fill all leading whitespace with tabs, and use spaces for alignment that appears within a line (e.g. consecutive assignments and declarations).
  • UT_AlignWithSpaces (in configuration: AlignWithSpaces) Use tabs for line continuation and indentation, and spaces for alignment.
  • UT_Always (in configuration: Always) Use tabs whenever we need to fill whitespace that spans at least from one tab stop to the next one.
VerilogBreakBetweenInstancePorts (Boolean) clang-format 17 ¶ <VerilogBreakBetweenInstancePorts>

For Verilog, put each port on its own line in module instantiations.

true:
ffnand ff1(.q(),
           .qbar(out1),
           .clear(in1),
           .preset(in2));

false:
ffnand ff1(.q(), .qbar(out1), .clear(in1), .preset(in2));
WhitespaceSensitiveMacros (List of Strings) clang-format 11 ¶ <WhitespaceSensitiveMacros>

A vector of macros which are whitespace-sensitive and should not be touched.

These are expected to be macros of the form:

STRINGIZE(...)

In the .clang-format configuration file, this can be configured like:

WhitespaceSensitiveMacros: ['STRINGIZE', 'PP_STRINGIZE']

For example: BOOST_PP_STRINGIZE

Adding additional style options

Each additional style option adds costs to the clang-format project. Some of these costs affect the clang-format development itself, as we need to make sure that any given combination of options work and that new features don't break any of the existing options in any way. There are also costs for end users as options become less discoverable and people have to think about and make a decision on options they don't really care about.

The goal of the clang-format project is more on the side of supporting a limited set of styles really well as opposed to supporting every single style used by a codebase somewhere in the wild. Of course, we do want to support all major projects and thus have established the following bar for adding style options. Each new style option must ..

  • be used in a project of significant size (have dozens of contributors)
  • have a publicly accessible style guide
  • have a person willing to contribute and maintain patches

Examples

A style similar to the Linux Kernel style:

BasedOnStyle: LLVM
IndentWidth: 8
UseTab: Always
BreakBeforeBraces: Linux
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false

The result is (imagine that tabs are used for indentation here):

void test()
{
        switch (x) {
        case 0:
        case 1:
                do_something();
                break;
        case 2:
                do_something_else();
                break;
        default:
                break;
        }
        if (condition)
                do_something_completely_different();

        if (x == y) {
                q();
        } else if (x > y) {
                w();
        } else {
                r();
        }
}

A style similar to the default Visual Studio formatting style:

UseTab: Never
IndentWidth: 4
BreakBeforeBraces: Allman
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false
ColumnLimit: 0

The result is:

void test()
{
    switch (suffix)
    {
    case 0:
    case 1:
        do_something();
        break;
    case 2:
        do_something_else();
        break;
    default:
        break;
    }
    if (condition)
        do_something_completely_different();

    if (x == y)
    {
        q();
    }
    else if (x > y)
    {
        w();
    }
    else
    {
        r();
    }
}