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 #ifndef LO_CLANG_SHARED_PLUGINS
  11
  12 #include <string>
  13 #include <iostream>
  14 #include <map>
  15 #include <set>
  16
  17 #include "plugin.hxx"
  18 #include "clang/AST/CXXInheritance.h"
  19
  20 /**
  21  * Check for data member being shadowed.
  22  *
  23  * @TODO check for any members in superclass hierarchy with duplicate names,
  24  *       regardless of their visibility,
  25  *       more specific names will make the code easier to read
  26  */
  27 namespace
  28 {
  29
  30 class DataMemberShadow:
  31     public loplugin::FilteringPlugin<DataMemberShadow>
  32 {
  33 public:
  34     explicit DataMemberShadow(loplugin::InstantiationData const & data):
  35         FilteringPlugin(data) {}
  36
  37     virtual void run() override {
  38         TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
  39     }
  40
  41     bool VisitFieldDecl(FieldDecl const *);
  42 };
  43
  44 bool DataMemberShadow::VisitFieldDecl(FieldDecl const * fieldDecl)
  45 {
  46     if (ignoreLocation(fieldDecl)) {
  47         return true;
  48     }
  49     StringRef aFileName = getFilenameOfLocation(
  50         compiler.getSourceManager().getSpellingLoc(compat::getBeginLoc(fieldDecl)));
  51
  52     // FIXME complex stuff to fix later
  53
  54     if (loplugin::hasPathnamePrefix(aFileName, SRCDIR "/chart2/source/"))
  55         return true;
  56     if (loplugin::isSamePathname(aFileName, SRCDIR "/include/sfx2/recentdocsview.hxx"))
  57         return true;
  58     if (loplugin::isSamePathname(aFileName, SRCDIR "/include/sfx2/templatelocalview.hxx"))
  59         return true;
  60     if (loplugin::isSamePathname(aFileName, SRCDIR "/store/source/stortree.hxx")
  61         || loplugin::isSamePathname(aFileName, SRCDIR "/store/source/stordata.hxx"))
  62         return true;
  63     if (loplugin::isSamePathname(aFileName, SRCDIR "/sw/source/uibase/inc/dbtree.hxx"))
  64         return true;
  65
  66     const CXXRecordDecl* parentCXXRecordDecl = dyn_cast<CXXRecordDecl>(fieldDecl->getDeclContext());
  67     if (!parentCXXRecordDecl) {
  68         return true;
  69     }
  70
  71     fieldDecl = fieldDecl->getCanonicalDecl();
  72
  73     auto BaseMatchesCallback = [&](const CXXBaseSpecifier *cxxBaseSpecifier, CXXBasePath& Paths)
  74     {
  75         if (!cxxBaseSpecifier->getType().getTypePtr())
  76             return false;
  77         const CXXRecordDecl* baseCXXRecordDecl = cxxBaseSpecifier->getType()->getAsCXXRecordDecl();
  78         if (!baseCXXRecordDecl)
  79             return false;
  80         if (baseCXXRecordDecl->isInvalidDecl())
  81             return false;
  82         for (const FieldDecl* baseFieldDecl : baseCXXRecordDecl->fields())
  83         {
  84             // TODO look for overlaps even with private fields
  85
  86             if (baseFieldDecl->getAccess() == AS_private
  87                 || !baseFieldDecl->getDeclName().isIdentifier()
  88                 || fieldDecl->getName() != baseFieldDecl->getName()) {
  89                 continue;
  90             }
  91             std::string sPath;
  92             for (CXXBasePathElement const & pathElement : Paths) {
  93                 if (!sPath.empty()) {
  94                     sPath += "->";
  95                 }
  96                 sPath += pathElement.Class->getNameAsString();
  97             }
  98             sPath += "->";
  99             sPath += baseCXXRecordDecl->getNameAsString();
 100             report(DiagnosticsEngine::Warning,
 101                     "data member %0 is shadowing member in superclass, through inheritance path %1",
 102                     compat::getBeginLoc(fieldDecl))
 103                 << fieldDecl->getName()
 104                 << sPath
 105                 << fieldDecl->getSourceRange();
 106             report(DiagnosticsEngine::Note,
 107                     "superclass member here",
 108                     compat::getBeginLoc(baseFieldDecl))
 109                 << baseFieldDecl->getSourceRange();
 110         }
 111         return false;
 112     };
 113
 114     CXXBasePaths aPaths;
 115     parentCXXRecordDecl->lookupInBases(BaseMatchesCallback, aPaths);
 116     return true;
 117 }
 118
 119 loplugin::Plugin::Registration< DataMemberShadow > datamembershadow("datamembershadow", true);
 120
 121 }
 122
 123 #endif // LO_CLANG_SHARED_PLUGINS
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */