1 //===-- CommandLine.cpp - Command line parser implementation --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
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
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Config/config.h"
20 #include "llvm/Support/CommandLine.h"
32 // Globals for name and overview of program
33 static const char *ProgramName = "<unknown>";
34 static const char *ProgramOverview = 0;
36 // This collects additional help to be printed.
37 static std::vector<const char*> &MoreHelp() {
38 static std::vector<const char*> moreHelp;
42 extrahelp::extrahelp(const char* Help)
44 MoreHelp().push_back(Help);
47 //===----------------------------------------------------------------------===//
48 // Basic, shared command line option processing machinery...
51 // Return the global command line option vector. Making it a function scoped
52 // static ensures that it will be initialized correctly before its first use.
54 static std::map<std::string, Option*> &getOpts() {
55 static std::map<std::string, Option*> CommandLineOptions;
56 return CommandLineOptions;
59 static Option *getOption(const std::string &Str) {
60 std::map<std::string,Option*>::iterator I = getOpts().find(Str);
61 return I != getOpts().end() ? I->second : 0;
64 static std::vector<Option*> &getPositionalOpts() {
65 static std::vector<Option*> Positional;
69 static void AddArgument(const char *ArgName, Option *Opt) {
70 if (getOption(ArgName)) {
71 std::cerr << ProgramName << ": CommandLine Error: Argument '"
72 << ArgName << "' defined more than once!\n";
74 // Add argument to the argument map!
75 getOpts()[ArgName] = Opt;
79 // RemoveArgument - It's possible that the argument is no longer in the map if
80 // options have already been processed and the map has been deleted!
82 static void RemoveArgument(const char *ArgName, Option *Opt) {
83 if(getOpts().empty()) return;
86 // This disgusting HACK is brought to you courtesy of GCC 3.3.2, which ICE's
87 // If we pass ArgName directly into getOption here.
88 std::string Tmp = ArgName;
89 assert(getOption(Tmp) == Opt && "Arg not in map!");
91 getOpts().erase(ArgName);
94 static inline bool ProvideOption(Option *Handler, const char *ArgName,
95 const char *Value, int argc, char **argv,
97 // Enforce value requirements
98 switch (Handler->getValueExpectedFlag()) {
100 if (Value == 0) { // No value specified?
101 if (i+1 < argc) { // Steal the next argument, like for '-o filename'
104 return Handler->error(" requires a value!");
108 case ValueDisallowed:
110 return Handler->error(" does not allow a value! '" +
111 std::string(Value) + "' specified.");
116 std::cerr << ProgramName
117 << ": Bad ValueMask flag! CommandLine usage error:"
118 << Handler->getValueExpectedFlag() << "\n";
123 // Run the handler now!
124 return Handler->addOccurrence(i, ArgName, Value ? Value : "");
127 static bool ProvidePositionalOption(Option *Handler, const std::string &Arg,
130 return ProvideOption(Handler, Handler->ArgStr, Arg.c_str(), 0, 0, Dummy);
134 // Option predicates...
135 static inline bool isGrouping(const Option *O) {
136 return O->getFormattingFlag() == cl::Grouping;
138 static inline bool isPrefixedOrGrouping(const Option *O) {
139 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
142 // getOptionPred - Check to see if there are any options that satisfy the
143 // specified predicate with names that are the prefixes in Name. This is
144 // checked by progressively stripping characters off of the name, checking to
145 // see if there options that satisfy the predicate. If we find one, return it,
146 // otherwise return null.
148 static Option *getOptionPred(std::string Name, unsigned &Length,
149 bool (*Pred)(const Option*)) {
151 Option *Op = getOption(Name);
152 if (Op && Pred(Op)) {
153 Length = Name.length();
157 if (Name.size() == 1) return 0;
159 Name.erase(Name.end()-1, Name.end()); // Chop off the last character...
160 Op = getOption(Name);
162 // Loop while we haven't found an option and Name still has at least two
163 // characters in it (so that the next iteration will not be the empty
165 } while ((Op == 0 || !Pred(Op)) && Name.size() > 1);
167 if (Op && Pred(Op)) {
168 Length = Name.length();
169 return Op; // Found one!
171 return 0; // No option found!
174 static bool RequiresValue(const Option *O) {
175 return O->getNumOccurrencesFlag() == cl::Required ||
176 O->getNumOccurrencesFlag() == cl::OneOrMore;
179 static bool EatsUnboundedNumberOfValues(const Option *O) {
180 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
181 O->getNumOccurrencesFlag() == cl::OneOrMore;
184 /// ParseCStringVector - Break INPUT up wherever one or more
185 /// whitespace characters are found, and store the resulting tokens in
186 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
187 /// using strdup (), so it is the caller's responsibility to free ()
190 static void ParseCStringVector (std::vector<char *> &output,
192 // Characters which will be treated as token separators:
193 static const char *delims = " \v\f\t\r\n";
195 std::string work (input);
196 // Skip past any delims at head of input string.
197 size_t pos = work.find_first_not_of (delims);
198 // If the string consists entirely of delims, then exit early.
199 if (pos == std::string::npos) return;
200 // Otherwise, jump forward to beginning of first word.
201 work = work.substr (pos);
202 // Find position of first delimiter.
203 pos = work.find_first_of (delims);
205 while (!work.empty() && pos != std::string::npos) {
206 // Everything from 0 to POS is the next word to copy.
207 output.push_back (strdup (work.substr (0,pos).c_str ()));
208 // Is there another word in the string?
209 size_t nextpos = work.find_first_not_of (delims, pos + 1);
210 if (nextpos != std::string::npos) {
211 // Yes? Then remove delims from beginning ...
212 work = work.substr (work.find_first_not_of (delims, pos + 1));
213 // and find the end of the word.
214 pos = work.find_first_of (delims);
216 // No? (Remainder of string is delims.) End the loop.
218 pos = std::string::npos;
222 // If `input' ended with non-delim char, then we'll get here with
223 // the last word of `input' in `work'; copy it now.
224 if (!work.empty ()) {
225 output.push_back (strdup (work.c_str ()));
229 /// ParseEnvironmentOptions - An alternative entry point to the
230 /// CommandLine library, which allows you to read the program's name
231 /// from the caller (as PROGNAME) and its command-line arguments from
232 /// an environment variable (whose name is given in ENVVAR).
234 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
235 const char *Overview) {
237 assert(progName && "Program name not specified");
238 assert(envVar && "Environment variable name missing");
240 // Get the environment variable they want us to parse options out of.
241 const char *envValue = getenv (envVar);
245 // Get program's "name", which we wouldn't know without the caller
247 std::vector<char *> newArgv;
248 newArgv.push_back (strdup (progName));
250 // Parse the value of the environment variable into a "command line"
251 // and hand it off to ParseCommandLineOptions().
252 ParseCStringVector (newArgv, envValue);
253 int newArgc = newArgv.size ();
254 ParseCommandLineOptions (newArgc, &newArgv[0], Overview);
256 // Free all the strdup()ed strings.
257 for (std::vector<char *>::iterator i = newArgv.begin (), e = newArgv.end ();
263 /// LookupOption - Lookup the option specified by the specified option on the
264 /// command line. If there is a value specified (after an equal sign) return
266 static Option *LookupOption(const char *&Arg, const char *&Value) {
267 while (*Arg == '-') ++Arg; // Eat leading dashes
269 const char *ArgEnd = Arg;
270 while (*ArgEnd && *ArgEnd != '=')
271 ++ArgEnd; // Scan till end of argument name.
273 if (*ArgEnd == '=') // If we have an equals sign...
274 Value = ArgEnd+1; // Get the value, not the equals
277 if (*Arg == 0) return 0;
279 // Look up the option.
280 std::map<std::string, Option*> &Opts = getOpts();
281 std::map<std::string, Option*>::iterator I =
282 Opts.find(std::string(Arg, ArgEnd));
283 return (I != Opts.end()) ? I->second : 0;
286 void cl::ParseCommandLineOptions(int &argc, char **argv,
287 const char *Overview) {
288 assert((!getOpts().empty() || !getPositionalOpts().empty()) &&
289 "No options specified, or ParseCommandLineOptions called more"
291 ProgramName = argv[0]; // Save this away safe and snug
292 ProgramOverview = Overview;
293 bool ErrorParsing = false;
295 std::map<std::string, Option*> &Opts = getOpts();
296 std::vector<Option*> &PositionalOpts = getPositionalOpts();
298 // Check out the positional arguments to collect information about them.
299 unsigned NumPositionalRequired = 0;
300 Option *ConsumeAfterOpt = 0;
301 if (!PositionalOpts.empty()) {
302 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
303 assert(PositionalOpts.size() > 1 &&
304 "Cannot specify cl::ConsumeAfter without a positional argument!");
305 ConsumeAfterOpt = PositionalOpts[0];
308 // Calculate how many positional values are _required_.
309 bool UnboundedFound = false;
310 for (unsigned i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
312 Option *Opt = PositionalOpts[i];
313 if (RequiresValue(Opt))
314 ++NumPositionalRequired;
315 else if (ConsumeAfterOpt) {
316 // ConsumeAfter cannot be combined with "optional" positional options
317 // unless there is only one positional argument...
318 if (PositionalOpts.size() > 2)
320 Opt->error(" error - this positional option will never be matched, "
321 "because it does not Require a value, and a "
322 "cl::ConsumeAfter option is active!");
323 } else if (UnboundedFound && !Opt->ArgStr[0]) {
324 // This option does not "require" a value... Make sure this option is
325 // not specified after an option that eats all extra arguments, or this
326 // one will never get any!
328 ErrorParsing |= Opt->error(" error - option can never match, because "
329 "another positional argument will match an "
330 "unbounded number of values, and this option"
331 " does not require a value!");
333 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
337 // PositionalVals - A vector of "positional" arguments we accumulate into
338 // the process at the end...
340 std::vector<std::pair<std::string,unsigned> > PositionalVals;
342 // If the program has named positional arguments, and the name has been run
343 // across, keep track of which positional argument was named. Otherwise put
344 // the positional args into the PositionalVals list...
345 Option *ActivePositionalArg = 0;
347 // Loop over all of the arguments... processing them.
348 bool DashDashFound = false; // Have we read '--'?
349 for (int i = 1; i < argc; ++i) {
351 const char *Value = 0;
352 const char *ArgName = "";
354 // Check to see if this is a positional argument. This argument is
355 // considered to be positional if it doesn't start with '-', if it is "-"
356 // itself, or if we have seen "--" already.
358 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
359 // Positional argument!
360 if (ActivePositionalArg) {
361 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
362 continue; // We are done!
363 } else if (!PositionalOpts.empty()) {
364 PositionalVals.push_back(std::make_pair(argv[i],i));
366 // All of the positional arguments have been fulfulled, give the rest to
367 // the consume after option... if it's specified...
369 if (PositionalVals.size() >= NumPositionalRequired &&
370 ConsumeAfterOpt != 0) {
371 for (++i; i < argc; ++i)
372 PositionalVals.push_back(std::make_pair(argv[i],i));
373 break; // Handle outside of the argument processing loop...
376 // Delay processing positional arguments until the end...
379 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
381 DashDashFound = true; // This is the mythical "--"?
382 continue; // Don't try to process it as an argument itself.
383 } else if (ActivePositionalArg &&
384 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
385 // If there is a positional argument eating options, check to see if this
386 // option is another positional argument. If so, treat it as an argument,
387 // otherwise feed it to the eating positional.
389 Handler = LookupOption(ArgName, Value);
390 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
391 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
392 continue; // We are done!
395 } else { // We start with a '-', must be an argument...
397 Handler = LookupOption(ArgName, Value);
399 // Check to see if this "option" is really a prefixed or grouped argument.
401 std::string RealName(ArgName);
402 if (RealName.size() > 1) {
404 Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping);
406 // If the option is a prefixed option, then the value is simply the
407 // rest of the name... so fall through to later processing, by
408 // setting up the argument name flags and value fields.
410 if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
411 Value = ArgName+Length;
412 assert(Opts.find(std::string(ArgName, Value)) != Opts.end() &&
413 Opts.find(std::string(ArgName, Value))->second == PGOpt);
416 // This must be a grouped option... handle them now.
417 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
420 // Move current arg name out of RealName into RealArgName...
421 std::string RealArgName(RealName.begin(),
422 RealName.begin() + Length);
423 RealName.erase(RealName.begin(), RealName.begin() + Length);
425 // Because ValueRequired is an invalid flag for grouped arguments,
426 // we don't need to pass argc/argv in...
428 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
429 "Option can not be cl::Grouping AND cl::ValueRequired!");
431 ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(),
434 // Get the next grouping option...
435 PGOpt = getOptionPred(RealName, Length, isGrouping);
436 } while (PGOpt && Length != RealName.size());
438 Handler = PGOpt; // Ate all of the options.
445 std::cerr << ProgramName << ": Unknown command line argument '" << argv[i]
446 << "'. Try: '" << argv[0] << " --help'\n";
451 // Check to see if this option accepts a comma separated list of values. If
452 // it does, we have to split up the value into multiple values...
453 if (Value && Handler->getMiscFlags() & CommaSeparated) {
454 std::string Val(Value);
455 std::string::size_type Pos = Val.find(',');
457 while (Pos != std::string::npos) {
458 // Process the portion before the comma...
459 ErrorParsing |= ProvideOption(Handler, ArgName,
460 std::string(Val.begin(),
461 Val.begin()+Pos).c_str(),
463 // Erase the portion before the comma, AND the comma...
464 Val.erase(Val.begin(), Val.begin()+Pos+1);
465 Value += Pos+1; // Increment the original value pointer as well...
467 // Check for another comma...
472 // If this is a named positional argument, just remember that it is the
474 if (Handler->getFormattingFlag() == cl::Positional)
475 ActivePositionalArg = Handler;
477 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
480 // Check and handle positional arguments now...
481 if (NumPositionalRequired > PositionalVals.size()) {
482 std::cerr << ProgramName
483 << ": Not enough positional command line arguments specified!\n"
484 << "Must specify at least " << NumPositionalRequired
485 << " positional arguments: See: " << argv[0] << " --help\n";
489 } else if (ConsumeAfterOpt == 0) {
490 // Positional args have already been handled if ConsumeAfter is specified...
491 unsigned ValNo = 0, NumVals = PositionalVals.size();
492 for (unsigned i = 0, e = PositionalOpts.size(); i != e; ++i) {
493 if (RequiresValue(PositionalOpts[i])) {
494 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
495 PositionalVals[ValNo].second);
497 --NumPositionalRequired; // We fulfilled our duty...
500 // If we _can_ give this option more arguments, do so now, as long as we
501 // do not give it values that others need. 'Done' controls whether the
502 // option even _WANTS_ any more.
504 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
505 while (NumVals-ValNo > NumPositionalRequired && !Done) {
506 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
508 Done = true; // Optional arguments want _at most_ one value
510 case cl::ZeroOrMore: // Zero or more will take all they can get...
511 case cl::OneOrMore: // One or more will take all they can get...
512 ProvidePositionalOption(PositionalOpts[i],
513 PositionalVals[ValNo].first,
514 PositionalVals[ValNo].second);
518 assert(0 && "Internal error, unexpected NumOccurrences flag in "
519 "positional argument processing!");
524 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
526 for (unsigned j = 1, e = PositionalOpts.size(); j != e; ++j)
527 if (RequiresValue(PositionalOpts[j])) {
528 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
529 PositionalVals[ValNo].first,
530 PositionalVals[ValNo].second);
534 // Handle the case where there is just one positional option, and it's
535 // optional. In this case, we want to give JUST THE FIRST option to the
536 // positional option and keep the rest for the consume after. The above
537 // loop would have assigned no values to positional options in this case.
539 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
540 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
541 PositionalVals[ValNo].first,
542 PositionalVals[ValNo].second);
546 // Handle over all of the rest of the arguments to the
547 // cl::ConsumeAfter command line option...
548 for (; ValNo != PositionalVals.size(); ++ValNo)
549 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
550 PositionalVals[ValNo].first,
551 PositionalVals[ValNo].second);
554 // Loop over args and make sure all required args are specified!
555 for (std::map<std::string, Option*>::iterator I = Opts.begin(),
556 E = Opts.end(); I != E; ++I) {
557 switch (I->second->getNumOccurrencesFlag()) {
560 if (I->second->getNumOccurrences() == 0) {
561 I->second->error(" must be specified at least once!");
570 // Free all of the memory allocated to the map. Command line options may only
571 // be processed once!
573 PositionalOpts.clear();
576 // If we had an error processing our arguments, don't let the program execute
577 if (ErrorParsing) exit(1);
580 //===----------------------------------------------------------------------===//
581 // Option Base class implementation
584 bool Option::error(std::string Message, const char *ArgName) {
585 if (ArgName == 0) ArgName = ArgStr;
587 std::cerr << HelpStr; // Be nice for positional arguments
589 std::cerr << ProgramName << ": for the -" << ArgName;
590 std::cerr << " option: " << Message << "\n";
594 bool Option::addOccurrence(unsigned pos, const char *ArgName,
595 const std::string &Value) {
596 NumOccurrences++; // Increment the number of times we have been seen
598 switch (getNumOccurrencesFlag()) {
600 if (NumOccurrences > 1)
601 return error(": may only occur zero or one times!", ArgName);
604 if (NumOccurrences > 1)
605 return error(": must occur exactly one time!", ArgName);
609 case ConsumeAfter: break;
610 default: return error(": bad num occurrences flag value!");
613 return handleOccurrence(pos, ArgName, Value);
616 // addArgument - Tell the system that this Option subclass will handle all
617 // occurrences of -ArgStr on the command line.
619 void Option::addArgument(const char *ArgStr) {
621 AddArgument(ArgStr, this);
623 if (getFormattingFlag() == Positional)
624 getPositionalOpts().push_back(this);
625 else if (getNumOccurrencesFlag() == ConsumeAfter) {
626 if (!getPositionalOpts().empty() &&
627 getPositionalOpts().front()->getNumOccurrencesFlag() == ConsumeAfter)
628 error("Cannot specify more than one option with cl::ConsumeAfter!");
629 getPositionalOpts().insert(getPositionalOpts().begin(), this);
633 void Option::removeArgument(const char *ArgStr) {
635 RemoveArgument(ArgStr, this);
637 if (getFormattingFlag() == Positional) {
638 std::vector<Option*>::iterator I =
639 std::find(getPositionalOpts().begin(), getPositionalOpts().end(), this);
640 assert(I != getPositionalOpts().end() && "Arg not registered!");
641 getPositionalOpts().erase(I);
642 } else if (getNumOccurrencesFlag() == ConsumeAfter) {
643 assert(!getPositionalOpts().empty() && getPositionalOpts()[0] == this &&
644 "Arg not registered correctly!");
645 getPositionalOpts().erase(getPositionalOpts().begin());
650 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
651 // has been specified yet.
653 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
654 if (O.ValueStr[0] == 0) return DefaultMsg;
658 //===----------------------------------------------------------------------===//
659 // cl::alias class implementation
662 // Return the width of the option tag for printing...
663 unsigned alias::getOptionWidth() const {
664 return std::strlen(ArgStr)+6;
667 // Print out the option for the alias...
668 void alias::printOptionInfo(unsigned GlobalWidth) const {
669 unsigned L = std::strlen(ArgStr);
670 std::cerr << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
676 //===----------------------------------------------------------------------===//
677 // Parser Implementation code...
680 // basic_parser implementation
683 // Return the width of the option tag for printing...
684 unsigned basic_parser_impl::getOptionWidth(const Option &O) const {
685 unsigned Len = std::strlen(O.ArgStr);
686 if (const char *ValName = getValueName())
687 Len += std::strlen(getValueStr(O, ValName))+3;
692 // printOptionInfo - Print out information about this option. The
693 // to-be-maintained width is specified.
695 void basic_parser_impl::printOptionInfo(const Option &O,
696 unsigned GlobalWidth) const {
697 std::cerr << " -" << O.ArgStr;
699 if (const char *ValName = getValueName())
700 std::cerr << "=<" << getValueStr(O, ValName) << ">";
702 std::cerr << std::string(GlobalWidth-getOptionWidth(O), ' ') << " - "
703 << O.HelpStr << "\n";
709 // parser<bool> implementation
711 bool parser<bool>::parse(Option &O, const char *ArgName,
712 const std::string &Arg, bool &Value) {
713 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
716 } else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
719 return O.error(": '" + Arg +
720 "' is invalid value for boolean argument! Try 0 or 1");
725 // parser<int> implementation
727 bool parser<int>::parse(Option &O, const char *ArgName,
728 const std::string &Arg, int &Value) {
730 Value = (int)strtol(Arg.c_str(), &End, 0);
732 return O.error(": '" + Arg + "' value invalid for integer argument!");
736 // parser<unsigned> implementation
738 bool parser<unsigned>::parse(Option &O, const char *ArgName,
739 const std::string &Arg, unsigned &Value) {
742 unsigned long V = strtoul(Arg.c_str(), &End, 0);
744 if (((V == ULONG_MAX) && (errno == ERANGE))
747 return O.error(": '" + Arg + "' value invalid for uint argument!");
751 // parser<double>/parser<float> implementation
753 static bool parseDouble(Option &O, const std::string &Arg, double &Value) {
754 const char *ArgStart = Arg.c_str();
756 Value = strtod(ArgStart, &End);
758 return O.error(": '" +Arg+ "' value invalid for floating point argument!");
762 bool parser<double>::parse(Option &O, const char *AN,
763 const std::string &Arg, double &Val) {
764 return parseDouble(O, Arg, Val);
767 bool parser<float>::parse(Option &O, const char *AN,
768 const std::string &Arg, float &Val) {
770 if (parseDouble(O, Arg, dVal))
778 // generic_parser_base implementation
781 // findOption - Return the option number corresponding to the specified
782 // argument string. If the option is not found, getNumOptions() is returned.
784 unsigned generic_parser_base::findOption(const char *Name) {
785 unsigned i = 0, e = getNumOptions();
789 if (getOption(i) == N)
797 // Return the width of the option tag for printing...
798 unsigned generic_parser_base::getOptionWidth(const Option &O) const {
800 unsigned Size = std::strlen(O.ArgStr)+6;
801 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
802 Size = std::max(Size, (unsigned)std::strlen(getOption(i))+8);
805 unsigned BaseSize = 0;
806 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
807 BaseSize = std::max(BaseSize, (unsigned)std::strlen(getOption(i))+8);
812 // printOptionInfo - Print out information about this option. The
813 // to-be-maintained width is specified.
815 void generic_parser_base::printOptionInfo(const Option &O,
816 unsigned GlobalWidth) const {
818 unsigned L = std::strlen(O.ArgStr);
819 std::cerr << " -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
820 << " - " << O.HelpStr << "\n";
822 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
823 unsigned NumSpaces = GlobalWidth-strlen(getOption(i))-8;
824 std::cerr << " =" << getOption(i) << std::string(NumSpaces, ' ')
825 << " - " << getDescription(i) << "\n";
829 std::cerr << " " << O.HelpStr << "\n";
830 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
831 unsigned L = std::strlen(getOption(i));
832 std::cerr << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
833 << " - " << getDescription(i) << "\n";
839 //===----------------------------------------------------------------------===//
840 // --help and --help-hidden option implementation
847 const Option *EmptyArg;
848 const bool ShowHidden;
850 // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
851 inline static bool isHidden(std::pair<std::string, Option *> &OptPair) {
852 return OptPair.second->getOptionHiddenFlag() >= Hidden;
854 inline static bool isReallyHidden(std::pair<std::string, Option *> &OptPair) {
855 return OptPair.second->getOptionHiddenFlag() == ReallyHidden;
859 HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
863 void operator=(bool Value) {
864 if (Value == false) return;
866 // Copy Options into a vector so we can sort them as we like...
867 std::vector<std::pair<std::string, Option*> > Options;
868 copy(getOpts().begin(), getOpts().end(), std::back_inserter(Options));
870 // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
871 Options.erase(std::remove_if(Options.begin(), Options.end(),
872 std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
875 // Eliminate duplicate entries in table (from enum flags options, f.e.)
876 { // Give OptionSet a scope
877 std::set<Option*> OptionSet;
878 for (unsigned i = 0; i != Options.size(); ++i)
879 if (OptionSet.count(Options[i].second) == 0)
880 OptionSet.insert(Options[i].second); // Add new entry to set
882 Options.erase(Options.begin()+i--); // Erase duplicate
886 std::cerr << "OVERVIEW:" << ProgramOverview << "\n";
888 std::cerr << "USAGE: " << ProgramName << " [options]";
890 // Print out the positional options...
891 std::vector<Option*> &PosOpts = getPositionalOpts();
892 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
893 if (!PosOpts.empty() && PosOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
896 for (unsigned i = CAOpt != 0, e = PosOpts.size(); i != e; ++i) {
897 if (PosOpts[i]->ArgStr[0])
898 std::cerr << " --" << PosOpts[i]->ArgStr;
899 std::cerr << " " << PosOpts[i]->HelpStr;
902 // Print the consume after option info if it exists...
903 if (CAOpt) std::cerr << " " << CAOpt->HelpStr;
907 // Compute the maximum argument length...
909 for (unsigned i = 0, e = Options.size(); i != e; ++i)
910 MaxArgLen = std::max(MaxArgLen, Options[i].second->getOptionWidth());
912 std::cerr << "OPTIONS:\n";
913 for (unsigned i = 0, e = Options.size(); i != e; ++i)
914 Options[i].second->printOptionInfo(MaxArgLen);
916 // Print any extra help the user has declared.
917 for (std::vector<const char *>::iterator I = MoreHelp().begin(),
918 E = MoreHelp().end(); I != E; ++I)
922 // Halt the program since help information was printed
923 getOpts().clear(); // Don't bother making option dtors remove from map.
928 class VersionPrinter {
930 void operator=(bool OptionWasSpecified) {
931 if (OptionWasSpecified) {
932 std::cerr << "Low Level Virtual Machine (" << PACKAGE_NAME << ") "
933 << PACKAGE_VERSION << " (see http://llvm.cs.uiuc.edu/)\n";
934 getOpts().clear(); // Don't bother making option dtors remove from map.
941 // Define the two HelpPrinter instances that are used to print out help, or
944 HelpPrinter NormalPrinter(false);
945 HelpPrinter HiddenPrinter(true);
947 cl::opt<HelpPrinter, true, parser<bool> >
948 HOp("help", cl::desc("display available options (--help-hidden for more)"),
949 cl::location(NormalPrinter), cl::ValueDisallowed);
951 cl::opt<HelpPrinter, true, parser<bool> >
952 HHOp("help-hidden", cl::desc("display all available options"),
953 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
955 // Define the --version option that prints out the LLVM version for the tool
956 VersionPrinter VersionPrinterInstance;
957 cl::opt<VersionPrinter, true, parser<bool> >
958 VersOp("version", cl::desc("display the version"),
959 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
962 } // End anonymous namespace
964 // Utility function for printing the help message.
965 void cl::PrintHelpMessage() {
966 // This looks weird, but it actually prints the help message. The
967 // NormalPrinter variable is a HelpPrinter and the help gets printed when
968 // its operator= is invoked. That's because the "normal" usages of the
969 // help printer is to be assigned true/false depending on whether the
970 // --help option was given or not. Since we're circumventing that we have
971 // to make it look like --help was given, so we assign true.
972 NormalPrinter = true;