X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Fcore%2Fgetopt.cpp;h=0f8886ad746a542e3a40b36ed8e7c2ddcd0c1e19;hp=b472c58b835a94e27fa94046c488e9777096b60f;hb=20c897ece781e18ba54c41fd68e232ce566a938d;hpb=c7afef88380ebebc8c2b04e48664d73281ec8848

diff --git a/source/core/getopt.cpp b/source/core/getopt.cpp
index b472c58..0f8886a 100644
--- a/source/core/getopt.cpp
+++ b/source/core/getopt.cpp
@@ -1,3 +1,4 @@
+#include <msp/strings/format.h>
 #include "getopt.h"
 
 using namespace std;
@@ -12,21 +13,69 @@ GetOpt::GetOpt():
 
 GetOpt::~GetOpt()
 {
-	for(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); ++i)
+	for(OptionList::iterator i=opts.begin(); i!=opts.end(); ++i)
 		delete *i;
+	for(ArgumentList::iterator i=args.begin(); i!=args.end(); ++i)
+		delete *i;
+}
+
+GetOpt::OptionImpl &GetOpt::add_option(char s, const string &l, const Store &t, ArgType a)
+{
+	if(l.empty())
+		throw invalid_argument("GetOpt::add_option");
+	if(t.is_list() && a!=REQUIRED_ARG)
+		throw invalid_argument("GetOpt::add_option");
+
+	for(OptionList::iterator i=opts.begin(); i!=opts.end(); )
+	{
+		if((s!=0 && (*i)->get_short()==s) || (*i)->get_long()==l)
+		{
+			delete *i;
+			opts.erase(i++);
+		}
+		else
+			++i;
+	}
+
+	opts.push_back(new OptionImpl(s, l, t, a));
+	return *opts.back();
 }
 
-GetOpt::OptBase &GetOpt::get_option(char s)
+GetOpt::ArgumentImpl &GetOpt::add_argument(const string &n, const Store &t, ArgType a)
 {
-	for(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); ++i)
+	if(a==NO_ARG)
+		throw invalid_argument("GetOpt::add_argument");
+
+	bool have_list = false;
+	bool have_optional = false;
+	for(ArgumentList::const_iterator i=args.begin(); i!=args.end(); ++i)
+	{
+		if((*i)->is_list_store())
+			have_list = true;
+		else if((*i)->get_type()==OPTIONAL_ARG)
+			have_optional = true;
+	}
+
+	if(have_optional && (t.is_list() || a!=OPTIONAL_ARG))
+		throw invalid_argument("GetOpt::add_argument");
+	if(have_list && (t.is_list() || a==OPTIONAL_ARG))
+		throw invalid_argument("GetOpt::add_argument");
+
+	args.push_back(new ArgumentImpl(n, t, a));
+	return *args.back();
+}
+
+GetOpt::OptionImpl &GetOpt::get_option(char s)
+{
+	for(OptionList::iterator i=opts.begin(); i!=opts.end(); ++i)
 		if((*i)->get_short()==s)
 			return **i;
 	throw usage_error(string("Unknown option -")+s);
 }
 
-GetOpt::OptBase &GetOpt::get_option(const string &l)
+GetOpt::OptionImpl &GetOpt::get_option(const string &l)
 {
-	for(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); ++i)
+	for(OptionList::iterator i=opts.begin(); i!=opts.end(); ++i)
 		if((*i)->get_long()==l)
 			return **i;
 	throw usage_error(string("Unknown option --")+l);
