Skip to content
Snippets Groups Projects
.uncrustify.cfg 60.7 KiB
Newer Older
# Uncrustify 0.60

#
# General options
#

# The type of line endings
newlines = lf # auto / lf / crlf / cr

# The original size of tabs in the input
Jan Trávníček's avatar
Jan Trávníček committed
 input_tab_size = 4 # number

# The size of tabs in the output (only used if align_with_tabs=true)
Jan Trávníček's avatar
Jan Trávníček committed
 output_tab_size = 4 # number

# The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn)
 string_escape_char = 92 # number

# Alternate string escape char for Pawn. Only works right before the quote char.
 string_escape_char2 = 0 # number

# Allow interpreting '>=' and '>>=' as part of a template in 'void f(list<list<B>>=val);'.
# If true (default), 'assert(x<0 && y>=3)' will be broken.
# Improvements to template detection may make this option obsolete.
Jan Trávníček's avatar
Jan Trávníček committed
 tok_split_gte = true # false / true

# Control what to do with the UTF-8 BOM (recommend 'remove')
 utf8_bom = remove # ignore / add / remove / force

# If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8
 utf8_byte = false # false / true

# Force the output encoding to UTF-8
 utf8_force = false # false / true

#
# Indenting
#

# The number of columns to indent per level.
# Usually 2, 3, 4, or 8.
Jan Trávníček's avatar
Jan Trávníček committed
 indent_columns = 4 # number

# The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents.
# For FreeBSD, this is set to 4. Negative value is absolute and not increased for each ( level
 indent_continue = 0 # number

# How to use tabs when indenting code
# 0 =spaces only
# 1 =indent with tabs to brace level, align with spaces
# 2 =indent and align with tabs, using spaces when not on a tabstop
Jan Trávníček's avatar
Jan Trávníček committed
 indent_with_tabs = 2 # number

# Comments that are not a brace level are indented with tabs on a tabstop.
# Requires indent_with_tabs=2. If false, will use spaces.
 indent_cmt_with_tabs = false # false / true

# Whether to indent strings broken by '\' so that they line up
 indent_align_string = true # false / true

# The number of spaces to indent multi-line XML strings.
# Requires indent_align_string=True
 indent_xml_string = 0 # number

# Spaces to indent '{' from level
 indent_brace = 0 # number

# Whether braces are indented to the body level
 indent_braces = false # false / true

# Disabled indenting function braces if indent_braces is true
 indent_braces_no_func = false # false / true

# Disabled indenting class braces if indent_braces is true
 indent_braces_no_class = false # false / true

# Disabled indenting struct braces if indent_braces is true
 indent_braces_no_struct = false # false / true

# Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
 indent_brace_parent = false # false / true

# Whether the 'namespace' body is indented
 indent_namespace = false # false / true

# The number of spaces to indent a namespace block
 indent_namespace_level = 0 # number

# If the body of the namespace is longer than this number, it won't be indented.
# Requires indent_namespace=true. Default=0 (no limit)
 indent_namespace_limit = 0 # number

# Whether the 'extern "C"' body is indented
 indent_extern = false # false / true

# Whether the 'class' body is indented
 indent_class = true # false / true

# Whether to indent the stuff after a leading class colon
 indent_class_colon = true # false / true

# Virtual indent from the ':' for member initializers. Default is 2
 indent_ctor_init_leading = 2 # number

# Additional indenting for constructor initializer list
 indent_ctor_init = 0 # number

# False =treat 'else\nif' as 'else if' for indenting purposes
# True =indent the 'if' one level
 indent_else_if = false # false / true

# Amount to indent variable declarations after a open brace. neg=relative, pos=absolute
 indent_var_def_blk = 0 # number

# Indent continued variable declarations instead of aligning.
 indent_var_def_cont = false # false / true

# True : force indentation of function definition to start in column 1
# False : use the default behavior
 indent_func_def_force_col1 = false # false / true

# True : indent continued function call parameters one indent level
# False : align parameters under the open paren
 indent_func_call_param = false # false / true

# Same as indent_func_call_param, but for function defs
 indent_func_def_param = false # false / true

# Same as indent_func_call_param, but for function protos
 indent_func_proto_param = false # false / true

# Same as indent_func_call_param, but for class declarations
 indent_func_class_param = false # false / true

# Same as indent_func_call_param, but for class variable constructors
 indent_func_ctor_var_param = false # false / true

# Same as indent_func_call_param, but for templates
 indent_template_param = false # false / true

# Double the indent for indent_func_xxx_param options
 indent_func_param_double = false # false / true

# Indentation column for standalone 'const' function decl/proto qualifier
 indent_func_const = 0 # number

