lib/Support/CommandLine.cpp

   1 //===-- CommandLine.cpp - Command line parser implementation --------------===//
   2 //
   3 // This class implements a command line argument processor that is useful when
   4 // creating a tool.  It provides a simple, minimalistic interface that is easily
   5 // extensible and supports nonlocal (library) command line options.
   6 //
   7 // Note that rather than trying to figure out what this code does, you could try
   8 // reading the library documentation located in docs/CommandLine.html
   9 //
  10 //===----------------------------------------------------------------------===//
  11
  12 #include "Support/CommandLine.h"
  13 #include <algorithm>
  14 #include <map>
  15 #include <set>
  16 #include <iostream>
  17
  18 using namespace cl;
  19
  20 //===----------------------------------------------------------------------===//
  21 // Basic, shared command line option processing machinery...
  22 //
  23
  24 // Return the global command line option vector.  Making it a function scoped
  25 // static ensures that it will be initialized correctly before its first use.
  26 //
  27 static std::map<std::string, Option*> *CommandLineOptions = 0;
  28 static std::map<std::string, Option*> &getOpts() {
  29   if (CommandLineOptions == 0)
  30     CommandLineOptions = new std::map<std::string,Option*>();
  31   return *CommandLineOptions;
  32 }
  33
  34 static Option *getOption(const std::string &Str) {
  35   if (CommandLineOptions == 0) return 0;
  36   std::map<std::string,Option*>::iterator I = CommandLineOptions->find(Str);
  37   return I != CommandLineOptions->end() ? I->second : 0;
  38 }
  39
  40 static std::vector<Option*> &getPositionalOpts() {
  41   static std::vector<Option*> Positional;
  42   return Positional;
  43 }
  44
  45 static void AddArgument(const char *ArgName, Option *Opt) {
  46   if (getOption(ArgName)) {
  47     std::cerr << "CommandLine Error: Argument '" << ArgName
  48               << "' defined more than once!\n";
  49   } else {
  50     // Add argument to the argument map!
  51     getOpts()[ArgName] = Opt;
  52   }
  53 }
  54
  55 // RemoveArgument - It's possible that the argument is no longer in the map if
  56 // options have already been processed and the map has been deleted!
  57 //
  58 static void RemoveArgument(const char *ArgName, Option *Opt) {
  59   if (CommandLineOptions == 0) return;
  60   assert(getOption(ArgName) == Opt && "Arg not in map!");
  61   CommandLineOptions->erase(ArgName);
  62   if (CommandLineOptions->empty()) {
  63     delete CommandLineOptions;
  64     CommandLineOptions = 0;
  65   }
  66 }
  67
  68 static const char *ProgramName = 0;
  69 static const char *ProgramOverview = 0;
  70
  71 static inline bool ProvideOption(Option *Handler, const char *ArgName,
  72                                  const char *Value, int argc, char **argv,
  73                                  int &i) {
  74   // Enforce value requirements
  75   switch (Handler->getValueExpectedFlag()) {
  76   case ValueRequired:
  77     if (Value == 0 || *Value == 0) {  // No value specified?
  78       if (i+1 < argc) {     // Steal the next argument, like for '-o filename'
  79         Value = argv[++i];
  80       } else {
  81         return Handler->error(" requires a value!");
  82       }
  83     }
  84     break;
  85   case ValueDisallowed:
  86     if (*Value != 0)
  87       return Handler->error(" does not allow a value! '" +
  88                             std::string(Value) + "' specified.");
  89     break;
  90   case ValueOptional: break;
  91   default: std::cerr << "Bad ValueMask flag! CommandLine usage error:"
  92                      << Handler->getValueExpectedFlag() << "\n"; abort();
  93   }
  94
  95   // Run the handler now!
  96   return Handler->addOccurrence(ArgName, Value);
  97 }
  98
  99 static bool ProvidePositionalOption(Option *Handler, const std::string &Arg) {
 100   int Dummy;
 101   return ProvideOption(Handler, Handler->ArgStr, Arg.c_str(), 0, 0, Dummy);
 102 }
 103
 104
 105 // Option predicates...
 106 static inline bool isGrouping(const Option *O) {
 107   return O->getFormattingFlag() == cl::Grouping;
 108 }
 109 static inline bool isPrefixedOrGrouping(const Option *O) {
 110   return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
 111 }
 112
 113 // getOptionPred - Check to see if there are any options that satisfy the
 114 // specified predicate with names that are the prefixes in Name.  This is
 115 // checked by progressively stripping characters off of the name, checking to
 116 // see if there options that satisfy the predicate.  If we find one, return it,
 117 // otherwise return null.
 118 //
 119 static Option *getOptionPred(std::string Name, unsigned &Length,
 120                              bool (*Pred)(const Option*)) {
 121
 122   Option *Op = getOption(Name);
 123   if (Op && Pred(Op)) {
 124     Length = Name.length();
 125     return Op;
 126   }
 127
 128   if (Name.size() == 1) return 0;
 129   do {
 130     Name.erase(Name.end()-1, Name.end());   // Chop off the last character...
 131     Op = getOption(Name);
 132
 133     // Loop while we haven't found an option and Name still has at least two
 134     // characters in it (so that the next iteration will not be the empty
 135     // string...
 136   } while ((Op == 0 || !Pred(Op)) && Name.size() > 1);
 137
 138   if (Op && Pred(Op)) {
 139     Length = Name.length();
 140     return Op;             // Found one!
 141   }
 142   return 0;                // No option found!
 143 }
 144
 145 static bool RequiresValue(const Option *O) {
 146   return O->getNumOccurrencesFlag() == cl::Required ||
 147          O->getNumOccurrencesFlag() == cl::OneOrMore;
 148 }
 149
 150 static bool EatsUnboundedNumberOfValues(const Option *O) {
 151   return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
 152          O->getNumOccurrencesFlag() == cl::OneOrMore;
 153 }
 154
 155 void cl::ParseCommandLineOptions(int &argc, char **argv,
 156                                  const char *Overview) {
 157   assert((!getOpts().empty() || !getPositionalOpts().empty()) &&
 158          "No options specified, or ParseCommandLineOptions called more"
 159          " than once!");
 160   ProgramName = argv[0];  // Save this away safe and snug
 161   ProgramOverview = Overview;
 162   bool ErrorParsing = false;
 163
 164   std::map<std::string, Option*> &Opts = getOpts();
 165   std::vector<Option*> &PositionalOpts = getPositionalOpts();
 166
 167   // Check out the positional arguments to collect information about them.
 168   unsigned NumPositionalRequired = 0;
 169   Option *ConsumeAfterOpt = 0;
 170   if (!PositionalOpts.empty()) {
 171     if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
 172       assert(PositionalOpts.size() > 1 &&
 173              "Cannot specify cl::ConsumeAfter without a positional argument!");
 174       ConsumeAfterOpt = PositionalOpts[0];
 175     }
 176
 177     // Calculate how many positional values are _required_.
 178     bool UnboundedFound = false;
 179     for (unsigned i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
 180          i != e; ++i) {
 181       Option *Opt = PositionalOpts[i];
 182       if (RequiresValue(Opt))
 183         ++NumPositionalRequired;
 184       else if (ConsumeAfterOpt) {
 185         // ConsumeAfter cannot be combined with "optional" positional options
 186         // unless there is only one positional argument...
 187         if (PositionalOpts.size() > 2)
 188           ErrorParsing |=
 189             Opt->error(" error - this positional option will never be matched, "
 190                        "because it does not Require a value, and a "
 191                        "cl::ConsumeAfter option is active!");
 192       } else if (UnboundedFound && !Opt->ArgStr[0]) {
 193         // This option does not "require" a value...  Make sure this option is
 194         // not specified after an option that eats all extra arguments, or this
 195         // one will never get any!
 196         //
 197         ErrorParsing |= Opt->error(" error - option can never match, because "
 198                                    "another positional argument will match an "
 199                                    "unbounded number of values, and this option"
 200                                    " does not require a value!");
 201       }
 202       UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
 203     }
 204   }
 205
 206   // PositionalVals - A vector of "positional" arguments we accumulate into to
 207   // processes at the end...
 208   //
 209   std::vector<std::string> PositionalVals;
 210
 211   // If the program has named positional arguments, and the name has been run
 212   // across, keep track of which positional argument was named.  Otherwise put
 213   // the positional args into the PositionalVals list...
 214   Option *ActivePositionalArg = 0;
 215
 216   // Loop over all of the arguments... processing them.
 217   bool DashDashFound = false;  // Have we read '--'?
 218   for (int i = 1; i < argc; ++i) {
 219     Option *Handler = 0;
 220     const char *Value = "";
 221     const char *ArgName = "";
 222
 223     // Check to see if this is a positional argument.  This argument is
 224     // considered to be positional if it doesn't start with '-', if it is "-"
 225     // itself, or if we have seen "--" already.
 226     //
 227     if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
 228       // Positional argument!
 229       if (ActivePositionalArg) {
 230         ProvidePositionalOption(ActivePositionalArg, argv[i]);
 231         continue;  // We are done!
 232       } else if (!PositionalOpts.empty()) {
 233         PositionalVals.push_back(argv[i]);
 234
 235         // All of the positional arguments have been fulfulled, give the rest to
 236         // the consume after option... if it's specified...
 237         //
 238         if (PositionalVals.size() >= NumPositionalRequired &&
 239             ConsumeAfterOpt != 0) {
 240           for (++i; i < argc; ++i)
 241             PositionalVals.push_back(argv[i]);
 242           break;   // Handle outside of the argument processing loop...
 243         }
 244
 245         // Delay processing positional arguments until the end...
 246         continue;
 247       }
 248     } else {               // We start with a '-', must be an argument...
 249       ArgName = argv[i]+1;
 250       while (*ArgName == '-') ++ArgName;  // Eat leading dashes
 251
 252       if (*ArgName == 0 && !DashDashFound) {   // Is this the mythical "--"?
 253         DashDashFound = true;  // Yup, take note of that fact...
 254         continue;              // Don't try to process it as an argument iself.
 255       }
 256
 257       const char *ArgNameEnd = ArgName;
 258       while (*ArgNameEnd && *ArgNameEnd != '=')
 259         ++ArgNameEnd; // Scan till end of argument name...
 260
 261       Value = ArgNameEnd;
 262       if (*Value)           // If we have an equals sign...
 263         ++Value;            // Advance to value...
 264
 265       if (*ArgName != 0) {
 266         std::string RealName(ArgName, ArgNameEnd);
 267         // Extract arg name part
 268         std::map<std::string, Option*>::iterator I = Opts.find(RealName);
 269
 270         if (I == Opts.end() && !*Value && RealName.size() > 1) {
 271           // Check to see if this "option" is really a prefixed or grouped
 272           // argument...
 273           //
 274           unsigned Length = 0;
 275           Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping);
 276
 277           // If the option is a prefixed option, then the value is simply the
 278           // rest of the name...  so fall through to later processing, by
 279           // setting up the argument name flags and value fields.
 280           //
 281           if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
 282             ArgNameEnd = ArgName+Length;
 283             Value = ArgNameEnd;
 284             I = Opts.find(std::string(ArgName, ArgNameEnd));
 285             assert(I->second == PGOpt);
 286           } else if (PGOpt) {
 287             // This must be a grouped option... handle all of them now...
 288             assert(isGrouping(PGOpt) && "Broken getOptionPred!");
 289
 290             do {
 291               // Move current arg name out of RealName into RealArgName...
 292               std::string RealArgName(RealName.begin(),RealName.begin()+Length);
 293               RealName.erase(RealName.begin(), RealName.begin()+Length);
 294
 295               // Because ValueRequired is an invalid flag for grouped arguments,
 296               // we don't need to pass argc/argv in...
 297               //
 298               assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
 299                      "Option can not be cl::Grouping AND cl::ValueRequired!");
 300               int Dummy;
 301               ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(), "",
 302                                             0, 0, Dummy);
 303
 304               // Get the next grouping option...
 305               if (!RealName.empty())
 306                 PGOpt = getOptionPred(RealName, Length, isGrouping);
 307             } while (!RealName.empty() && PGOpt);
 308
 309             if (RealName.empty())    // Processed all of the options, move on
 310               continue;              // to the next argv[] value...
 311
 312             // If RealName is not empty, that means we did not match one of the
 313             // options!  This is an error.
 314             //
 315             I = Opts.end();
 316           }
 317         }
 318
 319         Handler = I != Opts.end() ? I->second : 0;
 320       }
 321     }
 322
 323     if (Handler == 0) {
 324       std::cerr << "Unknown command line argument '" << argv[i] << "'.  Try: "
 325                 << argv[0] << " --help'\n";
 326       ErrorParsing = true;
 327       continue;
 328     }
 329
 330     // Check to see if this option accepts a comma separated list of values.  If
 331     // it does, we have to split up the value into multiple values...
 332     if (Handler->getMiscFlags() & CommaSeparated) {
 333       std::string Val(Value);
 334       std::string::size_type Pos = Val.find(',');
 335
 336       while (Pos != std::string::npos) {
 337         // Process the portion before the comma...
 338         ErrorParsing |= ProvideOption(Handler, ArgName,
 339                                       std::string(Val.begin(),
 340                                                   Val.begin()+Pos).c_str(),
 341                                       argc, argv, i);
 342         // Erase the portion before the comma, AND the comma...
 343         Val.erase(Val.begin(), Val.begin()+Pos+1);
 344         Value += Pos+1;  // Increment the original value pointer as well...
 345
 346         // Check for another comma...
 347         Pos = Val.find(',');
 348       }
 349     }
 350
 351     // If this is a named positional argument, just remember that it is the
 352     // active one...
 353     if (Handler->getFormattingFlag() == cl::Positional)
 354       ActivePositionalArg = Handler;
 355     else
 356       ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
 357   }
 358
 359   // Check and handle positional arguments now...
 360   if (NumPositionalRequired > PositionalVals.size()) {
 361     std::cerr << "Not enough positional command line arguments specified!\n"
 362               << "Must specify at least " << NumPositionalRequired
 363               << " positional arguments: See: " << argv[0] << " --help\n";
 364     ErrorParsing = true;
 365
 366
 367   } else if (ConsumeAfterOpt == 0) {
 368     // Positional args have already been handled if ConsumeAfter is specified...
 369     unsigned ValNo = 0, NumVals = PositionalVals.size();
 370     for (unsigned i = 0, e = PositionalOpts.size(); i != e; ++i) {
 371       if (RequiresValue(PositionalOpts[i])) {
 372         ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo++]);
 373         --NumPositionalRequired;  // We fulfilled our duty...
 374       }
 375
 376       // If we _can_ give this option more arguments, do so now, as long as we
 377       // do not give it values that others need.  'Done' controls whether the
 378       // option even _WANTS_ any more.
 379       //
 380       bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
 381       while (NumVals-ValNo > NumPositionalRequired && !Done) {
 382         switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
 383         case cl::Optional:
 384           Done = true;          // Optional arguments want _at most_ one value
 385           // FALL THROUGH
 386         case cl::ZeroOrMore:    // Zero or more will take all they can get...
 387         case cl::OneOrMore:     // One or more will take all they can get...
 388           ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo++]);
 389           break;
 390         default:
 391           assert(0 && "Internal error, unexpected NumOccurrences flag in "
 392                  "positional argument processing!");
 393         }
 394       }
 395     }
 396   } else {
 397     assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
 398     unsigned ValNo = 0;
 399     for (unsigned j = 1, e = PositionalOpts.size(); j != e; ++j)
 400       if (RequiresValue(PositionalOpts[j]))
 401         ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
 402                                                 PositionalVals[ValNo++]);
 403
 404     // Handle the case where there is just one positional option, and it's
 405     // optional.  In this case, we want to give JUST THE FIRST option to the
 406     // positional option and keep the rest for the consume after.  The above
 407     // loop would have assigned no values to positional options in this case.
 408     //
 409     if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty())
 410       ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
 411                                               PositionalVals[ValNo++]);
 412
 413     // Handle over all of the rest of the arguments to the
 414     // cl::ConsumeAfter command line option...
 415     for (; ValNo != PositionalVals.size(); ++ValNo)
 416       ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
 417                                               PositionalVals[ValNo]);
 418   }
 419
 420   // Loop over args and make sure all required args are specified!
 421   for (std::map<std::string, Option*>::iterator I = Opts.begin(),
 422          E = Opts.end(); I != E; ++I) {
 423     switch (I->second->getNumOccurrencesFlag()) {
 424     case Required:
 425     case OneOrMore:
 426       if (I->second->getNumOccurrences() == 0) {
 427         I->second->error(" must be specified at least once!");
 428         ErrorParsing = true;
 429       }
 430       // Fall through
 431     default:
 432       break;
 433     }
 434   }
 435
 436   // Free all of the memory allocated to the map.  Command line options may only
 437   // be processed once!
 438   delete CommandLineOptions;
 439   CommandLineOptions = 0;
 440   PositionalOpts.clear();
 441
 442   // If we had an error processing our arguments, don't let the program execute
 443   if (ErrorParsing) exit(1);
 444 }
 445
 446 //===----------------------------------------------------------------------===//
 447 // Option Base class implementation
 448 //
 449
 450 bool Option::error(std::string Message, const char *ArgName) {
 451   if (ArgName == 0) ArgName = ArgStr;
 452   if (ArgName[0] == 0)
 453     std::cerr << HelpStr;  // Be nice for positional arguments
 454   else
 455     std::cerr << "-" << ArgName;
 456   std::cerr << " option" << Message << "\n";
 457   return true;
 458 }
 459
 460 bool Option::addOccurrence(const char *ArgName, const std::string &Value) {
 461   NumOccurrences++;   // Increment the number of times we have been seen
 462
 463   switch (getNumOccurrencesFlag()) {
 464   case Optional:
 465     if (NumOccurrences > 1)
 466       return error(": may only occur zero or one times!", ArgName);
 467     break;
 468   case Required:
 469     if (NumOccurrences > 1)
 470       return error(": must occur exactly one time!", ArgName);
 471     // Fall through
 472   case OneOrMore:
 473   case ZeroOrMore:
 474   case ConsumeAfter: break;
 475   default: return error(": bad num occurrences flag value!");
 476   }
 477
 478   return handleOccurrence(ArgName, Value);
 479 }
 480
 481 // addArgument - Tell the system that this Option subclass will handle all
 482 // occurrences of -ArgStr on the command line.
 483 //
 484 void Option::addArgument(const char *ArgStr) {
 485   if (ArgStr[0])
 486     AddArgument(ArgStr, this);
 487
 488   if (getFormattingFlag() == Positional)
 489     getPositionalOpts().push_back(this);
 490   else if (getNumOccurrencesFlag() == ConsumeAfter) {
 491     if (!getPositionalOpts().empty() &&
 492         getPositionalOpts().front()->getNumOccurrencesFlag() == ConsumeAfter)
 493       error("Cannot specify more than one option with cl::ConsumeAfter!");
 494     getPositionalOpts().insert(getPositionalOpts().begin(), this);
 495   }
 496 }
 497
 498 void Option::removeArgument(const char *ArgStr) {
 499   if (ArgStr[0])
 500     RemoveArgument(ArgStr, this);
 501
 502   if (getFormattingFlag() == Positional) {
 503     std::vector<Option*>::iterator I =
 504       std::find(getPositionalOpts().begin(), getPositionalOpts().end(), this);
 505     assert(I != getPositionalOpts().end() && "Arg not registered!");
 506     getPositionalOpts().erase(I);
 507   } else if (getNumOccurrencesFlag() == ConsumeAfter) {
 508     assert(!getPositionalOpts().empty() && getPositionalOpts()[0] == this &&
 509            "Arg not registered correctly!");
 510     getPositionalOpts().erase(getPositionalOpts().begin());
 511   }
 512 }
 513
 514
 515 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
 516 // has been specified yet.
 517 //
 518 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
 519   if (O.ValueStr[0] == 0) return DefaultMsg;
 520   return O.ValueStr;
 521 }
 522
 523 //===----------------------------------------------------------------------===//
 524 // cl::alias class implementation
 525 //
 526
 527 // Return the width of the option tag for printing...
 528 unsigned alias::getOptionWidth() const {
 529   return std::strlen(ArgStr)+6;
 530 }
 531
 532 // Print out the option for the alias...
 533 void alias::printOptionInfo(unsigned GlobalWidth) const {
 534   unsigned L = std::strlen(ArgStr);
 535   std::cerr << "  -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
 536             << HelpStr << "\n";
 537 }
 538
 539
 540
 541 //===----------------------------------------------------------------------===//
 542 // Parser Implementation code...
 543 //
 544
 545 // basic_parser implementation
 546 //
 547
 548 // Return the width of the option tag for printing...
 549 unsigned basic_parser_impl::getOptionWidth(const Option &O) const {
 550   unsigned Len = std::strlen(O.ArgStr);
 551   if (const char *ValName = getValueName())
 552     Len += std::strlen(getValueStr(O, ValName))+3;
 553
 554   return Len + 6;
 555 }
 556
 557 // printOptionInfo - Print out information about this option.  The
 558 // to-be-maintained width is specified.
 559 //
 560 void basic_parser_impl::printOptionInfo(const Option &O,
 561                                         unsigned GlobalWidth) const {
 562   std::cerr << "  -" << O.ArgStr;
 563
 564   if (const char *ValName = getValueName())
 565     std::cerr << "=<" << getValueStr(O, ValName) << ">";
 566
 567   std::cerr << std::string(GlobalWidth-getOptionWidth(O), ' ') << " - "
 568             << O.HelpStr << "\n";
 569 }
 570
 571
 572
 573
 574 // parser<bool> implementation
 575 //
 576 bool parser<bool>::parse(Option &O, const char *ArgName,
 577                          const std::string &Arg, bool &Value) {
 578   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
 579       Arg == "1") {
 580     Value = true;
 581   } else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
 582     Value = false;
 583   } else {
 584     return O.error(": '" + Arg +
 585                    "' is invalid value for boolean argument! Try 0 or 1");
 586   }
 587   return false;
 588 }
 589
 590 // parser<int> implementation
 591 //
 592 bool parser<int>::parse(Option &O, const char *ArgName,
 593                         const std::string &Arg, int &Value) {
 594   char *End;
 595   Value = (int)strtol(Arg.c_str(), &End, 0);
 596   if (*End != 0)
 597     return O.error(": '" + Arg + "' value invalid for integer argument!");
 598   return false;
 599 }
 600
 601 // parser<unsigned> implementation
 602 //
 603 bool parser<unsigned>::parse(Option &O, const char *ArgName,
 604                              const std::string &Arg, unsigned &Value) {
 605   char *End;
 606   long long int V = strtoll(Arg.c_str(), &End, 0);
 607   Value = (unsigned)V;
 608   if (*End != 0 || V < 0 || Value != V)
 609     return O.error(": '" + Arg + "' value invalid for uint argument!");
 610   return false;
 611 }
 612
 613 // parser<double>/parser<float> implementation
 614 //
 615 static bool parseDouble(Option &O, const std::string &Arg, double &Value) {
 616   const char *ArgStart = Arg.c_str();
 617   char *End;
 618   Value = strtod(ArgStart, &End);
 619   if (*End != 0)
 620     return O.error(": '" +Arg+ "' value invalid for floating point argument!");
 621   return false;
 622 }
 623
 624 bool parser<double>::parse(Option &O, const char *AN,
 625                            const std::string &Arg, double &Val) {
 626   return parseDouble(O, Arg, Val);
 627 }
 628
 629 bool parser<float>::parse(Option &O, const char *AN,
 630                           const std::string &Arg, float &Val) {
 631   double dVal;
 632   if (parseDouble(O, Arg, dVal))
 633     return true;
 634   Val = (float)dVal;
 635   return false;
 636 }
 637
 638
 639
 640 // generic_parser_base implementation
 641 //
 642
 643 // findOption - Return the option number corresponding to the specified
 644 // argument string.  If the option is not found, getNumOptions() is returned.
 645 //
 646 unsigned generic_parser_base::findOption(const char *Name) {
 647   unsigned i = 0, e = getNumOptions();
 648   std::string N(Name);
 649
 650   while (i != e)
 651     if (getOption(i) == N)
 652       return i;
 653     else
 654       ++i;
 655   return e;
 656 }
 657
 658
 659 // Return the width of the option tag for printing...
 660 unsigned generic_parser_base::getOptionWidth(const Option &O) const {
 661   if (O.hasArgStr()) {
 662     unsigned Size = std::strlen(O.ArgStr)+6;
 663     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
 664       Size = std::max(Size, (unsigned)std::strlen(getOption(i))+8);
 665     return Size;
 666   } else {
 667     unsigned BaseSize = 0;
 668     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
 669       BaseSize = std::max(BaseSize, (unsigned)std::strlen(getOption(i))+8);
 670     return BaseSize;
 671   }
 672 }
 673
 674 // printOptionInfo - Print out information about this option.  The
 675 // to-be-maintained width is specified.
 676 //
 677 void generic_parser_base::printOptionInfo(const Option &O,
 678                                           unsigned GlobalWidth) const {
 679   if (O.hasArgStr()) {
 680     unsigned L = std::strlen(O.ArgStr);
 681     std::cerr << "  -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
 682               << " - " << O.HelpStr << "\n";
 683
 684     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
 685       unsigned NumSpaces = GlobalWidth-strlen(getOption(i))-8;
 686       std::cerr << "    =" << getOption(i) << std::string(NumSpaces, ' ')
 687                 << " - " << getDescription(i) << "\n";
 688     }
 689   } else {
 690     if (O.HelpStr[0])
 691       std::cerr << "  " << O.HelpStr << "\n";
 692     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
 693       unsigned L = std::strlen(getOption(i));
 694       std::cerr << "    -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
 695                 << " - " << getDescription(i) << "\n";
 696     }
 697   }
 698 }
 699
 700
 701 //===----------------------------------------------------------------------===//
 702 // --help and --help-hidden option implementation
 703 //
 704 namespace {
 705
 706 class HelpPrinter {
 707   unsigned MaxArgLen;
 708   const Option *EmptyArg;
 709   const bool ShowHidden;
 710
 711   // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
 712   inline static bool isHidden(std::pair<std::string, Option *> &OptPair) {
 713     return OptPair.second->getOptionHiddenFlag() >= Hidden;
 714   }
 715   inline static bool isReallyHidden(std::pair<std::string, Option *> &OptPair) {
 716     return OptPair.second->getOptionHiddenFlag() == ReallyHidden;
 717   }
 718
 719 public:
 720   HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
 721     EmptyArg = 0;
 722   }
 723
 724   void operator=(bool Value) {
 725     if (Value == false) return;
 726
 727     // Copy Options into a vector so we can sort them as we like...
 728     std::vector<std::pair<std::string, Option*> > Options;
 729     copy(getOpts().begin(), getOpts().end(), std::back_inserter(Options));
 730
 731     // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
 732     Options.erase(std::remove_if(Options.begin(), Options.end(),
 733                          std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
 734                   Options.end());
 735
 736     // Eliminate duplicate entries in table (from enum flags options, f.e.)
 737     {  // Give OptionSet a scope
 738       std::set<Option*> OptionSet;
 739       for (unsigned i = 0; i != Options.size(); ++i)
 740         if (OptionSet.count(Options[i].second) == 0)
 741           OptionSet.insert(Options[i].second);   // Add new entry to set
 742         else
 743           Options.erase(Options.begin()+i--);    // Erase duplicate
 744     }
 745
 746     if (ProgramOverview)
 747       std::cerr << "OVERVIEW:" << ProgramOverview << "\n";
 748
 749     std::cerr << "USAGE: " << ProgramName << " [options]";
 750
 751     // Print out the positional options...
 752     std::vector<Option*> &PosOpts = getPositionalOpts();
 753     Option *CAOpt = 0;   // The cl::ConsumeAfter option, if it exists...
 754     if (!PosOpts.empty() && PosOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
 755       CAOpt = PosOpts[0];
 756
 757     for (unsigned i = CAOpt != 0, e = PosOpts.size(); i != e; ++i) {
 758       if (PosOpts[i]->ArgStr[0])
 759         std::cerr << " --" << PosOpts[i]->ArgStr;
 760       std::cerr << " " << PosOpts[i]->HelpStr;
 761     }
 762
 763     // Print the consume after option info if it exists...
 764     if (CAOpt) std::cerr << " " << CAOpt->HelpStr;
 765
 766     std::cerr << "\n\n";
 767
 768     // Compute the maximum argument length...
 769     MaxArgLen = 0;
 770     for (unsigned i = 0, e = Options.size(); i != e; ++i)
 771       MaxArgLen = std::max(MaxArgLen, Options[i].second->getOptionWidth());
 772
 773     std::cerr << "OPTIONS:\n";
 774     for (unsigned i = 0, e = Options.size(); i != e; ++i)
 775       Options[i].second->printOptionInfo(MaxArgLen);
 776
 777     // Halt the program if help information is printed
 778     exit(1);
 779   }
 780 };
 781
 782
 783
 784 // Define the two HelpPrinter instances that are used to print out help, or
 785 // help-hidden...
 786 //
 787 HelpPrinter NormalPrinter(false);
 788 HelpPrinter HiddenPrinter(true);
 789
 790 cl::opt<HelpPrinter, true, parser<bool> >
 791 HOp("help", cl::desc("display available options (--help-hidden for more)"),
 792     cl::location(NormalPrinter), cl::ValueDisallowed);
 793
 794 cl::opt<HelpPrinter, true, parser<bool> >
 795 HHOp("help-hidden", cl::desc("display all available options"),
 796      cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
 797
 798 } // End anonymous namespace