diff options
Diffstat (limited to 'clang-r353983e/include/clang/Format/Format.h')
| -rw-r--r-- | clang-r353983e/include/clang/Format/Format.h | 2076 |
1 files changed, 2076 insertions, 0 deletions
diff --git a/clang-r353983e/include/clang/Format/Format.h b/clang-r353983e/include/clang/Format/Format.h new file mode 100644 index 00000000..4bc0a5c4 --- /dev/null +++ b/clang-r353983e/include/clang/Format/Format.h @@ -0,0 +1,2076 @@ +//===--- Format.h - Format C++ code -----------------------------*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// +/// +/// \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 "clang/Tooling/Inclusions/IncludeStyle.h" +#include "llvm/ADT/ArrayRef.h" +#include "llvm/Support/Regex.h" +#include <system_error> + +namespace llvm { +namespace vfs { +class FileSystem; +} +} // namespace llvm + +namespace clang { + +class Lexer; +class SourceManager; +class DiagnosticConsumer; + +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); + +/// The ``FormatStyle`` is used to configure the formatting to follow +/// specific guidelines. +struct FormatStyle { + /// The extra indent or outdent of access modifiers, e.g. ``public:``. + int AccessModifierOffset; + + /// Different styles for aligning after open brackets. + enum BracketAlignmentStyle { + /// Align parameters on the open bracket, e.g.: + /// \code + /// someLongFunction(argument1, + /// argument2); + /// \endcode + BAS_Align, + /// Don't align, instead use ``ContinuationIndentWidth``, e.g.: + /// \code + /// someLongFunction(argument1, + /// argument2); + /// \endcode + BAS_DontAlign, + /// 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, + }; + + /// If ``true``, horizontally aligns arguments after an open bracket. + /// + /// This applies to round brackets (parentheses), angle brackets and square + /// brackets. + BracketAlignmentStyle AlignAfterOpenBracket; + + /// 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; + + /// 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; + + /// Different styles for aligning escaped newlines. + enum EscapedNewlineAlignmentStyle { + /// Don't align escaped newlines. + /// \code + /// #define A \ + /// int aaaa; \ + /// int b; \ + /// int dddddddddd; + /// \endcode + ENAS_DontAlign, + /// Align escaped newlines as far left as possible. + /// \code + /// true: + /// #define A \ + /// int aaaa; \ + /// int b; \ + /// int dddddddddd; + /// + /// false: + /// \endcode + ENAS_Left, + /// Align escaped newlines in the right-most column. + /// \code + /// #define A \ + /// int aaaa; \ + /// int b; \ + /// int dddddddddd; + /// \endcode + ENAS_Right, + }; + + /// Options for aligning backslashes in escaped newlines. + EscapedNewlineAlignmentStyle AlignEscapedNewlines; + + /// 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; + + /// 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; + + /// If the function declaration doesn't fit on a line, + /// allow putting all parameters of a function declaration onto + /// the next line even if ``BinPackParameters`` is ``false``. + /// \code + /// true: + /// void myFunction( + /// int a, int b, int c, int d, int e); + /// + /// false: + /// void myFunction(int a, + /// int b, + /// int c, + /// int d, + /// int e); + /// \endcode + bool AllowAllParametersOfDeclarationOnNextLine; + + /// 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; + + /// 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; + + /// Different styles for merging short functions containing at most one + /// statement. + enum ShortFunctionStyle { + /// Never merge functions into a single line. + SFS_None, + /// Only merge functions defined inside a class. Same as "inline", + /// except it does not implies "empty": i.e. top level empty functions + /// are not merged either. + /// \code + /// class Foo { + /// void f() { foo(); } + /// }; + /// void f() { + /// foo(); + /// } + /// void f() { + /// } + /// \endcode + SFS_InlineOnly, + /// Only merge empty functions. + /// \code + /// void f() {} + /// void f2() { + /// bar2(); + /// } + /// \endcode + SFS_Empty, + /// Only merge functions defined inside a class. Implies "empty". + /// \code + /// class Foo { + /// void f() { foo(); } + /// }; + /// void f() { + /// foo(); + /// } + /// void f() {} + /// \endcode + SFS_Inline, + /// Merge all functions fitting on a single line. + /// \code + /// class Foo { + /// void f() { foo(); } + /// }; + /// void f() { bar(); } + /// \endcode + SFS_All, + }; + + /// Dependent on the value, ``int f() { return 0; }`` can be put on a + /// single line. + ShortFunctionStyle AllowShortFunctionsOnASingleLine; + + /// If ``true``, ``if (a) return;`` can be put on a single line. + bool AllowShortIfStatementsOnASingleLine; + + /// If ``true``, ``while (true) continue;`` can be put on a single + /// line. + bool AllowShortLoopsOnASingleLine; + + /// 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, + }; + + /// 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, + }; + + /// The function definition return type breaking style to use. This + /// option is **deprecated** and is retained for backwards compatibility. + DefinitionReturnTypeBreakingStyle AlwaysBreakAfterDefinitionReturnType; + + /// The function declaration return type breaking style to use. + ReturnTypeBreakingStyle AlwaysBreakAfterReturnType; + + /// 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; + + /// Different ways to break after the template declaration. + enum BreakTemplateDeclarationsStyle { + /// Do not force break before declaration. + /// ``PenaltyBreakTemplateDeclaration`` is taken into account. + /// \code + /// template <typename T> T foo() { + /// } + /// template <typename T> T foo(int aaaaaaaaaaaaaaaaaaaaa, + /// int bbbbbbbbbbbbbbbbbbbbb) { + /// } + /// \endcode + BTDS_No, + /// Force break after template declaration only when the following + /// declaration spans multiple lines. + /// \code + /// template <typename T> T foo() { + /// } + /// template <typename T> + /// T foo(int aaaaaaaaaaaaaaaaaaaaa, + /// int bbbbbbbbbbbbbbbbbbbbb) { + /// } + /// \endcode + BTDS_MultiLine, + /// Always break after template declaration. + /// \code + /// template <typename T> + /// T foo() { + /// } + /// template <typename T> + /// T foo(int aaaaaaaaaaaaaaaaaaaaa, + /// int bbbbbbbbbbbbbbbbbbbbb) { + /// } + /// \endcode + BTDS_Yes + }; + + /// The template declaration breaking style to use. + BreakTemplateDeclarationsStyle AlwaysBreakTemplateDeclarations; + + /// 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; + + /// 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; + + /// The style of wrapping parameters on the same line (bin-packed) or + /// on one line each. + enum BinPackStyle { + /// Automatically determine parameter bin-packing behavior. + BPS_Auto, + /// Always bin-pack parameters. + BPS_Always, + /// Never bin-pack parameters. + BPS_Never, + }; + + /// 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, + }; + + /// The way to wrap binary operators. + BinaryOperatorStyle BreakBeforeBinaryOperators; + + /// 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 + }; + + /// The brace breaking style to use. + BraceBreakingStyle BreakBeforeBraces; + + /// Precise control over the wrapping of braces. + /// \code + /// # Should be declared this way: + /// BreakBeforeBraces: Custom + /// BraceWrapping: + /// AfterClass: true + /// \endcode + struct BraceWrappingFlags { + /// Wrap class definitions. + /// \code + /// true: + /// class foo {}; + /// + /// false: + /// class foo + /// {}; + /// \endcode + bool AfterClass; + /// 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; + /// Wrap enum definitions. + /// \code + /// true: + /// enum X : int + /// { + /// B + /// }; + /// + /// false: + /// enum X : int { B }; + /// \endcode + bool AfterEnum; + /// Wrap function definitions. + /// \code + /// true: + /// void foo() + /// { + /// bar(); + /// bar2(); + /// } + /// + /// false: + /// void foo() { + /// bar(); + /// bar2(); + /// } + /// \endcode + bool AfterFunction; + /// Wrap namespace definitions. + /// \code + /// true: + /// namespace + /// { + /// int foo(); + /// int bar(); + /// } + /// + /// false: + /// namespace { + /// int foo(); + /// int bar(); + /// } + /// \endcode + bool AfterNamespace; + /// Wrap ObjC definitions (interfaces, implementations...). + /// \note @autoreleasepool and @synchronized blocks are wrapped + /// according to `AfterControlStatement` flag. + bool AfterObjCDeclaration; + /// Wrap struct definitions. + /// \code + /// true: + /// struct foo + /// { + /// int x; + /// }; + /// + /// false: + /// struct foo { + /// int x; + /// }; + /// \endcode + bool AfterStruct; + /// Wrap union definitions. + /// \code + /// true: + /// union foo + /// { + /// int x; + /// } + /// + /// false: + /// union foo { + /// int x; + /// } + /// \endcode + bool AfterUnion; + /// Wrap extern blocks. + /// \code + /// true: + /// extern "C" + /// { + /// int foo(); + /// } + /// + /// false: + /// extern "C" { + /// int foo(); + /// } + /// \endcode + bool AfterExternBlock; + /// Wrap before ``catch``. + /// \code + /// true: + /// try { + /// foo(); + /// } + /// catch () { + /// } + /// + /// false: + /// try { + /// foo(); + /// } catch () { + /// } + /// \endcode + bool BeforeCatch; + /// Wrap before ``else``. + /// \code + /// true: + /// if (foo()) { + /// } + /// else { + /// } + /// + /// false: + /// if (foo()) { + /// } else { + /// } + /// \endcode + bool BeforeElse; + /// Indent the wrapped braces themselves. + bool IndentBraces; + /// If ``false``, empty function body can be put on a single line. + /// This option is used only if the opening brace of the function has + /// already been wrapped, i.e. the `AfterFunction` brace wrapping mode is + /// set, and the function could/should not be put on a single line (as per + /// `AllowShortFunctionsOnASingleLine` and constructor formatting options). + /// \code + /// int f() vs. inf f() + /// {} { + /// } + /// \endcode + /// + bool SplitEmptyFunction; + /// If ``false``, empty record (e.g. class, struct or union) body + /// can be put on a single line. This option is used only if the opening + /// brace of the record has already been wrapped, i.e. the `AfterClass` + /// (for classes) brace wrapping mode is set. + /// \code + /// class Foo vs. class Foo + /// {} { + /// } + /// \endcode + /// + bool SplitEmptyRecord; + /// If ``false``, empty namespace body can be put on a single line. + /// This option is used only if the opening brace of the namespace has + /// already been wrapped, i.e. the `AfterNamespace` brace wrapping mode is + /// set. + /// \code + /// namespace Foo vs. namespace Foo + /// {} { + /// } + /// \endcode + /// + bool SplitEmptyNamespace; + }; + + /// Control of individual brace wrapping cases. + /// + /// If ``BreakBeforeBraces`` is set to ``BS_Custom``, use this to specify how + /// each individual brace case should be handled. Otherwise, this is ignored. + /// \code{.yaml} + /// # Example of usage: + /// BreakBeforeBraces: Custom + /// BraceWrapping: + /// AfterEnum: true + /// AfterStruct: false + /// SplitEmptyFunction: false + /// \endcode + BraceWrappingFlags BraceWrapping; + + /// If ``true``, ternary operators will be placed after line breaks. + /// \code + /// true: + /// veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription + /// ? firstValue + /// : SecondValueVeryVeryVeryVeryLong; + /// + /// false: + /// veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ? + /// firstValue : + /// SecondValueVeryVeryVeryVeryLong; + /// \endcode + bool BreakBeforeTernaryOperators; + + /// Different ways to break initializers. + enum BreakConstructorInitializersStyle { + /// Break constructor initializers before the colon and after the commas. + /// \code + /// Constructor() + /// : initializer1(), + /// initializer2() + /// \endcode + BCIS_BeforeColon, + /// Break constructor initializers before the colon and commas, and align + /// the commas with the colon. + /// \code + /// Constructor() + /// : initializer1() + /// , initializer2() + /// \endcode + BCIS_BeforeComma, + /// Break constructor initializers after the colon and commas. + /// \code + /// Constructor() : + /// initializer1(), + /// initializer2() + /// \endcode + BCIS_AfterColon + }; + + /// The constructor initializers style to use. + BreakConstructorInitializersStyle BreakConstructorInitializers; + + /// Break after each annotation on a field in Java files. + /// \code{.java} + /// true: false: + /// @Partial vs. @Partial @Mock DataLoad loader; + /// @Mock + /// DataLoad loader; + /// \endcode + bool BreakAfterJavaFieldAnnotations; + + /// Allow breaking string literals when formatting. + bool BreakStringLiterals; + + /// 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; + + /// 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 <vector> // FOOBAR pragma: keep + /// \endcode + std::string CommentPragmas; + + /// Different ways to break inheritance list. + enum BreakInheritanceListStyle { + /// Break inheritance list before the colon and after the commas. + /// \code + /// class Foo + /// : Base1, + /// Base2 + /// {}; + /// \endcode + BILS_BeforeColon, + /// Break inheritance list before the colon and commas, and align + /// the commas with the colon. + /// \code + /// class Foo + /// : Base1 + /// , Base2 + /// {}; + /// \endcode + BILS_BeforeComma, + /// Break inheritance list after the colon and commas. + /// \code + /// class Foo : + /// Base1, + /// Base2 + /// {}; + /// \endcode + BILS_AfterColon + }; + + /// The inheritance list style to use. + BreakInheritanceListStyle BreakInheritanceList; + + /// If ``true``, consecutive namespace declarations will be on the same + /// line. If ``false``, each namespace is declared on a new line. + /// \code + /// true: + /// namespace Foo { namespace Bar { + /// }} + /// + /// false: + /// namespace Foo { + /// namespace Bar { + /// } + /// } + /// \endcode + /// + /// If it does not fit on a single line, the overflowing namespaces get + /// wrapped: + /// \code + /// namespace Foo { namespace Bar { + /// namespace Extra { + /// }}} + /// \endcode + bool CompactNamespaces; + + /// 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; + + /// The number of characters to use for indentation of constructor + /// initializer lists as well as inheritance lists. + unsigned ConstructorInitializerIndentWidth; + + /// Indent width for line continuations. + /// \code + /// ContinuationIndentWidth: 2 + /// + /// int i = // VeryVeryVeryVeryVeryLongComment + /// longFunction( // Again a long comment + /// arg); + /// \endcode + unsigned ContinuationIndentWidth; + + /// If ``true``, format braced lists as best suited for C++11 braced + /// lists. + /// + /// Important differences: + /// - No spaces inside the braced list. + /// - No line break before the closing brace. + /// - Indentation with the continuation indent, not with the block indent. + /// + /// Fundamentally, C++11 braced lists are formatted exactly like function + /// calls would be formatted in their place. If the braced list follows a name + /// (e.g. a type or variable name), clang-format formats as if the ``{}`` were + /// the parentheses of a function call with that name. If there is no name, + /// a zero-length name is assumed. + /// \code + /// true: false: + /// vector<int> x{1, 2, 3, 4}; vs. vector<int> x{ 1, 2, 3, 4 }; + /// vector<T> x{{}, {}, {}, {}}; vector<T> x{ {}, {}, {}, {} }; + /// f(MyMap[{composite, key}]); f(MyMap[{ composite, key }]); + /// new int[3]{1, 2, 3}; new int[3]{ 1, 2, 3 }; + /// \endcode + bool Cpp11BracedListStyle; + + /// If ``true``, analyze the formatted file for the most common + /// alignment of ``&`` and ``*``. + /// Pointer and reference alignment styles are going to be updated according + /// to the preferences found in the file. + /// ``PointerAlignment`` is then used only as fallback. + bool DerivePointerAlignment; + + /// Disables formatting completely. + bool DisableFormat; + + /// 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; + + /// 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; + + /// 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(<variable-declaration>, ...) + /// <loop-body> + /// \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<std::string> ForEachMacros; + + /// A vector of macros that should be interpreted as complete + /// statements. + /// + /// Typical macros are expressions, and require a semi-colon to be + /// added; sometimes this is not the case, and this allows to make + /// clang-format aware of such cases. + /// + /// For example: Q_UNUSED + std::vector<std::string> StatementMacros; + + tooling::IncludeStyle IncludeStyle; + + /// 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. + /// \code + /// false: true: + /// switch (fool) { vs. switch (fool) { + /// case 1: case 1: + /// bar(); bar(); + /// break; break; + /// default: default: + /// plop(); plop(); + /// } } + /// \endcode + bool IndentCaseLabels; + + /// Options for indenting preprocessor directives. + enum PPDirectiveIndentStyle { + /// Does not indent any directives. + /// \code + /// #if FOO + /// #if BAR + /// #include <foo> + /// #endif + /// #endif + /// \endcode + PPDIS_None, + /// Indents directives after the hash. + /// \code + /// #if FOO + /// # if BAR + /// # include <foo> + /// # endif + /// #endif + /// \endcode + PPDIS_AfterHash + }; + + /// The preprocessor directive indenting style to use. + PPDirectiveIndentStyle IndentPPDirectives; + + /// The number of columns to use for indentation. + /// \code + /// IndentWidth: 3 + /// + /// void f() { + /// someFunction(); + /// if (true, false) { + /// f(); + /// } + /// } + /// \endcode + unsigned IndentWidth; + + /// Indent if a function definition or declaration is wrapped after the + /// type. + /// \code + /// true: + /// LoooooooooooooooooooooooooooooooooooooooongReturnType + /// LoooooooooooooooooooooooooooooooongFunctionDeclaration(); + /// + /// false: + /// LoooooooooooooooooooooooooooooooooooooooongReturnType + /// LoooooooooooooooooooooooooooooooongFunctionDeclaration(); + /// \endcode + bool IndentWrappedFunctionNames; + + /// A vector of prefixes ordered by the desired groups for Java imports. + /// + /// Each group is seperated by a newline. Static imports will also follow the + /// same grouping convention above all non-static imports. One group's prefix + /// can be a subset of another - the longest prefix is always matched. Within + /// a group, the imports are ordered lexicographically. + /// + /// In the .clang-format configuration file, this can be configured like + /// in the following yaml example. This will result in imports being + /// formatted as in the Java example below. + /// \code{.yaml} + /// JavaImportGroups: ['com.example', 'com', 'org'] + /// \endcode + /// + /// \code{.java} + /// import static com.example.function1; + /// + /// import static com.test.function2; + /// + /// import static org.example.function3; + /// + /// import com.example.ClassA; + /// import com.example.Test; + /// import com.example.a.ClassB; + /// + /// import com.test.ClassC; + /// + /// import org.example.ClassD; + /// \endcode + std::vector<std::string> JavaImportGroups; + + /// 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 + }; + + /// The JavaScriptQuoteStyle to use for JavaScript strings. + JavaScriptQuoteStyle JavaScriptQuotes; + + /// 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; + + /// If true, the empty line at the start of blocks is kept. + /// \code + /// true: false: + /// if (foo) { vs. if (foo) { + /// bar(); + /// bar(); } + /// } + /// \endcode + bool KeepEmptyLinesAtTheStartOfBlocks; + + /// 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, + /// Should be used for Protocol Buffer messages in text format + /// (https://developers.google.com/protocol-buffers/). + LK_TextProto + }; + bool isCpp() const { return Language == LK_Cpp || Language == LK_ObjC; } + + /// Language, this format style is targeted at. + LanguageKind Language; + + /// 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; + + /// A regular expression matching macros that end a block. + std::string MacroBlockEnd; + + /// 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; + + /// 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 + }; + + /// The indentation used for namespaces. + NamespaceIndentationKind NamespaceIndentation; + + /// Controls bin-packing Objective-C protocol conformance list + /// items into as few lines as possible when they go over ``ColumnLimit``. + /// + /// If ``Auto`` (the default), delegates to the value in + /// ``BinPackParameters``. If that is ``true``, bin-packs Objective-C + /// protocol conformance list items into as few lines as possible + /// whenever they go over ``ColumnLimit``. + /// + /// If ``Always``, always bin-packs Objective-C protocol conformance + /// list items into as few lines as possible whenever they go over + /// ``ColumnLimit``. + /// + /// If ``Never``, lays out Objective-C protocol conformance list items + /// onto individual lines whenever they go over ``ColumnLimit``. + /// + /// \code{.objc} + /// Always (or Auto, if BinPackParameters=true): + /// @interface ccccccccccccc () < + /// ccccccccccccc, ccccccccccccc, + /// ccccccccccccc, ccccccccccccc> { + /// } + /// + /// Never (or Auto, if BinPackParameters=false): + /// @interface ddddddddddddd () < + /// ddddddddddddd, + /// ddddddddddddd, + /// ddddddddddddd, + /// ddddddddddddd> { + /// } + /// \endcode + BinPackStyle ObjCBinPackProtocolList; + + /// The number of characters to use for indentation of ObjC blocks. + /// \code{.objc} + /// ObjCBlockIndentWidth: 4 + /// + /// [operation setCompletionBlock:^{ + /// [self onOperationDone]; + /// }]; + /// \endcode + unsigned ObjCBlockIndentWidth; + + /// Add a space after ``@property`` in Objective-C, i.e. use + /// ``@property (readonly)`` instead of ``@property(readonly)``. + bool ObjCSpaceAfterProperty; + + /// Add a space in front of an Objective-C protocol list, i.e. use + /// ``Foo <Protocol>`` instead of ``Foo<Protocol>``. + bool ObjCSpaceBeforeProtocolList; + + /// The penalty for breaking around an assignment operator. + unsigned PenaltyBreakAssignment; + + /// The penalty for breaking a function call after ``call(``. + unsigned PenaltyBreakBeforeFirstCallParameter; + + /// The penalty for each line break introduced inside a comment. + unsigned PenaltyBreakComment; + + /// The penalty for breaking before the first ``<<``. + unsigned PenaltyBreakFirstLessLess; + + /// The penalty for each line break introduced inside a string literal. + unsigned PenaltyBreakString; + + /// The penalty for breaking after template declaration. + unsigned PenaltyBreakTemplateDeclaration; + + /// The penalty for each character outside of the column limit. + unsigned PenaltyExcessCharacter; + + /// Penalty for putting the return type of a function onto its own + /// line. + unsigned PenaltyReturnTypeOnItsOwnLine; + + /// 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 + }; + + /// Pointer and reference alignment style. + PointerAlignmentStyle PointerAlignment; + + /// See documentation of ``RawStringFormats``. + struct RawStringFormat { + /// The language of this raw string. + LanguageKind Language; + /// A list of raw string delimiters that match this language. + std::vector<std::string> Delimiters; + /// A list of enclosing function names that match this language. + std::vector<std::string> EnclosingFunctions; + /// The canonical delimiter for this language. + std::string CanonicalDelimiter; + /// The style name on which this raw string format is based on. + /// If not specified, the raw string format is based on the style that this + /// format is based on. + std::string BasedOnStyle; + bool operator==(const RawStringFormat &Other) const { + return Language == Other.Language && Delimiters == Other.Delimiters && + EnclosingFunctions == Other.EnclosingFunctions && + CanonicalDelimiter == Other.CanonicalDelimiter && + BasedOnStyle == Other.BasedOnStyle; + } + }; + + /// Defines hints for detecting supported languages code blocks in raw + /// strings. + /// + /// A raw string with a matching delimiter or a matching enclosing function + /// name will be reformatted assuming the specified language based on the + /// style for that language defined in the .clang-format file. If no style has + /// been defined in the .clang-format file for the specific language, a + /// predefined style given by 'BasedOnStyle' is used. If 'BasedOnStyle' is not + /// found, the formatting is based on llvm style. A matching delimiter takes + /// precedence over a matching enclosing function name for determining the + /// language of the raw string contents. + /// + /// If a canonical delimiter is specified, occurrences of other delimiters for + /// the same language will be updated to the canonical if possible. + /// + /// There should be at most one specification per language and each delimiter + /// and enclosing function should not occur in multiple specifications. + /// + /// To configure this in the .clang-format file, use: + /// \code{.yaml} + /// RawStringFormats: + /// - Language: TextProto + /// Delimiters: + /// - 'pb' + /// - 'proto' + /// EnclosingFunctions: + /// - 'PARSE_TEXT_PROTO' + /// BasedOnStyle: google + /// - Language: Cpp + /// Delimiters: + /// - 'cc' + /// - 'cpp' + /// BasedOnStyle: llvm + /// CanonicalDelimiter: 'cc' + /// \endcode + std::vector<RawStringFormat> RawStringFormats; + + /// 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; + + /// 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; + + /// If ``true``, clang-format will sort using declarations. + /// + /// The order of using declarations is defined as follows: + /// Split the strings by "::" and discard any initial empty strings. The last + /// element of each list is a non-namespace name; all others are namespace + /// names. Sort the lists of names lexicographically, where the sort order of + /// individual names is that all non-namespace names come before all namespace + /// names, and within those groups, names are in case-insensitive + /// lexicographic order. + /// \code + /// false: true: + /// using std::cout; vs. using std::cin; + /// using std::cin; using std::cout; + /// \endcode + bool SortUsingDeclarations; + + /// If ``true``, a space is inserted after C style casts. + /// \code + /// true: false: + /// (int) i; vs. (int)i; + /// \endcode + bool SpaceAfterCStyleCast; + + /// If \c true, a space will be inserted after the 'template' keyword. + /// \code + /// true: false: + /// template <int> void foo(); vs. template<int> void foo(); + /// \endcode + bool SpaceAfterTemplateKeyword; + + /// 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; + + /// If ``true``, a space will be inserted before a C++11 braced list + /// used to initialize an object (after the preceding identifier or type). + /// \code + /// true: false: + /// Foo foo { bar }; vs. Foo foo{ bar }; + /// Foo {}; Foo{}; + /// vector<int> { 1, 2, 3 }; vector<int>{ 1, 2, 3 }; + /// new int[3] { 1, 2, 3 }; new int[3]{ 1, 2, 3 }; + /// \endcode + bool SpaceBeforeCpp11BracedList; + + /// If ``false``, spaces will be removed before constructor initializer + /// colon. + /// \code + /// true: false: + /// Foo::Foo() : a(a) {} Foo::Foo(): a(a) {} + /// \endcode + bool SpaceBeforeCtorInitializerColon; + + /// If ``false``, spaces will be removed before inheritance colon. + /// \code + /// true: false: + /// class Foo : Bar {} vs. class Foo: Bar {} + /// \endcode + bool SpaceBeforeInheritanceColon; + + /// 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 + }; + + /// Defines in which cases to put a space before opening parentheses. + SpaceBeforeParensOptions SpaceBeforeParens; + + /// If ``false``, spaces will be removed before range-based for loop + /// colon. + /// \code + /// true: false: + /// for (auto v : values) {} vs. for(auto v: values) {} + /// \endcode + bool SpaceBeforeRangeBasedForLoopColon; + + /// 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; + + /// 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; + + /// If ``true``, spaces will be inserted after ``<`` and before ``>`` + /// in template argument lists. + /// \code + /// true: false: + /// static_cast< int >(arg); vs. static_cast<int>(arg); + /// std::function< void(int) > fct; std::function<void(int)> fct; + /// \endcode + bool SpacesInAngles; + + /// 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; + + /// If ``true``, spaces may be inserted into C style casts. + /// \code + /// true: false: + /// x = ( int32 )y vs. x = (int32)y + /// \endcode + bool SpacesInCStyleCastParentheses; + + /// If ``true``, spaces will be inserted after ``(`` and before ``)``. + /// \code + /// true: false: + /// t f( Deleted & ) & = delete; vs. t f(Deleted &) & = delete; + /// \endcode + bool SpacesInParentheses; + + /// 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<int[]> foo() {} // Won't be affected + /// \endcode + bool SpacesInSquareBrackets; + + /// Supported language standards. + enum LanguageStandard { + /// Use C++03-compatible syntax. + LS_Cpp03, + /// Use features of C++11, C++14 and C++1z (e.g. ``A<A<int>>`` instead of + /// ``A<A<int> >``). + LS_Cpp11, + /// Automatic detection based on the input. + LS_Auto + }; + + /// Format compatible with this standard, e.g. use ``A<A<int> >`` + /// instead of ``A<A<int>>`` for ``LS_Cpp03``. + LanguageStandard Standard; + + /// The number of columns used for tab stops. + unsigned TabWidth; + + /// 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 + }; + + /// 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 && + AlignEscapedNewlines == R.AlignEscapedNewlines && + 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 && + BreakConstructorInitializers == R.BreakConstructorInitializers && + CompactNamespaces == R.CompactNamespaces && + BreakAfterJavaFieldAnnotations == R.BreakAfterJavaFieldAnnotations && + BreakStringLiterals == R.BreakStringLiterals && + ColumnLimit == R.ColumnLimit && CommentPragmas == R.CommentPragmas && + BreakInheritanceList == R.BreakInheritanceList && + 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 && + IncludeStyle.IncludeBlocks == R.IncludeStyle.IncludeBlocks && + IncludeStyle.IncludeCategories == R.IncludeStyle.IncludeCategories && + IndentCaseLabels == R.IndentCaseLabels && + IndentPPDirectives == R.IndentPPDirectives && + IndentWidth == R.IndentWidth && Language == R.Language && + IndentWrappedFunctionNames == R.IndentWrappedFunctionNames && + JavaImportGroups == R.JavaImportGroups && + JavaScriptQuotes == R.JavaScriptQuotes && + JavaScriptWrapImports == R.JavaScriptWrapImports && + KeepEmptyLinesAtTheStartOfBlocks == + R.KeepEmptyLinesAtTheStartOfBlocks && + MacroBlockBegin == R.MacroBlockBegin && + MacroBlockEnd == R.MacroBlockEnd && + MaxEmptyLinesToKeep == R.MaxEmptyLinesToKeep && + NamespaceIndentation == R.NamespaceIndentation && + ObjCBinPackProtocolList == R.ObjCBinPackProtocolList && + ObjCBlockIndentWidth == R.ObjCBlockIndentWidth && + ObjCSpaceAfterProperty == R.ObjCSpaceAfterProperty && + ObjCSpaceBeforeProtocolList == R.ObjCSpaceBeforeProtocolList && + PenaltyBreakAssignment == R.PenaltyBreakAssignment && + PenaltyBreakBeforeFirstCallParameter == + R.PenaltyBreakBeforeFirstCallParameter && + PenaltyBreakComment == R.PenaltyBreakComment && + PenaltyBreakFirstLessLess == R.PenaltyBreakFirstLessLess && + PenaltyBreakString == R.PenaltyBreakString && + PenaltyExcessCharacter == R.PenaltyExcessCharacter && + PenaltyReturnTypeOnItsOwnLine == R.PenaltyReturnTypeOnItsOwnLine && + PenaltyBreakTemplateDeclaration == + R.PenaltyBreakTemplateDeclaration && + PointerAlignment == R.PointerAlignment && + RawStringFormats == R.RawStringFormats && + SpaceAfterCStyleCast == R.SpaceAfterCStyleCast && + SpaceAfterTemplateKeyword == R.SpaceAfterTemplateKeyword && + SpaceBeforeAssignmentOperators == R.SpaceBeforeAssignmentOperators && + SpaceBeforeCpp11BracedList == R.SpaceBeforeCpp11BracedList && + SpaceBeforeCtorInitializerColon == + R.SpaceBeforeCtorInitializerColon && + SpaceBeforeInheritanceColon == R.SpaceBeforeInheritanceColon && + SpaceBeforeParens == R.SpaceBeforeParens && + SpaceBeforeRangeBasedForLoopColon == + R.SpaceBeforeRangeBasedForLoopColon && + 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 && + StatementMacros == R.StatementMacros && UseTab == R.UseTab; + } + + llvm::Optional<FormatStyle> GetLanguageStyle(LanguageKind Language) const; + + // Stores per-language styles. A FormatStyle instance inside has an empty + // StyleSet. A FormatStyle instance returned by the Get method has its + // StyleSet set to a copy of the originating StyleSet, effectively keeping the + // internal representation of that StyleSet alive. + // + // The memory management and ownership reminds of a birds nest: chicks + // leaving the nest take photos of the nest with them. + struct FormatStyleSet { + typedef std::map<FormatStyle::LanguageKind, FormatStyle> MapType; + + llvm::Optional<FormatStyle> Get(FormatStyle::LanguageKind Language) const; + + // Adds \p Style to this FormatStyleSet. Style must not have an associated + // FormatStyleSet. + // Style.Language should be different than LK_None. If this FormatStyleSet + // already contains an entry for Style.Language, that gets replaced with the + // passed Style. + void Add(FormatStyle Style); + + // Clears this FormatStyleSet. + void Clear(); + + private: + std::shared_ptr<MapType> Styles; + }; + + static FormatStyleSet BuildStyleSetFromConfiguration( + const FormatStyle &MainStyle, + const std::vector<FormatStyle> &ConfigurationStyles); + +private: + FormatStyleSet StyleSet; + + friend std::error_code parseConfiguration(StringRef Text, FormatStyle *Style); +}; + +/// Returns a format style complying with the LLVM coding standards: +/// http://llvm.org/docs/CodingStandards.html. +FormatStyle getLLVMStyle(); + +/// 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); + +/// Returns a format style complying with Chromium's style guide: +/// http://www.chromium.org/developers/coding-style. +FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language); + +/// Returns a format style complying with Mozilla's style guide: +/// https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style. +FormatStyle getMozillaStyle(); + +/// Returns a format style complying with Webkit's style guide: +/// http://www.webkit.org/coding/coding-style.html +FormatStyle getWebKitStyle(); + +/// Returns a format style complying with GNU Coding Standards: +/// http://www.gnu.org/prep/standards/standards.html +FormatStyle getGNUStyle(); + +/// Returns style indicating formatting should be not applied at all. +FormatStyle getNoStyle(); + +/// 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); + +/// Parse configuration from YAML-formatted text. +/// +/// Style->Language is used to get the base style, if the ``BasedOnStyle`` +/// option is present. +/// +/// The FormatStyleSet of Style is reset. +/// +/// 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); + +/// Gets configuration in a YAML string. +std::string configurationAsText(const FormatStyle &Style); + +/// Returns the replacements necessary to sort all ``#include`` blocks +/// that are affected by ``Ranges``. +tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code, + ArrayRef<tooling::Range> Ranges, + StringRef FileName, + unsigned *Cursor = nullptr); + +/// Returns the replacements corresponding to applying and formatting +/// \p Replaces on success; otheriwse, return an llvm::Error carrying +/// llvm::StringError. +llvm::Expected<tooling::Replacements> +formatReplacements(StringRef Code, const tooling::Replacements &Replaces, + const FormatStyle &Style); + +/// 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. +/// - 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. +/// The include manipulation is done via `tooling::HeaderInclude`, see its +/// documentation for more details on how include insertion points are found and +/// what edits are produced. +llvm::Expected<tooling::Replacements> +cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces, + const FormatStyle &Style); + +/// Represents the status of a formatting attempt. +struct FormattingAttemptStatus { + /// A value of ``false`` means that any of the affected ranges were not + /// formatted due to a non-recoverable syntax error. + bool FormatComplete = true; + + /// If ``FormatComplete`` is false, ``Line`` records a one-based + /// original line number at which a syntax error might have occurred. This is + /// based on a best-effort analysis and could be imprecise. + unsigned Line = 0; +}; + +/// 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 ``Status`` is non-null, its value will be populated with the status of +/// this formatting attempt. See \c FormattingAttemptStatus. +tooling::Replacements reformat(const FormatStyle &Style, StringRef Code, + ArrayRef<tooling::Range> Ranges, + StringRef FileName = "<stdin>", + FormattingAttemptStatus *Status = nullptr); + +/// Same as above, except 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<tooling::Range> Ranges, + StringRef FileName, + bool *IncompleteFormat); + +/// 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<tooling::Range> Ranges, + StringRef FileName = "<stdin>"); + +/// 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<tooling::Range> Ranges, + StringRef FileName = "<stdin>"); + +/// Sort consecutive using declarations in the given \p Ranges in +/// \p Code. +/// +/// Returns the ``Replacements`` that sort the using declarations in all +/// \p Ranges in \p Code. +tooling::Replacements sortUsingDeclarations(const FormatStyle &Style, + StringRef Code, + ArrayRef<tooling::Range> Ranges, + StringRef FileName = "<stdin>"); + +/// Returns the ``LangOpts`` that the formatter expects you to set. +/// +/// \param Style determines specific settings for lexing mode. +LangOptions getFormattingLangOpts(const FormatStyle &Style = getLLVMStyle()); + +/// 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; + +/// The suggested format style to use by default. This allows tools using +/// `getStyle` to have a consistent default style. +/// Different builds can modify the value to the preferred styles. +extern const char *DefaultFormatStyle; + +/// The suggested predefined style to use as the fallback style in `getStyle`. +/// Different builds can modify the value to the preferred styles. +extern const char *DefaultFallbackStyle; + +/// Construct a FormatStyle based on ``StyleName``. +/// +/// ``StyleName`` can take several forms: +/// * "{<key>: <value>, ...}" - Set specic style parameters. +/// * "<style name>" - One of the style names supported by +/// getPredefinedStyle(). +/// * "file" - Load style configuration from a file called ``.clang-format`` +/// located in one of the parent directories of ``FileName`` or the current +/// directory if ``FileName`` is empty. +/// +/// \param[in] StyleName Style name to interpret according to the description +/// above. +/// \param[in] FileName Path to start search for .clang-format if ``StyleName`` +/// == "file". +/// \param[in] FallbackStyle The name of a predefined style used to fallback to +/// in case \p StyleName is "file" and no file can be found. +/// \param[in] Code The actual code to be formatted. Used to determine the +/// language if the filename isn't sufficient. +/// \param[in] FS The underlying file system, in which the file resides. By +/// default, the file system is the real file system. +/// +/// \returns FormatStyle as specified by ``StyleName``. If ``StyleName`` is +/// "file" and no file is found, returns ``FallbackStyle``. If no style could be +/// determined, returns an Error. +llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName, + StringRef FallbackStyle, + StringRef Code = "", + llvm::vfs::FileSystem *FS = nullptr); + +// Guesses the language from the ``FileName`` and ``Code`` to be formatted. +// Defaults to FormatStyle::LK_Cpp. +FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code); + +// Returns a string representation of ``Language``. +inline StringRef getLanguageName(FormatStyle::LanguageKind Language) { + switch (Language) { + case FormatStyle::LK_Cpp: + return "C++"; + case FormatStyle::LK_ObjC: + return "Objective-C"; + case FormatStyle::LK_Java: + return "Java"; + case FormatStyle::LK_JavaScript: + return "JavaScript"; + case FormatStyle::LK_Proto: + return "Proto"; + case FormatStyle::LK_TextProto: + return "TextProto"; + default: + return "Unknown"; + } +} + +} // end namespace format +} // end namespace clang + +namespace std { +template <> +struct is_error_code_enum<clang::format::ParseError> : std::true_type {}; +} + +#endif // LLVM_CLANG_FORMAT_FORMAT_H |