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