Clang format file.

This is a configuration file for clang-format, a code formatting tool, created by Ingmar Delsink. It specifies formatting rules for C++ code, including a tab width and indent width of 4, no tab characters, and C++11 standard compatibility. The file also enables alignment of consecutive assignments and sets pointer alignment to the left.

clang-format Made by: Ingmar Delsink https://ingmar.dels.ink See http://clang.llvm.org/docs/ClangFormatStyleOptions.html Tested with: clang-format version 3.7.1 General The style used for all options not specifically set in the configuration. This option is supported only in the clang-format configuration both within -style='{...}' and the .clang-format file . Possible values: LLVM A style complying with the LLVM coding standards Google A style complying with Google’s C++ style guide Chromium A style complying with Chromium’s style guide Mozilla A style complying with Mozilla’s style guide WebKit A style complying with WebKit’s style guide BasedOnStyle: TabWidth unsigned The number of columns used for tab stops. TabWidth: 4 IndentWidth unsigned The number of columns to use for indentation. IndentWidth: 4 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 Always in configuration: Always Use tabs whenever we need to fill whitespace that spans at least from one tab stop to the next one. UseTab: Never C++ 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++, ObjectiveC, ObjectiveC++. LK Java in configuration: Java Should be used for Java. LK JavaScript in configuration: JavaScript Should be used for JavaScript. 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. Language: Cpp Standard LanguageStandard Format compatible with this standard, e.g. use A<A<int instead of A<A<int 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<A<int instead of A<A<int . LS Auto in configuration: Auto Automatic detection based on the input. Standard: Cpp11 Pointer and reference alignment style. Possible values: Left, Right, Middle. PointerAlignment: Left AccessModifierOffset int The extra indent or outdent of access modifiers, e.g. public:. AccessModifierOffset: 0 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.: someLongFunction argument1, argument2 ; BAS DontAlign in configuration: DontAlign Don’t align, instead use ContinuationIndentWidth, e.g.: 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.: someLongFunction argument1, argument2 ; AlignAfterOpenBracket: false AlignConsecutiveAssignments bool If true, aligns consecutive assignments. This will align the assignment operators of consecutive lines. This will result in formattings like int aaaa = 12; int b = 23; int ccc = 23; AlignConsecutiveAssignments: true AlignEscapedNewlinesLeft bool If true, aligns escaped newlines as far left as possible. Otherwise puts them into the right-most column. AlignEscapedNewlinesLeft: true 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.: int aaa = bbbbbbbbbbbbbbb + ccccccccccccccc; AlignOperands: false AlignTrailingComments bool If true, aligns trailing comments. AlignTrailingComments: true AllowAllParametersOfDeclarationOnNextLine bool Allow putting all parameters of a function declaration onto the next line even if BinPackParameters is false. AllowAllParametersOfDeclarationOnNextLine: false AllowShortBlocksOnASingleLine bool Allows contracting simple braced statements to a single line. AllowShortBlocksOnASingleLine: false AllowShortCaseLabelsOnASingleLine bool If true, short case labels will be contracted to a single line. AllowShortCaseLabelsOnASingleLine: true 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. SFS Inline in configuration: Inline Only merge functions defined inside a class. Implies “empty”. SFS All in configuration: All Merge all functions fitting on a single line. AllowShortFunctionsOnASingleLine: false AllowShortIfStatementsOnASingleLine bool If true, if a return; can be put on a single line. AllowShortIfStatementsOnASingleLine: false AllowShortLoopsOnASingleLine bool If true, while true continue; can be put on a single line. AllowShortLoopsOnASingleLine: false 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. AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations bool If true, always break after the template<... of a template declaration. AlwaysBreakTemplateDeclarations: false BinPackArguments bool If false, a function call’s arguments will either be all on the same line or will have one line each. BinPackArguments: false 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. BinPackParameters: false 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. bool AfterControlStatement Wrap control statements if/for/while/switch/.. . bool AfterEnum Wrap enum definitions. bool AfterFunction Wrap function definitions. bool AfterNamespace Wrap namespace definitions. bool AfterObjCDeclaration Wrap ObjC definitions @autoreleasepool, interfaces, .. . bool AfterStruct Wrap struct definitions. bool AfterUnion Wrap union definitions. bool BeforeCatch Wrap before catch. bool BeforeElse Wrap before else. bool IndentBraces Indent the wrapped braces themselves. BraceWrapping: BreakAfterJavaFieldAnnotations bool Break after each annotation on a field in Java files. BreakAfterJavaFieldAnnotations: BreakBeforeBinaryOperators BinaryOperatorStyle The way to wrap binary operators. Possible values: BOS None in configuration: None Break after operators. BOS NonAssignment in configuration: NonAssignment Break before operators that aren’t assignments. BOS All in configuration: All Break before operators. BreakBeforeBinaryOperators: false BreakBeforeBraces BraceBreakingStyle The brace breaking style to use. Possible values: BS Attach in configuration: Attach Always attach braces to surrounding context. BS Linux in configuration: Linux Like Attach, but break before braces on function, namespace and class definitions. BS Mozilla in configuration: Mozilla Like Attach, but break before braces on enum, function, and record definitions. BS Stroustrup in configuration: Stroustrup Like Attach, but break before function definitions, catch, and else. BS Allman in configuration: Allman Always break before braces. 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. BS WebKit in configuration: WebKit Like Attach, but break before functions. BS Custom in configuration: Custom Configure each individual brace in BraceWrapping. BreakBeforeBraces: Attach BreakBeforeTernaryOperators bool If true, ternary operators will be placed after line breaks. BreakBeforeTernaryOperators: false BreakConstructorInitializersBeforeComma bool Always break constructor initializers before commas and align the commas with the colon. BreakConstructorInitializersBeforeComma: false BreakStringLiterals bool Allow breaking string literals when formatting. BreakStringLiterals: 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. ColumnLimit: 80 CommentPragmas std::string A regular expression that describes comments with special meaning, which should not be split into lines or otherwise changed. CommentPragmas: '' ConstructorInitializerAllOnOneLineOrOnePerLine bool If the constructor initializers don’t fit on a line, put each initializer on its own line. ConstructorInitializerAllOnOneLineOrOnePerLine: false ConstructorInitializerIndentWidth unsigned The number of characters to use for indentation of constructor initializer lists. ConstructorInitializerIndentWidth: 0 ContinuationIndentWidth unsigned Indent width for line continuations. ContinuationIndentWidth: 0 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. Cpp11BracedListStyle: false DerivePointerAlignment bool If true, analyze the formatted file for the most common alignment of & and \ . PointerAlignment is then used only as fallback. DerivePointerBinding: false DisableFormat bool Disables formatting completely. DisableFormat: 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. ExperimentalAutoDetectBinPacking: ForEachMacros std::vector<std::string A vector of macros that should be interpreted as foreach loops instead of as function calls. These are expected to be macros of the form: FOREACH <variable-declaration , ... <loop-body In the .clang-format configuration file, this can be configured like: ForEachMacros: 'RANGES FOR', 'FOREACH' For example: BOOST FOREACH. ForEachMacros: IncludeCategories std::vector<IncludeCategory 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: IncludeCategories: - Regex: '^" llvm|llvm-c|clang|clang-c /' Priority: 2 - Regex: '^ <|" gtest|isl|json / ' Priority: 3 - Regex: '.\ ' Priority: 1 IncludeCategories: 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. IndentCaseLabels: false IndentFunctionDeclarationAfterType bool If true, indent when breaking function declarations which are not also definitions after the type. IndentFunctionDeclarationAfterType: false IndentWrappedFunctionNames bool Indent if a function definition or declaration is wrapped after the type. IndentWrappedFunctionNames: KeepEmptyLinesAtTheStartOfBlocks bool If true, empty lines at the start of blocks are kept. KeepEmptyLinesAtTheStartOfBlocks: MacroBlockBegin std::string A regular expression matching macros that start a block. MacroBlockBegin: MacroBlockEnd std::string A regular expression matching macros that end a block. MacroBlockEnd: MaxEmptyLinesToKeep unsigned The maximum number of consecutive empty lines to keep. MaxEmptyLinesToKeep: 2 NamespaceIndentation NamespaceIndentationKind The indentation used for namespaces. Possible values: NI None in configuration: None Don’t indent in namespaces. NI Inner in configuration: Inner Indent only in inner namespaces nested in other namespaces . NI All in configuration: All Indent in all namespaces. NamespaceIndentation: None ObjCBlockIndentWidth unsigned The number of characters to use for indentation of ObjC blocks. ObjCBlockIndentWidth: ObjCSpaceAfterProperty bool Add a space after @property in Objective-C, i.e. use @property readonly instead of @property readonly . ObjCSpaceAfterProperty: true ObjCSpaceBeforeProtocolList bool Add a space in front of an Objective-C protocol list, i.e. use Foo <Protocol instead of Foo<Protocol . ObjCSpaceBeforeProtocolList: true PenaltyBreakBeforeFirstCallParameter unsigned The penalty for breaking a function call after call . PenaltyBreakBeforeFirstCallParameter: 100 PenaltyBreakComment unsigned The penalty for each line break introduced inside a comment. PenaltyBreakComment: 100 PenaltyBreakFirstLessLess unsigned The penalty for breaking before the first <<. PenaltyBreakFirstLessLess: 0 PenaltyBreakString unsigned The penalty for each line break introduced inside a string literal. PenaltyBreakString: 100 PenaltyExcessCharacter unsigned The penalty for each character outside of the column limit. PenaltyExcessCharacter: 1 PenaltyReturnTypeOnItsOwnLine unsigned Penalty for putting the return type of a function onto its own line. PenaltyReturnTypeOnItsOwnLine: 20 PointerAlignment PointerAlignmentStyle Pointer and reference alignment style. Possible values: PAS Left in configuration: Left Align pointer to the left. PAS Right in configuration: Right Align pointer to the right. PAS Middle in configuration: Middle Align pointer in the middle. PointerAlignment: ReflowComments bool If true, clang-format will attempt to re-flow comments. ReflowComments: true from v3.9 SortIncludes bool If true, clang-format will sort includes. SortIncludes: false from v3.9 SpaceAfterCStyleCast bool If true, a space may be inserted after C style casts. SpaceAfterCStyleCast: false SpaceBeforeAssignmentOperators bool If false, spaces will be removed before assignment operators. SpaceBeforeAssignmentOperators: true 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. SBPO ControlStatements in configuration: ControlStatements Put a space before opening parentheses only after control statement keywords for/if/while... . 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. SpaceBeforeParens: Always SpaceInEmptyParentheses bool If true, spaces may be inserted into . SpaceInEmptyParentheses: false 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. SpacesBeforeTrailingComments: 1 SpacesInAngles bool If true, spaces will be inserted after < and before in template argument lists. SpacesInAngles: false SpacesInCStyleCastParentheses bool If true, spaces may be inserted into C style casts. SpacesInCStyleCastParentheses: false SpacesInContainerLiterals bool If true, spaces are inserted inside container literals e.g. ObjC and Javascript array and dict literals . SpacesInContainerLiterals: false SpacesInParentheses bool If true, spaces will be inserted after and before . SpacesInParentheses: false SpacesInSquareBrackets bool If true, spaces will be inserted after and before . SpacesInSquareBrackets: false