# Indentation column for standalone 'throw' function decl/proto qualifier
 indent_func_throw = 0 # number

# The number of spaces to indent a continued '->' or '.'
# Usually set to 0, 1, or indent_columns.
 indent_member = 3 # number

# Spaces to indent single line (' // ') comments on lines before code
 indent_sing_line_comments = 1 # number

# If set, will indent trailing single line (' // ') comments relative
# to the code instead of trying to keep the same absolute column
 indent_relative_single_line_comments = true # false / true

# Spaces to indent 'case' from 'switch'
# Usually 0 or indent_columns.
 indent_switch_case = 0 # number

# Spaces to shift the 'case' line, without affecting any other lines
# Usually 0.
 indent_case_shift = 0 # number

# Spaces to indent '{' from 'case'.
# By default, the brace will appear under the 'c' in case.
# Usually set to 0 or indent_columns.
 indent_case_brace = 3 # number

# Whether to indent comments found in first column
 indent_col1_comment = true # false / true

# How to indent goto labels
# > 0 : absolute column where 1 is the leftmost column
# <= 0 : subtract from brace indent
 indent_label = 1 # number

# Same as indent_label, but for access specifiers that are followed by a colon
 indent_access_spec = -4 # number

# Indent the code after an access specifier by one level.
# If set, this option forces 'indent_access_spec=0'
 indent_access_spec_body = false # false / true

# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
 indent_paren_nl = false # false / true

# Controls the indent of a close paren after a newline.
# 0 : Indent to body level
# 1 : Align under the open paren
# 2 : Indent to the brace level
 indent_paren_close = 0 # number

# Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
 indent_comma_paren = false # false / true

# Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
 indent_bool_paren = false # false / true

# If 'indent_bool_paren' is true, controls the indent of the first expression. If TRUE, aligns the first expression to the following ones
 indent_first_bool_expr = false # false / true

# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
 indent_square_nl = false # false / true

# Don 't change the relative indent of ESQL/C 'EXEC SQL' bodies
 indent_preserve_sql = false # false / true

# Align continued statements at the '='. Default=True
# If FALSE or the '=' is followed by a newline, the next line is indent one tab.
 indent_align_assign = true # false / true

# Indent OC blocks at brace level instead of usual rules.
 indent_oc_block = false # false / true

# Indent OC blocks in a message relative to the parameter name.
# 0 =use indent_oc_block rules, 1+=spaces to indent
 indent_oc_block_msg = 0 # number

# Minimum indent for subsequent parameters
 indent_oc_msg_colon = 0 # number

#
# Spacing options
#

# Add or remove space around arithmetic operator '+', '-', '/', '*', etc
 sp_arith = force # ignore / add / remove / force

# Add or remove space around assignment operator '=', '+=', etc
 sp_assign = force # ignore / add / remove / force

# Add or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign
 sp_cpp_lambda_assign = remove # ignore / add / remove / force

# Add or remove space after the capture specification in C++11 lambda.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_cpp_lambda_paren = force # ignore / add / remove / force

# Add or remove space around assignment operator '=' in a prototype
Jan Trávníček's avatar
Jan Trávníček committed
 sp_assign_default = force # ignore / add / remove / force

# Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_assign = force # ignore / add / remove / force

# Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_assign = force # ignore / add / remove / force

# Add or remove space around assignment '=' in enum
Jan Trávníček's avatar
Jan Trávníček committed
 sp_enum_assign = force # ignore / add / remove / force

# Add or remove space before assignment '=' in enum. Overrides sp_enum_assign.
 sp_enum_before_assign = ignore # ignore / add / remove / force

# Add or remove space after assignment '=' in enum. Overrides sp_enum_assign.
 sp_enum_after_assign = ignore # ignore / add / remove / force

# Add or remove space around preprocessor '##' concatenation operator. Default=Add
Jan Trávníček's avatar
Jan Trávníček committed
 sp_pp_concat = force # ignore / add / remove / force

# Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator. Default=Add
Jan Trávníček's avatar
Jan Trávníček committed
 sp_pp_stringify = force # ignore / add / remove / force

# Add or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'.
 sp_before_pp_stringify = ignore # ignore / add / remove / force

# Add or remove space around boolean operators '&&' and '||'
 sp_bool = force # ignore / add / remove / force

# Add or remove space around compare operator '<', '>', '==', etc
 sp_compare = force # ignore / add / remove / force

# Add or remove space inside '(' and ')'
 sp_inside_paren = force # ignore / add / remove / force

# Add or remove space between nested parens: '((' vs ') )'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_paren_paren = force # ignore / add / remove / force

