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/ADT/ArrayRef.h"
  21 #include "llvm/ADT/OwningPtr.h"
  22 #include "llvm/ADT/SmallPtrSet.h"
  23 #include "llvm/ADT/SmallString.h"
  24 #include "llvm/ADT/StringMap.h"
  25 #include "llvm/ADT/Twine.h"
  26 #include "llvm/Config/config.h"
  27 #include "llvm/Support/ConvertUTF.h"
  28 #include "llvm/Support/Debug.h"
  29 #include "llvm/Support/ErrorHandling.h"
  30 #include "llvm/Support/Host.h"
  31 #include "llvm/Support/ManagedStatic.h"
  32 #include "llvm/Support/MemoryBuffer.h"
  33 #include "llvm/Support/Path.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 #include "llvm/Support/system_error.h"
  36 #include <cerrno>
  37 #include <cstdlib>
  38 #include <map>
  39 using namespace llvm;
  40 using namespace cl;
  41
  42 //===----------------------------------------------------------------------===//
  43 // Template instantiations and anchors.
  44 //
  45 namespace llvm { namespace cl {
  46 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
  47 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
  48 TEMPLATE_INSTANTIATION(class basic_parser<int>);
  49 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
  50 TEMPLATE_INSTANTIATION(class basic_parser<unsigned long long>);
  51 TEMPLATE_INSTANTIATION(class basic_parser<double>);
  52 TEMPLATE_INSTANTIATION(class basic_parser<float>);
  53 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
  54 TEMPLATE_INSTANTIATION(class basic_parser<char>);
  55
  56 TEMPLATE_INSTANTIATION(class opt<unsigned>);
  57 TEMPLATE_INSTANTIATION(class opt<int>);
  58 TEMPLATE_INSTANTIATION(class opt<std::string>);
  59 TEMPLATE_INSTANTIATION(class opt<char>);
  60 TEMPLATE_INSTANTIATION(class opt<bool>);
  61 } } // end namespace llvm::cl
  62
  63 void OptionValue<boolOrDefault>::anchor() {}
  64 void OptionValue<std::string>::anchor() {}
  65 void Option::anchor() {}
  66 void basic_parser_impl::anchor() {}
  67 void parser<bool>::anchor() {}
  68 void parser<boolOrDefault>::anchor() {}
  69 void parser<int>::anchor() {}
  70 void parser<unsigned>::anchor() {}
  71 void parser<unsigned long long>::anchor() {}
  72 void parser<double>::anchor() {}
  73 void parser<float>::anchor() {}
  74 void parser<std::string>::anchor() {}
  75 void parser<char>::anchor() {}
  76
  77 //===----------------------------------------------------------------------===//
  78
  79 // Globals for name and overview of program.  Program name is not a string to
  80 // avoid static ctor/dtor issues.
  81 static char ProgramName[80] = "<premain>";
  82 static const char *ProgramOverview = 0;
  83
  84 // This collects additional help to be printed.
  85 static ManagedStatic<std::vector<const char*> > MoreHelp;
  86
  87 extrahelp::extrahelp(const char *Help)
  88   : morehelp(Help) {
  89   MoreHelp->push_back(Help);
  90 }
  91
  92 static bool OptionListChanged = false;
  93
  94 // MarkOptionsChanged - Internal helper function.
  95 void cl::MarkOptionsChanged() {
  96   OptionListChanged = true;
  97 }
  98
  99 /// RegisteredOptionList - This is the list of the command line options that
 100 /// have statically constructed themselves.
 101 static Option *RegisteredOptionList = 0;
 102
 103 void Option::addArgument() {
 104   assert(NextRegistered == 0 && "argument multiply registered!");
 105
 106   NextRegistered = RegisteredOptionList;
 107   RegisteredOptionList = this;
 108   MarkOptionsChanged();
 109 }
 110
 111 // This collects the different option categories that have been registered.
 112 typedef SmallPtrSet<OptionCategory*,16> OptionCatSet;
 113 static ManagedStatic<OptionCatSet> RegisteredOptionCategories;
 114
 115 // Initialise the general option category.
 116 OptionCategory llvm::cl::GeneralCategory("General options");
 117
 118 void OptionCategory::registerCategory()
 119 {
 120   RegisteredOptionCategories->insert(this);
 121 }
 122
 123 //===----------------------------------------------------------------------===//
 124 // Basic, shared command line option processing machinery.
 125 //
 126
 127 /// GetOptionInfo - Scan the list of registered options, turning them into data
 128 /// structures that are easier to handle.
 129 static void GetOptionInfo(SmallVectorImpl<Option*> &PositionalOpts,
 130                           SmallVectorImpl<Option*> &SinkOpts,
 131                           StringMap<Option*> &OptionsMap) {
 132   SmallVector<const char*, 16> OptionNames;
 133   Option *CAOpt = 0;  // The ConsumeAfter option if it exists.
 134   for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
 135     // If this option wants to handle multiple option names, get the full set.
 136     // This handles enum options like "-O1 -O2" etc.
 137     O->getExtraOptionNames(OptionNames);
 138     if (O->ArgStr[0])
 139       OptionNames.push_back(O->ArgStr);
 140
 141     // Handle named options.
 142     for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
 143       // Add argument to the argument map!
 144       if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
 145         errs() << ProgramName << ": CommandLine Error: Argument '"
 146              << OptionNames[i] << "' defined more than once!\n";
 147       }
 148     }
 149
 150     OptionNames.clear();
 151
 152     // Remember information about positional options.
 153     if (O->getFormattingFlag() == cl::Positional)
 154       PositionalOpts.push_back(O);
 155     else if (O->getMiscFlags() & cl::Sink) // Remember sink options
 156       SinkOpts.push_back(O);
 157     else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
 158       if (CAOpt)
 159         O->error("Cannot specify more than one option with cl::ConsumeAfter!");
 160       CAOpt = O;
 161     }
 162   }
 163
 164   if (CAOpt)
 165     PositionalOpts.push_back(CAOpt);
 166
 167   // Make sure that they are in order of registration not backwards.
 168   std::reverse(PositionalOpts.begin(), PositionalOpts.end());
 169 }
 170
 171
 172 /// LookupOption - Lookup the option specified by the specified option on the
 173 /// command line.  If there is a value specified (after an equal sign) return
 174 /// that as well.  This assumes that leading dashes have already been stripped.
 175 static Option *LookupOption(StringRef &Arg, StringRef &Value,
 176                             const StringMap<Option*> &OptionsMap) {
 177   // Reject all dashes.
 178   if (Arg.empty()) return 0;
 179
 180   size_t EqualPos = Arg.find('=');
 181
 182   // If we have an equals sign, remember the value.
 183   if (EqualPos == StringRef::npos) {
 184     // Look up the option.
 185     StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
 186     return I != OptionsMap.end() ? I->second : 0;
 187   }
 188
 189   // If the argument before the = is a valid option name, we match.  If not,
 190   // return Arg unmolested.
 191   StringMap<Option*>::const_iterator I =
 192     OptionsMap.find(Arg.substr(0, EqualPos));
 193   if (I == OptionsMap.end()) return 0;
 194
 195   Value = Arg.substr(EqualPos+1);
 196   Arg = Arg.substr(0, EqualPos);
 197   return I->second;
 198 }
 199
 200 /// LookupNearestOption - Lookup the closest match to the option specified by
 201 /// the specified option on the command line.  If there is a value specified
 202 /// (after an equal sign) return that as well.  This assumes that leading dashes
 203 /// have already been stripped.
 204 static Option *LookupNearestOption(StringRef Arg,
 205                                    const StringMap<Option*> &OptionsMap,
 206                                    std::string &NearestString) {
 207   // Reject all dashes.
 208   if (Arg.empty()) return 0;
 209
 210   // Split on any equal sign.
 211   std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
 212   StringRef &LHS = SplitArg.first;  // LHS == Arg when no '=' is present.
 213   StringRef &RHS = SplitArg.second;
 214
 215   // Find the closest match.
 216   Option *Best = 0;
 217   unsigned BestDistance = 0;
 218   for (StringMap<Option*>::const_iterator it = OptionsMap.begin(),
 219          ie = OptionsMap.end(); it != ie; ++it) {
 220     Option *O = it->second;
 221     SmallVector<const char*, 16> OptionNames;
 222     O->getExtraOptionNames(OptionNames);
 223     if (O->ArgStr[0])
 224       OptionNames.push_back(O->ArgStr);
 225
 226     bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
 227     StringRef Flag = PermitValue ? LHS : Arg;
 228     for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
 229       StringRef Name = OptionNames[i];
 230       unsigned Distance = StringRef(Name).edit_distance(
 231         Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
 232       if (!Best || Distance < BestDistance) {
 233         Best = O;
 234         BestDistance = Distance;
 235         if (RHS.empty() || !PermitValue)
 236           NearestString = OptionNames[i];
 237         else
 238           NearestString = std::string(OptionNames[i]) + "=" + RHS.str();
 239       }
 240     }
 241   }
 242
 243   return Best;
 244 }
 245
 246 /// CommaSeparateAndAddOccurence - A wrapper around Handler->addOccurence() that
 247 /// does special handling of cl::CommaSeparated options.
 248 static bool CommaSeparateAndAddOccurence(Option *Handler, unsigned pos,
 249                                          StringRef ArgName,
 250                                          StringRef Value, bool MultiArg = false)
 251 {
 252   // Check to see if this option accepts a comma separated list of values.  If
 253   // it does, we have to split up the value into multiple values.
 254   if (Handler->getMiscFlags() & CommaSeparated) {
 255     StringRef Val(Value);
 256     StringRef::size_type Pos = Val.find(',');
 257
 258     while (Pos != StringRef::npos) {
 259       // Process the portion before the comma.
 260       if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
 261         return true;
 262       // Erase the portion before the comma, AND the comma.
 263       Val = Val.substr(Pos+1);
 264       Value.substr(Pos+1);  // Increment the original value pointer as well.
 265       // Check for another comma.
 266       Pos = Val.find(',');
 267     }
 268
 269     Value = Val;
 270   }
 271
 272   if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
 273     return true;
 274
 275   return false;
 276 }
 277
 278 /// ProvideOption - For Value, this differentiates between an empty value ("")
 279 /// and a null value (StringRef()).  The later is accepted for arguments that
 280 /// don't allow a value (-foo) the former is rejected (-foo=).
 281 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
 282                                  StringRef Value, int argc,
 283                                  const char *const *argv, int &i) {
 284   // Is this a multi-argument option?
 285   unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
 286
 287   // Enforce value requirements
 288   switch (Handler->getValueExpectedFlag()) {
 289   case ValueRequired:
 290     if (Value.data() == 0) {       // No value specified?
 291       if (i+1 >= argc)
 292         return Handler->error("requires a value!");
 293       // Steal the next argument, like for '-o filename'
 294       Value = argv[++i];
 295     }
 296     break;
 297   case ValueDisallowed:
 298     if (NumAdditionalVals > 0)
 299       return Handler->error("multi-valued option specified"
 300                             " with ValueDisallowed modifier!");
 301
 302     if (Value.data())
 303       return Handler->error("does not allow a value! '" +
 304                             Twine(Value) + "' specified.");
 305     break;
 306   case ValueOptional:
 307     break;
 308   }
 309
 310   // If this isn't a multi-arg option, just run the handler.
 311   if (NumAdditionalVals == 0)
 312     return CommaSeparateAndAddOccurence(Handler, i, ArgName, Value);
 313
 314   // If it is, run the handle several times.
 315   bool MultiArg = false;
 316
 317   if (Value.data()) {
 318     if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
 319       return true;
 320     --NumAdditionalVals;
 321     MultiArg = true;
 322   }
 323
 324   while (NumAdditionalVals > 0) {
 325     if (i+1 >= argc)
 326       return Handler->error("not enough values!");
 327     Value = argv[++i];
 328
 329     if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
 330       return true;
 331     MultiArg = true;
 332     --NumAdditionalVals;
 333   }
 334   return false;
 335 }
 336
 337 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
 338   int Dummy = i;
 339   return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
 340 }
 341
 342
 343 // Option predicates...
 344 static inline bool isGrouping(const Option *O) {
 345   return O->getFormattingFlag() == cl::Grouping;
 346 }
 347 static inline bool isPrefixedOrGrouping(const Option *O) {
 348   return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
 349 }
 350
 351 // getOptionPred - Check to see if there are any options that satisfy the
 352 // specified predicate with names that are the prefixes in Name.  This is
 353 // checked by progressively stripping characters off of the name, checking to
 354 // see if there options that satisfy the predicate.  If we find one, return it,
 355 // otherwise return null.
 356 //
 357 static Option *getOptionPred(StringRef Name, size_t &Length,
 358                              bool (*Pred)(const Option*),
 359                              const StringMap<Option*> &OptionsMap) {
 360
 361   StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
 362
 363   // Loop while we haven't found an option and Name still has at least two
 364   // characters in it (so that the next iteration will not be the empty
 365   // string.
 366   while (OMI == OptionsMap.end() && Name.size() > 1) {
 367     Name = Name.substr(0, Name.size()-1);   // Chop off the last character.
 368     OMI = OptionsMap.find(Name);
 369   }
 370
 371   if (OMI != OptionsMap.end() && Pred(OMI->second)) {
 372     Length = Name.size();
 373     return OMI->second;    // Found one!
 374   }
 375   return 0;                // No option found!
 376 }
 377
 378 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
 379 /// with at least one '-') does not fully match an available option.  Check to
 380 /// see if this is a prefix or grouped option.  If so, split arg into output an
 381 /// Arg/Value pair and return the Option to parse it with.
 382 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
 383                                              bool &ErrorParsing,
 384                                          const StringMap<Option*> &OptionsMap) {
 385   if (Arg.size() == 1) return 0;
 386
 387   // Do the lookup!
 388   size_t Length = 0;
 389   Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
 390   if (PGOpt == 0) return 0;
 391
 392   // If the option is a prefixed option, then the value is simply the
 393   // rest of the name...  so fall through to later processing, by
 394   // setting up the argument name flags and value fields.
 395   if (PGOpt->getFormattingFlag() == cl::Prefix) {
 396     Value = Arg.substr(Length);
 397     Arg = Arg.substr(0, Length);
 398     assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
 399     return PGOpt;
 400   }
 401
 402   // This must be a grouped option... handle them now.  Grouping options can't
 403   // have values.
 404   assert(isGrouping(PGOpt) && "Broken getOptionPred!");
 405
 406   do {
 407     // Move current arg name out of Arg into OneArgName.
 408     StringRef OneArgName = Arg.substr(0, Length);
 409     Arg = Arg.substr(Length);
 410
 411     // Because ValueRequired is an invalid flag for grouped arguments,
 412     // we don't need to pass argc/argv in.
 413     assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
 414            "Option can not be cl::Grouping AND cl::ValueRequired!");
 415     int Dummy = 0;
 416     ErrorParsing |= ProvideOption(PGOpt, OneArgName,
 417                                   StringRef(), 0, 0, Dummy);
 418
 419     // Get the next grouping option.
 420     PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
 421   } while (PGOpt && Length != Arg.size());
 422
 423   // Return the last option with Arg cut down to just the last one.
 424   return PGOpt;
 425 }
 426
 427
 428
 429 static bool RequiresValue(const Option *O) {
 430   return O->getNumOccurrencesFlag() == cl::Required ||
 431          O->getNumOccurrencesFlag() == cl::OneOrMore;
 432 }
 433
 434 static bool EatsUnboundedNumberOfValues(const Option *O) {
 435   return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
 436          O->getNumOccurrencesFlag() == cl::OneOrMore;
 437 }
 438
 439 static bool isWhitespace(char C) {
 440   return strchr(" \t\n\r\f\v", C);
 441 }
 442
 443 static bool isQuote(char C) {
 444   return C == '\"' || C == '\'';
 445 }
 446
 447 static bool isGNUSpecial(char C) {
 448   return strchr("\\\"\' ", C);
 449 }
 450
 451 void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
 452                                 SmallVectorImpl<const char *> &NewArgv) {
 453   SmallString<128> Token;
 454   for (size_t I = 0, E = Src.size(); I != E; ++I) {
 455     // Consume runs of whitespace.
 456     if (Token.empty()) {
 457       while (I != E && isWhitespace(Src[I]))
 458         ++I;
 459       if (I == E) break;
 460     }
 461
 462     // Backslashes can escape backslashes, spaces, and other quotes.  Otherwise
 463     // they are literal.  This makes it much easier to read Windows file paths.
 464     if (I + 1 < E && Src[I] == '\\' && isGNUSpecial(Src[I + 1])) {
 465       ++I;  // Skip the escape.
 466       Token.push_back(Src[I]);
 467       continue;
 468     }
 469
 470     // Consume a quoted string.
 471     if (isQuote(Src[I])) {
 472       char Quote = Src[I++];
 473       while (I != E && Src[I] != Quote) {
 474         // Backslashes are literal, unless they escape a special character.
 475         if (Src[I] == '\\' && I + 1 != E && isGNUSpecial(Src[I + 1]))
 476           ++I;
 477         Token.push_back(Src[I]);
 478         ++I;
 479       }
 480       if (I == E) break;
 481       continue;
 482     }
 483
 484     // End the token if this is whitespace.
 485     if (isWhitespace(Src[I])) {
 486       if (!Token.empty())
 487         NewArgv.push_back(Saver.SaveString(Token.c_str()));
 488       Token.clear();
 489       continue;
 490     }
 491
 492     // This is a normal character.  Append it.
 493     Token.push_back(Src[I]);
 494   }
 495
 496   // Append the last token after hitting EOF with no whitespace.
 497   if (!Token.empty())
 498     NewArgv.push_back(Saver.SaveString(Token.c_str()));
 499 }
 500
 501 void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
 502                                     SmallVectorImpl<const char *> &NewArgv) {
 503   llvm_unreachable("FIXME not implemented");
 504 }
 505
 506 static bool ExpandResponseFile(const char *FName, StringSaver &Saver,
 507                                TokenizerCallback Tokenizer,
 508                                SmallVectorImpl<const char *> &NewArgv) {
 509   OwningPtr<MemoryBuffer> MemBuf;
 510   if (MemoryBuffer::getFile(FName, MemBuf))
 511     return false;
 512   StringRef Str(MemBuf->getBufferStart(), MemBuf->getBufferSize());
 513
 514   // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
 515   ArrayRef<char> BufRef(MemBuf->getBufferStart(), MemBuf->getBufferEnd());
 516   std::string UTF8Buf;
 517   if (hasUTF16ByteOrderMark(BufRef)) {
 518     if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
 519       return false;
 520     Str = StringRef(UTF8Buf);
 521   }
 522
 523   // Tokenize the contents into NewArgv.
 524   Tokenizer(Str, Saver, NewArgv);
 525
 526   return true;
 527 }
 528
 529 /// \brief Expand response files on a command line recursively using the given
 530 /// StringSaver and tokenization strategy.
 531 bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
 532                              SmallVectorImpl<const char *> &Argv) {
 533   unsigned RspFiles = 0;
 534   bool AllExpanded = false;
 535
 536   // Don't cache Argv.size() because it can change.
 537   for (unsigned I = 0; I != Argv.size(); ) {
 538     const char *Arg = Argv[I];
 539     if (Arg[0] != '@') {
 540       ++I;
 541       continue;
 542     }
 543
 544     // If we have too many response files, leave some unexpanded.  This avoids
 545     // crashing on self-referential response files.
 546     if (RspFiles++ > 20)
 547       return false;
 548
 549     // Replace this response file argument with the tokenization of its
 550     // contents.  Nested response files are expanded in subsequent iterations.
 551     // FIXME: If a nested response file uses a relative path, is it relative to
 552     // the cwd of the process or the response file?
 553     SmallVector<const char *, 0> ExpandedArgv;
 554     if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv)) {
 555       AllExpanded = false;
 556       continue;
 557     }
 558     Argv.erase(Argv.begin() + I);
 559     Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
 560   }
 561   return AllExpanded;
 562 }
 563
 564 namespace {
 565   class StrDupSaver : public StringSaver {
 566     std::vector<char*> Dups;
 567   public:
 568     ~StrDupSaver() {
 569       for (std::vector<char *>::iterator I = Dups.begin(), E = Dups.end();
 570            I != E; ++I) {
 571         char *Dup = *I;
 572         free(Dup);
 573       }
 574     }
 575     const char *SaveString(const char *Str) LLVM_OVERRIDE {
 576       char *Dup = strdup(Str);
 577       Dups.push_back(Dup);
 578       return Dup;
 579     }
 580   };
 581 }
 582
 583 /// ParseEnvironmentOptions - An alternative entry point to the
 584 /// CommandLine library, which allows you to read the program's name
 585 /// from the caller (as PROGNAME) and its command-line arguments from
 586 /// an environment variable (whose name is given in ENVVAR).
 587 ///
 588 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
 589                                  const char *Overview) {
 590   // Check args.
 591   assert(progName && "Program name not specified");
 592   assert(envVar && "Environment variable name missing");
 593
 594   // Get the environment variable they want us to parse options out of.
 595   const char *envValue = getenv(envVar);
 596   if (!envValue)
 597     return;
 598
 599   // Get program's "name", which we wouldn't know without the caller
 600   // telling us.
 601   SmallVector<const char *, 20> newArgv;
 602   StrDupSaver Saver;
 603   newArgv.push_back(Saver.SaveString(progName));
 604
 605   // Parse the value of the environment variable into a "command line"
 606   // and hand it off to ParseCommandLineOptions().
 607   TokenizeGNUCommandLine(envValue, Saver, newArgv);
 608   int newArgc = static_cast<int>(newArgv.size());
 609   ParseCommandLineOptions(newArgc, &newArgv[0], Overview);
 610 }
 611
 612 void cl::ParseCommandLineOptions(int argc, const char * const *argv,
 613                                  const char *Overview) {
 614   // Process all registered options.
 615   SmallVector<Option*, 4> PositionalOpts;
 616   SmallVector<Option*, 4> SinkOpts;
 617   StringMap<Option*> Opts;
 618   GetOptionInfo(PositionalOpts, SinkOpts, Opts);
 619
 620   assert((!Opts.empty() || !PositionalOpts.empty()) &&
 621          "No options specified!");
 622
 623   // Expand response files.
 624   SmallVector<const char *, 20> newArgv;
 625   for (int i = 0; i != argc; ++i)
 626     newArgv.push_back(argv[i]);
 627   StrDupSaver Saver;
 628   ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
 629   argv = &newArgv[0];
 630   argc = static_cast<int>(newArgv.size());
 631
 632   // Copy the program name into ProgName, making sure not to overflow it.
 633   std::string ProgName = sys::path::filename(argv[0]);
 634   size_t Len = std::min(ProgName.size(), size_t(79));
 635   memcpy(ProgramName, ProgName.data(), Len);
 636   ProgramName[Len] = '\0';
 637
 638   ProgramOverview = Overview;
 639   bool ErrorParsing = false;
 640
 641   // Check out the positional arguments to collect information about them.
 642   unsigned NumPositionalRequired = 0;
 643
 644   // Determine whether or not there are an unlimited number of positionals
 645   bool HasUnlimitedPositionals = false;
 646
 647   Option *ConsumeAfterOpt = 0;
 648   if (!PositionalOpts.empty()) {
 649     if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
 650       assert(PositionalOpts.size() > 1 &&
 651              "Cannot specify cl::ConsumeAfter without a positional argument!");
 652       ConsumeAfterOpt = PositionalOpts[0];
 653     }
 654
 655     // Calculate how many positional values are _required_.
 656     bool UnboundedFound = false;
 657     for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
 658          i != e; ++i) {
 659       Option *Opt = PositionalOpts[i];
 660       if (RequiresValue(Opt))
 661         ++NumPositionalRequired;
 662       else if (ConsumeAfterOpt) {
 663         // ConsumeAfter cannot be combined with "optional" positional options
 664         // unless there is only one positional argument...
 665         if (PositionalOpts.size() > 2)
 666           ErrorParsing |=
 667             Opt->error("error - this positional option will never be matched, "
 668                        "because it does not Require a value, and a "
 669                        "cl::ConsumeAfter option is active!");
 670       } else if (UnboundedFound && !Opt->ArgStr[0]) {
 671         // This option does not "require" a value...  Make sure this option is
 672         // not specified after an option that eats all extra arguments, or this
 673         // one will never get any!
 674         //
 675         ErrorParsing |= Opt->error("error - option can never match, because "
 676                                    "another positional argument will match an "
 677                                    "unbounded number of values, and this option"
 678                                    " does not require a value!");
 679       }
 680       UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
 681     }
 682     HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
 683   }
 684
 685   // PositionalVals - A vector of "positional" arguments we accumulate into
 686   // the process at the end.
 687   //
 688   SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
 689
 690   // If the program has named positional arguments, and the name has been run
 691   // across, keep track of which positional argument was named.  Otherwise put
 692   // the positional args into the PositionalVals list...
 693   Option *ActivePositionalArg = 0;
 694
 695   // Loop over all of the arguments... processing them.
 696   bool DashDashFound = false;  // Have we read '--'?
 697   for (int i = 1; i < argc; ++i) {
 698     Option *Handler = 0;
 699     Option *NearestHandler = 0;
 700     std::string NearestHandlerString;
 701     StringRef Value;
 702     StringRef ArgName = "";
 703
 704     // If the option list changed, this means that some command line
 705     // option has just been registered or deregistered.  This can occur in
 706     // response to things like -load, etc.  If this happens, rescan the options.
 707     if (OptionListChanged) {
 708       PositionalOpts.clear();
 709       SinkOpts.clear();
 710       Opts.clear();
 711       GetOptionInfo(PositionalOpts, SinkOpts, Opts);
 712       OptionListChanged = false;
 713     }
 714
 715     // Check to see if this is a positional argument.  This argument is
 716     // considered to be positional if it doesn't start with '-', if it is "-"
 717     // itself, or if we have seen "--" already.
 718     //
 719     if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
 720       // Positional argument!
 721       if (ActivePositionalArg) {
 722         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
 723         continue;  // We are done!
 724       }
 725
 726       if (!PositionalOpts.empty()) {
 727         PositionalVals.push_back(std::make_pair(argv[i],i));
 728
 729         // All of the positional arguments have been fulfulled, give the rest to
 730         // the consume after option... if it's specified...
 731         //
 732         if (PositionalVals.size() >= NumPositionalRequired &&
 733             ConsumeAfterOpt != 0) {
 734           for (++i; i < argc; ++i)
 735             PositionalVals.push_back(std::make_pair(argv[i],i));
 736           break;   // Handle outside of the argument processing loop...
 737         }
 738
 739         // Delay processing positional arguments until the end...
 740         continue;
 741       }
 742     } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
 743                !DashDashFound) {
 744       DashDashFound = true;  // This is the mythical "--"?
 745       continue;              // Don't try to process it as an argument itself.
 746     } else if (ActivePositionalArg &&
 747                (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
 748       // If there is a positional argument eating options, check to see if this
 749       // option is another positional argument.  If so, treat it as an argument,
 750       // otherwise feed it to the eating positional.
 751       ArgName = argv[i]+1;
 752       // Eat leading dashes.
 753       while (!ArgName.empty() && ArgName[0] == '-')
 754         ArgName = ArgName.substr(1);
 755
 756       Handler = LookupOption(ArgName, Value, Opts);
 757       if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
 758         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
 759         continue;  // We are done!
 760       }
 761
 762     } else {     // We start with a '-', must be an argument.
 763       ArgName = argv[i]+1;
 764       // Eat leading dashes.
 765       while (!ArgName.empty() && ArgName[0] == '-')
 766         ArgName = ArgName.substr(1);
 767
 768       Handler = LookupOption(ArgName, Value, Opts);
 769
 770       // Check to see if this "option" is really a prefixed or grouped argument.
 771       if (Handler == 0)
 772         Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
 773                                                 ErrorParsing, Opts);
 774
 775       // Otherwise, look for the closest available option to report to the user
 776       // in the upcoming error.
 777       if (Handler == 0 && SinkOpts.empty())
 778         NearestHandler = LookupNearestOption(ArgName, Opts,
 779                                              NearestHandlerString);
 780     }
 781
 782     if (Handler == 0) {
 783       if (SinkOpts.empty()) {
 784         errs() << ProgramName << ": Unknown command line argument '"
 785              << argv[i] << "'.  Try: '" << argv[0] << " -help'\n";
 786
 787         if (NearestHandler) {
 788           // If we know a near match, report it as well.
 789           errs() << ProgramName << ": Did you mean '-"
 790                  << NearestHandlerString << "'?\n";
 791         }
 792
 793         ErrorParsing = true;
 794       } else {
 795         for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
 796                E = SinkOpts.end(); I != E ; ++I)
 797           (*I)->addOccurrence(i, "", argv[i]);
 798       }
 799       continue;
 800     }
 801
 802     // If this is a named positional argument, just remember that it is the
 803     // active one...
 804     if (Handler->getFormattingFlag() == cl::Positional)
 805       ActivePositionalArg = Handler;
 806     else
 807       ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
 808   }
 809
 810   // Check and handle positional arguments now...
 811   if (NumPositionalRequired > PositionalVals.size()) {
 812     errs() << ProgramName
 813          << ": Not enough positional command line arguments specified!\n"
 814          << "Must specify at least " << NumPositionalRequired
 815          << " positional arguments: See: " << argv[0] << " -help\n";
 816
 817     ErrorParsing = true;
 818   } else if (!HasUnlimitedPositionals &&
 819              PositionalVals.size() > PositionalOpts.size()) {
 820     errs() << ProgramName
 821          << ": Too many positional arguments specified!\n"
 822          << "Can specify at most " << PositionalOpts.size()
 823          << " positional arguments: See: " << argv[0] << " -help\n";
 824     ErrorParsing = true;
 825
 826   } else if (ConsumeAfterOpt == 0) {
 827     // Positional args have already been handled if ConsumeAfter is specified.
 828     unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
 829     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
 830       if (RequiresValue(PositionalOpts[i])) {
 831         ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
 832                                 PositionalVals[ValNo].second);
 833         ValNo++;
 834         --NumPositionalRequired;  // We fulfilled our duty...
 835       }
 836
 837       // If we _can_ give this option more arguments, do so now, as long as we
 838       // do not give it values that others need.  'Done' controls whether the
 839       // option even _WANTS_ any more.
 840       //
 841       bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
 842       while (NumVals-ValNo > NumPositionalRequired && !Done) {
 843         switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
 844         case cl::Optional:
 845           Done = true;          // Optional arguments want _at most_ one value
 846           // FALL THROUGH
 847         case cl::ZeroOrMore:    // Zero or more will take all they can get...
 848         case cl::OneOrMore:     // One or more will take all they can get...
 849           ProvidePositionalOption(PositionalOpts[i],
 850                                   PositionalVals[ValNo].first,
 851                                   PositionalVals[ValNo].second);
 852           ValNo++;
 853           break;
 854         default:
 855           llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
 856                  "positional argument processing!");
 857         }
 858       }
 859     }
 860   } else {
 861     assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
 862     unsigned ValNo = 0;
 863     for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
 864       if (RequiresValue(PositionalOpts[j])) {
 865         ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
 866                                                 PositionalVals[ValNo].first,
 867                                                 PositionalVals[ValNo].second);
 868         ValNo++;
 869       }
 870
 871     // Handle the case where there is just one positional option, and it's
 872     // optional.  In this case, we want to give JUST THE FIRST option to the
 873     // positional option and keep the rest for the consume after.  The above
 874     // loop would have assigned no values to positional options in this case.
 875     //
 876     if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
 877       ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
 878                                               PositionalVals[ValNo].first,
 879                                               PositionalVals[ValNo].second);
 880       ValNo++;
 881     }
 882
 883     // Handle over all of the rest of the arguments to the
 884     // cl::ConsumeAfter command line option...
 885     for (; ValNo != PositionalVals.size(); ++ValNo)
 886       ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
 887                                               PositionalVals[ValNo].first,
 888                                               PositionalVals[ValNo].second);
 889   }
 890
 891   // Loop over args and make sure all required args are specified!
 892   for (StringMap<Option*>::iterator I = Opts.begin(),
 893          E = Opts.end(); I != E; ++I) {
 894     switch (I->second->getNumOccurrencesFlag()) {
 895     case Required:
 896     case OneOrMore:
 897       if (I->second->getNumOccurrences() == 0) {
 898         I->second->error("must be specified at least once!");
 899         ErrorParsing = true;
 900       }
 901       // Fall through
 902     default:
 903       break;
 904     }
 905   }
 906
 907   // Now that we know if -debug is specified, we can use it.
 908   // Note that if ReadResponseFiles == true, this must be done before the
 909   // memory allocated for the expanded command line is free()d below.
 910   DEBUG(dbgs() << "Args: ";
 911         for (int i = 0; i < argc; ++i)
 912           dbgs() << argv[i] << ' ';
 913         dbgs() << '\n';
 914        );
 915
 916   // Free all of the memory allocated to the map.  Command line options may only
 917   // be processed once!
 918   Opts.clear();
 919   PositionalOpts.clear();
 920   MoreHelp->clear();
 921
 922   // If we had an error processing our arguments, don't let the program execute
 923   if (ErrorParsing) exit(1);
 924 }
 925
 926 //===----------------------------------------------------------------------===//
 927 // Option Base class implementation
 928 //
 929
 930 bool Option::error(const Twine &Message, StringRef ArgName) {
 931   if (ArgName.data() == 0) ArgName = ArgStr;
 932   if (ArgName.empty())
 933     errs() << HelpStr;  // Be nice for positional arguments
 934   else
 935     errs() << ProgramName << ": for the -" << ArgName;
 936
 937   errs() << " option: " << Message << "\n";
 938   return true;
 939 }
 940
 941 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
 942                            StringRef Value, bool MultiArg) {
 943   if (!MultiArg)
 944     NumOccurrences++;   // Increment the number of times we have been seen
 945
 946   switch (getNumOccurrencesFlag()) {
 947   case Optional:
 948     if (NumOccurrences > 1)
 949       return error("may only occur zero or one times!", ArgName);
 950     break;
 951   case Required:
 952     if (NumOccurrences > 1)
 953       return error("must occur exactly one time!", ArgName);
 954     // Fall through
 955   case OneOrMore:
 956   case ZeroOrMore:
 957   case ConsumeAfter: break;
 958   }
 959
 960   return handleOccurrence(pos, ArgName, Value);
 961 }
 962
 963
 964 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
 965 // has been specified yet.
 966 //
 967 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
 968   if (O.ValueStr[0] == 0) return DefaultMsg;
 969   return O.ValueStr;
 970 }
 971
 972 //===----------------------------------------------------------------------===//
 973 // cl::alias class implementation
 974 //
 975
 976 // Return the width of the option tag for printing...
 977 size_t alias::getOptionWidth() const {
 978   return std::strlen(ArgStr)+6;
 979 }
 980
 981 static void printHelpStr(StringRef HelpStr, size_t Indent,
 982                          size_t FirstLineIndentedBy) {
 983   std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
 984   outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
 985   while (!Split.second.empty()) {
 986     Split = Split.second.split('\n');
 987     outs().indent(Indent) << Split.first << "\n";
 988   }
 989 }
 990
 991 // Print out the option for the alias.
 992 void alias::printOptionInfo(size_t GlobalWidth) const {
 993   outs() << "  -" << ArgStr;
 994   printHelpStr(HelpStr, GlobalWidth, std::strlen(ArgStr) + 6);
 995 }
 996
 997 //===----------------------------------------------------------------------===//
 998 // Parser Implementation code...
 999 //
