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
|
/*
This file is part of the clazy static checker.
Copyright (C) 2015 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
Author: Sérgio Martins <sergio.martins@kdab.com>
Copyright (C) 2015 Nyall Dawson <nyall.dawson@gmail.com>
Copyright (C) 2015-2016 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 "checkmanager.h"
#include "temporaryiterator.h"
#include "Utils.h"
#include "HierarchyUtils.h"
#include "StringUtils.h"
#include <clang/AST/ParentMap.h>
#include <clang/AST/DeclCXX.h>
#include <clang/AST/Expr.h>
#include <clang/AST/ExprCXX.h>
using namespace clang;
using namespace std;
TemporaryIterator::TemporaryIterator(const std::string &name, const clang::CompilerInstance &ci)
: CheckBase(name, ci)
{
m_methodsByType["vector"] = {"begin", "end", "cbegin", "cend" }; // TODO: More stl support
m_methodsByType["QList"] = { "begin", "end", "constBegin", "constEnd", "cbegin", "cend" };
m_methodsByType["QVector"] = { "begin", "end","constBegin","constEnd", "cbegin", "cend", "insert" };
m_methodsByType["QMap"] = {"begin", "end", "constBegin", "constEnd", "find", "constFind", "lowerBound","upperBound", "cbegin", "cend", "equal_range" };
m_methodsByType["QHash"] = {"begin", "end", "constBegin", "constEnd", "cbegin", "cend", "find", "constFind", "insert", "insertMulti" };
m_methodsByType["QLinkedList"] = {"begin", "end", "constBegin", "constEnd", "cbegin", "cend"};
m_methodsByType["QSet"] = {"begin", "end", "constBegin", "constEnd", "find", "constFind", "cbegin", "cend"};
m_methodsByType["QStack"] = m_methodsByType["QVector"];
m_methodsByType["QQueue"] = m_methodsByType["QList"];
m_methodsByType["QMultiMap"] = m_methodsByType["QMap"];
m_methodsByType["QMultiHash"] = m_methodsByType["QHash"];
}
static bool isBlacklistedFunction(const string &name)
{
// These are fine
static const vector<string> list = {"QVariant::toList", "QHash::operator[]", "QMap::operator[]", "QSet::operator[]"};
return clazy_std::contains(list, name);
}
void TemporaryIterator::VisitStmt(clang::Stmt *stm)
{
CXXMemberCallExpr *memberExpr = dyn_cast<CXXMemberCallExpr>(stm);
if (!memberExpr)
return;
CXXRecordDecl *classDecl = memberExpr->getRecordDecl();
CXXMethodDecl *methodDecl = memberExpr->getMethodDecl();
if (!classDecl || !methodDecl)
return;
// Check if it's a container
const std::string className = classDecl->getNameAsString();
auto it = m_methodsByType.find(className);
if (it == m_methodsByType.end())
return;
// Check if it's a method returning an iterator
const std::string functionName = methodDecl->getNameAsString();
const auto &allowedFunctions = it->second;
if (!clazy_std::contains(allowedFunctions, functionName))
return;
// Catch getList().cbegin().value(), which is ok
if (HierarchyUtils::getFirstParentOfType<CXXMemberCallExpr>(m_parentMap, m_parentMap->getParent(memberExpr)))
return;
// Catch variant.toList().cbegin(), which is ok
CXXMemberCallExpr *chainedMemberCall = HierarchyUtils::getFirstChildOfType<CXXMemberCallExpr>(memberExpr);
if (chainedMemberCall) {
if (isBlacklistedFunction(StringUtils::qualifiedMethodName(chainedMemberCall->getMethodDecl())))
return;
}
// catch map[foo].cbegin()
CXXOperatorCallExpr *chainedOperatorCall = HierarchyUtils::getFirstChildOfType<CXXOperatorCallExpr>(memberExpr);
if (chainedOperatorCall) {
FunctionDecl *func = chainedOperatorCall->getDirectCallee();
if (func) {
CXXMethodDecl *method = dyn_cast<CXXMethodDecl>(func);
if (method) {
if (isBlacklistedFunction(StringUtils::qualifiedMethodName(method)))
return;
}
}
}
// If we deref it within the expression, then we'll copy the value before the iterator becomes invalid, so it's safe
if (Utils::isInDerefExpression(memberExpr, m_parentMap))
return;
Expr *expr = memberExpr->getImplicitObjectArgument();
if (!expr || expr->isLValue()) // This check is about detaching temporaries, so check for r value
return;
const Type *containerType = expr->getType().getTypePtrOrNull();
if (!containerType || containerType->isPointerType())
return;
{
// *really* check for rvalue
ImplicitCastExpr *impl = dyn_cast<ImplicitCastExpr>(expr);
if (impl) {
if (impl->getCastKind() == CK_LValueToRValue)
return;
Stmt *firstChild = HierarchyUtils::getFirstChild(impl);
if (firstChild && isa<ImplicitCastExpr>(firstChild) && dyn_cast<ImplicitCastExpr>(firstChild)->getCastKind() == CK_LValueToRValue)
return;
}
}
CXXConstructExpr *possibleCtorCall = dyn_cast_or_null<CXXConstructExpr>(HierarchyUtils::getFirstChildAtDepth(expr, 2));
if (possibleCtorCall)
return;
CXXThisExpr *possibleThisCall = dyn_cast_or_null<CXXThisExpr>(HierarchyUtils::getFirstChildAtDepth(expr, 1));
if (possibleThisCall)
return;
// llvm::errs() << "Expression: " << expr->getStmtClassName() << "\n";
std::string error = std::string("Don't call ") + StringUtils::qualifiedMethodName(methodDecl) + std::string("() on temporary");
emitWarning(stm->getLocStart(), error.c_str());
}
REGISTER_CHECK_WITH_FLAGS("temporary-iterator", TemporaryIterator, CheckLevel0)
|
