//===-- CommandLine.cpp - Command line parser implementation --------------===//
//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
// This class implements a command line argument processor that is useful when
// creating a tool. It provides a simple, minimalistic interface that is easily
// extensible and supports nonlocal (library) command line options.
//
//===----------------------------------------------------------------------===//
-#include "Support/CommandLine.h"
+#include "llvm/Config/config.h"
+#include "llvm/Support/CommandLine.h"
#include <algorithm>
+#include <functional>
#include <map>
#include <set>
#include <iostream>
+#include <cstdlib>
+#include <cerrno>
+#include <cstring>
+using namespace llvm;
using namespace cl;
-using std::map;
-using std::pair;
-using std::vector;
-using std::string;
-using std::cerr;
+
+// Globals for name and overview of program
+static const char *ProgramName = "<unknown>";
+static const char *ProgramOverview = 0;
+
+// This collects additional help to be printed.
+static std::vector<const char*> &MoreHelp() {
+ static std::vector<const char*> moreHelp;
+ return moreHelp;
+}
+
+extrahelp::extrahelp(const char* Help)
+ : morehelp(Help) {
+ MoreHelp().push_back(Help);
+}
//===----------------------------------------------------------------------===//
// Basic, shared command line option processing machinery...
// Return the global command line option vector. Making it a function scoped
// static ensures that it will be initialized correctly before its first use.
//
-static map<string,Option*> *CommandLineOptions = 0;
-static map<string, Option*> &getOpts() {
- if (CommandLineOptions == 0) CommandLineOptions = new map<string,Option*>();
- return *CommandLineOptions;
+static std::map<std::string, Option*> &getOpts() {
+ static std::map<std::string, Option*> CommandLineOptions;
+ return CommandLineOptions;
}
-static Option *getOption(const string &Str) {
- if (CommandLineOptions == 0) return 0;
- map<string,Option*>::iterator I = CommandLineOptions->find(Str);
- return I != CommandLineOptions->end() ? I->second : 0;
+static Option *getOption(const std::string &Str) {
+ std::map<std::string,Option*>::iterator I = getOpts().find(Str);
+ return I != getOpts().end() ? I->second : 0;
}
-static vector<Option*> &getPositionalOpts() {
- static vector<Option*> Positional;
+static std::vector<Option*> &getPositionalOpts() {
+ static std::vector<Option*> Positional;
return Positional;
}
static void AddArgument(const char *ArgName, Option *Opt) {
if (getOption(ArgName)) {
- cerr << "CommandLine Error: Argument '" << ArgName
- << "' defined more than once!\n";
+ std::cerr << ProgramName << ": CommandLine Error: Argument '"
+ << ArgName << "' defined more than once!\n";
} else {
// Add argument to the argument map!
getOpts()[ArgName] = Opt;
// RemoveArgument - It's possible that the argument is no longer in the map if
// options have already been processed and the map has been deleted!
-//
+//
static void RemoveArgument(const char *ArgName, Option *Opt) {
- if (CommandLineOptions == 0) return;
- assert(getOption(ArgName) == Opt && "Arg not in map!");
- CommandLineOptions->erase(ArgName);
- if (CommandLineOptions->empty()) {
- delete CommandLineOptions;
- CommandLineOptions = 0;
- }
-}
+ if(getOpts().empty()) return;
-static const char *ProgramName = 0;
-static const char *ProgramOverview = 0;
+#ifndef NDEBUG
+ // This disgusting HACK is brought to you courtesy of GCC 3.3.2, which ICE's
+ // If we pass ArgName directly into getOption here.
+ std::string Tmp = ArgName;
+ assert(getOption(Tmp) == Opt && "Arg not in map!");
+#endif
+ getOpts().erase(ArgName);
+}
static inline bool ProvideOption(Option *Handler, const char *ArgName,
const char *Value, int argc, char **argv,
// Enforce value requirements
switch (Handler->getValueExpectedFlag()) {
case ValueRequired:
- if (Value == 0 || *Value == 0) { // No value specified?
+ if (Value == 0) { // No value specified?
if (i+1 < argc) { // Steal the next argument, like for '-o filename'
Value = argv[++i];
} else {
}
break;
case ValueDisallowed:
- if (*Value != 0)
- return Handler->error(" does not allow a value! '" +
- string(Value) + "' specified.");
+ if (Value)
+ return Handler->error(" does not allow a value! '" +
+ std::string(Value) + "' specified.");
+ break;
+ case ValueOptional:
+ break;
+ default:
+ std::cerr << ProgramName
+ << ": Bad ValueMask flag! CommandLine usage error:"
+ << Handler->getValueExpectedFlag() << "\n";
+ abort();
break;
- case ValueOptional: break;
- default: cerr << "Bad ValueMask flag! CommandLine usage error:"
- << Handler->getValueExpectedFlag() << "\n"; abort();
}
// Run the handler now!
- return Handler->addOccurance(ArgName, Value);
+ return Handler->addOccurrence(i, ArgName, Value ? Value : "");
}
-static bool ProvidePositionalOption(Option *Handler, string &Arg) {
- int Dummy;
- return ProvideOption(Handler, "", Arg.c_str(), 0, 0, Dummy);
+static bool ProvidePositionalOption(Option *Handler, const std::string &Arg,
+ int i) {
+ int Dummy = i;
+ return ProvideOption(Handler, Handler->ArgStr, Arg.c_str(), 0, 0, Dummy);
}
//
static Option *getOptionPred(std::string Name, unsigned &Length,
bool (*Pred)(const Option*)) {
-
+
Option *Op = getOption(Name);
if (Op && Pred(Op)) {
Length = Name.length();
}
static bool RequiresValue(const Option *O) {
- return O->getNumOccurancesFlag() == cl::Required ||
- O->getNumOccurancesFlag() == cl::OneOrMore;
+ return O->getNumOccurrencesFlag() == cl::Required ||
+ O->getNumOccurrencesFlag() == cl::OneOrMore;
}
static bool EatsUnboundedNumberOfValues(const Option *O) {
- return O->getNumOccurancesFlag() == cl::ZeroOrMore ||
- O->getNumOccurancesFlag() == cl::OneOrMore;
+ return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
+ O->getNumOccurrencesFlag() == cl::OneOrMore;
+}
+
+/// ParseCStringVector - Break INPUT up wherever one or more
+/// whitespace characters are found, and store the resulting tokens in
+/// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
+/// using strdup (), so it is the caller's responsibility to free ()
+/// them later.
+///
+static void ParseCStringVector (std::vector<char *> &output,
+ const char *input) {
+ // Characters which will be treated as token separators:
+ static const char *delims = " \v\f\t\r\n";
+
+ std::string work (input);
+ // Skip past any delims at head of input string.
+ size_t pos = work.find_first_not_of (delims);
+ // If the string consists entirely of delims, then exit early.
+ if (pos == std::string::npos) return;
+ // Otherwise, jump forward to beginning of first word.
+ work = work.substr (pos);
+ // Find position of first delimiter.
+ pos = work.find_first_of (delims);
+
+ while (!work.empty() && pos != std::string::npos) {
+ // Everything from 0 to POS is the next word to copy.
+ output.push_back (strdup (work.substr (0,pos).c_str ()));
+ // Is there another word in the string?
+ size_t nextpos = work.find_first_not_of (delims, pos + 1);
+ if (nextpos != std::string::npos) {
+ // Yes? Then remove delims from beginning ...
+ work = work.substr (work.find_first_not_of (delims, pos + 1));
+ // and find the end of the word.
+ pos = work.find_first_of (delims);
+ } else {
+ // No? (Remainder of string is delims.) End the loop.
+ work = "";
+ pos = std::string::npos;
+ }
+ }
+
+ // If `input' ended with non-delim char, then we'll get here with
+ // the last word of `input' in `work'; copy it now.
+ if (!work.empty ()) {
+ output.push_back (strdup (work.c_str ()));
+ }
+}
+
+/// ParseEnvironmentOptions - An alternative entry point to the
+/// CommandLine library, which allows you to read the program's name
+/// from the caller (as PROGNAME) and its command-line arguments from
+/// an environment variable (whose name is given in ENVVAR).
+///
+void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
+ const char *Overview) {
+ // Check args.
+ assert(progName && "Program name not specified");
+ assert(envVar && "Environment variable name missing");
+
+ // Get the environment variable they want us to parse options out of.
+ const char *envValue = getenv (envVar);
+ if (!envValue)
+ return;
+
+ // Get program's "name", which we wouldn't know without the caller
+ // telling us.
+ std::vector<char *> newArgv;
+ newArgv.push_back (strdup (progName));
+
+ // Parse the value of the environment variable into a "command line"
+ // and hand it off to ParseCommandLineOptions().
+ ParseCStringVector (newArgv, envValue);
+ int newArgc = newArgv.size ();
+ ParseCommandLineOptions (newArgc, &newArgv[0], Overview);
+
+ // Free all the strdup()ed strings.
+ for (std::vector<char *>::iterator i = newArgv.begin (), e = newArgv.end ();
+ i != e; ++i) {
+ free (*i);
+ }
+}
+
+/// LookupOption - Lookup the option specified by the specified option on the
+/// command line. If there is a value specified (after an equal sign) return
+/// that as well.
+static Option *LookupOption(const char *&Arg, const char *&Value) {
+ while (*Arg == '-') ++Arg; // Eat leading dashes
+
+ const char *ArgEnd = Arg;
+ while (*ArgEnd && *ArgEnd != '=')
+ ++ArgEnd; // Scan till end of argument name.
+
+ if (*ArgEnd == '=') // If we have an equals sign...
+ Value = ArgEnd+1; // Get the value, not the equals
+
+
+ if (*Arg == 0) return 0;
+
+ // Look up the option.
+ std::map<std::string, Option*> &Opts = getOpts();
+ std::map<std::string, Option*>::iterator I =
+ Opts.find(std::string(Arg, ArgEnd));
+ return (I != Opts.end()) ? I->second : 0;
}
void cl::ParseCommandLineOptions(int &argc, char **argv,
ProgramOverview = Overview;
bool ErrorParsing = false;
- map<string, Option*> &Opts = getOpts();
- vector<Option*> &PositionalOpts = getPositionalOpts();
+ std::map<std::string, Option*> &Opts = getOpts();
+ std::vector<Option*> &PositionalOpts = getPositionalOpts();
// Check out the positional arguments to collect information about them.
unsigned NumPositionalRequired = 0;
+
+ // Determine whether or not there are an unlimited number of positionals
+ bool HasUnlimitedPositionals = false;
+
Option *ConsumeAfterOpt = 0;
if (!PositionalOpts.empty()) {
- if (PositionalOpts[0]->getNumOccurancesFlag() == cl::ConsumeAfter) {
+ if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
assert(PositionalOpts.size() > 1 &&
"Cannot specify cl::ConsumeAfter without a positional argument!");
ConsumeAfterOpt = PositionalOpts[0];
Opt->error(" error - this positional option will never be matched, "
"because it does not Require a value, and a "
"cl::ConsumeAfter option is active!");
- } else if (UnboundedFound) { // This option does not "require" a value...
- // Make sure this option is not specified after an option that eats all
- // extra arguments, or this one will never get any!
+ } else if (UnboundedFound && !Opt->ArgStr[0]) {
+ // This option does not "require" a value... Make sure this option is
+ // not specified after an option that eats all extra arguments, or this
+ // one will never get any!
//
ErrorParsing |= Opt->error(" error - option can never match, because "
"another positional argument will match an "
}
UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
}
+ HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
}
- // PositionalVals - A vector of "positional" arguments we accumulate into to
- // processes at the end...
+ // PositionalVals - A vector of "positional" arguments we accumulate into
+ // the process at the end...
//
- vector<string> PositionalVals;
+ std::vector<std::pair<std::string,unsigned> > PositionalVals;
+
+ // If the program has named positional arguments, and the name has been run
+ // across, keep track of which positional argument was named. Otherwise put
+ // the positional args into the PositionalVals list...
+ Option *ActivePositionalArg = 0;
// Loop over all of the arguments... processing them.
bool DashDashFound = false; // Have we read '--'?
for (int i = 1; i < argc; ++i) {
Option *Handler = 0;
- const char *Value = "";
+ const char *Value = 0;
const char *ArgName = "";
// Check to see if this is a positional argument. This argument is
// considered to be positional if it doesn't start with '-', if it is "-"
- // itself, or if we have see "--" already.
+ // itself, or if we have seen "--" already.
//
if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
// Positional argument!
- if (!PositionalOpts.empty()) {
- PositionalVals.push_back(argv[i]);
+ if (ActivePositionalArg) {
+ ProvidePositionalOption(ActivePositionalArg, argv[i], i);
+ continue; // We are done!
+ } else if (!PositionalOpts.empty()) {
+ PositionalVals.push_back(std::make_pair(argv[i],i));
// All of the positional arguments have been fulfulled, give the rest to
// the consume after option... if it's specified...
//
- if (PositionalVals.size() == NumPositionalRequired &&
+ if (PositionalVals.size() >= NumPositionalRequired &&
ConsumeAfterOpt != 0) {
for (++i; i < argc; ++i)
- PositionalVals.push_back(argv[i]);
+ PositionalVals.push_back(std::make_pair(argv[i],i));
break; // Handle outside of the argument processing loop...
}
// Delay processing positional arguments until the end...
continue;
}
- } else { // We start with a '-', must be an argument...
+ } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
+ !DashDashFound) {
+ DashDashFound = true; // This is the mythical "--"?
+ continue; // Don't try to process it as an argument itself.
+ } else if (ActivePositionalArg &&
+ (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
+ // If there is a positional argument eating options, check to see if this
+ // option is another positional argument. If so, treat it as an argument,
+ // otherwise feed it to the eating positional.
ArgName = argv[i]+1;
- while (*ArgName == '-') ++ArgName; // Eat leading dashes
-
- if (*ArgName == 0 && !DashDashFound) { // Is this the mythical "--"?
- DashDashFound = true; // Yup, take note of that fact...
- continue; // Don't try to process it as an argument iself.
+ Handler = LookupOption(ArgName, Value);
+ if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
+ ProvidePositionalOption(ActivePositionalArg, argv[i], i);
+ continue; // We are done!
}
- const char *ArgNameEnd = ArgName;
- while (*ArgNameEnd && *ArgNameEnd != '=')
- ++ArgNameEnd; // Scan till end of argument name...
-
- Value = ArgNameEnd;
- if (*Value) // If we have an equals sign...
- ++Value; // Advance to value...
-
- if (*ArgName != 0) {
- string RealName(ArgName, ArgNameEnd);
- // Extract arg name part
- map<string, Option*>::iterator I = Opts.find(RealName);
+ } else { // We start with a '-', must be an argument...
+ ArgName = argv[i]+1;
+ Handler = LookupOption(ArgName, Value);
- if (I == Opts.end() && !*Value && RealName.size() > 1) {
- // Check to see if this "option" is really a prefixed or grouped
- // argument...
- //
+ // Check to see if this "option" is really a prefixed or grouped argument.
+ if (Handler == 0) {
+ std::string RealName(ArgName);
+ if (RealName.size() > 1) {
unsigned Length = 0;
Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping);
// setting up the argument name flags and value fields.
//
if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
- ArgNameEnd = ArgName+Length;
- Value = ArgNameEnd;
- I = Opts.find(string(ArgName, ArgNameEnd));
- assert(I->second == PGOpt);
+ Value = ArgName+Length;
+ assert(Opts.find(std::string(ArgName, Value)) != Opts.end() &&
+ Opts.find(std::string(ArgName, Value))->second == PGOpt);
+ Handler = PGOpt;
} else if (PGOpt) {
- // This must be a grouped option... handle all of them now...
+ // This must be a grouped option... handle them now.
assert(isGrouping(PGOpt) && "Broken getOptionPred!");
do {
// Move current arg name out of RealName into RealArgName...
- string RealArgName(RealName.begin(), RealName.begin()+Length);
- RealName.erase(RealName.begin(), RealName.begin()+Length);
+ std::string RealArgName(RealName.begin(),
+ RealName.begin() + Length);
+ RealName.erase(RealName.begin(), RealName.begin() + Length);
- // Because ValueRequired is an invalid flag for grouped arguments,
- // we don't need to pass argc/argv in...
- //
+ // Because ValueRequired is an invalid flag for grouped arguments,
+ // we don't need to pass argc/argv in...
+ //
assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
"Option can not be cl::Grouping AND cl::ValueRequired!");
int Dummy;
- ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(), "",
- 0, 0, Dummy);
+ ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(),
+ 0, 0, 0, Dummy);
// Get the next grouping option...
- if (!RealName.empty())
- PGOpt = getOptionPred(RealName, Length, isGrouping);
- } while (!RealName.empty() && PGOpt);
+ PGOpt = getOptionPred(RealName, Length, isGrouping);
+ } while (PGOpt && Length != RealName.size());
- if (RealName.empty()) // Processed all of the options, move on
- continue; // to the next argv[] value...
-
- // If RealName is not empty, that means we did not match one of the
- // options! This is an error.
- //
- I = Opts.end();
+ Handler = PGOpt; // Ate all of the options.
}
- }
-
- Handler = I != Opts.end() ? I->second : 0;
+ }
}
}
if (Handler == 0) {
- cerr << "Unknown command line argument '" << argv[i] << "'. Try: "
- << argv[0] << " --help'\n";
+ if (ProgramName)
+ std::cerr << ProgramName << ": Unknown command line argument '"
+ << argv[i] << "'. Try: '" << argv[0] << " --help'\n";
+ else
+ std::cerr << "Unknown command line argument '" << argv[i] << "'.\n";
ErrorParsing = true;
continue;
}
- ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
+ // Check to see if this option accepts a comma separated list of values. If
+ // it does, we have to split up the value into multiple values...
+ if (Value && Handler->getMiscFlags() & CommaSeparated) {
+ std::string Val(Value);
+ std::string::size_type Pos = Val.find(',');
+
+ while (Pos != std::string::npos) {
+ // Process the portion before the comma...
+ ErrorParsing |= ProvideOption(Handler, ArgName,
+ std::string(Val.begin(),
+ Val.begin()+Pos).c_str(),
+ argc, argv, i);
+ // Erase the portion before the comma, AND the comma...
+ Val.erase(Val.begin(), Val.begin()+Pos+1);
+ Value += Pos+1; // Increment the original value pointer as well...
+
+ // Check for another comma...
+ Pos = Val.find(',');
+ }
+ }
+
+ // If this is a named positional argument, just remember that it is the
+ // active one...
+ if (Handler->getFormattingFlag() == cl::Positional)
+ ActivePositionalArg = Handler;
+ else
+ ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
}
// Check and handle positional arguments now...
if (NumPositionalRequired > PositionalVals.size()) {
- cerr << "Not enough positional command line arguments specified!\n";
- cerr << "Must specify at least " << NumPositionalRequired
- << " positional arguments: See: " << argv[0] << " --help\n";
+ if (ProgramName)
+ std::cerr << ProgramName
+ << ": Not enough positional command line arguments specified!\n"
+ << "Must specify at least " << NumPositionalRequired
+ << " positional arguments: See: " << argv[0] << " --help\n";
+ else
+ std::cerr << "Not enough positional command line arguments specified!\n"
+ << "Must specify at least " << NumPositionalRequired
+ << " positional arguments.";
+
+ ErrorParsing = true;
+ } else if (!HasUnlimitedPositionals
+ && PositionalVals.size() > PositionalOpts.size()) {
+ if (ProgramName)
+ std::cerr << ProgramName
+ << ": Too many positional arguments specified!\n"
+ << "Can specify at most " << PositionalOpts.size()
+ << " positional arguments: See: " << argv[0] << " --help\n";
+ else
+ std::cerr << "Too many positional arguments specified!\n"
+ << "Can specify at most " << PositionalOpts.size()
+ << " positional arguments.\n";
ErrorParsing = true;
-
} else if (ConsumeAfterOpt == 0) {
// Positional args have already been handled if ConsumeAfter is specified...
unsigned ValNo = 0, NumVals = PositionalVals.size();
for (unsigned i = 0, e = PositionalOpts.size(); i != e; ++i) {
if (RequiresValue(PositionalOpts[i])) {
- ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo++]);
+ ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
+ PositionalVals[ValNo].second);
+ ValNo++;
--NumPositionalRequired; // We fulfilled our duty...
}
// do not give it values that others need. 'Done' controls whether the
// option even _WANTS_ any more.
//
- bool Done = PositionalOpts[i]->getNumOccurancesFlag() == cl::Required;
+ bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
while (NumVals-ValNo > NumPositionalRequired && !Done) {
- switch (PositionalOpts[i]->getNumOccurancesFlag()) {
+ switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
case cl::Optional:
Done = true; // Optional arguments want _at most_ one value
// FALL THROUGH
case cl::ZeroOrMore: // Zero or more will take all they can get...
case cl::OneOrMore: // One or more will take all they can get...
- ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo++]);
+ ProvidePositionalOption(PositionalOpts[i],
+ PositionalVals[ValNo].first,
+ PositionalVals[ValNo].second);
+ ValNo++;
break;
default:
- assert(0 && "Internal error, unexpected NumOccurances flag in "
+ assert(0 && "Internal error, unexpected NumOccurrences flag in "
"positional argument processing!");
}
}
assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
unsigned ValNo = 0;
for (unsigned j = 1, e = PositionalOpts.size(); j != e; ++j)
- if (RequiresValue(PositionalOpts[j]))
+ if (RequiresValue(PositionalOpts[j])) {
ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
- PositionalVals[ValNo++]);
+ PositionalVals[ValNo].first,
+ PositionalVals[ValNo].second);
+ ValNo++;
+ }
// Handle the case where there is just one positional option, and it's
// optional. In this case, we want to give JUST THE FIRST option to the
// positional option and keep the rest for the consume after. The above
// loop would have assigned no values to positional options in this case.
//
- if (PositionalOpts.size() == 2 && ValNo == 0)
+ if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
- PositionalVals[ValNo++]);
-
+ PositionalVals[ValNo].first,
+ PositionalVals[ValNo].second);
+ ValNo++;
+ }
+
// Handle over all of the rest of the arguments to the
// cl::ConsumeAfter command line option...
for (; ValNo != PositionalVals.size(); ++ValNo)
ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
- PositionalVals[ValNo]);
+ PositionalVals[ValNo].first,
+ PositionalVals[ValNo].second);
}
// Loop over args and make sure all required args are specified!
- for (map<string, Option*>::iterator I = Opts.begin(),
- E = Opts.end(); I != E; ++I) {
- switch (I->second->getNumOccurancesFlag()) {
+ for (std::map<std::string, Option*>::iterator I = Opts.begin(),
+ E = Opts.end(); I != E; ++I) {
+ switch (I->second->getNumOccurrencesFlag()) {
case Required:
case OneOrMore:
- if (I->second->getNumOccurances() == 0) {
- I->second->error(" must be specified at least once!");
+ if (I->second->getNumOccurrences() == 0) {
+ I->second->error(" must be specified at least once!");
ErrorParsing = true;
}
// Fall through
// Free all of the memory allocated to the map. Command line options may only
// be processed once!
- delete CommandLineOptions;
- CommandLineOptions = 0;
+ getOpts().clear();
PositionalOpts.clear();
+ MoreHelp().clear();
// If we had an error processing our arguments, don't let the program execute
if (ErrorParsing) exit(1);
// Option Base class implementation
//
-bool Option::error(string Message, const char *ArgName) {
+bool Option::error(std::string Message, const char *ArgName) {
if (ArgName == 0) ArgName = ArgStr;
if (ArgName[0] == 0)
- cerr << HelpStr; // Be nice for positional arguments
+ std::cerr << HelpStr; // Be nice for positional arguments
else
- cerr << "-" << ArgName;
- cerr << " option" << Message << "\n";
+ std::cerr << ProgramName << ": for the -" << ArgName;
+ std::cerr << " option: " << Message << "\n";
return true;
}
-bool Option::addOccurance(const char *ArgName, const string &Value) {
- NumOccurances++; // Increment the number of times we have been seen
+bool Option::addOccurrence(unsigned pos, const char *ArgName,
+ const std::string &Value) {
+ NumOccurrences++; // Increment the number of times we have been seen
- switch (getNumOccurancesFlag()) {
+ switch (getNumOccurrencesFlag()) {
case Optional:
- if (NumOccurances > 1)
+ if (NumOccurrences > 1)
return error(": may only occur zero or one times!", ArgName);
break;
case Required:
- if (NumOccurances > 1)
+ if (NumOccurrences > 1)
return error(": must occur exactly one time!", ArgName);
// Fall through
case OneOrMore:
case ZeroOrMore:
case ConsumeAfter: break;
- default: return error(": bad num occurances flag value!");
+ default: return error(": bad num occurrences flag value!");
}
- return handleOccurance(ArgName, Value);
+ return handleOccurrence(pos, ArgName, Value);
}
// addArgument - Tell the system that this Option subclass will handle all
-// occurances of -ArgStr on the command line.
+// occurrences of -ArgStr on the command line.
//
void Option::addArgument(const char *ArgStr) {
if (ArgStr[0])
AddArgument(ArgStr, this);
- else if (getFormattingFlag() == Positional)
+
+ if (getFormattingFlag() == Positional)
getPositionalOpts().push_back(this);
- else if (getNumOccurancesFlag() == ConsumeAfter) {
- assert((getPositionalOpts().empty() ||
- getPositionalOpts().front()->getNumOccurancesFlag() != ConsumeAfter)
- && "Cannot specify more than one option with cl::ConsumeAfter "
- "specified!");
+ else if (getNumOccurrencesFlag() == ConsumeAfter) {
+ if (!getPositionalOpts().empty() &&
+ getPositionalOpts().front()->getNumOccurrencesFlag() == ConsumeAfter)
+ error("Cannot specify more than one option with cl::ConsumeAfter!");
getPositionalOpts().insert(getPositionalOpts().begin(), this);
}
}
void Option::removeArgument(const char *ArgStr) {
- if (ArgStr[0]) {
+ if (ArgStr[0])
RemoveArgument(ArgStr, this);
- } else if (getFormattingFlag() == Positional) {
- vector<Option*>::iterator I =
+
+ if (getFormattingFlag() == Positional) {
+ std::vector<Option*>::iterator I =
std::find(getPositionalOpts().begin(), getPositionalOpts().end(), this);
assert(I != getPositionalOpts().end() && "Arg not registered!");
getPositionalOpts().erase(I);
- } else if (getNumOccurancesFlag() == ConsumeAfter) {
+ } else if (getNumOccurrencesFlag() == ConsumeAfter) {
assert(!getPositionalOpts().empty() && getPositionalOpts()[0] == this &&
"Arg not registered correctly!");
getPositionalOpts().erase(getPositionalOpts().begin());
// Print out the option for the alias...
void alias::printOptionInfo(unsigned GlobalWidth) const {
unsigned L = std::strlen(ArgStr);
- cerr << " -" << ArgStr << string(GlobalWidth-L-6, ' ') << " - "
- << HelpStr << "\n";
+ std::cerr << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
+ << HelpStr << "\n";
}
// Parser Implementation code...
//
+// basic_parser implementation
+//
+
+// Return the width of the option tag for printing...
+unsigned basic_parser_impl::getOptionWidth(const Option &O) const {
+ unsigned Len = std::strlen(O.ArgStr);
+ if (const char *ValName = getValueName())
+ Len += std::strlen(getValueStr(O, ValName))+3;
+
+ return Len + 6;
+}
+
+// printOptionInfo - Print out information about this option. The
+// to-be-maintained width is specified.
+//
+void basic_parser_impl::printOptionInfo(const Option &O,
+ unsigned GlobalWidth) const {
+ std::cerr << " -" << O.ArgStr;
+
+ if (const char *ValName = getValueName())
+ std::cerr << "=<" << getValueStr(O, ValName) << ">";
+
+ std::cerr << std::string(GlobalWidth-getOptionWidth(O), ' ') << " - "
+ << O.HelpStr << "\n";
+}
+
+
+
+
// parser<bool> implementation
//
-bool parser<bool>::parseImpl(Option &O, const string &Arg, bool &Value) {
- if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
+bool parser<bool>::parse(Option &O, const char *ArgName,
+ const std::string &Arg, bool &Value) {
+ if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
Arg == "1") {
Value = true;
} else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
return false;
}
-// Return the width of the option tag for printing...
-unsigned parser<bool>::getOptionWidth(const Option &O) const {
- return std::strlen(O.ArgStr)+6;
-}
-
-// printOptionInfo - Print out information about this option. The
-// to-be-maintained width is specified.
-//
-void parser<bool>::printOptionInfo(const Option &O, unsigned GlobalWidth) const{
- unsigned L = std::strlen(O.ArgStr);
- cerr << " -" << O.ArgStr << string(GlobalWidth-L-6, ' ') << " - "
- << O.HelpStr << "\n";
-}
-
-
-
// parser<int> implementation
//
-bool parser<int>::parseImpl(Option &O, const string &Arg, int &Value) {
- const char *ArgStart = Arg.c_str();
+bool parser<int>::parse(Option &O, const char *ArgName,
+ const std::string &Arg, int &Value) {
char *End;
- Value = (int)strtol(ArgStart, &End, 0);
- if (*End != 0)
+ Value = (int)strtol(Arg.c_str(), &End, 0);
+ if (*End != 0)
return O.error(": '" + Arg + "' value invalid for integer argument!");
return false;
}
-// Return the width of the option tag for printing...
-unsigned parser<int>::getOptionWidth(const Option &O) const {
- return std::strlen(O.ArgStr)+std::strlen(getValueStr(O, "int"))+9;
-}
-
-// printOptionInfo - Print out information about this option. The
-// to-be-maintained width is specified.
+// parser<unsigned> implementation
//
-void parser<int>::printOptionInfo(const Option &O, unsigned GlobalWidth) const{
- cerr << " -" << O.ArgStr << "=<" << getValueStr(O, "int") << ">"
- << string(GlobalWidth-getOptionWidth(O), ' ') << " - "
- << O.HelpStr << "\n";
+bool parser<unsigned>::parse(Option &O, const char *ArgName,
+ const std::string &Arg, unsigned &Value) {
+ char *End;
+ errno = 0;
+ unsigned long V = strtoul(Arg.c_str(), &End, 0);
+ Value = (unsigned)V;
+ if (((V == ULONG_MAX) && (errno == ERANGE))
+ || (*End != 0)
+ || (Value != V))
+ return O.error(": '" + Arg + "' value invalid for uint argument!");
+ return false;
}
-
-// parser<double> implementation
+// parser<double>/parser<float> implementation
//
-bool parser<double>::parseImpl(Option &O, const string &Arg, double &Value) {
+static bool parseDouble(Option &O, const std::string &Arg, double &Value) {
const char *ArgStart = Arg.c_str();
char *End;
Value = strtod(ArgStart, &End);
- if (*End != 0)
+ if (*End != 0)
return O.error(": '" +Arg+ "' value invalid for floating point argument!");
return false;
}
-// Return the width of the option tag for printing...
-unsigned parser<double>::getOptionWidth(const Option &O) const {
- return std::strlen(O.ArgStr)+std::strlen(getValueStr(O, "number"))+9;
+bool parser<double>::parse(Option &O, const char *AN,
+ const std::string &Arg, double &Val) {
+ return parseDouble(O, Arg, Val);
}
-// printOptionInfo - Print out information about this option. The
-// to-be-maintained width is specified.
-//
-void parser<double>::printOptionInfo(const Option &O,
- unsigned GlobalWidth) const{
- cerr << " -" << O.ArgStr << "=<" << getValueStr(O, "number") << ">"
- << string(GlobalWidth-getOptionWidth(O), ' ')
- << " - " << O.HelpStr << "\n";
+bool parser<float>::parse(Option &O, const char *AN,
+ const std::string &Arg, float &Val) {
+ double dVal;
+ if (parseDouble(O, Arg, dVal))
+ return true;
+ Val = (float)dVal;
+ return false;
}
-// parser<string> implementation
-//
-
-// Return the width of the option tag for printing...
-unsigned parser<string>::getOptionWidth(const Option &O) const {
- return std::strlen(O.ArgStr)+std::strlen(getValueStr(O, "string"))+9;
-}
-
-// printOptionInfo - Print out information about this option. The
-// to-be-maintained width is specified.
-//
-void parser<string>::printOptionInfo(const Option &O,
- unsigned GlobalWidth) const{
- cerr << " -" << O.ArgStr << " <" << getValueStr(O, "string") << ">"
- << string(GlobalWidth-getOptionWidth(O), ' ')
- << " - " << O.HelpStr << "\n";
-}
// generic_parser_base implementation
//
//
unsigned generic_parser_base::findOption(const char *Name) {
unsigned i = 0, e = getNumOptions();
- string N(Name);
+ std::string N(Name);
while (i != e)
if (getOption(i) == N)
}
}
-// printOptionInfo - Print out information about this option. The
+// printOptionInfo - Print out information about this option. The
// to-be-maintained width is specified.
//
void generic_parser_base::printOptionInfo(const Option &O,
unsigned GlobalWidth) const {
if (O.hasArgStr()) {
unsigned L = std::strlen(O.ArgStr);
- cerr << " -" << O.ArgStr << string(GlobalWidth-L-6, ' ')
- << " - " << O.HelpStr << "\n";
+ std::cerr << " -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
+ << " - " << O.HelpStr << "\n";
for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
unsigned NumSpaces = GlobalWidth-strlen(getOption(i))-8;
- cerr << " =" << getOption(i) << string(NumSpaces, ' ') << " - "
- << getDescription(i) << "\n";
+ std::cerr << " =" << getOption(i) << std::string(NumSpaces, ' ')
+ << " - " << getDescription(i) << "\n";
}
} else {
if (O.HelpStr[0])
- cerr << " " << O.HelpStr << "\n";
+ std::cerr << " " << O.HelpStr << "\n";
for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
unsigned L = std::strlen(getOption(i));
- cerr << " -" << getOption(i) << string(GlobalWidth-L-8, ' ') << " - "
- << getDescription(i) << "\n";
+ std::cerr << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
+ << " - " << getDescription(i) << "\n";
}
}
}
//===----------------------------------------------------------------------===//
// --help and --help-hidden option implementation
//
+
namespace {
class HelpPrinter {
const bool ShowHidden;
// isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
- inline static bool isHidden(pair<string, Option *> &OptPair) {
+ inline static bool isHidden(std::pair<std::string, Option *> &OptPair) {
return OptPair.second->getOptionHiddenFlag() >= Hidden;
}
- inline static bool isReallyHidden(pair<string, Option *> &OptPair) {
+ inline static bool isReallyHidden(std::pair<std::string, Option *> &OptPair) {
return OptPair.second->getOptionHiddenFlag() == ReallyHidden;
}
if (Value == false) return;
// Copy Options into a vector so we can sort them as we like...
- vector<pair<string, Option*> > Options;
+ std::vector<std::pair<std::string, Option*> > Options;
copy(getOpts().begin(), getOpts().end(), std::back_inserter(Options));
// Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
- Options.erase(std::remove_if(Options.begin(), Options.end(),
+ Options.erase(std::remove_if(Options.begin(), Options.end(),
std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
- Options.end());
+ Options.end());
// Eliminate duplicate entries in table (from enum flags options, f.e.)
{ // Give OptionSet a scope
}
if (ProgramOverview)
- cerr << "OVERVIEW:" << ProgramOverview << "\n";
+ std::cerr << "OVERVIEW:" << ProgramOverview << "\n";
- cerr << "USAGE: " << ProgramName << " [options]";
+ std::cerr << "USAGE: " << ProgramName << " [options]";
// Print out the positional options...
- vector<Option*> &PosOpts = getPositionalOpts();
+ std::vector<Option*> &PosOpts = getPositionalOpts();
Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
- if (!PosOpts.empty() && PosOpts[0]->getNumOccurancesFlag() == ConsumeAfter)
+ if (!PosOpts.empty() && PosOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
CAOpt = PosOpts[0];
for (unsigned i = CAOpt != 0, e = PosOpts.size(); i != e; ++i) {
- cerr << " " << PosOpts[i]->HelpStr;
- switch (PosOpts[i]->getNumOccurancesFlag()) {
- case Optional: cerr << "?"; break;
- case ZeroOrMore: cerr << "*"; break;
- case Required: break;
- case OneOrMore: cerr << "+"; break;
- case ConsumeAfter:
- default:
- assert(0 && "Unknown NumOccurances Flag Value!");
- }
+ if (PosOpts[i]->ArgStr[0])
+ std::cerr << " --" << PosOpts[i]->ArgStr;
+ std::cerr << " " << PosOpts[i]->HelpStr;
}
// Print the consume after option info if it exists...
- if (CAOpt) cerr << " " << CAOpt->HelpStr;
+ if (CAOpt) std::cerr << " " << CAOpt->HelpStr;
- cerr << "\n\n";
+ std::cerr << "\n\n";
// Compute the maximum argument length...
MaxArgLen = 0;
for (unsigned i = 0, e = Options.size(); i != e; ++i)
MaxArgLen = std::max(MaxArgLen, Options[i].second->getOptionWidth());
- cerr << "OPTIONS:\n";
+ std::cerr << "OPTIONS:\n";
for (unsigned i = 0, e = Options.size(); i != e; ++i)
Options[i].second->printOptionInfo(MaxArgLen);
- // Halt the program if help information is printed
+ // Print any extra help the user has declared.
+ for (std::vector<const char *>::iterator I = MoreHelp().begin(),
+ E = MoreHelp().end(); I != E; ++I)
+ std::cerr << *I;
+ MoreHelp().clear();
+
+ // Halt the program since help information was printed
+ getOpts().clear(); // Don't bother making option dtors remove from map.
exit(1);
}
};
+class VersionPrinter {
+public:
+ void operator=(bool OptionWasSpecified) {
+ if (OptionWasSpecified) {
+ std::cerr << "Low Level Virtual Machine (" << PACKAGE_NAME << ") "
+ << PACKAGE_VERSION << " (see http://llvm.org/)";
+#ifndef NDEBUG
+ std::cerr << " DEBUG BUILD\n";
+#else
+ std::cerr << "\n";
+#endif
+ getOpts().clear(); // Don't bother making option dtors remove from map.
+ exit(1);
+ }
+ }
+};
// Define the two HelpPrinter instances that are used to print out help, or
HelpPrinter NormalPrinter(false);
HelpPrinter HiddenPrinter(true);
-cl::opt<HelpPrinter, true, parser<bool> >
-HOp("help", cl::desc("display available options (--help-hidden for more)"),
- cl::location(NormalPrinter));
+cl::opt<HelpPrinter, true, parser<bool> >
+HOp("help", cl::desc("Display available options (--help-hidden for more)"),
+ cl::location(NormalPrinter), cl::ValueDisallowed);
cl::opt<HelpPrinter, true, parser<bool> >
-HHOp("help-hidden", cl::desc("display all available options"),
- cl::location(HiddenPrinter), cl::Hidden);
+HHOp("help-hidden", cl::desc("Display all available options"),
+ cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
+
+// Define the --version option that prints out the LLVM version for the tool
+VersionPrinter VersionPrinterInstance;
+cl::opt<VersionPrinter, true, parser<bool> >
+VersOp("version", cl::desc("Display the version of this program"),
+ cl::location(VersionPrinterInstance), cl::ValueDisallowed);
+
} // End anonymous namespace
+
+// Utility function for printing the help message.
+void cl::PrintHelpMessage() {
+ // This looks weird, but it actually prints the help message. The
+ // NormalPrinter variable is a HelpPrinter and the help gets printed when
+ // its operator= is invoked. That's because the "normal" usages of the
+ // help printer is to be assigned true/false depending on whether the
+ // --help option was given or not. Since we're circumventing that we have
+ // to make it look like --help was given, so we assign true.
+ NormalPrinter = true;
+}