# Add or remove space between back-to-back parens: ')(' vs ') ('
Jan Trávníček's avatar
Jan Trávníček committed
 sp_cparen_oparen = force # ignore / add / remove / force

# Whether to balance spaces inside nested parens
 sp_balance_nested_parens = false # false / true

# Add or remove space between ')' and '{'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_paren_brace = force # ignore / add / remove / force

# Add or remove space before pointer star '*'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_ptr_star = force # ignore / add / remove / force

# Add or remove space before pointer star '*' that isn't followed by a variable name
# If set to 'ignore', sp_before_ptr_star is used instead.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_unnamed_ptr_star = force # ignore / add / remove / force

# Add or remove space between pointer stars '*'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_between_ptr_star = force # ignore / add / remove / force

# Add or remove space after pointer star '*', if followed by a word.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_ptr_star = force # ignore / add / remove / force

# Add or remove space after a pointer star '*', if followed by a func proto/def.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_ptr_star_func = force # ignore / add / remove / force

# Add or remove space after a pointer star '*', if followed by an open paren (function types).
Jan Trávníček's avatar
Jan Trávníček committed
 sp_ptr_star_paren = force # ignore / add / remove / force

# Add or remove space before a pointer star '*', if followed by a func proto/def.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_ptr_star_func = force # ignore / add / remove / force

# Add or remove space before a reference sign '&'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_byref = force # ignore / add / remove / force

# Add or remove space before a reference sign '&' that isn't followed by a variable name
# If set to 'ignore', sp_before_byref is used instead.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_unnamed_byref = force # ignore / add / remove / force

# Add or remove space after reference sign '&', if followed by a word.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_byref = force # ignore / add / remove / force

# Add or remove space after a reference sign '&', if followed by a func proto/def.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_byref_func = force # ignore / add / remove / force

# Add or remove space before a reference sign '&', if followed by a func proto/def.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_byref_func = force # ignore / add / remove / force

# Add or remove space between type and word. Default=Force
 sp_after_type = force # ignore / add / remove / force

# Add or remove space before the paren in the D constructs 'template Foo(' and 'class Foo('.
 sp_before_template_paren = ignore # ignore / add / remove / force

# Add or remove space in 'template <' vs 'template<'.
# If set to ignore, sp_before_angle is used.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_template_angle = force # ignore / add / remove / force

# Add or remove space before '<>'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_angle = force # ignore / add / remove / force

# Add or remove space inside '<' and '>'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_inside_angle = force # ignore / add / remove / force

# Add or remove space after '<>'
 sp_after_angle = force # ignore / add / remove / force

# Add or remove space between '<>' and '(' as found in 'new List<byte>();'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_angle_paren = force # ignore / add / remove / force

# Add or remove space between '<>' and a word as in 'List<byte> m;'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_angle_word = force # ignore / add / remove / force

# Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add
Jan Trávníček's avatar
Jan Trávníček committed
 sp_angle_shift = force # ignore / add / remove / force

# Permit removal of the space between '>>' in 'foo<bar<int> >' (C++11 only). Default=False
# sp_angle_shift cannot remove the space without this option.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_permit_cpp11_shift = true # false / true

# Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
 sp_before_sparen = force # ignore / add / remove / force

# Add or remove space inside if-condition '(' and ')'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_inside_sparen = force # ignore / add / remove / force

# Add or remove space before if-condition ')'. Overrides sp_inside_sparen.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_inside_sparen_close = force # ignore / add / remove / force

# Add or remove space before if-condition '('. Overrides sp_inside_sparen.
 sp_inside_sparen_open = ignore # ignore / add / remove / force

# Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
 sp_after_sparen = force # ignore / add / remove / force

# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_sparen_brace = force # ignore / add / remove / force

# Add or remove space between 'invariant' and '(' in the D language.
 sp_invariant_paren = ignore # ignore / add / remove / force

# Add or remove space after the ')' in 'invariant (C) c' in the D language.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_invariant_paren = force # ignore / add / remove / force

# Add or remove space before empty statement ';' on 'if', 'for' and 'while'
 sp_special_semi = ignore # ignore / add / remove / force

# Add or remove space before ';'. Default=Remove
 sp_before_semi = remove # ignore / add / remove / force

# Add or remove space before ';' in non-empty 'for' statements
 sp_before_semi_for = ignore # ignore / add / remove / force

# Add or remove space before a semicolon of an empty part of a for statement.
 sp_before_semi_for_empty = force # ignore / add / remove / force

# Add or remove space after ';', except when followed by a comment. Default=Add
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_semi = force # ignore / add / remove / force

