compilerplugins/clang/automem.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <memory>
  11 #include <cassert>
  12 #include <string>
  13 #include <iostream>
  14 #include <fstream>
  15 #include <set>
  16 #include "config_clang.h"
  17 #include "plugin.hxx"
  18
  19 /**
  20   Find calls to "delete x" where x is a field on an object.
  21   Should rather be using std::unique_ptr
  22 */
  23
  24 namespace {
  25
  26 class AutoMem:
  27     public loplugin::FilteringPlugin<AutoMem>
  28 {
  29 public:
  30     explicit AutoMem(loplugin::InstantiationData const & data): FilteringPlugin(data), mbInsideDestructor(false) {}
  31
  32     virtual void run() override
  33     {
  34         TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
  35     }
  36
  37     bool TraverseCXXDestructorDecl(CXXDestructorDecl* );
  38     bool VisitCXXDeleteExpr(const CXXDeleteExpr* );
  39 private:
  40     bool mbInsideDestructor;
  41 };
  42
  43 bool AutoMem::TraverseCXXDestructorDecl(CXXDestructorDecl* expr)
  44 {
  45     mbInsideDestructor = true;
  46     bool ret = RecursiveASTVisitor::TraverseCXXDestructorDecl(expr);
  47     mbInsideDestructor = false;
  48     return ret;
  49 }
  50
  51 bool AutoMem::VisitCXXDeleteExpr(const CXXDeleteExpr* expr)
  52 {
  53     if (ignoreLocation( expr ))
  54         return true;
  55     StringRef aFileName = getFilenameOfLocation(compiler.getSourceManager().getSpellingLoc(expr->getBeginLoc()));
  56     if (loplugin::hasPathnamePrefix(aFileName, SRCDIR "/include/salhelper/")
  57         || loplugin::hasPathnamePrefix(aFileName, SRCDIR "/include/osl/")
  58         || loplugin::hasPathnamePrefix(aFileName, SRCDIR "/salhelper/")
  59         || loplugin::hasPathnamePrefix(aFileName, SRCDIR "/store/")
  60         || loplugin::hasPathnamePrefix(aFileName, SRCDIR "/sal/"))
  61         return true;
  62
  63     if (mbInsideDestructor)
  64         return true;
  65
  66     const ImplicitCastExpr* pCastExpr = dyn_cast<ImplicitCastExpr>(expr->getArgument());
  67     if (!pCastExpr)
  68         return true;
  69     const MemberExpr* pMemberExpr = dyn_cast<MemberExpr>(pCastExpr->getSubExpr());
  70     if (!pMemberExpr)
  71         return true;
  72     // ignore union games
  73     const FieldDecl* pFieldDecl = dyn_cast<FieldDecl>(pMemberExpr->getMemberDecl());
  74     if (!pFieldDecl)
  75         return true;
  76     TagDecl const * td = dyn_cast<TagDecl>(pFieldDecl->getDeclContext());
  77     if (td->isUnion())
  78         return true;
  79
  80     report(
  81         DiagnosticsEngine::Warning,
  82         "calling delete on object field, rather use std::unique_ptr or std::scoped_ptr",
  83         expr->getBeginLoc())
  84         << expr->getSourceRange();
  85     return true;
  86 }
  87
  88 loplugin::Plugin::Registration< AutoMem > X("automem", false);
  89
  90 }
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */