1#
2# FreeFEM options
3#
4
5# The type of line endings. Default=Auto.
6newlines                        = auto     # auto/lf/crlf/cr
7
8# The original size of tabs in the input. Default=8.
9input_tab_size                  = 8        # unsigned number
10
11# The size of tabs in the output (only used if align_with_tabs=true). Default=8.
12output_tab_size                 = 4        # unsigned number
13
14# The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn).
15string_escape_char              = 92       # unsigned number
16
17# Alternate string escape char for Pawn. Only works right before the quote char.
18string_escape_char2             = 0        # unsigned number
19
20# Replace tab characters found in string literals with the escape sequence \t instead.
21string_replace_tab_chars        = false    # false/true
22
23# Allow interpreting '>=' and '>>=' as part of a template in 'void f(list<list<B>>=val);'.
24# If True, 'assert(x<0 && y>=3)' will be broken. Default=False
25# Improvements to template detection may make this option obsolete.
26tok_split_gte                   = false    # false/true
27
28# Override the default ' *INDENT-OFF*' in comments for disabling processing of part of the file.
29disable_processing_cmt          = ""         # string
30
31# Override the default ' *INDENT-ON*' in comments for enabling processing of part of the file.
32enable_processing_cmt           = ""         # string
33
34# Enable parsing of digraphs. Default=False.
35enable_digraphs                 = false    # false/true
36
37# Control what to do with the UTF-8 BOM (recommend 'remove').
38utf8_bom                        = ignore   # ignore/add/remove/force
39
40# If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8.
41utf8_byte                       = true    # false/true
42
43# Force the output encoding to UTF-8.
44utf8_force                      = true    # false/true
45
46#
47# Spacing options
48#
49
50# Add or remove space around arithmetic operator '+', '-', '/', '*', etc
51# also '>>>' '<<' '>>' '%' '|'.
52sp_arith                        = force   # ignore/add/remove/force
53
54# Add or remove space around arithmetic operator '+' and '-'. Overrides sp_arith
55sp_arith_additive               = ignore   # ignore/add/remove/force
56
57# Add or remove space around assignment operator '=', '+=', etc.
58sp_assign                       = force   # ignore/add/remove/force
59
60# Add or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign.
61sp_cpp_lambda_assign            = ignore   # ignore/add/remove/force
62
63# Add or remove space after the capture specification in C++11 lambda.
64sp_cpp_lambda_paren             = force   # ignore/add/remove/force
65
66# Add or remove space around assignment operator '=' in a prototype.
67sp_assign_default               = force   # ignore/add/remove/force
68
69# Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign.
70sp_before_assign                = ignore   # ignore/add/remove/force
71
72# Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign.
73sp_after_assign                 = ignore   # ignore/add/remove/force
74
75# Add or remove space in 'NS_ENUM ('.
76sp_enum_paren                   = ignore   # ignore/add/remove/force
77
78# Add or remove space around assignment '=' in enum.
79sp_enum_assign                  = ignore   # ignore/add/remove/force
80
81# Add or remove space before assignment '=' in enum. Overrides sp_enum_assign.
82sp_enum_before_assign           = ignore   # ignore/add/remove/force
83
84# Add or remove space after assignment '=' in enum. Overrides sp_enum_assign.
85sp_enum_after_assign            = ignore   # ignore/add/remove/force
86
87# Add or remove space around assignment ':' in enum.
88sp_enum_colon                   = ignore   # ignore/add/remove/force
89
90# Add or remove space around preprocessor '##' concatenation operator. Default=Add.
91sp_pp_concat                    = force      # ignore/add/remove/force
92
93# Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator.
94sp_pp_stringify                 = ignore   # ignore/add/remove/force
95
96# Add or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'.
97sp_before_pp_stringify          = ignore   # ignore/add/remove/force
98
99# Add or remove space around boolean operators '&&' and '||'.
100sp_bool                         = force   # ignore/add/remove/force
101
102# Add or remove space around compare operator '<', '>', '==', etc.
103sp_compare                      = force   # ignore/add/remove/force
104
105# Add or remove space inside '(' and ')'.
106sp_inside_paren                 = remove   # ignore/add/remove/force
107
108# Add or remove space between nested parens: '((' vs ') )'.
109sp_paren_paren                  = remove   # ignore/add/remove/force
110
111# Add or remove space between back-to-back parens: ')(' vs ') ('.
112sp_cparen_oparen                = ignore   # ignore/add/remove/force
113
114# Whether to balance spaces inside nested parens.
115sp_balance_nested_parens        = false    # false/true
116
117# Add or remove space between ')' and '{'.
118sp_paren_brace                  = force   # ignore/add/remove/force
119
120# Add or remove space before pointer star '*'.
121sp_before_ptr_star              = force   # ignore/add/remove/force
122
123# Add or remove space before pointer star '*' that isn't followed by a variable name
124# If set to 'ignore', sp_before_ptr_star is used instead.
125sp_before_unnamed_ptr_star      = ignore   # ignore/add/remove/force
126
127# Add or remove space between pointer stars '*'.
128sp_between_ptr_star             = remove   # ignore/add/remove/force
129
130# Add or remove space after pointer star '*', if followed by a word.
131sp_after_ptr_star               = remove   # ignore/add/remove/force
132
133# Add or remove space after pointer star '*', if followed by a qualifier.
134sp_after_ptr_star_qualifier     = remove   # ignore/add/remove/force
135
136# Add or remove space after a pointer star '*', if followed by a func proto/def.
137sp_after_ptr_star_func          = remove   # ignore/add/remove/force
138
139# Add or remove space after a pointer star '*', if followed by an open paren (function types).
140sp_ptr_star_paren               = remove   # ignore/add/remove/force
141
142# Add or remove space before a pointer star '*', if followed by a func proto/def.
143sp_before_ptr_star_func         = remove   # ignore/add/remove/force
144
145# Add or remove space before a reference sign '&'.
146sp_before_byref                 = force   # ignore/add/remove/force
147
148# Add or remove space before a reference sign '&' that isn't followed by a variable name.
149# If set to 'ignore', sp_before_byref is used instead.
150sp_before_unnamed_byref         = force   # ignore/add/remove/force
151
152# Add or remove space after reference sign '&', if followed by a word.
153sp_after_byref                  = remove   # ignore/add/remove/force
154
155# Add or remove space after a reference sign '&', if followed by a func proto/def.
156sp_after_byref_func             = remove   # ignore/add/remove/force
157
158# Add or remove space before a reference sign '&', if followed by a func proto/def.
159sp_before_byref_func            = remove   # ignore/add/remove/force
160
161# Add or remove space between type and word. Default=Force.
162sp_after_type                   = force    # ignore/add/remove/force
163
164# Add or remove space before the paren in the D constructs 'template Foo(' and 'class Foo('.
165sp_before_template_paren        = force   # ignore/add/remove/force
166
167# Add or remove space in 'template <' vs 'template<'.
168# If set to ignore, sp_before_angle is used.
169sp_template_angle               = remove   # ignore/add/remove/force
170
171# Add or remove space before '<>'.
172sp_before_angle                 = remove   # ignore/add/remove/force
173
174# Add or remove space inside '<' and '>'.
175sp_inside_angle                 = remove   # ignore/add/remove/force
176
177# Add or remove space between '<>' and ':'.
178sp_angle_colon                  = remove   # ignore/add/remove/force
179
180# Add or remove space after '<>'.
181sp_after_angle                  = force   # ignore/add/remove/force
182
183# Add or remove space between '<>' and '(' as found in 'new List<byte>(foo);'.
184sp_angle_paren                  = remove   # ignore/add/remove/force
185
186# Add or remove space between '<>' and '()' as found in 'new List<byte>();'.
187sp_angle_paren_empty            = remove   # ignore/add/remove/force
188
189# Add or remove space between '<>' and a word as in 'List<byte> m;' or 'template <typename T> static ...'.
190sp_angle_word                   = force   # ignore/add/remove/force
191
192# Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add.
193sp_angle_shift                  = force      # ignore/add/remove/force
194
195# Permit removal of the space between '>>' in 'foo<bar<int> >' (C++11 only). Default=False.
196# sp_angle_shift cannot remove the space without this option.
197sp_permit_cpp11_shift           = true    # false/true
198
199# Add or remove space before '(' of 'if', 'for', 'switch', 'while', etc.
200sp_before_sparen                = force   # ignore/add/remove/force
201
202# Add or remove space inside if-condition '(' and ')'.
203sp_inside_sparen                = remove   # ignore/add/remove/force
204
205# Add or remove space before if-condition ')'. Overrides sp_inside_sparen.
206sp_inside_sparen_close          = remove   # ignore/add/remove/force
207
208# Add or remove space after if-condition '('. Overrides sp_inside_sparen.
209sp_inside_sparen_open           = ignore   # ignore/add/remove/force
210
211# Add or remove space after ')' of 'if', 'for', 'switch', and 'while', etc.
212sp_after_sparen                 = ignore   # ignore/add/remove/force
213
214# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while', etc.
215sp_sparen_brace                 = force   # ignore/add/remove/force
216
217# Add or remove space between 'invariant' and '(' in the D language.
218sp_invariant_paren              = force   # ignore/add/remove/force
219
220# Add or remove space after the ')' in 'invariant (C) c' in the D language.
221sp_after_invariant_paren        = ignore   # ignore/add/remove/force
222
223# Add or remove space before empty statement ';' on 'if', 'for' and 'while'.
224sp_special_semi                 = remove   # ignore/add/remove/force
225
226# Add or remove space before ';'. Default=Remove.
227sp_before_semi                  = remove   # ignore/add/remove/force
228
229# Add or remove space before ';' in non-empty 'for' statements.
230sp_before_semi_for              = remove   # ignore/add/remove/force
231
232# Add or remove space before a semicolon of an empty part of a for statement.
233sp_before_semi_for_empty        = remove   # ignore/add/remove/force
234
235# Add or remove space after ';', except when followed by a comment. Default=Add.
236sp_after_semi                   = force      # ignore/add/remove/force
237
238# Add or remove space after ';' in non-empty 'for' statements. Default=Force.
239sp_after_semi_for               = force    # ignore/add/remove/force
240
241# Add or remove space after the final semicolon of an empty part of a for statement: for ( ; ; <here> ).
242sp_after_semi_for_empty         = force   # ignore/add/remove/force
243
244# Add or remove space before '[' (except '[]').
245sp_before_square                = remove   # ignore/add/remove/force
246
247# Add or remove space before '[]'.
248sp_before_squares               = force   # ignore/add/remove/force
249
250# Add or remove space inside a non-empty '[' and ']'.
251sp_inside_square                = remove   # ignore/add/remove/force
252
253# Add or remove space after ',', 'a,b' vs 'a, b'.
254sp_after_comma                  = force   # ignore/add/remove/force
255
256# Add or remove space before ','. Default=Remove.
257sp_before_comma                 = remove   # ignore/add/remove/force
258
259# Add or remove space between an open paren and comma: '(,' vs '( ,'. Default=Force.
260sp_paren_comma                  = force    # ignore/add/remove/force
261
262# Add or remove space before the variadic '...' when preceded by a non-punctuator.
263sp_before_ellipsis              = ignore   # ignore/add/remove/force
264
265# Add or remove space after class ':'.
266sp_after_class_colon            = ignore   # ignore/add/remove/force
267
268# Add or remove space before class ':'.
269sp_before_class_colon           = remove   # ignore/add/remove/force
270
271# Add or remove space after class constructor ':'.
272sp_after_constr_colon           = ignore   # ignore/add/remove/force
273
274# Add or remove space before class constructor ':'.
275sp_before_constr_colon          = remove   # ignore/add/remove/force
276
277# Add or remove space before case ':'. Default=Remove.
278sp_before_case_colon            = remove   # ignore/add/remove/force
279
280# Add or remove space between 'operator' and operator sign.
281sp_after_operator               = force   # ignore/add/remove/force
282
283# Add or remove space between the operator symbol and the open paren, as in 'operator ++('.
284sp_after_operator_sym           = force   # ignore/add/remove/force
285
286# Overrides sp_after_operator_sym when the operator has no arguments, as in 'operator *()'.
287sp_after_operator_sym_empty     = force   # ignore/add/remove/force
288
289# Add or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'.
290sp_after_cast                   = remove   # ignore/add/remove/force
291
292# Add or remove spaces inside cast parens.
293sp_inside_paren_cast            = remove   # ignore/add/remove/force
294
295# Add or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)'.
296sp_cpp_cast_paren               = remove   # ignore/add/remove/force
297
298# Add or remove space between 'sizeof' and '('.
299sp_sizeof_paren                 = remove   # ignore/add/remove/force
300
301# Add or remove space after the tag keyword (Pawn).
302sp_after_tag                    = force   # ignore/add/remove/force
303
304# Add or remove space inside enum '{' and '}'.
305sp_inside_braces_enum           = remove   # ignore/add/remove/force
306
307# Add or remove space inside struct/union '{' and '}'.
308sp_inside_braces_struct         = remove   # ignore/add/remove/force
309
310# Add or remove space after open brace in an unnamed temporary direct-list-initialization.
311sp_after_type_brace_init_lst_open = remove   # ignore/add/remove/force
312
313# Add or remove space before close brace in an unnamed temporary direct-list-initialization.
314sp_before_type_brace_init_lst_close = remove   # ignore/add/remove/force
315
316# Add or remove space inside an unnamed temporary direct-list-initialization.
317sp_inside_type_brace_init_lst   = remove   # ignore/add/remove/force
318
319# Add or remove space inside '{' and '}'.
320sp_inside_braces                = remove   # ignore/add/remove/force
321
322# Add or remove space inside '{}'.
323sp_inside_braces_empty          = remove   # ignore/add/remove/force
324
325# Add or remove space between return type and function name
326# A minimum of 1 is forced except for pointer return types.
327sp_type_func                    = force   # ignore/add/remove/force
328
329# Add or remove space between type and open brace of an unnamed temporary direct-list-initialization.
330sp_type_brace_init_lst          = force   # ignore/add/remove/force
331
332# Add or remove space between function name and '(' on function declaration.
333sp_func_proto_paren             = force   # ignore/add/remove/force
334
335# Add or remove space between function name and '()' on function declaration without parameters.
336sp_func_proto_paren_empty       = force   # ignore/add/remove/force
337
338# Add or remove space between function name and '(' on function definition.
339sp_func_def_paren               = force   # ignore/add/remove/force
340
341# Add or remove space between function name and '()' on function definition without parameters.
342sp_func_def_paren_empty         = force   # ignore/add/remove/force
343
344# Add or remove space inside empty function '()'.
345sp_inside_fparens               = remove   # ignore/add/remove/force
346
347# Add or remove space inside function '(' and ')'.
348sp_inside_fparen                = remove   # ignore/add/remove/force
349
350# Add or remove space inside the first parens in the function type: 'void (*x)(...)'.
351sp_inside_tparen                = remove   # ignore/add/remove/force
352
353# Add or remove between the parens in the function type: 'void (*x)(...)'.
354sp_after_tparen_close           = remove   # ignore/add/remove/force
355
356# Add or remove space between ']' and '(' when part of a function call.
357sp_square_fparen                = ignore   # ignore/add/remove/force
358
359# Add or remove space between ')' and '{' of function.
360sp_fparen_brace                 = force   # ignore/add/remove/force
361
362# Add or remove space between function name and '(' on function calls.
363sp_func_call_paren              = remove   # ignore/add/remove/force
364
365# Add or remove space between function name and '()' on function calls without parameters.
366# If set to 'ignore' (the default), sp_func_call_paren is used.
367sp_func_call_paren_empty        = remove   # ignore/add/remove/force
368
369# Add or remove space between the user function name and '(' on function calls
370# You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
371sp_func_call_user_paren         = remove   # ignore/add/remove/force
372
373# Add or remove space between a constructor/destructor and the open paren.
374sp_func_class_paren             = force   # ignore/add/remove/force
375
376# Add or remove space between a constructor without parameters or destructor and '()'.
377sp_func_class_paren_empty       = force   # ignore/add/remove/force
378
379# Add or remove space between 'return' and '('.
380sp_return_paren                 = force   # ignore/add/remove/force
381
382# Add or remove space between '__attribute__' and '('.
383sp_attribute_paren              = force   # ignore/add/remove/force
384
385# Add or remove space between 'defined' and '(' in '#if defined (FOO)'.
386sp_defined_paren                = force   # ignore/add/remove/force
387
388# Add or remove space between 'throw' and '(' in 'throw (something)'.
389sp_throw_paren                  = force   # ignore/add/remove/force
390
391# Add or remove space between 'throw' and anything other than '(' as in '@throw [...];'.
392sp_after_throw                  = force   # ignore/add/remove/force
393
394# Add or remove space between 'catch' and '(' in 'catch (something) { }'
395# If set to ignore, sp_before_sparen is used.
396sp_catch_paren                  = force   # ignore/add/remove/force
397
398# Add or remove space between 'version' and '(' in 'version (something) { }' (D language)
399# If set to ignore, sp_before_sparen is used.
400#sp_version_paren                = ignore   # ignore/add/remove/force
401
402# Add or remove space between 'scope' and '(' in 'scope (something) { }' (D language)
403# If set to ignore, sp_before_sparen is used.
404#sp_scope_paren                  = ignore   # ignore/add/remove/force
405
406# Add or remove space between 'super' and '(' in 'super (something)'. Default=Remove.
407sp_super_paren                  = remove   # ignore/add/remove/force
408
409# Add or remove space between 'this' and '(' in 'this (something)'. Default=Remove.
410sp_this_paren                   = remove   # ignore/add/remove/force
411
412# Add or remove space between macro and value.
413sp_macro                        = force   # ignore/add/remove/force
414
415# Add or remove space between macro function ')' and value.
416sp_macro_func                   = force   # ignore/add/remove/force
417
418# Add or remove space between 'else' and '{' if on the same line.
419sp_else_brace                   = force   # ignore/add/remove/force
420
421# Add or remove space between '}' and 'else' if on the same line.
422sp_brace_else                   = force   # ignore/add/remove/force
423
424# Add or remove space between '}' and the name of a typedef on the same line.
425sp_brace_typedef                = force   # ignore/add/remove/force
426
427# Add or remove space between 'catch' and '{' if on the same line.
428sp_catch_brace                  = force   # ignore/add/remove/force
429
430# Add or remove space between '}' and 'catch' if on the same line.
431sp_brace_catch                  = force   # ignore/add/remove/force
432
433# Add or remove space between 'finally' and '{' if on the same line.
434sp_finally_brace                = force   # ignore/add/remove/force
435
436# Add or remove space between '}' and 'finally' if on the same line.
437sp_brace_finally                = force   # ignore/add/remove/force
438
439# Add or remove space between 'try' and '{' if on the same line.
440sp_try_brace                    = force   # ignore/add/remove/force
441
442# Add or remove space between get/set and '{' if on the same line.
443sp_getset_brace                 = force   # ignore/add/remove/force
444
445# Add or remove space between a variable and '{' for C++ uniform initialization. Default=Add.
446sp_word_brace                   = force      # ignore/add/remove/force
447
448# Add or remove space between a variable and '{' for a namespace. Default=Add.
449sp_word_brace_ns                = force      # ignore/add/remove/force
450
451# Add or remove space before the '::' operator.
452sp_before_dc                    = remove   # ignore/add/remove/force
453
454# Add or remove space after the '::' operator.
455sp_after_dc                     = remove   # ignore/add/remove/force
456
457# Add or remove around the D named array initializer ':' operator.
458#sp_d_array_colon                = ignore   # ignore/add/remove/force
459
460# Add or remove space after the '!' (not) operator. Default=Remove.
461sp_not                          = remove   # ignore/add/remove/force
462
463# Add or remove space after the '~' (invert) operator. Default=Remove.
464sp_inv                          = remove   # ignore/add/remove/force
465
466# Add or remove space after the '&' (address-of) operator. Default=Remove
467# This does not affect the spacing after a '&' that is part of a type.
468sp_addr                         = remove   # ignore/add/remove/force
469
470# Add or remove space around the '.' or '->' operators. Default=Remove.
471sp_member                       = remove   # ignore/add/remove/force
472
473# Add or remove space after the '*' (dereference) operator. Default=Remove
474# This does not affect the spacing after a '*' that is part of a type.
475sp_deref                        = remove   # ignore/add/remove/force
476
477# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove.
478sp_sign                         = remove   # ignore/add/remove/force
479
480# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove.
481sp_incdec                       = remove   # ignore/add/remove/force
482
483# Add or remove space before a backslash-newline at the end of a line. Default=Add.
484sp_before_nl_cont               = add      # ignore/add/remove/force
485
486# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'.
487sp_after_oc_scope               = ignore   # ignore/add/remove/force
488
489# Add or remove space after the colon in message specs
490# '-(int) f:(int) x;' vs '-(int) f: (int) x;'.
491sp_after_oc_colon               = remove   # ignore/add/remove/force
492
493# Add or remove space before the colon in message specs
494# '-(int) f: (int) x;' vs '-(int) f : (int) x;'.
495sp_before_oc_colon              = remove   # ignore/add/remove/force
496
497# Add or remove space after the colon in immutable dictionary expression
498# 'NSDictionary *test = @{@"foo" :@"bar"};'.
499sp_after_oc_dict_colon          = remove   # ignore/add/remove/force
500
501# Add or remove space before the colon in immutable dictionary expression
502# 'NSDictionary *test = @{@"foo" :@"bar"};'.
503sp_before_oc_dict_colon         = remove   # ignore/add/remove/force
504
505# Add or remove space after the colon in message specs
506# '[object setValue:1];' vs '[object setValue: 1];'.
507sp_after_send_oc_colon          = force   # ignore/add/remove/force
508
509# Add or remove space before the colon in message specs
510# '[object setValue:1];' vs '[object setValue :1];'.
511sp_before_send_oc_colon         = remove   # ignore/add/remove/force
512
513# Add or remove space after the (type) in message specs
514# '-(int)f: (int) x;' vs '-(int)f: (int)x;'.
515sp_after_oc_type                = remove   # ignore/add/remove/force
516
517# Add or remove space after the first (type) in message specs
518# '-(int) f:(int)x;' vs '-(int)f:(int)x;'.
519sp_after_oc_return_type         = remove   # ignore/add/remove/force
520
521# Add or remove space between '@selector' and '('
522# '@selector(msgName)' vs '@selector (msgName)'
523# Also applies to @protocol() constructs.
524sp_after_oc_at_sel              = remove   # ignore/add/remove/force
525
526# Add or remove space between '@selector(x)' and the following word
527# '@selector(foo) a:' vs '@selector(foo)a:'.
528sp_after_oc_at_sel_parens       = force   # ignore/add/remove/force
529
530# Add or remove space inside '@selector' parens
531# '@selector(foo)' vs '@selector( foo )'
532# Also applies to @protocol() constructs.
533sp_inside_oc_at_sel_parens      = remove   # ignore/add/remove/force
534
535# Add or remove space before a block pointer caret
536# '^int (int arg){...}' vs. ' ^int (int arg){...}'.
537sp_before_oc_block_caret        = ignore   # ignore/add/remove/force
538
539# Add or remove space after a block pointer caret
540# '^int (int arg){...}' vs. '^ int (int arg){...}'.
541sp_after_oc_block_caret         = ignore   # ignore/add/remove/force
542
543# Add or remove space between the receiver and selector in a message.
544# '[receiver selector ...]'.
545sp_after_oc_msg_receiver        = force   # ignore/add/remove/force
546
547# Add or remove space after @property.
548sp_after_oc_property            = force   # ignore/add/remove/force
549
550# Add or remove space around the ':' in 'b ? t : f'.
551sp_cond_colon                   = force   # ignore/add/remove/force
552
553# Add or remove space before the ':' in 'b ? t : f'. Overrides sp_cond_colon.
554sp_cond_colon_before            = ignore   # ignore/add/remove/force
555
556# Add or remove space after the ':' in 'b ? t : f'. Overrides sp_cond_colon.
557sp_cond_colon_after             = ignore   # ignore/add/remove/force
558
559# Add or remove space around the '?' in 'b ? t : f'.
560sp_cond_question                = force   # ignore/add/remove/force
561
562# Add or remove space before the '?' in 'b ? t : f'. Overrides sp_cond_question.
563sp_cond_question_before         = ignore   # ignore/add/remove/force
564
565# Add or remove space after the '?' in 'b ? t : f'. Overrides sp_cond_question.
566sp_cond_question_after          = ignore   # ignore/add/remove/force
567
568# In the abbreviated ternary form (a ?: b), add/remove space between ? and :.'. Overrides all other sp_cond_* options.
569sp_cond_ternary_short           = remove   # ignore/add/remove/force
570
571# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
572sp_case_label                   = ignore   # ignore/add/remove/force
573
574# Control the space around the D '..' operator.
575#sp_range                        = ignore   # ignore/add/remove/force
576
577# Control the spacing after ':' in 'for (TYPE VAR : EXPR)'. Only JAVA.
578#sp_after_for_colon              = ignore   # ignore/add/remove/force
579
580# Control the spacing before ':' in 'for (TYPE VAR : EXPR)'. Only JAVA.
581#sp_before_for_colon             = ignore   # ignore/add/remove/force
582
583# Control the spacing in 'extern (C)' (D).
584#sp_extern_paren                 = ignore   # ignore/add/remove/force
585
586# Control the space after the opening of a C++ comment '// A' vs '//A'.
587sp_cmt_cpp_start                = force   # ignore/add/remove/force
588
589# True: If space is added with sp_cmt_cpp_start, do it after doxygen sequences like '///', '///<', '//!' and '//!<'.
590sp_cmt_cpp_doxygen              = true    # false/true
591
592# True: If space is added with sp_cmt_cpp_start, do it after Qt translator or meta-data comments like '//:', '//=', and '//~'.
593sp_cmt_cpp_qttr                 = true    # false/true
594
595# Controls the spaces between #else or #endif and a trailing comment.
596sp_endif_cmt                    = ignore   # ignore/add/remove/force
597
598# Controls the spaces after 'new', 'delete' and 'delete[]'.
599sp_after_new                    = force   # ignore/add/remove/force
600
601# Controls the spaces between new and '(' in 'new()'.
602sp_between_new_paren            = remove   # ignore/add/remove/force
603
604# Controls the spaces between ')' and 'type' in 'new(foo) BAR'.
605sp_after_newop_paren            = force   # ignore/add/remove/force
606
607# Controls the spaces inside paren of the new operator: 'new(foo) BAR'.
608sp_inside_newop_paren           = remove   # ignore/add/remove/force
609
610# Controls the space after open paren of the new operator: 'new(foo) BAR'.
611# Overrides sp_inside_newop_paren.
612sp_inside_newop_paren_open      = ignore   # ignore/add/remove/force
613
614# Controls the space before close paren of the new operator: 'new(foo) BAR'.
615# Overrides sp_inside_newop_paren.
616sp_inside_newop_paren_close     = ignore   # ignore/add/remove/force
617
618# Controls the spaces before a trailing or embedded comment.
619sp_before_tr_emb_cmt            = force   # ignore/add/remove/force
620
621# Number of spaces before a trailing or embedded comment.
622sp_num_before_tr_emb_cmt        = 0        # unsigned number
623
624# Control space between a Java annotation and the open paren.
625sp_annotation_paren             = ignore   # ignore/add/remove/force
626
627# If True, vbrace tokens are dropped to the previous token and skipped.
628sp_skip_vbrace_tokens           = false    # false/true
629
630# If True, a <TAB> is inserted after #define.
631force_tab_after_define          = false    # false/true
632
633#
634# Indenting
635#
636
637# The number of columns to indent per level.
638# Usually 2, 3, 4, or 8. Default=8.
639indent_columns                  = output_tab_size        # unsigned number
640
641# The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents.
642# For FreeBSD, this is set to 4. Negative value is absolute and not increased for each '(' level.
643indent_continue                 = 0        # number
644
645# The continuation indent for func_*_param if they are true.
646# If non-zero, this overrides the indent.
647indent_param                    = 0        # unsigned number
648
649# How to use tabs when indenting code
650# 0=spaces only
651# 1=indent with tabs to brace level, align with spaces (default)
652# 2=indent and align with tabs, using spaces when not on a tabstop
653indent_with_tabs                = 1        # unsigned number
654
655# Comments that are not a brace level are indented with tabs on a tabstop.
656# Requires indent_with_tabs=2. If false, will use spaces.
657indent_cmt_with_tabs            = true    # false/true
658
659# Whether to indent strings broken by '\' so that they line up.
660indent_align_string             = true    # false/true
661
662# The number of spaces to indent multi-line XML strings.
663# Requires indent_align_string=True.
664indent_xml_string               = 0        # unsigned number
665
666# Spaces to indent '{' from level.
667indent_brace                    = 0        # unsigned number
668
669# Whether braces are indented to the body level.
670indent_braces                   = false    # false/true
671
672# Disabled indenting function braces if indent_braces is True.
673indent_braces_no_func           = true    # false/true
674
675# Disabled indenting class braces if indent_braces is True.
676indent_braces_no_class          = false    # false/true
677
678# Disabled indenting struct braces if indent_braces is True.
679indent_braces_no_struct         = false    # false/true
680
681# Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
682indent_brace_parent             = false    # false/true
683
684# Indent based on the paren open instead of the brace open in '({\n', default is to indent by brace.
685indent_paren_open_brace         = false    # false/true
686
687# indent a C# delegate by another level, default is to not indent by another level.
688indent_cs_delegate_brace        = false    # false/true
689
690# Whether the 'namespace' body is indented.
691indent_namespace                = true    # false/true
692
693# Only indent one namespace and no sub-namespaces.
694# Requires indent_namespace=True.
695indent_namespace_single_indent  = false    # false/true
696
697# The number of spaces to indent a namespace block.
698indent_namespace_level          = 0        # unsigned number
699
700# If the body of the namespace is longer than this number, it won't be indented.
701# Requires indent_namespace=True. Default=0 (no limit)
702indent_namespace_limit          = 0        # unsigned number
703
704# Whether the 'extern "C"' body is indented.
705indent_extern                   = true    # false/true
706
707# Whether the 'class' body is indented.
708indent_class                    = true    # false/true
709
710# Whether to indent the stuff after a leading base class colon.
711indent_class_colon              = true    # false/true
712
713# Indent based on a class colon instead of the stuff after the colon.
714# Requires indent_class_colon=True. Default=False.
715indent_class_on_colon           = false    # false/true
716
717# Whether to indent the stuff after a leading class initializer colon.
718indent_constr_colon             = false    # false/true
719
720# Virtual indent from the ':' for member initializers. Default=2.
721indent_ctor_init_leading        = 2        # unsigned number
722
723# Additional indent for constructor initializer list.
724# Negative values decrease indent down to the first column. Default=0.
725indent_ctor_init                = 0        # number
726
727# False=treat 'else\nif' as 'else if' for indenting purposes
728# True=indent the 'if' one level.
729indent_else_if                  = false    # false/true
730
731# Amount to indent variable declarations after a open brace. neg=relative, pos=absolute.
732indent_var_def_blk              = 0        # number
733
734# Indent continued variable declarations instead of aligning.
735indent_var_def_cont             = false    # false/true
736
737# Indent continued shift expressions ('<<' and '>>') instead of aligning.
738# Turn align_left_shift off when enabling this.
739indent_shift                    = false    # false/true
740
741# True:  force indentation of function definition to start in column 1
742# False: use the default behavior.
743indent_func_def_force_col1      = false    # false/true
744
745# True:  indent continued function call parameters one indent level
746# False: align parameters under the open paren.
747indent_func_call_param          = false    # false/true
748
749# Same as indent_func_call_param, but for function defs.
750indent_func_def_param           = false    # false/true
751
752# Same as indent_func_call_param, but for function protos.
753indent_func_proto_param         = false    # false/true
754
755# Same as indent_func_call_param, but for class declarations.
756indent_func_class_param         = false    # false/true
757
758# Same as indent_func_call_param, but for class variable constructors.
759indent_func_ctor_var_param      = false    # false/true
760
761# Same as indent_func_call_param, but for templates.
762indent_template_param           = false    # false/true
763
764# Double the indent for indent_func_xxx_param options.
765# Use both values of the options indent_columns and indent_param.
766indent_func_param_double        = false    # false/true
767
768# Indentation column for standalone 'const' function decl/proto qualifier.
769indent_func_const               = 0        # unsigned number
770
771# Indentation column for standalone 'throw' function decl/proto qualifier.
772indent_func_throw               = 0        # unsigned number
773
774# The number of spaces to indent a continued '->' or '.'
775# Usually set to 0, 1, or indent_columns.
776indent_member                   = 0        # unsigned number
777
778# Spaces to indent single line ('//') comments on lines before code.
779indent_sing_line_comments       = 0        # unsigned number
780
781# If set, will indent trailing single line ('//') comments relative
782# to the code instead of trying to keep the same absolute column.
783indent_relative_single_line_comments = true    # false/true
784
785# Spaces to indent 'case' from 'switch'
786# Usually 0 or indent_columns.
787indent_switch_case              = 0        # unsigned number
788
789# Whether to indent preproccesor statements inside of switch statements.
790indent_switch_pp                = true     # false/true
791
792# Spaces to shift the 'case' line, without affecting any other lines
793# Usually 0.
794indent_case_shift               = 0        # unsigned number
795
796# Spaces to indent '{' from 'case'.
797# By default, the brace will appear under the 'c' in case.
798# Usually set to 0 or indent_columns.
799# negative value are OK.
800indent_case_brace               = 0        # number
801
802# Whether to indent comments found in first column.
803indent_col1_comment             = false    # false/true
804
805# How to indent goto labels
806#   >0: absolute column where 1 is the leftmost column
807#  <=0: subtract from brace indent
808# Default=1
809indent_label                    = 1        # number
810
811# Same as indent_label, but for access specifiers that are followed by a colon. Default=1
812indent_access_spec              = 1        # number
813
814# Indent the code after an access specifier by one level.
815# If set, this option forces 'indent_access_spec=0'.
816indent_access_spec_body         = true    # false/true
817
818# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended).
819indent_paren_nl                 = false    # false/true
820
821# Controls the indent of a close paren after a newline.
822# 0: Indent to body level
823# 1: Align under the open paren
824# 2: Indent to the brace level
825indent_paren_close              = 0        # unsigned number
826
827# Controls the indent of the open paren of a function definition, if on it's own line.If True, indents the open paren
828indent_paren_after_func_def     = false    # false/true
829
830# Controls the indent of the open paren of a function declaration, if on it's own line.If True, indents the open paren
831indent_paren_after_func_decl    = false    # false/true
832
833# Controls the indent of the open paren of a function call, if on it's own line.If True, indents the open paren
834indent_paren_after_func_call    = false    # false/true
835
836# Controls the indent of a comma when inside a paren.If True, aligns under the open paren.
837indent_comma_paren              = false    # false/true
838
839# Controls the indent of a BOOL operator when inside a paren.If True, aligns under the open paren.
840indent_bool_paren               = false    # false/true
841
842# If 'indent_bool_paren' is True, controls the indent of the first expression. If True, aligns the first expression to the following ones.
843indent_first_bool_expr          = false    # false/true
844
845# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended).
846indent_square_nl                = false    # false/true
847
848# Don't change the relative indent of ESQL/C 'EXEC SQL' bodies.
849indent_preserve_sql             = false    # false/true
850
851# Align continued statements at the '='. Default=True
852# If False or the '=' is followed by a newline, the next line is indent one tab.
853indent_align_assign             = true     # false/true
854
855# Indent OC blocks at brace level instead of usual rules.
856indent_oc_block                 = false    # false/true
857
858# Indent OC blocks in a message relative to the parameter name.
859# 0=use indent_oc_block rules, 1+=spaces to indent
860indent_oc_block_msg             = 0        # unsigned number
861
862# Minimum indent for subsequent parameters
863indent_oc_msg_colon             = 0        # unsigned number
864
865# If True, prioritize aligning with initial colon (and stripping spaces from lines, if necessary).
866# Default=True.
867indent_oc_msg_prioritize_first_colon = true     # false/true
868
869# If indent_oc_block_msg and this option are on, blocks will be indented the way that Xcode does by default (from keyword if the parameter is on its own line; otherwise, from the previous indentation level).
870indent_oc_block_msg_xcode_style = false    # false/true
871
872# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is relative to a msg keyword.
873indent_oc_block_msg_from_keyword = false    # false/true
874
875# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is relative to a msg colon.
876indent_oc_block_msg_from_colon  = false    # false/true
877
878# If indent_oc_block_msg and this option are on, blocks will be indented from where the block caret is.
879indent_oc_block_msg_from_caret  = false    # false/true
880
881# If indent_oc_block_msg and this option are on, blocks will be indented from where the brace is.
882indent_oc_block_msg_from_brace  = false    # false/true
883
884# When identing after virtual brace open and newline add further spaces to reach this min. indent.
885indent_min_vbrace_open          = 0        # unsigned number
886
887# True: When identing after virtual brace open and newline add further spaces after regular indent to reach next tabstop.
888indent_vbrace_open_on_tabstop   = false    # false/true
889
890# If True, a brace followed by another token (not a newline) will indent all contained lines to match the token.Default=True.
891indent_token_after_brace        = true     # false/true
892
893# If True, cpp lambda body will be indentedDefault=False.
894indent_cpp_lambda_body          = false    # false/true
895
896# indent (or not) an using block if no braces are used. Only for C#.Default=True.
897indent_using_block              = true     # false/true
898
899# indent the continuation of ternary operator.
900# 0: (Default) off
901# 1: When the `if_false` is a continuation, indent it under `if_false`
902# 2: When the `:` is a continuation, indent it under `?`
903indent_ternary_operator         = 0        # unsigned number
904
905# If true, ignore indent and align for asm blocks as they have their own indentation.
906indent_ignore_asm_block         = false    # false/true
907
908#
909# Newline adding and removing options
910#
911
912# Whether to collapse empty blocks between '{' and '}'.
913nl_collapse_empty_body          = true    # false/true
914
915# Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'.
916nl_assign_leave_one_liners      = true    # false/true
917
918# Don't split one-line braced statements inside a class xx { } body.
919nl_class_leave_one_liners       = true    # false/true
920
921# Don't split one-line enums: 'enum foo { BAR = 15 };'
922nl_enum_leave_one_liners        = true    # false/true
923
924# Don't split one-line get or set functions.
925nl_getset_leave_one_liners      = true    # false/true
926
927# Don't split one-line function definitions - 'int foo() { return 0; }'.
928nl_func_leave_one_liners        = true    # false/true
929
930# Don't split one-line C++11 lambdas - '[]() { return 0; }'.
931nl_cpp_lambda_leave_one_liners  = true    # false/true
932
933# Don't split one-line if/else statements - 'if(a) b++;'.
934nl_if_leave_one_liners          = true    # false/true
935
936# Don't split one-line while statements - 'while(a) b++;'.
937nl_while_leave_one_liners       = true    # false/true
938
939# Don't split one-line OC messages.
940nl_oc_msg_leave_one_liner       = true    # false/true
941
942# Add or remove newline between Objective-C block signature and '{'.
943nl_oc_block_brace               = ignore   # ignore/add/remove/force
944
945# Add or remove newlines at the start of the file.
946nl_start_of_file                = remove   # ignore/add/remove/force
947
948# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'.
949nl_start_of_file_min            = 0        # unsigned number
950
951# Add or remove newline at the end of the file.
952nl_end_of_file                  = force   # ignore/add/remove/force
953
954# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force').
955nl_end_of_file_min              = 2        # unsigned number
956
957# Add or remove newline between '=' and '{'.
958nl_assign_brace                 = remove   # ignore/add/remove/force
959
960# The number of blank lines after a block of variable definitions at the top of a function body
961# 0 = No change (default).
962nl_func_var_def_blk             = 1        # unsigned number
963
964# The number of newlines before a block of typedefs
965# 0 = No change (default)
966# is overridden by the option 'nl_after_access_spec'.
967nl_typedef_blk_start            = 1        # unsigned number
968
969# The number of newlines after a block of typedefs
970# 0 = No change (default).
971nl_typedef_blk_end              = 1        # unsigned number
972
973# The maximum consecutive newlines within a block of typedefs
974# 0 = No change (default).
975nl_typedef_blk_in               = 1        # unsigned number
976
977# The number of newlines before a block of variable definitions not at the top of a function body
978# 0 = No change (default)
979# is overridden by the option 'nl_after_access_spec'.
980nl_var_def_blk_start            = 0        # unsigned number
981
982# The number of newlines after a block of variable definitions not at the top of a function body
983# 0 = No change (default).
984nl_var_def_blk_end              = 0        # unsigned number
985
986# The maximum consecutive newlines within a block of variable definitions
987# 0 = No change (default).
988nl_var_def_blk_in               = 1        # unsigned number
989
990# Add or remove newline between a function call's ')' and '{', as in:
991# list_for_each(item, &list) { }.
992nl_fcall_brace                  = remove   # ignore/add/remove/force
993
994# Add or remove newline between 'enum' and '{'.
995nl_enum_brace                   = ignore   # ignore/add/remove/force
996
997# Add or remove newline between 'enum' and 'class'.
998nl_enum_class                   = ignore   # ignore/add/remove/force
999
1000# Add or remove newline between 'enum class' and the identifier.
1001nl_enum_class_identifier        = ignore   # ignore/add/remove/force
1002
1003# Add or remove newline between 'enum class' type and ':'.
1004nl_enum_identifier_colon        = ignore   # ignore/add/remove/force
1005
1006# Add or remove newline between 'enum class identifier :' and 'type' and/or 'type'.
1007nl_enum_colon_type              = ignore   # ignore/add/remove/force
1008
1009# Add or remove newline between 'struct and '{'.
1010nl_struct_brace                 = ignore   # ignore/add/remove/force
1011
1012# Add or remove newline between 'union' and '{'.
1013nl_union_brace                  = ignore   # ignore/add/remove/force
1014
1015# Add or remove newline between 'if' and '{'.
1016nl_if_brace                     = remove   # ignore/add/remove/force
1017
1018# Add or remove newline between '}' and 'else'.
1019nl_brace_else                   = remove   # ignore/add/remove/force
1020
1021# Add or remove newline between 'else if' and '{'
1022# If set to ignore, nl_if_brace is used instead.
1023nl_elseif_brace                 = remove   # ignore/add/remove/force
1024
1025# Add or remove newline between 'else' and '{'.
1026nl_else_brace                   = remove   # ignore/add/remove/force
1027
1028# Add or remove newline between 'else' and 'if'.
1029nl_else_if                      = remove   # ignore/add/remove/force
1030
1031# Add or remove newline before 'if'/'else if' closing parenthesis.
1032nl_before_if_closing_paren      = remove   # ignore/add/remove/force
1033
1034# Add or remove newline between '}' and 'finally'.
1035nl_brace_finally                = remove   # ignore/add/remove/force
1036
1037# Add or remove newline between 'finally' and '{'.
1038nl_finally_brace                = remove   # ignore/add/remove/force
1039
1040# Add or remove newline between 'try' and '{'.
1041nl_try_brace                    = remove   # ignore/add/remove/force
1042
1043# Add or remove newline between get/set and '{'.
1044nl_getset_brace                 = remove   # ignore/add/remove/force
1045
1046# Add or remove newline between 'for' and '{'.
1047nl_for_brace                    = remove   # ignore/add/remove/force
1048
1049# Add or remove newline between 'catch' and '{'.
1050nl_catch_brace                  = remove   # ignore/add/remove/force
1051
1052# Add or remove newline between '}' and 'catch'.
1053nl_brace_catch                  = remove   # ignore/add/remove/force
1054
1055# Add or remove newline between '}' and ']'.
1056nl_brace_square                 = ignore   # ignore/add/remove/force
1057
1058# Add or remove newline between '}' and ')' in a function invocation.
1059nl_brace_fparen                 = ignore   # ignore/add/remove/force
1060
1061# Add or remove newline between 'while' and '{'.
1062nl_while_brace                  = remove   # ignore/add/remove/force
1063
1064# Add or remove newline between 'using' and '{'.
1065nl_using_brace                  = ignore   # ignore/add/remove/force
1066
1067# Add or remove newline between two open or close braces.
1068# Due to general newline/brace handling, REMOVE may not work.
1069nl_brace_brace                  = ignore   # ignore/add/remove/force
1070
1071# Add or remove newline between 'do' and '{'.
1072nl_do_brace                     = remove   # ignore/add/remove/force
1073
1074# Add or remove newline between '}' and 'while' of 'do' statement.
1075nl_brace_while                  = remove   # ignore/add/remove/force
1076
1077# Add or remove newline between 'switch' and '{'.
1078nl_switch_brace                 = remove   # ignore/add/remove/force
1079
1080# Add or remove newline between 'synchronized' and '{'.
1081nl_synchronized_brace           = ignore   # ignore/add/remove/force
1082
1083# Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc.
1084# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch and nl_catch_brace.
1085nl_multi_line_cond              = false    # false/true
1086
1087# Force a newline in a define after the macro name for multi-line defines.
1088nl_multi_line_define            = false    # false/true
1089
1090# Whether to put a newline before 'case' statement, not after the first 'case'.
1091nl_before_case                  = false    # false/true
1092
1093# Add or remove newline between ')' and 'throw'.
1094nl_before_throw                 = ignore   # ignore/add/remove/force
1095
1096# Whether to put a newline after 'case' statement.
1097nl_after_case                   = false    # false/true
1098
1099# Add or remove a newline between a case ':' and '{'. Overrides nl_after_case.
1100nl_case_colon_brace             = ignore   # ignore/add/remove/force
1101
1102# Newline between namespace and {.
1103nl_namespace_brace              = ignore   # ignore/add/remove/force
1104
1105# Add or remove newline between 'template<>' and whatever follows.
1106nl_template_class               = ignore   # ignore/add/remove/force
1107
1108# Add or remove newline between 'class' and '{'.
1109nl_class_brace                  = ignore   # ignore/add/remove/force
1110
1111# Add or remove newline before/after each ',' in the base class list,
1112#   (tied to pos_class_comma).
1113nl_class_init_args              = ignore   # ignore/add/remove/force
1114
1115# Add or remove newline after each ',' in the constructor member initialization.
1116# Related to nl_constr_colon, pos_constr_colon and pos_constr_comma.
1117nl_constr_init_args             = ignore   # ignore/add/remove/force
1118
1119# Add or remove newline before first element, after comma, and after last element in enum.
1120nl_enum_own_lines               = ignore   # ignore/add/remove/force
1121
1122# Add or remove newline between return type and function name in a function definition.
1123nl_func_type_name               = ignore   # ignore/add/remove/force
1124
1125# Add or remove newline between return type and function name inside a class {}
1126# Uses nl_func_type_name or nl_func_proto_type_name if set to ignore.
1127nl_func_type_name_class         = ignore   # ignore/add/remove/force
1128
1129# Add or remove newline between class specification and '::' in 'void A::f() { }'
1130# Only appears in separate member implementation (does not appear with in-line implmementation).
1131nl_func_class_scope             = ignore   # ignore/add/remove/force
1132
1133# Add or remove newline between function scope and name
1134# Controls the newline after '::' in 'void A::f() { }'.
1135nl_func_scope_name              = ignore   # ignore/add/remove/force
1136
1137# Add or remove newline between return type and function name in a prototype.
1138nl_func_proto_type_name         = ignore   # ignore/add/remove/force
1139
1140# Add or remove newline between a function name and the opening '(' in the declaration.
1141nl_func_paren                   = ignore   # ignore/add/remove/force
1142
1143# Overrides nl_func_paren for functions with no parameters.
1144nl_func_paren_empty             = ignore   # ignore/add/remove/force
1145
1146# Add or remove newline between a function name and the opening '(' in the definition.
1147nl_func_def_paren               = ignore   # ignore/add/remove/force
1148
1149# Overrides nl_func_def_paren for functions with no parameters.
1150nl_func_def_paren_empty         = ignore   # ignore/add/remove/force
1151
1152# Add or remove newline between a function name and the opening '(' in the call
1153nl_func_call_paren              = ignore   # ignore/add/remove/force
1154
1155# Overrides nl_func_call_paren for functions with no parameters.
1156nl_func_call_paren_empty        = ignore   # ignore/add/remove/force
1157
1158# Add or remove newline after '(' in a function declaration.
1159nl_func_decl_start              = ignore   # ignore/add/remove/force
1160
1161# Add or remove newline after '(' in a function definition.
1162nl_func_def_start               = ignore   # ignore/add/remove/force
1163
1164# Overrides nl_func_decl_start when there is only one parameter.
1165nl_func_decl_start_single       = ignore   # ignore/add/remove/force
1166
1167# Overrides nl_func_def_start when there is only one parameter.
1168nl_func_def_start_single        = ignore   # ignore/add/remove/force
1169
1170# Whether to add newline after '(' in a function declaration if '(' and ')' are in different lines.
1171nl_func_decl_start_multi_line   = false    # false/true
1172
1173# Whether to add newline after '(' in a function definition if '(' and ')' are in different lines.
1174nl_func_def_start_multi_line    = false    # false/true
1175
1176# Add or remove newline after each ',' in a function declaration.
1177nl_func_decl_args               = ignore   # ignore/add/remove/force
1178
1179# Add or remove newline after each ',' in a function definition.
1180nl_func_def_args                = ignore   # ignore/add/remove/force
1181
1182# Whether to add newline after each ',' in a function declaration if '(' and ')' are in different lines.
1183nl_func_decl_args_multi_line    = false    # false/true
1184
1185# Whether to add newline after each ',' in a function definition if '(' and ')' are in different lines.
1186nl_func_def_args_multi_line     = false    # false/true
1187
1188# Add or remove newline before the ')' in a function declaration.
1189nl_func_decl_end                = ignore   # ignore/add/remove/force
1190
1191# Add or remove newline before the ')' in a function definition.
1192nl_func_def_end                 = remove   # ignore/add/remove/force
1193
1194# Overrides nl_func_decl_end when there is only one parameter.
1195nl_func_decl_end_single         = ignore   # ignore/add/remove/force
1196
1197# Overrides nl_func_def_end when there is only one parameter.
1198nl_func_def_end_single          = ignore   # ignore/add/remove/force
1199
1200# Whether to add newline before ')' in a function declaration if '(' and ')' are in different lines.
1201nl_func_decl_end_multi_line     = false    # false/true
1202
1203# Whether to add newline before ')' in a function definition if '(' and ')' are in different lines.
1204nl_func_def_end_multi_line      = false    # false/true
1205
1206# Add or remove newline between '()' in a function declaration.
1207nl_func_decl_empty              = ignore   # ignore/add/remove/force
1208
1209# Add or remove newline between '()' in a function definition.
1210nl_func_def_empty               = ignore   # ignore/add/remove/force
1211
1212# Add or remove newline between '()' in a function call.
1213nl_func_call_empty              = ignore   # ignore/add/remove/force
1214
1215# Whether to add newline after '(' in a function call if '(' and ')' are in different lines.
1216nl_func_call_start_multi_line   = false    # false/true
1217
1218# Whether to add newline after each ',' in a function call if '(' and ')' are in different lines.
1219nl_func_call_args_multi_line    = false    # false/true
1220
1221# Whether to add newline before ')' in a function call if '(' and ')' are in different lines.
1222nl_func_call_end_multi_line     = false    # false/true
1223
1224# Whether to put each OC message parameter on a separate line
1225# See nl_oc_msg_leave_one_liner.
1226nl_oc_msg_args                  = false    # false/true
1227
1228# Add or remove newline between function signature and '{'.
1229nl_fdef_brace                   = remove   # ignore/add/remove/force
1230
1231# Add or remove newline between C++11 lambda signature and '{'.
1232nl_cpp_ldef_brace               = ignore   # ignore/add/remove/force
1233
1234# Add or remove a newline between the return keyword and return expression.
1235nl_return_expr                  = ignore   # ignore/add/remove/force
1236
1237# Whether to put a newline after semicolons, except in 'for' statements.
1238nl_after_semicolon              = true    # false/true
1239
1240# Whether to put a newline after the type in an unnamed temporary direct-list-initialization.
1241nl_type_brace_init_lst          = ignore   # ignore/add/remove/force
1242
1243# Whether to put a newline after open brace in an unnamed temporary direct-list-initialization.
1244nl_type_brace_init_lst_open     = ignore   # ignore/add/remove/force
1245
1246# Whether to put a newline before close brace in an unnamed temporary direct-list-initialization.
1247nl_type_brace_init_lst_close    = ignore   # ignore/add/remove/force
1248
1249# Whether to put a newline after brace open.
1250# This also adds a newline before the matching brace close.
1251nl_after_brace_open             = false    # false/true
1252
1253# If nl_after_brace_open and nl_after_brace_open_cmt are True, a newline is
1254# placed between the open brace and a trailing single-line comment.
1255nl_after_brace_open_cmt         = false    # false/true
1256
1257# Whether to put a newline after a virtual brace open with a non-empty body.
1258# These occur in un-braced if/while/do/for statement bodies.
1259nl_after_vbrace_open            = false    # false/true
1260
1261# Whether to put a newline after a virtual brace open with an empty body.
1262# These occur in un-braced if/while/do/for statement bodies.
1263nl_after_vbrace_open_empty      = false    # false/true
1264
1265# Whether to put a newline after a brace close.
1266# Does not apply if followed by a necessary ';'.
1267nl_after_brace_close            = false    # false/true
1268
1269# Whether to put a newline after a virtual brace close.
1270# Would add a newline before return in: 'if (foo) a++; return;'.
1271nl_after_vbrace_close           = false    # false/true
1272
1273# Control the newline between the close brace and 'b' in: 'struct { int a; } b;'
1274# Affects enums, unions and structures. If set to ignore, uses nl_after_brace_close.
1275nl_brace_struct_var             = ignore   # ignore/add/remove/force
1276
1277# Whether to alter newlines in '#define' macros.
1278nl_define_macro                 = false    # false/true
1279
1280# Whether to remove blanks after '#ifxx' and '#elxx', or before '#elxx' and '#endif'. Does not affect top-level #ifdefs.
1281nl_squeeze_ifdef                = false    # false/true
1282
1283# Makes the nl_squeeze_ifdef option affect the top-level #ifdefs as well.
1284nl_squeeze_ifdef_top_level      = false    # false/true
1285
1286# Add or remove blank line before 'if'.
1287nl_before_if                    = ignore   # ignore/add/remove/force
1288
1289# Add or remove blank line after 'if' statement.
1290# Add/Force work only if the next token is not a closing brace.
1291nl_after_if                     = force   # ignore/add/remove/force
1292
1293# Add or remove blank line before 'for'.
1294nl_before_for                   = force   # ignore/add/remove/force
1295
1296# Add or remove blank line after 'for' statement.
1297nl_after_for                    = force   # ignore/add/remove/force
1298
1299# Add or remove blank line before 'while'.
1300nl_before_while                 = force   # ignore/add/remove/force
1301
1302# Add or remove blank line after 'while' statement.
1303nl_after_while                  = force   # ignore/add/remove/force
1304
1305# Add or remove blank line before 'switch'.
1306nl_before_switch                = force   # ignore/add/remove/force
1307
1308# Add or remove blank line after 'switch' statement.
1309nl_after_switch                 = force   # ignore/add/remove/force
1310
1311# Add or remove blank line before 'synchronized'.
1312nl_before_synchronized          = force   # ignore/add/remove/force
1313
1314# Add or remove blank line after 'synchronized' statement.
1315nl_after_synchronized           = force   # ignore/add/remove/force
1316
1317# Add or remove blank line before 'do'.
1318nl_before_do                    = force   # ignore/add/remove/force
1319
1320# Add or remove blank line after 'do/while' statement.
1321nl_after_do                     = force   # ignore/add/remove/force
1322
1323# Whether to double-space commented-entries in struct/union/enum.
1324nl_ds_struct_enum_cmt           = false    # false/true
1325
1326# force nl before } of a struct/union/enum
1327# (lower priority than 'eat_blanks_before_close_brace').
1328nl_ds_struct_enum_close_brace   = false    # false/true
1329
1330# Add or remove blank line before 'func_class_def'.
1331nl_before_func_class_def        = 0        # unsigned number
1332
1333# Add or remove blank line before 'func_class_proto'.
1334nl_before_func_class_proto      = 0        # unsigned number
1335
1336# Add or remove a newline before/after a class colon,
1337#   (tied to pos_class_colon).
1338nl_class_colon                  = ignore   # ignore/add/remove/force
1339
1340# Add or remove a newline around a class constructor colon.
1341# Related to nl_constr_init_args, pos_constr_colon and pos_constr_comma.
1342nl_constr_colon                 = ignore   # ignore/add/remove/force
1343
1344# Change simple unbraced if statements into a one-liner
1345# 'if(b)\n i++;' => 'if(b) i++;'.
1346nl_create_if_one_liner          = false    # false/true
1347
1348# Change simple unbraced for statements into a one-liner
1349# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'.
1350nl_create_for_one_liner         = false    # false/true
1351
1352# Change simple unbraced while statements into a one-liner
1353# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'.
1354nl_create_while_one_liner       = false    # false/true
1355
1356#  Change a one-liner if statement into simple unbraced if
1357# 'if(b) i++;' => 'if(b)\n i++;'.
1358nl_split_if_one_liner           = false    # false/true
1359
1360# Change a one-liner for statement into simple unbraced for
1361# 'for (i=0;<5;i++) foo(i);' => 'for (i=0;<5;i++)\n foo(i);'.
1362nl_split_for_one_liner          = false    # false/true
1363
1364# Change a one-liner while statement into simple unbraced while
1365# 'while (i<5) foo(i++);' => 'while (i<5)\n foo(i++);'.
1366nl_split_while_one_liner        = false    # false/true
1367
1368#
1369# Blank line options
1370#
1371
1372# The maximum consecutive newlines (3 = 2 blank lines).
1373nl_max                          = 2        # unsigned number
1374
1375# The maximum consecutive newlines in function.
1376nl_max_blank_in_func            = 0        # unsigned number
1377
1378# The number of newlines after a function prototype, if followed by another function prototype.
1379nl_after_func_proto             = 0        # unsigned number
1380
1381# The number of newlines after a function prototype, if not followed by another function prototype.
1382nl_after_func_proto_group       = 0        # unsigned number
1383
1384# The number of newlines after a function class prototype, if followed by another function class prototype.
1385nl_after_func_class_proto       = 0        # unsigned number
1386
1387# The number of newlines after a function class prototype, if not followed by another function class prototype.
1388nl_after_func_class_proto_group = 0        # unsigned number
1389
1390# The number of newlines before a multi-line function def body.
1391nl_before_func_body_def         = 0        # unsigned number
1392
1393# The number of newlines before a multi-line function prototype body.
1394nl_before_func_body_proto       = 0        # unsigned number
1395
1396# The number of newlines after '}' of a multi-line function body.
1397nl_after_func_body              = 2        # unsigned number
1398
1399# The number of newlines after '}' of a multi-line function body in a class declaration.
1400nl_after_func_body_class        = 2        # unsigned number
1401
1402# The number of newlines after '}' of a single line function body.
1403nl_after_func_body_one_liner    = 2        # unsigned number
1404
1405# The minimum number of newlines before a multi-line comment.
1406# Doesn't apply if after a brace open or another multi-line comment.
1407nl_before_block_comment         = 0        # unsigned number
1408
1409# The minimum number of newlines before a single-line C comment.
1410# Doesn't apply if after a brace open or other single-line C comments.
1411nl_before_c_comment             = 0        # unsigned number
1412
1413# The minimum number of newlines before a CPP comment.
1414# Doesn't apply if after a brace open or other CPP comments.
1415nl_before_cpp_comment           = 0        # unsigned number
1416
1417# Whether to force a newline after a multi-line comment.
1418nl_after_multiline_comment      = true    # false/true
1419
1420# Whether to force a newline after a label's colon.
1421nl_after_label_colon            = false    # false/true
1422
1423# The number of newlines after '}' or ';' of a struct/enum/union definition.
1424nl_after_struct                 = 2        # unsigned number
1425
1426# The number of newlines before a class definition.
1427nl_before_class                 = 0        # unsigned number
1428
1429# The number of newlines after '}' or ';' of a class definition.
1430nl_after_class                  = 2        # unsigned number
1431
1432# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
1433# Will not change the newline count if after a brace open.
1434# 0 = No change.
1435nl_before_access_spec           = 2        # unsigned number
1436
1437# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:' or 'slots:' label.
1438# 0 = No change.
1439# Overrides 'nl_typedef_blk_start' and 'nl_var_def_blk_start'.
1440nl_after_access_spec            = 0        # unsigned number
1441
1442# The number of newlines between a function def and the function comment.
1443# 0 = No change.
1444nl_comment_func_def             = 0        # unsigned number
1445
1446# The number of newlines after a try-catch-finally block that isn't followed by a brace close.
1447# 0 = No change.
1448nl_after_try_catch_finally      = 2        # unsigned number
1449
1450# The number of newlines before and after a property, indexer or event decl.
1451# 0 = No change.
1452nl_around_cs_property           = 0        # unsigned number
1453
1454# The number of newlines between the get/set/add/remove handlers in C#.
1455# 0 = No change.
1456nl_between_get_set              = 0        # unsigned number
1457
1458# Add or remove newline between C# property and the '{'.
1459nl_property_brace               = ignore   # ignore/add/remove/force
1460
1461# Whether to remove blank lines after '{'.
1462eat_blanks_after_open_brace     = true    # false/true
1463
1464# Whether to remove blank lines before '}'.
1465eat_blanks_before_close_brace   = true    # false/true
1466
1467# How aggressively to remove extra newlines not in preproc.
1468# 0: No change
1469# 1: Remove most newlines not handled by other config
1470# 2: Remove all newlines and reformat completely by config
1471nl_remove_extra_newlines        = 0        # unsigned number
1472
1473# Whether to put a blank line before 'return' statements, unless after an open brace.
1474nl_before_return                = false    # false/true
1475
1476# Whether to put a blank line after 'return' statements, unless followed by a close brace.
1477nl_after_return                 = false    # false/true
1478
1479# Whether to put a newline after a Java annotation statement.
1480# Only affects annotations that are after a newline.
1481nl_after_annotation             = ignore   # ignore/add/remove/force
1482
1483# Controls the newline between two annotations.
1484nl_between_annotation           = ignore   # ignore/add/remove/force
1485
1486#
1487# Positioning options
1488#
1489
1490# The position of arithmetic operators in wrapped expressions.
1491pos_arith                       = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1492
1493# The position of assignment in wrapped expressions.
1494# Do not affect '=' followed by '{'.
1495pos_assign                      = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1496
1497# The position of boolean operators in wrapped expressions.
1498pos_bool                        = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1499
1500# The position of comparison operators in wrapped expressions.
1501pos_compare                     = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1502
1503# The position of conditional (b ? t : f) operators in wrapped expressions.
1504pos_conditional                 = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1505
1506# The position of the comma in wrapped expressions.
1507pos_comma                       = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1508
1509# The position of the comma in enum entries.
1510pos_enum_comma                  = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1511
1512# The position of the comma in the base class list if there are more than one line,
1513#   (tied to nl_class_init_args).
1514pos_class_comma                 = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1515
1516# The position of the comma in the constructor initialization list.
1517# Related to nl_constr_colon, nl_constr_init_args and pos_constr_colon.
1518pos_constr_comma                = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1519
1520# The position of trailing/leading class colon, between class and base class list
1521#   (tied to nl_class_colon).
1522pos_class_colon                 = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1523
1524# The position of colons between constructor and member initialization,
1525# (tied to nl_constr_colon).
1526# Related to nl_constr_colon, nl_constr_init_args and pos_constr_comma.
1527pos_constr_colon                = ignore   # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
1528
1529#
1530# Line Splitting options
1531#
1532
1533# Try to limit code width to N number of columns
1534code_width                      = 0        # unsigned number
1535
1536# Whether to fully split long 'for' statements at semi-colons.
1537ls_for_split_full               = false    # false/true
1538
1539# Whether to fully split long function protos/calls at commas.
1540ls_func_split_full              = false    # false/true
1541
1542# Whether to split lines as close to code_width as possible and ignore some groupings.
1543ls_code_width                   = false    # false/true
1544
1545#
1546# Code alignment (not left column spaces/tabs)
1547#
1548
1549# Whether to keep non-indenting tabs.
1550align_keep_tabs                 = false    # false/true
1551
1552# Whether to use tabs for aligning.
1553align_with_tabs                 = false    # false/true
1554
1555# Whether to bump out to the next tab when aligning.
1556align_on_tabstop                = false    # false/true
1557
1558# Whether to right-align numbers.
1559align_number_right              = false    # false/true
1560
1561# Whether to keep whitespace not required for alignment.
1562align_keep_extra_space          = false    # false/true
1563
1564# Align variable definitions in prototypes and functions.
1565align_func_params               = false    # false/true
1566
1567# The span for aligning parameter definitions in function on parameter name (0=don't align).
1568align_func_params_span          = 0        # unsigned number
1569
1570# The threshold for aligning function parameter definitions (0=no limit).
1571align_func_params_thresh        = 0        # unsigned number
1572
1573# The gap for aligning function parameter definitions.
1574align_func_params_gap           = 0        # unsigned number
1575
1576# Align parameters in single-line functions that have the same name.
1577# The function names must already be aligned with each other.
1578align_same_func_call_params     = false    # false/true
1579
1580# The span for aligning variable definitions (0=don't align)
1581align_var_def_span              = 0        # unsigned number
1582
1583# How to align the star in variable definitions.
1584#  0=Part of the type     'void *   foo;'
1585#  1=Part of the variable 'void     *foo;'
1586#  2=Dangling             'void    *foo;'
1587align_var_def_star_style        = 0        # unsigned number
1588
1589# How to align the '&' in variable definitions.
1590#  0=Part of the type
1591#  1=Part of the variable
1592#  2=Dangling
1593align_var_def_amp_style         = 0        # unsigned number
1594
1595# The threshold for aligning variable definitions (0=no limit)
1596align_var_def_thresh            = 0        # unsigned number
1597
1598# The gap for aligning variable definitions.
1599align_var_def_gap               = 0        # unsigned number
1600
1601# Whether to align the colon in struct bit fields.
1602align_var_def_colon             = false    # false/true
1603
1604# align variable defs gap for bit colons.
1605align_var_def_colon_gap         = 0        # unsigned number
1606
1607# Whether to align any attribute after the variable name.
1608align_var_def_attribute         = false    # false/true
1609
1610# Whether to align inline struct/enum/union variable definitions.
1611align_var_def_inline            = false    # false/true
1612
1613# The span for aligning on '=' in assignments (0=don't align)
1614align_assign_span               = 0        # unsigned number
1615
1616# The threshold for aligning on '=' in assignments (0=no limit)
1617align_assign_thresh             = 0        # unsigned number
1618
1619# The span for aligning on '=' in enums (0=don't align)
1620align_enum_equ_span             = 0        # unsigned number
1621
1622# The threshold for aligning on '=' in enums (0=no limit)
1623align_enum_equ_thresh           = 0        # unsigned number
1624
1625# The span for aligning class (0=don't align)
1626align_var_class_span            = 0        # unsigned number
1627
1628# The threshold for aligning class member definitions (0=no limit).
1629align_var_class_thresh          = 0        # unsigned number
1630
1631# The gap for aligning class member definitions.
1632align_var_class_gap             = 0        # unsigned number
1633
1634# The span for aligning struct/union (0=don't align)
1635align_var_struct_span           = 0        # unsigned number
1636
1637# The threshold for aligning struct/union member definitions (0=no limit)
1638align_var_struct_thresh         = 0        # unsigned number
1639
1640# The gap for aligning struct/union member definitions.
1641align_var_struct_gap            = 0        # unsigned number
1642
1643# The span for aligning struct initializer values (0=don't align)
1644align_struct_init_span          = 0        # unsigned number
1645
1646# The minimum space between the type and the synonym of a typedef.
1647align_typedef_gap               = 0        # unsigned number
1648
1649# The span for aligning single-line typedefs (0=don't align).
1650align_typedef_span              = 0        # unsigned number
1651
1652# How to align typedef'd functions with other typedefs
1653# 0: Don't mix them at all
1654# 1: align the open paren with the types
1655# 2: align the function type name with the other type names
1656align_typedef_func              = 0        # unsigned number
1657
1658# Controls the positioning of the '*' in typedefs. Just try it.
1659# 0: Align on typedef type, ignore '*'
1660# 1: The '*' is part of type name: typedef int  *pint;
1661# 2: The '*' is part of the type, but dangling: typedef int *pint;
1662align_typedef_star_style        = 0        # unsigned number
1663
1664# Controls the positioning of the '&' in typedefs. Just try it.
1665# 0: Align on typedef type, ignore '&'
1666# 1: The '&' is part of type name: typedef int  &pint;
1667# 2: The '&' is part of the type, but dangling: typedef int &pint;
1668align_typedef_amp_style         = 0        # unsigned number
1669
1670# The span for aligning comments that end lines (0=don't align)
1671align_right_cmt_span            = 0        # unsigned number
1672
1673# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment.
1674align_right_cmt_mix             = false    # false/true
1675
1676# If a trailing comment is more than this number of columns away from the text it follows,
1677# it will qualify for being aligned. This has to be > 0 to do anything.
1678align_right_cmt_gap             = 0        # unsigned number
1679
1680# Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore)
1681align_right_cmt_at_col          = 0        # unsigned number
1682
1683# The span for aligning function prototypes (0=don't align).
1684align_func_proto_span           = 0        # unsigned number
1685
1686# Minimum gap between the return type and the function name.
1687align_func_proto_gap            = 0        # unsigned number
1688
1689# Align function protos on the 'operator' keyword instead of what follows.
1690align_on_operator               = false    # false/true
1691
1692# Whether to mix aligning prototype and variable declarations.
1693# If True, align_var_def_XXX options are used instead of align_func_proto_XXX options.
1694align_mix_var_proto             = false    # false/true
1695
1696# Align single-line functions with function prototypes, uses align_func_proto_span.
1697align_single_line_func          = false    # false/true
1698
1699# Aligning the open brace of single-line functions.
1700# Requires align_single_line_func=True, uses align_func_proto_span.
1701align_single_line_brace         = false    # false/true
1702
1703# Gap for align_single_line_brace.
1704align_single_line_brace_gap     = 0        # unsigned number
1705
1706# The span for aligning ObjC msg spec (0=don't align)
1707align_oc_msg_spec_span          = 0        # unsigned number
1708
1709# Whether to align macros wrapped with a backslash and a newline.
1710# This will not work right if the macro contains a multi-line comment.
1711align_nl_cont                   = false    # false/true
1712
1713# # Align macro functions and variables together.
1714align_pp_define_together        = false    # false/true
1715
1716# The minimum space between label and value of a preprocessor define.
1717align_pp_define_gap             = 0        # unsigned number
1718
1719# The span for aligning on '#define' bodies (0=don't align, other=number of lines including comments between blocks)
1720align_pp_define_span            = 0        # unsigned number
1721
1722# Align lines that start with '<<' with previous '<<'. Default=True.
1723align_left_shift                = true     # false/true
1724
1725# Align text after asm volatile () colons.
1726align_asm_colon                 = false    # false/true
1727
1728# Span for aligning parameters in an Obj-C message call on the ':' (0=don't align)
1729align_oc_msg_colon_span         = 0        # unsigned number
1730
1731# If True, always align with the first parameter, even if it is too short.
1732align_oc_msg_colon_first        = false    # false/true
1733
1734# Aligning parameters in an Obj-C '+' or '-' declaration on the ':'.
1735align_oc_decl_colon             = false    # false/true
1736
1737#
1738# Comment modifications
1739#
1740
1741# Try to wrap comments at cmt_width columns
1742cmt_width                       = 0        # unsigned number
1743
1744# Set the comment reflow mode (Default=0)
1745# 0: no reflowing (apart from the line wrapping due to cmt_width)
1746# 1: no touching at all
1747# 2: full reflow
1748cmt_reflow_mode                 = 2        # unsigned number
1749
1750# Whether to convert all tabs to spaces in comments. Default is to leave tabs inside comments alone, unless used for indenting.
1751cmt_convert_tab_to_spaces       = false    # false/true
1752
1753# If False, disable all multi-line comment changes, including cmt_width. keyword substitution and leading chars.
1754# Default=True.
1755cmt_indent_multi                = true     # false/true
1756
1757# Whether to group c-comments that look like they are in a block.
1758cmt_c_group                     = false    # false/true
1759
1760# Whether to put an empty '/*' on the first line of the combined c-comment.
1761cmt_c_nl_start                  = false    # false/true
1762
1763# Whether to put a newline before the closing '*/' of the combined c-comment.
1764cmt_c_nl_end                    = false    # false/true
1765
1766# Whether to group cpp-comments that look like they are in a block.
1767cmt_cpp_group                   = false    # false/true
1768
1769# Whether to put an empty '/*' on the first line of the combined cpp-comment.
1770cmt_cpp_nl_start                = false    # false/true
1771
1772# Whether to put a newline before the closing '*/' of the combined cpp-comment.
1773cmt_cpp_nl_end                  = false    # false/true
1774
1775# Whether to change cpp-comments into c-comments.
1776cmt_cpp_to_c                    = false    # false/true
1777
1778# Whether to put a star on subsequent comment lines.
1779cmt_star_cont                   = true    # false/true
1780
1781# The number of spaces to insert at the start of subsequent comment lines.
1782cmt_sp_before_star_cont         = 0        # unsigned number
1783
1784# The number of spaces to insert after the star on subsequent comment lines.
1785cmt_sp_after_star_cont          = 0        # number
1786
1787# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of
1788# the comment are the same length. Default=True.
1789cmt_multi_check_last            = true     # false/true
1790
1791# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of
1792# the comment are the same length AND if the length is bigger as the first_len minimum. Default=4
1793cmt_multi_first_len_minimum     = 4        # unsigned number
1794
1795# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
1796# Will substitute $(filename) with the current file's name.
1797cmt_insert_file_header          = ""         # string
1798
1799# The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment.
1800# Will substitute $(filename) with the current file's name.
1801cmt_insert_file_footer          = ""         # string
1802
1803# The filename that contains text to insert before a function implementation if the function isn't preceded with a C/C++ comment.
1804# Will substitute $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
1805# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }.
1806cmt_insert_func_header          = ""         # string
1807
1808# The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment.
1809# Will substitute $(class) with the class name.
1810cmt_insert_class_header         = ""         # string
1811
1812# The filename that contains text to insert before a Obj-C message specification if the method isn't preceded with a C/C++ comment.
1813# Will substitute $(message) with the function name and $(javaparam) with the javadoc @param and @return stuff.
1814cmt_insert_oc_msg_header        = ""         # string
1815
1816# If a preprocessor is encountered when stepping backwards from a function name, then
1817# this option decides whether the comment should be inserted.
1818# Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header.
1819cmt_insert_before_preproc       = false    # false/true
1820
1821# If a function is declared inline to a class definition, then
1822# this option decides whether the comment should be inserted.
1823# Affects cmt_insert_func_header.
1824cmt_insert_before_inlines       = true     # false/true
1825
1826# If the function is a constructor/destructor, then
1827# this option decides whether the comment should be inserted.
1828# Affects cmt_insert_func_header.
1829cmt_insert_before_ctor_dtor     = false    # false/true
1830
1831#
1832# Code modifying options (non-whitespace)
1833#
1834
1835# Add or remove braces on single-line 'do' statement.
1836mod_full_brace_do               = force   # ignore/add/remove/force
1837
1838# Add or remove braces on single-line 'for' statement.
1839mod_full_brace_for              = force   # ignore/add/remove/force
1840
1841# Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.
1842mod_full_brace_if               = force   # ignore/add/remove/force
1843
1844# Make all if/elseif/else statements in a chain be braced or not. Overrides mod_full_brace_if.
1845# If any must be braced, they are all braced.  If all can be unbraced, then the braces are removed.
1846mod_full_brace_if_chain         = false    # false/true
1847
1848# Make all if/elseif/else statements with at least one 'else' or 'else if' fully braced.
1849# If mod_full_brace_if_chain is used together with this option, all if-else chains will get braces,
1850# and simple 'if' statements will lose them (if possible).
1851mod_full_brace_if_chain_only    = false    # false/true
1852
1853# Don't remove braces around statements that span N newlines
1854mod_full_brace_nl               = 0        # unsigned number
1855
1856# Blocks removal of braces if the parenthesis of if/for/while/.. span multiple lines.
1857mod_full_brace_nl_block_rem_mlcond = false    # false/true
1858
1859# Add or remove braces on single-line 'while' statement.
1860mod_full_brace_while            = force   # ignore/add/remove/force
1861
1862# Add or remove braces on single-line 'using ()' statement.
1863mod_full_brace_using            = ignore   # ignore/add/remove/force
1864
1865# Add or remove unnecessary paren on 'return' statement.
1866mod_paren_on_return             = remove   # ignore/add/remove/force
1867
1868# Whether to change optional semicolons to real semicolons.
1869mod_pawn_semicolon              = false    # false/true
1870
1871# Add parens on 'while' and 'if' statement around bools.
1872mod_full_paren_if_bool          = false    # false/true
1873
1874# Whether to remove superfluous semicolons.
1875mod_remove_extra_semicolon      = false    # false/true
1876
1877# If a function body exceeds the specified number of newlines and doesn't have a comment after
1878# the close brace, a comment will be added.
1879mod_add_long_function_closebrace_comment = 0        # unsigned number
1880
1881# If a namespace body exceeds the specified number of newlines and doesn't have a comment after
1882# the close brace, a comment will be added.
1883mod_add_long_namespace_closebrace_comment = 0        # unsigned number
1884
1885# If a class body exceeds the specified number of newlines and doesn't have a comment after
1886# the close brace, a comment will be added.
1887mod_add_long_class_closebrace_comment = 0        # unsigned number
1888
1889# If a switch body exceeds the specified number of newlines and doesn't have a comment after
1890# the close brace, a comment will be added.
1891mod_add_long_switch_closebrace_comment = 0        # unsigned number
1892
1893# If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after
1894# the #endif, a comment will be added.
1895mod_add_long_ifdef_endif_comment = 0        # unsigned number
1896
1897# If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after
1898# the #else, a comment will be added.
1899mod_add_long_ifdef_else_comment = 0        # unsigned number
1900
1901# If True, will sort consecutive single-line 'import' statements [Java, D].
1902mod_sort_import                 = false    # false/true
1903
1904# If True, will sort consecutive single-line 'using' statements [C#].
1905mod_sort_using                  = false    # false/true
1906
1907# If True, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
1908# This is generally a bad idea, as it may break your code.
1909mod_sort_include                = false    # false/true
1910
1911# If True, it will move a 'break' that appears after a fully braced 'case' before the close brace.
1912mod_move_case_break             = false    # false/true
1913
1914# Will add or remove the braces around a fully braced case statement.
1915# Will only remove the braces if there are no variable declarations in the block.
1916mod_case_brace                  = ignore   # ignore/add/remove/force
1917
1918# If True, it will remove a void 'return;' that appears as the last statement in a function.
1919mod_remove_empty_return         = false    # false/true
1920
1921# If True, it will organize the properties (Obj-C).
1922mod_sort_oc_properties          = false    # false/true
1923
1924# Determines weight of class property modifier (Obj-C).
1925mod_sort_oc_property_class_weight = 0        # number
1926
1927# Determines weight of atomic, nonatomic (Obj-C).
1928mod_sort_oc_property_thread_safe_weight = 0        # number
1929
1930# Determines weight of readwrite (Obj-C).
1931mod_sort_oc_property_readwrite_weight = 0        # number
1932
1933# Determines weight of reference type (retain, copy, assign, weak, strong) (Obj-C).
1934mod_sort_oc_property_reference_weight = 0        # number
1935
1936# Determines weight of getter type (getter=) (Obj-C).
1937mod_sort_oc_property_getter_weight = 0        # number
1938
1939# Determines weight of setter type (setter=) (Obj-C).
1940mod_sort_oc_property_setter_weight = 0        # number
1941
1942# Determines weight of nullability type (nullable, nonnull, null_unspecified, null_resettable) (Obj-C).
1943mod_sort_oc_property_nullability_weight = 0        # number
1944
1945#
1946# Preprocessor options
1947#
1948
1949# Control indent of preprocessors inside #if blocks at brace level 0 (file-level).
1950pp_indent                       = ignore   # ignore/add/remove/force
1951
1952# Whether to indent #if/#else/#endif at the brace level (True) or from column 1 (False).
1953pp_indent_at_level              = false    # false/true
1954
1955# Specifies the number of columns to indent preprocessors per level at brace level 0 (file-level).
1956# If pp_indent_at_level=False, specifies the number of columns to indent preprocessors per level at brace level > 0 (function-level).
1957# Default=1.
1958pp_indent_count                 = 1        # unsigned number
1959
1960# Add or remove space after # based on pp_level of #if blocks.
1961pp_space                        = ignore   # ignore/add/remove/force
1962
1963# Sets the number of spaces added with pp_space.
1964pp_space_count                  = 0        # unsigned number
1965
1966# The indent for #region and #endregion in C# and '#pragma region' in C/C++.
1967pp_indent_region                = 0        # number
1968
1969# Whether to indent the code between #region and #endregion.
1970pp_region_indent_code           = false    # false/true
1971
1972# If pp_indent_at_level=True, sets the indent for #if, #else and #endif when not at file-level.
1973# 0:  indent preprocessors using output_tab_size.
1974# >0: column at which all preprocessors will be indented.
1975pp_indent_if                    = 0        # number
1976
1977# Control whether to indent the code between #if, #else and #endif.
1978pp_if_indent_code               = false    # false/true
1979
1980# Whether to indent '#define' at the brace level (True) or from column 1 (false).
1981pp_define_at_level              = false    # false/true
1982
1983# Whether to ignore the '#define' body while formatting.
1984pp_ignore_define_body           = false    # false/true
1985
1986# Whether to indent case statements between #if, #else, and #endif.
1987# Only applies to the indent of the preprocesser that the case statements directly inside of.
1988pp_indent_case                  = true     # false/true
1989
1990# Whether to indent whole function definitions between #if, #else, and #endif.
1991# Only applies to the indent of the preprocesser that the function definition is directly inside of.
1992pp_indent_func_def              = true     # false/true
1993
1994# Whether to indent extern C blocks between #if, #else, and #endif.
1995# Only applies to the indent of the preprocesser that the extern block is directly inside of.
1996pp_indent_extern                = true     # false/true
1997
1998# Whether to indent braces directly inside #if, #else, and #endif.
1999# Only applies to the indent of the preprocesser that the braces are directly inside of.
2000pp_indent_brace                 = true     # false/true
2001
2002#
2003# Sort includes options
2004#
2005
2006# The regex for include category with priority 0.
2007include_category_0              = ""         # string
2008
2009# The regex for include category with priority 1.
2010include_category_1              = ""         # string
2011
2012# The regex for include category with priority 2.
2013include_category_2              = ""         # string
2014
2015#
2016# Use or Do not Use options
2017#
2018
2019# True:  indent_func_call_param will be used (default)
2020# False: indent_func_call_param will NOT be used.
2021use_indent_func_call_param      = true     # false/true
2022
2023# The value of the indentation for a continuation line is calculate differently if the line is:
2024#   a declaration :your case with QString fileName ...
2025#   an assignment  :your case with pSettings = new QSettings( ...
2026# At the second case the option value might be used twice:
2027#   at the assignment
2028#   at the function call (if present)
2029# To prevent the double use of the option value, use this option with the value 'True'.
2030# True:  indent_continue will be used only once
2031# False: indent_continue will be used every time (default).
2032use_indent_continue_only_once   = false    # false/true
2033
2034# SIGNAL/SLOT Qt macros have special formatting options. See options_for_QT.cpp for details.
2035# Default=True.
2036use_options_overriding_for_qt_macros = true     # false/true
2037
2038#
2039# Warn levels - 1: error, 2: warning (default), 3: note
2040#
2041
2042# Warning is given if doing tab-to-\t replacement and we have found one in a C# verbatim string literal.
2043warn_level_tabs_found_in_verbatim_string_literals = 2        # unsigned number
2044
2045# Meaning of the settings:
2046#   Ignore - do not do any changes
2047#   Add    - makes sure there is 1 or more space/brace/newline/etc
2048#   Force  - makes sure there is exactly 1 space/brace/newline/etc,
2049#            behaves like Add in some contexts
2050#   Remove - removes space/brace/newline/etc
2051#
2052#
2053# - Token(s) can be treated as specific type(s) with the 'set' option:
2054#     `set tokenType tokenString [tokenString...]`
2055#
2056#     Example:
2057#       `set BOOL __AND__ __OR__`
2058#
2059#     tokenTypes are defined in src/token_enum.h, use them without the
2060#     'CT_' prefix: 'CT_BOOL' -> 'BOOL'
2061#
2062#
2063# - Token(s) can be treated as type(s) with the 'type' option.
2064#     `type tokenString [tokenString...]`
2065#
2066#     Example:
2067#       `type int c_uint_8 Rectangle`
2068#
2069#     This can also be achieved with `set TYPE int c_uint_8 Rectangle`
2070#
2071#
2072# To embed whitespace in tokenStrings use the '\' escape character, or quote
2073# the tokenStrings. These quotes are supported: "'`
2074#
2075#
2076# - Support for the auto detection of languages through the file ending can be
2077#   added using the 'file_ext' command.
2078#     `file_ext langType langString [langString..]`
2079#
2080#     Example:
2081#       `file_ext CPP .ch .cxx .cpp.in`
2082#
2083#     langTypes are defined in uncrusify_types.h in the lang_flag_e enum, use
2084#     them without the 'LANG_' prefix: 'LANG_CPP' -> 'CPP'
2085#
2086#
2087# - Custom macro-based indentation can be set up using 'macro-open',
2088#   'macro-else' and 'macro-close'.
2089#     `(macro-open | macro-else | macro-close) tokenString`
2090#
2091#     Example:
2092#       `macro-open  BEGIN_TEMPLATE_MESSAGE_MAP`
2093#       `macro-open  BEGIN_MESSAGE_MAP`
2094#       `macro-close END_MESSAGE_MAP`
2095#
2096## option(s) with 'not default' value: 0
2097#
2098