lib/Support/CommandLine.cpp

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