1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/lemon/arg_parser.cc Sat Mar 03 12:05:05 2007 +0000
1.3 @@ -0,0 +1,379 @@
1.4 +/* -*- C++ -*-
1.5 + * lemon/main_params.h - Part of LEMON, a generic C++ optimization library
1.6 + *
1.7 + * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
1.8 + * (Egervary Research Group on Combinatorial Optimization, EGRES).
1.9 + *
1.10 + * Permission to use, modify and distribute this software is granted
1.11 + * provided that this copyright notice appears in all copies. For
1.12 + * precise terms see the accompanying LICENSE file.
1.13 + *
1.14 + * This software is provided "AS IS" with no warranty of any kind,
1.15 + * express or implied, and with no claim as to its suitability for any
1.16 + * purpose.
1.17 + *
1.18 + */
1.19 +
1.20 +#include <lemon/arg_parser.h>
1.21 +
1.22 +namespace lemon {
1.23 +
1.24 + void ArgParser::_showHelp(void *p)
1.25 + {
1.26 + ((ArgParser*)p)->showHelp();
1.27 + exit(1);
1.28 + }
1.29 +
1.30 + ArgParser::ArgParser(int argc, char **argv) :_argc(argc), _argv(argv),
1.31 + _command_name(argv[0]) {
1.32 + option("-help","Print a short help message",_showHelp,this);
1.33 + synonym("help","-help");
1.34 + synonym("h","-help");
1.35 +
1.36 + }
1.37 +
1.38 + ArgParser &ArgParser::option(const std::string &name,
1.39 + const std::string &help,
1.40 + int &value, bool obl)
1.41 + {
1.42 + ParData p;
1.43 + p.int_p=&value;
1.44 + p.help=help;
1.45 + p.type=INTEGER;
1.46 + p.mandatory=obl;
1.47 + _opts[name]=p;
1.48 + return *this;
1.49 + }
1.50 +
1.51 + ArgParser &ArgParser::option(const std::string &name,
1.52 + const std::string &help,
1.53 + double &value, bool obl)
1.54 + {
1.55 + ParData p;
1.56 + p.double_p=&value;
1.57 + p.help=help;
1.58 + p.type=DOUBLE;
1.59 + p.mandatory=obl;
1.60 + _opts[name]=p;
1.61 + return *this;
1.62 + }
1.63 +
1.64 + ArgParser &ArgParser::option(const std::string &name,
1.65 + const std::string &help,
1.66 + bool &value, bool obl)
1.67 + {
1.68 + ParData p;
1.69 + p.bool_p=&value;
1.70 + p.help=help;
1.71 + p.type=BOOL;
1.72 + p.mandatory=obl;
1.73 + _opts[name]=p;
1.74 +
1.75 + value = false;
1.76 +
1.77 + return *this;
1.78 + }
1.79 +
1.80 + ArgParser &ArgParser::option(const std::string &name,
1.81 + const std::string &help,
1.82 + std::string &value, bool obl)
1.83 + {
1.84 + ParData p;
1.85 + p.string_p=&value;
1.86 + p.help=help;
1.87 + p.type=STRING;
1.88 + p.mandatory=obl;
1.89 + _opts[name]=p;
1.90 + return *this;
1.91 + }
1.92 +
1.93 + ArgParser &ArgParser::option(const std::string &name,
1.94 + const std::string &help,
1.95 + void (*func)(void *),void *data)
1.96 + {
1.97 + ParData p;
1.98 + p.func_p.p=func;
1.99 + p.func_p.data=data;
1.100 + p.help=help;
1.101 + p.type=FUNC;
1.102 + p.mandatory=false;
1.103 + _opts[name]=p;
1.104 + return *this;
1.105 + }
1.106 + ArgParser &ArgParser::optionGroup(const std::string &group,
1.107 + const std::string &opt)
1.108 + {
1.109 + Opts::iterator i = _opts.find(opt);
1.110 + if(i==_opts.end()) exit(3); ///\todo throw exception instead
1.111 + else if(i->second.ingroup) exit(3); ///\todo throw exception instead
1.112 + else {
1.113 + GroupData &g=_groups[group];
1.114 + g.opts.push_back(opt);
1.115 + i->second.ingroup=true;
1.116 + }
1.117 + return *this;
1.118 + }
1.119 +
1.120 + ArgParser &ArgParser::onlyOneGroup(const std::string &group)
1.121 + {
1.122 + GroupData &g=_groups[group];
1.123 + g.only_one=true;
1.124 + return *this;
1.125 + }
1.126 +
1.127 + ArgParser &ArgParser::synonym(const std::string &syn,
1.128 + const std::string &opt)
1.129 + {
1.130 + Opts::iterator o = _opts.find(opt);
1.131 + Opts::iterator s = _opts.find(syn);
1.132 + if(o==_opts.end()||s!=_opts.end())
1.133 + exit(3); ///\todo throw exception instead
1.134 + else {
1.135 + ParData p;
1.136 + p.help=opt;
1.137 + p.mandatory=false;
1.138 + p.syn=true;
1.139 + _opts[syn]=p;
1.140 + o->second.has_syn=true;
1.141 + }
1.142 + return *this;
1.143 + }
1.144 +
1.145 + ArgParser &ArgParser::mandatoryGroup(const std::string &group)
1.146 + {
1.147 + GroupData &g=_groups[group];
1.148 + g.mandatory=true;
1.149 + return *this;
1.150 + }
1.151 +
1.152 + ArgParser &ArgParser::other(const std::string &name,
1.153 + const std::string &help)
1.154 + {
1.155 + _others_help.push_back(OtherArg(name,help));
1.156 + return *this;
1.157 + }
1.158 +
1.159 + void ArgParser::show(std::ostream &os,Opts::iterator i)
1.160 + {
1.161 + os << "-" << i->first;
1.162 + if(i->second.has_syn)
1.163 + for(Opts::iterator j=_opts.begin();j!=_opts.end();++j)
1.164 + if(j->second.syn&&j->second.help==i->first)
1.165 + os << "|-" << j->first;
1.166 + switch(i->second.type) {
1.167 + case STRING:
1.168 + os << " str";
1.169 + break;
1.170 + case INTEGER:
1.171 + os << " int";
1.172 + break;
1.173 + case DOUBLE:
1.174 + os << " num";
1.175 + break;
1.176 + default:
1.177 + break;
1.178 + }
1.179 + }
1.180 +
1.181 + void ArgParser::show(std::ostream &os,Groups::iterator i)
1.182 + {
1.183 + GroupData::Opts::iterator o=i->second.opts.begin();
1.184 + while(o!=i->second.opts.end()) {
1.185 + show(os,_opts.find(*o));
1.186 + ++o;
1.187 + if(o!=i->second.opts.end()) os<<'|';
1.188 + }
1.189 + }
1.190 +
1.191 + void ArgParser::showHelp(Opts::iterator i)
1.192 + {
1.193 + if(i->second.help.size()==0||i->second.syn) return;
1.194 + std::cerr << " ";
1.195 + show(std::cerr,i);
1.196 + std::cerr << std::endl;
1.197 + std::cerr << " " << i->second.help << std::endl;
1.198 + }
1.199 + void ArgParser::showHelp(std::vector<ArgParser::OtherArg>::iterator i)
1.200 + {
1.201 + if(i->help.size()==0) return;
1.202 + std::cerr << " " << i->name << std::endl
1.203 + << " " << i->help << std::endl;
1.204 + }
1.205 +
1.206 + void ArgParser::shortHelp()
1.207 + {
1.208 + const unsigned int LINE_LEN=77;
1.209 + const std::string indent(" ");
1.210 + std::cerr << "Usage:\n " << _command_name;
1.211 + int pos=_command_name.size()+2;
1.212 + for(Groups::iterator g=_groups.begin();g!=_groups.end();++g) {
1.213 + std::ostringstream cstr;
1.214 + cstr << ' ';
1.215 + if(!g->second.mandatory) cstr << '[';
1.216 + show(cstr,g);
1.217 + if(!g->second.mandatory) cstr << ']';
1.218 + if(pos+cstr.str().size()>LINE_LEN) {
1.219 + std::cerr << std::endl << indent;
1.220 + pos=indent.size();
1.221 + }
1.222 + std::cerr << cstr.str();
1.223 + pos+=cstr.str().size();
1.224 + }
1.225 + for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)
1.226 + if(!i->second.ingroup&&!i->second.syn) {
1.227 + std::ostringstream cstr;
1.228 + cstr << ' ';
1.229 + if(!i->second.mandatory) cstr << '[';
1.230 + show(cstr,i);
1.231 + if(!i->second.mandatory) cstr << ']';
1.232 + if(pos+cstr.str().size()>LINE_LEN) {
1.233 + std::cerr << std::endl << indent;
1.234 + pos=indent.size();
1.235 + }
1.236 + std::cerr << cstr.str();
1.237 + pos+=cstr.str().size();
1.238 + }
1.239 + for(std::vector<OtherArg>::iterator i=_others_help.begin();
1.240 + i!=_others_help.end();++i)
1.241 + {
1.242 + std::ostringstream cstr;
1.243 + cstr << ' ' << i->name;
1.244 +
1.245 + if(pos+cstr.str().size()>LINE_LEN) {
1.246 + std::cerr << std::endl << indent;
1.247 + pos=indent.size();
1.248 + }
1.249 + std::cerr << cstr.str();
1.250 + pos+=cstr.str().size();
1.251 + }
1.252 + std::cerr << std::endl;
1.253 + }
1.254 +
1.255 + void ArgParser::showHelp()
1.256 + {
1.257 + shortHelp();
1.258 + std::cerr << "Where:\n";
1.259 + for(std::vector<OtherArg>::iterator i=_others_help.begin();
1.260 + i!=_others_help.end();++i) showHelp(i);
1.261 + for(Opts::iterator i=_opts.begin();i!=_opts.end();++i) showHelp(i);
1.262 + exit(1);
1.263 + }
1.264 +
1.265 +
1.266 + void ArgParser::unknownOpt(std::string arg)
1.267 + {
1.268 + std::cerr << "\nUnknown option: " << arg << "\n";
1.269 + std::cerr << "\nType '" << _command_name <<
1.270 + " --help' to obtain a short summary on the usage.\n\n";
1.271 + exit(1);
1.272 + }
1.273 +
1.274 + void ArgParser::requiresValue(std::string arg, OptType t)
1.275 + {
1.276 + std::cerr << "Argument '" << arg << "' requires a";
1.277 + switch(t) {
1.278 + case STRING:
1.279 + std::cerr << " string";
1.280 + break;
1.281 + case INTEGER:
1.282 + std::cerr << "n integer";
1.283 + break;
1.284 + case DOUBLE:
1.285 + std::cerr << " floating point";
1.286 + break;
1.287 + default:
1.288 + break;
1.289 + }
1.290 + std::cerr << " value\n\n";
1.291 + showHelp();
1.292 + }
1.293 +
1.294 +
1.295 + void ArgParser::checkMandatories()
1.296 + {
1.297 + bool ok=true;
1.298 + for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)
1.299 + if(i->second.mandatory&&!i->second.set)
1.300 + {
1.301 + if(ok)
1.302 + std::cerr << _command_name
1.303 + << ": The following mandatory arguments are missing.\n";
1.304 + ok=false;
1.305 + showHelp(i);
1.306 + }
1.307 + for(Groups::iterator i=_groups.begin();i!=_groups.end();++i)
1.308 + if(i->second.mandatory||i->second.only_one)
1.309 + {
1.310 + int set=0;
1.311 + for(GroupData::Opts::iterator o=i->second.opts.begin();
1.312 + o!=i->second.opts.end();++o)
1.313 + if(_opts.find(*o)->second.set) ++set;
1.314 + if(i->second.mandatory&&!set) {
1.315 + std::cerr << _command_name
1.316 + << ": At least one of the following arguments is mandatory.\n";
1.317 + ok=false;
1.318 + for(GroupData::Opts::iterator o=i->second.opts.begin();
1.319 + o!=i->second.opts.end();++o)
1.320 + showHelp(_opts.find(*o));
1.321 + }
1.322 + if(i->second.only_one&&set>1) {
1.323 + std::cerr << _command_name
1.324 + << ": At most one of the following arguments can be given.\n";
1.325 + ok=false;
1.326 + for(GroupData::Opts::iterator o=i->second.opts.begin();
1.327 + o!=i->second.opts.end();++o)
1.328 + showHelp(_opts.find(*o));
1.329 + }
1.330 + }
1.331 + if(!ok) {
1.332 + std::cerr << "\nType '" << _command_name <<
1.333 + " --help' to obtain a short summary on the usage.\n\n";
1.334 + exit(1);
1.335 + }
1.336 + }
1.337 +
1.338 + ArgParser &ArgParser::parse()
1.339 + {
1.340 + for(int ar=1; ar<_argc; ++ar) {
1.341 + std::string arg(_argv[ar]);
1.342 + if (arg[0] != '-' || arg.size() == 1) {
1.343 + _file_args.push_back(arg);
1.344 + }
1.345 + else {
1.346 + Opts::iterator i = _opts.find(arg.substr(1));
1.347 + if(i==_opts.end()) unknownOpt(arg);
1.348 + else {
1.349 + if(i->second.syn) i=_opts.find(i->second.help);
1.350 + ParData &p(i->second);
1.351 + if (p.type==BOOL) *p.bool_p=true;
1.352 + else if (p.type==FUNC) p.func_p.p(p.func_p.data);
1.353 + else if(++ar==_argc) requiresValue(arg, p.type);
1.354 + else {
1.355 + std::string val(_argv[ar]);
1.356 + std::istringstream vals(val);
1.357 + switch(p.type) {
1.358 + case STRING:
1.359 + *p.string_p=val;
1.360 + break;
1.361 + case INTEGER:
1.362 + vals >> *p.int_p;
1.363 + break;
1.364 + case DOUBLE:
1.365 + vals >> *p.double_p;
1.366 + break;
1.367 + default:
1.368 + break;
1.369 + }
1.370 + if(p.type!=STRING&&(!vals||!vals.eof()))
1.371 + requiresValue(arg, p.type);
1.372 + }
1.373 + p.set = true;
1.374 + }
1.375 + }
1.376 + }
1.377 + checkMandatories();
1.378 +
1.379 + return *this;
1.380 + }
1.381 +
1.382 +}