X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Fcore%2Fgetopt.cpp;h=6f7b1f807c9d719d3829959db91370860a62fabe;hp=be1d151a3ee8e704af0b10b79ed42c7a8b787572;hb=44da9fc9afb6b7e49c1558c5572213a1e6f401e8;hpb=ae48dac6a368dbf68b1ec976254a5f896c5b737b

diff --git a/source/core/getopt.cpp b/source/core/getopt.cpp
index be1d151..6f7b1f8 100644
--- a/source/core/getopt.cpp
+++ b/source/core/getopt.cpp
@@ -1,180 +1,169 @@
-/* $Id$
-
-This file is part of libmspcore
-Copyright © 2006-2007 Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
+#include <msp/strings/format.h>
+#include "algorithm.h"
 #include "getopt.h"
 
 using namespace std;
 
 namespace Msp {
 
-GetOpt::~GetOpt()
+GetOpt::GetOpt():
+	help(false)
 {
-	for(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); ++i)
-		delete *i;
+	add_option("help", help, NO_ARG).set_help("Displays this help");
 }
 
-/**
-Generates a single line that gives an overview about the known options.
-
-@param   argv0  The program name to be used in the usage string
+GetOpt::~GetOpt()
+{
+	for(OptionImpl *i: opts)
+		delete i;
+	for(ArgumentImpl *i: args)
+		delete i;
+}
 
-@return  The generated usage string
-*/
-string GetOpt::generate_usage(const string &argv0) const
+GetOpt::OptionImpl &GetOpt::add_option(char s, const string &l, const Store &t, ArgType a)
 {
-	ostringstream line;
-	
-	line<<argv0;
-	for(list<OptBase *>::const_iterator i=opts.begin(); i!=opts.end(); ++i)
+	if(l.empty())
+		throw invalid_argument("GetOpt::add_option");
+	if(t.is_list() && a!=REQUIRED_ARG)
+		throw invalid_argument("GetOpt::add_option");
+
+	for(auto i=opts.begin(); i!=opts.end(); )
 	{
-		line<<" [";
-		if((*i)->get_short())
-		{
-			line<<'-'<<(*i)->get_short();
-			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())
+		if((s!=0 && (*i)->get_short()==s) || (*i)->get_long()==l)
 		{
-			line<<"--"<<(*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();
+			delete *i;
+			opts.erase(i++);
 		}
-		line<<']';
+		else
+			++i;
 	}
 
-	return line.str();
+	opts.push_back(new OptionImpl(s, l, t, a));
+	return *opts.back();
 }
 
-/**
-Generates help for known options in tabular format, one option per line.
-The returned string will have a linefeed at the end.
-*/
-string GetOpt::generate_help() const
+GetOpt::ArgumentImpl &GetOpt::add_argument(const string &n, const Store &t, ArgType y)
 {
-	bool any_short=false;
-	for(list<OptBase *>::const_iterator i=opts.begin(); (!any_short && i!=opts.end()); ++i)
-		any_short=(*i)->get_short();
+	if(y==NO_ARG)
+		throw invalid_argument("GetOpt::add_argument");
 
-	unsigned maxw=0;
-	list<string> switches;
-	for(list<OptBase *>::const_iterator i=opts.begin(); i!=opts.end(); ++i)
+	bool have_list = false;
+	bool have_optional = false;
+	for(const ArgumentImpl *a: args)
 	{
-		ostringstream swtch;
-		if((*i)->get_short())
-		{
-			swtch<<'-'<<(*i)->get_short();
-			if(!(*i)->get_long().empty())
-				swtch<<", ";
-			else if((*i)->get_arg_type()==OPTIONAL_ARG)
-				swtch<<'['<<(*i)->get_metavar()<<']';
-			else if((*i)->get_arg_type()==REQUIRED_ARG)
-				swtch<<' '<<(*i)->get_metavar();
-		}
-		else if(any_short)
-			swtch<<"    ";
-		if(!(*i)->get_long().empty())
-		{
-			swtch<<"--"<<(*i)->get_long();
-
-			if((*i)->get_arg_type()==OPTIONAL_ARG)
-				swtch<<"[="<<(*i)->get_metavar()<<']';
-			else if((*i)->get_arg_type()==REQUIRED_ARG)
-				swtch<<'='<<(*i)->get_metavar();
-		}
-		switches.push_back(swtch.str());
-		maxw=max(maxw, switches.back().size());
+		if(a->is_list_store())
+			have_list = true;
+		else if(a->get_type()==OPTIONAL_ARG)
+			have_optional = true;
 	}
 
-	string result;
-	list<string>::const_iterator j=switches.begin();
-	for(list<OptBase *>::const_iterator i=opts.begin(); i!=opts.end(); ++i, ++j)
-	{
-		result+="  "+*j;
-		result+=string(maxw+2-j->size(), ' ');
-		result+=(*i)->get_help();
-		result+='\n';
-	}
-	
-	return result;
+	if(have_optional && (t.is_list() || y!=OPTIONAL_ARG))
+		throw invalid_argument("GetOpt::add_argument");
+	if(have_list && (t.is_list() || y==OPTIONAL_ARG))
+		throw invalid_argument("GetOpt::add_argument");
+
+	args.push_back(new ArgumentImpl(n, t, y));
+	return *args.back();
+}
+
+GetOpt::OptionImpl &GetOpt::get_option(char s)
+{
+	auto i = find_if(opts, [s](const OptionImpl *o){ return o->get_short()==s; });
+	if(i!=opts.end())
+		return **i;
+	throw usage_error(string("Unknown option -")+s);
+}
+
+GetOpt::OptionImpl &GetOpt::get_option(const string &l)
+{
+	auto i = find_if(opts, [&l](const OptionImpl *o){ return o->get_long()==l; });
+	if(i!=opts.end())
+		return **i;
+	throw usage_error(string("Unknown option --")+l);
 }
 
 void GetOpt::operator()(unsigned argc, const char *const *argv)
 {
-	unsigned i=1;
-	for(; i<argc;)
+	try
 	{
-		if(argv[i][0]=='-')
+		/* 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;)
 		{
-			if(argv[i][1]=='-')
+			if(argv[i][0]=='-')
 			{
-				if(!argv[i][2])
-					break;
-
-				i+=process_long(argv+i);
+				if(argv[i][1]=='-')
+				{
+					if(!argv[i][2])
+						break;
+
+					i += process_long(argv+i);
+				}
+				else
+					i += process_short(argv+i);
 			}
 			else
-				i+=process_short(argv+i);
+				args_raw.push_back(argv[i++]);
 		}
-		else
-			args.push_back(argv[i++]);
-	}
-	
-	for(; i<argc; ++i)
-		args.push_back(argv[i]);
-}
 
-GetOpt::OptBase &GetOpt::get_option(char s)
-{
-	for(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); ++i)
-		if((*i)->get_short()==s)
-			return **i;
-	throw UsageError(string("Unknown option -")+s);
-}
+		for(; i<argc; ++i)
+			args_raw.push_back(argv[i]);
 
-GetOpt::OptBase &GetOpt::get_option(const string &l)
-{
-	for(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); ++i)
-		if((*i)->get_long()==l)
-			return **i;
-	throw UsageError(string("Unknown option --")+l);
-}
+		i = 0;
+		for(auto j=args.begin(); j!=args.end(); ++j)
+		{
+			if((*j)->is_list_store())
+			{
+				unsigned end = args_raw.size();
+				for(auto 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");
+			}
+		}
 
-/**
-Processes the given argument as a long option.
+		// 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)
+	{
+		if(!help)
+			throw usage_error(e.what(), "Usage: "+generate_usage(argv[0]));
+	}
 
-@param   argp  Pointer to the argument
+	if(help)
+		throw usage_error(string("Help for ")+argv[0]+":", "\nUsage:\n  "+generate_usage(argv[0], true)+"\n\n"+generate_help());
+}
 
-@return  The number of arguments eaten (1 or 2)
-*/
 unsigned GetOpt::process_long(const char *const *argp)
 {
 	// Skip the --
-	const char *arg=argp[0]+2;
+	const char *arg = argp[0]+2;
 
 	// See if the argument contains an =
-	unsigned equals=0;
+	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);
 	else if(opt.get_arg_type()==REQUIRED_ARG)
 	{
 		if(!argp[1])
-			throw UsageError("Premature end of arguments");
+			throw usage_error("--"+string(arg)+" requires an argument");
 
 		// Process the next argument as option argument
 		opt.process(argp[1]);
@@ -182,26 +171,19 @@ unsigned GetOpt::process_long(const char *const *argp)
 	}
 	else
 		opt.process();
-	
+
 	return 1;
 }
 
-/**
-Processes short options from the given argument.
-
-@param   argp  Pointer to the argument
-
-@return  The number of arguments eaten (1 or 2)
-*/
 unsigned GetOpt::process_short(const char *const *argp)
 {
 	// Skip the -
-	const char *arg=argp[0]+1;
+	const char *arg = argp[0]+1;
 
 	// 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)
 		{
@@ -212,8 +194,8 @@ unsigned GetOpt::process_short(const char *const *argp)
 		else if(opt.get_arg_type()==REQUIRED_ARG)
 		{
 			if(!argp[1])
-				throw UsageError("Premature end of arguments");
-			
+				throw usage_error("-"+string(1, *arg)+" requires an argument");
+
 			// Use the next argument as option argument
 			opt.process(argp[1]);
 			return 2;
@@ -225,44 +207,213 @@ unsigned GetOpt::process_short(const char *const *argp)
 	return 1;
 }
 
+string GetOpt::generate_usage(const string &argv0, bool compact) const
+{
+	string result = argv0;
+	if(compact)
+		result += " [options]";
+	else
+	{
+		for(const OptionImpl *o: opts)
+		{
+			result += " [";
+			if(o->get_short())
+			{
+				result += format("-%c", o->get_short());
+				if(!o->get_long().empty())
+					result += '|';
+				else if(o->get_arg_type()==OPTIONAL_ARG)
+					result += format("[%s]", o->get_metavar());
+				else if(o->get_arg_type()==REQUIRED_ARG)
+					result += format(" %s", o->get_metavar());
+			}
+			if(!o->get_long().empty())
+			{
+				result += format("--%s", o->get_long());
+
+				if(o->get_arg_type()==OPTIONAL_ARG)
+					result += format("[=%s]", o->get_metavar());
+				else if(o->get_arg_type()==REQUIRED_ARG)
+					result += format("=%s", o->get_metavar());
+			}
+			result += ']';
+		}
+	}
+
+	for(const ArgumentImpl *a: args)
+	{
+		result += ' ';
+		if(a->get_type()==OPTIONAL_ARG)
+			result += '[';
+		result += format("<%s>", a->get_name());
+		if(a->is_list_store())
+			result += " ...";
+		if(a->get_type()==OPTIONAL_ARG)
+			result += ']';
+	}
+
+	return result;
+}
+
+string GetOpt::generate_help() const
+{
+	bool any_short = any_of(opts.begin(), opts.end(), [](const OptionImpl *o){ return o->get_short(); });
+
+	string::size_type maxw = 0;
+	vector<string> switches;
+	for(const OptionImpl *o: opts)
+	{
+		string swtch;
+		if(o->get_short())
+		{
+			swtch += format("-%c", o->get_short());
+			if(!o->get_long().empty())
+				swtch += ", ";
+			else if(o->get_arg_type()==OPTIONAL_ARG)
+				swtch += format("[%s]", o->get_metavar());
+			else if(o->get_arg_type()==REQUIRED_ARG)
+				swtch += format(" %s", o->get_metavar());
+		}
+		else if(any_short)
+			swtch += "    ";
+		if(!o->get_long().empty())
+		{
+			swtch += format("--%s", o->get_long());
+
+			if(o->get_arg_type()==OPTIONAL_ARG)
+				swtch += format("[=%s]", o->get_metavar());
+			else if(o->get_arg_type()==REQUIRED_ARG)
+				swtch += format("=%s", o->get_metavar());
+		}
+		switches.push_back(swtch);
+		maxw = max(maxw, swtch.size());
+	}
+
+	vector<string> pargs;
+	for(const ArgumentImpl *a: args)
+	{
+		string parg = format("<%s>", a->get_name());
+		pargs.push_back(parg);
+		maxw = max(maxw, parg.size());
+	}
+
+	string result;
+	result += "Options:\n";
+	auto j = switches.begin();
+	for(auto 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 += "\nArguments:\n";
+		j = pargs.begin();
+		for(auto 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::OptionImpl &GetOpt::OptionImpl::set_help(const string &h, const string &m)
 {
-	help=h;
+	help = h;
+	metavar = m;
 	return *this;
 }
 
-GetOpt::OptBase &GetOpt::OptBase::set_help(const string &h, const string &m)
+GetOpt::OptionImpl &GetOpt::OptionImpl::bind_seen_count(unsigned &c)
 {
-	help=h;
-	metavar=m;
+	ext_seen_count = &c;
 	return *this;
 }
 
-void GetOpt::OptBase::process()
+void GetOpt::OptionImpl::process()
 {
 	if(arg_type==REQUIRED_ARG)
-		throw UsageError("--"+lng+" requires an argument");
+		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 UsageError("--"+lng+" takes no argument");
+		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;
+}
+
+GetOpt::ArgumentImpl &GetOpt::ArgumentImpl::set_help(const string &h)
+{
+	help = h;
+	return *this;
+}
 
-	store(arg);
+void GetOpt::ArgumentImpl::process(const string &arg)
+{
+	try
+	{
+		store->store(arg);
+	}
+	catch(const exception &e)
+	{
+		throw usage_error("Invalid "+name+" ("+e.what()+")");
+	}
 }
 
 } // namespace Msp