# Add or remove space after ';' in non-empty 'for' statements. Default=Force
 sp_after_semi_for = force # ignore / add / remove / force

# Add or remove space after the final semicolon of an empty part of a for statement: for ( ; ; <here> ).
 sp_after_semi_for_empty = ignore # ignore / add / remove / force

# Add or remove space before '[' (except '[]')
 sp_before_square = ignore # ignore / add / remove / force

# Add or remove space before '[]'
 sp_before_squares = ignore # ignore / add / remove / force

# Add or remove space inside a non-empty '[' and ']'
 sp_inside_square = remove # ignore / add / remove / force

# Add or remove space after ','
 sp_after_comma = force # ignore / add / remove / force

# Add or remove space before ','
 sp_before_comma = remove # ignore / add / remove / force

# Add or remove space between an open paren and comma: '(,' vs '( ,'
 sp_paren_comma = force # ignore / add / remove / force

# Add or remove space before the variadic '...' when preceded by a non-punctuator
 sp_before_ellipsis = ignore # ignore / add / remove / force

# Add or remove space after class ':'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_class_colon = force # ignore / add / remove / force

# Add or remove space before class ':'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_class_colon = force # ignore / add / remove / force

# Add or remove space before case ':'. Default=Remove
 sp_before_case_colon = remove # ignore / add / remove / force

# Add or remove space between 'operator' and operator sign
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_operator = force # ignore / add / remove / force

# Add or remove space between the operator symbol and the open paren, as in 'operator ++('
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_operator_sym = remove # ignore / add / remove / force

# Add or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_cast = force # ignore / add / remove / force

# Add or remove spaces inside cast parens
Jan Trávníček's avatar
Jan Trávníček committed
 sp_inside_paren_cast = force # ignore / add / remove / force

# Add or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_cpp_cast_paren = force # ignore / add / remove / force

# Add or remove space between 'sizeof' and '('
Jan Trávníček's avatar
Jan Trávníček committed
 sp_sizeof_paren = force # ignore / add / remove / force

# Add or remove space after the tag keyword (Pawn)
 sp_after_tag = ignore # ignore / add / remove / force

# Add or remove space inside enum '{' and '}'
 sp_inside_braces_enum = force # ignore / add / remove / force

# Add or remove space inside struct/union '{' and '}'
 sp_inside_braces_struct = force # ignore / add / remove / force

# Add or remove space inside '{' and '}'
 sp_inside_braces = force # ignore / add / remove / force

# Add or remove space inside '{}'
 sp_inside_braces_empty = force # ignore / add / remove / force

# Add or remove space between return type and function name
# A minimum of 1 is forced except for pointer return types.
 sp_type_func = force # ignore / add / remove / force

# Add or remove space between function name and '(' on function declaration
 sp_func_proto_paren = force # ignore / add / remove / force

# Add or remove space between function name and '(' on function definition
 sp_func_def_paren = force # ignore / add / remove / force

# Add or remove space inside empty function '()'
 sp_inside_fparens = force # ignore / add / remove / force

# Add or remove space inside function '(' and ')'
 sp_inside_fparen = force # ignore / add / remove / force

# Add or remove space inside the first parens in the function type: 'void (*x)(...)'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_inside_tparen = force # ignore / add / remove / force

# Add or remove between the parens in the function type: 'void (*x)(...)'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_after_tparen_close = force # ignore / add / remove / force

# Add or remove space between ']' and '(' when part of a function call.
 sp_square_fparen = ignore # ignore / add / remove / force

# Add or remove space between ')' and '{' of function
 sp_fparen_brace = force # ignore / add / remove / force

# Add or remove space between function name and '(' on function calls
 sp_func_call_paren = force # ignore / add / remove / force

# Add or remove space between function name and '()' on function calls without parameters.
# If set to 'ignore' (the default), sp_func_call_paren is used.
 sp_func_call_paren_empty = ignore # ignore / add / remove / force

# Add or remove space between the user function name and '(' on function calls
# You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
 sp_func_call_user_paren = ignore # ignore / add / remove / force

# Add or remove space between a constructor/destructor and the open paren
Jan Trávníček's avatar
Jan Trávníček committed
 sp_func_class_paren = force # ignore / add / remove / force

# Add or remove space between 'return' and '('
Jan Trávníček's avatar
Jan Trávníček committed
 sp_return_paren = force # ignore / add / remove / force

# Add or remove space between '__attribute__' and '('
Jan Trávníček's avatar
Jan Trávníček committed
 sp_attribute_paren = force # ignore / add / remove / force

