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
|
/* -*- 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 <string>
#include <set>
#include "plugin.hxx"
// Find places where we are returning a pointer to something, where we can be returning a reference.
// e.g.
// class A {
// struct X x;
// public:
// X* getX() { return &x; }
// }
// which can be:
// X& getX() { return x; }
namespace {
class ReturnByRef:
public loplugin::FilteringPlugin<ReturnByRef>
{
public:
explicit ReturnByRef(InstantiationData const & data): FilteringPlugin(data) {}
virtual void run() override { TraverseDecl(compiler.getASTContext().getTranslationUnitDecl()); }
bool VisitCXXMethodDecl(const CXXMethodDecl * decl);
private:
std::string getFilename(SourceLocation loc);
};
bool ReturnByRef::VisitCXXMethodDecl(const CXXMethodDecl * functionDecl) {
if (ignoreLocation(functionDecl)) {
return true;
}
if (functionDecl->isVirtual()) {
return true;
}
if (!functionDecl->isInstance()) {
return true;
}
if (!functionDecl->hasBody()) {
return true;
}
// ignore stuff that forms part of the stable URE interface
if (isInUnoIncludeFile(functionDecl)) {
return true;
}
QualType t1 { functionDecl->getReturnType() };
if (!t1->isPointerType()) {
return true;
}
// Ignore stuff like:
// operator vcl::Window *(){ return &m_rWindow; }
if (dyn_cast< CXXConversionDecl >( functionDecl ) != nullptr) {
return true;
}
std::string aFilename = getFilename(functionDecl->getCanonicalDecl()->getLocStart());
if (aFilename == SRCDIR "/include/o3tl/cow_wrapper.hxx")
{
return true;
}
if ( functionDecl->getNameAsString() == "operator->") {
return true;
}
std::string aFunctionName = functionDecl->getQualifiedNameAsString();
if (aFunctionName == "SbxValue::data") {
return true;
}
/*
std::string aParentName = functionDecl->getParent()->getQualifiedNameAsString();
std::string fqn = aParentName + "::" + functionDecl->getNameAsString();
if (aFilename == "TextCharAttribList::GetAttrib") {
return true;
}*/
/*
The AST here looks like:
-CompoundStmt
`-ReturnStmt
`-UnaryOperator
*/
const CompoundStmt* compoundStmt = dyn_cast< CompoundStmt >( functionDecl->getBody() );
if (compoundStmt == nullptr || compoundStmt->body_begin() == compoundStmt->body_end()) {
return true;
}
const ReturnStmt* returnStmt = dyn_cast<ReturnStmt>(*compoundStmt->child_begin());
if (returnStmt == nullptr) {
return true;
}
const Stmt* nextStmt = dyn_cast<Expr>(*returnStmt->child_begin())->IgnoreParens();
const UnaryOperator* unaryOperator = dyn_cast<UnaryOperator>(nextStmt);
if (unaryOperator == nullptr || unaryOperator->getOpcode() != UO_AddrOf) {
return true;
}
nextStmt->dump();
report(
DiagnosticsEngine::Warning,
"rather return by reference ",
functionDecl->getSourceRange().getBegin())
<< functionDecl->getSourceRange();
// display the location of the class member declaration so I don't have to search for it by hand
auto otherLoc = functionDecl->getCanonicalDecl()->getSourceRange().getBegin();
if (otherLoc != functionDecl->getSourceRange().getBegin())
{
report(
DiagnosticsEngine::Note,
"rather return by reference",
functionDecl->getCanonicalDecl()->getSourceRange().getBegin())
<< functionDecl->getCanonicalDecl()->getSourceRange();
}
return true;
}
std::string ReturnByRef::getFilename(SourceLocation loc)
{
SourceLocation spellingLocation = compiler.getSourceManager().getSpellingLoc(loc);
return getFilenameOfLocation(spellingLocation);
}
loplugin::Plugin::Registration< ReturnByRef > X("returnbyref");
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
