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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
/* -*- 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 <iostream>
#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 VisitVarDecl(const VarDecl *);
bool VisitFieldDecl(const FieldDecl *);
bool VisitParmVarDecl(const ParmVarDecl *);
bool VisitFunctionDecl(const FunctionDecl *);
bool VisitCXXDestructorDecl(const CXXDestructorDecl *);
bool VisitCXXDeleteExpr(const CXXDeleteExpr *);
private:
bool isDisposeCallingSuperclassDispose(const CXXMethodDecl* pMethodDecl);
};
static bool startsWith(const std::string& s, const char* other)
{
return s.compare(0, strlen(other), other) == 0;
}
bool BaseCheckNotWindowSubclass(const CXXRecordDecl *BaseDefinition, void *) {
if (BaseDefinition && BaseDefinition->getQualifiedNameAsString() == "OutputDevice") {
return false;
}
return true;
}
bool isDerivedFromWindow(const CXXRecordDecl *decl) {
if (!decl)
return false;
if (decl->getQualifiedNameAsString() == "OutputDevice")
return true;
if (!decl->hasDefinition()) {
return false;
}
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 containsWindowSubclass(const Type* pType0);
bool containsWindowSubclass(const QualType& qType) {
auto t = qType->getAs<RecordType>();
if (t != nullptr) {
auto d = dyn_cast<ClassTemplateSpecializationDecl>(t->getDecl());
if (d != nullptr) {
std::string name(d->getQualifiedNameAsString());
if (name == "ScopedVclPtr" || name == "ScopedVclPtrInstance"
|| name == "VclPtr" || name == "VclPtrInstance")
{
return false;
}
}
}
return containsWindowSubclass(qType.getTypePtr());
}
bool containsWindowSubclass(const Type* pType0) {
if (!pType0)
return false;
const Type* pType = pType0->getUnqualifiedDesugaredType();
if (!pType)
return false;
const CXXRecordDecl* pRecordDecl = pType->getAsCXXRecordDecl();
if (pRecordDecl) {
const ClassTemplateSpecializationDecl* pTemplate = dyn_cast<ClassTemplateSpecializationDecl>(pRecordDecl);
if (pTemplate) {
bool link = pTemplate->getQualifiedNameAsString() == "Link";
for(unsigned i=0; i<pTemplate->getTemplateArgs().size(); ++i) {
const TemplateArgument& rArg = pTemplate->getTemplateArgs()[i];
if (rArg.getKind() == TemplateArgument::ArgKind::Type &&
containsWindowSubclass(rArg.getAsType()))
{
// OK for first template argument of tools/link.hxx Link
// to be a Window-derived pointer:
if (!link || i != 0) {
return true;
}
}
}
}
}
if (pType->isPointerType()) {
QualType pointeeType = pType->getPointeeType();
return containsWindowSubclass(pointeeType);
} else if (pType->isArrayType()) {
const ArrayType* pArrayType = dyn_cast<ArrayType>(pType);
QualType elementType = pArrayType->getElementType();
return containsWindowSubclass(elementType);
} else {
return isDerivedFromWindow(pRecordDecl);
}
}
bool VCLWidgets::VisitCXXDestructorDecl(const CXXDestructorDecl* pCXXDestructorDecl)
{
if (ignoreLocation(pCXXDestructorDecl)) {
return true;
}
if (!pCXXDestructorDecl->isThisDeclarationADefinition()) {
return true;
}
const CXXRecordDecl * pRecordDecl = pCXXDestructorDecl->getParent();
// ignore OutputDevice class
if (pRecordDecl->getQualifiedNameAsString() == "OutputDevice") {
return true;
}
// check if this class is derived from Window
if (!isDerivedFromWindow(pRecordDecl)) {
return true;
}
bool foundVclPtrField = false;
for(auto fieldDecl : pRecordDecl->fields()) {
const RecordType *pFieldRecordType = fieldDecl->getType()->getAs<RecordType>();
if (pFieldRecordType) {
const CXXRecordDecl *pFieldRecordTypeDecl = dyn_cast<CXXRecordDecl>(pFieldRecordType->getDecl());
if (startsWith(pFieldRecordTypeDecl->getQualifiedNameAsString(), "VclPtr")) {
foundVclPtrField = true;
break;
}
}
}
bool foundDispose = false;
for(auto methodDecl : pRecordDecl->methods()) {
if (methodDecl->isInstance() && methodDecl->param_size()==0 && methodDecl->getNameAsString() == "dispose") {
foundDispose = true;
break;
}
}
const CompoundStmt *pCompoundStatement = dyn_cast<CompoundStmt>(pCXXDestructorDecl->getBody());
// having an empty body and no dispose() method is fine
if (!foundVclPtrField && !foundDispose && pCompoundStatement && pCompoundStatement->size() == 0) {
return true;
}
if (foundVclPtrField && pCompoundStatement && pCompoundStatement->size() == 0) {
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass with VclPtr field must call dispose() from it's destructor.",
pCXXDestructorDecl->getLocStart())
<< pCXXDestructorDecl->getSourceRange();
return true;
}
// check that the destructor for a OutputDevice subclass does nothing except call into the dispose() method
bool ok = false;
if (pCompoundStatement && pCompoundStatement->size() == 1) {
const CXXMemberCallExpr *pCallExpr = dyn_cast<CXXMemberCallExpr>(*pCompoundStatement->body_begin());
if (pCallExpr) {
if( const FunctionDecl* func = pCallExpr->getDirectCallee()) {
if( func->getNumParams() == 0 && func->getIdentifier() != NULL
&& ( func->getName() == "disposeOnce" )) {
ok = true;
}
}
}
}
if (!ok) {
SourceLocation spellingLocation = compiler.getSourceManager().getSpellingLoc(
pCXXDestructorDecl->getLocStart());
StringRef filename = compiler.getSourceManager().getFilename(spellingLocation);
if ( !(filename.startswith(SRCDIR "/vcl/source/window/window.cxx"))
&& !(filename.startswith(SRCDIR "/vcl/source/gdi/virdev.cxx")) )
{
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass should have nothing in it's destructor but a call to disposeOnce().",
pCXXDestructorDecl->getLocStart())
<< pCXXDestructorDecl->getSourceRange();
}
}
return true;
}
bool VCLWidgets::VisitVarDecl(const VarDecl * pVarDecl) {
if (ignoreLocation(pVarDecl)) {
return true;
}
const RecordType *recordType = pVarDecl->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)) {
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass allocated on stack, should be allocated via VclPtr or via *.",
pVarDecl->getLocation())
<< pVarDecl->getSourceRange();
}
if ( !startsWith(pVarDecl->getType().getAsString(), "std::vector<vcl::Window *>")
&& !startsWith(pVarDecl->getType().getAsString(), "std::map<vcl::Window *, Size>")
&& !startsWith(pVarDecl->getType().getAsString(), "std::map<vcl::Window *, class Size>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::vector<class Button *>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::vector<Button *>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::mem_fun1_t<")
&& !startsWith(pVarDecl->getType().getAsString(), "::comphelper::mem_fun1_t<")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::pair<formula::RefButton *, formula::RefEdit *>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::pair<RefButton *, RefEdit *>")
&& !startsWith(pVarDecl->getType().getAsString(), "std::list<SwSidebarWin *>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::map<OTableWindow *, sal_Int32>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::map<class OTableWindow *, sal_Int32>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::multimap<sal_Int32, OTableWindow *>")
&& !startsWith(pVarDecl->getType().getAsString(), "::std::multimap<sal_Int32, class OTableWindow *>")
&& !startsWith(pVarDecl->getType().getAsString(), "::dbp::OMultiInstanceAutoRegistration< ::dbp::OUnoAutoPilot<")
&& !startsWith(pVarDecl->getType().getAsString(), "SwSidebarWin_iterator")
&& !startsWith(pVarDecl->getType().getAsString(), "functor_vector_type")
&& !startsWith(pVarDecl->getType().getAsString(), "const functor_vector_type")
&& containsWindowSubclass(pVarDecl->getType()))
{
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass should be wrapped in VclPtr. " + pVarDecl->getType().getAsString(),
pVarDecl->getLocation())
<< pVarDecl->getSourceRange();
}
return true;
}
bool VCLWidgets::VisitFieldDecl(const FieldDecl * fieldDecl) {
if (ignoreLocation(fieldDecl)) {
return true;
}
if (fieldDecl->isBitField()) {
return true;
}
const CXXRecordDecl *pParentRecordDecl = isa<RecordDecl>(fieldDecl->getDeclContext()) ? dyn_cast<CXXRecordDecl>(fieldDecl->getParent()) : nullptr;
if (containsWindowSubclass(fieldDecl->getType())) {
// have to ignore this for now, nasty reverse dependency from tools->vcl
if (!(pParentRecordDecl != nullptr && pParentRecordDecl->getQualifiedNameAsString() == "ErrorContextImpl")) {
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass declared as a pointer field, should be wrapped in VclPtr." + fieldDecl->getType().getAsString(),
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)) {
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass allocated as a class member, should be allocated via VclPtr.",
fieldDecl->getLocation())
<< fieldDecl->getSourceRange();
}
// If this field is a VclPtr field, then the class MUST have a dispose method
if (pParentRecordDecl && isDerivedFromWindow(pParentRecordDecl)
&& startsWith(recordDecl->getQualifiedNameAsString(), "VclPtr"))
{
bool foundDispose = false;
for(auto methodDecl : pParentRecordDecl->methods()) {
if (methodDecl->isInstance() && methodDecl->param_size()==0 && methodDecl->getNameAsString() == "dispose") {
foundDispose = true;
break;
}
}
if (!foundDispose) {
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass with a VclPtr field MUST have a dispose() method.",
fieldDecl->getLocation())
<< fieldDecl->getSourceRange();
}
if (!pParentRecordDecl->hasUserDeclaredDestructor()) {
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass with a VclPtr field MUST have an explicit destructor.",
fieldDecl->getLocation())
<< fieldDecl->getSourceRange();
}
}
return true;
}
bool VCLWidgets::VisitParmVarDecl(ParmVarDecl const * pvDecl)
{
if (ignoreLocation(pvDecl)) {
return true;
}
// ignore the stuff in the VclPtr template class
const CXXMethodDecl *pMethodDecl = dyn_cast<CXXMethodDecl>(pvDecl->getDeclContext());
if (pMethodDecl
&& pMethodDecl->getParent()->getQualifiedNameAsString().find("VclPtr") != std::string::npos) {
return true;
}
// we exclude this method in VclBuilder because it's so useful to have it like this
if (pMethodDecl
&& pMethodDecl->getNameAsString() == "get"
&& (pMethodDecl->getParent()->getQualifiedNameAsString() == "VclBuilder"
|| pMethodDecl->getParent()->getQualifiedNameAsString() == "VclBuilderContainer"))
{
return true;
}
return true;
}
bool VCLWidgets::VisitFunctionDecl( const FunctionDecl* functionDecl )
{
if (ignoreLocation(functionDecl)) {
return true;
}
// ignore the stuff in the VclPtr template class
const CXXMethodDecl *pMethodDecl = dyn_cast<CXXMethodDecl>(functionDecl);
if (pMethodDecl
&& pMethodDecl->getParent()->getQualifiedNameAsString() == "VclPtr") {
return true;
}
// ignore the OutputDevice::dispose() method
if (pMethodDecl
&& pMethodDecl->getParent()->getQualifiedNameAsString() == "OutputDevice") {
return true;
}
if (functionDecl->hasBody() && pMethodDecl && isDerivedFromWindow(pMethodDecl->getParent())) {
// check the last thing that the dispose() method does, is to call into the superclass dispose method
if (pMethodDecl->getNameAsString() == "dispose") {
if (!isDisposeCallingSuperclassDispose(pMethodDecl)) {
report(
DiagnosticsEngine::Warning,
"OutputDevice subclass dispose() method MUST call it's superclass dispose() as the last thing it does",
functionDecl->getLocStart())
<< functionDecl->getSourceRange();
}
}
}
return true;
}
bool VCLWidgets::VisitCXXDeleteExpr(const CXXDeleteExpr *pCXXDeleteExpr)
{
if (ignoreLocation(pCXXDeleteExpr)) {
return true;
}
const CXXRecordDecl *pPointee = pCXXDeleteExpr->getArgument()->getType()->getPointeeCXXRecordDecl();
if (pPointee && isDerivedFromWindow(pPointee)) {
SourceLocation spellingLocation = compiler.getSourceManager().getSpellingLoc(
pCXXDeleteExpr->getLocStart());
StringRef filename = compiler.getSourceManager().getFilename(spellingLocation);
if ( !(filename.startswith(SRCDIR "/include/vcl/outdev.hxx")))
{
report(
DiagnosticsEngine::Warning,
"calling delete on instance of OutputDevice subclass, must rather call disposeAndClear()",
pCXXDeleteExpr->getLocStart())
<< pCXXDeleteExpr->getSourceRange();
}
}
const ImplicitCastExpr* pImplicitCastExpr = dyn_cast<ImplicitCastExpr>(pCXXDeleteExpr->getArgument());
if (!pImplicitCastExpr) {
return true;
}
if (pImplicitCastExpr->getCastKind() != CK_UserDefinedConversion) {
return true;
}
report(
DiagnosticsEngine::Warning,
"calling delete on instance of VclPtr, must rather call disposeAndClear()",
pCXXDeleteExpr->getLocStart())
<< pCXXDeleteExpr->getSourceRange();
return true;
}
/**
The AST looks like:
`-CXXMemberCallExpr 0xb06d8b0 'void'
`-MemberExpr 0xb06d868 '<bound member function type>' ->dispose 0x9d34880
`-ImplicitCastExpr 0xb06d8d8 'class SfxTabPage *' <UncheckedDerivedToBase (SfxTabPage)>
`-CXXThisExpr 0xb06d850 'class SfxAcceleratorConfigPage *' this
*/
bool VCLWidgets::isDisposeCallingSuperclassDispose(const CXXMethodDecl* pMethodDecl)
{
const CompoundStmt *pCompoundStatement = dyn_cast<CompoundStmt>(pMethodDecl->getBody());
if (!pCompoundStatement) return false;
if (pCompoundStatement->size() == 0) return false;
// find the last statement
const CXXMemberCallExpr *pCallExpr = dyn_cast<CXXMemberCallExpr>(*pCompoundStatement->body_rbegin());
if (!pCallExpr) return false;
const MemberExpr *pMemberExpr = dyn_cast<MemberExpr>(pCallExpr->getCallee());
if (!pMemberExpr) return false;
if (pMemberExpr->getMemberDecl()->getNameAsString() != "dispose") return false;
const CXXMethodDecl *pDirectCallee = dyn_cast<CXXMethodDecl>(pCallExpr->getDirectCallee());
if (!pDirectCallee) return false;
/* Not working yet. Partially because sometimes the superclass does not a dispose() method, so it gets passed up the chain.
Need complex checking for that case.
if (pDirectCallee->getParent()->getTypeForDecl() != (*pMethodDecl->getParent()->bases_begin()).getType().getTypePtr()) {
report(
DiagnosticsEngine::Warning,
"dispose() method calling wrong baseclass, calling " + pDirectCallee->getParent()->getQualifiedNameAsString() +
" should be calling " + (*pMethodDecl->getParent()->bases_begin()).getType().getAsString(),
pCallExpr->getLocStart())
<< pCallExpr->getSourceRange();
return false;
}*/
return true;
}
loplugin::Plugin::Registration< VCLWidgets > X("vclwidgets");
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|