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
|
/* -*- 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 "plugin.hxx"
#include "compat.hxx"
#include "clang/AST/CXXInheritance.h"
// Final goal: Checker for VCL widget references. Makes sure that VCL Window subclasses are properly referenced counted and dispose()'ed.
//
// But at the moment it just finds subclasses of Window which are not heap-allocated
//
// TODO do I need to check for local and static variables, too ?
// TODO when we have a dispose() method, verify that the dispose() methods releases all of the Window references
// TODO when we have a dispose() method, verify that it calls the super-class dispose() method at some point.
namespace {
class VCLWidgets:
public RecursiveASTVisitor<VCLWidgets>, public loplugin::Plugin
{
public:
explicit VCLWidgets(InstantiationData const & data): Plugin(data) {}
virtual void run() override { TraverseDecl(compiler.getASTContext().getTranslationUnitDecl()); }
bool VisitCXXRecordDecl(const CXXRecordDecl * decl);
bool VisitFieldDecl(const FieldDecl * decl);
bool VisitParmVarDecl(ParmVarDecl const * decl);
bool VisitVarDecl( const VarDecl* var );
bool VisitFunctionDecl( const FunctionDecl* var );
};
bool BaseCheckNotWindowSubclass(const CXXRecordDecl *BaseDefinition, void *) {
if (BaseDefinition->getQualifiedNameAsString().compare("vcl::Window") == 0) {
return false;
}
return true;
}
bool isDerivedFromWindow(const CXXRecordDecl *decl) {
if (!decl->hasDefinition())
return false;
if (decl->getQualifiedNameAsString().compare("vcl::Window") == 0)
return true;
if (// not sure what hasAnyDependentBases() does,
// but it avoids classes we don't want, e.g. WeakAggComponentImplHelper1
!decl->hasAnyDependentBases() &&
!decl->forallBases(BaseCheckNotWindowSubclass, nullptr, true)) {
return true;
}
return false;
}
bool isPointerToWindowSubclass(const QualType& pType) {
if (!pType->isPointerType())
return false;
QualType pointeeType = pType->getPointeeType();
const RecordType *recordType = pointeeType->getAs<RecordType>();
if (recordType == nullptr) {
return false;
}
const CXXRecordDecl *recordDecl = dyn_cast<CXXRecordDecl>(recordType->getDecl());
if (recordDecl == nullptr) {
return false;
}
return isDerivedFromWindow(recordDecl);
}
bool VCLWidgets::VisitCXXRecordDecl(const CXXRecordDecl * recordDecl) {
if (ignoreLocation(recordDecl)) {
return true;
}
if (!recordDecl->isCompleteDefinition())
return true;
// check if this field is derived from Window
if (!isDerivedFromWindow(recordDecl)) {
return true;
}
bool foundVclPtr = false;
for(auto fieldDecl : recordDecl->fields()) {
if (fieldDecl->getType().getAsString().find("VclPtr")==0) {
foundVclPtr = true;
break;
}
}
if (!foundVclPtr) {
return true;
}
bool foundDispose = false;
for(auto methodDecl : recordDecl->methods()) {
if (methodDecl->isInstance() && methodDecl->param_size()==0 && methodDecl->getNameAsString() == "dispose") {
foundDispose = true;
break;
}
}
if (!foundDispose) {
report(
DiagnosticsEngine::Warning,
"vcl::Window subclass with VclPtr members should declare a dispose() method.",
recordDecl->getLocation())
<< recordDecl->getSourceRange();
}
return true;
}
bool VCLWidgets::VisitFieldDecl(const FieldDecl * fieldDecl) {
if (ignoreLocation(fieldDecl)) {
return true;
}
if (fieldDecl->isBitField()) {
return true;
}
if (isPointerToWindowSubclass(fieldDecl->getType())) {
report(
DiagnosticsEngine::Remark,
"vcl::Window subclass declared as a pointer field, should be wrapped in VclPtr.",
fieldDecl->getLocation())
<< fieldDecl->getSourceRange();
return true;
}
const RecordType *recordType = fieldDecl->getType()->getAs<RecordType>();
if (recordType == nullptr) {
return true;
}
const CXXRecordDecl *recordDecl = dyn_cast<CXXRecordDecl>(recordType->getDecl());
if (recordDecl == nullptr) {
return true;
}
// check if this field is derived from Window
if (!isDerivedFromWindow(recordDecl)) {
return true;
}
report(
DiagnosticsEngine::Warning,
"vcl::Window subclass allocated as a class member, should be allocated via VclPtr.",
fieldDecl->getLocation())
<< fieldDecl->getSourceRange();
return true;
}
bool VCLWidgets::VisitParmVarDecl(ParmVarDecl const * pvDecl) {
if (ignoreLocation(pvDecl)) {
return true;
}
// check if this parameter is derived from Window
if (isPointerToWindowSubclass(pvDecl->getType())) {
report(
DiagnosticsEngine::Remark,
"vcl::Window subclass passed as a pointer parameter, should be wrapped in VclPtr.",
pvDecl->getLocation())
<< pvDecl->getSourceRange();
}
return true;
}
bool VCLWidgets::VisitVarDecl( const VarDecl* varDecl )
{
if (ignoreLocation(varDecl)) {
return true;
}
if (!varDecl->isLocalVarDecl())
return true;
// check if this variables type is derived from Window
if (isPointerToWindowSubclass(varDecl->getType())) {
report(
DiagnosticsEngine::Remark,
"vcl::Window subclass declared as a pointer var, should be wrapped in VclPtr.",
varDecl->getLocation())
<< varDecl->getSourceRange();
}
return true;
}
bool VCLWidgets::VisitFunctionDecl( const FunctionDecl* functionDecl )
{
if (ignoreLocation(functionDecl)) {
return true;
}
QualType t1 { compat::getReturnType(*functionDecl) };
// check if this variables type is derived from Window
if (isPointerToWindowSubclass(t1)) {
report(
DiagnosticsEngine::Remark,
"vcl::Window subclass declared as a return type from a method/function, should be wrapped in VclPtr.",
functionDecl->getLocation())
<< functionDecl->getSourceRange();
}
return true;
}
loplugin::Plugin::Registration< VCLWidgets > X("vclwidgets");
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
