compilerplugins/clang/sharedvisitor/analyzer.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
  10 #include "clang/AST/ASTConsumer.h"
  11 #include "clang/AST/RecursiveASTVisitor.h"
  12 #include "clang/Frontend/CompilerInstance.h"
  13 #include "clang/Frontend/FrontendAction.h"
  14 #include "clang/Tooling/Tooling.h"
  15 #include "llvm/ADT/StringExtras.h"
  16
  17 #include <cassert>
  18 #include <cstddef>
  19 #include <cstring>
  20 #include <iostream>
  21 #include <memory>
  22 #include <fstream>
  23 #include <set>
  24
  25 #include "config_clang.h"
  26 #include "../check.hxx"
  27 #include "../check.cxx"
  28
  29 using namespace clang;
  30 using namespace llvm;
  31
  32 using namespace loplugin;
  33
  34 // Info about a Traverse* function in a plugin.
  35 struct TraverseFunctionInfo
  36 {
  37     std::string name;
  38     std::string argument;
  39     bool hasPre = false;
  40     bool hasPost = false;
  41 };
  42
  43 struct TraverseFunctionInfoLess
  44 {
  45     bool operator()( const TraverseFunctionInfo& l, const TraverseFunctionInfo& r ) const
  46     {
  47         return l.name < r.name;
  48     }
  49 };
  50
  51 static std::set< TraverseFunctionInfo, TraverseFunctionInfoLess > traverseFunctions;
  52
  53 class CheckFileVisitor
  54     : public RecursiveASTVisitor< CheckFileVisitor >
  55 {
  56 public:
  57     void setContext(ASTContext const& context) { context_ = &context; }
  58
  59     bool VisitCXXRecordDecl(CXXRecordDecl *Declaration);
  60
  61     bool TraverseNamespaceDecl(NamespaceDecl * decl)
  62     {
  63         // Skip non-LO namespaces the same way FilteringPlugin does.
  64         if( !ContextCheck( decl ).Namespace( "loplugin" ).GlobalNamespace()
  65             && !ContextCheck( decl ).AnonymousNamespace())
  66         {
  67             return true;
  68         }
  69         return RecursiveASTVisitor<CheckFileVisitor>::TraverseNamespaceDecl(decl);
  70     }
  71
  72 private:
  73     ASTContext const* context_ = nullptr;
  74
  75     QualType unqualifyPointeeType(QualType type)
  76     {
  77         assert(context_ != nullptr);
  78         if (auto const t = type->getAs<clang::PointerType>())
  79         {
  80             return context_->getQualifiedType(
  81                 context_->getPointerType(t->getPointeeType().getUnqualifiedType()),
  82                 type.getQualifiers());
  83         }
  84         return type;
  85     }
  86 };
  87
  88 static bool inheritsPluginClassCheck( const Decl* decl )
  89 {
  90     return bool( DeclCheck( decl ).Class( "FilteringPlugin" ).Namespace( "loplugin" ).GlobalNamespace())
  91         || bool( DeclCheck( decl ).Class( "FilteringRewritePlugin" ).Namespace( "loplugin" ).GlobalNamespace());
  92 }
  93
  94 static TraverseFunctionInfo findOrCreateTraverseFunctionInfo( StringRef name )
  95 {
  96     TraverseFunctionInfo info;
  97     info.name = name.str();
  98     auto foundInfo = traverseFunctions.find( info );
  99     if( foundInfo != traverseFunctions.end())
 100     {
 101         info = std::move( *foundInfo );
 102         traverseFunctions.erase( foundInfo );
 103     }
 104     return info;
 105 }
 106
 107 static bool foundSomething;
 108
 109 bool CheckFileVisitor::VisitCXXRecordDecl( CXXRecordDecl* decl )
 110 {
 111     if( !isDerivedFrom( decl, inheritsPluginClassCheck ))
 112         return true;
 113
 114     if( decl->getName() == "FilteringPlugin" || decl->getName() == "FilteringRewritePlugin" )
 115         return true;
 116
 117     std::cout << "# This file is autogenerated. Do not modify." << std::endl;
 118     std::cout << "# Generated by compilerplugins/clang/sharedvisitor/analyzer.cxx ." << std::endl;
 119     std::cout << "InfoVersion:1" << std::endl;
 120     std::cout << "ClassName:" << decl->getName().str() << std::endl;
 121     traverseFunctions.clear();
 122     for( const CXXMethodDecl* method : decl->methods())
 123     {
 124         if( !method->getDeclName().isIdentifier())
 125             continue;
 126         if( method->isStatic() || method->getAccess() != AS_public )
 127             continue;
 128         if( method->getName().startswith( "Visit" ))
 129         {
 130             if( method->getNumParams() == 1 )
 131             {
 132                 std::cout << "VisitFunctionStart" << std::endl;
 133                 std::cout << "VisitFunctionName:" << method->getName().str() << std::endl;
 134                 std::cout << "VisitFunctionArgument:"
 135                     << unqualifyPointeeType(
 136                         method->getParamDecl( 0 )->getTypeSourceInfo()->getType()).getAsString()
 137                     << std::endl;
 138                 std::cout << "VisitFunctionEnd" << std::endl;
 139             }
 140             else
 141             {
 142                 std::cerr << "Unhandled Visit* function: " << decl->getName().str()
 143                      << "::" << method->getName().str() << std::endl;
 144                 abort();
 145             }
 146         }
 147         else if( method->getName().startswith( "Traverse" ))
 148         {
 149             if( method->getNumParams() == 1 )
 150             {
 151                 TraverseFunctionInfo traverseInfo = findOrCreateTraverseFunctionInfo( method->getName());
 152                 traverseInfo.argument = method->getParamDecl( 0 )->getTypeSourceInfo()->getType().getAsString();
 153                 traverseFunctions.insert( std::move( traverseInfo ));
 154             }
 155             else
 156             {
 157                 std::cerr << "Unhandled Traverse* function: " << decl->getName().str()
 158                      << "::" << method->getName().str() << std::endl;
 159                 abort();
 160             }
 161         }
 162         else if( method->getName().startswith( "PreTraverse" ))
 163         {
 164             TraverseFunctionInfo traverseInfo = findOrCreateTraverseFunctionInfo( method->getName().substr( 3 ));
 165             traverseInfo.hasPre = true;
 166             traverseFunctions.insert( std::move( traverseInfo ));
 167         }
 168         else if( method->getName().startswith( "PostTraverse" ))
 169         {
 170                 TraverseFunctionInfo traverseInfo = findOrCreateTraverseFunctionInfo( method->getName().substr( 4 ));
 171                 traverseInfo.hasPost = true;
 172                 traverseFunctions.insert( std::move( traverseInfo ));
 173         }
 174         else if( method->getName() == "shouldVisitTemplateInstantiations" )
 175             std::cout << "ShouldVisitTemplateInstantiations:1" << std::endl;
 176         else if (method->getName() == "shouldVisitImplicitCode")
 177             std::cout << "ShouldVisitImplicitCode:1" << std::endl;
 178         else if( method->getName().startswith( "WalkUp" ))
 179         {
 180             std::cerr << "WalkUp function not supported for shared visitor: " << decl->getName().str()
 181                  << "::" << method->getName().str() << std::endl;
 182             abort();
 183         }
 184     }
 185
 186     for( const auto& traverseFunction : traverseFunctions )
 187     {
 188         std::cout << "TraverseFunctionStart" << std::endl;
 189         std::cout << "TraverseFunctionName:" << traverseFunction.name << std::endl;
 190         std::cout << "TraverseFunctionArgument:" << traverseFunction.argument << std::endl;
 191         std::cout << "TraverseFunctionHasPre:" << traverseFunction.hasPre << std::endl;
 192         std::cout << "TraverseFunctionHasPost:" << traverseFunction.hasPost << std::endl;
 193         std::cout << "TraverseFunctionEnd" << std::endl;
 194     }
 195
 196     std::cout << "InfoEnd" << std::endl;
 197     foundSomething = true;
 198     return true;
 199 }
 200
 201 class FindNamedClassConsumer
 202     : public ASTConsumer
 203 {
 204 public:
 205     void Initialize(ASTContext& context) override
 206     {
 207         visitor.setContext(context);
 208     }
 209     virtual void HandleTranslationUnit(ASTContext& context) override
 210     {
 211         visitor.TraverseDecl( context.getTranslationUnitDecl());
 212     }
 213 private:
 214     CheckFileVisitor visitor;
 215 };
 216
 217 class FindNamedClassAction
 218     : public ASTFrontendAction
 219     {
 220 public:
 221     virtual std::unique_ptr<ASTConsumer> CreateASTConsumer( CompilerInstance&, StringRef ) override
 222     {
 223         return std::unique_ptr<ASTConsumer>( new FindNamedClassConsumer );
 224     }
 225 };
 226
 227
 228 std::string readSourceFile( const char* filename )
 229 {
 230     std::string contents;
 231     std::ifstream stream( filename );
 232     if( !stream )
 233     {
 234         std::cerr << "Failed to open: " << filename << std::endl;
 235         exit( 1 );
 236     }
 237     std::string line;
 238     bool hasIfdef = false;
 239     while( getline( stream, line ))
 240     {
 241         // TODO add checks that it's e.g. not "#ifdef" ?
 242         if( line.find( "#ifndef LO_CLANG_SHARED_PLUGINS" ) == 0 )
 243             hasIfdef = true;
 244         contents += line;
 245         contents += '\n';
 246     }
 247     if( stream.eof() && hasIfdef )
 248         return contents;
 249     return "";
 250 }
 251
 252 int main(int argc, char** argv)
 253 {
 254     std::vector< std::string > args;
 255     int i = 1;
 256     for( ; i < argc; ++ i )
 257     {
 258         constexpr std::size_t prefixlen = 5; // strlen("-arg=");
 259         if (std::strncmp(argv[i], "-arg=", prefixlen) != 0)
 260         {
 261             break;
 262         }
 263         args.push_back(argv[i] + prefixlen);
 264     }
 265     SmallVector< StringRef, 20 > clangflags;
 266     SplitString( CLANGFLAGS, clangflags );
 267     for (auto const & i: clangflags) {
 268         args.push_back(i.str());
 269     }
 270     args.insert(
 271         args.end(),
 272         {   // These must match LO_CLANG_ANALYZER_PCH_CXXFLAGS in Makefile-clang.mk .
 273             "-I" BUILDDIR "/config_host" // plugin sources use e.g. config_global.h
 274 #if LO_CLANG_USE_ANALYZER_PCH
 275             ,
 276             "-include-pch", // use PCH with Clang headers to speed up parsing/analysing
 277             BUILDDIR "/compilerplugins/clang/sharedvisitor/clang.pch"
 278 #endif
 279         });
 280     for( ; i < argc; ++ i )
 281     {
 282         std::string contents = readSourceFile(argv[i]);
 283         if( contents.empty())
 284             continue;
 285         foundSomething = false;
 286 #if CLANG_VERSION >= 100000
 287         if( !tooling::runToolOnCodeWithArgs( std::unique_ptr<FindNamedClassAction>(new FindNamedClassAction), contents, args, argv[ i ] ))
 288 #else
 289         if( !tooling::runToolOnCodeWithArgs( new FindNamedClassAction, contents, args, argv[ i ] ))
 290 #endif
 291         {
 292             std::cerr << "Failed to analyze: " << argv[ i ] << std::endl;
 293             return 2;
 294         }
 295         if( !foundSomething )
 296         {
 297             // there's #ifndef LO_CLANG_SHARED_PLUGINS in the source, but no class matched
 298             std::cerr << "Failed to find code: " << argv[ i ] << std::endl;
 299             return 2;
 300         }
 301     }
 302     return 0;
 303 }