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
|
/*
This file is part of the clazy static checker.
Copyright (C) 2015 Sergio Martins <smartins@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "rule-of-three.h"
#include "Utils.h"
#include "MacroUtils.h"
#include "StringUtils.h"
#include "TypeUtils.h"
#include <clang/AST/AST.h>
using namespace clang;
using namespace std;
RuleOfThree::RuleOfThree(const std::string &name, ClazyContext *context)
: RuleOfBase(name, context)
{
m_filesToIgnore = { "qrc_" };
}
void RuleOfThree::VisitDecl(clang::Decl *decl)
{
CXXRecordDecl *record = dyn_cast<CXXRecordDecl>(decl);
if (!record || isBlacklisted(record) || !record->hasDefinition() || record->isPolymorphic())
return;
// fwd decl is not interesting
if (record != record->getDefinition())
return;
if (shouldIgnoreFile(getLocStart(decl)))
return;
const SourceLocation recordStart = getLocStart(record);
if (recordStart.isMacroID()) {
if (clazy::isInMacro(&m_astContext, recordStart, "Q_GLOBAL_STATIC_INTERNAL"))
return;
}
CXXConstructorDecl *copyCtor = Utils::copyCtor(record);
CXXMethodDecl *copyAssign = Utils::copyAssign(record);
CXXDestructorDecl *destructor = record->getDestructor();
const bool dtorDefaultedByUser = destructor && destructor->isDefaulted() && !destructor->isImplicit();
const bool hasUserCopyCtor = copyCtor && copyCtor->isUserProvided();
const bool hasUserCopyAssign = copyAssign && copyAssign->isUserProvided();
const bool hasUserDtor = destructor && destructor->isUserProvided();
//const bool hasMoveCtor = record->hasNonTrivialMoveConstructor();
//const bool hasTrivialMoveAssignment = record->hasNonTrivialMoveAssignment();
const bool copyCtorIsDeleted = copyCtor && copyCtor->isDeleted();
const bool copyAssignIsDeleted = copyAssign && copyAssign->isDeleted();
if (hasUserDtor && (copyCtorIsDeleted || copyAssignIsDeleted)) {
// One of the copy methods was explicitely deleted, it's safe.
// The case we want to catch is when one is user-written and the other is
// compiler-generated.
return;
}
const int numImplemented = hasUserCopyCtor + hasUserCopyAssign + hasUserDtor;
if (numImplemented == 0 || numImplemented == 3) // Rule of 3 respected
return;
vector<StringRef> hasList;
vector<StringRef> missingList;
if (hasUserDtor)
hasList.push_back("dtor");
else
missingList.push_back("dtor");
if (hasUserCopyCtor)
hasList.push_back("copy-ctor");
else
missingList.push_back("copy-ctor");
if (hasUserCopyAssign)
hasList.push_back("copy-assignment");
else
missingList.push_back("copy-assignment");
const int numNotImplemented = missingList.size();
if (hasUserDtor && numImplemented == 1) {
// Protected dtor is a way for a non-polymorphic base class avoid being deleted
if (destructor->getAccess() == clang::AccessSpecifier::AS_protected)
return;
if (Utils::functionHasEmptyBody(destructor)) {
// Lets reduce noise and allow the empty dtor. In theory we could warn, but there's no
// hidden bug behind this dummy dtor.
return;
}
}
if (!hasUserDtor && (TypeUtils::derivesFrom(record, "QSharedData") || dtorDefaultedByUser))
return;
if (Utils::hasMember(record, "QSharedDataPointer"))
return; // These need boiler-plate copy ctor and dtor
const string className = record->getNameAsString();
const string classQualifiedName = record->getQualifiedNameAsString();
const string filename = sm().getFilename(recordStart);
if (clazy::endsWith(className, "Private") && clazy::endsWithAny(filename, { ".cpp", ".cxx", "_p.h" }))
return; // Lots of RAII classes fall into this category. And even Private (d-pointer) classes, warning in that case would just be noise
string msg = classQualifiedName + " has ";
for (int i = 0; i < numImplemented; ++i) {
msg += hasList[i];
const bool isLast = i == numImplemented - 1;
if (!isLast)
msg += ',';
msg += ' ';
}
msg += "but not ";
for (int i = 0; i < numNotImplemented; ++i) {
msg += missingList[i];
const bool isLast = i == numNotImplemented - 1;
if (!isLast)
msg += ", ";
}
emitWarning(getLocStart(decl), msg);
}
|
