compilerplugins/clang/sallogareas.cxx

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * Based on LLVM/Clang.
   5  *
   6  * This file is distributed under the University of Illinois Open Source
   7  * License. See LICENSE.TXT for details.
   8  *
   9  */
  10
  11 #include "sallogareas.hxx"
  12
  13 #include <clang/AST/ASTContext.h>
  14 #include <clang/Basic/SourceManager.h>
  15 #include <clang/Lex/Lexer.h>
  16
  17 #include <fstream>
  18
  19 namespace loplugin
  20 {
  21
  22 /*
  23 This is a compile check.
  24
  25 Check that areas used in SAL_LOG/SAL_WARN are listed in sal/inc/sal/log-areas.dox .
  26 */
  27
  28 SalLogAreas::SalLogAreas( ASTContext& context )
  29     : Plugin( context )
  30     {
  31     }
  32
  33 void SalLogAreas::run()
  34     {
  35     inFunction = NULL;
  36     lastSalDetailLogStreamMacro = SourceLocation();
  37     TraverseDecl( context.getTranslationUnitDecl());
  38     }
  39
  40 bool SalLogAreas::VisitFunctionDecl( FunctionDecl* function )
  41     {
  42     inFunction = function;
  43     return true;
  44     }
  45
  46 bool SalLogAreas::VisitCallExpr( CallExpr* call )
  47     {
  48     if( ignoreLocation( call ))
  49         return true;
  50     if( FunctionDecl* func = call->getDirectCallee())
  51         {
  52         // Optimize, getQualifiedNameAsString() is reportedly expensive.
  53         if( func->getNumParams() == 4 && func->getIdentifier() != NULL
  54             && ( func->getName() == "sal_detail_log" || func->getName() == "log" ))
  55             {
  56             string qualifiedName = func->getQualifiedNameAsString();
  57             if( qualifiedName == "sal_detail_log" || qualifiedName == "sal::detail::log" )
  58                 {
  59                 // The SAL_DETAIL_LOG_STREAM macro expands to two calls to sal::detail::log(),
  60                 // so do not warn repeatedly about the same macro (the area->getLocStart() of all the calls
  61                 // from the same macro should be the same).
  62                 SourceLocation expansionLocation = context.getSourceManager().getExpansionLoc( call->getLocStart());
  63                 if( expansionLocation == lastSalDetailLogStreamMacro )
  64                     return true;
  65                 lastSalDetailLogStreamMacro = expansionLocation;
  66                 if( const StringLiteral* area = dyn_cast< StringLiteral >( call->getArg( 1 )->IgnoreParenImpCasts()))
  67                     {
  68                     if( area->getKind() == StringLiteral::Ascii )
  69                         checkArea( area->getBytes(), area->getExprLoc());
  70                     else
  71                         report( DiagnosticsEngine::Warning, "unsupported string literal kind (plugin needs fixing?) [loplugin]",
  72                             area->getLocStart());
  73                     return true;
  74                     }
  75                 if( inFunction->getQualifiedNameAsString() == "sal::detail::log" )
  76                     return true; // This function only forwards to sal_detail_log, so ok.
  77                 if( call->getArg( 1 )->isNullPointerConstant( context, Expr::NPC_ValueDependentIsNotNull ) != Expr::NPCK_NotNull )
  78                     { // If the area argument is a null pointer, that is allowed only for SAL_DEBUG.
  79                     const SourceManager& source = context.getSourceManager();
  80                     for( SourceLocation loc = call->getLocStart();
  81                          loc.isMacroID();
  82                          loc = source.getImmediateExpansionRange( loc ).first )
  83                         {
  84                         StringRef inMacro = Lexer::getImmediateMacroName( loc, source, context.getLangOpts());
  85                         if( inMacro == "SAL_DEBUG" )
  86                             return true; // ok
  87                         }
  88                     report( DiagnosticsEngine::Warning, "missing log area [loplugin]",
  89                         call->getArg( 1 )->IgnoreParenImpCasts()->getLocStart());
  90                     return true;
  91                     }
  92                 report( DiagnosticsEngine::Warning, "cannot analyse log area argument (plugin needs fixing?) [loplugin]",
  93                     call->getLocStart());
  94                 }
  95             }
  96         }
  97     return true;
  98     }
  99
 100 void SalLogAreas::checkArea( StringRef area, SourceLocation location )
 101     {
 102     if( logAreas.empty())
 103         readLogAreas();
 104     if( !logAreas.count( area ))
 105         {
 106         report( DiagnosticsEngine::Warning, "unknown log area '%0' (check or extend sal/inc/sal/log-areas.dox) [loplugin]",
 107             location ) << area;
 108         }
 109     }
 110
 111 void SalLogAreas::readLogAreas()
 112     {
 113 #define STRINGIFY2( s ) #s
 114 #define STRINGIFY( s ) STRINGIFY2( s )
 115     ifstream is( STRINGIFY( SRCDIR ) "/sal/inc/sal/log-areas.dox" );
 116 #undef STRINGIFY
 117 #undef STRINGIFY2
 118     while( is.good())
 119         {
 120         string line;
 121         getline( is, line );
 122         size_t pos = line.find( "@li @c " );
 123         if( pos != string::npos )
 124             {
 125             pos += strlen( "@li @c " );
 126             size_t end = line.find( ' ', pos );
 127             if( end == string::npos )
 128                 logAreas.insert( line.substr( pos ));
 129             else if( pos != end )
 130                 logAreas.insert( line.substr( pos, end - pos ));
 131             }
 132         }
 133     // If you get this error message, you possibly have too old icecream (ICECC_EXTRAFILES is needed).
 134     if( logAreas.empty())
 135         report( DiagnosticsEngine::Warning, "error reading log areas [loplugin]" );
 136     }
 137
 138 } // namespace