|  | //===--- tools/extra/clang-tidy/ClangTidyMain.cpp - Clang tidy tool -------===// | 
|  | // | 
|  | //                     The LLVM Compiler Infrastructure | 
|  | // | 
|  | // This file is distributed under the University of Illinois Open Source | 
|  | // License. See LICENSE.TXT for details. | 
|  | // | 
|  | //===----------------------------------------------------------------------===// | 
|  | /// | 
|  | ///  \file This file implements a clang-tidy tool. | 
|  | /// | 
|  | ///  This tool uses the Clang Tooling infrastructure, see | 
|  | ///    http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html | 
|  | ///  for details on setting it up with LLVM source tree. | 
|  | /// | 
|  | //===----------------------------------------------------------------------===// | 
|  |  | 
|  | #include "../ClangTidy.h" | 
|  | #include "clang/Tooling/CommonOptionsParser.h" | 
|  | #include "llvm/Support/Process.h" | 
|  |  | 
|  | using namespace clang::ast_matchers; | 
|  | using namespace clang::driver; | 
|  | using namespace clang::tooling; | 
|  | using namespace llvm; | 
|  |  | 
|  | static cl::OptionCategory ClangTidyCategory("clang-tidy options"); | 
|  |  | 
|  | static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage); | 
|  | static cl::extrahelp ClangTidyHelp( | 
|  | "Configuration files:\n" | 
|  | "  clang-tidy attempts to read configuration for each source file from a\n" | 
|  | "  .clang-tidy file located in the closest parent directory of the source\n" | 
|  | "  file. If any configuration options have a corresponding command-line\n" | 
|  | "  option, command-line option takes precedence. The effective\n" | 
|  | "  configuration can be inspected using -dump-config:\n" | 
|  | "\n" | 
|  | "    $ clang-tidy -dump-config - --\n" | 
|  | "    ---\n" | 
|  | "    Checks:          '-*,some-check'\n" | 
|  | "    HeaderFilterRegex: ''\n" | 
|  | "    AnalyzeTemporaryDtors: false\n" | 
|  | "    User:            user\n" | 
|  | "    CheckOptions:    \n" | 
|  | "      - key:             some-check.SomeOption\n" | 
|  | "        value:           'some value'\n" | 
|  | "    ...\n" | 
|  | "\n\n"); | 
|  |  | 
|  | const char DefaultChecks[] =  // Enable these checks: | 
|  | "clang-diagnostic-*,"     //   * compiler diagnostics | 
|  | "clang-analyzer-*,"       //   * Static Analyzer checks | 
|  | "-clang-analyzer-alpha*"; //   * but not alpha checks: many false positives | 
|  |  | 
|  | static cl::opt<std::string> | 
|  | Checks("checks", cl::desc("Comma-separated list of globs with optional '-'\n" | 
|  | "prefix. Globs are processed in order of appearance\n" | 
|  | "in the list. Globs without '-' prefix add checks\n" | 
|  | "with matching names to the set, globs with the '-'\n" | 
|  | "prefix remove checks with matching names from the\n" | 
|  | "set of enabled checks.\n" | 
|  | "This option's value is appended to the value read\n" | 
|  | "from a .clang-tidy file, if any."), | 
|  | cl::init(""), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<std::string> | 
|  | HeaderFilter("header-filter", | 
|  | cl::desc("Regular expression matching the names of the\n" | 
|  | "headers to output diagnostics from. Diagnostics\n" | 
|  | "from the main file of each translation unit are\n" | 
|  | "always displayed.\n" | 
|  | "Can be used together with -line-filter.\n" | 
|  | "This option overrides the value read from a\n" | 
|  | ".clang-tidy file."), | 
|  | cl::init(""), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<bool> | 
|  | SystemHeaders("system-headers", | 
|  | cl::desc("Display the errors from system headers."), | 
|  | cl::init(false), cl::cat(ClangTidyCategory)); | 
|  | static cl::opt<std::string> | 
|  | LineFilter("line-filter", | 
|  | cl::desc("List of files with line ranges to filter the\n" | 
|  | "warnings. Can be used together with\n" | 
|  | "-header-filter. The format of the list is a JSON\n" | 
|  | "array of objects:\n" | 
|  | "  [\n" | 
|  | "    {\"name\":\"file1.cpp\",\"lines\":[[1,3],[5,7]]},\n" | 
|  | "    {\"name\":\"file2.h\"}\n" | 
|  | "  ]"), | 
|  | cl::init(""), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<bool> | 
|  | Fix("fix", cl::desc("Apply suggested fixes. Without -fix-errors\n" | 
|  | "clang-tidy will bail out if any compilation\n" | 
|  | "errors were found."), | 
|  | cl::init(false), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<bool> | 
|  | FixErrors("fix-errors", | 
|  | cl::desc("Apply suggested fixes even if compilation errors\n" | 
|  | "were found. If compiler errors have attached\n" | 
|  | "fix-its, clang-tidy will apply them as well."), | 
|  | cl::init(false), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<bool> | 
|  | ListChecks("list-checks", | 
|  | cl::desc("List all enabled checks and exit. Use with\n" | 
|  | "-checks=* to list all available checks."), | 
|  | cl::init(false), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<std::string> Config( | 
|  | "config", | 
|  | cl::desc("Specifies a configuration in YAML/JSON format:\n" | 
|  | "  -config=\"{Checks: '*', CheckOptions: [{key: x, value: y}]}\"\n" | 
|  | "When the value is empty, clang-tidy will attempt to find\n" | 
|  | "a file named .clang-tidy for each source file in its parent\n" | 
|  | "directories."), | 
|  | cl::init(""), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<bool> DumpConfig( | 
|  | "dump-config", | 
|  | cl::desc("Dumps configuration in the YAML format to stdout. This option\n" | 
|  | "should be used along with a file name (and '--' if the file is\n" | 
|  | "outside of a project with configured compilation database). The\n" | 
|  | "configuration used for this file will be printed."), | 
|  | cl::init(false), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<bool> EnableCheckProfile( | 
|  | "enable-check-profile", | 
|  | cl::desc("Enable per-check timing profiles, and print a report to stderr."), | 
|  | cl::init(false), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<bool> AnalyzeTemporaryDtors( | 
|  | "analyze-temporary-dtors", | 
|  | cl::desc("Enable temporary destructor-aware analysis in\n" | 
|  | "clang-analyzer- checks.\n" | 
|  | "This option overrides the value read from a\n" | 
|  | ".clang-tidy file."), | 
|  | cl::init(false), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | static cl::opt<std::string> ExportFixes( | 
|  | "export-fixes", | 
|  | cl::desc("YAML file to store suggested fixes in. The\n" | 
|  | "stored fixes can be applied to the input source\n" | 
|  | "code with clang-apply-replacements."), | 
|  | cl::value_desc("filename"), cl::cat(ClangTidyCategory)); | 
|  |  | 
|  | namespace clang { | 
|  | namespace tidy { | 
|  |  | 
|  | static void printStats(const ClangTidyStats &Stats) { | 
|  | if (Stats.errorsIgnored()) { | 
|  | llvm::errs() << "Suppressed " << Stats.errorsIgnored() << " warnings ("; | 
|  | StringRef Separator = ""; | 
|  | if (Stats.ErrorsIgnoredNonUserCode) { | 
|  | llvm::errs() << Stats.ErrorsIgnoredNonUserCode << " in non-user code"; | 
|  | Separator = ", "; | 
|  | } | 
|  | if (Stats.ErrorsIgnoredLineFilter) { | 
|  | llvm::errs() << Separator << Stats.ErrorsIgnoredLineFilter | 
|  | << " due to line filter"; | 
|  | Separator = ", "; | 
|  | } | 
|  | if (Stats.ErrorsIgnoredNOLINT) { | 
|  | llvm::errs() << Separator << Stats.ErrorsIgnoredNOLINT << " NOLINT"; | 
|  | Separator = ", "; | 
|  | } | 
|  | if (Stats.ErrorsIgnoredCheckFilter) | 
|  | llvm::errs() << Separator << Stats.ErrorsIgnoredCheckFilter | 
|  | << " with check filters"; | 
|  | llvm::errs() << ").\n"; | 
|  | if (Stats.ErrorsIgnoredNonUserCode) | 
|  | llvm::errs() << "Use -header-filter=.* to display errors from all " | 
|  | "non-system headers.\n"; | 
|  | } | 
|  | } | 
|  |  | 
|  | static void printProfileData(const ProfileData &Profile, | 
|  | llvm::raw_ostream &OS) { | 
|  | // Time is first to allow for sorting by it. | 
|  | std::vector<std::pair<llvm::TimeRecord, StringRef>> Timers; | 
|  | TimeRecord Total; | 
|  |  | 
|  | for (const auto& P : Profile.Records) { | 
|  | Timers.emplace_back(P.getValue(), P.getKey()); | 
|  | Total += P.getValue(); | 
|  | } | 
|  |  | 
|  | std::sort(Timers.begin(), Timers.end()); | 
|  |  | 
|  | std::string Line = "===" + std::string(73, '-') + "===\n"; | 
|  | OS << Line; | 
|  |  | 
|  | if (Total.getUserTime()) | 
|  | OS << "   ---User Time---"; | 
|  | if (Total.getSystemTime()) | 
|  | OS << "   --System Time--"; | 
|  | if (Total.getProcessTime()) | 
|  | OS << "   --User+System--"; | 
|  | OS << "   ---Wall Time---"; | 
|  | if (Total.getMemUsed()) | 
|  | OS << "  ---Mem---"; | 
|  | OS << "  --- Name ---\n"; | 
|  |  | 
|  | // Loop through all of the timing data, printing it out. | 
|  | for (auto I = Timers.rbegin(), E = Timers.rend(); I != E; ++I) { | 
|  | I->first.print(Total, OS); | 
|  | OS << I->second << '\n'; | 
|  | } | 
|  |  | 
|  | Total.print(Total, OS); | 
|  | OS << "Total\n"; | 
|  | OS << Line << "\n"; | 
|  | OS.flush(); | 
|  | } | 
|  |  | 
|  | static std::unique_ptr<ClangTidyOptionsProvider> createOptionsProvider() { | 
|  | ClangTidyGlobalOptions GlobalOptions; | 
|  | if (std::error_code Err = parseLineFilter(LineFilter, GlobalOptions)) { | 
|  | llvm::errs() << "Invalid LineFilter: " << Err.message() << "\n\nUsage:\n"; | 
|  | llvm::cl::PrintHelpMessage(/*Hidden=*/false, /*Categorized=*/true); | 
|  | return nullptr; | 
|  | } | 
|  |  | 
|  | ClangTidyOptions DefaultOptions; | 
|  | DefaultOptions.Checks = DefaultChecks; | 
|  | DefaultOptions.HeaderFilterRegex = HeaderFilter; | 
|  | DefaultOptions.SystemHeaders = SystemHeaders; | 
|  | DefaultOptions.AnalyzeTemporaryDtors = AnalyzeTemporaryDtors; | 
|  | DefaultOptions.User = llvm::sys::Process::GetEnv("USER"); | 
|  | // USERNAME is used on Windows. | 
|  | if (!DefaultOptions.User) | 
|  | DefaultOptions.User = llvm::sys::Process::GetEnv("USERNAME"); | 
|  |  | 
|  | ClangTidyOptions OverrideOptions; | 
|  | if (Checks.getNumOccurrences() > 0) | 
|  | OverrideOptions.Checks = Checks; | 
|  | if (HeaderFilter.getNumOccurrences() > 0) | 
|  | OverrideOptions.HeaderFilterRegex = HeaderFilter; | 
|  | if (SystemHeaders.getNumOccurrences() > 0) | 
|  | OverrideOptions.SystemHeaders = SystemHeaders; | 
|  | if (AnalyzeTemporaryDtors.getNumOccurrences() > 0) | 
|  | OverrideOptions.AnalyzeTemporaryDtors = AnalyzeTemporaryDtors; | 
|  |  | 
|  | if (!Config.empty()) { | 
|  | if (llvm::ErrorOr<ClangTidyOptions> ParsedConfig = | 
|  | parseConfiguration(Config)) { | 
|  | return llvm::make_unique<DefaultOptionsProvider>( | 
|  | GlobalOptions, ClangTidyOptions::getDefaults() | 
|  | .mergeWith(DefaultOptions) | 
|  | .mergeWith(*ParsedConfig) | 
|  | .mergeWith(OverrideOptions)); | 
|  | } else { | 
|  | llvm::errs() << "Error: invalid configuration specified.\n" | 
|  | << ParsedConfig.getError().message() << "\n"; | 
|  | return nullptr; | 
|  | } | 
|  | } | 
|  | return llvm::make_unique<FileOptionsProvider>(GlobalOptions, DefaultOptions, | 
|  | OverrideOptions); | 
|  | } | 
|  |  | 
|  | static int clangTidyMain(int argc, const char **argv) { | 
|  | CommonOptionsParser OptionsParser(argc, argv, ClangTidyCategory); | 
|  |  | 
|  | auto OptionsProvider = createOptionsProvider(); | 
|  | if (!OptionsProvider) | 
|  | return 1; | 
|  |  | 
|  | std::string FileName = OptionsParser.getSourcePathList().front(); | 
|  | ClangTidyOptions EffectiveOptions = OptionsProvider->getOptions(FileName); | 
|  | std::vector<std::string> EnabledChecks = getCheckNames(EffectiveOptions); | 
|  |  | 
|  | // FIXME: Allow using --list-checks without positional arguments. | 
|  | if (ListChecks) { | 
|  | llvm::outs() << "Enabled checks:"; | 
|  | for (auto CheckName : EnabledChecks) | 
|  | llvm::outs() << "\n    " << CheckName; | 
|  | llvm::outs() << "\n\n"; | 
|  | return 0; | 
|  | } | 
|  |  | 
|  | if (DumpConfig) { | 
|  | EffectiveOptions.CheckOptions = getCheckOptions(EffectiveOptions); | 
|  | llvm::outs() << configurationAsText(ClangTidyOptions::getDefaults() | 
|  | .mergeWith(EffectiveOptions)) | 
|  | << "\n"; | 
|  | return 0; | 
|  | } | 
|  |  | 
|  | if (EnabledChecks.empty()) { | 
|  | llvm::errs() << "Error: no checks enabled.\n"; | 
|  | llvm::cl::PrintHelpMessage(/*Hidden=*/false, /*Categorized=*/true); | 
|  | return 1; | 
|  | } | 
|  |  | 
|  | ProfileData Profile; | 
|  |  | 
|  | std::vector<ClangTidyError> Errors; | 
|  | ClangTidyStats Stats = | 
|  | runClangTidy(std::move(OptionsProvider), OptionsParser.getCompilations(), | 
|  | OptionsParser.getSourcePathList(), &Errors, | 
|  | EnableCheckProfile ? &Profile : nullptr); | 
|  | bool FoundErrors = | 
|  | std::find_if(Errors.begin(), Errors.end(), [](const ClangTidyError &E) { | 
|  | return E.DiagLevel == ClangTidyError::Error; | 
|  | }) != Errors.end(); | 
|  |  | 
|  | const bool DisableFixes = Fix && FoundErrors && !FixErrors; | 
|  |  | 
|  | // -fix-errors implies -fix. | 
|  | handleErrors(Errors, (FixErrors || Fix) && !DisableFixes); | 
|  |  | 
|  | if (!ExportFixes.empty() && !Errors.empty()) { | 
|  | std::error_code EC; | 
|  | llvm::raw_fd_ostream OS(ExportFixes, EC, llvm::sys::fs::F_None); | 
|  | if (EC) { | 
|  | llvm::errs() << "Error opening output file: " << EC.message() << '\n'; | 
|  | return 1; | 
|  | } | 
|  | exportReplacements(Errors, OS); | 
|  | } | 
|  |  | 
|  | printStats(Stats); | 
|  | if (DisableFixes) | 
|  | llvm::errs() | 
|  | << "Found compiler errors, but -fix-errors was not specified.\n" | 
|  | "Fixes have NOT been applied.\n\n"; | 
|  |  | 
|  | if (EnableCheckProfile) | 
|  | printProfileData(Profile, llvm::errs()); | 
|  |  | 
|  | return 0; | 
|  | } | 
|  |  | 
|  | // This anchor is used to force the linker to link the LLVMModule. | 
|  | extern volatile int LLVMModuleAnchorSource; | 
|  | static int LLVM_ATTRIBUTE_UNUSED LLVMModuleAnchorDestination = LLVMModuleAnchorSource; | 
|  |  | 
|  | // This anchor is used to force the linker to link the GoogleModule. | 
|  | extern volatile int GoogleModuleAnchorSource; | 
|  | static int LLVM_ATTRIBUTE_UNUSED GoogleModuleAnchorDestination = GoogleModuleAnchorSource; | 
|  |  | 
|  | // This anchor is used to force the linker to link the MiscModule. | 
|  | extern volatile int MiscModuleAnchorSource; | 
|  | static int LLVM_ATTRIBUTE_UNUSED MiscModuleAnchorDestination = MiscModuleAnchorSource; | 
|  |  | 
|  | // This anchor is used to force the linker to link the ReadabilityModule. | 
|  | extern volatile int ReadabilityModuleAnchorSource; | 
|  | static int LLVM_ATTRIBUTE_UNUSED ReadabilityModuleAnchorDestination = ReadabilityModuleAnchorSource; | 
|  |  | 
|  | } // namespace tidy | 
|  | } // namespace clang | 
|  |  | 
|  | int main(int argc, const char **argv) { | 
|  | return clang::tidy::clangTidyMain(argc, argv); | 
|  | } |