1 //===--- CommonOptionsParser.cpp - common options for clang tools ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the CommonOptionsParser class used to parse common
11 // command-line options for clang tools, so that they can be run as separate
12 // command-line applications with a consistent common interface for handling
13 // compilation database and input files.
15 // It provides a common subset of command-line options, common algorithm
16 // for locating a compilation database and source files, and help messages
17 // for the basic command-line interface.
19 // It creates a CompilationDatabase and reads common command-line options.
21 // This class uses the Clang Tooling infrastructure, see
22 // http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html
23 // for details on setting it up with LLVM source tree.
25 //===----------------------------------------------------------------------===//
27 #include "llvm/Support/CommandLine.h"
28 #include "clang/Tooling/ArgumentsAdjusters.h"
29 #include "clang/Tooling/CommonOptionsParser.h"
30 #include "clang/Tooling/Tooling.h"
32 using namespace clang::tooling;
35 const char *const CommonOptionsParser::HelpMessage =
37 "-p <build-path> is used to read a compile command database.\n"
39 "\tFor example, it can be a CMake build directory in which a file named\n"
40 "\tcompile_commands.json exists (use -DCMAKE_EXPORT_COMPILE_COMMANDS=ON\n"
41 "\tCMake option to get this output). When no build path is specified,\n"
42 "\ta search for compile_commands.json will be attempted through all\n"
43 "\tparent paths of the first input file . See:\n"
44 "\thttp://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an\n"
45 "\texample of setting up Clang Tooling on a source tree.\n"
47 "<source0> ... specify the paths of source files. These paths are\n"
48 "\tlooked up in the compile command database. If the path of a file is\n"
49 "\tabsolute, it needs to point into CMake's source tree. If the path is\n"
50 "\trelative, the current working directory needs to be in the CMake\n"
51 "\tsource tree and the file must be in a subdirectory of the current\n"
52 "\tworking directory. \"./\" prefixes in the relative files will be\n"
53 "\tautomatically removed, but the rest of a relative path must be a\n"
54 "\tsuffix of a path in the compile command database.\n"
57 class ArgumentsAdjustingCompilations : public CompilationDatabase {
59 ArgumentsAdjustingCompilations(
60 std::unique_ptr<CompilationDatabase> Compilations)
61 : Compilations(std::move(Compilations)) {}
63 void appendArgumentsAdjuster(ArgumentsAdjuster Adjuster) {
64 Adjusters.push_back(Adjuster);
67 std::vector<CompileCommand>
68 getCompileCommands(StringRef FilePath) const override {
69 return adjustCommands(Compilations->getCompileCommands(FilePath));
72 std::vector<std::string> getAllFiles() const override {
73 return Compilations->getAllFiles();
76 std::vector<CompileCommand> getAllCompileCommands() const override {
77 return adjustCommands(Compilations->getAllCompileCommands());
81 std::unique_ptr<CompilationDatabase> Compilations;
82 std::vector<ArgumentsAdjuster> Adjusters;
84 std::vector<CompileCommand>
85 adjustCommands(std::vector<CompileCommand> Commands) const {
86 for (CompileCommand &Command : Commands)
87 for (const auto &Adjuster : Adjusters)
88 Command.CommandLine = Adjuster(Command.CommandLine);
93 CommonOptionsParser::CommonOptionsParser(int &argc, const char **argv,
94 cl::OptionCategory &Category,
95 const char *Overview) {
96 static cl::opt<bool> Help("h", cl::desc("Alias for -help"), cl::Hidden);
98 static cl::opt<std::string> BuildPath("p", cl::desc("Build path"),
99 cl::Optional, cl::cat(Category));
101 static cl::list<std::string> SourcePaths(
102 cl::Positional, cl::desc("<source0> [... <sourceN>]"), cl::OneOrMore,
105 static cl::list<std::string> ArgsAfter(
107 cl::desc("Additional argument to append to the compiler command line"),
110 static cl::list<std::string> ArgsBefore(
112 cl::desc("Additional argument to prepend to the compiler command line"),
115 // Hide unrelated options.
116 StringMap<cl::Option*> Options;
117 cl::getRegisteredOptions(Options);
118 for (StringMap<cl::Option *>::iterator I = Options.begin(), E = Options.end();
120 if (I->second->Category != &Category && I->first() != "help" &&
121 I->first() != "version")
122 I->second->setHiddenFlag(cl::ReallyHidden);
125 Compilations.reset(FixedCompilationDatabase::loadFromCommandLine(argc,
127 cl::ParseCommandLineOptions(argc, argv, Overview);
128 SourcePathList = SourcePaths;
130 std::string ErrorMessage;
131 if (!BuildPath.empty()) {
133 CompilationDatabase::autoDetectFromDirectory(BuildPath, ErrorMessage);
135 Compilations = CompilationDatabase::autoDetectFromSource(SourcePaths[0],
139 llvm::report_fatal_error(ErrorMessage);
141 auto AdjustingCompilations =
142 llvm::make_unique<ArgumentsAdjustingCompilations>(
143 std::move(Compilations));
144 AdjustingCompilations->appendArgumentsAdjuster(
145 getInsertArgumentAdjuster(ArgsBefore, ArgumentInsertPosition::BEGIN));
146 AdjustingCompilations->appendArgumentsAdjuster(
147 getInsertArgumentAdjuster(ArgsAfter, ArgumentInsertPosition::END));
148 Compilations = std::move(AdjustingCompilations);