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