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