Index: docs/ClangFormatStyleOptions.rst =================================================================== --- docs/ClangFormatStyleOptions.rst +++ docs/ClangFormatStyleOptions.rst @@ -1,1605 +1,1618 @@ -========================== -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) 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. - -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 lanugages. -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 - ... - -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. - -.. 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 -`_ -structure. - - -Configurable Format Style Options -================================= - -This section lists the supported style options. Value type is specified for -each option. For enumeration types possible values are specified both as a C++ -enumeration member (with a prefix, e.g. ``LS_Auto``), and as a value usable in -the configuration (without a prefix: ``Auto``). - - -**BasedOnStyle** (``string``) - 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 - `_ - * ``Google`` - A style complying with `Google's C++ style guide - `_ - * ``Chromium`` - A style complying with `Chromium's style guide - `_ - * ``Mozilla`` - A style complying with `Mozilla's style guide - `_ - * ``WebKit`` - A style complying with `WebKit's style guide - `_ - -.. START_FORMAT_STYLE_OPTIONS - -**AccessModifierOffset** (``int``) - The extra indent or outdent of access modifiers, e.g. ``public:``. - -**AlignAfterOpenBracket** (``BracketAlignmentStyle``) - 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); - - - -**AlignConsecutiveAssignments** (``bool``) - If ``true``, aligns consecutive assignments. - - This will align the assignment operators of consecutive lines. This - will result in formattings like - - .. code-block:: c++ - - int aaaa = 12; - int b = 23; - int ccc = 23; - -**AlignConsecutiveDeclarations** (``bool``) - If ``true``, aligns consecutive declarations. - - This 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 = 23; - -**AlignEscapedNewlinesLeft** (``bool``) - If ``true``, aligns escaped newlines as far left as possible. - Otherwise puts them into the right-most column. - - .. code-block:: c++ - - true: - #define A \ - int aaaa; \ - int b; \ - int dddddddddd; - - false: - #define A \ - int aaaa; \ - int b; \ - int dddddddddd; - -**AlignOperands** (``bool``) - If ``true``, 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; - -**AlignTrailingComments** (``bool``) - If ``true``, aligns trailing comments. - - .. code-block:: c++ - - true: false: - int a; // My comment a vs. int a; // My comment a - int b = 2; // comment b int b = 2; // comment about b - -**AllowAllParametersOfDeclarationOnNextLine** (``bool``) - Allow putting all parameters of a function declaration onto - the next line even if ``BinPackParameters`` is ``false``. - - .. code-block:: c++ - - true: false: - myFunction(foo, vs. myFunction(foo, bar, plop); - bar, - plop); - -**AllowShortBlocksOnASingleLine** (``bool``) - Allows contracting simple braced statements to a single line. - - E.g., this allows ``if (a) { return; }`` to be put on a single line. - -**AllowShortCaseLabelsOnASingleLine** (``bool``) - 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; - } - -**AllowShortFunctionsOnASingleLine** (``ShortFunctionStyle``) - 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_Empty`` (in configuration: ``Empty``) - Only merge empty functions. - - .. code-block:: c++ - - void f() { bar(); } - 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(); } - }; - - * ``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** (``bool``) - If ``true``, ``if (a) return;`` can be put on a single line. - -**AllowShortLoopsOnASingleLine** (``bool``) - If ``true``, ``while (true) continue;`` can be put on a single - line. - -**AlwaysBreakAfterDefinitionReturnType** (``DefinitionReturnTypeBreakingStyle``) - The function definition return type breaking style to use. This - option is **deprecated** and is retained for backwards compatibility. - - Possible values: - - * ``DRTBS_None`` (in configuration: ``None``) - Break after return type automatically. - ``PenaltyReturnTypeOnItsOwnLine`` is taken into account. - - * ``DRTBS_All`` (in configuration: ``All``) - Always break after the return type. - - * ``DRTBS_TopLevel`` (in configuration: ``TopLevel``) - Always break after the return types of top-level functions. - - - -**AlwaysBreakAfterReturnType** (``ReturnTypeBreakingStyle``) - The function declaration return type breaking style to use. - - Possible values: - - * ``RTBS_None`` (in configuration: ``None``) - Break after return type automatically. - ``PenaltyReturnTypeOnItsOwnLine`` is taken into account. - - .. code-block:: c++ - - class A { - int f() { return 0; }; - }; - int f(); - int f() { return 1; } - - * ``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; - } - - * ``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; - } - - * ``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; - } - - * ``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; - } - - - -**AlwaysBreakBeforeMultilineStrings** (``bool``) - 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** (``bool``) - If ``true``, always break after the ``template<...>`` of a template - declaration. - - .. code-block:: c++ - - true: false: - template vs. template class C {}; - class C {}; - -**BinPackArguments** (``bool``) - 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** (``bool``) - If ``false``, a function declaration's or function definition's - parameters will either all be on the same line or will have one line each. - - .. code-block:: c++ - - true: - void f(int aaaaaaaaaaaaaaaaaaaa, int aaaaaaaaaaaaaaaaaaaa, - int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {} - - false: - void f(int aaaaaaaaaaaaaaaaaaaa, - int aaaaaaaaaaaaaaaaaaaa, - int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {} - -**BraceWrapping** (``BraceWrappingFlags``) - 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. - - Nested configuration flags: - - - * ``bool AfterClass`` Wrap class definitions. - - .. code-block:: c++ - - true: - class foo {}; - - false: - class foo - {}; - - * ``bool AfterControlStatement`` Wrap control statements (``if``/``for``/``while``/``switch``/..). - - .. code-block:: c++ - - true: - if (foo()) - { - } else - {} - for (int i = 0; i < 10; ++i) - {} - - false: - 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 (``@autoreleasepool``, interfaces, ..). - - * ``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 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 IndentBraces`` Indent the wrapped braces themselves. - - -**BreakAfterJavaFieldAnnotations** (``bool``) - Break after each annotation on a field in Java files. - -**BreakBeforeBinaryOperators** (``BinaryOperatorStyle``) - 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** (``BraceBreakingStyle``) - The brace breaking style to use. - - Possible values: - - * ``BS_Attach`` (in configuration: ``Attach``) - Always attach braces to surrounding context. - - .. code-block:: c++ - - try { - foo(); - } catch () { - } - void foo() { bar(); } - class foo {}; - if (foo()) { - } else { - } - enum X : int { A, B }; - - * ``BS_Linux`` (in configuration: ``Linux``) - Like ``Attach``, but break before braces on function, namespace and - class definitions. - - .. code-block:: c++ - - try { - foo(); - } catch () { - } - void foo() { bar(); } - class foo - { - }; - if (foo()) { - } else { - } - enum X : int { A, B }; - - * ``BS_Mozilla`` (in configuration: ``Mozilla``) - Like ``Attach``, but break before braces on enum, function, and record - definitions. - - .. code-block:: c++ - - try { - foo(); - } catch () { - } - void foo() { bar(); } - class foo - { - }; - if (foo()) { - } else { - } - enum X : int { A, B }; - - * ``BS_Stroustrup`` (in configuration: ``Stroustrup``) - Like ``Attach``, but break before function definitions, ``catch``, and - ``else``. - - .. code-block:: c++ - - try { - foo(); - } catch () { - } - void foo() { bar(); } - class foo - { - }; - if (foo()) { - } else { - } - enum X : int - { - A, - B - }; - - * ``BS_Allman`` (in configuration: ``Allman``) - Always break before braces. - - .. code-block:: c++ - - try { - foo(); - } - catch () { - } - void foo() { bar(); } - class foo { - }; - if (foo()) { - } - else { - } - enum X : int { A, B }; - - * ``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++ - - try - { - foo(); - } - catch () - { - } - void foo() { bar(); } - class foo - { - }; - if (foo()) - { - } - else - { - } - enum X : int - { - A, - B - }; - - * ``BS_WebKit`` (in configuration: ``WebKit``) - Like ``Attach``, but break before functions. - - .. code-block:: c++ - - try { - foo(); - } catch () { - } - void foo() { bar(); } - class foo { - }; - if (foo()) { - } else { - } - enum X : int { A, B }; - - * ``BS_Custom`` (in configuration: ``Custom``) - Configure each individual brace in `BraceWrapping`. - - - -**BreakBeforeInheritanceComma** (``bool``) - If ``true``, in the class inheritance expression clang-format will - break before ``:`` and ``,`` if there is multiple inheritance. - - .. code-block:: c++ - - true: false: - class MyClass vs. class MyClass : public X, public Y { - : public X }; - , public Y { - }; - -**BreakBeforeTernaryOperators** (``bool``) - If ``true``, ternary operators will be placed after line breaks. - - .. code-block:: c++ - - true: - veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription - ? firstValue - : SecondValueVeryVeryVeryVeryLong; - - true: - veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ? - firstValue : - SecondValueVeryVeryVeryVeryLong; - -**BreakConstructorInitializersBeforeComma** (``bool``) - Always break constructor initializers before commas and align - the commas with the colon. - - .. code-block:: c++ - - true: false: - SomeClass::Constructor() vs. SomeClass::Constructor() : a(a), - : a(a) b(b), - , b(b) c(c) {} - , c(c) {} - -**BreakStringLiterals** (``bool``) - Allow breaking string literals when formatting. - -**ColumnLimit** (``unsigned``) - 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** (``std::string``) - 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 // FOOBAR pragma: keep - -**ConstructorInitializerAllOnOneLineOrOnePerLine** (``bool``) - If the constructor initializers don't fit on a line, put each - initializer on its own line. - - .. code-block:: c++ - - true: - SomeClass::Constructor() - : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa) { - return 0; - } - - false: - SomeClass::Constructor() - : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), - aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa) { - return 0; - } - -**ConstructorInitializerIndentWidth** (``unsigned``) - The number of characters to use for indentation of constructor - initializer lists. - -**ContinuationIndentWidth** (``unsigned``) - Indent width for line continuations. - -**Cpp11BracedListStyle** (``bool``) - 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. - -**DerivePointerAlignment** (``bool``) - If ``true``, analyze the formatted file for the most common - alignment of ``&`` and ``*``. ``PointerAlignment`` is then used only as - fallback. - -**DisableFormat** (``bool``) - Disables formatting completely. - -**ExperimentalAutoDetectBinPacking** (``bool``) - 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** (``bool``) - If ``true``, clang-format adds missing namespace end comments and - fixes invalid existing ones. - - .. code-block:: c++ - - true: false: - namespace a { vs. namespace a { - foo(); foo(); - } // namespace a; } - -**ForEachMacros** (``std::vector``) - 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(, ...) - - - In the .clang-format configuration file, this can be configured like: - - .. code-block:: yaml - - ForEachMacros: ['RANGES_FOR', 'FOREACH'] - - For example: BOOST_FOREACH. - -**IncludeCategories** (``std::vector``) - Regular expressions denoting the different ``#include`` categories - used for ordering ``#includes``. - - 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`` - (http://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. - - To configure this in the .clang-format file, use: - - .. code-block:: yaml - - IncludeCategories: - - Regex: '^"(llvm|llvm-c|clang|clang-c)/' - Priority: 2 - - Regex: '^(<|"(gtest|isl|json)/)' - Priority: 3 - - Regex: '.*' - Priority: 1 - -**IncludeIsMainRegex** (``std::string``) - 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. - -**IndentCaseLabels** (``bool``) - 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. - -**IndentWidth** (``unsigned``) - The number of columns to use for indentation. - - .. code-block:: c++ - - IndentWidth: 3 - void f() { - someFunction(); - if (true, false) { - f(); - } - } - -**IndentWrappedFunctionNames** (``bool``) - Indent if a function definition or declaration is wrapped after the - type. - -**JavaScriptQuotes** (``JavaScriptQuoteStyle``) - 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** (``bool``) - 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" - -**KeepEmptyLinesAtTheStartOfBlocks** (``bool``) - If true, empty lines at the start of blocks are kept. - -**Language** (``LanguageKind``) - 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_Java`` (in configuration: ``Java``) - Should be used for Java. - - * ``LK_JavaScript`` (in configuration: ``JavaScript``) - Should be used for JavaScript. - - * ``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. - - - -**MacroBlockBegin** (``std::string``) - 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** (``std::string``) - A regular expression matching macros that end a block. - -**MaxEmptyLinesToKeep** (``unsigned``) - 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** (``NamespaceIndentationKind``) - 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; - } - } - - - -**ObjCBlockIndentWidth** (``unsigned``) - The number of characters to use for indentation of ObjC blocks. - -**ObjCSpaceAfterProperty** (``bool``) - Add a space after ``@property`` in Objective-C, i.e. use - ``@property (readonly)`` instead of ``@property(readonly)``. - -**ObjCSpaceBeforeProtocolList** (``bool``) - Add a space in front of an Objective-C protocol list, i.e. use - ``Foo `` instead of ``Foo``. - -**PenaltyBreakBeforeFirstCallParameter** (``unsigned``) - The penalty for breaking a function call after ``call(``. - -**PenaltyBreakComment** (``unsigned``) - The penalty for each line break introduced inside a comment. - -**PenaltyBreakFirstLessLess** (``unsigned``) - The penalty for breaking before the first ``<<``. - -**PenaltyBreakString** (``unsigned``) - The penalty for each line break introduced inside a string literal. - -**PenaltyExcessCharacter** (``unsigned``) - The penalty for each character outside of the column limit. - -**PenaltyReturnTypeOnItsOwnLine** (``unsigned``) - Penalty for putting the return type of a function onto its own - line. - -**PointerAlignment** (``PointerAlignmentStyle``) - 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; - - - -**ReflowComments** (``bool``) - If ``true``, clang-format will attempt to re-flow comments. - - .. 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 */ - -**SortIncludes** (``bool``) - If ``true``, clang-format will sort ``#includes``. - - .. code-block:: c++ - - false: true: - #include "b.h" vs. #include "a.h" - #include "a.h" #include "b.h" - -**SpaceAfterCStyleCast** (``bool``) - If ``true``, a space is inserted after C style casts. - - .. code-block:: c++ - - true: false: - (int)i; vs. (int) i; - -**SpaceAfterTemplateKeyword** (``bool``) - If ``true``, a space will be inserted after the 'template' keyword. - - .. code-block:: c++ - - true: false: - template void foo(); vs. template void foo(); - -**SpaceBeforeAssignmentOperators** (``bool``) - 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; - -**SpaceBeforeParens** (``SpaceBeforeParensOptions``) - Defines in which cases to put a space before opening parentheses. - - Possible values: - - * ``SBPO_Never`` (in configuration: ``Never``) - Never put a space before opening parentheses. - - .. code-block:: c++ - - void f() { - if(true) { - f(); - } - } - - * ``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_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 (); - } - } - - - -**SpaceInEmptyParentheses** (``bool``) - If ``true``, spaces may be inserted into ``()``. - - .. code-block:: c++ - - true: false: - void f( ) { vs. void f() { - int x[] = {foo( ), bar( )}; int x[] = {foo(), bar()}; - if (true) { if (true) { - f( ); f(); - } } - } } - -**SpacesBeforeTrailingComments** (``unsigned``) - 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. - - .. code-block:: c++ - - SpacesBeforeTrailingComments: 3 - void f() { - if (true) { // foo1 - f(); // bar - } // foo - } - -**SpacesInAngles** (``bool``) - If ``true``, spaces will be inserted after ``<`` and before ``>`` - in template argument lists. - - .. code-block:: c++ - - true: false: - static_cast< int >(arg); vs. static_cast(arg); - std::function< void(int) > fct; std::function fct; - -**SpacesInCStyleCastParentheses** (``bool``) - If ``true``, spaces may be inserted into C style casts. - - .. code-block:: c++ - - true: false: - x = ( int32 )y vs. x = (int32)y - -**SpacesInContainerLiterals** (``bool``) - If ``true``, spaces are inserted inside container literals (e.g. - ObjC and Javascript array and dict literals). - - .. 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}); - -**SpacesInParentheses** (``bool``) - If ``true``, spaces will be inserted after ``(`` and before ``)``. - - .. code-block:: c++ - - true: false: - t f( Deleted & ) & = delete; vs. t f(Deleted &) & = delete; - -**SpacesInSquareBrackets** (``bool``) - If ``true``, spaces will be inserted after ``[`` and before ``]``. - Lambdas or unspecified size array declarations will not be affected. - - .. code-block:: c++ - - true: false: - int a[ 5 ]; vs. int a[5]; - std::unique_ptr foo() {} // Won't be affected - -**Standard** (``LanguageStandard``) - Format compatible with this standard, e.g. use ``A >`` - instead of ``A>`` for ``LS_Cpp03``. - - Possible values: - - * ``LS_Cpp03`` (in configuration: ``Cpp03``) - Use C++03-compatible syntax. - - * ``LS_Cpp11`` (in configuration: ``Cpp11``) - Use features of C++11 (e.g. ``A>`` instead of ``A >``). - - * ``LS_Auto`` (in configuration: ``Auto``) - Automatic detection based on the input. - - - -**TabWidth** (``unsigned``) - The number of columns used for tab stops. - -**UseTab** (``UseTabStyle``) - 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``) - Use tabs only for line continuation and indentation. - - * ``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. - - - -.. 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 -`_: - -.. 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_somthing_completely_different(); - - if (x == y) - { - q(); - } - else if (x > y) - { - w(); - } - else - { - r(); - } - } +========================== +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) 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. + +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 lanugages. +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 + ... + +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. + +.. 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 +`_ +structure. + + +Configurable Format Style Options +================================= + +This section lists the supported style options. Value type is specified for +each option. For enumeration types possible values are specified both as a C++ +enumeration member (with a prefix, e.g. ``LS_Auto``), and as a value usable in +the configuration (without a prefix: ``Auto``). + + +**BasedOnStyle** (``string``) + 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 + `_ + * ``Google`` + A style complying with `Google's C++ style guide + `_ + * ``Chromium`` + A style complying with `Chromium's style guide + `_ + * ``Mozilla`` + A style complying with `Mozilla's style guide + `_ + * ``WebKit`` + A style complying with `WebKit's style guide + `_ + +.. START_FORMAT_STYLE_OPTIONS + +**AccessModifierOffset** (``int``) + The extra indent or outdent of access modifiers, e.g. ``public:``. + +**AlignAfterOpenBracket** (``BracketAlignmentStyle``) + 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); + + + +**AlignConsecutiveAssignments** (``bool``) + If ``true``, aligns consecutive assignments. + + This will align the assignment operators of consecutive lines. This + will result in formattings like + + .. code-block:: c++ + + int aaaa = 12; + int b = 23; + int ccc = 23; + +**AlignConsecutiveDeclarations** (``bool``) + If ``true``, aligns consecutive declarations. + + This 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 = 23; + +**AlignEscapedNewlinesLeft** (``bool``) + If ``true``, aligns escaped newlines as far left as possible. + Otherwise puts them into the right-most column. + + .. code-block:: c++ + + true: + #define A \ + int aaaa; \ + int b; \ + int dddddddddd; + + false: + #define A \ + int aaaa; \ + int b; \ + int dddddddddd; + +**AlignOperands** (``bool``) + If ``true``, 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; + +**AlignTrailingComments** (``bool``) + If ``true``, aligns trailing comments. + + .. code-block:: c++ + + true: false: + int a; // My comment a vs. int a; // My comment a + int b = 2; // comment b int b = 2; // comment about b + +**AllowAllParametersOfDeclarationOnNextLine** (``bool``) + Allow putting all parameters of a function declaration onto + the next line even if ``BinPackParameters`` is ``false``. + + .. code-block:: c++ + + true: false: + myFunction(foo, vs. myFunction(foo, bar, plop); + bar, + plop); + +**AllowShortBlocksOnASingleLine** (``bool``) + Allows contracting simple braced statements to a single line. + + E.g., this allows ``if (a) { return; }`` to be put on a single line. + +**AllowShortCaseLabelsOnASingleLine** (``bool``) + 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; + } + +**AllowShortFunctionsOnASingleLine** (``ShortFunctionStyle``) + 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_Empty`` (in configuration: ``Empty``) + Only merge empty functions. + + .. code-block:: c++ + + void f() { bar(); } + 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(); } + }; + + * ``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** (``bool``) + If ``true``, ``if (a) return;`` can be put on a single line. + +**AllowShortLoopsOnASingleLine** (``bool``) + If ``true``, ``while (true) continue;`` can be put on a single + line. + +**AlwaysBreakAfterDefinitionReturnType** (``DefinitionReturnTypeBreakingStyle``) + The function definition return type breaking style to use. This + option is **deprecated** and is retained for backwards compatibility. + + Possible values: + + * ``DRTBS_None`` (in configuration: ``None``) + Break after return type automatically. + ``PenaltyReturnTypeOnItsOwnLine`` is taken into account. + + * ``DRTBS_All`` (in configuration: ``All``) + Always break after the return type. + + * ``DRTBS_TopLevel`` (in configuration: ``TopLevel``) + Always break after the return types of top-level functions. + + + +**AlwaysBreakAfterReturnType** (``ReturnTypeBreakingStyle``) + The function declaration return type breaking style to use. + + Possible values: + + * ``RTBS_None`` (in configuration: ``None``) + Break after return type automatically. + ``PenaltyReturnTypeOnItsOwnLine`` is taken into account. + + .. code-block:: c++ + + class A { + int f() { return 0; }; + }; + int f(); + int f() { return 1; } + + * ``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; + } + + * ``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; + } + + * ``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; + } + + * ``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; + } + + + +**AlwaysBreakBeforeMultilineStrings** (``bool``) + 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** (``bool``) + If ``true``, always break after the ``template<...>`` of a template + declaration. + + .. code-block:: c++ + + true: false: + template vs. template class C {}; + class C {}; + +**BinPackArguments** (``bool``) + 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** (``bool``) + If ``false``, a function declaration's or function definition's + parameters will either all be on the same line or will have one line each. + + .. code-block:: c++ + + true: + void f(int aaaaaaaaaaaaaaaaaaaa, int aaaaaaaaaaaaaaaaaaaa, + int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {} + + false: + void f(int aaaaaaaaaaaaaaaaaaaa, + int aaaaaaaaaaaaaaaaaaaa, + int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {} + +**BraceWrapping** (``BraceWrappingFlags``) + 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. + + Nested configuration flags: + + + * ``bool AfterClass`` Wrap class definitions. + + .. code-block:: c++ + + true: + class foo {}; + + false: + class foo + {}; + + * ``bool AfterControlStatement`` Wrap control statements (``if``/``for``/``while``/``switch``/..). + + .. code-block:: c++ + + true: + if (foo()) + { + } else + {} + for (int i = 0; i < 10; ++i) + {} + + false: + 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 (``@autoreleasepool``, interfaces, ..). + + * ``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 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 IndentBraces`` Indent the wrapped braces themselves. + + +**BreakAfterJavaFieldAnnotations** (``bool``) + Break after each annotation on a field in Java files. + +**BreakBeforeBinaryOperators** (``BinaryOperatorStyle``) + 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** (``BraceBreakingStyle``) + The brace breaking style to use. + + Possible values: + + * ``BS_Attach`` (in configuration: ``Attach``) + Always attach braces to surrounding context. + + .. code-block:: c++ + + try { + foo(); + } catch () { + } + void foo() { bar(); } + class foo {}; + if (foo()) { + } else { + } + enum X : int { A, B }; + + * ``BS_Linux`` (in configuration: ``Linux``) + Like ``Attach``, but break before braces on function, namespace and + class definitions. + + .. code-block:: c++ + + try { + foo(); + } catch () { + } + void foo() { bar(); } + class foo + { + }; + if (foo()) { + } else { + } + enum X : int { A, B }; + + * ``BS_Mozilla`` (in configuration: ``Mozilla``) + Like ``Attach``, but break before braces on enum, function, and record + definitions. + + .. code-block:: c++ + + try { + foo(); + } catch () { + } + void foo() { bar(); } + class foo + { + }; + if (foo()) { + } else { + } + enum X : int { A, B }; + + * ``BS_Stroustrup`` (in configuration: ``Stroustrup``) + Like ``Attach``, but break before function definitions, ``catch``, and + ``else``. + + .. code-block:: c++ + + try { + foo(); + } catch () { + } + void foo() { bar(); } + class foo + { + }; + if (foo()) { + } else { + } + enum X : int + { + A, + B + }; + + * ``BS_Allman`` (in configuration: ``Allman``) + Always break before braces. + + .. code-block:: c++ + + try { + foo(); + } + catch () { + } + void foo() { bar(); } + class foo { + }; + if (foo()) { + } + else { + } + enum X : int { A, B }; + + * ``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++ + + try + { + foo(); + } + catch () + { + } + void foo() { bar(); } + class foo + { + }; + if (foo()) + { + } + else + { + } + enum X : int + { + A, + B + }; + + * ``BS_WebKit`` (in configuration: ``WebKit``) + Like ``Attach``, but break before functions. + + .. code-block:: c++ + + try { + foo(); + } catch () { + } + void foo() { bar(); } + class foo { + }; + if (foo()) { + } else { + } + enum X : int { A, B }; + + * ``BS_Custom`` (in configuration: ``Custom``) + Configure each individual brace in `BraceWrapping`. + + + +**BreakBeforeInheritanceComma** (``bool``) + If ``true``, in the class inheritance expression clang-format will + break before ``:`` and ``,`` if there is multiple inheritance. + + .. code-block:: c++ + + true: false: + class MyClass vs. class MyClass : public X, public Y { + : public X }; + , public Y { + }; + +**BreakBeforeTernaryOperators** (``bool``) + If ``true``, ternary operators will be placed after line breaks. + + .. code-block:: c++ + + true: + veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription + ? firstValue + : SecondValueVeryVeryVeryVeryLong; + + true: + veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ? + firstValue : + SecondValueVeryVeryVeryVeryLong; + +**BreakConstructorInitializersBeforeComma** (``bool``) + Always break constructor initializers before commas and align + the commas with the colon. + + .. code-block:: c++ + + true: false: + SomeClass::Constructor() vs. SomeClass::Constructor() : a(a), + : a(a) b(b), + , b(b) c(c) {} + , c(c) {} + +**BreakStringLiterals** (``bool``) + Allow breaking string literals when formatting. + +**ColumnLimit** (``unsigned``) + 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** (``std::string``) + 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 // FOOBAR pragma: keep + +**ConstructorInitializerAllOnOneLineOrOnePerLine** (``bool``) + If the constructor initializers don't fit on a line, put each + initializer on its own line. + + .. code-block:: c++ + + true: + SomeClass::Constructor() + : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa) { + return 0; + } + + false: + SomeClass::Constructor() + : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), + aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa) { + return 0; + } + +**ConstructorInitializerIndentWidth** (``unsigned``) + The number of characters to use for indentation of constructor + initializer lists. + +**ContinuationIndentWidth** (``unsigned``) + Indent width for line continuations. + +**Cpp11BracedListStyle** (``bool``) + 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. + +**DerivePointerAlignment** (``bool``) + If ``true``, analyze the formatted file for the most common + alignment of ``&`` and ``*``. ``PointerAlignment`` is then used only as + fallback. + +**DisableFormat** (``bool``) + Disables formatting completely. + +**ExperimentalAutoDetectBinPacking** (``bool``) + 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** (``bool``) + If ``true``, clang-format adds missing namespace end comments and + fixes invalid existing ones. + + .. code-block:: c++ + + true: false: + namespace a { vs. namespace a { + foo(); foo(); + } // namespace a; } + +**ForEachMacros** (``std::vector``) + 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(, ...) + + + In the .clang-format configuration file, this can be configured like: + + .. code-block:: yaml + + ForEachMacros: ['RANGES_FOR', 'FOREACH'] + + For example: BOOST_FOREACH. + +**IncludeCategories** (``std::vector``) + Regular expressions denoting the different ``#include`` categories + used for ordering ``#includes``. + + 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`` + (http://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. + + To configure this in the .clang-format file, use: + + .. code-block:: yaml + + IncludeCategories: + - Regex: '^"(llvm|llvm-c|clang|clang-c)/' + Priority: 2 + - Regex: '^(<|"(gtest|isl|json)/)' + Priority: 3 + - Regex: '.*' + Priority: 1 + +**IncludeIsMainRegex** (``std::string``) + 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. + +**IndentCaseLabels** (``bool``) + 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. + +**IndentWidth** (``unsigned``) + The number of columns to use for indentation. + + .. code-block:: c++ + + IndentWidth: 3 + void f() { + someFunction(); + if (true, false) { + f(); + } + } + +**IndentWrappedFunctionNames** (``bool``) + Indent if a function definition or declaration is wrapped after the + type. + +**JavaScriptQuotes** (``JavaScriptQuoteStyle``) + 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** (``bool``) + 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" + +**KeepEmptyLinesAtTheStartOfBlocks** (``bool``) + If true, empty lines at the start of blocks are kept. + +**Language** (``LanguageKind``) + 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_Java`` (in configuration: ``Java``) + Should be used for Java. + + * ``LK_JavaScript`` (in configuration: ``JavaScript``) + Should be used for JavaScript. + + * ``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. + + + +**MacroBlockBegin** (``std::string``) + 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** (``std::string``) + A regular expression matching macros that end a block. + +**MaxEmptyLinesToKeep** (``unsigned``) + 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** (``NamespaceIndentationKind``) + 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; + } + } + + + +**ObjCBlockIndentWidth** (``unsigned``) + The number of characters to use for indentation of ObjC blocks. + +**ObjCSpaceAfterProperty** (``bool``) + Add a space after ``@property`` in Objective-C, i.e. use + ``@property (readonly)`` instead of ``@property(readonly)``. + +**ObjCSpaceBeforeProtocolList** (``bool``) + Add a space in front of an Objective-C protocol list, i.e. use + ``Foo `` instead of ``Foo``. + +**PenaltyBreakBeforeFirstCallParameter** (``unsigned``) + The penalty for breaking a function call after ``call(``. + +**PenaltyBreakComment** (``unsigned``) + The penalty for each line break introduced inside a comment. + +**PenaltyBreakFirstLessLess** (``unsigned``) + The penalty for breaking before the first ``<<``. + +**PenaltyBreakString** (``unsigned``) + The penalty for each line break introduced inside a string literal. + +**PenaltyExcessCharacter** (``unsigned``) + The penalty for each character outside of the column limit. + +**PenaltyReturnTypeOnItsOwnLine** (``unsigned``) + Penalty for putting the return type of a function onto its own + line. + +**PointerAlignment** (``PointerAlignmentStyle``) + 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; + + + +**PPDirectiveIndentation ** (``PPDirectiveIndentation Kind``) + The indentation used for preprocessor directives. + + Possible values: + + * ``PPDI_None`` (in configuration: ``None``) + Don't indent preprocessor directives. + + * ``PPDI_All`` (in configuration: ``All``) + Indent all preprocessor directives. + + + +**ReflowComments** (``bool``) + If ``true``, clang-format will attempt to re-flow comments. + + .. 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 */ + +**SortIncludes** (``bool``) + If ``true``, clang-format will sort ``#includes``. + + .. code-block:: c++ + + false: true: + #include "b.h" vs. #include "a.h" + #include "a.h" #include "b.h" + +**SpaceAfterCStyleCast** (``bool``) + If ``true``, a space is inserted after C style casts. + + .. code-block:: c++ + + true: false: + (int)i; vs. (int) i; + +**SpaceAfterTemplateKeyword** (``bool``) + If ``true``, a space will be inserted after the 'template' keyword. + + .. code-block:: c++ + + true: false: + template void foo(); vs. template void foo(); + +**SpaceBeforeAssignmentOperators** (``bool``) + 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; + +**SpaceBeforeParens** (``SpaceBeforeParensOptions``) + Defines in which cases to put a space before opening parentheses. + + Possible values: + + * ``SBPO_Never`` (in configuration: ``Never``) + Never put a space before opening parentheses. + + .. code-block:: c++ + + void f() { + if(true) { + f(); + } + } + + * ``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_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 (); + } + } + + + +**SpaceInEmptyParentheses** (``bool``) + If ``true``, spaces may be inserted into ``()``. + + .. code-block:: c++ + + true: false: + void f( ) { vs. void f() { + int x[] = {foo( ), bar( )}; int x[] = {foo(), bar()}; + if (true) { if (true) { + f( ); f(); + } } + } } + +**SpacesBeforeTrailingComments** (``unsigned``) + 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. + + .. code-block:: c++ + + SpacesBeforeTrailingComments: 3 + void f() { + if (true) { // foo1 + f(); // bar + } // foo + } + +**SpacesInAngles** (``bool``) + If ``true``, spaces will be inserted after ``<`` and before ``>`` + in template argument lists. + + .. code-block:: c++ + + true: false: + static_cast< int >(arg); vs. static_cast(arg); + std::function< void(int) > fct; std::function fct; + +**SpacesInCStyleCastParentheses** (``bool``) + If ``true``, spaces may be inserted into C style casts. + + .. code-block:: c++ + + true: false: + x = ( int32 )y vs. x = (int32)y + +**SpacesInContainerLiterals** (``bool``) + If ``true``, spaces are inserted inside container literals (e.g. + ObjC and Javascript array and dict literals). + + .. 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}); + +**SpacesInParentheses** (``bool``) + If ``true``, spaces will be inserted after ``(`` and before ``)``. + + .. code-block:: c++ + + true: false: + t f( Deleted & ) & = delete; vs. t f(Deleted &) & = delete; + +**SpacesInSquareBrackets** (``bool``) + If ``true``, spaces will be inserted after ``[`` and before ``]``. + Lambdas or unspecified size array declarations will not be affected. + + .. code-block:: c++ + + true: false: + int a[ 5 ]; vs. int a[5]; + std::unique_ptr foo() {} // Won't be affected + +**Standard** (``LanguageStandard``) + Format compatible with this standard, e.g. use ``A >`` + instead of ``A>`` for ``LS_Cpp03``. + + Possible values: + + * ``LS_Cpp03`` (in configuration: ``Cpp03``) + Use C++03-compatible syntax. + + * ``LS_Cpp11`` (in configuration: ``Cpp11``) + Use features of C++11 (e.g. ``A>`` instead of ``A >``). + + * ``LS_Auto`` (in configuration: ``Auto``) + Automatic detection based on the input. + + + +**TabWidth** (``unsigned``) + The number of columns used for tab stops. + +**UseTab** (``UseTabStyle``) + 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``) + Use tabs only for line continuation and indentation. + + * ``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. + + + +.. 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 +`_: + +.. 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_somthing_completely_different(); + + if (x == y) + { + q(); + } + else if (x > y) + { + w(); + } + else + { + r(); + } + } Index: include/clang/Format/Format.h =================================================================== --- include/clang/Format/Format.h +++ include/clang/Format/Format.h @@ -1,1557 +1,1593 @@ -//===--- Format.h - Format C++ code -----------------------------*- C++ -*-===// -// -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. -// -//===----------------------------------------------------------------------===// -/// -/// \file -/// Various functions to configurably format source code. -/// -//===----------------------------------------------------------------------===// - -#ifndef LLVM_CLANG_FORMAT_FORMAT_H -#define LLVM_CLANG_FORMAT_FORMAT_H - -#include "clang/Basic/LangOptions.h" -#include "clang/Tooling/Core/Replacement.h" -#include "llvm/ADT/ArrayRef.h" -#include - -namespace clang { - -class Lexer; -class SourceManager; -class DiagnosticConsumer; - -namespace vfs { -class FileSystem; -} - -namespace format { - -enum class ParseError { Success = 0, Error, Unsuitable }; -class ParseErrorCategory final : public std::error_category { -public: - const char *name() const noexcept override; - std::string message(int EV) const override; -}; -const std::error_category &getParseCategory(); -std::error_code make_error_code(ParseError e); - -/// \brief The ``FormatStyle`` is used to configure the formatting to follow -/// specific guidelines. -struct FormatStyle { - /// \brief The extra indent or outdent of access modifiers, e.g. ``public:``. - int AccessModifierOffset; - - /// \brief Different styles for aligning after open brackets. - enum BracketAlignmentStyle { - /// \brief Align parameters on the open bracket, e.g.: - /// \code - /// someLongFunction(argument1, - /// argument2); - /// \endcode - BAS_Align, - /// \brief Don't align, instead use ``ContinuationIndentWidth``, e.g.: - /// \code - /// someLongFunction(argument1, - /// argument2); - /// \endcode - BAS_DontAlign, - /// \brief Always break after an open bracket, if the parameters don't fit - /// on a single line, e.g.: - /// \code - /// someLongFunction( - /// argument1, argument2); - /// \endcode - BAS_AlwaysBreak, - }; - - /// \brief If ``true``, horizontally aligns arguments after an open bracket. - /// - /// This applies to round brackets (parentheses), angle brackets and square - /// brackets. - BracketAlignmentStyle AlignAfterOpenBracket; - - /// \brief If ``true``, aligns consecutive assignments. - /// - /// This will align the assignment operators of consecutive lines. This - /// will result in formattings like - /// \code - /// int aaaa = 12; - /// int b = 23; - /// int ccc = 23; - /// \endcode - bool AlignConsecutiveAssignments; - - /// \brief If ``true``, aligns consecutive declarations. - /// - /// This will align the declaration names of consecutive lines. This - /// will result in formattings like - /// \code - /// int aaaa = 12; - /// float b = 23; - /// std::string ccc = 23; - /// \endcode - bool AlignConsecutiveDeclarations; - - /// \brief If ``true``, aligns escaped newlines as far left as possible. - /// Otherwise puts them into the right-most column. - /// \code - /// true: - /// #define A \ - /// int aaaa; \ - /// int b; \ - /// int dddddddddd; - /// - /// false: - /// #define A \ - /// int aaaa; \ - /// int b; \ - /// int dddddddddd; - /// \endcode - bool AlignEscapedNewlinesLeft; - - /// \brief If ``true``, 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 - /// int aaa = bbbbbbbbbbbbbbb + - /// ccccccccccccccc; - /// \endcode - bool AlignOperands; - - /// \brief If ``true``, aligns trailing comments. - /// \code - /// true: false: - /// int a; // My comment a vs. int a; // My comment a - /// int b = 2; // comment b int b = 2; // comment about b - /// \endcode - bool AlignTrailingComments; - - /// \brief Allow putting all parameters of a function declaration onto - /// the next line even if ``BinPackParameters`` is ``false``. - /// \code - /// true: false: - /// myFunction(foo, vs. myFunction(foo, bar, plop); - /// bar, - /// plop); - /// \endcode - bool AllowAllParametersOfDeclarationOnNextLine; - - /// \brief Allows contracting simple braced statements to a single line. - /// - /// E.g., this allows ``if (a) { return; }`` to be put on a single line. - bool AllowShortBlocksOnASingleLine; - - /// \brief If ``true``, short case labels will be contracted to a single line. - /// \code - /// true: false: - /// switch (a) { vs. switch (a) { - /// case 1: x = 1; break; case 1: - /// case 2: return; x = 1; - /// } break; - /// case 2: - /// return; - /// } - /// \endcode - bool AllowShortCaseLabelsOnASingleLine; - - /// \brief Different styles for merging short functions containing at most one - /// statement. - enum ShortFunctionStyle { - /// \brief Never merge functions into a single line. - SFS_None, - /// \brief Only merge empty functions. - /// \code - /// void f() { bar(); } - /// void f2() { - /// bar2(); - /// } - /// \endcode - SFS_Empty, - /// \brief Only merge functions defined inside a class. Implies "empty". - /// \code - /// class { - /// void f() { foo(); } - /// }; - /// \endcode - SFS_Inline, - /// \brief Merge all functions fitting on a single line. - /// \code - /// class { - /// void f() { foo(); } - /// }; - /// void f() { bar(); } - /// \endcode - SFS_All, - }; - - /// \brief Dependent on the value, ``int f() { return 0; }`` can be put on a - /// single line. - ShortFunctionStyle AllowShortFunctionsOnASingleLine; - - /// \brief If ``true``, ``if (a) return;`` can be put on a single line. - bool AllowShortIfStatementsOnASingleLine; - - /// \brief If ``true``, ``while (true) continue;`` can be put on a single - /// line. - bool AllowShortLoopsOnASingleLine; - - /// \brief Different ways to break after the function definition return type. - /// This option is **deprecated** and is retained for backwards compatibility. - enum DefinitionReturnTypeBreakingStyle { - /// Break after return type automatically. - /// ``PenaltyReturnTypeOnItsOwnLine`` is taken into account. - DRTBS_None, - /// Always break after the return type. - DRTBS_All, - /// Always break after the return types of top-level functions. - DRTBS_TopLevel, - }; - - /// \brief Different ways to break after the function definition or - /// declaration return type. - enum ReturnTypeBreakingStyle { - /// Break after return type automatically. - /// ``PenaltyReturnTypeOnItsOwnLine`` is taken into account. - /// \code - /// class A { - /// int f() { return 0; }; - /// }; - /// int f(); - /// int f() { return 1; } - /// \endcode - RTBS_None, - /// Always break after the return type. - /// \code - /// class A { - /// int - /// f() { - /// return 0; - /// }; - /// }; - /// int - /// f(); - /// int - /// f() { - /// return 1; - /// } - /// \endcode - RTBS_All, - /// Always break after the return types of top-level functions. - /// \code - /// class A { - /// int f() { return 0; }; - /// }; - /// int - /// f(); - /// int - /// f() { - /// return 1; - /// } - /// \endcode - RTBS_TopLevel, - /// Always break after the return type of function definitions. - /// \code - /// class A { - /// int - /// f() { - /// return 0; - /// }; - /// }; - /// int f(); - /// int - /// f() { - /// return 1; - /// } - /// \endcode - RTBS_AllDefinitions, - /// Always break after the return type of top-level definitions. - /// \code - /// class A { - /// int f() { return 0; }; - /// }; - /// int f(); - /// int - /// f() { - /// return 1; - /// } - /// \endcode - RTBS_TopLevelDefinitions, - }; - - /// \brief The function definition return type breaking style to use. This - /// option is **deprecated** and is retained for backwards compatibility. - DefinitionReturnTypeBreakingStyle AlwaysBreakAfterDefinitionReturnType; - - /// \brief The function declaration return type breaking style to use. - ReturnTypeBreakingStyle AlwaysBreakAfterReturnType; - - /// \brief 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 - /// true: false: - /// aaaa = vs. aaaa = "bbbb" - /// "bbbb" "cccc"; - /// "cccc"; - /// \endcode - bool AlwaysBreakBeforeMultilineStrings; - - /// \brief If ``true``, always break after the ``template<...>`` of a template - /// declaration. - /// \code - /// true: false: - /// template vs. template class C {}; - /// class C {}; - /// \endcode - bool AlwaysBreakTemplateDeclarations; - - /// \brief If ``false``, a function call's arguments will either be all on the - /// same line or will have one line each. - /// \code - /// true: - /// void f() { - /// f(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaa, - /// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa); - /// } - /// - /// false: - /// void f() { - /// f(aaaaaaaaaaaaaaaaaaaa, - /// aaaaaaaaaaaaaaaaaaaa, - /// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa); - /// } - /// \endcode - bool BinPackArguments; - - /// \brief If ``false``, a function declaration's or function definition's - /// parameters will either all be on the same line or will have one line each. - /// \code - /// true: - /// void f(int aaaaaaaaaaaaaaaaaaaa, int aaaaaaaaaaaaaaaaaaaa, - /// int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {} - /// - /// false: - /// void f(int aaaaaaaaaaaaaaaaaaaa, - /// int aaaaaaaaaaaaaaaaaaaa, - /// int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {} - /// \endcode - bool BinPackParameters; - - /// \brief The style of breaking before or after binary operators. - enum BinaryOperatorStyle { - /// Break after operators. - /// \code - /// LooooooooooongType loooooooooooooooooooooongVariable = - /// someLooooooooooooooooongFunction(); - /// - /// bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - /// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == - /// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa && - /// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa > - /// ccccccccccccccccccccccccccccccccccccccccc; - /// \endcode - BOS_None, - /// Break before operators that aren't assignments. - /// \code - /// LooooooooooongType loooooooooooooooooooooongVariable = - /// someLooooooooooooooooongFunction(); - /// - /// bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// && aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// > ccccccccccccccccccccccccccccccccccccccccc; - /// \endcode - BOS_NonAssignment, - /// Break before operators. - /// \code - /// LooooooooooongType loooooooooooooooooooooongVariable - /// = someLooooooooooooooooongFunction(); - /// - /// bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// && aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /// > ccccccccccccccccccccccccccccccccccccccccc; - /// \endcode - BOS_All, - }; - - /// \brief The way to wrap binary operators. - BinaryOperatorStyle BreakBeforeBinaryOperators; - - /// \brief Different ways to attach braces to their surrounding context. - enum BraceBreakingStyle { - /// Always attach braces to surrounding context. - /// \code - /// try { - /// foo(); - /// } catch () { - /// } - /// void foo() { bar(); } - /// class foo {}; - /// if (foo()) { - /// } else { - /// } - /// enum X : int { A, B }; - /// \endcode - BS_Attach, - /// Like ``Attach``, but break before braces on function, namespace and - /// class definitions. - /// \code - /// try { - /// foo(); - /// } catch () { - /// } - /// void foo() { bar(); } - /// class foo - /// { - /// }; - /// if (foo()) { - /// } else { - /// } - /// enum X : int { A, B }; - /// \endcode - BS_Linux, - /// Like ``Attach``, but break before braces on enum, function, and record - /// definitions. - /// \code - /// try { - /// foo(); - /// } catch () { - /// } - /// void foo() { bar(); } - /// class foo - /// { - /// }; - /// if (foo()) { - /// } else { - /// } - /// enum X : int { A, B }; - /// \endcode - BS_Mozilla, - /// Like ``Attach``, but break before function definitions, ``catch``, and - /// ``else``. - /// \code - /// try { - /// foo(); - /// } catch () { - /// } - /// void foo() { bar(); } - /// class foo - /// { - /// }; - /// if (foo()) { - /// } else { - /// } - /// enum X : int - /// { - /// A, - /// B - /// }; - /// \endcode - BS_Stroustrup, - /// Always break before braces. - /// \code - /// try { - /// foo(); - /// } - /// catch () { - /// } - /// void foo() { bar(); } - /// class foo { - /// }; - /// if (foo()) { - /// } - /// else { - /// } - /// enum X : int { A, B }; - /// \endcode - BS_Allman, - /// 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 - /// try - /// { - /// foo(); - /// } - /// catch () - /// { - /// } - /// void foo() { bar(); } - /// class foo - /// { - /// }; - /// if (foo()) - /// { - /// } - /// else - /// { - /// } - /// enum X : int - /// { - /// A, - /// B - /// }; - /// \endcode - BS_GNU, - /// Like ``Attach``, but break before functions. - /// \code - /// try { - /// foo(); - /// } catch () { - /// } - /// void foo() { bar(); } - /// class foo { - /// }; - /// if (foo()) { - /// } else { - /// } - /// enum X : int { A, B }; - /// \endcode - BS_WebKit, - /// Configure each individual brace in `BraceWrapping`. - BS_Custom - }; - - /// \brief The brace breaking style to use. - BraceBreakingStyle BreakBeforeBraces; - - /// \brief Precise control over the wrapping of braces. - /// \code - /// # Should be declared this way: - /// BreakBeforeBraces: Custom - /// BraceWrapping: - /// AfterClass: true - /// \endcode - struct BraceWrappingFlags { - /// \brief Wrap class definitions. - /// \code - /// true: - /// class foo {}; - /// - /// false: - /// class foo - /// {}; - /// \endcode - bool AfterClass; - /// \brief Wrap control statements (``if``/``for``/``while``/``switch``/..). - /// \code - /// true: - /// if (foo()) - /// { - /// } else - /// {} - /// for (int i = 0; i < 10; ++i) - /// {} - /// - /// false: - /// if (foo()) { - /// } else { - /// } - /// for (int i = 0; i < 10; ++i) { - /// } - /// \endcode - bool AfterControlStatement; - /// \brief Wrap enum definitions. - /// \code - /// true: - /// enum X : int - /// { - /// B - /// }; - /// - /// false: - /// enum X : int { B }; - /// \endcode - bool AfterEnum; - /// \brief Wrap function definitions. - /// \code - /// true: - /// void foo() - /// { - /// bar(); - /// bar2(); - /// } - /// - /// false: - /// void foo() { - /// bar(); - /// bar2(); - /// } - /// \endcode - bool AfterFunction; - /// \brief Wrap namespace definitions. - /// \code - /// true: - /// namespace - /// { - /// int foo(); - /// int bar(); - /// } - /// - /// false: - /// namespace { - /// int foo(); - /// int bar(); - /// } - /// \endcode - bool AfterNamespace; - /// \brief Wrap ObjC definitions (``@autoreleasepool``, interfaces, ..). - bool AfterObjCDeclaration; - /// \brief Wrap struct definitions. - /// \code - /// true: - /// struct foo - /// { - /// int x; - /// } - /// - /// false: - /// struct foo { - /// int x; - /// } - /// \endcode - bool AfterStruct; - /// \brief Wrap union definitions. - /// \code - /// true: - /// union foo - /// { - /// int x; - /// } - /// - /// false: - /// union foo { - /// int x; - /// } - /// \endcode - bool AfterUnion; - /// \brief Wrap before ``catch``. - /// \code - /// true: - /// try { - /// foo(); - /// } - /// catch () { - /// } - /// - /// false: - /// try { - /// foo(); - /// } catch () { - /// } - /// \endcode - bool BeforeCatch; - /// \brief Wrap before ``else``. - /// \code - /// true: - /// if (foo()) { - /// } - /// else { - /// } - /// - /// false: - /// if (foo()) { - /// } else { - /// } - /// \endcode - bool BeforeElse; - /// \brief Indent the wrapped braces themselves. - bool IndentBraces; - }; - - /// \brief 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. - BraceWrappingFlags BraceWrapping; - - /// \brief If ``true``, ternary operators will be placed after line breaks. - /// \code - /// true: - /// veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription - /// ? firstValue - /// : SecondValueVeryVeryVeryVeryLong; - /// - /// true: - /// veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ? - /// firstValue : - /// SecondValueVeryVeryVeryVeryLong; - /// \endcode - bool BreakBeforeTernaryOperators; - - /// \brief Always break constructor initializers before commas and align - /// the commas with the colon. - /// \code - /// true: false: - /// SomeClass::Constructor() vs. SomeClass::Constructor() : a(a), - /// : a(a) b(b), - /// , b(b) c(c) {} - /// , c(c) {} - /// \endcode - bool BreakConstructorInitializersBeforeComma; - - /// \brief Break after each annotation on a field in Java files. - bool BreakAfterJavaFieldAnnotations; - - /// \brief Allow breaking string literals when formatting. - bool BreakStringLiterals; - - /// \brief 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. - unsigned ColumnLimit; - - /// \brief A regular expression that describes comments with special meaning, - /// which should not be split into lines or otherwise changed. - /// \code - /// CommentPragmas: '^ FOOBAR pragma:' - /// // Will leave the following line unaffected - /// #include // FOOBAR pragma: keep - /// \endcode - std::string CommentPragmas; - - /// \brief If ``true``, in the class inheritance expression clang-format will - /// break before ``:`` and ``,`` if there is multiple inheritance. - /// \code - /// true: false: - /// class MyClass vs. class MyClass : public X, public Y { - /// : public X }; - /// , public Y { - /// }; - /// \endcode - bool BreakBeforeInheritanceComma; - - /// \brief If the constructor initializers don't fit on a line, put each - /// initializer on its own line. - /// \code - /// true: - /// SomeClass::Constructor() - /// : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa) { - /// return 0; - /// } - /// - /// false: - /// SomeClass::Constructor() - /// : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), - /// aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa) { - /// return 0; - /// } - /// \endcode - bool ConstructorInitializerAllOnOneLineOrOnePerLine; - - /// \brief The number of characters to use for indentation of constructor - /// initializer lists. - unsigned ConstructorInitializerIndentWidth; - - /// \brief Indent width for line continuations. - unsigned ContinuationIndentWidth; - - /// \brief 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. - bool Cpp11BracedListStyle; - - /// \brief If ``true``, analyze the formatted file for the most common - /// alignment of ``&`` and ``*``. ``PointerAlignment`` is then used only as - /// fallback. - bool DerivePointerAlignment; - - /// \brief Disables formatting completely. - bool DisableFormat; - - /// \brief 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. - bool ExperimentalAutoDetectBinPacking; - - /// \brief If ``true``, clang-format adds missing namespace end comments and - /// fixes invalid existing ones. - /// \code - /// true: false: - /// namespace a { vs. namespace a { - /// foo(); foo(); - /// } // namespace a; } - /// \endcode - bool FixNamespaceComments; - - /// \brief 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 - /// FOREACH(, ...) - /// - /// \endcode - /// - /// In the .clang-format configuration file, this can be configured like: - /// \code{.yaml} - /// ForEachMacros: ['RANGES_FOR', 'FOREACH'] - /// \endcode - /// - /// For example: BOOST_FOREACH. - std::vector ForEachMacros; - - /// \brief See documentation of ``IncludeCategories``. - struct IncludeCategory { - /// \brief The regular expression that this category matches. - std::string Regex; - /// \brief The priority to assign to this category. - int Priority; - bool operator==(const IncludeCategory &Other) const { - return Regex == Other.Regex && Priority == Other.Priority; - } - }; - - /// \brief Regular expressions denoting the different ``#include`` categories - /// used for ordering ``#includes``. - /// - /// 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`` - /// (http://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. - /// - /// To configure this in the .clang-format file, use: - /// \code{.yaml} - /// IncludeCategories: - /// - Regex: '^"(llvm|llvm-c|clang|clang-c)/' - /// Priority: 2 - /// - Regex: '^(<|"(gtest|isl|json)/)' - /// Priority: 3 - /// - Regex: '.*' - /// Priority: 1 - /// \endcode - std::vector IncludeCategories; - - /// \brief 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. - std::string IncludeIsMainRegex; - - /// \brief 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. - bool IndentCaseLabels; - - /// \brief The number of columns to use for indentation. - /// \code - /// IndentWidth: 3 - /// void f() { - /// someFunction(); - /// if (true, false) { - /// f(); - /// } - /// } - /// \endcode - unsigned IndentWidth; - - /// \brief Indent if a function definition or declaration is wrapped after the - /// type. - bool IndentWrappedFunctionNames; - - /// \brief Quotation styles for JavaScript strings. Does not affect template - /// strings. - enum JavaScriptQuoteStyle { - /// Leave string quotes as they are. - /// \code{.js} - /// string1 = "foo"; - /// string2 = 'bar'; - /// \endcode - JSQS_Leave, - /// Always use single quotes. - /// \code{.js} - /// string1 = 'foo'; - /// string2 = 'bar'; - /// \endcode - JSQS_Single, - /// Always use double quotes. - /// \code{.js} - /// string1 = "foo"; - /// string2 = "bar"; - /// \endcode - JSQS_Double - }; - - /// \brief The JavaScriptQuoteStyle to use for JavaScript strings. - JavaScriptQuoteStyle JavaScriptQuotes; - - /// \brief Whether to wrap JavaScript import/export statements. - /// \code{.js} - /// true: - /// import { - /// VeryLongImportsAreAnnoying, - /// VeryLongImportsAreAnnoying, - /// VeryLongImportsAreAnnoying, - /// } from 'some/module.js' - /// - /// false: - /// import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,} from "some/module.js" - /// \endcode - bool JavaScriptWrapImports; - - /// \brief If true, empty lines at the start of blocks are kept. - bool KeepEmptyLinesAtTheStartOfBlocks; - - /// \brief Supported languages. - /// - /// When stored in a configuration file, specifies the language, that the - /// configuration targets. When passed to the ``reformat()`` function, enables - /// syntax features specific to the language. - enum LanguageKind { - /// Do not use. - LK_None, - /// Should be used for C, C++. - LK_Cpp, - /// Should be used for Java. - LK_Java, - /// Should be used for JavaScript. - LK_JavaScript, - /// Should be used for Objective-C, Objective-C++. - LK_ObjC, - /// Should be used for Protocol Buffers - /// (https://developers.google.com/protocol-buffers/). - LK_Proto, - /// Should be used for TableGen code. - LK_TableGen - }; - bool IsCpp() const { return Language == LK_Cpp || Language == LK_ObjC; } - - /// \brief Language, this format style is targeted at. - LanguageKind Language; - - /// \brief A regular expression matching macros that start a block. - /// \code - /// # 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 - /// \endcode - std::string MacroBlockBegin; - - /// \brief A regular expression matching macros that end a block. - std::string MacroBlockEnd; - - /// \brief The maximum number of consecutive empty lines to keep. - /// \code - /// MaxEmptyLinesToKeep: 1 vs. MaxEmptyLinesToKeep: 0 - /// int f() { int f() { - /// int = 1; int i = 1; - /// i = foo(); - /// i = foo(); return i; - /// } - /// return i; - /// } - /// \endcode - unsigned MaxEmptyLinesToKeep; - - /// \brief Different ways to indent namespace contents. - enum NamespaceIndentationKind { - /// Don't indent in namespaces. - /// \code - /// namespace out { - /// int i; - /// namespace in { - /// int i; - /// } - /// } - /// \endcode - NI_None, - /// Indent only in inner namespaces (nested in other namespaces). - /// \code - /// namespace out { - /// int i; - /// namespace in { - /// int i; - /// } - /// } - /// \endcode - NI_Inner, - /// Indent in all namespaces. - /// \code - /// namespace out { - /// int i; - /// namespace in { - /// int i; - /// } - /// } - /// \endcode - NI_All - }; - - /// \brief The indentation used for namespaces. - NamespaceIndentationKind NamespaceIndentation; - - /// \brief The number of characters to use for indentation of ObjC blocks. - unsigned ObjCBlockIndentWidth; - - /// \brief Add a space after ``@property`` in Objective-C, i.e. use - /// ``@property (readonly)`` instead of ``@property(readonly)``. - bool ObjCSpaceAfterProperty; - - /// \brief Add a space in front of an Objective-C protocol list, i.e. use - /// ``Foo `` instead of ``Foo``. - bool ObjCSpaceBeforeProtocolList; - - /// \brief The penalty for breaking a function call after ``call(``. - unsigned PenaltyBreakBeforeFirstCallParameter; - - /// \brief The penalty for each line break introduced inside a comment. - unsigned PenaltyBreakComment; - - /// \brief The penalty for breaking before the first ``<<``. - unsigned PenaltyBreakFirstLessLess; - - /// \brief The penalty for each line break introduced inside a string literal. - unsigned PenaltyBreakString; - - /// \brief The penalty for each character outside of the column limit. - unsigned PenaltyExcessCharacter; - - /// \brief Penalty for putting the return type of a function onto its own - /// line. - unsigned PenaltyReturnTypeOnItsOwnLine; - - /// \brief The ``&`` and ``*`` alignment style. - enum PointerAlignmentStyle { - /// Align pointer to the left. - /// \code - /// int* a; - /// \endcode - PAS_Left, - /// Align pointer to the right. - /// \code - /// int *a; - /// \endcode - PAS_Right, - /// Align pointer in the middle. - /// \code - /// int * a; - /// \endcode - PAS_Middle - }; - - /// \brief Pointer and reference alignment style. - PointerAlignmentStyle PointerAlignment; - - /// \brief If ``true``, clang-format will attempt to re-flow comments. - /// \code - /// false: - /// // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information - /// /* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information */ - /// - /// true: - /// // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of - /// // information - /// /* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of - /// * information */ - /// \endcode - bool ReflowComments; - - /// \brief If ``true``, clang-format will sort ``#includes``. - /// \code - /// false: true: - /// #include "b.h" vs. #include "a.h" - /// #include "a.h" #include "b.h" - /// \endcode - bool SortIncludes; - - /// \brief If ``true``, a space is inserted after C style casts. - /// \code - /// true: false: - /// (int)i; vs. (int) i; - /// \endcode - bool SpaceAfterCStyleCast; - - /// \brief If \c true, a space will be inserted after the 'template' keyword. - /// \code - /// true: false: - /// template void foo(); vs. template void foo(); - /// \endcode - bool SpaceAfterTemplateKeyword; - - /// \brief If ``false``, spaces will be removed before assignment operators. - /// \code - /// true: false: - /// int a = 5; vs. int a=5; - /// a += 42 a+=42; - /// \endcode - bool SpaceBeforeAssignmentOperators; - - /// \brief Different ways to put a space before opening parentheses. - enum SpaceBeforeParensOptions { - /// Never put a space before opening parentheses. - /// \code - /// void f() { - /// if(true) { - /// f(); - /// } - /// } - /// \endcode - SBPO_Never, - /// Put a space before opening parentheses only after control statement - /// keywords (``for/if/while...``). - /// \code - /// void f() { - /// if (true) { - /// f(); - /// } - /// } - /// \endcode - SBPO_ControlStatements, - /// 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 - /// void f () { - /// if (true) { - /// f (); - /// } - /// } - /// \endcode - SBPO_Always - }; - - /// \brief Defines in which cases to put a space before opening parentheses. - SpaceBeforeParensOptions SpaceBeforeParens; - - /// \brief If ``true``, spaces may be inserted into ``()``. - /// \code - /// true: false: - /// void f( ) { vs. void f() { - /// int x[] = {foo( ), bar( )}; int x[] = {foo(), bar()}; - /// if (true) { if (true) { - /// f( ); f(); - /// } } - /// } } - /// \endcode - bool SpaceInEmptyParentheses; - - /// \brief 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. - /// \code - /// SpacesBeforeTrailingComments: 3 - /// void f() { - /// if (true) { // foo1 - /// f(); // bar - /// } // foo - /// } - /// \endcode - unsigned SpacesBeforeTrailingComments; - - /// \brief If ``true``, spaces will be inserted after ``<`` and before ``>`` - /// in template argument lists. - /// \code - /// true: false: - /// static_cast< int >(arg); vs. static_cast(arg); - /// std::function< void(int) > fct; std::function fct; - /// \endcode - bool SpacesInAngles; - - /// \brief If ``true``, spaces are inserted inside container literals (e.g. - /// ObjC and Javascript array and dict literals). - /// \code{.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}); - /// \endcode - bool SpacesInContainerLiterals; - - /// \brief If ``true``, spaces may be inserted into C style casts. - /// \code - /// true: false: - /// x = ( int32 )y vs. x = (int32)y - /// \endcode - bool SpacesInCStyleCastParentheses; - - /// \brief If ``true``, spaces will be inserted after ``(`` and before ``)``. - /// \code - /// true: false: - /// t f( Deleted & ) & = delete; vs. t f(Deleted &) & = delete; - /// \endcode - bool SpacesInParentheses; - - /// \brief If ``true``, spaces will be inserted after ``[`` and before ``]``. - /// Lambdas or unspecified size array declarations will not be affected. - /// \code - /// true: false: - /// int a[ 5 ]; vs. int a[5]; - /// std::unique_ptr foo() {} // Won't be affected - /// \endcode - bool SpacesInSquareBrackets; - - /// \brief Supported language standards. - enum LanguageStandard { - /// Use C++03-compatible syntax. - LS_Cpp03, - /// Use features of C++11 (e.g. ``A>`` instead of ``A >``). - LS_Cpp11, - /// Automatic detection based on the input. - LS_Auto - }; - - /// \brief Format compatible with this standard, e.g. use ``A >`` - /// instead of ``A>`` for ``LS_Cpp03``. - LanguageStandard Standard; - - /// \brief The number of columns used for tab stops. - unsigned TabWidth; - - /// \brief Different ways to use tab in formatting. - enum UseTabStyle { - /// Never use tab. - UT_Never, - /// Use tabs only for indentation. - UT_ForIndentation, - /// Use tabs only for line continuation and indentation. - UT_ForContinuationAndIndentation, - /// Use tabs whenever we need to fill whitespace that spans at least from - /// one tab stop to the next one. - UT_Always - }; - - /// \brief The way to use tab characters in the resulting file. - UseTabStyle UseTab; - - bool operator==(const FormatStyle &R) const { - return AccessModifierOffset == R.AccessModifierOffset && - AlignAfterOpenBracket == R.AlignAfterOpenBracket && - AlignConsecutiveAssignments == R.AlignConsecutiveAssignments && - AlignConsecutiveDeclarations == R.AlignConsecutiveDeclarations && - AlignEscapedNewlinesLeft == R.AlignEscapedNewlinesLeft && - AlignOperands == R.AlignOperands && - AlignTrailingComments == R.AlignTrailingComments && - AllowAllParametersOfDeclarationOnNextLine == - R.AllowAllParametersOfDeclarationOnNextLine && - AllowShortBlocksOnASingleLine == R.AllowShortBlocksOnASingleLine && - AllowShortCaseLabelsOnASingleLine == - R.AllowShortCaseLabelsOnASingleLine && - AllowShortFunctionsOnASingleLine == - R.AllowShortFunctionsOnASingleLine && - AllowShortIfStatementsOnASingleLine == - R.AllowShortIfStatementsOnASingleLine && - AllowShortLoopsOnASingleLine == R.AllowShortLoopsOnASingleLine && - AlwaysBreakAfterReturnType == R.AlwaysBreakAfterReturnType && - AlwaysBreakBeforeMultilineStrings == - R.AlwaysBreakBeforeMultilineStrings && - AlwaysBreakTemplateDeclarations == - R.AlwaysBreakTemplateDeclarations && - BinPackArguments == R.BinPackArguments && - BinPackParameters == R.BinPackParameters && - BreakBeforeBinaryOperators == R.BreakBeforeBinaryOperators && - BreakBeforeBraces == R.BreakBeforeBraces && - BreakBeforeTernaryOperators == R.BreakBeforeTernaryOperators && - BreakConstructorInitializersBeforeComma == - R.BreakConstructorInitializersBeforeComma && - BreakAfterJavaFieldAnnotations == R.BreakAfterJavaFieldAnnotations && - BreakStringLiterals == R.BreakStringLiterals && - ColumnLimit == R.ColumnLimit && CommentPragmas == R.CommentPragmas && - BreakBeforeInheritanceComma == R.BreakBeforeInheritanceComma && - ConstructorInitializerAllOnOneLineOrOnePerLine == - R.ConstructorInitializerAllOnOneLineOrOnePerLine && - ConstructorInitializerIndentWidth == - R.ConstructorInitializerIndentWidth && - ContinuationIndentWidth == R.ContinuationIndentWidth && - Cpp11BracedListStyle == R.Cpp11BracedListStyle && - DerivePointerAlignment == R.DerivePointerAlignment && - DisableFormat == R.DisableFormat && - ExperimentalAutoDetectBinPacking == - R.ExperimentalAutoDetectBinPacking && - FixNamespaceComments == R.FixNamespaceComments && - ForEachMacros == R.ForEachMacros && - IncludeCategories == R.IncludeCategories && - IndentCaseLabels == R.IndentCaseLabels && - IndentWidth == R.IndentWidth && Language == R.Language && - IndentWrappedFunctionNames == R.IndentWrappedFunctionNames && - JavaScriptQuotes == R.JavaScriptQuotes && - JavaScriptWrapImports == R.JavaScriptWrapImports && - KeepEmptyLinesAtTheStartOfBlocks == - R.KeepEmptyLinesAtTheStartOfBlocks && - MacroBlockBegin == R.MacroBlockBegin && - MacroBlockEnd == R.MacroBlockEnd && - MaxEmptyLinesToKeep == R.MaxEmptyLinesToKeep && - NamespaceIndentation == R.NamespaceIndentation && - ObjCBlockIndentWidth == R.ObjCBlockIndentWidth && - ObjCSpaceAfterProperty == R.ObjCSpaceAfterProperty && - ObjCSpaceBeforeProtocolList == R.ObjCSpaceBeforeProtocolList && - PenaltyBreakBeforeFirstCallParameter == - R.PenaltyBreakBeforeFirstCallParameter && - PenaltyBreakComment == R.PenaltyBreakComment && - PenaltyBreakFirstLessLess == R.PenaltyBreakFirstLessLess && - PenaltyBreakString == R.PenaltyBreakString && - PenaltyExcessCharacter == R.PenaltyExcessCharacter && - PenaltyReturnTypeOnItsOwnLine == R.PenaltyReturnTypeOnItsOwnLine && - PointerAlignment == R.PointerAlignment && - SpaceAfterCStyleCast == R.SpaceAfterCStyleCast && - SpaceAfterTemplateKeyword == R.SpaceAfterTemplateKeyword && - SpaceBeforeAssignmentOperators == R.SpaceBeforeAssignmentOperators && - SpaceBeforeParens == R.SpaceBeforeParens && - SpaceInEmptyParentheses == R.SpaceInEmptyParentheses && - SpacesBeforeTrailingComments == R.SpacesBeforeTrailingComments && - SpacesInAngles == R.SpacesInAngles && - SpacesInContainerLiterals == R.SpacesInContainerLiterals && - SpacesInCStyleCastParentheses == R.SpacesInCStyleCastParentheses && - SpacesInParentheses == R.SpacesInParentheses && - SpacesInSquareBrackets == R.SpacesInSquareBrackets && - Standard == R.Standard && TabWidth == R.TabWidth && - UseTab == R.UseTab; - } -}; - -/// \brief Returns a format style complying with the LLVM coding standards: -/// http://llvm.org/docs/CodingStandards.html. -FormatStyle getLLVMStyle(); - -/// \brief Returns a format style complying with one of Google's style guides: -/// http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml. -/// http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml. -/// https://developers.google.com/protocol-buffers/docs/style. -FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language); - -/// \brief Returns a format style complying with Chromium's style guide: -/// http://www.chromium.org/developers/coding-style. -FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language); - -/// \brief Returns a format style complying with Mozilla's style guide: -/// https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style. -FormatStyle getMozillaStyle(); - -/// \brief Returns a format style complying with Webkit's style guide: -/// http://www.webkit.org/coding/coding-style.html -FormatStyle getWebKitStyle(); - -/// \brief Returns a format style complying with GNU Coding Standards: -/// http://www.gnu.org/prep/standards/standards.html -FormatStyle getGNUStyle(); - -/// \brief Returns style indicating formatting should be not applied at all. -FormatStyle getNoStyle(); - -/// \brief Gets a predefined style for the specified language by name. -/// -/// Currently supported names: LLVM, Google, Chromium, Mozilla. Names are -/// compared case-insensitively. -/// -/// Returns ``true`` if the Style has been set. -bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language, - FormatStyle *Style); - -/// \brief Parse configuration from YAML-formatted text. -/// -/// Style->Language is used to get the base style, if the ``BasedOnStyle`` -/// option is present. -/// -/// When ``BasedOnStyle`` is not present, options not present in the YAML -/// document, are retained in \p Style. -std::error_code parseConfiguration(StringRef Text, FormatStyle *Style); - -/// \brief Gets configuration in a YAML string. -std::string configurationAsText(const FormatStyle &Style); - -/// \brief Returns the replacements necessary to sort all ``#include`` blocks -/// that are affected by ``Ranges``. -tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code, - ArrayRef Ranges, - StringRef FileName, - unsigned *Cursor = nullptr); - -/// \brief Returns the replacements corresponding to applying and formatting -/// \p Replaces on success; otheriwse, return an llvm::Error carrying -/// llvm::StringError. -llvm::Expected -formatReplacements(StringRef Code, const tooling::Replacements &Replaces, - const FormatStyle &Style); - -/// \brief Returns the replacements corresponding to applying \p Replaces and -/// cleaning up the code after that on success; otherwise, return an llvm::Error -/// carrying llvm::StringError. -/// This also supports inserting/deleting C++ #include directives: -/// - If a replacement has offset UINT_MAX, length 0, and a replacement text -/// that is an #include directive, this will insert the #include into the -/// correct block in the \p Code. When searching for points to insert new -/// header, this ignores #include's after the #include block(s) in the -/// beginning of a file to avoid inserting headers into code sections where -/// new #include's should not be added by default. These code sections -/// include: -/// - raw string literals (containing #include). -/// - #if blocks. -/// - Special #include's among declarations (e.g. functions). -/// - If a replacement has offset UINT_MAX, length 1, and a replacement text -/// that is the name of the header to be removed, the header will be removed -/// from \p Code if it exists. -llvm::Expected -cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces, - const FormatStyle &Style); - -/// \brief Reformats the given \p Ranges in \p Code. -/// -/// Each range is extended on either end to its next bigger logic unit, i.e. -/// everything that might influence its formatting or might be influenced by its -/// formatting. -/// -/// Returns the ``Replacements`` necessary to make all \p Ranges comply with -/// \p Style. -/// -/// If ``IncompleteFormat`` is non-null, its value will be set to true if any -/// of the affected ranges were not formatted due to a non-recoverable syntax -/// error. -tooling::Replacements reformat(const FormatStyle &Style, StringRef Code, - ArrayRef Ranges, - StringRef FileName = "", - bool *IncompleteFormat = nullptr); - -/// \brief Clean up any erroneous/redundant code in the given \p Ranges in \p -/// Code. -/// -/// Returns the ``Replacements`` that clean up all \p Ranges in \p Code. -tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code, - ArrayRef Ranges, - StringRef FileName = ""); - -/// \brief Fix namespace end comments in the given \p Ranges in \p Code. -/// -/// Returns the ``Replacements`` that fix the namespace comments in all -/// \p Ranges in \p Code. -tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style, - StringRef Code, - ArrayRef Ranges, - StringRef FileName = ""); - -/// \brief Returns the ``LangOpts`` that the formatter expects you to set. -/// -/// \param Style determines specific settings for lexing mode. -LangOptions getFormattingLangOpts(const FormatStyle &Style = getLLVMStyle()); - -/// \brief Description to be used for help text for a ``llvm::cl`` option for -/// specifying format style. The description is closely related to the operation -/// of ``getStyle()``. -extern const char *StyleOptionHelpDescription; - -/// \brief Construct a FormatStyle based on ``StyleName``. -/// -/// ``StyleName`` can take several forms: -/// * "{: , ...}" - Set specic style parameters. -/// * "