CommonOptionsParser.cpp revision 288943 
1//===--- CommonOptionsParser.cpp - common options for clang tools ---------===//
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 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.
14//
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.
18//
19//  It creates a CompilationDatabase and reads common command-line options.
20//
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.
24//
25//===----------------------------------------------------------------------===//
26
27#include "llvm/Support/CommandLine.h"
28#include "clang/Tooling/ArgumentsAdjusters.h"
29#include "clang/Tooling/CommonOptionsParser.h"
30#include "clang/Tooling/Tooling.h"
31
32using namespace clang::tooling;
33using namespace llvm;
34
35const char *const CommonOptionsParser::HelpMessage =
36    "\n"
37    "-p <build-path> is used to read a compile command database.\n"
38    "\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"
46    "\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"
55    "\n";
56
57namespace {
58class ArgumentsAdjustingCompilations : public CompilationDatabase {
59public:
60  ArgumentsAdjustingCompilations(
61      std::unique_ptr<CompilationDatabase> Compilations)
62      : Compilations(std::move(Compilations)) {}
63
64  void appendArgumentsAdjuster(ArgumentsAdjuster Adjuster) {
65    Adjusters.push_back(Adjuster);
66  }
67
68  std::vector<CompileCommand>
69  getCompileCommands(StringRef FilePath) const override {
70    return adjustCommands(Compilations->getCompileCommands(FilePath));
71  }
72
73  std::vector<std::string> getAllFiles() const override {
74    return Compilations->getAllFiles();
75  }
76
77  std::vector<CompileCommand> getAllCompileCommands() const override {
78    return adjustCommands(Compilations->getAllCompileCommands());
79  }
80
81private:
82  std::unique_ptr<CompilationDatabase> Compilations;
83  std::vector<ArgumentsAdjuster> Adjusters;
84
85  std::vector<CompileCommand>
86  adjustCommands(std::vector<CompileCommand> Commands) const {
87    for (CompileCommand &Command : Commands)
88      for (const auto &Adjuster : Adjusters)
89        Command.CommandLine = Adjuster(Command.CommandLine);
90    return Commands;
91  }
92};
93} // namespace
94
95CommonOptionsParser::CommonOptionsParser(int &argc, const char **argv,
96                                         cl::OptionCategory &Category,
97                                         const char *Overview) {
98  static cl::opt<bool> Help("h", cl::desc("Alias for -help"), cl::Hidden);
99
100  static cl::opt<std::string> BuildPath("p", cl::desc("Build path"),
101                                        cl::Optional, cl::cat(Category));
102
103  static cl::list<std::string> SourcePaths(
104      cl::Positional, cl::desc("<source0> [... <sourceN>]"), cl::OneOrMore,
105      cl::cat(Category));
106
107  static cl::list<std::string> ArgsAfter(
108      "extra-arg",
109      cl::desc("Additional argument to append to the compiler command line"),
110      cl::cat(Category));
111
112  static cl::list<std::string> ArgsBefore(
113      "extra-arg-before",
114      cl::desc("Additional argument to prepend to the compiler command line"),
115      cl::cat(Category));
116
117  cl::HideUnrelatedOptions(Category);
118
119  Compilations.reset(FixedCompilationDatabase::loadFromCommandLine(argc,
120                                                                   argv));
121  cl::ParseCommandLineOptions(argc, argv, Overview);
122  SourcePathList = SourcePaths;
123  if (!Compilations) {
124    std::string ErrorMessage;
125    if (!BuildPath.empty()) {
126      Compilations =
127          CompilationDatabase::autoDetectFromDirectory(BuildPath, ErrorMessage);
128    } else {
129      Compilations = CompilationDatabase::autoDetectFromSource(SourcePaths[0],
130                                                               ErrorMessage);
131    }
132    if (!Compilations)
133      llvm::report_fatal_error(ErrorMessage);
134  }
135  auto AdjustingCompilations =
136      llvm::make_unique<ArgumentsAdjustingCompilations>(
137          std::move(Compilations));
138  AdjustingCompilations->appendArgumentsAdjuster(
139      getInsertArgumentAdjuster(ArgsBefore, ArgumentInsertPosition::BEGIN));
140  AdjustingCompilations->appendArgumentsAdjuster(
141      getInsertArgumentAdjuster(ArgsAfter, ArgumentInsertPosition::END));
142  Compilations = std::move(AdjustingCompilations);
143}
144