1000
1001 // basic_parser implementation
1002 //
1003
1004 // Return the width of the option tag for printing...
1005 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
1006   size_t Len = std::strlen(O.ArgStr);
1007   if (const char *ValName = getValueName())
1008     Len += std::strlen(getValueStr(O, ValName))+3;
1009
1010   return Len + 6;
1011 }
1012
1013 // printOptionInfo - Print out information about this option.  The
1014 // to-be-maintained width is specified.
1015 //
1016 void basic_parser_impl::printOptionInfo(const Option &O,
1017                                         size_t GlobalWidth) const {
1018   outs() << "  -" << O.ArgStr;
1019
1020   if (const char *ValName = getValueName())
1021     outs() << "=<" << getValueStr(O, ValName) << '>';
1022
1023   printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
1024 }
1025
1026 void basic_parser_impl::printOptionName(const Option &O,
1027                                         size_t GlobalWidth) const {
1028   outs() << "  -" << O.ArgStr;
1029   outs().indent(GlobalWidth-std::strlen(O.ArgStr));
1030 }
1031
1032
1033 // parser<bool> implementation
1034 //
1035 bool parser<bool>::parse(Option &O, StringRef ArgName,
1036                          StringRef Arg, bool &Value) {
1037   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1038       Arg == "1") {
1039     Value = true;
1040     return false;
1041   }
1042
1043   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1044     Value = false;
1045     return false;
1046   }
1047   return O.error("'" + Arg +
1048                  "' is invalid value for boolean argument! Try 0 or 1");
1049 }
1050
1051 // parser<boolOrDefault> implementation
1052 //
1053 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
1054                                   StringRef Arg, boolOrDefault &Value) {
1055   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1056       Arg == "1") {
1057     Value = BOU_TRUE;
1058     return false;
1059   }
1060   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1061     Value = BOU_FALSE;
1062     return false;
1063   }
1064
1065   return O.error("'" + Arg +
1066                  "' is invalid value for boolean argument! Try 0 or 1");
1067 }
1068
1069 // parser<int> implementation
1070 //
1071 bool parser<int>::parse(Option &O, StringRef ArgName,
1072                         StringRef Arg, int &Value) {
1073   if (Arg.getAsInteger(0, Value))
1074     return O.error("'" + Arg + "' value invalid for integer argument!");
1075   return false;
1076 }
1077
1078 // parser<unsigned> implementation
1079 //
1080 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
1081                              StringRef Arg, unsigned &Value) {
1082
1083   if (Arg.getAsInteger(0, Value))
1084     return O.error("'" + Arg + "' value invalid for uint argument!");
1085   return false;
1086 }
1087
1088 // parser<unsigned long long> implementation
1089 //
1090 bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
1091                                       StringRef Arg, unsigned long long &Value){
1092
1093   if (Arg.getAsInteger(0, Value))
1094     return O.error("'" + Arg + "' value invalid for uint argument!");
1095   return false;
1096 }
1097
1098 // parser<double>/parser<float> implementation
1099 //
1100 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1101   SmallString<32> TmpStr(Arg.begin(), Arg.end());
1102   const char *ArgStart = TmpStr.c_str();
1103   char *End;
1104   Value = strtod(ArgStart, &End);
1105   if (*End != 0)
1106     return O.error("'" + Arg + "' value invalid for floating point argument!");
1107   return false;
1108 }
1109
1110 bool parser<double>::parse(Option &O, StringRef ArgName,
1111                            StringRef Arg, double &Val) {
1112   return parseDouble(O, Arg, Val);
1113 }
1114
1115 bool parser<float>::parse(Option &O, StringRef ArgName,
1116                           StringRef Arg, float &Val) {
1117   double dVal;
1118   if (parseDouble(O, Arg, dVal))
1119     return true;
1120   Val = (float)dVal;
1121   return false;
1122 }
1123
1124
1125
1126 // generic_parser_base implementation
1127 //
1128
1129 // findOption - Return the option number corresponding to the specified
1130 // argument string.  If the option is not found, getNumOptions() is returned.
1131 //
1132 unsigned generic_parser_base::findOption(const char *Name) {
1133   unsigned e = getNumOptions();
1134
1135   for (unsigned i = 0; i != e; ++i) {
1136     if (strcmp(getOption(i), Name) == 0)
1137       return i;
1138   }
1139   return e;
1140 }
1141
1142
1143 // Return the width of the option tag for printing...
1144 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1145   if (O.hasArgStr()) {
1146     size_t Size = std::strlen(O.ArgStr)+6;
1147     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1148       Size = std::max(Size, std::strlen(getOption(i))+8);
1149     return Size;
1150   } else {
1151     size_t BaseSize = 0;
1152     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1153       BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1154     return BaseSize;
1155   }
1156 }
1157
1158 // printOptionInfo - Print out information about this option.  The
1159 // to-be-maintained width is specified.
1160 //
1161 void generic_parser_base::printOptionInfo(const Option &O,
1162                                           size_t GlobalWidth) const {
1163   if (O.hasArgStr()) {
1164     outs() << "  -" << O.ArgStr;
1165     printHelpStr(O.HelpStr, GlobalWidth, std::strlen(O.ArgStr) + 6);
1166
1167     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1168       size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1169       outs() << "    =" << getOption(i);
1170       outs().indent(NumSpaces) << " -   " << getDescription(i) << '\n';
1171     }
1172   } else {
1173     if (O.HelpStr[0])
1174       outs() << "  " << O.HelpStr << '\n';
1175     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1176       const char *Option = getOption(i);
1177       outs() << "    -" << Option;
1178       printHelpStr(getDescription(i), GlobalWidth, std::strlen(Option) + 8);
1179     }
1180   }
1181 }
1182
1183 static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1184
1185 // printGenericOptionDiff - Print the value of this option and it's default.
1186 //
1187 // "Generic" options have each value mapped to a name.
1188 void generic_parser_base::
1189 printGenericOptionDiff(const Option &O, const GenericOptionValue &Value,
1190                        const GenericOptionValue &Default,
1191                        size_t GlobalWidth) const {
1192   outs() << "  -" << O.ArgStr;
1193   outs().indent(GlobalWidth-std::strlen(O.ArgStr));
1194
1195   unsigned NumOpts = getNumOptions();
1196   for (unsigned i = 0; i != NumOpts; ++i) {
1197     if (Value.compare(getOptionValue(i)))
1198       continue;
1199
1200     outs() << "= " << getOption(i);
1201     size_t L = std::strlen(getOption(i));
1202     size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1203     outs().indent(NumSpaces) << " (default: ";
1204     for (unsigned j = 0; j != NumOpts; ++j) {
1205       if (Default.compare(getOptionValue(j)))
1206         continue;
1207       outs() << getOption(j);
1208       break;
1209     }
1210     outs() << ")\n";
1211     return;
1212   }
1213   outs() << "= *unknown option value*\n";
1214 }
1215
1216 // printOptionDiff - Specializations for printing basic value types.
1217 //
1218 #define PRINT_OPT_DIFF(T)                                               \
1219   void parser<T>::                                                      \
1220   printOptionDiff(const Option &O, T V, OptionValue<T> D,               \
1221                   size_t GlobalWidth) const {                           \
1222     printOptionName(O, GlobalWidth);                                    \
1223     std::string Str;                                                    \
1224     {                                                                   \
1225       raw_string_ostream SS(Str);                                       \
1226       SS << V;                                                          \
1227     }                                                                   \
1228     outs() << "= " << Str;                                              \
1229     size_t NumSpaces = MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0;\
1230     outs().indent(NumSpaces) << " (default: ";                          \
1231     if (D.hasValue())                                                   \
1232       outs() << D.getValue();                                           \
1233     else                                                                \
1234       outs() << "*no default*";                                         \
1235     outs() << ")\n";                                                    \
1236   }                                                                     \
1237
1238 PRINT_OPT_DIFF(bool)
1239 PRINT_OPT_DIFF(boolOrDefault)
1240 PRINT_OPT_DIFF(int)
1241 PRINT_OPT_DIFF(unsigned)
1242 PRINT_OPT_DIFF(unsigned long long)
1243 PRINT_OPT_DIFF(double)
1244 PRINT_OPT_DIFF(float)
1245 PRINT_OPT_DIFF(char)
1246
1247 void parser<std::string>::
1248 printOptionDiff(const Option &O, StringRef V, OptionValue<std::string> D,
1249                 size_t GlobalWidth) const {
1250   printOptionName(O, GlobalWidth);
1251   outs() << "= " << V;
1252   size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1253   outs().indent(NumSpaces) << " (default: ";
1254   if (D.hasValue())
1255     outs() << D.getValue();
1256   else
1257     outs() << "*no default*";
1258   outs() << ")\n";
1259 }
1260
1261 // Print a placeholder for options that don't yet support printOptionDiff().
1262 void basic_parser_impl::
1263 printOptionNoValue(const Option &O, size_t GlobalWidth) const {
1264   printOptionName(O, GlobalWidth);
1265   outs() << "= *cannot print option value*\n";
1266 }
1267
1268 //===----------------------------------------------------------------------===//
1269 // -help and -help-hidden option implementation
1270 //
1271
1272 static int OptNameCompare(const void *LHS, const void *RHS) {
1273   typedef std::pair<const char *, Option*> pair_ty;
1274
1275   return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1276 }
1277
1278 // Copy Options into a vector so we can sort them as we like.
1279 static void
1280 sortOpts(StringMap<Option*> &OptMap,
1281          SmallVectorImpl< std::pair<const char *, Option*> > &Opts,
1282          bool ShowHidden) {
1283   SmallPtrSet<Option*, 128> OptionSet;  // Duplicate option detection.
1284
1285   for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1286        I != E; ++I) {
1287     // Ignore really-hidden options.
1288     if (I->second->getOptionHiddenFlag() == ReallyHidden)
1289       continue;
1290
1291     // Unless showhidden is set, ignore hidden flags.
1292     if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1293       continue;
1294
1295     // If we've already seen this option, don't add it to the list again.
1296     if (!OptionSet.insert(I->second))
1297       continue;
1298
1299     Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1300                                                     I->second));
1301   }
1302
1303   // Sort the options list alphabetically.
1304   qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1305 }
1306
1307 namespace {
1308
1309 class HelpPrinter {
1310 protected:
1311   const bool ShowHidden;
1312   typedef SmallVector<std::pair<const char *, Option*>,128> StrOptionPairVector;
1313   // Print the options. Opts is assumed to be alphabetically sorted.
1314   virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1315     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1316       Opts[i].second->printOptionInfo(MaxArgLen);
1317   }
1318
1319 public:
1320   explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
1321   virtual ~HelpPrinter() {}
1322
1323   // Invoke the printer.
1324   void operator=(bool Value) {
1325     if (Value == false) return;
1326
1327     // Get all the options.
1328     SmallVector<Option*, 4> PositionalOpts;
1329     SmallVector<Option*, 4> SinkOpts;
1330     StringMap<Option*> OptMap;
1331     GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1332
1333     StrOptionPairVector Opts;
1334     sortOpts(OptMap, Opts, ShowHidden);
1335
1336     if (ProgramOverview)
1337       outs() << "OVERVIEW: " << ProgramOverview << "\n";
1338
1339     outs() << "USAGE: " << ProgramName << " [options]";
1340
1341     // Print out the positional options.
1342     Option *CAOpt = 0;   // The cl::ConsumeAfter option, if it exists...
1343     if (!PositionalOpts.empty() &&
1344         PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1345       CAOpt = PositionalOpts[0];
1346
1347     for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1348       if (PositionalOpts[i]->ArgStr[0])
1349         outs() << " --" << PositionalOpts[i]->ArgStr;
1350       outs() << " " << PositionalOpts[i]->HelpStr;
1351     }
1352
1353     // Print the consume after option info if it exists...
1354     if (CAOpt) outs() << " " << CAOpt->HelpStr;
1355
1356     outs() << "\n\n";
1357
1358     // Compute the maximum argument length...
1359     size_t MaxArgLen = 0;
1360     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1361       MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1362
1363     outs() << "OPTIONS:\n";
1364     printOptions(Opts, MaxArgLen);
1365
1366     // Print any extra help the user has declared.
1367     for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1368                                              E = MoreHelp->end();
1369          I != E; ++I)
1370       outs() << *I;
1371     MoreHelp->clear();
1372
1373     // Halt the program since help information was printed
1374     exit(1);
1375   }
1376 };
1377
1378 class CategorizedHelpPrinter : public HelpPrinter {
1379 public:
1380   explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1381
1382   // Helper function for printOptions().
1383   // It shall return true if A's name should be lexographically
1384   // ordered before B's name. It returns false otherwise.
1385   static bool OptionCategoryCompare(OptionCategory *A, OptionCategory *B) {
1386     int Length = strcmp(A->getName(), B->getName());
1387     assert(Length != 0 && "Duplicate option categories");
1388     return Length < 0;
1389   }
1390
1391   // Make sure we inherit our base class's operator=()
1392   using HelpPrinter::operator= ;
1393
1394 protected:
1395   virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1396     std::vector<OptionCategory *> SortedCategories;
1397     std::map<OptionCategory *, std::vector<Option *> > CategorizedOptions;
1398
1399     // Collect registered option categories into vector in preperation for
1400     // sorting.
1401     for (OptionCatSet::const_iterator I = RegisteredOptionCategories->begin(),
1402                                       E = RegisteredOptionCategories->end();
1403          I != E; ++I)
1404       SortedCategories.push_back(*I);
1405
1406     // Sort the different option categories alphabetically.
1407     assert(SortedCategories.size() > 0 && "No option categories registered!");
1408     std::sort(SortedCategories.begin(), SortedCategories.end(),
1409               OptionCategoryCompare);
1410
1411     // Create map to empty vectors.
1412     for (std::vector<OptionCategory *>::const_iterator
1413              I = SortedCategories.begin(),
1414              E = SortedCategories.end();
1415          I != E; ++I)
1416       CategorizedOptions[*I] = std::vector<Option *>();
1417
1418     // Walk through pre-sorted options and assign into categories.
1419     // Because the options are already alphabetically sorted the
1420     // options within categories will also be alphabetically sorted.
1421     for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1422       Option *Opt = Opts[I].second;
1423       assert(CategorizedOptions.count(Opt->Category) > 0 &&
1424              "Option has an unregistered category");
1425       CategorizedOptions[Opt->Category].push_back(Opt);
1426     }
1427
1428     // Now do printing.
1429     for (std::vector<OptionCategory *>::const_iterator
1430              Category = SortedCategories.begin(),
1431              E = SortedCategories.end();
1432          Category != E; ++Category) {
1433       // Hide empty categories for -help, but show for -help-hidden.
1434       bool IsEmptyCategory = CategorizedOptions[*Category].size() == 0;
1435       if (!ShowHidden && IsEmptyCategory)
1436         continue;
1437
1438       // Print category information.
1439       outs() << "\n";
1440       outs() << (*Category)->getName() << ":\n";
1441
1442       // Check if description is set.
1443       if ((*Category)->getDescription() != 0)
1444         outs() << (*Category)->getDescription() << "\n\n";
1445       else
1446         outs() << "\n";
1447
1448       // When using -help-hidden explicitly state if the category has no
1449       // options associated with it.
1450       if (IsEmptyCategory) {
1451         outs() << "  This option category has no options.\n";
1452         continue;
1453       }
1454       // Loop over the options in the category and print.
1455       for (std::vector<Option *>::const_iterator
1456                Opt = CategorizedOptions[*Category].begin(),
1457                E = CategorizedOptions[*Category].end();
1458            Opt != E; ++Opt)
1459         (*Opt)->printOptionInfo(MaxArgLen);
1460     }
1461   }
1462 };
1463
1464 // This wraps the Uncategorizing and Categorizing printers and decides
1465 // at run time which should be invoked.
1466 class HelpPrinterWrapper {
1467 private:
1468   HelpPrinter &UncategorizedPrinter;
1469   CategorizedHelpPrinter &CategorizedPrinter;
1470
1471 public:
1472   explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
1473                               CategorizedHelpPrinter &CategorizedPrinter) :
1474     UncategorizedPrinter(UncategorizedPrinter),
1475     CategorizedPrinter(CategorizedPrinter) { }
1476
1477   // Invoke the printer.
1478   void operator=(bool Value);
1479 };
1480
1481 } // End anonymous namespace
1482
1483 // Declare the four HelpPrinter instances that are used to print out help, or
1484 // help-hidden as an uncategorized list or in categories.
1485 static HelpPrinter UncategorizedNormalPrinter(false);
1486 static HelpPrinter UncategorizedHiddenPrinter(true);
1487 static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1488 static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1489
1490
1491 // Declare HelpPrinter wrappers that will decide whether or not to invoke
1492 // a categorizing help printer
1493 static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1494                                                CategorizedNormalPrinter);
1495 static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1496                                                CategorizedHiddenPrinter);
1497
1498 // Define uncategorized help printers.
1499 // -help-list is hidden by default because if Option categories are being used
1500 // then -help behaves the same as -help-list.
1501 static cl::opt<HelpPrinter, true, parser<bool> >
1502 HLOp("help-list",
1503      cl::desc("Display list of available options (-help-list-hidden for more)"),
1504      cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed);
1505
1506 static cl::opt<HelpPrinter, true, parser<bool> >
1507 HLHOp("help-list-hidden",
1508      cl::desc("Display list of all available options"),
1509      cl::location(UncategorizedHiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1510
1511 // Define uncategorized/categorized help printers. These printers change their
1512 // behaviour at runtime depending on whether one or more Option categories have
1513 // been declared.
1514 static cl::opt<HelpPrinterWrapper, true, parser<bool> >
1515 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1516     cl::location(WrappedNormalPrinter), cl::ValueDisallowed);
1517
1518 static cl::opt<HelpPrinterWrapper, true, parser<bool> >
1519 HHOp("help-hidden", cl::desc("Display all available options"),
1520      cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1521
1522
1523
1524 static cl::opt<bool>
1525 PrintOptions("print-options",
1526              cl::desc("Print non-default options after command line parsing"),
1527              cl::Hidden, cl::init(false));
1528
1529 static cl::opt<bool>
1530 PrintAllOptions("print-all-options",
1531                 cl::desc("Print all option values after command line parsing"),
1532                 cl::Hidden, cl::init(false));
1533
1534 void HelpPrinterWrapper::operator=(bool Value) {
1535   if (Value == false)
1536     return;
1537
1538   // Decide which printer to invoke. If more than one option category is
1539   // registered then it is useful to show the categorized help instead of
1540   // uncategorized help.
1541   if (RegisteredOptionCategories->size() > 1) {
1542     // unhide -help-list option so user can have uncategorized output if they
1543     // want it.
1544     HLOp.setHiddenFlag(NotHidden);
1545
1546     CategorizedPrinter = true; // Invoke categorized printer
1547   }
1548   else
1549     UncategorizedPrinter = true; // Invoke uncategorized printer
1550 }
1551
1552 // Print the value of each option.
1553 void cl::PrintOptionValues() {
1554   if (!PrintOptions && !PrintAllOptions) return;
1555
1556   // Get all the options.
1557   SmallVector<Option*, 4> PositionalOpts;
1558   SmallVector<Option*, 4> SinkOpts;
1559   StringMap<Option*> OptMap;
1560   GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1561
1562   SmallVector<std::pair<const char *, Option*>, 128> Opts;
1563   sortOpts(OptMap, Opts, /*ShowHidden*/true);
1564
1565   // Compute the maximum argument length...
1566   size_t MaxArgLen = 0;
1567   for (size_t i = 0, e = Opts.size(); i != e; ++i)
1568     MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1569
1570   for (size_t i = 0, e = Opts.size(); i != e; ++i)
1571     Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
1572 }
1573
1574 static void (*OverrideVersionPrinter)() = 0;
1575
1576 static std::vector<void (*)()>* ExtraVersionPrinters = 0;
1577
1578 namespace {
1579 class VersionPrinter {
1580 public:
1581   void print() {
1582     raw_ostream &OS = outs();
1583     OS << "LLVM (http://llvm.org/):\n"
1584        << "  " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1585 #ifdef LLVM_VERSION_INFO
1586     OS << LLVM_VERSION_INFO;
1587 #endif
1588     OS << "\n  ";
1589 #ifndef __OPTIMIZE__
1590     OS << "DEBUG build";
1591 #else
1592     OS << "Optimized build";
1593 #endif
1594 #ifndef NDEBUG
1595     OS << " with assertions";
1596 #endif
1597     std::string CPU = sys::getHostCPUName();
1598     if (CPU == "generic") CPU = "(unknown)";
1599     OS << ".\n"
1600 #if (ENABLE_TIMESTAMPS == 1)
1601        << "  Built " << __DATE__ << " (" << __TIME__ << ").\n"
1602 #endif
1603        << "  Default target: " << sys::getDefaultTargetTriple() << '\n'
1604        << "  Host CPU: " << CPU << '\n';
1605   }
1606   void operator=(bool OptionWasSpecified) {
1607     if (!OptionWasSpecified) return;
1608
1609     if (OverrideVersionPrinter != 0) {
1610       (*OverrideVersionPrinter)();
1611       exit(1);
1612     }
1613     print();
1614
1615     // Iterate over any registered extra printers and call them to add further
1616     // information.
1617     if (ExtraVersionPrinters != 0) {
1618       outs() << '\n';
1619       for (std::vector<void (*)()>::iterator I = ExtraVersionPrinters->begin(),
1620                                              E = ExtraVersionPrinters->end();
1621            I != E; ++I)
1622         (*I)();
1623     }
1624
1625     exit(1);
1626   }
1627 };
1628 } // End anonymous namespace
1629
1630
1631 // Define the --version option that prints out the LLVM version for the tool
1632 static VersionPrinter VersionPrinterInstance;
1633
1634 static cl::opt<VersionPrinter, true, parser<bool> >
1635 VersOp("version", cl::desc("Display the version of this program"),
1636     cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1637
1638 // Utility function for printing the help message.
1639 void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
1640   // This looks weird, but it actually prints the help message. The Printers are
1641   // types of HelpPrinter and the help gets printed when its operator= is
1642   // invoked. That's because the "normal" usages of the help printer is to be
1643   // assigned true/false depending on whether -help or -help-hidden was given or
1644   // not.  Since we're circumventing that we have to make it look like -help or
1645   // -help-hidden were given, so we assign true.
1646
1647   if (!Hidden && !Categorized)
1648     UncategorizedNormalPrinter = true;
1649   else if (!Hidden && Categorized)
1650     CategorizedNormalPrinter = true;
1651   else if (Hidden && !Categorized)
1652     UncategorizedHiddenPrinter = true;
1653   else
1654     CategorizedHiddenPrinter = true;
1655 }
1656
1657 /// Utility function for printing version number.
1658 void cl::PrintVersionMessage() {
1659   VersionPrinterInstance.print();
1660 }
1661
1662 void cl::SetVersionPrinter(void (*func)()) {
1663   OverrideVersionPrinter = func;
1664 }
1665
1666 void cl::AddExtraVersionPrinter(void (*func)()) {
1667   if (ExtraVersionPrinters == 0)
1668     ExtraVersionPrinters = new std::vector<void (*)()>;
1669
1670   ExtraVersionPrinters->push_back(func);
1671 }
1672
1673 void cl::getRegisteredOptions(StringMap<Option*> &Map)
1674 {
1675   // Get all the options.
1676   SmallVector<Option*, 4> PositionalOpts; //NOT USED
1677   SmallVector<Option*, 4> SinkOpts;  //NOT USED
1678   assert(Map.size() == 0 && "StringMap must be empty");
1679   GetOptionInfo(PositionalOpts, SinkOpts, Map);
1680   return;
1681 }