blob: bf4337486ad907c923762f58a934f62bd3d4c90b [file] [log] [blame]
Alexander Kornienkod7166b02012-08-22 20:52:52 +00001//===--- tools/clang-check/ClangCheck.cpp - Clang check tool --------------===//
Manuel Klimekcb971c62012-04-04 12:07:46 +00002//
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//
Daniel Jasper5e5f7262012-10-03 13:28:43 +000010// This file implements a clang-check tool that runs clang based on the info
11// stored in a compilation database.
Manuel Klimekcb971c62012-04-04 12:07:46 +000012//
Alexander Kornienkodea8fba2012-07-16 12:46:48 +000013// 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//
Manuel Klimekcb971c62012-04-04 12:07:46 +000017//===----------------------------------------------------------------------===//
18
Alexander Kornienko48464702012-08-13 10:50:08 +000019#include "clang/AST/ASTConsumer.h"
20#include "clang/Driver/OptTable.h"
21#include "clang/Driver/Options.h"
22#include "clang/Frontend/ASTConsumers.h"
Daniel Jasper5e5f7262012-10-03 13:28:43 +000023#include "clang/Frontend/CompilerInstance.h"
24#include "clang/Rewrite/Frontend/FixItRewriter.h"
25#include "clang/Rewrite/Frontend/FrontendActions.h"
Alexander Kornienkod7166b02012-08-22 20:52:52 +000026#include "clang/Tooling/CommonOptionsParser.h"
Manuel Klimekcb971c62012-04-04 12:07:46 +000027#include "clang/Tooling/Tooling.h"
Alexander Kornienkod7166b02012-08-22 20:52:52 +000028#include "llvm/Support/CommandLine.h"
Daniel Jasper5e5f7262012-10-03 13:28:43 +000029#include "llvm/Support/Path.h"
NAKAMURA Takumib8238b62013-01-18 13:46:48 +000030#include "llvm/Support/Signals.h"
Manuel Klimekcb971c62012-04-04 12:07:46 +000031
Alexander Kornienko48464702012-08-13 10:50:08 +000032using namespace clang::driver;
Manuel Klimekcb971c62012-04-04 12:07:46 +000033using namespace clang::tooling;
34using namespace llvm;
35
Alexander Kornienko6fbe9822012-08-24 00:39:14 +000036static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage);
Alexander Kornienkod7166b02012-08-22 20:52:52 +000037static cl::extrahelp MoreHelp(
Alexander Kornienkodea8fba2012-07-16 12:46:48 +000038 "\tFor example, to run clang-check on all files in a subtree of the\n"
39 "\tsource tree, use:\n"
Alexander Kornienko140d5132012-07-12 14:34:23 +000040 "\n"
Alexander Kornienkodea8fba2012-07-16 12:46:48 +000041 "\t find path/in/subtree -name '*.cpp'|xargs clang-check\n"
Alexander Kornienko140d5132012-07-12 14:34:23 +000042 "\n"
Alexander Kornienkodea8fba2012-07-16 12:46:48 +000043 "\tor using a specific build path:\n"
Alexander Kornienko140d5132012-07-12 14:34:23 +000044 "\n"
Alexander Kornienkodea8fba2012-07-16 12:46:48 +000045 "\t find path/in/subtree -name '*.cpp'|xargs clang-check -p build/path\n"
Alexander Kornienko140d5132012-07-12 14:34:23 +000046 "\n"
Alexander Kornienkodea8fba2012-07-16 12:46:48 +000047 "\tNote, that path/in/subtree and current directory should follow the\n"
48 "\trules described above.\n"
Alexander Kornienkod7166b02012-08-22 20:52:52 +000049 "\n"
50);
51
52static OwningPtr<OptTable> Options(createDriverOptTable());
53static cl::opt<bool> ASTDump(
54 "ast-dump",
55 cl::desc(Options->getOptionHelpText(options::OPT_ast_dump)));
56static cl::opt<bool> ASTList(
57 "ast-list",
58 cl::desc(Options->getOptionHelpText(options::OPT_ast_list)));
59static cl::opt<bool> ASTPrint(
60 "ast-print",
61 cl::desc(Options->getOptionHelpText(options::OPT_ast_print)));
62static cl::opt<std::string> ASTDumpFilter(
63 "ast-dump-filter",
64 cl::desc(Options->getOptionHelpText(options::OPT_ast_dump_filter)));
Alexander Kornienko140d5132012-07-12 14:34:23 +000065
Daniel Jasper5e5f7262012-10-03 13:28:43 +000066static cl::opt<bool> Fixit(
67 "fixit",
68 cl::desc(Options->getOptionHelpText(options::OPT_fixit)));
69static cl::opt<bool> FixWhatYouCan(
70 "fix-what-you-can",
71 cl::desc(Options->getOptionHelpText(options::OPT_fix_what_you_can)));
72
73namespace {
74
75// FIXME: Move FixItRewriteInPlace from lib/Rewrite/Frontend/FrontendActions.cpp
76// into a header file and reuse that.
77class FixItOptions : public clang::FixItOptions {
78public:
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.
101class FixItRewriter : public clang::FixItRewriter {
102public:
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.
115class FixItAction : public clang::FixItAction {
116public:
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
Alexander Kornienko18857f72012-09-10 14:54:38 +0000128// Anonymous namespace here causes problems with gcc <= 4.4 on MacOS 10.6.
129// "Non-global symbol: ... can't be a weak_definition"
130namespace clang_check {
131class ClangCheckActionFactory {
Alexander Kornienko48464702012-08-13 10:50:08 +0000132public:
Alexander Kornienko48464702012-08-13 10:50:08 +0000133 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 }
Alexander Kornienko48464702012-08-13 10:50:08 +0000142};
Alexander Kornienko18857f72012-09-10 14:54:38 +0000143}
Alexander Kornienko48464702012-08-13 10:50:08 +0000144
Manuel Klimek30318e62012-04-18 07:41:50 +0000145int main(int argc, const char **argv) {
NAKAMURA Takumib8238b62013-01-18 13:46:48 +0000146 llvm::sys::PrintStackTraceOnErrorSignal();
Alexander Kornienkod7166b02012-08-22 20:52:52 +0000147 CommonOptionsParser OptionsParser(argc, argv);
Edwin Vaneb1f67db2012-12-14 18:58:25 +0000148 ClangTool Tool(OptionsParser.getCompilations(),
149 OptionsParser.getSourcePathList());
Daniel Jasper5e5f7262012-10-03 13:28:43 +0000150 if (Fixit)
151 return Tool.run(newFrontendActionFactory<FixItAction>());
152 clang_check::ClangCheckActionFactory Factory;
Alexander Kornienko48464702012-08-13 10:50:08 +0000153 return Tool.run(newFrontendActionFactory(&Factory));
Manuel Klimekcb971c62012-04-04 12:07:46 +0000154}