Coverage Report

Created: 2021-08-24 07:12

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Tooling/CommonOptionsParser.cpp
Line
Count
Source (jump to first uncovered line)
1
//===--- CommonOptionsParser.cpp - common options for clang tools ---------===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
//
9
//  This file implements the CommonOptionsParser class used to parse common
10
//  command-line options for clang tools, so that they can be run as separate
11
//  command-line applications with a consistent common interface for handling
12
//  compilation database and input files.
13
//
14
//  It provides a common subset of command-line options, common algorithm
15
//  for locating a compilation database and source files, and help messages
16
//  for the basic command-line interface.
17
//
18
//  It creates a CompilationDatabase and reads common command-line options.
19
//
20
//  This class uses the Clang Tooling infrastructure, see
21
//    http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html
22
//  for details on setting it up with LLVM source tree.
23
//
24
//===----------------------------------------------------------------------===//
25
26
#include "clang/Tooling/CommonOptionsParser.h"
27
#include "clang/Tooling/Tooling.h"
28
#include "llvm/Support/CommandLine.h"
29
30
using namespace clang::tooling;
31
using namespace llvm;
32
33
const char *const CommonOptionsParser::HelpMessage =
34
    "\n"
35
    "-p <build-path> is used to read a compile command database.\n"
36
    "\n"
37
    "\tFor example, it can be a CMake build directory in which a file named\n"
38
    "\tcompile_commands.json exists (use -DCMAKE_EXPORT_COMPILE_COMMANDS=ON\n"
39
    "\tCMake option to get this output). When no build path is specified,\n"
40
    "\ta search for compile_commands.json will be attempted through all\n"
41
    "\tparent paths of the first input file . See:\n"
42
    "\thttps://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an\n"
43
    "\texample of setting up Clang Tooling on a source tree.\n"
44
    "\n"
45
    "<source0> ... specify the paths of source files. These paths are\n"
46
    "\tlooked up in the compile command database. If the path of a file is\n"
47
    "\tabsolute, it needs to point into CMake's source tree. If the path is\n"
48
    "\trelative, the current working directory needs to be in the CMake\n"
49
    "\tsource tree and the file must be in a subdirectory of the current\n"
50
    "\tworking directory. \"./\" prefixes in the relative files will be\n"
51
    "\tautomatically removed, but the rest of a relative path must be a\n"
52
    "\tsuffix of a path in the compile command database.\n"
53
    "\n";
