1 //===--- ArgList.h - Argument List Management -------------------*- C++ -*-===// 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 #ifndef LLVM_OPTION_ARGLIST_H 11 #define LLVM_OPTION_ARGLIST_H 12 13 #include "llvm/ADT/SmallVector.h" 14 #include "llvm/ADT/StringRef.h" 15 #include "llvm/Option/OptSpecifier.h" 16 #include "llvm/Option/Option.h" 17 #include <list> 18 #include <memory> 19 #include <string> 20 #include <vector> 21 22 namespace llvm { 23 namespace opt { 24 class Arg; 25 class ArgList; 26 class Option; 27 28 /// arg_iterator - Iterates through arguments stored inside an ArgList. 29 class arg_iterator { 30 /// The current argument. 31 SmallVectorImpl<Arg*>::const_iterator Current; 32 33 /// The argument list we are iterating over. 34 const ArgList &Args; 35 36 /// Optional filters on the arguments which will be match. Most clients 37 /// should never want to iterate over arguments without filters, so we won't 38 /// bother to factor this into two separate iterator implementations. 39 // 40 // FIXME: Make efficient; the idea is to provide efficient iteration over 41 // all arguments which match a particular id and then just provide an 42 // iterator combinator which takes multiple iterators which can be 43 // efficiently compared and returns them in order. 44 OptSpecifier Id0, Id1, Id2; 45 46 void SkipToNextArg(); 47 48 public: 49 typedef Arg * const * value_type; 50 typedef Arg * const & reference; 51 typedef Arg * const * pointer; 52 typedef std::forward_iterator_tag iterator_category; 53 typedef std::ptrdiff_t difference_type; 54 55 arg_iterator(SmallVectorImpl<Arg*>::const_iterator it, 56 const ArgList &_Args, OptSpecifier _Id0 = 0U, 57 OptSpecifier _Id1 = 0U, OptSpecifier _Id2 = 0U) 58 : Current(it), Args(_Args), Id0(_Id0), Id1(_Id1), Id2(_Id2) { 59 SkipToNextArg(); 60 } 61 62 operator const Arg*() { return *Current; } 63 reference operator*() const { return *Current; } 64 pointer operator->() const { return Current; } 65 66 arg_iterator &operator++() { 67 ++Current; 68 SkipToNextArg(); 69 return *this; 70 } 71 72 arg_iterator operator++(int) { 73 arg_iterator tmp(*this); 74 ++(*this); 75 return tmp; 76 } 77 78 friend bool operator==(arg_iterator LHS, arg_iterator RHS) { 79 return LHS.Current == RHS.Current; 80 } 81 friend bool operator!=(arg_iterator LHS, arg_iterator RHS) { 82 return !(LHS == RHS); 83 } 84 }; 85 86 /// ArgList - Ordered collection of driver arguments. 87 /// 88 /// The ArgList class manages a list of Arg instances as well as 89 /// auxiliary data and convenience methods to allow Tools to quickly 90 /// check for the presence of Arg instances for a particular Option 91 /// and to iterate over groups of arguments. 92 class ArgList { 93 private: 94 ArgList(const ArgList &) LLVM_DELETED_FUNCTION; 95 void operator=(const ArgList &) LLVM_DELETED_FUNCTION; 96 97 public: 98 typedef SmallVector<Arg*, 16> arglist_type; 99 typedef arglist_type::iterator iterator; 100 typedef arglist_type::const_iterator const_iterator; 101 typedef arglist_type::reverse_iterator reverse_iterator; 102 typedef arglist_type::const_reverse_iterator const_reverse_iterator; 103 104 private: 105 /// The internal list of arguments. 106 arglist_type Args; 107 108 protected: 109 // Default ctor provided explicitly as it is not provided implicitly due to 110 // the presence of the (deleted) copy ctor above. 111 ArgList() { } 112 // Virtual to provide a vtable anchor and because -Wnon-virtua-dtor warns, not 113 // because this type is ever actually destroyed polymorphically. 114 virtual ~ArgList(); 115 116 public: 117 118 /// @name Arg Access 119 /// @{ 120 121 /// append - Append \p A to the arg list. 122 void append(Arg *A); 123 124 arglist_type &getArgs() { return Args; } 125 const arglist_type &getArgs() const { return Args; } 126 127 unsigned size() const { return Args.size(); } 128 129 /// @} 130 /// @name Arg Iteration 131 /// @{ 132 133 iterator begin() { return Args.begin(); } 134 iterator end() { return Args.end(); } 135 136 reverse_iterator rbegin() { return Args.rbegin(); } 137 reverse_iterator rend() { return Args.rend(); } 138 139 const_iterator begin() const { return Args.begin(); } 140 const_iterator end() const { return Args.end(); } 141 142 const_reverse_iterator rbegin() const { return Args.rbegin(); } 143 const_reverse_iterator rend() const { return Args.rend(); } 144 145 arg_iterator filtered_begin(OptSpecifier Id0 = 0U, OptSpecifier Id1 = 0U, 146 OptSpecifier Id2 = 0U) const { 147 return arg_iterator(Args.begin(), *this, Id0, Id1, Id2); 148 } 149 arg_iterator filtered_end() const { 150 return arg_iterator(Args.end(), *this); 151 } 152 153 iterator_range<arg_iterator> filtered(OptSpecifier Id0 = 0U, 154 OptSpecifier Id1 = 0U, 155 OptSpecifier Id2 = 0U) const { 156 return make_range(filtered_begin(Id0, Id1, Id2), filtered_end()); 157 } 158 159 /// @} 160 /// @name Arg Removal 161 /// @{ 162 163 /// eraseArg - Remove any option matching \p Id. 164 void eraseArg(OptSpecifier Id); 165 166 /// @} 167 /// @name Arg Access 168 /// @{ 169 170 /// hasArg - Does the arg list contain any option matching \p Id. 171 /// 172 /// \p Claim Whether the argument should be claimed, if it exists. 173 bool hasArgNoClaim(OptSpecifier Id) const { 174 return getLastArgNoClaim(Id) != nullptr; 175 } 176 bool hasArg(OptSpecifier Id) const { 177 return getLastArg(Id) != nullptr; 178 } 179 bool hasArg(OptSpecifier Id0, OptSpecifier Id1) const { 180 return getLastArg(Id0, Id1) != nullptr; 181 } 182 bool hasArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const { 183 return getLastArg(Id0, Id1, Id2) != nullptr; 184 } 185 186 /// getLastArg - Return the last argument matching \p Id, or null. 187 /// 188 /// \p Claim Whether the argument should be claimed, if it exists. 189 Arg *getLastArgNoClaim(OptSpecifier Id) const; 190 Arg *getLastArg(OptSpecifier Id) const; 191 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1) const; 192 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const; 193 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2, 194 OptSpecifier Id3) const; 195 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2, 196 OptSpecifier Id3, OptSpecifier Id4) const; 197 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2, 198 OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5) const; 199 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2, 200 OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5, 201 OptSpecifier Id6) const; 202 Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2, 203 OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5, 204 OptSpecifier Id6, OptSpecifier Id7) const; 205 206 /// getArgString - Return the input argument string at \p Index. 207 virtual const char *getArgString(unsigned Index) const = 0; 208 209 /// getNumInputArgStrings - Return the number of original argument strings, 210 /// which are guaranteed to be the first strings in the argument string 211 /// list. 212 virtual unsigned getNumInputArgStrings() const = 0; 213 214 /// @} 215 /// @name Argument Lookup Utilities 216 /// @{ 217 218 /// getLastArgValue - Return the value of the last argument, or a default. 219 StringRef getLastArgValue(OptSpecifier Id, 220 StringRef Default = "") const; 221 222 /// getAllArgValues - Get the values of all instances of the given argument 223 /// as strings. 224 std::vector<std::string> getAllArgValues(OptSpecifier Id) const; 225 226 /// @} 227 /// @name Translation Utilities 228 /// @{ 229 230 /// hasFlag - Given an option \p Pos and its negative form \p Neg, return 231 /// true if the option is present, false if the negation is present, and 232 /// \p Default if neither option is given. If both the option and its 233 /// negation are present, the last one wins. 234 bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const; 235 236 /// hasFlag - Given an option \p Pos, an alias \p PosAlias and its negative 237 /// form \p Neg, return true if the option or its alias is present, false if 238 /// the negation is present, and \p Default if none of the options are 239 /// given. If multiple options are present, the last one wins. 240 bool hasFlag(OptSpecifier Pos, OptSpecifier PosAlias, OptSpecifier Neg, 241 bool Default = true) const; 242 243 /// AddLastArg - Render only the last argument match \p Id0, if present. 244 void AddLastArg(ArgStringList &Output, OptSpecifier Id0) const; 245 void AddLastArg(ArgStringList &Output, OptSpecifier Id0, 246 OptSpecifier Id1) const; 247 248 /// AddAllArgs - Render all arguments matching the given ids. 249 void AddAllArgs(ArgStringList &Output, OptSpecifier Id0, 250 OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const; 251 252 /// AddAllArgValues - Render the argument values of all arguments 253 /// matching the given ids. 254 void AddAllArgValues(ArgStringList &Output, OptSpecifier Id0, 255 OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const; 256 257 /// AddAllArgsTranslated - Render all the arguments matching the 258 /// given ids, but forced to separate args and using the provided 259 /// name instead of the first option value. 260 /// 261 /// \param Joined - If true, render the argument as joined with 262 /// the option specifier. 263 void AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0, 264 const char *Translation, 265 bool Joined = false) const; 266 267 /// ClaimAllArgs - Claim all arguments which match the given 268 /// option id. 269 void ClaimAllArgs(OptSpecifier Id0) const; 270 271 /// ClaimAllArgs - Claim all arguments. 272 /// 273 void ClaimAllArgs() const; 274 275 /// @} 276 /// @name Arg Synthesis 277 /// @{ 278 279 /// MakeArgString - Construct a constant string pointer whose 280 /// lifetime will match that of the ArgList. 281 virtual const char *MakeArgString(StringRef Str) const = 0; 282 const char *MakeArgString(const char *Str) const { 283 return MakeArgString(StringRef(Str)); 284 } 285 const char *MakeArgString(std::string Str) const { 286 return MakeArgString(StringRef(Str)); 287 } 288 const char *MakeArgString(const Twine &Str) const; 289 290 /// \brief Create an arg string for (\p LHS + \p RHS), reusing the 291 /// string at \p Index if possible. 292 const char *GetOrMakeJoinedArgString(unsigned Index, StringRef LHS, 293 StringRef RHS) const; 294 295 /// @} 296 }; 297 298 class InputArgList : public ArgList { 299 private: 300 /// List of argument strings used by the contained Args. 301 /// 302 /// This is mutable since we treat the ArgList as being the list 303 /// of Args, and allow routines to add new strings (to have a 304 /// convenient place to store the memory) via MakeIndex. 305 mutable ArgStringList ArgStrings; 306 307 /// Strings for synthesized arguments. 308 /// 309 /// This is mutable since we treat the ArgList as being the list 310 /// of Args, and allow routines to add new strings (to have a 311 /// convenient place to store the memory) via MakeIndex. 312 mutable std::list<std::string> SynthesizedStrings; 313 314 /// The number of original input argument strings. 315 unsigned NumInputArgStrings; 316 317 public: 318 InputArgList(const char* const *ArgBegin, const char* const *ArgEnd); 319 ~InputArgList(); 320 321 const char *getArgString(unsigned Index) const override { 322 return ArgStrings[Index]; 323 } 324 325 unsigned getNumInputArgStrings() const override { 326 return NumInputArgStrings; 327 } 328 329 /// @name Arg Synthesis 330 /// @{ 331 332 public: 333 /// MakeIndex - Get an index for the given string(s). 334 unsigned MakeIndex(StringRef String0) const; 335 unsigned MakeIndex(StringRef String0, StringRef String1) const; 336 337 using ArgList::MakeArgString; 338 const char *MakeArgString(StringRef Str) const override; 339 340 /// @} 341 }; 342 343 /// DerivedArgList - An ordered collection of driver arguments, 344 /// whose storage may be in another argument list. 345 class DerivedArgList : public ArgList { 346 const InputArgList &BaseArgs; 347 348 /// The list of arguments we synthesized. 349 mutable SmallVector<std::unique_ptr<Arg>, 16> SynthesizedArgs; 350 351 public: 352 /// Construct a new derived arg list from \p BaseArgs. 353 DerivedArgList(const InputArgList &BaseArgs); 354 ~DerivedArgList(); 355 356 const char *getArgString(unsigned Index) const override { 357 return BaseArgs.getArgString(Index); 358 } 359 360 unsigned getNumInputArgStrings() const override { 361 return BaseArgs.getNumInputArgStrings(); 362 } 363 364 const InputArgList &getBaseArgs() const { 365 return BaseArgs; 366 } 367 368 /// @name Arg Synthesis 369 /// @{ 370 371 /// AddSynthesizedArg - Add a argument to the list of synthesized arguments 372 /// (to be freed). 373 void AddSynthesizedArg(Arg *A); 374 375 using ArgList::MakeArgString; 376 const char *MakeArgString(StringRef Str) const override; 377 378 /// AddFlagArg - Construct a new FlagArg for the given option \p Id and 379 /// append it to the argument list. 380 void AddFlagArg(const Arg *BaseArg, const Option Opt) { 381 append(MakeFlagArg(BaseArg, Opt)); 382 } 383 384 /// AddPositionalArg - Construct a new Positional arg for the given option 385 /// \p Id, with the provided \p Value and append it to the argument 386 /// list. 387 void AddPositionalArg(const Arg *BaseArg, const Option Opt, 388 StringRef Value) { 389 append(MakePositionalArg(BaseArg, Opt, Value)); 390 } 391 392 393 /// AddSeparateArg - Construct a new Positional arg for the given option 394 /// \p Id, with the provided \p Value and append it to the argument 395 /// list. 396 void AddSeparateArg(const Arg *BaseArg, const Option Opt, 397 StringRef Value) { 398 append(MakeSeparateArg(BaseArg, Opt, Value)); 399 } 400 401 402 /// AddJoinedArg - Construct a new Positional arg for the given option 403 /// \p Id, with the provided \p Value and append it to the argument list. 404 void AddJoinedArg(const Arg *BaseArg, const Option Opt, 405 StringRef Value) { 406 append(MakeJoinedArg(BaseArg, Opt, Value)); 407 } 408 409 410 /// MakeFlagArg - Construct a new FlagArg for the given option \p Id. 411 Arg *MakeFlagArg(const Arg *BaseArg, const Option Opt) const; 412 413 /// MakePositionalArg - Construct a new Positional arg for the 414 /// given option \p Id, with the provided \p Value. 415 Arg *MakePositionalArg(const Arg *BaseArg, const Option Opt, 416 StringRef Value) const; 417 418 /// MakeSeparateArg - Construct a new Positional arg for the 419 /// given option \p Id, with the provided \p Value. 420 Arg *MakeSeparateArg(const Arg *BaseArg, const Option Opt, 421 StringRef Value) const; 422 423 /// MakeJoinedArg - Construct a new Positional arg for the 424 /// given option \p Id, with the provided \p Value. 425 Arg *MakeJoinedArg(const Arg *BaseArg, const Option Opt, 426 StringRef Value) const; 427 428 /// @} 429 }; 430 431 } // end namespace opt 432 } // end namespace llvm 433 434 #endif 435
