compilerplugins/clang/datamembershadow.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 <string>
  11 #include <iostream>
  12 #include <map>
  13 #include <set>
  14
  15 #include "plugin.hxx"
  16 #include "clang/AST/CXXInheritance.h"
  17
  18 /**
  19  * Check for data member being shadowed.
  20  *
  21  * @TODO check for any members in superclass hierarchy with duplicate names,
  22  *       more specific names will make the code easier to read
  23  */
  24 namespace
  25 {
  26
  27 class DataMemberShadow:
  28     public RecursiveASTVisitor<DataMemberShadow>, public loplugin::Plugin
  29 {
  30 public:
  31     explicit DataMemberShadow(InstantiationData const & data): Plugin(data) {}
  32
  33     virtual void run() override {
  34         TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
  35     }
  36
  37     bool VisitFieldDecl(FieldDecl const *);
  38 };
  39
  40 bool DataMemberShadow::VisitFieldDecl(FieldDecl const * fieldDecl)
  41 {
  42     if (ignoreLocation(fieldDecl)) {
  43         return true;
  44     }
  45     StringRef aFileName = compiler.getSourceManager().getFilename(
  46             compiler.getSourceManager().getSpellingLoc(fieldDecl->getLocStart()));
  47
  48     // FIXME complex stuff to fix later
  49
  50     if (aFileName == SRCDIR "/connectivity/source/inc/calc/CTable.hxx")
  51         return true;
  52     if (aFileName.startswith(SRCDIR "/chart2/source/"))
  53         return true;
  54     if (aFileName == SRCDIR "/cppcanvas/source/mtfrenderer/emfplus.cxx")
  55         return true;
  56     if (aFileName == SRCDIR "/cui/source/customize/eventdlg.hxx")
  57         return true;
  58     if (aFileName == SRCDIR "/include/sfx2/recentdocsview.hxx")
  59         return true;
  60     if (aFileName == SRCDIR "/include/sfx2/templatelocalview.hxx")
  61         return true;
  62     if (aFileName == SRCDIR "/filter/source/graphicfilter/idxf/dxfentrd.hxx")
  63         return true;
  64     if (aFileName == SRCDIR "/framework/source/uielement/popuptoolbarcontroller.cxx")
  65         return true;
  66     if (aFileName == SRCDIR "/lotuswordpro/source/filter/xfilter/xfcellstyle.hxx")
  67         return true;
  68     if (aFileName == SRCDIR "/lotuswordpro/source/filter/xfilter/xfdrawobj.hxx")
  69         return true;
  70     if (aFileName == SRCDIR "/sc/source/ui/vba/vbastyles.hxx")
  71         return true;
  72     if (aFileName == SRCDIR "/sd/inc/Outliner.hxx")
  73         return true;
  74     if (aFileName == SRCDIR "/sd/source/ui/annotations/annotationtag.cxx")
  75         return true;
  76     if (aFileName == SRCDIR "/sd/source/ui/inc/FrameView.hxx"
  77         || aFileName == SRCDIR "/sd/source/filter/ppt/../../ui/inc/FrameView.hxx")
  78         return true;
  79     if (aFileName == SRCDIR "/sd/source/ui/inc/unopage.hxx")
  80         return true;
  81     if (aFileName == SRCDIR "/sd/source/ui/view/viewoverlaymanager.cxx")
  82         return true;
  83     if (aFileName == SRCDIR "/sdext/source/presenter/PresenterSpritePane.hxx")
  84         return true;
  85     if (aFileName == SRCDIR "/store/source/stortree.hxx"
  86         || aFileName == SRCDIR "/store/source/stordata.hxx")
  87         return true;
  88     if (aFileName == SRCDIR "/svx/source/table/cell.hxx"
  89         || aFileName == SRCDIR "/svx/source/unodraw/../table/cell.hxx"
  90         || aFileName == SRCDIR "/svx/source/accessibility/../table/cell.hxx")
  91         return true;
  92     if (aFileName == SRCDIR "/sw/source/uibase/inc/dbtree.hxx")
  93         return true;
  94     if (aFileName == SRCDIR "/vcl/unx/generic/print/genpspgraphics.cxx")
  95         return true;
  96     if (aFileName == SRCDIR "/xmloff/source/draw/ximplink.hxx")
  97         return true;
  98
  99     const CXXRecordDecl* parentCXXRecordDecl = dyn_cast<CXXRecordDecl>(fieldDecl->getDeclContext());
 100     if (!parentCXXRecordDecl) {
 101         return true;
 102     }
 103
 104     fieldDecl = fieldDecl->getCanonicalDecl();
 105
 106 #if CLANG_VERSION >= 30800
 107
 108     auto BaseMatchesCallback = [&](const CXXBaseSpecifier *cxxBaseSpecifier, CXXBasePath& Paths)
 109     {
 110         if (!cxxBaseSpecifier->getType().getTypePtr())
 111             return false;
 112         const CXXRecordDecl* baseCXXRecordDecl = cxxBaseSpecifier->getType()->getAsCXXRecordDecl();
 113         if (!baseCXXRecordDecl)
 114             return false;
 115         if (baseCXXRecordDecl->isInvalidDecl())
 116             return false;
 117         for (const FieldDecl* baseFieldDecl : baseCXXRecordDecl->fields())
 118         {
 119             if (baseFieldDecl->getAccess() == AS_private
 120                 || !baseFieldDecl->getDeclName().isIdentifier()
 121                 || fieldDecl->getName() != baseFieldDecl->getName()) {
 122                 continue;
 123             }
 124             std::string sPath;
 125             for (CXXBasePathElement const & pathElement : Paths) {
 126                 if (!sPath.empty()) {
 127                     sPath += "->";
 128                 }
 129                 sPath += pathElement.Class->getNameAsString();
 130             }
 131             sPath += "->";
 132             sPath += baseCXXRecordDecl->getNameAsString();
 133             report(DiagnosticsEngine::Warning,
 134                     "data member %0 is shadowing member in superclass, through inheritance path %1",
 135                     fieldDecl->getLocStart())
 136                 << fieldDecl->getName()
 137                 << sPath
 138                 << fieldDecl->getSourceRange();
 139             report(DiagnosticsEngine::Note,
 140                     "superclass member here",
 141                     baseFieldDecl->getLocStart())
 142                 << baseFieldDecl->getSourceRange();
 143         }
 144         return false;
 145     };
 146
 147     CXXBasePaths aPaths;
 148     parentCXXRecordDecl->lookupInBases(BaseMatchesCallback, aPaths);
 149 #endif
 150     return true;
 151 }
 152
 153 loplugin::Plugin::Registration< DataMemberShadow > X("datamembershadow", true);
 154
 155 }
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */