1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
|
#
# Uncrustify options (with comments) for Pandora Projects
#
# Copyright (C) 2008 Sun Microsystems, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
nl_after_brace_close = TRUE
# The type of line endings
newlines = lf # auto/lf/crlf/cr
# The original size of tabs in the input
input_tab_size = 8 # number
# The size of tabs in the output (only used if align_with_tabs=true)
output_tab_size = 3 # number
# The ascii value of the string escape char, usually 92 (\) or 94 (^). (Pawn)
string_escape_char = 92 # number
# Alternate string escape char for Pawn. Only works right before the quote char.
string_escape_char2 = 0 # number
#
# Indenting
#
# The number of columns to indent per level.
# Usually 2, 3, 4, or 8.
indent_columns = 2 # number
# How to use tabs when indenting code
# 0=spaces only
# 1=indent with tabs, align with spaces
# 2=indent and align with tabs
indent_with_tabs = 0 # number
# Whether to indent strings broken by '\' so that they line up
indent_align_string = true # false/true
# The number of spaces to indent multi-line XML strings.
# Requires indent_align_string=True
indent_xml_string = 0 # number
# Spaces to indent '{' from level
indent_brace = 0 # number
# Whether braces are indented to the body level
indent_braces = false # false/true
# Disabled indenting function braces if indent_braces is true
indent_braces_no_func = false # false/true
# Indent based on the size of the brace parent, ie 'if' => 3 spaces, 'for' => 4 spaces, etc.
indent_brace_parent = false # false/true
# Whether the 'namespace' body is indented
indent_namespace = false # false/true
# Whether the 'extern "C"' body is indented
indent_extern = false # false/true
# Whether the 'class' body is indented
indent_class = true # false/true
# Whether to indent the stuff after a leading class colon
indent_class_colon = true # false/true
# False=treat 'else\nif' as 'else if' for indenting purposes
# True=indent the 'if' one level
indent_else_if = false # false/true
# True: indent continued function call parameters one indent level
# False: align parameters under the open paren
indent_func_call_param = false # false/true
# Same as indent_func_call_param, but for function defs
indent_func_def_param = false # false/true
# Same as indent_func_call_param, but for function protos
indent_func_proto_param = false # false/true
# Same as indent_func_call_param, but for class declarations
indent_func_class_param = false # false/true
# Same as indent_func_call_param, but for class variable constructors
indent_func_ctor_var_param = false # false/true
# Same as indent_func_call_param, but for templates
indent_template_param = false # false/true
# Double the indent for indent_func_xxx_param options
indent_func_param_double = false # false/true
# Indentation column for standalone 'const' function decl/proto qualifier
indent_func_const = 0 # number
# Indentation column for standalone 'throw' function decl/proto qualifier
indent_func_throw = 0 # number
# The number of spaces to indent a continued '->' or '.'
# Usually set to 0, 1, or indent_columns.
indent_member = 3 # number
# Spaces to indent single line ('//') comments on lines before code
indent_sing_line_comments = 0 # number
# If set, will indent trailing single line ('//') comments relative
# to the code instead of trying to keep the same absolute column
indent_relative_single_line_comments = false # false/true
# Spaces to indent 'case' from 'switch'
# Usually 0 or indent_columns.
indent_switch_case = 0 # number
# Spaces to shift the 'case' line, without affecting any other lines
# Usually 0.
indent_case_shift = 0 # number
# Spaces to indent '{' from 'case'.
# By default, the brace will appear under the 'c' in case.
# Usually set to 0 or indent_columns.
indent_case_brace = 0 # number
# Whether to indent comments found in first column
indent_col1_comment = false # false/true
# How to indent goto labels
# >0 : absolute column where 1 is the leftmost column
# <=0 : subtract from brace indent
indent_label = 1 # number
# Same as indent_label, but for access specifiers that are followed by a colon
indent_access_spec = 1 # number
# Indent the code after an access specifier by one level.
# If set, this option forces 'indent_access_spec=0'
indent_access_spec_body = false # false/true
# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
indent_paren_nl = false # false/true
# Controls the indent of a close paren after a newline.
# 0: Indent to body level
# 1: Align under the open paren
# 2: Indent to the brace level
indent_paren_close = 0 # number
# Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
indent_comma_paren = false # false/true
# Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
indent_bool_paren = false # false/true
# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
indent_square_nl = false # false/true
# Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
indent_preserve_sql = false # false/true
#
# Spacing options
#
# Add or remove space around arithmetic operator '+', '-', '/', '*', etc
sp_arith = force # ignore/add/remove/force
# Add or remove space before assignment operator '=', '+=', etc
sp_before_assign = remove # ignore/add/remove/force
# Add or remove space after assignment operator '=', '+=', etc
sp_after_assign = force # ignore/add/remove/force
# Add or remove space around assignment '=' in enum
sp_enum_assign = ignore # ignore/add/remove/force
# Add or remove space around boolean operators '&&' and '||'
sp_bool = force # ignore/add/remove/force
# Add or remove space around compare operator '<', '>', '==', etc
sp_compare = force # ignore/add/remove/force
# Add or remove space inside '(' and ')'
sp_inside_paren = remove # ignore/add/remove/force
# Add or remove space between nested parens
sp_paren_paren = remove # ignore/add/remove/force
# Whether to balance spaces inside nested parens
sp_balance_nested_parens = false # false/true
# Add or remove space between ')' and '{'
sp_paren_brace = ignore # ignore/add/remove/force
# Add or remove space before pointer star '*'
sp_before_ptr_star = force # ignore/add/remove/force
# Add or remove space before pointer star '*' that isn't followed by a variable name
# If set to 'ignore', sp_before_ptr_star is used instead.
sp_before_unnamed_ptr_star = ignore # ignore/add/remove/force
# Add or remove space between pointer stars '*'
sp_between_ptr_star = remove # ignore/add/remove/force
# Add or remove space after pointer star '*', if followed by a word.
sp_after_ptr_star = remove # ignore/add/remove/force
# Add or remove space after a pointer star '*', if followed by a func proto/def.
sp_after_ptr_star_func = ignore # ignore/add/remove/force
# Add or remove space before a pointer star '*', if followed by a func proto/def.
sp_before_ptr_star_func = ignore # ignore/add/remove/force
# Add or remove space before a reference sign '&'
sp_before_byref = remove # ignore/add/remove/force
# Add or remove space before a reference sign '&' that isn't followed by a variable name
# If set to 'ignore', sp_before_byref is used instead.
sp_before_unnamed_byref = ignore # ignore/add/remove/force
# Add or remove space after reference sign '&', if followed by a word.
sp_after_byref = force # ignore/add/remove/force
# Add or remove space after a reference sign '&', if followed by a func proto/def.
sp_after_byref_func = ignore # ignore/add/remove/force
# Add or remove space before a reference sign '&', if followed by a func proto/def.
sp_before_byref_func = ignore # ignore/add/remove/force
# Add or remove space between type and word
sp_after_type = force # ignore/add/remove/force
# Add or remove space in 'template <' vs 'template<'.
# If set to ignore, sp_before_angle is used.
sp_template_angle = ignore # ignore/add/remove/force
# Add or remove space before '<>'
sp_before_angle = remove # ignore/add/remove/force
# Add or remove space inside '<' and '>'
sp_inside_angle = remove # ignore/add/remove/force
# Add or remove space after '<>'
sp_after_angle = force # ignore/add/remove/force
# Add or remove space between '<>' and '(' as found in 'new List<byte>();'
sp_angle_paren = ignore # ignore/add/remove/force
# Add or remove space between '<>' and a word as in 'List<byte> m;'
sp_angle_word = ignore # ignore/add/remove/force
# Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
sp_before_sparen = force # ignore/add/remove/force
# Add or remove space inside if-condition '(' and ')'
sp_inside_sparen = remove # ignore/add/remove/force
# Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
sp_after_sparen = force # ignore/add/remove/force
# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
sp_sparen_brace = add # ignore/add/remove/force
# Add or remove space before empty statement ';' on 'if', 'for' and 'while'
sp_special_semi = ignore # ignore/add/remove/force
# Add or remove space before ';'
sp_before_semi = remove # ignore/add/remove/force
# Add or remove space before ';' in non-empty 'for' statements
sp_before_semi_for = ignore # ignore/add/remove/force
# Add or remove space before a semicolon of an empty part of a for statment.
sp_before_semi_for_empty = force # ignore/add/remove/force
# Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; <here> ).
sp_after_semi_for_empty = ignore # ignore/add/remove/force
# Add or remove space before '[' (except '[]')
sp_before_square = ignore # ignore/add/remove/force
# Add or remove space before '[]'
sp_before_squares = ignore # ignore/add/remove/force
# Add or remove space inside '[' and ']'
sp_inside_square = remove # ignore/add/remove/force
# Add or remove space after ','
sp_after_comma = force # ignore/add/remove/force
# Add or remove space before ','
sp_before_comma = remove # ignore/add/remove/force
# Add or remove space after class ':'
sp_after_class_colon = ignore # ignore/add/remove/force
# Add or remove space before class ':'
sp_before_class_colon = ignore # ignore/add/remove/force
# Add or remove space between 'operator' and operator sign
sp_after_operator = ignore # ignore/add/remove/force
# Add or remove space between the operator symbol and the open paren, as in 'operator ++('
sp_after_operator_sym = ignore # ignore/add/remove/force
# Add or remove space after C/D cast, ie 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'
sp_after_cast = remove # ignore/add/remove/force
# Add or remove spaces inside cast parens
sp_inside_paren_cast = remove # ignore/add/remove/force
# Add or remove space between the type and open paren in a C++ cast, ie 'int(exp)' vs 'int (exp)'
sp_cpp_cast_paren = remove # ignore/add/remove/force
# Add or remove space between 'sizeof' and '('
sp_sizeof_paren = remove # ignore/add/remove/force
# Add or remove space after the tag keyword (Pawn)
sp_after_tag = ignore # ignore/add/remove/force
# Add or remove space inside enum '{' and '}'
sp_inside_braces_enum = force # ignore/add/remove/force
# Add or remove space inside struct/union '{' and '}'
sp_inside_braces_struct = force # ignore/add/remove/force
# Add or remove space inside '{' and '}'
sp_inside_braces = force # ignore/add/remove/force
# Add or remove space inside '{}'
sp_inside_braces_empty = ignore # ignore/add/remove/force
# Add or remove space between return type and function name
# A minimum of 1 is forced except for pointer return types.
sp_type_func = force # ignore/add/remove/force
# Add or remove space between function name and '(' on function declaration
sp_func_proto_paren = remove # ignore/add/remove/force
# Add or remove space between function name and '(' on function definition
sp_func_def_paren = remove # ignore/add/remove/force
# Add or remove space inside empty function '()'
sp_inside_fparens = ignore # ignore/add/remove/force
# Add or remove space inside function '(' and ')'
sp_inside_fparen = remove # ignore/add/remove/force
# Add or remove space between ']' and '(' when part of a function call.
sp_square_fparen = ignore # ignore/add/remove/force
# Add or remove space between ')' and '{' of function
sp_fparen_brace = add # ignore/add/remove/force
# Add or remove space between function name and '(' on function calls
sp_func_call_paren = remove # ignore/add/remove/force
# Add or remove space between the user function name and '(' on function calls
# You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
sp_func_call_user_paren = ignore # ignore/add/remove/force
# Add or remove space between a constructor/destructor and the open paren
sp_func_class_paren = remove # ignore/add/remove/force
# Add or remove space between 'return' and '('
sp_return_paren = remove # ignore/add/remove/force
# Add or remove space between '__attribute__' and '('
sp_attribute_paren = remove # ignore/add/remove/force
# Add or remove space between 'defined' and '(' in '#if defined (FOO)'
sp_defined_paren = remove # ignore/add/remove/force
# Add or remove space between 'throw' and '(' in 'throw (something)'
sp_throw_paren = ignore # ignore/add/remove/force
# Add or remove space between macro and value
sp_macro = ignore # ignore/add/remove/force
# Add or remove space between macro function ')' and value
sp_macro_func = ignore # ignore/add/remove/force
# Add or remove space between 'else' and '{' if on the same line
sp_else_brace = ignore # ignore/add/remove/force
# Add or remove space between '}' and 'else' if on the same line
sp_brace_else = ignore # ignore/add/remove/force
# Add or remove space between '}' and the name of a typedef on the same line
sp_brace_typedef = force # ignore/add/remove/force
# Add or remove space between 'catch' and '{' if on the same line
sp_catch_brace = ignore # ignore/add/remove/force
# Add or remove space between '}' and 'catch' if on the same line
sp_brace_catch = ignore # ignore/add/remove/force
# Add or remove space between 'finally' and '{' if on the same line
sp_finally_brace = ignore # ignore/add/remove/force
# Add or remove space between '}' and 'finally' if on the same line
sp_brace_finally = ignore # ignore/add/remove/force
# Add or remove space between 'try' and '{' if on the same line
sp_try_brace = ignore # ignore/add/remove/force
# Add or remove space between get/set and '{' if on the same line
sp_getset_brace = ignore # ignore/add/remove/force
# Add or remove space before the '::' operator
sp_before_dc = remove # ignore/add/remove/force
# Add or remove space after the '::' operator
sp_after_dc = remove # ignore/add/remove/force
# Add or remove around the D named array initializer ':' operator
sp_d_array_colon = ignore # ignore/add/remove/force
# Add or remove space after the '!' (not) operator.
sp_not = force # ignore/add/remove/force
# Add or remove space after the '~' (invert) operator.
sp_inv = remove # ignore/add/remove/force
# Add or remove space after the '&' (address-of) operator.
# This does not affect the spacing after a '&' that is part of a type.
sp_addr = remove # ignore/add/remove/force
# Add or remove space around the '.' or '->' operators
sp_member = remove # ignore/add/remove/force
# Add or remove space after the '*' (dereference) operator.
# This does not affect the spacing after a '*' that is part of a type.
sp_deref = remove # ignore/add/remove/force
# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'
sp_sign = remove # ignore/add/remove/force
# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'
sp_incdec = remove # ignore/add/remove/force
# Add or remove space before a backslash-newline at the end of a line
sp_before_nl_cont = add # ignore/add/remove/force
# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
sp_after_oc_scope = ignore # ignore/add/remove/force
# Add or remove space after the colon in message specs
# '-(int) f:(int) x;' vs '-(int) f: (int) x;'
sp_after_oc_colon = ignore # ignore/add/remove/force
# Add or remove space before the colon in message specs
# '-(int) f: (int) x;' vs '-(int) f : (int) x;'
sp_before_oc_colon = ignore # ignore/add/remove/force
# Add or remove space after the colon in message specs
# '[object setValue:1];' vs '[object setValue: 1];'
sp_after_send_oc_colon = ignore # ignore/add/remove/force
# Add or remove space before the colon in message specs
# '[object setValue:1];' vs '[object setValue :1];'
sp_before_send_oc_colon = ignore # ignore/add/remove/force
# Add or remove space after the (type) in message specs
# '-(int) f: (int) x;' vs '-(int) f: (int)x;'
sp_after_oc_type = ignore # ignore/add/remove/force
# Add or remove space around the ':' in 'b ? t : f'
sp_cond_colon = ignore # ignore/add/remove/force
# Add or remove space around the '?' in 'b ? t : f'
sp_cond_question = ignore # ignore/add/remove/force
# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
sp_case_label = remove # ignore/add/remove/force
#
# Code alignment (not left column spaces/tabs)
#
# Whether to keep non-indenting tabs
align_keep_tabs = false # false/true
# Whether to use tabs for alinging
align_with_tabs = false # false/true
# Whether to bump out to the next tab when aligning
align_on_tabstop = false # false/true
# Whether to left-align numbers
align_number_left = false # false/true
# Align variable definitions in prototypes and functions
align_func_params = false # false/true
# Align parameters in single-line functions that have the same name.
# The function names must already be aligned with each other.
align_same_func_call_params = false # false/true
# The span for aligning variable definitions (0=don't align)
align_var_def_span = 1 # number
# How to align the star in variable definitions.
# 0=Part of the type 'void * foo;'
# 1=Part of the variable 'void *foo;'
# 2=Dangling 'void *foo;'
align_var_def_star_style = 1 # number
# How to align the '&' in variable definitions.
# 0=Part of the type
# 1=Part of the variable
# 2=Dangling
align_var_def_amp_style = 0 # number
# The threshold for aligning variable definitions (0=no limit)
align_var_def_thresh = 1 # number
# The gap for aligning variable definitions
align_var_def_gap = 0 # number
# Whether to align the colon in struct bit fields
align_var_def_colon = false # false/true
# Whether to align inline struct/enum/union variable definitions
align_var_def_inline = false # false/true
# The span for aligning on '=' in assignments (0=don't align)
align_assign_span = 0 # number
# The threshold for aligning on '=' in assignments (0=no limit)
align_assign_thresh = 12 # number
# The span for aligning on '=' in enums (0=don't align)
align_enum_equ_span = 0 # number
# The threshold for aligning on '=' in enums (0=no limit)
align_enum_equ_thresh = 0 # number
# The span for aligning struct/union (0=don't align)
align_var_struct_span = 0 # number
# The threshold for aligning struct/union member definitions (0=no limit)
align_var_struct_thresh = 0 # number
# The gap for aligning struct/union member definitions
align_var_struct_gap = 0 # number
# The span for aligning struct initializer values (0=don't align)
align_struct_init_span = 3 # number
# The minimum space between the type and the synonym of a typedef
align_typedef_gap = 3 # number
# The span for aligning single-line typedefs (0=don't align)
align_typedef_span = 5 # number
# How to align typedef'd functions with other typedefs
# 0: Don't mix them at all
# 1: align the open paren with the types
# 2: align the function type name with the other type names
align_typedef_func = 0 # number
# Controls the positioning of the '*' in typedefs. Just try it.
# 0: Align on typdef type, ignore '*'
# 1: The '*' is part of type name: typedef int *pint;
# 2: The '*' is part of the type, but dangling: typedef int *pint;
align_typedef_star_style = 0 # number
# Controls the positioning of the '&' in typedefs. Just try it.
# 0: Align on typdef type, ignore '&'
# 1: The '&' is part of type name: typedef int &pint;
# 2: The '&' is part of the type, but dangling: typedef int &pint;
align_typedef_amp_style = 0 # number
# The span for aligning comments that end lines (0=don't align)
align_right_cmt_span = 3 # number
# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
align_right_cmt_mix = false # false/true
# If a trailing comment is more than this number of columns away from the text it follows,
# it will qualify for being aligned.
align_right_cmt_gap = 0 # number
# The span for aligning function prototypes (0=don't align)
align_func_proto_span = 0 # number
# Minimum gap between the return type and the function name.
align_func_proto_gap = 0 # number
# Whether to mix aligning prototype and variable declarations.
# If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.
align_mix_var_proto = false # false/true
# Align single-line functions with function prototypes, uses align_func_proto_span
align_single_line_func = false # false/true
# Aligning the open brace of single-line functions.
# Requires align_single_line_func=true, uses align_func_proto_span
align_single_line_brace = false # false/true
# Gap for align_single_line_brace.
align_single_line_brace_gap = 0 # number
# The span for aligning ObjC msg spec (0=don't align)
align_oc_msg_spec_span = 0 # number
# Whether to align macros wrapped with a backslash and a newline.
# This will not work right if the macro contains a multi-line comment.
align_nl_cont = true # false/true
# The minimum space between label and value of a preprocessor define
align_pp_define_gap = 4 # number
# The span for aligning on '#define' bodies (0=don't align)
align_pp_define_span = 3 # number
# Align lines that start with '<<' with previous '<<'. Default=true
align_left_shift = true # false/true
#
# Newline adding and removing options
#
# Whether to collapse empty blocks between '{' and '}'
nl_collapse_empty_body = true # false/true
# Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'
nl_assign_leave_one_liners = false # false/true
# Don't split one-line braced statements inside a class xx { } body
nl_class_leave_one_liners = false # false/true
# Don't split one-line enums: 'enum foo { BAR = 15 };'
nl_enum_leave_one_liners = false # false/true
# Don't split one-line get or set functions
nl_getset_leave_one_liners = false # false/true
# Don't split one-line function definitions - 'int foo() { return 0; }'
nl_func_leave_one_liners = false # false/true
# Don't split one-line if/else statements - 'if(a) b++;'
nl_if_leave_one_liners = false # false/true
# Add or remove newlines at the start of the file
nl_start_of_file = remove # ignore/add/remove/force
# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
nl_start_of_file_min = 0 # number
# Add or remove newline at the end of the file
nl_end_of_file = force # ignore/add/remove/force
# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
nl_end_of_file_min = 1 # number
# Add or remove newline between '=' and '{'
nl_assign_brace = force # ignore/add/remove/force
# Add or remove newline between '=' and '[' (D only)
nl_assign_square = force # ignore/add/remove/force
# Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
nl_after_square_assign = force # ignore/add/remove/force
# The number of newlines after a block of variable definitions
nl_func_var_def_blk = 1 # number
# Add or remove newline between a function call's ')' and '{', as in:
# list_for_each(item, &list) { }
nl_fcall_brace = force # ignore/add/remove/force
# Add or remove newline between 'enum' and '{'
nl_enum_brace = force # ignore/add/remove/force
# Add or remove newline between 'struct and '{'
nl_struct_brace = force # ignore/add/remove/force
# Add or remove newline between 'union' and '{'
nl_union_brace = force # ignore/add/remove/force
# Add or remove newline between 'if' and '{'
nl_if_brace = force # ignore/add/remove/force
# Add or remove newline between '}' and 'else'
nl_brace_else = force # ignore/add/remove/force
# Add or remove newline between 'else if' and '{'
# If set to ignore, nl_if_brace is used instead
nl_elseif_brace = force # ignore/add/remove/force
# Add or remove newline between 'else' and '{'
nl_else_brace = force # ignore/add/remove/force
# Add or remove newline between 'else' and 'if'
nl_else_if = remove # ignore/add/remove/force
# Add or remove newline between '}' and 'finally'
nl_brace_finally = force # ignore/add/remove/force
# Add or remove newline between 'finally' and '{'
nl_finally_brace = force # ignore/add/remove/force
# Add or remove newline between 'try' and '{'
nl_try_brace = force # ignore/add/remove/force
# Add or remove newline between get/set and '{'
nl_getset_brace = force # ignore/add/remove/force
# Add or remove newline between 'for' and '{'
nl_for_brace = force # ignore/add/remove/force
# Add or remove newline between 'catch' and '{'
nl_catch_brace = force # ignore/add/remove/force
# Add or remove newline between '}' and 'catch'
nl_brace_catch = force # ignore/add/remove/force
# Add or remove newline between 'while' and '{'
nl_while_brace = force # ignore/add/remove/force
# Add or remove newline between 'do' and '{'
nl_do_brace = force # ignore/add/remove/force
# Add or remove newline between '}' and 'while' of 'do' statement
nl_brace_while = force # ignore/add/remove/force
# Add or remove newline between 'switch' and '{'
nl_switch_brace = force # ignore/add/remove/force
# Add or remove newline when condition spans two or more lines
nl_multi_line_cond = false # false/true
# Force a newline in a define after the macro name for multi-line defines.
nl_multi_line_define = true # false/true
# Whether to put a newline before 'case' statement
nl_before_case = true # false/true
# Add or remove newline between ')' and 'throw'
nl_before_throw = ignore # ignore/add/remove/force
# Whether to put a newline after 'case' statement
nl_after_case = true # false/true
# Newline between namespace and {
nl_namespace_brace = add # ignore/add/remove/force
# Add or remove newline between 'template<>' and whatever follows.
nl_template_class = add # ignore/add/remove/force
# Add or remove newline between 'class' and '{'
nl_class_brace = add # ignore/add/remove/force
# Add or remove newline after each ',' in the constructor member initialization
nl_class_init_args = force # ignore/add/remove/force
# Add or remove newline between return type and function name in definition
nl_func_type_name = ignore # ignore/add/remove/force
# Add or remove newline between return type and function name in a prototype
nl_func_proto_type_name = remove # ignore/add/remove/force
# Add or remove newline between a function name and the opening '('
nl_func_paren = remove # ignore/add/remove/force
# Add or remove newline after '(' in a function declaration
nl_func_decl_start = remove # ignore/add/remove/force
# Add or remove newline after each ',' in a function declaration
nl_func_decl_args = remove # ignore/add/remove/force
# Add or remove newline before the ')' in a function declaration
nl_func_decl_end = remove # ignore/add/remove/force
# Add or remove newline between function signature and '{'
nl_fdef_brace = add # ignore/add/remove/force
# Whether to put a newline after 'return' statement
nl_after_return = true # false/true
# Add or remove a newline between the return keyword and return expression.
nl_return_expr = remove # ignore/add/remove/force
# Whether to put a newline after semicolons, except in 'for' statements
nl_after_semicolon = true # false/true
# Whether to put a newline after brace open.
# This also adds a newline before the matching brace close.
nl_after_brace_open = true # false/true
# If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is
# placed between the open brace and a trailing single-line comment.
nl_after_brace_open_cmt = false # false/true
# Whether to put a newline after a virtual brace open.
# These occur in un-braced if/while/do/for statement bodies.
nl_after_vbrace_open = true # false/true
# Whether to alter newlines in '#define' macros
nl_define_macro = true # false/true
# Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
nl_squeeze_ifdef = false # false/true
# Add or remove newline before 'if'
nl_before_if = ignore # ignore/add/remove/force
# Add or remove newline after 'if'
nl_after_if = ignore # ignore/add/remove/force
# Add or remove newline before 'for'
nl_before_for = ignore # ignore/add/remove/force
# Add or remove newline after 'for'
nl_after_for = ignore # ignore/add/remove/force
# Add or remove newline before 'while'
nl_before_while = ignore # ignore/add/remove/force
# Add or remove newline after 'while'
nl_after_while = ignore # ignore/add/remove/force
# Add or remove newline before 'switch'
nl_before_switch = force # ignore/add/remove/force
# Add or remove newline after 'switch'
nl_after_switch = force # ignore/add/remove/force
# Add or remove newline before 'do'
nl_before_do = ignore # ignore/add/remove/force
# Add or remove newline after 'do'
nl_after_do = ignore # ignore/add/remove/force
# Whether to double-space commented-entries in struct/enum
nl_ds_struct_enum_cmt = false # false/true
# Whether to double-space before the close brace of a struct/union/enum
nl_ds_struct_enum_close_brace = false # false/true
# Add or remove a newline around a class colon.
# Related to pos_class_colon, nl_class_init_args, and pos_comma.
nl_class_colon = ignore # ignore/add/remove/force
# Change simple unbraced if statements into a one-liner
# 'if(b)\n i++;' => 'if(b) i++;'
nl_create_if_one_liner = false # false/true
# Change simple unbraced for statements into a one-liner
# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
nl_create_for_one_liner = false # false/true
# Change simple unbraced while statements into a one-liner
# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
nl_create_while_one_liner = false # false/true
#
# Positioning options
#
# The position of arithmetic operators in wrapped expressions
pos_arith = lead # ignore/lead/trail
# The position of assignment in wrapped expressions
pos_assign = trail # ignore/lead/trail
# The position of boolean operators in wrapped expressions
pos_bool = lead # ignore/lead/trail
# The position of the comma in wrapped expressions
pos_comma = trail # ignore/lead/trail
# The position of the comma in the constructor initialization list
pos_class_comma = trail # ignore/lead/trail
# The position of colons between constructor and member initialization
pos_class_colon = lead # ignore/lead/trail
#
# Line Splitting options
#
# Try to limit code width to N number of columns
code_width = 76 # number
# Whether to fully split long 'for' statements at semi-colons
ls_for_split_full = true # false/true
# Whether to fully split long function protos/calls at commas
ls_func_split_full = true # false/true
#
# Blank line options
#
# The maximum consecutive newlines
nl_max = 4 # number
# The number of newlines after a function prototype, if followed by another function prototype
nl_after_func_proto = 0 # number
# The number of newlines after a function prototype, if not followed by another function prototype
nl_after_func_proto_group = 3 # number
# The number of newlines after '}' of a multi-line function body
nl_after_func_body = 3 # number
# The number of newlines after '}' of a single line function body
nl_after_func_body_one_liner = 1 # number
# The minimum number of newlines before a multi-line comment.
# Doesn't apply if after a brace open or another multi-line comment.
nl_before_block_comment = 2 # number
# The minimum number of newlines before a single-line C comment.
# Doesn't apply if after a brace open or other single-line C comments.
nl_before_c_comment = 1 # number
# The minimum number of newlines before a CPP comment.
# Doesn't apply if after a brace open or other CPP comments.
nl_before_cpp_comment = 0 # number
# Whether to force a newline after a mulit-line comment.
nl_after_multiline_comment = false # false/true
# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
# Will not change the newline count if after a brace open.
# 0 = No change.
nl_before_access_spec = 1 # number
# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
# 0 = No change.
nl_after_access_spec = 1 # number
# The number of newlines between a function def and the function comment.
# 0 = No change.
nl_comment_func_def = 0 # number
# Whether to remove blank lines after '{'
eat_blanks_after_open_brace = true # false/true
# Whether to remove blank lines before '}'
eat_blanks_before_close_brace = true # false/true
#
# Code modifying options (non-whitespace)
#
# Add or remove braces on single-line 'do' statement
mod_full_brace_do = add # ignore/add/remove/force
# Add or remove braces on single-line 'for' statement
mod_full_brace_for = add # ignore/add/remove/force
# Add or remove braces on single-line function defintions. (Pawn)
mod_full_brace_function = ignore # ignore/add/remove/force
# Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.
mod_full_brace_if = ignore # ignore/add/remove/force
# Don't remove braces around statements that span N newlines
mod_full_brace_nl = 0 # number
# Add or remove braces on single-line 'while' statement
mod_full_brace_while = add # ignore/add/remove/force
# Add or remove unnecessary paren on 'return' statement
mod_paren_on_return = remove # ignore/add/remove/force
# Whether to change optional semicolons to real semicolons
mod_pawn_semicolon = false # false/true
# Add parens on 'while' and 'if' statement around bools
mod_full_paren_if_bool = true # false/true
# Whether to remove superfluous semicolons
mod_remove_extra_semicolon = true # false/true
# If a function body exceeds the specified number of newlines and doesn't have a comment after
# the close brace, a comment will be added.
mod_add_long_function_closebrace_comment = 5 # number
# If a switch body exceeds the specified number of newlines and doesn't have a comment after
# the close brace, a comment will be added.
mod_add_long_switch_closebrace_comment = 5 # number
# If TRUE, will sort consecutive single-line 'import' statements [Java, D]
mod_sort_import = false # false/true
# If TRUE, will sort consecutive single-line 'using' statements [C#]
mod_sort_using = false # false/true
# If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
# This is generally a bad idea, as it may break your code.
mod_sort_include = false # false/true
# If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.
mod_move_case_break = false # false/true
# If TRUE, it will remove a void 'return;' that appears as the last statement in a function.
mod_remove_empty_return = true # false/true
#
# Comment modifications
#
# Try to wrap comments at cmt_width columns
cmt_width = 0 # number
# If false, disable all multi-line comment changes, including cmt_width and leading chars.
# Default is true.
cmt_indent_multi = true # false/true
# Whether to group c-comments that look like they are in a block
cmt_c_group = false # false/true
# Whether to put an empty '/*' on the first line of the combined c-comment
cmt_c_nl_start = false # false/true
# Whether to put a newline before the closing '*/' of the combined c-comment
cmt_c_nl_end = false # false/true
# Whether to group cpp-comments that look like they are in a block
cmt_cpp_group = false # false/true
# Whether to put an empty '/*' on the first line of the combined cpp-comment
cmt_cpp_nl_start = false # false/true
# Whether to put a newline before the closing '*/' of the combined cpp-comment
cmt_cpp_nl_end = false # false/true
# Whether to change cpp-comments into c-comments
cmt_cpp_to_c = false # false/true
# Whether to put a star on subsequent comment lines
cmt_star_cont = true # false/true
# The number of spaces to insert at the start of subsequent comment lines
cmt_sp_before_star_cont = 0 # number
# The number of spaces to insert after the star on subsequent comment lines
cmt_sp_after_star_cont = 1 # number
# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of
# the comment are the same length. Default=True
cmt_multi_check_last = true # false/true
# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
# Will substitue $(filename) with the current file's name.
cmt_insert_file_header = "" # string
# The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment.
# Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
cmt_insert_func_header = "" # string
# The filename that contains text to insert before a class if the class isn't preceeded with a C/C++ comment.
# Will substitue $(class) with the class name.
cmt_insert_class_header = "" # string
# If a preprocessor is encountered when stepping backwards from a function name, then
# this option decides whether the comment should be inserted.
# Affects cmt_insert_func_header and cmt_insert_class_header.
cmt_insert_before_preproc = false # false/true
#
# Preprocessor options
#
# Control indent of preprocessors inside #if blocks at brace level 0
pp_indent = remove # ignore/add/remove/force
# Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
pp_indent_at_level = false # false/true
# If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1.
pp_indent_count = 1 # number
# Add or remove space after # based on pp_level of #if blocks
pp_space = add # ignore/add/remove/force
# Sets the number of spaces added with pp_space
pp_space_count = 1 # number
# The indent for #region and #endregion in C# and '#pragma region' in C/C++
pp_indent_region = 0 # number
# Whether to indent the code between #region and #endregion
pp_region_indent_code = false # false/true
# If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level
pp_indent_if = 0 # number
# Control whether to indent the code between #if, #else and #endif when not at file-level
pp_if_indent_code = false # false/true
# Whether to indent '#define' at the brace level (true) or from column 1 (false)
pp_define_at_level = false # false/true
# You can force a token to be a type with the 'type' option.
# Example:
# type myfoo1 myfoo2
#
# You can create custom macro-based indentation using macro-open,
# macro-else and macro-close.
# Example:
# macro-open BEGIN_TEMPLATE_MESSAGE_MAP
# macro-open BEGIN_MESSAGE_MAP
# macro-close END_MESSAGE_MAP
#
# You can assign any keyword to any type with the set option.
# set func_call_user _ N_
|