# Add or remove space between 'defined' and '(' in '#if defined (FOO)'
 sp_defined_paren = ignore # ignore / add / remove / force

# Add or remove space between 'throw' and '(' in 'throw (something)'
Jan Trávníček's avatar
Jan Trávníček committed
 sp_throw_paren = force # ignore / add / remove / force

# Add or remove space between 'throw' and anything other than '(' as in '@throw [...];'
 sp_after_throw = ignore # ignore / add / remove / force

# Add or remove space between 'catch' and '(' in 'catch (something) { }'
# If set to ignore, sp_before_sparen is used.
Jan Trávníček's avatar
Jan Trávníček committed
 sp_catch_paren = force # ignore / add / remove / force

# Add or remove space between 'version' and '(' in 'version (something) { }' (D language)
# If set to ignore, sp_before_sparen is used.
 sp_version_paren = ignore # ignore / add / remove / force

# Add or remove space between 'scope' and '(' in 'scope (something) { }' (D language)
# If set to ignore, sp_before_sparen is used.
 sp_scope_paren = ignore # ignore / add / remove / force

# Add or remove space between macro and value
 sp_macro = ignore # ignore / add / remove / force

# Add or remove space between macro function ')' and value
 sp_macro_func = ignore # ignore / add / remove / force

# Add or remove space between 'else' and '{' if on the same line
 sp_else_brace = force # ignore / add / remove / force

# Add or remove space between '}' and 'else' if on the same line
 sp_brace_else = force # ignore / add / remove / force

# Add or remove space between '}' and the name of a typedef on the same line
 sp_brace_typedef = force # ignore / add / remove / force

# Add or remove space between 'catch' and '{' if on the same line
 sp_catch_brace = force # ignore / add / remove / force

# Add or remove space between '}' and 'catch' if on the same line
 sp_brace_catch = force # ignore / add / remove / force

# Add or remove space between 'finally' and '{' if on the same line
 sp_finally_brace = force # ignore / add / remove / force

# Add or remove space between '}' and 'finally' if on the same line
 sp_brace_finally = force # ignore / add / remove / force

# Add or remove space between 'try' and '{' if on the same line
 sp_try_brace = force # ignore / add / remove / force

# Add or remove space between get/set and '{' if on the same line
 sp_getset_brace = force # ignore / add / remove / force

# Add or remove space between a variable and '{' for C++ uniform initialization
Jan Trávníček's avatar
Jan Trávníček committed
 sp_word_brace = force # ignore / add / remove / force

# Add or remove space between a variable and '{' for a namespace
Jan Trávníček's avatar
Jan Trávníček committed
 sp_word_brace_ns = force # ignore / add / remove / force

# Add or remove space before the '::' operator
 sp_before_dc = remove # ignore / add / remove / force

# Add or remove space after the '::' operator
 sp_after_dc = remove # ignore / add / remove / force

# Add or remove around the D named array initializer ':' operator
 sp_d_array_colon = ignore # ignore / add / remove / force

# Add or remove space after the '!' (not) operator. Default=Remove
 sp_not = remove # ignore / add / remove / force

# Add or remove space after the '~' (invert) operator. Default=Remove
 sp_inv = remove # ignore / add / remove / force

# Add or remove space after the '&' (address-of) operator. Default=Remove
# This does not affect the spacing after a '&' that is part of a type.
 sp_addr = force # ignore / add / remove / force

# Add or remove space around the '.' or '->' operators. Default=Remove
 sp_member = remove # ignore / add / remove / force

# Add or remove space after the '*' (dereference) operator. Default=Remove
# This does not affect the spacing after a '*' that is part of a type.
 sp_deref = force # ignore / add / remove / force

# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove
 sp_sign = remove # ignore / add / remove / force

# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove
 sp_incdec = remove # ignore / add / remove / force

# Add or remove space before a backslash-newline at the end of a line. Default=Add
Jan Trávníček's avatar
Jan Trávníček committed
 sp_before_nl_cont = force # ignore / add / remove / force

# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
 sp_after_oc_scope = ignore # ignore / add / remove / force

# Add or remove space after the colon in message specs
# '-(int) f:(int) x;' vs '-(int) f: (int) x;'
 sp_after_oc_colon = ignore # ignore / add / remove / force

# Add or remove space before the colon in message specs
# '-(int) f: (int) x;' vs '-(int) f : (int) x;'
 sp_before_oc_colon = ignore # ignore / add / remove / force

# Add or remove space after the colon in immutable dictionary expression
# 'NSDictionary *test = @{@"foo" :@"bar"};'
 sp_after_oc_dict_colon = ignore # ignore / add / remove / force

