~vcs-imports/balsa/master

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