COIN-OR::LEMON - Graph Library

source: lemon-0.x/lemon/arg_parser.cc @ 2409:fe0a8fe16271

Last change on this file since 2409:fe0a8fe16271 was 2406:0ffc78641b34, checked in by Alpar Juttner, 13 years ago

Better doc.

File size: 10.9 KB
Line 
1/* -*- C++ -*-
2 *
3 * This file is a part of LEMON, a generic C++ optimization library
4 *
5 * Copyright (C) 2003-2007
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 */
18
19#include <lemon/arg_parser.h>
20
21namespace lemon {
22
23  void ArgParser::_showHelp(void *p)
24  {
25    (static_cast<ArgParser*>(p))->showHelp();
26    exit(1);
27  }
28
29  ArgParser::ArgParser(int argc, 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");
34
35  }
36
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  }
60 
61
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    p.self_delete=true;
73    _opts[name]=p;
74    return *this;
75  }
76
77  ArgParser &ArgParser::doubleOption(const std::string &name,
78                               const std::string &help,
79                               double value, bool obl)
80  {
81    ParData p;
82    p.double_p=new double(value);
83    p.self_delete=true;
84    p.help=help;
85    p.type=DOUBLE;
86    p.mandatory=obl;
87    _opts[name]=p;
88    return *this;
89  }
90
91  ArgParser &ArgParser::boolOption(const std::string &name,
92                               const std::string &help,
93                               bool value, bool obl)
94  {
95    ParData p;
96    p.bool_p=new bool(value);
97    p.self_delete=true;
98    p.help=help;
99    p.type=BOOL;
100    p.mandatory=obl;
101    _opts[name]=p;
102
103    value = false;
104
105    return *this;
106  }
107
108  ArgParser &ArgParser::stringOption(const std::string &name,
109                               const std::string &help,
110                               std::string value, bool obl)
111  {
112    ParData p;
113    p.string_p=new std::string(value);
114    p.self_delete=true;
115    p.help=help;
116    p.type=STRING;
117    p.mandatory=obl;
118    _opts[name]=p;
119    return *this;
120  }
121
122  ArgParser &ArgParser::refOption(const std::string &name,
123                               const std::string &help,
124                               int &ref, bool obl)
125  {
126    ParData p;
127    p.int_p=&ref;
128    p.self_delete=false;
129    p.help=help;
130    p.type=INTEGER;
131    p.mandatory=obl;
132    _opts[name]=p;
133    return *this;
134  }
135
136  ArgParser &ArgParser::refOption(const std::string &name,
137                               const std::string &help,
138                               double &ref, bool obl)
139  {
140    ParData p;
141    p.double_p=&ref;
142    p.self_delete=false;
143    p.help=help;
144    p.type=DOUBLE;
145    p.mandatory=obl;
146    _opts[name]=p;
147    return *this;
148  }
149
150  ArgParser &ArgParser::refOption(const std::string &name,
151                               const std::string &help,
152                               bool &ref, bool obl)
153  {
154    ParData p;
155    p.bool_p=&ref;
156    p.self_delete=false;
157    p.help=help;
158    p.type=BOOL;
159    p.mandatory=obl;
160    _opts[name]=p;
161
162    ref = false;
163
164    return *this;
165  }
166
167  ArgParser &ArgParser::refOption(const std::string &name,
168                               const std::string &help,
169                               std::string &ref, bool obl)
170  {
171    ParData p;
172    p.string_p=&ref;
173    p.self_delete=false;
174    p.help=help;
175    p.type=STRING;
176    p.mandatory=obl;
177    _opts[name]=p;
178    return *this;
179  }
180
181  ArgParser &ArgParser::funcOption(const std::string &name,
182                               const std::string &help,
183                               void (*func)(void *),void *data)
184  {
185    ParData p;
186    p.func_p.p=func;
187    p.func_p.data=data;
188    p.self_delete=false;
189    p.help=help;
190    p.type=FUNC;
191    p.mandatory=false;
192    _opts[name]=p;
193    return *this;
194  }
195
196  ArgParser &ArgParser::optionGroup(const std::string &group,
197                                    const std::string &opt)
198  {
199    Opts::iterator i = _opts.find(opt);
200    if(i==_opts.end()) throw LogicError();
201    else if(i->second.ingroup) throw LogicError();
202    else {
203      GroupData &g=_groups[group];
204      g.opts.push_back(opt);
205      i->second.ingroup=true;
206    }
207    return *this;
208  }
209
210  ArgParser &ArgParser::onlyOneGroup(const std::string &group)
211  {
212    GroupData &g=_groups[group];
213    g.only_one=true;
214    return *this;
215  }
216
217  ArgParser &ArgParser::synonym(const std::string &syn,
218                                const std::string &opt)
219  {
220    Opts::iterator o = _opts.find(opt);
221    Opts::iterator s = _opts.find(syn);
222    if(o==_opts.end()||s!=_opts.end())
223      throw LogicError();
224    else {
225      ParData p;
226      p.help=opt;
227      p.mandatory=false;
228      p.syn=true;
229      _opts[syn]=p;
230      o->second.has_syn=true;
231    }
232    return *this;
233  }
234
235  ArgParser &ArgParser::mandatoryGroup(const std::string &group)
236  {
237    GroupData &g=_groups[group];
238    g.mandatory=true;
239    return *this;
240  }
241
242  ArgParser &ArgParser::other(const std::string &name,
243                              const std::string &help)
244  {
245    _others_help.push_back(OtherArg(name,help));
246    return *this;
247  }
248
249  void ArgParser::show(std::ostream &os,Opts::iterator i)
250  {
251    os << "-" << i->first;
252    if(i->second.has_syn)
253      for(Opts::iterator j=_opts.begin();j!=_opts.end();++j)
254        if(j->second.syn&&j->second.help==i->first)
255          os << "|-" << j->first;
256    switch(i->second.type) {
257    case STRING:
258      os << " str";
259      break;
260    case INTEGER:
261      os << " int";
262      break;
263    case DOUBLE:
264      os << " num";
265      break;
266    default:
267      break;
268    }
269  }
270
271  void ArgParser::show(std::ostream &os,Groups::iterator i)
272  {
273    GroupData::Opts::iterator o=i->second.opts.begin();
274    while(o!=i->second.opts.end()) {
275      show(os,_opts.find(*o));
276      ++o;
277      if(o!=i->second.opts.end()) os<<'|';
278    }
279  }
280   
281  void ArgParser::showHelp(Opts::iterator i)
282  {
283    if(i->second.help.size()==0||i->second.syn) return;
284    std::cerr << "  ";
285    show(std::cerr,i);
286    std::cerr << std::endl;
287    std::cerr << "     " << i->second.help << std::endl;
288  }
289  void ArgParser::showHelp(std::vector<ArgParser::OtherArg>::iterator i)
290  {
291    if(i->help.size()==0) return;
292    std::cerr << "  " << i->name << std::endl
293              << "     " << i->help << std::endl;
294  }
295   
296  void ArgParser::shortHelp()
297  {
298    const unsigned int LINE_LEN=77;
299    const std::string indent("    ");
300    std::cerr << "Usage:\n  " << _command_name;
301    int pos=_command_name.size()+2;
302    for(Groups::iterator g=_groups.begin();g!=_groups.end();++g) {
303      std::ostringstream cstr;
304      cstr << ' ';
305      if(!g->second.mandatory) cstr << '[';
306      show(cstr,g);
307      if(!g->second.mandatory) cstr << ']';
308      if(pos+cstr.str().size()>LINE_LEN) {
309        std::cerr << std::endl << indent;
310        pos=indent.size();
311      }
312      std::cerr << cstr.str();
313      pos+=cstr.str().size();
314    }
315    for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)
316      if(!i->second.ingroup&&!i->second.syn) {
317        std::ostringstream cstr;
318        cstr << ' ';
319        if(!i->second.mandatory) cstr << '[';
320        show(cstr,i);
321        if(!i->second.mandatory) cstr << ']';
322        if(pos+cstr.str().size()>LINE_LEN) {
323          std::cerr << std::endl << indent;
324          pos=indent.size();
325        }
326        std::cerr << cstr.str();
327        pos+=cstr.str().size();
328      }
329    for(std::vector<OtherArg>::iterator i=_others_help.begin();
330        i!=_others_help.end();++i)
331      {
332        std::ostringstream cstr;
333        cstr << ' ' << i->name;
334     
335        if(pos+cstr.str().size()>LINE_LEN) {
336          std::cerr << std::endl << indent;
337          pos=indent.size();
338        }
339        std::cerr << cstr.str();
340        pos+=cstr.str().size();
341      }
342    std::cerr << std::endl;
343  }
344   
345  void ArgParser::showHelp()
346  {
347    shortHelp();
348    std::cerr << "Where:\n";
349    for(std::vector<OtherArg>::iterator i=_others_help.begin();
350        i!=_others_help.end();++i) showHelp(i);
351    for(Opts::iterator i=_opts.begin();i!=_opts.end();++i) showHelp(i);
352    exit(1);
353  }
354   
355     
356  void ArgParser::unknownOpt(std::string arg)
357  {
358    std::cerr << "\nUnknown option: " << arg << "\n";
359    std::cerr << "\nType '" << _command_name <<
360      " --help' to obtain a short summary on the usage.\n\n";
361    exit(1);
362  }
363   
364  void ArgParser::requiresValue(std::string arg, OptType t)
365  {
366    std::cerr << "Argument '" << arg << "' requires a";
367    switch(t) {
368    case STRING:
369      std::cerr << " string";
370      break;
371    case INTEGER:
372      std::cerr << "n integer";
373      break;
374    case DOUBLE:
375      std::cerr << " floating point";
376      break;
377    default:
378      break;
379    }
380    std::cerr << " value\n\n";
381    showHelp();
382  }
383   
384
385  void ArgParser::checkMandatories()
386  {
387    bool ok=true;
388    for(Opts::iterator i=_opts.begin();i!=_opts.end();++i)
389      if(i->second.mandatory&&!i->second.set)
390        {
391          if(ok)
392            std::cerr << _command_name
393                      << ": The following mandatory arguments are missing.\n";
394          ok=false;
395          showHelp(i);
396        }
397    for(Groups::iterator i=_groups.begin();i!=_groups.end();++i)
398      if(i->second.mandatory||i->second.only_one)
399        {
400          int set=0;
401          for(GroupData::Opts::iterator o=i->second.opts.begin();
402              o!=i->second.opts.end();++o)
403            if(_opts.find(*o)->second.set) ++set;
404          if(i->second.mandatory&&!set) {
405            std::cerr << _command_name
406                      << ": At least one of the following arguments is mandatory.\n";
407            ok=false;
408            for(GroupData::Opts::iterator o=i->second.opts.begin();
409                o!=i->second.opts.end();++o)
410              showHelp(_opts.find(*o));
411          }
412          if(i->second.only_one&&set>1) {
413            std::cerr << _command_name
414                      << ": At most one of the following arguments can be given.\n";
415            ok=false;
416            for(GroupData::Opts::iterator o=i->second.opts.begin();
417                o!=i->second.opts.end();++o)
418              showHelp(_opts.find(*o));
419          }
420        }
421    if(!ok) {
422      std::cerr << "\nType '" << _command_name <<
423        " --help' to obtain a short summary on the usage.\n\n";
424      exit(1);
425    }
426  }
427
428  ArgParser &ArgParser::parse()
429  {
430    for(int ar=1; ar<_argc; ++ar) {
431      std::string arg(_argv[ar]);
432      if (arg[0] != '-' || arg.size() == 1) {
433        _file_args.push_back(arg);
434      }
435      else {
436        Opts::iterator i = _opts.find(arg.substr(1));
437        if(i==_opts.end()) unknownOpt(arg);
438        else {
439          if(i->second.syn) i=_opts.find(i->second.help);
440          ParData &p(i->second);
441          if (p.type==BOOL) *p.bool_p=true;
442          else if (p.type==FUNC) p.func_p.p(p.func_p.data);
443          else if(++ar==_argc) requiresValue(arg, p.type);
444          else {
445            std::string val(_argv[ar]);
446            std::istringstream vals(val);
447            switch(p.type) {
448            case STRING:
449              *p.string_p=val;
450              break;
451            case INTEGER:
452              vals >> *p.int_p;
453              break;
454            case DOUBLE:
455              vals >> *p.double_p;
456              break;
457            default:
458              break;
459            }
460            if(p.type!=STRING&&(!vals||!vals.eof()))
461              requiresValue(arg, p.type);
462          }
463          p.set = true;
464        }
465      }
466    }
467    checkMandatories();
468
469    return *this;
470  } 
471
472}
Note: See TracBrowser for help on using the repository browser.