performance-unnecessary-value-param.cpp
13.9 KB
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
// RUN: %check_clang_tidy %s performance-unnecessary-value-param %t
// CHECK-FIXES: #include <utility>
struct ExpensiveToCopyType {
const ExpensiveToCopyType & constReference() const {
return *this;
}
void nonConstMethod();
virtual ~ExpensiveToCopyType();
};
void mutate(ExpensiveToCopyType &);
void mutate(ExpensiveToCopyType *);
void useAsConstReference(const ExpensiveToCopyType &);
void useByValue(ExpensiveToCopyType);
template <class T> class Vector {
public:
using iterator = T*;
using const_iterator = const T*;
Vector(const Vector&);
Vector& operator=(const Vector&);
iterator begin();
iterator end();
const_iterator begin() const;
const_iterator end() const;
};
// This class simulates std::pair<>. It is trivially copy constructible
// and trivially destructible, but not trivially copy assignable.
class SomewhatTrivial {
public:
SomewhatTrivial();
SomewhatTrivial(const SomewhatTrivial&) = default;
~SomewhatTrivial() = default;
SomewhatTrivial& operator=(const SomewhatTrivial&);
};
struct MoveOnlyType {
MoveOnlyType(const MoveOnlyType &) = delete;
MoveOnlyType(MoveOnlyType &&) = default;
~MoveOnlyType();
void constMethod() const;
};
struct ExpensiveMovableType {
ExpensiveMovableType();
ExpensiveMovableType(ExpensiveMovableType &&);
ExpensiveMovableType(const ExpensiveMovableType &) = default;
ExpensiveMovableType &operator=(const ExpensiveMovableType &) = default;
ExpensiveMovableType &operator=(ExpensiveMovableType &&);
~ExpensiveMovableType();
};
void positiveExpensiveConstValue(const ExpensiveToCopyType Obj);
// CHECK-FIXES: void positiveExpensiveConstValue(const ExpensiveToCopyType& Obj);
void positiveExpensiveConstValue(const ExpensiveToCopyType Obj) {
// CHECK-MESSAGES: [[@LINE-1]]:60: warning: the const qualified parameter 'Obj' is copied for each invocation; consider making it a reference [performance-unnecessary-value-param]
// CHECK-FIXES: void positiveExpensiveConstValue(const ExpensiveToCopyType& Obj) {
}
void positiveExpensiveValue(ExpensiveToCopyType Obj);
// CHECK-FIXES: void positiveExpensiveValue(const ExpensiveToCopyType& Obj);
void positiveExpensiveValue(ExpensiveToCopyType Obj) {
// CHECK-MESSAGES: [[@LINE-1]]:49: warning: the parameter 'Obj' is copied for each invocation but only used as a const reference; consider making it a const reference [performance-unnecessary-value-param]
// CHECK-FIXES: void positiveExpensiveValue(const ExpensiveToCopyType& Obj) {
Obj.constReference();
useAsConstReference(Obj);
auto Copy = Obj;
useByValue(Obj);
}
void positiveVector(Vector<ExpensiveToCopyType> V) {
// CHECK-MESSAGES: [[@LINE-1]]:49: warning: the parameter 'V' is copied for each invocation but only used as a const reference; consider making it a const reference [performance-unnecessary-value-param]
// CHECK-FIXES: void positiveVector(const Vector<ExpensiveToCopyType>& V) {
for (const auto& Obj : V) {
useByValue(Obj);
}
}
void positiveWithComment(const ExpensiveToCopyType /* important */ S);
// CHECK-FIXES: void positiveWithComment(const ExpensiveToCopyType& /* important */ S);
void positiveWithComment(const ExpensiveToCopyType /* important */ S) {
// CHECK-MESSAGES: [[@LINE-1]]:68: warning: the const qualified
// CHECK-FIXES: void positiveWithComment(const ExpensiveToCopyType& /* important */ S) {
}
void positiveUnnamedParam(const ExpensiveToCopyType) {
// CHECK-MESSAGES: [[@LINE-1]]:52: warning: the const qualified parameter #1
// CHECK-FIXES: void positiveUnnamedParam(const ExpensiveToCopyType&) {
}
void positiveAndNegative(const ExpensiveToCopyType ConstCopy, const ExpensiveToCopyType& ConstRef, ExpensiveToCopyType Copy);
// CHECK-FIXES: void positiveAndNegative(const ExpensiveToCopyType& ConstCopy, const ExpensiveToCopyType& ConstRef, const ExpensiveToCopyType& Copy);
void positiveAndNegative(const ExpensiveToCopyType ConstCopy, const ExpensiveToCopyType& ConstRef, ExpensiveToCopyType Copy) {
// CHECK-MESSAGES: [[@LINE-1]]:52: warning: the const qualified parameter 'ConstCopy'
// CHECK-MESSAGES: [[@LINE-2]]:120: warning: the parameter 'Copy'
// CHECK-FIXES: void positiveAndNegative(const ExpensiveToCopyType& ConstCopy, const ExpensiveToCopyType& ConstRef, const ExpensiveToCopyType& Copy) {
}
struct PositiveConstValueConstructor {
PositiveConstValueConstructor(const ExpensiveToCopyType ConstCopy) {}
// CHECK-MESSAGES: [[@LINE-1]]:59: warning: the const qualified parameter 'ConstCopy'
// CHECK-FIXES: PositiveConstValueConstructor(const ExpensiveToCopyType& ConstCopy) {}
};
template <typename T> void templateWithNonTemplatizedParameter(const ExpensiveToCopyType S, T V) {
// CHECK-MESSAGES: [[@LINE-1]]:90: warning: the const qualified parameter 'S'
// CHECK-FIXES: template <typename T> void templateWithNonTemplatizedParameter(const ExpensiveToCopyType& S, T V) {
}
void instantiated() {
templateWithNonTemplatizedParameter(ExpensiveToCopyType(), ExpensiveToCopyType());
templateWithNonTemplatizedParameter(ExpensiveToCopyType(), 5);
}
template <typename T> void negativeTemplateType(const T V) {
}
void negativeArray(const ExpensiveToCopyType[]) {
}
void negativePointer(ExpensiveToCopyType* Obj) {
}
void negativeConstPointer(const ExpensiveToCopyType* Obj) {
}
void negativeConstReference(const ExpensiveToCopyType& Obj) {
}
void negativeReference(ExpensiveToCopyType& Obj) {
}
void negativeUniversalReference(ExpensiveToCopyType&& Obj) {
}
void negativeSomewhatTrivialConstValue(const SomewhatTrivial Somewhat) {
}
void negativeSomewhatTrivialValue(SomewhatTrivial Somewhat) {
}
void negativeConstBuiltIn(const int I) {
}
void negativeValueBuiltIn(int I) {
}
void negativeValueIsMutatedByReference(ExpensiveToCopyType Obj) {
mutate(Obj);
}
void negativeValueIsMutatatedByPointer(ExpensiveToCopyType Obj) {
mutate(&Obj);
}
void negativeValueIsReassigned(ExpensiveToCopyType Obj) {
Obj = ExpensiveToCopyType();
}
void negativeValueNonConstMethodIsCalled(ExpensiveToCopyType Obj) {
Obj.nonConstMethod();
}
struct PositiveValueUnusedConstructor {
PositiveValueUnusedConstructor(ExpensiveToCopyType Copy) {}
// CHECK-MESSAGES: [[@LINE-1]]:54: warning: the parameter 'Copy'
// CHECK-FIXES: PositiveValueUnusedConstructor(const ExpensiveToCopyType& Copy) {}
};
struct PositiveValueCopiedConstructor {
PositiveValueCopiedConstructor(ExpensiveToCopyType Copy) : Field(Copy) {}
// CHECK-MESSAGES: [[@LINE-1]]:54: warning: the parameter 'Copy'
// CHECK-FIXES: PositiveValueCopiedConstructor(const ExpensiveToCopyType& Copy) : Field(Copy) {}
ExpensiveToCopyType Field;
};
struct PositiveValueMovableConstructor {
PositiveValueMovableConstructor(ExpensiveMovableType Copy) : Field(Copy) {}
// CHECK-MESSAGES: [[@LINE-1]]:70: warning: parameter 'Copy'
// CHECK-FIXES: PositiveValueMovableConstructor(ExpensiveMovableType Copy) : Field(std::move(Copy)) {}
ExpensiveMovableType Field;
};
struct NegativeValueMovedConstructor {
NegativeValueMovedConstructor(ExpensiveMovableType Copy) : Field(static_cast<ExpensiveMovableType &&>(Copy)) {}
ExpensiveMovableType Field;
};
template <typename T>
struct Container {
typedef const T & const_reference;
};
void NegativeTypedefParam(const Container<ExpensiveToCopyType>::const_reference Param) {
}
#define UNNECESSARY_VALUE_PARAM_IN_MACRO_BODY() \
void inMacro(const ExpensiveToCopyType T) { \
} \
// Ensure fix is not applied.
// CHECK-FIXES: void inMacro(const ExpensiveToCopyType T) {
UNNECESSARY_VALUE_PARAM_IN_MACRO_BODY()
// CHECK-MESSAGES: [[@LINE-1]]:1: warning: the const qualified parameter 'T'
#define UNNECESSARY_VALUE_PARAM_IN_MACRO_ARGUMENT(ARGUMENT) \
ARGUMENT
UNNECESSARY_VALUE_PARAM_IN_MACRO_ARGUMENT(void inMacroArgument(const ExpensiveToCopyType InMacroArg) {})
// CHECK-MESSAGES: [[@LINE-1]]:90: warning: the const qualified parameter 'InMacroArg'
// CHECK-FIXES: void inMacroArgument(const ExpensiveToCopyType InMacroArg) {}
struct VirtualMethod {
virtual ~VirtualMethod() {}
virtual void handle(ExpensiveToCopyType T) const = 0;
};
struct NegativeOverriddenMethod : public VirtualMethod {
void handle(ExpensiveToCopyType Overridden) const {
// CHECK-FIXES: handle(ExpensiveToCopyType Overridden) const {
}
};
struct VirtualMethodWarningOnly {
virtual void methodWithExpensiveValueParam(ExpensiveToCopyType T) {}
// CHECK-MESSAGES: [[@LINE-1]]:66: warning: the parameter 'T' is copied
// CHECK-FIXES: virtual void methodWithExpensiveValueParam(ExpensiveToCopyType T) {}
virtual ~VirtualMethodWarningOnly() {}
};
struct PositiveNonVirualMethod {
void method(const ExpensiveToCopyType T) {}
// CHECK-MESSAGES: [[@LINE-1]]:41: warning: the const qualified parameter 'T' is copied
// CHECK-FIXES: void method(const ExpensiveToCopyType& T) {}
};
struct NegativeDeletedMethod {
~NegativeDeletedMethod() {}
NegativeDeletedMethod& operator=(NegativeDeletedMethod N) = delete;
// CHECK-FIXES: NegativeDeletedMethod& operator=(NegativeDeletedMethod N) = delete;
};
void NegativeMoveOnlyTypePassedByValue(MoveOnlyType M) {
M.constMethod();
}
void PositiveMoveOnCopyConstruction(ExpensiveMovableType E) {
auto F = E;
// CHECK-MESSAGES: [[@LINE-1]]:12: warning: parameter 'E' is passed by value and only copied once; consider moving it to avoid unnecessary copies [performance-unnecessary-value-param]
// CHECK-FIXES: auto F = std::move(E);
}
void PositiveConstRefNotMoveSinceReferencedMultipleTimes(ExpensiveMovableType E) {
// CHECK-MESSAGES: [[@LINE-1]]:79: warning: the parameter 'E' is copied
// CHECK-FIXES: void PositiveConstRefNotMoveSinceReferencedMultipleTimes(const ExpensiveMovableType& E) {
auto F = E;
auto G = E;
}
void PositiveMoveOnCopyAssignment(ExpensiveMovableType E) {
ExpensiveMovableType F;
F = E;
// CHECK-MESSAGES: [[@LINE-1]]:7: warning: parameter 'E' is passed by value
// CHECK-FIXES: F = std::move(E);
}
struct NotCopyAssigned {
NotCopyAssigned &operator=(const ExpensiveMovableType &);
};
void PositiveNoMoveForNonCopyAssigmentOperator(ExpensiveMovableType E) {
// CHECK-MESSAGES: [[@LINE-1]]:69: warning: the parameter 'E' is copied
// CHECK-FIXES: void PositiveNoMoveForNonCopyAssigmentOperator(const ExpensiveMovableType& E) {
NotCopyAssigned N;
N = E;
}
// The argument could be moved but is not since copy statement is inside a loop.
void PositiveNoMoveInsideLoop(ExpensiveMovableType E) {
// CHECK-MESSAGES: [[@LINE-1]]:52: warning: the parameter 'E' is copied
// CHECK-FIXES: void PositiveNoMoveInsideLoop(const ExpensiveMovableType& E) {
for (;;) {
auto F = E;
}
}
void PositiveConstRefNotMoveConstructible(ExpensiveToCopyType T) {
// CHECK-MESSAGES: [[@LINE-1]]:63: warning: the parameter 'T' is copied
// CHECK-FIXES: void PositiveConstRefNotMoveConstructible(const ExpensiveToCopyType& T) {
auto U = T;
}
void PositiveConstRefNotMoveAssignable(ExpensiveToCopyType A) {
// CHECK-MESSAGES: [[@LINE-1]]:60: warning: the parameter 'A' is copied
// CHECK-FIXES: void PositiveConstRefNotMoveAssignable(const ExpensiveToCopyType& A) {
ExpensiveToCopyType B;
B = A;
}
// Case where parameter in declaration is already const-qualified but not in
// implementation. Make sure a second 'const' is not added to the declaration.
void PositiveConstDeclaration(const ExpensiveToCopyType A);
// CHECK-FIXES: void PositiveConstDeclaration(const ExpensiveToCopyType& A);
void PositiveConstDeclaration(ExpensiveToCopyType A) {
// CHECK-MESSAGES: [[@LINE-1]]:51: warning: the parameter 'A' is copied
// CHECK-FIXES: void PositiveConstDeclaration(const ExpensiveToCopyType& A) {
}
void PositiveNonConstDeclaration(ExpensiveToCopyType A);
// CHECK-FIXES: void PositiveNonConstDeclaration(const ExpensiveToCopyType& A);
void PositiveNonConstDeclaration(const ExpensiveToCopyType A) {
// CHECK-MESSAGES: [[@LINE-1]]:60: warning: the const qualified parameter 'A'
// CHECK-FIXES: void PositiveNonConstDeclaration(const ExpensiveToCopyType& A) {
}
void PositiveOnlyMessageAsReferencedInCompilationUnit(ExpensiveToCopyType A) {
// CHECK-MESSAGES: [[@LINE-1]]:75: warning: the parameter 'A' is copied
// CHECK-FIXES: void PositiveOnlyMessageAsReferencedInCompilationUnit(ExpensiveToCopyType A) {
}
void ReferenceFunctionOutsideOfCallExpr() {
void (*ptr)(ExpensiveToCopyType) = &PositiveOnlyMessageAsReferencedInCompilationUnit;
}
void PositiveMessageAndFixAsFunctionIsCalled(ExpensiveToCopyType A) {
// CHECK-MESSAGES: [[@LINE-1]]:66: warning: the parameter 'A' is copied
// CHECK-FIXES: void PositiveMessageAndFixAsFunctionIsCalled(const ExpensiveToCopyType& A) {
}
void ReferenceFunctionByCallingIt() {
PositiveMessageAndFixAsFunctionIsCalled(ExpensiveToCopyType());
}
// Virtual method overrides of dependent types cannot be recognized unless they
// are marked as override or final. Test that check is not triggered on methods
// marked with override or final.
template <typename T>
struct NegativeDependentTypeInterface {
virtual void Method(ExpensiveToCopyType E) = 0;
};
template <typename T>
struct NegativeOverrideImpl : public NegativeDependentTypeInterface<T> {
void Method(ExpensiveToCopyType E) override {}
};
template <typename T>
struct NegativeFinalImpl : public NegativeDependentTypeInterface<T> {
void Method(ExpensiveToCopyType E) final {}
};
struct PositiveConstructor {
PositiveConstructor(ExpensiveToCopyType E) : E(E) {}
// CHECK-MESSAGES: [[@LINE-1]]:43: warning: the parameter 'E' is copied
// CHECK-FIXES: PositiveConstructor(const ExpensiveToCopyType& E) : E(E) {}
ExpensiveToCopyType E;
};
struct NegativeUsingConstructor : public PositiveConstructor {
using PositiveConstructor::PositiveConstructor;
};
void fun() {
ExpensiveToCopyType E;
NegativeUsingConstructor S(E);
}
template<typename T>
void templateFunction(T) {
}
template<>
void templateFunction<ExpensiveToCopyType>(ExpensiveToCopyType E) {
// CHECK-MESSAGES: [[@LINE-1]]:64: warning: the parameter 'E' is copied
// CHECK-FIXES: void templateFunction<ExpensiveToCopyType>(ExpensiveToCopyType E) {
E.constReference();
}