Remove outdated (already implemented) pinning TODO
[gromacs.git] / admin / uncrustify.cfg
blobccd0c6ecb6c2363c9df94f640af330bc6789dca3
1 # Uncrustify 0.59
4 # General options
7 # The type of line endings
8 newlines                                 = auto     # auto/lf/crlf/cr
10 # The original size of tabs in the input
11 input_tab_size                           = 4        # number
13 # The size of tabs in the output (only used if align_with_tabs=true)
14 output_tab_size                          = 4        # number
16 # The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn)
17 string_escape_char                       = 92       # number
19 # Alternate string escape char for Pawn. Only works right before the quote char.
20 string_escape_char2                      = 0        # number
22 # Allow interpreting '>=' and '>>=' as part of a template in 'void f(list<list<B>>=val);'.
23 # If true (default), 'assert(x<0 && y>=3)' will be broken.
24 # Improvements to template detection may make this option obsolete.
25 tok_split_gte                            = false    # false/true
27 # Control what to do with the UTF-8 BOM (recommend 'remove')
28 utf8_bom                                 = ignore   # ignore/add/remove/force
30 # If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8
31 utf8_byte                                = false    # false/true
33 # Force the output encoding to UTF-8
34 utf8_force                               = false    # false/true
37 # Indenting
40 # The number of columns to indent per level.
41 # Usually 2, 3, 4, or 8.
42 indent_columns                           = 4        # number
44 # The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents.
45 # For FreeBSD, this is set to 4. Negative value is absolute and not increased for each ( level
46 indent_continue                          = 0        # number
48 # How to use tabs when indenting code
49 # 0=spaces only
50 # 1=indent with tabs to brace level, align with spaces
51 # 2=indent and align with tabs, using spaces when not on a tabstop
52 indent_with_tabs                         = 0        # number
54 # Comments that are not a brace level are indented with tabs on a tabstop.
55 # Requires indent_with_tabs=2. If false, will use spaces.
56 indent_cmt_with_tabs                     = false    # false/true
58 # Whether to indent strings broken by '\' so that they line up
59 indent_align_string                      = false    # false/true
61 # The number of spaces to indent multi-line XML strings.
62 # Requires indent_align_string=True
63 indent_xml_string                        = 0        # number
65 # Spaces to indent '{' from level
66 indent_brace                             = 0        # number
68 # Whether braces are indented to the body level
69 indent_braces                            = false    # false/true
71 # Disabled indenting function braces if indent_braces is true
72 indent_braces_no_func                    = true     # false/true
74 # Disabled indenting class braces if indent_braces is true
75 indent_braces_no_class                   = true     # false/true
77 # Disabled indenting struct braces if indent_braces is true
78 indent_braces_no_struct                  = true     # false/true
80 # Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
81 indent_brace_parent                      = false    # false/true
83 # Whether the 'namespace' body is indented
84 indent_namespace                         = false    # false/true
86 # The number of spaces to indent a namespace block
87 indent_namespace_level                   = 0        # number
89 # If the body of the namespace is longer than this number, it won't be indented.
90 # Requires indent_namespace=true. Default=0 (no limit)
91 indent_namespace_limit                   = 0        # number
93 # Whether the 'extern "C"' body is indented
94 indent_extern                            = false    # false/true
96 # Whether the 'class' body is indented
97 indent_class                             = true     # false/true
99 # Whether to indent the stuff after a leading class colon
100 indent_class_colon                       = true    # false/true
102 # Virtual indent from the ':' for member initializers. Default is 2
103 indent_ctor_init_leading                 = 2        # number
105 # Additional indenting for constructor initializer list
106 indent_ctor_init                         = 0        # number
108 # False=treat 'else\nif' as 'else if' for indenting purposes
109 # True=indent the 'if' one level
110 indent_else_if                           = false    # false/true
112 # Amount to indent variable declarations after a open brace. neg=relative, pos=absolute
113 indent_var_def_blk                       = 0        # number
115 # Indent continued variable declarations instead of aligning.
116 indent_var_def_cont                      = false    # false/true
118 # True:  force indentation of function definition to start in column 1
119 # False: use the default behavior
120 indent_func_def_force_col1               = false    # false/true
122 # True:  indent continued function call parameters one indent level
123 # False: align parameters under the open paren
124 indent_func_call_param                   = false    # false/true
126 # Same as indent_func_call_param, but for function defs
127 indent_func_def_param                    = false    # false/true
129 # Same as indent_func_call_param, but for function protos
130 indent_func_proto_param                  = false    # false/true
132 # Same as indent_func_call_param, but for class declarations
133 indent_func_class_param                  = false    # false/true
135 # Same as indent_func_call_param, but for class variable constructors
136 indent_func_ctor_var_param               = false    # false/true
138 # Same as indent_func_call_param, but for templates
139 indent_template_param                    = false    # false/true
141 # Double the indent for indent_func_xxx_param options
142 indent_func_param_double                 = true     # false/true
144 # Indentation column for standalone 'const' function decl/proto qualifier
145 indent_func_const                        = 0        # number
147 # Indentation column for standalone 'throw' function decl/proto qualifier
148 indent_func_throw                        = 0        # number
150 # The number of spaces to indent a continued '->' or '.'
151 # Usually set to 0, 1, or indent_columns.
152 indent_member                            = 4        # number
154 # Spaces to indent single line ('//') comments on lines before code
155 indent_sing_line_comments                = 0        # number
157 # If set, will indent trailing single line ('//') comments relative
158 # to the code instead of trying to keep the same absolute column
159 indent_relative_single_line_comments     = false    # false/true
161 # Spaces to indent 'case' from 'switch'
162 # Usually 0 or indent_columns.
163 indent_switch_case                       = 4        # number
165 # Spaces to shift the 'case' line, without affecting any other lines
166 # Usually 0.
167 indent_case_shift                        = 0        # number
169 # Spaces to indent '{' from 'case'.
170 # By default, the brace will appear under the 'c' in case.
171 # Usually set to 0 or indent_columns.
172 indent_case_brace                        = 0        # number
174 # Whether to indent comments found in first column
175 indent_col1_comment                      = false    # false/true
177 # How to indent goto labels
178 #  >0 : absolute column where 1 is the leftmost column
179 #  <=0 : subtract from brace indent
180 indent_label                             = 1        # number
182 # Same as indent_label, but for access specifiers that are followed by a colon
183 indent_access_spec                       = 1        # number
185 # Indent the code after an access specifier by one level.
186 # If set, this option forces 'indent_access_spec=0'
187 indent_access_spec_body                  = true     # false/true
189 # If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
190 indent_paren_nl                          = false    # false/true
192 # Controls the indent of a close paren after a newline.
193 # 0: Indent to body level
194 # 1: Align under the open paren
195 # 2: Indent to the brace level
196 indent_paren_close                       = 0        # number
198 # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
199 indent_comma_paren                       = false    # false/true
201 # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
202 indent_bool_paren                        = false    # false/true
204 # If 'indent_bool_paren' is true, controls the indent of the first expression. If TRUE, aligns the first expression to the following ones
205 indent_first_bool_expr                   = false    # false/true
207 # If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
208 indent_square_nl                         = false    # false/true
210 # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
211 indent_preserve_sql                      = false    # false/true
213 # Align continued statements at the '='. Default=True
214 # If FALSE or the '=' is followed by a newline, the next line is indent one tab.
215 indent_align_assign                      = false    # false/true
217 # Indent OC blocks at brace level instead of usual rules.
218 indent_oc_block                          = false    # false/true
220 # Minimum indent for subsequent parameters
221 indent_oc_msg_colon                      = 0        # number
224 # Spacing options
227 # Add or remove space around arithmetic operator '+', '-', '/', '*', etc
228 sp_arith                                 = ignore   # ignore/add/remove/force
230 # Add or remove space around assignment operator '=', '+=', etc
231 sp_assign                                = add      # ignore/add/remove/force
233 # Add or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign
234 sp_cpp_lambda_assign                     = ignore   # ignore/add/remove/force
236 # Add or remove space after the capture specification in C++11 lambda.
237 sp_cpp_lambda_paren                      = ignore   # ignore/add/remove/force
239 # Add or remove space around assignment operator '=' in a prototype
240 sp_assign_default                        = add      # ignore/add/remove/force
242 # Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign.
243 sp_before_assign                         = add      # ignore/add/remove/force
245 # Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign.
246 sp_after_assign                          = add      # ignore/add/remove/force
248 # Add or remove space around assignment '=' in enum
249 sp_enum_assign                           = add      # ignore/add/remove/force
251 # Add or remove space before assignment '=' in enum. Overrides sp_enum_assign.
252 sp_enum_before_assign                    = ignore   # ignore/add/remove/force
254 # Add or remove space after assignment '=' in enum. Overrides sp_enum_assign.
255 sp_enum_after_assign                     = ignore   # ignore/add/remove/force
257 # Add or remove space around preprocessor '##' concatenation operator. Default=Add
258 sp_pp_concat                             = add      # ignore/add/remove/force
260 # Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator.
261 sp_pp_stringify                          = ignore   # ignore/add/remove/force
263 # Add or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'.
264 sp_before_pp_stringify                   = ignore   # ignore/add/remove/force
266 # Add or remove space around boolean operators '&&' and '||'
267 sp_bool                                  = add      # ignore/add/remove/force
269 # Add or remove space around compare operator '<', '>', '==', etc
270 sp_compare                               = add      # ignore/add/remove/force
272 # Add or remove space inside '(' and ')'
273 sp_inside_paren                          = ignore   # ignore/add/remove/force
275 # Add or remove space between nested parens
276 sp_paren_paren                           = ignore   # ignore/add/remove/force
278 # Whether to balance spaces inside nested parens
279 sp_balance_nested_parens                 = false    # false/true
281 # Add or remove space between ')' and '{'
282 sp_paren_brace                           = ignore   # ignore/add/remove/force
284 # Add or remove space before pointer star '*'
285 sp_before_ptr_star                       = ignore   # ignore/add/remove/force
287 # Add or remove space before pointer star '*' that isn't followed by a variable name
288 # If set to 'ignore', sp_before_ptr_star is used instead.
289 sp_before_unnamed_ptr_star               = ignore   # ignore/add/remove/force
291 # Add or remove space between pointer stars '*'
292 sp_between_ptr_star                      = ignore   # ignore/add/remove/force
294 # Add or remove space after pointer star '*', if followed by a word.
295 sp_after_ptr_star                        = ignore   # ignore/add/remove/force
297 # Add or remove space after a pointer star '*', if followed by a func proto/def.
298 sp_after_ptr_star_func                   = ignore   # ignore/add/remove/force
300 # Add or remove space after a pointer star '*', if followed by an open paren (function types).
301 sp_ptr_star_paren                        = ignore   # ignore/add/remove/force
303 # Add or remove space before a pointer star '*', if followed by a func proto/def.
304 sp_before_ptr_star_func                  = ignore   # ignore/add/remove/force
306 # Add or remove space before a reference sign '&'
307 sp_before_byref                          = add      # ignore/add/remove/force
309 # Add or remove space before a reference sign '&' that isn't followed by a variable name
310 # If set to 'ignore', sp_before_byref is used instead.
311 sp_before_unnamed_byref                  = ignore   # ignore/add/remove/force
313 # Add or remove space after reference sign '&', if followed by a word.
314 sp_after_byref                           = remove   # ignore/add/remove/force
316 # Add or remove space after a reference sign '&', if followed by a func proto/def.
317 sp_after_byref_func                      = ignore   # ignore/add/remove/force
319 # Add or remove space before a reference sign '&', if followed by a func proto/def.
320 sp_before_byref_func                     = ignore   # ignore/add/remove/force
322 # Add or remove space between type and word. Default=Force
323 sp_after_type                            = ignore   # ignore/add/remove/force
325 # Add or remove space before the paren in the D constructs 'template Foo(' and 'class Foo('.
326 sp_before_template_paren                 = ignore   # ignore/add/remove/force
328 # Add or remove space in 'template <' vs 'template<'.
329 # If set to ignore, sp_before_angle is used.
330 sp_template_angle                        = ignore   # ignore/add/remove/force
332 # Add or remove space before '<>'
333 sp_before_angle                          = ignore   # ignore/add/remove/force
335 # Add or remove space inside '<' and '>'
336 sp_inside_angle                          = ignore   # ignore/add/remove/force
338 # Add or remove space after '<>'
339 sp_after_angle                           = ignore   # ignore/add/remove/force
341 # Add or remove space between '<>' and '(' as found in 'new List<byte>();'
342 sp_angle_paren                           = ignore   # ignore/add/remove/force
344 # Add or remove space between '<>' and a word as in 'List<byte> m;'
345 sp_angle_word                            = ignore   # ignore/add/remove/force
347 # Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add
348 sp_angle_shift                           = add      # ignore/add/remove/force
350 # Permit removal of the space between '>>' in 'foo<bar<int> >' (C++11 only). Default=False
351 # sp_angle_shift cannot remove the space without this option.
352 sp_permit_cpp11_shift                    = false    # false/true
354 # Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
355 sp_before_sparen                         = add      # ignore/add/remove/force
357 # Add or remove space inside if-condition '(' and ')'
358 sp_inside_sparen                         = remove   # ignore/add/remove/force
360 # Add or remove space before if-condition ')'. Overrides sp_inside_sparen.
361 sp_inside_sparen_close                   = ignore   # ignore/add/remove/force
363 # Add or remove space before if-condition '('. Overrides sp_inside_sparen.
364 sp_inside_sparen_open                    = ignore   # ignore/add/remove/force
366 # Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
367 sp_after_sparen                          = ignore   # ignore/add/remove/force
369 # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
370 sp_sparen_brace                          = ignore   # ignore/add/remove/force
372 # Add or remove space between 'invariant' and '(' in the D language.
373 sp_invariant_paren                       = ignore   # ignore/add/remove/force
375 # Add or remove space after the ')' in 'invariant (C) c' in the D language.
376 sp_after_invariant_paren                 = ignore   # ignore/add/remove/force
378 # Add or remove space before empty statement ';' on 'if', 'for' and 'while'
379 sp_special_semi                          = ignore   # ignore/add/remove/force
381 # Add or remove space before ';'. Default=Remove
382 sp_before_semi                           = remove   # ignore/add/remove/force
384 # Add or remove space before ';' in non-empty 'for' statements
385 sp_before_semi_for                       = ignore   # ignore/add/remove/force
387 # Add or remove space before a semicolon of an empty part of a for statement.
388 sp_before_semi_for_empty                 = ignore   # ignore/add/remove/force
390 # Add or remove space after ';', except when followed by a comment. Default=Add
391 sp_after_semi                            = add      # ignore/add/remove/force
393 # Add or remove space after ';' in non-empty 'for' statements. Default=Force
394 sp_after_semi_for                        = force    # ignore/add/remove/force
396 # Add or remove space after the final semicolon of an empty part of a for statement: for ( ; ; <here> ).
397 sp_after_semi_for_empty                  = ignore   # ignore/add/remove/force
399 # Add or remove space before '[' (except '[]')
400 sp_before_square                         = ignore   # ignore/add/remove/force
402 # Add or remove space before '[]'
403 sp_before_squares                        = ignore   # ignore/add/remove/force
405 # Add or remove space inside a non-empty '[' and ']'
406 sp_inside_square                         = ignore   # ignore/add/remove/force
408 # Add or remove space after ','
409 sp_after_comma                           = add      # ignore/add/remove/force
411 # Add or remove space before ','
412 sp_before_comma                          = remove   # ignore/add/remove/force
414 # Add or remove space between an open paren and comma: '(,' vs '( ,'
415 sp_paren_comma                           = force    # ignore/add/remove/force
417 # Add or remove space before the variadic '...' when preceded by a non-punctuator
418 sp_before_ellipsis                       = ignore   # ignore/add/remove/force
420 # Add or remove space after class ':'
421 sp_after_class_colon                     = add      # ignore/add/remove/force
423 # Add or remove space before class ':'
424 sp_before_class_colon                    = add      # ignore/add/remove/force
426 # Add or remove space before case ':'. Default=Remove
427 sp_before_case_colon                     = remove   # ignore/add/remove/force
429 # Add or remove space between 'operator' and operator sign
430 sp_after_operator                        = remove   # ignore/add/remove/force
432 # Add or remove space between the operator symbol and the open paren, as in 'operator ++('
433 sp_after_operator_sym                    = ignore   # ignore/add/remove/force
435 # Add or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'
436 sp_after_cast                            = ignore   # ignore/add/remove/force
438 # Add or remove spaces inside cast parens
439 sp_inside_paren_cast                     = ignore   # ignore/add/remove/force
441 # Add or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)'
442 sp_cpp_cast_paren                        = ignore   # ignore/add/remove/force
444 # Add or remove space between 'sizeof' and '('
445 sp_sizeof_paren                          = ignore   # ignore/add/remove/force
447 # Add or remove space after the tag keyword (Pawn)
448 sp_after_tag                             = ignore   # ignore/add/remove/force
450 # Add or remove space inside enum '{' and '}'
451 sp_inside_braces_enum                    = ignore   # ignore/add/remove/force
453 # Add or remove space inside struct/union '{' and '}'
454 sp_inside_braces_struct                  = ignore   # ignore/add/remove/force
456 # Add or remove space inside '{' and '}'
457 sp_inside_braces                         = ignore   # ignore/add/remove/force
459 # Add or remove space inside '{}'
460 sp_inside_braces_empty                   = ignore   # ignore/add/remove/force
462 # Add or remove space between return type and function name
463 # A minimum of 1 is forced except for pointer return types.
464 sp_type_func                             = ignore   # ignore/add/remove/force
466 # Add or remove space between function name and '(' on function declaration
467 sp_func_proto_paren                      = ignore   # ignore/add/remove/force
469 # Add or remove space between function name and '(' on function definition
470 sp_func_def_paren                        = ignore   # ignore/add/remove/force
472 # Add or remove space inside empty function '()'
473 sp_inside_fparens                        = ignore   # ignore/add/remove/force
475 # Add or remove space inside function '(' and ')'
476 sp_inside_fparen                         = ignore   # ignore/add/remove/force
478 # Add or remove space inside the first parens in the function type: 'void (*x)(...)'
479 sp_inside_tparen                         = ignore   # ignore/add/remove/force
481 # Add or remove between the parens in the function type: 'void (*x)(...)'
482 sp_after_tparen_close                    = ignore   # ignore/add/remove/force
484 # Add or remove space between ']' and '(' when part of a function call.
485 sp_square_fparen                         = ignore   # ignore/add/remove/force
487 # Add or remove space between ')' and '{' of function
488 sp_fparen_brace                          = ignore   # ignore/add/remove/force
490 # Add or remove space between function name and '(' on function calls
491 sp_func_call_paren                       = ignore   # ignore/add/remove/force
493 # Add or remove space between function name and '()' on function calls without parameters.
494 # If set to 'ignore' (the default), sp_func_call_paren is used.
495 sp_func_call_paren_empty                 = ignore   # ignore/add/remove/force
497 # Add or remove space between the user function name and '(' on function calls
498 # You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
499 sp_func_call_user_paren                  = ignore   # ignore/add/remove/force
501 # Add or remove space between a constructor/destructor and the open paren
502 sp_func_class_paren                      = ignore   # ignore/add/remove/force
504 # Add or remove space between 'return' and '('
505 sp_return_paren                          = ignore   # ignore/add/remove/force
507 # Add or remove space between '__attribute__' and '('
508 sp_attribute_paren                       = ignore   # ignore/add/remove/force
510 # Add or remove space between 'defined' and '(' in '#if defined (FOO)'
511 sp_defined_paren                         = ignore   # ignore/add/remove/force
513 # Add or remove space between 'throw' and '(' in 'throw (something)'
514 sp_throw_paren                           = ignore   # ignore/add/remove/force
516 # Add or remove space between 'throw' and anything other than '(' as in '@throw [...];'
517 sp_after_throw                           = ignore   # ignore/add/remove/force
519 # Add or remove space between 'catch' and '(' in 'catch (something) { }'
520 # If set to ignore, sp_before_sparen is used.
521 sp_catch_paren                           = ignore   # ignore/add/remove/force
523 # Add or remove space between 'version' and '(' in 'version (something) { }' (D language)
524 # If set to ignore, sp_before_sparen is used.
525 sp_version_paren                         = ignore   # ignore/add/remove/force
527 # Add or remove space between 'scope' and '(' in 'scope (something) { }' (D language)
528 # If set to ignore, sp_before_sparen is used.
529 sp_scope_paren                           = ignore   # ignore/add/remove/force
531 # Add or remove space between macro and value
532 sp_macro                                 = ignore   # ignore/add/remove/force
534 # Add or remove space between macro function ')' and value
535 sp_macro_func                            = ignore   # ignore/add/remove/force
537 # Add or remove space between 'else' and '{' if on the same line
538 sp_else_brace                            = ignore   # ignore/add/remove/force
540 # Add or remove space between '}' and 'else' if on the same line
541 sp_brace_else                            = ignore   # ignore/add/remove/force
543 # Add or remove space between '}' and the name of a typedef on the same line
544 sp_brace_typedef                         = ignore   # ignore/add/remove/force
546 # Add or remove space between 'catch' and '{' if on the same line
547 sp_catch_brace                           = ignore   # ignore/add/remove/force
549 # Add or remove space between '}' and 'catch' if on the same line
550 sp_brace_catch                           = ignore   # ignore/add/remove/force
552 # Add or remove space between 'finally' and '{' if on the same line
553 sp_finally_brace                         = ignore   # ignore/add/remove/force
555 # Add or remove space between '}' and 'finally' if on the same line
556 sp_brace_finally                         = ignore   # ignore/add/remove/force
558 # Add or remove space between 'try' and '{' if on the same line
559 sp_try_brace                             = ignore   # ignore/add/remove/force
561 # Add or remove space between get/set and '{' if on the same line
562 sp_getset_brace                          = ignore   # ignore/add/remove/force
564 # Add or remove space before the '::' operator
565 sp_before_dc                             = ignore   # ignore/add/remove/force
567 # Add or remove space after the '::' operator
568 sp_after_dc                              = ignore   # ignore/add/remove/force
570 # Add or remove around the D named array initializer ':' operator
571 sp_d_array_colon                         = ignore   # ignore/add/remove/force
573 # Add or remove space after the '!' (not) operator. Default=Remove
574 sp_not                                   = remove   # ignore/add/remove/force
576 # Add or remove space after the '~' (invert) operator. Default=Remove
577 sp_inv                                   = remove   # ignore/add/remove/force
579 # Add or remove space after the '&' (address-of) operator. Default=Remove
580 # This does not affect the spacing after a '&' that is part of a type.
581 sp_addr                                  = remove   # ignore/add/remove/force
583 # Add or remove space around the '.' or '->' operators. Default=Remove
584 sp_member                                = remove   # ignore/add/remove/force
586 # Add or remove space after the '*' (dereference) operator. Default=Remove
587 # This does not affect the spacing after a '*' that is part of a type.
588 sp_deref                                 = remove   # ignore/add/remove/force
590 # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove
591 sp_sign                                  = remove   # ignore/add/remove/force
593 # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove
594 sp_incdec                                = remove   # ignore/add/remove/force
596 # Add or remove space before a backslash-newline at the end of a line. Default=Add
597 sp_before_nl_cont                        = add      # ignore/add/remove/force
599 # Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
600 sp_after_oc_scope                        = ignore   # ignore/add/remove/force
602 # Add or remove space after the colon in message specs
603 # '-(int) f:(int) x;' vs '-(int) f: (int) x;'
604 sp_after_oc_colon                        = ignore   # ignore/add/remove/force
606 # Add or remove space before the colon in message specs
607 # '-(int) f: (int) x;' vs '-(int) f : (int) x;'
608 sp_before_oc_colon                       = ignore   # ignore/add/remove/force
610 # Add or remove space after the colon in immutable dictionary expression
611 # 'NSDictionary *test = @{@"foo" :@"bar"};'
612 sp_after_oc_dict_colon                   = ignore   # ignore/add/remove/force
614 # Add or remove space before the colon in immutable dictionary expression
615 # 'NSDictionary *test = @{@"foo" :@"bar"};'
616 sp_before_oc_dict_colon                  = ignore   # ignore/add/remove/force
618 # Add or remove space after the colon in message specs
619 # '[object setValue:1];' vs '[object setValue: 1];'
620 sp_after_send_oc_colon                   = ignore   # ignore/add/remove/force
622 # Add or remove space before the colon in message specs
623 # '[object setValue:1];' vs '[object setValue :1];'
624 sp_before_send_oc_colon                  = ignore   # ignore/add/remove/force
626 # Add or remove space after the (type) in message specs
627 # '-(int)f: (int) x;' vs '-(int)f: (int)x;'
628 sp_after_oc_type                         = ignore   # ignore/add/remove/force
630 # Add or remove space after the first (type) in message specs
631 # '-(int) f:(int)x;' vs '-(int)f:(int)x;'
632 sp_after_oc_return_type                  = ignore   # ignore/add/remove/force
634 # Add or remove space between '@selector' and '('
635 # '@selector(msgName)' vs '@selector (msgName)'
636 # Also applies to @protocol() constructs
637 sp_after_oc_at_sel                       = ignore   # ignore/add/remove/force
639 # Add or remove space between '@selector(x)' and the following word
640 # '@selector(foo) a:' vs '@selector(foo)a:'
641 sp_after_oc_at_sel_parens                = ignore   # ignore/add/remove/force
643 # Add or remove space inside '@selector' parens
644 # '@selector(foo)' vs '@selector( foo )'
645 # Also applies to @protocol() constructs
646 sp_inside_oc_at_sel_parens               = ignore   # ignore/add/remove/force
648 # Add or remove space before a block pointer caret
649 # '^int (int arg){...}' vs. ' ^int (int arg){...}'
650 sp_before_oc_block_caret                 = ignore   # ignore/add/remove/force
652 # Add or remove space after a block pointer caret
653 # '^int (int arg){...}' vs. '^ int (int arg){...}'
654 sp_after_oc_block_caret                  = ignore   # ignore/add/remove/force
656 # Add or remove space between the receiver and selector in a message.
657 # '[receiver selector ...]'
658 sp_after_oc_msg_receiver                 = ignore   # ignore/add/remove/force
660 # Add or remove space after @property.
661 sp_after_oc_property                     = ignore   # ignore/add/remove/force
663 # Add or remove space around the ':' in 'b ? t : f'
664 sp_cond_colon                            = add      # ignore/add/remove/force
666 # Add or remove space around the '?' in 'b ? t : f'
667 sp_cond_question                         = add      # ignore/add/remove/force
669 # Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
670 sp_case_label                            = ignore   # ignore/add/remove/force
672 # Control the space around the D '..' operator.
673 sp_range                                 = ignore   # ignore/add/remove/force
675 # Control the spacing after ':' in 'for (TYPE VAR : EXPR)' (Java)
676 sp_after_for_colon                       = ignore   # ignore/add/remove/force
678 # Control the spacing before ':' in 'for (TYPE VAR : EXPR)' (Java)
679 sp_before_for_colon                      = ignore   # ignore/add/remove/force
681 # Control the spacing in 'extern (C)' (D)
682 sp_extern_paren                          = ignore   # ignore/add/remove/force
684 # Control the space after the opening of a C++ comment '// A' vs '//A'
685 sp_cmt_cpp_start                         = ignore   # ignore/add/remove/force
687 # Controls the spaces between #else or #endif and a trailing comment
688 sp_endif_cmt                             = ignore   # ignore/add/remove/force
690 # Controls the spaces after 'new', 'delete', and 'delete[]'
691 sp_after_new                             = ignore   # ignore/add/remove/force
693 # Controls the spaces before a trailing or embedded comment
694 sp_before_tr_emb_cmt                     = ignore   # ignore/add/remove/force
696 # Number of spaces before a trailing or embedded comment
697 sp_num_before_tr_emb_cmt                 = 0        # number
699 # Control space between a Java annotation and the open paren.
700 sp_annotation_paren                      = ignore   # ignore/add/remove/force
703 # Code alignment (not left column spaces/tabs)
706 # Whether to keep non-indenting tabs
707 align_keep_tabs                          = false    # false/true
709 # Whether to keep whitespace not required for alignment
710 align_keep_extra_space                   = true     # false/true
712 # Whether to use tabs for aligning
713 align_with_tabs                          = false    # false/true
715 # Whether to bump out to the next tab when aligning
716 align_on_tabstop                         = false    # false/true
718 # Whether to left-align numbers
719 align_number_left                        = false    # false/true
721 # Align variable definitions in prototypes and functions
722 align_func_params                        = true     # false/true
724 # Align parameters in single-line functions that have the same name.
725 # The function names must already be aligned with each other.
726 align_same_func_call_params              = false    # false/true
728 # The span for aligning variable definitions (0=don't align)
729 align_var_def_span                       = 2        # number
731 # How to align the star in variable definitions.
732 #  0=Part of the type     'void *   foo;'
733 #  1=Part of the variable 'void     *foo;'
734 #  2=Dangling             'void    *foo;'
735 align_var_def_star_style                 = 2        # number
737 # How to align the '&' in variable definitions.
738 #  0=Part of the type
739 #  1=Part of the variable
740 #  2=Dangling
741 align_var_def_amp_style                  = 2        # number
743 # The threshold for aligning variable definitions (0=no limit)
744 align_var_def_thresh                     = 20       # number
746 # The gap for aligning variable definitions
747 align_var_def_gap                        = 0        # number
749 # Whether to align the colon in struct bit fields
750 align_var_def_colon                      = false    # false/true
752 # Whether to align any attribute after the variable name
753 align_var_def_attribute                  = false    # false/true
755 # Whether to align inline struct/enum/union variable definitions
756 align_var_def_inline                     = false    # false/true
758 # The span for aligning on '=' in assignments (0=don't align)
759 align_assign_span                        = 1        # number
761 # The threshold for aligning on '=' in assignments (0=no limit)
762 align_assign_thresh                      = 20       # number
764 # The span for aligning on '=' in enums (0=don't align)
765 align_enum_equ_span                      = 0        # number
767 # The threshold for aligning on '=' in enums (0=no limit)
768 align_enum_equ_thresh                    = 0        # number
770 # The span for aligning struct/union (0=don't align)
771 align_var_struct_span                    = 2        # number
773 # The threshold for aligning struct/union member definitions (0=no limit)
774 align_var_struct_thresh                  = 0        # number
776 # The gap for aligning struct/union member definitions
777 align_var_struct_gap                     = 0        # number
779 # The span for aligning struct initializer values (0=don't align)
780 align_struct_init_span                   = 0        # number
782 # The minimum space between the type and the synonym of a typedef
783 align_typedef_gap                        = 0        # number
785 # The span for aligning single-line typedefs (0=don't align)
786 align_typedef_span                       = 0        # number
788 # How to align typedef'd functions with other typedefs
789 # 0: Don't mix them at all
790 # 1: align the open paren with the types
791 # 2: align the function type name with the other type names
792 align_typedef_func                       = 0        # number
794 # Controls the positioning of the '*' in typedefs. Just try it.
795 # 0: Align on typedef type, ignore '*'
796 # 1: The '*' is part of type name: typedef int  *pint;
797 # 2: The '*' is part of the type, but dangling: typedef int *pint;
798 align_typedef_star_style                 = 0        # number
800 # Controls the positioning of the '&' in typedefs. Just try it.
801 # 0: Align on typedef type, ignore '&'
802 # 1: The '&' is part of type name: typedef int  &pint;
803 # 2: The '&' is part of the type, but dangling: typedef int &pint;
804 align_typedef_amp_style                  = 0        # number
806 # The span for aligning comments that end lines (0=don't align)
807 align_right_cmt_span                     = 3        # number
809 # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
810 align_right_cmt_mix                      = true    # false/true
812 # If a trailing comment is more than this number of columns away from the text it follows,
813 # it will qualify for being aligned. This has to be > 0 to do anything.
814 align_right_cmt_gap                      = 0        # number
816 # Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore)
817 align_right_cmt_at_col                   = 0        # number
819 # The span for aligning function prototypes (0=don't align)
820 align_func_proto_span                    = 0        # number
822 # Minimum gap between the return type and the function name.
823 align_func_proto_gap                     = 0        # number
825 # Align function protos on the 'operator' keyword instead of what follows
826 align_on_operator                        = false    # false/true
828 # Whether to mix aligning prototype and variable declarations.
829 # If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.
830 align_mix_var_proto                      = false    # false/true
832 # Align single-line functions with function prototypes, uses align_func_proto_span
833 align_single_line_func                   = false    # false/true
835 # Aligning the open brace of single-line functions.
836 # Requires align_single_line_func=true, uses align_func_proto_span
837 align_single_line_brace                  = false    # false/true
839 # Gap for align_single_line_brace.
840 align_single_line_brace_gap              = 0        # number
842 # The span for aligning ObjC msg spec (0=don't align)
843 align_oc_msg_spec_span                   = 0        # number
845 # Whether to align macros wrapped with a backslash and a newline.
846 # This will not work right if the macro contains a multi-line comment.
847 align_nl_cont                            = false    # false/true
849 # # Align macro functions and variables together
850 align_pp_define_together                 = false    # false/true
852 # The minimum space between label and value of a preprocessor define
853 align_pp_define_gap                      = 0        # number
855 # The span for aligning on '#define' bodies (0=don't align)
856 align_pp_define_span                     = 0        # number
858 # Align lines that start with '<<' with previous '<<'. Default=true
859 align_left_shift                         = false    # false/true
861 # Span for aligning parameters in an Obj-C message call on the ':' (0=don't align)
862 align_oc_msg_colon_span                  = 0        # number
864 # If true, always align with the first parameter, even if it is too short.
865 align_oc_msg_colon_first                 = false    # false/true
867 # Aligning parameters in an Obj-C '+' or '-' declaration on the ':'
868 align_oc_decl_colon                      = false    # false/true
871 # Newline adding and removing options
874 # Whether to collapse empty blocks between '{' and '}'
875 nl_collapse_empty_body                   = false    # false/true
877 # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'
878 nl_assign_leave_one_liners               = true     # false/true
880 # Don't split one-line braced statements inside a class xx { } body
881 nl_class_leave_one_liners                = true     # false/true
883 # Don't split one-line enums: 'enum foo { BAR = 15 };'
884 nl_enum_leave_one_liners                 = false    # false/true
886 # Don't split one-line get or set functions
887 nl_getset_leave_one_liners               = false    # false/true
889 # Don't split one-line function definitions - 'int foo() { return 0; }'
890 nl_func_leave_one_liners                 = true    # false/true
892 # Don't split one-line if/else statements - 'if(a) b++;'
893 nl_if_leave_one_liners                   = false    # false/true
895 # Don't split one-line OC messages
896 nl_oc_msg_leave_one_liner                = false    # false/true
898 # Add or remove newlines at the start of the file
899 nl_start_of_file                         = ignore   # ignore/add/remove/force
901 # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
902 nl_start_of_file_min                     = 0        # number
904 # Add or remove newline at the end of the file
905 nl_end_of_file                           = force    # ignore/add/remove/force
907 # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
908 nl_end_of_file_min                       = 1        # number
910 # Add or remove newline between '=' and '{'
911 nl_assign_brace                          = ignore   # ignore/add/remove/force
913 # Add or remove newline between '=' and '[' (D only)
914 nl_assign_square                         = ignore   # ignore/add/remove/force
916 # Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
917 nl_after_square_assign                   = ignore   # ignore/add/remove/force
919 # The number of blank lines after a block of variable definitions at the top of a function body
920 # 0 = No change (default)
921 nl_func_var_def_blk                      = 0        # number
923 # The number of newlines before a block of typedefs
924 # 0 = No change (default)
925 nl_typedef_blk_start                     = 0        # number
927 # The number of newlines after a block of typedefs
928 # 0 = No change (default)
929 nl_typedef_blk_end                       = 0        # number
931 # The maximum consecutive newlines within a block of typedefs
932 # 0 = No change (default)
933 nl_typedef_blk_in                        = 0        # number
935 # The number of newlines before a block of variable definitions not at the top of a function body
936 # 0 = No change (default)
937 nl_var_def_blk_start                     = 0        # number
939 # The number of newlines after a block of variable definitions not at the top of a function body
940 # 0 = No change (default)
941 nl_var_def_blk_end                       = 0        # number
943 # The maximum consecutive newlines within a block of variable definitions
944 # 0 = No change (default)
945 nl_var_def_blk_in                        = 0        # number
947 # Add or remove newline between a function call's ')' and '{', as in:
948 # list_for_each(item, &list) { }
949 nl_fcall_brace                           = ignore   # ignore/add/remove/force
951 # Add or remove newline between 'enum' and '{'
952 nl_enum_brace                            = ignore   # ignore/add/remove/force
954 # Add or remove newline between 'struct and '{'
955 nl_struct_brace                          = ignore   # ignore/add/remove/force
957 # Add or remove newline between 'union' and '{'
958 nl_union_brace                           = ignore   # ignore/add/remove/force
960 # Add or remove newline between 'if' and '{'
961 nl_if_brace                              = add      # ignore/add/remove/force
963 # Add or remove newline between '}' and 'else'
964 nl_brace_else                            = add      # ignore/add/remove/force
966 # Add or remove newline between 'else if' and '{'
967 # If set to ignore, nl_if_brace is used instead
968 nl_elseif_brace                          = add      # ignore/add/remove/force
970 # Add or remove newline between 'else' and '{'
971 nl_else_brace                            = add      # ignore/add/remove/force
973 # Add or remove newline between 'else' and 'if'
974 nl_else_if                               = ignore   # ignore/add/remove/force
976 # Add or remove newline between '}' and 'finally'
977 nl_brace_finally                         = ignore   # ignore/add/remove/force
979 # Add or remove newline between 'finally' and '{'
980 nl_finally_brace                         = ignore   # ignore/add/remove/force
982 # Add or remove newline between 'try' and '{'
983 nl_try_brace                             = add      # ignore/add/remove/force
985 # Add or remove newline between get/set and '{'
986 nl_getset_brace                          = ignore   # ignore/add/remove/force
988 # Add or remove newline between 'for' and '{'
989 nl_for_brace                             = add      # ignore/add/remove/force
991 # Add or remove newline between 'catch' and '{'
992 nl_catch_brace                           = add      # ignore/add/remove/force
994 # Add or remove newline between '}' and 'catch'
995 nl_brace_catch                           = add      # ignore/add/remove/force
997 # Add or remove newline between 'while' and '{'
998 nl_while_brace                           = add      # ignore/add/remove/force
1000 # Add or remove newline between 'scope (x)' and '{' (D)
1001 nl_scope_brace                           = ignore   # ignore/add/remove/force
1003 # Add or remove newline between 'unittest' and '{' (D)
1004 nl_unittest_brace                        = ignore   # ignore/add/remove/force
1006 # Add or remove newline between 'version (x)' and '{' (D)
1007 nl_version_brace                         = ignore   # ignore/add/remove/force
1009 # Add or remove newline between 'using' and '{'
1010 nl_using_brace                           = ignore   # ignore/add/remove/force
1012 # Add or remove newline between two open or close braces.
1013 # Due to general newline/brace handling, REMOVE may not work.
1014 nl_brace_brace                           = ignore   # ignore/add/remove/force
1016 # Add or remove newline between 'do' and '{'
1017 nl_do_brace                              = add      # ignore/add/remove/force
1019 # Add or remove newline between '}' and 'while' of 'do' statement
1020 nl_brace_while                           = add      # ignore/add/remove/force
1022 # Add or remove newline between 'switch' and '{'
1023 nl_switch_brace                          = add      # ignore/add/remove/force
1025 # Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc.
1026 # Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch, and nl_catch_brace.
1027 nl_multi_line_cond                       = false    # false/true
1029 # Force a newline in a define after the macro name for multi-line defines.
1030 nl_multi_line_define                     = false    # false/true
1032 # Whether to put a newline before 'case' statement
1033 nl_before_case                           = false    # false/true
1035 # Add or remove newline between ')' and 'throw'
1036 nl_before_throw                          = ignore   # ignore/add/remove/force
1038 # Whether to put a newline after 'case' statement
1039 nl_after_case                            = false    # false/true
1041 # Add or remove a newline between a case ':' and '{'. Overrides nl_after_case.
1042 nl_case_colon_brace                      = add      # ignore/add/remove/force
1044 # Newline between namespace and {
1045 nl_namespace_brace                       = add      # ignore/add/remove/force
1047 # Add or remove newline between 'template<>' and whatever follows.
1048 nl_template_class                        = ignore   # ignore/add/remove/force
1050 # Add or remove newline between 'class' and '{'
1051 nl_class_brace                           = add      # ignore/add/remove/force
1053 # Add or remove newline after each ',' in the constructor member initialization
1054 nl_class_init_args                       = ignore   # ignore/add/remove/force
1056 # Add or remove newline between return type and function name in a function definition
1057 nl_func_type_name                        = ignore   # ignore/add/remove/force
1059 # Add or remove newline between return type and function name inside a class {}
1060 # Uses nl_func_type_name or nl_func_proto_type_name if set to ignore.
1061 nl_func_type_name_class                  = ignore   # ignore/add/remove/force
1063 # Add or remove newline between function scope and name in a definition
1064 # Controls the newline after '::' in 'void A::f() { }'
1065 nl_func_scope_name                       = ignore   # ignore/add/remove/force
1067 # Add or remove newline between return type and function name in a prototype
1068 nl_func_proto_type_name                  = ignore   # ignore/add/remove/force
1070 # Add or remove newline between a function name and the opening '('
1071 nl_func_paren                            = remove   # ignore/add/remove/force
1073 # Add or remove newline between a function name and the opening '(' in the definition
1074 nl_func_def_paren                        = ignore   # ignore/add/remove/force
1076 # Add or remove newline after '(' in a function declaration
1077 nl_func_decl_start                       = ignore   # ignore/add/remove/force
1079 # Add or remove newline after '(' in a function definition
1080 nl_func_def_start                        = ignore   # ignore/add/remove/force
1082 # Overrides nl_func_decl_start when there is only one parameter.
1083 nl_func_decl_start_single                = ignore   # ignore/add/remove/force
1085 # Overrides nl_func_def_start when there is only one parameter.
1086 nl_func_def_start_single                 = ignore   # ignore/add/remove/force
1088 # Add or remove newline after each ',' in a function declaration
1089 nl_func_decl_args                        = ignore   # ignore/add/remove/force
1091 # Add or remove newline after each ',' in a function definition
1092 nl_func_def_args                         = ignore   # ignore/add/remove/force
1094 # Add or remove newline before the ')' in a function declaration
1095 nl_func_decl_end                         = ignore   # ignore/add/remove/force
1097 # Add or remove newline before the ')' in a function definition
1098 nl_func_def_end                          = ignore   # ignore/add/remove/force
1100 # Overrides nl_func_decl_end when there is only one parameter.
1101 nl_func_decl_end_single                  = ignore   # ignore/add/remove/force
1103 # Overrides nl_func_def_end when there is only one parameter.
1104 nl_func_def_end_single                   = ignore   # ignore/add/remove/force
1106 # Add or remove newline between '()' in a function declaration.
1107 nl_func_decl_empty                       = ignore   # ignore/add/remove/force
1109 # Add or remove newline between '()' in a function definition.
1110 nl_func_def_empty                        = ignore   # ignore/add/remove/force
1112 # Whether to put each OC message parameter on a separate line
1113 # See nl_oc_msg_leave_one_liner
1114 nl_oc_msg_args                           = false    # false/true
1116 # Add or remove newline between function signature and '{'
1117 nl_fdef_brace                            = add      # ignore/add/remove/force
1119 # Add or remove a newline between the return keyword and return expression.
1120 nl_return_expr                           = ignore   # ignore/add/remove/force
1122 # Whether to put a newline after semicolons, except in 'for' statements
1123 nl_after_semicolon                       = false    # false/true
1125 # Whether to put a newline after brace open.
1126 # This also adds a newline before the matching brace close.
1127 nl_after_brace_open                      = true     # false/true
1129 # If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is
1130 # placed between the open brace and a trailing single-line comment.
1131 nl_after_brace_open_cmt                  = false    # false/true
1133 # Whether to put a newline after a virtual brace open with a non-empty body.
1134 # These occur in un-braced if/while/do/for statement bodies.
1135 nl_after_vbrace_open                     = false    # false/true
1137 # Whether to put a newline after a virtual brace open with an empty body.
1138 # These occur in un-braced if/while/do/for statement bodies.
1139 nl_after_vbrace_open_empty               = false    # false/true
1141 # Whether to put a newline after a brace close.
1142 # Does not apply if followed by a necessary ';'.
1143 nl_after_brace_close                     = false    # false/true
1145 # Whether to put a newline after a virtual brace close.
1146 # Would add a newline before return in: 'if (foo) a++; return;'
1147 nl_after_vbrace_close                    = false    # false/true
1149 # Control the newline between the close brace and 'b' in: 'struct { int a; } b;'
1150 # Affects enums, unions, and structures. If set to ignore, uses nl_after_brace_close
1151 nl_brace_struct_var                      = ignore   # ignore/add/remove/force
1153 # Whether to alter newlines in '#define' macros
1154 nl_define_macro                          = false    # false/true
1156 # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
1157 nl_squeeze_ifdef                         = false    # false/true
1159 # Add or remove blank line before 'if'
1160 nl_before_if                             = ignore   # ignore/add/remove/force
1162 # Add or remove blank line after 'if' statement
1163 nl_after_if                              = ignore   # ignore/add/remove/force
1165 # Add or remove blank line before 'for'
1166 nl_before_for                            = ignore   # ignore/add/remove/force
1168 # Add or remove blank line after 'for' statement
1169 nl_after_for                             = ignore   # ignore/add/remove/force
1171 # Add or remove blank line before 'while'
1172 nl_before_while                          = ignore   # ignore/add/remove/force
1174 # Add or remove blank line after 'while' statement
1175 nl_after_while                           = ignore   # ignore/add/remove/force
1177 # Add or remove blank line before 'switch'
1178 nl_before_switch                         = ignore   # ignore/add/remove/force
1180 # Add or remove blank line after 'switch' statement
1181 nl_after_switch                          = ignore   # ignore/add/remove/force
1183 # Add or remove blank line before 'do'
1184 nl_before_do                             = ignore   # ignore/add/remove/force
1186 # Add or remove blank line after 'do/while' statement
1187 nl_after_do                              = ignore   # ignore/add/remove/force
1189 # Whether to double-space commented-entries in struct/enum
1190 nl_ds_struct_enum_cmt                    = false    # false/true
1192 # Whether to double-space before the close brace of a struct/union/enum
1193 # (lower priority than 'eat_blanks_before_close_brace')
1194 nl_ds_struct_enum_close_brace            = false    # false/true
1196 # Add or remove a newline around a class colon.
1197 # Related to pos_class_colon, nl_class_init_args, and pos_comma.
1198 nl_class_colon                           = ignore   # ignore/add/remove/force
1200 # Change simple unbraced if statements into a one-liner
1201 # 'if(b)\n i++;' => 'if(b) i++;'
1202 nl_create_if_one_liner                   = false    # false/true
1204 # Change simple unbraced for statements into a one-liner
1205 # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
1206 nl_create_for_one_liner                  = false    # false/true
1208 # Change simple unbraced while statements into a one-liner
1209 # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
1210 nl_create_while_one_liner                = false    # false/true
1213 # Positioning options
1216 # The position of arithmetic operators in wrapped expressions
1217 pos_arith                                = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1219 # The position of assignment in wrapped expressions.
1220 # Do not affect '=' followed by '{'
1221 pos_assign                               = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1223 # The position of boolean operators in wrapped expressions
1224 pos_bool                                 = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1226 # The position of comparison operators in wrapped expressions
1227 pos_compare                              = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1229 # The position of conditional (b ? t : f) operators in wrapped expressions
1230 pos_conditional                          = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1232 # The position of the comma in wrapped expressions
1233 pos_comma                                = trail    # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1235 # The position of the comma in the constructor initialization list
1236 pos_class_comma                          = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1238 # The position of colons between constructor and member initialization
1239 pos_class_colon                          = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1242 # Line Splitting options
1245 # Try to limit code width to N number of columns
1246 code_width                               = 0        # number
1248 # Whether to fully split long 'for' statements at semi-colons
1249 ls_for_split_full                        = false    # false/true
1251 # Whether to fully split long function protos/calls at commas
1252 ls_func_split_full                       = false    # false/true
1254 # Whether to split lines as close to code_width as possible and ignore some groupings
1255 ls_code_width                            = false    # false/true
1258 # Blank line options
1261 # The maximum consecutive newlines
1262 nl_max                                   = 0        # number
1264 # The number of newlines after a function prototype, if followed by another function prototype
1265 nl_after_func_proto                      = 0        # number
1267 # The number of newlines after a function prototype, if not followed by another function prototype
1268 nl_after_func_proto_group                = 0        # number
1270 # The number of newlines after '}' of a multi-line function body
1271 nl_after_func_body                       = 0        # number
1273 # The number of newlines after '}' of a multi-line function body in a class declaration
1274 nl_after_func_body_class                 = 0        # number
1276 # The number of newlines after '}' of a single line function body
1277 nl_after_func_body_one_liner             = 0        # number
1279 # The minimum number of newlines before a multi-line comment.
1280 # Doesn't apply if after a brace open or another multi-line comment.
1281 nl_before_block_comment                  = 0        # number
1283 # The minimum number of newlines before a single-line C comment.
1284 # Doesn't apply if after a brace open or other single-line C comments.
1285 nl_before_c_comment                      = 0        # number
1287 # The minimum number of newlines before a CPP comment.
1288 # Doesn't apply if after a brace open or other CPP comments.
1289 nl_before_cpp_comment                    = 0        # number
1291 # Whether to force a newline after a multi-line comment.
1292 nl_after_multiline_comment               = false    # false/true
1294 # The number of newlines after '}' or ';' of a struct/enum/union definition
1295 nl_after_struct                          = 0        # number
1297 # The number of newlines after '}' or ';' of a class definition
1298 nl_after_class                           = 0        # number
1300 # The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
1301 # Will not change the newline count if after a brace open.
1302 # 0 = No change.
1303 nl_before_access_spec                    = 0        # number
1305 # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
1306 # 0 = No change.
1307 nl_after_access_spec                     = 0        # number
1309 # The number of newlines between a function def and the function comment.
1310 # 0 = No change.
1311 nl_comment_func_def                      = 0        # number
1313 # The number of newlines after a try-catch-finally block that isn't followed by a brace close.
1314 # 0 = No change.
1315 nl_after_try_catch_finally               = 0        # number
1317 # The number of newlines before and after a property, indexer or event decl.
1318 # 0 = No change.
1319 nl_around_cs_property                    = 0        # number
1321 # The number of newlines between the get/set/add/remove handlers in C#.
1322 # 0 = No change.
1323 nl_between_get_set                       = 0        # number
1325 # Add or remove newline between C# property and the '{'
1326 nl_property_brace                        = ignore   # ignore/add/remove/force
1328 # Whether to remove blank lines after '{'
1329 eat_blanks_after_open_brace              = false    # false/true
1331 # Whether to remove blank lines before '}'
1332 eat_blanks_before_close_brace            = false    # false/true
1334 # How aggressively to remove extra newlines not in preproc.
1335 # 0: No change
1336 # 1: Remove most newlines not handled by other config
1337 # 2: Remove all newlines and reformat completely by config
1338 nl_remove_extra_newlines                 = 0        # number
1340 # Whether to put a blank line before 'return' statements, unless after an open brace.
1341 nl_before_return                         = false    # false/true
1343 # Whether to put a blank line after 'return' statements, unless followed by a close brace.
1344 nl_after_return                          = false    # false/true
1346 # Whether to put a newline after a Java annotation statement.
1347 # Only affects annotations that are after a newline.
1348 nl_after_annotation                      = ignore   # ignore/add/remove/force
1350 # Controls the newline between two annotations.
1351 nl_between_annotation                    = ignore   # ignore/add/remove/force
1354 # Code modifying options (non-whitespace)
1357 # Add or remove braces on single-line 'do' statement
1358 mod_full_brace_do                        = add      # ignore/add/remove/force
1360 # Add or remove braces on single-line 'for' statement
1361 mod_full_brace_for                       = add      # ignore/add/remove/force
1363 # Add or remove braces on single-line function definitions. (Pawn)
1364 mod_full_brace_function                  = add      # ignore/add/remove/force
1366 # Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.
1367 mod_full_brace_if                        = add      # ignore/add/remove/force
1369 # Make all if/elseif/else statements in a chain be braced or not. Overrides mod_full_brace_if.
1370 # If any must be braced, they are all braced.  If all can be unbraced, then the braces are removed.
1371 mod_full_brace_if_chain                  = false    # false/true
1373 # Don't remove braces around statements that span N newlines
1374 mod_full_brace_nl                        = 0        # number
1376 # Add or remove braces on single-line 'while' statement
1377 mod_full_brace_while                     = add      # ignore/add/remove/force
1379 # Add or remove braces on single-line 'using ()' statement
1380 mod_full_brace_using                     = ignore   # ignore/add/remove/force
1382 # Add or remove unnecessary paren on 'return' statement
1383 mod_paren_on_return                      = ignore   # ignore/add/remove/force
1385 # Whether to change optional semicolons to real semicolons
1386 mod_pawn_semicolon                       = false    # false/true
1388 # Add parens on 'while' and 'if' statement around bools
1389 mod_full_paren_if_bool                   = false    # false/true
1391 # Whether to remove superfluous semicolons
1392 mod_remove_extra_semicolon               = false    # false/true
1394 # If a function body exceeds the specified number of newlines and doesn't have a comment after
1395 # the close brace, a comment will be added.
1396 mod_add_long_function_closebrace_comment = 0        # number
1398 # If a switch body exceeds the specified number of newlines and doesn't have a comment after
1399 # the close brace, a comment will be added.
1400 mod_add_long_switch_closebrace_comment   = 0        # number
1402 # If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after
1403 # the #endif, a comment will be added.
1404 mod_add_long_ifdef_endif_comment         = 0        # number
1406 # If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after
1407 # the #else, a comment will be added.
1408 mod_add_long_ifdef_else_comment          = 0        # number
1410 # If TRUE, will sort consecutive single-line 'import' statements [Java, D]
1411 mod_sort_import                          = false    # false/true
1413 # If TRUE, will sort consecutive single-line 'using' statements [C#]
1414 mod_sort_using                           = false    # false/true
1416 # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
1417 # This is generally a bad idea, as it may break your code.
1418 mod_sort_include                         = false    # false/true
1420 # If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.
1421 mod_move_case_break                      = false    # false/true
1423 # Will add or remove the braces around a fully braced case statement.
1424 # Will only remove the braces if there are no variable declarations in the block.
1425 mod_case_brace                           = ignore   # ignore/add/remove/force
1427 # If TRUE, it will remove a void 'return;' that appears as the last statement in a function.
1428 mod_remove_empty_return                  = false    # false/true
1431 # Comment modifications
1434 # Try to wrap comments at cmt_width columns
1435 cmt_width                                = 0        # number
1437 # Set the comment reflow mode (default: 0)
1438 # 0: no reflowing (apart from the line wrapping due to cmt_width)
1439 # 1: no touching at all
1440 # 2: full reflow
1441 cmt_reflow_mode                          = 0        # number
1443 # If false, disable all multi-line comment changes, including cmt_width. keyword substitution, and leading chars.
1444 # Default is true.
1445 cmt_indent_multi                         = true     # false/true
1447 # Whether to group c-comments that look like they are in a block
1448 cmt_c_group                              = false    # false/true
1450 # Whether to put an empty '/*' on the first line of the combined c-comment
1451 cmt_c_nl_start                           = false    # false/true
1453 # Whether to put a newline before the closing '*/' of the combined c-comment
1454 cmt_c_nl_end                             = false    # false/true
1456 # Whether to group cpp-comments that look like they are in a block
1457 cmt_cpp_group                            = false    # false/true
1459 # Whether to put an empty '/*' on the first line of the combined cpp-comment
1460 cmt_cpp_nl_start                         = false    # false/true
1462 # Whether to put a newline before the closing '*/' of the combined cpp-comment
1463 cmt_cpp_nl_end                           = false    # false/true
1465 # Whether to change cpp-comments into c-comments
1466 cmt_cpp_to_c                             = false    # false/true
1468 # Whether to put a star on subsequent comment lines
1469 cmt_star_cont                            = false    # false/true
1471 # The number of spaces to insert at the start of subsequent comment lines
1472 cmt_sp_before_star_cont                  = 0        # number
1474 # The number of spaces to insert after the star on subsequent comment lines
1475 cmt_sp_after_star_cont                   = 0        # number
1477 # For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of
1478 # the comment are the same length. Default=True
1479 cmt_multi_check_last                     = false    # false/true
1481 # The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
1482 # Will substitute $(filename) with the current file's name.
1483 cmt_insert_file_header                   = ""         # string
1485 # The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment.
1486 # Will substitute $(filename) with the current file's name.
1487 cmt_insert_file_footer                   = ""         # string
1489 # The filename that contains text to insert before a function implementation if the function isn't preceded with a C/C++ comment.
1490 # Will substitute $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
1491 # Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
1492 cmt_insert_func_header                   = ""         # string
1494 # The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment.
1495 # Will substitute $(class) with the class name.
1496 cmt_insert_class_header                  = ""         # string
1498 # The filename that contains text to insert before a Obj-C message specification if the method isn't preceeded with a C/C++ comment.
1499 # Will substitute $(message) with the function name and $(javaparam) with the javadoc @param and @return stuff.
1500 cmt_insert_oc_msg_header                 = ""         # string
1502 # If a preprocessor is encountered when stepping backwards from a function name, then
1503 # this option decides whether the comment should be inserted.
1504 # Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header.
1505 cmt_insert_before_preproc                = false    # false/true
1508 # Preprocessor options
1511 # Control indent of preprocessors inside #if blocks at brace level 0
1512 pp_indent                                = ignore   # ignore/add/remove/force
1514 # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
1515 pp_indent_at_level                       = false    # false/true
1517 # If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1.
1518 pp_indent_count                          = 1        # number
1520 # Add or remove space after # based on pp_level of #if blocks
1521 pp_space                                 = ignore   # ignore/add/remove/force
1523 # Sets the number of spaces added with pp_space
1524 pp_space_count                           = 0        # number
1526 # The indent for #region and #endregion in C# and '#pragma region' in C/C++
1527 pp_indent_region                         = 0        # number
1529 # Whether to indent the code between #region and #endregion
1530 pp_region_indent_code                    = false    # false/true
1532 # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level
1533 pp_indent_if                             = 0        # number
1535 # Control whether to indent the code between #if, #else and #endif when not at file-level
1536 pp_if_indent_code                        = false    # false/true
1538 # Whether to indent '#define' at the brace level (true) or from column 1 (false)
1539 pp_define_at_level                       = false    # false/true
1541 # You can force a token to be a type with the 'type' option.
1542 # Example:
1543 # type myfoo1 myfoo2
1545 # You can create custom macro-based indentation using macro-open,
1546 # macro-else and macro-close.
1547 # Example:
1548 # macro-open  BEGIN_TEMPLATE_MESSAGE_MAP
1549 # macro-open  BEGIN_MESSAGE_MAP
1550 # macro-close END_MESSAGE_MAP
1552 # You can assign any keyword to any type with the set option.
1553 # set func_call_user _ N_
1555 # The full syntax description of all custom definition config entries
1556 # is shown below:
1558 # define custom tokens as:
1559 # - embed whitespace in token using '' escape character, or
1560 #   put token in quotes
1561 # - these: ' " and ` are recognized as quote delimiters
1563 # type token1 token2 token3 ...
1564 #             ^ optionally specify multiple tokens on a single line
1565 # define def_token output_token
1566 #                  ^ output_token is optional, then NULL is assumed
1567 # macro-open token
1568 # macro-close token
1569 # macro-else token
1570 # set id token1 token2 ...
1571 #               ^ optionally specify multiple tokens on a single line
1572 #     ^ id is one of the names in token_enum.h sans the CT_ prefix,
1573 #       e.g. PP_PRAGMA
1575 # all tokens are separated by any mix of ',' commas, '=' equal signs
1576 # and whitespace (space, tab)
1579 # Teach uncrustify about the GROMACS attribute aliases that we use
1580 # to hide compiler differences. This means that declarations like
1582 # int i, j;
1583 # int nthreads gmx_unused;
1585 # does not align i with gmx_unused.
1586 set ATTRIBUTE gmx_unused gmx_inline gmx_restrict