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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
|
/* -*- 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 <memory>
#include <cassert>
#include <string>
#include <iostream>
#include <fstream>
#include <set>
#include "plugin.hxx"
#include "check.hxx"
/**
Find destructors that only contain a single call to delete of a field. In which
case that field should really be managed by unique_ptr.
*/
namespace {
class UseUniquePtr:
public RecursiveASTVisitor<UseUniquePtr>, public loplugin::Plugin
{
public:
explicit UseUniquePtr(loplugin::InstantiationData const & data):
Plugin(data) {}
virtual void run() override
{
std::string fn(handler.getMainFileName());
loplugin::normalizeDotDotInFilePath(fn);
// can't change these because we pass them down to the SfxItemPool stuff
if (fn == SRCDIR "/sc/source/core/data/docpool.cxx")
return;
// this just too clever for me
if (fn == SRCDIR "/sc/source/core/tool/chgtrack.cxx")
return;
// too clever
if (fn == SRCDIR "/pyuno/source/module/pyuno_runtime.cxx")
return;
// m_pExampleSet here is very badly managed. sometimes it is owning, sometimes not,
// and the logic depends on overriding methods.
if (fn == SRCDIR "/sfx2/source/dialog/tabdlg.cxx")
return;
// pLongArr is being deleted here because we temporarily overwrite a pointer to someone else's buffer, with a pointer
// to our own buffer
if (fn == SRCDIR "/editeng/source/misc/txtrange.cxx")
return;
// can't use std::set<std::unique_ptr<>> until C++14
if (fn == SRCDIR "/editeng/source/misc/svxacorr.cxx")
return;
// horrible horrible spawn of evil ownership and deletion here
if (fn == SRCDIR "/sfx2/source/view/ipclient.cxx")
return;
// sometimes it owns, sometimes it doesn't
if (fn == SRCDIR "/editeng/source/misc/svxacorr.cxx")
return;
// SwDoc::m_PageDescs has weird handling
if (fn == SRCDIR "/sw/source/core/doc/docnew.cxx")
return;
// SwRedlineData::pNext and pExtraData have complex handling
if (fn == SRCDIR "/sw/source/core/doc/docredln.cxx")
return;
// ScTempDocSource::pTempDoc
if (fn == SRCDIR "/sc/source/ui/unoobj/funcuno.cxx")
return;
// SwAttrIter::m_pFont
if (fn == SRCDIR "/sw/source/core/text/itratr.cxx"
|| fn == SRCDIR "/sw/source/core/text/redlnitr.cxx")
return;
// SwWrongList
if (fn == SRCDIR "/sw/source/core/text/wrong.cxx")
return;
// SwLineLayout::m_pNext
if (fn == SRCDIR "/sw/source/core/text/porlay.cxx")
return;
// ODatabaseExport::m_aDestColumns
if (fn == SRCDIR "/dbaccess/source/ui/misc/DExport.cxx")
return;
// ScTabView::pDrawActual and pDrawOld
if (fn == SRCDIR "/sc/source/ui/view/tabview5.cxx")
return;
// SwHTMLParser::m_pPendStack
if (fn == SRCDIR "/sw/source/filter/html/htmlcss1.cxx")
return;
// Visual Studio 2017 has trouble with these
if (fn == SRCDIR "/comphelper/source/property/MasterPropertySet.cxx"
|| fn == SRCDIR "/comphelper/source/property/MasterPropertySetInfo.cxx")
return;
// SwTableLine::m_aBoxes
if (fn == SRCDIR "/sw/source/core/table/swtable.cxx")
return;
// SwHTMLParser::m_pFormImpl
if (fn == SRCDIR "/sw/source/filter/html/htmlform.cxx")
return;
// SwHTMLParser::m_pPendStack, pNext
if (fn == SRCDIR "/sw/source/filter/html/htmltab.cxx")
return;
// SaveLine::pBox, pNext
if (fn == SRCDIR "/sw/source/core/undo/untbl.cxx")
return;
// RedlineInfo::pNextRedline
if (fn == SRCDIR "/sw/source/filter/xml/XMLRedlineImportHelper.cxx")
return;
// SfxObjectShell::pMedium
if (fn == SRCDIR "/sfx2/source/doc/objxtor.cxx")
return;
// various
if (fn == SRCDIR "/sw/source/filter/ww8/wrtww8.cxx")
return;
// WW8TabBandDesc
if (fn == SRCDIR "/sw/source/filter/ww8/ww8par2.cxx")
return;
TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
}
bool VisitCXXMethodDecl(const CXXMethodDecl* );
bool VisitCompoundStmt(const CompoundStmt* );
bool VisitCXXDeleteExpr(const CXXDeleteExpr* );
bool TraverseFunctionDecl(FunctionDecl* );
bool TraverseCXXMethodDecl(CXXMethodDecl* );
bool TraverseCXXConstructorDecl(CXXConstructorDecl* );
bool TraverseConstructorInitializer(CXXCtorInitializer*);
private:
void CheckCompoundStmt(const CXXMethodDecl*, const CompoundStmt* );
void CheckIfStmt(const CXXMethodDecl* methodDecl, const IfStmt* );
void CheckCXXForRangeStmt(const CXXMethodDecl*, const CXXForRangeStmt* );
void CheckLoopDelete(const CXXMethodDecl*, const Stmt* );
void CheckLoopDelete(const CXXMethodDecl*, const CXXDeleteExpr* );
void CheckDeleteExpr(const CXXMethodDecl*, const CXXDeleteExpr*);
void CheckParenExpr(const CXXMethodDecl*, const ParenExpr*);
void CheckDeleteExpr(const CXXMethodDecl*, const CXXDeleteExpr*,
const MemberExpr*, StringRef message);
FunctionDecl const * mpCurrentFunctionDecl = nullptr;
};
bool UseUniquePtr::VisitCXXMethodDecl(const CXXMethodDecl* methodDecl)
{
if (ignoreLocation(methodDecl))
return true;
if (isInUnoIncludeFile(methodDecl))
return true;
const CompoundStmt* compoundStmt = dyn_cast_or_null< CompoundStmt >( methodDecl->getBody() );
if (!compoundStmt || compoundStmt->size() == 0)
return true;
CheckCompoundStmt(methodDecl, compoundStmt);
return true;
}
/**
* check for simple call to delete i.e. direct unconditional call, or if-guarded call
*/
void UseUniquePtr::CheckCompoundStmt(const CXXMethodDecl* methodDecl, const CompoundStmt* compoundStmt)
{
for (auto i = compoundStmt->body_begin(); i != compoundStmt->body_end(); ++i)
{
if (auto cxxForRangeStmt = dyn_cast<CXXForRangeStmt>(*i))
CheckCXXForRangeStmt(methodDecl, cxxForRangeStmt);
else if (auto forStmt = dyn_cast<ForStmt>(*i))
CheckLoopDelete(methodDecl, forStmt->getBody());
else if (auto whileStmt = dyn_cast<WhileStmt>(*i))
CheckLoopDelete(methodDecl, whileStmt->getBody());
// check for unconditional inner compound statements
else if (auto innerCompoundStmt = dyn_cast<CompoundStmt>(*i))
CheckCompoundStmt(methodDecl, innerCompoundStmt);
else if (auto deleteExpr = dyn_cast<CXXDeleteExpr>(*i))
CheckDeleteExpr(methodDecl, deleteExpr);
else if (auto parenExpr = dyn_cast<ParenExpr>(*i))
CheckParenExpr(methodDecl, parenExpr);
else if (auto ifStmt = dyn_cast<IfStmt>(*i))
CheckIfStmt(methodDecl, ifStmt);
}
}
// Check for conditional deletes like:
// if (m_pField != nullptr) delete m_pField;
void UseUniquePtr::CheckIfStmt(const CXXMethodDecl* methodDecl, const IfStmt* ifStmt)
{
auto cond = ifStmt->getCond()->IgnoreImpCasts();
if (auto ifCondMemberExpr = dyn_cast<MemberExpr>(cond))
{
// ignore "if (bMine)"
if (!loplugin::TypeCheck(ifCondMemberExpr->getType()).Pointer())
return;
// good
}
else if (auto binaryOp = dyn_cast<BinaryOperator>(cond))
{
if (!isa<MemberExpr>(binaryOp->getLHS()->IgnoreImpCasts()))
return;
if (!isa<CXXNullPtrLiteralExpr>(binaryOp->getRHS()->IgnoreImpCasts()))
return;
// good
}
else // ignore anything more complicated
return;
auto deleteExpr = dyn_cast<CXXDeleteExpr>(ifStmt->getThen());
if (deleteExpr)
{
CheckDeleteExpr(methodDecl, deleteExpr);
return;
}
auto parenExpr = dyn_cast<ParenExpr>(ifStmt->getThen());
if (parenExpr)
{
CheckParenExpr(methodDecl, parenExpr);
return;
}
auto ifThenCompoundStmt = dyn_cast<CompoundStmt>(ifStmt->getThen());
if (!ifThenCompoundStmt)
return;
for (auto j = ifThenCompoundStmt->body_begin(); j != ifThenCompoundStmt->body_end(); ++j)
{
auto ifDeleteExpr = dyn_cast<CXXDeleteExpr>(*j);
if (ifDeleteExpr)
CheckDeleteExpr(methodDecl, ifDeleteExpr);
ParenExpr const * parenExpr = dyn_cast<ParenExpr>(*j);
if (parenExpr)
CheckParenExpr(methodDecl, parenExpr);
}
}
void UseUniquePtr::CheckDeleteExpr(const CXXMethodDecl* methodDecl, const CXXDeleteExpr* deleteExpr)
{
auto deleteExprArg = deleteExpr->getArgument()->IgnoreParenImpCasts();
const MemberExpr* memberExpr = dyn_cast<MemberExpr>(deleteExprArg);
if (memberExpr)
{
CheckDeleteExpr(methodDecl, deleteExpr, memberExpr,
"unconditional call to delete on a member, should be using std::unique_ptr");
return;
}
const ArraySubscriptExpr* arrayExpr = dyn_cast<ArraySubscriptExpr>(deleteExprArg);
if (arrayExpr)
{
auto baseMemberExpr = dyn_cast<MemberExpr>(arrayExpr->getBase()->IgnoreParenImpCasts());
if (baseMemberExpr)
CheckDeleteExpr(methodDecl, deleteExpr, baseMemberExpr,
"unconditional call to delete on a member, should be using std::unique_ptr");
}
}
/**
* Look for DELETEZ expressions.
*/
void UseUniquePtr::CheckParenExpr(const CXXMethodDecl* methodDecl, const ParenExpr* parenExpr)
{
auto binaryOp = dyn_cast<BinaryOperator>(parenExpr->getSubExpr());
if (!binaryOp || binaryOp->getOpcode() != BO_Comma)
return;
auto deleteExpr = dyn_cast<CXXDeleteExpr>(binaryOp->getLHS());
if (!deleteExpr)
return;
CheckDeleteExpr(methodDecl, deleteExpr);
}
void UseUniquePtr::CheckDeleteExpr(const CXXMethodDecl* methodDecl, const CXXDeleteExpr* deleteExpr,
const MemberExpr* memberExpr, StringRef message)
{
// ignore union games
const FieldDecl* fieldDecl = dyn_cast<FieldDecl>(memberExpr->getMemberDecl());
if (!fieldDecl)
return;
TagDecl const * td = dyn_cast<TagDecl>(fieldDecl->getDeclContext());
if (td->isUnion())
return;
// ignore calling delete on someone else's field
if (fieldDecl->getParent() != methodDecl->getParent() )
return;
if (ignoreLocation(fieldDecl))
return;
// to ignore things like the CPPUNIT macros
StringRef aFileName = getFileNameOfSpellingLoc(
compiler.getSourceManager().getSpellingLoc(compat::getBeginLoc(fieldDecl)));
if (loplugin::hasPathnamePrefix(aFileName, WORKDIR "/"))
return;
// passes and stores pointers to member fields
if (loplugin::isSamePathname(aFileName, SRCDIR "/sot/source/sdstor/stgdir.hxx"))
return;
// something platform-specific
if (loplugin::isSamePathname(aFileName, SRCDIR "/hwpfilter/source/htags.h"))
return;
// passes pointers to member fields
if (loplugin::isSamePathname(aFileName, SRCDIR "/sd/inc/sdpptwrp.hxx"))
return;
// @TODO intrusive linked-lists here, with some trickiness
if (loplugin::isSamePathname(aFileName, SRCDIR "/sw/source/filter/html/parcss1.hxx"))
return;
// @TODO SwDoc has some weird ref-counting going on
if (loplugin::isSamePathname(aFileName, SRCDIR "/sw/inc/shellio.hxx"))
return;
// @TODO it's sharing pointers with another class
if (loplugin::isSamePathname(aFileName, SRCDIR "/sc/inc/formulacell.hxx"))
return;
// some weird stuff going on here around struct Entity
if (loplugin::hasPathnamePrefix(aFileName, SRCDIR "/sax/"))
return;
if (loplugin::hasPathnamePrefix(aFileName, SRCDIR "/include/sax/"))
return;
// manipulation of tree structures ie. StgAvlNode, don't lend themselves to std::unique_ptr
if (loplugin::hasPathnamePrefix(aFileName, SRCDIR "/sot/"))
return;
if (loplugin::hasPathnamePrefix(aFileName, SRCDIR "/include/sot/"))
return;
// the std::vector is being passed to another class
if (loplugin::isSamePathname(aFileName, SRCDIR "/sfx2/source/explorer/nochaos.cxx"))
return;
auto tc = loplugin::TypeCheck(fieldDecl->getType());
// these sw::Ring based classes do not lend themselves to std::unique_ptr management
if (tc.Pointer().Class("SwNodeIndex").GlobalNamespace() || tc.Pointer().Class("SwShellTableCursor").GlobalNamespace()
|| tc.Pointer().Class("SwBlockCursor").GlobalNamespace() || tc.Pointer().Class("SwVisibleCursor").GlobalNamespace()
|| tc.Pointer().Class("SwShellCursor").GlobalNamespace())
return;
// there is a loop in ~ImplPrnQueueList deleting stuff on a global data structure
if (loplugin::isSamePathname(aFileName, SRCDIR "/vcl/inc/print.h"))
return;
// painful linked list
if (loplugin::isSamePathname(aFileName, SRCDIR "/basic/source/inc/runtime.hxx"))
return;
// not sure how the node management is working here
if (loplugin::isSamePathname(aFileName, SRCDIR "/i18npool/source/localedata/saxparser.cxx"))
return;
// has a pointer that it only sometimes owns
if (loplugin::isSamePathname(aFileName, SRCDIR "/editeng/source/editeng/impedit.hxx"))
return;
report(
DiagnosticsEngine::Warning,
message,
compat::getBeginLoc(deleteExpr))
<< deleteExpr->getSourceRange();
report(
DiagnosticsEngine::Note,
"member is here",
compat::getBeginLoc(fieldDecl))
<< fieldDecl->getSourceRange();
}
void UseUniquePtr::CheckLoopDelete(const CXXMethodDecl* methodDecl, const Stmt* bodyStmt)
{
if (auto deleteExpr = dyn_cast<CXXDeleteExpr>(bodyStmt))
CheckLoopDelete(methodDecl, deleteExpr);
else if (auto compoundStmt = dyn_cast<CompoundStmt>(bodyStmt))
{
for (auto i = compoundStmt->body_begin(); i != compoundStmt->body_end(); ++i)
{
if (auto deleteExpr = dyn_cast<CXXDeleteExpr>(*i))
CheckLoopDelete(methodDecl, deleteExpr);
}
}
}
void UseUniquePtr::CheckLoopDelete(const CXXMethodDecl* methodDecl, const CXXDeleteExpr* deleteExpr)
{
const MemberExpr* memberExpr = nullptr;
const Expr* subExpr = deleteExpr->getArgument();
// drill down looking for a MemberExpr
for (;;)
{
subExpr = subExpr->IgnoreImpCasts();
if ((memberExpr = dyn_cast<MemberExpr>(subExpr)))
break;
else if (auto arraySubscriptExpr = dyn_cast<ArraySubscriptExpr>(subExpr))
subExpr = arraySubscriptExpr->getBase();
else if (auto cxxOperatorCallExpr = dyn_cast<CXXOperatorCallExpr>(subExpr))
{
// look for deletes of an iterator object where the iterator is over a member field
if (auto declRefExpr = dyn_cast<DeclRefExpr>(cxxOperatorCallExpr->getArg(0)->IgnoreImpCasts()))
{
if (auto varDecl = dyn_cast<VarDecl>(declRefExpr->getDecl()))
{
auto init = varDecl->getInit();
if (auto x = dyn_cast<ExprWithCleanups>(init))
init = x->getSubExpr();
if (auto x = dyn_cast<CXXBindTemporaryExpr>(init))
init = x->getSubExpr();
if (auto x = dyn_cast<CXXMemberCallExpr>(init))
init = x->getImplicitObjectArgument();
memberExpr = dyn_cast<MemberExpr>(init);
break;
}
}
// look for deletes like "delete m_pField[0]"
if (cxxOperatorCallExpr->getOperator() == OO_Subscript)
{
memberExpr = dyn_cast<MemberExpr>(cxxOperatorCallExpr->getArg(0));
}
break;
}
else
break;
}
if (!memberExpr)
return;
CheckDeleteExpr(methodDecl, deleteExpr, memberExpr, "rather manage with std::some_container<std::unique_ptr<T>>");
}
void UseUniquePtr::CheckCXXForRangeStmt(const CXXMethodDecl* methodDecl, const CXXForRangeStmt* cxxForRangeStmt)
{
CXXDeleteExpr const * deleteExpr = nullptr;
if (auto compoundStmt = dyn_cast<CompoundStmt>(cxxForRangeStmt->getBody()))
{
for (auto i = compoundStmt->body_begin(); i != compoundStmt->body_end(); ++i)
if ((deleteExpr = dyn_cast<CXXDeleteExpr>(*i)))
break;
}
else
deleteExpr = dyn_cast<CXXDeleteExpr>(cxxForRangeStmt->getBody());
if (!deleteExpr)
return;
auto memberExpr = dyn_cast<MemberExpr>(cxxForRangeStmt->getRangeInit());
if (!memberExpr)
return;
auto fieldDecl = dyn_cast<FieldDecl>(memberExpr->getMemberDecl());
if (!fieldDecl)
return;
CheckDeleteExpr(methodDecl, deleteExpr, memberExpr, "rather manage with std::some_container<std::unique_ptr<T>>");
}
bool UseUniquePtr::VisitCompoundStmt(const CompoundStmt* compoundStmt)
{
if (ignoreLocation(compoundStmt))
return true;
if (isInUnoIncludeFile(compat::getBeginLoc(compoundStmt)))
return true;
if (compoundStmt->size() == 0) {
return true;
}
auto lastStmt = compoundStmt->body_back();
if (compoundStmt->size() > 1) {
if (isa<ReturnStmt>(lastStmt))
lastStmt = *(++compoundStmt->body_rbegin());
}
auto deleteExpr = dyn_cast<CXXDeleteExpr>(lastStmt);
if (deleteExpr == nullptr) {
return true;
}
auto declRefExpr = dyn_cast<DeclRefExpr>(deleteExpr->getArgument()->IgnoreParenImpCasts());
if (!declRefExpr)
return true;
auto varDecl = dyn_cast<VarDecl>(declRefExpr->getDecl());
if (!varDecl)
return true;
if (!varDecl->hasInit()
|| !isa<CXXNewExpr>(
varDecl->getInit()->IgnoreImplicit()->IgnoreParenImpCasts()))
return true;
// determine if the var is declared inside the same block as the delete.
// @TODO there should surely be a better way to do this
if (compat::getBeginLoc(varDecl) < compat::getBeginLoc(compoundStmt))
return true;
report(
DiagnosticsEngine::Warning,
"deleting a local variable at the end of a block, is a sure sign it should be using std::unique_ptr for that var",
compat::getBeginLoc(deleteExpr))
<< deleteExpr->getSourceRange();
report(
DiagnosticsEngine::Note,
"var is here",
compat::getBeginLoc(varDecl))
<< varDecl->getSourceRange();
return true;
}
bool UseUniquePtr::TraverseFunctionDecl(FunctionDecl* functionDecl)
{
if (ignoreLocation(functionDecl))
return true;
auto oldCurrent = mpCurrentFunctionDecl;
mpCurrentFunctionDecl = functionDecl;
bool ret = RecursiveASTVisitor::TraverseFunctionDecl(functionDecl);
mpCurrentFunctionDecl = oldCurrent;
return ret;
}
bool UseUniquePtr::TraverseCXXMethodDecl(CXXMethodDecl* methodDecl)
{
if (ignoreLocation(methodDecl))
return true;
auto oldCurrent = mpCurrentFunctionDecl;
mpCurrentFunctionDecl = methodDecl;
bool ret = RecursiveASTVisitor::TraverseCXXMethodDecl(methodDecl);
mpCurrentFunctionDecl = oldCurrent;
return ret;
}
bool UseUniquePtr::TraverseCXXConstructorDecl(CXXConstructorDecl* methodDecl)
{
if (ignoreLocation(methodDecl))
return true;
auto oldCurrent = mpCurrentFunctionDecl;
mpCurrentFunctionDecl = methodDecl;
bool ret = RecursiveASTVisitor::TraverseCXXConstructorDecl(methodDecl);
mpCurrentFunctionDecl = oldCurrent;
return ret;
}
bool UseUniquePtr::VisitCXXDeleteExpr(const CXXDeleteExpr* deleteExpr)
{
if (!mpCurrentFunctionDecl)
return true;
if (ignoreLocation(mpCurrentFunctionDecl))
return true;
if (isInUnoIncludeFile(compat::getBeginLoc(mpCurrentFunctionDecl->getCanonicalDecl())))
return true;
if (mpCurrentFunctionDecl->getIdentifier())
{
auto name = mpCurrentFunctionDecl->getName();
if (name == "delete_IncludesCollection" || name == "convertName"
|| name == "createNamedType"
|| name == "typelib_typedescriptionreference_release" || name == "deleteExceptions"
|| name == "uno_threadpool_destroy"
|| name == "AddRanges_Impl"
|| name == "DestroySalInstance"
|| name == "ImplHandleUserEvent"
|| name == "releaseDecimalPtr" // TODO, basic
|| name == "replaceAndReset" // TODO, connectivity
|| name == "intrusive_ptr_release"
|| name == "FreeParaList"
|| name == "DeleteSdrUndoAction" // TODO, sc
|| name == "lcl_MergeGCBox" || name == "lcl_MergeGCLine" || name == "lcl_DelHFFormat")
return true;
}
if (auto cxxMethodDecl = dyn_cast<CXXMethodDecl>(mpCurrentFunctionDecl))
{
// include/o3tl/deleter.hxx
if (cxxMethodDecl->getParent()->getName() == "default_delete")
return true;
// TODO Bitmap::ReleaseAccess
// Tricky because it reverberates through other code and requires that BitmapWriteAccess move into /include again
if (cxxMethodDecl->getParent()->getName() == "Bitmap")
return true;
// TODO virtual ones are much trickier, leave for later
if (cxxMethodDecl->isVirtual())
return true;
// sw/inc/unobaseclass.hxx holds SolarMutex while deleting
if (cxxMethodDecl->getParent()->getName() == "UnoImplPtrDeleter")
return true;
}
auto declRefExpr = dyn_cast<DeclRefExpr>(deleteExpr->getArgument()->IgnoreParenImpCasts());
if (!declRefExpr)
return true;
auto varDecl = dyn_cast<ParmVarDecl>(declRefExpr->getDecl());
if (!varDecl)
return true;
std::string fn(handler.getMainFileName());
loplugin::normalizeDotDotInFilePath(fn);
// StgAvlNode::Remove
if (fn == SRCDIR "/sot/source/sdstor/stgavl.cxx")
return true;
// SfxItemPool::ReleaseDefaults and SfxItemPool::Free
if (fn == SRCDIR "/svl/source/items/itempool.cxx")
return true;
// SwContourCache
if (fn == SRCDIR "/sw/source/core/text/txtfly.cxx")
return true;
// too messy to cope with the SQL parser
if (fn == SRCDIR "/connectivity/source/parse/sqlnode.cxx")
return true;
// I can't figure out the ownership of the SfxMedium in the call site(s)
if (fn == SRCDIR "/sfx2/source/doc/sfxbasemodel.cxx")
return true;
// pointer passed via IMPL_LINK
if (fn == SRCDIR "/sfx2/source/control/dispatch.cxx")
return true;
// NavigatorTreeModel::Remove
if (fn == SRCDIR "/svx/source/form/navigatortreemodel.cxx")
return true;
// SdrModel::AddUndo
if (fn == SRCDIR "/svx/source/svdraw/svdmodel.cxx")
return true;
// undo callback
if (fn == SRCDIR "/basctl/source/basicide/baside3.cxx")
return true;
// ActualizeProgress::TimeoutHdl
if (fn == SRCDIR "/cui/source/dialogs/cuigaldlg.cxx")
return true;
// ToolbarSaveInData::RemoveToolbar
if (fn == SRCDIR "/cui/source/customize/cfg.cxx")
return true;
// OStorage_Impl::RemoveElement very complicated ownership passing going on
if (fn == SRCDIR "/package/source/xstor/xstorage.cxx")
return true;
// actually held via shared_ptr, uses protected deleter object
if (fn == SRCDIR "/sd/source/ui/framework/tools/FrameworkHelper.cxx")
return true;
// actually held via shared_ptr, uses protected deleter object
if (fn == SRCDIR "/sd/source/ui/presenter/CanvasUpdateRequester.cxx")
return true;
// actually held via shared_ptr, uses protected deleter object
if (fn == SRCDIR "/sd/source/ui/slidesorter/cache/SlsPageCacheManager.cxx")
return true;
// actually held via shared_ptr, uses protected deleter object
if (fn == SRCDIR "/sd/source/ui/sidebar/MasterPageContainer.cxx")
return true;
// actually held via shared_ptr, uses protected deleter object
if (fn == SRCDIR "/sd/source/ui/tools/TimerBasedTaskExecution.cxx")
return true;
// actually held via shared_ptr, uses protected deleter object
if (fn == SRCDIR "/sd/source/ui/view/ViewShellImplementation.cxx")
return true;
// ScBroadcastAreaSlot::StartListeningArea manual ref-counting of ScBroadcastArea
if (fn == SRCDIR "/sc/source/core/data/bcaslot.cxx")
return true;
// ScDrawLayer::AddCalcUndo undo stuff
if (fn == SRCDIR "/sc/source/core/data/drwlayer.cxx")
return true;
// ScTable::SetFormulaCell
if (fn == SRCDIR "/sc/source/core/data/table2.cxx")
return true;
// ScDocument::SetFormulaCell
if (fn == SRCDIR "/sc/source/core/data/documen2.cxx")
return true;
// RemoveEditAttribsHandler, stored in mdds block
if (fn == SRCDIR "/sc/source/core/data/column2.cxx")
return true;
// just turns into a mess
if (fn == SRCDIR "/sc/source/ui/Accessibility/AccessibleDocument.cxx")
return true;
// SwCache::DeleteObj, linked list
if (fn == SRCDIR "/sw/source/core/bastyp/swcache.cxx")
return true;
// SAXEventKeeperImpl::smashBufferNode
if (fn == SRCDIR "/xmlsecurity/source/framework/saxeventkeeperimpl.cxx")
return true;
// ZipOutputStream, ownership of ZipEntry is horribly complicated here
if (fn == SRCDIR "/package/source/zipapi/ZipOutputStream.cxx")
return true;
// SwDoc::DeleteExtTextInput
if (fn == SRCDIR "/sw/source/core/doc/extinput.cxx")
return true;
// SwDoc::DelSectionFormat
if (fn == SRCDIR "/sw/source/core/docnode/ndsect.cxx")
return true;
// SwFrame::DestroyFrame
if (fn == SRCDIR "/sw/source/core/layout/ssfrm.cxx")
return true;
// SwGluePortion::Join
if (fn == SRCDIR "/sw/source/core/text/porglue.cxx")
return true;
// SwDoc::DelFrameFormat
if (fn == SRCDIR "/sw/source/core/doc/docfmt.cxx")
return true;
// SwTextAttr::Destroy
if (fn == SRCDIR "/sw/source/core/txtnode/txatbase.cxx")
return true;
// IMPL_LINK( SwDoc, AddDrawUndo, SdrUndoAction *, pUndo, void )
if (fn == SRCDIR "/sw/source/core/undo/undraw.cxx")
return true;
// SwHTMLParser::EndAttr
if (fn == SRCDIR "/sw/source/filter/html/swhtml.cxx")
return true;
// SwGlossaryHdl::Expand sometimes the pointer is owned, sometimes it is not
if (fn == SRCDIR "/sw/source/uibase/dochdl/gloshdl.cxx")
return true;
// SwWrtShell::Insert only owned sometimes
if (fn == SRCDIR "/sw/source/uibase/wrtsh/wrtsh1.cxx")
return true;
// NodeArrayDeleter
if (fn == SRCDIR "/unoxml/source/rdf/librdf_repository.cxx")
return true;
// SmCursor::LineToList ran out of enthusiam to rework the node handling
if (fn == SRCDIR "/starmath/source/cursor.cxx")
return true;
// XMLEventOASISTransformerContext::FlushEventMap
if (fn == SRCDIR "/xmloff/source/transform/EventOASISTContext.cxx")
return true;
// XMLEventOOoTransformerContext::FlushEventMap
if (fn == SRCDIR "/xmloff/source/transform/EventOOoTContext.cxx")
return true;
/*
Sometimes we can pass the param as std::unique_ptr<T>& or std::unique_ptr, sometimes the method
just needs to be inlined, which normally exposes more simplification.
*/
report(
DiagnosticsEngine::Warning,
"calling delete on a pointer param, should be either whitelisted or simplified",
compat::getBeginLoc(deleteExpr))
<< deleteExpr->getSourceRange();
return true;
}
bool UseUniquePtr::TraverseConstructorInitializer(CXXCtorInitializer * ctorInit)
{
if (!ctorInit->getSourceLocation().isValid() || ignoreLocation(ctorInit->getSourceLocation()))
return true;
if (!ctorInit->getMember())
return true;
if (!loplugin::TypeCheck(ctorInit->getMember()->getType()).Class("unique_ptr").StdNamespace())
return true;
auto constructExpr = dyn_cast<CXXConstructExpr>(ctorInit->getInit());
if (!constructExpr)
return true;
auto init = constructExpr->getArg(0)->IgnoreImpCasts();
if (!isa<DeclRefExpr>(init))
return true;
report(
DiagnosticsEngine::Warning,
"should be passing via std::unique_ptr param",
ctorInit->getSourceLocation())
<< ctorInit->getSourceRange();
return RecursiveASTVisitor<UseUniquePtr>::TraverseConstructorInitializer(ctorInit);
}
loplugin::Plugin::Registration< UseUniquePtr > X("useuniqueptr", false);
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|