-
Notifications
You must be signed in to change notification settings - Fork 0
/
.clang-format
974 lines (778 loc) · 34.5 KB
/
.clang-format
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
# UPDATED TO CLANG FORMAT 19.14
# .clang-format is basically a YAML file.
# Where keys and values are separated by a colon e.g. key: value
# Comments are started using the # symbol!
# For an exhaustive list of options: https://clang.llvm.org/docs/ClangFormatStyleOptions.html
# Clang-format understands also special comments that switch formatting in a delimited range.
# The code between a comment // clang-format off or /* clang-format off */ up to a comment // clang-format on
# or /* clang-format on */ will not be formatted.
# The comments themselves will be formatted (aligned) normally. Also, a colon (:) and additional text may follow
# // clang-format off or // clang-format on to explain why clang-format is turned off or back on.
Language: Cpp
AccessModifierOffset: -2 # The extra indent or outdent of access modifiers, e.g. public:
AlignAfterOpenBracket: BlockIndent # If true, horizontally aligns arguments after an open bracket.
# This applies to round brackets (parentheses), angle brackets and square brackets.
# BlockIndent:
# Always break after an open bracket, if the parameters don't fit on a single line.
# Closing brackets will be placed on a new line. E.g.:
# someLongFunction(
# argument1, argument2
# )
AlignArrayOfStructures: Right # Align array column and right justify the columns e.g.:
# struct test demo[] =
# {
# {56, 23, "hello"},
# {-1, 93463, "world"},
# { 7, 5, "!!"}
# };
AlignConsecutiveAssignments:
Enabled: true
#define SHORT_NAME 42
#define LONGER_NAME 0x007f
#define EVEN_LONGER_NAME (2)
#define foo(x) (x * x)
#define bar(y, z) (y + z)
# int a = 1;
# int somelongname = 2;
# double c = 3;
#
# int aaaa : 1;
# int b : 12;
# int ccc : 8;
#
# int aaaa = 12;
# float b = 23;
# std::string ccc;
AcrossEmptyLines: true
# if set to true;
# int a = 1;
# int somelongname = 2;
# double c = 3;
#
# int d = 3;
# if set to false;
# int a = 1;
# int somelongname = 2;
# double c = 3;
#
# int d = 3;
AcrossComments: true
# if set to true;
# int d = 3;
# /* A comment. */
# double e = 4;
# if set to false;
# int d = 3;
# /* A comment. */
# double e = 4;
AlignCompound: true
# if set to true;
# a += 2;
# bbb = 2;
# if set to false;
# a += 2;
# bbb = 2;
PadOperators: true
# if set to true;
# a >>= 2;
# bbb = 2;
#
# a = 2;
# bbb >>= 2;
# if set to false;
# a >>= 2;
# bbb = 2;
#
# a = 2;
# bbb >>= 2;
AlignConsecutiveBitFields: # Same as `AlignConsecutiveAssignments`, but for bitfields.
Enabled: true
AcrossEmptyLines: true
AcrossComments: true
AlignCompound: true
PadOperators: true
AlignConsecutiveDeclarations: # Same as `AlignConsecutiveAssignments`, but for declarations.
Enabled: true
AcrossEmptyLines: true
# AlignFunctionDeclarations: false
AlignFunctionPointers: true
AcrossComments: true
AlignCompound: true
PadOperators: true
AlignConsecutiveMacros: # Same as `AlignConsecutiveAssignments`, but for macro definitions.
Enabled: true
AcrossEmptyLines: true
AcrossComments: true
AlignCompound: true
PadOperators: true
AlignConsecutiveShortCaseStatements:
Enabled: true
# if set to true;
# switch (level) {
# case log::info: return "info:";
# case log::warning: return "warning:";
# default: return "";
# }
# if set to false;
# switch (level) {
# case log::info: return "info:";
# case log::warning: return "warning:";
# default: return "";
# }
AcrossEmptyLines: true
AcrossComments: true
AlignCaseColons: true
# if set to true;
# switch (level) {
# case log::info : return "info:";
# case log::warning: return "warning:";
# default : return "";
# }
# if set to false;
# switch (level) {
# case log::info: return "info:";
# case log::warning: return "warning:";
# default: return "";
# }
AlignEscapedNewlines: LeftWithLastLine # #define A \
# int aaaa; \
# int b; \
# int dddddddddd;
AlignOperands: Align # int aaa = bbbbbbbbbbbbbbb +
# ccccccccccccccc;
AlignTrailingComments:
Kind: Always
OverEmptyLines: 0
# int a; // all these
#
# int ab; // comments are
#
#
# int abcdef; // aligned
AllowAllArgumentsOnNextLine: true # If a function call or braced initializer list doesn't fit on a line, allow putting ALL arguments
# onto the next line, even if BinPackArguments is false.
# if set to true;
# callFunction(
# a, b, c, d);
# if set to false;
# callFunction(a,
# b,
# c,
# d);
AllowAllParametersOfDeclarationOnNextLine: true # If the function declaration doesn't fit on a line, allow putting ALL parameters of a
# function declaration onto the next line even if BinPackParameters is false.
# if set to true;
# void myFunction(
# int a, int b, int c, int d, int e);
# if set to false;
# void myFunction(int a,
# int b,
# int c,
# int d,
# int e);
AllowBreakBeforeNoexceptSpecifier: Never # Controls if there could be a line break before a noexcept specifier.
AllowShortBlocksOnASingleLine: Always # Always merge short blocks into a single line.
# e.g.
# while (true) {}
# while (true) { continue; }
AllowShortCaseExpressionOnASingleLine: true
AllowShortCaseLabelsOnASingleLine: true # If true, short case labels will be contracted to a single line.
AllowShortCompoundRequirementOnASingleLine: true
# template <typename T>
# concept c = requires(T x) {
# { x + 1 } -> std::same_as<int>;
# };
# false:
# template <typename T>
# concept c = requires(T x) {
# {
# x + 1
# } -> std::same_as<int>;
# };
AllowShortEnumsOnASingleLine: true
AllowShortFunctionsOnASingleLine: All
AllowShortIfStatementsOnASingleLine: WithoutElse # Put short ifs on the same line only if there is no else statement.
AllowShortLambdasOnASingleLine: All
AllowShortLoopsOnASingleLine: true
AlwaysBreakAfterReturnType: None # Break after return type automatically. PenaltyReturnTypeOnItsOwnLine is taken into account.
# Note that this about the return TYPE not the return STATEMENT!
# If set to None;
# class A {
# int f() { return 0; };
# };
# int f();
# int f() { return 1; }
# If set to All; Always break after the return type.
# class A {
# int
# f() {
# return 0;
# };
# };
# int
# f();
# int
# f() {
# return 1;
# }
# If set to TopLevel; Always break after the return types of top-level functions.
# class A {
# int f() { return 0; };
# };
# int
# f();
# int
# f() {
# return 1;
# }
# If set to AllDefinitions; Always break after the return type of function definitions.
# class A {
# int
# f() {
# return 0;
# };
# };
# int f();
# int
# f() {
# return 1;
# }
# If set to TopLevelDefinitions; Always break after the return type of top-level definitions.
# class A {
# int f() { return 0; };
# };
# int f();
# int
# f() {
# return 1;
# }
AlwaysBreakBeforeMultilineStrings: false # if set to true; if set to false;
# aaaa = vs. aaaa = "bbbb"
# "bbbb" "cccc";
# "cccc";
AlwaysBreakTemplateDeclarations: MultiLine # Force break after template declaration only when the following declaration spans multiple lines.
# template <typename T> T foo() {
# }
# template <typename T>
# T foo(int aaaaaaaaaaaaaaaaaaaaa,
# int bbbbbbbbbbbbbbbbbbbbb) {
# }
AttributeMacros: []
BinPackArguments: false # If false, a function call's arguments will either be all on the same line or will have one line each.
BinPackParameters: false # If false, a function declaration's or function definition''s parameters will either all be on the same
# line or will have one line each.
BitFieldColonSpacing: Both
BracedInitializerIndentWidth: 3
BraceWrapping:
AfterCaseLabel: false
# if set to false; if set to true;
# switch (foo) { vs. switch (foo) {
# case 1: { case 1:
# bar(); {
# break; bar();
# } break;
# default: { }
# plop(); default:
# } {
# } plop();
# }
# }
AfterClass: false
AfterControlStatement: Never # Wrap control statements (if/for/while/switch/..).
AfterEnum: false
AfterExternBlock: false
# if set to true;
# extern "C"
# {
# int foo();
# }
# if set to false;
# extern "C" {
# int foo();
# }
AfterFunction: false
AfterNamespace: false
# Wrap ObjC definitions (interfaces, implementations…). That's for Objective-C!
# AfterObjCDeclaration: false
AfterStruct: false
AfterUnion: false
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
# if set to true;
# connect(
# []()
# {
# foo();
# bar();
# });
# if set to false;
# connect([]() {
# foo();
# bar();
# });
BeforeWhile: false # Wrap the while statement of a do while loop.
IndentBraces: false # If set to true, unnecessarily indents conditional statements with multiline bodies. Yikes!
SplitEmptyFunction: false # If false, empty function body can be put on a single line. This option is used only if the opening brace
# of the function has already been wrapped
# if set to false; if set to true;
# int f() vs. int f()
# {} {
# }
SplitEmptyRecord: false # If false, empty record (e.g. class, struct or union) body can be put on a single line.
# This option is used only if the opening brace of the record has already been wrapped
SplitEmptyNamespace: false # If false, empty namespace body can be put on a single line. This option is used only if
# the opening brace of the namespace has already been wrapped
BreakAdjacentStringLiterals: true
BreakAfterAttributes: Never # Break after a group of C++11 attributes before a function declaration/definition name.
# If set to Never;
# [[nodiscard]] inline int f();
# [[gnu::const]] [[nodiscard]] int g();
BreakAfterReturnType: Automatic
BreakArrays: false # This is currently only for formatting JSON.
# if set to true; if set to false;
# [ vs. [1, 2, 3, 4]
# 1,
# 2,
# 3,
# 4
# ]
BreakBeforeBinaryOperators: None
# Break after operators.
# LooooooooooongType loooooooooooooooooooooongVariable =
# someLooooooooooooooooongFunction();
# bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +
# aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==
# aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&
# aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >
# ccccccccccccccccccccccccccccccccccccccccc;
BreakBeforeBraces: Custom # Control of individual brace wrapping cases. (Whether a line break is inserted before the starting brace `{`)
BreakBeforeConceptDeclarations: Never # The concept declaration style to use.
# Keep the template declaration line together with concept.
# template <typename T> concept C = ...;
BreakBeforeInlineASMColon: OnlyMultiline
# BreakBinaryOperations: Never # clang-format 20.0
BreakBeforeTernaryOperators: false # If true, ternary operators will be placed after line breaks.
# if set to true;
# veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription
# ? firstValue
# : SecondValueVeryVeryVeryVeryLong;
#
# if set to false;
# veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ?
# firstValue :
# SecondValueVeryVeryVeryVeryLong;
BreakConstructorInitializers: AfterColon # The break constructor initializers style to use.
# If set to AfterColon;
# Constructor() :
# initializer1(),
# initializer2()
BreakFunctionDefinitionParameters: false
BreakInheritanceList: AfterColon
# class Foo :
# Base1,
# Base2
# {};
BreakStringLiterals: false
# if set to true;
# const char* x = "veryVeryVeryVeryVeryVe"
# "ryVeryVeryVeryVeryVery"
# "VeryLongString";
# if set to false;
# const char* x =
# "veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongString";
BreakTemplateDeclarations: No
ColumnLimit: 140 # A column limit of 0 means that there is no column limit. In this case, clang-format will respect
# the input's line breaking decisions within statements unless they contradict other rules.
CommentPragmas: '^ IWYU pragma:' # A regular expression that describes comments with special meaning, which should not be split into lines or otherwise changed.
CompactNamespaces: false # If true, consecutive namespace declarations will be on the same line. If false, each namespace is declared on a new line.
# if set to true;
# namespace Foo { namespace Bar {
# }}
# if set to false;
# namespace Foo {
# namespace Bar {
# }
# }
ConstructorInitializerIndentWidth: 4 # The number of characters to use for indentation of constructor initializer lists as well as inheritance lists.
ContinuationIndentWidth: 4 # Indent width for line continuations.
Cpp11BracedListStyle: false
# If true, format braced lists as best suited for C++11 braced lists.
# Important differences: - No spaces inside the braced list. - No line break before the closing brace. - Indentation with the continuation
# indent, not with the block indent.
# Fundamentally, C++11 braced lists are formatted exactly like function calls would be formatted in their place. If the braced list follows
# a name (e.g. a type or variable name), clang-format formats as if the {} were the parentheses of a function call with that name. If there
# is no name, a zero-length name is assumed.
# if set to true; if set to false;
# vector<int> x{1, 2, 3, 4}; vs. vector<int> x{ 1, 2, 3, 4 };
# vector<T> x{{}, {}, {}, {}}; vector<T> x{ {}, {}, {}, {} };
# f(MyMap[{composite, key}]); f(MyMap[{ composite, key }]);
# new int[3]{1, 2, 3}; new int[3]{ 1, 2, 3 };
DerivePointerAlignment: false # If true, analyze the formatted file for the most common alignment of & and *.
# Pointer and reference alignment styles are going to be updated according to the preferences found
# in the file. PointerAlignment is then used only as fallback.
DisableFormat: false # Disables formatting completely.
EmptyLineAfterAccessModifier: Never # Defines when to put an empty line after access modifiers. EmptyLineBeforeAccessModifier configuration
# handles the number of empty lines between two access modifiers.
# If set to Never; removes all empty lines after access modifiers.
# struct foo {
# private:
# int i;
# protected:
# int j;
# /* comment */
# public:
# foo() {}
# private:
# protected:
# };
EmptyLineBeforeAccessModifier: Always
# If set to Always; add empty line before access modifiers unless access modifier is at the start of struct or class definition.
# struct foo {
# private:
# int i;
#
# protected:
# int j;
# /* comment */
#
# public:
# foo() {}
#
# private:
#
# protected:
# };
ExperimentalAutoDetectBinPacking: false
FixNamespaceComments: true # If true, clang-format adds missing namespace end comments for namespaces and fixes invalid existing
# ones. This doesn't affect short namespaces, which are controlled by ShortNamespaceLines.
# if set to true; if set to false;
# namespace longNamespace { vs. namespace longNamespace {
# void foo(); void foo();
# void bar(); void bar();
# } // namespace a }
# namespace shortNamespace { namespace shortNamespace {
# void baz(); void baz();
# } }
IncludeBlocks: Regroup # Dependent on the value, multiple #include blocks can be sorted as one and divided based on category.
# If set to Regroup;
# IBS_Regroup (in configuration: Regroup) Merge multiple #include blocks together and sort as one. Then split into groups based on category
# priority. See IncludeCategories.
# #include "b.h" into #include "a.h"
# #include "b.h"
# #include <lib/main.h>
# #include "a.h" #include <lib/main.h>
IncludeCategories:
# These regular expressions are matched against the filename of an include (including the <> or “”) in order.
# The value belonging to the first matching regular expression is assigned and #includes are sorted first according to
# increasing category number and then alphabetically within each category.
# The main header for a source file automatically gets category 0. so that it is generally kept at the beginning of the #includes.
# e.g. If the source is "source.cpp", then a header named "source.h" or "source.hpp" will be considered the main header.
# By default this header gets a `Priority` score of 0.
# If we want this header to be treated as a regular header, use negative priorities for other header groups.
# The value of Priority defines the order of #include blocks and also allows the grouping of #includes of different priority.
# The smaller the `Priority` value, the upper that group will be rearranged in the source file!
# SortPriority is set to the value of Priority as default if it is not assigned.
- Regex: '^(<([0-9a-zA-Z\_\-]+)>)$' # C++ headers in the <header> form (intending to target STL headers)
Priority: -2
SortPriority: 0
CaseSensitive: false
- Regex: '^(<([0-9a-zA-Z\_\-]+)\.h>)$' # C headers in the <header.h> form (intending to target C stdlib headers)
Priority: -1
SortPriority: 0
CaseSensitive: false
- Regex: '^(\"([0-9a-zA-Z\_\-]+)\.hpp\")$' # C++ headers in the "header.hpp" form
Priority: 0
SortPriority: 0
CaseSensitive: false
- Regex: '^(\"([0-9a-zA-Z\_\-]+)\.h\")$' # C headers in the format "header.h"
Priority: 0
SortPriority: 0
CaseSensitive: false
IncludeIsMainRegex: '(_test)?$'
# Specifies the regex for finding the main header of a source file.
# When guessing whether a #include is the “main” include (to assign category 0, see above), use this regex of allowed suffixes
# to the header stem. A partial match is done, so that: - “” means “arbitrary suffix” - “$” means “no suffix”
# For example, if configured to “(_test)?$”, then a header a.h would be seen as the “main” include in both a.cc and a_test.cc.
IncludeIsMainSourceRegex: ''
# Specify a regular expression for files being formatted that are allowed to be considered “main” in the file-to-main-include mapping.
# i.e This regex is used to decide whether this is a source file for which clang-format should look for a main header!
# By default, clang-format considers files as “main” only when they end with: .c, .cc, .cpp, .c++, .cxx, .m or .mm extensions.
# For these files a guessing of “main” include takes place (to assign category 0, see above).
IndentAccessModifiers: true
# When false, access modifiers are indented (or outdented) relative to the record members, respecting the AccessModifierOffset.
# Record members are indented one level below the record
# When true, access modifiers get their own indentation level. As a consequence, record members are always indented 2 levels below the record,
# regardless of the access modifier presence. Value of the AccessModifierOffset is ignored.
# if set to false; if set to true;
# class C { vs. class C {
# class D { class D {
# void bar(); void bar();
# protected: protected:
# D(); D();
# }; };
# public: public:
# C(); C();
# }; };
# void foo() { void foo() {
# return 1; return 1;
# } }
IndentCaseBlocks: true
# Indent case label blocks one level from the case label.
# if set to false; if set to true;
# switch (fool) { vs. switch (fool) {
# case 1: { case 1:
# bar(); {
# } break; bar();
# default: { }
# plop(); break;
# } default:
# } {
# plop();
# }
# }
IndentCaseLabels: true
# If set to false; If set to true;
# switch (fool) { vs. switch (fool) {
# case 1: case 1:
# bar(); bar();
# break; break;
# default: default:
# plop(); plop();
# } }
IndentExternBlock: Indent
# extern "C" {
# void foo();
# }
IndentGotoLabels: false # When false, goto labels are flushed left.
IndentPPDirectives: BeforeHash # he preprocessor directive indenting style to use.
# #if FOO
# #if BAR
# #include <foo>
# #endif
# #endif
IndentRequiresClause: true
# If set to true;
# template <typename It>
# requires Iterator<It>
# void sort(It begin, It end) {
# //....
# }
# If set to false;
# template <typename It>
# requires Iterator<It>
# void sort(It begin, It end) {
# //....
# }
IndentWidth: 4 # The number of columns to use for indentation.
IndentWrappedFunctionNames: false # Indent if a function definition or declaration is wrapped after the type.
# If set to true;
# LoooooooooooooooooooooooooooooooooooooooongReturnType
# LoooooooooooooooooooooooooooooooongFunctionDeclaration();
# If set to false;
# LoooooooooooooooooooooooooooooooooooooooongReturnType
# LoooooooooooooooooooooooooooooooongFunctionDeclaration();
InsertBraces: false # Insert braces after control statements (if, else, for, do, and while) in C++ unless the control
# statements are inside macro definitions or the braces would enclose preprocessor directives.
InsertNewlineAtEOF: true
InsertTrailingCommas: None # insert trailing commas in container literals (arrays and objects) that wrap across multiple lines.
# It is currently only available for JavaScript.
# const someArray = [
# aaaaaaaaaaaaaaaaaaaaaaaaaa,
# aaaaaaaaaaaaaaaaaaaaaaaaaa,
# aaaaaaaaaaaaaaaaaaaaaaaaaa,
# // ^ inserted
# ]
IntegerLiteralSeparator: # Format integer literal separators (' for C++)
# If negative, remove separators. If 0, leave the literal as is. If positive,
# insert separators between digits starting from the rightmost digit.
# You can also specify a minimum number of digits (BinaryMinDigits, DecimalMinDigits, and HexMinDigits)
# the integer literal must have in order for the separators to be inserted.
Binary: 0
BinaryMinDigits: 0
Decimal: 0
DecimalMinDigits: 0
Hex: 0
HexMinDigits: 0
KeepEmptyLines:
AtEndOfFile: false
AtStartOfBlock: false
# If set to true; If set to false;
# if (foo) { vs. if (foo) {
# bar();
# bar(); }
# }
AtStartOfFile: false
LambdaBodyIndentation: Signature # The indentation style of lambda bodies. Signature (the default) causes the lambda body to be indented
# one additional level relative to the indentation level of the signature. OuterScope forces the lambda
# body to be indented one additional level relative to the parent scope containing the lambda signature.
# If set to Signature;
# someMethod(
# [](SomeReallyLongLambdaSignatureArgument foo) {
# return;
# });
# If set to OuterScope;
# someMethod(
# [](SomeReallyLongLambdaSignatureArgument foo) {
# return;
# });
# someMethod(someOtherMethod(
# [](SomeReallyLongLambdaSignatureArgument foo) {
# return;
# }));
LineEnding: CRLF
MacroBlockBegin: ''
MacroBlockEnd: ''
MainIncludeChar: AngleBracket
MaxEmptyLinesToKeep: 1 # The maximum number of consecutive empty lines to keep.
NamespaceIndentation: All
# namespace out {
# int i;
# namespace in {
# int i;
# }
# }
PackConstructorInitializers: NextLine
# Put all constructor initializers on the current line if they fit, else try to fit them on the next line.
# Otherwise, put each one on its own line.
# Constructor() : a(), b()
# Constructor()
# : aaaaaaaaaaaaaaaaaaaa(), bbbbbbbbbbbbbbbbbbbb(), ddddddddddddd()
# Constructor()
# : aaaaaaaaaaaaaaaaaaaa(),
# bbbbbbbbbbbbbbbbbbbb(),
# cccccccccccccccccccc()
PenaltyBreakAssignment: 2
PenaltyBreakBeforeFirstCallParameter: 19
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakOpenParenthesis: 0
PenaltyBreakString: 1000
PenaltyBreakTemplateDeclaration: 10
PenaltyExcessCharacter: 1000000
PenaltyIndentedWhitespace: 0
PenaltyReturnTypeOnItsOwnLine: 1000000
PointerAlignment: Left
PPIndentWidth: -1 # The number of columns to use for indentation of preprocessor statements.
# When set to -1 (default) IndentWidth is used also for preprocessor statements.
QualifierAlignment: Leave # Different ways to arrange specifiers and qualifiers (e.g. const/volatile).
# QualifierOrder: ['const', 'type', 'static', 'constexpr', 'inline']
# Items to the left of 'type' will be placed to the left of the type and aligned in the order supplied. Items to the right of 'type'
# will be placed to the right of the type and aligned in the order supplied.
ReferenceAlignment: Left # Reference alignment style (overrides PointerAlignment for references).
ReflowComments: false # If true, clang-format will attempt to re-flow comments.
# If set to false;
# // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information
# /* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information */
# If set to true;
# // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of
# // information
# /* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of
# * information */
RemoveBracesLLVM: true # Remove optional braces of control statements (if, else, for, and while) in C++ according to the LLVM coding style.
RemoveParentheses: ReturnStatement # Remove redundant parentheses.
# If set to Leave;
# class __declspec((dllimport)) X {};
# co_return (((0)));
# return ((a + b) - ((c + d)));
# If set to ReturnStatement;
# class __declspec(dllimport) X {};
# co_return 0;
# return (a + b) - (c + d);
RemoveSemicolon: false # Remove semicolons after the closing brace of a non-empty function.
RequiresClausePosition: SingleLine
# If set to WithPreceding;
# Try to put the clause together with the preceding part of a declaration.
# For class templates: stick to the template declaration. For function templates: stick to the template declaration.
# For function declaration followed by a requires clause: stick to the parameter list.
# template <typename T> requires C<T>
# struct Foo {...
# template <typename T> requires C<T>
# void bar(T t) {...
# template <typename T>
# void baz(T t) requires C<T>
# {...
# If set to WithFollowing;
# Try to put the requires clause together with the class or function declaration.
# template <typename T>
# requires C<T> struct Foo {...
# template <typename T>
# requires C<T> void bar(T t) {...
# template <typename T>
# void baz(T t)
# requires C<T> {...
# If set to SingleLine;
# Try to put everything in the same line if possible. Otherwise normal line breaking rules take over.
# // Fitting:
# template <typename T> requires C<T> struct Foo {...
# template <typename T> requires C<T> void bar(T t) {...
# template <typename T> void bar(T t) requires C<T> {...
# // Not fitting, one possible example:
# template <typename LongName>
# requires C<LongName>
# struct Foo {...
# template <typename LongName>
# requires C<LongName>
# void bar(LongName ln) {
# template <typename LongName>
# void bar(LongName ln)
# requires C<LongName> {
RequiresExpressionIndentation: OuterScope
SeparateDefinitionBlocks: Always # Specifies the use of empty lines to separate definition blocks, including classes, structs,
# enums, and functions.
ShortNamespaceLines: 10
SkipMacroDefinitionBody: false
SortIncludes: CaseInsensitive # Includes are sorted in an alphabetical or case insensitive fashion.
SortUsingDeclarations: Lexicographic
# Using declarations are sorted in the order defined as follows: Split the strings by “::” and discard any initial empty strings.
# Sort the lists of names lexicographically, and within those groups, names are in case-insensitive lexicographic order.
# If set to Lexicographic;
# using boost::regex;
# using boost::regex_constants::icase;
# using std::chrono::duration_cast;
# using std::move;
# using std::string;
SpaceAfterCStyleCast: true
# If set to true; If set to false;
# (int) i; vs. (int)i;
SpaceAfterLogicalNot: false
# If set to true; If set to false;
# ! someExpression(); vs. !someExpression();
SpaceAfterTemplateKeyword: false # If true, a space will be inserted after the 'template' keyword.
SpaceAroundPointerQualifiers: Default
SpaceBeforeAssignmentOperators: true
SpaceBeforeCaseColon: true
SpaceBeforeCpp11BracedList: true
SpaceBeforeCtorInitializerColon: true
SpaceBeforeInheritanceColon: true
SpaceBeforeJsonColon: true
SpaceBeforeParens: Custom
SpaceBeforeParensOptions:
AfterControlStatements: true
AfterForeachMacros: true
AfterFunctionDefinitionName: false
AfterFunctionDeclarationName: false
AfterIfMacros: true
AfterOverloadedOperator: false
AfterRequiresInClause: false
AfterRequiresInExpression: false
BeforeNonEmptyParentheses: false
SpaceBeforeRangeBasedForLoopColon: true
SpaceBeforeSquareBrackets: false
SpaceInEmptyBlock: true
SpacesBeforeTrailingComments: 1
SpacesInAngles: Never
SpacesInContainerLiterals: true
SpacesInLineCommentPrefix:
Minimum: 1
Maximum: -1
SpacesInParens: Custom
SpacesInParensOptions:
InCStyleCasts: false
InConditionalStatements: false
InEmptyParentheses: false
Other: false
SpacesInSquareBrackets: false
Standard: c++20
TabWidth: 4
UseTab: Never