# Add or remove space before the colon in immutable dictionary expression
# 'NSDictionary *test = @{@"foo" :@"bar"};'
 sp_before_oc_dict_colon = ignore # ignore / add / remove / force

# Add or remove space after the colon in message specs
# '[object setValue:1];' vs '[object setValue: 1];'
 sp_after_send_oc_colon = ignore # ignore / add / remove / force

# Add or remove space before the colon in message specs
# '[object setValue:1];' vs '[object setValue :1];'
 sp_before_send_oc_colon = ignore # ignore / add / remove / force

# Add or remove space after the (type) in message specs
# '-(int)f: (int) x;' vs '-(int)f: (int)x;'
 sp_after_oc_type = ignore # ignore / add / remove / force

# Add or remove space after the first (type) in message specs
# '-(int) f:(int)x;' vs '-(int)f:(int)x;'
 sp_after_oc_return_type = ignore # ignore / add / remove / force

# Add or remove space between '@selector' and '('
# '@selector(msgName)' vs '@selector (msgName)'
# Also applies to @protocol() constructs
 sp_after_oc_at_sel = ignore # ignore / add / remove / force

# Add or remove space between '@selector(x)' and the following word
# '@selector(foo) a:' vs '@selector(foo)a:'
 sp_after_oc_at_sel_parens = ignore # ignore / add / remove / force

# Add or remove space inside '@selector' parens
# '@selector(foo)' vs '@selector( foo )'
# Also applies to @protocol() constructs
 sp_inside_oc_at_sel_parens = ignore # ignore / add / remove / force

# Add or remove space before a block pointer caret
# '^int (int arg){...}' vs. ' ^int (int arg){...}'
 sp_before_oc_block_caret = ignore # ignore / add / remove / force

# Add or remove space after a block pointer caret
# '^int (int arg){...}' vs. '^ int (int arg){...}'
 sp_after_oc_block_caret = ignore # ignore / add / remove / force

# Add or remove space between the receiver and selector in a message.
# '[receiver selector ...]'
 sp_after_oc_msg_receiver = ignore # ignore / add / remove / force

# Add or remove space after @property.
 sp_after_oc_property = ignore # ignore / add / remove / force

# Add or remove space around the ':' in 'b ? t : f'
 sp_cond_colon = force # ignore / add / remove / force

# Add or remove space around the '?' in 'b ? t : f'
 sp_cond_question = force # ignore / add / remove / force

# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
 sp_case_label = ignore # ignore / add / remove / force

# Control the space around the D '..' operator.
 sp_range = ignore # ignore / add / remove / force

# Control the spacing after ':' in 'for (TYPE VAR : EXPR)' (Java)
 sp_after_for_colon = ignore # ignore / add / remove / force

# Control the spacing before ':' in 'for (TYPE VAR : EXPR)' (Java)
 sp_before_for_colon = ignore # ignore / add / remove / force

# Control the spacing in 'extern (C)' (D)
 sp_extern_paren = ignore # ignore / add / remove / force

# Control the space after the opening of a C++ comment ' // A' vs '//A'
 sp_cmt_cpp_start = force # ignore / add / remove / force

# Controls the spaces between #else or #endif and a trailing comment
 sp_endif_cmt = ignore # ignore / add / remove / force

# Controls the spaces after 'new', 'delete', and 'delete[]'
 sp_after_new = force # ignore / add / remove / force

# Controls the spaces before a trailing or embedded comment
 sp_before_tr_emb_cmt = ignore # ignore / add / remove / force

# Number of spaces before a trailing or embedded comment
 sp_num_before_tr_emb_cmt = 1 # number

# Control space between a Java annotation and the open paren.
 sp_annotation_paren = ignore # ignore / add / remove / force

#
# Code alignment (not left column spaces/tabs)
#

# Whether to keep non-indenting tabs
Jan Trávníček's avatar
Jan Trávníček committed
 align_keep_tabs = true # false / true

# Whether to use tabs for aligning
Jan Trávníček's avatar
Jan Trávníček committed
 align_with_tabs = true # false / true

# Whether to bump out to the next tab when aligning
 align_on_tabstop = false # false / true

# Whether to left-align numbers
Jan Trávníček's avatar
Jan Trávníček committed
 align_number_left = false # false / true

# Whether to keep whitespace not required for alignment.
 align_keep_extra_space = false # false / true

# Align variable definitions in prototypes and functions
Jan Trávníček's avatar
Jan Trávníček committed
 align_func_params = false # false / true

# Align parameters in single-line functions that have the same name.
# The function names must already be aligned with each other.
 align_same_func_call_params = false # false / true

