arg_parser.h: A command line argument parser.
dist_log.h: A tool for measuring one and two dimensional distributions.
2 * lemon/main_params.h - Part of LEMON, a generic C++ optimization library
4 * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
5 * (Egervary Research Group on Combinatorial Optimization, EGRES).
7 * Permission to use, modify and distribute this software is granted
8 * provided that this copyright notice appears in all copies. For
9 * precise terms see the accompanying LICENSE file.
11 * This software is provided "AS IS" with no warranty of any kind,
12 * express or implied, and with no claim as to its suitability for any
17 #include <lemon/arg_parser.h>
21 void ArgParser::_showHelp(void *p)
23 ((ArgParser*)p)->showHelp();
27 ArgParser::ArgParser(int argc, char **argv) :_argc(argc), _argv(argv),
28 _command_name(argv[0]) {
29 option("-help","Print a short help message",_showHelp,this);
30 synonym("help","-help");
35 ArgParser &ArgParser::option(const std::string &name,
36 const std::string &help,
48 ArgParser &ArgParser::option(const std::string &name,
49 const std::string &help,
50 double &value, bool obl)
61 ArgParser &ArgParser::option(const std::string &name,
62 const std::string &help,
63 bool &value, bool obl)
77 ArgParser &ArgParser::option(const std::string &name,
78 const std::string &help,
79 std::string &value, bool obl)
90 ArgParser &ArgParser::option(const std::string &name,
91 const std::string &help,
92 void (*func)(void *),void *data)
103 ArgParser &ArgParser::optionGroup(const std::string &group,
104 const std::string &opt)
106 Opts::iterator i = _opts.find(opt);
107 if(i==_opts.end()) exit(3); ///\todo throw exception instead
108 else if(i->second.ingroup) exit(3); ///\todo throw exception instead
110 GroupData &g=_groups[group];
111 g.opts.push_back(opt);
112 i->second.ingroup=true;
117 ArgParser &ArgParser::onlyOneGroup(const std::string &group)
119 GroupData &g=_groups[group];
124 ArgParser &ArgParser::synonym(const std::string &syn,
125 const std::string &opt)
127 Opts::iterator o = _opts.find(opt);
128 Opts::iterator s = _opts.find(syn);
129 if(o==_opts.end()||s!=_opts.end())
130 exit(3); ///\todo throw exception instead
137 o->second.has_syn=true;
142 ArgParser &ArgParser::mandatoryGroup(const std::string &group)
144 GroupData &g=_groups[group];
149 ArgParser &ArgParser::other(const std::string &name,
150 const std::string &help)
152 _others_help.push_back(OtherArg(name,help));
156 void ArgParser::show(std::ostream &os,Opts::iterator i)
158 os << "-" << i->first;
159 if(i->second.has_syn)
160 for(Opts::iterator j=_opts.begin();j!=_opts.end();++j)
161 if(j->second.syn&&j->second.help==i->first)
162 os << "|-" << j->first;
163 switch(i->second.type) {
178 void ArgParser::show(std::ostream &os,Groups::iterator i)
180 GroupData::Opts::iterator o=i->second.opts.begin();
181 while(o!=i->second.opts.end()) {
182 show(os,_opts.find(*o));
184 if(o!=i->second.opts.end()) os<<'|';
188 void ArgParser::showHelp(Opts::iterator i)
190 if(i->second.help.size()==0||i->second.syn) return;
193 std::cerr << std::endl;
194 std::cerr << " " << i->second.help << std::endl;
196 void ArgParser::showHelp(std::vector<ArgParser::OtherArg>::iterator i)
198 if(i->help.size()==0) return;
199 std::cerr << " " << i->name << std::endl
200 << " " << i->help << std::endl;
203 void ArgParser::shortHelp()
205 const unsigned int LINE_LEN=77;
206 const std::string indent(" ");
207 std::cerr << "Usage:\n " << _command_name;
208 int pos=_command_name.size()+2;
209 for(Groups::iterator g=_groups.begin();g!=_groups.end();++g) {
210 std::ostringstream cstr;
212 if(!g->second.mandatory) cstr << '[';
214 if(!g->second.mandatory) cstr << ']';
215 if(pos+cstr.str().size()>LINE_LEN) {
216 std::cerr << std::endl << indent;
219 std::cerr << cstr.str();
220 pos+=cstr.str().size();
222 for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)
223 if(!i->second.ingroup&&!i->second.syn) {
224 std::ostringstream cstr;
226 if(!i->second.mandatory) cstr << '[';
228 if(!i->second.mandatory) cstr << ']';
229 if(pos+cstr.str().size()>LINE_LEN) {
230 std::cerr << std::endl << indent;
233 std::cerr << cstr.str();
234 pos+=cstr.str().size();
236 for(std::vector<OtherArg>::iterator i=_others_help.begin();
237 i!=_others_help.end();++i)
239 std::ostringstream cstr;
240 cstr << ' ' << i->name;
242 if(pos+cstr.str().size()>LINE_LEN) {
243 std::cerr << std::endl << indent;
246 std::cerr << cstr.str();
247 pos+=cstr.str().size();
249 std::cerr << std::endl;
252 void ArgParser::showHelp()
255 std::cerr << "Where:\n";
256 for(std::vector<OtherArg>::iterator i=_others_help.begin();
257 i!=_others_help.end();++i) showHelp(i);
258 for(Opts::iterator i=_opts.begin();i!=_opts.end();++i) showHelp(i);
263 void ArgParser::unknownOpt(std::string arg)
265 std::cerr << "\nUnknown option: " << arg << "\n";
266 std::cerr << "\nType '" << _command_name <<
267 " --help' to obtain a short summary on the usage.\n\n";
271 void ArgParser::requiresValue(std::string arg, OptType t)
273 std::cerr << "Argument '" << arg << "' requires a";
276 std::cerr << " string";
279 std::cerr << "n integer";
282 std::cerr << " floating point";
287 std::cerr << " value\n\n";
292 void ArgParser::checkMandatories()
295 for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)
296 if(i->second.mandatory&&!i->second.set)
299 std::cerr << _command_name
300 << ": The following mandatory arguments are missing.\n";
304 for(Groups::iterator i=_groups.begin();i!=_groups.end();++i)
305 if(i->second.mandatory||i->second.only_one)
308 for(GroupData::Opts::iterator o=i->second.opts.begin();
309 o!=i->second.opts.end();++o)
310 if(_opts.find(*o)->second.set) ++set;
311 if(i->second.mandatory&&!set) {
312 std::cerr << _command_name
313 << ": At least one of the following arguments is mandatory.\n";
315 for(GroupData::Opts::iterator o=i->second.opts.begin();
316 o!=i->second.opts.end();++o)
317 showHelp(_opts.find(*o));
319 if(i->second.only_one&&set>1) {
320 std::cerr << _command_name
321 << ": At most one of the following arguments can be given.\n";
323 for(GroupData::Opts::iterator o=i->second.opts.begin();
324 o!=i->second.opts.end();++o)
325 showHelp(_opts.find(*o));
329 std::cerr << "\nType '" << _command_name <<
330 " --help' to obtain a short summary on the usage.\n\n";
335 ArgParser &ArgParser::parse()
337 for(int ar=1; ar<_argc; ++ar) {
338 std::string arg(_argv[ar]);
339 if (arg[0] != '-' || arg.size() == 1) {
340 _file_args.push_back(arg);
343 Opts::iterator i = _opts.find(arg.substr(1));
344 if(i==_opts.end()) unknownOpt(arg);
346 if(i->second.syn) i=_opts.find(i->second.help);
347 ParData &p(i->second);
348 if (p.type==BOOL) *p.bool_p=true;
349 else if (p.type==FUNC) p.func_p.p(p.func_p.data);
350 else if(++ar==_argc) requiresValue(arg, p.type);
352 std::string val(_argv[ar]);
353 std::istringstream vals(val);
367 if(p.type!=STRING&&(!vals||!vals.eof()))
368 requiresValue(arg, p.type);