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
|
/* -*- 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/.
*/
#ifndef LO_CLANG_SHARED_PLUGINS
#include "check.hxx"
#include "compat.hxx"
#include "plugin.hxx"
#include <unordered_set>
/** Look for static O*String and O*String[], they can be more efficiently declared as:
static constexpr OUStringLiteral our_aLBEntryMap[] = {u" ", u", "};
static constexpr OUStringLiteral sName(u"name");
which is more efficient at startup time.
*/
namespace {
class StringStatic
: public loplugin::FilteringPlugin<StringStatic>
{
public:
explicit StringStatic(loplugin::InstantiationData const& rData):
FilteringPlugin(rData) {}
void run() override;
bool preRun() override;
void postRun() override;
bool VisitVarDecl(VarDecl const*);
bool VisitReturnStmt(ReturnStmt const*);
bool VisitDeclRefExpr(DeclRefExpr const*);
bool VisitMemberExpr(MemberExpr const*);
private:
std::unordered_set<VarDecl const *> potentialVars;
std::unordered_set<VarDecl const *> excludeVars;
};
void StringStatic::run()
{
if( preRun())
if( TraverseDecl(compiler.getASTContext().getTranslationUnitDecl()))
postRun();
}
bool StringStatic::preRun()
{
StringRef fn(handler.getMainFileName());
// passing around pointers to global OUString
if (loplugin::hasPathnamePrefix(fn, SRCDIR "/filter/source/svg/"))
return false;
// has a mix of literals and refs to external OUStrings
if (loplugin::isSamePathname(fn, SRCDIR "/ucb/source/ucp/webdav-neon/ContentProperties.cxx"))
return false;
return true;
}
void StringStatic::postRun()
{
for (auto const & pVarDecl : excludeVars) {
potentialVars.erase(pVarDecl);
}
for (auto const & varDecl : potentialVars) {
report(DiagnosticsEngine::Warning,
"rather declare this using OUStringLiteral/OStringLiteral/char[]",
varDecl->getLocation())
<< varDecl->getSourceRange();
}
}
bool StringStatic::VisitVarDecl(VarDecl const* varDecl)
{
if (ignoreLocation(varDecl))
return true;
QualType qt = varDecl->getType();
if (!varDecl->hasGlobalStorage())
return true;
if (varDecl->hasGlobalStorage() && !varDecl->isStaticLocal()) {
//TODO: For a non-public static member variable from an included file, we could still
// examine it further if all its uses must be seen in that included file:
if (!compiler.getSourceManager().isInMainFile(varDecl->getLocation())) {
return true;
}
}
if (!varDecl->isThisDeclarationADefinition()
|| !qt.isConstQualified())
return true;
if (qt->isArrayType())
qt = qt->getAsArrayTypeUnsafe()->getElementType();
auto tc = loplugin::TypeCheck(qt);
if (!tc.Class("OUString").Namespace("rtl").GlobalNamespace()
&& !tc.Class("OString").Namespace("rtl").GlobalNamespace())
return true;
if (varDecl->hasInit())
{
Expr const * expr = varDecl->getInit();
while (true) {
if (ExprWithCleanups const * exprWithCleanups = dyn_cast<ExprWithCleanups>(expr)) {
expr = exprWithCleanups->getSubExpr();
}
else if (CastExpr const * castExpr = dyn_cast<CastExpr>(expr)) {
expr = castExpr->getSubExpr();
}
else if (MaterializeTemporaryExpr const * materializeExpr = dyn_cast<MaterializeTemporaryExpr>(expr)) {
expr = compat::getSubExpr(materializeExpr);
}
else if (CXXBindTemporaryExpr const * bindExpr = dyn_cast<CXXBindTemporaryExpr>(expr)) {
expr = bindExpr->getSubExpr();
}
else if (CXXConstructExpr const * constructExpr = dyn_cast<CXXConstructExpr>(expr)) {
if (constructExpr->getNumArgs() == 0) {
return true;
}
expr = constructExpr->getArg(0);
} else if (isa<CallExpr>(expr)) {
return true;
} else {
break;
}
}
}
potentialVars.insert(varDecl);
return true;
}
bool StringStatic::VisitReturnStmt(ReturnStmt const * returnStmt)
{
if (ignoreLocation(returnStmt)) {
return true;
}
if (!returnStmt->getRetValue()) {
return true;
}
DeclRefExpr const * declRef = dyn_cast<DeclRefExpr>(returnStmt->getRetValue());
if (!declRef) {
return true;
}
VarDecl const * varDecl = dyn_cast<VarDecl>(declRef->getDecl());
if (varDecl) {
excludeVars.insert(varDecl);
}
return true;
}
bool StringStatic::VisitDeclRefExpr(DeclRefExpr const * declRef)
{
if (ignoreLocation(declRef))
return true;
VarDecl const * varDecl = dyn_cast<VarDecl>(declRef->getDecl());
if (!varDecl)
return true;
if (potentialVars.count(varDecl) == 0)
return true;
// ignore globals that are used in CPPUNIT_ASSERT expressions, otherwise we can end up
// trying to compare an OUStringLiteral and an OUString, and CPPUNIT can't handle that
auto loc = compat::getBeginLoc(declRef);
if (compiler.getSourceManager().isMacroArgExpansion(loc))
{
StringRef name { Lexer::getImmediateMacroName(loc, compiler.getSourceManager(), compiler.getLangOpts()) };
if (name.startswith("CPPUNIT_ASSERT"))
excludeVars.insert(varDecl);
}
return true;
}
bool StringStatic::VisitMemberExpr(MemberExpr const * expr)
{
if (ignoreLocation(expr))
return true;
auto const declRef = dyn_cast<DeclRefExpr>(expr->getBase());
if (declRef == nullptr) {
return true;
}
VarDecl const * varDecl = dyn_cast<VarDecl>(declRef->getDecl());
if (!varDecl)
return true;
if (potentialVars.count(varDecl) == 0)
return true;
auto const id = expr->getMemberDecl()->getIdentifier();
if (id == nullptr || id->getName() != "pData") {
return true;
}
excludeVars.insert(varDecl);
return true;
}
loplugin::Plugin::Registration<StringStatic> stringstatic("stringstatic");
} // namespace
#endif // LO_CLANG_SHARED_PLUGINS
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
