From a50845d836ce83cdead7aaa44636767524d80eec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Villemot?= Date: Wed, 18 Dec 2019 16:22:41 +0100 Subject: [PATCH] Upgrade uncrustify configuration --- scripts/uncrustify.cfg | 3275 +++++++++++++++++++++++++--------------- 1 file changed, 2025 insertions(+), 1250 deletions(-) diff --git a/scripts/uncrustify.cfg b/scripts/uncrustify.cfg index 1dd820aea..395548d2b 100644 --- a/scripts/uncrustify.cfg +++ b/scripts/uncrustify.cfg @@ -1,1277 +1,1538 @@ -# Uncrustify 0.64 +# Uncrustify-0.68_f # # General options # -# The type of line endings. Default=Auto -newlines = lf # auto/lf/crlf/cr +# The type of line endings. +# +# Default: auto +newlines = lf # lf/crlf/cr/auto -# The original size of tabs in the input. Default=8 -input_tab_size = 8 # number +# The original size of tabs in the input. +# +# Default: 8 +input_tab_size = 8 # unsigned number -# The size of tabs in the output (only used if align_with_tabs=true). Default=8 -output_tab_size = 8 # number +# The size of tabs in the output (only used if align_with_tabs=true). +# +# Default: 8 +output_tab_size = 8 # unsigned number -# The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn) -string_escape_char = 92 # number +# The ASCII value of the string escape char, usually 92 (\) or (Pawn) 94 (^). +# +# Default: 92 +string_escape_char = 92 # unsigned number -# Alternate string escape char for Pawn. Only works right before the quote char. -string_escape_char2 = 0 # number +# Alternate string escape char (usually only used for Pawn). +# Only works right before the quote char. +string_escape_char2 = 0 # unsigned number -# Replace tab characters found in string literals with the escape sequence \t instead. -string_replace_tab_chars = false # false/true +# Replace tab characters found in string literals with the escape sequence \t +# instead. +string_replace_tab_chars = false # true/false -# Allow interpreting '>=' and '>>=' as part of a template in 'void f(list>=val);'. -# If true, 'assert(x<0 && y>=3)' will be broken. Default=False +# Allow interpreting '>=' and '>>=' as part of a template in code like +# 'void f(list>=val);'. If true, 'assert(x<0 && y>=3)' will be broken. # Improvements to template detection may make this option obsolete. -tok_split_gte = false # false/true +tok_split_gte = false # true/false -# Override the default ' *INDENT-OFF*' in comments for disabling processing of part of the file. -disable_processing_cmt = "" # string +# Specify the marker used in comments to disable processing of part of the +# file. +# +# Default: *INDENT-OFF* +disable_processing_cmt = " *INDENT-OFF*" # string -# Override the default ' *INDENT-ON*' in comments for enabling processing of part of the file. -enable_processing_cmt = "" # string +# Specify the marker used in comments to (re)enable processing in a file. +# +# Default: *INDENT-ON* +enable_processing_cmt = " *INDENT-ON*" # string -# Enable parsing of digraphs. Default=False -enable_digraphs = false # false/true +# Enable parsing of digraphs. +enable_digraphs = false # true/false -# Control what to do with the UTF-8 BOM (recommend 'remove') +# Add or remove the UTF-8 BOM (recommend 'remove'). utf8_bom = ignore # 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 +# If the file contains bytes with values between 128 and 255, but is not +# UTF-8, then output as UTF-8. +utf8_byte = false # true/false -# 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. Default=8 -indent_columns = 2 # 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 (default) -# 2=indent and align with tabs, using spaces when not on a tabstop -indent_with_tabs = 0 # 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 = false # 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 = 2 # 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 - -# Indent based on the paren open instead of the brace open in '({\n', default is to indent by brace. -indent_paren_open_brace = false # false/true - -# indent a C# delegate by another level, default is to not indent by another level. -indent_cs_delegate_brace = false # false/true - -# Whether the 'namespace' body is indented -indent_namespace = true # false/true - -# Only indent one namespace and no sub-namespaces. -# Requires indent_namespace=true. -indent_namespace_single_indent = 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 = true # false/true - -# Whether the 'class' body is indented -indent_class = true # false/true - -# Whether to indent the stuff after a leading base class colon -indent_class_colon = false # false/true - -# Indent based on a class colon instead of the stuff after the colon. -# Requires indent_class_colon=true. Default=False -indent_class_on_colon = false # false/true - -# Whether to indent the stuff after a leading class initializer colon -indent_constr_colon = false # false/true - -# Virtual indent from the ':' for member initializers. Default=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 - -# Indent continued shift expressions ('<<' and '>>') instead of aligning. -# Turn align_left_shift off when enabling this. -indent_shift = 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 = 0 # number - -# Spaces to indent single line ('//') comments on lines before code -indent_sing_line_comments = 0 # 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 = 0 # number - -# Whether to indent comments found in first column -indent_col1_comment = false # false/true - -# How to indent goto labels -# >0: absolute column where 1 is the leftmost column -# <=0: subtract from brace indent -# Default=1 -indent_label = -2 # number - -# Same as indent_label, but for access specifiers that are followed by a colon. Default=1 -indent_access_spec = -2 # 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 - -# If true, prioritize aligning with initial colon (and stripping spaces from lines, if necessary). -# Default=True. -indent_oc_msg_prioritize_first_colon = true # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented the way that Xcode does by default (from keyword if the parameter is on its own line; otherwise, from the previous indentation level). -indent_oc_block_msg_xcode_style = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is relative to a msg keyword. -indent_oc_block_msg_from_keyword = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is relative to a msg colon. -indent_oc_block_msg_from_colon = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the block caret is. -indent_oc_block_msg_from_caret = false # false/true - -# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is. -indent_oc_block_msg_from_brace = false # false/true - -# When identing after virtual brace open and newline add further spaces to reach this min. indent. -indent_min_vbrace_open = 0 # number - -# TRUE: When identing after virtual brace open and newline add further spaces after regular indent to reach next tabstop. -indent_vbrace_open_on_tabstop = false # false/true - -# If true, a brace followed by another token (not a newline) will indent all contained lines to match the token.Default=True. -indent_token_after_brace = true # false/true - -# If true, cpp lambda body will be indentedDefault=False. -indent_cpp_lambda_body = false # false/true +# Force the output encoding to UTF-8. +utf8_force = true # true/false # # Spacing options # -# Add or remove space around arithmetic operator '+', '-', '/', '*', etc -# also '>>>' '<<' '>>' '%' '|' +# Add or remove space around non-assignment symbolic operators ('+', '/', '%', +# '<<', and so forth). sp_arith = ignore # ignore/add/remove/force -# Add or remove space around assignment operator '=', '+=', etc -sp_assign = add # ignore/add/remove/force +# Add or remove space around arithmetic operators '+' and '-'. +# +# Overrides sp_arith. +sp_arith_additive = ignore # ignore/add/remove/force -# Add or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign -sp_cpp_lambda_assign = ignore # 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. -sp_cpp_lambda_paren = ignore # ignore/add/remove/force +sp_cpp_lambda_paren = remove # ignore/add/remove/force -# Add or remove space around assignment operator '=' in a prototype -sp_assign_default = ignore # ignore/add/remove/force +# Add or remove space around assignment operator '=' in a prototype. +sp_assign_default = force # ignore/add/remove/force -# Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign. +# Add or remove space before assignment operator '=', '+=', etc. +# +# Overrides sp_assign. sp_before_assign = ignore # ignore/add/remove/force -# Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign. +# Add or remove space after assignment operator '=', '+=', etc. +# +# Overrides sp_assign. sp_after_assign = ignore # ignore/add/remove/force -# Add or remove space in 'NS_ENUM (' +# Add or remove space in 'NS_ENUM ('. sp_enum_paren = ignore # ignore/add/remove/force -# Add or remove space around assignment '=' in enum -sp_enum_assign = add # ignore/add/remove/force +# Add or remove space around assignment '=' in enum. +sp_enum_assign = force # ignore/add/remove/force -# Add or remove space before assignment '=' in enum. Overrides sp_enum_assign. +# 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. +# 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 -sp_pp_concat = add # ignore/add/remove/force +# Add or remove space around assignment ':' in enum. +sp_enum_colon = ignore # ignore/add/remove/force -# Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator. +# Add or remove space around preprocessor '##' concatenation operator. +# +# Default: add +sp_pp_concat = force # ignore/add/remove/force + +# Add or remove space after preprocessor '#' stringify operator. +# Also affects the '#@' charizing operator. sp_pp_stringify = ignore # ignore/add/remove/force -# Add or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'. +# 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 = add # 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 = add # 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 ')' +# Add or remove space inside '(' and ')'. sp_inside_paren = remove # ignore/add/remove/force -# Add or remove space between nested parens: '((' vs ') )' +# Add or remove space between nested parentheses, i.e. '((' vs. ') )'. sp_paren_paren = remove # ignore/add/remove/force -# Add or remove space between back-to-back parens: ')(' vs ') (' +# Add or remove space between back-to-back parentheses, i.e. ')(' vs. ') ('. sp_cparen_oparen = ignore # ignore/add/remove/force -# Whether to balance spaces inside nested parens -sp_balance_nested_parens = false # false/true +# Whether to balance spaces inside nested parentheses. +sp_balance_nested_parens = false # true/false -# Add or remove space between ')' and '{' +# Add or remove space between ')' and '{'. sp_paren_brace = ignore # ignore/add/remove/force -# Add or remove space before pointer star '*' -sp_before_ptr_star = add # ignore/add/remove/force +# Add or remove space between nested braces, i.e. '{{' vs '{ {'. +sp_brace_brace = ignore # 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. -sp_before_unnamed_ptr_star = add # ignore/add/remove/force +# Add or remove space before pointer star '*'. +sp_before_ptr_star = force # ignore/add/remove/force -# Add or remove space between pointer stars '*' +# 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. +sp_before_unnamed_ptr_star = force # ignore/add/remove/force + +# Add or remove space between pointer stars '*'. sp_between_ptr_star = remove # ignore/add/remove/force # Add or remove space after pointer star '*', if followed by a word. sp_after_ptr_star = remove # ignore/add/remove/force +# Add or remove space after pointer caret '^', if followed by a word. +sp_after_ptr_block_caret = ignore # ignore/add/remove/force + # Add or remove space after pointer star '*', if followed by a qualifier. sp_after_ptr_star_qualifier = ignore # ignore/add/remove/force -# Add or remove space after a pointer star '*', if followed by a func proto/def. +# Add or remove space after a pointer star '*', if followed by a function +# prototype or function definition. sp_after_ptr_star_func = remove # ignore/add/remove/force -# Add or remove space after a pointer star '*', if followed by an open paren (function types). +# Add or remove space after a pointer star '*', if followed by an open +# parenthesis, as in 'void* (*)(). sp_ptr_star_paren = ignore # ignore/add/remove/force -# Add or remove space before a pointer star '*', if followed by a func proto/def. -sp_before_ptr_star_func = add # ignore/add/remove/force +# Add or remove space before a pointer star '*', if followed by a function +# prototype or function definition. +sp_before_ptr_star_func = force # ignore/add/remove/force -# Add or remove space before a reference sign '&' -sp_before_byref = add # ignore/add/remove/force +# Add or remove space before a reference sign '&'. +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. -sp_before_unnamed_byref = add # 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. +sp_before_unnamed_byref = force # ignore/add/remove/force # Add or remove space after reference sign '&', if followed by a word. sp_after_byref = remove # ignore/add/remove/force -# Add or remove space after a reference sign '&', if followed by a func proto/def. +# Add or remove space after a reference sign '&', if followed by a function +# prototype or function definition. sp_after_byref_func = remove # ignore/add/remove/force -# Add or remove space before a reference sign '&', if followed by a func proto/def. -sp_before_byref_func = remove # ignore/add/remove/force +# Add or remove space before a reference sign '&', if followed by a function +# prototype or function definition. +sp_before_byref_func = force # ignore/add/remove/force -# Add or remove space between type and word. Default=Force -sp_after_type = add # 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('. +# Add or remove space between 'decltype(...)' and word. +sp_after_decltype = force # ignore/add/remove/force + +# (D) Add or remove space before the parenthesis 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<'. +# Add or remove space between 'template' and '<'. # If set to ignore, sp_before_angle is used. -sp_template_angle = ignore # ignore/add/remove/force +sp_template_angle = remove # ignore/add/remove/force -# Add or remove space before '<>' +# Add or remove space before '<'. sp_before_angle = ignore # ignore/add/remove/force -# Add or remove space inside '<' and '>' +# Add or remove space inside '<' and '>'. sp_inside_angle = ignore # ignore/add/remove/force -# Add or remove space after '<>' +# Add or remove space between '>' and ':'. +sp_angle_colon = ignore # ignore/add/remove/force + +# Add or remove space after '<>'. sp_after_angle = ignore # ignore/add/remove/force -# Add or remove space between '<>' and '(' as found in 'new List(foo);' +# Add or remove space between '>' and '(' as found in 'new List(foo);'. sp_angle_paren = remove # ignore/add/remove/force -# Add or remove space between '<>' and '()' as found in 'new List();' -sp_angle_paren_empty = ignore # ignore/add/remove/force +# Add or remove space between '>' and '()' as found in 'new List();'. +sp_angle_paren_empty = remove # ignore/add/remove/force -# Add or remove space between '<>' and a word as in 'List m;' or 'template static ...' -sp_angle_word = add # ignore/add/remove/force +# Add or remove space between '>' and a word as in 'List m;' or +# 'template static ...'. +sp_angle_word = force # ignore/add/remove/force -# Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add -sp_angle_shift = add # ignore/add/remove/force +# Add or remove space between '>' and '>' in '>>' (template stuff). +# +# Default: add +sp_angle_shift = remove # ignore/add/remove/force -# Permit removal of the space between '>>' in 'foo >' (C++11 only). Default=False -# sp_angle_shift cannot remove the space without this option. -sp_permit_cpp11_shift = false # false/true +# (C++11) Permit removal of the space between '>>' in 'foo >'. Note +# that sp_angle_shift cannot remove the space without this option. +sp_permit_cpp11_shift = true # true/false -# Add or remove space before '(' of 'if', 'for', 'switch', 'while', etc. -sp_before_sparen = add # ignore/add/remove/force +# Add or remove space before '(' of control statements ('if', 'for', 'switch', +# 'while', etc.). +sp_before_sparen = force # ignore/add/remove/force -# Add or remove space inside if-condition '(' and ')' +# Add or remove space inside '(' and ')' of control statements. sp_inside_sparen = remove # ignore/add/remove/force -# Add or remove space before if-condition ')'. Overrides sp_inside_sparen. -sp_inside_sparen_close = ignore # ignore/add/remove/force - -# Add or remove space after if-condition '('. Overrides sp_inside_sparen. +# Add or remove space after '(' of control statements. +# +# Overrides sp_inside_sparen. sp_inside_sparen_open = ignore # ignore/add/remove/force -# Add or remove space after ')' of 'if', 'for', 'switch', and 'while', etc. -sp_after_sparen = ignore # ignore/add/remove/force +# Add or remove space before ')' of control statements. +# +# Overrides sp_inside_sparen. +sp_inside_sparen_close = ignore # ignore/add/remove/force -# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while', etc. -sp_sparen_brace = ignore # ignore/add/remove/force +# Add or remove space after ')' of control statements. +sp_after_sparen = force # ignore/add/remove/force -# Add or remove space between 'invariant' and '(' in the D language. +# Add or remove space between ')' and '{' of of control statements. +sp_sparen_brace = force # ignore/add/remove/force + +# (D) Add or remove space between 'invariant' and '('. sp_invariant_paren = ignore # ignore/add/remove/force -# Add or remove space after the ')' in 'invariant (C) c' in the D language. +# (D) Add or remove space after the ')' in 'invariant (C) c'. sp_after_invariant_paren = ignore # ignore/add/remove/force -# Add or remove space before empty statement ';' on 'if', 'for' and 'while' +# 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 +# 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 +# Add or remove space before ';' in non-empty 'for' statements. sp_before_semi_for = remove # ignore/add/remove/force # Add or remove space before a semicolon of an empty part of a for statement. sp_before_semi_for_empty = remove # ignore/add/remove/force -# Add or remove space after ';', except when followed by a comment. Default=Add +# Add or remove space after ';', except when followed by a comment. +# +# Default: add sp_after_semi = add # ignore/add/remove/force -# Add or remove space after ';' in non-empty 'for' statements. Default=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 ( ; ; ). +# Add or remove space after the final semicolon of an empty part of a for +# statement, as in 'for ( ; ; )'. sp_after_semi_for_empty = remove # ignore/add/remove/force -# Add or remove space before '[' (except '[]') -sp_before_square = ignore # ignore/add/remove/force +# Add or remove space before '[' (except '[]'). +sp_before_square = remove # ignore/add/remove/force -# Add or remove space before '[]' -sp_before_squares = ignore # ignore/add/remove/force +# Add or remove space before '[]'. +sp_before_squares = remove # ignore/add/remove/force -# Add or remove space inside a non-empty '[' and ']' -sp_inside_square = ignore # ignore/add/remove/force +# Add or remove space before C++17 structured bindings. +sp_cpp_before_struct_binding = force # ignore/add/remove/force -# Add or remove space after ',' -sp_after_comma = add # 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 before ','. Default=Remove +# (OC) Add or remove space inside a non-empty Objective-C boxed array '@[' and +# ']'. If set to ignore, sp_inside_square is used. +sp_inside_square_oc_array = ignore # ignore/add/remove/force + +# Add or remove space after ',', i.e. 'a,b' vs. 'a, b'. +sp_after_comma = force # ignore/add/remove/force + +# Add or remove space before ','. +# +# Default: remove sp_before_comma = remove # ignore/add/remove/force -# Add or remove space between ',' and ']' in multidimensional array type 'int[,,]' +# (C#) Add or remove space between ',' and ']' in multidimensional array type +# like 'int[,,]'. sp_after_mdatype_commas = ignore # ignore/add/remove/force -# Add or remove space between '[' and ',' in multidimensional array type 'int[,,]' +# (C#) Add or remove space between '[' and ',' in multidimensional array type +# like 'int[,,]'. sp_before_mdatype_commas = ignore # ignore/add/remove/force -# Add or remove space between ',' in multidimensional array type 'int[,,]' +# (C#) Add or remove space between ',' in multidimensional array type +# like 'int[,,]'. sp_between_mdatype_commas = ignore # ignore/add/remove/force -# Add or remove space between an open paren and comma: '(,' vs '( ,'. Default=Force +# Add or remove space between an open parenthesis and comma, +# i.e. '(,' vs. '( ,'. +# +# Default: force sp_paren_comma = force # ignore/add/remove/force -# Add or remove space before the variadic '...' when preceded by a non-punctuator +# 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 ':' -sp_after_class_colon = add # ignore/add/remove/force +# Add or remove space between a type and '...'. +sp_type_ellipsis = ignore # ignore/add/remove/force -# Add or remove space before class ':' -sp_before_class_colon = add # ignore/add/remove/force +# Add or remove space between ')' and '...'. +sp_paren_ellipsis = ignore # ignore/add/remove/force -# Add or remove space after class constructor ':' -sp_after_constr_colon = ignore # ignore/add/remove/force +# Add or remove space after class ':'. +sp_after_class_colon = force # ignore/add/remove/force -# Add or remove space before class constructor ':' -sp_before_constr_colon = ignore # ignore/add/remove/force +# Add or remove space before class ':'. +sp_before_class_colon = force # ignore/add/remove/force -# Add or remove space before case ':'. Default=Remove +# Add or remove space after class constructor ':'. +sp_after_constr_colon = force # ignore/add/remove/force + +# Add or remove space before class constructor ':'. +sp_before_constr_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 +# Add or remove space between 'operator' and operator sign. sp_after_operator = remove # ignore/add/remove/force -# Add or remove space between the operator symbol and the open paren, as in 'operator ++(' +# Add or remove space between the operator symbol and the open parenthesis, as +# in 'operator ++('. sp_after_operator_sym = remove # ignore/add/remove/force -# Add or remove space between the operator symbol and the open paren when the operator has no arguments, as in 'operator *()' +# Overrides sp_after_operator_sym when the operator has no arguments, as in +# 'operator *()'. sp_after_operator_sym_empty = ignore # 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' -sp_after_cast = add # 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'. +sp_after_cast = force # ignore/add/remove/force -# Add or remove spaces inside cast parens +# Add or remove spaces inside cast parentheses. sp_inside_paren_cast = remove # 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)' -sp_cpp_cast_paren = add # ignore/add/remove/force +# Add or remove space between the type and open parenthesis in a C++ cast, +# i.e. 'int(exp)' vs. 'int (exp)'. +sp_cpp_cast_paren = ignore # ignore/add/remove/force -# Add or remove space between 'sizeof' and '(' +# Add or remove space between 'sizeof' and '('. sp_sizeof_paren = remove # ignore/add/remove/force -# Add or remove space after the tag keyword (Pawn) +# Add or remove space between 'sizeof' and '...'. +sp_sizeof_ellipsis = ignore # ignore/add/remove/force + +# Add or remove space between 'sizeof...' and '('. +sp_sizeof_ellipsis_paren = ignore # ignore/add/remove/force + +# Add or remove space between 'decltype' and '('. +sp_decltype_paren = remove # ignore/add/remove/force + +# (Pawn) Add or remove space after the tag keyword. sp_after_tag = ignore # ignore/add/remove/force -# Add or remove space inside enum '{' and '}' -sp_inside_braces_enum = 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 = ignore # 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 '}' +# (OC) Add or remove space inside Objective-C boxed dictionary '{' and '}' +sp_inside_braces_oc_dict = ignore # ignore/add/remove/force + +# Add or remove space after open brace in an unnamed temporary +# direct-list-initialization. +sp_after_type_brace_init_lst_open = ignore # ignore/add/remove/force + +# Add or remove space before close brace in an unnamed temporary +# direct-list-initialization. +sp_before_type_brace_init_lst_close = ignore # ignore/add/remove/force + +# Add or remove space inside an unnamed temporary direct-list-initialization. +sp_inside_type_brace_init_lst = ignore # ignore/add/remove/force + +# Add or remove space inside '{' and '}'. sp_inside_braces = ignore # ignore/add/remove/force -# Add or remove space inside '{}' -sp_inside_braces_empty = ignore # ignore/add/remove/force +# Add or remove space inside '{}'. +sp_inside_braces_empty = remove # 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. +# Add or remove space between return type and function name. A minimum of 1 +# is forced except for pointer return types. sp_type_func = ignore # ignore/add/remove/force -# Add or remove space between function name and '(' on function declaration +# Add or remove space between type and open brace of an unnamed temporary +# direct-list-initialization. +sp_type_brace_init_lst = remove # ignore/add/remove/force + +# Add or remove space between function name and '(' on function declaration. sp_func_proto_paren = remove # ignore/add/remove/force -# Add or remove space between function name and '()' on function declaration without parameters -sp_func_proto_paren_empty = ignore # ignore/add/remove/force +# Add or remove space between function name and '()' on function declaration +# without parameters. +sp_func_proto_paren_empty = remove # ignore/add/remove/force -# Add or remove space between function name and '(' on function definition +# Add or remove space between function name and '(' on function definition. sp_func_def_paren = remove # ignore/add/remove/force -# Add or remove space between function name and '()' on function definition without parameters -sp_func_def_paren_empty = ignore # ignore/add/remove/force +# Add or remove space between function name and '()' on function definition +# without parameters. +sp_func_def_paren_empty = remove # ignore/add/remove/force -# Add or remove space inside empty function '()' +# Add or remove space inside empty function '()'. sp_inside_fparens = remove # ignore/add/remove/force -# Add or remove space inside function '(' and ')' +# Add or remove space inside function '(' and ')'. sp_inside_fparen = remove # ignore/add/remove/force -# Add or remove space inside the first parens in the function type: 'void (*x)(...)' -sp_inside_tparen = ignore # ignore/add/remove/force +# Add or remove space inside the first parentheses in a function type, as in +# 'void (*x)(...)'. +sp_inside_tparen = remove # ignore/add/remove/force -# Add or remove between the parens in the function type: 'void (*x)(...)' -sp_after_tparen_close = ignore # ignore/add/remove/force +# Add or remove space between the ')' and '(' in a function type, as in +# 'void (*x)(...)'. +sp_after_tparen_close = remove # ignore/add/remove/force # Add or remove space between ']' and '(' when part of a function call. sp_square_fparen = remove # ignore/add/remove/force -# Add or remove space between ')' and '{' of function -sp_fparen_brace = ignore # ignore/add/remove/force +# Add or remove space between ')' and '{' of function. +sp_fparen_brace = force # ignore/add/remove/force -# Java: Add or remove space between ')' and '{{' of double brace initializer. +# Add or remove space between ')' and '{' of s function call in object +# initialization. +# +# Overrides sp_fparen_brace. +sp_fparen_brace_initializer = ignore # ignore/add/remove/force + +# (Java) Add or remove space between ')' and '{{' of double brace initializer. sp_fparen_dbrace = ignore # ignore/add/remove/force -# Add or remove space between function name and '(' on function calls +# Add or remove space between function name and '(' on function calls. sp_func_call_paren = remove # 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. +# 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. +# Add or remove space between the user function name and '(' on function +# calls. You need to set a keyword to be a user function in the config file, +# like: +# set func_call_user tr _ i18n sp_func_call_user_paren = ignore # ignore/add/remove/force -# Add or remove space between a constructor/destructor and the open paren +# Add or remove space inside user function '(' and ')'. +sp_func_call_user_inside_fparen = ignore # ignore/add/remove/force + +# Add or remove space between nested parentheses with user functions, +# i.e. '((' vs. '( ('. +sp_func_call_user_paren_paren = ignore # ignore/add/remove/force + +# Add or remove space between a constructor/destructor and the open +# parenthesis. sp_func_class_paren = remove # ignore/add/remove/force -# Add or remove space between a constructor without parameters or destructor and '()' -sp_func_class_paren_empty = ignore # ignore/add/remove/force +# Add or remove space between a constructor without parameters or destructor +# and '()'. +sp_func_class_paren_empty = remove # ignore/add/remove/force -# Add or remove space between 'return' and '(' -sp_return_paren = add # ignore/add/remove/force +# Add or remove space between 'return' and '('. +sp_return_paren = force # ignore/add/remove/force -# Add or remove space between '__attribute__' and '(' +# Add or remove space between 'return' and '{'. +sp_return_brace = force # ignore/add/remove/force + +# Add or remove space between '__attribute__' and '('. sp_attribute_paren = ignore # ignore/add/remove/force -# Add or remove space between 'defined' and '(' in '#if defined (FOO)' +# Add or remove space between 'defined' and '(' in '#if defined (FOO)'. sp_defined_paren = remove # ignore/add/remove/force -# Add or remove space between 'throw' and '(' in 'throw (something)' -sp_throw_paren = add # ignore/add/remove/force +# Add or remove space between 'throw' and '(' in 'throw (something)'. +sp_throw_paren = force # ignore/add/remove/force -# Add or remove space between 'throw' and anything other than '(' as in '@throw [...];' +# 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) { }' +# Add or remove space between 'catch' and '(' in 'catch (something) { }'. # If set to ignore, sp_before_sparen is used. -sp_catch_paren = ignore # ignore/add/remove/force +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. +# (OC) Add or remove space between '@catch' and '(' +# in '@catch (something) { }'. If set to ignore, sp_catch_paren is used. +sp_oc_catch_paren = ignore # ignore/add/remove/force + +# (D) Add or remove space between 'version' and '(' +# in 'version (something) { }'. 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. +# (D) Add or remove space between 'scope' and '(' +# in 'scope (something) { }'. If set to ignore, sp_before_sparen is used. sp_scope_paren = ignore # ignore/add/remove/force -# Add or remove space between 'super' and '(' in 'super (something)'. Default=Remove +# Add or remove space between 'super' and '(' in 'super (something)'. +# +# Default: remove sp_super_paren = remove # ignore/add/remove/force -# Add or remove space between 'this' and '(' in 'this (something)'. Default=Remove +# Add or remove space between 'this' and '(' in 'this (something)'. +# +# Default: remove sp_this_paren = remove # ignore/add/remove/force -# Add or remove space between macro and value -sp_macro = ignore # ignore/add/remove/force +# Add or remove space between a macro name and its definition. +sp_macro = force # 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 a macro function ')' and its definition. +sp_macro_func = force # ignore/add/remove/force -# Add or remove space between 'else' and '{' if on the same line -sp_else_brace = 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 = ignore # 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 = add # 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 = ignore # ignore/add/remove/force +# Add or remove space before the '{' of a 'catch' statement, if the '{' and +# 'catch' are on the same line, as in 'catch (decl) {'. +sp_catch_brace = force # ignore/add/remove/force -# Add or remove space between '}' and 'catch' if on the same line -sp_brace_catch = ignore # ignore/add/remove/force +# (OC) Add or remove space before the '{' of a '@catch' statement, if the '{' +# and '@catch' are on the same line, as in '@catch (decl) {'. +# If set to ignore, sp_catch_brace is used. +sp_oc_catch_brace = ignore # ignore/add/remove/force -# Add or remove space between 'finally' and '{' if on the same line -sp_finally_brace = ignore # 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 '}' and 'finally' if on the same line -sp_brace_finally = ignore # ignore/add/remove/force +# (OC) Add or remove space between '}' and '@catch' if on the same line. +# If set to ignore, sp_brace_catch is used. +sp_oc_brace_catch = ignore # ignore/add/remove/force -# Add or remove space between 'try' and '{' if on the same line -sp_try_brace = ignore # 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 get/set and '{' if on the same line +# 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 = ignore # ignore/add/remove/force -# Add or remove space between a variable and '{' for C++ uniform initialization. Default=Add +# Add or remove space between a variable and '{' for C++ uniform +# initialization. +# +# Default: add sp_word_brace = add # ignore/add/remove/force -# Add or remove space between a variable and '{' for a namespace. Default=Add +# Add or remove space between a variable and '{' for a namespace. +# +# Default: add sp_word_brace_ns = add # ignore/add/remove/force -# Add or remove space before the '::' operator +# Add or remove space before the '::' operator. sp_before_dc = remove # ignore/add/remove/force -# Add or remove space after the '::' operator +# 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 +# (D) 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 +# Add or remove space after the '!' (not) unary operator. +# +# Default: remove sp_not = remove # ignore/add/remove/force -# Add or remove space after the '~' (invert) operator. Default=Remove +# Add or remove space after the '~' (invert) unary 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. +# Add or remove space after the '&' (address-of) unary operator. This does not +# affect the spacing after a '&' that is part of a type. +# +# Default: remove sp_addr = remove # ignore/add/remove/force -# Add or remove space around the '.' or '->' operators. Default=Remove +# 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. +# Add or remove space after the '*' (dereference) unary operator. This does +# not affect the spacing after a '*' that is part of a type. +# +# Default: remove sp_deref = remove # ignore/add/remove/force -# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove +# 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 +# Add or remove space between '++' and '--' the word to which it is being +# applied, 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 +# Add or remove space before a backslash-newline at the end of a line. +# +# Default: add sp_before_nl_cont = add # ignore/add/remove/force -# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;' +# (OC) 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;' +# (OC) Add or remove space after the colon in message specs, +# i.e. '-(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;' +# (OC) Add or remove space before the colon in message specs, +# i.e. '-(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"};' +# (OC) 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"};' +# (OC) 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];' +# (OC) Add or remove space after the colon in message specs, +# i.e. '[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];' +# (OC) Add or remove space before the colon in message specs, +# i.e. '[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;' +# (OC) Add or remove space after the (type) in message specs, +# i.e. '-(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;' +# (OC) Add or remove space after the first (type) in message specs, +# i.e. '-(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 +# (OC) Add or remove space between '@selector' and '(', +# i.e. '@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:' +# (OC) Add or remove space between '@selector(x)' and the following word, +# i.e. '@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 +# (OC) Add or remove space inside '@selector' parentheses, +# i.e. '@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){...}' +# (OC) Add or remove space before a block pointer caret, +# i.e. '^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){...}' +# (OC) Add or remove space after a block pointer caret, +# i.e. '^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 ...]' +# (OC) Add or remove space between the receiver and selector in a message, +# as in '[receiver selector ...]'. sp_after_oc_msg_receiver = ignore # ignore/add/remove/force -# Add or remove space after @property. +# (OC) 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 = add # ignore/add/remove/force +# (OC) Add or remove space between '@synchronized' and the open parenthesis, +# i.e. '@synchronized(foo)' vs. '@synchronized (foo)'. +sp_after_oc_synchronized = ignore # ignore/add/remove/force -# Add or remove space before the ':' in 'b ? t : f'. Overrides sp_cond_colon. +# Add or remove space around the ':' in 'b ? t : f'. +sp_cond_colon = force # ignore/add/remove/force + +# Add or remove space before the ':' in 'b ? t : f'. +# +# Overrides sp_cond_colon. sp_cond_colon_before = ignore # ignore/add/remove/force -# Add or remove space after the ':' in 'b ? t : f'. Overrides sp_cond_colon. +# Add or remove space after the ':' in 'b ? t : f'. +# +# Overrides sp_cond_colon. sp_cond_colon_after = ignore # ignore/add/remove/force -# Add or remove space around the '?' in 'b ? t : f' -sp_cond_question = add # ignore/add/remove/force +# Add or remove space around the '?' in 'b ? t : f'. +sp_cond_question = force # ignore/add/remove/force -# Add or remove space before the '?' in 'b ? t : f'. Overrides sp_cond_question. +# Add or remove space before the '?' in 'b ? t : f'. +# +# Overrides sp_cond_question. sp_cond_question_before = ignore # ignore/add/remove/force -# Add or remove space after the '?' in 'b ? t : f'. Overrides sp_cond_question. +# Add or remove space after the '?' in 'b ? t : f'. +# +# Overrides sp_cond_question. sp_cond_question_after = ignore # ignore/add/remove/force -# In the abbreviated ternary form (a ?: b), add/remove space between ? and :.'. Overrides all other sp_cond_* options. +# In the abbreviated ternary form '(a ?: b)', add or remove space between '?' +# and ':'. +# +# Overrides all other sp_cond_* options. sp_cond_ternary_short = ignore # 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 +# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make +# sense here. +sp_case_label = force # ignore/add/remove/force -# Control the space around the D '..' operator. +# (D) Add or remove space around the D '..' operator. sp_range = ignore # ignore/add/remove/force -# Control the spacing after ':' in 'for (TYPE VAR : EXPR)' -sp_after_for_colon = ignore # ignore/add/remove/force +# Add or remove space after ':' in a Java/C++11 range-based 'for', +# as in 'for (Type var : expr)'. +sp_after_for_colon = force # ignore/add/remove/force -# Control the spacing before ':' in 'for (TYPE VAR : EXPR)' -sp_before_for_colon = ignore # ignore/add/remove/force +# Add or remove space before ':' in a Java/C++11 range-based 'for', +# as in 'for (Type var : expr)'. +sp_before_for_colon = force # ignore/add/remove/force -# Control the spacing in 'extern (C)' (D) +# (D) Add or remove space between 'extern' and '(' as in 'extern (C)'. sp_extern_paren = ignore # ignore/add/remove/force -# Control the space after the opening of a C++ comment '// A' vs '//A' +# Add or remove space after the opening of a C++ comment, +# i.e. '// A' vs. '//A'. sp_cmt_cpp_start = ignore # ignore/add/remove/force -# TRUE: If space is added with sp_cmt_cpp_start, do it after doxygen sequences like '///', '///<', '//!' and '//!<'. -sp_cmt_cpp_doxygen = false # false/true +# If true, space is added with sp_cmt_cpp_start will be added after doxygen +# sequences like '///', '///<', '//!' and '//!<'. +sp_cmt_cpp_doxygen = true # true/false -# TRUE: If space is added with sp_cmt_cpp_start, do it after Qt translator or meta-data comments like '//:', '//=', and '//~'. -sp_cmt_cpp_qttr = false # false/true +# If true, space is added with sp_cmt_cpp_start will be added after Qt +# translator or meta-data comments like '//:', '//=', and '//~'. +sp_cmt_cpp_qttr = false # true/false -# Controls the spaces between #else or #endif and a trailing comment +# Add or remove space 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 = ignore # ignore/add/remove/force +# Add or remove space after 'new', 'delete' and 'delete[]'. +sp_after_new = force # ignore/add/remove/force -# Controls the spaces between new and '(' in 'new()' +# Add or remove space between 'new' and '(' in 'new()'. sp_between_new_paren = ignore # ignore/add/remove/force -# Controls the spaces before a trailing or embedded comment -sp_before_tr_emb_cmt = ignore # ignore/add/remove/force +# Add or remove space between ')' and type in 'new(foo) BAR'. +sp_after_newop_paren = ignore # ignore/add/remove/force -# Number of spaces before a trailing or embedded comment -sp_num_before_tr_emb_cmt = 0 # number +# Add or remove space inside parenthesis of the new operator +# as in 'new(foo) BAR'. +sp_inside_newop_paren = ignore # ignore/add/remove/force -# Control space between a Java annotation and the open paren. +# Add or remove space after the open parenthesis of the new operator, +# as in 'new(foo) BAR'. +# +# Overrides sp_inside_newop_paren. +sp_inside_newop_paren_open = ignore # ignore/add/remove/force + +# Add or remove space before the close parenthesis of the new operator, +# as in 'new(foo) BAR'. +# +# Overrides sp_inside_newop_paren. +sp_inside_newop_paren_close = ignore # ignore/add/remove/force + +# Add or remove space before a trailing or embedded comment. +sp_before_tr_emb_cmt = force # ignore/add/remove/force + +# Number of spaces before a trailing or embedded comment. +sp_num_before_tr_emb_cmt = 0 # unsigned number + +# (Java) Add or remove space between an annotation and the open parenthesis. sp_annotation_paren = ignore # ignore/add/remove/force # If true, vbrace tokens are dropped to the previous token and skipped. -sp_skip_vbrace_tokens = false # false/true +sp_skip_vbrace_tokens = false # true/false + +# Add or remove space after 'noexcept'. +sp_after_noexcept = remove # ignore/add/remove/force + +# If true, a is inserted after #define. +force_tab_after_define = false # true/false # -# Code alignment (not left column spaces/tabs) +# Indenting options # -# Whether to keep non-indenting tabs -align_keep_tabs = false # false/true +# The number of columns to indent per level. Usually 2, 3, 4, or 8. +# +# Default: 8 +indent_columns = 2 # unsigned number -# Whether to use tabs for aligning -align_with_tabs = false # false/true +# The continuation indent. If non-zero, this overrides the indent of '(' and +# '=' continuation indents. Negative values are OK; negative value is absolute +# and not increased for each '(' level. +# +# For FreeBSD, this is set to 4. +indent_continue = 0 # number -# Whether to bump out to the next tab when aligning -align_on_tabstop = false # false/true +# The continuation indent, only for class header line(s). If non-zero, this +# overrides the indent of 'class' continuation indents. +indent_continue_class_head = 0 # unsigned number -# Whether to left-align numbers -align_number_left = false # false/true +# Whether to indent empty lines (i.e. lines which contain only spaces before +# the newline character). +indent_single_newlines = false # true/false -# Whether to keep whitespace not required for alignment. -align_keep_extra_space = false # false/true +# The continuation indent for func_*_param if they are true. If non-zero, this +# overrides the indent. +indent_param = 0 # unsigned number -# Align variable definitions in prototypes and functions -align_func_params = false # false/true +# How to use tabs when indenting code. +# +# 0: Spaces only +# 1: Indent with tabs to brace level, align with spaces (default) +# 2: Indent and align with tabs, using spaces when not on a tabstop +# +# Default: 1 +indent_with_tabs = 0 # unsigned number -# 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 +# Whether to indent comments that are not at a brace level with tabs on a +# tabstop. Requires indent_with_tabs=2. If false, will use spaces. +indent_cmt_with_tabs = false # true/false -# The span for aligning variable definitions (0=don't align) -align_var_def_span = 0 # number +# Whether to indent strings broken by '\' so that they line up. +indent_align_string = false # true/false -# 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 +# The number of spaces to indent multi-line XML strings. +# Requires indent_align_string=true. +indent_xml_string = 0 # unsigned 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 +# Spaces to indent '{' from level. +indent_brace = 2 # unsigned number -# The threshold for aligning variable definitions (0=no limit) -align_var_def_thresh = 0 # number +# Whether braces are indented to the body level. +indent_braces = false # true/false -# The gap for aligning variable definitions -align_var_def_gap = 0 # number +# Whether to disable indenting function braces if indent_braces=true. +indent_braces_no_func = false # true/false -# Whether to align the colon in struct bit fields -align_var_def_colon = false # false/true +# Whether to disable indenting class braces if indent_braces=true. +indent_braces_no_class = false # true/false -# Whether to align any attribute after the variable name -align_var_def_attribute = false # false/true +# Whether to disable indenting struct braces if indent_braces=true. +indent_braces_no_struct = false # true/false -# Whether to align inline struct/enum/union variable definitions -align_var_def_inline = false # false/true +# Whether to indent based on the size of the brace parent, +# i.e. 'if' → 3 spaces, 'for' → 4 spaces, etc. +indent_brace_parent = false # true/false -# The span for aligning on '=' in assignments (0=don't align) -align_assign_span = 0 # number +# Whether to indent based on the open parenthesis instead of the open brace +# in '({\n'. +indent_paren_open_brace = false # true/false -# The threshold for aligning on '=' in assignments (0=no limit) -align_assign_thresh = 0 # number +# (C#) Whether to indent the brace of a C# delegate by another level. +indent_cs_delegate_brace = false # true/false -# The span for aligning on '=' in enums (0=don't align) -align_enum_equ_span = 0 # number +# (C#) Whether to indent a C# delegate (to handle delegates with no brace) by +# another level. +indent_cs_delegate_body = false # true/false -# The threshold for aligning on '=' in enums (0=no limit) -align_enum_equ_thresh = 0 # number +# Whether to indent the body of a 'namespace'. +indent_namespace = true # true/false -# The span for aligning class (0=don't align) -align_var_class_span = 0 # number +# Whether to indent only the first namespace, and not any nested namespaces. +# Requires indent_namespace=true. +indent_namespace_single_indent = false # true/false -# The threshold for aligning class member definitions (0=no limit) -align_var_class_thresh = 0 # number +# The number of spaces to indent a namespace block. +indent_namespace_level = 0 # unsigned number -# The gap for aligning class member definitions -align_var_class_gap = 0 # number +# If the body of the namespace is longer than this number, it won't be +# indented. Requires indent_namespace=true. 0 means no limit. +indent_namespace_limit = 0 # unsigned number -# The span for aligning struct/union (0=don't align) -align_var_struct_span = 0 # number +# Whether the 'extern "C"' body is indented. +indent_extern = true # true/false -# The threshold for aligning struct/union member definitions (0=no limit) -align_var_struct_thresh = 0 # number +# Whether the 'class' body is indented. +indent_class = true # true/false -# The gap for aligning struct/union member definitions -align_var_struct_gap = 0 # number +# Whether to indent the stuff after a leading base class colon. +indent_class_colon = false # true/false -# The span for aligning struct initializer values (0=don't align) -align_struct_init_span = 0 # number +# Whether to indent based on a class colon instead of the stuff after the +# colon. Requires indent_class_colon=true. +indent_class_on_colon = false # true/false -# The minimum space between the type and the synonym of a typedef -align_typedef_gap = 0 # number +# Whether to indent the stuff after a leading class initializer colon. +indent_constr_colon = false # true/false -# The span for aligning single-line typedefs (0=don't align) -align_typedef_span = 0 # number +# Virtual indent from the ':' for member initializers. +# +# Default: 2 +indent_ctor_init_leading = 2 # unsigned 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 +# Additional indent for constructor initializer list. +# Negative values decrease indent down to the first column. +indent_ctor_init = 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 +# Whether to indent 'if' following 'else' as a new block under the 'else'. +# If false, 'else\nif' is treated as 'else if' for indenting purposes. +indent_else_if = true # true/false -# 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 +# Amount to indent variable declarations after a open brace. +# +# <0: Relative +# ≥0: Absolute +indent_var_def_blk = 0 # number -# The span for aligning comments that end lines (0=don't align) -align_right_cmt_span = 0 # number +# Whether to indent continued variable declarations instead of aligning. +indent_var_def_cont = false # true/false -# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment -align_right_cmt_mix = false # false/true +# Whether to indent continued shift expressions ('<<' and '>>') instead of +# aligning. Set align_left_shift=false when enabling this. +indent_shift = false # true/false -# 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 +# Whether to force indentation of function definitions to start in column 1. +indent_func_def_force_col1 = false # true/false -# 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 +# Whether to indent continued function call parameters one indent level, +# rather than aligning parameters under the open parenthesis. +indent_func_call_param = false # true/false -# The span for aligning function prototypes (0=don't align) -align_func_proto_span = 0 # number +# Same as indent_func_call_param, but for function definitions. +indent_func_def_param = false # true/false -# Minimum gap between the return type and the function name. -align_func_proto_gap = 0 # number +# Same as indent_func_call_param, but for function prototypes. +indent_func_proto_param = false # true/false -# Align function protos on the 'operator' keyword instead of what follows -align_on_operator = false # false/true +# Same as indent_func_call_param, but for class declarations. +indent_func_class_param = false # true/false -# 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 +# Same as indent_func_call_param, but for class variable constructors. +indent_func_ctor_var_param = false # true/false -# Align single-line functions with function prototypes, uses align_func_proto_span -align_single_line_func = false # false/true +# Same as indent_func_call_param, but for template parameter lists. +indent_template_param = false # true/false -# 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 +# Double the indent for indent_func_xxx_param options. +# Use both values of the options indent_columns and indent_param. +indent_func_param_double = false # true/false -# Gap for align_single_line_brace. -align_single_line_brace_gap = 0 # number +# Indentation column for standalone 'const' qualifier on a function +# prototype. +indent_func_const = 0 # unsigned number -# The span for aligning ObjC msg spec (0=don't align) -align_oc_msg_spec_span = 0 # number +# Indentation column for standalone 'throw' qualifier on a function +# prototype. +indent_func_throw = 0 # unsigned 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 = false # false/true +# The number of spaces to indent a continued '->' or '.'. +# Usually set to 0, 1, or indent_columns. +indent_member = 0 # unsigned number -# # Align macro functions and variables together -align_pp_define_together = false # false/true +# Whether lines broken at '.' or '->' should be indented by a single indent. +# The indent_member option will not be effective if this is set to true. +indent_member_single = true # true/false -# The minimum space between label and value of a preprocessor define -align_pp_define_gap = 0 # number +# Spaces to indent single line ('//') comments on lines before code. +indent_sing_line_comments = 0 # unsigned number -# The span for aligning on '#define' bodies (0=don't align, other=number of lines including comments between blocks) -align_pp_define_span = 0 # number +# Whether to indent trailing single line ('//') comments relative to the code +# instead of trying to keep the same absolute column. +indent_relative_single_line_comments = true # true/false -# Align lines that start with '<<' with previous '<<'. Default=True -align_left_shift = true # false/true +# Spaces to indent 'case' from 'switch'. Usually 0 or indent_columns. +indent_switch_case = 0 # unsigned number -# Align text after asm volatile () colons. -align_asm_colon = false # false/true +# Whether to indent preprocessor statements inside of switch statements. +# +# Default: true +indent_switch_pp = true # true/false -# Span for aligning parameters in an Obj-C message call on the ':' (0=don't align) -align_oc_msg_colon_span = 0 # number +# Spaces to shift the 'case' line, without affecting any other lines. +# Usually 0. +indent_case_shift = 0 # unsigned number -# If true, always align with the first parameter, even if it is too short. -align_oc_msg_colon_first = false # false/true +# Spaces to indent '{' from 'case'. By default, the brace will appear under +# the 'c' in case. Usually set to 0 or indent_columns. Negative values are OK. +indent_case_brace = 2 # number -# Aligning parameters in an Obj-C '+' or '-' declaration on the ':' -align_oc_decl_colon = false # false/true +# Whether to indent comments found in first column. +indent_col1_comment = false # true/false + +# How to indent goto labels. +# +# >0: Absolute column where 1 is the leftmost column +# ≤0: Subtract from brace indent +# +# Default: 1 +indent_label = -2 # number + +# Same as indent_label, but for access specifiers that are followed by a +# colon. +# +# Default: 1 +indent_access_spec = -2 # number + +# Whether to indent the code after an access specifier by one level. +# If true, this option forces 'indent_access_spec=0'. +indent_access_spec_body = false # true/false + +# If an open parenthesis is followed by a newline, whether to indent the next +# line so that it lines up after the open parenthesis (not recommended). +indent_paren_nl = false # true/false + +# How to indent a close parenthesis after a newline. +# +# 0: Indent to body level (default) +# 1: Align under the open parenthesis +# 2: Indent to the brace level +indent_paren_close = 0 # unsigned number + +# Whether to indent the open parenthesis of a function definition, +# if the parenthesis is on its own line. +indent_paren_after_func_def = false # true/false + +# Whether to indent the open parenthesis of a function declaration, +# if the parenthesis is on its own line. +indent_paren_after_func_decl = false # true/false + +# Whether to indent the open parenthesis of a function call, +# if the parenthesis is on its own line. +indent_paren_after_func_call = false # true/false + +# Whether to indent a comma when inside a parenthesis. +# If true, aligns under the open parenthesis. +indent_comma_paren = false # true/false + +# Whether to indent a Boolean operator when inside a parenthesis. +# If true, aligns under the open parenthesis. +indent_bool_paren = false # true/false + +# Whether to indent a semicolon when inside a for parenthesis. +# If true, aligns under the open for parenthesis. +indent_semicolon_for_paren = false # true/false + +# Whether to align the first expression to following ones +# if indent_bool_paren=true. +indent_first_bool_expr = false # true/false + +# Whether to align the first expression to following ones +# if indent_semicolon_for_paren=true. +indent_first_for_expr = false # true/false + +# If an open square is followed by a newline, whether to indent the next line +# so that it lines up after the open square (not recommended). +indent_square_nl = false # true/false + +# (ESQL/C) Whether to preserve the relative indent of 'EXEC SQL' bodies. +indent_preserve_sql = false # true/false + +# Whether to align continued statements at the '='. If false or if the '=' is +# followed by a newline, the next line is indent one tab. +# +# Default: true +indent_align_assign = true # true/false + +# Whether to align continued statements at the '('. If false or the '(' is not +# followed by a newline, the next line indent is one tab. +# +# Default: true +indent_align_paren = true # true/false + +# (OC) Whether to indent Objective-C blocks at brace level instead of usual +# rules. +indent_oc_block = false # true/false + +# (OC) Indent for Objective-C blocks in a message relative to the parameter +# name. +# +# =0: Use indent_oc_block rules +# >0: Use specified number of spaces to indent +indent_oc_block_msg = 0 # unsigned number + +# (OC) Minimum indent for subsequent parameters +indent_oc_msg_colon = 0 # unsigned number + +# (OC) Whether to prioritize aligning with initial colon (and stripping spaces +# from lines, if necessary). +# +# Default: true +indent_oc_msg_prioritize_first_colon = true # true/false + +# (OC) Whether to indent blocks the way that Xcode does by default +# (from the keyword if the parameter is on its own line; otherwise, from the +# previous indentation level). Requires indent_oc_block_msg=true. +indent_oc_block_msg_xcode_style = false # true/false + +# (OC) Whether to indent blocks from where the brace is, relative to a +# message keyword. Requires indent_oc_block_msg=true. +indent_oc_block_msg_from_keyword = false # true/false + +# (OC) Whether to indent blocks from where the brace is, relative to a message +# colon. Requires indent_oc_block_msg=true. +indent_oc_block_msg_from_colon = false # true/false + +# (OC) Whether to indent blocks from where the block caret is. +# Requires indent_oc_block_msg=true. +indent_oc_block_msg_from_caret = false # true/false + +# (OC) Whether to indent blocks from where the brace caret is. +# Requires indent_oc_block_msg=true. +indent_oc_block_msg_from_brace = false # true/false + +# When indenting after virtual brace open and newline add further spaces to +# reach this minimum indent. +indent_min_vbrace_open = 0 # unsigned number + +# Whether to add further spaces after regular indent to reach next tabstop +# when identing after virtual brace open and newline. +indent_vbrace_open_on_tabstop = false # true/false + +# How to indent after a brace followed by another token (not a newline). +# true: indent all contained lines to match the token +# false: indent all contained lines to match the brace +# +# Default: true +indent_token_after_brace = true # true/false + +# Whether to indent the body of a C++11 lambda. +indent_cpp_lambda_body = true # true/false + +# (C#) Whether to indent a 'using' block if no braces are used. +# +# Default: true +indent_using_block = true # true/false + +# How to indent the continuation of ternary operator. +# +# 0: Off (default) +# 1: When the `if_false` is a continuation, indent it under `if_false` +# 2: When the `:` is a continuation, indent it under `?` +indent_ternary_operator = 0 # unsigned number + +# If true, the indentation of the chunks after a `return new` sequence will be set at return indentation column. +indent_off_after_return_new = false # true/false + +# If true, the tokens after return are indented with regular single indentation. By default (false) the indentation is after the return token. +indent_single_after_return = false # true/false + +# Whether to ignore indent and alignment for 'asm' blocks (i.e. assume they +# have their own indentation). +indent_ignore_asm_block = false # true/false # # Newline adding and removing options # -# Whether to collapse empty blocks between '{' and '}' -nl_collapse_empty_body = false # false/true +# Whether to collapse empty blocks between '{' and '}'. +nl_collapse_empty_body = false # true/false -# 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 assignments, as in 'foo_t f = { 1, 2 };'. +nl_assign_leave_one_liners = true # true/false -# Don't split one-line braced statements inside a class xx { } body -nl_class_leave_one_liners = false # false/true +# Don't split one-line braced statements inside a 'class xx { }' body. +nl_class_leave_one_liners = false # true/false -# Don't split one-line enums: 'enum foo { BAR = 15 };' -nl_enum_leave_one_liners = true # false/true +# Don't split one-line enums, as in 'enum foo { BAR = 15 };' +nl_enum_leave_one_liners = true # true/false -# Don't split one-line get or set functions -nl_getset_leave_one_liners = false # false/true +# Don't split one-line get or set functions. +nl_getset_leave_one_liners = false # true/false -# Don't split one-line function definitions - 'int foo() { return 0; }' -nl_func_leave_one_liners = false # false/true +# (C#) Don't split one-line property get or set functions. +nl_cs_property_leave_one_liners = false # true/false -# Don't split one-line C++11 lambdas - '[]() { return 0; }' -nl_cpp_lambda_leave_one_liners = false # false/true +# Don't split one-line function definitions, as in 'int foo() { return 0; }'. +nl_func_leave_one_liners = false # true/false -# Don't split one-line if/else statements - 'if(a) b++;' -nl_if_leave_one_liners = false # false/true +# Don't split one-line C++11 lambdas, as in '[]() { return 0; }'. +nl_cpp_lambda_leave_one_liners = true # true/false -# Don't split one-line while statements - 'while(a) b++;' -nl_while_leave_one_liners = false # false/true +# Don't split one-line if/else statements, as in 'if(...) b++;'. +nl_if_leave_one_liners = false # true/false -# Don't split one-line OC messages -nl_oc_msg_leave_one_liner = false # false/true +# Don't split one-line while statements, as in 'while(...) b++;'. +nl_while_leave_one_liners = false # true/false -# Add or remove newline between Objective-C block signature and '{' +# Don't split one-line for statements, as in 'for(...) b++;'. +nl_for_leave_one_liners = false # true/false + +# (OC) Don't split one-line Objective-C messages. +nl_oc_msg_leave_one_liner = false # true/false + +# (OC) Add or remove newline between method declaration and '{'. +nl_oc_mdef_brace = ignore # ignore/add/remove/force + +# (OC) Add or remove newline between Objective-C block signature and '{'. nl_oc_block_brace = ignore # ignore/add/remove/force -# Add or remove newlines at the start of the file +# (OC) Add or remove newline between '@interface' and '{'. +nl_oc_interface_brace = ignore # ignore/add/remove/force + +# (OC) Add or remove newline between '@implementation' and '{'. +nl_oc_implementation_brace = ignore # ignore/add/remove/force + +# 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 +# The minimum 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 # unsigned number -# Add or remove newline at the end of the file -nl_end_of_file = add # ignore/add/remove/force +# 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 +# The minimum 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 # unsigned number -# Add or remove newline between '=' and '{' +# Add or remove newline between '=' and '{'. nl_assign_brace = ignore # ignore/add/remove/force -# Add or remove newline between '=' and '[' (D only) +# (D) Add or remove newline between '=' and '['. nl_assign_square = ignore # ignore/add/remove/force -# Add or remove newline after '= [' (D only). Will also affect the newline before the ']' +# Add or remove newline between '[]' and '{'. +nl_tsquare_brace = ignore # ignore/add/remove/force + +# (D) Add or remove newline after '= ['. 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 = 0 # number +# 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 = 0 # unsigned number -# The number of newlines before a block of typedefs -# 0 = No change (default) -# the option 'nl_after_access_spec' takes preference over 'nl_typedef_blk_start' -nl_typedef_blk_start = 0 # number +# The number of newlines before a block of typedefs. If nl_after_access_spec +# is non-zero, that option takes precedence. +# +# 0 = No change (default). +nl_typedef_blk_start = 0 # unsigned number -# The number of newlines after a block of typedefs -# 0 = No change (default) -nl_typedef_blk_end = 0 # number +# The number of newlines after a block of typedefs. +# +# 0 = No change (default). +nl_typedef_blk_end = 0 # unsigned number -# The maximum consecutive newlines within a block of typedefs -# 0 = No change (default) -nl_typedef_blk_in = 0 # number +# The maximum number of consecutive newlines within a block of typedefs. +# +# 0 = No change (default). +nl_typedef_blk_in = 0 # unsigned number -# The number of newlines before a block of variable definitions not at the top of a function body -# 0 = No change (default) -# the option 'nl_after_access_spec' takes preference over 'nl_var_def_blk_start' -nl_var_def_blk_start = 0 # number +# The number of newlines before a block of variable definitions not at the top +# of a function body. If nl_after_access_spec is non-zero, that option takes +# precedence. +# +# 0 = No change (default). +nl_var_def_blk_start = 0 # unsigned 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 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 # unsigned number -# The maximum consecutive newlines within a block of variable definitions -# 0 = No change (default) -nl_var_def_blk_in = 0 # number +# The maximum number of consecutive newlines within a block of variable +# definitions. +# +# 0 = No change (default). +nl_var_def_blk_in = 0 # unsigned number -# Add or remove newline between a function call's ')' and '{', as in: -# list_for_each(item, &list) { } +# Add or remove newline between a function call's ')' and '{', as in +# 'list_for_each(item, &list) { }'. nl_fcall_brace = ignore # ignore/add/remove/force -# Add or remove newline between 'enum' and '{' -nl_enum_brace = add # ignore/add/remove/force +# Add or remove newline between 'enum' and '{'. +nl_enum_brace = force # ignore/add/remove/force -# Add or remove newline between 'struct and '{' -nl_struct_brace = add # ignore/add/remove/force +# Add or remove newline between 'enum' and 'class'. +nl_enum_class = ignore # ignore/add/remove/force -# Add or remove newline between 'union' and '{' -nl_union_brace = add # ignore/add/remove/force +# Add or remove newline between 'enum class' and the identifier. +nl_enum_class_identifier = ignore # ignore/add/remove/force -# Add or remove newline between 'if' and '{' -nl_if_brace = add # ignore/add/remove/force +# Add or remove newline between 'enum class' type and ':'. +nl_enum_identifier_colon = ignore # ignore/add/remove/force -# Add or remove newline between '}' and 'else' -nl_brace_else = add # ignore/add/remove/force +# Add or remove newline between 'enum class identifier :' and type. +nl_enum_colon_type = ignore # ignore/add/remove/force -# Add or remove newline between 'else if' and '{' -# If set to ignore, nl_if_brace is used instead +# Add or remove newline between 'struct and '{'. +nl_struct_brace = force # ignore/add/remove/force + +# Add or remove newline between 'union' and '{'. +nl_union_brace = force # ignore/add/remove/force + +# Add or remove newline between 'if' and '{'. +nl_if_brace = force # ignore/add/remove/force + +# Add or remove newline between '}' and 'else'. +nl_brace_else = force # 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 = add # ignore/add/remove/force +# Add or remove newline between 'else' and '{'. +nl_else_brace = force # ignore/add/remove/force -# Add or remove newline between 'else' and 'if' -nl_else_if = ignore # 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' +# Add or remove newline before 'if'/'else if' closing parenthesis. +nl_before_if_closing_paren = ignore # ignore/add/remove/force + +# Add or remove newline between '}' and 'finally'. nl_brace_finally = ignore # ignore/add/remove/force -# Add or remove newline between 'finally' and '{' +# Add or remove newline between 'finally' and '{'. nl_finally_brace = ignore # ignore/add/remove/force -# Add or remove newline between 'try' and '{' -nl_try_brace = add # ignore/add/remove/force +# Add or remove newline between 'try' and '{'. +nl_try_brace = force # ignore/add/remove/force -# Add or remove newline between get/set and '{' +# Add or remove newline between get/set and '{'. nl_getset_brace = ignore # ignore/add/remove/force -# Add or remove newline between 'for' and '{' -nl_for_brace = add # ignore/add/remove/force +# Add or remove newline between 'for' and '{'. +nl_for_brace = force # ignore/add/remove/force -# Add or remove newline between 'catch' and '{' -nl_catch_brace = add # ignore/add/remove/force +# Add or remove newline before the '{' of a 'catch' statement, as in +# 'catch (decl) {'. +nl_catch_brace = force # ignore/add/remove/force -# Add or remove newline between '}' and 'catch' -nl_brace_catch = add # ignore/add/remove/force +# (OC) Add or remove newline before the '{' of a '@catch' statement, as in +# '@catch (decl) {'. If set to ignore, nl_catch_brace is used. +nl_oc_catch_brace = ignore # ignore/add/remove/force -# Add or remove newline between '}' and ']' +# Add or remove newline between '}' and 'catch'. +nl_brace_catch = force # ignore/add/remove/force + +# (OC) Add or remove newline between '}' and '@catch'. If set to ignore, +# nl_brace_catch is used. +nl_oc_brace_catch = ignore # ignore/add/remove/force + +# Add or remove newline between '}' and ']'. nl_brace_square = ignore # ignore/add/remove/force -# Add or remove newline between '}' and ')' in a function invocation +# Add or remove newline between '}' and ')' in a function invocation. nl_brace_fparen = ignore # ignore/add/remove/force -# Add or remove newline between 'while' and '{' -nl_while_brace = add # ignore/add/remove/force +# Add or remove newline between 'while' and '{'. +nl_while_brace = force # ignore/add/remove/force -# Add or remove newline between 'scope (x)' and '{' (D) +# (D) Add or remove newline between 'scope (x)' and '{'. nl_scope_brace = ignore # ignore/add/remove/force -# Add or remove newline between 'unittest' and '{' (D) +# (D) Add or remove newline between 'unittest' and '{'. nl_unittest_brace = ignore # ignore/add/remove/force -# Add or remove newline between 'version (x)' and '{' (D) +# (D) Add or remove newline between 'version (x)' and '{'. nl_version_brace = ignore # ignore/add/remove/force -# Add or remove newline between 'using' and '{' +# (C#) Add or remove newline between 'using' and '{'. nl_using_brace = ignore # ignore/add/remove/force -# Add or remove newline between two open or close braces. -# Due to general newline/brace handling, REMOVE may not work. +# Add or remove newline between two open or close braces. Due to general +# newline/brace handling, REMOVE may not work. nl_brace_brace = ignore # ignore/add/remove/force -# Add or remove newline between 'do' and '{' -nl_do_brace = add # ignore/add/remove/force +# Add or remove newline between 'do' and '{'. +nl_do_brace = force # ignore/add/remove/force -# Add or remove newline between '}' and 'while' of 'do' statement -nl_brace_while = add # ignore/add/remove/force +# Add or remove newline between '}' and 'while' of 'do' statement. +nl_brace_while = force # ignore/add/remove/force -# Add or remove newline between 'switch' and '{' -nl_switch_brace = add # ignore/add/remove/force +# Add or remove newline between 'switch' and '{'. +nl_switch_brace = force # ignore/add/remove/force -# Add or remove newline between 'synchronized' and '{' +# Add or remove newline between 'synchronized' and '{'. nl_synchronized_brace = ignore # ignore/add/remove/force -# Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc. -# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch and nl_catch_brace. -nl_multi_line_cond = false # false/true +# Add a newline between ')' and '{' if the ')' is on a different line than the +# if/for/etc. +# +# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch and +# nl_catch_brace. +nl_multi_line_cond = false # true/false # Force a newline in a define after the macro name for multi-line defines. -nl_multi_line_define = false # false/true +nl_multi_line_define = false # true/false -# Whether to put a newline before 'case' statement, not after the first 'case' -nl_before_case = false # false/true +# Whether to add a newline before 'case', and a blank line before a 'case' +# statement that follows a ';' or '}'. +nl_before_case = false # true/false -# Add or remove newline between ')' and 'throw' -nl_before_throw = ignore # ignore/add/remove/force +# Whether to add a newline after a 'case' statement. +nl_after_case = false # true/false -# Whether to put a newline after 'case' statement -nl_after_case = false # false/true - -# Add or remove a newline between a case ':' and '{'. Overrides nl_after_case. +# Add or remove newline between a case ':' and '{'. +# +# Overrides nl_after_case. nl_case_colon_brace = ignore # ignore/add/remove/force -# Newline between namespace and { -nl_namespace_brace = add # ignore/add/remove/force +# Add or remove newline between ')' and 'throw'. +nl_before_throw = ignore # ignore/add/remove/force + +# Add or remove newline between 'namespace' and '{'. +nl_namespace_brace = force # ignore/add/remove/force # Add or remove newline between 'template<>' and whatever follows. -nl_template_class = add # ignore/add/remove/force +nl_template_class = force # ignore/add/remove/force -# Add or remove newline between 'class' and '{' -nl_class_brace = add # ignore/add/remove/force +# Add or remove newline between 'class' and '{'. +nl_class_brace = force # ignore/add/remove/force -# Add or remove newline before/after each ',' in the base class list, -# (tied to pos_class_comma). +# Add or remove newline before or after (depending on pos_class_comma) each +# ',' in the base class list. nl_class_init_args = ignore # ignore/add/remove/force -# Add or remove newline after each ',' in the constructor member initialization. -# Related to nl_constr_colon, pos_constr_colon and pos_constr_comma. +# Add or remove newline after each ',' in the constructor member +# initialization. Related to nl_constr_colon, pos_constr_colon and +# pos_constr_comma. nl_constr_init_args = ignore # ignore/add/remove/force -# Add or remove newline before first element, after comma, and after last element in enum +# Add or remove newline before first element, after comma, and after last +# element, in 'enum'. nl_enum_own_lines = ignore # ignore/add/remove/force -# Add or remove newline between return type and function name in a function definition -nl_func_type_name = add # ignore/add/remove/force +# Add or remove newline between return type and function name in a function +# definition. +nl_func_type_name = force # ignore/add/remove/force -# Add or remove newline between return type and function name inside a class {} -# Uses nl_func_type_name or nl_func_proto_type_name if set to ignore. +# Add or remove newline between return type and function name inside a class +# definition. If set to ignore, nl_func_type_name or nl_func_proto_type_name +# is used instead. nl_func_type_name_class = ignore # ignore/add/remove/force -# Add or remove newline between class specification and '::' in 'void A::f() { }' -# Only appears in separate member implementation (does not appear with in-line implmementation) +# Add or remove newline between class specification and '::' +# in 'void A::f() { }'. Only appears in separate member implementation (does +# not appear with in-line implementation). nl_func_class_scope = ignore # ignore/add/remove/force -# Add or remove newline between function scope and name -# Controls the newline after '::' in 'void A::f() { }' +# Add or remove newline between function scope and name, as in +# 'void A :: f() { }'. nl_func_scope_name = ignore # ignore/add/remove/force -# Add or remove newline between return type and function name in a prototype +# Add or remove newline between return type and function name in a prototype. nl_func_proto_type_name = remove # ignore/add/remove/force -# Add or remove newline between a function name and the opening '(' in the declaration +# Add or remove newline between a function name and the opening '(' in the +# declaration. nl_func_paren = remove # ignore/add/remove/force -# Add or remove newline between a function name and the opening '(' in the definition +# Overrides nl_func_paren for functions with no parameters. +nl_func_paren_empty = ignore # ignore/add/remove/force + +# Add or remove newline between a function name and the opening '(' in the +# definition. nl_func_def_paren = ignore # ignore/add/remove/force -# Add or remove newline after '(' in a function declaration +# Overrides nl_func_def_paren for functions with no parameters. +nl_func_def_paren_empty = ignore # ignore/add/remove/force + +# Add or remove newline between a function name and the opening '(' in the +# call. +nl_func_call_paren = ignore # ignore/add/remove/force + +# Overrides nl_func_call_paren for functions with no parameters. +nl_func_call_paren_empty = ignore # ignore/add/remove/force + +# Add or remove newline after '(' in a function declaration. nl_func_decl_start = remove # ignore/add/remove/force -# Add or remove newline after '(' in a function definition +# Add or remove newline after '(' in a function definition. nl_func_def_start = ignore # ignore/add/remove/force # Overrides nl_func_decl_start when there is only one parameter. @@ -1280,28 +1541,32 @@ nl_func_decl_start_single = ignore # ignore/add/remove/force # Overrides nl_func_def_start when there is only one parameter. nl_func_def_start_single = ignore # ignore/add/remove/force -# Whether to add newline after '(' in a function declaration if '(' and ')' are in different lines. -nl_func_decl_start_multi_line = false # false/true +# Whether to add a newline after '(' in a function declaration if '(' and ')' +# are in different lines. If false, nl_func_decl_start is used instead. +nl_func_decl_start_multi_line = false # true/false -# Whether to add newline after '(' in a function definition if '(' and ')' are in different lines. -nl_func_def_start_multi_line = false # false/true +# Whether to add a newline after '(' in a function definition if '(' and ')' +# are in different lines. If false, nl_func_def_start is used instead. +nl_func_def_start_multi_line = false # true/false -# Add or remove newline after each ',' in a function declaration +# Add or remove newline after each ',' in a function declaration. nl_func_decl_args = ignore # ignore/add/remove/force -# Add or remove newline after each ',' in a function definition +# Add or remove newline after each ',' in a function definition. nl_func_def_args = ignore # ignore/add/remove/force -# Whether to add newline after each ',' in a function declaration if '(' and ')' are in different lines. -nl_func_decl_args_multi_line = false # false/true +# Whether to add a newline after each ',' in a function declaration if '(' +# and ')' are in different lines. If false, nl_func_decl_args is used instead. +nl_func_decl_args_multi_line = false # true/false -# Whether to add newline after each ',' in a function definition if '(' and ')' are in different lines. -nl_func_def_args_multi_line = false # false/true +# Whether to add a newline after each ',' in a function definition if '(' +# and ')' are in different lines. If false, nl_func_def_args is used instead. +nl_func_def_args_multi_line = false # true/false -# Add or remove newline before the ')' in a function declaration +# Add or remove newline before the ')' in a function declaration. nl_func_decl_end = ignore # ignore/add/remove/force -# Add or remove newline before the ')' in a function definition +# Add or remove newline before the ')' in a function definition. nl_func_def_end = ignore # ignore/add/remove/force # Overrides nl_func_decl_end when there is only one parameter. @@ -1310,11 +1575,13 @@ nl_func_decl_end_single = ignore # ignore/add/remove/force # Overrides nl_func_def_end when there is only one parameter. nl_func_def_end_single = ignore # ignore/add/remove/force -# Whether to add newline before ')' in a function declaration if '(' and ')' are in different lines. -nl_func_decl_end_multi_line = false # false/true +# Whether to add a newline before ')' in a function declaration if '(' and ')' +# are in different lines. If false, nl_func_decl_end is used instead. +nl_func_decl_end_multi_line = false # true/false -# Whether to add newline before ')' in a function definition if '(' and ')' are in different lines. -nl_func_def_end_multi_line = false # false/true +# Whether to add a newline before ')' in a function definition if '(' and ')' +# are in different lines. If false, nl_func_def_end is used instead. +nl_func_def_end_multi_line = false # true/false # Add or remove newline between '()' in a function declaration. nl_func_decl_empty = ignore # ignore/add/remove/force @@ -1322,640 +1589,1148 @@ nl_func_decl_empty = ignore # ignore/add/remove/force # Add or remove newline between '()' in a function definition. nl_func_def_empty = ignore # ignore/add/remove/force -# Whether to add newline after '(' in a function call if '(' and ')' are in different lines. -nl_func_call_start_multi_line = false # false/true +# Add or remove newline between '()' in a function call. +nl_func_call_empty = ignore # ignore/add/remove/force -# Whether to add newline after each ',' in a function call if '(' and ')' are in different lines. -nl_func_call_args_multi_line = false # false/true +# Whether to add a newline after '(' in a function call if '(' and ')' are in +# different lines. +nl_func_call_start_multi_line = false # true/false -# Whether to add newline before ')' in a function call if '(' and ')' are in different lines. -nl_func_call_end_multi_line = false # false/true +# Whether to add a newline after each ',' in a function call if '(' and ')' +# are in different lines. +nl_func_call_args_multi_line = false # true/false -# Whether to put each OC message parameter on a separate line -# See nl_oc_msg_leave_one_liner -nl_oc_msg_args = false # false/true +# Whether to add a newline before ')' in a function call if '(' and ')' are in +# different lines. +nl_func_call_end_multi_line = false # true/false -# Add or remove newline between function signature and '{' -nl_fdef_brace = add # ignore/add/remove/force +# (OC) Whether to put each Objective-C message parameter on a separate line. +# See nl_oc_msg_leave_one_liner. +nl_oc_msg_args = false # true/false -# Add or remove newline between C++11 lambda signature and '{' +# Add or remove newline between function signature and '{'. +nl_fdef_brace = force # ignore/add/remove/force + +# Add or remove newline between C++11 lambda signature and '{'. nl_cpp_ldef_brace = ignore # ignore/add/remove/force -# Add or remove a newline between the return keyword and return expression. -nl_return_expr = ignore # ignore/add/remove/force +# Add or remove newline between 'return' and the return expression. +nl_return_expr = remove # ignore/add/remove/force -# Whether to put a newline after semicolons, except in 'for' statements -nl_after_semicolon = false # false/true +# Whether to add a newline after semicolons, except in 'for' statements. +nl_after_semicolon = false # true/false -# Java: Control the newline between the ')' and '{{' of the double brace initializer. +# (Java) Add or remove newline between the ')' and '{{' of the double brace +# initializer. nl_paren_dbrace_open = ignore # ignore/add/remove/force -# Whether to put a newline after brace open. -# This also adds a newline before the matching brace close. -nl_after_brace_open = false # false/true +# Whether to add a newline after the type in an unnamed temporary +# direct-list-initialization. +nl_type_brace_init_lst = ignore # ignore/add/remove/force -# If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is -# placed between the open brace and a trailing single-line comment. -nl_after_brace_open_cmt = false # false/true +# Whether to add a newline after the open brace in an unnamed temporary +# direct-list-initialization. +nl_type_brace_init_lst_open = ignore # ignore/add/remove/force -# Whether to put a newline after a virtual brace open with a non-empty body. +# Whether to add a newline before the close brace in an unnamed temporary +# direct-list-initialization. +nl_type_brace_init_lst_close = ignore # ignore/add/remove/force + +# Whether to add a newline after '{'. This also adds a newline before the +# matching '}'. +nl_after_brace_open = false # true/false + +# Whether to add a newline between the open brace and a trailing single-line +# comment. Requires nl_after_brace_open=true. +nl_after_brace_open_cmt = false # true/false + +# Whether to add a newline after a virtual brace open with a non-empty body. # These occur in un-braced if/while/do/for statement bodies. -nl_after_vbrace_open = false # false/true +nl_after_vbrace_open = false # true/false -# Whether to put a newline after a virtual brace open with an empty body. +# Whether to add a newline after a virtual brace open with an empty body. # These occur in un-braced if/while/do/for statement bodies. -nl_after_vbrace_open_empty = false # false/true +nl_after_vbrace_open_empty = false # true/false -# Whether to put a newline after a brace close. -# Does not apply if followed by a necessary ';'. -nl_after_brace_close = false # false/true +# Whether to add a newline after '}'. Does not apply if followed by a +# necessary ';'. +nl_after_brace_close = false # true/false -# Whether to put a newline after a virtual brace close. -# Would add a newline before return in: 'if (foo) a++; return;' -nl_after_vbrace_close = false # false/true +# Whether to add a newline after a virtual brace close, +# as in 'if (foo) a++; return;'. +nl_after_vbrace_close = false # true/false -# Control the newline between the close brace and 'b' in: 'struct { int a; } b;' -# Affects enums, unions and structures. If set to ignore, uses nl_after_brace_close +# Add or remove newline between the close brace and identifier, +# as in 'struct { int a; } b;'. Affects enumerations, unions and +# structures. If set to ignore, uses nl_after_brace_close. nl_brace_struct_var = ignore # ignore/add/remove/force -# Whether to alter newlines in '#define' macros -nl_define_macro = false # false/true +# Whether to alter newlines in '#define' macros. +nl_define_macro = false # true/false -# Whether to remove blanks after '#ifxx' and '#elxx', or before '#elxx' and '#endif'. Does not affect top-level #ifdefs. -nl_squeeze_ifdef = false # false/true +# Whether to alter newlines between consecutive parenthesis closes. The number +# of closing parentheses in a line will depend on respective open parenthesis +# lines. +nl_squeeze_paren_close = false # true/false + +# Whether to remove blanks after '#ifxx' and '#elxx', or before '#elxx' and +# '#endif'. Does not affect top-level #ifdefs. +nl_squeeze_ifdef = false # true/false # Makes the nl_squeeze_ifdef option affect the top-level #ifdefs as well. -nl_squeeze_ifdef_top_level = false # false/true +nl_squeeze_ifdef_top_level = false # true/false -# Add or remove blank line before 'if' +# Add or remove blank line before 'if'. nl_before_if = ignore # ignore/add/remove/force -# Add or remove blank line after 'if' statement +# Add or remove blank line after 'if' statement. Add/Force work only if the +# next token is not a closing brace. nl_after_if = ignore # ignore/add/remove/force -# Add or remove blank line before 'for' +# Add or remove blank line before 'for'. nl_before_for = ignore # ignore/add/remove/force -# Add or remove blank line after 'for' statement +# Add or remove blank line after 'for' statement. nl_after_for = ignore # ignore/add/remove/force -# Add or remove blank line before 'while' +# Add or remove blank line before 'while'. nl_before_while = ignore # ignore/add/remove/force -# Add or remove blank line after 'while' statement +# Add or remove blank line after 'while' statement. nl_after_while = ignore # ignore/add/remove/force -# Add or remove blank line before 'switch' +# Add or remove blank line before 'switch'. nl_before_switch = ignore # ignore/add/remove/force -# Add or remove blank line after 'switch' statement +# Add or remove blank line after 'switch' statement. nl_after_switch = ignore # ignore/add/remove/force -# Add or remove blank line before 'synchronized' +# Add or remove blank line before 'synchronized'. nl_before_synchronized = ignore # ignore/add/remove/force -# Add or remove blank line after 'synchronized' statement +# Add or remove blank line after 'synchronized' statement. nl_after_synchronized = ignore # ignore/add/remove/force -# Add or remove blank line before 'do' +# Add or remove blank line before 'do'. nl_before_do = ignore # ignore/add/remove/force -# Add or remove blank line after 'do/while' statement +# Add or remove blank line after 'do/while' statement. nl_after_do = ignore # ignore/add/remove/force -# Whether to double-space commented-entries in struct/union/enum -nl_ds_struct_enum_cmt = false # false/true +# Whether to double-space commented-entries in 'struct'/'union'/'enum'. +nl_ds_struct_enum_cmt = false # true/false -# force nl before } of a struct/union/enum -# (lower priority than 'eat_blanks_before_close_brace') -nl_ds_struct_enum_close_brace = false # false/true +# Whether to force a newline before '}' of a 'struct'/'union'/'enum'. +# (Lower priority than eat_blanks_before_close_brace.) +nl_ds_struct_enum_close_brace = false # true/false -# Add or remove blank line before 'func_class_def' -nl_before_func_class_def = 0 # number - -# Add or remove blank line before 'func_class_proto' -nl_before_func_class_proto = 0 # number - -# Add or remove a newline before/after a class colon, -# (tied to pos_class_colon). +# Add or remove newline before or after (depending on pos_class_colon) a class +# colon, as in 'class Foo : public Bar'. nl_class_colon = ignore # ignore/add/remove/force -# Add or remove a newline around a class constructor colon. -# Related to nl_constr_init_args, pos_constr_colon and pos_constr_comma. +# Add or remove newline around a class constructor colon. The exact position +# depends on nl_constr_init_args, pos_constr_colon and pos_constr_comma. nl_constr_colon = ignore # ignore/add/remove/force -# Change simple unbraced if statements into a one-liner -# 'if(b)\n i++;' => 'if(b) i++;' -nl_create_if_one_liner = false # false/true +# Whether to collapse a two-line namespace, like 'namespace foo\n{ decl; }' +# into a single line. If true, prevents other brace newline rules from turning +# such code into four lines. +nl_namespace_two_to_one_liner = false # true/false -# Change simple unbraced for statements into a one-liner -# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);' -nl_create_for_one_liner = false # false/true +# Whether to remove a newline in simple unbraced if statements, turning them +# into one-liners, as in 'if(b)\n i++;' → 'if(b) i++;'. +nl_create_if_one_liner = false # true/false -# Change simple unbraced while statements into a one-liner -# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);' -nl_create_while_one_liner = false # false/true +# Whether to remove a newline in simple unbraced for statements, turning them +# into one-liners, as in 'for (...)\n stmt;' → 'for (...) stmt;'. +nl_create_for_one_liner = false # true/false -# Change a one-liner if statement into simple unbraced if -# 'if(b) i++;' => 'if(b) i++;' -nl_split_if_one_liner = false # false/true +# Whether to remove a newline in simple unbraced while statements, turning +# them into one-liners, as in 'while (expr)\n stmt;' → 'while (expr) stmt;'. +nl_create_while_one_liner = false # true/false -# Change a one-liner for statement into simple unbraced for -# 'for (i=0;<5;i++) foo(i);' => 'for (i=0;<5;i++) foo(i);' -nl_split_for_one_liner = false # false/true +# Whether to collapse a function definition whose body (not counting braces) +# is only one line so that the entire definition (prototype, braces, body) is +# a single line. +nl_create_func_def_one_liner = false # true/false -# Change simple unbraced while statements into a one-liner while -# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);' -nl_split_while_one_liner = false # false/true +# Whether to split one-line simple unbraced if statements into two lines by +# adding a newline, as in 'if(b) i++;'. +nl_split_if_one_liner = false # true/false -# -# Positioning options -# +# Whether to split one-line simple unbraced for statements into two lines by +# adding a newline, as in 'for (...) stmt;'. +nl_split_for_one_liner = false # true/false -# The position of arithmetic operators in wrapped expressions -pos_arith = lead # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of assignment in wrapped expressions. -# Do not affect '=' followed by '{' -pos_assign = lead # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of boolean operators in wrapped expressions -pos_bool = lead # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of comparison operators in wrapped expressions -pos_compare = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of conditional (b ? t : f) operators in wrapped expressions -pos_conditional = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in wrapped expressions -pos_comma = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in enum entries -pos_enum_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in the base class list if there are more than one line, -# (tied to nl_class_init_args). -pos_class_comma = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of the comma in the constructor initialization list. -# Related to nl_constr_colon, nl_constr_init_args and pos_constr_colon. -pos_constr_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of trailing/leading class colon, between class and base class list -# (tied to nl_class_colon). -pos_class_colon = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# The position of colons between constructor and member initialization, -# (tied to UO_nl_constr_colon). -# Related to nl_constr_colon, nl_constr_init_args and pos_constr_comma. -pos_constr_colon = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force - -# -# Line Splitting options -# - -# Try to limit code width to N number of columns -code_width = 0 # number - -# Whether to fully split long 'for' statements at semi-colons -ls_for_split_full = false # false/true - -# Whether to fully split long function protos/calls at commas -ls_func_split_full = false # false/true - -# Whether to split lines as close to code_width as possible and ignore some groupings -ls_code_width = false # false/true +# Whether to split one-line simple unbraced while statements into two lines by +# adding a newline, as in 'while (expr) stmt;'. +nl_split_while_one_liner = false # true/false # # Blank line options # -# The maximum consecutive newlines (3 = 2 blank lines) -nl_max = 2 # number +# The maximum number of consecutive newlines (3 = 2 blank lines). +nl_max = 2 # unsigned number -# The number of newlines after a function prototype, if followed by another function prototype -nl_after_func_proto = 0 # number +# The maximum number of consecutive newlines in a function. +nl_max_blank_in_func = 0 # unsigned number -# The number of newlines after a function prototype, if not followed by another function prototype -nl_after_func_proto_group = 0 # number +# The number of newlines before a function prototype. +nl_before_func_body_proto = 0 # unsigned number -# The number of newlines after a function class prototype, if followed by another function class prototype -nl_after_func_class_proto = 0 # number +# The number of newlines before a multi-line function definition. +nl_before_func_body_def = 0 # unsigned number -# The number of newlines after a function class prototype, if not followed by another function class prototype -nl_after_func_class_proto_group = 0 # number +# The number of newlines before a class constructor/destructor prototype. +nl_before_func_class_proto = 0 # unsigned number -# The number of newlines before a multi-line function def body -nl_before_func_body_def = 0 # number +# The number of newlines before a class constructor/destructor definition. +nl_before_func_class_def = 0 # unsigned number -# The number of newlines before a multi-line function prototype body -nl_before_func_body_proto = 0 # number +# The number of newlines after a function prototype. +nl_after_func_proto = 0 # unsigned number -# The number of newlines after '}' of a multi-line function body -nl_after_func_body = 0 # number +# The number of newlines after a function prototype, if not followed by +# another function prototype. +nl_after_func_proto_group = 0 # unsigned number -# The number of newlines after '}' of a multi-line function body in a class declaration -nl_after_func_body_class = 0 # number +# The number of newlines after a class constructor/destructor prototype. +nl_after_func_class_proto = 0 # unsigned number -# The number of newlines after '}' of a single line function body -nl_after_func_body_one_liner = 0 # number +# The number of newlines after a class constructor/destructor prototype, +# if not followed by another constructor/destructor prototype. +nl_after_func_class_proto_group = 0 # unsigned number + +# Whether one-line method definitions inside a class body should be treated +# as if they were prototypes for the purposes of adding newlines. +# +# Requires nl_class_leave_one_liners=true. Overrides nl_before_func_body_def +# and nl_before_func_class_def for one-liners. +nl_class_leave_one_liner_groups = false # true/false + +# The number of newlines after '}' of a multi-line function body. +nl_after_func_body = 0 # unsigned number + +# The number of newlines after '}' of a multi-line function body in a class +# declaration. Also affects class constructors/destructors. +# +# Overrides nl_after_func_body. +nl_after_func_body_class = 0 # unsigned number + +# The number of newlines after '}' of a single line function body. Also +# affects class constructors/destructors. +# +# Overrides nl_after_func_body and nl_after_func_body_class. +nl_after_func_body_one_liner = 0 # unsigned number # The minimum number of newlines before a multi-line comment. # Doesn't apply if after a brace open or another multi-line comment. -nl_before_block_comment = 0 # number +nl_before_block_comment = 0 # unsigned number # The minimum number of newlines before a single-line C comment. # Doesn't apply if after a brace open or other single-line C comments. -nl_before_c_comment = 0 # number +nl_before_c_comment = 0 # unsigned number # The minimum number of newlines before a CPP comment. # Doesn't apply if after a brace open or other CPP comments. -nl_before_cpp_comment = 0 # number +nl_before_cpp_comment = 0 # unsigned number # Whether to force a newline after a multi-line comment. -nl_after_multiline_comment = false # false/true +nl_after_multiline_comment = false # true/false # Whether to force a newline after a label's colon. -nl_after_label_colon = false # false/true +nl_after_label_colon = false # true/false -# The number of newlines after '}' or ';' of a struct/enum/union definition -nl_after_struct = 0 # number +# The number of newlines after '}' or ';' of a struct/enum/union definition. +nl_after_struct = 0 # unsigned number -# The number of newlines before a class definition -nl_before_class = 0 # number +# The number of newlines before a class definition. +nl_before_class = 0 # unsigned number -# The number of newlines after '}' or ';' of a class definition -nl_after_class = 0 # number +# The number of newlines after '}' or ';' of a class definition. +nl_after_class = 0 # unsigned number -# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. -# Will not change the newline count if after a brace open. -# 0 = No change. -nl_before_access_spec = 0 # number +# The number of newlines before an access specifier label. This also includes +# the Qt-specific 'signals:' and 'slots:'. Will not change the newline count +# if after a brace open. +# +# 0 = No change (default). +nl_before_access_spec = 0 # unsigned number -# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:' or 'slots:' label. -# 0 = No change. -# the option 'nl_after_access_spec' takes preference over 'nl_typedef_blk_start' and 'nl_var_def_blk_start' -nl_after_access_spec = 0 # number +# The number of newlines after an access specifier label. This also includes +# the Qt-specific 'signals:' and 'slots:'. Will not change the newline count +# if after a brace open. +# +# 0 = No change (default). +# +# Overrides nl_typedef_blk_start and nl_var_def_blk_start. +nl_after_access_spec = 0 # unsigned number -# The number of newlines between a function def and the function comment. -# 0 = No change. -nl_comment_func_def = 0 # number +# The number of newlines between a function definition and the function +# comment, as in '// comment\n void foo() {...}'. +# +# 0 = No change (default). +nl_comment_func_def = 0 # unsigned number -# The number of newlines after a try-catch-finally block that isn't followed by a brace close. -# 0 = No change. -nl_after_try_catch_finally = 0 # number +# The number of newlines after a try-catch-finally block that isn't followed +# by a brace close. +# +# 0 = No change (default). +nl_after_try_catch_finally = 0 # unsigned number -# The number of newlines before and after a property, indexer or event decl. -# 0 = No change. -nl_around_cs_property = 0 # number +# (C#) The number of newlines before and after a property, indexer or event +# declaration. +# +# 0 = No change (default). +nl_around_cs_property = 0 # unsigned number -# The number of newlines between the get/set/add/remove handlers in C#. -# 0 = No change. -nl_between_get_set = 0 # number +# (C#) The number of newlines between the get/set/add/remove handlers. +# +# 0 = No change (default). +nl_between_get_set = 0 # unsigned number -# Add or remove newline between C# property and the '{' +# (C#) Add or remove newline between property and the '{'. nl_property_brace = ignore # ignore/add/remove/force -# Whether to remove blank lines after '{' -eat_blanks_after_open_brace = false # false/true +# The number of newlines after '{' of a namespace. This also adds newlines +# before the matching '}'. +# +# 0 = Apply eat_blanks_after_open_brace or eat_blanks_before_close_brace if +# applicable, otherwise no change. +# +# Overrides eat_blanks_after_open_brace and eat_blanks_before_close_brace. +nl_inside_namespace = 0 # unsigned number -# Whether to remove blank lines before '}' -eat_blanks_before_close_brace = false # false/true +# Whether to remove blank lines after '{'. +eat_blanks_after_open_brace = false # true/false -# How aggressively to remove extra newlines not in preproc. -# 0: No change +# Whether to remove blank lines before '}'. +eat_blanks_before_close_brace = false # true/false + +# How aggressively to remove extra newlines not in preprocessor. +# +# 0: No change (default) # 1: Remove most newlines not handled by other config # 2: Remove all newlines and reformat completely by config -nl_remove_extra_newlines = 0 # number +nl_remove_extra_newlines = 0 # unsigned number -# Whether to put a blank line before 'return' statements, unless after an open brace. -nl_before_return = false # false/true +# Whether to put a blank line before 'return' statements, unless after an open +# brace. +nl_before_return = false # true/false -# Whether to put a blank line after 'return' statements, unless followed by a close brace. -nl_after_return = false # false/true +# Whether to put a blank line after 'return' statements, unless followed by a +# close brace. +nl_after_return = false # true/false -# Whether to put a newline after a Java annotation statement. -# Only affects annotations that are after a newline. +# (Java) Add or remove newline after an annotation statement. Only affects +# annotations that are after a newline. nl_after_annotation = ignore # ignore/add/remove/force -# Controls the newline between two annotations. +# (Java) Add or remove newline between two annotations. nl_between_annotation = ignore # ignore/add/remove/force +# +# Positioning options +# + +# The position of arithmetic operators in wrapped expressions. +pos_arith = lead # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of assignment in wrapped expressions. Do not affect '=' +# followed by '{'. +pos_assign = lead # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of Boolean operators in wrapped expressions. +pos_bool = lead # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of comparison operators in wrapped expressions. +pos_compare = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of conditional operators, as in the '?' and ':' of +# 'expr ? stmt : stmt', in wrapped expressions. +pos_conditional = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of the comma in wrapped expressions. +pos_comma = trail # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of the comma in enum entries. +pos_enum_comma = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of the comma in the base class list if there is more than one +# line. Affects nl_class_init_args. +pos_class_comma = trail # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of the comma in the constructor initialization list. +# Related to nl_constr_colon, nl_constr_init_args and pos_constr_colon. +pos_constr_comma = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of trailing/leading class colon, between class and base class +# list. Affects nl_class_colon. +pos_class_colon = trail # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# The position of colons between constructor and member initialization. +# Related to nl_constr_colon, nl_constr_init_args and pos_constr_comma. +pos_constr_colon = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force + +# +# Line splitting options +# + +# Try to limit code width to N columns. +code_width = 0 # unsigned number + +# Whether to fully split long 'for' statements at semi-colons. +ls_for_split_full = false # true/false + +# Whether to fully split long function prototypes/calls at commas. +ls_func_split_full = false # true/false + +# Whether to split lines as close to code_width as possible and ignore some +# groupings. +ls_code_width = false # true/false + +# +# Code alignment options (not left column spaces/tabs) +# + +# Whether to keep non-indenting tabs. +align_keep_tabs = false # true/false + +# Whether to use tabs for aligning. +align_with_tabs = false # true/false + +# Whether to bump out to the next tab when aligning. +align_on_tabstop = false # true/false + +# Whether to right-align numbers. +align_number_right = false # true/false + +# Whether to keep whitespace not required for alignment. +align_keep_extra_space = false # true/false + +# Whether to align variable definitions in prototypes and functions. +align_func_params = false # true/false + +# The span for aligning parameter definitions in function on parameter name. +# +# 0 = Don't align (default). +align_func_params_span = 0 # unsigned number + +# The threshold for aligning function parameter definitions. +# +# 0 = No limit (default). +align_func_params_thresh = 0 # unsigned number + +# The gap for aligning function parameter definitions. +align_func_params_gap = 0 # unsigned number + +# Whether to 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 # true/false + +# The span for aligning function-call parameters for single line functions. +# +# 0 = Don't align (default). +align_same_func_call_params_span = 0 # unsigned number + +# The threshold for aligning function-call parameters for single line +# functions. +# +# 0 = No limit (default). +align_same_func_call_params_thresh = 0 # unsigned number + +# The span for aligning variable definitions. +# +# 0 = Don't align (default). +align_var_def_span = 0 # unsigned number + +# How to align the '*' in variable definitions. +# +# 0: Part of the type 'void * foo;' (default) +# 1: Part of the variable 'void *foo;' +# 2: Dangling 'void *foo;' +align_var_def_star_style = 0 # unsigned number + +# How to align the '&' in variable definitions. +# +# 0: Part of the type 'long & foo;' (default) +# 1: Part of the variable 'long &foo;' +# 2: Dangling 'long &foo;' +align_var_def_amp_style = 0 # unsigned number + +# The threshold for aligning variable definitions. +# +# 0 = No limit (default). +align_var_def_thresh = 0 # unsigned number + +# The gap for aligning variable definitions. +align_var_def_gap = 0 # unsigned number + +# Whether to align the colon in struct bit fields. +align_var_def_colon = false # true/false + +# The gap for aligning the colon in struct bit fields. +align_var_def_colon_gap = 0 # unsigned number + +# Whether to align any attribute after the variable name. +align_var_def_attribute = false # true/false + +# Whether to align inline struct/enum/union variable definitions. +align_var_def_inline = false # true/false + +# The span for aligning on '=' in assignments. +# +# 0 = Don't align (default). +align_assign_span = 0 # unsigned number + +# The threshold for aligning on '=' in assignments. +# +# 0 = No limit (default). +align_assign_thresh = 0 # unsigned number + +# How to apply align_assign_span to function declaration "assignments", i.e. +# 'virtual void foo() = 0' or '~foo() = {default|delete}'. +# +# 0: Align with other assignments (default) +# 1: Align with each other, ignoring regular assignments +# 2: Don't align +align_assign_decl_func = 0 # unsigned number + +# The span for aligning on '=' in enums. +# +# 0 = Don't align (default). +align_enum_equ_span = 0 # unsigned number + +# The threshold for aligning on '=' in enums. +# +# 0 = no limit (default). +align_enum_equ_thresh = 0 # unsigned number + +# The span for aligning class member definitions. +# +# 0 = Don't align (default). +align_var_class_span = 0 # unsigned number + +# The threshold for aligning class member definitions. +# +# 0 = No limit (default). +align_var_class_thresh = 0 # unsigned number + +# The gap for aligning class member definitions. +align_var_class_gap = 0 # unsigned number + +# The span for aligning struct/union member definitions. +# +# 0 = Don't align (default). +align_var_struct_span = 0 # unsigned number + +# The threshold for aligning struct/union member definitions. +# +# 0 = No limit (default). +align_var_struct_thresh = 0 # unsigned number + +# The gap for aligning struct/union member definitions. +align_var_struct_gap = 0 # unsigned number + +# The span for aligning struct initializer values. +# +# 0 = Don't align (default). +align_struct_init_span = 0 # unsigned number + +# The minimum space between the type and the synonym of a typedef. +align_typedef_gap = 0 # unsigned number + +# The span for aligning single-line typedefs. +# +# 0 = Don't align (default). +align_typedef_span = 0 # unsigned number + +# How to align typedef'd functions with other typedefs. +# +# 0: Don't mix them at all (default) +# 1: Align the open parenthesis with the types +# 2: Align the function type name with the other type names +align_typedef_func = 0 # unsigned number + +# How to align the '*' in typedefs. +# +# 0: Align on typedef type, ignore '*' (default) +# 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 # unsigned number + +# How to align the '&' in typedefs. +# +# 0: Align on typedef type, ignore '&' (default) +# 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 # unsigned number + +# The span for aligning comments that end lines. +# +# 0 = Don't align (default). +align_right_cmt_span = 0 # unsigned number + +# If aligning comments, whether to mix with comments after '}' and #endif with +# less than three spaces before the comment. +align_right_cmt_mix = false # true/false + +# Whether to only align trailing comments that are at the same brace level. +align_right_cmt_same_level = false # true/false + +# Minimum number of columns between preceding text and a trailing comment in +# order for the comment to qualify for being aligned. Must be non-zero to have +# an effect. +align_right_cmt_gap = 0 # unsigned number + +# Minimum column at which to align trailing comments. Comments which are +# aligned beyond this column, but which can be aligned in a lesser column, +# may be "pulled in". +# +# 0 = Ignore (default). +align_right_cmt_at_col = 0 # unsigned number + +# The span for aligning function prototypes. +# +# 0 = Don't align (default). +align_func_proto_span = 0 # unsigned number + +# Minimum gap between the return type and the function name. +align_func_proto_gap = 0 # unsigned number + +# Whether to align function prototypes on the 'operator' keyword instead of +# what follows. +align_on_operator = false # true/false + +# 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 # true/false + +# Whether to align single-line functions with function prototypes. +# Uses align_func_proto_span. +align_single_line_func = false # true/false + +# Whether to align the open brace of single-line functions. +# Requires align_single_line_func=true. Uses align_func_proto_span. +align_single_line_brace = false # true/false + +# Gap for align_single_line_brace. +align_single_line_brace_gap = 0 # unsigned number + +# (OC) The span for aligning Objective-C message specifications. +# +# 0 = Don't align (default). +align_oc_msg_spec_span = 0 # unsigned 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 = false # true/false + +# Whether to align macro functions and variables together. +align_pp_define_together = false # true/false + +# The minimum space between label and value of a preprocessor define. +align_pp_define_gap = 0 # unsigned number + +# The span for aligning on '#define' bodies. +# +# =0: Don't align (default) +# >0: Number of lines (including comments) between blocks +align_pp_define_span = 0 # unsigned number + +# Whether to align lines that start with '<<' with previous '<<'. +# +# Default: true +align_left_shift = true # true/false + +# Whether to align text after 'asm volatile ()' colons. +align_asm_colon = false # true/false + +# (OC) Span for aligning parameters in an Objective-C message call +# on the ':'. +# +# 0 = Don't align. +align_oc_msg_colon_span = 0 # unsigned number + +# (OC) Whether to always align with the first parameter, even if it is too +# short. +align_oc_msg_colon_first = false # true/false + +# (OC) Whether to align parameters in an Objective-C '+' or '-' declaration +# on the ':'. +align_oc_decl_colon = false # true/false + +# +# Comment modification options +# + +# Try to wrap comments at N columns. +cmt_width = 0 # unsigned number + +# How to reflow comments. +# +# 0: No reflowing (apart from the line wrapping due to cmt_width) (default) +# 1: No touching at all +# 2: Full reflow +cmt_reflow_mode = 0 # unsigned number + +# Whether to convert all tabs to spaces in comments. If false, tabs in +# comments are left alone, unless used for indenting. +cmt_convert_tab_to_spaces = false # true/false + +# Whether to apply changes to multi-line comments, including cmt_width, +# keyword substitution and leading chars. +# +# Default: true +cmt_indent_multi = true # true/false + +# Whether to group c-comments that look like they are in a block. +cmt_c_group = false # true/false + +# Whether to put an empty '/*' on the first line of the combined c-comment. +cmt_c_nl_start = false # true/false + +# Whether to add a newline before the closing '*/' of the combined c-comment. +cmt_c_nl_end = false # true/false + +# Whether to change cpp-comments into c-comments. +cmt_cpp_to_c = false # true/false + +# Whether to group cpp-comments that look like they are in a block. Only +# meaningful if cmt_cpp_to_c=true. +cmt_cpp_group = false # true/false + +# Whether to put an empty '/*' on the first line of the combined cpp-comment +# when converting to a c-comment. +# +# Requires cmt_cpp_to_c=true and cmt_cpp_group=true. +cmt_cpp_nl_start = false # true/false + +# Whether to add a newline before the closing '*/' of the combined cpp-comment +# when converting to a c-comment. +# +# Requires cmt_cpp_to_c=true and cmt_cpp_group=true. +cmt_cpp_nl_end = false # true/false + +# Whether to put a star on subsequent comment lines. +cmt_star_cont = false # true/false + +# The number of spaces to insert at the start of subsequent comment lines. +cmt_sp_before_star_cont = 0 # unsigned number + +# The number of spaces to insert after the star on subsequent comment lines. +cmt_sp_after_star_cont = 0 # unsigned number + +# For multi-line comments with a '*' lead, remove leading spaces if the first +# and last lines of the comment are the same length. +# +# Default: true +cmt_multi_check_last = true # true/false + +# For multi-line comments with a '*' lead, remove leading spaces if the first +# and last lines of the comment are the same length AND if the length is +# bigger as the first_len minimum. +# +# Default: 4 +cmt_multi_first_len_minimum = 4 # unsigned number + +# Path to a file that contains text to insert at the beginning of a file if +# the file doesn't start with a C/C++ comment. If the inserted text contains +# '$(filename)', that will be replaced with the current file's name. +cmt_insert_file_header = "" # string + +# Path to a file that contains text to insert at the end of a file if the +# file doesn't end with a C/C++ comment. If the inserted text contains +# '$(filename)', that will be replaced with the current file's name. +cmt_insert_file_footer = "" # string + +# Path to a file that contains text to insert before a function definition if +# the function isn't preceded by a C/C++ comment. If the inserted text +# contains '$(function)', '$(javaparam)' or '$(fclass)', these will be +# replaced with, respectively, the name of the function, the javadoc '@param' +# and '@return' stuff, or the name of the class to which the member function +# belongs. +cmt_insert_func_header = "" # string + +# Path to a file that contains text to insert before a class if the class +# isn't preceded by a C/C++ comment. If the inserted text contains '$(class)', +# that will be replaced with the class name. +cmt_insert_class_header = "" # string + +# Path to a file that contains text to insert before an Objective-C message +# specification, if the method isn't preceded by a C/C++ comment. If the +# inserted text contains '$(message)' or '$(javaparam)', these will be +# replaced with, respectively, the name of the function, or the javadoc +# '@param' and '@return' stuff. +cmt_insert_oc_msg_header = "" # string + +# Whether a comment should be inserted if a preprocessor is encountered when +# stepping backwards from a function name. +# +# Applies to cmt_insert_oc_msg_header, cmt_insert_func_header and +# cmt_insert_class_header. +cmt_insert_before_preproc = false # true/false + +# Whether a comment should be inserted if a function is declared inline to a +# class definition. +# +# Applies to cmt_insert_func_header. +# +# Default: true +cmt_insert_before_inlines = true # true/false + +# Whether a comment should be inserted if the function is a class constructor +# or destructor. +# +# Applies to cmt_insert_func_header. +cmt_insert_before_ctor_dtor = false # true/false + # # Code modifying options (non-whitespace) # -# Add or remove braces on single-line 'do' statement +# Add or remove braces on a single-line 'do' statement. mod_full_brace_do = ignore # ignore/add/remove/force -# Add or remove braces on single-line 'for' statement +# Add or remove braces on a single-line 'for' statement. mod_full_brace_for = ignore # ignore/add/remove/force -# Add or remove braces on single-line function definitions. (Pawn) +# (Pawn) Add or remove braces on a single-line function definition. mod_full_brace_function = ignore # ignore/add/remove/force -# Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'. +# Add or remove braces on a single-line 'if' statement. Braces will not be +# removed if the braced statement contains an 'else'. mod_full_brace_if = ignore # ignore/add/remove/force -# Make all if/elseif/else statements in a chain be braced or not. Overrides mod_full_brace_if. -# If any must be braced, they are all braced. If all can be unbraced, then the braces are removed. -mod_full_brace_if_chain = false # false/true +# Whether to enforce that all blocks of an 'if'/'else if'/'else' chain either +# have, or do not have, braces. If true, braces will be added if any block +# needs braces, and will only be removed if they can be removed from all +# blocks. +# +# Overrides mod_full_brace_if. +mod_full_brace_if_chain = false # true/false -# Make all if/elseif/else statements with at least one 'else' or 'else if' fully braced. -# If mod_full_brace_if_chain is used together with this option, all if-else chains will get braces, -# and simple 'if' statements will lose them (if possible). -mod_full_brace_if_chain_only = false # false/true +# Whether to add braces to all blocks of an 'if'/'else if'/'else' chain. +# If true, mod_full_brace_if_chain will only remove braces from an 'if' that +# does not have an 'else if' or 'else'. +mod_full_brace_if_chain_only = false # true/false -# Don't remove braces around statements that span N newlines -mod_full_brace_nl = 0 # number - -# Add or remove braces on single-line 'while' statement +# Add or remove braces on single-line 'while' statement. mod_full_brace_while = ignore # ignore/add/remove/force -# Add or remove braces on single-line 'using ()' statement +# Add or remove braces on single-line 'using ()' statement. mod_full_brace_using = ignore # ignore/add/remove/force -# Add or remove unnecessary paren on 'return' statement +# Don't remove braces around statements that span N newlines +mod_full_brace_nl = 0 # unsigned number + +# Whether to prevent removal of braces from 'if'/'for'/'while'/etc. blocks +# which span multiple lines. +# +# Affects: +# mod_full_brace_for +# mod_full_brace_if +# mod_full_brace_if_chain +# mod_full_brace_if_chain_only +# mod_full_brace_while +# mod_full_brace_using +# +# Does not affect: +# mod_full_brace_do +# mod_full_brace_function +mod_full_brace_nl_block_rem_mlcond = false # true/false + +# Add or remove unnecessary parenthesis on 'return' statement. mod_paren_on_return = ignore # ignore/add/remove/force -# Whether to change optional semicolons to real semicolons -mod_pawn_semicolon = false # false/true +# (Pawn) Whether to change optional semicolons to real semicolons. +mod_pawn_semicolon = false # true/false -# Add parens on 'while' and 'if' statement around bools -mod_full_paren_if_bool = false # false/true +# Whether to fully parenthesize Boolean expressions in 'while' and 'if' +# statement, as in 'if (a && b > c)' → 'if (a && (b > c))'. +mod_full_paren_if_bool = false # true/false -# Whether to remove superfluous semicolons -mod_remove_extra_semicolon = false # false/true +# Whether to remove superfluous semicolons. +mod_remove_extra_semicolon = false # true/false -# If a function body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_function_closebrace_comment = 0 # number +# If a function body exceeds the specified number of newlines and doesn't have +# a comment after the close brace, a comment will be added. +mod_add_long_function_closebrace_comment = 0 # unsigned number -# If a namespace body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_namespace_closebrace_comment = 0 # number +# If a namespace body exceeds the specified number of newlines and doesn't +# have a comment after the close brace, a comment will be added. +mod_add_long_namespace_closebrace_comment = 0 # unsigned number -# If a class body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_class_closebrace_comment = 0 # number +# If a class body exceeds the specified number of newlines and doesn't have a +# comment after the close brace, a comment will be added. +mod_add_long_class_closebrace_comment = 0 # unsigned number -# If a switch body exceeds the specified number of newlines and doesn't have a comment after -# the close brace, a comment will be added. -mod_add_long_switch_closebrace_comment = 0 # number +# If a switch body exceeds the specified number of newlines and doesn't have a +# comment after the close brace, a comment will be added. +mod_add_long_switch_closebrace_comment = 0 # unsigned number -# If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after -# the #endif, a comment will be added. -mod_add_long_ifdef_endif_comment = 0 # number +# If an #ifdef body exceeds the specified number of newlines and doesn't have +# a comment after the #endif, a comment will be added. +mod_add_long_ifdef_endif_comment = 0 # unsigned number -# If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after -# the #else, a comment will be added. -mod_add_long_ifdef_else_comment = 0 # number +# If an #ifdef or #else body exceeds the specified number of newlines and +# doesn't have a comment after the #else, a comment will be added. +mod_add_long_ifdef_else_comment = 0 # unsigned number -# If TRUE, will sort consecutive single-line 'import' statements [Java, D] -mod_sort_import = false # false/true +# Whether to sort consecutive single-line 'import' statements. +mod_sort_import = false # true/false -# If TRUE, will sort consecutive single-line 'using' statements [C#] -mod_sort_using = false # false/true +# (C#) Whether to sort consecutive single-line 'using' statements. +mod_sort_using = false # true/false -# If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C] -# This is generally a bad idea, as it may break your code. -mod_sort_include = false # false/true +# Whether to sort consecutive single-line '#include' statements (C/C++) and +# '#import' statements (Objective-C). Be aware that this has the potential to +# break your code if your includes/imports have ordering dependencies. +mod_sort_include = false # true/false -# If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace. -mod_move_case_break = false # false/true +# Whether to move a 'break' that appears after a fully braced 'case' before +# the close brace, as in 'case X: { ... } break;' → 'case X: { ... break; }'. +mod_move_case_break = false # true/false -# Will add or remove the braces around a fully braced case statement. -# Will only remove the braces if there are no variable declarations in the block. +# Add or remove braces around a fully braced case statement. Will only remove +# braces if there are no variable declarations in the block. mod_case_brace = ignore # ignore/add/remove/force -# If TRUE, it will remove a void 'return;' that appears as the last statement in a function. -mod_remove_empty_return = false # false/true +# Whether to remove a void 'return;' that appears as the last statement in a +# function. +mod_remove_empty_return = false # true/false -# If TRUE, it will organize the properties (Obj-C) -mod_sort_oc_properties = false # false/true +# Add or remove the comma after the last value of an enumeration. +mod_enum_last_comma = ignore # ignore/add/remove/force -# Determines weight of atomic/nonatomic (Obj-C) +# (OC) Whether to organize the properties. If true, properties will be +# rearranged according to the mod_sort_oc_property_*_weight factors. +mod_sort_oc_properties = false # true/false + +# (OC) Weight of a class property modifier. +mod_sort_oc_property_class_weight = 0 # number + +# (OC) Weight of 'atomic' and 'nonatomic'. mod_sort_oc_property_thread_safe_weight = 0 # number -# Determines weight of readwrite (Obj-C) +# (OC) Weight of 'readwrite' when organizing properties. mod_sort_oc_property_readwrite_weight = 0 # number -# Determines weight of reference type (retain, copy, assign, weak, strong) (Obj-C) +# (OC) Weight of a reference type specifier ('retain', 'copy', 'assign', +# 'weak', 'strong') when organizing properties. mod_sort_oc_property_reference_weight = 0 # number -# Determines weight of getter type (getter=) (Obj-C) +# (OC) Weight of getter type ('getter=') when organizing properties. mod_sort_oc_property_getter_weight = 0 # number -# Determines weight of setter type (setter=) (Obj-C) +# (OC) Weight of setter type ('setter=') when organizing properties. mod_sort_oc_property_setter_weight = 0 # number -# Determines weight of nullability type (nullable/nonnull) (Obj-C) +# (OC) Weight of nullability type ('nullable', 'nonnull', 'null_unspecified', +# 'null_resettable') when organizing properties. mod_sort_oc_property_nullability_weight = 0 # number -# -# Comment modifications -# - -# Try to wrap comments at cmt_width columns -cmt_width = 0 # number - -# Set the comment reflow mode (default: 0) -# 0: no reflowing (apart from the line wrapping due to cmt_width) -# 1: no touching at all -# 2: full reflow -cmt_reflow_mode = 0 # number - -# Whether to convert all tabs to spaces in comments. Default is to leave tabs inside comments alone, unless used for indenting. -cmt_convert_tab_to_spaces = false # false/true - -# If false, disable all multi-line comment changes, including cmt_width. keyword substitution and leading chars. -# Default=True. -cmt_indent_multi = true # false/true - -# Whether to group c-comments that look like they are in a block -cmt_c_group = false # false/true - -# Whether to put an empty '/*' on the first line of the combined c-comment -cmt_c_nl_start = false # false/true - -# Whether to put a newline before the closing '*/' of the combined c-comment -cmt_c_nl_end = false # false/true - -# Whether to group cpp-comments that look like they are in a block -cmt_cpp_group = false # false/true - -# Whether to put an empty '/*' on the first line of the combined cpp-comment -cmt_cpp_nl_start = false # false/true - -# Whether to put a newline before the closing '*/' of the combined cpp-comment -cmt_cpp_nl_end = false # false/true - -# Whether to change cpp-comments into c-comments -cmt_cpp_to_c = false # false/true - -# Whether to put a star on subsequent comment lines -cmt_star_cont = false # false/true - -# The number of spaces to insert at the start of subsequent comment lines -cmt_sp_before_star_cont = 0 # number - -# The number of spaces to insert after the star on subsequent comment lines -cmt_sp_after_star_cont = 0 # number - -# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of -# the comment are the same length. Default=True -cmt_multi_check_last = true # false/true - -# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of -# the comment are the same length AND if the length is bigger as the first_len minimum. Default=4 -cmt_multi_first_len_minimum = 4 # number - -# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment. -# Will substitute $(filename) with the current file's name. -cmt_insert_file_header = "" # string - -# The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment. -# Will substitute $(filename) with the current file's name. -cmt_insert_file_footer = "" # string - -# The filename that contains text to insert before a function implementation if the function isn't preceded with a C/C++ comment. -# Will substitute $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff. -# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... } -cmt_insert_func_header = "" # string - -# The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment. -# Will substitute $(class) with the class name. -cmt_insert_class_header = "" # string - -# The filename that contains text to insert before a Obj-C message specification if the method isn't preceded with a C/C++ comment. -# Will substitute $(message) with the function name and $(javaparam) with the javadoc @param and @return stuff. -cmt_insert_oc_msg_header = "" # string - -# If a preprocessor is encountered when stepping backwards from a function name, then -# this option decides whether the comment should be inserted. -# Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header. -cmt_insert_before_preproc = false # false/true - -# If a function is declared inline to a class definition, then -# this option decides whether the comment should be inserted. -# Affects cmt_insert_func_header. -cmt_insert_before_inlines = true # false/true - -# If the function is a constructor/destructor, then -# this option decides whether the comment should be inserted. -# Affects cmt_insert_func_header. -cmt_insert_before_ctor_dtor = false # false/true - # # Preprocessor options # -# Control indent of preprocessors inside #if blocks at brace level 0 (file-level) +# Add or remove indentation of preprocessor directives inside #if blocks +# at brace level 0 (file-level). pp_indent = remove # ignore/add/remove/force -# Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false) -pp_indent_at_level = false # false/true +# Whether to indent #if/#else/#endif at the brace level. If false, these are +# indented from column 1. +pp_indent_at_level = false # true/false -# Specifies the number of columns to indent preprocessors per level at brace level 0 (file-level). -# If pp_indent_at_level=false, specifies the number of columns to indent preprocessors per level at brace level > 0 (function-level). -# Default=1. -pp_indent_count = 1 # number +# Specifies the number of columns to indent preprocessors per level +# at brace level 0 (file-level). If pp_indent_at_level=false, also specifies +# the number of columns to indent preprocessors per level +# at brace level > 0 (function-level). +# +# Default: 1 +pp_indent_count = 1 # unsigned number -# Add or remove space after # based on pp_level of #if blocks -pp_space = add # ignore/add/remove/force +# Add or remove space after # based on pp_level of #if blocks. +pp_space = force # ignore/add/remove/force -# Sets the number of spaces added with pp_space -pp_space_count = 1 # number +# Sets the number of spaces per level added with pp_space. +pp_space_count = 1 # unsigned number -# The indent for #region and #endregion in C# and '#pragma region' in C/C++ +# The indent for '#region' and '#endregion' in C# and '#pragma region' in +# C/C++. Negative values decrease indent down to the first column. pp_indent_region = 0 # number -# Whether to indent the code between #region and #endregion -pp_region_indent_code = false # false/true +# Whether to indent the code between #region and #endregion. +pp_region_indent_code = false # true/false -# If pp_indent_at_level=true, sets the indent for #if, #else and #endif when not at file-level. -# 0: indent preprocessors using output_tab_size. -# >0: column at which all preprocessors will be indented. +# If pp_indent_at_level=true, sets the indent for #if, #else and #endif when +# not at file-level. Negative values decrease indent down to the first column. +# +# =0: Indent preprocessors using output_tab_size +# >0: Column at which all preprocessors will be indented pp_indent_if = 0 # number -# Control whether to indent the code between #if, #else and #endif. -pp_if_indent_code = false # false/true +# Whether to indent the code between #if, #else and #endif. +pp_if_indent_code = false # true/false -# Whether to indent '#define' at the brace level (true) or from column 1 (false) -pp_define_at_level = false # false/true +# Whether to indent '#define' at the brace level. If false, these are +# indented from column 1. +pp_define_at_level = false # true/false + +# Whether to ignore the '#define' body while formatting. +pp_ignore_define_body = false # true/false + +# Whether to indent case statements between #if, #else, and #endif. +# Only applies to the indent of the preprocesser that the case statements +# directly inside of. +# +# Default: true +pp_indent_case = true # true/false + +# Whether to indent whole function definitions between #if, #else, and #endif. +# Only applies to the indent of the preprocesser that the function definition +# is directly inside of. +# +# Default: true +pp_indent_func_def = true # true/false + +# Whether to indent extern C blocks between #if, #else, and #endif. +# Only applies to the indent of the preprocesser that the extern block is +# directly inside of. +# +# Default: true +pp_indent_extern = true # true/false + +# Whether to indent braces directly inside #if, #else, and #endif. +# Only applies to the indent of the preprocesser that the braces are directly +# inside of. +# +# Default: true +pp_indent_brace = true # true/false + +# +# Sort includes options +# + +# The regex for include category with priority 0. +include_category_0 = "" # string + +# The regex for include category with priority 1. +include_category_1 = "" # string + +# The regex for include category with priority 2. +include_category_2 = "" # string # # Use or Do not Use options # -# True: indent_func_call_param will be used (default) -# False: indent_func_call_param will NOT be used -use_indent_func_call_param = true # false/true +# true: indent_func_call_param will be used (default) +# false: indent_func_call_param will NOT be used +# +# Default: true +use_indent_func_call_param = true # true/false -# The value of the indentation for a continuation line is calculate differently if the line is: -# a declaration :your case with QString fileName ... -# an assigment :your case with pSettings = new QSettings( ... -# At the second case the option value might be used twice: -# at the assigment -# at the function call (if present) -# To prevent the double use of the option value, use this option with the value 'true'. -# True: indent_continue will be used only once -# False: indent_continue will be used every time (default) -use_indent_continue_only_once = false # false/true +# The value of the indentation for a continuation line is calculated +# differently if the statement is: +# - a declaration: your case with QString fileName ... +# - an assignment: your case with pSettings = new QSettings( ... +# +# At the second case the indentation value might be used twice: +# - at the assignment +# - at the function call (if present) +# +# To prevent the double use of the indentation value, use this option with the +# value 'true'. +# +# true: indent_continue will be used only once +# false: indent_continue will be used every time (default) +use_indent_continue_only_once = false # true/false -# SIGNAL/SLOT Qt macros have special formatting options. See options_for_QT.cpp for details. -# Default=True. -use_options_overriding_for_qt_macros = true # false/true +# The value might be used twice: +# - at the assignment +# - at the opening brace +# +# To prevent the double use of the indentation value, use this option with the +# value 'true'. +# +# true: indentation will be used only once +# false: indentation will be used every time (default) +indent_cpp_lambda_only_once = true # true/false + +# Whether to apply special formatting for Qt SIGNAL/SLOT macros. Essentially, +# this tries to format these so that they match Qt's normalized form (i.e. the +# result of QMetaObject::normalizedSignature), which can slightly improve the +# performance of the QObject::connect call, rather than how they would +# otherwise be formatted. +# +# See options_for_QT.cpp for details. +# +# Default: true +use_options_overriding_for_qt_macros = true # true/false # # Warn levels - 1: error, 2: warning (default), 3: note # -# Warning is given if doing tab-to-\t replacement and we have found one in a C# verbatim string literal. -warn_level_tabs_found_in_verbatim_string_literals = 2 # number +# (C#) Warning is given if doing tab-to-\t replacement and we have found one +# in a C# verbatim string literal. +# +# Default: 2 +warn_level_tabs_found_in_verbatim_string_literals = 2 # unsigned number -# You can force a token to be a type with the 'type' option. -# Example: -# type myfoo1 myfoo2 +# Meaning of the settings: +# Ignore - do not do any changes +# Add - makes sure there is 1 or more space/brace/newline/etc +# Force - makes sure there is exactly 1 space/brace/newline/etc, +# behaves like Add in some contexts +# Remove - removes space/brace/newline/etc # -# You can create custom macro-based indentation using macro-open, -# macro-else and macro-close. -# Example: -# macro-open BEGIN_TEMPLATE_MESSAGE_MAP -# macro-open BEGIN_MESSAGE_MAP -# macro-close END_MESSAGE_MAP # -# You can assign any keyword to any type with the set option. -# set func_call_user _ N_ +# - Token(s) can be treated as specific type(s) with the 'set' option: +# `set tokenType tokenString [tokenString...]` # -# The full syntax description of all custom definition config entries -# is shown below: +# Example: +# `set BOOL __AND__ __OR__` # -# define custom tokens as: -# - embed whitespace in token using '' escape character, or -# put token in quotes -# - these: ' " and ` are recognized as quote delimiters +# tokenTypes are defined in src/token_enum.h, use them without the +# 'CT_' prefix: 'CT_BOOL' → 'BOOL' # -# type token1 token2 token3 ... -# ^ optionally specify multiple tokens on a single line -# define def_token output_token -# ^ output_token is optional, then NULL is assumed -# macro-open token -# macro-close token -# macro-else token -# set id token1 token2 ... -# ^ optionally specify multiple tokens on a single line -# ^ id is one of the names in token_enum.h sans the CT_ prefix, -# e.g. PP_PRAGMA # -# all tokens are separated by any mix of ',' commas, '=' equal signs -# and whitespace (space, tab) +# - Token(s) can be treated as type(s) with the 'type' option. +# `type tokenString [tokenString...]` # -# You can add support for other file extensions using the 'file_ext' command. -# The first arg is the language name used with the '-l' option. -# The remaining args are file extensions, matched with 'endswith'. -# file_ext CPP .ch .cxx .cpp.in +# Example: +# `type int c_uint_8 Rectangle` # -# option(s) with 'not default' value: 0 +# This can also be achieved with `set TYPE int c_uint_8 Rectangle` +# +# +# To embed whitespace in tokenStrings use the '\' escape character, or quote +# the tokenStrings. These quotes are supported: "'` +# +# +# - Support for the auto detection of languages through the file ending can be +# added using the 'file_ext' command. +# `file_ext langType langString [langString..]` +# +# Example: +# `file_ext CPP .ch .cxx .cpp.in` +# +# langTypes are defined in uncrusify_types.h in the lang_flag_e enum, use +# them without the 'LANG_' prefix: 'LANG_CPP' → 'CPP' +# +# +# - Custom macro-based indentation can be set up using 'macro-open', +# 'macro-else' and 'macro-close'. +# `(macro-open | macro-else | macro-close) tokenString` +# +# Example: +# `macro-open BEGIN_TEMPLATE_MESSAGE_MAP` +# `macro-open BEGIN_MESSAGE_MAP` +# `macro-close END_MESSAGE_MAP` +# +# +# option(s) with 'not default' value: 98 #