# The span for aligning variable definitions (0=don't align)
Jan Trávníček's avatar
Jan Trávníček committed
 align_var_def_span = 0 # number

# How to align the star in variable definitions.
# 0 =Part of the type 'void * foo;'
# 1 =Part of the variable 'void *foo;'
# 2 =Dangling 'void *foo;'
 align_var_def_star_style = 0 # number

# How to align the '&' in variable definitions.
# 0 =Part of the type
# 1 =Part of the variable
# 2 =Dangling
 align_var_def_amp_style = 0 # number

# The threshold for aligning variable definitions (0=no limit)
Jan Trávníček's avatar
Jan Trávníček committed
 align_var_def_thresh = 1 # number

# The gap for aligning variable definitions
 align_var_def_gap = 0 # number

# Whether to align the colon in struct bit fields
Jan Trávníček's avatar
Jan Trávníček committed
 align_var_def_colon = false # false / true

# Whether to align any attribute after the variable name
 align_var_def_attribute = false # false / true

# Whether to align inline struct/enum/union variable definitions
Jan Trávníček's avatar
Jan Trávníček committed
 align_var_def_inline = false # false / true

# The span for aligning on '=' in assignments (0=don't align)
 align_assign_span = 0 # number

# The threshold for aligning on '=' in assignments (0=no limit)
Jan Trávníček's avatar
Jan Trávníček committed
 align_assign_thresh = 1 # number

# The span for aligning on '=' in enums (0=don't align)
Jan Trávníček's avatar
Jan Trávníček committed
 align_enum_equ_span = 1 # number

# The threshold for aligning on '=' in enums (0=no limit)
 align_enum_equ_thresh = 0 # number

# The span for aligning struct/union (0=don't align)
Jan Trávníček's avatar
Jan Trávníček committed
 align_var_struct_span = 1 # number

# The threshold for aligning struct/union member definitions (0=no limit)
 align_var_struct_thresh = 0 # number

# The gap for aligning struct/union member definitions
 align_var_struct_gap = 0 # number

# The span for aligning struct initializer values (0=don't align)
Jan Trávníček's avatar
Jan Trávníček committed
 align_struct_init_span = 0 # number

# The minimum space between the type and the synonym of a typedef
 align_typedef_gap = 3 # number

# The span for aligning single-line typedefs (0=don't align)
Jan Trávníček's avatar
Jan Trávníček committed
 align_typedef_span = 0 # number

# How to align typedef'd functions with other typedefs
# 0 : Don't mix them at all
# 1 : align the open paren with the types
# 2 : align the function type name with the other type names
 align_typedef_func = 0 # number

# Controls the positioning of the '*' in typedefs. Just try it.
# 0 : Align on typedef type, ignore '*'
# 1 : The '*' is part of type name: typedef int *pint;
# 2 : The '*' is part of the type, but dangling: typedef int *pint;
 align_typedef_star_style = 0 # number

# Controls the positioning of the '&' in typedefs. Just try it.
# 0 : Align on typedef type, ignore '&'
# 1 : The '&' is part of type name: typedef int &pint;
# 2 : The '&' is part of the type, but dangling: typedef int &pint;
 align_typedef_amp_style = 0 # number

# The span for aligning comments that end lines (0=don't align)
 align_right_cmt_span = 0 # number

# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
 align_right_cmt_mix = false # false / true

# If a trailing comment is more than this number of columns away from the text it follows,
# it will qualify for being aligned. This has to be > 0 to do anything.
 align_right_cmt_gap = 0 # number

# Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore)
 align_right_cmt_at_col = 0 # number

# The span for aligning function prototypes (0=don't align)
 align_func_proto_span = 0 # number

# Minimum gap between the return type and the function name.
 align_func_proto_gap = 0 # number

# Align function protos on the 'operator' keyword instead of what follows
 align_on_operator = false # false / true

# Whether to mix aligning prototype and variable declarations.
# If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.
 align_mix_var_proto = false # false / true

# Align single-line functions with function prototypes, uses align_func_proto_span
 align_single_line_func = false # false / true

# Aligning the open brace of single-line functions.
# Requires align_single_line_func=true, uses align_func_proto_span
 align_single_line_brace = false # false / true

# Gap for align_single_line_brace.
 align_single_line_brace_gap = 0 # number

# The span for aligning ObjC msg spec (0=don't align)
 align_oc_msg_spec_span = 0 # number

# Whether to align macros wrapped with a backslash and a newline.
# This will not work right if the macro contains a multi-line comment.
 align_nl_cont = true # false / true

# # Align macro functions and variables together
 align_pp_define_together = false # false / true

