//===----------------------------------------------------------------------===//
#include "Support/CommandLine.h"
-#include "Support/STLExtras.h"
-#include <vector>
#include <algorithm>
#include <map>
#include <set>
#include <iostream>
+
using namespace cl;
-using std::map;
-using std::pair;
-using std::vector;
-using std::string;
-using std::cerr;
+
+//===----------------------------------------------------------------------===//
+// 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*> &getOpts() {
- static map<string,Option*> CommandLineOptions;
- return CommandLineOptions;
+static std::map<std::string, Option*> *CommandLineOptions = 0;
+static std::map<std::string, Option*> &getOpts() {
+ if (CommandLineOptions == 0)
+ CommandLineOptions = new std::map<std::string,Option*>();
+ return *CommandLineOptions;
+}
+
+static Option *getOption(const std::string &Str) {
+ if (CommandLineOptions == 0) return 0;
+ std::map<std::string,Option*>::iterator I = CommandLineOptions->find(Str);
+ return I != CommandLineOptions->end() ? I->second : 0;
+}
+
+static std::vector<Option*> &getPositionalOpts() {
+ static std::vector<Option*> Positional;
+ return Positional;
}
-static void AddArgument(const string &ArgName, Option *Opt) {
- if (getOpts().find(ArgName) != getOpts().end()) {
- cerr << "CommandLine Error: Argument '" << ArgName
- << "' defined more than once!\n";
+static void AddArgument(const char *ArgName, Option *Opt) {
+ if (getOption(ArgName)) {
+ std::cerr << "CommandLine Error: Argument '" << ArgName
+ << "' defined more than once!\n";
} else {
// Add argument to the argument map!
- getOpts().insert(std::make_pair(ArgName, Opt));
+ 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;
}
}
case ValueDisallowed:
if (*Value != 0)
return Handler->error(" does not allow a value! '" +
- string(Value) + "' specified.");
+ std::string(Value) + "' specified.");
break;
case ValueOptional: break;
- default: cerr << "Bad ValueMask flag! CommandLine usage error:"
- << Handler->getValueExpectedFlag() << "\n"; abort();
+ default: std::cerr << "Bad ValueMask flag! CommandLine usage error:"
+ << Handler->getValueExpectedFlag() << "\n"; abort();
}
// Run the handler now!
- return Handler->addOccurance(ArgName, Value);
+ return Handler->addOccurrence(ArgName, Value);
+}
+
+static bool ProvidePositionalOption(Option *Handler, const std::string &Arg) {
+ int Dummy;
+ return ProvideOption(Handler, Handler->ArgStr, Arg.c_str(), 0, 0, Dummy);
+}
+
+
+// Option predicates...
+static inline bool isGrouping(const Option *O) {
+ return O->getFormattingFlag() == cl::Grouping;
+}
+static inline bool isPrefixedOrGrouping(const Option *O) {
+ return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
}
-// ValueGroupedArgs - Return true if the specified string is valid as a group
-// of single letter arguments stuck together like the 'ls -la' case.
+// getOptionPred - Check to see if there are any options that satisfy the
+// specified predicate with names that are the prefixes in Name. This is
+// checked by progressively stripping characters off of the name, checking to
+// see if there options that satisfy the predicate. If we find one, return it,
+// otherwise return null.
//
-static inline bool ValidGroupedArgs(string Args) {
- for (unsigned i = 0; i < Args.size(); ++i) {
- map<string, Option*>::iterator I = getOpts().find(string(1, Args[i]));
- if (I == getOpts().end()) return false; // Make sure option exists
+static Option *getOptionPred(std::string Name, unsigned &Length,
+ bool (*Pred)(const Option*)) {
+
+ Option *Op = getOption(Name);
+ if (Op && Pred(Op)) {
+ Length = Name.length();
+ return Op;
+ }
- // Grouped arguments have no value specified, make sure that if this option
- // exists that it can accept no argument.
- //
- switch (I->second->getValueExpectedFlag()) {
- case ValueDisallowed:
- case ValueOptional: break;
- default: return false;
- }
+ if (Name.size() == 1) return 0;
+ do {
+ Name.erase(Name.end()-1, Name.end()); // Chop off the last character...
+ Op = getOption(Name);
+
+ // Loop while we haven't found an option and Name still has at least two
+ // characters in it (so that the next iteration will not be the empty
+ // string...
+ } while ((Op == 0 || !Pred(Op)) && Name.size() > 1);
+
+ if (Op && Pred(Op)) {
+ Length = Name.length();
+ return Op; // Found one!
}
+ return 0; // No option found!
+}
- return true;
+static bool RequiresValue(const Option *O) {
+ return O->getNumOccurrencesFlag() == cl::Required ||
+ O->getNumOccurrencesFlag() == cl::OneOrMore;
+}
+
+static bool EatsUnboundedNumberOfValues(const Option *O) {
+ return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
+ O->getNumOccurrencesFlag() == cl::OneOrMore;
}
void cl::ParseCommandLineOptions(int &argc, char **argv,
- const char *Overview = 0, int Flags = 0) {
+ const char *Overview) {
+ assert((!getOpts().empty() || !getPositionalOpts().empty()) &&
+ "No options specified, or ParseCommandLineOptions called more"
+ " than once!");
ProgramName = argv[0]; // Save this away safe and snug
ProgramOverview = Overview;
bool ErrorParsing = false;
+ 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;
+ Option *ConsumeAfterOpt = 0;
+ if (!PositionalOpts.empty()) {
+ if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
+ assert(PositionalOpts.size() > 1 &&
+ "Cannot specify cl::ConsumeAfter without a positional argument!");
+ ConsumeAfterOpt = PositionalOpts[0];
+ }
+
+ // Calculate how many positional values are _required_.
+ bool UnboundedFound = false;
+ for (unsigned i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
+ i != e; ++i) {
+ Option *Opt = PositionalOpts[i];
+ if (RequiresValue(Opt))
+ ++NumPositionalRequired;
+ else if (ConsumeAfterOpt) {
+ // ConsumeAfter cannot be combined with "optional" positional options
+ // unless there is only one positional argument...
+ if (PositionalOpts.size() > 2)
+ ErrorParsing |=
+ 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 && !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 "
+ "unbounded number of values, and this option"
+ " does not require a value!");
+ }
+ UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
+ }
+ }
+
+ // PositionalVals - A vector of "positional" arguments we accumulate into to
+ // processes at the end...
+ //
+ std::vector<std::string> 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 *ArgName = "";
- if (argv[i][0] != '-') { // Unnamed argument?
- map<string, Option*>::iterator I = getOpts().find("");
- Handler = I != getOpts().end() ? I->second : 0;
- Value = argv[i];
- } else { // We start with a - or --, eat dashes
+
+ // 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 seen "--" already.
+ //
+ if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
+ // Positional argument!
+ if (ActivePositionalArg) {
+ ProvidePositionalOption(ActivePositionalArg, argv[i]);
+ continue; // We are done!
+ } else if (!PositionalOpts.empty()) {
+ PositionalVals.push_back(argv[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 &&
+ ConsumeAfterOpt != 0) {
+ for (++i; i < argc; ++i)
+ PositionalVals.push_back(argv[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...
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.
+ }
+
const char *ArgNameEnd = ArgName;
while (*ArgNameEnd && *ArgNameEnd != '=')
- ++ArgNameEnd; // Scan till end of argument name...
+ ++ArgNameEnd; // Scan till end of argument name...
Value = ArgNameEnd;
if (*Value) // If we have an equals sign...
- ++Value; // Advance to value...
+ ++Value; // Advance to value...
if (*ArgName != 0) {
- string RealName(ArgName, ArgNameEnd);
- // Extract arg name part
- map<string, Option*>::iterator I = getOpts().find(RealName);
-
- if (I == getOpts().end() && !*Value && RealName.size() > 1) {
- // If grouping of single letter arguments is enabled, see if this is a
- // legal grouping...
- //
- if (!(Flags & DisableSingleLetterArgGrouping) &&
- ValidGroupedArgs(RealName)) {
-
- for (unsigned i = 0; i < RealName.size(); ++i) {
- char ArgName[2] = { 0, 0 }; int Dummy;
- ArgName[0] = RealName[i];
- I = getOpts().find(ArgName);
- assert(I != getOpts().end() && "ValidGroupedArgs failed!");
-
- // Because ValueRequired is an invalid flag for grouped arguments,
- // we don't need to pass argc/argv in...
- //
- ErrorParsing |= ProvideOption(I->second, ArgName, "",
- 0, 0, Dummy);
- }
- continue;
- } else if (Flags & EnableSingleLetterArgValue) {
- // Check to see if the first letter is a single letter argument that
- // have a value that is equal to the rest of the string. If this
- // is the case, recognize it now. (Example: -lfoo for a linker)
- //
- I = getOpts().find(string(1, RealName[0]));
- if (I != getOpts().end()) {
- // If we are successful, fall through to later processing, by
- // setting up the argument name flags and value fields.
- //
- ArgNameEnd = ArgName+1;
- Value = ArgNameEnd;
- }
- }
- }
-
-
- Handler = I != getOpts().end() ? I->second : 0;
+ std::string RealName(ArgName, ArgNameEnd);
+ // Extract arg name part
+ std::map<std::string, Option*>::iterator I = Opts.find(RealName);
+
+ if (I == Opts.end() && !*Value && RealName.size() > 1) {
+ // Check to see if this "option" is really a prefixed or grouped
+ // argument...
+ //
+ unsigned Length = 0;
+ Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping);
+
+ // If the option is a prefixed option, then the value is simply the
+ // rest of the name... so fall through to later processing, by
+ // setting up the argument name flags and value fields.
+ //
+ if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
+ ArgNameEnd = ArgName+Length;
+ Value = ArgNameEnd;
+ I = Opts.find(std::string(ArgName, ArgNameEnd));
+ assert(I->second == PGOpt);
+ } else if (PGOpt) {
+ // This must be a grouped option... handle all of them now...
+ assert(isGrouping(PGOpt) && "Broken getOptionPred!");
+
+ do {
+ // Move current arg name out of RealName into RealArgName...
+ 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...
+ //
+ 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);
+
+ // Get the next grouping option...
+ if (!RealName.empty())
+ PGOpt = getOptionPred(RealName, Length, isGrouping);
+ } while (!RealName.empty() && PGOpt);
+
+ 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 = I != Opts.end() ? I->second : 0;
}
}
if (Handler == 0) {
- cerr << "Unknown command line argument '" << argv[i] << "'. Try: "
- << argv[0] << " --help'\n";
+ std::cerr << "Unknown command line argument '" << argv[i] << "'. Try: "
+ << argv[0] << " --help'\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 (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()) {
+ std::cerr << "Not enough positional command line arguments specified!\n"
+ << "Must specify at least " << NumPositionalRequired
+ << " positional arguments: See: " << argv[0] << " --help\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++]);
+ --NumPositionalRequired; // We fulfilled our duty...
+ }
- // If this option should consume all arguments that come after it...
- if (Handler->getNumOccurancesFlag() == ConsumeAfter) {
- for (++i; i < argc; ++i)
- ErrorParsing |= ProvideOption(Handler, ArgName, argv[i], argc, argv, i);
+ // If we _can_ give this option more arguments, do so now, as long as we
+ // do not give it values that others need. 'Done' controls whether the
+ // option even _WANTS_ any more.
+ //
+ bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
+ while (NumVals-ValNo > NumPositionalRequired && !Done) {
+ 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++]);
+ break;
+ default:
+ assert(0 && "Internal error, unexpected NumOccurrences flag in "
+ "positional argument processing!");
+ }
+ }
}
+ } else {
+ assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
+ unsigned ValNo = 0;
+ for (unsigned j = 1, e = PositionalOpts.size(); j != e; ++j)
+ if (RequiresValue(PositionalOpts[j]))
+ ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
+ PositionalVals[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 && !PositionalVals.empty())
+ ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
+ PositionalVals[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]);
}
// Loop over args and make sure all required args are specified!
- for (map<string, Option*>::iterator I = getOpts().begin(),
- E = getOpts().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 vector. Command line options may
- // only be processed once!
- getOpts().clear();
+ // Free all of the memory allocated to the map. Command line options may only
+ // be processed once!
+ delete CommandLineOptions;
+ CommandLineOptions = 0;
+ PositionalOpts.clear();
// If we had an error processing our arguments, don't let the program execute
if (ErrorParsing) exit(1);
//===----------------------------------------------------------------------===//
// Option Base class implementation
//
-Option::Option(const char *argStr, const char *helpStr, int flags)
- : NumOccurances(0), Flags(flags), ArgStr(argStr), HelpStr(helpStr) {
- AddArgument(ArgStr, this);
-}
-bool Option::error(string Message, const char *ArgName = 0) {
+bool Option::error(std::string Message, const char *ArgName) {
if (ArgName == 0) ArgName = ArgStr;
- cerr << "-" << ArgName << " option" << Message << "\n";
+ if (ArgName[0] == 0)
+ std::cerr << HelpStr; // Be nice for positional arguments
+ else
+ std::cerr << "-" << 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(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(ArgName, Value);
}
-// Return the width of the option tag for printing...
-unsigned Option::getOptionWidth() const {
- return std::strlen(ArgStr)+6;
+// addArgument - Tell the system that this Option subclass will handle all
+// occurrences of -ArgStr on the command line.
+//
+void Option::addArgument(const char *ArgStr) {
+ if (ArgStr[0])
+ AddArgument(ArgStr, this);
+
+ if (getFormattingFlag() == Positional)
+ getPositionalOpts().push_back(this);
+ 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::printOptionInfo(unsigned GlobalWidth) const {
- unsigned L = std::strlen(ArgStr);
- if (L == 0) return; // Don't print the empty arg like this!
- cerr << " -" << ArgStr << string(GlobalWidth-L-6, ' ') << " - "
- << HelpStr << "\n";
+void Option::removeArgument(const char *ArgStr) {
+ if (ArgStr[0])
+ RemoveArgument(ArgStr, this);
+
+ 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 (getNumOccurrencesFlag() == ConsumeAfter) {
+ assert(!getPositionalOpts().empty() && getPositionalOpts()[0] == this &&
+ "Arg not registered correctly!");
+ getPositionalOpts().erase(getPositionalOpts().begin());
+ }
}
-//===----------------------------------------------------------------------===//
-// Boolean/flag command line option implementation
+// getValueStr - Get the value description string, using "DefaultMsg" if nothing
+// has been specified yet.
//
-
-bool Flag::handleOccurance(const char *ArgName, const string &Arg) {
- if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
- Arg == "1") {
- Value = true;
- } else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
- Value = false;
- } else {
- return error(": '" + Arg +
- "' is invalid value for boolean argument! Try 0 or 1");
- }
-
- return false;
+static const char *getValueStr(const Option &O, const char *DefaultMsg) {
+ if (O.ValueStr[0] == 0) return DefaultMsg;
+ return O.ValueStr;
}
//===----------------------------------------------------------------------===//
-// Integer valued command line option implementation
+// cl::alias class implementation
//
-bool Int::handleOccurance(const char *ArgName, const string &Arg) {
- const char *ArgStart = Arg.c_str();
- char *End;
- Value = (int)strtol(ArgStart, &End, 0);
- if (*End != 0)
- return error(": '" + Arg + "' value invalid for integer argument!");
- return false;
+
+// Return the width of the option tag for printing...
+unsigned alias::getOptionWidth() const {
+ return std::strlen(ArgStr)+6;
}
-//===----------------------------------------------------------------------===//
-// String valued command line option implementation
-//
-bool String::handleOccurance(const char *ArgName, const string &Arg) {
- *this = Arg;
- return false;
+// Print out the option for the alias...
+void alias::printOptionInfo(unsigned GlobalWidth) const {
+ unsigned L = std::strlen(ArgStr);
+ std::cerr << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
+ << HelpStr << "\n";
}
+
+
//===----------------------------------------------------------------------===//
-// StringList valued command line option implementation
+// Parser Implementation code...
//
-bool StringList::handleOccurance(const char *ArgName, const string &Arg) {
- push_back(Arg);
- return false;
-}
-//===----------------------------------------------------------------------===//
-// Enum valued command line option implementation
+// basic_parser implementation
//
-void EnumBase::processValues(va_list Vals) {
- while (const char *EnumName = va_arg(Vals, const char *)) {
- int EnumVal = va_arg(Vals, int);
- const char *EnumDesc = va_arg(Vals, const char *);
- ValueMap.push_back(std::make_pair(EnumName, // Add value to value map
- std::make_pair(EnumVal, EnumDesc)));
- }
-}
-// registerArgs - notify the system about these new arguments
-void EnumBase::registerArgs() {
- for (unsigned i = 0; i < ValueMap.size(); ++i)
- AddArgument(ValueMap[i].first, this);
-}
+// 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;
-const char *EnumBase::getArgName(int ID) const {
- for (unsigned i = 0; i < ValueMap.size(); ++i)
- if (ID == ValueMap[i].second.first) return ValueMap[i].first;
- return "";
-}
-const char *EnumBase::getArgDescription(int ID) const {
- for (unsigned i = 0; i < ValueMap.size(); ++i)
- if (ID == ValueMap[i].second.first) return ValueMap[i].second.second;
- return "";
+ 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";
+}
-bool EnumValueBase::handleOccurance(const char *ArgName, const string &Arg) {
- unsigned i;
- for (i = 0; i < ValueMap.size(); ++i)
- if (ValueMap[i].first == Arg) break;
- if (i == ValueMap.size()) {
- string Alternatives;
- for (i = 0; i < ValueMap.size(); ++i) {
- if (i) Alternatives += ", ";
- Alternatives += ValueMap[i].first;
- }
- return error(": unrecognized alternative '" + Arg +
- "'! Alternatives are: " + Alternatives);
+// parser<bool> implementation
+//
+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") {
+ Value = false;
+ } else {
+ return O.error(": '" + Arg +
+ "' is invalid value for boolean argument! Try 0 or 1");
}
- Value = ValueMap[i].second.first;
return false;
}
-// Return the width of the option tag for printing...
-unsigned EnumValueBase::getOptionWidth() const {
- unsigned BaseSize = Option::getOptionWidth();
- for (unsigned i = 0; i < ValueMap.size(); ++i)
- BaseSize = std::max(BaseSize, std::strlen(ValueMap[i].first)+8);
- return BaseSize;
+// parser<int> implementation
+//
+bool parser<int>::parse(Option &O, const char *ArgName,
+ const std::string &Arg, int &Value) {
+ char *End;
+ Value = (int)strtol(Arg.c_str(), &End, 0);
+ if (*End != 0)
+ return O.error(": '" + Arg + "' value invalid for integer argument!");
+ return false;
}
-// printOptionInfo - Print out information about this option. The
-// to-be-maintained width is specified.
+// parser<unsigned> implementation
//
-void EnumValueBase::printOptionInfo(unsigned GlobalWidth) const {
- Option::printOptionInfo(GlobalWidth);
- for (unsigned i = 0; i < ValueMap.size(); ++i) {
- unsigned NumSpaces = GlobalWidth-strlen(ValueMap[i].first)-8;
- cerr << " =" << ValueMap[i].first << string(NumSpaces, ' ') << " - "
- << ValueMap[i].second.second;
-
- if (i == 0) cerr << " (default)";
- cerr << "\n";
- }
+bool parser<unsigned>::parse(Option &O, const char *ArgName,
+ const std::string &Arg, unsigned &Value) {
+ char *End;
+ long long int V = strtoll(Arg.c_str(), &End, 0);
+ Value = (unsigned)V;
+ if (*End != 0 || V < 0 || Value != V)
+ return O.error(": '" + Arg + "' value invalid for uint argument!");
+ return false;
}
-//===----------------------------------------------------------------------===//
-// Enum flags command line option implementation
+// parser<double>/parser<float> implementation
//
-
-bool EnumFlagsBase::handleOccurance(const char *ArgName, const string &Arg) {
- return EnumValueBase::handleOccurance("", ArgName);
+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)
+ return O.error(": '" +Arg+ "' value invalid for floating point argument!");
+ return false;
}
-unsigned EnumFlagsBase::getOptionWidth() const {
- unsigned BaseSize = 0;
- for (unsigned i = 0; i < ValueMap.size(); ++i)
- BaseSize = std::max(BaseSize, std::strlen(ValueMap[i].first)+6);
- return BaseSize;
+bool parser<double>::parse(Option &O, const char *AN,
+ const std::string &Arg, double &Val) {
+ return parseDouble(O, Arg, Val);
}
-void EnumFlagsBase::printOptionInfo(unsigned GlobalWidth) const {
- for (unsigned i = 0; i < ValueMap.size(); ++i) {
- unsigned L = std::strlen(ValueMap[i].first);
- cerr << " -" << ValueMap[i].first << string(GlobalWidth-L-6, ' ') << " - "
- << ValueMap[i].second.second;
- if (i == 0) cerr << " (default)";
- cerr << "\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;
}
-//===----------------------------------------------------------------------===//
-// Enum list command line option implementation
+
+// generic_parser_base implementation
//
-bool EnumListBase::handleOccurance(const char *ArgName, const string &Arg) {
- unsigned i;
- for (i = 0; i < ValueMap.size(); ++i)
- if (ValueMap[i].first == string(ArgName)) break;
- if (i == ValueMap.size())
- return error(": CommandLine INTERNAL ERROR", ArgName);
- Values.push_back(ValueMap[i].second.first);
- return false;
+// findOption - Return the option number corresponding to the specified
+// argument string. If the option is not found, getNumOptions() is returned.
+//
+unsigned generic_parser_base::findOption(const char *Name) {
+ unsigned i = 0, e = getNumOptions();
+ std::string N(Name);
+
+ while (i != e)
+ if (getOption(i) == N)
+ return i;
+ else
+ ++i;
+ return e;
}
+
// Return the width of the option tag for printing...
-unsigned EnumListBase::getOptionWidth() const {
- unsigned BaseSize = 0;
- for (unsigned i = 0; i < ValueMap.size(); ++i)
- BaseSize = std::max(BaseSize, std::strlen(ValueMap[i].first)+6);
- return BaseSize;
+unsigned generic_parser_base::getOptionWidth(const Option &O) const {
+ if (O.hasArgStr()) {
+ unsigned Size = std::strlen(O.ArgStr)+6;
+ for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
+ Size = std::max(Size, (unsigned)std::strlen(getOption(i))+8);
+ return Size;
+ } else {
+ unsigned BaseSize = 0;
+ for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
+ BaseSize = std::max(BaseSize, (unsigned)std::strlen(getOption(i))+8);
+ return BaseSize;
+ }
}
-
// printOptionInfo - Print out information about this option. The
// to-be-maintained width is specified.
//
-void EnumListBase::printOptionInfo(unsigned GlobalWidth) const {
- for (unsigned i = 0; i < ValueMap.size(); ++i) {
- unsigned L = std::strlen(ValueMap[i].first);
- cerr << " -" << ValueMap[i].first << string(GlobalWidth-L-6, ' ') << " - "
- << ValueMap[i].second.second << "\n";
+void generic_parser_base::printOptionInfo(const Option &O,
+ unsigned GlobalWidth) const {
+ if (O.hasArgStr()) {
+ unsigned L = std::strlen(O.ArgStr);
+ 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;
+ std::cerr << " =" << getOption(i) << std::string(NumSpaces, ' ')
+ << " - " << getDescription(i) << "\n";
+ }
+ } else {
+ if (O.HelpStr[0])
+ std::cerr << " " << O.HelpStr << "\n";
+ for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
+ unsigned L = std::strlen(getOption(i));
+ std::cerr << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
+ << " - " << getDescription(i) << "\n";
+ }
}
}
//===----------------------------------------------------------------------===//
-// Help option... always automatically provided.
+// --help and --help-hidden option implementation
//
namespace {
-// isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
-inline bool isHidden(pair<string, Option *> &OptPair) {
- return OptPair.second->getOptionHiddenFlag() >= Hidden;
-}
-inline bool isReallyHidden(pair<string, Option *> &OptPair) {
- return OptPair.second->getOptionHiddenFlag() == ReallyHidden;
-}
-
-class Help : public Option {
+class HelpPrinter {
unsigned MaxArgLen;
const Option *EmptyArg;
const bool ShowHidden;
- virtual bool handleOccurance(const char *ArgName, const string &Arg) {
+ // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
+ inline static bool isHidden(std::pair<std::string, Option *> &OptPair) {
+ return OptPair.second->getOptionHiddenFlag() >= Hidden;
+ }
+ inline static bool isReallyHidden(std::pair<std::string, Option *> &OptPair) {
+ return OptPair.second->getOptionHiddenFlag() == ReallyHidden;
+ }
+
+public:
+ HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
+ EmptyArg = 0;
+ }
+
+ void operator=(bool Value) {
+ 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(remove_if(Options.begin(), Options.end(),
- std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
- Options.end());
+ Options.erase(std::remove_if(Options.begin(), Options.end(),
+ std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
+ Options.end());
// Eliminate duplicate entries in table (from enum flags options, f.e.)
- std::set<Option*> OptionSet;
- for (unsigned i = 0; i < Options.size(); )
- if (OptionSet.count(Options[i].second) == 0)
- OptionSet.insert(Options[i++].second); // Add to set
- else
- Options.erase(Options.begin()+i); // Erase duplicate
-
+ { // Give OptionSet a scope
+ std::set<Option*> OptionSet;
+ for (unsigned i = 0; i != Options.size(); ++i)
+ if (OptionSet.count(Options[i].second) == 0)
+ OptionSet.insert(Options[i].second); // Add new entry to set
+ else
+ Options.erase(Options.begin()+i--); // Erase duplicate
+ }
if (ProgramOverview)
- cerr << "OVERVIEW:" << ProgramOverview << "\n";
- // TODO: Sort options by some criteria
+ std::cerr << "OVERVIEW:" << ProgramOverview << "\n";
+
+ std::cerr << "USAGE: " << ProgramName << " [options]";
+
+ // Print out the positional options...
+ std::vector<Option*> &PosOpts = getPositionalOpts();
+ Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
+ if (!PosOpts.empty() && PosOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
+ CAOpt = PosOpts[0];
+
+ for (unsigned i = CAOpt != 0, e = PosOpts.size(); i != e; ++i) {
+ 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) std::cerr << " " << CAOpt->HelpStr;
- cerr << "USAGE: " << ProgramName << " [options]\n\n";
- // TODO: print usage nicer
+ std::cerr << "\n\n";
// Compute the maximum argument length...
MaxArgLen = 0;
- for_each(Options.begin(), Options.end(),
- bind_obj(this, &Help::getMaxArgLen));
+ for (unsigned i = 0, e = Options.size(); i != e; ++i)
+ MaxArgLen = std::max(MaxArgLen, Options[i].second->getOptionWidth());
- cerr << "OPTIONS:\n";
- for_each(Options.begin(), Options.end(),
- bind_obj(this, &Help::printOption));
+ std::cerr << "OPTIONS:\n";
+ for (unsigned i = 0, e = Options.size(); i != e; ++i)
+ Options[i].second->printOptionInfo(MaxArgLen);
- return true; // Displaying help is cause to terminate the program
+ // Halt the program if help information is printed
+ exit(1);
}
+};
- void getMaxArgLen(pair<string, Option *> OptPair) {
- const Option *Opt = OptPair.second;
- if (Opt->ArgStr[0] == 0) EmptyArg = Opt; // Capture the empty arg if exists
- MaxArgLen = std::max(MaxArgLen, Opt->getOptionWidth());
- }
- void printOption(pair<string, Option *> OptPair) {
- const Option *Opt = OptPair.second;
- Opt->printOptionInfo(MaxArgLen);
- }
-public:
- inline Help(const char *ArgVal, const char *HelpVal, bool showHidden)
- : Option(ArgVal, HelpVal, showHidden ? Hidden : 0), ShowHidden(showHidden) {
- EmptyArg = 0;
- }
-};
+// Define the two HelpPrinter instances that are used to print out help, or
+// help-hidden...
+//
+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::ValueDisallowed);
-Help HelpOp("help", "display available options"
- " (--help-hidden for more)", false);
-Help HelpHiddenOpt("help-hidden", "display all available options", true);
+cl::opt<HelpPrinter, true, parser<bool> >
+HHOp("help-hidden", cl::desc("display all available options"),
+ cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
} // End anonymous namespace
projects / oota-llvm.git / blobdiff