..
!!!!NOTE!!!!
This file is automatically generated, in part. Do not edit the style options
in this file directly. Instead, modify them in include/clang/Format/Format.h
and run the docs/tools/dump_format_style.py script to update this file.
.. raw:: html
<style type="text/css">
.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"; }
</style>
.. role:: versionbadge
==========================
Clang-Format Style Options
==========================
:doc:`ClangFormatStyleOptions` describes configurable formatting style options
supported by :doc:`LibFormat` and :doc:`ClangFormat`.
When using :program:`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
===================================
:program:`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``, :program:`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>``, :program:`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:
.. code-block:: yaml
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 :program:`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 :program:`clang-format` uses to detect the
language.
An example of a configuration file for multiple languages:
.. code-block:: yaml
---
# 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:
.. code-block:: console
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:
.. code-block:: console
-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.
.. code-block:: c++
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
<https://clang.llvm.org/doxygen/structclang_1_1format_1_1FormatStyle.html>`_
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:
**BasedOnStyle** (``String``) :ref:`¶ <BasedOnStyle>`
The style used for all options not specifically set in the configuration.
This option is supported only in the :program:`clang-format` configuration
(both within ``-style='{...}'`` and the ``.clang-format`` file).
Possible values:
* ``LLVM``
A style complying with the `LLVM coding standards
<https://llvm.org/docs/CodingStandards.html>`_
* ``Google``
A style complying with `Google's C++ style guide
<https://google.github.io/styleguide/cppguide.html>`_
* ``Chromium``
A style complying with `Chromium's style guide
<https://chromium.googlesource.com/chromium/src/+/refs/heads/main/styleguide/styleguide.md>`_
* ``Mozilla``
A style complying with `Mozilla's style guide
<https://firefox-source-docs.mozilla.org/code-quality/coding-style/index.html>`_
* ``WebKit``
A style complying with `WebKit's style guide
<https://www.webkit.org/coding/coding-style.html>`_
* ``Microsoft``
A style complying with `Microsoft's style guide
<https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference>`_
* ``GNU``
A style complying with the `GNU coding standards
<https://www.gnu.org/prep/standards/standards.html>`_
* ``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}``
.. START_FORMAT_STYLE_OPTIONS
.. _AccessModifierOffset:
**AccessModifierOffset** (``Integer``) :versionbadge:`clang-format 3.3` :ref:`¶ <AccessModifierOffset>`
The extra indent or outdent of access modifiers, e.g. ``public:``.
.. _AlignAfterOpenBracket:
**AlignAfterOpenBracket** (``BracketAlignmentStyle``) :versionbadge:`clang-format 3.8` :ref:`¶ <AlignAfterOpenBracket>`
If ``true``, horizontally aligns arguments after an open bracket.
This applies to round brackets (parentheses), angle brackets and square
brackets.
Possible values:
* ``BAS_Align`` (in configuration: ``Align``)
Align parameters on the open bracket, e.g.:
.. code-block:: c++
someLongFunction(argument1,
argument2);
* ``BAS_DontAlign`` (in configuration: ``DontAlign``)
Don't align, instead use ``ContinuationIndentWidth``, e.g.:
.. code-block:: c++
someLongFunction(argument1,
argument2);
* ``BAS_AlwaysBreak`` (in configuration: ``AlwaysBreak``)
Always break after an open bracket, if the parameters don't fit
on a single line, e.g.:
.. code-block:: c++
someLongFunction(
argument1, argument2);
* ``BAS_BlockIndent`` (in configuration: ``BlockIndent``)
Always break after an open bracket, if the parameters don't fit
on a single line. Closing brackets will be placed on a new line.
E.g.:
.. code-block:: c++
someLongFunction(
argument1, argument2
)
.. note::
This currently only applies to braced initializer lists (when
``Cpp11BracedListStyle`` is ``true``) and parentheses.
.. _AlignArrayOfStructures:
**AlignArrayOfStructures** (``ArrayInitializerAlignmentStyle``) :versionbadge:`clang-format 13` :ref:`¶ <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:
* ``AIAS_Left`` (in configuration: ``Left``)
Align array column and left justify the columns e.g.:
.. code-block:: c++
struct test demo[] =
{
{56, 23, "hello"},
{-1, 93463, "world"},
{7, 5, "!!" }
};
* ``AIAS_Right`` (in configuration: ``Right``)
Align array column and right justify the columns e.g.:
.. code-block:: c++
struct test demo[] =
{
{56, 23, "hello"},
{-1, 93463, "world"},
{ 7, 5, "!!"}
};
* ``AIAS_None`` (in configuration: ``None``)
Don't align array initializer columns.
.. _AlignConsecutiveAssignments:
**AlignConsecutiveAssignments** (``AlignConsecutiveStyle``) :versionbadge:`clang-format 3.8` :ref:`¶ <AlignConsecutiveAssignments>`
Style of aligning consecutive assignments.
``Consecutive`` will result in formattings like:
.. code-block:: c++
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.
.. code-block:: c++
AlignConsecutiveAssignments: AcrossEmptyLines
AlignConsecutiveAssignments:
Enabled: true
AcrossEmptyLines: true
AcrossComments: false
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;
* ``bool AlignCompound`` Only for ``AlignConsecutiveAssignments``. Whether compound assignments
like ``+=`` are aligned along with ``=``.
.. code-block:: c++
true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;
* ``bool AlignFunctionDeclarations`` Only for ``AlignConsecutiveDeclarations``. Whether function declarations
are aligned.
.. code-block:: c++
true:
unsigned int f1(void);
void f2(void);
size_t f3(void);
false:
unsigned int f1(void);
void f2(void);
size_t f3(void);
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``. Whether function pointers are
aligned.
.. code-block:: c++
true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
* ``bool PadOperators`` Only for ``AlignConsecutiveAssignments``. Whether short assignment
operators are left-padded to the same length as long ones in order to
put all assignment operators to the right of the left hand side.
.. code-block:: c++
true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
.. _AlignConsecutiveBitFields:
**AlignConsecutiveBitFields** (``AlignConsecutiveStyle``) :versionbadge:`clang-format 11` :ref:`¶ <AlignConsecutiveBitFields>`
Style of aligning consecutive bit fields.
``Consecutive`` will align the bitfield separators of consecutive lines.
This will result in formattings like:
.. code-block:: c++
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.
.. code-block:: c++
AlignConsecutiveBitFields: AcrossEmptyLines
AlignConsecutiveBitFields:
Enabled: true
AcrossEmptyLines: true
AcrossComments: false
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;
* ``bool AlignCompound`` Only for ``AlignConsecutiveAssignments``. Whether compound assignments
like ``+=`` are aligned along with ``=``.
.. code-block:: c++
true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;
* ``bool AlignFunctionDeclarations`` Only for ``AlignConsecutiveDeclarations``. Whether function declarations
are aligned.
.. code-block:: c++
true:
unsigned int f1(void);
void f2(void);
size_t f3(void);
false:
unsigned int f1(void);
void f2(void);
size_t f3(void);
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``. Whether function pointers are
aligned.
.. code-block:: c++
true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
* ``bool PadOperators`` Only for ``AlignConsecutiveAssignments``. Whether short assignment
operators are left-padded to the same length as long ones in order to
put all assignment operators to the right of the left hand side.
.. code-block:: c++
true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
.. _AlignConsecutiveDeclarations:
**AlignConsecutiveDeclarations** (``AlignConsecutiveStyle``) :versionbadge:`clang-format 3.8` :ref:`¶ <AlignConsecutiveDeclarations>`
Style of aligning consecutive declarations.
``Consecutive`` will align the declaration names of consecutive lines.
This will result in formattings like:
.. code-block:: c++
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.
.. code-block:: c++
AlignConsecutiveDeclarations: AcrossEmptyLines
AlignConsecutiveDeclarations:
Enabled: true
AcrossEmptyLines: true
AcrossComments: false
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;
* ``bool AlignCompound`` Only for ``AlignConsecutiveAssignments``. Whether compound assignments
like ``+=`` are aligned along with ``=``.
.. code-block:: c++
true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;
* ``bool AlignFunctionDeclarations`` Only for ``AlignConsecutiveDeclarations``. Whether function declarations
are aligned.
.. code-block:: c++
true:
unsigned int f1(void);
void f2(void);
size_t f3(void);
false:
unsigned int f1(void);
void f2(void);
size_t f3(void);
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``. Whether function pointers are
aligned.
.. code-block:: c++
true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
* ``bool PadOperators`` Only for ``AlignConsecutiveAssignments``. Whether short assignment
operators are left-padded to the same length as long ones in order to
put all assignment operators to the right of the left hand side.
.. code-block:: c++
true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
.. _AlignConsecutiveMacros:
**AlignConsecutiveMacros** (``AlignConsecutiveStyle``) :versionbadge:`clang-format 9` :ref:`¶ <AlignConsecutiveMacros>`
Style of aligning consecutive macro definitions.
``Consecutive`` will result in formattings like:
.. code-block:: c++
#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.
.. code-block:: c++
AlignConsecutiveMacros: AcrossEmptyLines
AlignConsecutiveMacros:
Enabled: true
AcrossEmptyLines: true
AcrossComments: false
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;
* ``bool AlignCompound`` Only for ``AlignConsecutiveAssignments``. Whether compound assignments
like ``+=`` are aligned along with ``=``.
.. code-block:: c++
true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;
* ``bool AlignFunctionDeclarations`` Only for ``AlignConsecutiveDeclarations``. Whether function declarations
are aligned.
.. code-block:: c++
true:
unsigned int f1(void);
void f2(void);
size_t f3(void);
false:
unsigned int f1(void);
void f2(void);
size_t f3(void);
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``. Whether function pointers are
aligned.
.. code-block:: c++
true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
* ``bool PadOperators`` Only for ``AlignConsecutiveAssignments``. Whether short assignment
operators are left-padded to the same length as long ones in order to
put all assignment operators to the right of the left hand side.
.. code-block:: c++
true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
.. _AlignConsecutiveShortCaseStatements:
**AlignConsecutiveShortCaseStatements** (``ShortCaseStatementsAlignmentStyle``) :versionbadge:`clang-format 17` :ref:`¶ <AlignConsecutiveShortCaseStatements>`
Style of aligning consecutive short case labels.
Only applies if ``AllowShortCaseExpressionOnASingleLine`` or
``AllowShortCaseLabelsOnASingleLine`` is ``true``.
.. code-block:: yaml
# Example of usage:
AlignConsecutiveShortCaseStatements:
Enabled: true
AcrossEmptyLines: true
AcrossComments: true
AlignCaseColons: false
Nested configuration flags:
Alignment options.
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
true:
switch (level) {
case log::info: return "info:";
case log::warning: return "warning:";
default: return "";
}
false:
switch (level) {
case log::info: return "info:";
case log::warning: return "warning:";
default: return "";
}
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
switch (level) {
case log::info: return "info:";
case log::warning: return "warning:";
default: return "";
}
false:
switch (level) {
case log::info: return "info:";
case log::warning: return "warning:";
default: return "";
}
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
switch (level) {
case log::info: return "info:";
case log::warning: return "warning:";
/* A comment. */
default: return "";
}
false:
switch (level) {
case log::info: return "info:";
case log::warning: return "warning:";
/* A comment. */
default: return "";
}
* ``bool AlignCaseArrows`` Whether to align the case arrows when aligning short case expressions.
.. code-block:: java
true:
i = switch (day) {
case THURSDAY, SATURDAY -> 8;
case WEDNESDAY -> 9;
default -> 0;
};
false:
i = switch (day) {
case THURSDAY, SATURDAY -> 8;
case WEDNESDAY -> 9;
default -> 0;
};
* ``bool AlignCaseColons`` Whether aligned case labels are aligned on the colon, or on the tokens
after the colon.
.. code-block:: c++
true:
switch (level) {
case log::info : return "info:";
case log::warning: return "warning:";
default : return "";
}
false:
switch (level) {
case log::info: return "info:";
case log::warning: return "warning:";
default: return "";
}
.. _AlignConsecutiveTableGenBreakingDAGArgColons:
**AlignConsecutiveTableGenBreakingDAGArgColons** (``AlignConsecutiveStyle``) :versionbadge:`clang-format 19` :ref:`¶ <AlignConsecutiveTableGenBreakingDAGArgColons>`
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.
.. code-block:: c++
let dagarg = (ins
a :$src1,
aa :$src2,
aaa:$src3
)
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.
.. code-block:: c++
AlignConsecutiveTableGenBreakingDAGArgColons: AcrossEmptyLines
AlignConsecutiveTableGenBreakingDAGArgColons:
Enabled: true
AcrossEmptyLines: true
AcrossComments: false
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;
* ``bool AlignCompound`` Only for ``AlignConsecutiveAssignments``. Whether compound assignments
like ``+=`` are aligned along with ``=``.
.. code-block:: c++
true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;
* ``bool AlignFunctionDeclarations`` Only for ``AlignConsecutiveDeclarations``. Whether function declarations
are aligned.
.. code-block:: c++
true:
unsigned int f1(void);
void f2(void);
size_t f3(void);
false:
unsigned int f1(void);
void f2(void);
size_t f3(void);
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``. Whether function pointers are
aligned.
.. code-block:: c++
true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
* ``bool PadOperators`` Only for ``AlignConsecutiveAssignments``. Whether short assignment
operators are left-padded to the same length as long ones in order to
put all assignment operators to the right of the left hand side.
.. code-block:: c++
true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
.. _AlignConsecutiveTableGenCondOperatorColons:
**AlignConsecutiveTableGenCondOperatorColons** (``AlignConsecutiveStyle``) :versionbadge:`clang-format 19` :ref:`¶ <AlignConsecutiveTableGenCondOperatorColons>`
Style of aligning consecutive TableGen cond operator colons.
Align the colons of cases inside !cond operators.
.. code-block:: c++
!cond(!eq(size, 1) : 1,
!eq(size, 16): 1,
true : 0)
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.
.. code-block:: c++
AlignConsecutiveTableGenCondOperatorColons: AcrossEmptyLines
AlignConsecutiveTableGenCondOperatorColons:
Enabled: true
AcrossEmptyLines: true
AcrossComments: false
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;
* ``bool AlignCompound`` Only for ``AlignConsecutiveAssignments``. Whether compound assignments
like ``+=`` are aligned along with ``=``.
.. code-block:: c++
true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;
* ``bool AlignFunctionDeclarations`` Only for ``AlignConsecutiveDeclarations``. Whether function declarations
are aligned.
.. code-block:: c++
true:
unsigned int f1(void);
void f2(void);
size_t f3(void);
false:
unsigned int f1(void);
void f2(void);
size_t f3(void);
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``. Whether function pointers are
aligned.
.. code-block:: c++
true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
* ``bool PadOperators`` Only for ``AlignConsecutiveAssignments``. Whether short assignment
operators are left-padded to the same length as long ones in order to
put all assignment operators to the right of the left hand side.
.. code-block:: c++
true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
.. _AlignConsecutiveTableGenDefinitionColons:
**AlignConsecutiveTableGenDefinitionColons** (``AlignConsecutiveStyle``) :versionbadge:`clang-format 19` :ref:`¶ <AlignConsecutiveTableGenDefinitionColons>`
Style of aligning consecutive TableGen definition colons.
This aligns the inheritance colons of consecutive definitions.
.. code-block:: c++
def Def : Parent {}
def DefDef : Parent {}
def DefDefDef : Parent {}
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.
.. code-block:: c++
AlignConsecutiveTableGenDefinitionColons: AcrossEmptyLines
AlignConsecutiveTableGenDefinitionColons:
Enabled: true
AcrossEmptyLines: true
AcrossComments: false
* ``bool Enabled`` Whether aligning is enabled.
.. code-block:: c++
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
int a = 1;
int somelongname = 2;
double c = 3;
int aaaa : 1;
int b : 12;
int ccc : 8;
int aaaa = 12;
float b = 23;
std::string ccc;
* ``bool AcrossEmptyLines`` Whether to align across empty lines.
.. code-block:: c++
true:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
false:
int a = 1;
int somelongname = 2;
double c = 3;
int d = 3;
* ``bool AcrossComments`` Whether to align across comments.
.. code-block:: c++
true:
int d = 3;
/* A comment. */
double e = 4;
false:
int d = 3;
/* A comment. */
double e = 4;
* ``bool AlignCompound`` Only for ``AlignConsecutiveAssignments``. Whether compound assignments
like ``+=`` are aligned along with ``=``.
.. code-block:: c++
true:
a &= 2;
bbb = 2;
false:
a &= 2;
bbb = 2;
* ``bool AlignFunctionDeclarations`` Only for ``AlignConsecutiveDeclarations``. Whether function declarations
are aligned.
.. code-block:: c++
true:
unsigned int f1(void);
void f2(void);
size_t f3(void);
false:
unsigned int f1(void);
void f2(void);
size_t f3(void);
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``. Whether function pointers are
aligned.
.. code-block:: c++
true:
unsigned i;
int &r;
int *p;
int (*f)();
false:
unsigned i;
int &r;
int *p;
int (*f)();
* ``bool PadOperators`` Only for ``AlignConsecutiveAssignments``. Whether short assignment
operators are left-padded to the same length as long ones in order to
put all assignment operators to the right of the left hand side.
.. code-block:: c++
true:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
false:
a >>= 2;
bbb = 2;
a = 2;
bbb >>= 2;
.. _AlignEscapedNewlines:
**AlignEscapedNewlines** (``EscapedNewlineAlignmentStyle``) :versionbadge:`clang-format 5` :ref:`¶ <AlignEscapedNewlines>`
Options for aligning backslashes in escaped newlines.
Possible values:
* ``ENAS_DontAlign`` (in configuration: ``DontAlign``)
Don't align escaped newlines.
.. code-block:: c++
#define A \
int aaaa; \
int b; \
int dddddddddd;
* ``ENAS_Left`` (in configuration: ``Left``)
Align escaped newlines as far left as possible.
.. code-block:: c++
#define A \
int aaaa; \
int b; \
int dddddddddd;
* ``ENAS_LeftWithLastLine`` (in configuration: ``LeftWithLastLine``)
Align escaped newlines as far left as possible, using the last line of
the preprocessor directive as the reference if it's the longest.
.. code-block:: c++
#define A \
int aaaa; \
int b; \
int dddddddddd;
* ``ENAS_Right`` (in configuration: ``Right``)
Align escaped newlines in the right-most column.
.. code-block:: c++
#define A \
int aaaa; \
int b; \
int dddddddddd;
.. _AlignOperands:
**AlignOperands** (``OperandAlignmentStyle``) :versionbadge:`clang-format 3.5` :ref:`¶ <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.:
.. code-block:: c++
int aaa = bbbbbbbbbbbbbbb +
ccccccccccccccc;
When ``BreakBeforeBinaryOperators`` is set, the wrapped operator is
aligned with the operand on the first line.
.. code-block:: c++
int aaa = bbbbbbbbbbbbbbb
+ ccccccccccccccc;
* ``OAS_AlignAfterOperator`` (in configuration: ``AlignAfterOperator``)
Horizontally align operands of binary and ternary expressions.
This is similar to ``OAS_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.
.. code-block:: c++
int aaa = bbbbbbbbbbbbbbb
+ ccccccccccccccc;
.. _AlignTrailingComments:
**AlignTrailingComments** (``TrailingCommentsAlignmentStyle``) :versionbadge:`clang-format 3.7` :ref:`¶ <AlignTrailingComments>`
Control of trailing comments.
The alignment stops at closing braces after a line break, and only
followed by other closing braces, a (``do-``) ``while``, a lambda call, or
a semicolon.
.. 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.
.. code-block:: yaml
# Example of usage:
AlignTrailingComments:
Kind: Always
OverEmptyLines: 2
Nested configuration flags:
Alignment options
* ``TrailingCommentsAlignmentKinds Kind``
Specifies the way to align trailing comments.
Possible values:
* ``TCAS_Leave`` (in configuration: ``Leave``)
Leave trailing comments as they are.
.. code-block:: c++
int a; // comment
int ab; // comment
int abc; // comment
int abcd; // comment
* ``TCAS_Always`` (in configuration: ``Always``)
Align trailing comments.
.. code-block:: c++
int a; // comment
int ab; // comment
int abc; // comment
int abcd; // comment
* ``TCAS_Never`` (in configuration: ``Never``)
Don't align trailing comments but other formatter applies.
.. code-block:: c++
int a; // comment
int ab; // comment
int abc; // comment
int abcd; // comment
* ``unsigned OverEmptyLines`` How many empty lines to apply alignment.
When both ``MaxEmptyLinesToKeep`` and ``OverEmptyLines`` are set to 2,
it formats like below.
.. code-block:: c++
int a; // all these
int ab; // comments are
int abcdef; // aligned
When ``MaxEmptyLinesToKeep`` is set to 2 and ``OverEmptyLines`` is set
to 1, it formats like below.
.. code-block:: c++
int a; // these are
int ab; // aligned
int abcdef; // but this isn't
.. _AllowAllArgumentsOnNextLine:
**AllowAllArgumentsOnNextLine** (``Boolean``) :versionbadge:`clang-format 9` :ref:`¶ <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``.
.. code-block:: c++
true:
callFunction(
a, b, c, d);
false:
callFunction(a,
b,
c,
d);
.. _AllowAllConstructorInitializersOnNextLine:
**AllowAllConstructorInitializersOnNextLine** (``Boolean``) :versionbadge:`clang-format 9` :ref:`¶ <AllowAllConstructorInitializersOnNextLine>`
This option is **deprecated**. See ``NextLine`` of
``PackConstructorInitializers``.
.. _AllowAllParametersOfDeclarationOnNextLine:
**AllowAllParametersOfDeclarationOnNextLine** (``Boolean``) :versionbadge:`clang-format 3.3` :ref:`¶ <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 ``OnePerLine``.
.. code-block:: c++
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:
**AllowBreakBeforeNoexceptSpecifier** (``BreakBeforeNoexceptSpecifierStyle``) :versionbadge:`clang-format 18` :ref:`¶ <AllowBreakBeforeNoexceptSpecifier>`
Controls if there could be a line break before a ``noexcept`` specifier.
Possible values:
* ``BBNSS_Never`` (in configuration: ``Never``)
No line break allowed.
.. code-block:: c++
void foo(int arg1,
double arg2) noexcept;
void bar(int arg1, double arg2) noexcept(
noexcept(baz(arg1)) &&
noexcept(baz(arg2)));
* ``BBNSS_OnlyWithParen`` (in configuration: ``OnlyWithParen``)
For a simple ``noexcept`` there is no line break allowed, but when we
have a condition it is.
.. code-block:: c++
void foo(int arg1,
double arg2) noexcept;
void bar(int arg1, double arg2)
noexcept(noexcept(baz(arg1)) &&
noexcept(baz(arg2)));
* ``BBNSS_Always`` (in configuration: ``Always``)
Line breaks are allowed. But note that because of the associated
penalties ``clang-format`` often prefers not to break before the
``noexcept``.
.. code-block:: c++
void foo(int arg1,
double arg2) noexcept;
void bar(int arg1, double arg2)
noexcept(noexcept(baz(arg1)) &&
noexcept(baz(arg2)));
.. _AllowShortBlocksOnASingleLine:
**AllowShortBlocksOnASingleLine** (``ShortBlockStyle``) :versionbadge:`clang-format 3.5` :ref:`¶ <AllowShortBlocksOnASingleLine>`
Dependent on the value, ``while (true) { continue; }`` can be put on a
single line.
Possible values:
* ``SBS_Never`` (in configuration: ``Never``)
Never merge blocks into a single line.
.. code-block:: c++
while (true) {
}
while (true) {
continue;
}
* ``SBS_Empty`` (in configuration: ``Empty``)
Only merge empty blocks.
.. code-block:: c++
while (true) {}
while (true) {
continue;
}
* ``SBS_Always`` (in configuration: ``Always``)
Always merge short blocks into a single line.
.. code-block:: c++
while (true) {}
while (true) { continue; }
.. _AllowShortCaseExpressionOnASingleLine:
**AllowShortCaseExpressionOnASingleLine** (``Boolean``) :versionbadge:`clang-format 19` :ref:`¶ <AllowShortCaseExpressionOnASingleLine>`
Whether to merge a short switch labeled rule into a single line.
.. code-block:: java
true: false:
switch (a) { vs. switch (a) {
case 1 -> 1; case 1 ->
default -> 0; 1;
}; default ->
0;
};
.. _AllowShortCaseLabelsOnASingleLine:
**AllowShortCaseLabelsOnASingleLine** (``Boolean``) :versionbadge:`clang-format 3.6` :ref:`¶ <AllowShortCaseLabelsOnASingleLine>`
If ``true``, short case labels will be contracted to a single line.
.. code-block:: c++
true: false:
switch (a) { vs. switch (a) {
case 1: x = 1; break; case 1:
case 2: return; x = 1;
} break;
case 2:
return;
}
.. _AllowShortCompoundRequirementOnASingleLine:
**AllowShortCompoundRequirementOnASingleLine** (``Boolean``) :versionbadge:`clang-format 18` :ref:`¶ <AllowShortCompoundRequirementOnASingleLine>`
Allow short compound requirement on a single line.
.. code-block:: c++
true:
template <typename T>
concept c = requires(T x) {
{ x + 1 } -> std::same_as<int>;
};
false:
template <typename T>
concept c = requires(T x) {
{
x + 1
} -> std::same_as<int>;
};
.. _AllowShortEnumsOnASingleLine:
**AllowShortEnumsOnASingleLine** (``Boolean``) :versionbadge:`clang-format 11` :ref:`¶ <AllowShortEnumsOnASingleLine>`
Allow short enums on a single line.
.. code-block:: c++
true:
enum { A, B } myEnum;
false:
enum {
A,
B
} myEnum;
.. _AllowShortFunctionsOnASingleLine:
**AllowShortFunctionsOnASingleLine** (``ShortFunctionStyle``) :versionbadge:`clang-format 3.5` :ref:`¶ <AllowShortFunctionsOnASingleLine>`
Dependent on the value, ``int f() { return 0; }`` can be put on a
single line.
Possible values:
* ``SFS_None`` (in configuration: ``None``)
Never merge functions into a single line.
* ``SFS_InlineOnly`` (in configuration: ``InlineOnly``)
Only merge functions defined inside a class. Same as ``inline``,
except it does not implies ``empty``: i.e. top level empty functions
are not merged either.
.. code-block:: c++
class Foo {
void f() { foo(); }
};
void f() {
foo();
}
void f() {
}
* ``SFS_Empty`` (in configuration: ``Empty``)
Only merge empty functions.
.. code-block:: c++
void f() {}
void f2() {
bar2();
}
* ``SFS_Inline`` (in configuration: ``Inline``)
Only merge functions defined inside a class. Implies ``empty``.
.. code-block:: c++
class Foo {
void f() { foo(); }
};
void f() {
foo();
}
void f() {}
* ``SFS_All`` (in configuration: ``All``)
Merge all functions fitting on a single line.
.. code-block:: c++
class Foo {
void f() { foo(); }
};
void f() { bar(); }
.. _AllowShortIfStatementsOnASingleLine:
**AllowShortIfStatementsOnASingleLine** (``ShortIfStyle``) :versionbadge:`clang-format 3.3` :ref:`¶ <AllowShortIfStatementsOnASingleLine>`
Dependent on the value, ``if (a) return;`` can be put on a single line.
Possible values:
* ``SIS_Never`` (in configuration: ``Never``)
Never put short ifs on the same line.
.. code-block:: c++
if (a)
return;
if (b)
return;
else
return;
if (c)
return;
else {
return;
}
* ``SIS_WithoutElse`` (in configuration: ``WithoutElse``)
Put short ifs on the same line only if there is no else statement.
.. code-block:: c++
if (a) return;
if (b)
return;
else
return;
if (c)
return;
else {
return;
}
* ``SIS_OnlyFirstIf`` (in configuration: ``OnlyFirstIf``)
Put short ifs, but not else ifs nor else statements, on the same line.
.. code-block:: c++
if (a) return;
if (b) return;
else if (b)
return;
else
return;
if (c) return;
else {
return;
}
* ``SIS_AllIfsAndElse`` (in configuration: ``AllIfsAndElse``)
Always put short ifs, else ifs and else statements on the same
line.
.. code-block:: c++
if (a) return;
if (b) return;
else return;
if (c) return;
else {
return;
}
.. _AllowShortLambdasOnASingleLine:
**AllowShortLambdasOnASingleLine** (``ShortLambdaStyle``) :versionbadge:`clang-format 9` :ref:`¶ <AllowShortLambdasOnASingleLine>`
Dependent on the value, ``auto lambda []() { return 0; }`` can be put on a
single line.
Possible values:
* ``SLS_None`` (in configuration: ``None``)
Never merge lambdas into a single line.
* ``SLS_Empty`` (in configuration: ``Empty``)
Only merge empty lambdas.
.. code-block:: c++
auto lambda = [](int a) {};
auto lambda2 = [](int a) {
return a;
};
* ``SLS_Inline`` (in configuration: ``Inline``)
Merge lambda into a single line if the lambda is argument of a function.
.. code-block:: c++
auto lambda = [](int x, int y) {
return x < y;
};
sort(a.begin(), a.end(), [](int x, int y) { return x < y; });
* ``SLS_All`` (in configuration: ``All``)
Merge all lambdas fitting on a single line.
.. code-block:: c++
auto lambda = [](int a) {};
auto lambda2 = [](int a) { return a; };
.. _AllowShortLoopsOnASingleLine:
**AllowShortLoopsOnASingleLine** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <AllowShortLoopsOnASingleLine>`
If ``true``, ``while (true) continue;`` can be put on a single
line.
.. _AlwaysBreakAfterDefinitionReturnType:
**AlwaysBreakAfterDefinitionReturnType** (``DefinitionReturnTypeBreakingStyle``) :versionbadge:`clang-format 3.7` :ref:`¶ <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:
**AlwaysBreakAfterReturnType** (``deprecated``) :versionbadge:`clang-format 3.8` :ref:`¶ <AlwaysBreakAfterReturnType>`
This option is renamed to ``BreakAfterReturnType``.
.. _AlwaysBreakBeforeMultilineStrings:
**AlwaysBreakBeforeMultilineStrings** (``Boolean``) :versionbadge:`clang-format 3.4` :ref:`¶ <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.
.. code-block:: c++
true: false:
aaaa = vs. aaaa = "bbbb"
"bbbb" "cccc";
"cccc";
.. _AlwaysBreakTemplateDeclarations:
**AlwaysBreakTemplateDeclarations** (``deprecated``) :versionbadge:`clang-format 3.4` :ref:`¶ <AlwaysBreakTemplateDeclarations>`
This option is renamed to ``BreakTemplateDeclarations``.
.. _AttributeMacros:
**AttributeMacros** (``List of Strings``) :versionbadge:`clang-format 12` :ref:`¶ <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:
.. code-block:: c++
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:
.. code-block:: yaml
AttributeMacros: [__capability, __output, __unused]
.. _BinPackArguments:
**BinPackArguments** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <BinPackArguments>`
If ``false``, a function call's arguments will either be all on the
same line or will have one line each.
.. code-block:: c++
true:
void f() {
f(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaa,
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);
}
false:
void f() {
f(aaaaaaaaaaaaaaaaaaaa,
aaaaaaaaaaaaaaaaaaaa,
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);
}
.. _BinPackParameters:
**BinPackParameters** (``BinPackParametersStyle``) :versionbadge:`clang-format 3.7` :ref:`¶ <BinPackParameters>`
The bin pack parameters style to use.
Possible values:
* ``BPPS_BinPack`` (in configuration: ``BinPack``)
Bin-pack parameters.
.. code-block:: c++
void f(int a, int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,
int ccccccccccccccccccccccccccccccccccccccccccc);
* ``BPPS_OnePerLine`` (in configuration: ``OnePerLine``)
Put all parameters on the current line if they fit.
Otherwise, put each one on its own line.
.. code-block:: c++
void f(int a, int b, int c);
void f(int a,
int b,
int ccccccccccccccccccccccccccccccccccccc);
* ``BPPS_AlwaysOnePerLine`` (in configuration: ``AlwaysOnePerLine``)
Always put each parameter on its own line.
.. code-block:: c++
void f(int a,
int b,
int c);
.. _BitFieldColonSpacing:
**BitFieldColonSpacing** (``BitFieldColonSpacingStyle``) :versionbadge:`clang-format 12` :ref:`¶ <BitFieldColonSpacing>`
The BitFieldColonSpacingStyle to use for bitfields.
Possible values:
* ``BFCS_Both`` (in configuration: ``Both``)
Add one space on each side of the ``:``
.. code-block:: c++
unsigned bf : 2;
* ``BFCS_None`` (in configuration: ``None``)
Add no space around the ``:`` (except when needed for
``AlignConsecutiveBitFields``).
.. code-block:: c++
unsigned bf:2;
* ``BFCS_Before`` (in configuration: ``Before``)
Add space before the ``:`` only
.. code-block:: c++
unsigned bf :2;
* ``BFCS_After`` (in configuration: ``After``)
Add space after the ``:`` only (space may be added before if
needed for ``AlignConsecutiveBitFields``).
.. code-block:: c++
unsigned bf: 2;
.. _BraceWrapping:
**BraceWrapping** (``BraceWrappingFlags``) :versionbadge:`clang-format 3.8` :ref:`¶ <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.
.. code-block:: yaml
# Example of usage:
BreakBeforeBraces: Custom
BraceWrapping:
AfterEnum: true
AfterStruct: false
SplitEmptyFunction: false
Nested configuration flags:
Precise control over the wrapping of braces.
.. code-block:: c++
# Should be declared this way:
BreakBeforeBraces: Custom
BraceWrapping:
AfterClass: true
* ``bool AfterCaseLabel`` Wrap case labels.
.. code-block:: c++
false: true:
switch (foo) { vs. switch (foo) {
case 1: { case 1:
bar(); {
break; bar();
} break;
default: { }
plop(); default:
} {
} plop();
}
}
* ``bool AfterClass`` Wrap class definitions.
.. code-block:: c++
true:
class foo
{};
false:
class foo {};
* ``BraceWrappingAfterControlStatementStyle AfterControlStatement``
Wrap control statements (``if``/``for``/``while``/``switch``/..).
Possible values:
* ``BWACS_Never`` (in configuration: ``Never``)
Never wrap braces after a control statement.
.. code-block:: c++
if (foo()) {
} else {
}
for (int i = 0; i < 10; ++i) {
}
* ``BWACS_MultiLine`` (in configuration: ``MultiLine``)
Only wrap braces after a multi-line control statement.
.. code-block:: c++
if (foo && bar &&
baz)
{
quux();
}
while (foo || bar) {
}
* ``BWACS_Always`` (in configuration: ``Always``)
Always wrap braces after a control statement.
.. code-block:: c++
if (foo())
{
} else
{}
for (int i = 0; i < 10; ++i)
{}
* ``bool AfterEnum`` Wrap enum definitions.
.. code-block:: c++
true:
enum X : int
{
B
};
false:
enum X : int { B };
* ``bool AfterFunction`` Wrap function definitions.
.. code-block:: c++
true:
void foo()
{
bar();
bar2();
}
false:
void foo() {
bar();
bar2();
}
* ``bool AfterNamespace`` Wrap namespace definitions.
.. code-block:: c++
true:
namespace
{
int foo();
int bar();
}
false:
namespace {
int foo();
int bar();
}
* ``bool AfterObjCDeclaration`` Wrap ObjC definitions (interfaces, implementations...).
.. note::
@autoreleasepool and @synchronized blocks are wrapped
according to ``AfterControlStatement`` flag.
* ``bool AfterStruct`` Wrap struct definitions.
.. code-block:: c++
true:
struct foo
{
int x;
};
false:
struct foo {
int x;
};
* ``bool AfterUnion`` Wrap union definitions.
.. code-block:: c++
true:
union foo
{
int x;
}
false:
union foo {
int x;
}
* ``bool AfterExternBlock`` Wrap extern blocks.
.. code-block:: c++
true:
extern "C"
{
int foo();
}
false:
extern "C" {
int foo();
}
* ``bool BeforeCatch`` Wrap before ``catch``.
.. code-block:: c++
true:
try {
foo();
}
catch () {
}
false:
try {
foo();
} catch () {
}
* ``bool BeforeElse`` Wrap before ``else``.
.. code-block:: c++
true:
if (foo()) {
}
else {
}
false:
if (foo()) {
} else {
}
* ``bool BeforeLambdaBody`` Wrap lambda block.
.. code-block:: c++
true:
connect(
[]()
{
foo();
bar();
});
false:
connect([]() {
foo();
bar();
});
* ``bool BeforeWhile`` Wrap before ``while``.
.. code-block:: c++
true:
do {
foo();
}
while (1);
false:
do {
foo();
} while (1);
* ``bool IndentBraces`` Indent the wrapped braces themselves.
* ``bool SplitEmptyFunction`` If ``false``, empty function body can be put on a single line.
This option is used only if the opening brace of the function has
already been wrapped, i.e. the ``AfterFunction`` brace wrapping mode is
set, and the function could/should not be put on a single line (as per
``AllowShortFunctionsOnASingleLine`` and constructor formatting
options).
.. code-block:: c++
false: true:
int f() vs. int f()
{} {
}
* ``bool SplitEmptyRecord`` If ``false``, empty record (e.g. class, struct or union) body
can be put on a single line. This option is used only if the opening
brace of the record has already been wrapped, i.e. the ``AfterClass``
(for classes) brace wrapping mode is set.
.. code-block:: c++
false: true:
class Foo vs. class Foo
{} {
}
* ``bool SplitEmptyNamespace`` If ``false``, empty namespace body can be put on a single line.
This option is used only if the opening brace of the namespace has
already been wrapped, i.e. the ``AfterNamespace`` brace wrapping mode is
set.
.. code-block:: c++
false: true:
namespace Foo vs. namespace Foo
{} {
}
.. _BracedInitializerIndentWidth:
**BracedInitializerIndentWidth** (``Unsigned``) :versionbadge:`clang-format 17` :ref:`¶ <BracedInitializerIndentWidth>`
The number of columns to use to indent the contents of braced init lists.
If unset, ``ContinuationIndentWidth`` is used.
.. code-block:: c++
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{},
};
}
.. _BreakAdjacentStringLiterals:
**BreakAdjacentStringLiterals** (``Boolean``) :versionbadge:`clang-format 18` :ref:`¶ <BreakAdjacentStringLiterals>`
Break between adjacent string literals.
.. code-block:: c++
true:
return "Code"
"\0\52\26\55\55\0"
"x013"
"\02\xBA";
false:
return "Code" "\0\52\26\55\55\0" "x013" "\02\xBA";
.. _BreakAfterAttributes:
**BreakAfterAttributes** (``AttributeBreakingStyle``) :versionbadge:`clang-format 16` :ref:`¶ <BreakAfterAttributes>`
Break after a group of C++11 attributes before variable or function
(including constructor/destructor) declaration/definition names or before
control statements, i.e. ``if``, ``switch`` (including ``case`` and
``default`` labels), ``for``, and ``while`` statements.
Possible values:
* ``ABS_Always`` (in configuration: ``Always``)
Always break after attributes.
.. code-block:: c++
[[maybe_unused]]
const int i;
[[gnu::const]] [[maybe_unused]]
int j;
[[nodiscard]]
inline int f();
[[gnu::const]] [[nodiscard]]
int g();
[[likely]]
if (a)
f();
else
g();
switch (b) {
[[unlikely]]
case 1:
++b;
break;
[[likely]]
default:
return;
}
* ``ABS_Leave`` (in configuration: ``Leave``)
Leave the line breaking after attributes as is.
.. code-block:: c++
[[maybe_unused]] const int i;
[[gnu::const]] [[maybe_unused]]
int j;
[[nodiscard]] inline int f();
[[gnu::const]] [[nodiscard]]
int g();
[[likely]] if (a)
f();
else
g();
switch (b) {
[[unlikely]] case 1:
++b;
break;
[[likely]]
default:
return;
}
* ``ABS_Never`` (in configuration: ``Never``)
Never break after attributes.
.. code-block:: c++
[[maybe_unused]] const int i;
[[gnu::const]] [[maybe_unused]] int j;
[[nodiscard]] inline int f();
[[gnu::const]] [[nodiscard]] int g();
[[likely]] if (a)
f();
else
g();
switch (b) {
[[unlikely]] case 1:
++b;
break;
[[likely]] default:
return;
}
.. _BreakAfterJavaFieldAnnotations:
**BreakAfterJavaFieldAnnotations** (``Boolean``) :versionbadge:`clang-format 3.8` :ref:`¶ <BreakAfterJavaFieldAnnotations>`
Break after each annotation on a field in Java files.
.. code-block:: java
true: false:
@Partial vs. @Partial @Mock DataLoad loader;
@Mock
DataLoad loader;
.. _BreakAfterReturnType:
**BreakAfterReturnType** (``ReturnTypeBreakingStyle``) :versionbadge:`clang-format 19` :ref:`¶ <BreakAfterReturnType>`
The function declaration return type breaking style to use.
Possible values:
* ``RTBS_None`` (in configuration: ``None``)
This is **deprecated**. See ``Automatic`` below.
* ``RTBS_Automatic`` (in configuration: ``Automatic``)
Break after return type based on ``PenaltyReturnTypeOnItsOwnLine``.
.. code-block:: c++
class A {
int f() { return 0; };
};
int f();
int f() { return 1; }
int
LongName::AnotherLongName();
* ``RTBS_ExceptShortType`` (in configuration: ``ExceptShortType``)
Same as ``Automatic`` above, except that there is no break after short
return types.
.. code-block:: c++
class A {
int f() { return 0; };
};
int f();
int f() { return 1; }
int LongName::
AnotherLongName();
* ``RTBS_All`` (in configuration: ``All``)
Always break after the return type.
.. code-block:: c++
class A {
int
f() {
return 0;
};
};
int
f();
int
f() {
return 1;
}
int
LongName::AnotherLongName();
* ``RTBS_TopLevel`` (in configuration: ``TopLevel``)
Always break after the return types of top-level functions.
.. code-block:: c++
class A {
int f() { return 0; };
};
int
f();
int
f() {
return 1;
}
int
LongName::AnotherLongName();
* ``RTBS_AllDefinitions`` (in configuration: ``AllDefinitions``)
Always break after the return type of function definitions.
.. code-block:: c++
class A {
int
f() {
return 0;
};
};
int f();
int
f() {
return 1;
}
int
LongName::AnotherLongName();
* ``RTBS_TopLevelDefinitions`` (in configuration: ``TopLevelDefinitions``)
Always break after the return type of top-level definitions.
.. code-block:: c++
class A {
int f() { return 0; };
};
int f();
int
f() {
return 1;
}
int
LongName::AnotherLongName();
.. _BreakArrays:
**BreakArrays** (``Boolean``) :versionbadge:`clang-format 16` :ref:`¶ <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.
.. code-block:: c++
true: false:
[ vs. [1, 2, 3, 4]
1,
2,
3,
4
]
.. _BreakBeforeBinaryOperators:
**BreakBeforeBinaryOperators** (``BinaryOperatorStyle``) :versionbadge:`clang-format 3.6` :ref:`¶ <BreakBeforeBinaryOperators>`
The way to wrap binary operators.
Possible values:
* ``BOS_None`` (in configuration: ``None``)
Break after operators.
.. code-block:: c++
LooooooooooongType loooooooooooooooooooooongVariable =
someLooooooooooooooooongFunction();
bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >
ccccccccccccccccccccccccccccccccccccccccc;
* ``BOS_NonAssignment`` (in configuration: ``NonAssignment``)
Break before operators that aren't assignments.
.. code-block:: c++
LooooooooooongType loooooooooooooooooooooongVariable =
someLooooooooooooooooongFunction();
bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
== aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
&& aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
> ccccccccccccccccccccccccccccccccccccccccc;
* ``BOS_All`` (in configuration: ``All``)
Break before operators.
.. code-block:: c++
LooooooooooongType loooooooooooooooooooooongVariable
= someLooooooooooooooooongFunction();
bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
== aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
&& aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
> ccccccccccccccccccccccccccccccccccccccccc;
.. _BreakBeforeBraces:
**BreakBeforeBraces** (``BraceBreakingStyle``) :versionbadge:`clang-format 3.7` :ref:`¶ <BreakBeforeBraces>`
The brace breaking style to use.
Possible values:
* ``BS_Attach`` (in configuration: ``Attach``)
Always attach braces to surrounding context.
.. code-block:: c++
namespace N {
enum E {
E1,
E2,
};
class C {
public:
C();
};
bool baz(int i) {
try {
do {
switch (i) {
case 1: {
foobar();
break;
}
default: {
break;
}
}
} while (--i);
return true;
} catch (...) {
handleError();
return false;
}
}
void foo(bool b) {
if (b) {
baz(2);
} else {
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_Linux`` (in configuration: ``Linux``)
Like ``Attach``, but break before braces on function, namespace and
class definitions.
.. code-block:: c++
namespace N
{
enum E {
E1,
E2,
};
class C
{
public:
C();
};
bool baz(int i)
{
try {
do {
switch (i) {
case 1: {
foobar();
break;
}
default: {
break;
}
}
} while (--i);
return true;
} catch (...) {
handleError();
return false;
}
}
void foo(bool b)
{
if (b) {
baz(2);
} else {
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_Mozilla`` (in configuration: ``Mozilla``)
Like ``Attach``, but break before braces on enum, function, and record
definitions.
.. code-block:: c++
namespace N {
enum E
{
E1,
E2,
};
class C
{
public:
C();
};
bool baz(int i)
{
try {
do {
switch (i) {
case 1: {
foobar();
break;
}
default: {
break;
}
}
} while (--i);
return true;
} catch (...) {
handleError();
return false;
}
}
void foo(bool b)
{
if (b) {
baz(2);
} else {
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_Stroustrup`` (in configuration: ``Stroustrup``)
Like ``Attach``, but break before function definitions, ``catch``, and
``else``.
.. code-block:: c++
namespace N {
enum E {
E1,
E2,
};
class C {
public:
C();
};
bool baz(int i)
{
try {
do {
switch (i) {
case 1: {
foobar();
break;
}
default: {
break;
}
}
} while (--i);
return true;
}
catch (...) {
handleError();
return false;
}
}
void foo(bool b)
{
if (b) {
baz(2);
}
else {
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_Allman`` (in configuration: ``Allman``)
Always break before braces.
.. code-block:: c++
namespace N
{
enum E
{
E1,
E2,
};
class C
{
public:
C();
};
bool baz(int i)
{
try
{
do
{
switch (i)
{
case 1:
{
foobar();
break;
}
default:
{
break;
}
}
} while (--i);
return true;
}
catch (...)
{
handleError();
return false;
}
}
void foo(bool b)
{
if (b)
{
baz(2);
}
else
{
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_Whitesmiths`` (in configuration: ``Whitesmiths``)
Like ``Allman`` but always indent braces and line up code with braces.
.. code-block:: c++
namespace N
{
enum E
{
E1,
E2,
};
class C
{
public:
C();
};
bool baz(int i)
{
try
{
do
{
switch (i)
{
case 1:
{
foobar();
break;
}
default:
{
break;
}
}
} while (--i);
return true;
}
catch (...)
{
handleError();
return false;
}
}
void foo(bool b)
{
if (b)
{
baz(2);
}
else
{
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_GNU`` (in configuration: ``GNU``)
Always break before braces and add an extra level of indentation to
braces of control statements, not to those of class, function
or other definitions.
.. code-block:: c++
namespace N
{
enum E
{
E1,
E2,
};
class C
{
public:
C();
};
bool baz(int i)
{
try
{
do
{
switch (i)
{
case 1:
{
foobar();
break;
}
default:
{
break;
}
}
}
while (--i);
return true;
}
catch (...)
{
handleError();
return false;
}
}
void foo(bool b)
{
if (b)
{
baz(2);
}
else
{
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_WebKit`` (in configuration: ``WebKit``)
Like ``Attach``, but break before functions.
.. code-block:: c++
namespace N {
enum E {
E1,
E2,
};
class C {
public:
C();
};
bool baz(int i)
{
try {
do {
switch (i) {
case 1: {
foobar();
break;
}
default: {
break;
}
}
} while (--i);
return true;
} catch (...) {
handleError();
return false;
}
}
void foo(bool b)
{
if (b) {
baz(2);
} else {
baz(5);
}
}
void bar() { foo(true); }
} // namespace N
* ``BS_Custom`` (in configuration: ``Custom``)
Configure each individual brace in ``BraceWrapping``.
.. _BreakBeforeConceptDeclarations:
**BreakBeforeConceptDeclarations** (``BreakBeforeConceptDeclarationsStyle``) :versionbadge:`clang-format 12` :ref:`¶ <BreakBeforeConceptDeclarations>`
The concept declaration style to use.
Possible values:
* ``BBCDS_Never`` (in configuration: ``Never``)
Keep the template declaration line together with ``concept``.
.. code-block:: c++
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.
.. code-block:: c++
template <typename T>
concept C = ...;
.. _BreakBeforeInlineASMColon:
**BreakBeforeInlineASMColon** (``BreakBeforeInlineASMColonStyle``) :versionbadge:`clang-format 16` :ref:`¶ <BreakBeforeInlineASMColon>`
The inline ASM colon style to use.
Possible values:
* ``BBIAS_Never`` (in configuration: ``Never``)
No break before inline ASM colon.
.. code-block:: c++
asm volatile("string", : : val);
* ``BBIAS_OnlyMultiline`` (in configuration: ``OnlyMultiline``)
Break before inline ASM colon if the line length is longer than column
limit.
.. code-block:: c++
asm volatile("string", : : val);
asm("cmoveq %1, %2, %[result]"
: [result] "=r"(result)
: "r"(test), "r"(new), "[result]"(old));
* ``BBIAS_Always`` (in configuration: ``Always``)
Always break before inline ASM colon.
.. code-block:: c++
asm volatile("string",
:
: val);
.. _BreakBeforeTernaryOperators:
**BreakBeforeTernaryOperators** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <BreakBeforeTernaryOperators>`
If ``true``, ternary operators will be placed after line breaks.
.. code-block:: c++
true:
veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription
? firstValue
: SecondValueVeryVeryVeryVeryLong;
false:
veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ?
firstValue :
SecondValueVeryVeryVeryVeryLong;
.. _BreakBinaryOperations:
**BreakBinaryOperations** (``BreakBinaryOperationsStyle``) :versionbadge:`clang-format 20` :ref:`¶ <BreakBinaryOperations>`
The break constructor initializers style to use.
Possible values:
* ``BBO_Never`` (in configuration: ``Never``)
Don't break binary operations
.. code-block:: c++
aaa + bbbb * ccccc - ddddd +
eeeeeeeeeeeeeeee;
* ``BBO_OnePerLine`` (in configuration: ``OnePerLine``)
Binary operations will either be all on the same line, or each operation
will have one line each.
.. code-block:: c++
aaa +
bbbb *
ccccc -
ddddd +
eeeeeeeeeeeeeeee;
* ``BBO_RespectPrecedence`` (in configuration: ``RespectPrecedence``)
Binary operations of a particular precedence that exceed the column
limit will have one line each.
.. code-block:: c++
aaa +
bbbb * ccccc -
ddddd +
eeeeeeeeeeeeeeee;
.. _BreakConstructorInitializers:
**BreakConstructorInitializers** (``BreakConstructorInitializersStyle``) :versionbadge:`clang-format 5` :ref:`¶ <BreakConstructorInitializers>`
The break constructor initializers style to use.
Possible values:
* ``BCIS_BeforeColon`` (in configuration: ``BeforeColon``)
Break constructor initializers before the colon and after the commas.
.. code-block:: c++
Constructor()
: initializer1(),
initializer2()
* ``BCIS_BeforeComma`` (in configuration: ``BeforeComma``)
Break constructor initializers before the colon and commas, and align
the commas with the colon.
.. code-block:: c++
Constructor()
: initializer1()
, initializer2()
* ``BCIS_AfterColon`` (in configuration: ``AfterColon``)
Break constructor initializers after the colon and commas.
.. code-block:: c++
Constructor() :
initializer1(),
initializer2()
.. _BreakFunctionDefinitionParameters:
**BreakFunctionDefinitionParameters** (``Boolean``) :versionbadge:`clang-format 19` :ref:`¶ <BreakFunctionDefinitionParameters>`
If ``true``, clang-format will always break before function definition
parameters.
.. code-block:: c++
true:
void functionDefinition(
int A, int B) {}
false:
void functionDefinition(int A, int B) {}
.. _BreakInheritanceList:
**BreakInheritanceList** (``BreakInheritanceListStyle``) :versionbadge:`clang-format 7` :ref:`¶ <BreakInheritanceList>`
The inheritance list style to use.
Possible values:
* ``BILS_BeforeColon`` (in configuration: ``BeforeColon``)
Break inheritance list before the colon and after the commas.
.. code-block:: c++
class Foo
: Base1,
Base2
{};
* ``BILS_BeforeComma`` (in configuration: ``BeforeComma``)
Break inheritance list before the colon and commas, and align
the commas with the colon.
.. code-block:: c++
class Foo
: Base1
, Base2
{};
* ``BILS_AfterColon`` (in configuration: ``AfterColon``)
Break inheritance list after the colon and commas.
.. code-block:: c++
class Foo :
Base1,
Base2
{};
* ``BILS_AfterComma`` (in configuration: ``AfterComma``)
Break inheritance list only after the commas.
.. code-block:: c++
class Foo : Base1,
Base2
{};
.. _BreakStringLiterals:
**BreakStringLiterals** (``Boolean``) :versionbadge:`clang-format 3.9` :ref:`¶ <BreakStringLiterals>`
Allow breaking string literals when formatting.
In C, C++, and Objective-C:
.. code-block:: c++
true:
const char* x = "veryVeryVeryVeryVeryVe"
"ryVeryVeryVeryVeryVery"
"VeryLongString";
false:
const char* x =
"veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";
In C# and Java:
.. code-block:: c++
true:
string x = "veryVeryVeryVeryVeryVe" +
"ryVeryVeryVeryVeryVery" +
"VeryLongString";
false:
string x =
"veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";
C# interpolated strings are not broken.
In Verilog:
.. code-block:: c++
true:
string x = {"veryVeryVeryVeryVeryVe",
"ryVeryVeryVeryVeryVery",
"VeryLongString"};
false:
string x =
"veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";
.. _BreakTemplateDeclarations:
**BreakTemplateDeclarations** (``BreakTemplateDeclarationsStyle``) :versionbadge:`clang-format 19` :ref:`¶ <BreakTemplateDeclarations>`
The template declaration breaking style to use.
Possible values:
* ``BTDS_Leave`` (in configuration: ``Leave``)
Do not change the line breaking before the declaration.
.. code-block:: c++
template <typename T>
T foo() {
}
template <typename T> T foo(int aaaaaaaaaaaaaaaaaaaaa,
int bbbbbbbbbbbbbbbbbbbbb) {
}
* ``BTDS_No`` (in configuration: ``No``)
Do not force break before declaration.
``PenaltyBreakTemplateDeclaration`` is taken into account.
.. code-block:: c++
template <typename T> T foo() {
}
template <typename T> T foo(int aaaaaaaaaaaaaaaaaaaaa,
int bbbbbbbbbbbbbbbbbbbbb) {
}
* ``BTDS_MultiLine`` (in configuration: ``MultiLine``)
Force break after template declaration only when the following
declaration spans multiple lines.
.. code-block:: c++
template <typename T> T foo() {
}
template <typename T>
T foo(int aaaaaaaaaaaaaaaaaaaaa,
int bbbbbbbbbbbbbbbbbbbbb) {
}
* ``BTDS_Yes`` (in configuration: ``Yes``)
Always break after template declaration.
.. code-block:: c++
template <typename T>
T foo() {
}
template <typename T>
T foo(int aaaaaaaaaaaaaaaaaaaaa,
int bbbbbbbbbbbbbbbbbbbbb) {
}
.. _ColumnLimit:
**ColumnLimit** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <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:
**CommentPragmas** (``String``) :versionbadge:`clang-format 3.7` :ref:`¶ <CommentPragmas>`
A regular expression that describes comments with special meaning,
which should not be split into lines or otherwise changed.
.. code-block:: c++
// CommentPragmas: '^ FOOBAR pragma:'
// Will leave the following line unaffected
#include <vector> // FOOBAR pragma: keep
.. _CompactNamespaces:
**CompactNamespaces** (``Boolean``) :versionbadge:`clang-format 5` :ref:`¶ <CompactNamespaces>`
If ``true``, consecutive namespace declarations will be on the same
line. If ``false``, each namespace is declared on a new line.
.. code-block:: c++
true:
namespace Foo { namespace Bar {
}}
false:
namespace Foo {
namespace Bar {
}
}
If it does not fit on a single line, the overflowing namespaces get
wrapped:
.. code-block:: c++
namespace Foo { namespace Bar {
namespace Extra {
}}}
.. _ConstructorInitializerAllOnOneLineOrOnePerLine:
**ConstructorInitializerAllOnOneLineOrOnePerLine** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <ConstructorInitializerAllOnOneLineOrOnePerLine>`
This option is **deprecated**. See ``CurrentLine`` of
``PackConstructorInitializers``.
.. _ConstructorInitializerIndentWidth:
**ConstructorInitializerIndentWidth** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <ConstructorInitializerIndentWidth>`
The number of characters to use for indentation of constructor
initializer lists as well as inheritance lists.
.. _ContinuationIndentWidth:
**ContinuationIndentWidth** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <ContinuationIndentWidth>`
Indent width for line continuations.
.. code-block:: c++
ContinuationIndentWidth: 2
int i = // VeryVeryVeryVeryVeryLongComment
longFunction( // Again a long comment
arg);
.. _Cpp11BracedListStyle:
**Cpp11BracedListStyle** (``Boolean``) :versionbadge:`clang-format 3.4` :ref:`¶ <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.
.. code-block:: c++
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:
**DeriveLineEnding** (``Boolean``) :versionbadge:`clang-format 10` :ref:`¶ <DeriveLineEnding>`
This option is **deprecated**. See ``DeriveLF`` and ``DeriveCRLF`` of
``LineEnding``.
.. _DerivePointerAlignment:
**DerivePointerAlignment** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <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:
**DisableFormat** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <DisableFormat>`
Disables formatting completely.
.. _EmptyLineAfterAccessModifier:
**EmptyLineAfterAccessModifier** (``EmptyLineAfterAccessModifierStyle``) :versionbadge:`clang-format 13` :ref:`¶ <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:
* ``ELAAMS_Never`` (in configuration: ``Never``)
Remove all empty lines after access modifiers.
.. code-block:: c++
struct foo {
private:
int i;
protected:
int j;
/* comment */
public:
foo() {}
private:
protected:
};
* ``ELAAMS_Leave`` (in configuration: ``Leave``)
Keep existing empty lines after access modifiers.
MaxEmptyLinesToKeep is applied instead.
* ``ELAAMS_Always`` (in configuration: ``Always``)
Always add empty line after access modifiers if there are none.
MaxEmptyLinesToKeep is applied also.
.. code-block:: c++
struct foo {
private:
int i;
protected:
int j;
/* comment */
public:
foo() {}
private:
protected:
};
.. _EmptyLineBeforeAccessModifier:
**EmptyLineBeforeAccessModifier** (``EmptyLineBeforeAccessModifierStyle``) :versionbadge:`clang-format 12` :ref:`¶ <EmptyLineBeforeAccessModifier>`
Defines in which cases to put empty line before access modifiers.
Possible values:
* ``ELBAMS_Never`` (in configuration: ``Never``)
Remove all empty lines before access modifiers.
.. code-block:: c++
struct foo {
private:
int i;
protected:
int j;
/* comment */
public:
foo() {}
private:
protected:
};
* ``ELBAMS_Leave`` (in configuration: ``Leave``)
Keep existing empty lines before access modifiers.
* ``ELBAMS_LogicalBlock`` (in configuration: ``LogicalBlock``)
Add empty line only when access modifier starts a new logical block.
Logical block is a group of one or more member fields or functions.
.. code-block:: c++
struct foo {
private:
int i;
protected:
int j;
/* comment */
public:
foo() {}
private:
protected:
};
* ``ELBAMS_Always`` (in configuration: ``Always``)
Always add empty line before access modifiers unless access modifier
is at the start of struct or class definition.
.. code-block:: c++
struct foo {
private:
int i;
protected:
int j;
/* comment */
public:
foo() {}
private:
protected:
};
.. _ExperimentalAutoDetectBinPacking:
**ExperimentalAutoDetectBinPacking** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <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:
**FixNamespaceComments** (``Boolean``) :versionbadge:`clang-format 5` :ref:`¶ <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``.
.. code-block:: c++
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:
**ForEachMacros** (``List of Strings``) :versionbadge:`clang-format 3.7` :ref:`¶ <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:
.. code-block:: c++
FOREACH(<variable-declaration>, ...)
<loop-body>
In the .clang-format configuration file, this can be configured like:
.. code-block:: yaml
ForEachMacros: [RANGES_FOR, FOREACH]
For example: BOOST_FOREACH.
.. _IfMacros:
**IfMacros** (``List of Strings``) :versionbadge:`clang-format 13` :ref:`¶ <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:
.. code-block:: c++
IF(...)
<conditional-body>
else IF(...)
<conditional-body>
In the .clang-format configuration file, this can be configured like:
.. code-block:: yaml
IfMacros: [IF]
For example: `KJ_IF_MAYBE
<https://github.com/capnproto/capnproto/blob/master/kjdoc/tour.md#maybes>`_
.. _IncludeBlocks:
**IncludeBlocks** (``IncludeBlocksStyle``) :versionbadge:`clang-format 6` :ref:`¶ <IncludeBlocks>`
Dependent on the value, multiple ``#include`` blocks can be sorted
as one and divided based on category.
Possible values:
* ``IBS_Preserve`` (in configuration: ``Preserve``)
Sort each ``#include`` block separately.
.. code-block:: c++
#include "b.h" into #include "b.h"
#include <lib/main.h> #include "a.h"
#include "a.h" #include <lib/main.h>
* ``IBS_Merge`` (in configuration: ``Merge``)
Merge multiple ``#include`` blocks together and sort as one.
.. code-block:: c++
#include "b.h" into #include "a.h"
#include "b.h"
#include <lib/main.h> #include <lib/main.h>
#include "a.h"
* ``IBS_Regroup`` (in configuration: ``Regroup``)
Merge multiple ``#include`` blocks together and sort as one.
Then split into groups based on category priority. See
``IncludeCategories``.
.. code-block:: c++
#include "b.h" into #include "a.h"
#include "b.h"
#include <lib/main.h>
#include "a.h" #include <lib/main.h>
.. _IncludeCategories:
**IncludeCategories** (``List of IncludeCategories``) :versionbadge:`clang-format 3.8` :ref:`¶ <IncludeCategories>`
Regular expressions denoting the different ``#include`` categories
used for ordering ``#includes``.
`POSIX extended
<https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html>`_
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:
.. code-block:: yaml
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:
**IncludeIsMainRegex** (``String``) :versionbadge:`clang-format 3.9` :ref:`¶ <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:
**IncludeIsMainSourceRegex** (``String``) :versionbadge:`clang-format 10` :ref:`¶ <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:
**IndentAccessModifiers** (``Boolean``) :versionbadge:`clang-format 13` :ref:`¶ <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.
.. code-block:: c++
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:
**IndentCaseBlocks** (``Boolean``) :versionbadge:`clang-format 11` :ref:`¶ <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.
.. code-block:: c++
false: true:
switch (fool) { vs. switch (fool) {
case 1: { case 1:
bar(); {
} break; bar();
default: { }
plop(); break;
} default:
} {
plop();
}
}
.. _IndentCaseLabels:
**IndentCaseLabels** (``Boolean``) :versionbadge:`clang-format 3.3` :ref:`¶ <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).
.. code-block:: c++
false: true:
switch (fool) { vs. switch (fool) {
case 1: case 1:
bar(); bar();
break; break;
default: default:
plop(); plop();
} }
.. _IndentExternBlock:
**IndentExternBlock** (``IndentExternBlockStyle``) :versionbadge:`clang-format 11` :ref:`¶ <IndentExternBlock>`
IndentExternBlockStyle is the type of indenting of extern blocks.
Possible values:
* ``IEBS_AfterExternBlock`` (in configuration: ``AfterExternBlock``)
Backwards compatible with AfterExternBlock's indenting.
.. code-block:: c++
IndentExternBlock: AfterExternBlock
BraceWrapping.AfterExternBlock: true
extern "C"
{
void foo();
}
.. code-block:: c++
IndentExternBlock: AfterExternBlock
BraceWrapping.AfterExternBlock: false
extern "C" {
void foo();
}
* ``IEBS_NoIndent`` (in configuration: ``NoIndent``)
Does not indent extern blocks.
.. code-block:: c++
extern "C" {
void foo();
}
* ``IEBS_Indent`` (in configuration: ``Indent``)
Indents extern blocks.
.. code-block:: c++
extern "C" {
void foo();
}
.. _IndentGotoLabels:
**IndentGotoLabels** (``Boolean``) :versionbadge:`clang-format 10` :ref:`¶ <IndentGotoLabels>`
Indent goto labels.
When ``false``, goto labels are flushed left.
.. code-block:: c++
true: false:
int f() { vs. int f() {
if (foo()) { if (foo()) {
label1: label1:
bar(); bar();
} }
label2: label2:
return 1; return 1;
} }
.. _IndentPPDirectives:
**IndentPPDirectives** (``PPDirectiveIndentStyle``) :versionbadge:`clang-format 6` :ref:`¶ <IndentPPDirectives>`
The preprocessor directive indenting style to use.
Possible values:
* ``PPDIS_None`` (in configuration: ``None``)
Does not indent any directives.
.. code-block:: c++
#if FOO
#if BAR
#include <foo>
#endif
#endif
* ``PPDIS_AfterHash`` (in configuration: ``AfterHash``)
Indents directives after the hash.
.. code-block:: c++
#if FOO
# if BAR
# include <foo>
# endif
#endif
* ``PPDIS_BeforeHash`` (in configuration: ``BeforeHash``)
Indents directives before the hash.
.. code-block:: c++
#if FOO
#if BAR
#include <foo>
#endif
#endif
.. _IndentRequiresClause:
**IndentRequiresClause** (``Boolean``) :versionbadge:`clang-format 15` :ref:`¶ <IndentRequiresClause>`
Indent the requires clause in a template. This only applies when
``RequiresClausePosition`` is ``OwnLine``, ``OwnLineWithBrace``,
or ``WithFollowing``.
In clang-format 12, 13 and 14 it was named ``IndentRequires``.
.. code-block:: c++
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:
**IndentWidth** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <IndentWidth>`
The number of columns to use for indentation.
.. code-block:: c++
IndentWidth: 3
void f() {
someFunction();
if (true, false) {
f();
}
}
.. _IndentWrappedFunctionNames:
**IndentWrappedFunctionNames** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <IndentWrappedFunctionNames>`
Indent if a function definition or declaration is wrapped after the
type.
.. code-block:: c++
true:
LoooooooooooooooooooooooooooooooooooooooongReturnType
LoooooooooooooooooooooooooooooooongFunctionDeclaration();
false:
LoooooooooooooooooooooooooooooooooooooooongReturnType
LoooooooooooooooooooooooooooooooongFunctionDeclaration();
.. _InsertBraces:
**InsertBraces** (``Boolean``) :versionbadge:`clang-format 15` :ref:`¶ <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.
.. code-block:: c++
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:
**InsertNewlineAtEOF** (``Boolean``) :versionbadge:`clang-format 16` :ref:`¶ <InsertNewlineAtEOF>`
Insert a newline at end of file if missing.
.. _InsertTrailingCommas:
**InsertTrailingCommas** (``TrailingCommaStyle``) :versionbadge:`clang-format 11` :ref:`¶ <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.
.. code-block:: c++
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:
**IntegerLiteralSeparator** (``IntegerLiteralSeparatorStyle``) :versionbadge:`clang-format 16` :ref:`¶ <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.
.. code-block:: c++
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.
.. code-block:: text
/* -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.
.. code-block:: text
// Binary: 3
// BinaryMinDigits: 7
b1 = 0b101101;
b2 = 0b1'101'101;
* ``int8_t Decimal`` Format separators in decimal literals.
.. code-block:: text
/* -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.
.. code-block:: text
// Decimal: 3
// DecimalMinDigits: 5
d1 = 2023;
d2 = 10'000;
* ``int8_t Hex`` Format separators in hexadecimal literals.
.. code-block:: text
/* -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.
.. code-block:: text
// Hex: 2
// HexMinDigits: 6
h1 = 0xABCDE;
h2 = 0xAB'CD'EF;
.. _JavaImportGroups:
**JavaImportGroups** (``List of Strings``) :versionbadge:`clang-format 8` :ref:`¶ <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.
.. code-block:: yaml
JavaImportGroups: [com.example, com, org]
.. code-block:: java
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:
**JavaScriptQuotes** (``JavaScriptQuoteStyle``) :versionbadge:`clang-format 3.9` :ref:`¶ <JavaScriptQuotes>`
The JavaScriptQuoteStyle to use for JavaScript strings.
Possible values:
* ``JSQS_Leave`` (in configuration: ``Leave``)
Leave string quotes as they are.
.. code-block:: js
string1 = "foo";
string2 = 'bar';
* ``JSQS_Single`` (in configuration: ``Single``)
Always use single quotes.
.. code-block:: js
string1 = 'foo';
string2 = 'bar';
* ``JSQS_Double`` (in configuration: ``Double``)
Always use double quotes.
.. code-block:: js
string1 = "foo";
string2 = "bar";
.. _JavaScriptWrapImports:
**JavaScriptWrapImports** (``Boolean``) :versionbadge:`clang-format 3.9` :ref:`¶ <JavaScriptWrapImports>`
Whether to wrap JavaScript import/export statements.
.. code-block:: js
true:
import {
VeryLongImportsAreAnnoying,
VeryLongImportsAreAnnoying,
VeryLongImportsAreAnnoying,
} from "some/module.js"
false:
import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,} from "some/module.js"
.. _KeepEmptyLines:
**KeepEmptyLines** (``KeepEmptyLinesStyle``) :versionbadge:`clang-format 19` :ref:`¶ <KeepEmptyLines>`
Which empty lines are kept. See ``MaxEmptyLinesToKeep`` for how many
consecutive empty lines are kept.
Nested configuration flags:
Options regarding which empty lines are kept.
For example, the config below will remove empty lines at start of the
file, end of the file, and start of blocks.
.. code-block:: c++
KeepEmptyLines:
AtEndOfFile: false
AtStartOfBlock: false
AtStartOfFile: false
* ``bool AtEndOfFile`` Keep empty lines at end of file.
* ``bool AtStartOfBlock`` Keep empty lines at start of a block.
.. code-block:: c++
true: false:
if (foo) { vs. if (foo) {
bar();
bar(); }
}
* ``bool AtStartOfFile`` Keep empty lines at start of file.
.. _KeepEmptyLinesAtEOF:
**KeepEmptyLinesAtEOF** (``Boolean``) :versionbadge:`clang-format 17` :ref:`¶ <KeepEmptyLinesAtEOF>`
This option is deprecated. See ``AtEndOfFile`` of ``KeepEmptyLines``.
.. _KeepEmptyLinesAtTheStartOfBlocks:
**KeepEmptyLinesAtTheStartOfBlocks** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <KeepEmptyLinesAtTheStartOfBlocks>`
This option is deprecated. See ``AtStartOfBlock`` of ``KeepEmptyLines``.
.. _LambdaBodyIndentation:
**LambdaBodyIndentation** (``LambdaBodyIndentationKind``) :versionbadge:`clang-format 13` :ref:`¶ <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:
* ``LBI_Signature`` (in configuration: ``Signature``)
Align lambda body relative to the lambda signature. This is the default.
.. code-block:: c++
someMethod(
[](SomeReallyLongLambdaSignatureArgument foo) {
return;
});
* ``LBI_OuterScope`` (in configuration: ``OuterScope``)
For statements within block scope, align lambda body relative to the
indentation level of the outer scope the lambda signature resides in.
.. code-block:: c++
someMethod(
[](SomeReallyLongLambdaSignatureArgument foo) {
return;
});
someMethod(someOtherMethod(
[](SomeReallyLongLambdaSignatureArgument foo) {
return;
}));
.. _Language:
**Language** (``LanguageKind``) :versionbadge:`clang-format 3.5` :ref:`¶ <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:
**LineEnding** (``LineEndingStyle``) :versionbadge:`clang-format 16` :ref:`¶ <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:
**MacroBlockBegin** (``String``) :versionbadge:`clang-format 3.7` :ref:`¶ <MacroBlockBegin>`
A regular expression matching macros that start a block.
.. code-block:: c++
# 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:
**MacroBlockEnd** (``String``) :versionbadge:`clang-format 3.7` :ref:`¶ <MacroBlockEnd>`
A regular expression matching macros that end a block.
.. _Macros:
**Macros** (``List of Strings``) :versionbadge:`clang-format 17` :ref:`¶ <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:
.. code-block:: c++
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:
.. code-block:: yaml
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
.. code-block:: c++
A; -> x;
A(); -> y;
A(z); -> z;
A(a, b); // will not be expanded.
.. _MainIncludeChar:
**MainIncludeChar** (``MainIncludeCharDiscriminator``) :versionbadge:`clang-format 19` :ref:`¶ <MainIncludeChar>`
When guessing whether a #include is the "main" include, only the include
directives that use the specified character are considered.
Possible values:
* ``MICD_Quote`` (in configuration: ``Quote``)
Main include uses quotes: ``#include "foo.hpp"`` (the default).
* ``MICD_AngleBracket`` (in configuration: ``AngleBracket``)
Main include uses angle brackets: ``#include <foo.hpp>``.
* ``MICD_Any`` (in configuration: ``Any``)
Main include uses either quotes or angle brackets.
.. _MaxEmptyLinesToKeep:
**MaxEmptyLinesToKeep** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <MaxEmptyLinesToKeep>`
The maximum number of consecutive empty lines to keep.
.. code-block:: c++
MaxEmptyLinesToKeep: 1 vs. MaxEmptyLinesToKeep: 0
int f() { int f() {
int = 1; int i = 1;
i = foo();
i = foo(); return i;
}
return i;
}
.. _NamespaceIndentation:
**NamespaceIndentation** (``NamespaceIndentationKind``) :versionbadge:`clang-format 3.7` :ref:`¶ <NamespaceIndentation>`
The indentation used for namespaces.
Possible values:
* ``NI_None`` (in configuration: ``None``)
Don't indent in namespaces.
.. code-block:: c++
namespace out {
int i;
namespace in {
int i;
}
}
* ``NI_Inner`` (in configuration: ``Inner``)
Indent only in inner namespaces (nested in other namespaces).
.. code-block:: c++
namespace out {
int i;
namespace in {
int i;
}
}
* ``NI_All`` (in configuration: ``All``)
Indent in all namespaces.
.. code-block:: c++
namespace out {
int i;
namespace in {
int i;
}
}
.. _NamespaceMacros:
**NamespaceMacros** (``List of Strings``) :versionbadge:`clang-format 9` :ref:`¶ <NamespaceMacros>`
A vector of macros which are used to open namespace blocks.
These are expected to be macros of the form:
.. code-block:: c++
NAMESPACE(<namespace-name>, ...) {
<namespace-content>
}
For example: TESTSUITE
.. _ObjCBinPackProtocolList:
**ObjCBinPackProtocolList** (``BinPackStyle``) :versionbadge:`clang-format 7` :ref:`¶ <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 ``BinPack``, 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``.
.. code-block:: objc
Always (or Auto, if BinPackParameters==BinPack):
@interface ccccccccccccc () <
ccccccccccccc, ccccccccccccc,
ccccccccccccc, ccccccccccccc> {
}
Never (or Auto, if BinPackParameters!=BinPack):
@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:
**ObjCBlockIndentWidth** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <ObjCBlockIndentWidth>`
The number of characters to use for indentation of ObjC blocks.
.. code-block:: objc
ObjCBlockIndentWidth: 4
[operation setCompletionBlock:^{
[self onOperationDone];
}];
.. _ObjCBreakBeforeNestedBlockParam:
**ObjCBreakBeforeNestedBlockParam** (``Boolean``) :versionbadge:`clang-format 11` :ref:`¶ <ObjCBreakBeforeNestedBlockParam>`
Break parameters list into lines when there is nested block
parameters in a function call.
.. code-block:: c++
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;
}]
}
.. _ObjCPropertyAttributeOrder:
**ObjCPropertyAttributeOrder** (``List of Strings``) :versionbadge:`clang-format 18` :ref:`¶ <ObjCPropertyAttributeOrder>`
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.
.. warning::
Using this option 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.
.. code-block:: yaml
ObjCPropertyAttributeOrder: [
class, direct,
atomic, nonatomic,
assign, retain, strong, copy, weak, unsafe_unretained,
readonly, readwrite, getter, setter,
nullable, nonnull, null_resettable, null_unspecified
]
.. _ObjCSpaceAfterProperty:
**ObjCSpaceAfterProperty** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <ObjCSpaceAfterProperty>`
Add a space after ``@property`` in Objective-C, i.e. use
``@property (readonly)`` instead of ``@property(readonly)``.
.. _ObjCSpaceBeforeProtocolList:
**ObjCSpaceBeforeProtocolList** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <ObjCSpaceBeforeProtocolList>`
Add a space in front of an Objective-C protocol list, i.e. use
``Foo <Protocol>`` instead of ``Foo<Protocol>``.
.. _PPIndentWidth:
**PPIndentWidth** (``Integer``) :versionbadge:`clang-format 13` :ref:`¶ <PPIndentWidth>`
The number of columns to use for indentation of preprocessor statements.
When set to -1 (default) ``IndentWidth`` is used also for preprocessor
statements.
.. code-block:: c++
PPIndentWidth: 1
#ifdef __linux__
# define FOO
#else
# define BAR
#endif
.. _PackConstructorInitializers:
**PackConstructorInitializers** (``PackConstructorInitializersStyle``) :versionbadge:`clang-format 14` :ref:`¶ <PackConstructorInitializers>`
The pack constructor initializers style to use.
Possible values:
* ``PCIS_Never`` (in configuration: ``Never``)
Always put each constructor initializer on its own line.
.. code-block:: c++
Constructor()
: a(),
b()
* ``PCIS_BinPack`` (in configuration: ``BinPack``)
Bin-pack constructor initializers.
.. code-block:: c++
Constructor()
: aaaaaaaaaaaaaaaaaaaa(), bbbbbbbbbbbbbbbbbbbb(),
cccccccccccccccccccc()
* ``PCIS_CurrentLine`` (in configuration: ``CurrentLine``)
Put all constructor initializers on the current line if they fit.
Otherwise, put each one on its own line.
.. code-block:: c++
Constructor() : a(), b()
Constructor()
: aaaaaaaaaaaaaaaaaaaa(),
bbbbbbbbbbbbbbbbbbbb(),
ddddddddddddd()
* ``PCIS_NextLine`` (in configuration: ``NextLine``)
Same as ``PCIS_CurrentLine`` except that if all constructor initializers
do not fit on the current line, try to fit them on the next line.
.. code-block:: c++
Constructor() : a(), b()
Constructor()
: aaaaaaaaaaaaaaaaaaaa(), bbbbbbbbbbbbbbbbbbbb(), ddddddddddddd()
Constructor()
: aaaaaaaaaaaaaaaaaaaa(),
bbbbbbbbbbbbbbbbbbbb(),
cccccccccccccccccccc()
* ``PCIS_NextLineOnly`` (in configuration: ``NextLineOnly``)
Put all constructor initializers on the next line if they fit.
Otherwise, put each one on its own line.
.. code-block:: c++
Constructor()
: a(), b()
Constructor()
: aaaaaaaaaaaaaaaaaaaa(), bbbbbbbbbbbbbbbbbbbb(), ddddddddddddd()
Constructor()
: aaaaaaaaaaaaaaaaaaaa(),
bbbbbbbbbbbbbbbbbbbb(),
cccccccccccccccccccc()
.. _PenaltyBreakAssignment:
**PenaltyBreakAssignment** (``Unsigned``) :versionbadge:`clang-format 5` :ref:`¶ <PenaltyBreakAssignment>`
The penalty for breaking around an assignment operator.
.. _PenaltyBreakBeforeFirstCallParameter:
**PenaltyBreakBeforeFirstCallParameter** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <PenaltyBreakBeforeFirstCallParameter>`
The penalty for breaking a function call after ``call(``.
.. _PenaltyBreakComment:
**PenaltyBreakComment** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <PenaltyBreakComment>`
The penalty for each line break introduced inside a comment.
.. _PenaltyBreakFirstLessLess:
**PenaltyBreakFirstLessLess** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <PenaltyBreakFirstLessLess>`
The penalty for breaking before the first ``<<``.
.. _PenaltyBreakOpenParenthesis:
**PenaltyBreakOpenParenthesis** (``Unsigned``) :versionbadge:`clang-format 14` :ref:`¶ <PenaltyBreakOpenParenthesis>`
The penalty for breaking after ``(``.
.. _PenaltyBreakScopeResolution:
**PenaltyBreakScopeResolution** (``Unsigned``) :versionbadge:`clang-format 18` :ref:`¶ <PenaltyBreakScopeResolution>`
The penalty for breaking after ``::``.
.. _PenaltyBreakString:
**PenaltyBreakString** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <PenaltyBreakString>`
The penalty for each line break introduced inside a string literal.
.. _PenaltyBreakTemplateDeclaration:
**PenaltyBreakTemplateDeclaration** (``Unsigned``) :versionbadge:`clang-format 7` :ref:`¶ <PenaltyBreakTemplateDeclaration>`
The penalty for breaking after template declaration.
.. _PenaltyExcessCharacter:
**PenaltyExcessCharacter** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <PenaltyExcessCharacter>`
The penalty for each character outside of the column limit.
.. _PenaltyIndentedWhitespace:
**PenaltyIndentedWhitespace** (``Unsigned``) :versionbadge:`clang-format 12` :ref:`¶ <PenaltyIndentedWhitespace>`
Penalty for each character of whitespace indentation
(counted relative to leading non-whitespace column).
.. _PenaltyReturnTypeOnItsOwnLine:
**PenaltyReturnTypeOnItsOwnLine** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <PenaltyReturnTypeOnItsOwnLine>`
Penalty for putting the return type of a function onto its own line.
.. _PointerAlignment:
**PointerAlignment** (``PointerAlignmentStyle``) :versionbadge:`clang-format 3.7` :ref:`¶ <PointerAlignment>`
Pointer and reference alignment style.
Possible values:
* ``PAS_Left`` (in configuration: ``Left``)
Align pointer to the left.
.. code-block:: c++
int* a;
* ``PAS_Right`` (in configuration: ``Right``)
Align pointer to the right.
.. code-block:: c++
int *a;
* ``PAS_Middle`` (in configuration: ``Middle``)
Align pointer in the middle.
.. code-block:: c++
int * a;
.. _QualifierAlignment:
**QualifierAlignment** (``QualifierAlignmentStyle``) :versionbadge:`clang-format 14` :ref:`¶ <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).
.. code-block:: c++
int const a;
const int *a;
* ``QAS_Left`` (in configuration: ``Left``)
Change specifiers/qualifiers to be left-aligned.
.. code-block:: c++
const int a;
const int *a;
* ``QAS_Right`` (in configuration: ``Right``)
Change specifiers/qualifiers to be right-aligned.
.. code-block:: c++
int const a;
int const *a;
* ``QAS_Custom`` (in configuration: ``Custom``)
Change specifiers/qualifiers to be aligned based on ``QualifierOrder``.
With:
.. code-block:: yaml
QualifierOrder: [inline, static, type, const]
.. code-block:: c++
int const a;
int const *a;
.. _QualifierOrder:
**QualifierOrder** (``List of Strings``) :versionbadge:`clang-format 14` :ref:`¶ <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.
.. code-block:: yaml
QualifierOrder: [inline, static, type, const, volatile]
.. _RawStringFormats:
**RawStringFormats** (``List of RawStringFormats``) :versionbadge:`clang-format 6` :ref:`¶ <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:
.. code-block:: yaml
RawStringFormats:
- Language: TextProto
Delimiters:
- pb
- proto
EnclosingFunctions:
- PARSE_TEXT_PROTO
BasedOnStyle: google
- Language: Cpp
Delimiters:
- cc
- cpp
BasedOnStyle: LLVM
CanonicalDelimiter: cc
.. _ReferenceAlignment:
**ReferenceAlignment** (``ReferenceAlignmentStyle``) :versionbadge:`clang-format 13` :ref:`¶ <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.
.. code-block:: c++
int& a;
* ``RAS_Right`` (in configuration: ``Right``)
Align reference to the right.
.. code-block:: c++
int &a;
* ``RAS_Middle`` (in configuration: ``Middle``)
Align reference in the middle.
.. code-block:: c++
int & a;
.. _ReflowComments:
**ReflowComments** (``Boolean``) :versionbadge:`clang-format 3.8` :ref:`¶ <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``.
.. code-block:: c++
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:
**RemoveBracesLLVM** (``Boolean``) :versionbadge:`clang-format 14` :ref:`¶ <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.
.. code-block:: c++
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:
**RemoveParentheses** (``RemoveParenthesesStyle``) :versionbadge:`clang-format 17` :ref:`¶ <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:
* ``RPS_Leave`` (in configuration: ``Leave``)
Do not remove parentheses.
.. code-block:: c++
class __declspec((dllimport)) X {};
co_return (((0)));
return ((a + b) - ((c + d)));
* ``RPS_MultipleParentheses`` (in configuration: ``MultipleParentheses``)
Replace multiple parentheses with single parentheses.
.. code-block:: c++
class __declspec(dllimport) X {};
co_return (0);
return ((a + b) - (c + d));
* ``RPS_ReturnStatement`` (in configuration: ``ReturnStatement``)
Also remove parentheses enclosing the expression in a
``return``/``co_return`` statement.
.. code-block:: c++
class __declspec(dllimport) X {};
co_return 0;
return (a + b) - (c + d);
.. _RemoveSemicolon:
**RemoveSemicolon** (``Boolean``) :versionbadge:`clang-format 16` :ref:`¶ <RemoveSemicolon>`
Remove semicolons after the closing braces of functions and
constructors/destructors.
.. 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.
.. code-block:: c++
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:
**RequiresClausePosition** (``RequiresClausePositionStyle``) :versionbadge:`clang-format 15` :ref:`¶ <RequiresClausePosition>`
The position of the ``requires`` clause.
Possible values:
* ``RCPS_OwnLine`` (in configuration: ``OwnLine``)
Always put the ``requires`` clause on its own line (possibly followed by
a semicolon).
.. code-block:: c++
template <typename T>
requires C<T>
struct Foo {...
template <typename T>
void bar(T t)
requires C<T>;
template <typename T>
requires C<T>
void bar(T t) {...
template <typename T>
void baz(T t)
requires C<T>
{...
* ``RCPS_OwnLineWithBrace`` (in configuration: ``OwnLineWithBrace``)
As with ``OwnLine``, except, unless otherwise prohibited, place a
following open brace (of a function definition) to follow on the same
line.
.. code-block:: c++
void bar(T t)
requires C<T> {
return;
}
void bar(T t)
requires C<T> {}
template <typename T>
requires C<T>
void baz(T t) {
...
* ``RCPS_WithPreceding`` (in configuration: ``WithPreceding``)
Try to put the clause together with the preceding part of a declaration.
For class templates: stick to the template declaration.
For function templates: stick to the template declaration.
For function declaration followed by a requires clause: stick to the
parameter list.
.. code-block:: c++
template <typename T> requires C<T>
struct Foo {...
template <typename T> requires C<T>
void bar(T t) {...
template <typename T>
void baz(T t) requires C<T>
{...
* ``RCPS_WithFollowing`` (in configuration: ``WithFollowing``)
Try to put the ``requires`` clause together with the class or function
declaration.
.. code-block:: c++
template <typename T>
requires C<T> struct Foo {...
template <typename T>
requires C<T> void bar(T t) {...
template <typename T>
void baz(T t)
requires C<T> {...
* ``RCPS_SingleLine`` (in configuration: ``SingleLine``)
Try to put everything in the same line if possible. Otherwise normal
line breaking rules take over.
.. code-block:: c++
// Fitting:
template <typename T> requires C<T> struct Foo {...
template <typename T> requires C<T> void bar(T t) {...
template <typename T> void bar(T t) requires C<T> {...
// Not fitting, one possible example:
template <typename LongName>
requires C<LongName>
struct Foo {...
template <typename LongName>
requires C<LongName>
void bar(LongName ln) {
template <typename LongName>
void bar(LongName ln)
requires C<LongName> {
.. _RequiresExpressionIndentation:
**RequiresExpressionIndentation** (``RequiresExpressionIndentationKind``) :versionbadge:`clang-format 16` :ref:`¶ <RequiresExpressionIndentation>`
The indentation used for requires expression bodies.
Possible values:
* ``REI_OuterScope`` (in configuration: ``OuterScope``)
Align requires expression body relative to the indentation level of the
outer scope the requires expression resides in.
This is the default.
.. code-block:: c++
template <typename T>
concept C = requires(T t) {
...
}
* ``REI_Keyword`` (in configuration: ``Keyword``)
Align requires expression body relative to the ``requires`` keyword.
.. code-block:: c++
template <typename T>
concept C = requires(T t) {
...
}
.. _SeparateDefinitionBlocks:
**SeparateDefinitionBlocks** (``SeparateDefinitionStyle``) :versionbadge:`clang-format 14` :ref:`¶ <SeparateDefinitionBlocks>`
Specifies the use of empty lines to separate definition blocks, including
classes, structs, enums, and functions.
.. code-block:: c++
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:
**ShortNamespaceLines** (``Unsigned``) :versionbadge:`clang-format 13` :ref:`¶ <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.
.. code-block:: c++
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
.. _SkipMacroDefinitionBody:
**SkipMacroDefinitionBody** (``Boolean``) :versionbadge:`clang-format 18` :ref:`¶ <SkipMacroDefinitionBody>`
Do not format macro definition body.
.. _SortIncludes:
**SortIncludes** (``SortIncludesOptions``) :versionbadge:`clang-format 3.8` :ref:`¶ <SortIncludes>`
Controls if and how clang-format will sort ``#includes``.
Possible values:
* ``SI_Never`` (in configuration: ``Never``)
Includes are never sorted.
.. code-block:: c++
#include "B/A.h"
#include "A/B.h"
#include "a/b.h"
#include "A/b.h"
#include "B/a.h"
* ``SI_CaseSensitive`` (in configuration: ``CaseSensitive``)
Includes are sorted in an ASCIIbetical or case sensitive fashion.
.. code-block:: c++
#include "A/B.h"
#include "A/b.h"
#include "B/A.h"
#include "B/a.h"
#include "a/b.h"
* ``SI_CaseInsensitive`` (in configuration: ``CaseInsensitive``)
Includes are sorted in an alphabetical or case insensitive fashion.
.. code-block:: c++
#include "A/B.h"
#include "A/b.h"
#include "a/b.h"
#include "B/A.h"
#include "B/a.h"
.. _SortJavaStaticImport:
**SortJavaStaticImport** (``SortJavaStaticImportOptions``) :versionbadge:`clang-format 12` :ref:`¶ <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.
.. code-block:: java
import static org.example.function1;
import org.example.ClassA;
* ``SJSIO_After`` (in configuration: ``After``)
Static imports are placed after non-static imports.
.. code-block:: java
import org.example.ClassA;
import static org.example.function1;
.. _SortUsingDeclarations:
**SortUsingDeclarations** (``SortUsingDeclarationsOptions``) :versionbadge:`clang-format 5` :ref:`¶ <SortUsingDeclarations>`
Controls if and how clang-format will sort using declarations.
Possible values:
* ``SUD_Never`` (in configuration: ``Never``)
Using declarations are never sorted.
.. code-block:: c++
using std::chrono::duration_cast;
using std::move;
using boost::regex;
using boost::regex_constants::icase;
using std::string;
* ``SUD_Lexicographic`` (in configuration: ``Lexicographic``)
Using declarations are sorted in the order defined as follows:
Split the strings by ``::`` and discard any initial empty strings. Sort
the lists of names lexicographically, and within those groups, names are
in case-insensitive lexicographic order.
.. code-block:: c++
using boost::regex;
using boost::regex_constants::icase;
using std::chrono::duration_cast;
using std::move;
using std::string;
* ``SUD_LexicographicNumeric`` (in configuration: ``LexicographicNumeric``)
Using declarations are sorted in the order defined as follows:
Split the strings by ``::`` and discard any initial empty strings. The
last element of each list is a non-namespace name; all others are
namespace names. Sort the lists of names lexicographically, where the
sort order of individual names is that all non-namespace names come
before all namespace names, and within those groups, names are in
case-insensitive lexicographic order.
.. code-block:: c++
using boost::regex;
using boost::regex_constants::icase;
using std::move;
using std::string;
using std::chrono::duration_cast;
.. _SpaceAfterCStyleCast:
**SpaceAfterCStyleCast** (``Boolean``) :versionbadge:`clang-format 3.5` :ref:`¶ <SpaceAfterCStyleCast>`
If ``true``, a space is inserted after C style casts.
.. code-block:: c++
true: false:
(int) i; vs. (int)i;
.. _SpaceAfterLogicalNot:
**SpaceAfterLogicalNot** (``Boolean``) :versionbadge:`clang-format 9` :ref:`¶ <SpaceAfterLogicalNot>`
If ``true``, a space is inserted after the logical not operator (``!``).
.. code-block:: c++
true: false:
! someExpression(); vs. !someExpression();
.. _SpaceAfterTemplateKeyword:
**SpaceAfterTemplateKeyword** (``Boolean``) :versionbadge:`clang-format 4` :ref:`¶ <SpaceAfterTemplateKeyword>`
If ``true``, a space will be inserted after the ``template`` keyword.
.. code-block:: c++
true: false:
template <int> void foo(); vs. template<int> void foo();
.. _SpaceAroundPointerQualifiers:
**SpaceAroundPointerQualifiers** (``SpaceAroundPointerQualifiersStyle``) :versionbadge:`clang-format 12` :ref:`¶ <SpaceAroundPointerQualifiers>`
Defines in which cases to put a space before or after pointer qualifiers
Possible values:
* ``SAPQ_Default`` (in configuration: ``Default``)
Don't ensure spaces around pointer qualifiers and use PointerAlignment
instead.
.. code-block:: c++
PointerAlignment: Left PointerAlignment: Right
void* const* x = NULL; vs. void *const *x = NULL;
* ``SAPQ_Before`` (in configuration: ``Before``)
Ensure that there is a space before pointer qualifiers.
.. code-block:: c++
PointerAlignment: Left PointerAlignment: Right
void* const* x = NULL; vs. void * const *x = NULL;
* ``SAPQ_After`` (in configuration: ``After``)
Ensure that there is a space after pointer qualifiers.
.. code-block:: c++
PointerAlignment: Left PointerAlignment: Right
void* const * x = NULL; vs. void *const *x = NULL;
* ``SAPQ_Both`` (in configuration: ``Both``)
Ensure that there is a space both before and after pointer qualifiers.
.. code-block:: c++
PointerAlignment: Left PointerAlignment: Right
void* const * x = NULL; vs. void * const *x = NULL;
.. _SpaceBeforeAssignmentOperators:
**SpaceBeforeAssignmentOperators** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <SpaceBeforeAssignmentOperators>`
If ``false``, spaces will be removed before assignment operators.
.. code-block:: c++
true: false:
int a = 5; vs. int a= 5;
a += 42; a+= 42;
.. _SpaceBeforeCaseColon:
**SpaceBeforeCaseColon** (``Boolean``) :versionbadge:`clang-format 12` :ref:`¶ <SpaceBeforeCaseColon>`
If ``false``, spaces will be removed before case colon.
.. code-block:: c++
true: false
switch (x) { vs. switch (x) {
case 1 : break; case 1: break;
} }
.. _SpaceBeforeCpp11BracedList:
**SpaceBeforeCpp11BracedList** (``Boolean``) :versionbadge:`clang-format 7` :ref:`¶ <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).
.. code-block:: c++
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:
**SpaceBeforeCtorInitializerColon** (``Boolean``) :versionbadge:`clang-format 7` :ref:`¶ <SpaceBeforeCtorInitializerColon>`
If ``false``, spaces will be removed before constructor initializer
colon.
.. code-block:: c++
true: false:
Foo::Foo() : a(a) {} Foo::Foo(): a(a) {}
.. _SpaceBeforeInheritanceColon:
**SpaceBeforeInheritanceColon** (``Boolean``) :versionbadge:`clang-format 7` :ref:`¶ <SpaceBeforeInheritanceColon>`
If ``false``, spaces will be removed before inheritance colon.
.. code-block:: c++
true: false:
class Foo : Bar {} vs. class Foo: Bar {}
.. _SpaceBeforeJsonColon:
**SpaceBeforeJsonColon** (``Boolean``) :versionbadge:`clang-format 17` :ref:`¶ <SpaceBeforeJsonColon>`
If ``true``, a space will be added before a JSON colon. For other
languages, e.g. JavaScript, use ``SpacesInContainerLiterals`` instead.
.. code-block:: c++
true: false:
{ {
"key" : "value" vs. "key": "value"
} }
.. _SpaceBeforeParens:
**SpaceBeforeParens** (``SpaceBeforeParensStyle``) :versionbadge:`clang-format 3.5` :ref:`¶ <SpaceBeforeParens>`
Defines in which cases to put a space before opening parentheses.
Possible values:
* ``SBPO_Never`` (in configuration: ``Never``)
This is **deprecated** and replaced by ``Custom`` below, with all
``SpaceBeforeParensOptions`` but ``AfterPlacementOperator`` set to
``false``.
* ``SBPO_ControlStatements`` (in configuration: ``ControlStatements``)
Put a space before opening parentheses only after control statement
keywords (``for/if/while...``).
.. code-block:: c++
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.
.. code-block:: c++
void f() {
Q_FOREACH(...) {
f();
}
}
* ``SBPO_NonEmptyParentheses`` (in configuration: ``NonEmptyParentheses``)
Put a space before opening parentheses only if the parentheses are not
empty.
.. code-block:: c++
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.)
.. code-block:: c++
void f () {
if (true) {
f ();
}
}
* ``SBPO_Custom`` (in configuration: ``Custom``)
Configure each individual space before parentheses in
``SpaceBeforeParensOptions``.
.. _SpaceBeforeParensOptions:
**SpaceBeforeParensOptions** (``SpaceBeforeParensCustom``) :versionbadge:`clang-format 14` :ref:`¶ <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.
.. code-block:: yaml
# Example of usage:
SpaceBeforeParens: Custom
SpaceBeforeParensOptions:
AfterControlStatements: true
AfterFunctionDefinitionName: true
Nested configuration flags:
Precise control over the spacing before parentheses.
.. code-block:: c++
# Should be declared this way:
SpaceBeforeParens: Custom
SpaceBeforeParensOptions:
AfterControlStatements: true
AfterFunctionDefinitionName: true
* ``bool AfterControlStatements`` If ``true``, put space between control statement keywords
(for/if/while...) and opening parentheses.
.. code-block:: c++
true: false:
if (...) {} vs. if(...) {}
* ``bool AfterForeachMacros`` If ``true``, put space between foreach macros and opening parentheses.
.. code-block:: c++
true: false:
FOREACH (...) vs. FOREACH(...)
<loop-body> <loop-body>
* ``bool AfterFunctionDeclarationName`` If ``true``, put a space between function declaration name and opening
parentheses.
.. code-block:: c++
true: false:
void f (); vs. void f();
* ``bool AfterFunctionDefinitionName`` If ``true``, put a space between function definition name and opening
parentheses.
.. code-block:: c++
true: false:
void f () {} vs. void f() {}
* ``bool AfterIfMacros`` If ``true``, put space between if macros and opening parentheses.
.. code-block:: c++
true: false:
IF (...) vs. IF(...)
<conditional-body> <conditional-body>
* ``bool AfterOverloadedOperator`` If ``true``, put a space between operator overloading and opening
parentheses.
.. code-block:: c++
true: false:
void operator++ (int a); vs. void operator++(int a);
object.operator++ (10); object.operator++(10);
* ``bool AfterPlacementOperator`` If ``true``, put a space between operator ``new``/``delete`` and opening
parenthesis.
.. code-block:: c++
true: false:
new (buf) T; vs. new(buf) T;
delete (buf) T; delete(buf) T;
* ``bool AfterRequiresInClause`` If ``true``, put space between requires keyword in a requires clause and
opening parentheses, if there is one.
.. code-block:: c++
true: false:
template<typename T> vs. template<typename T>
requires (A<T> && B<T>) requires(A<T> && B<T>)
... ...
* ``bool AfterRequiresInExpression`` If ``true``, put space between requires keyword in a requires expression
and opening parentheses.
.. code-block:: c++
true: false:
template<typename T> vs. template<typename T>
concept C = requires (T t) { concept C = requires(T t) {
... ...
} }
* ``bool BeforeNonEmptyParentheses`` If ``true``, put a space before opening parentheses only if the
parentheses are not empty.
.. code-block:: c++
true: false:
void f (int a); vs. void f();
f (a); f();
.. _SpaceBeforeRangeBasedForLoopColon:
**SpaceBeforeRangeBasedForLoopColon** (``Boolean``) :versionbadge:`clang-format 7` :ref:`¶ <SpaceBeforeRangeBasedForLoopColon>`
If ``false``, spaces will be removed before range-based for loop
colon.
.. code-block:: c++
true: false:
for (auto v : values) {} vs. for(auto v: values) {}
.. _SpaceBeforeSquareBrackets:
**SpaceBeforeSquareBrackets** (``Boolean``) :versionbadge:`clang-format 10` :ref:`¶ <SpaceBeforeSquareBrackets>`
If ``true``, spaces will be before ``[``.
Lambdas will not be affected. Only the first ``[`` will get a space added.
.. code-block:: c++
true: false:
int a [5]; vs. int a[5];
int a [5][5]; vs. int a[5][5];
.. _SpaceInEmptyBlock:
**SpaceInEmptyBlock** (``Boolean``) :versionbadge:`clang-format 10` :ref:`¶ <SpaceInEmptyBlock>`
If ``true``, spaces will be inserted into ``{}``.
.. code-block:: c++
true: false:
void f() { } vs. void f() {}
while (true) { } while (true) {}
.. _SpaceInEmptyParentheses:
**SpaceInEmptyParentheses** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <SpaceInEmptyParentheses>`
If ``true``, spaces may be inserted into ``()``.
This option is **deprecated**. See ``InEmptyParentheses`` of
``SpacesInParensOptions``.
.. _SpacesBeforeTrailingComments:
**SpacesBeforeTrailingComments** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <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.
.. code-block:: c++
SpacesBeforeTrailingComments: 3
void f() {
if (true) { // foo1
f(); // bar
} // foo
}
.. _SpacesInAngles:
**SpacesInAngles** (``SpacesInAnglesStyle``) :versionbadge:`clang-format 3.4` :ref:`¶ <SpacesInAngles>`
The SpacesInAnglesStyle to use for template argument lists.
Possible values:
* ``SIAS_Never`` (in configuration: ``Never``)
Remove spaces after ``<`` and before ``>``.
.. code-block:: c++
static_cast<int>(arg);
std::function<void(int)> fct;
* ``SIAS_Always`` (in configuration: ``Always``)
Add spaces after ``<`` and before ``>``.
.. code-block:: c++
static_cast< int >(arg);
std::function< void(int) > fct;
* ``SIAS_Leave`` (in configuration: ``Leave``)
Keep a single space after ``<`` and before ``>`` if any spaces were
present. Option ``Standard: Cpp03`` takes precedence.
.. _SpacesInCStyleCastParentheses:
**SpacesInCStyleCastParentheses** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <SpacesInCStyleCastParentheses>`
If ``true``, spaces may be inserted into C style casts.
This option is **deprecated**. See ``InCStyleCasts`` of
``SpacesInParensOptions``.
.. _SpacesInConditionalStatement:
**SpacesInConditionalStatement** (``Boolean``) :versionbadge:`clang-format 10` :ref:`¶ <SpacesInConditionalStatement>`
If ``true``, spaces will be inserted around if/for/switch/while
conditions.
This option is **deprecated**. See ``InConditionalStatements`` of
``SpacesInParensOptions``.
.. _SpacesInContainerLiterals:
**SpacesInContainerLiterals** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <SpacesInContainerLiterals>`
If ``true``, spaces are inserted inside container literals (e.g. ObjC and
Javascript array and dict literals). For JSON, use
``SpaceBeforeJsonColon`` instead.
.. code-block:: js
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:
**SpacesInLineCommentPrefix** (``SpacesInLineComment``) :versionbadge:`clang-format 13` :ref:`¶ <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.
.. code-block:: c++
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:
.. code-block:: c++
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:
**SpacesInParens** (``SpacesInParensStyle``) :versionbadge:`clang-format 17` :ref:`¶ <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.
.. code-block:: c++
void f() {
if(true) {
f();
}
}
* ``SIPO_Custom`` (in configuration: ``Custom``)
Configure each individual space in parentheses in
`SpacesInParensOptions`.
.. _SpacesInParensOptions:
**SpacesInParensOptions** (``SpacesInParensCustom``) :versionbadge:`clang-format 17` :ref:`¶ <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.
.. code-block:: yaml
# Example of usage:
SpacesInParens: Custom
SpacesInParensOptions:
ExceptDoubleParentheses: false
InConditionalStatements: true
InEmptyParentheses: true
Nested configuration flags:
Precise control over the spacing in parentheses.
.. code-block:: c++
# Should be declared this way:
SpacesInParens: Custom
SpacesInParensOptions:
ExceptDoubleParentheses: false
InConditionalStatements: true
Other: true
* ``bool ExceptDoubleParentheses`` Override any of the following options to prevent addition of space
when both opening and closing parentheses use multiple parentheses.
.. code-block:: c++
true:
__attribute__(( noreturn ))
__decltype__(( x ))
if (( a = b ))
false:
Uses the applicable option.
* ``bool InConditionalStatements`` Put a space in parentheses only inside conditional statements
(``for/if/while/switch...``).
.. code-block:: c++
true: false:
if ( a ) { ... } vs. if (a) { ... }
while ( i < 5 ) { ... } while (i < 5) { ... }
* ``bool InCStyleCasts`` Put a space in C style casts.
.. code-block:: c++
true: false:
x = ( int32 )y vs. x = (int32)y
y = (( int (*)(int) )foo)(x); y = ((int (*)(int))foo)(x);
* ``bool InEmptyParentheses`` Insert a space in empty parentheses, i.e. ``()``.
.. code-block:: c++
true: false:
void f( ) { vs. void f() {
int x[] = {foo( ), bar( )}; int x[] = {foo(), bar()};
if (true) { if (true) {
f( ); f();
} }
} }
* ``bool Other`` Put a space in parentheses not covered by preceding options.
.. code-block:: c++
true: false:
t f( Deleted & ) & = delete; vs. t f(Deleted &) & = delete;
.. _SpacesInParentheses:
**SpacesInParentheses** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <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:
**SpacesInSquareBrackets** (``Boolean``) :versionbadge:`clang-format 3.7` :ref:`¶ <SpacesInSquareBrackets>`
If ``true``, spaces will be inserted after ``[`` and before ``]``.
Lambdas without arguments or unspecified size array declarations will not
be affected.
.. code-block:: c++
true: false:
int a[ 5 ]; vs. int a[5];
std::unique_ptr<int[]> foo() {} // Won't be affected
.. _Standard:
**Standard** (``LanguageStandard``) :versionbadge:`clang-format 3.7` :ref:`¶ <Standard>`
Parse and format C++ constructs compatible with this standard.
.. code-block:: c++
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:
**StatementAttributeLikeMacros** (``List of Strings``) :versionbadge:`clang-format 12` :ref:`¶ <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.
.. code-block:: c++
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:
**StatementMacros** (``List of Strings``) :versionbadge:`clang-format 8` :ref:`¶ <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:
**TabWidth** (``Unsigned``) :versionbadge:`clang-format 3.7` :ref:`¶ <TabWidth>`
The number of columns used for tab stops.
.. _TableGenBreakInsideDAGArg:
**TableGenBreakInsideDAGArg** (``DAGArgStyle``) :versionbadge:`clang-format 19` :ref:`¶ <TableGenBreakInsideDAGArg>`
The styles of the line break inside the DAGArg in TableGen.
Possible values:
* ``DAS_DontBreak`` (in configuration: ``DontBreak``)
Never break inside DAGArg.
.. code-block:: c++
let DAGArgIns = (ins i32:$src1, i32:$src2);
* ``DAS_BreakElements`` (in configuration: ``BreakElements``)
Break inside DAGArg after each list element but for the last.
This aligns to the first element.
.. code-block:: c++
let DAGArgIns = (ins i32:$src1,
i32:$src2);
* ``DAS_BreakAll`` (in configuration: ``BreakAll``)
Break inside DAGArg after the operator and the all elements.
.. code-block:: c++
let DAGArgIns = (ins
i32:$src1,
i32:$src2
);
.. _TableGenBreakingDAGArgOperators:
**TableGenBreakingDAGArgOperators** (``List of Strings``) :versionbadge:`clang-format 19` :ref:`¶ <TableGenBreakingDAGArgOperators>`
Works only when TableGenBreakInsideDAGArg is not DontBreak.
The string list needs to consist of identifiers in TableGen.
If any identifier is specified, this limits the line breaks by
TableGenBreakInsideDAGArg option only on DAGArg values beginning with
the specified identifiers.
For example the configuration,
.. code-block:: yaml
TableGenBreakInsideDAGArg: BreakAll
TableGenBreakingDAGArgOperators: [ins, outs]
makes the line break only occurs inside DAGArgs beginning with the
specified identifiers ``ins`` and ``outs``.
.. code-block:: c++
let DAGArgIns = (ins
i32:$src1,
i32:$src2
);
let DAGArgOtherID = (other i32:$other1, i32:$other2);
let DAGArgBang = (!cast<SomeType>("Some") i32:$src1, i32:$src2)
.. _TemplateNames:
**TemplateNames** (``List of Strings``) :versionbadge:`clang-format 20` :ref:`¶ <TemplateNames>`
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.
.. _TypeNames:
**TypeNames** (``List of Strings``) :versionbadge:`clang-format 17` :ref:`¶ <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:
**TypenameMacros** (``List of Strings``) :versionbadge:`clang-format 9` :ref:`¶ <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:
.. code-block:: c++
STACK_OF(...)
In the .clang-format configuration file, this can be configured like:
.. code-block:: yaml
TypenameMacros: [STACK_OF, LIST]
For example: OpenSSL STACK_OF, BSD LIST_ENTRY.
.. _UseCRLF:
**UseCRLF** (``Boolean``) :versionbadge:`clang-format 10` :ref:`¶ <UseCRLF>`
This option is **deprecated**. See ``LF`` and ``CRLF`` of ``LineEnding``.
.. _UseTab:
**UseTab** (``UseTabStyle``) :versionbadge:`clang-format 3.7` :ref:`¶ <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:
**VerilogBreakBetweenInstancePorts** (``Boolean``) :versionbadge:`clang-format 17` :ref:`¶ <VerilogBreakBetweenInstancePorts>`
For Verilog, put each port on its own line in module instantiations.
.. code-block:: c++
true:
ffnand ff1(.q(),
.qbar(out1),
.clear(in1),
.preset(in2));
false:
ffnand ff1(.q(), .qbar(out1), .clear(in1), .preset(in2));
.. _WhitespaceSensitiveMacros:
**WhitespaceSensitiveMacros** (``List of Strings``) :versionbadge:`clang-format 11` :ref:`¶ <WhitespaceSensitiveMacros>`
A vector of macros which are whitespace-sensitive and should not
be touched.
These are expected to be macros of the form:
.. code-block:: c++
STRINGIZE(...)
In the .clang-format configuration file, this can be configured like:
.. code-block:: yaml
WhitespaceSensitiveMacros: [STRINGIZE, PP_STRINGIZE]
For example: BOOST_PP_STRINGIZE
.. END_FORMAT_STYLE_OPTIONS
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
<https://www.kernel.org/doc/html/latest/process/coding-style.html>`_:
.. code-block:: yaml
BasedOnStyle: LLVM
IndentWidth: 8
UseTab: Always
BreakBeforeBraces: Linux
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false
The result is (imagine that tabs are used for indentation here):
.. code-block:: c++
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:
.. code-block:: yaml
UseTab: Never
IndentWidth: 4
BreakBeforeBraces: Allman
AllowShortIfStatementsOnASingleLine: false
IndentCaseLabels: false
ColumnLimit: 0
The result is:
.. code-block:: c++
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();
}
}
Codebase Browser
llvm