claw  1.9.0
arguments_table.hpp
Go to the documentation of this file.
1 /*
2  CLAW - a C++ Library Absolutely Wonderful
3 
4  CLAW is a free library without any particular aim but being useful to
5  anyone.
6 
7  Copyright (C) 2005-2011 Julien Jorge
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 
23  contact: julien.jorge@stuff-o-matic.com
24 */
31 #ifndef __CLAW_ARGUMENTS_TABLE_HPP__
32 #define __CLAW_ARGUMENTS_TABLE_HPP__
33 
35 
36 namespace claw
37 {
49  {
50  private:
55  class argument_attributes
56  {
57  public:
58  argument_attributes(const std::string& name,
59  const std::string& second_name,
60  const std::string& help_message, bool optional,
61  const std::string& value_type);
62 
63  bool operator<(const argument_attributes& that) const;
64 
65  std::string format_short_help() const;
66  std::string format_long_help(std::size_t arguments_width) const;
67  std::string format_long_help_arguments() const;
68 
69  const std::string& get_name() const;
70  const std::string& get_second_name() const;
71 
72  bool is_optional() const;
73 
74  private:
76  const std::string m_name;
77 
79  const std::string m_second_name;
80 
82  const std::string m_help_message;
83 
85  const bool m_optional;
86 
88  const std::string m_value_type;
89 
90  }; // class argument_attributes
91 
92  public:
93  explicit arguments_table(const std::string& prog_name);
94  arguments_table(int& argc, char**& argv);
95 
96  void add(const std::string& short_name, const std::string& long_name,
97  const std::string& help_msg = "", bool optional = false,
98  const std::string& val_name = "");
99  void add_long(const std::string& long_name,
100  const std::string& help_msg = "", bool optional = false,
101  const std::string& val_name = "");
102  void add_short(const std::string& short_name,
103  const std::string& help_msg = "", bool optional = false,
104  const std::string& val_name = "");
105 
106  void parse(int& argc, char**& argv);
107  void help(const std::string& free_args = "") const;
108 
109  bool required_fields_are_set() const;
110  bool has_value(const std::string& arg_name) const;
111  bool only_integer_values(const std::string& arg_name) const;
112  bool only_real_values(const std::string& arg_name) const;
113 
114  const std::string& get_program_name() const;
115 
116  bool get_bool(const std::string& arg_name) const;
117  int get_integer(const std::string& arg_name) const;
118  double get_real(const std::string& arg_name) const;
119  const std::string& get_string(const std::string& arg_name) const;
120 
121  std::list<int> get_all_of_integer(const std::string& arg_name) const;
122  std::list<double> get_all_of_real(const std::string& arg_name) const;
123  std::list<std::string>
124  get_all_of_string(const std::string& arg_name) const;
125 
126  void add_argument(const std::string& arg);
127 
128  private:
129  void get_argument_names(const std::string& arg_name,
130  std::string& short_name,
131  std::string& long_name) const;
132 
133  std::size_t get_maximum_long_help_arguments_width() const;
134 
135  private:
137  arguments m_arguments;
138 
140  math::ordered_set<argument_attributes> m_short_arguments;
141 
144 
145  }; // class arguments_table
146 }
147 
148 #endif // __CLAW_ARGUMENTS_TABLE_HPP__
void add(const std::string &short_name, const std::string &long_name, const std::string &help_msg="", bool optional=false, const std::string &val_name="")
Add an argument in the table.
bool required_fields_are_set() const
Tell if all arguments not marqued as "optional" have been specified in the command line...
void help(const std::string &free_args="") const
Print some help about the arguments.
arguments_table(const std::string &prog_name)
Constructor.
A class to manage the arguments of your program, with automatic management of short/long arguments an...
A class to manage the arguments of your program.
Definition: arguments.hpp:51
double get_real(const std::string &arg_name) const
Get the real value of an argument.
bool only_integer_values(const std::string &arg_name) const
Tell if only integer values are associated to an argument.
const std::string & get_program_name() const
Get the name of the program.
std::list< int > get_all_of_integer(const std::string &arg_name) const
Get all integer values of an argument.
int get_integer(const std::string &arg_name) const
Get the integer value of an argument.
void add_argument(const std::string &arg)
Add an argument in our list.
bool only_real_values(const std::string &arg_name) const
Tell if only real values are associated to an argument.
void parse(int &argc, char **&argv)
Parse the command line arguments.
A class to manage the arguments of your program.
std::list< double > get_all_of_real(const std::string &arg_name) const
Get all real values of an argument.
bool has_value(const std::string &arg_name) const
Tell if an argument has a value.
void add_short(const std::string &short_name, const std::string &help_msg="", bool optional=false, const std::string &val_name="")
Add an argument in the table.
std::list< std::string > get_all_of_string(const std::string &arg_name) const
Get all string values of an argument.
const std::string & get_string(const std::string &arg_name) const
Get the string value of an argument.
bool get_bool(const std::string &arg_name) const
Get the boolean state of an argument.
This is the main namespace.
Definition: application.hpp:49
void add_long(const std::string &long_name, const std::string &help_msg="", bool optional=false, const std::string &val_name="")
Add an argument in the table.