lemon-1.1: lemon/arg_parser.cc@7b0ce9fb1169

     1 /* -*- C++ -*-

     2  *

     3  * This file is a part of LEMON, a generic C++ optimization library

     4  *

     5  * Copyright (C) 2003-2008

     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).

     8  *

     9  * Permission to use, modify and distribute this software is granted

    10  * provided that this copyright notice appears in all copies. For

    11  * precise terms see the accompanying LICENSE file.

    12  *

    13  * This software is provided "AS IS" with no warranty of any kind,

    14  * express or implied, and with no claim as to its suitability for any

    15  * purpose.

    16  *

    17  */

    19 #include <lemon/arg_parser.h>

    21 namespace lemon {

    23   void ArgParser::_showHelp(void *p)

    24   {

    25     (static_cast<ArgParser*>(p))->showHelp();

    26     exit(1);

    27   }

    29   ArgParser::ArgParser(int argc, const char **argv) :_argc(argc), _argv(argv),

    30                                                      _command_name(argv[0]) {

    31     funcOption("-help","Print a short help message",_showHelp,this);

    32     synonym("help","-help");

    33     synonym("h","-help");

    35   }

    37   ArgParser::~ArgParser()

    38   {

    39     for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)

    40       if(i->second.self_delete)

    41 	switch(i->second.type) {

    42 	case BOOL:

    43 	  delete i->second.bool_p;

    44 	  break;

    45 	case STRING:

    46 	  delete i->second.string_p;

    47 	  break;

    48 	case DOUBLE:

    49 	  delete i->second.double_p;

    50 	  break;

    51 	case INTEGER:

    52 	  delete i->second.int_p;

    53 	  break;

    54 	case UNKNOWN:

    55 	  break;

    56 	case FUNC:

    57 	  break;

    58 	}

    59   }

    62   ArgParser &ArgParser::intOption(const std::string &name,

    63 			       const std::string &help,

    64 			       int value, bool obl)

    65   {

    66     ParData p;

    67     p.int_p=new int(value);

    68     p.self_delete=true;

    69     p.help=help;

    70     p.type=INTEGER;

    71     p.mandatory=obl;

    72     _opts[name]=p;

    73     return *this;

    74   }

    76   ArgParser &ArgParser::doubleOption(const std::string &name,

    77 			       const std::string &help,

    78 			       double value, bool obl)

    79   {

    80     ParData p;

    81     p.double_p=new double(value);

    82     p.self_delete=true;

    83     p.help=help;

    84     p.type=DOUBLE;

    85     p.mandatory=obl;

    86     _opts[name]=p;

    87     return *this;

    88   }

    90   ArgParser &ArgParser::boolOption(const std::string &name,

    91 			       const std::string &help,

    92 			       bool value, bool obl)

    93   {

    94     ParData p;

    95     p.bool_p=new bool(value);

    96     p.self_delete=true;

    97     p.help=help;

    98     p.type=BOOL;

    99     p.mandatory=obl;

   100     _opts[name]=p;

   101     return *this;

   102   }

   104   ArgParser &ArgParser::stringOption(const std::string &name,

   105 			       const std::string &help,

   106 			       std::string value, bool obl)

   107   {

   108     ParData p;

   109     p.string_p=new std::string(value);

   110     p.self_delete=true;

   111     p.help=help;

   112     p.type=STRING;

   113     p.mandatory=obl;

   114     _opts[name]=p;

   115     return *this;

   116   }

   118   ArgParser &ArgParser::refOption(const std::string &name,

   119 			       const std::string &help,

   120 			       int &ref, bool obl)

   121   {

   122     ParData p;

   123     p.int_p=&ref;

   124     p.self_delete=false;

   125     p.help=help;

   126     p.type=INTEGER;

   127     p.mandatory=obl;

   128     _opts[name]=p;

   129     return *this;

   130   }

   132   ArgParser &ArgParser::refOption(const std::string &name,

   133                                   const std::string &help,

   134                                   double &ref, bool obl)

   135   {

   136     ParData p;

   137     p.double_p=&ref;

   138     p.self_delete=false;

   139     p.help=help;

   140     p.type=DOUBLE;

   141     p.mandatory=obl;

   142     _opts[name]=p;

   143     return *this;

   144   }

   146   ArgParser &ArgParser::refOption(const std::string &name,

   147                                   const std::string &help,

   148                                   bool &ref, bool obl)

   149   {

   150     ParData p;

   151     p.bool_p=&ref;

   152     p.self_delete=false;

   153     p.help=help;

   154     p.type=BOOL;

   155     p.mandatory=obl;

   156     _opts[name]=p;

   158     ref = false;

   160     return *this;

   161   }

   163   ArgParser &ArgParser::refOption(const std::string &name,

   164 			       const std::string &help,

   165 			       std::string &ref, bool obl)

   166   {

   167     ParData p;

   168     p.string_p=&ref;

   169     p.self_delete=false;

   170     p.help=help;

   171     p.type=STRING;

   172     p.mandatory=obl;

   173     _opts[name]=p;

   174     return *this;

   175   }

   177   ArgParser &ArgParser::funcOption(const std::string &name,

   178 			       const std::string &help,

   179 			       void (*func)(void *),void *data)

   180   {

   181     ParData p;

   182     p.func_p.p=func;

   183     p.func_p.data=data;

   184     p.self_delete=false;

   185     p.help=help;

   186     p.type=FUNC;

   187     p.mandatory=false;

   188     _opts[name]=p;

   189     return *this;

   190   }

   192   ArgParser &ArgParser::optionGroup(const std::string &group,

   193 				    const std::string &opt)

   194   {

   195     Opts::iterator i = _opts.find(opt);

   196     LEMON_ASSERT(i!=_opts.end(), "Unknown option: '"+opt+"'");

   197     LEMON_ASSERT(!(i->second.ingroup),

   198                  "Option already in option group: '"+opt+"'");

   199     GroupData &g=_groups[group];

   200     g.opts.push_back(opt);

   201     i->second.ingroup=true;

   202     return *this;

   203   }

   205   ArgParser &ArgParser::onlyOneGroup(const std::string &group)

   206   {

   207     GroupData &g=_groups[group];

   208     g.only_one=true;

   209     return *this;

   210   }

   212   ArgParser &ArgParser::synonym(const std::string &syn,

   213 				const std::string &opt)

   214   {

   215     Opts::iterator o = _opts.find(opt);

   216     Opts::iterator s = _opts.find(syn);

   217     LEMON_ASSERT(o!=_opts.end(), "Unknown option: '"+opt+"'");

   218     LEMON_ASSERT(s==_opts.end(), "Option already used: '"+syn+"'");

   219     ParData p;

   220     p.help=opt;

   221     p.mandatory=false;

   222     p.syn=true;

   223     _opts[syn]=p;

   224     o->second.has_syn=true;

   225     return *this;

   226   }

   228   ArgParser &ArgParser::mandatoryGroup(const std::string &group)

   229   {

   230     GroupData &g=_groups[group];

   231     g.mandatory=true;

   232     return *this;

   233   }

   235   ArgParser &ArgParser::other(const std::string &name,

   236 			      const std::string &help)

   237   {

   238     _others_help.push_back(OtherArg(name,help));

   239     return *this;

   240   }

   242   void ArgParser::show(std::ostream &os,Opts::iterator i)

   243   {

   244     os << "-" << i->first;

   245     if(i->second.has_syn)

   246       for(Opts::iterator j=_opts.begin();j!=_opts.end();++j)

   247 	if(j->second.syn&&j->second.help==i->first)

   248 	  os << "|-" << j->first;

   249     switch(i->second.type) {

   250     case STRING:

   251       os << " str";

   252       break;

   253     case INTEGER:

   254       os << " int";

   255       break;

   256     case DOUBLE:

   257       os << " num";

   258       break;

   259     default:

   260       break;

   261     }

   262   }

   264   void ArgParser::show(std::ostream &os,Groups::iterator i)

   265   {

   266     GroupData::Opts::iterator o=i->second.opts.begin();

   267     while(o!=i->second.opts.end()) {

   268       show(os,_opts.find(*o));

   269       ++o;

   270       if(o!=i->second.opts.end()) os<<'|';

   271     }

   272   }

   274   void ArgParser::showHelp(Opts::iterator i)

   275   {

   276     if(i->second.help.size()==0||i->second.syn) return;

   277     std::cerr << "  ";

   278     show(std::cerr,i);

   279     std::cerr << std::endl;

   280     std::cerr << "     " << i->second.help << std::endl;

   281   }

   282   void ArgParser::showHelp(std::vector<ArgParser::OtherArg>::iterator i)

   283   {

   284     if(i->help.size()==0) return;

   285     std::cerr << "  " << i->name << std::endl

   286 	      << "     " << i->help << std::endl;

   287   }

   289   void ArgParser::shortHelp()

   290   {

   291     const unsigned int LINE_LEN=77;

   292     const std::string indent("    ");

   293     std::cerr << "Usage:\n  " << _command_name;

   294     int pos=_command_name.size()+2;

   295     for(Groups::iterator g=_groups.begin();g!=_groups.end();++g) {

   296       std::ostringstream cstr;

   297       cstr << ' ';

   298       if(!g->second.mandatory) cstr << '[';

   299       show(cstr,g);

   300       if(!g->second.mandatory) cstr << ']';

   301       if(pos+cstr.str().size()>LINE_LEN) {

   302 	std::cerr << std::endl << indent;

   303 	pos=indent.size();

   304       }

   305       std::cerr << cstr.str();

   306       pos+=cstr.str().size();

   307     }

   308     for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)

   309       if(!i->second.ingroup&&!i->second.syn) {

   310 	std::ostringstream cstr;

   311 	cstr << ' ';

   312 	if(!i->second.mandatory) cstr << '[';

   313 	show(cstr,i);

   314 	if(!i->second.mandatory) cstr << ']';

   315 	if(pos+cstr.str().size()>LINE_LEN) {

   316 	  std::cerr << std::endl << indent;

   317 	  pos=indent.size();

   318 	}

   319 	std::cerr << cstr.str();

   320 	pos+=cstr.str().size();

   321       }

   322     for(std::vector<OtherArg>::iterator i=_others_help.begin();

   323 	i!=_others_help.end();++i)

   324       {

   325 	std::ostringstream cstr;

   326 	cstr << ' ' << i->name;

   328 	if(pos+cstr.str().size()>LINE_LEN) {

   329 	  std::cerr << std::endl << indent;

   330 	  pos=indent.size();

   331 	}

   332 	std::cerr << cstr.str();

   333 	pos+=cstr.str().size();

   334       }

   335     std::cerr << std::endl;

   336   }

   338   void ArgParser::showHelp()

   339   {

   340     shortHelp();

   341     std::cerr << "Where:\n";

   342     for(std::vector<OtherArg>::iterator i=_others_help.begin();

   343 	i!=_others_help.end();++i) showHelp(i);

   344     for(Opts::iterator i=_opts.begin();i!=_opts.end();++i) showHelp(i);

   345     exit(1);

   346   }

   349   void ArgParser::unknownOpt(std::string arg)

   350   {

   351     std::cerr << "\nUnknown option: " << arg << "\n";

   352     std::cerr << "\nType '" << _command_name <<

   353       " --help' to obtain a short summary on the usage.\n\n";

   354     exit(1);

   355   }

   357   void ArgParser::requiresValue(std::string arg, OptType t)

   358   {

   359     std::cerr << "Argument '" << arg << "' requires a";

   360     switch(t) {

   361     case STRING:

   362       std::cerr << " string";

   363       break;

   364     case INTEGER:

   365       std::cerr << "n integer";

   366       break;

   367     case DOUBLE:

   368       std::cerr << " floating point";

   369       break;

   370     default:

   371       break;

   372     }

   373     std::cerr << " value\n\n";

   374     showHelp();

   375   }

   378   void ArgParser::checkMandatories()

   379   {

   380     bool ok=true;

   381     for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)

   382       if(i->second.mandatory&&!i->second.set)

   383 	{

   384 	  if(ok)

   385 	    std::cerr << _command_name

   386 		      << ": The following mandatory arguments are missing.\n";

   387 	  ok=false;

   388 	  showHelp(i);

   389 	}

   390     for(Groups::iterator i=_groups.begin();i!=_groups.end();++i)

   391       if(i->second.mandatory||i->second.only_one)

   392 	{

   393 	  int set=0;

   394 	  for(GroupData::Opts::iterator o=i->second.opts.begin();

   395 	      o!=i->second.opts.end();++o)

   396 	    if(_opts.find(*o)->second.set) ++set;

   397 	  if(i->second.mandatory&&!set) {

   398 	    std::cerr << _command_name

   399 		      << ": At least one of the following arguments is mandatory.\n";

   400 	    ok=false;

   401 	    for(GroupData::Opts::iterator o=i->second.opts.begin();

   402 		o!=i->second.opts.end();++o)

   403 	      showHelp(_opts.find(*o));

   404 	  }

   405 	  if(i->second.only_one&&set>1) {

   406 	    std::cerr << _command_name

   407 		      << ": At most one of the following arguments can be given.\n";

   408 	    ok=false;

   409 	    for(GroupData::Opts::iterator o=i->second.opts.begin();

   410 		o!=i->second.opts.end();++o)

   411 	      showHelp(_opts.find(*o));

   412 	  }

   413 	}

   414     if(!ok) {

   415       std::cerr << "\nType '" << _command_name <<

   416 	" --help' to obtain a short summary on the usage.\n\n";

   417       exit(1);

   418     }

   419   }

   421   ArgParser &ArgParser::parse()

   422   {

   423     for(int ar=1; ar<_argc; ++ar) {

   424       std::string arg(_argv[ar]);

   425       if (arg[0] != '-' || arg.size() == 1) {

   426 	_file_args.push_back(arg);

   427       }

   428       else {

   429 	Opts::iterator i = _opts.find(arg.substr(1));

   430 	if(i==_opts.end()) unknownOpt(arg);

   431 	else {

   432 	  if(i->second.syn) i=_opts.find(i->second.help);

   433 	  ParData &p(i->second);

   434 	  if (p.type==BOOL) *p.bool_p=true;

   435 	  else if (p.type==FUNC) p.func_p.p(p.func_p.data);

   436 	  else if(++ar==_argc) requiresValue(arg, p.type);

   437 	  else {

   438 	    std::string val(_argv[ar]);

   439 	    std::istringstream vals(val);

   440 	    switch(p.type) {

   441 	    case STRING:

   442 	      *p.string_p=val;

   443 	      break;

   444 	    case INTEGER:

   445 	      vals >> *p.int_p;

   446 	      break;

   447 	    case DOUBLE:

   448 	      vals >> *p.double_p;

   449 	      break;

   450 	    default:

   451 	      break;

   452 	    }

   453 	    if(p.type!=STRING&&(!vals||!vals.eof()))

   454 	      requiresValue(arg, p.type);

   455 	  }

   456 	  p.set = true;

   457 	}

   458       }

   459     }

   460     checkMandatories();

   462     return *this;

   463   }

   465 }

author	Alpar Juttner <alpar@cs.elte.hu>
	Wed, 09 Apr 2008 17:19:40 +0100
changeset 117	7b0ce9fb1169
parent 85	3453d20a82cd
child 128	7cd965d2257f
permissions	-rw-r--r--