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