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