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