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