## Uncrustify 0.52 ## ## General options ## newlines = lf # { auto, lf, cr, crlf } # the type of line endings input_tab_size = 4 # number # the original size of tabs in the input output_tab_size = 4 # number # the size of tabs in the output (only used if align_with_tabs=true) #string_escape_char # number # the ascii value of the string escape char, usually 92 (\) or 94 (^). (pawn) #string_escape_char2 # number # alternate string escape char for pawn. only works right before the quote char. ## ## Indenting ## indent_columns = 4 # Number # The number of columns to indent per level. # Usually 2, 3, 4, or 8. indent_with_tabs = 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 #indent_align_string # { False, True } # Whether to indent strings broken by '\' so that they line up #indent_xml_string # Number # The number of spaces to indent multi-line XML strings. # Requires indent_align_string=True #indent_brace # Number # Spaces to indent '{' from level #indent_braces # { False, True } # Whether braces are indented to the body level #indent_braces_no_func # { False, True } # Disabled indenting function braces if indent_braces is true #indent_brace_parent # { False, True } # Indent based on the size of the brace parent, ie 'if' => 3 spaces, 'for' => 4 spaces, etc. #indent_namespace # { False, True } # Whether the 'namespace' body is indented #indent_extern # { False, True } # Whether the 'extern "C"' body is indented #indent_class # { False, True } # Whether the 'class' body is indented #indent_class_colon # { False, True } # Whether to indent the stuff after a leading class colon #indent_else_if # { False, True } # False=treat 'else\nif' as 'else if' for indenting purposes # True=indent the 'if' one level #indent_var_def_blk # Number # Amount to indent variable declarations after a open brace. neg=relative, pos=absolute #indent_func_call_param # { False, True } # True: indent continued function call parameters one indent level # False: align parameters under the open paren #indent_func_def_param # { False, True } # Same as indent_func_call_param, but for function defs #indent_func_proto_param # { False, True } # Same as indent_func_call_param, but for function protos #indent_func_class_param # { False, True } # Same as indent_func_call_param, but for class declarations #indent_func_ctor_var_param # { False, True } # Same as indent_func_call_param, but for class variable constructors #indent_template_param # { False, True } # Same as indent_func_call_param, but for templates #indent_func_param_double # { False, True } # Double the indent for indent_func_xxx_param options #indent_func_const # Number # Indentation column for standalone 'const' function decl/proto qualifier #indent_func_throw # Number # Indentation column for standalone 'throw' function decl/proto qualifier #indent_member # Number # The number of spaces to indent a continued '->' or '.' # Usually set to 0, 1, or indent_columns. #indent_sing_line_comments # Number # Spaces to indent single line ('//') comments on lines before code #indent_relative_single_line_comments # { False, True } # If set, will indent trailing single line ('//') comments relative # to the code instead of trying to keep the same absolute column #indent_switch_case # Number # Spaces to indent 'case' from 'switch' # Usually 0 or indent_columns. #indent_case_shift # Number # Spaces to shift the 'case' line, without affecting any other lines # Usually 0. #indent_case_brace # 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_col1_comment # { False, True } # Whether to indent comments found in first column #indent_label # Number # How to indent goto labels # >0 : absolute column where 1 is the leftmost column # <=0 : subtract from brace indent #indent_access_spec # Number # Same as indent_label, but for access specifiers that are followed by a colon #indent_access_spec_body # { False, True } # Indent the code after an access specifier by one level. # If set, this option forces 'indent_access_spec=0' #indent_paren_nl # { 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_close # Number # 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_comma_paren # { False, True } # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren #indent_bool_paren # { False, True } # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren #indent_square_nl # { 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_preserve_sql # { False, True } # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies #indent_align_assign # { 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. ## ## Spacing options ## sp_arith = add # { Ignore, Add, Remove, Force } # Add or remove space around arithmetic operator '+', '-', '/', '*', etc sp_assign = add # { Ignore, Add, Remove, Force } # Add or remove space around assignment operator '=', '+=', etc #sp_before_assign # { Ignore, Add, Remove, Force } # Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign. #sp_after_assign # { Ignore, Add, Remove, Force } # Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign. sp_enum_assign = add # { Ignore, Add, Remove, Force } # Add or remove space around assignment '=' in enum #sp_enum_before_assign # { Ignore, Add, Remove, Force } # Add or remove space before assignment '=' in enum. Overrides sp_enum_assign. #sp_enum_after_assign # { Ignore, Add, Remove, Force } # Add or remove space after assignment '=' in enum. Overrides sp_enum_assign. sp_bool = add # { Ignore, Add, Remove, Force } # Add or remove space around boolean operators '&&' and '||' sp_compare = add # { Ignore, Add, Remove, Force } # Add or remove space around compare operator '<', '>', '==', etc #sp_inside_paren # { Ignore, Add, Remove, Force } # Add or remove space inside '(' and ')' #sp_paren_paren # { Ignore, Add, Remove, Force } # Add or remove space between nested parens #sp_balance_nested_parens # { False, True } # Whether to balance spaces inside nested parens sp_paren_brace = add # { Ignore, Add, Remove, Force } # Add or remove space between ')' and '{' #sp_before_ptr_star # { Ignore, Add, Remove, Force } # Add or remove space before pointer star '*' #sp_before_unnamed_ptr_star # { 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_between_ptr_star # { Ignore, Add, Remove, Force } # Add or remove space between pointer stars '*' sp_after_ptr_star = remove # { Ignore, Add, Remove, Force } # Add or remove space after pointer star '*', if followed by a word. #sp_after_ptr_star_func # { Ignore, Add, Remove, Force } # Add or remove space after a pointer star '*', if followed by a func proto/def. #sp_before_ptr_star_func # { Ignore, Add, Remove, Force } # Add or remove space before a pointer star '*', if followed by a func proto/def. #sp_before_byref # { Ignore, Add, Remove, Force } # Add or remove space before a reference sign '&' #sp_before_unnamed_byref # { 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_after_byref # { Ignore, Add, Remove, Force } # Add or remove space after reference sign '&', if followed by a word. #sp_after_byref_func # { Ignore, Add, Remove, Force } # Add or remove space after a reference sign '&', if followed by a func proto/def. #sp_before_byref_func # { Ignore, Add, Remove, Force } # Add or remove space before a reference sign '&', if followed by a func proto/def. #sp_after_type # { Ignore, Add, Remove, Force } # Add or remove space between type and word #sp_template_angle # { Ignore, Add, Remove, Force } # Add or remove space in 'template <' vs 'template<'. # If set to ignore, sp_before_angle is used. #sp_before_angle # { Ignore, Add, Remove, Force } # Add or remove space before '<>' #sp_inside_angle # { Ignore, Add, Remove, Force } # Add or remove space inside '<' and '>' #sp_after_angle # { Ignore, Add, Remove, Force } # Add or remove space after '<>' #sp_angle_paren # { Ignore, Add, Remove, Force } # Add or remove space between '<>' and '(' as found in 'new List();' #sp_angle_word # { Ignore, Add, Remove, Force } # Add or remove space between '<>' and a word as in 'List m;' sp_before_sparen = add # { Ignore, Add, Remove, Force } # Add or remove space before '(' of 'if', 'for', 'switch', and 'while' sp_inside_sparen = remove # { Ignore, Add, Remove, Force } # Add or remove space inside if-condition '(' and ')' #sp_inside_sparen_close # { Ignore, Add, Remove, Force } # Add or remove space before if-condition ')'. Overrides sp_inside_sparen. #sp_after_sparen # { Ignore, Add, Remove, Force } # Add or remove space after ')' of 'if', 'for', 'switch', and 'while' #sp_sparen_brace # { Ignore, Add, Remove, Force } # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while' #sp_invariant_paren # { Ignore, Add, Remove, Force } # Add or remove space between 'invariant' and '(' in the D language. #sp_after_invariant_paren # { Ignore, Add, Remove, Force } # Add or remove space after the ')' in 'invariant (C) c' in the D language. #sp_special_semi # { Ignore, Add, Remove, Force } # Add or remove space before empty statement ';' on 'if', 'for' and 'while' #sp_before_semi # { Ignore, Add, Remove, Force } # Add or remove space before ';' #sp_before_semi_for # { Ignore, Add, Remove, Force } # Add or remove space before ';' in non-empty 'for' statements #sp_before_semi_for_empty # { Ignore, Add, Remove, Force } # Add or remove space before a semicolon of an empty part of a for statment. #sp_after_semi_for_empty # { Ignore, Add, Remove, Force } # Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; ). #sp_before_square # { Ignore, Add, Remove, Force } # Add or remove space before '[' (except '[]') #sp_before_squares # { Ignore, Add, Remove, Force } # Add or remove space before '[]' #sp_inside_square # { Ignore, Add, Remove, Force } # Add or remove space inside '[' and ']' #sp_after_comma # { Ignore, Add, Remove, Force } # Add or remove space after ',' #sp_before_comma # { Ignore, Add, Remove, Force } # Add or remove space before ',' #sp_after_class_colon # { Ignore, Add, Remove, Force } # Add or remove space after class ':' #sp_before_class_colon # { Ignore, Add, Remove, Force } # Add or remove space before class ':' #sp_before_case_colon # { Ignore, Add, Remove, Force } # Add or remove space before case ':' #sp_after_operator # { Ignore, Add, Remove, Force } # Add or remove space between 'operator' and operator sign #sp_after_operator_sym # { Ignore, Add, Remove, Force } # Add or remove space between the operator symbol and the open paren, as in 'operator ++(' #sp_after_cast # { 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' #sp_inside_paren_cast # { Ignore, Add, Remove, Force } # Add or remove spaces inside cast parens #sp_cpp_cast_paren # { Ignore, Add, Remove, Force } # Add or remove space between the type and open paren in a C++ cast, ie 'int(exp)' vs 'int (exp)' #sp_sizeof_paren # { Ignore, Add, Remove, Force } # Add or remove space between 'sizeof' and '(' #sp_after_tag # { Ignore, Add, Remove, Force } # Add or remove space after the tag keyword (Pawn) #sp_inside_braces_enum # { Ignore, Add, Remove, Force } # Add or remove space inside enum '{' and '}' #sp_inside_braces_struct # { Ignore, Add, Remove, Force } # Add or remove space inside struct/union '{' and '}' #sp_inside_braces # { Ignore, Add, Remove, Force } # Add or remove space inside '{' and '}' #sp_inside_braces_empty # { Ignore, Add, Remove, Force } # Add or remove space inside '{}' #sp_type_func # { Ignore, Add, Remove, Force } # Add or remove space between return type and function name # A minimum of 1 is forced except for pointer return types. sp_func_proto_paren = remove # { Ignore, Add, Remove, Force } # Add or remove space between function name and '(' on function declaration sp_func_def_paren = remove # { Ignore, Add, Remove, Force } # Add or remove space between function name and '(' on function definition #sp_inside_fparens # { Ignore, Add, Remove, Force } # Add or remove space inside empty function '()' #sp_inside_fparen # { Ignore, Add, Remove, Force } # Add or remove space inside function '(' and ')' #sp_square_fparen # { Ignore, Add, Remove, Force } # Add or remove space between ']' and '(' when part of a function call. #sp_fparen_brace # { Ignore, Add, Remove, Force } # Add or remove space between ')' and '{' of function sp_func_call_paren = remove # { Ignore, Add, Remove, Force } # Add or remove space between function name and '(' on function calls #sp_func_call_user_paren # { 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_class_paren # { Ignore, Add, Remove, Force } # Add or remove space between a constructor/destructor and the open paren #sp_return_paren # { Ignore, Add, Remove, Force } # Add or remove space between 'return' and '(' #sp_attribute_paren # { Ignore, Add, Remove, Force } # Add or remove space between '__attribute__' and '(' #sp_defined_paren # { Ignore, Add, Remove, Force } # Add or remove space between 'defined' and '(' in '#if defined (FOO)' #sp_throw_paren # { Ignore, Add, Remove, Force } # Add or remove space between 'throw' and '(' in 'throw (something)' #sp_macro # { Ignore, Add, Remove, Force } # Add or remove space between macro and value #sp_macro_func # { Ignore, Add, Remove, Force } # Add or remove space between macro function ')' and value #sp_else_brace # { Ignore, Add, Remove, Force } # Add or remove space between 'else' and '{' if on the same line #sp_brace_else # { Ignore, Add, Remove, Force } # Add or remove space between '}' and 'else' if on the same line #sp_brace_typedef # { Ignore, Add, Remove, Force } # Add or remove space between '}' and the name of a typedef on the same line #sp_catch_brace # { Ignore, Add, Remove, Force } # Add or remove space between 'catch' and '{' if on the same line #sp_brace_catch # { Ignore, Add, Remove, Force } # Add or remove space between '}' and 'catch' if on the same line #sp_finally_brace # { Ignore, Add, Remove, Force } # Add or remove space between 'finally' and '{' if on the same line #sp_brace_finally # { Ignore, Add, Remove, Force } # Add or remove space between '}' and 'finally' if on the same line #sp_try_brace # { Ignore, Add, Remove, Force } # Add or remove space between 'try' and '{' if on the same line #sp_getset_brace # { Ignore, Add, Remove, Force } # Add or remove space between get/set and '{' if on the same line #sp_before_dc # { Ignore, Add, Remove, Force } # Add or remove space before the '::' operator #sp_after_dc # { Ignore, Add, Remove, Force } # Add or remove space after the '::' operator #sp_d_array_colon # { Ignore, Add, Remove, Force } # Add or remove around the D named array initializer ':' operator #sp_not # { Ignore, Add, Remove, Force } # Add or remove space after the '!' (not) operator. #sp_inv # { Ignore, Add, Remove, Force } # Add or remove space after the '~' (invert) operator. #sp_addr # { Ignore, Add, Remove, Force } # Add or remove space after the '&' (address-of) operator. # This does not affect the spacing after a '&' that is part of a type. #sp_member # { Ignore, Add, Remove, Force } # Add or remove space around the '.' or '->' operators #sp_deref # { Ignore, Add, Remove, Force } # Add or remove space after the '*' (dereference) operator. # This does not affect the spacing after a '*' that is part of a type. #sp_sign # { Ignore, Add, Remove, Force } # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7' #sp_incdec # { Ignore, Add, Remove, Force } # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;' #sp_before_nl_cont # { Ignore, Add, Remove, Force } # Add or remove space before a backslash-newline at the end of a line #sp_after_oc_scope # { Ignore, Add, Remove, Force } # Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;' #sp_after_oc_colon # { Ignore, Add, Remove, Force } # Add or remove space after the colon in message specs # '-(int) f:(int) x;' vs '-(int) f: (int) x;' #sp_before_oc_colon # { Ignore, Add, Remove, Force } # Add or remove space before the colon in message specs # '-(int) f: (int) x;' vs '-(int) f : (int) x;' #sp_after_send_oc_colon # { Ignore, Add, Remove, Force } # Add or remove space after the colon in message specs # '[object setValue:1];' vs '[object setValue: 1];' #sp_before_send_oc_colon # { Ignore, Add, Remove, Force } # Add or remove space before the colon in message specs # '[object setValue:1];' vs '[object setValue :1];' #sp_after_oc_type # { Ignore, Add, Remove, Force } # Add or remove space after the (type) in message specs # '-(int) f: (int) x;' vs '-(int) f: (int)x;' #sp_cond_colon # { Ignore, Add, Remove, Force } # Add or remove space around the ':' in 'b ? t : f' #sp_cond_question # { Ignore, Add, Remove, Force } # Add or remove space around the '?' in 'b ? t : f' #sp_case_label # { Ignore, Add, Remove, Force } # Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here. #sp_range # { Ignore, Add, Remove, Force } # Control the space around the D '..' operator. #sp_cmt_cpp_start # { Ignore, Add, Remove, Force } # Control the space after the opening of a C++ comment '// A' vs '//A' ## ## Code alignment (not left column spaces/tabs) ## #align_keep_tabs # { False, True } # Whether to keep non-indenting tabs #align_with_tabs # { False, True } # Whether to use tabs for alinging #align_on_tabstop # { False, True } # Whether to bump out to the next tab when aligning #align_number_left # { False, True } # Whether to left-align numbers #align_func_params # { False, True } # Align variable definitions in prototypes and functions #align_same_func_call_params # { False, True } # Align parameters in single-line functions that have the same name. # The function names must already be aligned with each other. #align_var_def_span # Number #The span for aligning variable definitions (0=don't align) #align_var_def_star_style # Number # How to align the star in variable definitions. # 0=Part of the type 'void * foo;' # 1=Part of the variable 'void *foo;' # 2=Dangling 'void *foo;' #align_var_def_amp_style # Number # How to align the '&' in variable definitions. # 0=Part of the type # 1=Part of the variable # 2=Dangling #align_var_def_thresh # Number # The threshold for aligning variable definitions (0=no limit) #align_var_def_gap # Number # The gap for aligning variable definitions #align_var_def_colon # { False, True } # Whether to align the colon in struct bit fields #align_var_def_inline # { False, True } # Whether to align inline struct/enum/union variable definitions #align_assign_span # Number # The span for aligning on '=' in assignments (0=don't align) #align_assign_thresh # Number # The threshold for aligning on '=' in assignments (0=no limit) #align_enum_equ_span # Number # The span for aligning on '=' in enums (0=don't align) #align_enum_equ_thresh # Number # The threshold for aligning on '=' in enums (0=no limit) #align_var_struct_span # Number # The span for aligning struct/union (0=don't align) #align_var_struct_thresh # Number # The threshold for aligning struct/union member definitions (0=no limit) #align_var_struct_gap # Number # The gap for aligning struct/union member definitions #align_struct_init_span # Number # The span for aligning struct initializer values (0=don't align) #align_typedef_gap # Number # The minimum space between the type and the synonym of a typedef #align_typedef_span # Number # The span for aligning single-line typedefs (0=don't align) #align_typedef_func # 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_star_style # Number # Controls the positioning of the '*' in typedefs. Just try it. # 0: Align on typdef 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 # Number # Controls the positioning of the '&' in typedefs. Just try it. # 0: Align on typdef 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_right_cmt_span # Number # The span for aligning comments that end lines (0=don't align) #align_right_cmt_mix # { False, True } # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment #align_right_cmt_gap # Number # If a trailing comment is more than this number of columns away from the text it follows, # it will qualify for being aligned. #align_func_proto_span # Number # The span for aligning function prototypes (0=don't align) #align_func_proto_gap # Number # Minimum gap between the return type and the function name. #align_on_operator # { False, True } # Align function protos on the 'operator' keyword instead of what follows #align_mix_var_proto # { 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_single_line_func # { False, True } # Align single-line functions with function prototypes, uses align_func_proto_span #align_single_line_brace # { False, True } # Aligning the open brace of single-line functions. # Requires align_single_line_func=true, uses align_func_proto_span #align_single_line_brace_gap # Number # Gap for align_single_line_brace. #align_oc_msg_spec_span # Number # The span for aligning ObjC msg spec (0=don't align) #align_nl_cont # { False, True } # 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_pp_define_gap # Number # The minimum space between label and value of a preprocessor define #align_pp_define_span # Number # The span for aligning on '#define' bodies (0=don't align) #align_left_shift # { False, True } # Align lines that start with '<<' with previous '<<'. Default=true ## ## Newline adding and removing options ## #nl_collapse_empty_body # { False, True } # Whether to collapse empty blocks between '{' and '}' #nl_assign_leave_one_liners # { False, True } # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };' #nl_class_leave_one_liners # { False, True } # Don't split one-line braced statements inside a class xx { } body #nl_enum_leave_one_liners # { False, True } # Don't split one-line enums: 'enum foo { BAR = 15 };' #nl_getset_leave_one_liners # { False, True } # Don't split one-line get or set functions #nl_func_leave_one_liners # { False, True } # Don't split one-line function definitions - 'int foo() { return 0; }' #nl_if_leave_one_liners # { False, True } # Don't split one-line if/else statements - 'if(a) b++;' #nl_start_of_file # { Ignore, Add, Remove, Force } # Add or remove newlines at the start of the file #nl_start_of_file_min # Number # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force' #nl_end_of_file # { Ignore, Add, Remove, Force } # Add or remove newline at the end of the file #nl_end_of_file_min # Number # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force') #nl_assign_brace # { Ignore, Add, Remove, Force } # Add or remove newline between '=' and '{' #nl_assign_square # { Ignore, Add, Remove, Force } # Add or remove newline between '=' and '[' (D only) #nl_after_square_assign # { Ignore, Add, Remove, Force } # Add or remove newline after '= [' (D only). Will also affect the newline before the ']' #nl_func_var_def_blk # Number # The number of newlines after a block of variable definitions #nl_fcall_brace # { Ignore, Add, Remove, Force } # Add or remove newline between a function call's ')' and '{', as in: # list_for_each(item, &list) { } #nl_enum_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'enum' and '{' #nl_struct_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'struct and '{' #nl_union_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'union' and '{' #nl_if_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'if' and '{' #nl_brace_else # { Ignore, Add, Remove, Force } # Add or remove newline between '}' and 'else' #nl_elseif_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'else if' and '{' # If set to ignore, nl_if_brace is used instead #nl_else_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'else' and '{' #nl_else_if # { Ignore, Add, Remove, Force } # Add or remove newline between 'else' and 'if' #nl_brace_finally # { Ignore, Add, Remove, Force } # Add or remove newline between '}' and 'finally' #nl_finally_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'finally' and '{' #nl_try_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'try' and '{' #nl_getset_brace # { Ignore, Add, Remove, Force } # Add or remove newline between get/set and '{' #nl_for_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'for' and '{' #nl_catch_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'catch' and '{' #nl_brace_catch # { Ignore, Add, Remove, Force } # Add or remove newline between '}' and 'catch' #nl_while_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'while' and '{' #nl_do_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'do' and '{' #nl_brace_while # { Ignore, Add, Remove, Force } # Add or remove newline between '}' and 'while' of 'do' statement #nl_switch_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'switch' and '{' #nl_multi_line_cond # { 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_define # { False, True } # Force a newline in a define after the macro name for multi-line defines. nl_before_case = true # { False, True } # Whether to put a newline before 'case' statement #nl_before_throw # { Ignore, Add, Remove, Force } # Add or remove newline between ')' and 'throw' #nl_after_case # { False, True } # Whether to put a newline after 'case' statement #nl_namespace_brace # { Ignore, Add, Remove, Force } # Newline between namespace and { #nl_template_class # { Ignore, Add, Remove, Force } # Add or remove newline between 'template<>' and whatever follows. #nl_class_brace # { Ignore, Add, Remove, Force } # Add or remove newline between 'class' and '{' #nl_class_init_args # { Ignore, Add, Remove, Force } # Add or remove newline after each ',' in the constructor member initialization #nl_func_type_name # { Ignore, Add, Remove, Force } # Add or remove newline between return type and function name in definition #nl_func_scope_name # { 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_proto_type_name # { Ignore, Add, Remove, Force } # Add or remove newline between return type and function name in a prototype #nl_func_paren # { Ignore, Add, Remove, Force } # Add or remove newline between a function name and the opening '(' #nl_func_decl_start # { Ignore, Add, Remove, Force } # Add or remove newline after '(' in a function declaration #nl_func_decl_args # { Ignore, Add, Remove, Force } # Add or remove newline after each ',' in a function declaration #nl_func_decl_end # { Ignore, Add, Remove, Force } # Add or remove newline before the ')' in a function declaration #nl_fdef_brace # { Ignore, Add, Remove, Force } # Add or remove newline between function signature and '{' #nl_after_return # { False, True } # Whether to put a newline after 'return' statement #nl_return_expr # { Ignore, Add, Remove, Force } # Add or remove a newline between the return keyword and return expression. #nl_after_semicolon # { False, True } # Whether to put a newline after semicolons, except in 'for' statements #nl_after_brace_open # { False, True } # Whether to put a newline after brace open. # This also adds a newline before the matching brace close. #nl_after_brace_open_cmt # { 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_vbrace_open # { False, True } # Whether to put a newline after a virtual brace open. # These occur in un-braced if/while/do/for statement bodies. #nl_after_brace_close # { False, True } # Whether to put a newline after a brace close. # Does not apply if followed by a necessary ';'. #nl_define_macro # { False, True } # Whether to alter newlines in '#define' macros #nl_squeeze_ifdef # { False, True } # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif' #nl_before_if # { Ignore, Add, Remove, Force } # Add or remove newline before 'if' #nl_after_if # { Ignore, Add, Remove, Force } # Add or remove newline after 'if' #nl_before_for # { Ignore, Add, Remove, Force } # Add or remove newline before 'for' #nl_after_for # { Ignore, Add, Remove, Force } # Add or remove newline after 'for' #nl_before_while # { Ignore, Add, Remove, Force } # Add or remove newline before 'while' #nl_after_while # { Ignore, Add, Remove, Force } # Add or remove newline after 'while' #nl_before_switch # { Ignore, Add, Remove, Force } # Add or remove newline before 'switch' #nl_after_switch # { Ignore, Add, Remove, Force } # Add or remove newline after 'switch' #nl_before_do # { Ignore, Add, Remove, Force } # Add or remove newline before 'do' #nl_after_do # { Ignore, Add, Remove, Force } # Add or remove newline after 'do' #nl_ds_struct_enum_cmt # { False, True } # Whether to double-space commented-entries in struct/enum #nl_ds_struct_enum_close_brace # { False, True } # Whether to double-space before the close brace of a struct/union/enum #nl_class_colon # { Ignore, Add, Remove, Force } # Add or remove a newline around a class colon. # Related to pos_class_colon, nl_class_init_args, and pos_comma. #nl_create_if_one_liner # { False, True } # Change simple unbraced if statements into a one-liner # 'if(b)\n i++;' => 'if(b) i++;' #nl_create_for_one_liner # { False, True } # 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_while_one_liner # { False, True } # Change simple unbraced while statements into a one-liner # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);' ## ## Positioning options ## #pos_arith # { Ignore, Lead, Trail } # The position of arithmetic operators in wrapped expressions #pos_assign # { Ignore, Lead, Trail } # The position of assignment in wrapped expressions #pos_bool # { Ignore, Lead, Trail } # The position of boolean operators in wrapped expressions #pos_comma # { Ignore, Lead, Trail } # The position of the comma in wrapped expressions #pos_class_comma # { Ignore, Lead, Trail } # The position of the comma in the constructor initialization list #pos_class_colon # { Ignore, Lead, Trail } # The position of colons between constructor and member initialization ## ## Line Splitting options ## #code_width # Number # Try to limit code width to N number of columns #ls_for_split_full # { False, True } # Whether to fully split long 'for' statements at semi-colons #ls_func_split_full # { False, True } # Whether to fully split long function protos/calls at commas ## ## Blank line options ## #nl_max # Number # The maximum consecutive newlines #nl_after_func_proto # Number # The number of newlines after a function prototype, if followed by another function prototype #nl_after_func_proto_group # Number # The number of newlines after a function prototype, if not followed by another function prototype #nl_after_func_body # Number # The number of newlines after '}' of a multi-line function body #nl_after_func_body_one_liner # Number # The number of newlines after '}' of a single line function body #nl_before_block_comment # 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_c_comment # 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_cpp_comment # Number # The minimum number of newlines before a CPP comment. # Doesn't apply if after a brace open or other CPP comments. #nl_after_multiline_comment # { False, True } # Whether to force a newline after a mulit-line comment. #nl_before_access_spec # 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_after_access_spec # Number # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. # 0 = No change. #nl_comment_func_def # Number # The number of newlines between a function def and the function comment. # 0 = No change. #nl_after_try_catch_finally # Number # The number of newlines after a try-catch-finally block that isn't followed by a brace close. # 0 = No change. #nl_around_cs_property # Number # The number of newlines before and after a property, indexer or event decl. # 0 = No change. #nl_between_get_set # Number # The number of newlines between the get/set/add/remove handlers in C#. # 0 = No change. #eat_blanks_after_open_brace # { False, True } # Whether to remove blank lines after '{' #eat_blanks_before_close_brace # { False, True } # Whether to remove blank lines before '}' ## ## Code modifying options (non-whitespace) ## #mod_full_brace_do # { Ignore, Add, Remove, Force } #Add or remove braces on single-line 'do' statement #mod_full_brace_for # { Ignore, Add, Remove, Force } # Add or remove braces on single-line 'for' statement #mod_full_brace_function # { Ignore, Add, Remove, Force } # Add or remove braces on single-line function defintions. (Pawn) #mod_full_brace_if # { 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_nl # Number # Don't remove braces around statements that span N newlines #mod_full_brace_while # { Ignore, Add, Remove, Force } # Add or remove braces on single-line 'while' statement #mod_paren_on_return # { Ignore, Add, Remove, Force } # Add or remove unnecessary paren on 'return' statement #mod_pawn_semicolon # { False, True } # Whether to change optional semicolons to real semicolons #mod_full_paren_if_bool # { False, True } # Add parens on 'while' and 'if' statement around bools #mod_remove_extra_semicolon # { False, True } # Whether to remove superfluous semicolons #mod_add_long_function_closebrace_comment 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_switch_closebrace_comment # 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_sort_import # { False, True } # If TRUE, will sort consecutive single-line 'import' statements [Java, D] #mod_sort_using # { False, True } # If TRUE, will sort consecutive single-line 'using' statements [C#] #mod_sort_include # { False, True } # 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_move_case_break # { False, True } # If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace. #mod_remove_empty_return # { False, True } # If TRUE, it will remove a void 'return;' that appears as the last statement in a function. ## ## Comment modifications ## #cmt_width # Number # Try to wrap comments at cmt_width columns #cmt_indent_multi # { False, True } # If false, disable all multi-line comment changes, including cmt_width and leading chars. # Default is true. #cmt_c_group # { False, True } # Whether to group c-comments that look like they are in a block #cmt_c_nl_start # { False, True } # Whether to put an empty '/*' on the first line of the combined c-comment #cmt_c_nl_end # { False, True } # Whether to put a newline before the closing '*/' of the combined c-comment #cmt_cpp_group # { False, True } # Whether to group cpp-comments that look like they are in a block #cmt_cpp_nl_start # { False, True } # Whether to put an empty '/*' on the first line of the combined cpp-comment #cmt_cpp_nl_end # { False, True } # Whether to put a newline before the closing '*/' of the combined cpp-comment #cmt_cpp_to_c # { False, True } # Whether to change cpp-comments into c-comments #cmt_star_cont # { False, True } # Whether to put a star on subsequent comment lines #cmt_sp_before_star_cont # Number # The number of spaces to insert at the start of subsequent comment lines #cmt_sp_after_star_cont # Number # The number of spaces to insert after the star on subsequent comment lines #cmt_multi_check_last # { 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. Default=True #cmt_insert_file_header # String # 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. #cmt_insert_file_footer # 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 substitue $(filename) with the current file's name. #cmt_insert_func_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. # Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... } #cmt_insert_class_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. #cmt_insert_before_preproc # { False, True } # 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. ## ## Preprocessor options ## #pp_indent # { Ignore, Add, Remove, Force } # Control indent of preprocessors inside #if blocks at brace level 0 #pp_indent_at_level # { False, True } # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false) #pp_indent_count # Number # If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1. #pp_space # { Ignore, Add, Remove, Force } # Add or remove space after # based on pp_level of #if blocks #pp_space_count # Number # Sets the number of spaces added with pp_space #pp_indent_region # Number # The indent for #region and #endregion in C# and '#pragma region' in C/C++ #pp_region_indent_code # { False, True } # Whether to indent the code between #region and #endregion #pp_indent_if # Number # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level #pp_if_indent_code # { False, True } # Control whether to indent the code between #if, #else and #endif when not at file-level #pp_define_at_level # { False, True } # Whether to indent '#define' at the brace level (true) or from column 1 (false)