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