lib/Support/CommandLine.cpp

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