LLVM  10.0.0svn
ArgList.cpp
Go to the documentation of this file.
1 //===- ArgList.cpp - Argument List Management -----------------------------===//
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 #include "llvm/ADT/ArrayRef.h"
10 #include "llvm/ADT/None.h"
11 #include "llvm/ADT/SmallVector.h"
12 #include "llvm/ADT/STLExtras.h"
13 #include "llvm/ADT/StringRef.h"
14 #include "llvm/ADT/Twine.h"
15 #include "llvm/Config/llvm-config.h"
16 #include "llvm/Option/Arg.h"
17 #include "llvm/Option/ArgList.h"
18 #include "llvm/Option/Option.h"
20 #include "llvm/Support/Compiler.h"
21 #include "llvm/Support/Debug.h"
23 #include <algorithm>
24 #include <cassert>
25 #include <memory>
26 #include <string>
27 #include <utility>
28 #include <vector>
29 
30 using namespace llvm;
31 using namespace llvm::opt;
32 
33 void ArgList::append(Arg *A) {
34  Args.push_back(A);
35 
36  // Update ranges for the option and all of its groups.
37  for (Option O = A->getOption().getUnaliasedOption(); O.isValid();
38  O = O.getGroup()) {
39  auto &R =
40  OptRanges.insert(std::make_pair(O.getID(), emptyRange())).first->second;
41  R.first = std::min<unsigned>(R.first, Args.size() - 1);
42  R.second = Args.size();
43  }
44 }
45 
47  // Zero out the removed entries but keep them around so that we don't
48  // need to invalidate OptRanges.
49  for (Arg *const &A : filtered(Id)) {
50  // Avoid the need for a non-const filtered iterator variant.
51  Arg **ArgsBegin = Args.data();
52  ArgsBegin[&A - ArgsBegin] = nullptr;
53  }
54  OptRanges.erase(Id.getID());
55 }
56 
57 ArgList::OptRange
58 ArgList::getRange(std::initializer_list<OptSpecifier> Ids) const {
59  OptRange R = emptyRange();
60  for (auto Id : Ids) {
61  auto I = OptRanges.find(Id.getID());
62  if (I != OptRanges.end()) {
63  R.first = std::min(R.first, I->second.first);
64  R.second = std::max(R.second, I->second.second);
65  }
66  }
67  // Map an empty {-1, 0} range to {0, 0} so it can be used to form iterators.
68  if (R.first == -1u)
69  R.first = 0;
70  return R;
71 }
72 
73 bool ArgList::hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default) const {
74  if (Arg *A = getLastArg(Pos, Neg))
75  return A->getOption().matches(Pos);
76  return Default;
77 }
78 
80  bool Default) const {
81  if (Arg *A = getLastArg(Pos, PosAlias, Neg))
82  return A->getOption().matches(Pos) || A->getOption().matches(PosAlias);
83  return Default;
84 }
85 
87  if (Arg *A = getLastArg(Id))
88  return A->getValue();
89  return Default;
90 }
91 
92 std::vector<std::string> ArgList::getAllArgValues(OptSpecifier Id) const {
94  AddAllArgValues(Values, Id);
95  return std::vector<std::string>(Values.begin(), Values.end());
96 }
97 
100  ArrayRef<OptSpecifier> ExcludeIds) const {
101  for (const Arg *Arg : *this) {
102  bool Excluded = false;
103  for (OptSpecifier Id : ExcludeIds) {
104  if (Arg->getOption().matches(Id)) {
105  Excluded = true;
106  break;
107  }
108  }
109  if (!Excluded) {
110  for (OptSpecifier Id : Ids) {
111  if (Arg->getOption().matches(Id)) {
112  Arg->claim();
113  Arg->render(*this, Output);
114  break;
115  }
116  }
117  }
118  }
119 }
120 
121 /// This is a nicer interface when you don't have a list of Ids to exclude.
123  ArrayRef<OptSpecifier> Ids) const {
124  ArrayRef<OptSpecifier> Exclude = None;
125  AddAllArgsExcept(Output, Ids, Exclude);
126 }
127 
128 /// This 3-opt variant of AddAllArgs could be eliminated in favor of one
129 /// that accepts a single specifier, given the above which accepts any number.
131  OptSpecifier Id1, OptSpecifier Id2) const {
132  for (auto Arg: filtered(Id0, Id1, Id2)) {
133  Arg->claim();
134  Arg->render(*this, Output);
135  }
136 }
137 
139  OptSpecifier Id1, OptSpecifier Id2) const {
140  for (auto Arg : filtered(Id0, Id1, Id2)) {
141  Arg->claim();
142  const auto &Values = Arg->getValues();
143  Output.append(Values.begin(), Values.end());
144  }
145 }
146 
148  const char *Translation,
149  bool Joined) const {
150  for (auto Arg: filtered(Id0)) {
151  Arg->claim();
152 
153  if (Joined) {
154  Output.push_back(MakeArgString(StringRef(Translation) +
155  Arg->getValue(0)));
156  } else {
157  Output.push_back(Translation);
158  Output.push_back(Arg->getValue(0));
159  }
160  }
161 }
162 
164  for (auto *Arg : filtered(Id0))
165  Arg->claim();
166 }
167 
168 void ArgList::ClaimAllArgs() const {
169  for (auto *Arg : *this)
170  if (!Arg->isClaimed())
171  Arg->claim();
172 }
173 
175  StringRef LHS,
176  StringRef RHS) const {
177  StringRef Cur = getArgString(Index);
178  if (Cur.size() == LHS.size() + RHS.size() &&
179  Cur.startswith(LHS) && Cur.endswith(RHS))
180  return Cur.data();
181 
182  return MakeArgString(LHS + RHS);
183 }
184 
186  for (Arg *A : *this) {
187  O << "* ";
188  A->print(O);
189  }
190 }
191 
192 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
194 #endif
195 
196 void InputArgList::releaseMemory() {
197  // An InputArgList always owns its arguments.
198  for (Arg *A : *this)
199  delete A;
200 }
201 
202 InputArgList::InputArgList(const char* const *ArgBegin,
203  const char* const *ArgEnd)
204  : NumInputArgStrings(ArgEnd - ArgBegin) {
205  ArgStrings.append(ArgBegin, ArgEnd);
206 }
207 
208 unsigned InputArgList::MakeIndex(StringRef String0) const {
209  unsigned Index = ArgStrings.size();
210 
211  // Tuck away so we have a reliable const char *.
212  SynthesizedStrings.push_back(String0);
213  ArgStrings.push_back(SynthesizedStrings.back().c_str());
214 
215  return Index;
216 }
217 
219  StringRef String1) const {
220  unsigned Index0 = MakeIndex(String0);
221  unsigned Index1 = MakeIndex(String1);
222  assert(Index0 + 1 == Index1 && "Unexpected non-consecutive indices!");
223  (void) Index1;
224  return Index0;
225 }
226 
228  return getArgString(MakeIndex(Str));
229 }
230 
232  : BaseArgs(BaseArgs) {}
233 
235  return BaseArgs.MakeArgString(Str);
236 }
237 
239  SynthesizedArgs.push_back(std::unique_ptr<Arg>(A));
240 }
241 
242 Arg *DerivedArgList::MakeFlagArg(const Arg *BaseArg, const Option Opt) const {
243  SynthesizedArgs.push_back(
244  std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
245  BaseArgs.MakeIndex(Opt.getName()), BaseArg));
246  return SynthesizedArgs.back().get();
247 }
248 
249 Arg *DerivedArgList::MakePositionalArg(const Arg *BaseArg, const Option Opt,
250  StringRef Value) const {
251  unsigned Index = BaseArgs.MakeIndex(Value);
252  SynthesizedArgs.push_back(
253  std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
254  Index, BaseArgs.getArgString(Index), BaseArg));
255  return SynthesizedArgs.back().get();
256 }
257 
258 Arg *DerivedArgList::MakeSeparateArg(const Arg *BaseArg, const Option Opt,
259  StringRef Value) const {
260  unsigned Index = BaseArgs.MakeIndex(Opt.getName(), Value);
261  SynthesizedArgs.push_back(
262  std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
263  Index, BaseArgs.getArgString(Index + 1), BaseArg));
264  return SynthesizedArgs.back().get();
265 }
266 
267 Arg *DerivedArgList::MakeJoinedArg(const Arg *BaseArg, const Option Opt,
268  StringRef Value) const {
269  unsigned Index = BaseArgs.MakeIndex((Opt.getName() + Value).str());
270  SynthesizedArgs.push_back(std::make_unique<Arg>(
271  Opt, MakeArgString(Opt.getPrefix() + Opt.getName()), Index,
272  BaseArgs.getArgString(Index) + Opt.getName().size(), BaseArg));
273  return SynthesizedArgs.back().get();
274 }
const NoneType None
Definition: None.h:23
LLVM_NODISCARD bool endswith(StringRef Suffix) const
Check if this string ends with the given Suffix.
Definition: StringRef.h:281
StringRef getPrefix() const
Get the default prefix for this option.
Definition: Option.h:126
This class represents lattice values for constants.
Definition: AllocatorList.h:23
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds...
Definition: Compiler.h:484
void print(raw_ostream &O) const
Definition: Arg.cpp:47
const Option getUnaliasedOption() const
getUnaliasedOption - Return the final option this option aliases (itself, if the option has no alias)...
Definition: Option.h:176
LLVM_NODISCARD bool startswith(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition: StringRef.h:270
void push_back(const T &Elt)
Definition: SmallVector.h:211
iterator_range< filtered_iterator< sizeof...(OptSpecifiers)> > filtered(OptSpecifiers ...Ids) const
Definition: ArgList.h:205
void eraseArg(OptSpecifier Id)
eraseArg - Remove any option matching Id.
Definition: ArgList.cpp:46
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition: DenseMap.h:195
const char * getArgString(unsigned Index) const override
getArgString - Return the input argument string at Index.
Definition: ArgList.h:411
const Option & getOption() const
Definition: Arg.h:77
Arg * MakeFlagArg(const Arg *BaseArg, const Option Opt) const
MakeFlagArg - Construct a new FlagArg for the given option Id.
Definition: ArgList.cpp:242
unsigned getID() const
Definition: OptSpecifier.h:29
SmallVectorImpl< const char * > & getValues()
Definition: Arg.h:117
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:144
void AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0, const char *Translation, bool Joined=false) const
AddAllArgsTranslated - Render all the arguments matching the given ids, but forced to separate args a...
Definition: ArgList.cpp:147
Arg * MakeJoinedArg(const Arg *BaseArg, const Option Opt, StringRef Value) const
MakeJoinedArg - Construct a new Positional arg for the given option Id, with the provided Value...
Definition: ArgList.cpp:267
iterator find(const_arg_type_t< KeyT > Val)
Definition: DenseMap.h:150
void AddSynthesizedArg(Arg *A)
AddSynthesizedArg - Add a argument to the list of synthesized arguments (to be freed).
Definition: ArgList.cpp:238
bool erase(const KeyT &Val)
Definition: DenseMap.h:272
const char * MakeArgStringRef(StringRef Str) const override
Construct a constant string pointer whose lifetime will match that of the ArgList.
Definition: ArgList.cpp:234
Option - Abstract representation for a single form of driver argument.
Definition: Option.h:51
Definition: Arg.h:26
StringRef getName() const
Get the name of this option without any prefix.
Definition: Option.h:98
bool matches(OptSpecifier ID) const
matches - Predicate for whether this option is part of the given option (which may be a group)...
Definition: Option.cpp:93
void AddAllArgs(ArgStringList &Output, ArrayRef< OptSpecifier > Ids) const
AddAllArgs - Render all arguments matching any of the given ids.
Definition: ArgList.cpp:122
Arg * MakeSeparateArg(const Arg *BaseArg, const Option Opt, StringRef Value) const
MakeSeparateArg - Construct a new Positional arg for the given option Id, with the provided Value...
Definition: ArgList.cpp:258
A concrete instance of a particular driver option.
Definition: Arg.h:34
bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const
hasFlag - Given an option Pos and its negative form Neg, return true if the option is present...
Definition: ArgList.cpp:73
DerivedArgList(const InputArgList &BaseArgs)
Construct a new derived arg list from BaseArgs.
Definition: ArgList.cpp:231
const char * MakeArgString(const Twine &Str) const
Definition: ArgList.h:352
const char * GetOrMakeJoinedArgString(unsigned Index, StringRef LHS, StringRef RHS) const
Create an arg string for (LHS + RHS), reusing the string at Index if possible.
Definition: ArgList.cpp:174
size_t size() const
Definition: SmallVector.h:52
Arg * getLastArg(OptSpecifiers ...Ids) const
Return the last argument matching Id, or null.
Definition: ArgList.h:250
void claim() const
Set the Arg claimed bit.
Definition: Arg.h:109
Align max(MaybeAlign Lhs, Align Rhs)
Definition: Alignment.h:390
virtual const char * getArgString(unsigned Index) const =0
getArgString - Return the input argument string at Index.
unsigned MakeIndex(StringRef String0) const
MakeIndex - Get an index for the given string(s).
Definition: ArgList.cpp:208
Arg * MakePositionalArg(const Arg *BaseArg, const Option Opt, StringRef Value) const
MakePositionalArg - Construct a new Positional arg for the given option Id, with the provided Value...
Definition: ArgList.cpp:249
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
Defines the llvm::Arg class for parsed arguments.
std::vector< std::string > getAllArgValues(OptSpecifier Id) const
getAllArgValues - Get the values of all instances of the given argument as strings.
Definition: ArgList.cpp:92
void append(in_iter in_start, in_iter in_end)
Add the specified range to the end of the SmallVector.
Definition: SmallVector.h:387
StringRef getLastArgValue(OptSpecifier Id, StringRef Default="") const
getLastArgValue - Return the value of the last argument, or a default.
Definition: ArgList.cpp:86
void append(Arg *A)
append - Append A to the arg list.
Definition: ArgList.cpp:33
OptSpecifier - Wrapper class for abstracting references to option IDs.
Definition: OptSpecifier.h:18
void dump() const
Definition: ArgList.cpp:193
pointer data()
Return a pointer to the vector&#39;s buffer, even if empty().
Definition: SmallVector.h:144
#define I(x, y, z)
Definition: MD5.cpp:58
iterator end()
Definition: DenseMap.h:82
void AddAllArgsExcept(ArgStringList &Output, ArrayRef< OptSpecifier > Ids, ArrayRef< OptSpecifier > ExcludeIds) const
AddAllArgsExcept - Render all arguments matching any of the given ids and not matching any of the exc...
Definition: ArgList.cpp:98
void AddAllArgValues(ArgStringList &Output, OptSpecifier Id0, OptSpecifier Id1=0U, OptSpecifier Id2=0U) const
AddAllArgValues - Render the argument values of all arguments matching the given ids.
Definition: ArgList.cpp:138
void render(const ArgList &Args, ArgStringList &Output) const
Append the argument onto the given array as strings.
Definition: Arg.cpp:96
void ClaimAllArgs() const
ClaimAllArgs - Claim all arguments.
Definition: ArgList.cpp:168
LLVM_NODISCARD const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:136
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
LLVM Value Representation.
Definition: Value.h:74
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
const char * MakeArgStringRef(StringRef Str) const override
Construct a constant string pointer whose lifetime will match that of the ArgList.
Definition: ArgList.cpp:227
const char * getValue(unsigned N=0) const
Definition: Arg.h:113
void print(raw_ostream &O) const
Definition: ArgList.cpp:185
bool isClaimed() const
Definition: Arg.h:106