include/llvm/Support/CommandLine.h

   1 //===- llvm/Support/CommandLine.h - Command line handler --------*- 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 // This class implements a command line argument processor that is useful when
  11 // creating a tool.  It provides a simple, minimalistic interface that is easily
  12 // extensible and supports nonlocal (library) command line options.
  13 //
  14 // Note that rather than trying to figure out what this code does, you should
  15 // read the library documentation located in docs/CommandLine.html or looks at
  16 // the many example usages in tools/*/*.cpp
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_SUPPORT_COMMANDLINE_H
  21 #define LLVM_SUPPORT_COMMANDLINE_H
  22
  23 #include "llvm/Support/type_traits.h"
  24 #include "llvm/Support/DataTypes.h"
  25 #include "llvm/Support/Compiler.h"
  26 #include "llvm/ADT/SmallVector.h"
  27 #include <cassert>
  28 #include <cstdarg>
  29 #include <string>
  30 #include <utility>
  31 #include <vector>
  32
  33 namespace llvm {
  34
  35 /// cl Namespace - This namespace contains all of the command line option
  36 /// processing machinery.  It is intentionally a short name to make qualified
  37 /// usage concise.
  38 namespace cl {
  39
  40 //===----------------------------------------------------------------------===//
  41 // ParseCommandLineOptions - Command line option processing entry point.
  42 //
  43 void ParseCommandLineOptions(int argc, char **argv,
  44                              const char *Overview = 0,
  45                              bool ReadResponseFiles = false);
  46
  47 //===----------------------------------------------------------------------===//
  48 // ParseEnvironmentOptions - Environment variable option processing alternate
  49 //                           entry point.
  50 //
  51 void ParseEnvironmentOptions(const char *progName, const char *envvar,
  52                              const char *Overview = 0,
  53                              bool ReadResponseFiles = false);
  54
  55 ///===---------------------------------------------------------------------===//
  56 /// SetVersionPrinter - Override the default (LLVM specific) version printer
  57 ///                     used to print out the version when --version is given
  58 ///                     on the command line. This allows other systems using the
  59 ///                     CommandLine utilities to print their own version string.
  60 void SetVersionPrinter(void (*func)());
  61
  62
  63 // MarkOptionsChanged - Internal helper function.
  64 void MarkOptionsChanged();
  65
  66 //===----------------------------------------------------------------------===//
  67 // Flags permitted to be passed to command line arguments
  68 //
  69
  70 enum NumOccurrences {          // Flags for the number of occurrences allowed
  71   Optional        = 0x01,      // Zero or One occurrence
  72   ZeroOrMore      = 0x02,      // Zero or more occurrences allowed
  73   Required        = 0x03,      // One occurrence required
  74   OneOrMore       = 0x04,      // One or more occurrences required
  75
  76   // ConsumeAfter - Indicates that this option is fed anything that follows the
  77   // last positional argument required by the application (it is an error if
  78   // there are zero positional arguments, and a ConsumeAfter option is used).
  79   // Thus, for example, all arguments to LLI are processed until a filename is
  80   // found.  Once a filename is found, all of the succeeding arguments are
  81   // passed, unprocessed, to the ConsumeAfter option.
  82   //
  83   ConsumeAfter    = 0x05,
  84
  85   OccurrencesMask  = 0x07
  86 };
  87
  88 enum ValueExpected {           // Is a value required for the option?
  89   ValueOptional   = 0x08,      // The value can appear... or not
  90   ValueRequired   = 0x10,      // The value is required to appear!
  91   ValueDisallowed = 0x18,      // A value may not be specified (for flags)
  92   ValueMask       = 0x18
  93 };
  94
  95 enum OptionHidden {            // Control whether -help shows this option
  96   NotHidden       = 0x20,      // Option included in --help & --help-hidden
  97   Hidden          = 0x40,      // -help doesn't, but --help-hidden does
  98   ReallyHidden    = 0x60,      // Neither --help nor --help-hidden show this arg
  99   HiddenMask      = 0x60
 100 };
 101
 102 // Formatting flags - This controls special features that the option might have
 103 // that cause it to be parsed differently...
 104 //
 105 // Prefix - This option allows arguments that are otherwise unrecognized to be
 106 // matched by options that are a prefix of the actual value.  This is useful for
 107 // cases like a linker, where options are typically of the form '-lfoo' or
 108 // '-L../../include' where -l or -L are the actual flags.  When prefix is
 109 // enabled, and used, the value for the flag comes from the suffix of the
 110 // argument.
 111 //
 112 // Grouping - With this option enabled, multiple letter options are allowed to
 113 // bunch together with only a single hyphen for the whole group.  This allows
 114 // emulation of the behavior that ls uses for example: ls -la === ls -l -a
 115 //
 116
 117 enum FormattingFlags {
 118   NormalFormatting = 0x000,     // Nothing special
 119   Positional       = 0x080,     // Is a positional argument, no '-' required
 120   Prefix           = 0x100,     // Can this option directly prefix its value?
 121   Grouping         = 0x180,     // Can this option group with other options?
 122   FormattingMask   = 0x180      // Union of the above flags.
 123 };
 124
 125 enum MiscFlags {               // Miscellaneous flags to adjust argument
 126   CommaSeparated     = 0x200,  // Should this cl::list split between commas?
 127   PositionalEatsArgs = 0x400,  // Should this positional cl::list eat -args?
 128   Sink               = 0x800,  // Should this cl::list eat all unknown options?
 129   AllowInverse       = 0x1000, // Can this option take a -Xno- form?
 130   MiscMask           = 0x1E00  // Union of the above flags.
 131 };
 132
 133
 134
 135 //===----------------------------------------------------------------------===//
 136 // Option Base class
 137 //
 138 class alias;
 139 class Option {
 140   friend class alias;
 141
 142   // handleOccurrences - Overriden by subclasses to handle the value passed into
 143   // an argument.  Should return true if there was an error processing the
 144   // argument and the program should exit.
 145   //
 146   virtual bool handleOccurrence(unsigned pos, const char *ArgName,
 147                                 const std::string &Arg) = 0;
 148
 149   virtual enum ValueExpected getValueExpectedFlagDefault() const {
 150     return ValueOptional;
 151   }
 152
 153   // Out of line virtual function to provide home for the class.
 154   virtual void anchor();
 155
 156   int NumOccurrences;     // The number of times specified
 157   int Flags;              // Flags for the argument
 158   unsigned Position;      // Position of last occurrence of the option
 159   unsigned AdditionalVals;// Greater than 0 for multi-valued option.
 160   Option *NextRegistered; // Singly linked list of registered options.
 161 public:
 162   const char *ArgStr;     // The argument string itself (ex: "help", "o")
 163   const char *HelpStr;    // The descriptive text message for --help
 164   const char *ValueStr;   // String describing what the value of this option is
 165
 166   inline enum NumOccurrences getNumOccurrencesFlag() const {
 167     return static_cast<enum NumOccurrences>(Flags & OccurrencesMask);
 168   }
 169   inline enum ValueExpected getValueExpectedFlag() const {
 170     int VE = Flags & ValueMask;
 171     return VE ? static_cast<enum ValueExpected>(VE)
 172               : getValueExpectedFlagDefault();
 173   }
 174   inline enum OptionHidden getOptionHiddenFlag() const {
 175     return static_cast<enum OptionHidden>(Flags & HiddenMask);
 176   }
 177   inline enum FormattingFlags getFormattingFlag() const {
 178     return static_cast<enum FormattingFlags>(Flags & FormattingMask);
 179   }
 180   inline unsigned getMiscFlags() const {
 181     return Flags & MiscMask;
 182   }
 183   inline unsigned getPosition() const { return Position; }
 184   inline unsigned getNumAdditionalVals() const { return AdditionalVals; }
 185
 186   // hasArgStr - Return true if the argstr != ""
 187   bool hasArgStr() const { return ArgStr[0] != 0; }
 188
 189   //-------------------------------------------------------------------------===
 190   // Accessor functions set by OptionModifiers
 191   //
 192   void setArgStr(const char *S) { ArgStr = S; }
 193   void setDescription(const char *S) { HelpStr = S; }
 194   void setValueStr(const char *S) { ValueStr = S; }
 195
 196   void setFlag(unsigned Flag, unsigned FlagMask) {
 197     Flags &= ~FlagMask;
 198     Flags |= Flag;
 199   }
 200
 201   void setNumOccurrencesFlag(enum NumOccurrences Val) {
 202     setFlag(Val, OccurrencesMask);
 203   }
 204   void setValueExpectedFlag(enum ValueExpected Val) { setFlag(Val, ValueMask); }
 205   void setHiddenFlag(enum OptionHidden Val) { setFlag(Val, HiddenMask); }
 206   void setFormattingFlag(enum FormattingFlags V) { setFlag(V, FormattingMask); }
 207   void setMiscFlag(enum MiscFlags M) { setFlag(M, M); }
 208   void setPosition(unsigned pos) { Position = pos; }
 209 protected:
 210   explicit Option(unsigned DefaultFlags)
 211     : NumOccurrences(0), Flags(DefaultFlags | NormalFormatting), Position(0),
 212       AdditionalVals(0), NextRegistered(0),
 213       ArgStr(""), HelpStr(""), ValueStr("") {
 214     assert(getNumOccurrencesFlag() != 0 &&
 215            getOptionHiddenFlag() != 0 && "Not all default flags specified!");
 216   }
 217
 218   inline void setNumAdditionalVals(unsigned n)
 219   { AdditionalVals = n; }
 220 public:
 221   // addArgument - Register this argument with the commandline system.
 222   //
 223   void addArgument();
 224
 225   Option *getNextRegisteredOption() const { return NextRegistered; }
 226
 227   // Return the width of the option tag for printing...
 228   virtual size_t getOptionWidth() const = 0;
 229
 230   // printOptionInfo - Print out information about this option.  The
 231   // to-be-maintained width is specified.
 232   //
 233   virtual void printOptionInfo(size_t GlobalWidth) const = 0;
 234
 235   virtual void getExtraOptionNames(std::vector<const char*> &) {}
 236
 237   // addOccurrence - Wrapper around handleOccurrence that enforces Flags
 238   //
 239   bool addOccurrence(unsigned pos, const char *ArgName,
 240                      const std::string &Value, bool MultiArg = false);
 241
 242   // Prints option name followed by message.  Always returns true.
 243   bool error(std::string Message, const char *ArgName = 0);
 244
 245 public:
 246   inline int getNumOccurrences() const { return NumOccurrences; }
 247   virtual ~Option() {}
 248 };
 249
 250
 251 //===----------------------------------------------------------------------===//
 252 // Command line option modifiers that can be used to modify the behavior of
 253 // command line option parsers...
 254 //
 255
 256 // desc - Modifier to set the description shown in the --help output...
 257 struct desc {
 258   const char *Desc;
 259   desc(const char *Str) : Desc(Str) {}
 260   void apply(Option &O) const { O.setDescription(Desc); }
 261 };
 262
 263 // value_desc - Modifier to set the value description shown in the --help
 264 // output...
 265 struct value_desc {
 266   const char *Desc;
 267   value_desc(const char *Str) : Desc(Str) {}
 268   void apply(Option &O) const { O.setValueStr(Desc); }
 269 };
 270
 271 // init - Specify a default (initial) value for the command line argument, if
 272 // the default constructor for the argument type does not give you what you
 273 // want.  This is only valid on "opt" arguments, not on "list" arguments.
 274 //
 275 template<class Ty>
 276 struct initializer {
 277   const Ty &Init;
 278   initializer(const Ty &Val) : Init(Val) {}
 279
 280   template<class Opt>
 281   void apply(Opt &O) const { O.setInitialValue(Init); }
 282 };
 283
 284 template<class Ty>
 285 initializer<Ty> init(const Ty &Val) {
 286   return initializer<Ty>(Val);
 287 }
 288
 289
 290 // location - Allow the user to specify which external variable they want to
 291 // store the results of the command line argument processing into, if they don't
 292 // want to store it in the option itself.
 293 //
 294 template<class Ty>
 295 struct LocationClass {
 296   Ty &Loc;
 297   LocationClass(Ty &L) : Loc(L) {}
 298
 299   template<class Opt>
 300   void apply(Opt &O) const { O.setLocation(O, Loc); }
 301 };
 302
 303 template<class Ty>
 304 LocationClass<Ty> location(Ty &L) { return LocationClass<Ty>(L); }
 305
 306
 307 //===----------------------------------------------------------------------===//
 308 // Enum valued command line option
 309 //
 310 #define clEnumVal(ENUMVAL, DESC) #ENUMVAL, int(ENUMVAL), DESC
 311 #define clEnumValN(ENUMVAL, FLAGNAME, DESC) FLAGNAME, int(ENUMVAL), DESC
 312 #define clEnumValEnd (reinterpret_cast<void*>(0))
 313
 314 // values - For custom data types, allow specifying a group of values together
 315 // as the values that go into the mapping that the option handler uses.  Note
 316 // that the values list must always have a 0 at the end of the list to indicate
 317 // that the list has ended.
 318 //
 319 template<class DataType>
 320 class ValuesClass {
 321   // Use a vector instead of a map, because the lists should be short,
 322   // the overhead is less, and most importantly, it keeps them in the order
 323   // inserted so we can print our option out nicely.
 324   SmallVector<std::pair<const char *, std::pair<int, const char *> >,4> Values;
 325   void processValues(va_list Vals);
 326 public:
 327   ValuesClass(const char *EnumName, DataType Val, const char *Desc,
 328               va_list ValueArgs) {
 329     // Insert the first value, which is required.
 330     Values.push_back(std::make_pair(EnumName, std::make_pair(Val, Desc)));
 331
 332     // Process the varargs portion of the values...
 333     while (const char *enumName = va_arg(ValueArgs, const char *)) {
 334       DataType EnumVal = static_cast<DataType>(va_arg(ValueArgs, int));
 335       const char *EnumDesc = va_arg(ValueArgs, const char *);
 336       Values.push_back(std::make_pair(enumName,      // Add value to value map
 337                                       std::make_pair(EnumVal, EnumDesc)));
 338     }
 339   }
 340
 341   template<class Opt>
 342   void apply(Opt &O) const {
 343     for (unsigned i = 0, e = static_cast<unsigned>(Values.size());
 344          i != e; ++i)
 345       O.getParser().addLiteralOption(Values[i].first, Values[i].second.first,
 346                                      Values[i].second.second);
 347   }
 348 };
 349
 350 template<class DataType>
 351 ValuesClass<DataType> END_WITH_NULL values(const char *Arg, DataType Val,
 352                                            const char *Desc, ...) {
 353     va_list ValueArgs;
 354     va_start(ValueArgs, Desc);
 355     ValuesClass<DataType> Vals(Arg, Val, Desc, ValueArgs);
 356     va_end(ValueArgs);
 357     return Vals;
 358 }
 359
 360
 361 //===----------------------------------------------------------------------===//
 362 // parser class - Parameterizable parser for different data types.  By default,
 363 // known data types (string, int, bool) have specialized parsers, that do what
 364 // you would expect.  The default parser, used for data types that are not
 365 // built-in, uses a mapping table to map specific options to values, which is
 366 // used, among other things, to handle enum types.
 367
 368 //--------------------------------------------------
 369 // generic_parser_base - This class holds all the non-generic code that we do
 370 // not need replicated for every instance of the generic parser.  This also
 371 // allows us to put stuff into CommandLine.cpp
 372 //
 373 struct generic_parser_base {
 374   virtual ~generic_parser_base() {}  // Base class should have virtual-dtor
 375
 376   // getNumOptions - Virtual function implemented by generic subclass to
 377   // indicate how many entries are in Values.
 378   //
 379   virtual unsigned getNumOptions() const = 0;
 380
 381   // getOption - Return option name N.
 382   virtual const char *getOption(unsigned N) const = 0;
 383
 384   // getDescription - Return description N
 385   virtual const char *getDescription(unsigned N) const = 0;
 386
 387   // Return the width of the option tag for printing...
 388   virtual size_t getOptionWidth(const Option &O) const;
 389
 390   // printOptionInfo - Print out information about this option.  The
 391   // to-be-maintained width is specified.
 392   //
 393   virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const;
 394
 395   void initialize(Option &O) {
 396     // All of the modifiers for the option have been processed by now, so the
 397     // argstr field should be stable, copy it down now.
 398     //
 399     hasArgStr = O.hasArgStr();
 400   }
 401
 402   void getExtraOptionNames(std::vector<const char*> &OptionNames) {
 403     // If there has been no argstr specified, that means that we need to add an
 404     // argument for every possible option.  This ensures that our options are
 405     // vectored to us.
 406     if (!hasArgStr)
 407       for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
 408         OptionNames.push_back(getOption(i));
 409   }
 410
 411
 412   enum ValueExpected getValueExpectedFlagDefault() const {
 413     // If there is an ArgStr specified, then we are of the form:
 414     //
 415     //    -opt=O2   or   -opt O2  or  -optO2
 416     //
 417     // In which case, the value is required.  Otherwise if an arg str has not
 418     // been specified, we are of the form:
 419     //
 420     //    -O2 or O2 or -la (where -l and -a are separate options)
 421     //
 422     // If this is the case, we cannot allow a value.
 423     //
 424     if (hasArgStr)
 425       return ValueRequired;
 426     else
 427       return ValueDisallowed;
 428   }
 429
 430   // findOption - Return the option number corresponding to the specified
 431   // argument string.  If the option is not found, getNumOptions() is returned.
 432   //
 433   unsigned findOption(const char *Name);
 434
 435 protected:
 436   bool hasArgStr;
 437 };
 438
 439 // Default parser implementation - This implementation depends on having a
 440 // mapping of recognized options to values of some sort.  In addition to this,
 441 // each entry in the mapping also tracks a help message that is printed with the
 442 // command line option for --help.  Because this is a simple mapping parser, the
 443 // data type can be any unsupported type.
 444 //
 445 template <class DataType>
 446 class parser : public generic_parser_base {
 447 protected:
 448   SmallVector<std::pair<const char *,
 449                         std::pair<DataType, const char *> >, 8> Values;
 450 public:
 451   typedef DataType parser_data_type;
 452
 453   // Implement virtual functions needed by generic_parser_base
 454   unsigned getNumOptions() const { return unsigned(Values.size()); }
 455   const char *getOption(unsigned N) const { return Values[N].first; }
 456   const char *getDescription(unsigned N) const {
 457     return Values[N].second.second;
 458   }
 459
 460   // parse - Return true on error.
 461   bool parse(Option &O, const char *ArgName, const std::string &Arg,
 462              DataType &V) {
 463     std::string ArgVal;
 464     if (hasArgStr)
 465       ArgVal = Arg;
 466     else
 467       ArgVal = ArgName;
 468
 469     for (unsigned i = 0, e = static_cast<unsigned>(Values.size());
 470          i != e; ++i)
 471       if (ArgVal == Values[i].first) {
 472         V = Values[i].second.first;
 473         return false;
 474       }
 475
 476     return O.error(": Cannot find option named '" + ArgVal + "'!");
 477   }
 478
 479   /// addLiteralOption - Add an entry to the mapping table.
 480   ///
 481   template <class DT>
 482   void addLiteralOption(const char *Name, const DT &V, const char *HelpStr) {
 483     assert(findOption(Name) == Values.size() && "Option already exists!");
 484     Values.push_back(std::make_pair(Name,
 485                              std::make_pair(static_cast<DataType>(V),HelpStr)));
 486     MarkOptionsChanged();
 487   }
 488
 489   /// removeLiteralOption - Remove the specified option.
 490   ///
 491   void removeLiteralOption(const char *Name) {
 492     unsigned N = findOption(Name);
 493     assert(N != Values.size() && "Option not found!");
 494     Values.erase(Values.begin()+N);
 495   }
 496 };
 497
 498 //--------------------------------------------------
 499 // basic_parser - Super class of parsers to provide boilerplate code
 500 //
 501 struct basic_parser_impl {  // non-template implementation of basic_parser<t>
 502   virtual ~basic_parser_impl() {}
 503
 504   enum ValueExpected getValueExpectedFlagDefault() const {
 505     return ValueRequired;
 506   }
 507
 508   void getExtraOptionNames(std::vector<const char*> &) {}
 509
 510   void initialize(Option &) {}
 511
 512   // Return the width of the option tag for printing...
 513   size_t getOptionWidth(const Option &O) const;
 514
 515   // printOptionInfo - Print out information about this option.  The
 516   // to-be-maintained width is specified.
 517   //
 518   void printOptionInfo(const Option &O, size_t GlobalWidth) const;
 519
 520   // getValueName - Overload in subclass to provide a better default value.
 521   virtual const char *getValueName() const { return "value"; }
 522
 523   // An out-of-line virtual method to provide a 'home' for this class.
 524   virtual void anchor();
 525 };
 526
 527 // basic_parser - The real basic parser is just a template wrapper that provides
 528 // a typedef for the provided data type.
 529 //
 530 template<class DataType>
 531 struct basic_parser : public basic_parser_impl {
 532   typedef DataType parser_data_type;
 533 };
 534
 535 //--------------------------------------------------
 536 // parser<bool>
 537 //
 538 template<>
 539 class parser<bool> : public basic_parser<bool> {
 540   bool IsInvertable;    // Should we synthezise a -xno- style option?
 541   const char *ArgStr;
 542 public:
 543   void getExtraOptionNames(std::vector<const char*> &OptionNames);
 544
 545   // parse - Return true on error.
 546   bool parse(Option &O, const char *ArgName, const std::string &Arg, bool &Val);
 547
 548   template <class Opt>
 549   void initialize(Opt &O) {
 550     if (O.getMiscFlags() & llvm::cl::AllowInverse)
 551       IsInvertable = true;
 552     else
 553       IsInvertable = false;
 554     ArgStr = O.ArgStr;
 555   }
 556
 557   enum ValueExpected getValueExpectedFlagDefault() const {
 558     return ValueOptional;
 559   }
 560
 561   // getValueName - Do not print =<value> at all.
 562   virtual const char *getValueName() const { return 0; }
 563
 564   // An out-of-line virtual method to provide a 'home' for this class.
 565   virtual void anchor();
 566 };
 567
 568 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<bool>);
 569
 570 //--------------------------------------------------
 571 // parser<boolOrDefault>
 572 enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE };
 573 template<>
 574 class parser<boolOrDefault> : public basic_parser<boolOrDefault> {
 575 public:
 576   // parse - Return true on error.
 577   bool parse(Option &O, const char *ArgName, const std::string &Arg,
 578              boolOrDefault &Val);
 579
 580   enum ValueExpected getValueExpectedFlagDefault() const {
 581     return ValueOptional;
 582   }
 583
 584   // getValueName - Do not print =<value> at all.
 585   virtual const char *getValueName() const { return 0; }
 586
 587   // An out-of-line virtual method to provide a 'home' for this class.
 588   virtual void anchor();
 589 };
 590
 591 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
 592
 593 //--------------------------------------------------
 594 // parser<int>
 595 //
 596 template<>
 597 class parser<int> : public basic_parser<int> {
 598 public:
 599   // parse - Return true on error.
 600   bool parse(Option &O, const char *ArgName, const std::string &Arg, int &Val);
 601
 602   // getValueName - Overload in subclass to provide a better default value.
 603   virtual const char *getValueName() const { return "int"; }
 604
 605   // An out-of-line virtual method to provide a 'home' for this class.
 606   virtual void anchor();
 607 };
 608
 609 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<int>);
 610
 611
 612 //--------------------------------------------------
 613 // parser<unsigned>
 614 //
 615 template<>
 616 class parser<unsigned> : public basic_parser<unsigned> {
 617 public:
 618   // parse - Return true on error.
 619   bool parse(Option &O, const char *AN, const std::string &Arg, unsigned &Val);
 620
 621   // getValueName - Overload in subclass to provide a better default value.
 622   virtual const char *getValueName() const { return "uint"; }
 623
 624   // An out-of-line virtual method to provide a 'home' for this class.
 625   virtual void anchor();
 626 };
 627
 628 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
 629
 630 //--------------------------------------------------
 631 // parser<double>
 632 //
 633 template<>
 634 class parser<double> : public basic_parser<double> {
 635 public:
 636   // parse - Return true on error.
 637   bool parse(Option &O, const char *AN, const std::string &Arg, double &Val);
 638
 639   // getValueName - Overload in subclass to provide a better default value.
 640   virtual const char *getValueName() const { return "number"; }
 641
 642   // An out-of-line virtual method to provide a 'home' for this class.
 643   virtual void anchor();
 644 };
 645
 646 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<double>);
 647
 648 //--------------------------------------------------
 649 // parser<float>
 650 //
 651 template<>
 652 class parser<float> : public basic_parser<float> {
 653 public:
 654   // parse - Return true on error.
 655   bool parse(Option &O, const char *AN, const std::string &Arg, float &Val);
 656
 657   // getValueName - Overload in subclass to provide a better default value.
 658   virtual const char *getValueName() const { return "number"; }
 659
 660   // An out-of-line virtual method to provide a 'home' for this class.
 661   virtual void anchor();
 662 };
 663
 664 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<float>);
 665
 666 //--------------------------------------------------
 667 // parser<std::string>
 668 //
 669 template<>
 670 class parser<std::string> : public basic_parser<std::string> {
 671 public:
 672   // parse - Return true on error.
 673   bool parse(Option &, const char *, const std::string &Arg,
 674              std::string &Value) {
 675     Value = Arg;
 676     return false;
 677   }
 678
 679   // getValueName - Overload in subclass to provide a better default value.
 680   virtual const char *getValueName() const { return "string"; }
 681
 682   // An out-of-line virtual method to provide a 'home' for this class.
 683   virtual void anchor();
 684 };
 685
 686 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
 687
 688 //===----------------------------------------------------------------------===//
 689 // applicator class - This class is used because we must use partial
 690 // specialization to handle literal string arguments specially (const char* does
 691 // not correctly respond to the apply method).  Because the syntax to use this
 692 // is a pain, we have the 'apply' method below to handle the nastiness...
 693 //
 694 template<class Mod> struct applicator {
 695   template<class Opt>
 696   static void opt(const Mod &M, Opt &O) { M.apply(O); }
 697 };
 698
 699 // Handle const char* as a special case...
 700 template<unsigned n> struct applicator<char[n]> {
 701   template<class Opt>
 702   static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
 703 };
 704 template<unsigned n> struct applicator<const char[n]> {
 705   template<class Opt>
 706   static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
 707 };
 708 template<> struct applicator<const char*> {
 709   template<class Opt>
 710   static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
 711 };
 712
 713 template<> struct applicator<NumOccurrences> {
 714   static void opt(NumOccurrences NO, Option &O) { O.setNumOccurrencesFlag(NO); }
 715 };
 716 template<> struct applicator<ValueExpected> {
 717   static void opt(ValueExpected VE, Option &O) { O.setValueExpectedFlag(VE); }
 718 };
 719 template<> struct applicator<OptionHidden> {
 720   static void opt(OptionHidden OH, Option &O) { O.setHiddenFlag(OH); }
 721 };
 722 template<> struct applicator<FormattingFlags> {
 723   static void opt(FormattingFlags FF, Option &O) { O.setFormattingFlag(FF); }
 724 };
 725 template<> struct applicator<MiscFlags> {
 726   static void opt(MiscFlags MF, Option &O) { O.setMiscFlag(MF); }
 727 };
 728
 729 // apply method - Apply a modifier to an option in a type safe way.
 730 template<class Mod, class Opt>
 731 void apply(const Mod &M, Opt *O) {
 732   applicator<Mod>::opt(M, *O);
 733 }
 734
 735
 736 //===----------------------------------------------------------------------===//
 737 // opt_storage class
 738
 739 // Default storage class definition: external storage.  This implementation
 740 // assumes the user will specify a variable to store the data into with the
 741 // cl::location(x) modifier.
 742 //
 743 template<class DataType, bool ExternalStorage, bool isClass>
 744 class opt_storage {
 745   DataType *Location;   // Where to store the object...
 746
 747   void check() {
 748     assert(Location != 0 && "cl::location(...) not specified for a command "
 749            "line option with external storage, "
 750            "or cl::init specified before cl::location()!!");
 751   }
 752 public:
 753   opt_storage() : Location(0) {}
 754
 755   bool setLocation(Option &O, DataType &L) {
 756     if (Location)
 757       return O.error(": cl::location(x) specified more than once!");
 758     Location = &L;
 759     return false;
 760   }
 761
 762   template<class T>
 763   void setValue(const T &V) {
 764     check();
 765     *Location = V;
 766   }
 767
 768   DataType &getValue() { check(); return *Location; }
 769   const DataType &getValue() const { check(); return *Location; }
 770 };
 771
 772
 773 // Define how to hold a class type object, such as a string.  Since we can
 774 // inherit from a class, we do so.  This makes us exactly compatible with the
 775 // object in all cases that it is used.
 776 //
 777 template<class DataType>
 778 class opt_storage<DataType,false,true> : public DataType {
 779 public:
 780   template<class T>
 781   void setValue(const T &V) { DataType::operator=(V); }
 782
 783   DataType &getValue() { return *this; }
 784   const DataType &getValue() const { return *this; }
 785 };
 786
 787 // Define a partial specialization to handle things we cannot inherit from.  In
 788 // this case, we store an instance through containment, and overload operators
 789 // to get at the value.
 790 //
 791 template<class DataType>
 792 class opt_storage<DataType, false, false> {
 793 public:
 794   DataType Value;
 795
 796   // Make sure we initialize the value with the default constructor for the
 797   // type.
 798   opt_storage() : Value(DataType()) {}
 799
 800   template<class T>
 801   void setValue(const T &V) { Value = V; }
 802   DataType &getValue() { return Value; }
 803   DataType getValue() const { return Value; }
 804
 805   // If the datatype is a pointer, support -> on it.
 806   DataType operator->() const { return Value; }
 807 };
 808
 809
 810 //===----------------------------------------------------------------------===//
 811 // opt - A scalar command line option.
 812 //
 813 template <class DataType, bool ExternalStorage = false,
 814           class ParserClass = parser<DataType> >
 815 class opt : public Option,
 816             public opt_storage<DataType, ExternalStorage,
 817                                is_class<DataType>::value> {
 818   ParserClass Parser;
 819
 820   virtual bool handleOccurrence(unsigned pos, const char *ArgName,
 821                                 const std::string &Arg) {
 822     typename ParserClass::parser_data_type Val =
 823        typename ParserClass::parser_data_type();
 824     if (Parser.parse(*this, ArgName, Arg, Val))
 825       return true;                            // Parse error!
 826     this->setValue(Val);
 827     this->setPosition(pos);
 828     return false;
 829   }
 830
 831   virtual enum ValueExpected getValueExpectedFlagDefault() const {
 832     return Parser.getValueExpectedFlagDefault();
 833   }
 834   virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
 835     return Parser.getExtraOptionNames(OptionNames);
 836   }
 837
 838   // Forward printing stuff to the parser...
 839   virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
 840   virtual void printOptionInfo(size_t GlobalWidth) const {
 841     Parser.printOptionInfo(*this, GlobalWidth);
 842   }
 843
 844   void done() {
 845     addArgument();
 846     Parser.initialize(*this);
 847   }
 848 public:
 849   // setInitialValue - Used by the cl::init modifier...
 850   void setInitialValue(const DataType &V) { this->setValue(V); }
 851
 852   ParserClass &getParser() { return Parser; }
 853
 854   operator DataType() const { return this->getValue(); }
 855
 856   template<class T>
 857   DataType &operator=(const T &Val) {
 858     this->setValue(Val);
 859     return this->getValue();
 860   }
 861
 862   // One option...
 863   template<class M0t>
 864   explicit opt(const M0t &M0) : Option(Optional | NotHidden) {
 865     apply(M0, this);
 866     done();
 867   }
 868
 869   // Two options...
 870   template<class M0t, class M1t>
 871   opt(const M0t &M0, const M1t &M1) : Option(Optional | NotHidden) {
 872     apply(M0, this); apply(M1, this);
 873     done();
 874   }
 875
 876   // Three options...
 877   template<class M0t, class M1t, class M2t>
 878   opt(const M0t &M0, const M1t &M1,
 879       const M2t &M2) : Option(Optional | NotHidden) {
 880     apply(M0, this); apply(M1, this); apply(M2, this);
 881     done();
 882   }
 883   // Four options...
 884   template<class M0t, class M1t, class M2t, class M3t>
 885   opt(const M0t &M0, const M1t &M1, const M2t &M2,
 886       const M3t &M3) : Option(Optional | NotHidden) {
 887     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 888     done();
 889   }
 890   // Five options...
 891   template<class M0t, class M1t, class M2t, class M3t, class M4t>
 892   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 893       const M4t &M4) : Option(Optional | NotHidden) {
 894     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 895     apply(M4, this);
 896     done();
 897   }
 898   // Six options...
 899   template<class M0t, class M1t, class M2t, class M3t,
 900            class M4t, class M5t>
 901   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 902       const M4t &M4, const M5t &M5) : Option(Optional | NotHidden) {
 903     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 904     apply(M4, this); apply(M5, this);
 905     done();
 906   }
 907   // Seven options...
 908   template<class M0t, class M1t, class M2t, class M3t,
 909            class M4t, class M5t, class M6t>
 910   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 911       const M4t &M4, const M5t &M5,
 912       const M6t &M6) : Option(Optional | NotHidden) {
 913     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 914     apply(M4, this); apply(M5, this); apply(M6, this);
 915     done();
 916   }
 917   // Eight options...
 918   template<class M0t, class M1t, class M2t, class M3t,
 919            class M4t, class M5t, class M6t, class M7t>
 920   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 921       const M4t &M4, const M5t &M5, const M6t &M6,
 922       const M7t &M7) : Option(Optional | NotHidden) {
 923     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 924     apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
 925     done();
 926   }
 927 };
 928
 929 EXTERN_TEMPLATE_INSTANTIATION(class opt<unsigned>);
 930 EXTERN_TEMPLATE_INSTANTIATION(class opt<int>);
 931 EXTERN_TEMPLATE_INSTANTIATION(class opt<std::string>);
 932 EXTERN_TEMPLATE_INSTANTIATION(class opt<bool>);
 933
 934 //===----------------------------------------------------------------------===//
 935 // list_storage class
 936
 937 // Default storage class definition: external storage.  This implementation
 938 // assumes the user will specify a variable to store the data into with the
 939 // cl::location(x) modifier.
 940 //
 941 template<class DataType, class StorageClass>
 942 class list_storage {
 943   StorageClass *Location;   // Where to store the object...
 944
 945 public:
 946   list_storage() : Location(0) {}
 947
 948   bool setLocation(Option &O, StorageClass &L) {
 949     if (Location)
 950       return O.error(": cl::location(x) specified more than once!");
 951     Location = &L;
 952     return false;
 953   }
 954
 955   template<class T>
 956   void addValue(const T &V) {
 957     assert(Location != 0 && "cl::location(...) not specified for a command "
 958            "line option with external storage!");
 959     Location->push_back(V);
 960   }
 961 };
 962
 963
 964 // Define how to hold a class type object, such as a string.  Since we can
 965 // inherit from a class, we do so.  This makes us exactly compatible with the
 966 // object in all cases that it is used.
 967 //
 968 template<class DataType>
 969 class list_storage<DataType, bool> : public std::vector<DataType> {
 970 public:
 971   template<class T>
 972   void addValue(const T &V) { push_back(V); }
 973 };
 974
 975
 976 //===----------------------------------------------------------------------===//
 977 // list - A list of command line options.
 978 //
 979 template <class DataType, class Storage = bool,
 980           class ParserClass = parser<DataType> >
 981 class list : public Option, public list_storage<DataType, Storage> {
 982   std::vector<unsigned> Positions;
 983   ParserClass Parser;
 984
 985   virtual enum ValueExpected getValueExpectedFlagDefault() const {
 986     return Parser.getValueExpectedFlagDefault();
 987   }
 988   virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
 989     return Parser.getExtraOptionNames(OptionNames);
 990   }
 991
 992   virtual bool handleOccurrence(unsigned pos, const char *ArgName,
 993                                 const std::string &Arg) {
 994     typename ParserClass::parser_data_type Val =
 995       typename ParserClass::parser_data_type();
 996     if (Parser.parse(*this, ArgName, Arg, Val))
 997       return true;  // Parse Error!
 998     addValue(Val);
 999     setPosition(pos);
1000     Positions.push_back(pos);
1001     return false;
1002   }
1003
1004   // Forward printing stuff to the parser...
1005   virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1006   virtual void printOptionInfo(size_t GlobalWidth) const {
1007     Parser.printOptionInfo(*this, GlobalWidth);
1008   }
1009
1010   void done() {
1011     addArgument();
1012     Parser.initialize(*this);
1013   }
1014 public:
1015   ParserClass &getParser() { return Parser; }
1016
1017   unsigned getPosition(unsigned optnum) const {
1018     assert(optnum < this->size() && "Invalid option index");
1019     return Positions[optnum];
1020   }
1021
1022   void setNumAdditionalVals(unsigned n) {
1023     Option::setNumAdditionalVals(n);
1024   }
1025
1026   // One option...
1027   template<class M0t>
1028   explicit list(const M0t &M0) : Option(ZeroOrMore | NotHidden) {
1029     apply(M0, this);
1030     done();
1031   }
1032   // Two options...
1033   template<class M0t, class M1t>
1034   list(const M0t &M0, const M1t &M1) : Option(ZeroOrMore | NotHidden) {
1035     apply(M0, this); apply(M1, this);
1036     done();
1037   }
1038   // Three options...
1039   template<class M0t, class M1t, class M2t>
1040   list(const M0t &M0, const M1t &M1, const M2t &M2)
1041     : Option(ZeroOrMore | NotHidden) {
1042     apply(M0, this); apply(M1, this); apply(M2, this);
1043     done();
1044   }
1045   // Four options...
1046   template<class M0t, class M1t, class M2t, class M3t>
1047   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1048     : Option(ZeroOrMore | NotHidden) {
1049     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1050     done();
1051   }
1052   // Five options...
1053   template<class M0t, class M1t, class M2t, class M3t, class M4t>
1054   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1055        const M4t &M4) : Option(ZeroOrMore | NotHidden) {
1056     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1057     apply(M4, this);
1058     done();
1059   }
1060   // Six options...
1061   template<class M0t, class M1t, class M2t, class M3t,
1062            class M4t, class M5t>
1063   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1064        const M4t &M4, const M5t &M5) : Option(ZeroOrMore | NotHidden) {
1065     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1066     apply(M4, this); apply(M5, this);
1067     done();
1068   }
1069   // Seven options...
1070   template<class M0t, class M1t, class M2t, class M3t,
1071            class M4t, class M5t, class M6t>
1072   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1073        const M4t &M4, const M5t &M5, const M6t &M6)
1074     : Option(ZeroOrMore | NotHidden) {
1075     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1076     apply(M4, this); apply(M5, this); apply(M6, this);
1077     done();
1078   }
1079   // Eight options...
1080   template<class M0t, class M1t, class M2t, class M3t,
1081            class M4t, class M5t, class M6t, class M7t>
1082   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1083        const M4t &M4, const M5t &M5, const M6t &M6,
1084        const M7t &M7) : Option(ZeroOrMore | NotHidden) {
1085     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1086     apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1087     done();
1088   }
1089 };
1090
1091 // multi_arg - Modifier to set the number of additional values.
1092 struct multi_val {
1093   unsigned AdditionalVals;
1094   explicit multi_val(unsigned N) : AdditionalVals(N) {}
1095
1096   template <typename D, typename S, typename P>
1097   void apply(list<D, S, P> &L) const { L.setNumAdditionalVals(AdditionalVals); }
1098 };
1099
1100
1101 //===----------------------------------------------------------------------===//
1102 // bits_storage class
1103
1104 // Default storage class definition: external storage.  This implementation
1105 // assumes the user will specify a variable to store the data into with the
1106 // cl::location(x) modifier.
1107 //
1108 template<class DataType, class StorageClass>
1109 class bits_storage {
1110   unsigned *Location;   // Where to store the bits...
1111
1112   template<class T>
1113   static unsigned Bit(const T &V) {
1114     unsigned BitPos = reinterpret_cast<unsigned>(V);
1115     assert(BitPos < sizeof(unsigned) * 8 &&
1116           "enum exceeds width of bit vector!");
1117     return 1 << BitPos;
1118   }
1119
1120 public:
1121   bits_storage() : Location(0) {}
1122
1123   bool setLocation(Option &O, unsigned &L) {
1124     if (Location)
1125       return O.error(": cl::location(x) specified more than once!");
1126     Location = &L;
1127     return false;
1128   }
1129
1130   template<class T>
1131   void addValue(const T &V) {
1132     assert(Location != 0 && "cl::location(...) not specified for a command "
1133            "line option with external storage!");
1134     *Location |= Bit(V);
1135   }
1136
1137   unsigned getBits() { return *Location; }
1138
1139   template<class T>
1140   bool isSet(const T &V) {
1141     return (*Location & Bit(V)) != 0;
1142   }
1143 };
1144
1145
1146 // Define how to hold bits.  Since we can inherit from a class, we do so.
1147 // This makes us exactly compatible with the bits in all cases that it is used.
1148 //
1149 template<class DataType>
1150 class bits_storage<DataType, bool> {
1151   unsigned Bits;   // Where to store the bits...
1152
1153   template<class T>
1154   static unsigned Bit(const T &V) {
1155     unsigned BitPos = reinterpret_cast<unsigned>(V);
1156     assert(BitPos < sizeof(unsigned) * 8 &&
1157           "enum exceeds width of bit vector!");
1158     return 1 << BitPos;
1159   }
1160
1161 public:
1162   template<class T>
1163   void addValue(const T &V) {
1164     Bits |=  Bit(V);
1165   }
1166
1167   unsigned getBits() { return Bits; }
1168
1169   template<class T>
1170   bool isSet(const T &V) {
1171     return (Bits & Bit(V)) != 0;
1172   }
1173 };
1174
1175
1176 //===----------------------------------------------------------------------===//
1177 // bits - A bit vector of command options.
1178 //
1179 template <class DataType, class Storage = bool,
1180           class ParserClass = parser<DataType> >
1181 class bits : public Option, public bits_storage<DataType, Storage> {
1182   std::vector<unsigned> Positions;
1183   ParserClass Parser;
1184
1185   virtual enum ValueExpected getValueExpectedFlagDefault() const {
1186     return Parser.getValueExpectedFlagDefault();
1187   }
1188   virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
1189     return Parser.getExtraOptionNames(OptionNames);
1190   }
1191
1192   virtual bool handleOccurrence(unsigned pos, const char *ArgName,
1193                                 const std::string &Arg) {
1194     typename ParserClass::parser_data_type Val =
1195       typename ParserClass::parser_data_type();
1196     if (Parser.parse(*this, ArgName, Arg, Val))
1197       return true;  // Parse Error!
1198     addValue(Val);
1199     setPosition(pos);
1200     Positions.push_back(pos);
1201     return false;
1202   }
1203
1204   // Forward printing stuff to the parser...
1205   virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1206   virtual void printOptionInfo(size_t GlobalWidth) const {
1207     Parser.printOptionInfo(*this, GlobalWidth);
1208   }
1209
1210   void done() {
1211     addArgument();
1212     Parser.initialize(*this);
1213   }
1214 public:
1215   ParserClass &getParser() { return Parser; }
1216
1217   unsigned getPosition(unsigned optnum) const {
1218     assert(optnum < this->size() && "Invalid option index");
1219     return Positions[optnum];
1220   }
1221
1222   // One option...
1223   template<class M0t>
1224   explicit bits(const M0t &M0) : Option(ZeroOrMore | NotHidden) {
1225     apply(M0, this);
1226     done();
1227   }
1228   // Two options...
1229   template<class M0t, class M1t>
1230   bits(const M0t &M0, const M1t &M1) : Option(ZeroOrMore | NotHidden) {
1231     apply(M0, this); apply(M1, this);
1232     done();
1233   }
1234   // Three options...
1235   template<class M0t, class M1t, class M2t>
1236   bits(const M0t &M0, const M1t &M1, const M2t &M2)
1237     : Option(ZeroOrMore | NotHidden) {
1238     apply(M0, this); apply(M1, this); apply(M2, this);
1239     done();
1240   }
1241   // Four options...
1242   template<class M0t, class M1t, class M2t, class M3t>
1243   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1244     : Option(ZeroOrMore | NotHidden) {
1245     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1246     done();
1247   }
1248   // Five options...
1249   template<class M0t, class M1t, class M2t, class M3t, class M4t>
1250   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1251        const M4t &M4) : Option(ZeroOrMore | NotHidden) {
1252     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1253     apply(M4, this);
1254     done();
1255   }
1256   // Six options...
1257   template<class M0t, class M1t, class M2t, class M3t,
1258            class M4t, class M5t>
1259   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1260        const M4t &M4, const M5t &M5) : Option(ZeroOrMore | NotHidden) {
1261     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1262     apply(M4, this); apply(M5, this);
1263     done();
1264   }
1265   // Seven options...
1266   template<class M0t, class M1t, class M2t, class M3t,
1267            class M4t, class M5t, class M6t>
1268   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1269        const M4t &M4, const M5t &M5, const M6t &M6)
1270     : Option(ZeroOrMore | NotHidden) {
1271     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1272     apply(M4, this); apply(M5, this); apply(M6, this);
1273     done();
1274   }
1275   // Eight options...
1276   template<class M0t, class M1t, class M2t, class M3t,
1277            class M4t, class M5t, class M6t, class M7t>
1278   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1279        const M4t &M4, const M5t &M5, const M6t &M6,
1280        const M7t &M7) : Option(ZeroOrMore | NotHidden) {
1281     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1282     apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1283     done();
1284   }
1285 };
1286
1287 //===----------------------------------------------------------------------===//
1288 // Aliased command line option (alias this name to a preexisting name)
1289 //
1290
1291 class alias : public Option {
1292   Option *AliasFor;
1293   virtual bool handleOccurrence(unsigned pos, const char * /*ArgName*/,
1294                                 const std::string &Arg) {
1295     return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg);
1296   }
1297   // Handle printing stuff...
1298   virtual size_t getOptionWidth() const;
1299   virtual void printOptionInfo(size_t GlobalWidth) const;
1300
1301   void done() {
1302     if (!hasArgStr())
1303       error(": cl::alias must have argument name specified!");
1304     if (AliasFor == 0)
1305       error(": cl::alias must have an cl::aliasopt(option) specified!");
1306       addArgument();
1307   }
1308 public:
1309   void setAliasFor(Option &O) {
1310     if (AliasFor)
1311       error(": cl::alias must only have one cl::aliasopt(...) specified!");
1312     AliasFor = &O;
1313   }
1314
1315   // One option...
1316   template<class M0t>
1317   explicit alias(const M0t &M0) : Option(Optional | Hidden), AliasFor(0) {
1318     apply(M0, this);
1319     done();
1320   }
1321   // Two options...
1322   template<class M0t, class M1t>
1323   alias(const M0t &M0, const M1t &M1) : Option(Optional | Hidden), AliasFor(0) {
1324     apply(M0, this); apply(M1, this);
1325     done();
1326   }
1327   // Three options...
1328   template<class M0t, class M1t, class M2t>
1329   alias(const M0t &M0, const M1t &M1, const M2t &M2)
1330     : Option(Optional | Hidden), AliasFor(0) {
1331     apply(M0, this); apply(M1, this); apply(M2, this);
1332     done();
1333   }
1334   // Four options...
1335   template<class M0t, class M1t, class M2t, class M3t>
1336   alias(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1337     : Option(Optional | Hidden), AliasFor(0) {
1338     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1339     done();
1340   }
1341 };
1342
1343 // aliasfor - Modifier to set the option an alias aliases.
1344 struct aliasopt {
1345   Option &Opt;
1346   explicit aliasopt(Option &O) : Opt(O) {}
1347   void apply(alias &A) const { A.setAliasFor(Opt); }
1348 };
1349
1350 // extrahelp - provide additional help at the end of the normal help
1351 // output. All occurrences of cl::extrahelp will be accumulated and
1352 // printed to std::cerr at the end of the regular help, just before
1353 // exit is called.
1354 struct extrahelp {
1355   const char * morehelp;
1356   explicit extrahelp(const char* help);
1357 };
1358
1359 void PrintVersionMessage();
1360 // This function just prints the help message, exactly the same way as if the
1361 // --help option had been given on the command line.
1362 // NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
1363 void PrintHelpMessage();
1364
1365 } // End namespace cl
1366
1367 } // End namespace llvm
1368
1369 #endif