compilerplugins/clang/finalprotected.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 #ifndef LO_CLANG_SHARED_PLUGINS
  10
  11 #include <string>
  12 #include <iostream>
  13 #include <map>
  14 #include <set>
  15
  16 #include "plugin.hxx"
  17 #include "clang/AST/CXXInheritance.h"
  18
  19 // Check for final classes that have protected members
  20
  21 namespace
  22 {
  23
  24 class FinalProtected:
  25     public loplugin::FilteringPlugin<FinalProtected>
  26 {
  27 public:
  28     explicit FinalProtected(loplugin::InstantiationData const & data):
  29         FilteringPlugin(data) {}
  30
  31     virtual void run() override {
  32         TraverseDecl(compiler.getASTContext().getTranslationUnitDecl());
  33     }
  34
  35     bool VisitCXXMethodDecl(CXXMethodDecl const *);
  36     bool VisitFieldDecl(FieldDecl const *);
  37 };
  38
  39
  40 bool FinalProtected::VisitCXXMethodDecl(CXXMethodDecl const * cxxMethodDecl)
  41 {
  42     if (ignoreLocation(cxxMethodDecl)) {
  43         return true;
  44     }
  45     if (cxxMethodDecl->getAccess() != AS_protected) {
  46         return true;
  47     }
  48     if (!cxxMethodDecl->getParent()->hasAttr<FinalAttr>()) {
  49         return true;
  50     }
  51     cxxMethodDecl = cxxMethodDecl->getCanonicalDecl();
  52     report(DiagnosticsEngine::Warning,
  53             "final class should not have protected members - convert them to private",
  54             compat::getBeginLoc(cxxMethodDecl))
  55         << cxxMethodDecl->getSourceRange();
  56     return true;
  57 }
  58
  59 bool FinalProtected::VisitFieldDecl(FieldDecl const * fieldDecl)
  60 {
  61     if (ignoreLocation(fieldDecl)) {
  62         return true;
  63     }
  64     if (fieldDecl->getAccess() != AS_protected) {
  65         return true;
  66     }
  67     if (!fieldDecl->getParent()->hasAttr<FinalAttr>()) {
  68         return true;
  69     }
  70     fieldDecl = fieldDecl->getCanonicalDecl();
  71     report(DiagnosticsEngine::Warning,
  72             "final class should not have protected members - convert them to private",
  73             compat::getBeginLoc(fieldDecl))
  74         << fieldDecl->getSourceRange();
  75     return true;
  76 }
  77
  78 loplugin::Plugin::Registration< FinalProtected > finalprotected("finalprotected");
  79
  80 } // namespace
  81
  82 #endif // LO_CLANG_SHARED_PLUGINS
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */