1 //===--- tools/clang-check/ClangCheck.cpp - Clang check tool --------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file implements a clang-check tool that runs clang based on the info 11 // stored in a compilation database. 12 // 13 // This tool uses the Clang Tooling infrastructure, see 14 // http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html 15 // for details on setting it up with LLVM source tree. 16 // 17 //===----------------------------------------------------------------------===// 18 19 #include "clang/AST/ASTConsumer.h" 20 #include "clang/Driver/OptTable.h" 21 #include "clang/Driver/Options.h" 22 #include "clang/Frontend/ASTConsumers.h" 23 #include "clang/Frontend/CompilerInstance.h" 24 #include "clang/Rewrite/Frontend/FixItRewriter.h" 25 #include "clang/Rewrite/Frontend/FrontendActions.h" 26 #include "clang/Tooling/CommonOptionsParser.h" 27 #include "clang/Tooling/Tooling.h" 28 #include "llvm/Support/CommandLine.h" 29 #include "llvm/Support/Path.h" 30 #include "llvm/Support/Signals.h" 31 32 using namespace clang::driver; 33 using namespace clang::tooling; 34 using namespace llvm; 35 36 static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage); 37 static cl::extrahelp MoreHelp( 38 "\tFor example, to run clang-check on all files in a subtree of the\n" 39 "\tsource tree, use:\n" 40 "\n" 41 "\t find path/in/subtree -name '*.cpp'|xargs clang-check\n" 42 "\n" 43 "\tor using a specific build path:\n" 44 "\n" 45 "\t find path/in/subtree -name '*.cpp'|xargs clang-check -p build/path\n" 46 "\n" 47 "\tNote, that path/in/subtree and current directory should follow the\n" 48 "\trules described above.\n" 49 "\n" 50 ); 51 52 static OwningPtr<OptTable> Options(createDriverOptTable()); 53 static cl::opt<bool> ASTDump( 54 "ast-dump", 55 cl::desc(Options->getOptionHelpText(options::OPT_ast_dump))); 56 static cl::opt<bool> ASTList( 57 "ast-list", 58 cl::desc(Options->getOptionHelpText(options::OPT_ast_list))); 59 static cl::opt<bool> ASTPrint( 60 "ast-print", 61 cl::desc(Options->getOptionHelpText(options::OPT_ast_print))); 62 static cl::opt<std::string> ASTDumpFilter( 63 "ast-dump-filter", 64 cl::desc(Options->getOptionHelpText(options::OPT_ast_dump_filter))); 65 66 static cl::opt<bool> Fixit( 67 "fixit", 68 cl::desc(Options->getOptionHelpText(options::OPT_fixit))); 69 static cl::opt<bool> FixWhatYouCan( 70 "fix-what-you-can", 71 cl::desc(Options->getOptionHelpText(options::OPT_fix_what_you_can))); 72 73 namespace { 74 75 // FIXME: Move FixItRewriteInPlace from lib/Rewrite/Frontend/FrontendActions.cpp 76 // into a header file and reuse that. 77 class FixItOptions : public clang::FixItOptions { 78 public: 79 FixItOptions() { 80 FixWhatYouCan = ::FixWhatYouCan; 81 } 82 83 std::string RewriteFilename(const std::string& filename, int &fd) { 84 assert(llvm::sys::path::is_absolute(filename) && 85 "clang-fixit expects absolute paths only."); 86 87 // We don't need to do permission checking here since clang will diagnose 88 // any I/O errors itself. 89 90 fd = -1; // No file descriptor for file. 91 92 return filename; 93 } 94 }; 95 96 /// \brief Subclasses \c clang::FixItRewriter to not count fixed errors/warnings 97 /// in the final error counts. 98 /// 99 /// This has the side-effect that clang-check -fixit exits with code 0 on 100 /// successfully fixing all errors. 101 class FixItRewriter : public clang::FixItRewriter { 102 public: 103 FixItRewriter(clang::DiagnosticsEngine& Diags, 104 clang::SourceManager& SourceMgr, 105 const clang::LangOptions& LangOpts, 106 clang::FixItOptions* FixItOpts) 107 : clang::FixItRewriter(Diags, SourceMgr, LangOpts, FixItOpts) { 108 } 109 110 virtual bool IncludeInDiagnosticCounts() const { return false; } 111 }; 112 113 /// \brief Subclasses \c clang::FixItAction so that we can install the custom 114 /// \c FixItRewriter. 115 class FixItAction : public clang::FixItAction { 116 public: 117 virtual bool BeginSourceFileAction(clang::CompilerInstance& CI, 118 StringRef Filename) { 119 FixItOpts.reset(new FixItOptions); 120 Rewriter.reset(new FixItRewriter(CI.getDiagnostics(), CI.getSourceManager(), 121 CI.getLangOpts(), FixItOpts.get())); 122 return true; 123 } 124 }; 125 126 } // namespace 127 128 // Anonymous namespace here causes problems with gcc <= 4.4 on MacOS 10.6. 129 // "Non-global symbol: ... can't be a weak_definition" 130 namespace clang_check { 131 class ClangCheckActionFactory { 132 public: 133 clang::ASTConsumer *newASTConsumer() { 134 if (ASTList) 135 return clang::CreateASTDeclNodeLister(); 136 if (ASTDump) 137 return clang::CreateASTDumper(ASTDumpFilter); 138 if (ASTPrint) 139 return clang::CreateASTPrinter(&llvm::outs(), ASTDumpFilter); 140 return new clang::ASTConsumer(); 141 } 142 }; 143 } 144 145 int main(int argc, const char **argv) { 146 llvm::sys::PrintStackTraceOnErrorSignal(); 147 CommonOptionsParser OptionsParser(argc, argv); 148 ClangTool Tool(OptionsParser.getCompilations(), 149 OptionsParser.getSourcePathList()); 150 if (Fixit) 151 return Tool.run(newFrontendActionFactory<FixItAction>()); 152 clang_check::ClangCheckActionFactory Factory; 153 return Tool.run(newFrontendActionFactory(&Factory)); 154 } 155
