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