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     if (IsInvertable) {
 545       char *s = new char [strlen(ArgStr) + 3 + 1];
 546       s[0] = ArgStr[0];
 547       if (strncmp(ArgStr+1, "no-", 3) == 0)
 548         strcpy(&s[1], &ArgStr[4]);
 549       else {
 550         s[1] = 'n';
 551         s[2] = 'o';
 552         s[3] = '-';
 553         strcpy(&s[4], ArgStr+1);
 554       }
 555       OptionNames.push_back(s);
 556     }
 557   }
 558
 559   // parse - Return true on error.
 560   bool parse(Option &O, const char *ArgName, const std::string &Arg, bool &Val);
 561
 562   template <class Opt>
 563   void initialize(Opt &O) {
 564     if (O.getMiscFlags() & llvm::cl::AllowInverse)
 565       IsInvertable = true;
 566     else
 567       IsInvertable = false;
 568     ArgStr = O.ArgStr;
 569   }
 570
 571   enum ValueExpected getValueExpectedFlagDefault() const {
 572     return ValueOptional;
 573   }
 574
 575   // getValueName - Do not print =<value> at all.
 576   virtual const char *getValueName() const { return 0; }
 577
 578   // An out-of-line virtual method to provide a 'home' for this class.
 579   virtual void anchor();
 580 };
 581
 582 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<bool>);
 583
 584 //--------------------------------------------------
 585 // parser<boolOrDefault>
 586 enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE };
 587 template<>
 588 class parser<boolOrDefault> : public basic_parser<boolOrDefault> {
 589 public:
 590   // parse - Return true on error.
 591   bool parse(Option &O, const char *ArgName, const std::string &Arg,
 592              boolOrDefault &Val);
 593
 594   enum ValueExpected getValueExpectedFlagDefault() const {
 595     return ValueOptional;
 596   }
 597
 598   // getValueName - Do not print =<value> at all.
 599   virtual const char *getValueName() const { return 0; }
 600
 601   // An out-of-line virtual method to provide a 'home' for this class.
 602   virtual void anchor();
 603 };
 604
 605 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
 606
 607 //--------------------------------------------------
 608 // parser<int>
 609 //
 610 template<>
 611 class parser<int> : public basic_parser<int> {
 612 public:
 613   // parse - Return true on error.
 614   bool parse(Option &O, const char *ArgName, const std::string &Arg, int &Val);
 615
 616   // getValueName - Overload in subclass to provide a better default value.
 617   virtual const char *getValueName() const { return "int"; }
 618
 619   // An out-of-line virtual method to provide a 'home' for this class.
 620   virtual void anchor();
 621 };
 622
 623 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<int>);
 624
 625
 626 //--------------------------------------------------
 627 // parser<unsigned>
 628 //
 629 template<>
 630 class parser<unsigned> : public basic_parser<unsigned> {
 631 public:
 632   // parse - Return true on error.
 633   bool parse(Option &O, const char *AN, const std::string &Arg, unsigned &Val);
 634
 635   // getValueName - Overload in subclass to provide a better default value.
 636   virtual const char *getValueName() const { return "uint"; }
 637
 638   // An out-of-line virtual method to provide a 'home' for this class.
 639   virtual void anchor();
 640 };
 641
 642 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
 643
 644 //--------------------------------------------------
 645 // parser<double>
 646 //
 647 template<>
 648 class parser<double> : public basic_parser<double> {
 649 public:
 650   // parse - Return true on error.
 651   bool parse(Option &O, const char *AN, const std::string &Arg, double &Val);
 652
 653   // getValueName - Overload in subclass to provide a better default value.
 654   virtual const char *getValueName() const { return "number"; }
 655
 656   // An out-of-line virtual method to provide a 'home' for this class.
 657   virtual void anchor();
 658 };
 659
 660 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<double>);
 661
 662 //--------------------------------------------------
 663 // parser<float>
 664 //
 665 template<>
 666 class parser<float> : public basic_parser<float> {
 667 public:
 668   // parse - Return true on error.
 669   bool parse(Option &O, const char *AN, const std::string &Arg, float &Val);
 670
 671   // getValueName - Overload in subclass to provide a better default value.
 672   virtual const char *getValueName() const { return "number"; }
 673
 674   // An out-of-line virtual method to provide a 'home' for this class.
 675   virtual void anchor();
 676 };
 677
 678 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<float>);
 679
 680 //--------------------------------------------------
 681 // parser<std::string>
 682 //
 683 template<>
 684 class parser<std::string> : public basic_parser<std::string> {
 685 public:
 686   // parse - Return true on error.
 687   bool parse(Option &, const char *, const std::string &Arg,
 688              std::string &Value) {
 689     Value = Arg;
 690     return false;
 691   }
 692
 693   // getValueName - Overload in subclass to provide a better default value.
 694   virtual const char *getValueName() const { return "string"; }
 695
 696   // An out-of-line virtual method to provide a 'home' for this class.
 697   virtual void anchor();
 698 };
 699
 700 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
 701
 702 //===----------------------------------------------------------------------===//
 703 // applicator class - This class is used because we must use partial
 704 // specialization to handle literal string arguments specially (const char* does
 705 // not correctly respond to the apply method).  Because the syntax to use this
 706 // is a pain, we have the 'apply' method below to handle the nastiness...
 707 //
 708 template<class Mod> struct applicator {
 709   template<class Opt>
 710   static void opt(const Mod &M, Opt &O) { M.apply(O); }
 711 };
 712
 713 // Handle const char* as a special case...
 714 template<unsigned n> struct applicator<char[n]> {
 715   template<class Opt>
 716   static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
 717 };
 718 template<unsigned n> struct applicator<const char[n]> {
 719   template<class Opt>
 720   static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
 721 };
 722 template<> struct applicator<const char*> {
 723   template<class Opt>
 724   static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
 725 };
 726
 727 template<> struct applicator<NumOccurrences> {
 728   static void opt(NumOccurrences NO, Option &O) { O.setNumOccurrencesFlag(NO); }
 729 };
 730 template<> struct applicator<ValueExpected> {
 731   static void opt(ValueExpected VE, Option &O) { O.setValueExpectedFlag(VE); }
 732 };
 733 template<> struct applicator<OptionHidden> {
 734   static void opt(OptionHidden OH, Option &O) { O.setHiddenFlag(OH); }
 735 };
 736 template<> struct applicator<FormattingFlags> {
 737   static void opt(FormattingFlags FF, Option &O) { O.setFormattingFlag(FF); }
 738 };
 739 template<> struct applicator<MiscFlags> {
 740   static void opt(MiscFlags MF, Option &O) { O.setMiscFlag(MF); }
 741 };
 742
 743 // apply method - Apply a modifier to an option in a type safe way.
 744 template<class Mod, class Opt>
 745 void apply(const Mod &M, Opt *O) {
 746   applicator<Mod>::opt(M, *O);
 747 }
 748
 749
 750 //===----------------------------------------------------------------------===//
 751 // opt_storage class
 752
 753 // Default storage class definition: external storage.  This implementation
 754 // assumes the user will specify a variable to store the data into with the
 755 // cl::location(x) modifier.
 756 //
 757 template<class DataType, bool ExternalStorage, bool isClass>
 758 class opt_storage {
 759   DataType *Location;   // Where to store the object...
 760
 761   void check() {
 762     assert(Location != 0 && "cl::location(...) not specified for a command "
 763            "line option with external storage, "
 764            "or cl::init specified before cl::location()!!");
 765   }
 766 public:
 767   opt_storage() : Location(0) {}
 768
 769   bool setLocation(Option &O, DataType &L) {
 770     if (Location)
 771       return O.error(": cl::location(x) specified more than once!");
 772     Location = &L;
 773     return false;
 774   }
 775
 776   template<class T>
 777   void setValue(const T &V) {
 778     check();
 779     *Location = V;
 780   }
 781
 782   DataType &getValue() { check(); return *Location; }
 783   const DataType &getValue() const { check(); return *Location; }
 784 };
 785
 786
 787 // Define how to hold a class type object, such as a string.  Since we can
 788 // inherit from a class, we do so.  This makes us exactly compatible with the
 789 // object in all cases that it is used.
 790 //
 791 template<class DataType>
 792 class opt_storage<DataType,false,true> : public DataType {
 793 public:
 794   template<class T>
 795   void setValue(const T &V) { DataType::operator=(V); }
 796
 797   DataType &getValue() { return *this; }
 798   const DataType &getValue() const { return *this; }
 799 };
 800
 801 // Define a partial specialization to handle things we cannot inherit from.  In
 802 // this case, we store an instance through containment, and overload operators
 803 // to get at the value.
 804 //
 805 template<class DataType>
 806 class opt_storage<DataType, false, false> {
 807 public:
 808   DataType Value;
 809
 810   // Make sure we initialize the value with the default constructor for the
 811   // type.
 812   opt_storage() : Value(DataType()) {}
 813
 814   template<class T>
 815   void setValue(const T &V) { Value = V; }
 816   DataType &getValue() { return Value; }
 817   DataType getValue() const { return Value; }
 818
 819   // If the datatype is a pointer, support -> on it.
 820   DataType operator->() const { return Value; }
 821 };
 822
 823
 824 //===----------------------------------------------------------------------===//
 825 // opt - A scalar command line option.
 826 //
 827 template <class DataType, bool ExternalStorage = false,
 828           class ParserClass = parser<DataType> >
 829 class opt : public Option,
 830             public opt_storage<DataType, ExternalStorage,
 831                                is_class<DataType>::value> {
 832   ParserClass Parser;
 833
 834   virtual bool handleOccurrence(unsigned pos, const char *ArgName,
 835                                 const std::string &Arg) {
 836     typename ParserClass::parser_data_type Val =
 837        typename ParserClass::parser_data_type();
 838     if (Parser.parse(*this, ArgName, Arg, Val))
 839       return true;                            // Parse error!
 840     this->setValue(Val);
 841     this->setPosition(pos);
 842     return false;
 843   }
 844
 845   virtual enum ValueExpected getValueExpectedFlagDefault() const {
 846     return Parser.getValueExpectedFlagDefault();
 847   }
 848   virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
 849     return Parser.getExtraOptionNames(OptionNames);
 850   }
 851
 852   // Forward printing stuff to the parser...
 853   virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
 854   virtual void printOptionInfo(size_t GlobalWidth) const {
 855     Parser.printOptionInfo(*this, GlobalWidth);
 856   }
 857
 858   void done() {
 859     addArgument();
 860     Parser.initialize(*this);
 861   }
 862 public:
 863   // setInitialValue - Used by the cl::init modifier...
 864   void setInitialValue(const DataType &V) { this->setValue(V); }
 865
 866   ParserClass &getParser() { return Parser; }
 867
 868   operator DataType() const { return this->getValue(); }
 869
 870   template<class T>
 871   DataType &operator=(const T &Val) {
 872     this->setValue(Val);
 873     return this->getValue();
 874   }
 875
 876   // One option...
 877   template<class M0t>
 878   explicit opt(const M0t &M0) : Option(Optional | NotHidden) {
 879     apply(M0, this);
 880     done();
 881   }
 882
 883   // Two options...
 884   template<class M0t, class M1t>
 885   opt(const M0t &M0, const M1t &M1) : Option(Optional | NotHidden) {
 886     apply(M0, this); apply(M1, this);
 887     done();
 888   }
 889
 890   // Three options...
 891   template<class M0t, class M1t, class M2t>
 892   opt(const M0t &M0, const M1t &M1,
 893       const M2t &M2) : Option(Optional | NotHidden) {
 894     apply(M0, this); apply(M1, this); apply(M2, this);
 895     done();
 896   }
 897   // Four options...
 898   template<class M0t, class M1t, class M2t, class M3t>
 899   opt(const M0t &M0, const M1t &M1, const M2t &M2,
 900       const M3t &M3) : Option(Optional | NotHidden) {
 901     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 902     done();
 903   }
 904   // Five options...
 905   template<class M0t, class M1t, class M2t, class M3t, class M4t>
 906   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 907       const M4t &M4) : Option(Optional | NotHidden) {
 908     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 909     apply(M4, this);
 910     done();
 911   }
 912   // Six options...
 913   template<class M0t, class M1t, class M2t, class M3t,
 914            class M4t, class M5t>
 915   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 916       const M4t &M4, const M5t &M5) : Option(Optional | NotHidden) {
 917     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 918     apply(M4, this); apply(M5, this);
 919     done();
 920   }
 921   // Seven options...
 922   template<class M0t, class M1t, class M2t, class M3t,
 923            class M4t, class M5t, class M6t>
 924   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 925       const M4t &M4, const M5t &M5,
 926       const M6t &M6) : Option(Optional | NotHidden) {
 927     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 928     apply(M4, this); apply(M5, this); apply(M6, this);
 929     done();
 930   }
 931   // Eight options...
 932   template<class M0t, class M1t, class M2t, class M3t,
 933            class M4t, class M5t, class M6t, class M7t>
 934   opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
 935       const M4t &M4, const M5t &M5, const M6t &M6,
 936       const M7t &M7) : Option(Optional | NotHidden) {
 937     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
 938     apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
 939     done();
 940   }
 941 };
 942
 943 EXTERN_TEMPLATE_INSTANTIATION(class opt<unsigned>);
 944 EXTERN_TEMPLATE_INSTANTIATION(class opt<int>);
 945 EXTERN_TEMPLATE_INSTANTIATION(class opt<std::string>);
 946 EXTERN_TEMPLATE_INSTANTIATION(class opt<bool>);
 947
 948 //===----------------------------------------------------------------------===//
 949 // list_storage class
 950
 951 // Default storage class definition: external storage.  This implementation
 952 // assumes the user will specify a variable to store the data into with the
 953 // cl::location(x) modifier.
 954 //
 955 template<class DataType, class StorageClass>
 956 class list_storage {
 957   StorageClass *Location;   // Where to store the object...
 958
 959 public:
 960   list_storage() : Location(0) {}
 961
 962   bool setLocation(Option &O, StorageClass &L) {
 963     if (Location)
 964       return O.error(": cl::location(x) specified more than once!");
 965     Location = &L;
 966     return false;
 967   }
 968
 969   template<class T>
 970   void addValue(const T &V) {
 971     assert(Location != 0 && "cl::location(...) not specified for a command "
 972            "line option with external storage!");
 973     Location->push_back(V);
 974   }
 975 };
 976
 977
 978 // Define how to hold a class type object, such as a string.  Since we can
 979 // inherit from a class, we do so.  This makes us exactly compatible with the
 980 // object in all cases that it is used.
 981 //
 982 template<class DataType>
 983 class list_storage<DataType, bool> : public std::vector<DataType> {
 984 public:
 985   template<class T>
 986   void addValue(const T &V) { push_back(V); }
 987 };
 988
 989
 990 //===----------------------------------------------------------------------===//
 991 // list - A list of command line options.
 992 //
 993 template <class DataType, class Storage = bool,
 994           class ParserClass = parser<DataType> >
 995 class list : public Option, public list_storage<DataType, Storage> {
 996   std::vector<unsigned> Positions;
 997   ParserClass Parser;
 998
 999   virtual enum ValueExpected getValueExpectedFlagDefault() const {
1000     return Parser.getValueExpectedFlagDefault();
1001   }
1002   virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
1003     return Parser.getExtraOptionNames(OptionNames);
1004   }
1005
1006   virtual bool handleOccurrence(unsigned pos, const char *ArgName,
1007                                 const std::string &Arg) {
1008     typename ParserClass::parser_data_type Val =
1009       typename ParserClass::parser_data_type();
1010     if (Parser.parse(*this, ArgName, Arg, Val))
1011       return true;  // Parse Error!
1012     addValue(Val);
1013     setPosition(pos);
1014     Positions.push_back(pos);
1015     return false;
1016   }
1017
1018   // Forward printing stuff to the parser...
1019   virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1020   virtual void printOptionInfo(size_t GlobalWidth) const {
1021     Parser.printOptionInfo(*this, GlobalWidth);
1022   }
1023
1024   void done() {
1025     addArgument();
1026     Parser.initialize(*this);
1027   }
1028 public:
1029   ParserClass &getParser() { return Parser; }
1030
1031   unsigned getPosition(unsigned optnum) const {
1032     assert(optnum < this->size() && "Invalid option index");
1033     return Positions[optnum];
1034   }
1035
1036   void setNumAdditionalVals(unsigned n) {
1037     Option::setNumAdditionalVals(n);
1038   }
1039
1040   // One option...
1041   template<class M0t>
1042   explicit list(const M0t &M0) : Option(ZeroOrMore | NotHidden) {
1043     apply(M0, this);
1044     done();
1045   }
1046   // Two options...
1047   template<class M0t, class M1t>
1048   list(const M0t &M0, const M1t &M1) : Option(ZeroOrMore | NotHidden) {
1049     apply(M0, this); apply(M1, this);
1050     done();
1051   }
1052   // Three options...
1053   template<class M0t, class M1t, class M2t>
1054   list(const M0t &M0, const M1t &M1, const M2t &M2)
1055     : Option(ZeroOrMore | NotHidden) {
1056     apply(M0, this); apply(M1, this); apply(M2, this);
1057     done();
1058   }
1059   // Four options...
1060   template<class M0t, class M1t, class M2t, class M3t>
1061   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1062     : Option(ZeroOrMore | NotHidden) {
1063     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1064     done();
1065   }
1066   // Five options...
1067   template<class M0t, class M1t, class M2t, class M3t, class M4t>
1068   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1069        const M4t &M4) : Option(ZeroOrMore | NotHidden) {
1070     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1071     apply(M4, this);
1072     done();
1073   }
1074   // Six options...
1075   template<class M0t, class M1t, class M2t, class M3t,
1076            class M4t, class M5t>
1077   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1078        const M4t &M4, const M5t &M5) : Option(ZeroOrMore | NotHidden) {
1079     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1080     apply(M4, this); apply(M5, this);
1081     done();
1082   }
1083   // Seven options...
1084   template<class M0t, class M1t, class M2t, class M3t,
1085            class M4t, class M5t, class M6t>
1086   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1087        const M4t &M4, const M5t &M5, const M6t &M6)
1088     : Option(ZeroOrMore | NotHidden) {
1089     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1090     apply(M4, this); apply(M5, this); apply(M6, this);
1091     done();
1092   }
1093   // Eight options...
1094   template<class M0t, class M1t, class M2t, class M3t,
1095            class M4t, class M5t, class M6t, class M7t>
1096   list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1097        const M4t &M4, const M5t &M5, const M6t &M6,
1098        const M7t &M7) : Option(ZeroOrMore | NotHidden) {
1099     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1100     apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1101     done();
1102   }
1103 };
1104
1105 // multi_arg - Modifier to set the number of additional values.
1106 struct multi_val {
1107   unsigned AdditionalVals;
1108   explicit multi_val(unsigned N) : AdditionalVals(N) {}
1109
1110   template <typename D, typename S, typename P>
1111   void apply(list<D, S, P> &L) const { L.setNumAdditionalVals(AdditionalVals); }
1112 };
1113
1114
1115 //===----------------------------------------------------------------------===//
1116 // bits_storage class
1117
1118 // Default storage class definition: external storage.  This implementation
1119 // assumes the user will specify a variable to store the data into with the
1120 // cl::location(x) modifier.
1121 //
1122 template<class DataType, class StorageClass>
1123 class bits_storage {
1124   unsigned *Location;   // Where to store the bits...
1125
1126   template<class T>
1127   static unsigned Bit(const T &V) {
1128     unsigned BitPos = reinterpret_cast<unsigned>(V);
1129     assert(BitPos < sizeof(unsigned) * 8 &&
1130           "enum exceeds width of bit vector!");
1131     return 1 << BitPos;
1132   }
1133
1134 public:
1135   bits_storage() : Location(0) {}
1136
1137   bool setLocation(Option &O, unsigned &L) {
1138     if (Location)
1139       return O.error(": cl::location(x) specified more than once!");
1140     Location = &L;
1141     return false;
1142   }
1143
1144   template<class T>
1145   void addValue(const T &V) {
1146     assert(Location != 0 && "cl::location(...) not specified for a command "
1147            "line option with external storage!");
1148     *Location |= Bit(V);
1149   }
1150
1151   unsigned getBits() { return *Location; }
1152
1153   template<class T>
1154   bool isSet(const T &V) {
1155     return (*Location & Bit(V)) != 0;
1156   }
1157 };
1158
1159
1160 // Define how to hold bits.  Since we can inherit from a class, we do so.
1161 // This makes us exactly compatible with the bits in all cases that it is used.
1162 //
1163 template<class DataType>
1164 class bits_storage<DataType, bool> {
1165   unsigned Bits;   // Where to store the bits...
1166
1167   template<class T>
1168   static unsigned Bit(const T &V) {
1169     unsigned BitPos = reinterpret_cast<unsigned>(V);
1170     assert(BitPos < sizeof(unsigned) * 8 &&
1171           "enum exceeds width of bit vector!");
1172     return 1 << BitPos;
1173   }
1174
1175 public:
1176   template<class T>
1177   void addValue(const T &V) {
1178     Bits |=  Bit(V);
1179   }
1180
1181   unsigned getBits() { return Bits; }
1182
1183   template<class T>
1184   bool isSet(const T &V) {
1185     return (Bits & Bit(V)) != 0;
1186   }
1187 };
1188
1189
1190 //===----------------------------------------------------------------------===//
1191 // bits - A bit vector of command options.
1192 //
1193 template <class DataType, class Storage = bool,
1194           class ParserClass = parser<DataType> >
1195 class bits : public Option, public bits_storage<DataType, Storage> {
1196   std::vector<unsigned> Positions;
1197   ParserClass Parser;
1198
1199   virtual enum ValueExpected getValueExpectedFlagDefault() const {
1200     return Parser.getValueExpectedFlagDefault();
1201   }
1202   virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
1203     return Parser.getExtraOptionNames(OptionNames);
1204   }
1205
1206   virtual bool handleOccurrence(unsigned pos, const char *ArgName,
1207                                 const std::string &Arg) {
1208     typename ParserClass::parser_data_type Val =
1209       typename ParserClass::parser_data_type();
1210     if (Parser.parse(*this, ArgName, Arg, Val))
1211       return true;  // Parse Error!
1212     addValue(Val);
1213     setPosition(pos);
1214     Positions.push_back(pos);
1215     return false;
1216   }
1217
1218   // Forward printing stuff to the parser...
1219   virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1220   virtual void printOptionInfo(size_t GlobalWidth) const {
1221     Parser.printOptionInfo(*this, GlobalWidth);
1222   }
1223
1224   void done() {
1225     addArgument();
1226     Parser.initialize(*this);
1227   }
1228 public:
1229   ParserClass &getParser() { return Parser; }
1230
1231   unsigned getPosition(unsigned optnum) const {
1232     assert(optnum < this->size() && "Invalid option index");
1233     return Positions[optnum];
1234   }
1235
1236   // One option...
1237   template<class M0t>
1238   explicit bits(const M0t &M0) : Option(ZeroOrMore | NotHidden) {
1239     apply(M0, this);
1240     done();
1241   }
1242   // Two options...
1243   template<class M0t, class M1t>
1244   bits(const M0t &M0, const M1t &M1) : Option(ZeroOrMore | NotHidden) {
1245     apply(M0, this); apply(M1, this);
1246     done();
1247   }
1248   // Three options...
1249   template<class M0t, class M1t, class M2t>
1250   bits(const M0t &M0, const M1t &M1, const M2t &M2)
1251     : Option(ZeroOrMore | NotHidden) {
1252     apply(M0, this); apply(M1, this); apply(M2, this);
1253     done();
1254   }
1255   // Four options...
1256   template<class M0t, class M1t, class M2t, class M3t>
1257   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1258     : Option(ZeroOrMore | NotHidden) {
1259     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1260     done();
1261   }
1262   // Five options...
1263   template<class M0t, class M1t, class M2t, class M3t, class M4t>
1264   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1265        const M4t &M4) : Option(ZeroOrMore | NotHidden) {
1266     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1267     apply(M4, this);
1268     done();
1269   }
1270   // Six options...
1271   template<class M0t, class M1t, class M2t, class M3t,
1272            class M4t, class M5t>
1273   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1274        const M4t &M4, const M5t &M5) : Option(ZeroOrMore | NotHidden) {
1275     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1276     apply(M4, this); apply(M5, this);
1277     done();
1278   }
1279   // Seven options...
1280   template<class M0t, class M1t, class M2t, class M3t,
1281            class M4t, class M5t, class M6t>
1282   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1283        const M4t &M4, const M5t &M5, const M6t &M6)
1284     : Option(ZeroOrMore | NotHidden) {
1285     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1286     apply(M4, this); apply(M5, this); apply(M6, this);
1287     done();
1288   }
1289   // Eight options...
1290   template<class M0t, class M1t, class M2t, class M3t,
1291            class M4t, class M5t, class M6t, class M7t>
1292   bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1293        const M4t &M4, const M5t &M5, const M6t &M6,
1294        const M7t &M7) : Option(ZeroOrMore | NotHidden) {
1295     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1296     apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1297     done();
1298   }
1299 };
1300
1301 //===----------------------------------------------------------------------===//
1302 // Aliased command line option (alias this name to a preexisting name)
1303 //
1304
1305 class alias : public Option {
1306   Option *AliasFor;
1307   virtual bool handleOccurrence(unsigned pos, const char * /*ArgName*/,
1308                                 const std::string &Arg) {
1309     return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg);
1310   }
1311   // Handle printing stuff...
1312   virtual size_t getOptionWidth() const;
1313   virtual void printOptionInfo(size_t GlobalWidth) const;
1314
1315   void done() {
1316     if (!hasArgStr())
1317       error(": cl::alias must have argument name specified!");
1318     if (AliasFor == 0)
1319       error(": cl::alias must have an cl::aliasopt(option) specified!");
1320       addArgument();
1321   }
1322 public:
1323   void setAliasFor(Option &O) {
1324     if (AliasFor)
1325       error(": cl::alias must only have one cl::aliasopt(...) specified!");
1326     AliasFor = &O;
1327   }
1328
1329   // One option...
1330   template<class M0t>
1331   explicit alias(const M0t &M0) : Option(Optional | Hidden), AliasFor(0) {
1332     apply(M0, this);
1333     done();
1334   }
1335   // Two options...
1336   template<class M0t, class M1t>
1337   alias(const M0t &M0, const M1t &M1) : Option(Optional | Hidden), AliasFor(0) {
1338     apply(M0, this); apply(M1, this);
1339     done();
1340   }
1341   // Three options...
1342   template<class M0t, class M1t, class M2t>
1343   alias(const M0t &M0, const M1t &M1, const M2t &M2)
1344     : Option(Optional | Hidden), AliasFor(0) {
1345     apply(M0, this); apply(M1, this); apply(M2, this);
1346     done();
1347   }
1348   // Four options...
1349   template<class M0t, class M1t, class M2t, class M3t>
1350   alias(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1351     : Option(Optional | Hidden), AliasFor(0) {
1352     apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1353     done();
1354   }
1355 };
1356
1357 // aliasfor - Modifier to set the option an alias aliases.
1358 struct aliasopt {
1359   Option &Opt;
1360   explicit aliasopt(Option &O) : Opt(O) {}
1361   void apply(alias &A) const { A.setAliasFor(Opt); }
1362 };
1363
1364 // extrahelp - provide additional help at the end of the normal help
1365 // output. All occurrences of cl::extrahelp will be accumulated and
1366 // printed to std::cerr at the end of the regular help, just before
1367 // exit is called.
1368 struct extrahelp {
1369   const char * morehelp;
1370   explicit extrahelp(const char* help);
1371 };
1372
1373 void PrintVersionMessage();
1374 // This function just prints the help message, exactly the same way as if the
1375 // --help option had been given on the command line.
1376 // NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
1377 void PrintHelpMessage();
1378
1379 } // End namespace cl
1380
1381 } // End namespace llvm
1382
1383 #endif