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