@@ -36,6 +85,8 @@ void GetOpt::operator()(unsigned argc, const char *const *argv)
 {
 	try
 	{
+		/* Arguments must first be collected into an array to handle the case
+		where a variable-length argument list is followed by fixed arguments. */
 		unsigned i = 1;
 		for(; i<argc;)
 		{
@@ -52,19 +103,46 @@ void GetOpt::operator()(unsigned argc, const char *const *argv)
 					i += process_short(argv+i);
 			}
 			else
-				args.push_back(argv[i++]);
+				args_raw.push_back(argv[i++]);
 		}
-		
+
 		for(; i<argc; ++i)
-			args.push_back(argv[i]);
+			args_raw.push_back(argv[i]);
+
+		i = 0;
+		for(ArgumentList::const_iterator j=args.begin(); j!=args.end(); ++j)
+		{
+			if((*j)->is_list_store())
+			{
+				unsigned end = args_raw.size();
+				for(ArgumentList::const_iterator k=j; ++k!=args.end(); )
+					--end;
+				if(i==end && (*j)->get_type()==REQUIRED_ARG)
+					throw usage_error((*j)->get_name()+" is required");
+				for(; i<end; ++i)
+					(*j)->process(args_raw[i]);
+			}
+			else
+			{
+				if(i<args_raw.size())
+					(*j)->process(args_raw[i++]);
+				else if((*j)->get_type()==REQUIRED_ARG)
+					throw usage_error((*j)->get_name()+" is required");
+			}
+		}
+
+		// XXX Enable this when get_args() is completely removed
+		/*if(i<args_raw.size())
+			throw usage_error("Extra positional arguments");*/
 	}
 	catch(const usage_error &e)
 	{
-		throw usage_error(e.what(), "Usage: "+generate_usage(argv[0]));
+		if(!help)
+			throw usage_error(e.what(), "Usage: "+generate_usage(argv[0]));
 	}
 
 	if(help)
-		throw usage_error(string("Help for ")+argv[0]+":", generate_help());
+		throw usage_error(string("Help for ")+argv[0]+":", "\nUsage:\n  "+generate_usage(argv[0], true)+"\n\n"+generate_help());
 }
 
 unsigned GetOpt::process_long(const char *const *argp)
@@ -75,9 +153,9 @@ unsigned GetOpt::process_long(const char *const *argp)
 	// See if the argument contains an =
 	unsigned equals = 0;
 	for(; arg[equals] && arg[equals]!='='; ++equals) ;
-	
-	OptBase &opt = get_option(string(arg, equals));
-	
+
+	OptionImpl &opt = get_option(string(arg, equals));
+
 	if(arg[equals])
 		// Process the part after the = as option argument
 		opt.process(arg+equals+1);
@@ -92,7 +170,7 @@ unsigned GetOpt::process_long(const char *const *argp)
 	}
 	else
 		opt.process();
-	
+
 	return 1;
 }
 
