lib/Support/CommandLine.cpp

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