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