compilerplugins/clang/redundantstatic.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  * Based on LLVM/Clang.
   6  *
   7  */
   8 #ifndef LO_CLANG_SHARED_PLUGINS
   9
  10 #include "check.hxx"
  11 #include "compat.hxx"
  12 #include "plugin.hxx"
  13
  14 /*
  15 This is a compile check.
  16
  17 Warns about functions with static keyword in an unnamed namespace.
  18 */
  19
  20 namespace loplugin
  21 {
  22
  23 class RedundantStatic
  24     : public loplugin::FilteringPlugin<RedundantStatic>
  25     {
  26     public:
  27         explicit RedundantStatic( const InstantiationData& data );
  28
  29         bool preRun() override { return compiler.getLangOpts().CPlusPlus; }
  30
  31         virtual void run() override;
  32         bool VisitFunctionDecl( const FunctionDecl* func );
  33
  34         bool VisitVarDecl(VarDecl const * decl) {
  35             if (ignoreLocation(decl)) {
  36                 return true;
  37             }
  38             if (!decl->isFileVarDecl() || decl->isStaticDataMember()) {
  39                 return true;
  40             }
  41             if (decl->getStorageClass() != SC_Static) {
  42                 return true;
  43             }
  44             if (decl->isInAnonymousNamespace()) {
  45                 auto loc = compat::getBeginLoc(decl);
  46                 while (compiler.getSourceManager().isMacroArgExpansion(loc)) {
  47                     loc = compiler.getSourceManager().getImmediateMacroCallerLoc(loc);
  48                 }
  49                 if (compiler.getSourceManager().isMacroBodyExpansion(loc)) {
  50                     auto const name = Lexer::getImmediateMacroName(
  51                         loc, compiler.getSourceManager(), compiler.getLangOpts());
  52                     if (name == "CPPUNIT_TEST_SUITE_REGISTRATION"
  53                         || name == "CPPUNIT_TEST_SUITE_NAMED_REGISTRATION")
  54                     {
  55                         // Those macros contain a `static`, but are often used in an unnamed
  56                         // namespace, so filter them out:
  57                         return true;
  58                     }
  59                 }
  60                 report(
  61                     DiagnosticsEngine::Warning, "redundant 'static' keyword in unnamed namespace",
  62                     decl->getLocation())
  63                     << decl->getSourceRange();
  64                 return true;
  65             }
  66             if (decl->isInline()) {
  67                 return true;
  68             }
  69             if (!loplugin::TypeCheck(decl->getType()).ConstNonVolatile()) {
  70                 return true;
  71             }
  72             report(
  73                 DiagnosticsEngine::Warning,
  74                 "non-inline variable of non-volatile const-qualified type is redundantly marked as"
  75                     " 'static'",
  76                 decl->getLocation())
  77                 << decl->getSourceRange();
  78             return true;
  79         }
  80     };
  81
  82 RedundantStatic::RedundantStatic( const InstantiationData& data )
  83     : FilteringPlugin( data )
  84     {
  85     }
  86
  87 void RedundantStatic::run()
  88     {
  89     if (preRun()) {
  90         TraverseDecl( compiler.getASTContext().getTranslationUnitDecl());
  91     }
  92     }
  93
  94
  95 bool RedundantStatic::VisitFunctionDecl( const FunctionDecl* func )
  96
  97     {
  98     if( ignoreLocation( func ) )
  99         return true;
 100     if( func -> isInAnonymousNamespace () )
 101     {
 102       if ( !isa<CXXMethodDecl>(func) && !func->isInExternCContext() )
 103          {
 104             if(func-> getStorageClass() == SC_Static)
 105                {
 106                     report( DiagnosticsEngine::Warning,
 107                         "redundant 'static' keyword in unnamed namespace",
 108                         compat::getBeginLoc(func));
 109                }
 110          }
 111     }
 112
 113     return true;
 114     }
 115
 116 // Register the plugin action with the LO plugin handling.
 117 static Plugin::Registration< RedundantStatic > redundantstatic("redundantstatic");
 118
 119 } // namespace
 120
 121 #endif // LO_CLANG_SHARED_PLUGINS
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */