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 (size_t 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[i] << "' 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, size_t &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 = static_cast<int>(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 = static_cast<int>(newArgv.size());
 395   }
 396
 397   // Copy the program name into ProgName, making sure not to overflow it.
 398   std::string ProgName = sys::Path(argv[0]).getLast();
 399   if (ProgName.size() > 79) ProgName.resize(79);
 400   strcpy(ProgramName, ProgName.c_str());
 401
 402   ProgramOverview = Overview;
 403   bool ErrorParsing = false;
 404
 405   // Check out the positional arguments to collect information about them.
 406   unsigned NumPositionalRequired = 0;
 407
 408   // Determine whether or not there are an unlimited number of positionals
 409   bool HasUnlimitedPositionals = false;
 410
 411   Option *ConsumeAfterOpt = 0;
 412   if (!PositionalOpts.empty()) {
 413     if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
 414       assert(PositionalOpts.size() > 1 &&
 415              "Cannot specify cl::ConsumeAfter without a positional argument!");
 416       ConsumeAfterOpt = PositionalOpts[0];
 417     }
 418
 419     // Calculate how many positional values are _required_.
 420     bool UnboundedFound = false;
 421     for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
 422          i != e; ++i) {
 423       Option *Opt = PositionalOpts[i];
 424       if (RequiresValue(Opt))
 425         ++NumPositionalRequired;
 426       else if (ConsumeAfterOpt) {
 427         // ConsumeAfter cannot be combined with "optional" positional options
 428         // unless there is only one positional argument...
 429         if (PositionalOpts.size() > 2)
 430           ErrorParsing |=
 431             Opt->error(" error - this positional option will never be matched, "
 432                        "because it does not Require a value, and a "
 433                        "cl::ConsumeAfter option is active!");
 434       } else if (UnboundedFound && !Opt->ArgStr[0]) {
 435         // This option does not "require" a value...  Make sure this option is
 436         // not specified after an option that eats all extra arguments, or this
 437         // one will never get any!
 438         //
 439         ErrorParsing |= Opt->error(" error - option can never match, because "
 440                                    "another positional argument will match an "
 441                                    "unbounded number of values, and this option"
 442                                    " does not require a value!");
 443       }
 444       UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
 445     }
 446     HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
 447   }
 448
 449   // PositionalVals - A vector of "positional" arguments we accumulate into
 450   // the process at the end...
 451   //
 452   std::vector<std::pair<std::string,unsigned> > PositionalVals;
 453
 454   // If the program has named positional arguments, and the name has been run
 455   // across, keep track of which positional argument was named.  Otherwise put
 456   // the positional args into the PositionalVals list...
 457   Option *ActivePositionalArg = 0;
 458
 459   // Loop over all of the arguments... processing them.
 460   bool DashDashFound = false;  // Have we read '--'?
 461   for (int i = 1; i < argc; ++i) {
 462     Option *Handler = 0;
 463     const char *Value = 0;
 464     const char *ArgName = "";
 465
 466     // If the option list changed, this means that some command line
 467     // option has just been registered or deregistered.  This can occur in
 468     // response to things like -load, etc.  If this happens, rescan the options.
 469     if (OptionListChanged) {
 470       PositionalOpts.clear();
 471       SinkOpts.clear();
 472       Opts.clear();
 473       GetOptionInfo(PositionalOpts, SinkOpts, Opts);
 474       OptionListChanged = false;
 475     }
 476
 477     // Check to see if this is a positional argument.  This argument is
 478     // considered to be positional if it doesn't start with '-', if it is "-"
 479     // itself, or if we have seen "--" already.
 480     //
 481     if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
 482       // Positional argument!
 483       if (ActivePositionalArg) {
 484         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
 485         continue;  // We are done!
 486       } else if (!PositionalOpts.empty()) {
 487         PositionalVals.push_back(std::make_pair(argv[i],i));
 488
 489         // All of the positional arguments have been fulfulled, give the rest to
 490         // the consume after option... if it's specified...
 491         //
 492         if (PositionalVals.size() >= NumPositionalRequired &&
 493             ConsumeAfterOpt != 0) {
 494           for (++i; i < argc; ++i)
 495             PositionalVals.push_back(std::make_pair(argv[i],i));
 496           break;   // Handle outside of the argument processing loop...
 497         }
 498
 499         // Delay processing positional arguments until the end...
 500         continue;
 501       }
 502     } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
 503                !DashDashFound) {
 504       DashDashFound = true;  // This is the mythical "--"?
 505       continue;              // Don't try to process it as an argument itself.
 506     } else if (ActivePositionalArg &&
 507                (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
 508       // If there is a positional argument eating options, check to see if this
 509       // option is another positional argument.  If so, treat it as an argument,
 510       // otherwise feed it to the eating positional.
 511       ArgName = argv[i]+1;
 512       Handler = LookupOption(ArgName, Value, Opts);
 513       if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
 514         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
 515         continue;  // We are done!
 516       }
 517
 518     } else {     // We start with a '-', must be an argument...
 519       ArgName = argv[i]+1;
 520       Handler = LookupOption(ArgName, Value, Opts);
 521
 522       // Check to see if this "option" is really a prefixed or grouped argument.
 523       if (Handler == 0) {
 524         std::string RealName(ArgName);
 525         if (RealName.size() > 1) {
 526           size_t Length = 0;
 527           Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping,
 528                                         Opts);
 529
 530           // If the option is a prefixed option, then the value is simply the
 531           // rest of the name...  so fall through to later processing, by
 532           // setting up the argument name flags and value fields.
 533           //
 534           if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
 535             Value = ArgName+Length;
 536             assert(Opts.find(std::string(ArgName, Value)) != Opts.end() &&
 537                    Opts.find(std::string(ArgName, Value))->second == PGOpt);
 538             Handler = PGOpt;
 539           } else if (PGOpt) {
 540             // This must be a grouped option... handle them now.
 541             assert(isGrouping(PGOpt) && "Broken getOptionPred!");
 542
 543             do {
 544               // Move current arg name out of RealName into RealArgName...
 545               std::string RealArgName(RealName.begin(),
 546                                       RealName.begin() + Length);
 547               RealName.erase(RealName.begin(), RealName.begin() + Length);
 548
 549               // Because ValueRequired is an invalid flag for grouped arguments,
 550               // we don't need to pass argc/argv in...
 551               //
 552               assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
 553                      "Option can not be cl::Grouping AND cl::ValueRequired!");
 554               int Dummy;
 555               ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(),
 556                                             0, 0, 0, Dummy);
 557
 558               // Get the next grouping option...
 559               PGOpt = getOptionPred(RealName, Length, isGrouping, Opts);
 560             } while (PGOpt && Length != RealName.size());
 561
 562             Handler = PGOpt; // Ate all of the options.
 563           }
 564         }
 565       }
 566     }
 567
 568     if (Handler == 0) {
 569       if (SinkOpts.empty()) {
 570         cerr << ProgramName << ": Unknown command line argument '"
 571              << argv[i] << "'.  Try: '" << argv[0] << " --help'\n";
 572         ErrorParsing = true;
 573       } else {
 574         for (std::vector<Option*>::iterator I = SinkOpts.begin(),
 575                E = SinkOpts.end(); I != E ; ++I)
 576           (*I)->addOccurrence(i, "", argv[i]);
 577       }
 578       continue;
 579     }
 580
 581     // Check to see if this option accepts a comma separated list of values.  If
 582     // it does, we have to split up the value into multiple values...
 583     if (Value && Handler->getMiscFlags() & CommaSeparated) {
 584       std::string Val(Value);
 585       std::string::size_type Pos = Val.find(',');
 586
 587       while (Pos != std::string::npos) {
 588         // Process the portion before the comma...
 589         ErrorParsing |= ProvideOption(Handler, ArgName,
 590                                       std::string(Val.begin(),
 591                                                   Val.begin()+Pos).c_str(),
 592                                       argc, argv, i);
 593         // Erase the portion before the comma, AND the comma...
 594         Val.erase(Val.begin(), Val.begin()+Pos+1);
 595         Value += Pos+1;  // Increment the original value pointer as well...
 596
 597         // Check for another comma...
 598         Pos = Val.find(',');
 599       }
 600     }
 601
 602     // If this is a named positional argument, just remember that it is the
 603     // active one...
 604     if (Handler->getFormattingFlag() == cl::Positional)
 605       ActivePositionalArg = Handler;
 606     else
 607       ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
 608   }
 609
 610   // Check and handle positional arguments now...
 611   if (NumPositionalRequired > PositionalVals.size()) {
 612     cerr << ProgramName
 613          << ": Not enough positional command line arguments specified!\n"
 614          << "Must specify at least " << NumPositionalRequired
 615          << " positional arguments: See: " << argv[0] << " --help\n";
 616
 617     ErrorParsing = true;
 618   } else if (!HasUnlimitedPositionals
 619              && PositionalVals.size() > PositionalOpts.size()) {
 620     cerr << ProgramName
 621          << ": Too many positional arguments specified!\n"
 622          << "Can specify at most " << PositionalOpts.size()
 623          << " positional arguments: See: " << argv[0] << " --help\n";
 624     ErrorParsing = true;
 625
 626   } else if (ConsumeAfterOpt == 0) {
 627     // Positional args have already been handled if ConsumeAfter is specified...
 628     unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
 629     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
 630       if (RequiresValue(PositionalOpts[i])) {
 631         ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
 632                                 PositionalVals[ValNo].second);
 633         ValNo++;
 634         --NumPositionalRequired;  // We fulfilled our duty...
 635       }
 636
 637       // If we _can_ give this option more arguments, do so now, as long as we
 638       // do not give it values that others need.  'Done' controls whether the
 639       // option even _WANTS_ any more.
 640       //
 641       bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
 642       while (NumVals-ValNo > NumPositionalRequired && !Done) {
 643         switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
 644         case cl::Optional:
 645           Done = true;          // Optional arguments want _at most_ one value
 646           // FALL THROUGH
 647         case cl::ZeroOrMore:    // Zero or more will take all they can get...
 648         case cl::OneOrMore:     // One or more will take all they can get...
 649           ProvidePositionalOption(PositionalOpts[i],
 650                                   PositionalVals[ValNo].first,
 651                                   PositionalVals[ValNo].second);
 652           ValNo++;
 653           break;
 654         default:
 655           assert(0 && "Internal error, unexpected NumOccurrences flag in "
 656                  "positional argument processing!");
 657         }
 658       }
 659     }
 660   } else {
 661     assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
 662     unsigned ValNo = 0;
 663     for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
 664       if (RequiresValue(PositionalOpts[j])) {
 665         ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
 666                                                 PositionalVals[ValNo].first,
 667                                                 PositionalVals[ValNo].second);
 668         ValNo++;
 669       }
 670
 671     // Handle the case where there is just one positional option, and it's
 672     // optional.  In this case, we want to give JUST THE FIRST option to the
 673     // positional option and keep the rest for the consume after.  The above
 674     // loop would have assigned no values to positional options in this case.
 675     //
 676     if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
 677       ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
 678                                               PositionalVals[ValNo].first,
 679                                               PositionalVals[ValNo].second);
 680       ValNo++;
 681     }
 682
 683     // Handle over all of the rest of the arguments to the
 684     // cl::ConsumeAfter command line option...
 685     for (; ValNo != PositionalVals.size(); ++ValNo)
 686       ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
 687                                               PositionalVals[ValNo].first,
 688                                               PositionalVals[ValNo].second);
 689   }
 690
 691   // Loop over args and make sure all required args are specified!
 692   for (std::map<std::string, Option*>::iterator I = Opts.begin(),
 693          E = Opts.end(); I != E; ++I) {
 694     switch (I->second->getNumOccurrencesFlag()) {
 695     case Required:
 696     case OneOrMore:
 697       if (I->second->getNumOccurrences() == 0) {
 698         I->second->error(" must be specified at least once!");
 699         ErrorParsing = true;
 700       }
 701       // Fall through
 702     default:
 703       break;
 704     }
 705   }
 706
 707   // Free all of the memory allocated to the map.  Command line options may only
 708   // be processed once!
 709   Opts.clear();
 710   PositionalOpts.clear();
 711   MoreHelp->clear();
 712
 713   // Free the memory allocated by ExpandResponseFiles.
 714   if (ReadResponseFiles) {
 715     // Free all the strdup()ed strings.
 716     for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
 717          i != e; ++i)
 718       free (*i);
 719   }
 720
 721   // If we had an error processing our arguments, don't let the program execute
 722   if (ErrorParsing) exit(1);
 723 }
 724
 725 //===----------------------------------------------------------------------===//
 726 // Option Base class implementation
 727 //
 728
 729 bool Option::error(std::string Message, const char *ArgName) {
 730   if (ArgName == 0) ArgName = ArgStr;
 731   if (ArgName[0] == 0)
 732     cerr << HelpStr;  // Be nice for positional arguments
 733   else
 734     cerr << ProgramName << ": for the -" << ArgName;
 735
 736   cerr << " option: " << Message << "\n";
 737   return true;
 738 }
 739
 740 bool Option::addOccurrence(unsigned pos, const char *ArgName,
 741                            const std::string &Value) {
 742   NumOccurrences++;   // Increment the number of times we have been seen
 743
 744   switch (getNumOccurrencesFlag()) {
 745   case Optional:
 746     if (NumOccurrences > 1)
 747       return error(": may only occur zero or one times!", ArgName);
 748     break;
 749   case Required:
 750     if (NumOccurrences > 1)
 751       return error(": must occur exactly one time!", ArgName);
 752     // Fall through
 753   case OneOrMore:
 754   case ZeroOrMore:
 755   case ConsumeAfter: break;
 756   default: return error(": bad num occurrences flag value!");
 757   }
 758
 759   return handleOccurrence(pos, ArgName, Value);
 760 }
 761
 762
 763 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
 764 // has been specified yet.
 765 //
 766 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
 767   if (O.ValueStr[0] == 0) return DefaultMsg;
 768   return O.ValueStr;
 769 }
 770
 771 //===----------------------------------------------------------------------===//
 772 // cl::alias class implementation
 773 //
 774
 775 // Return the width of the option tag for printing...
 776 size_t alias::getOptionWidth() const {
 777   return std::strlen(ArgStr)+6;
 778 }
 779
 780 // Print out the option for the alias.
 781 void alias::printOptionInfo(size_t GlobalWidth) const {
 782   size_t L = std::strlen(ArgStr);
 783   cout << "  -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
 784        << HelpStr << "\n";
 785 }
 786
 787
 788
 789 //===----------------------------------------------------------------------===//
 790 // Parser Implementation code...
 791 //
 792
 793 // basic_parser implementation
 794 //
 795
 796 // Return the width of the option tag for printing...
 797 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
 798   size_t Len = std::strlen(O.ArgStr);
 799   if (const char *ValName = getValueName())
 800     Len += std::strlen(getValueStr(O, ValName))+3;
 801
 802   return Len + 6;
 803 }
 804
 805 // printOptionInfo - Print out information about this option.  The
 806 // to-be-maintained width is specified.
 807 //
 808 void basic_parser_impl::printOptionInfo(const Option &O,
 809                                         size_t GlobalWidth) const {
 810   cout << "  -" << O.ArgStr;
 811
 812   if (const char *ValName = getValueName())
 813     cout << "=<" << getValueStr(O, ValName) << ">";
 814
 815   cout << std::string(GlobalWidth-getOptionWidth(O), ' ') << " - "
 816        << O.HelpStr << "\n";
 817 }
 818
 819
 820
 821
 822 // parser<bool> implementation
 823 //
 824 bool parser<bool>::parse(Option &O, const char *ArgName,
 825                          const std::string &Arg, bool &Value) {
 826   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
 827       Arg == "1") {
 828     Value = true;
 829   } else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
 830     Value = false;
 831   } else {
 832     return O.error(": '" + Arg +
 833                    "' is invalid value for boolean argument! Try 0 or 1");
 834   }
 835   return false;
 836 }
 837
 838 // parser<boolOrDefault> implementation
 839 //
 840 bool parser<boolOrDefault>::parse(Option &O, const char *ArgName,
 841                          const std::string &Arg, boolOrDefault &Value) {
 842   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
 843       Arg == "1") {
 844     Value = BOU_TRUE;
 845   } else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
 846     Value = BOU_FALSE;
 847   } else {
 848     return O.error(": '" + Arg +
 849                    "' is invalid value for boolean argument! Try 0 or 1");
 850   }
 851   return false;
 852 }
 853
 854 // parser<int> implementation
 855 //
 856 bool parser<int>::parse(Option &O, const char *ArgName,
 857                         const std::string &Arg, int &Value) {
 858   char *End;
 859   Value = (int)strtol(Arg.c_str(), &End, 0);
 860   if (*End != 0)
 861     return O.error(": '" + Arg + "' value invalid for integer argument!");
 862   return false;
 863 }
 864
 865 // parser<unsigned> implementation
 866 //
 867 bool parser<unsigned>::parse(Option &O, const char *ArgName,
 868                              const std::string &Arg, unsigned &Value) {
 869   char *End;
 870   errno = 0;
 871   unsigned long V = strtoul(Arg.c_str(), &End, 0);
 872   Value = (unsigned)V;
 873   if (((V == ULONG_MAX) && (errno == ERANGE))
 874       || (*End != 0)
 875       || (Value != V))
 876     return O.error(": '" + Arg + "' value invalid for uint argument!");
 877   return false;
 878 }
 879
 880 // parser<double>/parser<float> implementation
 881 //
 882 static bool parseDouble(Option &O, const std::string &Arg, double &Value) {
 883   const char *ArgStart = Arg.c_str();
 884   char *End;
 885   Value = strtod(ArgStart, &End);
 886   if (*End != 0)
 887     return O.error(": '" +Arg+ "' value invalid for floating point argument!");
 888   return false;
 889 }
 890
 891 bool parser<double>::parse(Option &O, const char *AN,
 892                            const std::string &Arg, double &Val) {
 893   return parseDouble(O, Arg, Val);
 894 }
 895
 896 bool parser<float>::parse(Option &O, const char *AN,
 897                           const std::string &Arg, float &Val) {
 898   double dVal;
 899   if (parseDouble(O, Arg, dVal))
 900     return true;
 901   Val = (float)dVal;
 902   return false;
 903 }
 904
 905
 906
 907 // generic_parser_base implementation
 908 //
 909
 910 // findOption - Return the option number corresponding to the specified
 911 // argument string.  If the option is not found, getNumOptions() is returned.
 912 //
 913 unsigned generic_parser_base::findOption(const char *Name) {
 914   unsigned i = 0, e = getNumOptions();
 915   std::string N(Name);
 916
 917   while (i != e)
 918     if (getOption(i) == N)
 919       return i;
 920     else
 921       ++i;
 922   return e;
 923 }
 924
 925
 926 // Return the width of the option tag for printing...
 927 size_t generic_parser_base::getOptionWidth(const Option &O) const {
 928   if (O.hasArgStr()) {
 929     size_t Size = std::strlen(O.ArgStr)+6;
 930     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
 931       Size = std::max(Size, std::strlen(getOption(i))+8);
 932     return Size;
 933   } else {
 934     size_t BaseSize = 0;
 935     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
 936       BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
 937     return BaseSize;
 938   }
 939 }
 940
 941 // printOptionInfo - Print out information about this option.  The
 942 // to-be-maintained width is specified.
 943 //
 944 void generic_parser_base::printOptionInfo(const Option &O,
 945                                           size_t GlobalWidth) const {
 946   if (O.hasArgStr()) {
 947     size_t L = std::strlen(O.ArgStr);
 948     cout << "  -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
 949          << " - " << O.HelpStr << "\n";
 950
 951     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
 952       size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
 953       cout << "    =" << getOption(i) << std::string(NumSpaces, ' ')
 954            << " -   " << getDescription(i) << "\n";
 955     }
 956   } else {
 957     if (O.HelpStr[0])
 958       cout << "  " << O.HelpStr << "\n";
 959     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
 960       size_t L = std::strlen(getOption(i));
 961       cout << "    -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
 962            << " - " << getDescription(i) << "\n";
 963     }
 964   }
 965 }
 966
 967
 968 //===----------------------------------------------------------------------===//
 969 // --help and --help-hidden option implementation
 970 //
 971
 972 namespace {
 973
 974 class HelpPrinter {
 975   size_t MaxArgLen;
 976   const Option *EmptyArg;
 977   const bool ShowHidden;
 978
 979   // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
 980   inline static bool isHidden(std::pair<std::string, Option *> &OptPair) {
 981     return OptPair.second->getOptionHiddenFlag() >= Hidden;
 982   }
 983   inline static bool isReallyHidden(std::pair<std::string, Option *> &OptPair) {
 984     return OptPair.second->getOptionHiddenFlag() == ReallyHidden;
 985   }
 986
 987 public:
 988   explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
 989     EmptyArg = 0;
 990   }
 991
 992   void operator=(bool Value) {
 993     if (Value == false) return;
 994
 995     // Get all the options.
 996     std::vector<Option*> PositionalOpts;
 997     std::vector<Option*> SinkOpts;
 998     std::map<std::string, Option*> OptMap;
 999     GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1000
1001     // Copy Options into a vector so we can sort them as we like...
1002     std::vector<std::pair<std::string, Option*> > Opts;
1003     copy(OptMap.begin(), OptMap.end(), std::back_inserter(Opts));
1004
1005     // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
1006     Opts.erase(std::remove_if(Opts.begin(), Opts.end(),
1007                           std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
1008                Opts.end());
1009
1010     // Eliminate duplicate entries in table (from enum flags options, f.e.)
1011     {  // Give OptionSet a scope
1012       std::set<Option*> OptionSet;
1013       for (unsigned i = 0; i != Opts.size(); ++i)
1014         if (OptionSet.count(Opts[i].second) == 0)
1015           OptionSet.insert(Opts[i].second);   // Add new entry to set
1016         else
1017           Opts.erase(Opts.begin()+i--);    // Erase duplicate
1018     }
1019
1020     if (ProgramOverview)
1021       cout << "OVERVIEW: " << ProgramOverview << "\n";
1022
1023     cout << "USAGE: " << ProgramName << " [options]";
1024
1025     // Print out the positional options.
1026     Option *CAOpt = 0;   // The cl::ConsumeAfter option, if it exists...
1027     if (!PositionalOpts.empty() &&
1028         PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1029       CAOpt = PositionalOpts[0];
1030
1031     for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1032       if (PositionalOpts[i]->ArgStr[0])
1033         cout << " --" << PositionalOpts[i]->ArgStr;
1034       cout << " " << PositionalOpts[i]->HelpStr;
1035     }
1036
1037     // Print the consume after option info if it exists...
1038     if (CAOpt) cout << " " << CAOpt->HelpStr;
1039
1040     cout << "\n\n";
1041
1042     // Compute the maximum argument length...
1043     MaxArgLen = 0;
1044     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1045       MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1046
1047     cout << "OPTIONS:\n";
1048     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1049       Opts[i].second->printOptionInfo(MaxArgLen);
1050
1051     // Print any extra help the user has declared.
1052     for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1053           E = MoreHelp->end(); I != E; ++I)
1054       cout << *I;
1055     MoreHelp->clear();
1056
1057     // Halt the program since help information was printed
1058     exit(1);
1059   }
1060 };
1061 } // End anonymous namespace
1062
1063 // Define the two HelpPrinter instances that are used to print out help, or
1064 // help-hidden...
1065 //
1066 static HelpPrinter NormalPrinter(false);
1067 static HelpPrinter HiddenPrinter(true);
1068
1069 static cl::opt<HelpPrinter, true, parser<bool> >
1070 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1071     cl::location(NormalPrinter), cl::ValueDisallowed);
1072
1073 static cl::opt<HelpPrinter, true, parser<bool> >
1074 HHOp("help-hidden", cl::desc("Display all available options"),
1075      cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1076
1077 static void (*OverrideVersionPrinter)() = 0;
1078
1079 namespace {
1080 class VersionPrinter {
1081 public:
1082   void print() {
1083         cout << "Low Level Virtual Machine (http://llvm.org/):\n";
1084         cout << "  " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1085 #ifdef LLVM_VERSION_INFO
1086         cout << LLVM_VERSION_INFO;
1087 #endif
1088         cout << "\n  ";
1089 #ifndef __OPTIMIZE__
1090         cout << "DEBUG build";
1091 #else
1092         cout << "Optimized build";
1093 #endif
1094 #ifndef NDEBUG
1095         cout << " with assertions";
1096 #endif
1097         cout << ".\n";
1098   }
1099   void operator=(bool OptionWasSpecified) {
1100     if (OptionWasSpecified) {
1101       if (OverrideVersionPrinter == 0) {
1102         print();
1103         exit(1);
1104       } else {
1105         (*OverrideVersionPrinter)();
1106         exit(1);
1107       }
1108     }
1109   }
1110 };
1111 } // End anonymous namespace
1112
1113
1114 // Define the --version option that prints out the LLVM version for the tool
1115 static VersionPrinter VersionPrinterInstance;
1116
1117 static cl::opt<VersionPrinter, true, parser<bool> >
1118 VersOp("version", cl::desc("Display the version of this program"),
1119     cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1120
1121 // Utility function for printing the help message.
1122 void cl::PrintHelpMessage() {
1123   // This looks weird, but it actually prints the help message. The
1124   // NormalPrinter variable is a HelpPrinter and the help gets printed when
1125   // its operator= is invoked. That's because the "normal" usages of the
1126   // help printer is to be assigned true/false depending on whether the
1127   // --help option was given or not. Since we're circumventing that we have
1128   // to make it look like --help was given, so we assign true.
1129   NormalPrinter = true;
1130 }
1131
1132 /// Utility function for printing version number.
1133 void cl::PrintVersionMessage() {
1134   VersionPrinterInstance.print();
1135 }
1136
1137 void cl::SetVersionPrinter(void (*func)()) {
1138   OverrideVersionPrinter = func;
1139 }