blob: d702d061f04a881fcf0bc3a39d76ff08a7d5c0a2 [file] [log] [blame]
Radek Krejcia198c962020-08-16 10:32:10 +02001# Uncrustify-0.71.0_f
2
3#
4# General options
5#
6
7# Added specific file extensions.
8file_ext C .c.in
9file_ext C-Header .h.in
10
11# The type of line endings.
12#
13# Default: auto
14newlines = lf # lf/crlf/cr/auto
15
16# The original size of tabs in the input.
17#
18# Default: 8
19input_tab_size = 8 # unsigned number
20
21# The size of tabs in the output (only used if align_with_tabs=true).
22#
23# Default: 8
24output_tab_size = 8 # unsigned number
25
26# The ASCII value of the string escape char, usually 92 (\) or (Pawn) 94 (^).
27#
28# Default: 92
29string_escape_char = 92 # unsigned number
30
31# Alternate string escape char (usually only used for Pawn).
32# Only works right before the quote char.
33string_escape_char2 = 0 # unsigned number
34
35# Replace tab characters found in string literals with the escape sequence \t
36# instead.
37string_replace_tab_chars = true # true/false
38
39# Allow interpreting '>=' and '>>=' as part of a template in code like
40# 'void f(list<list<B>>=val);'. If true, 'assert(x<0 && y>=3)' will be broken.
41# Improvements to template detection may make this option obsolete.
42tok_split_gte = false # true/false
43
44# Disable formatting of NL_CONT ('\\n') ended lines (e.g. multiline macros)
45disable_processing_nl_cont = false # true/false
46
47# Specify the marker used in comments to disable processing of part of the
48# file.
49# The comment should be used alone in one line.
50#
51# Default: *INDENT-OFF*
52disable_processing_cmt = " *INDENT-OFF*" # string
53
54# Specify the marker used in comments to (re)enable processing in a file.
55# The comment should be used alone in one line.
56#
57# Default: *INDENT-ON*
58enable_processing_cmt = " *INDENT-ON*" # string
59
60# Enable parsing of digraphs.
61enable_digraphs = false # true/false
62
63# Add or remove the UTF-8 BOM (recommend 'remove').
64utf8_bom = ignore # ignore/add/remove/force
65
66# If the file contains bytes with values between 128 and 255, but is not
67# UTF-8, then output as UTF-8.
68utf8_byte = false # true/false
69
70# Force the output encoding to UTF-8.
71utf8_force = true # true/false
72
73# Add or remove space between 'do' and '{'.
Michal Vasko44f3d2c2020-08-24 09:49:38 +020074sp_do_brace_open = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +020075
76# Add or remove space between '}' and 'while'.
Michal Vasko44f3d2c2020-08-24 09:49:38 +020077sp_brace_close_while = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +020078
79# Add or remove space between 'while' and '('.
Michal Vasko44f3d2c2020-08-24 09:49:38 +020080sp_while_paren_open = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +020081
82#
83# Spacing options
84#
85
86# Add or remove space around non-assignment symbolic operators ('+', '/', '%',
87# '<<', and so forth).
Michal Vasko44f3d2c2020-08-24 09:49:38 +020088sp_arith = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +020089
90# Add or remove space around arithmetic operators '+' and '-'.
91#
92# Overrides sp_arith.
Michal Vasko44f3d2c2020-08-24 09:49:38 +020093sp_arith_additive = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +020094
95# Add or remove space around assignment operator '=', '+=', etc.
Michal Vasko44f3d2c2020-08-24 09:49:38 +020096sp_assign = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +020097
98# Add or remove space around '=' in C++11 lambda capture specifications.
99#
100# Overrides sp_assign.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200101sp_cpp_lambda_assign = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200102
103# Add or remove space after the capture specification of a C++11 lambda when
104# an argument list is present, as in '[] <here> (int x){ ... }'.
105sp_cpp_lambda_square_paren = ignore # ignore/add/remove/force
106
107# Add or remove space after the capture specification of a C++11 lambda with
108# no argument list is present, as in '[] <here> { ... }'.
109sp_cpp_lambda_square_brace = ignore # ignore/add/remove/force
110
111# Add or remove space after the argument list of a C++11 lambda, as in
112# '[](int x) <here> { ... }'.
113sp_cpp_lambda_paren_brace = ignore # ignore/add/remove/force
114
115# Add or remove space between a lambda body and its call operator of an
116# immediately invoked lambda, as in '[]( ... ){ ... } <here> ( ... )'.
117sp_cpp_lambda_fparen = ignore # ignore/add/remove/force
118
119# Add or remove space around assignment operator '=' in a prototype.
120#
121# If set to ignore, use sp_assign.
122sp_assign_default = ignore # ignore/add/remove/force
123
124# Add or remove space before assignment operator '=', '+=', etc.
125#
126# Overrides sp_assign.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200127sp_before_assign = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200128
129# Add or remove space after assignment operator '=', '+=', etc.
130#
131# Overrides sp_assign.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200132sp_after_assign = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200133
134# Add or remove space in 'NS_ENUM ('.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200135sp_enum_paren = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200136
137# Add or remove space around assignment '=' in enum.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200138sp_enum_assign = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200139
140# Add or remove space before assignment '=' in enum.
141#
142# Overrides sp_enum_assign.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200143sp_enum_before_assign = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200144
145# Add or remove space after assignment '=' in enum.
146#
147# Overrides sp_enum_assign.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200148sp_enum_after_assign = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200149
150# Add or remove space around assignment ':' in enum.
151sp_enum_colon = ignore # ignore/add/remove/force
152
153# Add or remove space around preprocessor '##' concatenation operator.
154#
155# Default: add
156sp_pp_concat = ignore # ignore/add/remove/force
157
158# Add or remove space after preprocessor '#' stringify operator.
159# Also affects the '#@' charizing operator.
160sp_pp_stringify = ignore # ignore/add/remove/force
161
162# Add or remove space before preprocessor '#' stringify operator
163# as in '#define x(y) L#y'.
164sp_before_pp_stringify = ignore # ignore/add/remove/force
165
166# Add or remove space around boolean operators '&&' and '||'.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200167sp_bool = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200168
169# Add or remove space around compare operator '<', '>', '==', etc.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200170sp_compare = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200171
172# Add or remove space inside '(' and ')'.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200173sp_inside_paren = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200174
175# Add or remove space between nested parentheses, i.e. '((' vs. ') )'.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200176sp_paren_paren = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200177
178# Add or remove space between back-to-back parentheses, i.e. ')(' vs. ') ('.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200179sp_cparen_oparen = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200180
181# Whether to balance spaces inside nested parentheses.
182sp_balance_nested_parens = false # true/false
183
184# Add or remove space between ')' and '{'.
Michal Vasko44f3d2c2020-08-24 09:49:38 +0200185sp_paren_brace = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200186
187# Add or remove space between nested braces, i.e. '{{' vs '{ {'.
188sp_brace_brace = ignore # ignore/add/remove/force
189
190# Add or remove space before pointer star '*'.
Michal Vasko22df3f02020-08-24 13:29:22 +0200191sp_before_ptr_star = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200192
193# Add or remove space before pointer star '*' that isn't followed by a
194# variable name. If set to ignore, sp_before_ptr_star is used instead.
195sp_before_unnamed_ptr_star = ignore # ignore/add/remove/force
196
197# Add or remove space between pointer stars '*'.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200198sp_between_ptr_star = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200199
200# Add or remove space after pointer star '*', if followed by a word.
201#
202# Overrides sp_type_func.
Michal Vasko22df3f02020-08-24 13:29:22 +0200203sp_after_ptr_star = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200204
205# Add or remove space after pointer caret '^', if followed by a word.
206#sp_after_ptr_block_caret = ignore # ignore/add/remove/force
207
208# Add or remove space after pointer star '*', if followed by a qualifier.
Michal Vasko22df3f02020-08-24 13:29:22 +0200209sp_after_ptr_star_qualifier = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200210
211# Add or remove space after a pointer star '*', if followed by a function
212# prototype or function definition.
213#
214# Overrides sp_after_ptr_star and sp_type_func.
215sp_after_ptr_star_func = ignore # ignore/add/remove/force
216
217# Add or remove space after a pointer star '*', if followed by an open
218# parenthesis, as in 'void* (*)().
Michal Vaskoe29489b2020-08-24 10:43:54 +0200219sp_ptr_star_paren = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200220
221# Add or remove space before a pointer star '*', if followed by a function
222# prototype or function definition.
Michal Vasko22df3f02020-08-24 13:29:22 +0200223sp_before_ptr_star_func = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200224
225# Add or remove space before a reference sign '&'.
226sp_before_byref = ignore # ignore/add/remove/force
227
228# Add or remove space before a reference sign '&' that isn't followed by a
229# variable name. If set to ignore, sp_before_byref is used instead.
230sp_before_unnamed_byref = ignore # ignore/add/remove/force
231
232# Add or remove space after reference sign '&', if followed by a word.
233#
234# Overrides sp_type_func.
235sp_after_byref = ignore # ignore/add/remove/force
236
237# Add or remove space after a reference sign '&', if followed by a function
238# prototype or function definition.
239#
240# Overrides sp_after_byref and sp_type_func.
241sp_after_byref_func = ignore # ignore/add/remove/force
242
243# Add or remove space before a reference sign '&', if followed by a function
244# prototype or function definition.
245sp_before_byref_func = ignore # ignore/add/remove/force
246
247# Add or remove space between type and word.
248#
249# Default: force
250sp_after_type = ignore # ignore/add/remove/force
251
252# Add or remove space between 'decltype(...)' and word.
253sp_after_decltype = ignore # ignore/add/remove/force
254
255# (D) Add or remove space before the parenthesis in the D constructs
256# 'template Foo(' and 'class Foo('.
257sp_before_template_paren = ignore # ignore/add/remove/force
258
259# Add or remove space between 'template' and '<'.
260# If set to ignore, sp_before_angle is used.
261sp_template_angle = ignore # ignore/add/remove/force
262
263# Add or remove space before '<'.
264sp_before_angle = ignore # ignore/add/remove/force
265
266# Add or remove space inside '<' and '>'.
267sp_inside_angle = ignore # ignore/add/remove/force
268
269# Add or remove space inside '<>'.
270sp_inside_angle_empty = ignore # ignore/add/remove/force
271
272# Add or remove space between '>' and ':'.
273sp_angle_colon = ignore # ignore/add/remove/force
274
275# Add or remove space after '>'.
276sp_after_angle = ignore # ignore/add/remove/force
277
278# Add or remove space between '>' and '(' as found in 'new List<byte>(foo);'.
279sp_angle_paren = ignore # ignore/add/remove/force
280
281# Add or remove space between '>' and '()' as found in 'new List<byte>();'.
282sp_angle_paren_empty = ignore # ignore/add/remove/force
283
284# Add or remove space between '>' and a word as in 'List<byte> m;' or
285# 'template <typename T> static ...'.
286sp_angle_word = ignore # ignore/add/remove/force
287
288# Add or remove space between '>' and '>' in '>>' (template stuff).
289#
290# Default: add
291sp_angle_shift = ignore # ignore/add/remove/force
292
293# (C++11) Permit removal of the space between '>>' in 'foo<bar<int> >'. Note
294# that sp_angle_shift cannot remove the space without this option.
295sp_permit_cpp11_shift = false # true/false
296
297# Add or remove space before '(' of control statements ('if', 'for', 'switch',
298# 'while', etc.).
Michal Vaskod989ba02020-08-24 10:59:24 +0200299sp_before_sparen = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200300
301# Add or remove space inside '(' and ')' of control statements.
Michal Vaskod989ba02020-08-24 10:59:24 +0200302sp_inside_sparen = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200303
304# Add or remove space after '(' of control statements.
305#
306# Overrides sp_inside_sparen.
307sp_inside_sparen_open = ignore # ignore/add/remove/force
308
309# Add or remove space before ')' of control statements.
310#
311# Overrides sp_inside_sparen.
312sp_inside_sparen_close = ignore # ignore/add/remove/force
313
314# Add or remove space after ')' of control statements.
Michal Vaskod989ba02020-08-24 10:59:24 +0200315sp_after_sparen = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200316
317# Add or remove space between ')' and '{' of of control statements.
Michal Vaskod989ba02020-08-24 10:59:24 +0200318sp_sparen_brace = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200319
320# (D) Add or remove space between 'invariant' and '('.
321sp_invariant_paren = ignore # ignore/add/remove/force
322
323# (D) Add or remove space after the ')' in 'invariant (C) c'.
324sp_after_invariant_paren = ignore # ignore/add/remove/force
325
326# Add or remove space before empty statement ';' on 'if', 'for' and 'while'.
327sp_special_semi = ignore # ignore/add/remove/force
328
329# Add or remove space before ';'.
330#
331# Default: remove
Michal Vaskod989ba02020-08-24 10:59:24 +0200332sp_before_semi = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200333
334# Add or remove space before ';' in non-empty 'for' statements.
Michal Vaskod989ba02020-08-24 10:59:24 +0200335sp_before_semi_for = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200336
337# Add or remove space before a semicolon of an empty part of a for statement.
Michal Vaskod989ba02020-08-24 10:59:24 +0200338sp_before_semi_for_empty = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200339
340# Add or remove space after ';', except when followed by a comment.
341#
342# Default: add
Michal Vaskod989ba02020-08-24 10:59:24 +0200343sp_after_semi = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200344
345# Add or remove space after ';' in non-empty 'for' statements.
346#
347# Default: force
Michal Vaskod989ba02020-08-24 10:59:24 +0200348sp_after_semi_for = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200349
350# Add or remove space after the final semicolon of an empty part of a for
351# statement, as in 'for ( ; ; <here> )'.
Michal Vaskod989ba02020-08-24 10:59:24 +0200352sp_after_semi_for_empty = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200353
354# Add or remove space before '[' (except '[]').
355sp_before_square = ignore # ignore/add/remove/force
356
357# Add or remove space before '[' for a variable definition.
358#
359# Default: remove
360sp_before_vardef_square = ignore # ignore/add/remove/force
361
362# Add or remove space before '[' for asm block.
363sp_before_square_asm_block = ignore # ignore/add/remove/force
364
365# Add or remove space before '[]'.
366sp_before_squares = ignore # ignore/add/remove/force
367
368# Add or remove space before C++17 structured bindings.
369sp_cpp_before_struct_binding = ignore # ignore/add/remove/force
370
371# Add or remove space inside a non-empty '[' and ']'.
372sp_inside_square = ignore # ignore/add/remove/force
373
374# (OC) Add or remove space inside a non-empty Objective-C boxed array '@[' and
375# ']'. If set to ignore, sp_inside_square is used.
376sp_inside_square_oc_array = ignore # ignore/add/remove/force
377
378# Add or remove space after ',', i.e. 'a,b' vs. 'a, b'.
Michal Vaskod989ba02020-08-24 10:59:24 +0200379sp_after_comma = add # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200380
381# Add or remove space before ','.
382#
383# Default: remove
Michal Vaskod989ba02020-08-24 10:59:24 +0200384sp_before_comma = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200385
386# (C#) Add or remove space between ',' and ']' in multidimensional array type
387# like 'int[,,]'.
388sp_after_mdatype_commas = ignore # ignore/add/remove/force
389
390# (C#) Add or remove space between '[' and ',' in multidimensional array type
391# like 'int[,,]'.
392sp_before_mdatype_commas = ignore # ignore/add/remove/force
393
394# (C#) Add or remove space between ',' in multidimensional array type
395# like 'int[,,]'.
396sp_between_mdatype_commas = ignore # ignore/add/remove/force
397
398# Add or remove space between an open parenthesis and comma,
399# i.e. '(,' vs. '( ,'.
400#
401# Default: force
Michal Vaskod989ba02020-08-24 10:59:24 +0200402sp_paren_comma = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200403
404# Add or remove space before the variadic '...' when preceded by a
405# non-punctuator.
Michal Vaskoe1445952020-08-24 11:19:42 +0200406sp_before_ellipsis = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200407
408# Add or remove space between a type and '...'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200409sp_type_ellipsis = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200410
411# (D) Add or remove space between a type and '?'.
412#sp_type_question = ignore # ignore/add/remove/force
413
414# Add or remove space between ')' and '...'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200415sp_paren_ellipsis = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200416
417# Add or remove space between ')' and a qualifier such as 'const'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200418sp_paren_qualifier = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200419
420# Add or remove space between ')' and 'noexcept'.
421sp_paren_noexcept = ignore # ignore/add/remove/force
422
423# Add or remove space after class ':'.
424sp_after_class_colon = ignore # ignore/add/remove/force
425
426# Add or remove space before class ':'.
427sp_before_class_colon = ignore # ignore/add/remove/force
428
429# Add or remove space after class constructor ':'.
430sp_after_constr_colon = ignore # ignore/add/remove/force
431
432# Add or remove space before class constructor ':'.
433sp_before_constr_colon = ignore # ignore/add/remove/force
434
435# Add or remove space before case ':'.
436#
437# Default: remove
438sp_before_case_colon = remove # ignore/add/remove/force
439
440# Add or remove space between 'operator' and operator sign.
441sp_after_operator = ignore # ignore/add/remove/force
442
443# Add or remove space between the operator symbol and the open parenthesis, as
444# in 'operator ++('.
445sp_after_operator_sym = ignore # ignore/add/remove/force
446
447# Overrides sp_after_operator_sym when the operator has no arguments, as in
448# 'operator *()'.
449sp_after_operator_sym_empty = ignore # ignore/add/remove/force
450
451# Add or remove space after C/D cast, i.e. 'cast(int)a' vs. 'cast(int) a' or
452# '(int)a' vs. '(int) a'.
453sp_after_cast = ignore # ignore/add/remove/force
454
455# Add or remove spaces inside cast parentheses.
Michal Vaskoe1445952020-08-24 11:19:42 +0200456sp_inside_paren_cast = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200457
458# Add or remove space between the type and open parenthesis in a C++ cast,
459# i.e. 'int(exp)' vs. 'int (exp)'.
460sp_cpp_cast_paren = ignore # ignore/add/remove/force
461
462# Add or remove space between 'sizeof' and '('.
463sp_sizeof_paren = ignore # ignore/add/remove/force
464
465# Add or remove space between 'sizeof' and '...'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200466sp_sizeof_ellipsis = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200467
468# Add or remove space between 'sizeof...' and '('.
Michal Vaskoe1445952020-08-24 11:19:42 +0200469sp_sizeof_ellipsis_paren = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200470
471# Add or remove space between 'decltype' and '('.
472sp_decltype_paren = ignore # ignore/add/remove/force
473
474# (Pawn) Add or remove space after the tag keyword.
475#sp_after_tag = ignore # ignore/add/remove/force
476
477# Add or remove space inside enum '{' and '}'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200478sp_inside_braces_enum = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200479
480# Add or remove space inside struct/union '{' and '}'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200481sp_inside_braces_struct = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200482
483# (OC) Add or remove space inside Objective-C boxed dictionary '{' and '}'
484#sp_inside_braces_oc_dict = ignore # ignore/add/remove/force
485
486# Add or remove space after open brace in an unnamed temporary
487# direct-list-initialization.
488sp_after_type_brace_init_lst_open = ignore # ignore/add/remove/force
489
490# Add or remove space before close brace in an unnamed temporary
491# direct-list-initialization.
492sp_before_type_brace_init_lst_close = ignore # ignore/add/remove/force
493
494# Add or remove space inside an unnamed temporary direct-list-initialization.
495sp_inside_type_brace_init_lst = ignore # ignore/add/remove/force
496
497# Add or remove space inside '{' and '}'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200498sp_inside_braces = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200499
500# Add or remove space inside '{}'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200501sp_inside_braces_empty = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200502
503# Add or remove space around trailing return operator '->'.
504sp_trailing_return = ignore # ignore/add/remove/force
505
506# Add or remove space between return type and function name. A minimum of 1
507# is forced except for pointer return types.
Michal Vaskoe1445952020-08-24 11:19:42 +0200508sp_type_func = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200509
510# Add or remove space between type and open brace of an unnamed temporary
511# direct-list-initialization.
Michal Vaskoe1445952020-08-24 11:19:42 +0200512sp_type_brace_init_lst = ignore # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200513
514# Add or remove space between function name and '(' on function declaration.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200515sp_func_proto_paren = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200516
517# Add or remove space between function name and '()' on function declaration
518# without parameters.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200519sp_func_proto_paren_empty = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200520
521# Add or remove space between function name and '(' with a typedef specifier.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200522sp_func_type_paren = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200523
524# Add or remove space between alias name and '(' of a non-pointer function type typedef.
525sp_func_def_paren = ignore # ignore/add/remove/force
526
527# Add or remove space between function name and '()' on function definition
528# without parameters.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200529sp_func_def_paren_empty = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200530
531# Add or remove space inside empty function '()'.
532# Overrides sp_after_angle unless use_sp_after_angle_always is set to true.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200533sp_inside_fparens = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200534
535# Add or remove space inside function '(' and ')'.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200536sp_inside_fparen = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200537
538# Add or remove space inside the first parentheses in a function type, as in
539# 'void (*x)(...)'.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200540sp_inside_tparen = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200541
542# Add or remove space between the ')' and '(' in a function type, as in
543# 'void (*x)(...)'.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200544sp_after_tparen_close = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200545
546# Add or remove space between ']' and '(' when part of a function call.
547sp_square_fparen = ignore # ignore/add/remove/force
548
549# Add or remove space between ')' and '{' of function.
550sp_fparen_brace = ignore # ignore/add/remove/force
551
552# Add or remove space between ')' and '{' of s function call in object
553# initialization.
554#
555# Overrides sp_fparen_brace.
556sp_fparen_brace_initializer = ignore # ignore/add/remove/force
557
558# (Java) Add or remove space between ')' and '{{' of double brace initializer.
559sp_fparen_dbrace = ignore # ignore/add/remove/force
560
561# Add or remove space between function name and '(' on function calls.
562sp_func_call_paren = ignore # ignore/add/remove/force
563
564# Add or remove space between function name and '()' on function calls without
565# parameters. If set to ignore (the default), sp_func_call_paren is used.
566sp_func_call_paren_empty = ignore # ignore/add/remove/force
567
568# Add or remove space between the user function name and '(' on function
569# calls. You need to set a keyword to be a user function in the config file,
570# like:
571# set func_call_user tr _ i18n
572sp_func_call_user_paren = ignore # ignore/add/remove/force
573
574# Add or remove space inside user function '(' and ')'.
575sp_func_call_user_inside_fparen = ignore # ignore/add/remove/force
576
577# Add or remove space between nested parentheses with user functions,
578# i.e. '((' vs. '( ('.
579sp_func_call_user_paren_paren = ignore # ignore/add/remove/force
580
581# Add or remove space between a constructor/destructor and the open
582# parenthesis.
583sp_func_class_paren = ignore # ignore/add/remove/force
584
585# Add or remove space between a constructor without parameters or destructor
586# and '()'.
587sp_func_class_paren_empty = ignore # ignore/add/remove/force
588
589# Add or remove space between 'return' and '('.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200590sp_return_paren = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200591
592# Add or remove space between 'return' and '{'.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200593sp_return_brace = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200594
595# Add or remove space between '__attribute__' and '('.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200596sp_attribute_paren = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200597
598# Add or remove space between 'defined' and '(' in '#if defined (FOO)'.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200599sp_defined_paren = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200600
601# Add or remove space between 'throw' and '(' in 'throw (something)'.
602sp_throw_paren = ignore # ignore/add/remove/force
603
604# Add or remove space between 'throw' and anything other than '(' as in
605# '@throw [...];'.
606sp_after_throw = ignore # ignore/add/remove/force
607
608# Add or remove space between 'catch' and '(' in 'catch (something) { }'.
609# If set to ignore, sp_before_sparen is used.
610sp_catch_paren = ignore # ignore/add/remove/force
611
612# (OC) Add or remove space between '@catch' and '('
613# in '@catch (something) { }'. If set to ignore, sp_catch_paren is used.
614sp_oc_catch_paren = ignore # ignore/add/remove/force
615
616# (OC) Add or remove space before Objective-C protocol list
617# as in '@protocol Protocol<here><Protocol_A>' or '@interface MyClass : NSObject<here><MyProtocol>'.
618sp_before_oc_proto_list = ignore # ignore/add/remove/force
619
620# (OC) Add or remove space between class name and '('
621# in '@interface className(categoryName)<ProtocolName>:BaseClass'
622sp_oc_classname_paren = ignore # ignore/add/remove/force
623
624# (D) Add or remove space between 'version' and '('
625# in 'version (something) { }'. If set to ignore, sp_before_sparen is used.
626sp_version_paren = ignore # ignore/add/remove/force
627
628# (D) Add or remove space between 'scope' and '('
629# in 'scope (something) { }'. If set to ignore, sp_before_sparen is used.
630sp_scope_paren = ignore # ignore/add/remove/force
631
632# Add or remove space between 'super' and '(' in 'super (something)'.
633#
634# Default: remove
635sp_super_paren = ignore # ignore/add/remove/force
636
637# Add or remove space between 'this' and '(' in 'this (something)'.
638#
639# Default: remove
640sp_this_paren = ignore # ignore/add/remove/force
641
642# Add or remove space between a macro name and its definition.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200643sp_macro = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200644
645# Add or remove space between a macro function ')' and its definition.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200646sp_macro_func = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200647
648# Add or remove space between 'else' and '{' if on the same line.
Michal Vaskod989ba02020-08-24 10:59:24 +0200649sp_else_brace = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200650
651# Add or remove space between '}' and 'else' if on the same line.
Michal Vaskoe29489b2020-08-24 10:43:54 +0200652sp_brace_else = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200653
654# Add or remove space between '}' and the name of a typedef on the same line.
Michal Vaskoe1445952020-08-24 11:19:42 +0200655sp_brace_typedef = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200656
657# Add or remove space before the '{' of a 'catch' statement, if the '{' and
658# 'catch' are on the same line, as in 'catch (decl) <here> {'.
659sp_catch_brace = ignore # ignore/add/remove/force
660
661# (OC) Add or remove space before the '{' of a '@catch' statement, if the '{'
662# and '@catch' are on the same line, as in '@catch (decl) <here> {'.
663# If set to ignore, sp_catch_brace is used.
664sp_oc_catch_brace = ignore # ignore/add/remove/force
665
666# Add or remove space between '}' and 'catch' if on the same line.
667sp_brace_catch = ignore # ignore/add/remove/force
668
669# (OC) Add or remove space between '}' and '@catch' if on the same line.
670# If set to ignore, sp_brace_catch is used.
671sp_oc_brace_catch = ignore # ignore/add/remove/force
672
673# Add or remove space between 'finally' and '{' if on the same line.
674sp_finally_brace = ignore # ignore/add/remove/force
675
676# Add or remove space between '}' and 'finally' if on the same line.
677sp_brace_finally = ignore # ignore/add/remove/force
678
679# Add or remove space between 'try' and '{' if on the same line.
680sp_try_brace = ignore # ignore/add/remove/force
681
682# Add or remove space between get/set and '{' if on the same line.
683sp_getset_brace = ignore # ignore/add/remove/force
684
685# Add or remove space between a variable and '{' for C++ uniform
686# initialization.
687sp_word_brace_init_lst = ignore # ignore/add/remove/force
688
689# Add or remove space between a variable and '{' for a namespace.
690#
691# Default: add
692sp_word_brace_ns = ignore # ignore/add/remove/force
693
694# Add or remove space before the '::' operator.
695sp_before_dc = ignore # ignore/add/remove/force
696
697# Add or remove space after the '::' operator.
698sp_after_dc = ignore # ignore/add/remove/force
699
700# (D) Add or remove around the D named array initializer ':' operator.
701sp_d_array_colon = remove # ignore/add/remove/force
702
703# Add or remove space after the '!' (not) unary operator.
704#
705# Default: remove
Michal Vaskoe1445952020-08-24 11:19:42 +0200706sp_not = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200707
708# Add or remove space after the '~' (invert) unary operator.
709#
710# Default: remove
Michal Vaskoe1445952020-08-24 11:19:42 +0200711sp_inv = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200712
713# Add or remove space after the '&' (address-of) unary operator. This does not
714# affect the spacing after a '&' that is part of a type.
715#
716# Default: remove
Michal Vaskoe1445952020-08-24 11:19:42 +0200717sp_addr = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200718
719# Add or remove space around the '.' or '->' operators.
720#
721# Default: remove
Michal Vaskoe1445952020-08-24 11:19:42 +0200722sp_member = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200723
724# Add or remove space after the '*' (dereference) unary operator. This does
725# not affect the spacing after a '*' that is part of a type.
726#
727# Default: remove
Michal Vaskoe1445952020-08-24 11:19:42 +0200728sp_deref = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200729
730# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'.
731#
732# Default: remove
Michal Vaskoe1445952020-08-24 11:19:42 +0200733sp_sign = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200734
735# Add or remove space between '++' and '--' the word to which it is being
736# applied, as in '(--x)' or 'y++;'.
737#
738# Default: remove
Michal Vaskoe1445952020-08-24 11:19:42 +0200739sp_incdec = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200740
741# Add or remove space before a backslash-newline at the end of a line.
742#
743# Default: add
744sp_before_nl_cont = ignore # ignore/add/remove/force
745
746# (OC) Add or remove space after the scope '+' or '-', as in '-(void) foo;'
747# or '+(int) bar;'.
748sp_after_oc_scope = ignore # ignore/add/remove/force
749
750# (OC) Add or remove space after the colon in message specs,
751# i.e. '-(int) f:(int) x;' vs. '-(int) f: (int) x;'.
752sp_after_oc_colon = ignore # ignore/add/remove/force
753
754# (OC) Add or remove space before the colon in message specs,
755# i.e. '-(int) f: (int) x;' vs. '-(int) f : (int) x;'.
756sp_before_oc_colon = ignore # ignore/add/remove/force
757
758# (OC) Add or remove space after the colon in immutable dictionary expression
759# 'NSDictionary *test = @{@"foo" :@"bar"};'.
760sp_after_oc_dict_colon = ignore # ignore/add/remove/force
761
762# (OC) Add or remove space before the colon in immutable dictionary expression
763# 'NSDictionary *test = @{@"foo" :@"bar"};'.
764sp_before_oc_dict_colon = ignore # ignore/add/remove/force
765
766# (OC) Add or remove space after the colon in message specs,
767# i.e. '[object setValue:1];' vs. '[object setValue: 1];'.
768sp_after_send_oc_colon = ignore # ignore/add/remove/force
769
770# (OC) Add or remove space before the colon in message specs,
771# i.e. '[object setValue:1];' vs. '[object setValue :1];'.
772sp_before_send_oc_colon = ignore # ignore/add/remove/force
773
774# (OC) Add or remove space after the (type) in message specs,
775# i.e. '-(int)f: (int) x;' vs. '-(int)f: (int)x;'.
776sp_after_oc_type = ignore # ignore/add/remove/force
777
778# (OC) Add or remove space after the first (type) in message specs,
779# i.e. '-(int) f:(int)x;' vs. '-(int)f:(int)x;'.
780sp_after_oc_return_type = ignore # ignore/add/remove/force
781
782# (OC) Add or remove space between '@selector' and '(',
783# i.e. '@selector(msgName)' vs. '@selector (msgName)'.
784# Also applies to '@protocol()' constructs.
785sp_after_oc_at_sel = ignore # ignore/add/remove/force
786
787# (OC) Add or remove space between '@selector(x)' and the following word,
788# i.e. '@selector(foo) a:' vs. '@selector(foo)a:'.
789sp_after_oc_at_sel_parens = ignore # ignore/add/remove/force
790
791# (OC) Add or remove space inside '@selector' parentheses,
792# i.e. '@selector(foo)' vs. '@selector( foo )'.
793# Also applies to '@protocol()' constructs.
794sp_inside_oc_at_sel_parens = ignore # ignore/add/remove/force
795
796# (OC) Add or remove space before a block pointer caret,
797# i.e. '^int (int arg){...}' vs. ' ^int (int arg){...}'.
798sp_before_oc_block_caret = ignore # ignore/add/remove/force
799
800# (OC) Add or remove space after a block pointer caret,
801# i.e. '^int (int arg){...}' vs. '^ int (int arg){...}'.
802sp_after_oc_block_caret = ignore # ignore/add/remove/force
803
804# (OC) Add or remove space between the receiver and selector in a message,
805# as in '[receiver selector ...]'.
806sp_after_oc_msg_receiver = ignore # ignore/add/remove/force
807
808# (OC) Add or remove space after '@property'.
809sp_after_oc_property = ignore # ignore/add/remove/force
810
811# (OC) Add or remove space between '@synchronized' and the open parenthesis,
812# i.e. '@synchronized(foo)' vs. '@synchronized (foo)'.
813sp_after_oc_synchronized = ignore # ignore/add/remove/force
814
815# Add or remove space around the ':' in 'b ? t : f'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200816sp_cond_colon = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200817
818# Add or remove space before the ':' in 'b ? t : f'.
819#
820# Overrides sp_cond_colon.
Michal Vaskoe1445952020-08-24 11:19:42 +0200821sp_cond_colon_before = ignore # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200822
823# Add or remove space after the ':' in 'b ? t : f'.
824#
825# Overrides sp_cond_colon.
Michal Vaskoe1445952020-08-24 11:19:42 +0200826sp_cond_colon_after = ignore # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200827
828# Add or remove space around the '?' in 'b ? t : f'.
Michal Vaskoe1445952020-08-24 11:19:42 +0200829sp_cond_question = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200830
831# Add or remove space before the '?' in 'b ? t : f'.
832#
833# Overrides sp_cond_question.
834sp_cond_question_before = ignore # ignore/add/remove/force
835
836# Add or remove space after the '?' in 'b ? t : f'.
837#
838# Overrides sp_cond_question.
839sp_cond_question_after = ignore # ignore/add/remove/force
840
841# In the abbreviated ternary form '(a ?: b)', add or remove space between '?'
842# and ':'.
843#
844# Overrides all other sp_cond_* options.
Michal Vaskoe1445952020-08-24 11:19:42 +0200845sp_cond_ternary_short = remove # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200846
847# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make
848# sense here.
Michal Vaskoe1445952020-08-24 11:19:42 +0200849sp_case_label = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200850
851# (D) Add or remove space around the D '..' operator.
852sp_range = ignore # ignore/add/remove/force
853
854# Add or remove space after ':' in a Java/C++11 range-based 'for',
855# as in 'for (Type var : expr)'.
856sp_after_for_colon = ignore # ignore/add/remove/force
857
858# Add or remove space before ':' in a Java/C++11 range-based 'for',
859# as in 'for (Type var : expr)'.
860sp_before_for_colon = ignore # ignore/add/remove/force
861
862# (D) Add or remove space between 'extern' and '(' as in 'extern (C)'.
863sp_extern_paren = ignore # ignore/add/remove/force
864
865# Add or remove space after the opening of a C++ comment,
866# i.e. '// A' vs. '//A'.
Michal Vasko033278d2020-08-24 11:24:52 +0200867sp_cmt_cpp_start = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200868
869# If true, space is added with sp_cmt_cpp_start will be added after doxygen
870# sequences like '///', '///<', '//!' and '//!<'.
871sp_cmt_cpp_doxygen = true # true/false
872
873# If true, space is added with sp_cmt_cpp_start will be added after Qt
874# translator or meta-data comments like '//:', '//=', and '//~'.
875sp_cmt_cpp_qttr = true # true/false
876
877# Add or remove space between #else or #endif and a trailing comment.
Michal Vasko033278d2020-08-24 11:24:52 +0200878sp_endif_cmt = force # ignore/add/remove/force
Radek Krejcia198c962020-08-16 10:32:10 +0200879
880# Add or remove space after 'new', 'delete' and 'delete[]'.
881sp_after_new = ignore # ignore/add/remove/force
882
883# Add or remove space between 'new' and '(' in 'new()'.
884sp_between_new_paren = ignore # ignore/add/remove/force
885
886# Add or remove space between ')' and type in 'new(foo) BAR'.
887sp_after_newop_paren = ignore # ignore/add/remove/force
888
889# Add or remove space inside parenthesis of the new operator
890# as in 'new(foo) BAR'.
891sp_inside_newop_paren = ignore # ignore/add/remove/force
892
893# Add or remove space after the open parenthesis of the new operator,
894# as in 'new(foo) BAR'.
895#
896# Overrides sp_inside_newop_paren.
897sp_inside_newop_paren_open = ignore # ignore/add/remove/force
898
899# Add or remove space before the close parenthesis of the new operator,
900# as in 'new(foo) BAR'.
901#
902# Overrides sp_inside_newop_paren.
903sp_inside_newop_paren_close = ignore # ignore/add/remove/force
904
905# Add or remove space before a trailing or embedded comment.
906sp_before_tr_emb_cmt = ignore # ignore/add/remove/force
907
908# Number of spaces before a trailing or embedded comment.
909sp_num_before_tr_emb_cmt = 0 # unsigned number
910
911# (Java) Add or remove space between an annotation and the open parenthesis.
912sp_annotation_paren = ignore # ignore/add/remove/force
913
914# If true, vbrace tokens are dropped to the previous token and skipped.
915sp_skip_vbrace_tokens = false # true/false
916
917# Add or remove space after 'noexcept'.
918sp_after_noexcept = ignore # ignore/add/remove/force
919
920# Add or remove space after '_'.
921sp_vala_after_translation = ignore # ignore/add/remove/force
922
923# If true, a <TAB> is inserted after #define.
924force_tab_after_define = false # true/false
925
926#
927# Indenting options
928#
929
930# The number of columns to indent per level. Usually 2, 3, 4, or 8.
931#
932# Default: 8
933indent_columns = 4 # unsigned number
934
935# The continuation indent. If non-zero, this overrides the indent of '(', '['
936# and '=' continuation indents. Negative values are OK; negative value is
937# absolute and not increased for each '(' or '[' level.
938#
939# For FreeBSD, this is set to 4.
940indent_continue = 8 # number
941
942# The continuation indent, only for class header line(s). If non-zero, this
943# overrides the indent of 'class' continuation indents.
944indent_continue_class_head = 0 # unsigned number
945
946# Whether to indent empty lines (i.e. lines which contain only spaces before
947# the newline character).
948indent_single_newlines = false # true/false
949
950# The continuation indent for func_*_param if they are true. If non-zero, this
951# overrides the indent.
952indent_param = 0 # unsigned number
953
954# How to use tabs when indenting code.
955#
956# 0: Spaces only
957# 1: Indent with tabs to brace level, align with spaces (default)
958# 2: Indent and align with tabs, using spaces when not on a tabstop
959#
960# Default: 1
961indent_with_tabs = 0 # unsigned number
962
963# Whether to indent comments that are not at a brace level with tabs on a
964# tabstop. Requires indent_with_tabs=2. If false, will use spaces.
965indent_cmt_with_tabs = false # true/false
966
967# Whether to indent strings broken by '\' so that they line up.
968indent_align_string = false # true/false
969
970# The number of spaces to indent multi-line XML strings.
971# Requires indent_align_string=true.
972indent_xml_string = 2 # unsigned number
973
974# Spaces to indent '{' from level.
975indent_brace = 0 # unsigned number
976
977# Whether braces are indented to the body level.
978indent_braces = false # true/false
979
980# Whether to disable indenting function braces if indent_braces=true.
981indent_braces_no_func = false # true/false
982
983# Whether to disable indenting class braces if indent_braces=true.
984indent_braces_no_class = false # true/false
985
986# Whether to disable indenting struct braces if indent_braces=true.
987indent_braces_no_struct = false # true/false
988
989# Whether to indent based on the size of the brace parent,
990# i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
991indent_brace_parent = false # true/false
992
993# Whether to indent based on the open parenthesis instead of the open brace
994# in '({\n'.
995indent_paren_open_brace = false # true/false
996
997# (C#) Whether to indent the brace of a C# delegate by another level.
998indent_cs_delegate_brace = false # true/false
999
1000# (C#) Whether to indent a C# delegate (to handle delegates with no brace) by
1001# another level.
1002indent_cs_delegate_body = false # true/false
1003
1004# Whether to indent the body of a 'namespace'.
1005indent_namespace = false # true/false
1006
1007# Whether to indent only the first namespace, and not any nested namespaces.
1008# Requires indent_namespace=true.
1009indent_namespace_single_indent = false # true/false
1010
1011# The number of spaces to indent a namespace block.
1012# If set to zero, use the value indent_columns
1013indent_namespace_level = 0 # unsigned number
1014
1015# If the body of the namespace is longer than this number, it won't be
1016# indented. Requires indent_namespace=true. 0 means no limit.
1017indent_namespace_limit = 0 # unsigned number
1018
1019# Whether the 'extern "C"' body is indented.
1020indent_extern = false # true/false
1021
1022# Whether the 'class' body is indented.
1023indent_class = false # true/false
1024
1025# Whether to indent the stuff after a leading base class colon.
1026indent_class_colon = false # true/false
1027
1028# Whether to indent based on a class colon instead of the stuff after the
1029# colon. Requires indent_class_colon=true.
1030indent_class_on_colon = false # true/false
1031
1032# Whether to indent the stuff after a leading class initializer colon.
1033indent_constr_colon = false # true/false
1034
1035# Virtual indent from the ':' for member initializers.
1036#
1037# Default: 2
1038indent_ctor_init_leading = 0 # unsigned number
1039
1040# Additional indent for constructor initializer list.
1041# Negative values decrease indent down to the first column.
1042indent_ctor_init = 0 # number
1043
1044# Whether to indent 'if' following 'else' as a new block under the 'else'.
1045# If false, 'else\nif' is treated as 'else if' for indenting purposes.
1046indent_else_if = false # true/false
1047
1048# Amount to indent variable declarations after a open brace.
1049#
1050# <0: Relative
1051# >=0: Absolute
1052indent_var_def_blk = 0 # number
1053
1054# Whether to indent continued variable declarations instead of aligning.
1055indent_var_def_cont = false # true/false
1056
1057# Whether to indent continued shift expressions ('<<' and '>>') instead of
1058# aligning. Set align_left_shift=false when enabling this.
1059indent_shift = false # true/false
1060
1061# Whether to force indentation of function definitions to start in column 1.
1062indent_func_def_force_col1 = false # true/false
1063
1064# Whether to indent continued function call parameters one indent level,
1065# rather than aligning parameters under the open parenthesis.
1066indent_func_call_param = false # true/false
1067
1068# Whether to indent continued function definition parameters one indent level,
1069# rather than aligning parameters under the open parenthesis.
1070indent_func_def_param = false # true/false
1071
1072# for function definitions, only if indent_func_def_param is false
1073# Allows to align params when appropriate and indent them when not
1074# behave as if it was true if paren position is more than this value
1075# if paren position is more than the option value
1076indent_func_def_param_paren_pos_threshold = 0 # unsigned number
1077
1078# Whether to indent continued function call prototype one indent level,
1079# rather than aligning parameters under the open parenthesis.
1080indent_func_proto_param = false # true/false
1081
1082# Whether to indent continued function call declaration one indent level,
1083# rather than aligning parameters under the open parenthesis.
1084indent_func_class_param = false # true/false
1085
1086# Whether to indent continued class variable constructors one indent level,
1087# rather than aligning parameters under the open parenthesis.
1088indent_func_ctor_var_param = false # true/false
1089
1090# Whether to indent continued template parameter list one indent level,
1091# rather than aligning parameters under the open parenthesis.
1092indent_template_param = false # true/false
1093
1094# Double the indent for indent_func_xxx_param options.
1095# Use both values of the options indent_columns and indent_param.
1096indent_func_param_double = false # true/false
1097
1098# Indentation column for standalone 'const' qualifier on a function
1099# prototype.
1100indent_func_const = 0 # unsigned number
1101
1102# Indentation column for standalone 'throw' qualifier on a function
1103# prototype.
1104indent_func_throw = 0 # unsigned number
1105
1106# How to indent within a macro followed by a brace on the same line
1107# This allows reducing the indent in macros that have (for example)
1108# `do { ... } while (0)` blocks bracketing them.
1109#
1110# true: add an indent for the brace on the same line as the macro
1111# false: do not add an indent for the brace on the same line as the macro
1112#
1113# Default: true
1114indent_macro_brace = false # true/false
1115
1116# The number of spaces to indent a continued '->' or '.'.
1117# Usually set to 0, 1, or indent_columns.
1118indent_member = 0 # unsigned number
1119
1120# Whether lines broken at '.' or '->' should be indented by a single indent.
1121# The indent_member option will not be effective if this is set to true.
1122indent_member_single = false # true/false
1123
1124# Spaces to indent single line ('//') comments on lines before code.
1125indent_sing_line_comments = 0 # unsigned number
1126
1127# When opening a paren for a control statement (if, for, while, etc), increase
1128# the indent level by this value. Negative values decrease the indent level.
1129indent_sparen_extra = 0 # number
1130
1131# Whether to indent trailing single line ('//') comments relative to the code
1132# instead of trying to keep the same absolute column.
1133indent_relative_single_line_comments = false # true/false
1134
1135# Spaces to indent 'case' from 'switch'. Usually 0 or indent_columns.
1136indent_switch_case = 0 # unsigned number
1137
1138# indent 'break' with 'case' from 'switch'.
1139indent_switch_break_with_case = false # true/false
1140
1141# Whether to indent preprocessor statements inside of switch statements.
1142#
1143# Default: true
1144indent_switch_pp = false # true/false
1145
1146# Spaces to shift the 'case' line, without affecting any other lines.
1147# Usually 0.
1148indent_case_shift = 0 # unsigned number
1149
1150# Spaces to indent '{' from 'case'. By default, the brace will appear under
1151# the 'c' in case. Usually set to 0 or indent_columns. Negative values are OK.
1152indent_case_brace = 0 # number
1153
1154# Whether to indent comments found in first column.
1155indent_col1_comment = false # true/false
1156
1157# Whether to indent multi string literal in first column.
1158indent_col1_multi_string_literal = false # true/false
1159
1160# How to indent goto labels.
1161#
1162# >0: Absolute column where 1 is the leftmost column
1163# <=0: Subtract from brace indent
1164#
1165# Default: 1
1166indent_label = 1 # number
1167
1168# How to indent access specifiers that are followed by a
1169# colon.
1170#
1171# >0: Absolute column where 1 is the leftmost column
1172# <=0: Subtract from brace indent
1173#
1174# Default: 1
1175indent_access_spec = 1 # number
1176
1177# Whether to indent the code after an access specifier by one level.
1178# If true, this option forces 'indent_access_spec=0'.
1179indent_access_spec_body = false # true/false
1180
1181# If an open parenthesis is followed by a newline, whether to indent the next
1182# line so that it lines up after the open parenthesis (not recommended).
1183indent_paren_nl = false # true/false
1184
1185# How to indent a close parenthesis after a newline.
1186#
1187# 0: Indent to body level (default)
1188# 1: Align under the open parenthesis
1189# 2: Indent to the brace level
1190indent_paren_close = 1 # unsigned number
1191
1192# Whether to indent the open parenthesis of a function definition,
1193# if the parenthesis is on its own line.
1194indent_paren_after_func_def = false # true/false
1195
1196# Whether to indent the open parenthesis of a function declaration,
1197# if the parenthesis is on its own line.
1198indent_paren_after_func_decl = false # true/false
1199
1200# Whether to indent the open parenthesis of a function call,
1201# if the parenthesis is on its own line.
1202indent_paren_after_func_call = false # true/false
1203
1204# Whether to indent a comma when inside a parenthesis.
1205# If true, aligns under the open parenthesis.
1206indent_comma_paren = true # true/false
1207
1208# Whether to indent a Boolean operator when inside a parenthesis.
1209# If true, aligns under the open parenthesis.
1210indent_bool_paren = false # true/false
1211
1212# Whether to indent a semicolon when inside a for parenthesis.
1213# If true, aligns under the open for parenthesis.
1214indent_semicolon_for_paren = false # true/false
1215
1216# Whether to align the first expression to following ones
1217# if indent_bool_paren=true.
1218indent_first_bool_expr = false # true/false
1219
1220# Whether to align the first expression to following ones
1221# if indent_semicolon_for_paren=true.
1222indent_first_for_expr = false # true/false
1223
1224# If an open square is followed by a newline, whether to indent the next line
1225# so that it lines up after the open square (not recommended).
1226indent_square_nl = false # true/false
1227
1228# (ESQL/C) Whether to preserve the relative indent of 'EXEC SQL' bodies.
1229indent_preserve_sql = false # true/false
1230
1231# Whether to align continued statements at the '='. If false or if the '=' is
1232# followed by a newline, the next line is indent one tab.
1233#
1234# Default: true
1235indent_align_assign = true # true/false
1236
1237# If true, the indentation of the chunks after a '=' sequence will be set at
1238# LHS token indentation column before '='.
1239indent_off_after_assign = false # true/false
1240
1241# Whether to align continued statements at the '('. If false or the '(' is
1242# followed by a newline, the next line indent is one tab.
1243#
1244# Default: true
1245indent_align_paren = true # true/false
1246
1247# (OC) Whether to indent Objective-C code inside message selectors.
1248indent_oc_inside_msg_sel = false # true/false
1249
1250# (OC) Whether to indent Objective-C blocks at brace level instead of usual
1251# rules.
1252indent_oc_block = false # true/false
1253
1254# (OC) Indent for Objective-C blocks in a message relative to the parameter
1255# name.
1256#
1257# =0: Use indent_oc_block rules
1258# >0: Use specified number of spaces to indent
1259indent_oc_block_msg = 0 # unsigned number
1260
1261# (OC) Minimum indent for subsequent parameters
1262indent_oc_msg_colon = 0 # unsigned number
1263
1264# (OC) Whether to prioritize aligning with initial colon (and stripping spaces
1265# from lines, if necessary).
1266#
1267# Default: true
1268indent_oc_msg_prioritize_first_colon = true # true/false
1269
1270# (OC) Whether to indent blocks the way that Xcode does by default
1271# (from the keyword if the parameter is on its own line; otherwise, from the
1272# previous indentation level). Requires indent_oc_block_msg=true.
1273indent_oc_block_msg_xcode_style = false # true/false
1274
1275# (OC) Whether to indent blocks from where the brace is, relative to a
1276# message keyword. Requires indent_oc_block_msg=true.
1277indent_oc_block_msg_from_keyword = false # true/false
1278
1279# (OC) Whether to indent blocks from where the brace is, relative to a message
1280# colon. Requires indent_oc_block_msg=true.
1281indent_oc_block_msg_from_colon = false # true/false
1282
1283# (OC) Whether to indent blocks from where the block caret is.
1284# Requires indent_oc_block_msg=true.
1285indent_oc_block_msg_from_caret = false # true/false
1286
1287# (OC) Whether to indent blocks from where the brace caret is.
1288# Requires indent_oc_block_msg=true.
1289indent_oc_block_msg_from_brace = false # true/false
1290
1291# When indenting after virtual brace open and newline add further spaces to
1292# reach this minimum indent.
1293indent_min_vbrace_open = 0 # unsigned number
1294
1295# Whether to add further spaces after regular indent to reach next tabstop
1296# when identing after virtual brace open and newline.
1297indent_vbrace_open_on_tabstop = false # true/false
1298
1299# How to indent after a brace followed by another token (not a newline).
1300# true: indent all contained lines to match the token
1301# false: indent all contained lines to match the brace
1302#
1303# Default: true
1304indent_token_after_brace = false # true/false
1305
1306# Whether to indent the body of a C++11 lambda.
1307indent_cpp_lambda_body = false # true/false
1308
1309# How to indent compound literals that are being returned.
1310# true: add both the indent from return & the compound literal open brace (ie:
1311# 2 indent levels)
1312# false: only indent 1 level, don't add the indent for the open brace, only add
1313# the indent for the return.
1314#
1315# Default: true
1316indent_compound_literal_return = true # true/false
1317
1318# (C#) Whether to indent a 'using' block if no braces are used.
1319#
1320# Default: true
1321indent_using_block = true # true/false
1322
1323# How to indent the continuation of ternary operator.
1324#
1325# 0: Off (default)
1326# 1: When the `if_false` is a continuation, indent it under `if_false`
1327# 2: When the `:` is a continuation, indent it under `?`
1328indent_ternary_operator = 2 # unsigned number
1329
1330# Whether to indent the statments inside ternary operator.
1331indent_inside_ternary_operator = false # true/false
1332
1333# If true, the indentation of the chunks after a `return` sequence will be set at return indentation column.
1334indent_off_after_return = false # true/false
1335
1336# If true, the indentation of the chunks after a `return new` sequence will be set at return indentation column.
1337indent_off_after_return_new = false # true/false
1338
1339# If true, the tokens after return are indented with regular single indentation. By default (false) the indentation is after the return token.
1340indent_single_after_return = false # true/false
1341
1342# Whether to ignore indent and alignment for 'asm' blocks (i.e. assume they
1343# have their own indentation).
1344indent_ignore_asm_block = true # true/false
1345
1346#
1347# Newline adding and removing options
1348#
1349
1350# Whether to collapse empty blocks between '{' and '}'.
1351nl_collapse_empty_body = true # true/false
1352
1353# Don't split one-line braced assignments, as in 'foo_t f = { 1, 2 };'.
1354nl_assign_leave_one_liners = true # true/false
1355
1356# Don't split one-line braced statements inside a 'class xx { }' body.
1357nl_class_leave_one_liners = true # true/false
1358
1359# Don't split one-line enums, as in 'enum foo { BAR = 15 };'
1360nl_enum_leave_one_liners = true # true/false
1361
1362# Don't split one-line get or set functions.
1363nl_getset_leave_one_liners = true # true/false
1364
1365# (C#) Don't split one-line property get or set functions.
1366nl_cs_property_leave_one_liners = true # true/false
1367
1368# Don't split one-line function definitions, as in 'int foo() { return 0; }'.
1369# might modify nl_func_type_name
1370nl_func_leave_one_liners = true # true/false
1371
1372# Don't split one-line C++11 lambdas, as in '[]() { return 0; }'.
1373nl_cpp_lambda_leave_one_liners = true # true/false
1374
1375# Don't split one-line if/else statements, as in 'if(...) b++;'.
1376nl_if_leave_one_liners = true # true/false
1377
1378# Don't split one-line while statements, as in 'while(...) b++;'.
1379nl_while_leave_one_liners = true # true/false
1380
1381# Don't split one-line for statements, as in 'for(...) b++;'.
1382nl_for_leave_one_liners = true # true/false
1383
1384# (OC) Don't split one-line Objective-C messages.
1385nl_oc_msg_leave_one_liner = true # true/false
1386
1387# (OC) Add or remove newline between method declaration and '{'.
1388nl_oc_mdef_brace = ignore # ignore/add/remove/force
1389
1390# (OC) Add or remove newline between Objective-C block signature and '{'.
1391nl_oc_block_brace = ignore # ignore/add/remove/force
1392
1393# (OC) Add or remove blank line before '@interface' statement.
1394nl_oc_before_interface = ignore # ignore/add/remove/force
1395
1396# (OC) Add or remove blank line before '@implementation' statement.
1397nl_oc_before_implementation = ignore # ignore/add/remove/force
1398
1399# (OC) Add or remove blank line before '@end' statement.
1400nl_oc_before_end = ignore # ignore/add/remove/force
1401
1402# (OC) Add or remove newline between '@interface' and '{'.
1403nl_oc_interface_brace = ignore # ignore/add/remove/force
1404
1405# (OC) Add or remove newline between '@implementation' and '{'.
1406nl_oc_implementation_brace = ignore # ignore/add/remove/force
1407
1408# Add or remove newlines at the start of the file.
1409nl_start_of_file = ignore # ignore/add/remove/force
1410
1411# The minimum number of newlines at the start of the file (only used if
1412# nl_start_of_file is 'add' or 'force').
1413nl_start_of_file_min = 0 # unsigned number
1414
1415# Add or remove newline at the end of the file.
1416nl_end_of_file = ignore # ignore/add/remove/force
1417
1418# The minimum number of newlines at the end of the file (only used if
1419# nl_end_of_file is 'add' or 'force').
1420nl_end_of_file_min = 0 # unsigned number
1421
1422# Add or remove newline between '=' and '{'.
1423nl_assign_brace = ignore # ignore/add/remove/force
1424
1425# (D) Add or remove newline between '=' and '['.
1426nl_assign_square = ignore # ignore/add/remove/force
1427
1428# Add or remove newline between '[]' and '{'.
1429nl_tsquare_brace = ignore # ignore/add/remove/force
1430
1431# (D) Add or remove newline after '= ['. Will also affect the newline before
1432# the ']'.
1433nl_after_square_assign = ignore # ignore/add/remove/force
1434
1435# Add or remove newline between a function call's ')' and '{', as in
1436# 'list_for_each(item, &list) { }'.
1437nl_fcall_brace = ignore # ignore/add/remove/force
1438
1439# Add or remove newline between 'enum' and '{'.
1440nl_enum_brace = ignore # ignore/add/remove/force
1441
1442# Add or remove newline between 'enum' and 'class'.
1443nl_enum_class = ignore # ignore/add/remove/force
1444
1445# Add or remove newline between 'enum class' and the identifier.
1446nl_enum_class_identifier = ignore # ignore/add/remove/force
1447
1448# Add or remove newline between 'enum class' type and ':'.
1449nl_enum_identifier_colon = ignore # ignore/add/remove/force
1450
1451# Add or remove newline between 'enum class identifier :' and type.
1452nl_enum_colon_type = ignore # ignore/add/remove/force
1453
1454# Add or remove newline between 'struct and '{'.
1455nl_struct_brace = ignore # ignore/add/remove/force
1456
1457# Add or remove newline between 'union' and '{'.
1458nl_union_brace = ignore # ignore/add/remove/force
1459
1460# Add or remove newline between 'if' and '{'.
1461nl_if_brace = ignore # ignore/add/remove/force
1462
1463# Add or remove newline between '}' and 'else'.
1464nl_brace_else = remove # ignore/add/remove/force
1465
1466# Add or remove newline between 'else if' and '{'. If set to ignore,
1467# nl_if_brace is used instead.
1468nl_elseif_brace = ignore # ignore/add/remove/force
1469
1470# Add or remove newline between 'else' and '{'.
1471nl_else_brace = ignore # ignore/add/remove/force
1472
1473# Add or remove newline between 'else' and 'if'.
1474nl_else_if = ignore # ignore/add/remove/force
1475
1476# Add or remove newline before '{' opening brace
1477nl_before_opening_brace_func_class_def = ignore # ignore/add/remove/force
1478
1479# Add or remove newline before 'if'/'else if' closing parenthesis.
1480nl_before_if_closing_paren = ignore # ignore/add/remove/force
1481
1482# Add or remove newline between '}' and 'finally'.
1483nl_brace_finally = ignore # ignore/add/remove/force
1484
1485# Add or remove newline between 'finally' and '{'.
1486nl_finally_brace = ignore # ignore/add/remove/force
1487
1488# Add or remove newline between 'try' and '{'.
1489nl_try_brace = ignore # ignore/add/remove/force
1490
1491# Add or remove newline between get/set and '{'.
1492nl_getset_brace = ignore # ignore/add/remove/force
1493
1494# Add or remove newline between 'for' and '{'.
1495nl_for_brace = ignore # ignore/add/remove/force
1496
1497# Add or remove newline before the '{' of a 'catch' statement, as in
1498# 'catch (decl) <here> {'.
1499nl_catch_brace = ignore # ignore/add/remove/force
1500
1501# (OC) Add or remove newline before the '{' of a '@catch' statement, as in
1502# '@catch (decl) <here> {'. If set to ignore, nl_catch_brace is used.
1503nl_oc_catch_brace = ignore # ignore/add/remove/force
1504
1505# Add or remove newline between '}' and 'catch'.
1506nl_brace_catch = ignore # ignore/add/remove/force
1507
1508# (OC) Add or remove newline between '}' and '@catch'. If set to ignore,
1509# nl_brace_catch is used.
1510nl_oc_brace_catch = ignore # ignore/add/remove/force
1511
1512# Add or remove newline between '}' and ']'.
1513nl_brace_square = ignore # ignore/add/remove/force
1514
1515# Add or remove newline between '}' and ')' in a function invocation.
1516nl_brace_fparen = ignore # ignore/add/remove/force
1517
1518# Add or remove newline between 'while' and '{'.
1519nl_while_brace = ignore # ignore/add/remove/force
1520
1521# (D) Add or remove newline between 'scope (x)' and '{'.
1522nl_scope_brace = ignore # ignore/add/remove/force
1523
1524# (D) Add or remove newline between 'unittest' and '{'.
1525nl_unittest_brace = ignore # ignore/add/remove/force
1526
1527# (D) Add or remove newline between 'version (x)' and '{'.
1528nl_version_brace = ignore # ignore/add/remove/force
1529
1530# (C#) Add or remove newline between 'using' and '{'.
1531nl_using_brace = ignore # ignore/add/remove/force
1532
1533# Add or remove newline between two open or close braces. Due to general
1534# newline/brace handling, REMOVE may not work.
1535nl_brace_brace = ignore # ignore/add/remove/force
1536
1537# Add or remove newline between 'do' and '{'.
1538nl_do_brace = ignore # ignore/add/remove/force
1539
1540# Add or remove newline between '}' and 'while' of 'do' statement.
1541nl_brace_while = ignore # ignore/add/remove/force
1542
1543# Add or remove newline between 'switch' and '{'.
1544nl_switch_brace = ignore # ignore/add/remove/force
1545
1546# Add or remove newline between 'synchronized' and '{'.
1547nl_synchronized_brace = ignore # ignore/add/remove/force
1548
1549# Add a newline between ')' and '{' if the ')' is on a different line than the
1550# if/for/etc.
1551#
1552# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch and
1553# nl_catch_brace.
1554nl_multi_line_cond = false # true/false
1555
1556# Add a newline after '(' if an if/for/while/switch condition spans multiple
1557# lines
1558nl_multi_line_sparen_open = ignore # ignore/add/remove/force
1559
1560# Add a newline before ')' if an if/for/while/switch condition spans multiple
1561# lines. Overrides nl_before_if_closing_paren if both are specified.
1562nl_multi_line_sparen_close = ignore # ignore/add/remove/force
1563
1564# Force a newline in a define after the macro name for multi-line defines.
1565nl_multi_line_define = false # true/false
1566
1567# Whether to add a newline before 'case', and a blank line before a 'case'
1568# statement that follows a ';' or '}'.
1569nl_before_case = false # true/false
1570
1571# Whether to add a newline after a 'case' statement.
1572nl_after_case = false # true/false
1573
1574# Add or remove newline between a case ':' and '{'.
1575#
1576# Overrides nl_after_case.
1577nl_case_colon_brace = ignore # ignore/add/remove/force
1578
1579# Add or remove newline between ')' and 'throw'.
1580nl_before_throw = ignore # ignore/add/remove/force
1581
1582# Add or remove newline between 'namespace' and '{'.
1583nl_namespace_brace = ignore # ignore/add/remove/force
1584
1585# Add or remove newline after 'template<...>' of a template class.
1586nl_template_class = ignore # ignore/add/remove/force
1587
1588# Add or remove newline after 'template<...>' of a template class declaration.
1589#
1590# Overrides nl_template_class.
1591nl_template_class_decl = ignore # ignore/add/remove/force
1592
1593# Add or remove newline after 'template<>' of a specialized class declaration.
1594#
1595# Overrides nl_template_class_decl.
1596nl_template_class_decl_special = ignore # ignore/add/remove/force
1597
1598# Add or remove newline after 'template<...>' of a template class definition.
1599#
1600# Overrides nl_template_class.
1601nl_template_class_def = ignore # ignore/add/remove/force
1602
1603# Add or remove newline after 'template<>' of a specialized class definition.
1604#
1605# Overrides nl_template_class_def.
1606nl_template_class_def_special = ignore # ignore/add/remove/force
1607
1608# Add or remove newline after 'template<...>' of a template function.
1609nl_template_func = ignore # ignore/add/remove/force
1610
1611# Add or remove newline after 'template<...>' of a template function
1612# declaration.
1613#
1614# Overrides nl_template_func.
1615nl_template_func_decl = ignore # ignore/add/remove/force
1616
1617# Add or remove newline after 'template<>' of a specialized function
1618# declaration.
1619#
1620# Overrides nl_template_func_decl.
1621nl_template_func_decl_special = ignore # ignore/add/remove/force
1622
1623# Add or remove newline after 'template<...>' of a template function
1624# definition.
1625#
1626# Overrides nl_template_func.
1627nl_template_func_def = ignore # ignore/add/remove/force
1628
1629# Add or remove newline after 'template<>' of a specialized function
1630# definition.
1631#
1632# Overrides nl_template_func_def.
1633nl_template_func_def_special = ignore # ignore/add/remove/force
1634
1635# Add or remove newline after 'template<...>' of a template variable.
1636nl_template_var = ignore # ignore/add/remove/force
1637
1638# Add or remove newline between 'template<...>' and 'using' of a templated
1639# type alias.
1640nl_template_using = ignore # ignore/add/remove/force
1641
1642# Add or remove newline between 'class' and '{'.
1643nl_class_brace = ignore # ignore/add/remove/force
1644
1645# Add or remove newline before or after (depending on pos_class_comma,
1646# may not be IGNORE) each',' in the base class list.
1647nl_class_init_args = ignore # ignore/add/remove/force
1648
1649# Add or remove newline after each ',' in the constructor member
1650# initialization. Related to nl_constr_colon, pos_constr_colon and
1651# pos_constr_comma.
1652nl_constr_init_args = ignore # ignore/add/remove/force
1653
1654# Add or remove newline before first element, after comma, and after last
1655# element, in 'enum'.
1656nl_enum_own_lines = ignore # ignore/add/remove/force
1657
1658# Add or remove newline between return type and function name in a function
1659# definition.
1660# might be modified by nl_func_leave_one_liners
1661nl_func_type_name = ignore # ignore/add/remove/force
1662
1663# Add or remove newline between return type and function name inside a class
1664# definition. If set to ignore, nl_func_type_name or nl_func_proto_type_name
1665# is used instead.
1666nl_func_type_name_class = ignore # ignore/add/remove/force
1667
1668# Add or remove newline between class specification and '::'
1669# in 'void A::f() { }'. Only appears in separate member implementation (does
1670# not appear with in-line implementation).
1671nl_func_class_scope = ignore # ignore/add/remove/force
1672
1673# Add or remove newline between function scope and name, as in
1674# 'void A :: <here> f() { }'.
1675nl_func_scope_name = ignore # ignore/add/remove/force
1676
1677# Add or remove newline between return type and function name in a prototype.
1678nl_func_proto_type_name = ignore # ignore/add/remove/force
1679
1680# Add or remove newline between a function name and the opening '(' in the
1681# declaration.
1682nl_func_paren = ignore # ignore/add/remove/force
1683
1684# Overrides nl_func_paren for functions with no parameters.
1685nl_func_paren_empty = ignore # ignore/add/remove/force
1686
1687# Add or remove newline between a function name and the opening '(' in the
1688# definition.
1689nl_func_def_paren = ignore # ignore/add/remove/force
1690
1691# Overrides nl_func_def_paren for functions with no parameters.
1692nl_func_def_paren_empty = ignore # ignore/add/remove/force
1693
1694# Add or remove newline between a function name and the opening '(' in the
1695# call.
1696nl_func_call_paren = ignore # ignore/add/remove/force
1697
1698# Overrides nl_func_call_paren for functions with no parameters.
1699nl_func_call_paren_empty = ignore # ignore/add/remove/force
1700
1701# Add or remove newline after '(' in a function declaration.
1702nl_func_decl_start = ignore # ignore/add/remove/force
1703
1704# Add or remove newline after '(' in a function definition.
1705nl_func_def_start = ignore # ignore/add/remove/force
1706
1707# Overrides nl_func_decl_start when there is only one parameter.
1708nl_func_decl_start_single = ignore # ignore/add/remove/force
1709
1710# Overrides nl_func_def_start when there is only one parameter.
1711nl_func_def_start_single = ignore # ignore/add/remove/force
1712
1713# Whether to add a newline after '(' in a function declaration if '(' and ')'
1714# are in different lines. If false, nl_func_decl_start is used instead.
1715nl_func_decl_start_multi_line = false # true/false
1716
1717# Whether to add a newline after '(' in a function definition if '(' and ')'
1718# are in different lines. If false, nl_func_def_start is used instead.
1719nl_func_def_start_multi_line = false # true/false
1720
1721# Add or remove newline after each ',' in a function declaration.
1722nl_func_decl_args = ignore # ignore/add/remove/force
1723
1724# Add or remove newline after each ',' in a function definition.
1725nl_func_def_args = ignore # ignore/add/remove/force
1726
1727# Add or remove newline after each ',' in a function call.
1728nl_func_call_args = ignore # ignore/add/remove/force
1729
1730# Whether to add a newline after each ',' in a function declaration if '('
1731# and ')' are in different lines. If false, nl_func_decl_args is used instead.
1732nl_func_decl_args_multi_line = false # true/false
1733
1734# Whether to add a newline after each ',' in a function definition if '('
1735# and ')' are in different lines. If false, nl_func_def_args is used instead.
1736nl_func_def_args_multi_line = false # true/false
1737
1738# Add or remove newline before the ')' in a function declaration.
1739nl_func_decl_end = ignore # ignore/add/remove/force
1740
1741# Add or remove newline before the ')' in a function definition.
1742nl_func_def_end = ignore # ignore/add/remove/force
1743
1744# Overrides nl_func_decl_end when there is only one parameter.
1745nl_func_decl_end_single = ignore # ignore/add/remove/force
1746
1747# Overrides nl_func_def_end when there is only one parameter.
1748nl_func_def_end_single = ignore # ignore/add/remove/force
1749
1750# Whether to add a newline before ')' in a function declaration if '(' and ')'
1751# are in different lines. If false, nl_func_decl_end is used instead.
1752nl_func_decl_end_multi_line = false # true/false
1753
1754# Whether to add a newline before ')' in a function definition if '(' and ')'
1755# are in different lines. If false, nl_func_def_end is used instead.
1756nl_func_def_end_multi_line = false # true/false
1757
1758# Add or remove newline between '()' in a function declaration.
1759nl_func_decl_empty = ignore # ignore/add/remove/force
1760
1761# Add or remove newline between '()' in a function definition.
1762nl_func_def_empty = ignore # ignore/add/remove/force
1763
1764# Add or remove newline between '()' in a function call.
1765nl_func_call_empty = ignore # ignore/add/remove/force
1766
1767# Whether to add a newline after '(' in a function call,
1768# has preference over nl_func_call_start_multi_line.
1769nl_func_call_start = ignore # ignore/add/remove/force
1770
1771# Whether to add a newline before ')' in a function call.
1772nl_func_call_end = ignore # ignore/add/remove/force
1773
1774# Whether to add a newline after '(' in a function call if '(' and ')' are in
1775# different lines.
1776nl_func_call_start_multi_line = false # true/false
1777
1778# Whether to add a newline after each ',' in a function call if '(' and ')'
1779# are in different lines.
1780nl_func_call_args_multi_line = false # true/false
1781
1782# Whether to add a newline before ')' in a function call if '(' and ')' are in
1783# different lines.
1784nl_func_call_end_multi_line = false # true/false
1785
1786# Whether to respect nl_func_call_XXX option incase of closure args.
1787nl_func_call_args_multi_line_ignore_closures = false # true/false
1788
1789# Whether to add a newline after '<' of a template parameter list.
1790nl_template_start = false # true/false
1791
1792# Whether to add a newline after each ',' in a template parameter list.
1793nl_template_args = false # true/false
1794
1795# Whether to add a newline before '>' of a template parameter list.
1796nl_template_end = false # true/false
1797
1798# (OC) Whether to put each Objective-C message parameter on a separate line.
1799# See nl_oc_msg_leave_one_liner.
1800nl_oc_msg_args = false # true/false
1801
1802# Add or remove newline between function signature and '{'.
1803nl_fdef_brace = ignore # ignore/add/remove/force
1804
1805# Add or remove newline between function signature and '{',
1806# if signature ends with ')'. Overrides nl_fdef_brace.
1807nl_fdef_brace_cond = ignore # ignore/add/remove/force
1808
1809# Add or remove newline between C++11 lambda signature and '{'.
1810nl_cpp_ldef_brace = ignore # ignore/add/remove/force
1811
1812# Add or remove newline between 'return' and the return expression.
1813nl_return_expr = ignore # ignore/add/remove/force
1814
1815# Whether to add a newline after semicolons, except in 'for' statements.
1816nl_after_semicolon = false # true/false
1817
1818# (Java) Add or remove newline between the ')' and '{{' of the double brace
1819# initializer.
1820nl_paren_dbrace_open = ignore # ignore/add/remove/force
1821
1822# Whether to add a newline after the type in an unnamed temporary
1823# direct-list-initialization.
1824nl_type_brace_init_lst = ignore # ignore/add/remove/force
1825
1826# Whether to add a newline after the open brace in an unnamed temporary
1827# direct-list-initialization.
1828nl_type_brace_init_lst_open = ignore # ignore/add/remove/force
1829
1830# Whether to add a newline before the close brace in an unnamed temporary
1831# direct-list-initialization.
1832nl_type_brace_init_lst_close = ignore # ignore/add/remove/force
1833
1834# Whether to add a newline after '{'. This also adds a newline before the
1835# matching '}'.
1836nl_after_brace_open = false # true/false
1837
1838# Whether to add a newline between the open brace and a trailing single-line
1839# comment. Requires nl_after_brace_open=true.
1840nl_after_brace_open_cmt = false # true/false
1841
1842# Whether to add a newline after a virtual brace open with a non-empty body.
1843# These occur in un-braced if/while/do/for statement bodies.
1844nl_after_vbrace_open = false # true/false
1845
1846# Whether to add a newline after a virtual brace open with an empty body.
1847# These occur in un-braced if/while/do/for statement bodies.
1848nl_after_vbrace_open_empty = false # true/false
1849
1850# Whether to add a newline after '}'. Does not apply if followed by a
1851# necessary ';'.
1852nl_after_brace_close = false # true/false
1853
1854# Whether to add a newline after a virtual brace close,
1855# as in 'if (foo) a++; <here> return;'.
1856nl_after_vbrace_close = false # true/false
1857
1858# Add or remove newline between the close brace and identifier,
1859# as in 'struct { int a; } <here> b;'. Affects enumerations, unions and
1860# structures. If set to ignore, uses nl_after_brace_close.
1861nl_brace_struct_var = ignore # ignore/add/remove/force
1862
1863# Whether to alter newlines in '#define' macros.
1864nl_define_macro = false # true/false
1865
1866# Whether to alter newlines between consecutive parenthesis closes. The number
1867# of closing parentheses in a line will depend on respective open parenthesis
1868# lines.
1869nl_squeeze_paren_close = false # true/false
1870
1871# Whether to remove blanks after '#ifxx' and '#elxx', or before '#elxx' and
1872# '#endif'. Does not affect top-level #ifdefs.
1873nl_squeeze_ifdef = false # true/false
1874
1875# Makes the nl_squeeze_ifdef option affect the top-level #ifdefs as well.
1876nl_squeeze_ifdef_top_level = false # true/false
1877
1878# Add or remove blank line before 'if'.
1879nl_before_if = ignore # ignore/add/remove/force
1880
1881# Add or remove blank line after 'if' statement. Add/Force work only if the
1882# next token is not a closing brace.
1883nl_after_if = ignore # ignore/add/remove/force
1884
1885# Add or remove blank line before 'for'.
1886nl_before_for = ignore # ignore/add/remove/force
1887
1888# Add or remove blank line after 'for' statement.
1889nl_after_for = ignore # ignore/add/remove/force
1890
1891# Add or remove blank line before 'while'.
1892nl_before_while = ignore # ignore/add/remove/force
1893
1894# Add or remove blank line after 'while' statement.
1895nl_after_while = ignore # ignore/add/remove/force
1896
1897# Add or remove blank line before 'switch'.
1898nl_before_switch = ignore # ignore/add/remove/force
1899
1900# Add or remove blank line after 'switch' statement.
1901nl_after_switch = ignore # ignore/add/remove/force
1902
1903# Add or remove blank line before 'synchronized'.
1904nl_before_synchronized = ignore # ignore/add/remove/force
1905
1906# Add or remove blank line after 'synchronized' statement.
1907nl_after_synchronized = ignore # ignore/add/remove/force
1908
1909# Add or remove blank line before 'do'.
1910nl_before_do = ignore # ignore/add/remove/force
1911
1912# Add or remove blank line after 'do/while' statement.
1913nl_after_do = ignore # ignore/add/remove/force
1914
1915# Whether to put a blank line before 'return' statements, unless after an open
1916# brace.
1917nl_before_return = false # true/false
1918
1919# Whether to put a blank line after 'return' statements, unless followed by a
1920# close brace.
1921nl_after_return = false # true/false
1922
1923# Whether to put a blank line before a member '.' or '->' operators.
1924nl_before_member = ignore # ignore/add/remove/force
1925
1926# (Java) Whether to put a blank line after a member '.' or '->' operators.
1927nl_after_member = ignore # ignore/add/remove/force
1928
1929# Whether to double-space commented-entries in 'struct'/'union'/'enum'.
1930nl_ds_struct_enum_cmt = false # true/false
1931
1932# Whether to force a newline before '}' of a 'struct'/'union'/'enum'.
1933# (Lower priority than eat_blanks_before_close_brace.)
1934nl_ds_struct_enum_close_brace = false # true/false
1935
1936# Add or remove newline before or after (depending on pos_class_colon) a class
1937# colon, as in 'class Foo <here> : <or here> public Bar'.
1938nl_class_colon = ignore # ignore/add/remove/force
1939
1940# Add or remove newline around a class constructor colon. The exact position
1941# depends on nl_constr_init_args, pos_constr_colon and pos_constr_comma.
1942nl_constr_colon = ignore # ignore/add/remove/force
1943
1944# Whether to collapse a two-line namespace, like 'namespace foo\n{ decl; }'
1945# into a single line. If true, prevents other brace newline rules from turning
1946# such code into four lines.
1947nl_namespace_two_to_one_liner = false # true/false
1948
1949# Whether to remove a newline in simple unbraced if statements, turning them
1950# into one-liners, as in 'if(b)\n i++;' => 'if(b) i++;'.
1951nl_create_if_one_liner = false # true/false
1952
1953# Whether to remove a newline in simple unbraced for statements, turning them
1954# into one-liners, as in 'for (...)\n stmt;' => 'for (...) stmt;'.
1955nl_create_for_one_liner = false # true/false
1956
1957# Whether to remove a newline in simple unbraced while statements, turning
1958# them into one-liners, as in 'while (expr)\n stmt;' => 'while (expr) stmt;'.
1959nl_create_while_one_liner = false # true/false
1960
1961# Whether to collapse a function definition whose body (not counting braces)
1962# is only one line so that the entire definition (prototype, braces, body) is
1963# a single line.
1964nl_create_func_def_one_liner = false # true/false
1965
1966# Whether to collapse a function definition whose body (not counting braces)
1967# is only one line so that the entire definition (prototype, braces, body) is
1968# a single line.
1969nl_create_list_one_liner = false # true/false
1970
1971# Whether to split one-line simple unbraced if statements into two lines by
1972# adding a newline, as in 'if(b) <here> i++;'.
1973nl_split_if_one_liner = false # true/false
1974
1975# Whether to split one-line simple unbraced for statements into two lines by
1976# adding a newline, as in 'for (...) <here> stmt;'.
1977nl_split_for_one_liner = false # true/false
1978
1979# Whether to split one-line simple unbraced while statements into two lines by
1980# adding a newline, as in 'while (expr) <here> stmt;'.
1981nl_split_while_one_liner = false # true/false
1982
1983#
1984# Blank line options
1985#
1986
1987# The maximum number of consecutive newlines (3 = 2 blank lines).
1988nl_max = 2 # unsigned number
1989
1990# The maximum number of consecutive newlines in a function.
1991nl_max_blank_in_func = 2 # unsigned number
1992
1993# The number of newlines before a function prototype.
1994nl_before_func_body_proto = 0 # unsigned number
1995
1996# The number of newlines before a multi-line function definition.
1997nl_before_func_body_def = 0 # unsigned number
1998
1999# The number of newlines before a class constructor/destructor prototype.
2000nl_before_func_class_proto = 0 # unsigned number
2001
2002# The number of newlines before a class constructor/destructor definition.
2003nl_before_func_class_def = 0 # unsigned number
2004
2005# The number of newlines after a function prototype.
2006nl_after_func_proto = 0 # unsigned number
2007
2008# The number of newlines after a function prototype, if not followed by
2009# another function prototype.
2010nl_after_func_proto_group = 0 # unsigned number
2011
2012# The number of newlines after a class constructor/destructor prototype.
2013nl_after_func_class_proto = 0 # unsigned number
2014
2015# The number of newlines after a class constructor/destructor prototype,
2016# if not followed by another constructor/destructor prototype.
2017nl_after_func_class_proto_group = 0 # unsigned number
2018
2019# Whether one-line method definitions inside a class body should be treated
2020# as if they were prototypes for the purposes of adding newlines.
2021#
2022# Requires nl_class_leave_one_liners=true. Overrides nl_before_func_body_def
2023# and nl_before_func_class_def for one-liners.
2024nl_class_leave_one_liner_groups = false # true/false
2025
2026# The number of newlines after '}' of a multi-line function body.
2027nl_after_func_body = 2 # unsigned number
2028
2029# The number of newlines after '}' of a multi-line function body in a class
2030# declaration. Also affects class constructors/destructors.
2031#
2032# Overrides nl_after_func_body.
2033nl_after_func_body_class = 2 # unsigned number
2034
2035# The number of newlines after '}' of a single line function body. Also
2036# affects class constructors/destructors.
2037#
2038# Overrides nl_after_func_body and nl_after_func_body_class.
2039nl_after_func_body_one_liner = 2 # unsigned number
2040
2041# The number of blank lines after a block of variable definitions at the top
2042# of a function body.
2043#
2044# 0: No change (default).
2045nl_func_var_def_blk = 0 # unsigned number
2046
2047# The number of newlines before a block of typedefs. If nl_after_access_spec
2048# is non-zero, that option takes precedence.
2049#
2050# 0: No change (default).
2051nl_typedef_blk_start = 0 # unsigned number
2052
2053# The number of newlines after a block of typedefs.
2054#
2055# 0: No change (default).
2056nl_typedef_blk_end = 0 # unsigned number
2057
2058# The maximum number of consecutive newlines within a block of typedefs.
2059#
2060# 0: No change (default).
2061nl_typedef_blk_in = 0 # unsigned number
2062
2063# The number of newlines before a block of variable definitions not at the top
2064# of a function body. If nl_after_access_spec is non-zero, that option takes
2065# precedence.
2066#
2067# 0: No change (default).
2068nl_var_def_blk_start = 0 # unsigned number
2069
2070# The number of newlines after a block of variable definitions not at the top
2071# of a function body.
2072#
2073# 0: No change (default).
2074nl_var_def_blk_end = 0 # unsigned number
2075
2076# The maximum number of consecutive newlines within a block of variable
2077# definitions.
2078#
2079# 0: No change (default).
2080nl_var_def_blk_in = 0 # unsigned number
2081
2082# The minimum number of newlines before a multi-line comment.
2083# Doesn't apply if after a brace open or another multi-line comment.
2084nl_before_block_comment = 0 # unsigned number
2085
2086# The minimum number of newlines before a single-line C comment.
2087# Doesn't apply if after a brace open or other single-line C comments.
2088nl_before_c_comment = 0 # unsigned number
2089
2090# The minimum number of newlines before a CPP comment.
2091# Doesn't apply if after a brace open or other CPP comments.
2092nl_before_cpp_comment = 0 # unsigned number
2093
2094# Whether to force a newline after a multi-line comment.
2095nl_after_multiline_comment = false # true/false
2096
2097# Whether to force a newline after a label's colon.
2098nl_after_label_colon = false # true/false
2099
2100# The number of newlines after '}' or ';' of a struct/enum/union definition.
2101nl_after_struct = 1 # unsigned number
2102
2103# The number of newlines before a class definition.
2104nl_before_class = 0 # unsigned number
2105
2106# The number of newlines after '}' or ';' of a class definition.
2107nl_after_class = 0 # unsigned number
2108
2109# The number of newlines before a namespace.
2110nl_before_namespace = 0 # unsigned number
2111
2112# The number of newlines after '{' of a namespace. This also adds newlines
2113# before the matching '}'.
2114#
2115# 0: Apply eat_blanks_after_open_brace or eat_blanks_before_close_brace if
2116# applicable, otherwise no change.
2117#
2118# Overrides eat_blanks_after_open_brace and eat_blanks_before_close_brace.
2119nl_inside_namespace = 0 # unsigned number
2120
2121# The number of newlines after '}' of a namespace.
2122nl_after_namespace = 0 # unsigned number
2123
2124# The number of newlines before an access specifier label. This also includes
2125# the Qt-specific 'signals:' and 'slots:'. Will not change the newline count
2126# if after a brace open.
2127#
2128# 0: No change (default).
2129nl_before_access_spec = 0 # unsigned number
2130
2131# The number of newlines after an access specifier label. This also includes
2132# the Qt-specific 'signals:' and 'slots:'. Will not change the newline count
2133# if after a brace open.
2134#
2135# 0: No change (default).
2136#
2137# Overrides nl_typedef_blk_start and nl_var_def_blk_start.
2138nl_after_access_spec = 0 # unsigned number
2139
2140# The number of newlines between a function definition and the function
2141# comment, as in '// comment\n <here> void foo() {...}'.
2142#
2143# 0: No change (default).
2144nl_comment_func_def = 0 # unsigned number
2145
2146# The number of newlines after a try-catch-finally block that isn't followed
2147# by a brace close.
2148#
2149# 0: No change (default).
2150nl_after_try_catch_finally = 0 # unsigned number
2151
2152# (C#) The number of newlines before and after a property, indexer or event
2153# declaration.
2154#
2155# 0: No change (default).
2156nl_around_cs_property = 0 # unsigned number
2157
2158# (C#) The number of newlines between the get/set/add/remove handlers.
2159#
2160# 0: No change (default).
2161nl_between_get_set = 0 # unsigned number
2162
2163# (C#) Add or remove newline between property and the '{'.
2164nl_property_brace = ignore # ignore/add/remove/force
2165
2166# Whether to remove blank lines after '{'.
2167eat_blanks_after_open_brace = false # true/false
2168
2169# Whether to remove blank lines before '}'.
2170eat_blanks_before_close_brace = false # true/false
2171
2172# How aggressively to remove extra newlines not in preprocessor.
2173#
2174# 0: No change (default)
2175# 1: Remove most newlines not handled by other config
2176# 2: Remove all newlines and reformat completely by config
2177nl_remove_extra_newlines = 0 # unsigned number
2178
2179# (Java) Add or remove newline after an annotation statement. Only affects
2180# annotations that are after a newline.
2181nl_after_annotation = ignore # ignore/add/remove/force
2182
2183# (Java) Add or remove newline between two annotations.
2184nl_between_annotation = ignore # ignore/add/remove/force
2185
2186# The number of newlines before a whole-file #ifdef.
2187#
2188# 0: No change (default).
2189nl_before_whole_file_ifdef = 0 # unsigned number
2190
2191# The number of newlines after a whole-file #ifdef.
2192#
2193# 0: No change (default).
2194nl_after_whole_file_ifdef = 0 # unsigned number
2195
2196# The number of newlines before a whole-file #endif.
2197#
2198# 0: No change (default).
2199nl_before_whole_file_endif = 0 # unsigned number
2200
2201# The number of newlines after a whole-file #endif.
2202#
2203# 0: No change (default).
2204nl_after_whole_file_endif = 0 # unsigned number
2205
2206#
2207# Positioning options
2208#
2209
2210# The position of arithmetic operators in wrapped expressions.
2211pos_arith = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2212
2213# The position of assignment in wrapped expressions. Do not affect '='
2214# followed by '{'.
2215pos_assign = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2216
2217# The position of Boolean operators in wrapped expressions.
2218pos_bool = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2219
2220# The position of comparison operators in wrapped expressions.
2221pos_compare = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2222
2223# The position of conditional operators, as in the '?' and ':' of
2224# 'expr ? stmt : stmt', in wrapped expressions.
2225pos_conditional = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2226
2227# The position of the comma in wrapped expressions.
2228pos_comma = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2229
2230# The position of the comma in enum entries.
2231pos_enum_comma = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2232
2233# The position of the comma in the base class list if there is more than one
2234# line. Affects nl_class_init_args.
2235pos_class_comma = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2236
2237# The position of the comma in the constructor initialization list.
2238# Related to nl_constr_colon, nl_constr_init_args and pos_constr_colon.
2239pos_constr_comma = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2240
2241# The position of trailing/leading class colon, between class and base class
2242# list. Affects nl_class_colon.
2243pos_class_colon = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2244
2245# The position of colons between constructor and member initialization.
2246# Related to nl_constr_colon, nl_constr_init_args and pos_constr_comma.
2247pos_constr_colon = ignore # ignore/break/force/lead/trail/join/lead_break/lead_force/trail_break/trail_force
2248
2249#
2250# Line splitting options
2251#
2252
2253# Try to limit code width to N columns.
2254code_width = 256 # unsigned number
2255
2256# Whether to fully split long 'for' statements at semi-colons.
2257ls_for_split_full = true # true/false
2258
2259# Whether to fully split long function prototypes/calls at commas.
2260# The option ls_code_width has priority over the option ls_func_split_full.
2261ls_func_split_full = false # true/false
2262
2263# Whether to split lines as close to code_width as possible and ignore some
2264# groupings.
2265# The option ls_code_width has priority over the option ls_func_split_full.
2266ls_code_width = false # true/false
2267
2268#
2269# Code alignment options (not left column spaces/tabs)
2270#
2271
2272# Whether to keep non-indenting tabs.
2273align_keep_tabs = false # true/false
2274
2275# Whether to use tabs for aligning.
2276align_with_tabs = false # true/false
2277
2278# Whether to bump out to the next tab when aligning.
2279align_on_tabstop = true # true/false
2280
2281# Whether to right-align numbers.
2282align_number_right = true # true/false
2283
2284# Whether to keep whitespace not required for alignment.
2285align_keep_extra_space = false # true/false
2286
2287# Whether to align variable definitions in prototypes and functions.
2288align_func_params = true # true/false
2289
2290# The span for aligning parameter definitions in function on parameter name.
2291#
2292# 0: Don't align (default).
2293align_func_params_span = 1 # unsigned number
2294
2295# The threshold for aligning function parameter definitions.
2296# Use a negative number for absolute thresholds.
2297#
2298# 0: No limit (default).
2299align_func_params_thresh = 0 # number
2300
2301# The gap for aligning function parameter definitions.
2302align_func_params_gap = 1 # unsigned number
2303
2304# The span for aligning constructor value.
2305#
2306# 0: Don't align (default).
2307align_constr_value_span = 0 # unsigned number
2308
2309# The threshold for aligning constructor value.
2310# Use a negative number for absolute thresholds.
2311#
2312# 0: No limit (default).
2313align_constr_value_thresh = 0 # number
2314
2315# The gap for aligning constructor value.
2316align_constr_value_gap = 0 # unsigned number
2317
2318# Whether to align parameters in single-line functions that have the same
2319# name. The function names must already be aligned with each other.
2320align_same_func_call_params = false # true/false
2321
2322# The span for aligning function-call parameters for single line functions.
2323#
2324# 0: Don't align (default).
2325align_same_func_call_params_span = 1 # unsigned number
2326
2327# The threshold for aligning function-call parameters for single line
2328# functions.
2329# Use a negative number for absolute thresholds.
2330#
2331# 0: No limit (default).
2332align_same_func_call_params_thresh = 0 # number
2333
2334# The span for aligning variable definitions.
2335#
2336# 0: Don't align (default).
2337align_var_def_span = 0 # unsigned number
2338
2339# How to consider (or treat) the '*' in the alignment of variable definitions.
2340#
2341# 0: Part of the type 'void * foo;' (default)
2342# 1: Part of the variable 'void *foo;'
2343# 2: Dangling 'void *foo;'
2344# Dangling: the '*' will not be taken into account when aligning.
2345align_var_def_star_style = 1 # unsigned number
2346
2347# How to consider (or treat) the '&' in the alignment of variable definitions.
2348#
2349# 0: Part of the type 'long & foo;' (default)
2350# 1: Part of the variable 'long &foo;'
2351# 2: Dangling 'long &foo;'
2352# Dangling: the '&' will not be taken into account when aligning.
2353align_var_def_amp_style = 1 # unsigned number
2354
2355# The threshold for aligning variable definitions.
2356# Use a negative number for absolute thresholds.
2357#
2358# 0: No limit (default).
2359align_var_def_thresh = 0 # number
2360
2361# The gap for aligning variable definitions.
2362align_var_def_gap = 0 # unsigned number
2363
2364# Whether to align the colon in struct bit fields.
2365align_var_def_colon = false # true/false
2366
2367# The gap for aligning the colon in struct bit fields.
2368align_var_def_colon_gap = 0 # unsigned number
2369
2370# Whether to align any attribute after the variable name.
2371align_var_def_attribute = false # true/false
2372
2373# Whether to align inline struct/enum/union variable definitions.
2374align_var_def_inline = false # true/false
2375
2376# The span for aligning on '=' in assignments.
2377#
2378# 0: Don't align (default).
2379align_assign_span = 0 # unsigned number
2380
2381# The span for aligning on '=' in function prototype modifier.
2382#
2383# 0: Don't align (default).
2384align_assign_func_proto_span = 0 # unsigned number
2385
2386# The threshold for aligning on '=' in assignments.
2387# Use a negative number for absolute thresholds.
2388#
2389# 0: No limit (default).
2390align_assign_thresh = 0 # number
2391
2392# How to apply align_assign_span to function declaration "assignments", i.e.
2393# 'virtual void foo() = 0' or '~foo() = {default|delete}'.
2394#
2395# 0: Align with other assignments (default)
2396# 1: Align with each other, ignoring regular assignments
2397# 2: Don't align
2398align_assign_decl_func = 0 # unsigned number
2399
2400# The span for aligning on '=' in enums.
2401#
2402# 0: Don't align (default).
2403align_enum_equ_span = 0 # unsigned number
2404
2405# The threshold for aligning on '=' in enums.
2406# Use a negative number for absolute thresholds.
2407#
2408# 0: no limit (default).
2409align_enum_equ_thresh = 0 # number
2410
2411# The span for aligning class member definitions.
2412#
2413# 0: Don't align (default).
2414align_var_class_span = 0 # unsigned number
2415
2416# The threshold for aligning class member definitions.
2417# Use a negative number for absolute thresholds.
2418#
2419# 0: No limit (default).
2420align_var_class_thresh = 0 # number
2421
2422# The gap for aligning class member definitions.
2423align_var_class_gap = 0 # unsigned number
2424
2425# The span for aligning struct/union member definitions.
2426#
2427# 0: Don't align (default).
2428align_var_struct_span = 0 # unsigned number
2429
2430# The threshold for aligning struct/union member definitions.
2431# Use a negative number for absolute thresholds.
2432#
2433# 0: No limit (default).
2434align_var_struct_thresh = 0 # number
2435
2436# The gap for aligning struct/union member definitions.
2437align_var_struct_gap = 0 # unsigned number
2438
2439# The span for aligning struct initializer values.
2440#
2441# 0: Don't align (default).
2442align_struct_init_span = 0 # unsigned number
2443
2444# The span for aligning single-line typedefs.
2445#
2446# 0: Don't align (default).
2447align_typedef_span = 0 # unsigned number
2448
2449# The minimum space between the type and the synonym of a typedef.
2450align_typedef_gap = 1 # unsigned number
2451
2452# How to align typedef'd functions with other typedefs.
2453#
2454# 0: Don't mix them at all (default)
2455# 1: Align the open parenthesis with the types
2456# 2: Align the function type name with the other type names
2457align_typedef_func = 0 # unsigned number
2458
2459# How to consider (or treat) the '*' in the alignment of typedefs.
2460#
2461# 0: Part of the typedef type, 'typedef int * pint;' (default)
2462# 1: Part of type name: 'typedef int *pint;'
2463# 2: Dangling: 'typedef int *pint;'
2464# Dangling: the '*' will not be taken into account when aligning.
2465align_typedef_star_style = 1 # unsigned number
2466
2467# How to consider (or treat) the '&' in the alignment of typedefs.
2468#
2469# 0: Part of the typedef type, 'typedef int & intref;' (default)
2470# 1: Part of type name: 'typedef int &intref;'
2471# 2: Dangling: 'typedef int &intref;'
2472# Dangling: the '&' will not be taken into account when aligning.
2473align_typedef_amp_style = 1 # unsigned number
2474
2475# The span for aligning comments that end lines.
2476#
2477# 0: Don't align (default).
2478align_right_cmt_span = 0 # unsigned number
2479
2480# Minimum number of columns between preceding text and a trailing comment in
2481# order for the comment to qualify for being aligned. Must be non-zero to have
2482# an effect.
2483align_right_cmt_gap = 0 # unsigned number
2484
2485# If aligning comments, whether to mix with comments after '}' and #endif with
2486# less than three spaces before the comment.
2487align_right_cmt_mix = false # true/false
2488
2489# Whether to only align trailing comments that are at the same brace level.
2490align_right_cmt_same_level = false # true/false
2491
2492# Minimum column at which to align trailing comments. Comments which are
2493# aligned beyond this column, but which can be aligned in a lesser column,
2494# may be "pulled in".
2495#
2496# 0: Ignore (default).
2497align_right_cmt_at_col = 0 # unsigned number
2498
2499# The span for aligning function prototypes.
2500#
2501# 0: Don't align (default).
2502align_func_proto_span = 0 # unsigned number
2503
2504# The threshold for aligning function prototypes.
2505# Use a negative number for absolute thresholds.
2506#
2507# 0: No limit (default).
2508align_func_proto_thresh = 0 # number
2509
2510# Minimum gap between the return type and the function name.
2511align_func_proto_gap = 1 # unsigned number
2512
2513# Whether to align function prototypes on the 'operator' keyword instead of
2514# what follows.
2515align_on_operator = false # true/false
2516
2517# Whether to mix aligning prototype and variable declarations. If true,
2518# align_var_def_XXX options are used instead of align_func_proto_XXX options.
2519align_mix_var_proto = false # true/false
2520
2521# Whether to align single-line functions with function prototypes.
2522# Uses align_func_proto_span.
2523align_single_line_func = true # true/false
2524
2525# Whether to align the open brace of single-line functions.
2526# Requires align_single_line_func=true. Uses align_func_proto_span.
2527align_single_line_brace = true # true/false
2528
2529# Gap for align_single_line_brace.
2530align_single_line_brace_gap = 1 # unsigned number
2531
2532# (OC) The span for aligning Objective-C message specifications.
2533#
2534# 0: Don't align (default).
2535align_oc_msg_spec_span = 0 # unsigned number
2536
2537# Whether to align macros wrapped with a backslash and a newline. This will
2538# not work right if the macro contains a multi-line comment.
2539align_nl_cont = false # true/false
2540
2541# Whether to align macro functions and variables together.
2542align_pp_define_together = false # true/false
2543
2544# The span for aligning on '#define' bodies.
2545#
2546# =0: Don't align (default)
2547# >0: Number of lines (including comments) between blocks
2548align_pp_define_span = 0 # unsigned number
2549
2550# The minimum space between label and value of a preprocessor define.
2551align_pp_define_gap = 1 # unsigned number
2552
2553# Whether to align lines that start with '<<' with previous '<<'.
2554#
2555# Default: true
2556align_left_shift = false # true/false
2557
2558# Whether to align text after 'asm volatile ()' colons.
2559align_asm_colon = false # true/false
2560
2561# (OC) Span for aligning parameters in an Objective-C message call
2562# on the ':'.
2563#
2564# 0: Don't align.
2565align_oc_msg_colon_span = 0 # unsigned number
2566
2567# (OC) Whether to always align with the first parameter, even if it is too
2568# short.
2569align_oc_msg_colon_first = false # true/false
2570
2571# (OC) Whether to align parameters in an Objective-C '+' or '-' declaration
2572# on the ':'.
2573align_oc_decl_colon = false # true/false
2574
2575# (OC) Whether to not align parameters in an Objectve-C message call if first
2576# colon is not on next line of the message call (the same way Xcode does
2577# aligment)
2578align_oc_msg_colon_xcode_like = false # true/false
2579
2580#
2581# Comment modification options
2582#
2583
2584# Try to wrap comments at N columns.
2585cmt_width = 256 # unsigned number
2586
2587# How to reflow comments.
2588#
2589# 0: No reflowing (apart from the line wrapping due to cmt_width) (default)
2590# 1: No touching at all
2591# 2: Full reflow
2592cmt_reflow_mode = 1 # unsigned number
2593
2594# Whether to convert all tabs to spaces in comments. If false, tabs in
2595# comments are left alone, unless used for indenting.
2596cmt_convert_tab_to_spaces = false # true/false
2597
2598# Whether to apply changes to multi-line comments, including cmt_width,
2599# keyword substitution and leading chars.
2600#
2601# Default: true
2602cmt_indent_multi = false # true/false
2603
2604# Whether to group c-comments that look like they are in a block.
2605cmt_c_group = false # true/false
2606
2607# Whether to put an empty '/*' on the first line of the combined c-comment.
2608cmt_c_nl_start = false # true/false
2609
2610# Whether to add a newline before the closing '*/' of the combined c-comment.
2611cmt_c_nl_end = false # true/false
2612
2613# Whether to change cpp-comments into c-comments.
2614cmt_cpp_to_c = false # true/false
2615
2616# Whether to group cpp-comments that look like they are in a block. Only
2617# meaningful if cmt_cpp_to_c=true.
2618cmt_cpp_group = false # true/false
2619
2620# Whether to put an empty '/*' on the first line of the combined cpp-comment
2621# when converting to a c-comment.
2622#
2623# Requires cmt_cpp_to_c=true and cmt_cpp_group=true.
2624cmt_cpp_nl_start = false # true/false
2625
2626# Whether to add a newline before the closing '*/' of the combined cpp-comment
2627# when converting to a c-comment.
2628#
2629# Requires cmt_cpp_to_c=true and cmt_cpp_group=true.
2630cmt_cpp_nl_end = false # true/false
2631
2632# Whether to put a star on subsequent comment lines.
2633cmt_star_cont = false # true/false
2634
2635# The number of spaces to insert at the start of subsequent comment lines.
2636cmt_sp_before_star_cont = 0 # unsigned number
2637
2638# The number of spaces to insert after the star on subsequent comment lines.
2639cmt_sp_after_star_cont = 3 # unsigned number
2640
2641# For multi-line comments with a '*' lead, remove leading spaces if the first
2642# and last lines of the comment are the same length.
2643#
2644# Default: true
2645cmt_multi_check_last = false # true/false
2646
2647# For multi-line comments with a '*' lead, remove leading spaces if the first
2648# and last lines of the comment are the same length AND if the length is
2649# bigger as the first_len minimum.
2650#
2651# Default: 4
2652cmt_multi_first_len_minimum = 4 # unsigned number
2653
2654# Path to a file that contains text to insert at the beginning of a file if
2655# the file doesn't start with a C/C++ comment. If the inserted text contains
2656# '$(filename)', that will be replaced with the current file's name.
2657cmt_insert_file_header = "" # string
2658
2659# Path to a file that contains text to insert at the end of a file if the
2660# file doesn't end with a C/C++ comment. If the inserted text contains
2661# '$(filename)', that will be replaced with the current file's name.
2662cmt_insert_file_footer = "" # string
2663
2664# Path to a file that contains text to insert before a function definition if
2665# the function isn't preceded by a C/C++ comment. If the inserted text
2666# contains '$(function)', '$(javaparam)' or '$(fclass)', these will be
2667# replaced with, respectively, the name of the function, the javadoc '@param'
2668# and '@return' stuff, or the name of the class to which the member function
2669# belongs.
2670cmt_insert_func_header = "" # string
2671
2672# Path to a file that contains text to insert before a class if the class
2673# isn't preceded by a C/C++ comment. If the inserted text contains '$(class)',
2674# that will be replaced with the class name.
2675cmt_insert_class_header = "" # string
2676
2677# Path to a file that contains text to insert before an Objective-C message
2678# specification, if the method isn't preceded by a C/C++ comment. If the
2679# inserted text contains '$(message)' or '$(javaparam)', these will be
2680# replaced with, respectively, the name of the function, or the javadoc
2681# '@param' and '@return' stuff.
2682cmt_insert_oc_msg_header = "" # string
2683
2684# Whether a comment should be inserted if a preprocessor is encountered when
2685# stepping backwards from a function name.
2686#
2687# Applies to cmt_insert_oc_msg_header, cmt_insert_func_header and
2688# cmt_insert_class_header.
2689cmt_insert_before_preproc = false # true/false
2690
2691# Whether a comment should be inserted if a function is declared inline to a
2692# class definition.
2693#
2694# Applies to cmt_insert_func_header.
2695#
2696# Default: true
2697cmt_insert_before_inlines = false # true/false
2698
2699# Whether a comment should be inserted if the function is a class constructor
2700# or destructor.
2701#
2702# Applies to cmt_insert_func_header.
2703cmt_insert_before_ctor_dtor = false # true/false
2704
2705#
2706# Code modifying options (non-whitespace)
2707#
2708
2709# Add or remove braces on a single-line 'do' statement.
2710mod_full_brace_do = ignore # ignore/add/remove/force
2711
2712# Add or remove braces on a single-line 'for' statement.
2713mod_full_brace_for = ignore # ignore/add/remove/force
2714
2715# (Pawn) Add or remove braces on a single-line function definition.
2716mod_full_brace_function = ignore # ignore/add/remove/force
2717
2718# Add or remove braces on a single-line 'if' statement. Braces will not be
2719# removed if the braced statement contains an 'else'.
2720mod_full_brace_if = ignore # ignore/add/remove/force
2721
2722# Whether to enforce that all blocks of an 'if'/'else if'/'else' chain either
2723# have, or do not have, braces. If true, braces will be added if any block
2724# needs braces, and will only be removed if they can be removed from all
2725# blocks.
2726#
2727# Overrides mod_full_brace_if.
2728mod_full_brace_if_chain = false # true/false
2729
2730# Whether to add braces to all blocks of an 'if'/'else if'/'else' chain.
2731# If true, mod_full_brace_if_chain will only remove braces from an 'if' that
2732# does not have an 'else if' or 'else'.
2733mod_full_brace_if_chain_only = false # true/false
2734
2735# Add or remove braces on single-line 'while' statement.
2736mod_full_brace_while = ignore # ignore/add/remove/force
2737
2738# Add or remove braces on single-line 'using ()' statement.
2739mod_full_brace_using = ignore # ignore/add/remove/force
2740
2741# Don't remove braces around statements that span N newlines
2742mod_full_brace_nl = 0 # unsigned number
2743
2744# Whether to prevent removal of braces from 'if'/'for'/'while'/etc. blocks
2745# which span multiple lines.
2746#
2747# Affects:
2748# mod_full_brace_for
2749# mod_full_brace_if
2750# mod_full_brace_if_chain
2751# mod_full_brace_if_chain_only
2752# mod_full_brace_while
2753# mod_full_brace_using
2754#
2755# Does not affect:
2756# mod_full_brace_do
2757# mod_full_brace_function
2758mod_full_brace_nl_block_rem_mlcond = false # true/false
2759
2760# Add or remove unnecessary parenthesis on 'return' statement.
2761mod_paren_on_return = ignore # ignore/add/remove/force
2762
2763# (Pawn) Whether to change optional semicolons to real semicolons.
2764mod_pawn_semicolon = false # true/false
2765
2766# Whether to fully parenthesize Boolean expressions in 'while' and 'if'
2767# statement, as in 'if (a && b > c)' => 'if (a && (b > c))'.
2768mod_full_paren_if_bool = false # true/false
2769
2770# Whether to remove superfluous semicolons.
2771mod_remove_extra_semicolon = false # true/false
2772
2773# If a function body exceeds the specified number of newlines and doesn't have
2774# a comment after the close brace, a comment will be added.
2775mod_add_long_function_closebrace_comment = 0 # unsigned number
2776
2777# If a namespace body exceeds the specified number of newlines and doesn't
2778# have a comment after the close brace, a comment will be added.
2779mod_add_long_namespace_closebrace_comment = 0 # unsigned number
2780
2781# If a class body exceeds the specified number of newlines and doesn't have a
2782# comment after the close brace, a comment will be added.
2783mod_add_long_class_closebrace_comment = 0 # unsigned number
2784
2785# If a switch body exceeds the specified number of newlines and doesn't have a
2786# comment after the close brace, a comment will be added.
2787mod_add_long_switch_closebrace_comment = 0 # unsigned number
2788
2789# If an #ifdef body exceeds the specified number of newlines and doesn't have
2790# a comment after the #endif, a comment will be added.
2791mod_add_long_ifdef_endif_comment = 0 # unsigned number
2792
2793# If an #ifdef or #else body exceeds the specified number of newlines and
2794# doesn't have a comment after the #else, a comment will be added.
2795mod_add_long_ifdef_else_comment = 0 # unsigned number
2796
2797# Whether to take care of the case by the mod_sort_xx options.
2798mod_sort_case_sensitive = false # true/false
2799
2800# Whether to sort consecutive single-line 'import' statements.
2801mod_sort_import = false # true/false
2802
2803# (C#) Whether to sort consecutive single-line 'using' statements.
2804mod_sort_using = false # true/false
2805
2806# Whether to sort consecutive single-line '#include' statements (C/C++) and
2807# '#import' statements (Objective-C). Be aware that this has the potential to
2808# break your code if your includes/imports have ordering dependencies.
2809mod_sort_include = false # true/false
2810
2811# Whether to prioritize '#include' and '#import' statements that contain
2812# filename without extension when sorting is enabled.
2813mod_sort_incl_import_prioritize_filename = false # true/false
2814
2815# Whether to prioritize '#include' and '#import' statements that does not
2816# contain extensions when sorting is enabled.
2817mod_sort_incl_import_prioritize_extensionless = false # true/false
2818
2819# Whether to prioritize '#include' and '#import' statements that contain
2820# angle over quotes when sorting is enabled.
2821mod_sort_incl_import_prioritize_angle_over_quotes = true # true/false
2822
2823# Whether to ignore file extension in '#include' and '#import' statements
2824# for sorting comparison.
2825mod_sort_incl_import_ignore_extension = true # true/false
2826
2827# Whether to group '#include' and '#import' statements when sorting is enabled.
2828mod_sort_incl_import_grouping_enabled = false # true/false
2829
2830# Whether to move a 'break' that appears after a fully braced 'case' before
2831# the close brace, as in 'case X: { ... } break;' => 'case X: { ... break; }'.
2832mod_move_case_break = false # true/false
2833
2834# Add or remove braces around a fully braced case statement. Will only remove
2835# braces if there are no variable declarations in the block.
2836mod_case_brace = ignore # ignore/add/remove/force
2837
2838# Whether to remove a void 'return;' that appears as the last statement in a
2839# function.
2840mod_remove_empty_return = false # true/false
2841
2842# Add or remove the comma after the last value of an enumeration.
2843mod_enum_last_comma = ignore # ignore/add/remove/force
2844
2845# (OC) Whether to organize the properties. If true, properties will be
2846# rearranged according to the mod_sort_oc_property_*_weight factors.
2847mod_sort_oc_properties = false # true/false
2848
2849# (OC) Weight of a class property modifier.
2850mod_sort_oc_property_class_weight = 0 # number
2851
2852# (OC) Weight of 'atomic' and 'nonatomic'.
2853mod_sort_oc_property_thread_safe_weight = 0 # number
2854
2855# (OC) Weight of 'readwrite' when organizing properties.
2856mod_sort_oc_property_readwrite_weight = 0 # number
2857
2858# (OC) Weight of a reference type specifier ('retain', 'copy', 'assign',
2859# 'weak', 'strong') when organizing properties.
2860mod_sort_oc_property_reference_weight = 0 # number
2861
2862# (OC) Weight of getter type ('getter=') when organizing properties.
2863mod_sort_oc_property_getter_weight = 0 # number
2864
2865# (OC) Weight of setter type ('setter=') when organizing properties.
2866mod_sort_oc_property_setter_weight = 0 # number
2867
2868# (OC) Weight of nullability type ('nullable', 'nonnull', 'null_unspecified',
2869# 'null_resettable') when organizing properties.
2870mod_sort_oc_property_nullability_weight = 0 # number
2871
2872#
2873# Preprocessor options
2874#
2875
2876# Add or remove indentation of preprocessor directives inside #if blocks
2877# at brace level 0 (file-level).
2878pp_indent = ignore # ignore/add/remove/force
2879
2880# Whether to indent #if/#else/#endif at the brace level. If false, these are
2881# indented from column 1.
2882pp_indent_at_level = false # true/false
2883
2884# Specifies the number of columns to indent preprocessors per level
2885# at brace level 0 (file-level). If pp_indent_at_level=false, also specifies
2886# the number of columns to indent preprocessors per level
2887# at brace level > 0 (function-level).
2888#
2889# Default: 1
2890pp_indent_count = 0 # unsigned number
2891
2892# Add or remove space after # based on pp_level of #if blocks.
2893pp_space = ignore # ignore/add/remove/force
2894
2895# Sets the number of spaces per level added with pp_space.
2896pp_space_count = 0 # unsigned number
2897
2898# The indent for '#region' and '#endregion' in C# and '#pragma region' in
2899# C/C++. Negative values decrease indent down to the first column.
2900pp_indent_region = 0 # number
2901
2902# Whether to indent the code between #region and #endregion.
2903pp_region_indent_code = false # true/false
2904
2905# If pp_indent_at_level=true, sets the indent for #if, #else and #endif when
2906# not at file-level. Negative values decrease indent down to the first column.
2907#
2908# =0: Indent preprocessors using output_tab_size
2909# >0: Column at which all preprocessors will be indented
2910pp_indent_if = 0 # number
2911
2912# Whether to indent the code between #if, #else and #endif.
2913pp_if_indent_code = false # true/false
2914
2915# Whether to indent '#define' at the brace level. If false, these are
2916# indented from column 1.
2917pp_define_at_level = false # true/false
2918
2919# Whether to ignore the '#define' body while formatting.
2920pp_ignore_define_body = true # true/false
2921
2922# Whether to indent case statements between #if, #else, and #endif.
2923# Only applies to the indent of the preprocesser that the case statements
2924# directly inside of.
2925#
2926# Default: true
2927pp_indent_case = false # true/false
2928
2929# Whether to indent whole function definitions between #if, #else, and #endif.
2930# Only applies to the indent of the preprocesser that the function definition
2931# is directly inside of.
2932#
2933# Default: true
2934pp_indent_func_def = false # true/false
2935
2936# Whether to indent extern C blocks between #if, #else, and #endif.
2937# Only applies to the indent of the preprocesser that the extern block is
2938# directly inside of.
2939#
2940# Default: true
2941pp_indent_extern = false # true/false
2942
2943# Whether to indent braces directly inside #if, #else, and #endif.
2944# Only applies to the indent of the preprocesser that the braces are directly
2945# inside of.
2946#
2947# Default: true
2948pp_indent_brace = false # true/false
2949
2950#
2951# Sort includes options
2952#
2953
2954# The regex for include category with priority 0.
2955include_category_0 = "" # string
2956
2957# The regex for include category with priority 1.
2958include_category_1 = "" # string
2959
2960# The regex for include category with priority 2.
2961include_category_2 = "" # string
2962
2963#
2964# Use or Do not Use options
2965#
2966
2967# true: indent_func_call_param will be used (default)
2968# false: indent_func_call_param will NOT be used
2969#
2970# Default: true
2971use_indent_func_call_param = false # true/false
2972
2973# The value of the indentation for a continuation line is calculated
2974# differently if the statement is:
2975# - a declaration: your case with QString fileName ...
2976# - an assignment: your case with pSettings = new QSettings( ...
2977#
2978# At the second case the indentation value might be used twice:
2979# - at the assignment
2980# - at the function call (if present)
2981#
2982# To prevent the double use of the indentation value, use this option with the
2983# value 'true'.
2984#
2985# true: indent_continue will be used only once
2986# false: indent_continue will be used every time (default)
2987use_indent_continue_only_once = false # true/false
2988
2989# The value might be used twice:
2990# - at the assignment
2991# - at the opening brace
2992#
2993# To prevent the double use of the indentation value, use this option with the
2994# value 'true'.
2995#
2996# true: indentation will be used only once
2997# false: indentation will be used every time (default)
2998indent_cpp_lambda_only_once = false # true/false
2999
3000# Whether sp_after_angle takes precedence over sp_inside_fparen. This was the
3001# historic behavior, but is probably not the desired behavior, so this is off
3002# by default.
3003use_sp_after_angle_always = false # true/false
3004
3005# Whether to apply special formatting for Qt SIGNAL/SLOT macros. Essentially,
3006# this tries to format these so that they match Qt's normalized form (i.e. the
3007# result of QMetaObject::normalizedSignature), which can slightly improve the
3008# performance of the QObject::connect call, rather than how they would
3009# otherwise be formatted.
3010#
3011# See options_for_QT.cpp for details.
3012#
3013# Default: true
3014use_options_overriding_for_qt_macros = false # true/false
3015
3016# If true: the form feed character is removed from the list
3017# of whitespace characters.
3018# See https://en.cppreference.com/w/cpp/string/byte/isspace
3019use_form_feed_no_more_as_whitespace_character = false # true/false
3020
3021#
3022# Warn levels - 1: error, 2: warning (default), 3: note
3023#
3024
3025# (C#) Warning is given if doing tab-to-\t replacement and we have found one
3026# in a C# verbatim string literal.
3027#
3028# Default: 2
3029warn_level_tabs_found_in_verbatim_string_literals = 2 # unsigned number
3030
3031# Limit the number of loops.
3032# Used by uncrustify.cpp to exit from infinite loop.
3033# 0: no limit.
3034debug_max_number_of_loops = 0 # number
3035
3036# Set the number of the line to protocol;
3037# Used in the function prot_the_line if the 2. parameter is zero.
3038# 0: nothing protocol.
3039debug_line_number_to_protocol = 0 # number
3040
3041# Meaning of the settings:
3042# Ignore - do not do any changes
3043# Add - makes sure there is 1 or more space/brace/newline/etc
3044# Force - makes sure there is exactly 1 space/brace/newline/etc,
3045# behaves like Add in some contexts
3046# Remove - removes space/brace/newline/etc
3047#
3048#
3049# - Token(s) can be treated as specific type(s) with the 'set' option:
3050# `set tokenType tokenString [tokenString...]`
3051#
3052# Example:
3053# `set BOOL __AND__ __OR__`
3054#
3055# tokenTypes are defined in src/token_enum.h, use them without the
3056# 'CT_' prefix: 'CT_BOOL' => 'BOOL'
3057#
3058#
3059# - Token(s) can be treated as type(s) with the 'type' option.
3060# `type tokenString [tokenString...]`
3061#
3062# Example:
3063# `type int c_uint_8 Rectangle`
3064#
3065# This can also be achieved with `set TYPE int c_uint_8 Rectangle`
3066#
3067#
3068# To embed whitespace in tokenStrings use the '\' escape character, or quote
3069# the tokenStrings. These quotes are supported: "'`
3070#
3071#
3072# - Support for the auto detection of languages through the file ending can be
3073# added using the 'file_ext' command.
3074# `file_ext langType langString [langString..]`
3075#
3076# Example:
3077# `file_ext CPP .ch .cxx .cpp.in`
3078#
3079# langTypes are defined in uncrusify_types.h in the lang_flag_e enum, use
3080# them without the 'LANG_' prefix: 'LANG_CPP' => 'CPP'
3081#
3082#
3083# - Custom macro-based indentation can be set up using 'macro-open',
3084# 'macro-else' and 'macro-close'.
3085# `(macro-open | macro-else | macro-close) tokenString`
3086#
3087# Example:
3088# `macro-open BEGIN_TEMPLATE_MESSAGE_MAP`
3089# `macro-open BEGIN_MESSAGE_MAP`
3090# `macro-close END_MESSAGE_MAP`
3091#
3092#
3093# option(s) with 'not default' value: 232
3094#