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