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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#include <cassert>
#include <set>
#include "compat.hxx"
#include "plugin.hxx"
namespace {
char const * kindName(Expr::NullPointerConstantKind kind) {
switch (kind) {
case Expr::NPCK_NotNull:
assert(false); // cannot happen
// fall through
case Expr::NPCK_ZeroExpression:
return "ZeroExpression";
case Expr::NPCK_ZeroLiteral:
return "ZeroLiteral";
case Expr::NPCK_CXX11_nullptr:
return "CXX11_nullptr";
case Expr::NPCK_GNUNull:
return "GNUNull";
}
}
class Nullptr:
public RecursiveASTVisitor<Nullptr>, public loplugin::RewritePlugin
{
public:
explicit Nullptr(InstantiationData const & data): RewritePlugin(data) {}
void run() override
{ TraverseDecl(compiler.getASTContext().getTranslationUnitDecl()); }
bool VisitImplicitCastExpr(CastExpr const * expr);
bool VisitGNUNullExpr(GNUNullExpr const * expr);
private:
bool isInLokIncludeFile(SourceLocation spellingLocation) const;
bool isFromCIncludeFile(SourceLocation spellingLocation) const;
bool isMacroBodyExpansion(SourceLocation location) const;
void handleNull(
Expr const * expr, char const * castKind,
Expr::NullPointerConstantKind nullPointerKind);
void rewriteOrWarn(
Expr const * expr, char const * castKind,
Expr::NullPointerConstantKind nullPointerKind,
char const * replacement);
std::set<Expr const *> gnuNulls_;
};
bool Nullptr::VisitImplicitCastExpr(CastExpr const * expr) {
if (ignoreLocation(expr)) {
return true;
}
switch (expr->getCastKind()) {
case CK_NullToPointer:
case CK_NullToMemberPointer:
break;
default:
return true;
}
Expr::NullPointerConstantKind k = expr->isNullPointerConstant(
compiler.getASTContext(), Expr::NPC_ValueDependentIsNotNull);
switch (k) {
case Expr::NPCK_NotNull:
k = expr->isNullPointerConstant(
compiler.getASTContext(), Expr::NPC_ValueDependentIsNull);
switch (k) {
case Expr::NPCK_NotNull:
break;
case Expr::NPCK_ZeroExpression:
case Expr::NPCK_ZeroLiteral:
report(
DiagnosticsEngine::Warning,
"suspicious ValueDependentIsNull %0", expr->getLocStart())
<< kindName(k) << expr->getSourceRange();
break;
default:
assert(false); // cannot happen
}
break;
case Expr::NPCK_CXX11_nullptr:
break;
default:
handleNull(expr->getSubExpr(), expr->getCastKindName(), k);
break;
}
return true;
}
bool Nullptr::VisitGNUNullExpr(GNUNullExpr const * expr) {
if (ignoreLocation(expr)) {
return true;
}
handleNull(expr, nullptr, Expr::NPCK_GNUNull);
return true;
}
bool Nullptr::isInLokIncludeFile(SourceLocation spellingLocation) const {
return compiler.getSourceManager().getFilename(spellingLocation)
.startswith(SRCDIR "/include/LibreOfficeKit/");
}
bool Nullptr::isFromCIncludeFile(SourceLocation spellingLocation) const {
return !compat::isInMainFile(compiler.getSourceManager(), spellingLocation)
&& (StringRef(
compiler.getSourceManager().getPresumedLoc(spellingLocation)
.getFilename())
.endswith(".h"));
}
bool Nullptr::isMacroBodyExpansion(SourceLocation location) const {
#if (__clang_major__ == 3 && __clang_minor__ >= 3) || __clang_major__ > 3
return compiler.getSourceManager().isMacroBodyExpansion(location);
#else
return location.isMacroID()
&& !compiler.getSourceManager().isMacroArgExpansion(location);
#endif
}
void Nullptr::handleNull(
Expr const * expr, char const * castKind,
Expr::NullPointerConstantKind nullPointerKind)
{
auto e = expr;
SourceLocation loc;
for (;;) {
e = e->IgnoreImpCasts();
loc = e->getLocStart();
while (compiler.getSourceManager().isMacroArgExpansion(loc)) {
loc = compiler.getSourceManager().getImmediateMacroCallerLoc(loc);
}
if (isMacroBodyExpansion(loc)) {
if (Lexer::getImmediateMacroName(
loc, compiler.getSourceManager(), compiler.getLangOpts())
== "NULL")
{
if (!compiler.getLangOpts().CPlusPlus) {
//TODO: if !castKind, warn if NULL is passed into fn call
// ellipsis, cast to void*
return;
}
loc = compiler.getSourceManager()
.getImmediateExpansionRange(loc).first;
if (isInUnoIncludeFile(
compiler.getSourceManager().getSpellingLoc(loc))
|| isInLokIncludeFile(
compiler.getSourceManager().getSpellingLoc(loc))
|| isFromCIncludeFile(
compiler.getSourceManager().getSpellingLoc(loc)))
{
//TODO: if !castKind, warn if NULL is passed into fn call
// ellipsis, cast to void*
return;
}
} else if (ignoreLocation(
compiler.getSourceManager().getSpellingLoc(loc)))
{
return;
}
}
ParenExpr const * pe = dyn_cast<ParenExpr>(e);
if (pe == nullptr) {
break;
}
e = pe->getSubExpr();
}
if (nullPointerKind == Expr::NPCK_GNUNull) {
if (castKind == nullptr) {
if (gnuNulls_.erase(expr) == 1) {
return;
}
} else {
auto const ok = gnuNulls_.insert(expr).second;
assert(ok); (void) ok;
}
}
auto const asMacro = !compiler.getLangOpts().CPlusPlus
|| isInUnoIncludeFile(compiler.getSourceManager().getSpellingLoc(loc))
|| isInLokIncludeFile(compiler.getSourceManager().getSpellingLoc(loc))
|| isFromCIncludeFile(compiler.getSourceManager().getSpellingLoc(loc));
assert(!asMacro || nullPointerKind != Expr::NPCK_GNUNull);
rewriteOrWarn(e, castKind, nullPointerKind, asMacro ? "NULL" : "nullptr");
}
void Nullptr::rewriteOrWarn(
Expr const * expr, char const * castKind,
Expr::NullPointerConstantKind nullPointerKind, char const * replacement)
{
if (rewriter != nullptr) {
SourceLocation locStart(expr->getLocStart());
while (compiler.getSourceManager().isMacroArgExpansion(locStart)) {
locStart = compiler.getSourceManager()
.getImmediateMacroCallerLoc(locStart);
}
if (compiler.getLangOpts().CPlusPlus && isMacroBodyExpansion(locStart)
&& (Lexer::getImmediateMacroName(
locStart, compiler.getSourceManager(),
compiler.getLangOpts())
== "NULL"))
{
locStart = compiler.getSourceManager().getImmediateExpansionRange(
locStart).first;
}
SourceLocation locEnd(expr->getLocEnd());
while (compiler.getSourceManager().isMacroArgExpansion(locEnd)) {
locEnd = compiler.getSourceManager()
.getImmediateMacroCallerLoc(locEnd);
}
if (compiler.getLangOpts().CPlusPlus && isMacroBodyExpansion(locEnd)
&& (Lexer::getImmediateMacroName(
locEnd, compiler.getSourceManager(),
compiler.getLangOpts())
== "NULL"))
{
locEnd = compiler.getSourceManager().getImmediateExpansionRange(
locEnd).first;
}
if (replaceText(SourceRange(compiler.getSourceManager().getSpellingLoc(locStart), compiler.getSourceManager().getSpellingLoc(locEnd)), replacement)) {
return;
}
}
if (castKind == nullptr) {
report(DiagnosticsEngine::Warning, "%0 -> %1", expr->getLocStart())
<< kindName(nullPointerKind) << replacement
<< expr->getSourceRange();
} else {
report(
DiagnosticsEngine::Warning, "%0 ValueDependentIsNotNull %1 -> %2",
expr->getLocStart())
<< castKind << kindName(nullPointerKind) << replacement
<< expr->getSourceRange();
}
}
loplugin::Plugin::Registration<Nullptr> X("nullptr", true);
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
