1 //===--- ArgList.h - Argument List Management -------------------*- C++ -*-===//
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 #ifndef LLVM_OPTION_ARGLIST_H
11 #define LLVM_OPTION_ARGLIST_H
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/ADT/StringRef.h"
16 #include "llvm/ADT/Twine.h"
17 #include "llvm/Option/Arg.h"
18 #include "llvm/Option/OptSpecifier.h"
19 #include "llvm/Option/Option.h"
30 /// arg_iterator - Iterates through arguments stored inside an ArgList.
32 /// The current argument.
33 SmallVectorImpl<Arg*>::const_iterator Current;
35 /// The argument list we are iterating over.
38 /// Optional filters on the arguments which will be match. Most clients
39 /// should never want to iterate over arguments without filters, so we won't
40 /// bother to factor this into two separate iterator implementations.
42 // FIXME: Make efficient; the idea is to provide efficient iteration over
43 // all arguments which match a particular id and then just provide an
44 // iterator combinator which takes multiple iterators which can be
45 // efficiently compared and returns them in order.
46 OptSpecifier Id0, Id1, Id2;
51 typedef Arg * const * value_type;
52 typedef Arg * const & reference;
53 typedef Arg * const * pointer;
54 typedef std::forward_iterator_tag iterator_category;
55 typedef std::ptrdiff_t difference_type;
57 arg_iterator(SmallVectorImpl<Arg *>::const_iterator it, const ArgList &Args,
58 OptSpecifier Id0 = 0U, OptSpecifier Id1 = 0U,
59 OptSpecifier Id2 = 0U)
60 : Current(it), Args(Args), Id0(Id0), Id1(Id1), Id2(Id2) {
64 operator const Arg*() { return *Current; }
65 reference operator*() const { return *Current; }
66 pointer operator->() const { return Current; }
68 arg_iterator &operator++() {
74 arg_iterator operator++(int) {
75 arg_iterator tmp(*this);
80 friend bool operator==(arg_iterator LHS, arg_iterator RHS) {
81 return LHS.Current == RHS.Current;
83 friend bool operator!=(arg_iterator LHS, arg_iterator RHS) {
88 /// ArgList - Ordered collection of driver arguments.
90 /// The ArgList class manages a list of Arg instances as well as
91 /// auxiliary data and convenience methods to allow Tools to quickly
92 /// check for the presence of Arg instances for a particular Option
93 /// and to iterate over groups of arguments.
96 ArgList(const ArgList &) = delete;
97 void operator=(const ArgList &) = delete;
100 typedef SmallVector<Arg*, 16> arglist_type;
101 typedef arglist_type::iterator iterator;
102 typedef arglist_type::const_iterator const_iterator;
103 typedef arglist_type::reverse_iterator reverse_iterator;
104 typedef arglist_type::const_reverse_iterator const_reverse_iterator;
107 /// The internal list of arguments.
111 // Default ctor provided explicitly as it is not provided implicitly due to
112 // the presence of the (deleted) copy ctor above.
114 // Protect the dtor to ensure this type is never destroyed polymorphically.
115 ~ArgList() = default;
122 /// append - Append \p A to the arg list.
125 arglist_type &getArgs() { return Args; }
126 const arglist_type &getArgs() const { return Args; }
128 unsigned size() const { return Args.size(); }
131 /// @name Arg Iteration
134 iterator begin() { return Args.begin(); }
135 iterator end() { return Args.end(); }
137 reverse_iterator rbegin() { return Args.rbegin(); }
138 reverse_iterator rend() { return Args.rend(); }
140 const_iterator begin() const { return Args.begin(); }
141 const_iterator end() const { return Args.end(); }
143 const_reverse_iterator rbegin() const { return Args.rbegin(); }
144 const_reverse_iterator rend() const { return Args.rend(); }
146 arg_iterator filtered_begin(OptSpecifier Id0 = 0U, OptSpecifier Id1 = 0U,
147 OptSpecifier Id2 = 0U) const {
148 return arg_iterator(Args.begin(), *this, Id0, Id1, Id2);
150 arg_iterator filtered_end() const {
151 return arg_iterator(Args.end(), *this);
154 iterator_range<arg_iterator> filtered(OptSpecifier Id0 = 0U,
155 OptSpecifier Id1 = 0U,
156 OptSpecifier Id2 = 0U) const {
157 return make_range(filtered_begin(Id0, Id1, Id2), filtered_end());
161 /// @name Arg Removal
164 /// eraseArg - Remove any option matching \p Id.
165 void eraseArg(OptSpecifier Id);
171 /// hasArg - Does the arg list contain any option matching \p Id.
173 /// \p Claim Whether the argument should be claimed, if it exists.
174 bool hasArgNoClaim(OptSpecifier Id) const {
175 return getLastArgNoClaim(Id) != nullptr;
177 bool hasArg(OptSpecifier Id) const {
178 return getLastArg(Id) != nullptr;
180 bool hasArg(OptSpecifier Id0, OptSpecifier Id1) const {
181 return getLastArg(Id0, Id1) != nullptr;
183 bool hasArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const {
184 return getLastArg(Id0, Id1, Id2) != nullptr;
187 /// getLastArg - Return the last argument matching \p Id, or null.
189 /// \p Claim Whether the argument should be claimed, if it exists.
190 Arg *getLastArgNoClaim(OptSpecifier Id) const;
191 Arg *getLastArgNoClaim(OptSpecifier Id0, OptSpecifier Id1) const;
192 Arg *getLastArgNoClaim(OptSpecifier Id0, OptSpecifier Id1,
193 OptSpecifier Id2) const;
194 Arg *getLastArgNoClaim(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
195 OptSpecifier Id3) const;
196 Arg *getLastArg(OptSpecifier Id) const;
197 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1) const;
198 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const;
199 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
200 OptSpecifier Id3) const;
201 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
202 OptSpecifier Id3, OptSpecifier Id4) const;
203 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
204 OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5) const;
205 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
206 OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5,
207 OptSpecifier Id6) const;
208 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
209 OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5,
210 OptSpecifier Id6, OptSpecifier Id7) const;
212 /// getArgString - Return the input argument string at \p Index.
213 virtual const char *getArgString(unsigned Index) const = 0;
215 /// getNumInputArgStrings - Return the number of original argument strings,
216 /// which are guaranteed to be the first strings in the argument string
218 virtual unsigned getNumInputArgStrings() const = 0;
221 /// @name Argument Lookup Utilities
224 /// getLastArgValue - Return the value of the last argument, or a default.
225 StringRef getLastArgValue(OptSpecifier Id,
226 StringRef Default = "") const;
228 /// getAllArgValues - Get the values of all instances of the given argument
230 std::vector<std::string> getAllArgValues(OptSpecifier Id) const;
233 /// @name Translation Utilities
236 /// hasFlag - Given an option \p Pos and its negative form \p Neg, return
237 /// true if the option is present, false if the negation is present, and
238 /// \p Default if neither option is given. If both the option and its
239 /// negation are present, the last one wins.
240 bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const;
242 /// hasFlag - Given an option \p Pos, an alias \p PosAlias and its negative
243 /// form \p Neg, return true if the option or its alias is present, false if
244 /// the negation is present, and \p Default if none of the options are
245 /// given. If multiple options are present, the last one wins.
246 bool hasFlag(OptSpecifier Pos, OptSpecifier PosAlias, OptSpecifier Neg,
247 bool Default = true) const;
249 /// AddLastArg - Render only the last argument match \p Id0, if present.
250 void AddLastArg(ArgStringList &Output, OptSpecifier Id0) const;
251 void AddLastArg(ArgStringList &Output, OptSpecifier Id0,
252 OptSpecifier Id1) const;
254 /// AddAllArgs - Render all arguments matching the given ids.
255 void AddAllArgs(ArgStringList &Output, OptSpecifier Id0,
256 OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const;
258 /// AddAllArgValues - Render the argument values of all arguments
259 /// matching the given ids.
260 void AddAllArgValues(ArgStringList &Output, OptSpecifier Id0,
261 OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const;
263 /// AddAllArgsTranslated - Render all the arguments matching the
264 /// given ids, but forced to separate args and using the provided
265 /// name instead of the first option value.
267 /// \param Joined - If true, render the argument as joined with
268 /// the option specifier.
269 void AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0,
270 const char *Translation,
271 bool Joined = false) const;
273 /// ClaimAllArgs - Claim all arguments which match the given
275 void ClaimAllArgs(OptSpecifier Id0) const;
277 /// ClaimAllArgs - Claim all arguments.
279 void ClaimAllArgs() const;
282 /// @name Arg Synthesis
285 /// Construct a constant string pointer whose
286 /// lifetime will match that of the ArgList.
287 virtual const char *MakeArgStringRef(StringRef Str) const = 0;
288 const char *MakeArgString(const Twine &Str) const {
289 SmallString<256> Buf;
290 return MakeArgStringRef(Str.toStringRef(Buf));
293 /// \brief Create an arg string for (\p LHS + \p RHS), reusing the
294 /// string at \p Index if possible.
295 const char *GetOrMakeJoinedArgString(unsigned Index, StringRef LHS,
296 StringRef RHS) const;
301 class InputArgList final : public ArgList {
303 /// List of argument strings used by the contained Args.
305 /// This is mutable since we treat the ArgList as being the list
306 /// of Args, and allow routines to add new strings (to have a
307 /// convenient place to store the memory) via MakeIndex.
308 mutable ArgStringList ArgStrings;
310 /// Strings for synthesized arguments.
312 /// This is mutable since we treat the ArgList as being the list
313 /// of Args, and allow routines to add new strings (to have a
314 /// convenient place to store the memory) via MakeIndex.
315 mutable std::list<std::string> SynthesizedStrings;
317 /// The number of original input argument strings.
318 unsigned NumInputArgStrings;
321 InputArgList(const char* const *ArgBegin, const char* const *ArgEnd);
324 const char *getArgString(unsigned Index) const override {
325 return ArgStrings[Index];
328 unsigned getNumInputArgStrings() const override {
329 return NumInputArgStrings;
332 /// @name Arg Synthesis
336 /// MakeIndex - Get an index for the given string(s).
337 unsigned MakeIndex(StringRef String0) const;
338 unsigned MakeIndex(StringRef String0, StringRef String1) const;
340 using ArgList::MakeArgString;
341 const char *MakeArgStringRef(StringRef Str) const override;
346 /// DerivedArgList - An ordered collection of driver arguments,
347 /// whose storage may be in another argument list.
348 class DerivedArgList final : public ArgList {
349 const InputArgList &BaseArgs;
351 /// The list of arguments we synthesized.
352 mutable SmallVector<std::unique_ptr<Arg>, 16> SynthesizedArgs;
355 /// Construct a new derived arg list from \p BaseArgs.
356 DerivedArgList(const InputArgList &BaseArgs);
358 const char *getArgString(unsigned Index) const override {
359 return BaseArgs.getArgString(Index);
362 unsigned getNumInputArgStrings() const override {
363 return BaseArgs.getNumInputArgStrings();
366 const InputArgList &getBaseArgs() const {
370 /// @name Arg Synthesis
373 /// AddSynthesizedArg - Add a argument to the list of synthesized arguments
375 void AddSynthesizedArg(Arg *A);
377 using ArgList::MakeArgString;
378 const char *MakeArgStringRef(StringRef Str) const override;
380 /// AddFlagArg - Construct a new FlagArg for the given option \p Id and
381 /// append it to the argument list.
382 void AddFlagArg(const Arg *BaseArg, const Option Opt) {
383 append(MakeFlagArg(BaseArg, Opt));
386 /// AddPositionalArg - Construct a new Positional arg for the given option
387 /// \p Id, with the provided \p Value and append it to the argument
389 void AddPositionalArg(const Arg *BaseArg, const Option Opt,
391 append(MakePositionalArg(BaseArg, Opt, Value));
395 /// AddSeparateArg - Construct a new Positional arg for the given option
396 /// \p Id, with the provided \p Value and append it to the argument
398 void AddSeparateArg(const Arg *BaseArg, const Option Opt,
400 append(MakeSeparateArg(BaseArg, Opt, Value));
404 /// AddJoinedArg - Construct a new Positional arg for the given option
405 /// \p Id, with the provided \p Value and append it to the argument list.
406 void AddJoinedArg(const Arg *BaseArg, const Option Opt,
408 append(MakeJoinedArg(BaseArg, Opt, Value));
412 /// MakeFlagArg - Construct a new FlagArg for the given option \p Id.
413 Arg *MakeFlagArg(const Arg *BaseArg, const Option Opt) const;
415 /// MakePositionalArg - Construct a new Positional arg for the
416 /// given option \p Id, with the provided \p Value.
417 Arg *MakePositionalArg(const Arg *BaseArg, const Option Opt,
418 StringRef Value) const;
420 /// MakeSeparateArg - Construct a new Positional arg for the
421 /// given option \p Id, with the provided \p Value.
422 Arg *MakeSeparateArg(const Arg *BaseArg, const Option Opt,
423 StringRef Value) const;
425 /// MakeJoinedArg - Construct a new Positional arg for the
426 /// given option \p Id, with the provided \p Value.
427 Arg *MakeJoinedArg(const Arg *BaseArg, const Option Opt,
428 StringRef Value) const;
433 } // end namespace opt
434 } // end namespace llvm