Developer/Coding/Conventions: rtems.uncrustify

File rtems.uncrustify, 69.3 KB (added by Gedare, on Feb 27, 2015 at 5:37:28 PM)

Uncrustify configuration for RTEMS Style

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