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