]> git.tdb.fi Git - libs/core.git/blobdiff - source/core/getopt.cpp
Cosmetic fixes for comments and output
[libs/core.git] / source / core / getopt.cpp
index 911b673d9b1d28358966a302de44aaf6428735e3..e42ceb2143fb28265277c534af6c536878f16a03 100644 (file)
@@ -13,15 +13,22 @@ 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::OptBase &GetOpt::add_option(OptBase *opt)
+GetOpt::OptionImpl &GetOpt::add_option(char s, const string &l, const Store &t, ArgType a)
 {
-       for(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); )
+       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((*i)->get_short()==opt->get_short() || (*i)->get_long()==opt->get_long())
+               if((s!=0 && (*i)->get_short()==s) || (*i)->get_long()==l)
                {
                        delete *i;
                        opts.erase(i++);
@@ -30,21 +37,45 @@ GetOpt::OptBase &GetOpt::add_option(OptBase *opt)
                        ++i;
        }
 
-       opts.push_back(opt);
+       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)
+{
+       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(list<OptBase *>::iterator i=opts.begin(); i!=opts.end(); ++i)
+       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);
@@ -54,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;)
                {
@@ -70,11 +103,37 @@ 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)
        {
@@ -82,7 +141,7 @@ void GetOpt::operator()(unsigned argc, const char *const *argv)
        }
 
        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])+"\n\n"+generate_help());
 }
 
 unsigned GetOpt::process_long(const char *const *argp)
@@ -94,7 +153,7 @@ unsigned GetOpt::process_long(const char *const *argp)
        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
@@ -122,7 +181,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)
                {
@@ -149,7 +208,7 @@ unsigned GetOpt::process_short(const char *const *argp)
 string GetOpt::generate_usage(const string &argv0) const
 {
        string result = argv0;
-       for(list<OptBase *>::const_iterator i=opts.begin(); i!=opts.end(); ++i)
+       for(OptionList::const_iterator i=opts.begin(); i!=opts.end(); ++i)
        {
                result += " [";
                if((*i)->get_short())
@@ -174,18 +233,30 @@ string GetOpt::generate_usage(const string &argv0) const
                result += ']';
        }
 
+       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)
        {
                string swtch;
                if((*i)->get_short())
@@ -213,55 +284,131 @@ string GetOpt::generate_help() const
                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 += "\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 std::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::OptionImpl::~OptionImpl()
 {
-       if(lng.empty())
-               throw invalid_argument("empty long option name");
+       delete store;
 }
 
-GetOpt::OptBase &GetOpt::OptBase::set_help(const string &h)
+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()+")");
+       }
+}
+
 
-       store(arg);
+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;
+}
+
+void GetOpt::ArgumentImpl::process(const string &arg)
+{
+       try
+       {
+               store->store(arg);
+       }
+       catch(const exception &e)
+       {
+               throw usage_error("Invalid "+name+" ("+e.what()+")");
+       }
 }
 
 } // namespace Msp