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 *> &output,
 355                                const char *input) {
 356   // Characters which will be treated as token separators:
 357   static const char *const delims = " \v\f\t\r\n";
 358
 359   std::string work(input);
 360   // Skip past any delims at head of input string.
 361   size_t pos = work.find_first_not_of(delims);
 362   // If the string consists entirely of delims, then exit early.
 363   if (pos == std::string::npos) return;
 364   // Otherwise, jump forward to beginning of first word.
 365   work = work.substr(pos);
 366   // Find position of first delimiter.
 367   pos = work.find_first_of(delims);
 368
 369   while (!work.empty() && pos != std::string::npos) {
 370     // Everything from 0 to POS is the next word to copy.
 371     output.push_back(strdup(work.substr(0,pos).c_str()));
 372     // Is there another word in the string?
 373     size_t nextpos = work.find_first_not_of(delims, pos + 1);
 374     if (nextpos != std::string::npos) {
 375       // Yes? Then remove delims from beginning ...
 376       work = work.substr(work.find_first_not_of(delims, pos + 1));
 377       // and find the end of the word.
 378       pos = work.find_first_of(delims);
 379     } else {
 380       // No? (Remainder of string is delims.) End the loop.
 381       work = "";
 382       pos = std::string::npos;
 383     }
 384   }
 385
 386   // If `input' ended with non-delim char, then we'll get here with
 387   // the last word of `input' in `work'; copy it now.
 388   if (!work.empty())
 389     output.push_back(strdup(work.c_str()));
 390 }
 391
 392 /// ParseEnvironmentOptions - An alternative entry point to the
 393 /// CommandLine library, which allows you to read the program's name
 394 /// from the caller (as PROGNAME) and its command-line arguments from
 395 /// an environment variable (whose name is given in ENVVAR).
 396 ///
 397 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
 398                                  const char *Overview, bool ReadResponseFiles) {
 399   // Check args.
 400   assert(progName && "Program name not specified");
 401   assert(envVar && "Environment variable name missing");
 402
 403   // Get the environment variable they want us to parse options out of.
 404   const char *envValue = getenv(envVar);
 405   if (!envValue)
 406     return;
 407
 408   // Get program's "name", which we wouldn't know without the caller
 409   // telling us.
 410   std::vector<char*> newArgv;
 411   newArgv.push_back(strdup(progName));
 412
 413   // Parse the value of the environment variable into a "command line"
 414   // and hand it off to ParseCommandLineOptions().
 415   ParseCStringVector(newArgv, envValue);
 416   int newArgc = static_cast<int>(newArgv.size());
 417   ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
 418
 419   // Free all the strdup()ed strings.
 420   for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
 421        i != e; ++i)
 422     free(*i);
 423 }
 424
 425
 426 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
 427 /// substituting the contents of the response files for the arguments
 428 /// of type @file.
 429 static void ExpandResponseFiles(unsigned argc, char** argv,
 430                                 std::vector<char*>& newArgv) {
 431   for (unsigned i = 1; i != argc; ++i) {
 432     char *arg = argv[i];
 433
 434     if (arg[0] == '@') {
 435       sys::PathWithStatus respFile(++arg);
 436
 437       // Check that the response file is not empty (mmap'ing empty
 438       // files can be problematic).
 439       const sys::FileStatus *FileStat = respFile.getFileStatus();
 440       if (FileStat && FileStat->getSize() != 0) {
 441
 442         // Mmap the response file into memory.
 443         OwningPtr<MemoryBuffer>
 444           respFilePtr(MemoryBuffer::getFile(respFile.c_str()));
 445
 446         // If we could open the file, parse its contents, otherwise
 447         // pass the @file option verbatim.
 448
 449         // TODO: we should also support recursive loading of response files,
 450         // since this is how gcc behaves. (From their man page: "The file may
 451         // itself contain additional @file options; any such options will be
 452         // processed recursively.")
 453
 454         if (respFilePtr != 0) {
 455           ParseCStringVector(newArgv, respFilePtr->getBufferStart());
 456           continue;
 457         }
 458       }
 459     }
 460     newArgv.push_back(strdup(arg));
 461   }
 462 }
 463
 464 void cl::ParseCommandLineOptions(int argc, char **argv,
 465                                  const char *Overview, bool ReadResponseFiles) {
 466   // Process all registered options.
 467   SmallVector<Option*, 4> PositionalOpts;
 468   SmallVector<Option*, 4> SinkOpts;
 469   StringMap<Option*> Opts;
 470   GetOptionInfo(PositionalOpts, SinkOpts, Opts);
 471
 472   assert((!Opts.empty() || !PositionalOpts.empty()) &&
 473          "No options specified!");
 474
 475   // Expand response files.
 476   std::vector<char*> newArgv;
 477   if (ReadResponseFiles) {
 478     newArgv.push_back(strdup(argv[0]));
 479     ExpandResponseFiles(argc, argv, newArgv);
 480     argv = &newArgv[0];
 481     argc = static_cast<int>(newArgv.size());
 482   }
 483
 484   // Copy the program name into ProgName, making sure not to overflow it.
 485   std::string ProgName = sys::Path(argv[0]).getLast();
 486   if (ProgName.size() > 79) ProgName.resize(79);
 487   strcpy(ProgramName, ProgName.c_str());
 488
 489   ProgramOverview = Overview;
 490   bool ErrorParsing = false;
 491
 492   // Check out the positional arguments to collect information about them.
 493   unsigned NumPositionalRequired = 0;
 494
 495   // Determine whether or not there are an unlimited number of positionals
 496   bool HasUnlimitedPositionals = false;
 497
 498   Option *ConsumeAfterOpt = 0;
 499   if (!PositionalOpts.empty()) {
 500     if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
 501       assert(PositionalOpts.size() > 1 &&
 502              "Cannot specify cl::ConsumeAfter without a positional argument!");
 503       ConsumeAfterOpt = PositionalOpts[0];
 504     }
 505
 506     // Calculate how many positional values are _required_.
 507     bool UnboundedFound = false;
 508     for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
 509          i != e; ++i) {
 510       Option *Opt = PositionalOpts[i];
 511       if (RequiresValue(Opt))
 512         ++NumPositionalRequired;
 513       else if (ConsumeAfterOpt) {
 514         // ConsumeAfter cannot be combined with "optional" positional options
 515         // unless there is only one positional argument...
 516         if (PositionalOpts.size() > 2)
 517           ErrorParsing |=
 518             Opt->error("error - this positional option will never be matched, "
 519                        "because it does not Require a value, and a "
 520                        "cl::ConsumeAfter option is active!");
 521       } else if (UnboundedFound && !Opt->ArgStr[0]) {
 522         // This option does not "require" a value...  Make sure this option is
 523         // not specified after an option that eats all extra arguments, or this
 524         // one will never get any!
 525         //
 526         ErrorParsing |= Opt->error("error - option can never match, because "
 527                                    "another positional argument will match an "
 528                                    "unbounded number of values, and this option"
 529                                    " does not require a value!");
 530       }
 531       UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
 532     }
 533     HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
 534   }
 535
 536   // PositionalVals - A vector of "positional" arguments we accumulate into
 537   // the process at the end.
 538   //
 539   SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
 540
 541   // If the program has named positional arguments, and the name has been run
 542   // across, keep track of which positional argument was named.  Otherwise put
 543   // the positional args into the PositionalVals list...
 544   Option *ActivePositionalArg = 0;
 545
 546   // Loop over all of the arguments... processing them.
 547   bool DashDashFound = false;  // Have we read '--'?
 548   for (int i = 1; i < argc; ++i) {
 549     Option *Handler = 0;
 550     StringRef Value;
 551     StringRef ArgName = "";
 552
 553     // If the option list changed, this means that some command line
 554     // option has just been registered or deregistered.  This can occur in
 555     // response to things like -load, etc.  If this happens, rescan the options.
 556     if (OptionListChanged) {
 557       PositionalOpts.clear();
 558       SinkOpts.clear();
 559       Opts.clear();
 560       GetOptionInfo(PositionalOpts, SinkOpts, Opts);
 561       OptionListChanged = false;
 562     }
 563
 564     // Check to see if this is a positional argument.  This argument is
 565     // considered to be positional if it doesn't start with '-', if it is "-"
 566     // itself, or if we have seen "--" already.
 567     //
 568     if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
 569       // Positional argument!
 570       if (ActivePositionalArg) {
 571         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
 572         continue;  // We are done!
 573       }
 574
 575       if (!PositionalOpts.empty()) {
 576         PositionalVals.push_back(std::make_pair(argv[i],i));
 577
 578         // All of the positional arguments have been fulfulled, give the rest to
 579         // the consume after option... if it's specified...
 580         //
 581         if (PositionalVals.size() >= NumPositionalRequired &&
 582             ConsumeAfterOpt != 0) {
 583           for (++i; i < argc; ++i)
 584             PositionalVals.push_back(std::make_pair(argv[i],i));
 585           break;   // Handle outside of the argument processing loop...
 586         }
 587
 588         // Delay processing positional arguments until the end...
 589         continue;
 590       }
 591     } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
 592                !DashDashFound) {
 593       DashDashFound = true;  // This is the mythical "--"?
 594       continue;              // Don't try to process it as an argument itself.
 595     } else if (ActivePositionalArg &&
 596                (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
 597       // If there is a positional argument eating options, check to see if this
 598       // option is another positional argument.  If so, treat it as an argument,
 599       // otherwise feed it to the eating positional.
 600       ArgName = argv[i]+1;
 601       // Eat leading dashes.
 602       while (!ArgName.empty() && ArgName[0] == '-')
 603         ArgName = ArgName.substr(1);
 604
 605       Handler = LookupOption(ArgName, Value, Opts);
 606       if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
 607         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
 608         continue;  // We are done!
 609       }
 610
 611     } else {     // We start with a '-', must be an argument.
 612       ArgName = argv[i]+1;
 613       // Eat leading dashes.
 614       while (!ArgName.empty() && ArgName[0] == '-')
 615         ArgName = ArgName.substr(1);
 616
 617       Handler = LookupOption(ArgName, Value, Opts);
 618
 619       // Check to see if this "option" is really a prefixed or grouped argument.
 620       if (Handler == 0)
 621         Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
 622                                                 ErrorParsing, Opts);
 623     }
 624
 625     if (Handler == 0) {
 626       if (SinkOpts.empty()) {
 627         errs() << ProgramName << ": Unknown command line argument '"
 628              << argv[i] << "'.  Try: '" << argv[0] << " --help'\n";
 629         ErrorParsing = true;
 630       } else {
 631         for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
 632                E = SinkOpts.end(); I != E ; ++I)
 633           (*I)->addOccurrence(i, "", argv[i]);
 634       }
 635       continue;
 636     }
 637
 638     // Check to see if this option accepts a comma separated list of values.  If
 639     // it does, we have to split up the value into multiple values.
 640     if (Handler->getMiscFlags() & CommaSeparated) {
 641       StringRef Val(Value);
 642       StringRef::size_type Pos = Val.find(',');
 643
 644       while (Pos != StringRef::npos) {
 645         // Process the portion before the comma.
 646         ErrorParsing |= ProvideOption(Handler, ArgName, Val.substr(0, Pos),
 647                                       argc, argv, i);
 648         // Erase the portion before the comma, AND the comma.
 649         Val = Val.substr(Pos+1);
 650         Value.substr(Pos+1);  // Increment the original value pointer as well.
 651
 652         // Check for another comma.
 653         Pos = Val.find(',');
 654       }
 655     }
 656
 657     // If this is a named positional argument, just remember that it is the
 658     // active one...
 659     if (Handler->getFormattingFlag() == cl::Positional)
 660       ActivePositionalArg = Handler;
 661     else
 662       ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
 663   }
 664
 665   // Check and handle positional arguments now...
 666   if (NumPositionalRequired > PositionalVals.size()) {
 667     errs() << ProgramName
 668          << ": Not enough positional command line arguments specified!\n"
 669          << "Must specify at least " << NumPositionalRequired
 670          << " positional arguments: See: " << argv[0] << " --help\n";
 671
 672     ErrorParsing = true;
 673   } else if (!HasUnlimitedPositionals
 674              && PositionalVals.size() > PositionalOpts.size()) {
 675     errs() << ProgramName
 676          << ": Too many positional arguments specified!\n"
 677          << "Can specify at most " << PositionalOpts.size()
 678          << " positional arguments: See: " << argv[0] << " --help\n";
 679     ErrorParsing = true;
 680
 681   } else if (ConsumeAfterOpt == 0) {
 682     // Positional args have already been handled if ConsumeAfter is specified.
 683     unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
 684     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
 685       if (RequiresValue(PositionalOpts[i])) {
 686         ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
 687                                 PositionalVals[ValNo].second);
 688         ValNo++;
 689         --NumPositionalRequired;  // We fulfilled our duty...
 690       }
 691
 692       // If we _can_ give this option more arguments, do so now, as long as we
 693       // do not give it values that others need.  'Done' controls whether the
 694       // option even _WANTS_ any more.
 695       //
 696       bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
 697       while (NumVals-ValNo > NumPositionalRequired && !Done) {
 698         switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
 699         case cl::Optional:
 700           Done = true;          // Optional arguments want _at most_ one value
 701           // FALL THROUGH
 702         case cl::ZeroOrMore:    // Zero or more will take all they can get...
 703         case cl::OneOrMore:     // One or more will take all they can get...
 704           ProvidePositionalOption(PositionalOpts[i],
 705                                   PositionalVals[ValNo].first,
 706                                   PositionalVals[ValNo].second);
 707           ValNo++;
 708           break;
 709         default:
 710           llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
 711                  "positional argument processing!");
 712         }
 713       }
 714     }
 715   } else {
 716     assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
 717     unsigned ValNo = 0;
 718     for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
 719       if (RequiresValue(PositionalOpts[j])) {
 720         ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
 721                                                 PositionalVals[ValNo].first,
 722                                                 PositionalVals[ValNo].second);
 723         ValNo++;
 724       }
 725
 726     // Handle the case where there is just one positional option, and it's
 727     // optional.  In this case, we want to give JUST THE FIRST option to the
 728     // positional option and keep the rest for the consume after.  The above
 729     // loop would have assigned no values to positional options in this case.
 730     //
 731     if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
 732       ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
 733                                               PositionalVals[ValNo].first,
 734                                               PositionalVals[ValNo].second);
 735       ValNo++;
 736     }
 737
 738     // Handle over all of the rest of the arguments to the
 739     // cl::ConsumeAfter command line option...
 740     for (; ValNo != PositionalVals.size(); ++ValNo)
 741       ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
 742                                               PositionalVals[ValNo].first,
 743                                               PositionalVals[ValNo].second);
 744   }
 745
 746   // Loop over args and make sure all required args are specified!
 747   for (StringMap<Option*>::iterator I = Opts.begin(),
 748          E = Opts.end(); I != E; ++I) {
 749     switch (I->second->getNumOccurrencesFlag()) {
 750     case Required:
 751     case OneOrMore:
 752       if (I->second->getNumOccurrences() == 0) {
 753         I->second->error("must be specified at least once!");
 754         ErrorParsing = true;
 755       }
 756       // Fall through
 757     default:
 758       break;
 759     }
 760   }
 761
 762   // Free all of the memory allocated to the map.  Command line options may only
 763   // be processed once!
 764   Opts.clear();
 765   PositionalOpts.clear();
 766   MoreHelp->clear();
 767
 768   // Free the memory allocated by ExpandResponseFiles.
 769   if (ReadResponseFiles) {
 770     // Free all the strdup()ed strings.
 771     for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
 772          i != e; ++i)
 773       free(*i);
 774   }
 775
 776   // If we had an error processing our arguments, don't let the program execute
 777   if (ErrorParsing) exit(1);
 778 }
 779
 780 //===----------------------------------------------------------------------===//
 781 // Option Base class implementation
 782 //
 783
 784 bool Option::error(const Twine &Message, StringRef ArgName) {
 785   if (ArgName.data() == 0) ArgName = ArgStr;
 786   if (ArgName.empty())
 787     errs() << HelpStr;  // Be nice for positional arguments
 788   else
 789     errs() << ProgramName << ": for the -" << ArgName;
 790
 791   errs() << " option: " << Message << "\n";
 792   return true;
 793 }
 794
 795 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
 796                            StringRef Value, bool MultiArg) {
 797   if (!MultiArg)
 798     NumOccurrences++;   // Increment the number of times we have been seen
 799
 800   switch (getNumOccurrencesFlag()) {
 801   case Optional:
 802     if (NumOccurrences > 1)
 803       return error("may only occur zero or one times!", ArgName);
 804     break;
 805   case Required:
 806     if (NumOccurrences > 1)
 807       return error("must occur exactly one time!", ArgName);
 808     // Fall through
 809   case OneOrMore:
 810   case ZeroOrMore:
 811   case ConsumeAfter: break;
 812   default: return error("bad num occurrences flag value!");
 813   }
 814
 815   return handleOccurrence(pos, ArgName, Value);
 816 }
 817
 818
 819 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
 820 // has been specified yet.
 821 //
 822 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
 823   if (O.ValueStr[0] == 0) return DefaultMsg;
 824   return O.ValueStr;
 825 }
 826
 827 //===----------------------------------------------------------------------===//
 828 // cl::alias class implementation
 829 //
 830
 831 // Return the width of the option tag for printing...
 832 size_t alias::getOptionWidth() const {
 833   return std::strlen(ArgStr)+6;
 834 }
 835
 836 // Print out the option for the alias.
 837 void alias::printOptionInfo(size_t GlobalWidth) const {
 838   size_t L = std::strlen(ArgStr);
 839   errs() << "  -" << ArgStr;
 840   errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
 841 }
 842
 843
 844
 845 //===----------------------------------------------------------------------===//
 846 // Parser Implementation code...
 847 //
 848
 849 // basic_parser implementation
 850 //
 851
 852 // Return the width of the option tag for printing...
 853 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
 854   size_t Len = std::strlen(O.ArgStr);
 855   if (const char *ValName = getValueName())
 856     Len += std::strlen(getValueStr(O, ValName))+3;
 857
 858   return Len + 6;
 859 }
 860
 861 // printOptionInfo - Print out information about this option.  The
 862 // to-be-maintained width is specified.
 863 //
 864 void basic_parser_impl::printOptionInfo(const Option &O,
 865                                         size_t GlobalWidth) const {
 866   outs() << "  -" << O.ArgStr;
 867
 868   if (const char *ValName = getValueName())
 869     outs() << "=<" << getValueStr(O, ValName) << '>';
 870
 871   outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
 872 }
 873
 874
 875
 876
 877 // parser<bool> implementation
 878 //
 879 bool parser<bool>::parse(Option &O, StringRef ArgName,
 880                          StringRef Arg, bool &Value) {
 881   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
 882       Arg == "1") {
 883     Value = true;
 884     return false;
 885   }
 886
 887   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
 888     Value = false;
 889     return false;
 890   }
 891   return O.error("'" + Arg +
 892                  "' is invalid value for boolean argument! Try 0 or 1");
 893 }
 894
 895 // parser<boolOrDefault> implementation
 896 //
 897 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
 898                                   StringRef Arg, boolOrDefault &Value) {
 899   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
 900       Arg == "1") {
 901     Value = BOU_TRUE;
 902     return false;
 903   }
 904   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
 905     Value = BOU_FALSE;
 906     return false;
 907   }
 908
 909   return O.error("'" + Arg +
 910                  "' is invalid value for boolean argument! Try 0 or 1");
 911 }
 912
 913 // parser<int> implementation
 914 //
 915 bool parser<int>::parse(Option &O, StringRef ArgName,
 916                         StringRef Arg, int &Value) {
 917   if (Arg.getAsInteger(0, Value))
 918     return O.error("'" + Arg + "' value invalid for integer argument!");
 919   return false;
 920 }
 921
 922 // parser<unsigned> implementation
 923 //
 924 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
 925                              StringRef Arg, unsigned &Value) {
 926
 927   if (Arg.getAsInteger(0, Value))
 928     return O.error("'" + Arg + "' value invalid for uint argument!");
 929   return false;
 930 }
 931
 932 // parser<double>/parser<float> implementation
 933 //
 934 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
 935   SmallString<32> TmpStr(Arg.begin(), Arg.end());
 936   const char *ArgStart = TmpStr.c_str();
 937   char *End;
 938   Value = strtod(ArgStart, &End);
 939   if (*End != 0)
 940     return O.error("'" + Arg + "' value invalid for floating point argument!");
 941   return false;
 942 }
 943
 944 bool parser<double>::parse(Option &O, StringRef ArgName,
 945                            StringRef Arg, double &Val) {
 946   return parseDouble(O, Arg, Val);
 947 }
 948
 949 bool parser<float>::parse(Option &O, StringRef ArgName,
 950                           StringRef Arg, float &Val) {
 951   double dVal;
 952   if (parseDouble(O, Arg, dVal))
 953     return true;
 954   Val = (float)dVal;
 955   return false;
 956 }
 957
 958
 959
 960 // generic_parser_base implementation
 961 //
 962
 963 // findOption - Return the option number corresponding to the specified
 964 // argument string.  If the option is not found, getNumOptions() is returned.
 965 //
 966 unsigned generic_parser_base::findOption(const char *Name) {
 967   unsigned e = getNumOptions();
 968
 969   for (unsigned i = 0; i != e; ++i) {
 970     if (strcmp(getOption(i), Name) == 0)
 971       return i;
 972   }
 973   return e;
 974 }
 975
 976
 977 // Return the width of the option tag for printing...
 978 size_t generic_parser_base::getOptionWidth(const Option &O) const {
 979   if (O.hasArgStr()) {
 980     size_t Size = std::strlen(O.ArgStr)+6;
 981     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
 982       Size = std::max(Size, std::strlen(getOption(i))+8);
 983     return Size;
 984   } else {
 985     size_t BaseSize = 0;
 986     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
 987       BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
 988     return BaseSize;
 989   }
 990 }
 991
 992 // printOptionInfo - Print out information about this option.  The
 993 // to-be-maintained width is specified.
 994 //
 995 void generic_parser_base::printOptionInfo(const Option &O,
 996                                           size_t GlobalWidth) const {
 997   if (O.hasArgStr()) {
 998     size_t L = std::strlen(O.ArgStr);
 999     outs() << "  -" << O.ArgStr;
1000     outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
1001
1002     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1003       size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1004       outs() << "    =" << getOption(i);
1005       outs().indent(NumSpaces) << " -   " << getDescription(i) << '\n';
1006     }
1007   } else {
1008     if (O.HelpStr[0])
1009       outs() << "  " << O.HelpStr << '\n';
1010     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1011       size_t L = std::strlen(getOption(i));
1012       outs() << "    -" << getOption(i);
1013       outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1014     }
1015   }
1016 }
1017
1018
1019 //===----------------------------------------------------------------------===//
1020 // --help and --help-hidden option implementation
1021 //
1022
1023 static int OptNameCompare(const void *LHS, const void *RHS) {
1024   typedef std::pair<const char *, Option*> pair_ty;
1025
1026   return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1027 }
1028
1029 namespace {
1030
1031 class HelpPrinter {
1032   size_t MaxArgLen;
1033   const Option *EmptyArg;
1034   const bool ShowHidden;
1035
1036 public:
1037   explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1038     EmptyArg = 0;
1039   }
1040
1041   void operator=(bool Value) {
1042     if (Value == false) return;
1043
1044     // Get all the options.
1045     SmallVector<Option*, 4> PositionalOpts;
1046     SmallVector<Option*, 4> SinkOpts;
1047     StringMap<Option*> OptMap;
1048     GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1049
1050     // Copy Options into a vector so we can sort them as we like.
1051     SmallVector<std::pair<const char *, Option*>, 128> Opts;
1052     SmallPtrSet<Option*, 128> OptionSet;  // Duplicate option detection.
1053
1054     for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1055          I != E; ++I) {
1056       // Ignore really-hidden options.
1057       if (I->second->getOptionHiddenFlag() == ReallyHidden)
1058         continue;
1059
1060       // Unless showhidden is set, ignore hidden flags.
1061       if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1062         continue;
1063
1064       // If we've already seen this option, don't add it to the list again.
1065       if (!OptionSet.insert(I->second))
1066         continue;
1067
1068       Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1069                                                       I->second));
1070     }
1071
1072     // Sort the options list alphabetically.
1073     qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1074
1075     if (ProgramOverview)
1076       outs() << "OVERVIEW: " << ProgramOverview << "\n";
1077
1078     outs() << "USAGE: " << ProgramName << " [options]";
1079
1080     // Print out the positional options.
1081     Option *CAOpt = 0;   // The cl::ConsumeAfter option, if it exists...
1082     if (!PositionalOpts.empty() &&
1083         PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1084       CAOpt = PositionalOpts[0];
1085
1086     for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1087       if (PositionalOpts[i]->ArgStr[0])
1088         outs() << " --" << PositionalOpts[i]->ArgStr;
1089       outs() << " " << PositionalOpts[i]->HelpStr;
1090     }
1091
1092     // Print the consume after option info if it exists...
1093     if (CAOpt) outs() << " " << CAOpt->HelpStr;
1094
1095     outs() << "\n\n";
1096
1097     // Compute the maximum argument length...
1098     MaxArgLen = 0;
1099     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1100       MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1101
1102     outs() << "OPTIONS:\n";
1103     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1104       Opts[i].second->printOptionInfo(MaxArgLen);
1105
1106     // Print any extra help the user has declared.
1107     for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1108           E = MoreHelp->end(); I != E; ++I)
1109       outs() << *I;
1110     MoreHelp->clear();
1111
1112     // Halt the program since help information was printed
1113     exit(1);
1114   }
1115 };
1116 } // End anonymous namespace
1117
1118 // Define the two HelpPrinter instances that are used to print out help, or
1119 // help-hidden...
1120 //
1121 static HelpPrinter NormalPrinter(false);
1122 static HelpPrinter HiddenPrinter(true);
1123
1124 static cl::opt<HelpPrinter, true, parser<bool> >
1125 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1126     cl::location(NormalPrinter), cl::ValueDisallowed);
1127
1128 static cl::opt<HelpPrinter, true, parser<bool> >
1129 HHOp("help-hidden", cl::desc("Display all available options"),
1130      cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1131
1132 static void (*OverrideVersionPrinter)() = 0;
1133
1134 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1135   typedef std::pair<const char *, const Target*> pair_ty;
1136   return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1137 }
1138
1139 namespace {
1140 class VersionPrinter {
1141 public:
1142   void print() {
1143     raw_ostream &OS = outs();
1144     OS << "Low Level Virtual Machine (http://llvm.org/):\n"
1145        << "  " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1146 #ifdef LLVM_VERSION_INFO
1147     OS << LLVM_VERSION_INFO;
1148 #endif
1149     OS << "\n  ";
1150 #ifndef __OPTIMIZE__
1151     OS << "DEBUG build";
1152 #else
1153     OS << "Optimized build";
1154 #endif
1155 #ifndef NDEBUG
1156     OS << " with assertions";
1157 #endif
1158     OS << ".\n"
1159        << "  Built " << __DATE__ << " (" << __TIME__ << ").\n"
1160        << "  Host: " << sys::getHostTriple() << '\n'
1161        << '\n'
1162        << "  Registered Targets:\n";
1163
1164     std::vector<std::pair<const char *, const Target*> > Targets;
1165     size_t Width = 0;
1166     for (TargetRegistry::iterator it = TargetRegistry::begin(),
1167            ie = TargetRegistry::end(); it != ie; ++it) {
1168       Targets.push_back(std::make_pair(it->getName(), &*it));
1169       Width = std::max(Width, strlen(Targets.back().first));
1170     }
1171     if (!Targets.empty())
1172       qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1173             TargetArraySortFn);
1174
1175     for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1176       OS << "    " << Targets[i].first;
1177       OS.indent(Width - strlen(Targets[i].first)) << " - "
1178              << Targets[i].second->getShortDescription() << '\n';
1179     }
1180     if (Targets.empty())
1181       OS << "    (none)\n";
1182   }
1183   void operator=(bool OptionWasSpecified) {
1184     if (!OptionWasSpecified) return;
1185
1186     if (OverrideVersionPrinter == 0) {
1187       print();
1188       exit(1);
1189     }
1190     (*OverrideVersionPrinter)();
1191     exit(1);
1192   }
1193 };
1194 } // End anonymous namespace
1195
1196
1197 // Define the --version option that prints out the LLVM version for the tool
1198 static VersionPrinter VersionPrinterInstance;
1199
1200 static cl::opt<VersionPrinter, true, parser<bool> >
1201 VersOp("version", cl::desc("Display the version of this program"),
1202     cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1203
1204 // Utility function for printing the help message.
1205 void cl::PrintHelpMessage() {
1206   // This looks weird, but it actually prints the help message. The
1207   // NormalPrinter variable is a HelpPrinter and the help gets printed when
1208   // its operator= is invoked. That's because the "normal" usages of the
1209   // help printer is to be assigned true/false depending on whether the
1210   // --help option was given or not. Since we're circumventing that we have
1211   // to make it look like --help was given, so we assign true.
1212   NormalPrinter = true;
1213 }
1214
1215 /// Utility function for printing version number.
1216 void cl::PrintVersionMessage() {
1217   VersionPrinterInstance.print();
1218 }
1219
1220 void cl::SetVersionPrinter(void (*func)()) {
1221   OverrideVersionPrinter = func;
1222 }