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
|
// RUN: %check_clang_tidy %s bugprone-argument-comment %t -- \
// RUN: -config="{CheckOptions: [ \
// RUN: {key: bugprone-argument-comment.CommentBoolLiterals, value: 1}, \
// RUN: {key: bugprone-argument-comment.CommentIntegerLiterals, value: 1}, \
// RUN: {key: bugprone-argument-comment.CommentFloatLiterals, value: 1}, \
// RUN: {key: bugprone-argument-comment.CommentUserDefinedLiterals, value: 1}, \
// RUN: {key: bugprone-argument-comment.CommentStringLiterals, value: 1}, \
// RUN: {key: bugprone-argument-comment.CommentNullPtrs, value: 1}, \
// RUN: {key: bugprone-argument-comment.CommentCharacterLiterals, value: 1}]}" --
struct A {
void foo(bool abc);
void foo(bool abc, bool cde);
void foo(const char *, bool abc);
void foo(int iabc);
void foo(float fabc);
void foo(double dabc);
void foo(const char *strabc);
void fooW(const wchar_t *wstrabc);
void fooPtr(A *ptrabc);
void foo(char chabc);
};
#define FOO 1
#define X(x) (x)
void g(int a);
void h(double b);
void i(const char *c);
void j(int a, int b, int c);
double operator"" _km(long double);
void test() {
A a;
a.foo(true);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*abc=*/true);
a.foo(false);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*abc=*/false);
a.foo(true, false);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
// CHECK-MESSAGES: [[@LINE-2]]:15: warning: argument comment missing for literal argument 'cde' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*abc=*/true, /*cde=*/false);
a.foo(false, true);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
// CHECK-MESSAGES: [[@LINE-2]]:16: warning: argument comment missing for literal argument 'cde' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*abc=*/false, /*cde=*/true);
a.foo(/*abc=*/false, true);
// CHECK-MESSAGES: [[@LINE-1]]:24: warning: argument comment missing for literal argument 'cde' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*abc=*/false, /*cde=*/true);
a.foo(false, /*cde=*/true);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*abc=*/false, /*cde=*/true);
bool val1 = true;
bool val2 = false;
a.foo(val1, val2);
a.foo("", true);
// CHECK-MESSAGES: [[@LINE-1]]:13: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo("", /*abc=*/true);
a.foo(0);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'iabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*iabc=*/0);
a.foo(1.0f);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'fabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*fabc=*/1.0f);
a.foo(-1.0f);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'fabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*fabc=*/-1.0f);
a.foo(1.0);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*dabc=*/1.0);
a.foo(-1.0);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*dabc=*/-1.0);
int val3 = 10;
a.foo(val3);
a.foo(-val3);
float val4 = 10.0;
a.foo(val4);
a.foo(-val4);
double val5 = 10.0;
a.foo(val5);
a.foo(-val5);
a.foo("Hello World");
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'strabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*strabc=*/"Hello World");
//
a.fooW(L"Hello World");
// CHECK-MESSAGES: [[@LINE-1]]:10: warning: argument comment missing for literal argument 'wstrabc' [bugprone-argument-comment]
// CHECK-FIXES: a.fooW(/*wstrabc=*/L"Hello World");
a.fooPtr(nullptr);
// CHECK-MESSAGES: [[@LINE-1]]:12: warning: argument comment missing for literal argument 'ptrabc' [bugprone-argument-comment]
// CHECK-FIXES: a.fooPtr(/*ptrabc=*/nullptr);
a.foo(402.0_km);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*dabc=*/402.0_km);
a.foo(-402.0_km);
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'dabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*dabc=*/-402.0_km);
a.foo('A');
// CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'chabc' [bugprone-argument-comment]
// CHECK-FIXES: a.foo(/*chabc=*/'A');
g(FOO);
g(-FOO);
h(1.0f);
// CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
// CHECK-FIXES: h(/*b=*/1.0f);
h(-1.0f);
// CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
// CHECK-FIXES: h(/*b=*/-1.0f);
i(__FILE__);
j(1, X(1), X(1));
// CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'a' [bugprone-argument-comment]
// CHECK-FIXES: j(/*a=*/1, X(1), X(1));
j(/*a=*/1, X(1), X(1));
j(X(1), 1, X(1));
// CHECK-MESSAGES: [[@LINE-1]]:11: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
// CHECK-FIXES: j(X(1), /*b=*/1, X(1));
j(X(1), /*b=*/1, X(1));
j(X(1), X(1), 1);
// CHECK-MESSAGES: [[@LINE-1]]:17: warning: argument comment missing for literal argument 'c' [bugprone-argument-comment]
// CHECK-FIXES: j(X(1), X(1), /*c=*/1);
j(X(1), X(1), /*c=*/1);
j(X(1), 1, 1);
// CHECK-MESSAGES: [[@LINE-1]]:11: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
// CHECK-MESSAGES: [[@LINE-2]]:14: warning: argument comment missing for literal argument 'c' [bugprone-argument-comment]
// CHECK-FIXES: j(X(1), /*b=*/1, /*c=*/1);
j(X(1), /*b=*/1, /*c=*/1);
j(1, X(1), 1);
// CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'a' [bugprone-argument-comment]
// CHECK-MESSAGES: [[@LINE-2]]:14: warning: argument comment missing for literal argument 'c' [bugprone-argument-comment]
// CHECK-FIXES: j(/*a=*/1, X(1), /*c=*/1);
j(/*a=*/1, X(1), /*c=*/1);
j(1, 1, X(1));
// CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument 'a' [bugprone-argument-comment]
// CHECK-MESSAGES: [[@LINE-2]]:8: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
// CHECK-FIXES: j(/*a=*/1, /*b=*/1, X(1));
j(/*a=*/1, /*b=*/1, X(1));
// FIXME Would like the below to add argument comments.
g((1));
// FIXME But we should not add argument comments here.
g(_Generic(0, int : 0));
}
void f(bool _with_underscores_);
void ignores_underscores() {
f(false);
// CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument '_with_underscores_' [bugprone-argument-comment]
// CHECK-FIXES: f(/*_with_underscores_=*/false);
f(true);
// CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument
// CHECK-FIXES: f(/*_with_underscores_=*/true);
}
|
