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
|
/*
This file is part of the clazy static checker.
Copyright (C) 2016-2017 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 "unused-non-trivial-variable.h"
#include "Utils.h"
#include "StringUtils.h"
#include "HierarchyUtils.h"
#include "ContextUtils.h"
#include "QtUtils.h"
#include "clazy_stl.h"
#include <clang/AST/AST.h>
#include <clang/Lex/Lexer.h>
#include <vector>
#include <string>
using namespace clang;
using namespace std;
UnusedNonTrivialVariable::UnusedNonTrivialVariable(const std::string &name, ClazyContext *context)
: CheckBase(name, context, Option_CanIgnoreIncludes)
{
const char *user_blacklist = getenv("CLAZY_UNUSED_NON_TRIVIAL_VARIABLE_BLACKLIST");
const char *user_whitelist = getenv("CLAZY_UNUSED_NON_TRIVIAL_VARIABLE_WHITELIST");
if (user_blacklist)
m_userBlacklist = clazy::splitString(user_blacklist, ',');
if (user_whitelist)
m_userWhitelist = clazy::splitString(user_whitelist, ',');
}
void UnusedNonTrivialVariable::VisitStmt(clang::Stmt *stmt)
{
auto declStmt = dyn_cast<DeclStmt>(stmt);
if (!declStmt)
return;
for (auto decl : declStmt->decls())
handleVarDecl(dyn_cast<VarDecl>(decl));
}
bool UnusedNonTrivialVariable::isUninterestingType(const CXXRecordDecl *record) const
{
static const vector<StringRef> blacklist = { "QMutexLocker", "QDebugStateSaver",
"QTextBlockFormat", "QWriteLocker",
"QSignalBlocker", "QReadLocker", "PRNGLocker", "QDBusWriteLocker", "QDBusBlockingCallWatcher",
"QBoolBlocker", "QOrderedMutexLocker", "QTextLine", "QScopedScopeLevelCounter" };
// Check some obvious candidates first
StringRef typeName = clazy::name(record);
bool any = clazy::any_of(blacklist, [typeName] (StringRef container) {
return container == typeName;
});
if (any)
return true;
static const vector<StringRef> blacklistedTemplates = { "QScopedPointer", "QSetValueOnDestroy", "QScopedValueRollback" };
StringRef className = clazy::name(record);
for (StringRef templateName : blacklistedTemplates) {
if (clazy::startsWith(className, templateName))
return true;
}
// Now check the user's blacklist, set by env-variable
any = clazy::any_of(m_userBlacklist, [typeName] (const std::string &container) {
return container == typeName;
});
if (any)
return true;
return false;
}
bool UnusedNonTrivialVariable::isInterestingType(QualType t) const
{
// TODO Remove QColor in Qt6
static const vector<StringRef> nonTrivialTypes = { "QColor", "QVariant", "QFont", "QUrl", "QIcon",
"QImage", "QPixmap", "QPicture", "QBitmap", "QBrush",
"QPen", "QBuffer", "QCache", "QDateTime", "QDir", "QEvent",
"QFileInfo", "QFontInfo", "QFontMetrics", "QJSValue", "QLocale",
"QRegularExpression", "QRegExp", "QUrlQuery", "QStorageInfo",
"QPersistentModelIndex", "QJsonArray", "QJsonDocument",
"QMimeType", "QBitArray", "QCollator",
"QByteArrayList", "QCollatorSortKey",
"QCursor", "QPalette", "QPainterPath", "QRegion", "QFontInfo", "QTextCursor",
"QStaticText", "QFontMetricsF", "QTextFrameFormat", "QTextImageFormat",
"QNetworkCookie", "QNetworkRequest", "QNetworkConfiguration",
"QHostAddress", "QSqlQuery", "QSqlRecord", "QSqlField",
"QLine", "QLineF", "QRect", "QRectF"
};
CXXRecordDecl *record = TypeUtils::typeAsRecord(t);
if (!record)
return false;
if (isOptionSet("no-whitelist")) {
// Will cause too many false-positives, like RAII classes. Use suppressing comments to silence them.
return !isUninterestingType(record);
}
if (clazy::isQtContainer(record))
return true;
StringRef typeName = clazy::name(record);
bool any = clazy::any_of(nonTrivialTypes, [typeName] (StringRef container) {
return container == typeName;
});
if (any)
return true;
return clazy::any_of(m_userWhitelist, [typeName] (const std::string &container) {
return container == typeName;
});
}
void UnusedNonTrivialVariable::handleVarDecl(VarDecl *varDecl)
{
if (!varDecl || !isInterestingType(varDecl->getType()))
return;
auto currentFunc = clazy::firstContextOfType<FunctionDecl>(varDecl->getDeclContext());
Stmt *body = currentFunc ? currentFunc->getBody() : nullptr;
if (!body)
return;
SourceLocation locStart = getLocStart(varDecl);
locStart = sm().getExpansionLoc(locStart);
auto declRefs = clazy::getStatements<DeclRefExpr>(body, &sm(), locStart);
auto pred = [varDecl] (DeclRefExpr *declRef) {
return declRef->getDecl() == varDecl;
};
if (!clazy::any_of(declRefs, pred))
emitWarning(locStart, "unused " + clazy::simpleTypeName(varDecl->getType(), lo()));
}
|