# The minimum space between label and value of a preprocessor define
 align_pp_define_gap = 4 # number

# The span for aligning on '#define' bodies (0=don't align)
 align_pp_define_span = 3 # number

# Align lines that start with '<<' with previous '<<'. Default=true
 align_left_shift = true # false / true

# Span for aligning parameters in an Obj-C message call on the ':' (0=don't align)
 align_oc_msg_colon_span = 0 # number

# If true, always align with the first parameter, even if it is too short.
 align_oc_msg_colon_first = false # false / true

# Aligning parameters in an Obj-C '+' or '-' declaration on the ':'
 align_oc_decl_colon = false # false / true

#
# Newline adding and removing options
#

# Whether to collapse empty blocks between '{' and '}'
 nl_collapse_empty_body = false # false / true

# Don 't split one-line braced assignments - 'foo_t f = { 1, 2 };'
 nl_assign_leave_one_liners = true # false / true

# Don 't split one-line braced statements inside a class xx { } body
 nl_class_leave_one_liners = true # false / true

# Don 't split one-line enums: 'enum foo { BAR = 15 };'
 nl_enum_leave_one_liners = false # false / true

# Don 't split one-line get or set functions
 nl_getset_leave_one_liners = false # false / true

# Don 't split one-line function definitions - 'int foo() { return 0; }'
 nl_func_leave_one_liners = false # false / true

# Don 't split one-line C++11 lambdas - '[]() { return 0; }'
 nl_cpp_lambda_leave_one_liners = false # false / true

# Don 't split one-line if/else statements - 'if(a) b++;'
 nl_if_leave_one_liners = false # false / true

# Don 't split one-line OC messages
 nl_oc_msg_leave_one_liner = false # false / true

# Add or remove newlines at the start of the file
 nl_start_of_file = remove # ignore / add / remove / force

# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
 nl_start_of_file_min = 0 # number

# Add or remove newline at the end of the file
 nl_end_of_file = force # ignore / add / remove / force

# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
 nl_end_of_file_min = 1 # number

# Add or remove newline between '=' and '{'
 nl_assign_brace = force # ignore / add / remove / force

# Add or remove newline between '=' and '[' (D only)
 nl_assign_square = ignore # ignore / add / remove / force

# Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
 nl_after_square_assign = ignore # ignore / add / remove / force

# The number of blank lines after a block of variable definitions at the top of a function body
# 0 = No change (default)
 nl_func_var_def_blk = 1 # number

# The number of newlines before a block of typedefs
# 0 = No change (default)
 nl_typedef_blk_start = 0 # number

# The number of newlines after a block of typedefs
# 0 = No change (default)
 nl_typedef_blk_end = 0 # number

# The maximum consecutive newlines within a block of typedefs
# 0 = No change (default)
 nl_typedef_blk_in = 0 # number

# The number of newlines before a block of variable definitions not at the top of a function body
# 0 = No change (default)
 nl_var_def_blk_start = 0 # number

# The number of newlines after a block of variable definitions not at the top of a function body
# 0 = No change (default)
 nl_var_def_blk_end = 0 # number

# The maximum consecutive newlines within a block of variable definitions
# 0 = No change (default)
Jan Trávníček's avatar
Jan Trávníček committed
 nl_var_def_blk_in = 2 # number

# Add or remove newline between a function call's ')' and '{', as in:
# list_for_each (item, &list) { }
 nl_fcall_brace = remove # ignore / add / remove / force

# Add or remove newline between 'enum' and '{'
 nl_enum_brace = remove # ignore / add / remove / force

# Add or remove newline between 'struct and '{'
 nl_struct_brace = remove # ignore / add / remove / force

# Add or remove newline between 'union' and '{'
 nl_union_brace = remove # ignore / add / remove / force

# Add or remove newline between 'if' and '{'
 nl_if_brace = remove # ignore / add / remove / force

# Add or remove newline between '}' and 'else'
 nl_brace_else = remove # ignore / add / remove / force

# Add or remove newline between 'else if' and '{'
# If set to ignore, nl_if_brace is used instead
 nl_elseif_brace = ignore # ignore / add / remove / force

# Add or remove newline between 'else' and '{'
 nl_else_brace = remove # ignore / add / remove / force

# Add or remove newline between 'else' and 'if'
 nl_else_if = remove # ignore / add / remove / force

# Add or remove newline between '}' and 'finally'
 nl_brace_finally = remove # ignore / add / remove / force

# Add or remove newline between 'finally' and '{'
 nl_finally_brace = remove # ignore / add / remove / force

# Add or remove newline between 'try' and '{'
 nl_try_brace = remove # ignore / add / remove / force