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