@@ -104,7 +182,7 @@ unsigned GetOpt::process_short(const char *const *argp)
 	// Loop through all characters in the argument
 	for(; *arg; ++arg)
 	{
-		OptBase &opt = get_option(*arg);
+		OptionImpl &opt = get_option(*arg);
 
 		if(arg[1] && opt.get_arg_type()!=NO_ARG)
 		{
@@ -116,7 +194,7 @@ unsigned GetOpt::process_short(const char *const *argp)
 		{
 			if(!argp[1])
 				throw usage_error("-"+string(1, *arg)+" requires an argument");
-			
+
 			// Use the next argument as option argument
 			opt.process(argp[1]);
 			return 2;
@@ -128,126 +206,215 @@ unsigned GetOpt::process_short(const char *const *argp)
 	return 1;
 }
 
-string GetOpt::generate_usage(const string &argv0) const
+string GetOpt::generate_usage(const string &argv0, bool compact) const
 {
-	ostringstream line;
-	
-	line<<argv0;
-	for(list<OptBase *>::const_iterator i=opts.begin(); i!=opts.end(); ++i)
+	string result = argv0;
+	if(compact)
+		result += " [options]";
+	else
 	{
-		line<<" [";
-		if((*i)->get_short())
+		for(OptionList::const_iterator i=opts.begin(); i!=opts.end(); ++i)
 		{
-			line<<'-'<<(*i)->get_short();
+			result += " [";
+			if((*i)->get_short())
+			{
+				result += format("-%c", (*i)->get_short());
+				if(!(*i)->get_long().empty())
+					result += '|';
+				else if((*i)->get_arg_type()==OPTIONAL_ARG)
+					result += format("[%s]", (*i)->get_metavar());
+				else if((*i)->get_arg_type()==REQUIRED_ARG)
+					result += format(" %s", (*i)->get_metavar());
+			}
 			if(!(*i)->get_long().empty())
-				line<<'|';
-			else if((*i)->get_arg_type()==OPTIONAL_ARG)
-				line<<'['<<(*i)->get_metavar()<<']';
-			else if((*i)->get_arg_type()==REQUIRED_ARG)
-				line<<' '<<(*i)->get_metavar();
-		}
-		if(!(*i)->get_long().empty())
-		{
-			line<<"--"<<(*i)->get_long();
+			{
+				result += format("--%s", (*i)->get_long());
 
-			if((*i)->get_arg_type()==OPTIONAL_ARG)
-				line<<"[="<<(*i)->get_metavar()<<']';
-			else if((*i)->get_arg_type()==REQUIRED_ARG)
-				line<<'='<<(*i)->get_metavar();
+				if((*i)->get_arg_type()==OPTIONAL_ARG)
+					result += format("[=%s]", (*i)->get_metavar());
+				else if((*i)->get_arg_type()==REQUIRED_ARG)
+					result += format("=%s", (*i)->get_metavar());
+			}
+			result += ']';
 		}
-		line<<']';
 	}
 
-	return line.str();
+	for(ArgumentList::const_iterator i=args.begin(); i!=args.end(); ++i)
+	{
+		result += ' ';
+		if((*i)->get_type()==OPTIONAL_ARG)
+			result += '[';
+		result += format("<%s>", (*i)->get_name());
+		if((*i)->is_list_store())
+			result += " ...";
+		if((*i)->get_type()==OPTIONAL_ARG)
+			result += ']';
+	}
+
+	return result;
 }
 
 string GetOpt::generate_help() const
 {
 	bool any_short = false;
-	for(list<OptBase *>::const_iterator i=opts.begin(); (!any_short && i!=opts.end()); ++i)
+	for(OptionList::const_iterator i=opts.begin(); (!any_short && i!=opts.end()); ++i)
 		any_short = (*i)->get_short();
 
 	string::size_type maxw = 0;
 	list<string> switches;
-	for(list<OptBase *>::const_iterator i=opts.begin(); i!=opts.end(); ++i)
+	for(OptionList::const_iterator i=opts.begin(); i!=opts.end(); ++i)
 	{
-		ostringstream swtch;
+		string swtch;
 		if((*i)->get_short())
 		{
-			swtch<<'-'<<(*i)->get_short();
+			swtch += format("-%c", (*i)->get_short());
 			if(!(*i)->get_long().empty())
-				swtch<<", ";
+				swtch += ", ";
 			else if((*i)->get_arg_type()==OPTIONAL_ARG)
-				swtch<<'['<<(*i)->get_metavar()<<']';
+				swtch += format("[%s]", (*i)->get_metavar());
 			else if((*i)->get_arg_type()==REQUIRED_ARG)
-				swtch<<' '<<(*i)->get_metavar();
+				swtch += format(" %s", (*i)->get_metavar());
 		}
 		else if(any_short)
-			swtch<<"    ";
+			swtch += "    ";
 		if(!(*i)->get_long().empty())
 		{
-			swtch<<"--"<<(*i)->get_long();
+			swtch += format("--%s", (*i)->get_long());
 
 			if((*i)->get_arg_type()==OPTIONAL_ARG)
-				swtch<<"[="<<(*i)->get_metavar()<<']';
+				swtch += format("[=%s]", (*i)->get_metavar());
 			else if((*i)->get_arg_type()==REQUIRED_ARG)
-				swtch<<'='<<(*i)->get_metavar();
+				swtch += format("=%s", (*i)->get_metavar());
 		}
-		switches.push_back(swtch.str());
-		maxw = max(maxw, switches.back().size());
+		switches.push_back(swtch);
+		maxw = max(maxw, swtch.size());
+	}
+
+	list<string> pargs;
+	for(ArgumentList::const_iterator i=args.begin(); i!=args.end(); ++i)
+	{
+		string parg = format("<%s>", (*i)->get_name());
+		pargs.push_back(parg);
+		maxw = max(maxw, parg.size());
 	}
 
 	string result;
+	result += "Options:\n";
 	list<string>::const_iterator j = switches.begin();
-	for(list<OptBase *>::const_iterator i=opts.begin(); i!=opts.end(); ++i, ++j)
+	for(OptionList::const_iterator i=opts.begin(); i!=opts.end(); ++i, ++j)
+		result += format("  %s%s%s\n", *j, string(maxw+2-j->size(), ' '), (*i)->get_help());
+	if(!pargs.empty())
 	{
-		result += "  "+*j;
-		result += string(maxw+2-j->size(), ' ');
-		result += (*i)->get_help();
-		result += '\n';
+		result += "\nArguments:\n";
+		j = pargs.begin();
+		for(ArgumentList::const_iterator i=args.begin(); i!=args.end(); ++i, ++j)
+			result += format("  %s%s%s\n", *j, string(maxw+2-j->size(), ' '), (*i)->get_help());
 	}
-	
+
 	return result;
 }
 
 
-GetOpt::OptBase::OptBase(char s, const std::string &l, ArgType a):
+GetOpt::OptionImpl::OptionImpl(char s, const string &l, const Store &t, ArgType a):
 	shrt(s),
 	lng(l),
 	arg_type(a),
 	seen_count(0),
-	metavar("ARG")
+	ext_seen_count(0),
+	metavar("ARG"),
+	store(t.clone())
 { }
 
-GetOpt::OptBase &GetOpt::OptBase::set_help(const string &h)
+GetOpt::OptionImpl::~OptionImpl()
+{
+	delete store;
+}
+
+GetOpt::OptionImpl &GetOpt::OptionImpl::set_help(const string &h)
 {
 	help = h;
 	return *this;
 }
 
-GetOpt::OptBase &GetOpt::OptBase::set_help(const string &h, const string &m)
+GetOpt::OptionImpl &GetOpt::OptionImpl::set_help(const string &h, const string &m)
 {
 	help = h;
 	metavar = m;
 	return *this;
 }
 
-void GetOpt::OptBase::process()
+GetOpt::OptionImpl &GetOpt::OptionImpl::bind_seen_count(unsigned &c)
+{
+	ext_seen_count = &c;
+	return *this;
+}
+
+void GetOpt::OptionImpl::process()
 {
 	if(arg_type==REQUIRED_ARG)
 		throw usage_error("--"+lng+" requires an argument");
+
 	++seen_count;
+	if(ext_seen_count)
+		*ext_seen_count = seen_count;
 
-	store();
+	try
+	{
+		store->store();
+	}
+	catch(const exception &e)
+	{
+		throw usage_error("Invalid argument for --"+lng+" ("+e.what()+")");
+	}
 }
 
-void GetOpt::OptBase::process(const string &arg)
+void GetOpt::OptionImpl::process(const string &arg)
 {
 	if(arg_type==NO_ARG)
 		throw usage_error("--"+lng+" takes no argument");
+
 	++seen_count;
+	if(ext_seen_count)
+		*ext_seen_count = seen_count;
+
+	try
+	{
+		store->store(arg);
+	}
+	catch(const exception &e)
+	{
+		throw usage_error("Invalid argument for --"+lng+" ("+e.what()+")");
+	}
+}
+
+
+GetOpt::ArgumentImpl::ArgumentImpl(const string &n, const Store &t, ArgType a):
+	name(n),
+	type(a),
+	store(t.clone())
+{ }
+
+GetOpt::ArgumentImpl::~ArgumentImpl()
+{
+	delete store;
+}
 
-	store(arg);
+GetOpt::ArgumentImpl &GetOpt::ArgumentImpl::set_help(const string &h)
+{
+	help = h;
+	return *this;
+}
+
+void GetOpt::ArgumentImpl::process(const string &arg)
+{
+	try
+	{
+		store->store(arg);
+	}
+	catch(const exception &e)
+	{
+		throw usage_error("Invalid "+name+" ("+e.what()+")");
+	}
 }
 
 } // namespace Msp