lib/Support/CommandLine.cpp

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