54
55
void ArgumentsAdjustingCompilations::appendArgumentsAdjuster(
56
207
    ArgumentsAdjuster Adjuster) {
57
207
  Adjusters.push_back(std::move(Adjuster));
58
207
}
59
60
std::vector<CompileCommand> ArgumentsAdjustingCompilations::getCompileCommands(
61
213
    StringRef FilePath) const {
62
213
  return adjustCommands(Compilations->getCompileCommands(FilePath));
63
213
}
64
65
std::vector<std::string>
66
0
ArgumentsAdjustingCompilations::getAllFiles() const {
67
0
  return Compilations->getAllFiles();
68
0
}
69
70
std::vector<CompileCommand>
71
54
ArgumentsAdjustingCompilations::getAllCompileCommands() const {
72
54
  return adjustCommands(Compilations->getAllCompileCommands());
73
54
}
74
75
std::vector<CompileCommand> ArgumentsAdjustingCompilations::adjustCommands(
76
267
    std::vector<CompileCommand> Commands) const {
77
267
  for (CompileCommand &Command : Commands)
78
368
    for (const auto &Adjuster : Adjusters)
79
385
      Command.CommandLine = Adjuster(Command.CommandLine, Command.Filename);
80
267
  return Commands;
81
267
}
82
83
llvm::Error CommonOptionsParser::init(
84
    int &argc, const char **argv, cl::OptionCategory &Category,
85
133
    llvm::cl::NumOccurrencesFlag OccurrencesFlag, const char *Overview) {
86
87
133
  static cl::opt<std::string> BuildPath("p", cl::desc("Build path"),
88
133
                                        cl::Optional, cl::cat(Category),
89
133
                                        cl::sub(*cl::AllSubCommands));
90
91
133
  static cl::list<std::string> SourcePaths(
92
133
      cl::Positional, cl::desc("<source0> [... <sourceN>]"), OccurrencesFlag,
93
133
      cl::cat(Category), cl::sub(*cl::AllSubCommands));
94
95
133
  static cl::list<std::string> ArgsAfter(
96
133
      "extra-arg",
97
133
      cl::desc("Additional argument to append to the compiler command line"),
98
133
      cl::cat(Category), cl::sub(*cl::AllSubCommands));
99
100
133
  static cl::list<std::string> ArgsBefore(
101
133
      "extra-arg-before",
102
133
      cl::desc("Additional argument to prepend to the compiler command line"),
103
133
      cl::cat(Category), cl::sub(*cl::AllSubCommands));
104
105
133
  cl::ResetAllOptionOccurrences();
106
107
133
  cl::HideUnrelatedOptions(Category);
108
109
133
  std::string ErrorMessage;
110
133
  Compilations =
111
133
      FixedCompilationDatabase::loadFromCommandLine(argc, argv, ErrorMessage);
112
133
  if (!ErrorMessage.empty())
113
0
    ErrorMessage.append("\n");
114
133
  llvm::raw_string_ostream OS(ErrorMessage);
115
  // Stop initializing if command-line option parsing failed.
116
133
  if (!cl::ParseCommandLineOptions(argc, argv, Overview, &OS)) {
117
1
    OS.flush();
118
1
    return llvm::make_error<llvm::StringError>(ErrorMessage,
119
1
                                               llvm::inconvertibleErrorCode());
120
1
  }
121
122
132
  cl::PrintOptionValues();
123
124
132
  SourcePathList = SourcePaths;
125
132
  if ((OccurrencesFlag == cl::ZeroOrMore || 
OccurrencesFlag == cl::Optional109
) &&
126
132
      
SourcePathList.empty()23
)
127
1
    return llvm::Error::success();
128
131
  if (!Compilations) {
129
22
    if (!BuildPath.empty()) {
130
9
      Compilations =
131
9
          CompilationDatabase::autoDetectFromDirectory(BuildPath, ErrorMessage);
132
13
    } else {
133
13
      Compilations = CompilationDatabase::autoDetectFromSource(SourcePaths[0],
134
13
                                                               ErrorMessage);
135
13
    }
136
22
    if (!Compilations) {
137
2
      llvm::errs() << "Error while trying to load a compilation database:\n"
138
2
                   << ErrorMessage << "Running without flags.\n";
139
2
      Compilations.reset(
140
2
          new FixedCompilationDatabase(".", std::vector<std::string>()));
141
2
    }
142
22
  }
143
131
  auto AdjustingCompilations =
144
131
      std::make_unique<ArgumentsAdjustingCompilations>(
145
131
          std::move(Compilations));
146
131
  Adjuster =
147
131
      getInsertArgumentAdjuster(ArgsBefore, ArgumentInsertPosition::BEGIN);
148
131
  Adjuster = combineAdjusters(
149
131
      std::move(Adjuster),
150
131
      getInsertArgumentAdjuster(ArgsAfter, ArgumentInsertPosition::END));
151
131
  AdjustingCompilations->appendArgumentsAdjuster(Adjuster);
152
131
  Compilations = std::move(AdjustingCompilations);
153
131
  return llvm::Error::success();
154
132
}
155
156
llvm::Expected<CommonOptionsParser> CommonOptionsParser::create(
157
    int &argc, const char **argv, llvm::cl::OptionCategory &Category,
158
133
    llvm::cl::NumOccurrencesFlag OccurrencesFlag, const char *Overview) {
159
133
  CommonOptionsParser Parser;
160
133
  llvm::Error Err =
161
133
      Parser.init(argc, argv, Category, OccurrencesFlag, Overview);
162
133
  if (Err)
163
1
    return std::move(Err);
164
132
  return std::move(Parser);
165
133
}
166
167
CommonOptionsParser::CommonOptionsParser(
168
    int &argc, const char **argv, cl::OptionCategory &Category,
169
0
    llvm::cl::NumOccurrencesFlag OccurrencesFlag, const char *Overview) {
170
0
  llvm::Error Err = init(argc, argv, Category, OccurrencesFlag, Overview);
171
0
  if (Err) {
172
0
    llvm::report_fatal_error(
173
0
        "CommonOptionsParser: failed to parse command-line arguments. " +
174
0
        llvm::toString(std::move(Err)));
175
0
  }
176
0
}