From 4154af55e16df2c629ae36961618430d1a294e36 Mon Sep 17 00:00:00 2001 From: Dick Hollenbeck Date: Wed, 22 Feb 2012 16:00:55 -0600 Subject: [PATCH] Uncrustify 0.59 has some new options, it is still actively supported, now under GIT. --- uncrustify.cfg | 491 +++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 412 insertions(+), 79 deletions(-) diff --git a/uncrustify.cfg b/uncrustify.cfg index cbc1e2d85a..b57b2c1698 100644 --- a/uncrustify.cfg +++ b/uncrustify.cfg @@ -1,4 +1,4 @@ -# Uncrustify 0.51+svn +# Uncrustify 0.59 # # General options @@ -13,12 +13,26 @@ input_tab_size = 4 # number # The size of tabs in the output (only used if align_with_tabs=true) output_tab_size = 4 # number -# The ascii value of the string escape char, usually 92 (\) or 94 (^). (Pawn) +# The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn) string_escape_char = 92 # number # Alternate string escape char for Pawn. Only works right before the quote char. string_escape_char2 = 0 # number +# Allow interpreting '>=' and '>>=' as part of a template in 'void f(list>=val);'. +# If true (default), 'assert(x<0 && y>=3)' will be broken. +# Improvements to template detection may make this option obsolete. +tok_split_gte = false # false/true + +# Control what to do with 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 + +# Force the output encoding to UTF-8 +utf8_force = false # false/true + # # Indenting # @@ -27,12 +41,20 @@ string_escape_char2 = 0 # number # Usually 2, 3, 4, or 8. indent_columns = 4 # number +# The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents. +# For FreeBSD, this is set to 4. Negative value is absolute and not increased for each ( level +indent_continue = 0 # number + # How to use tabs when indenting code # 0=spaces only -# 1=indent with tabs, align with spaces -# 2=indent and align with tabs +# 1=indent with tabs to brace level, align with spaces +# 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 = true # false/true @@ -49,12 +71,25 @@ indent_braces = false # false/true # Disabled indenting function braces if indent_braces is true indent_braces_no_func = false # false/true -# Indent based on the size of the brace parent, ie 'if' => 3 spaces, 'for' => 4 spaces, etc. +# Disabled indenting class braces if indent_braces is true +indent_braces_no_class = false # false/true + +# Disabled indenting struct braces if indent_braces is true +indent_braces_no_struct = false # false/true + +# Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc. indent_brace_parent = false # false/true # Whether the 'namespace' body is indented indent_namespace = false # false/true +# The number of spaces to indent a namespace block +indent_namespace_level = 0 # number + +# If the body of the namespace is longer than this number, it won't be indented. +# Requires indent_namespace=true. Default=0 (no limit) +indent_namespace_limit = 0 # number + # Whether the 'extern "C"' body is indented indent_extern = false # false/true @@ -64,6 +99,9 @@ indent_class = true # false/true # Whether to indent the stuff after a leading class colon indent_class_colon = false # false/true +# 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 = true # false/true @@ -71,6 +109,13 @@ indent_else_if = true # false/true # Amount to indent variable declarations after a open brace. neg=relative, pos=absolute indent_var_def_blk = 0 # number +# Indent continued variable declarations instead of aligning. +indent_var_def_cont = false # false/true + +# True: force indentation of function definition to start in column 1 +# False: use the default behavior +indent_func_def_force_col1 = false # false/true + # True: indent continued function call parameters one indent level # False: align parameters under the open paren indent_func_call_param = false # false/true @@ -121,7 +166,7 @@ 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 +indent_case_brace = 4 # number # Whether to indent comments found in first column indent_col1_comment = false # false/true @@ -153,6 +198,9 @@ 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 = true # 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 @@ -173,6 +221,9 @@ sp_arith = force # ignore/add/remove/force # Add or remove space around assignment operator '=', '+=', etc sp_assign = force # ignore/add/remove/force +# Add or remove space around assignment operator '=' in a prototype +sp_assign_default = ignore # ignore/add/remove/force + # Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign. sp_before_assign = ignore # ignore/add/remove/force @@ -188,6 +239,12 @@ sp_enum_before_assign = ignore # ignore/add/remove/force # Add or remove space after assignment '=' in enum. Overrides sp_enum_assign. sp_enum_after_assign = ignore # ignore/add/remove/force +# Add or remove space around preprocessor '##' concatenation operator. Default=Add +sp_pp_concat = add # ignore/add/remove/force + +# Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator. Default=Add +sp_pp_stringify = add # ignore/add/remove/force + # Add or remove space around boolean operators '&&' and '||' sp_bool = ignore # ignore/add/remove/force @@ -241,12 +298,15 @@ sp_after_byref_func = ignore # ignore/add/remove/force # Add or remove space before a reference sign '&', if followed by a func proto/def. sp_before_byref_func = ignore # ignore/add/remove/force -# Add or remove space between type and word +# Add or remove space between type and word. Default=Force sp_after_type = force # ignore/add/remove/force +# Add or remove space before the paren in the D constructs 'template Foo(' and 'class Foo('. +sp_before_template_paren = ignore # ignore/add/remove/force + # Add or remove space in 'template <' vs 'template<'. # If set to ignore, sp_before_angle is used. -sp_template_angle = force # ignore/add/remove/force +sp_template_angle = force # ignore/add/remove/force # Add or remove space before '<>' sp_before_angle = ignore # ignore/add/remove/force @@ -255,7 +315,7 @@ sp_before_angle = ignore # ignore/add/remove/force sp_inside_angle = remove # ignore/add/remove/force # Add or remove space after '<>' -sp_after_angle = force # ignore/add/remove/force +sp_after_angle = force # ignore/add/remove/force # Add or remove space between '<>' and '(' as found in 'new List();' sp_angle_paren = ignore # ignore/add/remove/force @@ -263,6 +323,9 @@ sp_angle_paren = ignore # ignore/add/remove/force # Add or remove space between '<>' and a word as in 'List m;' sp_angle_word = ignore # 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 before '(' of 'if', 'for', 'switch', and 'while' sp_before_sparen = remove # ignore/add/remove/force @@ -287,16 +350,22 @@ sp_after_invariant_paren = ignore # ignore/add/remove/force # Add or remove space before empty statement ';' on 'if', 'for' and 'while' sp_special_semi = add # ignore/add/remove/force -# Add or remove space before ';' +# Add or remove space before ';'. Default=Remove sp_before_semi = remove # ignore/add/remove/force # Add or remove space before ';' in non-empty 'for' statements sp_before_semi_for = remove # ignore/add/remove/force -# Add or remove space before a semicolon of an empty part of a for statment. +# Add or remove space before a semicolon of an empty part of a for statement. sp_before_semi_for_empty = add # ignore/add/remove/force -# Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; ). +# 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 +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 ( ; ; ). sp_after_semi_for_empty = ignore # ignore/add/remove/force # Add or remove space before '[' (except '[]') @@ -305,7 +374,7 @@ 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 inside '[' and ']' +# Add or remove space inside a non-empty '[' and ']' sp_inside_square = ignore # ignore/add/remove/force # Add or remove space after ',' @@ -314,13 +383,19 @@ sp_after_comma = force # ignore/add/remove/force # Add or remove space before ',' sp_before_comma = remove # ignore/add/remove/force +# Add or remove space between an open paren and comma: '(,' vs '( ,' +sp_paren_comma = force # ignore/add/remove/force + +# Add or remove space before the variadic '...' when preceded by a non-punctuator +sp_before_ellipsis = ignore # ignore/add/remove/force + # Add or remove space after class ':' sp_after_class_colon = ignore # ignore/add/remove/force # Add or remove space before class ':' sp_before_class_colon = ignore # ignore/add/remove/force -# Add or remove space before case ':' +# 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 @@ -329,13 +404,13 @@ sp_after_operator = ignore # ignore/add/remove/force # Add or remove space between the operator symbol and the open paren, as in 'operator ++(' sp_after_operator_sym = ignore # ignore/add/remove/force -# Add or remove space after C/D cast, ie 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a' +# 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 sp_inside_paren_cast = remove # ignore/add/remove/force -# Add or remove space between the type and open paren in a C++ cast, ie 'int(exp)' vs 'int (exp)' +# 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 = ignore # ignore/add/remove/force # Add or remove space between 'sizeof' and '(' @@ -381,6 +456,10 @@ sp_fparen_brace = add # ignore/add/remove/force # 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. +sp_func_call_paren_empty = ignore # ignore/add/remove/force + # Add or remove space between the user function name and '(' on function calls # You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file. sp_func_call_user_paren = ignore # ignore/add/remove/force @@ -400,6 +479,18 @@ sp_defined_paren = remove # ignore/add/remove/force # Add or remove space between 'throw' and '(' in 'throw (something)' sp_throw_paren = ignore # ignore/add/remove/force +# Add or remove space between 'catch' and '(' in 'catch (something) { }' +# If set to ignore, sp_before_sparen is used. +sp_catch_paren = remove # ignore/add/remove/force + +# Add or remove space between 'version' and '(' in 'version (something) { }' (D language) +# If set to ignore, sp_before_sparen is used. +sp_version_paren = ignore # ignore/add/remove/force + +# Add or remove space between 'scope' and '(' in 'scope (something) { }' (D language) +# If set to ignore, sp_before_sparen is used. +sp_scope_paren = ignore # ignore/add/remove/force + # Add or remove space between macro and value sp_macro = add # ignore/add/remove/force @@ -442,30 +533,30 @@ sp_after_dc = ignore # ignore/add/remove/force # Add or remove around the D named array initializer ':' operator sp_d_array_colon = ignore # ignore/add/remove/force -# Add or remove space after the '!' (not) operator. +# Add or remove space after the '!' (not) operator. Default=Remove sp_not = remove # ignore/add/remove/force -# Add or remove space after the '~' (invert) operator. +# Add or remove space after the '~' (invert) operator. Default=Remove sp_inv = remove # ignore/add/remove/force -# Add or remove space after the '&' (address-of) operator. +# Add or remove space after the '&' (address-of) operator. Default=Remove # This does not affect the spacing after a '&' that is part of a type. sp_addr = remove # ignore/add/remove/force -# Add or remove space around the '.' or '->' operators +# 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. +# Add or remove space after the '*' (dereference) operator. Default=Remove # This does not affect the spacing after a '*' that is part of a type. sp_deref = remove # ignore/add/remove/force -# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7' +# 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++;' +# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove sp_incdec = remove # ignore/add/remove/force -# Add or remove space before a backslash-newline at the end of a line +# 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;' @@ -488,8 +579,34 @@ sp_after_send_oc_colon = ignore # ignore/add/remove/force sp_before_send_oc_colon = ignore # ignore/add/remove/force # Add or remove space after the (type) in message specs -# '-(int) f: (int) x;' vs '-(int) f: (int)x;' -sp_after_oc_type = ignore # ignore/add/remove/force +# '-(int)f: (int) x;' vs '-(int)f: (int)x;' +sp_after_oc_type = add # ignore/add/remove/force + +# Add or remove space after the first (type) in message specs +# '-(int) f:(int)x;' vs '-(int)f:(int)x;' +sp_after_oc_return_type = ignore # ignore/add/remove/force + +# Add or remove space between '@selector' and '(' +# '@selector(msgName)' vs '@selector (msgName)' +# Also applies to @protocol() constructs +sp_after_oc_at_sel = ignore # ignore/add/remove/force + +# Add or remove space between '@selector(x)' and the following word +# '@selector(foo) a:' vs '@selector(foo)a:' +sp_after_oc_at_sel_parens = ignore # ignore/add/remove/force + +# Add or remove space inside '@selector' parens +# '@selector(foo)' vs '@selector( foo )' +# Also applies to @protocol() constructs +sp_inside_oc_at_sel_parens = ignore # ignore/add/remove/force + +# Add or remove space before a block pointer caret +# '^int (int arg){...}' vs. ' ^int (int arg){...}' +sp_before_oc_block_caret = ignore # ignore/add/remove/force + +# Add or remove space after a block pointer caret +# '^int (int arg){...}' vs. '^ int (int arg){...}' +sp_after_oc_block_caret = ignore # ignore/add/remove/force # Add or remove space around the ':' in 'b ? t : f' sp_cond_colon = add # ignore/add/remove/force @@ -503,6 +620,21 @@ sp_case_label = force # ignore/add/remove/force # Control the space around the D '..' operator. sp_range = ignore # ignore/add/remove/force +# Control the space after the opening of a C++ comment '// A' vs '//A' +sp_cmt_cpp_start = force # ignore/add/remove/force + +# Controls the spaces between #else or #endif and a trailing comment +sp_endif_cmt = force # ignore/add/remove/force + +# Controls the spaces after 'new', 'delete', and 'delete[]' +sp_after_new = force # ignore/add/remove/force + +# Controls the spaces before a trailing or embedded comment +sp_before_tr_emb_cmt = add # ignore/add/remove/force + +# Number of spaces before a trailing or embedded comment +sp_num_before_tr_emb_cmt = 4 # number + # # Code alignment (not left column spaces/tabs) # @@ -510,14 +642,14 @@ sp_range = ignore # ignore/add/remove/force # Whether to keep non-indenting tabs align_keep_tabs = false # false/true -# Whether to use tabs for alinging +# Whether to use tabs for aligning align_with_tabs = false # false/true # Whether to bump out to the next tab when aligning align_on_tabstop = true # false/true # Whether to left-align numbers -align_number_left = false # false/true +align_number_left = true # false/true # Align variable definitions in prototypes and functions align_func_params = true # false/true @@ -550,8 +682,11 @@ align_var_def_gap = 0 # number # Whether to align the colon in struct bit fields align_var_def_colon = false # false/true +# Whether to align any attribute after the variable name +align_var_def_attribute = false # false/true + # Whether to align inline struct/enum/union variable definitions -align_var_def_inline = true # false/true +align_var_def_inline = false # false/true # The span for aligning on '=' in assignments (0=don't align) align_assign_span = 1 # number @@ -590,13 +725,13 @@ align_typedef_span = 2 # number align_typedef_func = 0 # number # Controls the positioning of the '*' in typedefs. Just try it. -# 0: Align on typdef type, ignore '*' +# 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 = 2 # number # Controls the positioning of the '&' in typedefs. Just try it. -# 0: Align on typdef type, ignore '&' +# 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 @@ -608,15 +743,21 @@ align_right_cmt_span = 3 # number align_right_cmt_mix = false # false/true # If a trailing comment is more than this number of columns away from the text it follows, -# it will qualify for being aligned. +# it will qualify for being aligned. This has to be > 0 to do anything. align_right_cmt_gap = 0 # number +# Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore) +align_right_cmt_at_col = 0 # number + # The span for aligning function prototypes (0=don't align) align_func_proto_span = 5 # number # Minimum gap between the return type and the function name. align_func_proto_gap = 0 # number +# Align function protos on the 'operator' keyword instead of what follows +align_on_operator = true # false/true + # Whether to mix aligning prototype and variable declarations. # If true, align_var_def_XXX options are used instead of align_func_proto_XXX options. align_mix_var_proto = false # false/true @@ -638,6 +779,9 @@ align_oc_msg_spec_span = 0 # number # This will not work right if the macro contains a multi-line comment. align_nl_cont = false # false/true +# # Align macro functions and variables together +align_pp_define_together = false # false/true + # The minimum space between label and value of a preprocessor define align_pp_define_gap = 1 # number @@ -647,6 +791,12 @@ align_pp_define_span = 1 # number # Align lines that start with '<<' with previous '<<'. Default=true align_left_shift = true # false/true +# Span for aligning parameters in an Obj-C message call on the ':' (0=don't align) +align_oc_msg_colon_span = 0 # number + +# Aligning parameters in an Obj-C '+' or '-' declaration on the ':' +align_oc_decl_colon = false # false/true + # # Newline adding and removing options # @@ -693,9 +843,34 @@ nl_assign_square = add # ignore/add/remove/force # Add or remove newline after '= [' (D only). Will also affect the newline before the ']' nl_after_square_assign = ignore # ignore/add/remove/force -# The number of newlines after a block of variable definitions +# The number of blank lines after a block of variable definitions at the top of a function body +# 0 = No change (default) nl_func_var_def_blk = 1 # number +# The number of newlines before a block of typedefs +# 0 = No change (default) +nl_typedef_blk_start = 1 # number + +# The number of newlines after a block of typedefs +# 0 = No change (default) +nl_typedef_blk_end = 1 # number + +# The maximum consecutive newlines within a block of typedefs +# 0 = No change (default) +nl_typedef_blk_in = 0 # number + +# The number of newlines before a block of variable definitions not at the top of a function body +# 0 = No change (default) +nl_var_def_blk_start = 0 # number + +# The number of newlines after a block of variable definitions not at the top of a function body +# 0 = No change (default) +nl_var_def_blk_end = 1 # number + +# The maximum consecutive newlines within a block of variable definitions +# 0 = No change (default) +nl_var_def_blk_in = 0 # number + # Add or remove newline between a function call's ')' and '{', as in: # list_for_each(item, &list) { } nl_fcall_brace = remove # ignore/add/remove/force @@ -749,6 +924,22 @@ nl_brace_catch = force # 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) +nl_scope_brace = ignore # ignore/add/remove/force + +# Add or remove newline between 'unittest' and '{' (D) +nl_unittest_brace = ignore # ignore/add/remove/force + +# Add or remove newline between 'version (x)' and '{' (D) +nl_version_brace = ignore # ignore/add/remove/force + +# 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. +nl_brace_brace = ignore # ignore/add/remove/force + # Add or remove newline between 'do' and '{' nl_do_brace = ignore # ignore/add/remove/force @@ -758,7 +949,8 @@ nl_brace_while = remove # ignore/add/remove/force # Add or remove newline between 'switch' and '{' nl_switch_brace = force # ignore/add/remove/force -# Add or remove newline when condition spans two or more lines +# 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 # Force a newline in a define after the macro name for multi-line defines. @@ -773,6 +965,9 @@ nl_before_throw = ignore # ignore/add/remove/force # Whether to put a newline after 'case' statement nl_after_case = true # false/true +# Add or remove a 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 = ignore # ignore/add/remove/force @@ -785,32 +980,67 @@ nl_class_brace = force # ignore/add/remove/force # Add or remove newline after each ',' in the constructor member initialization nl_class_init_args = add # ignore/add/remove/force -# Add or remove newline between return type and function name in definition +# Add or remove newline between return type and function name in a function definition nl_func_type_name = remove # 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. +nl_func_type_name_class = ignore # ignore/add/remove/force + +# Add or remove newline between function scope and name in a definition +# Controls the newline after '::' in 'void A::f() { }' +nl_func_scope_name = remove # ignore/add/remove/force + # 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 '(' nl_func_paren = remove # ignore/add/remove/force +# Add or remove newline between a function name and the opening '(' in the definition +nl_func_def_paren = remove # ignore/add/remove/force + # Add or remove newline after '(' in a function declaration nl_func_decl_start = ignore # ignore/add/remove/force +# 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. +nl_func_decl_start_single = remove # ignore/add/remove/force + +# Overrides nl_func_def_start when there is only one parameter. +nl_func_def_start_single = remove # ignore/add/remove/force + # 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 +nl_func_def_args = ignore # ignore/add/remove/force + # 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 +nl_func_def_end = ignore # ignore/add/remove/force + +# Overrides nl_func_decl_end when there is only one parameter. +nl_func_decl_end_single = remove # ignore/add/remove/force + +# Overrides nl_func_def_end when there is only one parameter. +nl_func_def_end_single = remove # ignore/add/remove/force + +# Add or remove newline between '()' in a function declaration. +nl_func_decl_empty = remove # ignore/add/remove/force + +# Add or remove newline between '()' in a function definition. +nl_func_def_empty = remove # ignore/add/remove/force + # Add or remove newline between function signature and '{' nl_fdef_brace = force # ignore/add/remove/force -# Whether to put a newline after 'return' statement -nl_after_return = false # false/true - # Add or remove a newline between the return keyword and return expression. -nl_return_expr = ignore # ignore/add/remove/force +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 @@ -821,53 +1051,65 @@ nl_after_brace_open = true # false/true # 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 = true # false/true +nl_after_brace_open_cmt = true # false/true -# Whether to put a newline after a virtual brace open. +# Whether to put 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 = true # false/true +# Whether to put 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 = true # false/true + +# Whether to put a newline after a brace close. +# Does not apply if followed by a necessary ';'. +nl_after_brace_close = true # false/true + +# 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 = true # false/true + # Whether to alter newlines in '#define' macros nl_define_macro = false # false/true # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif' nl_squeeze_ifdef = false # false/true -# Add or remove newline before 'if' -nl_before_if = ignore # ignore/add/remove/force +# Add or remove blank line before 'if' +nl_before_if = add # ignore/add/remove/force -# Add or remove newline after 'if' -# Dick: this needs to stay at ignore until the trailing else support is fixed. -nl_after_if = ignore # ignore/add/remove/force +# Add or remove blank line after 'if' statement +nl_after_if = add # ignore/add/remove/force -# Add or remove newline before 'for' -nl_before_for = ignore # ignore/add/remove/force +# Add or remove blank line before 'for' +nl_before_for = add # ignore/add/remove/force -# Add or remove newline after 'for' -nl_after_for = add # ignore/add/remove/force +# Add or remove blank line after 'for' statement +nl_after_for = add # ignore/add/remove/force -# Add or remove newline before 'while' -nl_before_while = ignore # ignore/add/remove/force +# Add or remove blank line before 'while' +nl_before_while = add # ignore/add/remove/force -# Add or remove newline after 'while' +# Add or remove blank line after 'while' statement nl_after_while = add # ignore/add/remove/force -# Add or remove newline before 'switch' -nl_before_switch = ignore # ignore/add/remove/force +# Add or remove blank line before 'switch' +nl_before_switch = add # ignore/add/remove/force -# Add or remove newline after 'switch' +# Add or remove blank line after 'switch' statement nl_after_switch = add # ignore/add/remove/force -# Add or remove newline before 'do' -nl_before_do = ignore # ignore/add/remove/force +# Add or remove blank line before 'do' +nl_before_do = add # ignore/add/remove/force -# Add or remove newline after 'do' +# Add or remove blank line after 'do/while' statement nl_after_do = add # ignore/add/remove/force # Whether to double-space commented-entries in struct/enum nl_ds_struct_enum_cmt = true # false/true # Whether to double-space before the close brace of a struct/union/enum +# (lower priority than 'eat_blanks_before_close_brace') nl_ds_struct_enum_close_brace = false # false/true # Add or remove a newline around a class colon. @@ -891,22 +1133,29 @@ nl_create_while_one_liner = false # false/true # # The position of arithmetic operators in wrapped expressions -pos_arith = ignore # ignore/lead/trail +pos_arith = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force -# The position of assignment in wrapped expressions -pos_assign = ignore # ignore/lead/trail +# The position of assignment in wrapped expressions. +# Do not affect '=' followed by '{' +pos_assign = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of boolean operators in wrapped expressions -pos_bool = lead # ignore/lead/trail +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/lead/trail +pos_comma = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of the comma in the constructor initialization list -pos_class_comma = ignore # ignore/lead/trail +pos_class_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of colons between constructor and member initialization -pos_class_colon = trail # ignore/lead/trail +pos_class_colon = trail # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force # # Line Splitting options @@ -921,6 +1170,9 @@ ls_for_split_full = true # false/true # Whether to fully split long function protos/calls at commas ls_func_split_full = true # false/true +# Whether to split lines as close to code_width as possible and ignore some groupings +ls_code_width = false # false/true + # # Blank line options # @@ -937,12 +1189,15 @@ nl_after_func_proto_group = 2 # number # The number of newlines after '}' of a multi-line function body nl_after_func_body = 3 # number +# The number of newlines after '}' of a multi-line function body in a class declaration +nl_after_func_body_class = 2 # number + # The number of newlines after '}' of a single line function body nl_after_func_body_one_liner = 1 # 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 = 2 # number +nl_before_block_comment = 1 # 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. @@ -950,15 +1205,21 @@ nl_before_c_comment = 1 # 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 = 2 # number +nl_before_cpp_comment = 1 # number -# Whether to force a newline after a mulit-line comment. +# Whether to force a newline after a multi-line comment. nl_after_multiline_comment = false # false/true +# 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 class definition +nl_after_class = 0 # 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 +nl_before_access_spec = 1 # number # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. # 0 = No change. @@ -980,12 +1241,27 @@ nl_around_cs_property = 0 # number # 0 = No change. nl_between_get_set = 0 # number +# Add or remove newline between C# property and the '{' +nl_property_brace = ignore # ignore/add/remove/force + # Whether to remove blank lines after '{' eat_blanks_after_open_brace = true # false/true # Whether to remove blank lines before '}' eat_blanks_before_close_brace = true # false/true +# How aggressively to remove extra newlines not in preproc. +# 0: No change +# 1: Remove most newlines not handled by other config +# 2: Remove all newlines and reformat completely by config +nl_remove_extra_newlines = 0 # 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 after 'return' statements, unless followed by a close brace. +nl_after_return = false # false/true + # # Code modifying options (non-whitespace) # @@ -996,18 +1272,25 @@ mod_full_brace_do = add # ignore/add/remove/force # Add or remove braces on single-line 'for' statement mod_full_brace_for = ignore # ignore/add/remove/force -# Add or remove braces on single-line function defintions. (Pawn) +# Add or remove braces on single-line function definitions. (Pawn) 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'. 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 + # Don't remove braces around statements that span N newlines mod_full_brace_nl = 3 # number # 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 +mod_full_brace_using = ignore # ignore/add/remove/force + # Add or remove unnecessary paren on 'return' statement mod_paren_on_return = remove # ignore/add/remove/force @@ -1028,6 +1311,14 @@ mod_add_long_function_closebrace_comment = 0 # number # the close brace, a comment will be added. mod_add_long_switch_closebrace_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 # 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 TRUE, will sort consecutive single-line 'import' statements [Java, D] mod_sort_import = false # false/true @@ -1041,8 +1332,12 @@ mod_sort_include = false # false/true # 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 +# 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. +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 +mod_remove_empty_return = true # false/true # # Comment modifications @@ -1051,7 +1346,13 @@ mod_remove_empty_return = false # false/true # Try to wrap comments at cmt_width columns cmt_width = 0 # number -# If false, disable all multi-line comment changes, including cmt_width and leading chars. +# 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 + +# If false, disable all multi-line comment changes, including cmt_width. keyword substitution, and leading chars. # Default is true. cmt_indent_multi = true # false/true @@ -1090,21 +1391,29 @@ cmt_sp_after_star_cont = 1 # number cmt_multi_check_last = true # false/true # 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 substitue $(filename) with the current file's name. +# Will substitute $(filename) with the current file's name. cmt_insert_file_header = "" # string -# The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment. -# Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff. +# 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 preceeded with a C/C++ comment. -# Will substitue $(class) with the class name. +# 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 preceeded 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_func_header and cmt_insert_class_header. +# Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header. cmt_insert_before_preproc = false # false/true # @@ -1154,3 +1463,27 @@ pp_define_at_level = false # false/true # # You can assign any keyword to any type with the set option. # set func_call_user _ N_ +# +# The full syntax description of all custom definition config entries +# is shown below: +# +# define custom tokens as: +# - embed whitespace in token using '' escape character, or +# put token in quotes +# - these: ' " and ` are recognized as quote delimiters +# +# 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) +#