bugprone-unhandled-self-assignment.cpp
12 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
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
// RUN: %check_clang_tidy %s bugprone-unhandled-self-assignment %t -- -- -fno-delayed-template-parsing
namespace std {
template <class T>
void swap(T x, T y) {
}
template <class T>
T &&move(T x) {
}
template <class T>
class unique_ptr {
};
template <class T>
class shared_ptr {
};
template <class T>
class weak_ptr {
};
template <class T>
class auto_ptr {
};
} // namespace std
void assert(int expression){};
///////////////////////////////////////////////////////////////////
/// Test cases correctly caught by the check.
class PtrField {
public:
PtrField &operator=(const PtrField &object);
private:
int *p;
};
PtrField &PtrField::operator=(const PtrField &object) {
// CHECK-MESSAGES: [[@LINE-1]]:21: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
// Class with an inline operator definition.
class InlineDefinition {
public:
InlineDefinition &operator=(const InlineDefinition &object) {
// CHECK-MESSAGES: [[@LINE-1]]:21: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
int *p;
};
class UniquePtrField {
public:
UniquePtrField &operator=(const UniquePtrField &object) {
// CHECK-MESSAGES: [[@LINE-1]]:19: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
std::unique_ptr<int> p;
};
class SharedPtrField {
public:
SharedPtrField &operator=(const SharedPtrField &object) {
// CHECK-MESSAGES: [[@LINE-1]]:19: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
std::shared_ptr<int> p;
};
class WeakPtrField {
public:
WeakPtrField &operator=(const WeakPtrField &object) {
// CHECK-MESSAGES: [[@LINE-1]]:17: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
std::weak_ptr<int> p;
};
class AutoPtrField {
public:
AutoPtrField &operator=(const AutoPtrField &object) {
// CHECK-MESSAGES: [[@LINE-1]]:17: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
std::auto_ptr<int> p;
};
// Class with C array field.
class CArrayField {
public:
CArrayField &operator=(const CArrayField &object) {
// CHECK-MESSAGES: [[@LINE-1]]:16: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
int array[256];
};
// Make sure to not ignore cases when the operator definition calls
// a copy constructor of another class.
class CopyConstruct {
public:
CopyConstruct &operator=(const CopyConstruct &object) {
// CHECK-MESSAGES: [[@LINE-1]]:18: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
WeakPtrField a;
WeakPtrField b(a);
// ...
return *this;
}
private:
int *p;
};
// Make sure to not ignore cases when the operator definition calls
// a copy assignment operator of another class.
class AssignOperator {
public:
AssignOperator &operator=(const AssignOperator &object) {
// CHECK-MESSAGES: [[@LINE-1]]:19: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
a.operator=(object.a);
// ...
return *this;
}
private:
int *p;
WeakPtrField a;
};
class NotSelfCheck {
public:
NotSelfCheck &operator=(const NotSelfCheck &object) {
// CHECK-MESSAGES: [[@LINE-1]]:17: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
if (&object == this->doSomething()) {
// ...
}
return *this;
}
void *doSomething() {
return p;
}
private:
int *p;
};
template <class T>
class TemplatePtrField {
public:
TemplatePtrField<T> &operator=(const TemplatePtrField<T> &object) {
// CHECK-MESSAGES: [[@LINE-1]]:24: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
T *p;
};
template <class T>
class TemplateCArrayField {
public:
TemplateCArrayField<T> &operator=(const TemplateCArrayField<T> &object) {
// CHECK-MESSAGES: [[@LINE-1]]:27: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
// ...
return *this;
}
private:
T p[256];
};
// Other template class's constructor is called inside a declaration.
template <class T>
class WrongTemplateCopyAndMove {
public:
WrongTemplateCopyAndMove<T> &operator=(const WrongTemplateCopyAndMove<T> &object) {
// CHECK-MESSAGES: [[@LINE-1]]:32: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
TemplatePtrField<T> temp;
TemplatePtrField<T> temp2(temp);
return *this;
}
private:
T *p;
};
///////////////////////////////////////////////////////////////////
/// Test cases correctly ignored by the check.
// Self-assignment is checked using the equality operator.
class SelfCheck1 {
public:
SelfCheck1 &operator=(const SelfCheck1 &object) {
if (this == &object)
return *this;
// ...
return *this;
}
private:
int *p;
};
class SelfCheck2 {
public:
SelfCheck2 &operator=(const SelfCheck2 &object) {
if (&object == this)
return *this;
// ...
return *this;
}
private:
int *p;
};
// Self-assignment is checked using the inequality operator.
class SelfCheck3 {
public:
SelfCheck3 &operator=(const SelfCheck3 &object) {
if (this != &object) {
// ...
}
return *this;
}
private:
int *p;
};
class SelfCheck4 {
public:
SelfCheck4 &operator=(const SelfCheck4 &object) {
if (&object != this) {
// ...
}
return *this;
}
private:
int *p;
};
template <class T>
class TemplateSelfCheck {
public:
TemplateSelfCheck<T> &operator=(const TemplateSelfCheck<T> &object) {
if (&object != this) {
// ...
}
return *this;
}
private:
T *p;
};
// There is no warning if the copy assignment operator gets the object by value.
class PassedByValue {
public:
PassedByValue &operator=(PassedByValue object) {
// ...
return *this;
}
private:
int *p;
};
// User-defined swap method calling std::swap inside.
class CopyAndSwap1 {
public:
CopyAndSwap1 &operator=(const CopyAndSwap1 &object) {
CopyAndSwap1 temp(object);
doSwap(temp);
return *this;
}
private:
int *p;
void doSwap(CopyAndSwap1 &object) {
using std::swap;
swap(p, object.p);
}
};
// User-defined swap method used with passed-by-value parameter.
class CopyAndSwap2 {
public:
CopyAndSwap2 &operator=(CopyAndSwap2 object) {
doSwap(object);
return *this;
}
private:
int *p;
void doSwap(CopyAndSwap2 &object) {
using std::swap;
swap(p, object.p);
}
};
// Copy-and-swap method is used but without creating a separate method for it.
class CopyAndSwap3 {
public:
CopyAndSwap3 &operator=(const CopyAndSwap3 &object) {
CopyAndSwap3 temp(object);
std::swap(p, temp.p);
return *this;
}
private:
int *p;
};
template <class T>
class TemplateCopyAndSwap {
public:
TemplateCopyAndSwap<T> &operator=(const TemplateCopyAndSwap<T> &object) {
TemplateCopyAndSwap<T> temp(object);
std::swap(p, temp.p);
return *this;
}
private:
T *p;
};
// Move semantics is used on a temporary copy of the object.
class CopyAndMove1 {
public:
CopyAndMove1 &operator=(const CopyAndMove1 &object) {
CopyAndMove1 temp(object);
*this = std::move(temp);
return *this;
}
private:
int *p;
};
// There is no local variable for the temporary copy.
class CopyAndMove2 {
public:
CopyAndMove2 &operator=(const CopyAndMove2 &object) {
*this = std::move(CopyAndMove2(object));
return *this;
}
private:
int *p;
};
template <class T>
class TemplateCopyAndMove {
public:
TemplateCopyAndMove<T> &operator=(const TemplateCopyAndMove<T> &object) {
TemplateCopyAndMove<T> temp(object);
*this = std::move(temp);
return *this;
}
private:
T *p;
};
// There is no local variable for the temporary copy.
template <class T>
class TemplateCopyAndMove2 {
public:
TemplateCopyAndMove2<T> &operator=(const TemplateCopyAndMove2<T> &object) {
*this = std::move(TemplateCopyAndMove2<T>(object));
return *this;
}
private:
T *p;
};
// We should not catch move assignment operators.
class MoveAssignOperator {
public:
MoveAssignOperator &operator=(MoveAssignOperator &&object) {
// ...
return *this;
}
private:
int *p;
};
// We ignore copy assignment operators without user-defined implementation.
class DefaultOperator {
public:
DefaultOperator &operator=(const DefaultOperator &object) = default;
private:
int *p;
};
class DeletedOperator {
public:
DeletedOperator &operator=(const DefaultOperator &object) = delete;
private:
int *p;
};
class ImplicitOperator {
private:
int *p;
};
// Check ignores those classes which has no any pointer or array field.
class TrivialFields {
public:
TrivialFields &operator=(const TrivialFields &object) {
// ...
return *this;
}
private:
int m;
float f;
double d;
bool b;
};
// There is no warning when the class calls another assignment operator on 'this'
// inside the copy assignment operator's definition.
class AssignIsForwarded {
public:
AssignIsForwarded &operator=(const AssignIsForwarded &object) {
operator=(object.p);
return *this;
}
AssignIsForwarded &operator=(int *pp) {
if (p != pp) {
delete p;
p = new int(*pp);
}
return *this;
}
private:
int *p;
};
// Assertion is a valid way to say that self-assignment is not expected to happen.
class AssertGuard {
public:
AssertGuard &operator=(const AssertGuard &object) {
assert(this != &object);
// ...
return *this;
}
private:
int *p;
};
// Make sure we don't catch this operator=() as a copy assignment operator.
// Note that RHS has swapped template arguments.
template <typename Ty, typename Uy>
class NotACopyAssignmentOperator {
Ty *Ptr1;
Uy *Ptr2;
public:
NotACopyAssignmentOperator& operator=(const NotACopyAssignmentOperator<Uy, Ty> &RHS) {
Ptr1 = RHS.getUy();
Ptr2 = RHS.getTy();
return *this;
}
Ty *getTy() const { return Ptr1; }
Uy *getUy() const { return Ptr2; }
};
///////////////////////////////////////////////////////////////////
/// Test cases which should be caught by the check.
// TODO: handle custom pointers.
template <class T>
class custom_ptr {
};
class CustomPtrField {
public:
CustomPtrField &operator=(const CustomPtrField &object) {
// ...
return *this;
}
private:
custom_ptr<int> p;
};
/////////////////////////////////////////////////////////////////////////////////////////////////////
/// False positives: These are self-assignment safe, but they don't use any of the three patterns.
class ArrayCopy {
public:
ArrayCopy &operator=(const ArrayCopy &object) {
// CHECK-MESSAGES: [[@LINE-1]]:14: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
for (int i = 0; i < 256; i++)
array[i] = object.array[i];
return *this;
}
private:
int array[256];
};
class GetterSetter {
public:
GetterSetter &operator=(const GetterSetter &object) {
// CHECK-MESSAGES: [[@LINE-1]]:17: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
setValue(object.getValue());
return *this;
}
int *getValue() const { return value; }
void setValue(int *newPtr) {
int *pTmp(newPtr ? new int(*newPtr) : nullptr);
std::swap(value, pTmp);
delete pTmp;
}
private:
int *value;
};
class CustomSelfCheck {
public:
CustomSelfCheck &operator=(const CustomSelfCheck &object) {
// CHECK-MESSAGES: [[@LINE-1]]:20: warning: operator=() does not handle self-assignment properly [bugprone-unhandled-self-assignment]
if (index != object.index) {
// ...
}
return *this;
}
private:
int *value;
int index;
};