clang-format (.clang-format)

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

clang-format 3.3

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

clang-format 3.8

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

clang-format 13

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.

clang-format 17

Style of aligning consecutive short case labels.

clang-format 5

Options for aligning backslashes in escaped newlines.

clang-format 3.5

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

Control of trailing comments.

clang-format 9

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.

clang-format 9

This option is deprecated in clang-format 15. See NextLine of PackConstructorInitializers.

If a constructor definition with a member initializer list doesn't fit on a single line, allow putting all member initializers onto the next line, if ConstructorInitializerAllOnOneLineOrOnePerLine is true. Note that this parameter has no effect if ConstructorInitializerAllOnOneLineOrOnePerLine is false.

clang-format 3.3

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.

clang-format 18

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

clang-format 11

Allow short enums on a single line.

clang-format 3.5

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

clang-format 3.6

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

clang-format 18

Allow short compound requirement on a single line.

clang-format 3.5

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

clang-format 9

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

clang-format 3.3

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

clang-format 3.7

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

clang-format 3.7

This option is deprecated and is retained for backwards compatibility.

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

clang-format 19

The function declaration return type breaking style to use.

clang-format 3.4

If true, always break before multiline string literals.

clang-format 19

The template declaration breaking style to use.

clang-format 12

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.

clang-format 3.7

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

clang-format 3.7

The bin pack parameters style to use.

clang-format 12

The BitFieldColonSpacingStyle to use for bitfields.

clang-format 3.8

Control of individual brace wrapping cases. If BreakBeforeBraces is set to Custom, use this to specify how each individual brace case should be handled. Otherwise, this is ignored.

clang-format 17

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

clang-format 18

Break between adjacent string literals.

clang-format 16

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

clang-format 3.8

Break after each annotation on a field in Java files.

clang-format 16

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).

clang-format 16

The inline ASM colon style to use..

clang-format 3.6

The way to wrap binary operators.

clang-format 3.7

The brace breaking style to use.

clang-format 12

The concept declaration style to use.

clang-format 3.7

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

clang-format 5

The constructor initializers style to use.

clang-format 7

The inheritance list style to use.

clang-format 3.9

Allow breaking string literals when formatting.

clang-format 3.7

The column limit.

clang-format 3.7

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

clang-format 5

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

clang-format 3.7

This option is deprecated. See CurrentLine of PackConstructorInitializers.

clang-format 3.7

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

clang-format 3.7

Indent width for line continuations.

clang-format 3.4

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

clang-format 10

Deprecated. See DeriveLF and DeriveCRLF of LineEnding.

clang-format 3.7

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.

clang-format 3.7

Disables formatting completely.

clang-format 13

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

clang-format 12

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

clang-format 3.7

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

clang-format 5

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.

clang-format 3.7

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

clang-format 13

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

clang-format 6

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

clang-format 3.8

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.

clang-format 3.9

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.

clang-format 10

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". 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".

clang-format 13

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.

clang-format 11

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.

clang-format 3.3

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).

clang-format 11

IndentExternBlockStyle is the type of indenting of extern blocks.

clang-format 10

Indent goto labels. When false, goto labels are flushed left.

clang-format 6

The preprocessor directive indenting style to use.

clang-format 15

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

clang-format 12-14

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.

clang-format 3.7

The number of columns to use for indentation.

clang-format 3.7

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

clang-format 15

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.

clang-format 16

Insert a newline at end of file if missing.

clang-format 11

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.

clang-format 16

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

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.

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.

clang-format 3.9

The JavaScriptQuoteStyle to use for JavaScript strings.

clang-format 3.9

Whether to wrap JavaScript import/export statements.

clang-format 17

This option is deprecated. See AtEndOfFile of KeepEmptyLines.

clang-format 3.7

This option is deprecated. See AtStartOfBlock of KeepEmptyLines.

clang-format 13

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.

clang-format 3.5

Language, this format style is targeted at.

clang-format 16

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

clang-format 3.7

A regular expression matching macros that start a block.

clang-format 3.7

A regular expression matching macros that end a block.

clang-format 17

A list of macros of the form =.

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

clang-format 3.7

The maximum number of consecutive empty lines to keep.

clang-format 3.7

The indentation used for namespaces.

clang-format 9

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

clang-format 7

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.

clang-format 3.7

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

clang-format 11

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

clang-format 18

The order in which ObjC property attributes should appear.

Attributes in code will be sorted in the order specified. Any attributes encountered that are not mentioned in this array will be sorted last, in stable order. Comments between attributes will leave the attributes untouched.

clang-format 3.7

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

clang-format 3.7

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

clang-format 13

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

clang-format 14

The pack constructor initializers style to use.

clang-format 5

The penalty for breaking around an assignment operator.

clang-format 3.7

