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