compilerplugins/clang/checkconfigmacros.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  * This file is distributed under the University of Illinois Open Source
   8  * License. See LICENSE.TXT for details.
   9  *
  10  */
  11
  12 #include <memory>
  13 #include <set>
  14
  15 #include "compat.hxx"
  16 #include "plugin.hxx"
  17
  18 #include "config_clang.h"
  19
  20 #include <clang/Lex/Preprocessor.h>
  21
  22 namespace loplugin
  23 {
  24
  25 /*
  26 This is a compile check.
  27
  28 Feature macros from config_XXX.h headers are always #defined (to 1 or 0 in case of yes/no
  29 settings). It is a mistake to use #ifdef/#ifndef/defined to check them.
  30
  31 Using 1/0 instead of defined/undefined avoids undetected problems when e.g. the necessary
  32 #include of the config_XXX.h file is missing.
  33 */
  34
  35 class CheckConfigMacros
  36     : public PPCallbacks
  37     , public Plugin
  38     {
  39     public:
  40         explicit CheckConfigMacros( const InstantiationData& data );
  41         virtual void run() override;
  42         virtual void MacroDefined( const Token& macroToken, const MacroDirective* info ) override;
  43         virtual void MacroUndefined( const Token& macroToken, MacroDefinition const &, MacroDirective const * ) override;
  44         virtual void Ifdef( SourceLocation location, const Token& macroToken, MacroDefinition const & ) override;
  45         virtual void Ifndef( SourceLocation location, const Token& macroToken, MacroDefinition const & ) override;
  46         virtual void Defined( const Token& macroToken, MacroDefinition const &, SourceRange Range ) override;
  47         enum { isPPCallback = true };
  48     private:
  49         void checkMacro( const Token& macroToken, SourceLocation location );
  50         std::set< std::string > configMacros;
  51     };
  52
  53 CheckConfigMacros::CheckConfigMacros( const InstantiationData& data )
  54     : Plugin( data )
  55     {
  56     compiler.getPreprocessor().addPPCallbacks(std::unique_ptr<PPCallbacks>(this));
  57     }
  58
  59 void CheckConfigMacros::run()
  60     {
  61     // nothing, only check preprocessor usage
  62     }
  63
  64 void CheckConfigMacros::MacroDefined( const Token& macroToken, const MacroDirective* info )
  65     {
  66     SourceLocation location = info->getLocation();
  67     const char* filename = compiler.getSourceManager().getPresumedLoc( location ).getFilename();
  68     if( filename != NULL
  69         && ( hasPathnamePrefix(filename, BUILDDIR "/config_host/")
  70             || hasPathnamePrefix(filename, BUILDDIR "/config_build/") ))
  71         {
  72 //        fprintf(stderr,"DEF: %s %s\n", macroToken.getIdentifierInfo()->getName().data(), filename );
  73         StringRef macro = macroToken.getIdentifierInfo()->getName();
  74         // Skia #defines do not have values, but we set them in config_skia.h .
  75         if( compat::starts_with(macro, "SK_" ) && loplugin::isSamePathname(filename, BUILDDIR "/config_host/config_skia.h"))
  76             return;
  77         configMacros.insert( macro.str());
  78         }
  79     }
  80
  81 void CheckConfigMacros::MacroUndefined( const Token& macroToken, MacroDefinition const &, MacroDirective const * )
  82     {
  83     configMacros.erase( macroToken.getIdentifierInfo()->getName().str());
  84     }
  85
  86 void CheckConfigMacros::Ifdef( SourceLocation location, const Token& macroToken, MacroDefinition const & )
  87     {
  88     checkMacro( macroToken, location );
  89     }
  90
  91 void CheckConfigMacros::Ifndef( SourceLocation location, const Token& macroToken, MacroDefinition const & )
  92     {
  93     checkMacro( macroToken, location );
  94     }
  95
  96 void CheckConfigMacros::Defined( const Token& macroToken, MacroDefinition const &, SourceRange )
  97     {
  98     checkMacro( macroToken, macroToken.getLocation());
  99     }
 100
 101 void CheckConfigMacros::checkMacro( const Token& macroToken, SourceLocation location )
 102     {
 103     if( configMacros.find( macroToken.getIdentifierInfo()->getName().str()) != configMacros.end())
 104         {
 105         const char* filename = compiler.getSourceManager().getPresumedLoc( location ).getFilename();
 106         if( filename == NULL
 107             || ( !hasPathnamePrefix(filename, SRCDIR "/include/LibreOfficeKit/")
 108                 && !hasPathnamePrefix(filename, WORKDIR "/UnpackedTarball/" )))
 109             {
 110             report( DiagnosticsEngine::Error, "checking whether a config macro %0 is defined",
 111                 location ) << macroToken.getIdentifierInfo()->getName();
 112             report( DiagnosticsEngine::Note, "use #if instead of #ifdef/#ifndef/defined", location );
 113             }
 114         }
 115     }
 116
 117 static Plugin::Registration< CheckConfigMacros > X( "checkconfigmacros" );
 118
 119 } // namespace
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */