xref: /llvm-project/clang-tools-extra/test/clang-tidy/checkers/bugprone/argument-comment-literals.cpp (revision e8a3ddafe063c970df9c23e803812369abde4c82) 
189a1d03eSRichard // RUN: %check_clang_tidy %s bugprone-argument-comment %t -- \
2*e8a3ddafSNathan James // RUN:   -config="{CheckOptions: { \
3*e8a3ddafSNathan James // RUN:     bugprone-argument-comment.CommentBoolLiterals: true, \
4*e8a3ddafSNathan James // RUN:     bugprone-argument-comment.CommentIntegerLiterals: true, \
5*e8a3ddafSNathan James // RUN:     bugprone-argument-comment.CommentFloatLiterals: true, \
6*e8a3ddafSNathan James // RUN:     bugprone-argument-comment.CommentUserDefinedLiterals: true, \
7*e8a3ddafSNathan James // RUN:     bugprone-argument-comment.CommentStringLiterals: true, \
8*e8a3ddafSNathan James // RUN:     bugprone-argument-comment.CommentNullPtrs: true, \
9*e8a3ddafSNathan James // RUN:     bugprone-argument-comment.CommentCharacterLiterals: true}}" --
1089a1d03eSRichard 
1189a1d03eSRichard struct A {
1289a1d03eSRichard   void foo(bool abc);
1389a1d03eSRichard   void foo(bool abc, bool cde);
1489a1d03eSRichard   void foo(const char *, bool abc);
1589a1d03eSRichard   void foo(int iabc);
1689a1d03eSRichard   void foo(float fabc);
1789a1d03eSRichard   void foo(double dabc);
1889a1d03eSRichard   void foo(const char *strabc);
1989a1d03eSRichard   void fooW(const wchar_t *wstrabc);
2089a1d03eSRichard   void fooPtr(A *ptrabc);
2189a1d03eSRichard   void foo(char chabc);
2289a1d03eSRichard };
2389a1d03eSRichard 
2489a1d03eSRichard #define FOO 1
2589a1d03eSRichard #define X(x) (x)
2689a1d03eSRichard 
2789a1d03eSRichard void g(int a);
2889a1d03eSRichard void h(double b);
2989a1d03eSRichard void i(const char *c);
3089a1d03eSRichard void j(int a, int b, int c);
3189a1d03eSRichard 
3289a1d03eSRichard double operator"" _km(long double value);
3389a1d03eSRichard 
test()3489a1d03eSRichard void test() {
3589a1d03eSRichard   A a;
3689a1d03eSRichard 
3789a1d03eSRichard   a.foo(true);
3889a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
3989a1d03eSRichard   // CHECK-FIXES: a.foo(/*abc=*/true);
4089a1d03eSRichard 
4189a1d03eSRichard   a.foo(false);
4289a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
4389a1d03eSRichard   // CHECK-FIXES: a.foo(/*abc=*/false);
4489a1d03eSRichard 
4589a1d03eSRichard   a.foo(true, false);
4689a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
4789a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-2]]:15: warning: argument comment missing for literal argument 'cde' [bugprone-argument-comment]
4889a1d03eSRichard   // CHECK-FIXES: a.foo(/*abc=*/true, /*cde=*/false);
4989a1d03eSRichard 
5089a1d03eSRichard   a.foo(false, true);
5189a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
5289a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-2]]:16: warning: argument comment missing for literal argument 'cde' [bugprone-argument-comment]
5389a1d03eSRichard   // CHECK-FIXES: a.foo(/*abc=*/false, /*cde=*/true);
5489a1d03eSRichard 
5589a1d03eSRichard   a.foo(/*abc=*/false, true);
5689a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:24: warning: argument comment missing for literal argument 'cde' [bugprone-argument-comment]
5789a1d03eSRichard   // CHECK-FIXES: a.foo(/*abc=*/false, /*cde=*/true);
5889a1d03eSRichard 
5989a1d03eSRichard   a.foo(false, /*cde=*/true);
6089a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
6189a1d03eSRichard   // CHECK-FIXES: a.foo(/*abc=*/false, /*cde=*/true);
6289a1d03eSRichard 
6389a1d03eSRichard   bool val1 = true;
6489a1d03eSRichard   bool val2 = false;
6589a1d03eSRichard   a.foo(val1, val2);
6689a1d03eSRichard 
6789a1d03eSRichard   a.foo("", true);
6889a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:13: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
6989a1d03eSRichard   // CHECK-FIXES: a.foo("", /*abc=*/true);
7089a1d03eSRichard 
7189a1d03eSRichard   a.foo(0);
7289a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'iabc' [bugprone-argument-comment]
7389a1d03eSRichard   // CHECK-FIXES: a.foo(/*iabc=*/0);
7489a1d03eSRichard 
7589a1d03eSRichard   a.foo(1.0f);
7689a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'fabc' [bugprone-argument-comment]
7789a1d03eSRichard   // CHECK-FIXES: a.foo(/*fabc=*/1.0f);
7889a1d03eSRichard 
7989a1d03eSRichard   a.foo(-1.0f);
8089a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'fabc' [bugprone-argument-comment]
8189a1d03eSRichard   // CHECK-FIXES: a.foo(/*fabc=*/-1.0f);
8289a1d03eSRichard 
8389a1d03eSRichard   a.foo(1.0);
8489a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
8589a1d03eSRichard   // CHECK-FIXES: a.foo(/*dabc=*/1.0);
8689a1d03eSRichard 
8789a1d03eSRichard   a.foo(-1.0);
8889a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
8989a1d03eSRichard   // CHECK-FIXES: a.foo(/*dabc=*/-1.0);
9089a1d03eSRichard 
9189a1d03eSRichard   int val3 = 10;
9289a1d03eSRichard   a.foo(val3);
9389a1d03eSRichard   a.foo(-val3);
9489a1d03eSRichard 
9589a1d03eSRichard   float val4 = 10.0;
9689a1d03eSRichard   a.foo(val4);
9789a1d03eSRichard   a.foo(-val4);
9889a1d03eSRichard 
9989a1d03eSRichard   double val5 = 10.0;
10089a1d03eSRichard   a.foo(val5);
10189a1d03eSRichard   a.foo(-val5);
10289a1d03eSRichard 
10389a1d03eSRichard   a.foo("Hello World");
10489a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'strabc' [bugprone-argument-comment]
10589a1d03eSRichard   // CHECK-FIXES: a.foo(/*strabc=*/"Hello World");
10689a1d03eSRichard   //
10789a1d03eSRichard   a.fooW(L"Hello World");
10889a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:10: warning: argument comment missing for literal argument 'wstrabc' [bugprone-argument-comment]
10989a1d03eSRichard   // CHECK-FIXES: a.fooW(/*wstrabc=*/L"Hello World");
11089a1d03eSRichard 
11189a1d03eSRichard   a.fooPtr(nullptr);
11289a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:12: warning: argument comment missing for literal argument 'ptrabc' [bugprone-argument-comment]
11389a1d03eSRichard   // CHECK-FIXES: a.fooPtr(/*ptrabc=*/nullptr);
11489a1d03eSRichard 
11589a1d03eSRichard   a.foo(402.0_km);
11689a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
11789a1d03eSRichard   // CHECK-FIXES: a.foo(/*dabc=*/402.0_km);
11889a1d03eSRichard 
11989a1d03eSRichard   a.foo(-402.0_km);
12089a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
12189a1d03eSRichard   // CHECK-FIXES: a.foo(/*dabc=*/-402.0_km);
12289a1d03eSRichard 
12389a1d03eSRichard   a.foo('A');
12489a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'chabc' [bugprone-argument-comment]
12589a1d03eSRichard   // CHECK-FIXES: a.foo(/*chabc=*/'A');
12689a1d03eSRichard 
12789a1d03eSRichard   g(FOO);
12889a1d03eSRichard   g(-FOO);
12989a1d03eSRichard   h(1.0f);
13089a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
13189a1d03eSRichard   // CHECK-FIXES: h(/*b=*/1.0f);
13289a1d03eSRichard   h(-1.0f);
13389a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
13489a1d03eSRichard   // CHECK-FIXES: h(/*b=*/-1.0f);
13589a1d03eSRichard   i(__FILE__);
13689a1d03eSRichard 
13789a1d03eSRichard   j(1, X(1), X(1));
13889a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'a' [bugprone-argument-comment]
13989a1d03eSRichard   // CHECK-FIXES: j(/*a=*/1, X(1), X(1));
14089a1d03eSRichard   j(/*a=*/1, X(1), X(1));
14189a1d03eSRichard 
14289a1d03eSRichard   j(X(1), 1, X(1));
14389a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:11: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
14489a1d03eSRichard   // CHECK-FIXES: j(X(1), /*b=*/1, X(1));
14589a1d03eSRichard   j(X(1), /*b=*/1, X(1));
14689a1d03eSRichard 
14789a1d03eSRichard   j(X(1), X(1), 1);
14889a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:17: warning: argument comment missing for literal argument 'c' [bugprone-argument-comment]
14989a1d03eSRichard   // CHECK-FIXES: j(X(1), X(1), /*c=*/1);
15089a1d03eSRichard   j(X(1), X(1), /*c=*/1);
15189a1d03eSRichard 
15289a1d03eSRichard   j(X(1), 1, 1);
15389a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:11: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
15489a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-2]]:14: warning: argument comment missing for literal argument 'c' [bugprone-argument-comment]
15589a1d03eSRichard   // CHECK-FIXES: j(X(1), /*b=*/1, /*c=*/1);
15689a1d03eSRichard   j(X(1), /*b=*/1, /*c=*/1);
15789a1d03eSRichard 
15889a1d03eSRichard   j(1, X(1), 1);
15989a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'a' [bugprone-argument-comment]
16089a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-2]]:14: warning: argument comment missing for literal argument 'c' [bugprone-argument-comment]
16189a1d03eSRichard   // CHECK-FIXES: j(/*a=*/1, X(1), /*c=*/1);
16289a1d03eSRichard   j(/*a=*/1, X(1), /*c=*/1);
16389a1d03eSRichard 
16489a1d03eSRichard   j(1, 1, X(1));
16589a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'a' [bugprone-argument-comment]
16689a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-2]]:8: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
16789a1d03eSRichard   // CHECK-FIXES: j(/*a=*/1, /*b=*/1, X(1));
16889a1d03eSRichard   j(/*a=*/1, /*b=*/1, X(1));
16989a1d03eSRichard 
17089a1d03eSRichard   // FIXME Would like the below to add argument comments.
17189a1d03eSRichard   g((1));
17289a1d03eSRichard   // FIXME But we should not add argument comments here.
17389a1d03eSRichard   g(_Generic(0, int : 0));
17489a1d03eSRichard 
17589a1d03eSRichard   402.0_km;
17689a1d03eSRichard }
17789a1d03eSRichard 
17889a1d03eSRichard void f(bool _with_underscores_);
ignores_underscores()17989a1d03eSRichard void ignores_underscores() {
18089a1d03eSRichard   f(false);
18189a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument '_with_underscores_' [bugprone-argument-comment]
18289a1d03eSRichard   // CHECK-FIXES: f(/*_with_underscores_=*/false);
18389a1d03eSRichard 
18489a1d03eSRichard   f(true);
18589a1d03eSRichard   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument
18689a1d03eSRichard   // CHECK-FIXES: f(/*_with_underscores_=*/true);
18789a1d03eSRichard }
188