comparison TOOLS/mp-uncrustify-style.cfg @ 32934:a899bfef04c8

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