include/llvm/Option/ArgList.h

   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   /// @}
 154   /// @name Arg Removal
 155   /// @{
 156
 157   /// eraseArg - Remove any option matching \p Id.
 158   void eraseArg(OptSpecifier Id);
 159
 160   /// @}
 161   /// @name Arg Access
 162   /// @{
 163
 164   /// hasArg - Does the arg list contain any option matching \p Id.
 165   ///
 166   /// \p Claim Whether the argument should be claimed, if it exists.
 167   bool hasArgNoClaim(OptSpecifier Id) const {
 168     return getLastArgNoClaim(Id) != nullptr;
 169   }
 170   bool hasArg(OptSpecifier Id) const {
 171     return getLastArg(Id) != nullptr;
 172   }
 173   bool hasArg(OptSpecifier Id0, OptSpecifier Id1) const {
 174     return getLastArg(Id0, Id1) != nullptr;
 175   }
 176   bool hasArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const {
 177     return getLastArg(Id0, Id1, Id2) != nullptr;
 178   }
 179
 180   /// getLastArg - Return the last argument matching \p Id, or null.
 181   ///
 182   /// \p Claim Whether the argument should be claimed, if it exists.
 183   Arg *getLastArgNoClaim(OptSpecifier Id) const;
 184   Arg *getLastArg(OptSpecifier Id) const;
 185   Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1) const;
 186   Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2) const;
 187   Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
 188                   OptSpecifier Id3) const;
 189   Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
 190                   OptSpecifier Id3, OptSpecifier Id4) const;
 191   Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
 192                   OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5) const;
 193   Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
 194                   OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5,
 195                   OptSpecifier Id6) const;
 196   Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1, OptSpecifier Id2,
 197                   OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5,
 198                   OptSpecifier Id6, OptSpecifier Id7) const;
 199
 200   /// getArgString - Return the input argument string at \p Index.
 201   virtual const char *getArgString(unsigned Index) const = 0;
 202
 203   /// getNumInputArgStrings - Return the number of original argument strings,
 204   /// which are guaranteed to be the first strings in the argument string
 205   /// list.
 206   virtual unsigned getNumInputArgStrings() const = 0;
 207
 208   /// @}
 209   /// @name Argument Lookup Utilities
 210   /// @{
 211
 212   /// getLastArgValue - Return the value of the last argument, or a default.
 213   StringRef getLastArgValue(OptSpecifier Id,
 214                                   StringRef Default = "") const;
 215
 216   /// getAllArgValues - Get the values of all instances of the given argument
 217   /// as strings.
 218   std::vector<std::string> getAllArgValues(OptSpecifier Id) const;
 219
 220   /// @}
 221   /// @name Translation Utilities
 222   /// @{
 223
 224   /// hasFlag - Given an option \p Pos and its negative form \p Neg, return
 225   /// true if the option is present, false if the negation is present, and
 226   /// \p Default if neither option is given. If both the option and its
 227   /// negation are present, the last one wins.
 228   bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const;
 229
 230   /// hasFlag - Given an option \p Pos, an alias \p PosAlias and its negative
 231   /// form \p Neg, return true if the option or its alias is present, false if
 232   /// the negation is present, and \p Default if none of the options are
 233   /// given. If multiple options are present, the last one wins.
 234   bool hasFlag(OptSpecifier Pos, OptSpecifier PosAlias, OptSpecifier Neg,
 235                bool Default = true) const;
 236
 237   /// AddLastArg - Render only the last argument match \p Id0, if present.
 238   void AddLastArg(ArgStringList &Output, OptSpecifier Id0) const;
 239   void AddLastArg(ArgStringList &Output, OptSpecifier Id0,
 240                   OptSpecifier Id1) const;
 241
 242   /// AddAllArgs - Render all arguments matching the given ids.
 243   void AddAllArgs(ArgStringList &Output, OptSpecifier Id0,
 244                   OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const;
 245
 246   /// AddAllArgValues - Render the argument values of all arguments
 247   /// matching the given ids.
 248   void AddAllArgValues(ArgStringList &Output, OptSpecifier Id0,
 249                         OptSpecifier Id1 = 0U, OptSpecifier Id2 = 0U) const;
 250
 251   /// AddAllArgsTranslated - Render all the arguments matching the
 252   /// given ids, but forced to separate args and using the provided
 253   /// name instead of the first option value.
 254   ///
 255   /// \param Joined - If true, render the argument as joined with
 256   /// the option specifier.
 257   void AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0,
 258                             const char *Translation,
 259                             bool Joined = false) const;
 260
 261   /// ClaimAllArgs - Claim all arguments which match the given
 262   /// option id.
 263   void ClaimAllArgs(OptSpecifier Id0) const;
 264
 265   /// ClaimAllArgs - Claim all arguments.
 266   ///
 267   void ClaimAllArgs() const;
 268
 269   /// @}
 270   /// @name Arg Synthesis
 271   /// @{
 272
 273   /// MakeArgString - Construct a constant string pointer whose
 274   /// lifetime will match that of the ArgList.
 275   virtual const char *MakeArgString(StringRef Str) const = 0;
 276   const char *MakeArgString(const char *Str) const {
 277     return MakeArgString(StringRef(Str));
 278   }
 279   const char *MakeArgString(std::string Str) const {
 280     return MakeArgString(StringRef(Str));
 281   }
 282   const char *MakeArgString(const Twine &Str) const;
 283
 284   /// \brief Create an arg string for (\p LHS + \p RHS), reusing the
 285   /// string at \p Index if possible.
 286   const char *GetOrMakeJoinedArgString(unsigned Index, StringRef LHS,
 287                                         StringRef RHS) const;
 288
 289   /// @}
 290 };
 291
 292 class InputArgList : public ArgList  {
 293 private:
 294   /// List of argument strings used by the contained Args.
 295   ///
 296   /// This is mutable since we treat the ArgList as being the list
 297   /// of Args, and allow routines to add new strings (to have a
 298   /// convenient place to store the memory) via MakeIndex.
 299   mutable ArgStringList ArgStrings;
 300
 301   /// Strings for synthesized arguments.
 302   ///
 303   /// This is mutable since we treat the ArgList as being the list
 304   /// of Args, and allow routines to add new strings (to have a
 305   /// convenient place to store the memory) via MakeIndex.
 306   mutable std::list<std::string> SynthesizedStrings;
 307
 308   /// The number of original input argument strings.
 309   unsigned NumInputArgStrings;
 310
 311 public:
 312   InputArgList(const char* const *ArgBegin, const char* const *ArgEnd);
 313   ~InputArgList();
 314
 315   const char *getArgString(unsigned Index) const override {
 316     return ArgStrings[Index];
 317   }
 318
 319   unsigned getNumInputArgStrings() const override {
 320     return NumInputArgStrings;
 321   }
 322
 323   /// @name Arg Synthesis
 324   /// @{
 325
 326 public:
 327   /// MakeIndex - Get an index for the given string(s).
 328   unsigned MakeIndex(StringRef String0) const;
 329   unsigned MakeIndex(StringRef String0, StringRef String1) const;
 330
 331   using ArgList::MakeArgString;
 332   const char *MakeArgString(StringRef Str) const override;
 333
 334   /// @}
 335 };
 336
 337 /// DerivedArgList - An ordered collection of driver arguments,
 338 /// whose storage may be in another argument list.
 339 class DerivedArgList : public ArgList {
 340   const InputArgList &BaseArgs;
 341
 342   /// The list of arguments we synthesized.
 343   mutable SmallVector<std::unique_ptr<Arg>, 16> SynthesizedArgs;
 344
 345 public:
 346   /// Construct a new derived arg list from \p BaseArgs.
 347   DerivedArgList(const InputArgList &BaseArgs);
 348   ~DerivedArgList();
 349
 350   const char *getArgString(unsigned Index) const override {
 351     return BaseArgs.getArgString(Index);
 352   }
 353
 354   unsigned getNumInputArgStrings() const override {
 355     return BaseArgs.getNumInputArgStrings();
 356   }
 357
 358   const InputArgList &getBaseArgs() const {
 359     return BaseArgs;
 360   }
 361
 362   /// @name Arg Synthesis
 363   /// @{
 364
 365   /// AddSynthesizedArg - Add a argument to the list of synthesized arguments
 366   /// (to be freed).
 367   void AddSynthesizedArg(Arg *A);
 368
 369   using ArgList::MakeArgString;
 370   const char *MakeArgString(StringRef Str) const override;
 371
 372   /// AddFlagArg - Construct a new FlagArg for the given option \p Id and
 373   /// append it to the argument list.
 374   void AddFlagArg(const Arg *BaseArg, const Option Opt) {
 375     append(MakeFlagArg(BaseArg, Opt));
 376   }
 377
 378   /// AddPositionalArg - Construct a new Positional arg for the given option
 379   /// \p Id, with the provided \p Value and append it to the argument
 380   /// list.
 381   void AddPositionalArg(const Arg *BaseArg, const Option Opt,
 382                         StringRef Value) {
 383     append(MakePositionalArg(BaseArg, Opt, Value));
 384   }
 385
 386
 387   /// AddSeparateArg - Construct a new Positional arg for the given option
 388   /// \p Id, with the provided \p Value and append it to the argument
 389   /// list.
 390   void AddSeparateArg(const Arg *BaseArg, const Option Opt,
 391                       StringRef Value) {
 392     append(MakeSeparateArg(BaseArg, Opt, Value));
 393   }
 394
 395
 396   /// AddJoinedArg - Construct a new Positional arg for the given option
 397   /// \p Id, with the provided \p Value and append it to the argument list.
 398   void AddJoinedArg(const Arg *BaseArg, const Option Opt,
 399                     StringRef Value) {
 400     append(MakeJoinedArg(BaseArg, Opt, Value));
 401   }
 402
 403
 404   /// MakeFlagArg - Construct a new FlagArg for the given option \p Id.
 405   Arg *MakeFlagArg(const Arg *BaseArg, const Option Opt) const;
 406
 407   /// MakePositionalArg - Construct a new Positional arg for the
 408   /// given option \p Id, with the provided \p Value.
 409   Arg *MakePositionalArg(const Arg *BaseArg, const Option Opt,
 410                           StringRef Value) const;
 411
 412   /// MakeSeparateArg - Construct a new Positional arg for the
 413   /// given option \p Id, with the provided \p Value.
 414   Arg *MakeSeparateArg(const Arg *BaseArg, const Option Opt,
 415                         StringRef Value) const;
 416
 417   /// MakeJoinedArg - Construct a new Positional arg for the
 418   /// given option \p Id, with the provided \p Value.
 419   Arg *MakeJoinedArg(const Arg *BaseArg, const Option Opt,
 420                       StringRef Value) const;
 421
 422   /// @}
 423 };
 424
 425 } // end namespace opt
 426 } // end namespace llvm
 427
 428 #endif