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