1# Uncrustify 0.53 2 3# 4# General options 5# 6 7# The type of line endings 8newlines = auto # auto/lf/crlf/cr 9 10# The original size of tabs in the input 11input_tab_size = 8 # number 12 13# The size of tabs in the output (only used if align_with_tabs=true) 14output_tab_size = 8 # number 15 16# The ascii value of the string escape char, usually 92 (\) or 94 (^). (Pawn) 17string_escape_char = 92 # number 18 19# Alternate string escape char for Pawn. Only works right before the quote char. 20string_escape_char2 = 0 # number 21 22# 23# Indenting 24# 25 26# The number of columns to indent per level. 27# Usually 2, 3, 4, or 8. 28indent_columns = 2 # number 29 30# How to use tabs when indenting code 31# 0=spaces only 32# 1=indent with tabs, align with spaces 33# 2=indent and align with tabs 34indent_with_tabs = 0 # number 35 36# Whether to indent strings broken by '\' so that they line up 37indent_align_string = false # false/true 38 39# The number of spaces to indent multi-line XML strings. 40# Requires indent_align_string=True 41indent_xml_string = 0 # number 42 43# Spaces to indent '{' from level 44indent_brace = 0 # number 45 46# Whether braces are indented to the body level 47indent_braces = false # false/true 48 49# Disabled indenting function braces if indent_braces is true 50indent_braces_no_func = false # false/true 51 52# Indent based on the size of the brace parent, ie 'if' => 3 spaces, 'for' => 4 spaces, etc. 53indent_brace_parent = false # false/true 54 55# Whether the 'namespace' body is indented 56indent_namespace = true # false/true 57 58# Whether the 'extern "C"' body is indented 59indent_extern = false # false/true 60 61# Whether the 'class' body is indented 62indent_class = true # false/true 63 64# Whether to indent the stuff after a leading class colon 65indent_class_colon = false # false/true 66 67# False=treat 'else\nif' as 'else if' for indenting purposes 68# True=indent the 'if' one level 69indent_else_if = false # false/true 70 71# Amount to indent variable declarations after a open brace. neg=relative, pos=absolute 72indent_var_def_blk = 0 # number 73 74# True: indent continued function call parameters one indent level 75# False: align parameters under the open paren 76indent_func_call_param = false # false/true 77 78# Same as indent_func_call_param, but for function defs 79indent_func_def_param = false # false/true 80 81# Same as indent_func_call_param, but for function protos 82indent_func_proto_param = false # false/true 83 84# Same as indent_func_call_param, but for class declarations 85indent_func_class_param = false # false/true 86 87# Same as indent_func_call_param, but for class variable constructors 88indent_func_ctor_var_param = false # false/true 89 90# Same as indent_func_call_param, but for templates 91indent_template_param = false # false/true 92 93# Double the indent for indent_func_xxx_param options 94indent_func_param_double = false # false/true 95 96# Indentation column for standalone 'const' function decl/proto qualifier 97indent_func_const = 0 # number 98 99# Indentation column for standalone 'throw' function decl/proto qualifier 100indent_func_throw = 0 # number 101 102# The number of spaces to indent a continued '->' or '.' 103# Usually set to 0, 1, or indent_columns. 104indent_member = 0 # number 105 106# Spaces to indent single line ('//') comments on lines before code 107indent_sing_line_comments = 0 # number 108 109# If set, will indent trailing single line ('//') comments relative 110# to the code instead of trying to keep the same absolute column 111indent_relative_single_line_comments = false # false/true 112 113# Spaces to indent 'case' from 'switch' 114# Usually 0 or indent_columns. 115indent_switch_case = 2 # number 116 117# Spaces to shift the 'case' line, without affecting any other lines 118# Usually 0. 119indent_case_shift = 0 # number 120 121# Spaces to indent '{' from 'case'. 122# By default, the brace will appear under the 'c' in case. 123# Usually set to 0 or indent_columns. 124indent_case_brace = 0 # number 125 126# Whether to indent comments found in first column 127indent_col1_comment = false # false/true 128 129# How to indent goto labels 130# >0 : absolute column where 1 is the leftmost column 131# <=0 : subtract from brace indent 132indent_label = 1 # number 133 134# Same as indent_label, but for access specifiers that are followed by a colon 135indent_access_spec = 1 # number 136 137# Indent the code after an access specifier by one level. 138# If set, this option forces 'indent_access_spec=0' 139indent_access_spec_body = false # false/true 140 141# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended) 142indent_paren_nl = false # false/true 143 144# Controls the indent of a close paren after a newline. 145# 0: Indent to body level 146# 1: Align under the open paren 147# 2: Indent to the brace level 148indent_paren_close = 0 # number 149 150# Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren 151indent_comma_paren = false # false/true 152 153# Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren 154indent_bool_paren = false # false/true 155 156# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended) 157indent_square_nl = false # false/true 158 159# Don't change the relative indent of ESQL/C 'EXEC SQL' bodies 160indent_preserve_sql = false # false/true 161 162# Align continued statements at the '='. Default=True 163# If FALSE or the '=' is followed by a newline, the next line is indent one tab. 164indent_align_assign = true # false/true 165 166# 167# Spacing options 168# 169 170# Add or remove space around arithmetic operator '+', '-', '/', '*', etc 171sp_arith = force # ignore/add/remove/force 172 173# Add or remove space around assignment operator '=', '+=', etc 174sp_assign = force # ignore/add/remove/force 175 176# Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign. 177sp_before_assign = ignore # ignore/add/remove/force 178 179# Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign. 180sp_after_assign = ignore # ignore/add/remove/force 181 182# Add or remove space around assignment '=' in enum 183sp_enum_assign = force # ignore/add/remove/force 184 185# Add or remove space before assignment '=' in enum. Overrides sp_enum_assign. 186sp_enum_before_assign = ignore # ignore/add/remove/force 187 188# Add or remove space after assignment '=' in enum. Overrides sp_enum_assign. 189sp_enum_after_assign = ignore # ignore/add/remove/force 190 191# Add or remove space around preprocessor '##' concatenation operator 192sp_pp_concat = add # ignore/add/remove/force 193 194# Add or remove space after preprocessor '#' stringify operator 195sp_pp_stringify = add # ignore/add/remove/force 196 197# Add or remove space around boolean operators '&&' and '||' 198sp_bool = force # ignore/add/remove/force 199 200# Add or remove space around compare operator '<', '>', '==', etc 201sp_compare = force # ignore/add/remove/force 202 203# Add or remove space inside '(' and ')' 204sp_inside_paren = remove # ignore/add/remove/force 205 206# Add or remove space between nested parens 207sp_paren_paren = remove # ignore/add/remove/force 208 209# Whether to balance spaces inside nested parens 210sp_balance_nested_parens = false # false/true 211 212# Add or remove space between ')' and '{' 213sp_paren_brace = ignore # ignore/add/remove/force 214 215# Add or remove space before pointer star '*' 216sp_before_ptr_star = force # ignore/add/remove/force 217 218# Add or remove space before pointer star '*' that isn't followed by a variable name 219# If set to 'ignore', sp_before_ptr_star is used instead. 220sp_before_unnamed_ptr_star = ignore # ignore/add/remove/force 221 222# Add or remove space between pointer stars '*' 223sp_between_ptr_star = remove # ignore/add/remove/force 224 225# Add or remove space after pointer star '*', if followed by a word. 226sp_after_ptr_star = remove # ignore/add/remove/force 227 228# Add or remove space after a pointer star '*', if followed by a func proto/def. 229sp_after_ptr_star_func = ignore # ignore/add/remove/force 230 231# Add or remove space before a pointer star '*', if followed by a func proto/def. 232sp_before_ptr_star_func = ignore # ignore/add/remove/force 233 234# Add or remove space before a reference sign '&' 235sp_before_byref = force # ignore/add/remove/force 236 237# Add or remove space before a reference sign '&' that isn't followed by a variable name 238# If set to 'ignore', sp_before_byref is used instead. 239sp_before_unnamed_byref = ignore # ignore/add/remove/force 240 241# Add or remove space after reference sign '&', if followed by a word. 242sp_after_byref = remove # ignore/add/remove/force 243 244# Add or remove space after a reference sign '&', if followed by a func proto/def. 245sp_after_byref_func = ignore # ignore/add/remove/force 246 247# Add or remove space before a reference sign '&', if followed by a func proto/def. 248sp_before_byref_func = ignore # ignore/add/remove/force 249 250# Add or remove space between type and word 251sp_after_type = force # ignore/add/remove/force 252 253# Add or remove space in 'template <' vs 'template<'. 254# If set to ignore, sp_before_angle is used. 255sp_template_angle = ignore # ignore/add/remove/force 256 257# Add or remove space before '<>' 258sp_before_angle = ignore # ignore/add/remove/force 259 260# Add or remove space inside '<' and '>' 261sp_inside_angle = ignore # ignore/add/remove/force 262 263# Add or remove space after '<>' 264sp_after_angle = ignore # ignore/add/remove/force 265 266# Add or remove space between '<>' and '(' as found in 'new List<byte>();' 267sp_angle_paren = ignore # ignore/add/remove/force 268 269# Add or remove space between '<>' and a word as in 'List<byte> m;' 270sp_angle_word = ignore # ignore/add/remove/force 271 272# Add or remove space before '(' of 'if', 'for', 'switch', and 'while' 273sp_before_sparen = force # ignore/add/remove/force 274 275# Add or remove space inside if-condition '(' and ')' 276sp_inside_sparen = remove # ignore/add/remove/force 277 278# Add or remove space before if-condition ')'. Overrides sp_inside_sparen. 279sp_inside_sparen_close = ignore # ignore/add/remove/force 280 281# Add or remove space after ')' of 'if', 'for', 'switch', and 'while' 282sp_after_sparen = force # ignore/add/remove/force 283 284# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while' 285sp_sparen_brace = force # ignore/add/remove/force 286 287# Add or remove space between 'invariant' and '(' in the D language. 288sp_invariant_paren = ignore # ignore/add/remove/force 289 290# Add or remove space after the ')' in 'invariant (C) c' in the D language. 291sp_after_invariant_paren = ignore # ignore/add/remove/force 292 293# Add or remove space before empty statement ';' on 'if', 'for' and 'while' 294sp_special_semi = remove # ignore/add/remove/force 295 296# Add or remove space before ';' 297sp_before_semi = remove # ignore/add/remove/force 298 299# Add or remove space before ';' in non-empty 'for' statements 300sp_before_semi_for = remove # ignore/add/remove/force 301 302# Add or remove space before a semicolon of an empty part of a for statment. 303sp_before_semi_for_empty = force # ignore/add/remove/force 304 305# Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; <here> ). 306sp_after_semi_for_empty = ignore # ignore/add/remove/force 307 308# Add or remove space before '[' (except '[]') 309sp_before_square = remove # ignore/add/remove/force 310 311# Add or remove space before '[]' 312sp_before_squares = remove # ignore/add/remove/force 313 314# Add or remove space inside '[' and ']' 315sp_inside_square = remove # ignore/add/remove/force 316 317# Add or remove space after ',' 318sp_after_comma = force # ignore/add/remove/force 319 320# Add or remove space before ',' 321sp_before_comma = remove # ignore/add/remove/force 322 323# Add or remove space after class ':' 324sp_after_class_colon = ignore # ignore/add/remove/force 325 326# Add or remove space before class ':' 327sp_before_class_colon = ignore # ignore/add/remove/force 328 329# Add or remove space before case ':' 330sp_before_case_colon = remove # ignore/add/remove/force 331 332# Add or remove space between 'operator' and operator sign 333sp_after_operator = ignore # ignore/add/remove/force 334 335# Add or remove space between the operator symbol and the open paren, as in 'operator ++(' 336sp_after_operator_sym = ignore # ignore/add/remove/force 337 338# Add or remove space after C/D cast, ie 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a' 339sp_after_cast = force # ignore/add/remove/force 340 341# Add or remove spaces inside cast parens 342sp_inside_paren_cast = remove # ignore/add/remove/force 343 344# Add or remove space between the type and open paren in a C++ cast, ie 'int(exp)' vs 'int (exp)' 345sp_cpp_cast_paren = ignore # ignore/add/remove/force 346 347# Add or remove space between 'sizeof' and '(' 348sp_sizeof_paren = force # ignore/add/remove/force 349 350# Add or remove space after the tag keyword (Pawn) 351sp_after_tag = ignore # ignore/add/remove/force 352 353# Add or remove space inside enum '{' and '}' 354sp_inside_braces_enum = remove # ignore/add/remove/force 355 356# Add or remove space inside struct/union '{' and '}' 357sp_inside_braces_struct = remove # ignore/add/remove/force 358 359# Add or remove space inside '{' and '}' 360sp_inside_braces = remove # ignore/add/remove/force 361 362# Add or remove space inside '{}' 363sp_inside_braces_empty = remove # ignore/add/remove/force 364 365# Add or remove space between return type and function name 366# A minimum of 1 is forced except for pointer return types. 367sp_type_func = ignore # ignore/add/remove/force 368 369# Add or remove space between function name and '(' on function declaration 370sp_func_proto_paren = force # ignore/add/remove/force 371 372# Add or remove space between function name and '(' on function definition 373sp_func_def_paren = force # ignore/add/remove/force 374 375# Add or remove space inside empty function '()' 376sp_inside_fparens = remove # ignore/add/remove/force 377 378# Add or remove space inside function '(' and ')' 379sp_inside_fparen = remove # ignore/add/remove/force 380 381# Add or remove space between ']' and '(' when part of a function call. 382sp_square_fparen = ignore # ignore/add/remove/force 383 384# Add or remove space between ')' and '{' of function 385sp_fparen_brace = ignore # ignore/add/remove/force 386 387# Add or remove space between function name and '(' on function calls 388sp_func_call_paren = force # ignore/add/remove/force 389 390# Add or remove space between the user function name and '(' on function calls 391# You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file. 392sp_func_call_user_paren = remove # ignore/add/remove/force 393 394# Add or remove space between a constructor/destructor and the open paren 395sp_func_class_paren = ignore # ignore/add/remove/force 396 397# Add or remove space between 'return' and '(' 398sp_return_paren = force # ignore/add/remove/force 399 400# Add or remove space between '__attribute__' and '(' 401sp_attribute_paren = ignore # ignore/add/remove/force 402 403# Add or remove space between 'defined' and '(' in '#if defined (FOO)' 404sp_defined_paren = force # ignore/add/remove/force 405 406# Add or remove space between 'throw' and '(' in 'throw (something)' 407sp_throw_paren = ignore # ignore/add/remove/force 408 409# Add or remove space between macro and value 410sp_macro = force # ignore/add/remove/force 411 412# Add or remove space between macro function ')' and value 413sp_macro_func = force # ignore/add/remove/force 414 415# Add or remove space between 'else' and '{' if on the same line 416sp_else_brace = ignore # ignore/add/remove/force 417 418# Add or remove space between '}' and 'else' if on the same line 419sp_brace_else = ignore # ignore/add/remove/force 420 421# Add or remove space between '}' and the name of a typedef on the same line 422sp_brace_typedef = ignore # ignore/add/remove/force 423 424# Add or remove space between 'catch' and '{' if on the same line 425sp_catch_brace = ignore # ignore/add/remove/force 426 427# Add or remove space between '}' and 'catch' if on the same line 428sp_brace_catch = ignore # ignore/add/remove/force 429 430# Add or remove space between 'finally' and '{' if on the same line 431sp_finally_brace = ignore # ignore/add/remove/force 432 433# Add or remove space between '}' and 'finally' if on the same line 434sp_brace_finally = ignore # ignore/add/remove/force 435 436# Add or remove space between 'try' and '{' if on the same line 437sp_try_brace = ignore # ignore/add/remove/force 438 439# Add or remove space between get/set and '{' if on the same line 440sp_getset_brace = ignore # ignore/add/remove/force 441 442# Add or remove space before the '::' operator 443sp_before_dc = ignore # ignore/add/remove/force 444 445# Add or remove space after the '::' operator 446sp_after_dc = ignore # ignore/add/remove/force 447 448# Add or remove around the D named array initializer ':' operator 449sp_d_array_colon = ignore # ignore/add/remove/force 450 451# Add or remove space after the '!' (not) operator. 452sp_not = remove # ignore/add/remove/force 453 454# Add or remove space after the '~' (invert) operator. 455sp_inv = remove # ignore/add/remove/force 456 457# Add or remove space after the '&' (address-of) operator. 458# This does not affect the spacing after a '&' that is part of a type. 459sp_addr = remove # ignore/add/remove/force 460 461# Add or remove space around the '.' or '->' operators 462sp_member = remove # ignore/add/remove/force 463 464# Add or remove space after the '*' (dereference) operator. 465# This does not affect the spacing after a '*' that is part of a type. 466sp_deref = remove # ignore/add/remove/force 467 468# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7' 469sp_sign = remove # ignore/add/remove/force 470 471# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;' 472sp_incdec = remove # ignore/add/remove/force 473 474# Add or remove space before a backslash-newline at the end of a line 475sp_before_nl_cont = add # ignore/add/remove/force 476 477# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;' 478sp_after_oc_scope = ignore # ignore/add/remove/force 479 480# Add or remove space after the colon in message specs 481# '-(int) f:(int) x;' vs '-(int) f: (int) x;' 482sp_after_oc_colon = ignore # ignore/add/remove/force 483 484# Add or remove space before the colon in message specs 485# '-(int) f: (int) x;' vs '-(int) f : (int) x;' 486sp_before_oc_colon = ignore # ignore/add/remove/force 487 488# Add or remove space after the colon in message specs 489# '[object setValue:1];' vs '[object setValue: 1];' 490sp_after_send_oc_colon = ignore # ignore/add/remove/force 491 492# Add or remove space before the colon in message specs 493# '[object setValue:1];' vs '[object setValue :1];' 494sp_before_send_oc_colon = ignore # ignore/add/remove/force 495 496# Add or remove space after the (type) in message specs 497# '-(int) f: (int) x;' vs '-(int) f: (int)x;' 498sp_after_oc_type = ignore # ignore/add/remove/force 499 500# Add or remove space around the ':' in 'b ? t : f' 501sp_cond_colon = force # ignore/add/remove/force 502 503# Add or remove space around the '?' in 'b ? t : f' 504sp_cond_question = force # ignore/add/remove/force 505 506# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here. 507sp_case_label = ignore # ignore/add/remove/force 508 509# Control the space around the D '..' operator. 510sp_range = ignore # ignore/add/remove/force 511 512# Control the space after the opening of a C++ comment '// A' vs '//A' 513sp_cmt_cpp_start = ignore # ignore/add/remove/force 514 515# 516# Code alignment (not left column spaces/tabs) 517# 518 519# Whether to keep non-indenting tabs 520align_keep_tabs = false # false/true 521 522# Whether to use tabs for alinging 523align_with_tabs = false # false/true 524 525# Whether to bump out to the next tab when aligning 526align_on_tabstop = false # false/true 527 528# Whether to left-align numbers 529align_number_left = false # false/true 530 531# Align variable definitions in prototypes and functions 532align_func_params = true # false/true 533 534# Align parameters in single-line functions that have the same name. 535# The function names must already be aligned with each other. 536align_same_func_call_params = false # false/true 537 538# The span for aligning variable definitions (0=don't align) 539align_var_def_span = 1 # number 540 541# How to align the star in variable definitions. 542# 0=Part of the type 'void * foo;' 543# 1=Part of the variable 'void *foo;' 544# 2=Dangling 'void *foo;' 545align_var_def_star_style = 2 # number 546 547# How to align the '&' in variable definitions. 548# 0=Part of the type 549# 1=Part of the variable 550# 2=Dangling 551align_var_def_amp_style = 2 # number 552 553# The threshold for aligning variable definitions (0=no limit) 554align_var_def_thresh = 0 # number 555 556# The gap for aligning variable definitions 557align_var_def_gap = 1 # number 558 559# Whether to align the colon in struct bit fields 560align_var_def_colon = true # false/true 561 562# Whether to align any attribute after the variable name 563align_var_def_attribute = false # false/true 564 565# Whether to align inline struct/enum/union variable definitions 566align_var_def_inline = true # false/true 567 568# The span for aligning on '=' in assignments (0=don't align) 569align_assign_span = 1 # number 570 571# The threshold for aligning on '=' in assignments (0=no limit) 572align_assign_thresh = 0 # number 573 574# The span for aligning on '=' in enums (0=don't align) 575align_enum_equ_span = 1 # number 576 577# The threshold for aligning on '=' in enums (0=no limit) 578align_enum_equ_thresh = 0 # number 579 580# The span for aligning struct/union (0=don't align) 581align_var_struct_span = 1 # number 582 583# The threshold for aligning struct/union member definitions (0=no limit) 584align_var_struct_thresh = 1 # number 585 586# The gap for aligning struct/union member definitions 587align_var_struct_gap = 1 # number 588 589# The span for aligning struct initializer values (0=don't align) 590align_struct_init_span = 1 # number 591 592# The minimum space between the type and the synonym of a typedef 593align_typedef_gap = 0 # number 594 595# The span for aligning single-line typedefs (0=don't align) 596align_typedef_span = 0 # number 597 598# How to align typedef'd functions with other typedefs 599# 0: Don't mix them at all 600# 1: align the open paren with the types 601# 2: align the function type name with the other type names 602align_typedef_func = 0 # number 603 604# Controls the positioning of the '*' in typedefs. Just try it. 605# 0: Align on typdef type, ignore '*' 606# 1: The '*' is part of type name: typedef int *pint; 607# 2: The '*' is part of the type, but dangling: typedef int *pint; 608align_typedef_star_style = 2 # number 609 610# Controls the positioning of the '&' in typedefs. Just try it. 611# 0: Align on typdef type, ignore '&' 612# 1: The '&' is part of type name: typedef int &pint; 613# 2: The '&' is part of the type, but dangling: typedef int &pint; 614align_typedef_amp_style = 2 # number 615 616# The span for aligning comments that end lines (0=don't align) 617align_right_cmt_span = 0 # number 618 619# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment 620align_right_cmt_mix = false # false/true 621 622# If a trailing comment is more than this number of columns away from the text it follows, 623# it will qualify for being aligned. 624align_right_cmt_gap = 0 # number 625 626# Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore) 627align_right_cmt_at_col = 0 # number 628 629# The span for aligning function prototypes (0=don't align) 630align_func_proto_span = 1 # number 631 632# Minimum gap between the return type and the function name. 633align_func_proto_gap = 0 # number 634 635# Align function protos on the 'operator' keyword instead of what follows 636align_on_operator = false # false/true 637 638# Whether to mix aligning prototype and variable declarations. 639# If true, align_var_def_XXX options are used instead of align_func_proto_XXX options. 640align_mix_var_proto = false # false/true 641 642# Align single-line functions with function prototypes, uses align_func_proto_span 643align_single_line_func = false # false/true 644 645# Aligning the open brace of single-line functions. 646# Requires align_single_line_func=true, uses align_func_proto_span 647align_single_line_brace = false # false/true 648 649# Gap for align_single_line_brace. 650align_single_line_brace_gap = 0 # number 651 652# The span for aligning ObjC msg spec (0=don't align) 653align_oc_msg_spec_span = 0 # number 654 655# Whether to align macros wrapped with a backslash and a newline. 656# This will not work right if the macro contains a multi-line comment. 657align_nl_cont = true # false/true 658 659# The minimum space between label and value of a preprocessor define 660align_pp_define_gap = 0 # number 661 662# The span for aligning on '#define' bodies (0=don't align) 663align_pp_define_span = 1 # number 664 665# Align lines that start with '<<' with previous '<<'. Default=true 666align_left_shift = true # false/true 667 668# 669# Newline adding and removing options 670# 671 672# Whether to collapse empty blocks between '{' and '}' 673nl_collapse_empty_body = false # false/true 674 675# Don't split one-line braced assignments - 'foo_t f = { 1, 2 };' 676nl_assign_leave_one_liners = true # false/true 677 678# Don't split one-line braced statements inside a class xx { } body 679nl_class_leave_one_liners = false # false/true 680 681# Don't split one-line enums: 'enum foo { BAR = 15 };' 682nl_enum_leave_one_liners = false # false/true 683 684# Don't split one-line get or set functions 685nl_getset_leave_one_liners = false # false/true 686 687# Don't split one-line function definitions - 'int foo() { return 0; }' 688nl_func_leave_one_liners = false # false/true 689 690# Don't split one-line if/else statements - 'if(a) b++;' 691nl_if_leave_one_liners = false # false/true 692 693# Add or remove newlines at the start of the file 694nl_start_of_file = ignore # ignore/add/remove/force 695 696# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force' 697nl_start_of_file_min = 0 # number 698 699# Add or remove newline at the end of the file 700nl_end_of_file = force # ignore/add/remove/force 701 702# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force') 703nl_end_of_file_min = 1 # number 704 705# Add or remove newline between '=' and '{' 706nl_assign_brace = remove # ignore/add/remove/force 707 708# Add or remove newline between '=' and '[' (D only) 709nl_assign_square = ignore # ignore/add/remove/force 710 711# Add or remove newline after '= [' (D only). Will also affect the newline before the ']' 712nl_after_square_assign = ignore # ignore/add/remove/force 713 714# The number of newlines after a block of variable definitions 715nl_func_var_def_blk = 1 # number 716 717# Add or remove newline between a function call's ')' and '{', as in: 718# list_for_each(item, &list) { } 719nl_fcall_brace = force # ignore/add/remove/force 720 721# Add or remove newline between 'enum' and '{' 722nl_enum_brace = force # ignore/add/remove/force 723 724# Add or remove newline between 'struct and '{' 725nl_struct_brace = force # ignore/add/remove/force 726 727# Add or remove newline between 'union' and '{' 728nl_union_brace = force # ignore/add/remove/force 729 730# Add or remove newline between 'if' and '{' 731nl_if_brace = force # ignore/add/remove/force 732 733# Add or remove newline between '}' and 'else' 734nl_brace_else = force # ignore/add/remove/force 735 736# Add or remove newline between 'else if' and '{' 737# If set to ignore, nl_if_brace is used instead 738nl_elseif_brace = force # ignore/add/remove/force 739 740# Add or remove newline between 'else' and '{' 741nl_else_brace = force # ignore/add/remove/force 742 743# Add or remove newline between 'else' and 'if' 744nl_else_if = force # ignore/add/remove/force 745 746# Add or remove newline between '}' and 'finally' 747nl_brace_finally = force # ignore/add/remove/force 748 749# Add or remove newline between 'finally' and '{' 750nl_finally_brace = force # ignore/add/remove/force 751 752# Add or remove newline between 'try' and '{' 753nl_try_brace = force # ignore/add/remove/force 754 755# Add or remove newline between get/set and '{' 756nl_getset_brace = force # ignore/add/remove/force 757 758# Add or remove newline between 'for' and '{' 759nl_for_brace = force # ignore/add/remove/force 760 761# Add or remove newline between 'catch' and '{' 762nl_catch_brace = force # ignore/add/remove/force 763 764# Add or remove newline between '}' and 'catch' 765nl_brace_catch = force # ignore/add/remove/force 766 767# Add or remove newline between 'while' and '{' 768nl_while_brace = force # ignore/add/remove/force 769 770# Add or remove newline between 'do' and '{' 771nl_do_brace = force # ignore/add/remove/force 772 773# Add or remove newline between '}' and 'while' of 'do' statement 774nl_brace_while = force # ignore/add/remove/force 775 776# Add or remove newline between 'switch' and '{' 777nl_switch_brace = force # ignore/add/remove/force 778 779# Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc. 780# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch, and nl_catch_brace. 781nl_multi_line_cond = false # false/true 782 783# Force a newline in a define after the macro name for multi-line defines. 784nl_multi_line_define = false # false/true 785 786# Whether to put a newline before 'case' statement 787nl_before_case = true # false/true 788 789# Add or remove newline between ')' and 'throw' 790nl_before_throw = ignore # ignore/add/remove/force 791 792# Whether to put a newline after 'case' statement 793nl_after_case = true # false/true 794 795# Newline between namespace and { 796nl_namespace_brace = force # ignore/add/remove/force 797 798# Add or remove newline between 'template<>' and whatever follows. 799nl_template_class = force # ignore/add/remove/force 800 801# Add or remove newline between 'class' and '{' 802nl_class_brace = force # ignore/add/remove/force 803 804# Add or remove newline after each ',' in the constructor member initialization 805nl_class_init_args = ignore # ignore/add/remove/force 806 807# Add or remove newline between return type and function name in definition 808nl_func_type_name = remove # ignore/add/remove/force 809 810# Add or remove newline between function scope and name in a definition 811# Controls the newline after '::' in 'void A::f() { }' 812nl_func_scope_name = ignore # ignore/add/remove/force 813 814# Add or remove newline between return type and function name in a prototype 815nl_func_proto_type_name = remove # ignore/add/remove/force 816 817# Add or remove newline between a function name and the opening '(' 818nl_func_paren = remove # ignore/add/remove/force 819 820# Add or remove newline after '(' in a function declaration 821nl_func_decl_start = remove # ignore/add/remove/force 822 823# Add or remove newline after each ',' in a function declaration 824nl_func_decl_args = ignore # ignore/add/remove/force 825 826# Add or remove newline before the ')' in a function declaration 827nl_func_decl_end = remove # ignore/add/remove/force 828 829# Add or remove newline between function signature and '{' 830nl_fdef_brace = force # ignore/add/remove/force 831 832# Whether to put a newline after 'return' statement 833nl_after_return = false # false/true 834 835# Add or remove a newline between the return keyword and return expression. 836nl_return_expr = ignore # ignore/add/remove/force 837 838# Whether to put a newline after semicolons, except in 'for' statements 839nl_after_semicolon = false # false/true 840 841# Whether to put a newline after brace open. 842# This also adds a newline before the matching brace close. 843nl_after_brace_open = false # false/true 844 845# If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is 846# placed between the open brace and a trailing single-line comment. 847nl_after_brace_open_cmt = false # false/true 848 849# Whether to put a newline after a virtual brace open. 850# These occur in un-braced if/while/do/for statement bodies. 851nl_after_vbrace_open = false # false/true 852 853# Whether to put a newline after a brace close. 854# Does not apply if followed by a necessary ';'. 855nl_after_brace_close = false # false/true 856 857# Whether to alter newlines in '#define' macros 858nl_define_macro = false # false/true 859 860# Whether to not put blanks after '#ifxx', '#elxx', or before '#endif' 861nl_squeeze_ifdef = true # false/true 862 863# Add or remove newline before 'if' 864nl_before_if = ignore # ignore/add/remove/force 865 866# Add or remove newline after 'if' 867nl_after_if = ignore # ignore/add/remove/force 868 869# Add or remove newline before 'for' 870nl_before_for = ignore # ignore/add/remove/force 871 872# Add or remove newline after 'for' 873nl_after_for = ignore # ignore/add/remove/force 874 875# Add or remove newline before 'while' 876nl_before_while = ignore # ignore/add/remove/force 877 878# Add or remove newline after 'while' 879nl_after_while = ignore # ignore/add/remove/force 880 881# Add or remove newline before 'switch' 882nl_before_switch = ignore # ignore/add/remove/force 883 884# Add or remove newline after 'switch' 885nl_after_switch = ignore # ignore/add/remove/force 886 887# Add or remove newline before 'do' 888nl_before_do = ignore # ignore/add/remove/force 889 890# Add or remove newline after 'do' 891nl_after_do = ignore # ignore/add/remove/force 892 893# Whether to double-space commented-entries in struct/enum 894nl_ds_struct_enum_cmt = false # false/true 895 896# Whether to double-space before the close brace of a struct/union/enum 897nl_ds_struct_enum_close_brace = false # false/true 898 899# Add or remove a newline around a class colon. 900# Related to pos_class_colon, nl_class_init_args, and pos_comma. 901nl_class_colon = ignore # ignore/add/remove/force 902 903# Change simple unbraced if statements into a one-liner 904# 'if(b)\n i++;' => 'if(b) i++;' 905nl_create_if_one_liner = false # false/true 906 907# Change simple unbraced for statements into a one-liner 908# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);' 909nl_create_for_one_liner = false # false/true 910 911# Change simple unbraced while statements into a one-liner 912# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);' 913nl_create_while_one_liner = false # false/true 914 915# 916# Positioning options 917# 918 919# The position of arithmetic operators in wrapped expressions 920pos_arith = ignore # ignore/lead/trail 921 922# The position of assignment in wrapped expressions 923pos_assign = ignore # ignore/lead/trail 924 925# The position of boolean operators in wrapped expressions 926pos_bool = ignore # ignore/lead/trail 927 928# The position of the comma in wrapped expressions 929pos_comma = ignore # ignore/lead/trail 930 931# The position of the comma in the constructor initialization list 932pos_class_comma = ignore # ignore/lead/trail 933 934# The position of colons between constructor and member initialization 935pos_class_colon = ignore # ignore/lead/trail 936 937# 938# Line Splitting options 939# 940 941# Try to limit code width to N number of columns 942code_width = 120 # number 943 944# Whether to fully split long 'for' statements at semi-colons 945ls_for_split_full = false # false/true 946 947# Whether to fully split long function protos/calls at commas 948ls_func_split_full = true # false/true 949 950# 951# Blank line options 952# 953 954# The maximum consecutive newlines 955nl_max = 0 # number 956 957# The number of newlines after a function prototype, if followed by another function prototype 958nl_after_func_proto = 0 # number 959 960# The number of newlines after a function prototype, if not followed by another function prototype 961nl_after_func_proto_group = 0 # number 962 963# The number of newlines after '}' of a multi-line function body 964nl_after_func_body = 2 # number 965 966# The number of newlines after '}' of a single line function body 967nl_after_func_body_one_liner = 2 # number 968 969# The minimum number of newlines before a multi-line comment. 970# Doesn't apply if after a brace open or another multi-line comment. 971nl_before_block_comment = 2 # number 972 973# The minimum number of newlines before a single-line C comment. 974# Doesn't apply if after a brace open or other single-line C comments. 975nl_before_c_comment = 2 # number 976 977# The minimum number of newlines before a CPP comment. 978# Doesn't apply if after a brace open or other CPP comments. 979nl_before_cpp_comment = 2 # number 980 981# Whether to force a newline after a mulit-line comment. 982nl_after_multiline_comment = false # false/true 983 984# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. 985# Will not change the newline count if after a brace open. 986# 0 = No change. 987nl_before_access_spec = 0 # number 988 989# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. 990# 0 = No change. 991nl_after_access_spec = 0 # number 992 993# The number of newlines between a function def and the function comment. 994# 0 = No change. 995nl_comment_func_def = 0 # number 996 997# The number of newlines after a try-catch-finally block that isn't followed by a brace close. 998# 0 = No change. 999nl_after_try_catch_finally = 0 # number 1000 1001# The number of newlines before and after a property, indexer or event decl. 1002# 0 = No change. 1003nl_around_cs_property = 0 # number 1004 1005# The number of newlines between the get/set/add/remove handlers in C#. 1006# 0 = No change. 1007nl_between_get_set = 0 # number 1008 1009# Whether to remove blank lines after '{' 1010eat_blanks_after_open_brace = true # false/true 1011 1012# Whether to remove blank lines before '}' 1013eat_blanks_before_close_brace = true # false/true 1014 1015# 1016# Code modifying options (non-whitespace) 1017# 1018 1019# Add or remove braces on single-line 'do' statement 1020mod_full_brace_do = ignore # ignore/add/remove/force 1021 1022# Add or remove braces on single-line 'for' statement 1023mod_full_brace_for = ignore # ignore/add/remove/force 1024 1025# Add or remove braces on single-line function defintions. (Pawn) 1026mod_full_brace_function = ignore # ignore/add/remove/force 1027 1028# Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'. 1029mod_full_brace_if = ignore # ignore/add/remove/force 1030 1031# Don't remove braces around statements that span N newlines 1032mod_full_brace_nl = 0 # number 1033 1034# Add or remove braces on single-line 'while' statement 1035mod_full_brace_while = ignore # ignore/add/remove/force 1036 1037# Add or remove unnecessary paren on 'return' statement 1038mod_paren_on_return = ignore # ignore/add/remove/force 1039 1040# Whether to change optional semicolons to real semicolons 1041mod_pawn_semicolon = false # false/true 1042 1043# Add parens on 'while' and 'if' statement around bools 1044mod_full_paren_if_bool = false # false/true 1045 1046# Whether to remove superfluous semicolons 1047mod_remove_extra_semicolon = false # false/true 1048 1049# If a function body exceeds the specified number of newlines and doesn't have a comment after 1050# the close brace, a comment will be added. 1051mod_add_long_function_closebrace_comment = 0 # number 1052 1053# If a switch body exceeds the specified number of newlines and doesn't have a comment after 1054# the close brace, a comment will be added. 1055mod_add_long_switch_closebrace_comment = 0 # number 1056 1057# If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after 1058# the #else, a comment will be added. 1059mod_add_long_ifdef_endif_comment = 0 # number 1060 1061# If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after 1062# the #endif, a comment will be added. 1063mod_add_long_ifdef_else_comment = 0 # number 1064 1065# If TRUE, will sort consecutive single-line 'import' statements [Java, D] 1066mod_sort_import = false # false/true 1067 1068# If TRUE, will sort consecutive single-line 'using' statements [C#] 1069mod_sort_using = false # false/true 1070 1071# If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C] 1072# This is generally a bad idea, as it may break your code. 1073mod_sort_include = false # false/true 1074 1075# If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace. 1076mod_move_case_break = false # false/true 1077 1078# If TRUE, it will remove a void 'return;' that appears as the last statement in a function. 1079mod_remove_empty_return = false # false/true 1080 1081# 1082# Comment modifications 1083# 1084 1085# Try to wrap comments at cmt_width columns 1086cmt_width = 0 # number 1087 1088# If false, disable all multi-line comment changes, including cmt_width and leading chars. 1089# Default is true. 1090cmt_indent_multi = true # false/true 1091 1092# Whether to group c-comments that look like they are in a block 1093cmt_c_group = true # false/true 1094 1095# Whether to put an empty '/*' on the first line of the combined c-comment 1096cmt_c_nl_start = true # false/true 1097 1098# Whether to put a newline before the closing '*/' of the combined c-comment 1099cmt_c_nl_end = true # false/true 1100 1101# Whether to group cpp-comments that look like they are in a block 1102cmt_cpp_group = true # false/true 1103 1104# Whether to put an empty '/*' on the first line of the combined cpp-comment 1105cmt_cpp_nl_start = true # false/true 1106 1107# Whether to put a newline before the closing '*/' of the combined cpp-comment 1108cmt_cpp_nl_end = true # false/true 1109 1110# Whether to change cpp-comments into c-comments 1111cmt_cpp_to_c = true # false/true 1112 1113# Whether to put a star on subsequent comment lines 1114cmt_star_cont = true # false/true 1115 1116# The number of spaces to insert at the start of subsequent comment lines 1117cmt_sp_before_star_cont = 0 # number 1118 1119# The number of spaces to insert after the star on subsequent comment lines 1120cmt_sp_after_star_cont = 0 # number 1121 1122# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of 1123# the comment are the same length. Default=True 1124cmt_multi_check_last = true # false/true 1125 1126# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment. 1127# Will substitue $(filename) with the current file's name. 1128cmt_insert_file_header = "" # string 1129 1130# The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment. 1131# Will substitue $(filename) with the current file's name. 1132cmt_insert_file_footer = "" # string 1133 1134# The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment. 1135# Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff. 1136# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... } 1137cmt_insert_func_header = "" # string 1138 1139# The filename that contains text to insert before a class if the class isn't preceeded with a C/C++ comment. 1140# Will substitue $(class) with the class name. 1141cmt_insert_class_header = "" # string 1142 1143# If a preprocessor is encountered when stepping backwards from a function name, then 1144# this option decides whether the comment should be inserted. 1145# Affects cmt_insert_func_header and cmt_insert_class_header. 1146cmt_insert_before_preproc = false # false/true 1147 1148# 1149# Preprocessor options 1150# 1151 1152# Control indent of preprocessors inside #if blocks at brace level 0 1153pp_indent = force # ignore/add/remove/force 1154 1155# Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false) 1156pp_indent_at_level = false # false/true 1157 1158# If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1. 1159pp_indent_count = 2 # number 1160 1161# Add or remove space after # based on pp_level of #if blocks 1162pp_space = ignore # ignore/add/remove/force 1163 1164# Sets the number of spaces added with pp_space 1165pp_space_count = 0 # number 1166 1167# The indent for #region and #endregion in C# and '#pragma region' in C/C++ 1168pp_indent_region = 0 # number 1169 1170# Whether to indent the code between #region and #endregion 1171pp_region_indent_code = false # false/true 1172 1173# If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level 1174pp_indent_if = 0 # number 1175 1176# Control whether to indent the code between #if, #else and #endif when not at file-level 1177pp_if_indent_code = false # false/true 1178 1179# Whether to indent '#define' at the brace level (true) or from column 1 (false) 1180pp_define_at_level = false # false/true 1181 1182# You can force a token to be a type with the 'type' option. 1183# Example: 1184# type myfoo1 myfoo2 1185# 1186# You can create custom macro-based indentation using macro-open, 1187# macro-else and macro-close. 1188# Example: 1189# macro-open BEGIN_TEMPLATE_MESSAGE_MAP 1190# macro-open BEGIN_MESSAGE_MAP 1191# macro-close END_MESSAGE_MAP 1192# 1193# You can assign any keyword to any type with the set option. 1194# set func_call_user _ N_ 1195# 1196# The full syntax description of all custom definition config entries 1197# is shown below: 1198# 1199# define custom tokens as: 1200# - embed whitespace in token using '' escape character, or 1201# put token in quotes 1202# - these: ' " and ` are recognized as quote delimiters 1203# 1204# type token1 token2 token3 ... 1205# ^ optionally specify multiple tokens on a single line 1206# define def_token output_token 1207# ^ output_token is optional, then NULL is assumed 1208# macro-open token 1209# macro-close token 1210# macro-else token 1211# set id token1 token2 ... 1212# ^ optionally specify multiple tokens on a single line 1213# ^ id is one of the names in token_enum.h sans the CT_ prefix, 1214# e.g. PP_PRAGMA 1215# 1216# all tokens are separated by any mix of ',' commas, '=' equal signs 1217# and whitespace (space, tab) 1218# 1219set FUNC_CALL_USER N_ 1220set FUNC_CALL_USER _ 1221