Use pkg-config to find NTK.
[zynaddsubfx.git] / style.cfg
blobba66d990d05d0f329cc0e9ad9e3e74273a1d6282
1 # Uncrustify 0.53
4 # General options
7 # The type of line endings
8 newlines                                 = lf       # auto/lf/crlf/cr
10 # The original size of tabs in the input
11 input_tab_size                           = 4        # number
13 # The size of tabs in the output (only used if align_with_tabs=true)
14 output_tab_size                          = 4        # number
16 # The ascii value of the string escape char, usually 92 (\) or 94 (^). (Pawn)
17 string_escape_char                       = 92       # number
19 # Alternate string escape char for Pawn. Only works right before the quote char.
20 string_escape_char2                      = 0        # number
23 # Indenting
26 # The number of columns to indent per level.
27 # Usually 2, 3, 4, or 8.
28 indent_columns                           = 4        # number
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
36 # Whether to indent strings broken by '\' so that they line up
37 indent_align_string                      = true    # false/true
39 # The number of spaces to indent multi-line XML strings.
40 # Requires indent_align_string=True
41 indent_xml_string                        = 0        # number
43 # Spaces to indent '{' from level
44 indent_brace                             = 0        # number
46 # Whether braces are indented to the body level
47 indent_braces                            = false    # false/true
49 # Disabled indenting function braces if indent_braces is true
50 indent_braces_no_func                    = false    # false/true
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
55 # Whether the 'namespace' body is indented
56 indent_namespace                         = true    # false/true
58 # Whether the 'extern "C"' body is indented
59 indent_extern                            = true    # false/true
61 # Whether the 'class' body is indented
62 indent_class                             = true    # false/true
64 # Whether to indent the stuff after a leading class colon
65 indent_class_colon                       = true    # false/true
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
71 # Amount to indent variable declarations after a open brace. neg=relative, pos=absolute
72 indent_var_def_blk                       = 0        # number
74 # True:  indent continued function call parameters one indent level
75 # False: align parameters under the open paren
76 indent_func_call_param                   = false    # false/true
78 # Same as indent_func_call_param, but for function defs
79 indent_func_def_param                    = false    # false/true
81 # Same as indent_func_call_param, but for function protos
82 indent_func_proto_param                  = false    # false/true
84 # Same as indent_func_call_param, but for class declarations
85 indent_func_class_param                  = false    # false/true
87 # Same as indent_func_call_param, but for class variable constructors
88 indent_func_ctor_var_param               = false    # false/true
90 # Same as indent_func_call_param, but for templates
91 indent_template_param                    = false    # false/true
93 # Double the indent for indent_func_xxx_param options
94 indent_func_param_double                 = false    # false/true
96 # Indentation column for standalone 'const' function decl/proto qualifier
97 indent_func_const                        = 0        # number
99 # Indentation column for standalone 'throw' function decl/proto qualifier
100 indent_func_throw                        = 0        # number
102 # The number of spaces to indent a continued '->' or '.'
103 # Usually set to 0, 1, or indent_columns.
104 indent_member                            = 0        # number
106 # Spaces to indent single line ('//') comments on lines before code
107 indent_sing_line_comments                = 0        # number
109 # If set, will indent trailing single line ('//') comments relative
110 # to the code instead of trying to keep the same absolute column
111 indent_relative_single_line_comments     = false    # false/true
113 # Spaces to indent 'case' from 'switch'
114 # Usually 0 or indent_columns.
115 indent_switch_case                       = 4        # number
117 # Spaces to shift the 'case' line, without affecting any other lines
118 # Usually 0.
119 indent_case_shift                        = 0        # number
121 # Spaces to indent '{' from 'case'.
122 # By default, the brace will appear under the 'c' in case.
123 # Usually set to 0 or indent_columns.
124 indent_case_brace                        = 0        # number
126 # Whether to indent comments found in first column
127 indent_col1_comment                      = false    # false/true
129 # How to indent goto labels
130 #  >0 : absolute column where 1 is the leftmost column
131 #  <=0 : subtract from brace indent
132 indent_label                             = 1        # number
134 # Same as indent_label, but for access specifiers that are followed by a colon
135 indent_access_spec                       = 1        # number
137 # Indent the code after an access specifier by one level.
138 # If set, this option forces 'indent_access_spec=0'
139 indent_access_spec_body                  = true    # false/true
141 # If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
142 indent_paren_nl                          = false    # false/true
144 # Controls the indent of a close paren after a newline.
145 # 0: Indent to body level
146 # 1: Align under the open paren
147 # 2: Indent to the brace level
148 indent_paren_close                       = 1        # number
150 # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
151 indent_comma_paren                       = false    # false/true
153 # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
154 indent_bool_paren                        = false    # false/true
156 # If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
157 indent_square_nl                         = false    # false/true
159 # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
160 indent_preserve_sql                      = false    # false/true
162 # Align continued statements at the '='. Default=True
163 # If FALSE or the '=' is followed by a newline, the next line is indent one tab.
164 indent_align_assign                      = true     # false/true
167 # Spacing options
170 # Add or remove space around arithmetic operator '+', '-', '/', '*', etc
171 sp_arith                                 = force      # ignore/add/remove/force
173 # Add or remove space around assignment operator '=', '+=', etc
174 sp_assign                                = force      # ignore/add/remove/force
176 # Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign.
177 sp_before_assign                         = ignore   # ignore/add/remove/force
179 # Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign.
180 sp_after_assign                          = ignore   # ignore/add/remove/force
182 # Add or remove space around assignment '=' in enum
183 sp_enum_assign                           = force      # ignore/add/remove/force
185 # Add or remove space before assignment '=' in enum. Overrides sp_enum_assign.
186 sp_enum_before_assign                    = ignore   # ignore/add/remove/force
188 # Add or remove space after assignment '=' in enum. Overrides sp_enum_assign.
189 sp_enum_after_assign                     = ignore   # ignore/add/remove/force
191 # Add or remove space around preprocessor '##' concatenation operator
192 sp_pp_concat                             = add      # ignore/add/remove/force
194 # Add or remove space after preprocessor '#' stringify operator
195 sp_pp_stringify                          = add      # ignore/add/remove/force
197 # Add or remove space around boolean operators '&&' and '||'
198 sp_bool                                  = force      # ignore/add/remove/force
200 # Add or remove space around compare operator '<', '>', '==', etc
201 sp_compare                               = force      # ignore/add/remove/force
203 # Add or remove space inside '(' and ')'
204 sp_inside_paren                          = remove   # ignore/add/remove/force
206 # Add or remove space between nested parens
207 sp_paren_paren                           = remove   # ignore/add/remove/force
209 # Whether to balance spaces inside nested parens
210 sp_balance_nested_parens                 = false    # false/true
212 # Add or remove space between ')' and '{'
213 sp_paren_brace                           = force   # ignore/add/remove/force
215 # Add or remove space before pointer star '*'
216 sp_before_ptr_star                       = force   # ignore/add/remove/force
218 # Add or remove space before pointer star '*' that isn't followed by a variable name
219 # If set to 'ignore', sp_before_ptr_star is used instead.
220 sp_before_unnamed_ptr_star               = ignore   # ignore/add/remove/force
222 # Add or remove space between pointer stars '*'
223 sp_between_ptr_star                      = remove   # ignore/add/remove/force
225 # Add or remove space after pointer star '*', if followed by a word.
226 sp_after_ptr_star                        = remove   # ignore/add/remove/force
228 # Add or remove space after a pointer star '*', if followed by a func proto/def.
229 sp_after_ptr_star_func                   = remove   # ignore/add/remove/force
231 # Add or remove space before a pointer star '*', if followed by a func proto/def.
232 sp_before_ptr_star_func                  = force   # ignore/add/remove/force
234 # Add or remove space before a reference sign '&'
235 sp_before_byref                          = force   # ignore/add/remove/force
237 # Add or remove space before a reference sign '&' that isn't followed by a variable name
238 # If set to 'ignore', sp_before_byref is used instead.
239 sp_before_unnamed_byref                  = ignore   # ignore/add/remove/force
241 # Add or remove space after reference sign '&', if followed by a word.
242 sp_after_byref                           = remove   # ignore/add/remove/force
244 # Add or remove space after a reference sign '&', if followed by a func proto/def.
245 sp_after_byref_func                      = ignore   # ignore/add/remove/force
247 # Add or remove space before a reference sign '&', if followed by a func proto/def.
248 sp_before_byref_func                     = ignore   # ignore/add/remove/force
250 # Add or remove space between type and word
251 sp_after_type                            = remove    # ignore/add/remove/force
253 # Add or remove space in 'template <' vs 'template<'.
254 # If set to ignore, sp_before_angle is used.
255 sp_template_angle                        = ignore   # ignore/add/remove/force
257 # Add or remove space before '<>'
258 sp_before_angle                          = remove   # ignore/add/remove/force
260 # Add or remove space inside '<' and '>'
261 sp_inside_angle                          = remove   # ignore/add/remove/force
263 # Add or remove space after '<>'
264 sp_after_angle                           = ignore   # ignore/add/remove/force
266 # Add or remove space between '<>' and '(' as found in 'new List<byte>();'
267 sp_angle_paren                           = remove   # ignore/add/remove/force
269 # Add or remove space between '<>' and a word as in 'List<byte> m;'
270 sp_angle_word                            = ignore   # ignore/add/remove/force
272 # Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
273 sp_before_sparen                         = remove   # ignore/add/remove/force
275 # Add or remove space inside if-condition '(' and ')'
276 sp_inside_sparen                         = remove   # ignore/add/remove/force
278 # Add or remove space before if-condition ')'. Overrides sp_inside_sparen.
279 sp_inside_sparen_close                   = remove   # ignore/add/remove/force
281 # Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
282 sp_after_sparen                          = remove   # ignore/add/remove/force
284 # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
285 sp_sparen_brace                          = force   # ignore/add/remove/force
287 # Add or remove space between 'invariant' and '(' in the D language.
288 sp_invariant_paren                       = ignore   # ignore/add/remove/force
290 # Add or remove space after the ')' in 'invariant (C) c' in the D language.
291 sp_after_invariant_paren                 = ignore   # ignore/add/remove/force
293 # Add or remove space before empty statement ';' on 'if', 'for' and 'while'
294 sp_special_semi                          = ignore   # ignore/add/remove/force
296 # Add or remove space before ';'
297 sp_before_semi                           = remove   # ignore/add/remove/force
299 # Add or remove space before ';' in non-empty 'for' statements
300 sp_before_semi_for                       = remove   # ignore/add/remove/force
302 # Add or remove space before a semicolon of an empty part of a for statment.
303 sp_before_semi_for_empty                 = remove   # ignore/add/remove/force
305 # Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; <here> ).
306 sp_after_semi_for_empty                  = remove   # ignore/add/remove/force
308 # Add or remove space before '[' (except '[]')
309 sp_before_square                         = ignore   # ignore/add/remove/force
311 # Add or remove space before '[]'
312 sp_before_squares                        = ignore   # ignore/add/remove/force
314 # Add or remove space inside '[' and ']'
315 sp_inside_square                         = remove   # ignore/add/remove/force
317 # Add or remove space after ','
318 sp_after_comma                           = force   # ignore/add/remove/force
320 # Add or remove space before ','
321 sp_before_comma                          = remove   # ignore/add/remove/force
323 # Add or remove space after class ':'
324 sp_after_class_colon                     = remove   # ignore/add/remove/force
326 # Add or remove space before class ':'
327 sp_before_class_colon                    = remove   # ignore/add/remove/force
329 # Add or remove space before case ':'
330 sp_before_case_colon                     = remove   # ignore/add/remove/force
332 # Add or remove space between 'operator' and operator sign
333 sp_after_operator                        = ignore   # ignore/add/remove/force
335 # Add or remove space between the operator symbol and the open paren, as in 'operator ++('
336 sp_after_operator_sym                    = ignore   # ignore/add/remove/force
338 # Add or remove space after C/D cast, ie 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'
339 sp_after_cast                            = ignore   # ignore/add/remove/force
341 # Add or remove spaces inside cast parens
342 sp_inside_paren_cast                     = remove   # ignore/add/remove/force
344 # Add or remove space between the type and open paren in a C++ cast, ie 'int(exp)' vs 'int (exp)'
345 sp_cpp_cast_paren                        = remove   # ignore/add/remove/force
347 # Add or remove space between 'sizeof' and '('
348 sp_sizeof_paren                          = remove   # ignore/add/remove/force
350 # Add or remove space after the tag keyword (Pawn)
351 sp_after_tag                             = ignore   # ignore/add/remove/force
353 # Add or remove space inside enum '{' and '}'
354 sp_inside_braces_enum                    = ignore   # ignore/add/remove/force
356 # Add or remove space inside struct/union '{' and '}'
357 sp_inside_braces_struct                  = remove   # ignore/add/remove/force
359 # Add or remove space inside '{' and '}'
360 sp_inside_braces                         = ignore   # ignore/add/remove/force
362 # Add or remove space inside '{}'
363 sp_inside_braces_empty                   = ignore   # ignore/add/remove/force
365 # Add or remove space between return type and function name
366 # A minimum of 1 is forced except for pointer return types.
367 sp_type_func                             = ignore   # ignore/add/remove/force
369 # Add or remove space between function name and '(' on function declaration
370 sp_func_proto_paren                      = remove   # ignore/add/remove/force
372 # Add or remove space between function name and '(' on function definition
373 sp_func_def_paren                        = remove   # ignore/add/remove/force
375 # Add or remove space inside empty function '()'
376 sp_inside_fparens                        = remove   # ignore/add/remove/force
378 # Add or remove space inside function '(' and ')'
379 sp_inside_fparen                         = remove   # ignore/add/remove/force
381 # Add or remove space between ']' and '(' when part of a function call.
382 sp_square_fparen                         = ignore   # ignore/add/remove/force
384 # Add or remove space between ')' and '{' of function
385 sp_fparen_brace                          = force   # ignore/add/remove/force
387 # Add or remove space between function name and '(' on function calls
388 sp_func_call_paren                       = remove   # ignore/add/remove/force
390 # Add or remove space between the user function name and '(' on function calls
391 # You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
392 sp_func_call_user_paren                  = ignore   # ignore/add/remove/force
394 # Add or remove space between a constructor/destructor and the open paren
395 sp_func_class_paren                      = remove   # ignore/add/remove/force
397 # Add or remove space between 'return' and '('
398 sp_return_paren                          = remove   # ignore/add/remove/force
400 # Add or remove space between '__attribute__' and '('
401 sp_attribute_paren                       = ignore   # ignore/add/remove/force
403 # Add or remove space between 'defined' and '(' in '#if defined (FOO)'
404 sp_defined_paren                         = ignore   # ignore/add/remove/force
406 # Add or remove space between 'throw' and '(' in 'throw (something)'
407 sp_throw_paren                           = ignore   # ignore/add/remove/force
409 # Add or remove space between macro and value
410 sp_macro                                 = ignore   # ignore/add/remove/force
412 # Add or remove space between macro function ')' and value
413 sp_macro_func                            = ignore   # ignore/add/remove/force
415 # Add or remove space between 'else' and '{' if on the same line
416 sp_else_brace                            = force   # ignore/add/remove/force
418 # Add or remove space between '}' and 'else' if on the same line
419 sp_brace_else                            = ignore   # ignore/add/remove/force
421 # Add or remove space between '}' and the name of a typedef on the same line
422 sp_brace_typedef                         = ignore   # ignore/add/remove/force
424 # Add or remove space between 'catch' and '{' if on the same line
425 sp_catch_brace                           = ignore   # ignore/add/remove/force
427 # Add or remove space between '}' and 'catch' if on the same line
428 sp_brace_catch                           = ignore   # ignore/add/remove/force
430 # Add or remove space between 'finally' and '{' if on the same line
431 sp_finally_brace                         = ignore   # ignore/add/remove/force
433 # Add or remove space between '}' and 'finally' if on the same line
434 sp_brace_finally                         = ignore   # ignore/add/remove/force
436 # Add or remove space between 'try' and '{' if on the same line
437 sp_try_brace                             = ignore   # ignore/add/remove/force
439 # Add or remove space between get/set and '{' if on the same line
440 sp_getset_brace                          = ignore   # ignore/add/remove/force
442 # Add or remove space before the '::' operator
443 sp_before_dc                             = remove   # ignore/add/remove/force
445 # Add or remove space after the '::' operator
446 sp_after_dc                              = remove   # ignore/add/remove/force
448 # Add or remove around the D named array initializer ':' operator
449 sp_d_array_colon                         = ignore   # ignore/add/remove/force
451 # Add or remove space after the '!' (not) operator.
452 sp_not                                   = remove   # ignore/add/remove/force
454 # Add or remove space after the '~' (invert) operator.
455 sp_inv                                   = remove   # ignore/add/remove/force
457 # Add or remove space after the '&' (address-of) operator.
458 # This does not affect the spacing after a '&' that is part of a type.
459 sp_addr                                  = remove   # ignore/add/remove/force
461 # Add or remove space around the '.' or '->' operators
462 sp_member                                = remove   # ignore/add/remove/force
464 # Add or remove space after the '*' (dereference) operator.
465 # This does not affect the spacing after a '*' that is part of a type.
466 sp_deref                                 = remove   # ignore/add/remove/force
468 # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'
469 sp_sign                                  = remove   # ignore/add/remove/force
471 # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'
472 sp_incdec                                = remove   # ignore/add/remove/force
474 # Add or remove space before a backslash-newline at the end of a line
475 sp_before_nl_cont                        = force      # ignore/add/remove/force
477 # Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
478 sp_after_oc_scope                        = ignore   # ignore/add/remove/force
480 # Add or remove space after the colon in message specs
481 # '-(int) f:(int) x;' vs '-(int) f: (int) x;'
482 sp_after_oc_colon                        = ignore   # ignore/add/remove/force
484 # Add or remove space before the colon in message specs
485 # '-(int) f: (int) x;' vs '-(int) f : (int) x;'
486 sp_before_oc_colon                       = ignore   # ignore/add/remove/force
488 # Add or remove space after the colon in message specs
489 # '[object setValue:1];' vs '[object setValue: 1];'
490 sp_after_send_oc_colon                   = ignore   # ignore/add/remove/force
492 # Add or remove space before the colon in message specs
493 # '[object setValue:1];' vs '[object setValue :1];'
494 sp_before_send_oc_colon                  = ignore   # ignore/add/remove/force
496 # Add or remove space after the (type) in message specs
497 # '-(int) f: (int) x;' vs '-(int) f: (int)x;'
498 sp_after_oc_type                         = ignore   # ignore/add/remove/force
500 # Add or remove space around the ':' in 'b ? t : f'
501 sp_cond_colon                            = ignore   # ignore/add/remove/force
503 # Add or remove space around the '?' in 'b ? t : f'
504 sp_cond_question                         = ignore   # ignore/add/remove/force
506 # Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
507 sp_case_label                            = ignore   # ignore/add/remove/force
509 # Control the space around the D '..' operator.
510 sp_range                                 = ignore   # ignore/add/remove/force
512 # Control the space after the opening of a C++ comment '// A' vs '//A'
513 sp_cmt_cpp_start                         = ignore   # ignore/add/remove/force
516 # Code alignment (not left column spaces/tabs)
519 # Whether to keep non-indenting tabs
520 align_keep_tabs                          = false    # false/true
522 # Whether to use tabs for alinging
523 align_with_tabs                          = false    # false/true
525 # Whether to bump out to the next tab when aligning
526 align_on_tabstop                         = false    # false/true
528 # Whether to left-align numbers
529 align_number_left                        = false    # false/true
531 # Align variable definitions in prototypes and functions
532 align_func_params                        = false    # false/true
534 # Align parameters in single-line functions that have the same name.
535 # The function names must already be aligned with each other.
536 align_same_func_call_params              = false    # false/true
538 # The span for aligning variable definitions (0=don't align)
539 align_var_def_span                       = 1        # number
541 # How to align the star in variable definitions.
542 #  0=Part of the type     'void *   foo;'
543 #  1=Part of the variable 'void     *foo;'
544 #  2=Dangling             'void    *foo;'
545 align_var_def_star_style                 = 2        # number
547 # How to align the '&' in variable definitions.
548 #  0=Part of the type
549 #  1=Part of the variable
550 #  2=Dangling
551 align_var_def_amp_style                  = 2        # number
553 # The threshold for aligning variable definitions (0=no limit)
554 align_var_def_thresh                     = 5        # number
556 # The gap for aligning variable definitions
557 align_var_def_gap                        = 1        # number
559 # Whether to align the colon in struct bit fields
560 align_var_def_colon                      = false    # false/true
562 # Whether to align any attribute after the variable name
563 align_var_def_attribute                  = false    # false/true
565 # Whether to align inline struct/enum/union variable definitions
566 align_var_def_inline                     = false    # false/true
568 # The span for aligning on '=' in assignments (0=don't align)
569 align_assign_span                        = 1        # number
571 # The threshold for aligning on '=' in assignments (0=no limit)
572 align_assign_thresh                      = 5    # number
574 # The span for aligning on '=' in enums (0=don't align)
575 align_enum_equ_span                      = 1        # number
577 # The threshold for aligning on '=' in enums (0=no limit)
578 align_enum_equ_thresh                    = 5        # number
580 # The span for aligning struct/union (0=don't align)
581 align_var_struct_span                    = 1        # number
583 # The threshold for aligning struct/union member definitions (0=no limit)
584 align_var_struct_thresh                  = 5        # number
586 # The gap for aligning struct/union member definitions
587 align_var_struct_gap                     = 0        # number
589 # The span for aligning struct initializer values (0=don't align)
590 align_struct_init_span                   = 1        # number
592 # The minimum space between the type and the synonym of a typedef
593 align_typedef_gap                        = 0        # number
595 # The span for aligning single-line typedefs (0=don't align)
596 align_typedef_span                       = 1        # number
598 # How to align typedef'd functions with other typedefs
599 # 0: Don't mix them at all
600 # 1: align the open paren with the types
601 # 2: align the function type name with the other type names
602 align_typedef_func                       = 0        # number
604 # Controls the positioning of the '*' in typedefs. Just try it.
605 # 0: Align on typdef type, ignore '*'
606 # 1: The '*' is part of type name: typedef int  *pint;
607 # 2: The '*' is part of the type, but dangling: typedef int *pint;
608 align_typedef_star_style                 = 0        # number
610 # Controls the positioning of the '&' in typedefs. Just try it.
611 # 0: Align on typdef type, ignore '&'
612 # 1: The '&' is part of type name: typedef int  &pint;
613 # 2: The '&' is part of the type, but dangling: typedef int &pint;
614 align_typedef_amp_style                  = 0        # number
616 # The span for aligning comments that end lines (0=don't align)
617 align_right_cmt_span                     = 0        # number
619 # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
620 align_right_cmt_mix                      = false    # false/true
622 # If a trailing comment is more than this number of columns away from the text it follows,
623 # it will qualify for being aligned.
624 align_right_cmt_gap                      = 0        # number
626 # Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore)
627 align_right_cmt_at_col                   = 0        # number
629 # The span for aligning function prototypes (0=don't align)
630 align_func_proto_span                    = 0        # number
632 # Minimum gap between the return type and the function name.
633 align_func_proto_gap                     = 0        # number
635 # Align function protos on the 'operator' keyword instead of what follows
636 align_on_operator                        = false    # false/true
638 # Whether to mix aligning prototype and variable declarations.
639 # If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.
640 align_mix_var_proto                      = false    # false/true
642 # Align single-line functions with function prototypes, uses align_func_proto_span
643 align_single_line_func                   = false    # false/true
645 # Aligning the open brace of single-line functions.
646 # Requires align_single_line_func=true, uses align_func_proto_span
647 align_single_line_brace                  = false    # false/true
649 # Gap for align_single_line_brace.
650 align_single_line_brace_gap              = 0        # number
652 # The span for aligning ObjC msg spec (0=don't align)
653 align_oc_msg_spec_span                   = 0        # number
655 # Whether to align macros wrapped with a backslash and a newline.
656 # This will not work right if the macro contains a multi-line comment.
657 align_nl_cont                            = false    # false/true
659 # The minimum space between label and value of a preprocessor define
660 align_pp_define_gap                      = 0        # number
662 # The span for aligning on '#define' bodies (0=don't align)
663 align_pp_define_span                     = 0        # number
665 # Align lines that start with '<<' with previous '<<'. Default=true
666 align_left_shift                         = true     # false/true
669 # Newline adding and removing options
672 # Whether to collapse empty blocks between '{' and '}'
673 nl_collapse_empty_body                   = true    # false/true
675 # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'
676 nl_assign_leave_one_liners               = true    # false/true
678 # Don't split one-line braced statements inside a class xx { } body
679 nl_class_leave_one_liners                = false    # false/true
681 # Don't split one-line enums: 'enum foo { BAR = 15 };'
682 nl_enum_leave_one_liners                 = false    # false/true
684 # Don't split one-line get or set functions
685 nl_getset_leave_one_liners               = true     # false/true
687 # Don't split one-line function definitions - 'int foo() { return 0; }'
688 nl_func_leave_one_liners                 = true    # false/true
690 # Don't split one-line if/else statements - 'if(a) b++;'
691 nl_if_leave_one_liners                   = false    # false/true
693 # Add or remove newlines at the start of the file
694 nl_start_of_file                         = ignore   # ignore/add/remove/force
696 # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
697 nl_start_of_file_min                     = 0        # number
699 # Add or remove newline at the end of the file
700 nl_end_of_file                           = force   # ignore/add/remove/force
702 # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
703 nl_end_of_file_min                       = 1        # number
705 # Add or remove newline between '=' and '{'
706 nl_assign_brace                          = ignore   # ignore/add/remove/force
708 # Add or remove newline between '=' and '[' (D only)
709 nl_assign_square                         = ignore   # ignore/add/remove/force
711 # Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
712 nl_after_square_assign                   = ignore   # ignore/add/remove/force
714 # The number of newlines after a block of variable definitions
715 nl_func_var_def_blk                      = 0        # number
717 # Add or remove newline between a function call's ')' and '{', as in:
718 # list_for_each(item, &list) { }
719 nl_fcall_brace                           = force   # ignore/add/remove/force
721 # Add or remove newline between 'enum' and '{'
722 nl_enum_brace                            = remove   # ignore/add/remove/force
724 # Add or remove newline between 'struct and '{'
725 nl_struct_brace                          = remove   # ignore/add/remove/force
727 # Add or remove newline between 'union' and '{'
728 nl_union_brace                           = remove   # ignore/add/remove/force
730 # Add or remove newline between 'if' and '{'
731 nl_if_brace                              = remove   # ignore/add/remove/force
733 # Add or remove newline between '}' and 'else'
734 nl_brace_else                            = force   # ignore/add/remove/force
736 # Add or remove newline between 'else if' and '{'
737 # If set to ignore, nl_if_brace is used instead
738 nl_elseif_brace                          = ignore   # ignore/add/remove/force
740 # Add or remove newline between 'else' and '{'
741 nl_else_brace                            = remove   # ignore/add/remove/force
743 # Add or remove newline between 'else' and 'if'
744 nl_else_if                               = add   # ignore/add/remove/force
746 # Add or remove newline between '}' and 'finally'
747 nl_brace_finally                         = force   # ignore/add/remove/force
749 # Add or remove newline between 'finally' and '{'
750 nl_finally_brace                         = remove   # ignore/add/remove/force
752 # Add or remove newline between 'try' and '{'
753 nl_try_brace                             = remove   # ignore/add/remove/force
755 # Add or remove newline between get/set and '{'
756 nl_getset_brace                          = ignore   # ignore/add/remove/force
758 # Add or remove newline between 'for' and '{'
759 nl_for_brace                             = remove   # ignore/add/remove/force
761 # Add or remove newline between 'catch' and '{'
762 nl_catch_brace                           = remove   # ignore/add/remove/force
764 # Add or remove newline between '}' and 'catch'
765 nl_brace_catch                           = force   # ignore/add/remove/force
767 # Add or remove newline between 'while' and '{'
768 nl_while_brace                           = remove   # ignore/add/remove/force
770 # Add or remove newline between 'do' and '{'
771 nl_do_brace                              = remove   # ignore/add/remove/force
773 # Add or remove newline between '}' and 'while' of 'do' statement
774 nl_brace_while                           = remove   # ignore/add/remove/force
776 # Add or remove newline between 'switch' and '{'
777 nl_switch_brace                          = remove   # ignore/add/remove/force
779 # Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc.
780 # Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch, and nl_catch_brace.
781 nl_multi_line_cond                       = false    # false/true
783 # Force a newline in a define after the macro name for multi-line defines.
784 nl_multi_line_define                     = false    # false/true
786 # Whether to put a newline before 'case' statement
787 nl_before_case                           = false    # false/true
789 # Add or remove newline between ')' and 'throw'
790 nl_before_throw                          = ignore   # ignore/add/remove/force
792 # Whether to put a newline after 'case' statement
793 nl_after_case                            = false    # false/true
795 # Newline between namespace and {
796 nl_namespace_brace                       = ignore   # ignore/add/remove/force
798 # Add or remove newline between 'template<>' and whatever follows.
799 nl_template_class                        = ignore   # ignore/add/remove/force
801 # Add or remove newline between 'class' and '{'
802 nl_class_brace                           = force   # ignore/add/remove/force
804 # Add or remove newline after each ',' in the constructor member initialization
805 nl_class_init_args                       = ignore   # ignore/add/remove/force
807 # Add or remove newline between return type and function name in definition
808 nl_func_type_name                        = ignore   # ignore/add/remove/force
810 # Add or remove newline between function scope and name in a definition
811 # Controls the newline after '::' in 'void A::f() { }'
812 nl_func_scope_name                       = ignore   # ignore/add/remove/force
814 # Add or remove newline between return type and function name in a prototype
815 nl_func_proto_type_name                  = ignore   # ignore/add/remove/force
817 # Add or remove newline between a function name and the opening '('
818 nl_func_paren                            = remove   # ignore/add/remove/force
820 # Add or remove newline after '(' in a function declaration
821 nl_func_decl_start                       = ignore   # ignore/add/remove/force
823 # Add or remove newline after each ',' in a function declaration
824 nl_func_decl_args                        = ignore   # ignore/add/remove/force
826 # Add or remove newline before the ')' in a function declaration
827 nl_func_decl_end                         = ignore   # ignore/add/remove/force
829 # Add or remove newline between function signature and '{'
830 nl_fdef_brace                            = ignore   # ignore/add/remove/force
832 # Whether to put a newline after 'return' statement
833 nl_after_return                          = false    # false/true
835 # Add or remove a newline between the return keyword and return expression.
836 nl_return_expr                           = ignore   # ignore/add/remove/force
838 # Whether to put a newline after semicolons, except in 'for' statements
839 nl_after_semicolon                       = false    # false/true
841 # Whether to put a newline after brace open.
842 # This also adds a newline before the matching brace close.
843 nl_after_brace_open                      = true    # false/true
845 # If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is
846 # placed between the open brace and a trailing single-line comment.
847 nl_after_brace_open_cmt                  = false    # false/true
849 # Whether to put a newline after a virtual brace open.
850 # These occur in un-braced if/while/do/for statement bodies.
851 nl_after_vbrace_open                     = true    # false/true
853 # Whether to put a newline after a brace close.
854 # Does not apply if followed by a necessary ';'.
855 nl_after_brace_close                     = false    # false/true
857 # Whether to alter newlines in '#define' macros
858 nl_define_macro                          = false    # false/true
860 # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
861 nl_squeeze_ifdef                         = false    # false/true
863 # Add or remove newline before 'if'
864 nl_before_if                             = ignore   # ignore/add/remove/force
866 # Add or remove newline after 'if'
867 nl_after_if                              = ignore   # ignore/add/remove/force
869 # Add or remove newline before 'for'
870 nl_before_for                            = ignore   # ignore/add/remove/force
872 # Add or remove newline after 'for'
873 nl_after_for                             = ignore   # ignore/add/remove/force
875 # Add or remove newline before 'while'
876 nl_before_while                          = ignore   # ignore/add/remove/force
878 # Add or remove newline after 'while'
879 nl_after_while                           = ignore   # ignore/add/remove/force
881 # Add or remove newline before 'switch'
882 nl_before_switch                         = ignore   # ignore/add/remove/force
884 # Add or remove newline after 'switch'
885 nl_after_switch                          = ignore   # ignore/add/remove/force
887 # Add or remove newline before 'do'
888 nl_before_do                             = ignore   # ignore/add/remove/force
890 # Add or remove newline after 'do'
891 nl_after_do                              = ignore   # ignore/add/remove/force
893 # Whether to double-space commented-entries in struct/enum
894 nl_ds_struct_enum_cmt                    = false    # false/true
896 # Whether to double-space before the close brace of a struct/union/enum
897 nl_ds_struct_enum_close_brace            = false    # false/true
899 # Add or remove a newline around a class colon.
900 # Related to pos_class_colon, nl_class_init_args, and pos_comma.
901 nl_class_colon                           = ignore   # ignore/add/remove/force
903 # Change simple unbraced if statements into a one-liner
904 # 'if(b)\n i++;' => 'if(b) i++;'
905 nl_create_if_one_liner                   = false    # false/true
907 # Change simple unbraced for statements into a one-liner
908 # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
909 nl_create_for_one_liner                  = false    # false/true
911 # Change simple unbraced while statements into a one-liner
912 # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
913 nl_create_while_one_liner                = false    # false/true
916 # Positioning options
919 # The position of arithmetic operators in wrapped expressions
920 pos_arith                                = lead    # ignore/lead/trail
922 # The position of assignment in wrapped expressions
923 pos_assign                               = trail   # ignore/lead/trail
925 # The position of boolean operators in wrapped expressions
926 pos_bool                                 = lead     # ignore/lead/trail
928 # The position of the comma in wrapped expressions
929 pos_comma                                = trail   # ignore/lead/trail
931 # The position of the comma in the constructor initialization list
932 pos_class_comma                          = trail   # ignore/lead/trail
934 # The position of colons between constructor and member initialization
935 pos_class_colon                          = lead   # ignore/lead/trail
938 # Line Splitting options
941 # Try to limit code width to N number of columns
942 code_width                               = 80        # number
944 # Whether to fully split long 'for' statements at semi-colons
945 ls_for_split_full                        = true    # false/true
947 # Whether to fully split long function protos/calls at commas
948 ls_func_split_full                       = true    # false/true
951 # Blank line options
954 # The maximum consecutive newlines
955 nl_max                                   = 0        # number
957 # The number of newlines after a function prototype, if followed by another function prototype
958 nl_after_func_proto                      = 0        # number
960 # The number of newlines after a function prototype, if not followed by another function prototype
961 nl_after_func_proto_group                = 0        # number
963 # The number of newlines after '}' of a multi-line function body
964 nl_after_func_body                       = 0        # number
966 # The number of newlines after '}' of a single line function body
967 nl_after_func_body_one_liner             = 0        # number
969 # The minimum number of newlines before a multi-line comment.
970 # Doesn't apply if after a brace open or another multi-line comment.
971 nl_before_block_comment                  = 0        # number
973 # The minimum number of newlines before a single-line C comment.
974 # Doesn't apply if after a brace open or other single-line C comments.
975 nl_before_c_comment                      = 0        # number
977 # The minimum number of newlines before a CPP comment.
978 # Doesn't apply if after a brace open or other CPP comments.
979 nl_before_cpp_comment                    = 0        # number
981 # Whether to force a newline after a mulit-line comment.
982 nl_after_multiline_comment               = false    # false/true
984 # The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
985 # Will not change the newline count if after a brace open.
986 # 0 = No change.
987 nl_before_access_spec                    = 0        # number
989 # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
990 # 0 = No change.
991 nl_after_access_spec                     = 0        # number
993 # The number of newlines between a function def and the function comment.
994 # 0 = No change.
995 nl_comment_func_def                      = 0        # number
997 # The number of newlines after a try-catch-finally block that isn't followed by a brace close.
998 # 0 = No change.
999 nl_after_try_catch_finally               = 0        # number
1001 # The number of newlines before and after a property, indexer or event decl.
1002 # 0 = No change.
1003 nl_around_cs_property                    = 0        # number
1005 # The number of newlines between the get/set/add/remove handlers in C#.
1006 # 0 = No change.
1007 nl_between_get_set                       = 0        # number
1009 # Whether to remove blank lines after '{'
1010 eat_blanks_after_open_brace              = true    # false/true
1012 # Whether to remove blank lines before '}'
1013 eat_blanks_before_close_brace            = true    # false/true
1016 # Code modifying options (non-whitespace)
1019 # Add or remove braces on single-line 'do' statement
1020 mod_full_brace_do                        = ignore   # ignore/add/remove/force
1022 # Add or remove braces on single-line 'for' statement
1023 mod_full_brace_for                       = remove   # ignore/add/remove/force
1025 # Add or remove braces on single-line function defintions. (Pawn)
1026 mod_full_brace_function                  = ignore   # ignore/add/remove/force
1028 # Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.
1029 mod_full_brace_if                        = remove   # ignore/add/remove/force
1031 # Don't remove braces around statements that span N newlines
1032 mod_full_brace_nl                        = 0        # number
1034 # Add or remove braces on single-line 'while' statement
1035 mod_full_brace_while                     = ignore   # ignore/add/remove/force
1037 # Add or remove unnecessary paren on 'return' statement
1038 mod_paren_on_return                      = remove   # ignore/add/remove/force
1040 # Whether to change optional semicolons to real semicolons
1041 mod_pawn_semicolon                       = false    # false/true
1043 # Add parens on 'while' and 'if' statement around bools
1044 mod_full_paren_if_bool                   = true    # false/true
1046 # Whether to remove superfluous semicolons
1047 mod_remove_extra_semicolon               = true    # false/true
1049 # If a function body exceeds the specified number of newlines and doesn't have a comment after
1050 # the close brace, a comment will be added.
1051 mod_add_long_function_closebrace_comment = 0        # number
1053 # If a switch body exceeds the specified number of newlines and doesn't have a comment after
1054 # the close brace, a comment will be added.
1055 mod_add_long_switch_closebrace_comment   = 0        # number
1057 # If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after
1058 # the #else, a comment will be added.
1059 mod_add_long_ifdef_endif_comment         = 0        # number
1061 # If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after
1062 # the #endif, a comment will be added.
1063 mod_add_long_ifdef_else_comment          = 0        # number
1065 # If TRUE, will sort consecutive single-line 'import' statements [Java, D]
1066 mod_sort_import                          = false    # false/true
1068 # If TRUE, will sort consecutive single-line 'using' statements [C#]
1069 mod_sort_using                           = false    # false/true
1071 # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
1072 # This is generally a bad idea, as it may break your code.
1073 mod_sort_include                         = false    # false/true
1075 # If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.
1076 mod_move_case_break                      = false    # false/true
1078 # If TRUE, it will remove a void 'return;' that appears as the last statement in a function.
1079 mod_remove_empty_return                  = false    # false/true
1082 # Comment modifications
1085 # Try to wrap comments at cmt_width columns
1086 cmt_width                                = 0        # number
1088 # If false, disable all multi-line comment changes, including cmt_width and leading chars.
1089 # Default is true.
1090 cmt_indent_multi                         = false    # false/true
1092 # Whether to group c-comments that look like they are in a block
1093 cmt_c_group                              = false    # false/true
1095 # Whether to put an empty '/*' on the first line of the combined c-comment
1096 cmt_c_nl_start                           = false    # false/true
1098 # Whether to put a newline before the closing '*/' of the combined c-comment
1099 cmt_c_nl_end                             = false    # false/true
1101 # Whether to group cpp-comments that look like they are in a block
1102 cmt_cpp_group                            = false    # false/true
1104 # Whether to put an empty '/*' on the first line of the combined cpp-comment
1105 cmt_cpp_nl_start                         = false    # false/true
1107 # Whether to put a newline before the closing '*/' of the combined cpp-comment
1108 cmt_cpp_nl_end                           = false    # false/true
1110 # Whether to change cpp-comments into c-comments
1111 cmt_cpp_to_c                             = false    # false/true
1113 # Whether to put a star on subsequent comment lines
1114 cmt_star_cont                            = false    # false/true
1116 # The number of spaces to insert at the start of subsequent comment lines
1117 cmt_sp_before_star_cont                  = 0        # number
1119 # The number of spaces to insert after the star on subsequent comment lines
1120 cmt_sp_after_star_cont                   = 1        # number
1122 # For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of
1123 # the comment are the same length. Default=True
1124 cmt_multi_check_last                     = true     # false/true
1126 # The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
1127 # Will substitue $(filename) with the current file's name.
1128 cmt_insert_file_header                   = ""         # string
1130 # The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment.
1131 # Will substitue $(filename) with the current file's name.
1132 cmt_insert_file_footer                   = ""         # string
1134 # The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment.
1135 # Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
1136 # Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
1137 cmt_insert_func_header                   = ""         # string
1139 # The filename that contains text to insert before a class if the class isn't preceeded with a C/C++ comment.
1140 # Will substitue $(class) with the class name.
1141 cmt_insert_class_header                  = ""         # string
1143 # If a preprocessor is encountered when stepping backwards from a function name, then
1144 # this option decides whether the comment should be inserted.
1145 # Affects cmt_insert_func_header and cmt_insert_class_header.
1146 cmt_insert_before_preproc                = false    # false/true
1149 # Preprocessor options
1152 # Control indent of preprocessors inside #if blocks at brace level 0
1153 pp_indent                                = ignore   # ignore/add/remove/force
1155 # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
1156 pp_indent_at_level                       = false    # false/true
1158 # If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1.
1159 pp_indent_count                          = 1        # number
1161 # Add or remove space after # based on pp_level of #if blocks
1162 pp_space                                 = ignore   # ignore/add/remove/force
1164 # Sets the number of spaces added with pp_space
1165 pp_space_count                           = 0        # number
1167 # The indent for #region and #endregion in C# and '#pragma region' in C/C++
1168 pp_indent_region                         = 0        # number
1170 # Whether to indent the code between #region and #endregion
1171 pp_region_indent_code                    = false    # false/true
1173 # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level
1174 pp_indent_if                             = 0        # number
1176 # Control whether to indent the code between #if, #else and #endif when not at file-level
1177 pp_if_indent_code                        = false    # false/true
1179 # Whether to indent '#define' at the brace level (true) or from column 1 (false)
1180 pp_define_at_level                       = false    # false/true
1182 # You can force a token to be a type with the 'type' option.
1183 # Example:
1184 # type myfoo1 myfoo2
1186 # You can create custom macro-based indentation using macro-open,
1187 # macro-else and macro-close.
1188 # Example:
1189 # macro-open  BEGIN_TEMPLATE_MESSAGE_MAP
1190 # macro-open  BEGIN_MESSAGE_MAP
1191 # macro-close END_MESSAGE_MAP
1193 # You can assign any keyword to any type with the set option.
1194 # set func_call_user _ N_
1196 # The full syntax description of all custom definition config entries
1197 # is shown below:
1199 # define custom tokens as:
1200 # - embed whitespace in token using '' escape character, or
1201 #   put token in quotes
1202 # - these: ' " and ` are recognized as quote delimiters
1204 # type token1 token2 token3 ...
1205 #             ^ optionally specify multiple tokens on a single line
1206 # define def_token output_token
1207 #                  ^ output_token is optional, then NULL is assumed
1208 # macro-open token
1209 # macro-close token
1210 # macro-else token
1211 # set id token1 token2 ...
1212 #               ^ optionally specify multiple tokens on a single line
1213 #     ^ id is one of the names in token_enum.h sans the CT_ prefix,
1214 #       e.g. PP_PRAGMA
1216 # all tokens are separated by any mix of ',' commas, '=' equal signs
1217 # and whitespace (space, tab)