]> de.git.xonotic.org Git - xonotic/netradiant.git/blob - uncrustify.cfg
* moved zeroradiant (1.6) into trunk
[xonotic/netradiant.git] / uncrustify.cfg
1 # Uncrustify 0.44
2
3 #
4 # General options
5 #
6
7 # The type of line endings
8 newlines                                 = lf       # 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                         = 2        # 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 'class' body is indented
59 indent_class                             = false    # false/true
60
61 # Whether to indent the stuff after a leading class colon
62 indent_class_colon                       = false    # false/true
63
64 # True:  indent continued function call parameters one indent level
65 # False: align parameters under the open paren
66 indent_func_call_param                   = false    # false/true
67
68 # Same as indent_func_call_param, but for function defs
69 indent_func_def_param                    = false    # false/true
70
71 # Same as indent_func_call_param, but for function protos
72 indent_func_proto_param                  = false    # false/true
73
74 # Same as indent_func_call_param, but for class declarations
75 indent_func_class_param                  = false    # false/true
76
77 # Same as indent_func_call_param, but for class variable constructors
78 indent_func_ctor_var_param               = false    # false/true
79
80 # Double the indent for indent_func_xxx_param options
81 indent_func_param_double                 = false    # false/true
82
83 # The number of spaces to indent a continued '->' or '.'
84 # Usually set to 0, 1, or indent_columns.
85 indent_member                            = 0        # number
86
87 # Spaces to indent single line ('//') comments on lines before code
88 indent_sing_line_comments                = 0        # number
89
90 # Spaces to indent 'case' from 'switch'
91 # Usually 0 or indent_columns.
92 indent_switch_case                       = 0        # number
93
94 # Spaces to shift the 'case' line, without affecting any other lines
95 # Usually 0.
96 indent_case_shift                        = 0        # number
97
98 # Spaces to indent '{' from 'case'.
99 # By default, the brace will appear under the 'c' in case.
100 # Usually set to 0 or indent_columns.
101 indent_case_brace                        = 0        # number
102
103 # Whether to indent comments found in first column
104 indent_col1_comment                      = false    # false/true
105
106 # How to indent goto labels
107 #  >0 : absolute column where 1 is the leftmost column
108 #  <=0 : subtract from brace indent
109 indent_label                             = 1        # number
110
111 # Same as indent_label, but for access specifiers that are followed by a colon
112 indent_access_spec                       = 1        # number
113
114 # If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
115 indent_paren_nl                          = false    # false/true
116
117 # Controls the indent of a close paren after a newline.
118 # 0: Indent to body level
119 # 1: Align under the open paren
120 # 2: Indent to the brace level
121 indent_paren_close                       = 0        # number
122
123 # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
124 indent_comma_paren                       = false    # false/true
125
126 # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
127 indent_bool_paren                        = false    # false/true
128
129 # If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
130 indent_square_nl                         = false    # false/true
131
132 # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
133 indent_preserve_sql                      = false    # false/true
134
135 #
136 # Spacing options
137 #
138
139 # Add or remove space around arithmetic operator '+', '-', '/', '*', etc
140 sp_arith                                 = add      # ignore/add/remove/force
141
142 # Add or remove space around assignment operator '=', '+=', etc
143 sp_assign                                = add      # ignore/add/remove/force
144
145 # Add or remove space around boolean operators '&&' and '||'
146 sp_bool                                  = add          # ignore/add/remove/force
147
148 # Add or remove space around compare operator '<', '>', '==', etc
149 sp_compare                               = add      # ignore/add/remove/force
150
151 # Add or remove space inside '(' and ')'
152 sp_inside_paren                          = add          # ignore/add/remove/force
153
154 # Add or remove space between nested parens
155 sp_paren_paren                           = add      # ignore/add/remove/force
156
157 # Whether to balance spaces inside nested parens
158 sp_balance_nested_parens                 = false    # false/true
159
160 # Add or remove space between ')' and '{'
161 sp_paren_brace                           = add          # ignore/add/remove/force
162
163 # Add or remove space before pointer star '*'
164 sp_before_ptr_star                       = ignore   # ignore/add/remove/force
165
166 # Add or remove space between pointer stars '*'
167 sp_between_ptr_star                      = ignore   # ignore/add/remove/force
168
169 # Add or remove space after pointer star '*', if followed by a word.
170 sp_after_ptr_star                        = ignore   # ignore/add/remove/force
171
172 # Add or remove space before reference sign '&'
173 sp_before_byref                          = ignore   # ignore/add/remove/force
174
175 # Add or remove space after reference sign '&', if followed by a word.
176 sp_after_byref                           = ignore   # ignore/add/remove/force
177
178 # Add or remove space before '<>'
179 sp_before_angle                          = ignore   # ignore/add/remove/force
180
181 # Add or remove space after '<>'
182 sp_after_angle                           = ignore   # ignore/add/remove/force
183
184 # Add or remove space between '<>' and '(' as found in 'new List<byte>();'
185 sp_angle_paren                           = ignore   # ignore/add/remove/force
186
187 # Add or remove space between '<>' and a word as in 'List<byte> m;'
188 sp_angle_word                            = ignore   # ignore/add/remove/force
189
190 # Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
191 sp_before_sparen                         = add   # ignore/add/remove/force
192
193 # Add or remove space inside if-condition '(' and ')'
194 sp_inside_sparen                         = add   # ignore/add/remove/force
195
196 # Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
197 sp_after_sparen                          = ignore   # ignore/add/remove/force
198
199 # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
200 sp_sparen_brace                          = add   # ignore/add/remove/force
201
202 # Add or remove space before empty statement ';' on 'if', 'for' and 'while'
203 sp_special_semi                          = ignore   # ignore/add/remove/force
204
205 # Add or remove space before ';'
206 sp_before_semi                           = ignore   # ignore/add/remove/force
207
208 # Add or remove space before ';' in non-empty 'for' statements
209 sp_before_semi_for                       = ignore   # ignore/add/remove/force
210
211 # Add or remove space before a semicolon of an empty part of a for statment.
212 sp_before_semi_for_empty                 = ignore   # ignore/add/remove/force
213
214 # Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; <here> ).
215 sp_after_semi_for_empty                  = ignore   # ignore/add/remove/force
216
217 # Add or remove space before '[' (except '[]')
218 sp_before_square                         = ignore   # ignore/add/remove/force
219
220 # Add or remove space before '[]'
221 sp_before_squares                        = ignore   # ignore/add/remove/force
222
223 # Add or remove space inside '[' and ']'
224 sp_inside_square                         = ignore   # ignore/add/remove/force
225
226 # Add or remove space after ','
227 sp_after_comma                           = ignore   # ignore/add/remove/force
228
229 # Add or remove space before ','
230 sp_before_comma                          = remove   # ignore/add/remove/force
231
232 # Add or remove space between 'operator' and operator sign
233 sp_after_operator                        = ignore   # ignore/add/remove/force
234
235 # Add or remove space after cast
236 sp_after_cast                            = ignore   # ignore/add/remove/force
237
238 # Add or remove spaces inside cast parens
239 sp_inside_paren_cast                     = ignore   # ignore/add/remove/force
240
241 # Add or remove space between 'sizeof' and '('
242 sp_sizeof_paren                          = remove   # ignore/add/remove/force
243
244 # Add or remove space after the tag keyword (Pawn)
245 sp_after_tag                             = ignore   # ignore/add/remove/force
246
247 # Add or remove space inside enum '{' and '}'
248 sp_inside_braces_enum                    = ignore   # ignore/add/remove/force
249
250 # Add or remove space inside struct/union '{' and '}'
251 sp_inside_braces_struct                  = ignore   # ignore/add/remove/force
252
253 # Add or remove space inside '{' and '}'
254 sp_inside_braces                         = ignore   # ignore/add/remove/force
255
256 # Add or remove space inside '<' and '>'
257 sp_inside_angle                          = ignore   # ignore/add/remove/force
258
259 # Add or remove space between return type and function name
260 # A minimum of 1 is forced except for pointer return types.
261 sp_type_func                             = ignore   # ignore/add/remove/force
262
263 # Add or remove space between function name and '(' on function declaration
264 sp_func_proto_paren                      = remove   # ignore/add/remove/force
265
266 # Add or remove space between function name and '(' on function definition
267 sp_func_def_paren                        = remove   # ignore/add/remove/force
268
269 # Add or remove space inside empty function '()'
270 sp_inside_fparens                        = remove   # ignore/add/remove/force
271
272 # Add or remove space inside function '(' and ')'
273 sp_inside_fparen                         = add          # ignore/add/remove/force
274
275 # Add or remove space between ']' and '(' when part of a function call.
276 sp_square_fparen                         = ignore   # ignore/add/remove/force
277
278 # Add or remove space between ')' and '{' of function
279 sp_fparen_brace                          = ignore   # ignore/add/remove/force
280
281 # Add or remove space between function name and '(' on function calls
282 sp_func_call_paren                       = remove   # ignore/add/remove/force
283
284 # Add or remove space between a constructor/destructor and the open paren
285 sp_func_class_paren                      = ignore   # ignore/add/remove/force
286
287 # Add or remove space between 'return' and '('
288 sp_return_paren                          = ignore   # ignore/add/remove/force
289
290 # Add or remove space between '__attribute__' and '('
291 sp_attribute_paren                       = ignore   # ignore/add/remove/force
292
293 # Add or remove space between macro and value
294 sp_macro                                 = ignore   # ignore/add/remove/force
295
296 # Add or remove space between macro function ')' and value
297 sp_macro_func                            = ignore   # ignore/add/remove/force
298
299 # Add or remove space between 'else' and '{' if on the same line
300 sp_else_brace                            = ignore   # ignore/add/remove/force
301
302 # Add or remove space between '}' and 'else' if on the same line
303 sp_brace_else                            = ignore   # ignore/add/remove/force
304
305 # Add or remove space between 'catch' and '{' if on the same line
306 sp_catch_brace                           = ignore   # ignore/add/remove/force
307
308 # Add or remove space between '}' and 'catch' if on the same line
309 sp_brace_catch                           = ignore   # ignore/add/remove/force
310
311 # Add or remove space between 'finally' and '{' if on the same line
312 sp_finally_brace                         = ignore   # ignore/add/remove/force
313
314 # Add or remove space between '}' and 'finally' if on the same line
315 sp_brace_finally                         = ignore   # ignore/add/remove/force
316
317 # Add or remove space between 'try' and '{' if on the same line
318 sp_try_brace                             = ignore   # ignore/add/remove/force
319
320 # Add or remove space between get/set and '{' if on the same line
321 sp_getset_brace                          = ignore   # ignore/add/remove/force
322
323 # Add or remove space before the '::' operator
324 sp_before_dc                             = ignore   # ignore/add/remove/force
325
326 # Add or remove space after the '::' operator
327 sp_after_dc                              = ignore   # ignore/add/remove/force
328
329 # Add or remove around the D named array initializer ':' operator
330 sp_d_array_colon                         = ignore   # ignore/add/remove/force
331
332 # Add or remove space after the '!' (not) operator.
333 sp_not                                   = remove   # ignore/add/remove/force
334
335 # Add or remove space after the '~' (invert) operator.
336 sp_inv                                   = remove   # ignore/add/remove/force
337
338 # Add or remove space after the '&' (address-of) operator.
339 # This does not affect the spacing after a '&' that is part of a type.
340 sp_addr                                  = remove   # ignore/add/remove/force
341
342 # Add or remove space around the '.' or '->' operators
343 sp_member                                = remove   # ignore/add/remove/force
344
345 # Add or remove space after the '*' (dereference) operator.
346 # This does not affect the spacing after a '*' that is part of a type.
347 sp_deref                                 = remove   # ignore/add/remove/force
348
349 # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'
350 sp_sign                                  = remove   # ignore/add/remove/force
351
352 # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'
353 sp_incdec                                = remove   # ignore/add/remove/force
354
355 # Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
356 sp_after_oc_scope                        = ignore   # ignore/add/remove/force
357
358 # Add or remove space after the colon in message specs
359 # '-(int) f: (int) x;' vs '+(int) f : (int) x;'
360 sp_before_oc_colon                       = ignore   # ignore/add/remove/force
361
362 # Add or remove space after the (type) in message specs
363 # '-(int) f: (int) x;' vs '+(int)f : (int)x;'
364 sp_after_oc_type                         = ignore   # ignore/add/remove/force
365
366 #
367 # Code alignment (not left column spaces/tabs)
368 #
369
370 # Whether to keep non-indenting tabs
371 align_keep_tabs                          = false    # false/true
372
373 # Whether to use tabs for alinging
374 align_with_tabs                          = true     # false/true
375
376 # Whether to bump out to the next tab when aligning
377 align_on_tabstop                         = false    # false/true
378
379 # Whether to left-align numbers
380 align_number_left                        = false    # false/true
381
382 # Align variable definitions in prototypes and functions
383 align_func_params                        = false    # false/true
384
385 # The span for aligning variable definitions (0=don't align)
386 align_var_def_span                       = 0        # number
387
388 # How to align the star in variable definitions.
389 #  0=Part of the type
390 #  1=Part of the variable
391 #  2=Dangling
392 align_var_def_star_style                 = 0        # number
393
394 # How to align the '&' in variable definitions.
395 #  0=Part of the type
396 #  1=Part of the variable
397 #  2=Dangling
398 align_var_def_amp_style                  = 0        # number
399
400 # The threshold for aligning variable definitions (0=no limit)
401 align_var_def_thresh                     = 0        # number
402
403 # Whether to align the colon in struct bit fields
404 align_var_def_colon                      = false    # false/true
405
406 # Whether to align inline struct/enum/union variable definitions
407 align_var_def_inline                     = false    # false/true
408
409 # The span for aligning on '=' in assignments (0=don't align)
410 align_assign_span                        = 0        # number
411
412 # The threshold for aligning on '=' in assignments (0=no limit)
413 align_assign_thresh                      = 0        # number
414
415 # The span for aligning on '=' in enums (0=don't align)
416 align_enum_equ_span                      = 0        # number
417
418 # The threshold for aligning on '=' in enums (0=no limit)
419 align_enum_equ_thresh                    = 0        # number
420
421 # The span for aligning struct/union (0=don't align)
422 align_var_struct_span                    = 0        # number
423
424 # The threshold for aligning struct/union member definitions (0=no limit)
425 align_var_struct_thresh                  = 0        # number
426
427 # The span for aligning struct initializer values (0=don't align)
428 align_struct_init_span                   = 0        # number
429
430 # The minimum space between the type and the synonym of a typedef
431 align_typedef_gap                        = 0        # number
432
433 # The span for aligning single-line typedefs (0=don't align)
434 align_typedef_span                       = 0        # number
435
436 # How to align typedef'd functions with other typedefs
437 # 0: Don't mix them at all
438 # 1: align the open paren with the types
439 # 2: align the function type name with the other type names
440 align_typedef_func                       = 0        # number
441
442 # Controls the positioning of the '*' in typedefs. Just try it.
443 # 0: Align on typdef type, ignore '*'
444 # 1: The '*' is part of type name: typedef int  *pint;
445 # 2: The '*' is part of the type, but dangling: typedef int *pint;
446 align_typedef_star_style                 = 0        # number
447
448 # Controls the positioning of the '&' in typedefs. Just try it.
449 # 0: Align on typdef type, ignore '&'
450 # 1: The '&' is part of type name: typedef int  &pint;
451 # 2: The '&' is part of the type, but dangling: typedef int &pint;
452 align_typedef_amp_style                  = 0        # number
453
454 # The span for aligning comments that end lines (0=don't align)
455 align_right_cmt_span                     = 0        # number
456
457 # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
458 align_right_cmt_mix                      = false    # false/true
459
460 # The span for aligning function prototypes (0=don't align)
461 align_func_proto_span                    = 0        # number
462
463 # The span for aligning function prototypes (0=don't align)
464 align_oc_msg_spec_span                   = 0        # number
465
466 # Whether to align macros wrapped with a backslash and a newline.
467 # This will not work right if the macro contains a multi-line comment.
468 align_nl_cont                            = false    # false/true
469
470 # The minimum space between label and value of a preprocessor define
471 align_pp_define_gap                      = 0        # number
472
473 # The span for aligning on '#define' bodies (0=don't align)
474 align_pp_define_span                     = 0        # number
475
476 #
477 # Newline adding and removing options
478 #
479
480 # Whether to collapse empty blocks between '{' and '}'
481 nl_collapse_empty_body                   = false    # false/true
482
483 # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'
484 nl_assign_leave_one_liners               = true    # false/true
485
486 # Don't split one-line braced statements inside a class xx { } body
487 nl_class_leave_one_liners                = false    # false/true
488
489 # Don't split one-line enums: 'enum foo { BAR = 15 };'
490 nl_enum_leave_one_liners                 = true    # false/true
491
492 # Don't split one-line get or set functions
493 nl_getset_leave_one_liners               = true    # false/true
494
495 # Don't split one-line function definitions - 'int foo() { return 0; }'
496 nl_func_leave_one_liners                 = true    # false/true
497
498 # Don't split one-line if/else statements - 'if(a) b++;'
499 nl_if_leave_one_liners                   = false    # false/true
500
501 # Add or remove newlines at the start of the file
502 nl_start_of_file                         = ignore   # ignore/add/remove/force
503
504 # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
505 nl_start_of_file_min                     = 0        # number
506
507 # Add or remove newline at the end of the file
508 nl_end_of_file                           = add   # ignore/add/remove/force
509
510 # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
511 nl_end_of_file_min                       = 0        # number
512
513 # Add or remove newline between '=' and '{'
514 nl_assign_brace                          = ignore   # ignore/add/remove/force
515
516 # Add or remove newline between '=' and '[' (D only)
517 nl_assign_square                         = ignore   # ignore/add/remove/force
518
519 # Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
520 nl_after_square_assign                   = ignore   # ignore/add/remove/force
521
522 # The number of newlines after a block of variable definitions
523 nl_func_var_def_blk                      = 0        # number
524
525 # Add or remove newline between a function call's ')' and '{', as in:
526 # list_for_each(item, &list) { }
527 nl_fcall_brace                           = ignore   # ignore/add/remove/force
528
529 # Add or remove newline between 'enum' and '{'
530 nl_enum_brace                            = ignore   # ignore/add/remove/force
531
532 # Add or remove newline between 'struct and '{'
533 nl_struct_brace                          = ignore   # ignore/add/remove/force
534
535 # Add or remove newline between 'union' and '{'
536 nl_union_brace                           = ignore   # ignore/add/remove/force
537
538 # Add or remove newline between 'if' and '{'
539 nl_if_brace                              = remove   # ignore/add/remove/force
540
541 # Add or remove newline between '}' and 'else'
542 nl_brace_else                            = ignore   # ignore/add/remove/force
543
544 # Add or remove newline between 'else if' and '{'
545 # If set to ignore, nl_if_brace is used instead
546 nl_elseif_brace                          = ignore   # ignore/add/remove/force
547
548 # Add or remove newline between 'else' and '{'
549 nl_else_brace                            = ignore   # ignore/add/remove/force
550
551 # Add or remove newline between '}' and 'finally'
552 nl_brace_finally                         = ignore   # ignore/add/remove/force
553
554 # Add or remove newline between 'finally' and '{'
555 nl_finally_brace                         = ignore   # ignore/add/remove/force
556
557 # Add or remove newline between 'try' and '{'
558 nl_try_brace                             = ignore   # ignore/add/remove/force
559
560 # Add or remove newline between get/set and '{'
561 nl_getset_brace                          = ignore   # ignore/add/remove/force
562
563 # Add or remove newline between 'for' and '{'
564 nl_for_brace                             = ignore   # ignore/add/remove/force
565
566 # Add or remove newline between 'catch' and '{'
567 nl_catch_brace                           = ignore   # ignore/add/remove/force
568
569 # Add or remove newline between '}' and 'catch'
570 nl_brace_catch                           = ignore   # ignore/add/remove/force
571
572 # Add or remove newline between 'while' and '{'
573 nl_while_brace                           = ignore   # ignore/add/remove/force
574
575 # Add or remove newline between 'do' and '{'
576 nl_do_brace                              = ignore   # ignore/add/remove/force
577
578 # Add or remove newline between '}' and 'while' of 'do' statement
579 nl_brace_while                           = ignore   # ignore/add/remove/force
580
581 # Add or remove newline between 'switch' and '{'
582 nl_switch_brace                          = ignore   # ignore/add/remove/force
583
584 # Add or remove newline when condition spans two or more lines
585 nl_multi_line_cond                       = false    # false/true
586
587 # Force a newline in a define after the macro name for multi-line defines.
588 nl_multi_line_define                     = false    # false/true
589
590 # Whether to put a newline before 'case' statement
591 nl_before_case                           = false    # false/true
592
593 # Whether to put a newline after 'case' statement
594 nl_after_case                            = false    # false/true
595
596 # Newline between namespace and {
597 nl_namespace_brace                       = ignore   # ignore/add/remove/force
598
599 # Add or remove newline between 'template<>' and 'class'
600 nl_template_class                        = ignore   # ignore/add/remove/force
601
602 # Add or remove newline between 'class' and '{'
603 nl_class_brace                           = ignore   # ignore/add/remove/force
604
605 # Add or remove newline after each ',' in the constructor member initialization
606 nl_class_init_args                       = ignore   # ignore/add/remove/force
607
608 # Add or remove newline between return type and function name in definition
609 nl_func_type_name                        = ignore   # ignore/add/remove/force
610
611 # Add or remove newline between return type and function name in a prototype
612 nl_func_proto_type_name                  = ignore   # ignore/add/remove/force
613
614 # Add or remove newline between a function name and the opening '('
615 nl_func_paren                            = ignore   # ignore/add/remove/force
616
617 # Add or remove newline after '(' in a function declaration
618 nl_func_decl_start                       = ignore   # ignore/add/remove/force
619
620 # Add or remove newline after each ',' in a function declaration
621 nl_func_decl_args                        = ignore   # ignore/add/remove/force
622
623 # Add or remove newline before the ')' in a function declaration
624 nl_func_decl_end                         = ignore   # ignore/add/remove/force
625
626 # Add or remove newline between function signature and '{'
627 nl_fdef_brace                            = remove   # ignore/add/remove/force
628
629 # Whether to put a newline after 'return' statement
630 nl_after_return                          = false    # false/true
631
632 # Whether to put a newline after semicolons, except in 'for' statements
633 nl_after_semicolon                       = false    # false/true
634
635 # Whether to put a newline after brace open.
636 # This also adds a newline before the matching brace close.
637 nl_after_brace_open                      = false    # false/true
638
639 # If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is
640 # placed between the open brace and a trailing single-line comment.
641 nl_after_brace_open_cmt                  = false    # false/true
642
643 # Whether to put a newline after a virtual brace open.
644 # These occur in un-braced if/while/do/for statement bodies.
645 nl_after_vbrace_open                     = false    # false/true
646
647 # Whether to alter newlines in '#define' macros
648 nl_define_macro                          = false    # false/true
649
650 # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
651 nl_squeeze_ifdef                         = false    # false/true
652
653 # Add or remove newline before 'if'
654 nl_before_if                             = ignore   # ignore/add/remove/force
655
656 # Add or remove newline after 'if'
657 nl_after_if                              = ignore   # ignore/add/remove/force
658
659 # Add or remove newline before 'for'
660 nl_before_for                            = ignore   # ignore/add/remove/force
661
662 # Add or remove newline after 'for'
663 nl_after_for                             = ignore   # ignore/add/remove/force
664
665 # Add or remove newline before 'while'
666 nl_before_while                          = ignore   # ignore/add/remove/force
667
668 # Add or remove newline after 'while'
669 nl_after_while                           = ignore   # ignore/add/remove/force
670
671 # Add or remove newline before 'switch'
672 nl_before_switch                         = ignore   # ignore/add/remove/force
673
674 # Add or remove newline after 'switch'
675 nl_after_switch                          = ignore   # ignore/add/remove/force
676
677 # Add or remove newline before 'do'
678 nl_before_do                             = ignore   # ignore/add/remove/force
679
680 # Add or remove newline after 'do'
681 nl_after_do                              = ignore   # ignore/add/remove/force
682
683 # Whether to double-space commented-entries in struct/enum
684 nl_ds_struct_enum_cmt                    = false    # false/true
685
686 # Whether to double-space before the close brace of a struct/union/enum
687 nl_ds_struct_enum_close_brace            = false    # false/true
688
689 # Add or remove a newline around a class colon.
690 # Related to pos_class_colon, nl_class_init_args, and pos_comma.
691 nl_class_colon                           = ignore   # ignore/add/remove/force
692
693 # Change simple unbraced if statements into a one-liner
694 # 'if(b)\n i++;' => 'if(b) i++;'
695 nl_create_if_one_liner                   = true    # false/true
696
697 # Change simple unbraced for statements into a one-liner
698 # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
699 nl_create_for_one_liner                  = false    # false/true
700
701 # Change simple unbraced while statements into a one-liner
702 # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
703 nl_create_while_one_liner                = false    # false/true
704
705 #
706 # Positioning options
707 #
708
709 # The position of boolean operators in wrapped expressions
710 pos_bool                                 = ignore   # ignore/lead/trail
711
712 # The position of the comma in wrapped expressions
713 pos_comma                                = ignore   # ignore/lead/trail
714
715 # The position of the comma in the constructor initialization list
716 pos_class_comma                          = ignore   # ignore/lead/trail
717
718 # The position of colons between constructor and member initialization
719 pos_class_colon                          = ignore   # ignore/lead/trail
720
721 #
722 # Line Splitting options
723 #
724
725 # Try to limit code width to N number of columns
726 code_width                               = 0        # number
727
728 # Whether to fully split long 'for' statements at semi-colons
729 ls_for_split_full                        = false    # false/true
730
731 # Whether to fully split long function protos/calls at commas
732 ls_func_split_full                       = false    # false/true
733
734 #
735 # Blank line options
736 #
737
738 # The maximum consecutive newlines
739 nl_max                                   = 0        # number
740
741 # The number of newlines after a function prototype, if followed by another function prototype
742 nl_after_func_proto                      = 0        # number
743
744 # The number of newlines after a function prototype, if not followed by another function prototype
745 nl_after_func_proto_group                = 0        # number
746
747 # The number of newlines after '}' of a multi-line function body
748 nl_after_func_body                       = 0        # number
749
750 # The number of newlines after '}' of a single line function body
751 nl_after_func_body_one_liner             = 0        # number
752
753 # The minimum number of newlines before a multi-line comment.
754 # Doesn't apply if after a brace open or another multi-line comment.
755 nl_before_block_comment                  = 0        # number
756
757 # The minimum number of newlines before a single-line C comment.
758 # Doesn't apply if after a brace open or other single-line C comments.
759 nl_before_c_comment                      = 0        # number
760
761 # The minimum number of newlines before a CPP comment.
762 # Doesn't apply if after a brace open or other CPP comments.
763 nl_before_cpp_comment                    = 0        # number
764
765 # Whether to force a newline after a mulit-line comment.
766 nl_after_multiline_comment               = false    # false/true
767
768 # The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
769 # Will not change the newline count if after a brace open.
770 # 0 = No change.
771 nl_before_access_spec                    = 0        # number
772
773 # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
774 # 0 = No change.
775 nl_after_access_spec                     = 0        # number
776
777 # Whether to remove blank lines after '{'
778 eat_blanks_after_open_brace              = false    # false/true
779
780 # Whether to remove blank lines before '}'
781 eat_blanks_before_close_brace            = false    # false/true
782
783 #
784 # Code modifying options (non-whitespace)
785 #
786
787 # Add or remove braces on single-line 'do' statement
788 mod_full_brace_do                        = ignore   # ignore/add/remove/force
789
790 # Add or remove braces on single-line 'for' statement
791 mod_full_brace_for                       = ignore   # ignore/add/remove/force
792
793 # Add or remove braces on single-line function defintions. (Pawn)
794 mod_full_brace_function                  = ignore   # ignore/add/remove/force
795
796 # Add or remove braces on single-line 'if' statement
797 mod_full_brace_if                        = add      # ignore/add/remove/force
798
799 # Don't remove braces around statements that span N newlines
800 mod_full_brace_nl                        = 0        # number
801
802 # Add or remove braces on single-line 'while' statement
803 mod_full_brace_while                     = ignore   # ignore/add/remove/force
804
805 # Add or remove unnecessary paren on 'return' statement
806 mod_paren_on_return                      = ignore   # ignore/add/remove/force
807
808 # Whether to change optional semicolons to real semicolons
809 mod_pawn_semicolon                       = false    # false/true
810
811 # Add parens on 'while' and 'if' statement around bools
812 mod_full_paren_if_bool                   = false    # false/true
813
814 # Whether to remove superfluous semicolons
815 mod_remove_extra_semicolon               = false    # false/true
816
817 # If a function body exceeds the specified number of newlines and doesn't have a comment after
818 # the close brace, a comment will be added.
819 mod_add_long_function_closebrace_comment = 0        # number
820
821 # If a switch body exceeds the specified number of newlines and doesn't have a comment after
822 # the close brace, a comment will be added.
823 mod_add_long_switch_closebrace_comment   = 0        # number
824
825 # If TRUE, will sort consecutive single-line 'import' statements [Java, D]
826 mod_sort_import                          = false    # false/true
827
828 # If TRUE, will sort consecutive single-line 'using' statements [C#]
829 mod_sort_using                           = false    # false/true
830
831 # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
832 # This is generally a bad idea, as it may break your code.
833 mod_sort_include                         = false    # false/true
834
835 #
836 # Comment modifications
837 #
838
839 # Try to wrap comments at cmt_witdth columns
840 cmt_width                                = 0        # number
841
842 # Whether to group c-comments that look like they are in a block
843 cmt_c_group                              = false    # false/true
844
845 # Whether to put an empty '/*' on the first line of the combined c-comment
846 cmt_c_nl_start                           = false    # false/true
847
848 # Whether to put a newline before the closing '*/' of the combined c-comment
849 cmt_c_nl_end                             = false    # false/true
850
851 # Whether to group cpp-comments that look like they are in a block
852 cmt_cpp_group                            = false    # false/true
853
854 # Whether to put an empty '/*' on the first line of the combined cpp-comment
855 cmt_cpp_nl_start                         = false    # false/true
856
857 # Whether to put a newline before the closing '*/' of the combined cpp-comment
858 cmt_cpp_nl_end                           = false    # false/true
859
860 # Whether to change cpp-comments into c-comments
861 cmt_cpp_to_c                             = false    # false/true
862
863 # Whether to put a star on subsequent comment lines
864 cmt_star_cont                            = false    # false/true
865
866 # The number of spaces to insert at the start of subsequent comment lines
867 cmt_sp_before_star_cont                  = 0        # number
868
869 # The number of spaces to insert after the star on subsequent comment lines
870 cmt_sp_after_star_cont                   = 0        # number
871
872 # The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
873 # Will substitue $(filename) with the current file's name.
874 cmt_insert_file_header                   = ""         # string
875
876 # The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment.
877 # Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
878 # Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
879 cmt_insert_func_header                   = ""         # string
880
881 # The filename that contains text to insert before a class if the class isn't preceeded with a C/C++ comment.
882 # Will substitue $(class) with the class name.
883 cmt_insert_class_header                  = ""         # string
884
885 #
886 # Preprocessor options
887 #
888
889 # Control indent of preprocessors inside #if blocks at brace level 0
890 pp_indent                                = ignore   # ignore/add/remove/force
891
892 # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
893 pp_indent_at_level                       = false    # false/true
894
895 # Add or remove space after # based on pp_level of #if blocks
896 pp_space                                 = ignore   # ignore/add/remove/force
897
898 # Sets the number of spaces added with pp_space
899 pp_space_count                           = 0        # number
900
901 # The indent for #region and #endregion in C# and '#pragma region' in C/C++
902 pp_indent_region                         = 0        # number
903
904 # Whether to indent the code between #region and #endregion
905 pp_region_indent_code                    = false    # false/true
906
907 # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level
908 pp_indent_if                             = 0        # number
909
910 # Control whether to indent the code between #if, #else and #endif when not at file-level
911 pp_if_indent_code                        = false    # false/true
912
913 # Whether to indent '#define' at the brace level (true) or from column 1 (false)
914 pp_define_at_level                       = false    # false/true
915
916 # You can force a token to be a type with the 'type' option.
917 # Example:
918 # type myfoo1 myfoo2
919 #
920 # You can create custom macro-based indentation using macro-open, 
921 # macro-else and macro-close.
922 # Example:
923 # macro-open  BEGIN_TEMPLATE_MESSAGE_MAP
924 # macro-open  BEGIN_MESSAGE_MAP
925 # macro-close END_MESSAGE_MAP