blob: 030e4b163987b226eab2cb0879632d18e63c7047 [file] [log] [blame]
Daniel Jasperd07c8402013-07-29 08:19:24 +00001//===--- tools/extra/clang-tidy/ClangTidyMain.cpp - Clang tidy 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/// \file This file implements a clang-tidy tool.
11///
12/// This tool uses the Clang Tooling infrastructure, see
13/// http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html
14/// for details on setting it up with LLVM source tree.
15///
16//===----------------------------------------------------------------------===//
17
18#include "../ClangTidy.h"
Manuel Klimek814f9bd2013-11-14 15:49:44 +000019#include "clang/Tooling/CommonOptionsParser.h"
Daniel Jasperd07c8402013-07-29 08:19:24 +000020
21using namespace clang::ast_matchers;
22using namespace clang::driver;
23using namespace clang::tooling;
24using namespace llvm;
25
Alexander Kornienko99c9d6a2014-02-05 13:43:27 +000026static cl::OptionCategory ClangTidyCategory("clang-tidy options");
Daniel Jasperd07c8402013-07-29 08:19:24 +000027
Manuel Klimek814f9bd2013-11-14 15:49:44 +000028static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage);
Daniel Jasperd07c8402013-07-29 08:19:24 +000029
Alexander Kornienko23fe9592014-05-15 14:27:36 +000030const char DefaultChecks[] =
31 "*," // Enable all checks, except these:
32 "-clang-analyzer-alpha*," // Too many false positives.
33 "-llvm-include-order," // Not implemented yet.
Alexander Kornienko23fe9592014-05-15 14:27:36 +000034 "-google-*,"; // Doesn't apply to LLVM.
Alexander Kornienkodad4acb2014-05-22 16:07:11 +000035
Alexander Kornienko23fe9592014-05-15 14:27:36 +000036static cl::opt<std::string>
Alexander Kornienko3ab34672014-05-16 13:07:18 +000037Checks("checks", cl::desc("Comma-separated list of globs with optional '-'\n"
38 "prefix. Globs are processed in order of appearance\n"
39 "in the list. Globs without '-' prefix add checks\n"
40 "with matching names to the set, globs with the '-'\n"
41 "prefix remove checks with matching names from the\n"
42 "set of enabled checks."),
Alexander Kornienko23fe9592014-05-15 14:27:36 +000043 cl::init(""), cl::cat(ClangTidyCategory));
Alexander Kornienkodad4acb2014-05-22 16:07:11 +000044
Alexander Kornienko3ab34672014-05-16 13:07:18 +000045static cl::opt<std::string>
46HeaderFilter("header-filter",
47 cl::desc("Regular expression matching the names of the\n"
Alexander Kornienkodad4acb2014-05-22 16:07:11 +000048 "headers to output diagnostics from. Diagnostics\n"
49 "from the main file of each translation unit are\n"
50 "always displayed.\n"
51 "Can be used together with -line-filter."),
Alexander Kornienko3ab34672014-05-16 13:07:18 +000052 cl::init(""), cl::cat(ClangTidyCategory));
Alexander Kornienkodad4acb2014-05-22 16:07:11 +000053
54static cl::opt<std::string>
55LineFilter("line-filter",
56 cl::desc("List of files with line ranges to filter the\n"
57 "warnings. Can be used together with\n"
58 "-header-filter. The format of the list is a JSON\n"
59 "array of objects:\n"
60 " [\n"
61 " {\"name\":\"file1.cpp\",\"lines\":[[1,3],[5,7]]},\n"
62 " {\"name\":\"file2.h\"}\n"
63 " ]"),
64 cl::init(""), cl::cat(ClangTidyCategory));
65
Daniel Jasperd07c8402013-07-29 08:19:24 +000066static cl::opt<bool> Fix("fix", cl::desc("Fix detected errors if possible."),
67 cl::init(false), cl::cat(ClangTidyCategory));
68
Alexander Kornienko3ab34672014-05-16 13:07:18 +000069static cl::opt<bool>
70ListChecks("list-checks",
71 cl::desc("List all enabled checks and exit. Use with\n"
72 "-checks='*' to list all available checks."),
73 cl::init(false), cl::cat(ClangTidyCategory));
Daniel Jasperd07c8402013-07-29 08:19:24 +000074
Alexander Kornienko3ab34672014-05-16 13:07:18 +000075static cl::opt<bool>
76AnalyzeTemporaryDtors("analyze-temporary-dtors",
77 cl::desc("Enable temporary destructor-aware analysis in\n"
78 "clang-analyzer- checks."),
79 cl::init(false), cl::cat(ClangTidyCategory));
Alex McCarthyfec08c72014-04-30 14:09:24 +000080
Alexander Kornienko5d174542014-05-07 09:06:53 +000081static void printStats(const clang::tidy::ClangTidyStats &Stats) {
Alexander Kornienkodad4acb2014-05-22 16:07:11 +000082 if (Stats.errorsIgnored()) {
83 llvm::errs() << "Suppressed " << Stats.errorsIgnored() << " warnings (";
Alexander Kornienko5d174542014-05-07 09:06:53 +000084 StringRef Separator = "";
85 if (Stats.ErrorsIgnoredNonUserCode) {
86 llvm::errs() << Stats.ErrorsIgnoredNonUserCode << " in non-user code";
87 Separator = ", ";
88 }
Alexander Kornienkodad4acb2014-05-22 16:07:11 +000089 if (Stats.ErrorsIgnoredLineFilter) {
90 llvm::errs() << Separator << Stats.ErrorsIgnoredLineFilter
91 << " due to line filter";
92 Separator = ", ";
93 }
Alexander Kornienko5d174542014-05-07 09:06:53 +000094 if (Stats.ErrorsIgnoredNOLINT) {
95 llvm::errs() << Separator << Stats.ErrorsIgnoredNOLINT << " NOLINT";
96 Separator = ", ";
97 }
98 if (Stats.ErrorsIgnoredCheckFilter)
99 llvm::errs() << Separator << Stats.ErrorsIgnoredCheckFilter
100 << " with check filters";
101 llvm::errs() << ").\n";
102 if (Stats.ErrorsIgnoredNonUserCode)
103 llvm::errs() << "Use -header-filter='.*' to display errors from all "
104 "non-system headers.\n";
105 }
106}
107
Daniel Jasperd07c8402013-07-29 08:19:24 +0000108int main(int argc, const char **argv) {
Alexander Kornienko06ff5a72013-12-12 10:01:39 +0000109 CommonOptionsParser OptionsParser(argc, argv, ClangTidyCategory);
Daniel Jasperd07c8402013-07-29 08:19:24 +0000110
Alexander Kornienkoa4695222014-06-05 13:31:45 +0000111 clang::tidy::ClangTidyGlobalOptions GlobalOptions;
Rafael Espindola15c57842014-06-12 13:32:11 +0000112 if (std::error_code Err =
Alexander Kornienkoa4695222014-06-05 13:31:45 +0000113 clang::tidy::parseLineFilter(LineFilter, GlobalOptions)) {
Alexander Kornienkodad4acb2014-05-22 16:07:11 +0000114 llvm::errs() << "Invalid LineFilter: " << Err.message() << "\n\nUsage:\n";
115 llvm::cl::PrintHelpMessage(/*Hidden=*/false, /*Categorized=*/true);
116 return 1;
117 }
Alexander Kornienko33a9bcc2014-04-29 15:20:10 +0000118
Alexander Kornienkoa4695222014-06-05 13:31:45 +0000119 clang::tidy::ClangTidyOptions Options;
120 Options.Checks = DefaultChecks + Checks;
121 Options.HeaderFilterRegex = HeaderFilter;
122 Options.AnalyzeTemporaryDtors = AnalyzeTemporaryDtors;
123
Alexander Kornienkofbf92582014-06-02 20:32:06 +0000124 std::vector<std::string> EnabledChecks = clang::tidy::getCheckNames(Options);
125
Alexander Kornienkofb9e92b2013-12-19 19:57:05 +0000126 // FIXME: Allow using --list-checks without positional arguments.
127 if (ListChecks) {
Alexander Kornienkofb9e92b2013-12-19 19:57:05 +0000128 llvm::outs() << "Enabled checks:";
Alexander Kornienkofbf92582014-06-02 20:32:06 +0000129 for (auto CheckName : EnabledChecks)
Alexander Kornienko16ac6ce2014-03-05 13:14:32 +0000130 llvm::outs() << "\n " << CheckName;
Alexander Kornienkofb9e92b2013-12-19 19:57:05 +0000131 llvm::outs() << "\n\n";
132 return 0;
133 }
134
Alexander Kornienkofbf92582014-06-02 20:32:06 +0000135 if (EnabledChecks.empty()) {
136 llvm::errs() << "Error: no checks enabled.\n";
137 llvm::cl::PrintHelpMessage(/*Hidden=*/false, /*Categorized=*/true);
138 return 1;
139 }
140
Alexander Kornienkoa4695222014-06-05 13:31:45 +0000141 // TODO: Implement configuration file reading and a "real" options provider.
142 auto OptionsProvider =
143 new clang::tidy::DefaultOptionsProvider(GlobalOptions, Options);
Alexander Kornienko826b5ad2014-05-09 12:24:09 +0000144 std::vector<clang::tidy::ClangTidyError> Errors;
Alexander Kornienkoa4695222014-06-05 13:31:45 +0000145 clang::tidy::ClangTidyStats Stats = clang::tidy::runClangTidy(
146 OptionsProvider, OptionsParser.getCompilations(),
147 OptionsParser.getSourcePathList(), &Errors);
Daniel Jasperd07c8402013-07-29 08:19:24 +0000148 clang::tidy::handleErrors(Errors, Fix);
149
Alexander Kornienko5d174542014-05-07 09:06:53 +0000150 printStats(Stats);
Daniel Jasperd07c8402013-07-29 08:19:24 +0000151 return 0;
152}
Daniel Jasper89bbab02013-08-04 15:56:30 +0000153
154namespace clang {
155namespace tidy {
156
157// This anchor is used to force the linker to link the LLVMModule.
158extern volatile int LLVMModuleAnchorSource;
159static int LLVMModuleAnchorDestination = LLVMModuleAnchorSource;
160
161// This anchor is used to force the linker to link the GoogleModule.
162extern volatile int GoogleModuleAnchorSource;
163static int GoogleModuleAnchorDestination = GoogleModuleAnchorSource;
164
Alexander Kornienko16ac6ce2014-03-05 13:14:32 +0000165// This anchor is used to force the linker to link the MiscModule.
166extern volatile int MiscModuleAnchorSource;
167static int MiscModuleAnchorDestination = MiscModuleAnchorSource;
168
Daniel Jasper89bbab02013-08-04 15:56:30 +0000169} // namespace tidy
170} // namespace clang