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