The penalty for breaking a function call after call(.

clang-format 3.7

The penalty for each line break introduced inside a comment.

clang-format 3.7

The penalty for breaking before the first <<.

clang-format 14

The penalty for breaking after (.

clang-format 18

The penalty for breaking after ::.

clang-format 3.7

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

clang-format 7

The penalty for breaking after template declaration.

clang-format 3.7

The penalty for each character outside of the column limit.

clang-format 12

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

clang-format 3.7

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

clang-format 3.7

Pointer and reference alignment style.

clang-format 14

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.

clang-format 14

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

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.

clang-format 6

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

clang-format 13

Reference alignment style (overrides PointerAlignment for references).

clang-format 3.8

Comment reformatting style.

clang-format 16

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.

clang-format 14

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.

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.

clang-format 17

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.

clang-format 15

The position of the requires clause.

clang-format 16

The indentation used for requires expression bodies.

clang-format 14

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

clang-format 13

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

clang-format 18

Do not format macro definition body.

clang-format 3.8

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

clang-format 12

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.

clang-format 5

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

clang-format 3.5

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

clang-format 9

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

clang-format 4

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

clang-format 12

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

clang-format 3.7

If false, spaces will be removed before assignment operators.

clang-format 12

If false, spaces will be removed before case colon.

clang-format 7

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

clang-format 7

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

clang-format 7

If false, spaces will be removed before inheritance colon.

clang-format 17

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

clang-format 3.5

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

clang-format 14

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.

clang-format 7

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

clang-format 10

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

clang-format 10

If true, spaces will be inserted into {}.

clang-format 3.7

If true, spaces may be inserted into (). This option is deprecated in clang-format 17. See InEmptyParentheses of SpacesInParensOptions.

clang-format 3.7

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.

clang-format 3.4

The SpacesInAnglesStyle to use for template argument lists.

clang-format 3.7

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

clang-format 10

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

clang-format 3.7

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

clang-format 13

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.

In clang-format 16, this option has only effect if ReflowComments is set to true.

clang-format 17

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

clang-format 17

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.

clang-format 3.7

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

clang-format 3.7

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

clang-format 3.7

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

clang-format 12

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.

clnag-format 8

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.

clang-format 3.7

The number of columns used for tab stops.

clang-format 17

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.

clang-format 9

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

For example: OpenSSL STACK_OF, BSD LIST_ENTRY.

clang-format 10

Use instead of for line breaks. Also used as fallback if DeriveLineEnding is true.

This option is deprecated in clang-format 16. See LF and CRLF of LineEnding.

clang-format 3.7

The way to use tab characters in the resulting file.

clang-format 17

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

clang-format 11

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

For example: BOOST_PP_STRINGIZE

clang-format 19

Style of aligning consecutive TableGen DAGArg operator colons. If enabled, align the colon inside DAGArg which have line break inside. This works only when TableGenBreakInsideDAGArg is BreakElements or BreakAll and the DAGArg is not excepted by TableGenBreakingDAGArgOperators’s effect.

clang-format 19

Style of aligning consecutive TableGen cond operator colons. Align the colons of cases inside !cond operators.

clang-format 19

Style of aligning consecutive TableGen definition colons. This aligns the inheritance colons of consecutive definitions.

clang-format 19

Whether to merge a short switch labeled rule into a single line.

clang-format 20

If true, namespace a { class b; } can be put on a single line.

clang-format 21

If BinPackLongBracedList is true it overrides BinPackArguments if there are 20 or more items in a braced initializer list.

clang-format 19

The function declaration return type breaking style to use.

clang-format 21

If true, break before a template closing bracket (>) when there is a line break after the matching opening bracket (<).

clang-format 20

The break binary operations style to use.

clang-format 19

If true, clang-format will always break before function definition parameters.

clang-format 19

The template declaration breaking style to use.

clang-format 21

Insert a comma (if missing) or remove the comma at the end of an enum enumerator list.

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.

clang-format 20

If true, clang-format will indent the body of an export { ... } block. This doesn’t affect the formatting of anything else related to exported declarations.

clang-format 8

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

clang-format 19

Which empty lines are kept. See MaxEmptyLinesToKeep for how many consecutive empty lines are kept.

clang-format 20

Keep the form feed character if it's immediately preceded and followed by a newline.

clang-format 21

A vector of function-like macros whose invocations should be skipped by RemoveParentheses.

clang-format 19

When guessing whether a #include is the "main" include, only the include directives that use the specified character are considered.

clang-format 21

A regular expression that describes markers for turning formatting off for one line.

clang-format 20

The penalty for breaking before a member access operator (., ->).

clang-format 20

Remove empty lines within unwrapped lines.

clang-format 21

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

clang-format 19

The styles of the line break inside the DAGArg in TableGen.

clang-format 19

Works only when TableGenBreakInsideDAGArg is not DontBreak. If any identifier is specified, this limits the line breaks by TableGenBreakInsideDAGArg option only on DAGArg values beginning with the specified identifiers.

clang-format 20

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

A < after a template name is annotated as a template opener instead of a binary operator.

clang-format 20

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

A ) after a variable template instantiation is not annotated as the closing parenthesis of C-style cast operator.

clang-format 20

Wrap namespace body with empty lines.