source: trunk/yat/utility/CommandLine.cc

Last change on this file was 3792, checked in by Peter, 2 years ago

update copyright years

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 6.9 KB
Line 
1// $Id: CommandLine.cc 3792 2019-04-12 07:15:09Z peter $
2
3/*
4  Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Markus Ringnér
5  Copyright (C) 2008 Jari Häkkinen, Peter Johansson
6  Copyright (C) 2009, 2010, 2011, 2012, 2013, 2018 Peter Johansson
7
8  This file is part of the yat library, http://dev.thep.lu.se/yat
9
10  The yat library is free software; you can redistribute it and/or
11  modify it under the terms of the GNU General Public License as
12  published by the Free Software Foundation; either version 3 of the
13  License, or (at your option) any later version.
14
15  The yat library is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  General Public License for more details.
19
20  You should have received a copy of the GNU General Public License
21  along with yat. If not, see <http://www.gnu.org/licenses/>.
22*/
23
24#include <config.h>
25
26#include "CommandLine.h"
27
28#include "ColumnStream.h"
29#include "Exception.h"
30#include "Option.h"
31#include "OptionSwitch.h"
32#include "utility.h"
33
34#include <algorithm>
35#include <cassert>
36#include <functional>
37#include <fstream>
38#include <ostream>
39#include <sstream>
40#include <stdexcept>
41#include <string>
42#include <vector>
43
44namespace theplu {
45namespace yat {
46namespace utility {
47
48  CommandLine::CommandLine(std::string str)
49    : description_(str), free_arg_max_(0), parsed_(false)
50  {}
51
52
53  CommandLine::~CommandLine(void)
54  {
55  }
56
57
58  void CommandLine::add(Option& option)
59  {
60    if (option.long_name().size()) {
61      if (long_options_.find(option.long_name())!=long_options_.end()) {
62        std::stringstream ss;
63        ss << "yat::utility::Commandline: two options with long_name: "
64           << option.long_name();
65        throw runtime_error(ss.str());
66      }
67      long_options_[option.long_name()] = &option;
68    }
69    if (option.short_name()) {
70      if (short_options_.find(option.short_name())!=short_options_.end()) {
71        std::stringstream ss;
72        ss << "yat::utility::Commandline: two options with short_name: "
73           << option.short_name();
74        throw runtime_error(ss.str());
75      }
76      short_options_[option.short_name()] = &option;
77    }
78    if (option.long_name().size() || option.short_name())
79      options_.push_back(&option);
80  }
81
82
83  void CommandLine::allow_free_args(size_t n)
84  {
85    free_arg_max_ = n;
86  }
87
88
89  const std::vector<std::string>& CommandLine::free_args(void) const
90  {
91    return free_arg_;
92  }
93
94
95  bool CommandLine::is_long_option(std::string str) const
96  {
97    return (str.size()>2 && str[0]=='-' && str[1]=='-');
98  }
99
100
101  bool CommandLine::is_short_option(std::string str) const
102  {
103    return (str.size()>=2 && str[0]=='-' && str[1]!='-');
104  }
105
106
107  void CommandLine::parse(int argc, char* argv[])
108  {
109    parsed_=true;
110    using namespace std;
111    // just in case it is not pristine
112    for_each(options_.begin(), options_.end(),std::mem_fun(&Option::reset));
113
114    std::vector<std::string> arguments(argv, argv+argc);
115    std::vector<std::string>::iterator arg(arguments.begin());
116    std::vector<std::string>::iterator end(arguments.end());
117    // keeping string after last /
118    program_name_ = basename(*arg);
119    ++arg;
120
121    bool ok=true;
122    std::string error_message;
123    for (; arg!=end; ++arg) {
124      try {
125        parse(arg, end);
126      }
127      catch (cmd_error& e) {
128        if (ok) { // we only store first error
129          ok = false;
130          error_message = e.what();
131        }
132      }
133    }
134    // validate all options
135    try {
136      for_each(options_.begin(), options_.end(),
137               std::mem_fun(&Option::validate)); 
138    }
139    catch (cmd_error& e) {
140      if (ok) { // we only store first error
141        ok = false;
142        error_message = e.what();
143      }
144    }
145   
146    if (!ok) {
147      std::stringstream ss;
148      ss << program_name_ << ": " << error_message;
149      throw cmd_error(ss.str());
150    }
151  }
152 
153
154  void CommandLine::parse_long(std::vector<std::string>::iterator& arg,
155                               std::vector<std::string>::iterator& last)
156  {
157    std::string key(arg->substr(2));
158    std::stringstream ss2(key);
159    getline(ss2, key, '=');
160    std::string value;
161    getline(ss2, value, '\0');
162    if (!value.empty()){
163      *arg = value;
164      *(--arg) = std::string("--")+key;
165    }
166    else
167      *arg = key;
168    std::map<std::string, Option*>::const_iterator
169      iter(long_options_.find(key));
170    if (iter!=long_options_.end())
171      iter->second->parse(arg, last);
172    else if (key.size()>3 && key.substr(0,3)=="no-") {
173      iter = long_options_.find(key.substr(3));
174      if (iter!=long_options_.end())
175        iter->second->parse(arg, last);
176    }
177    if (iter==long_options_.end()) {
178      std::stringstream ss3;
179      ss3 << "unrecognized option '" << key << "'\n" << try_help();
180      throw cmd_error(ss3.str());
181    }
182  }
183
184  void CommandLine::parse_short(std::vector<std::string>::iterator& arg,
185                                std::vector<std::string>::iterator& last)
186  {
187    size_t size=arg->size();
188    for (size_t i=1; i<size; ++i){
189      std::map<char, Option*>::const_iterator
190        iter(short_options_.find((*arg)[i]));
191      if (iter==short_options_.end()) {
192        std::stringstream ss2;
193        ss2 << ": invalid option -- " << (*arg)[i] << "\n"
194            << try_help();
195        throw cmd_error(ss2.str());
196      }       
197      else 
198        iter->second->parse(arg, last);
199    }
200  }
201
202
203  void CommandLine::parse_free_arg(std::vector<std::string>::iterator& arg,
204                                   std::vector<std::string>::iterator& last)
205  {
206    free_arg_.push_back(*arg);
207    if (free_arg_.size()>free_arg_max_) {
208      std::stringstream ss2;
209      ss2 << ": invalid option -- " << *arg << "\n"
210          << try_help();
211      throw cmd_error(ss2.str());
212    }
213  }
214
215 
216  void CommandLine::parse(std::vector<std::string>::iterator& first,
217                          std::vector<std::string>::iterator& last)
218  {
219    if (is_long_option(*first))
220      parse_long(first, last);
221    else if (is_short_option(*first))
222      parse_short(first, last);
223    else
224      parse_free_arg(first, last);
225
226  }
227 
228
229  bool CommandLine::parsed(void) const
230  {
231    return parsed_;
232  }
233
234
235  std::string CommandLine::program_name(void) const
236  {
237    return program_name_;
238  }
239
240
241  void CommandLine::sort(void)
242  {
243    sort(OptionCompare());
244  }
245
246
247  std::string CommandLine::try_help(void) const
248  {
249    return std::string("Try '"+program_name()+" --help' for more information.");
250  }
251
252
253  std::ostream& operator<<(std::ostream& os, const CommandLine& cmd)
254  {
255    os << cmd.description_ << "\n";
256    ColumnStream cs2(os, 2);
257    std::string::size_type width = 0;
258    for (std::vector<Option*>::const_iterator i(cmd.options_.begin()); 
259         i!=cmd.options_.end();++i) {
260      std::stringstream ss((*i)->print());
261      std::string str;
262      getline(ss, str, '\t');
263      width = std::max(width, str.size()+3);       
264    }
265    cs2.width(0)=width;
266    cs2.width(1)=76-width;
267    cs2.margin(0)=2;
268
269    for (std::vector<Option*>::const_iterator i(cmd.options_.begin()); 
270         i!=cmd.options_.end();++i) 
271      cs2 << (*i)->print() << "\n";
272
273    return os;
274  }
275
276
277  bool CommandLine::OptionCompare::operator()(const Option* lhs, 
278                                              const Option* rhs) const
279  {
280    assert(lhs);
281    assert(rhs);
282    std::string lhs_str = lhs->long_name();
283    if (lhs_str.empty())
284      lhs_str = lhs->short_name();
285    std::string rhs_str = rhs->long_name();
286    if (rhs_str.empty())
287      rhs_str = rhs->short_name();
288    return lhs_str < rhs_str;
289  }
290
291
292}}} // of namespace utility, yat, and theplu
Note: See TracBrowser for help on using the repository browser.