lib/Support/CommandLine.cpp

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