arguments.hpp
Go to the documentation of this file.
/*
CLAW - a C++ Library Absolutely Wonderful
CLAW is a free library without any particular aim but being useful to
anyone.
Copyright (C) 2005-2011 Julien Jorge
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
contact: julien.jorge@gamned.org
*/
#ifndef __CLAW_ARGUMENTS_HPP__
#define __CLAW_ARGUMENTS_HPP__
#include <string>
#include <map>
#include <claw/ordered_set.hpp>
namespace claw
{
class arguments
{
private:
typedef
std::map< std::string, std::list<std::string> > valued_arguments_map;
public:
arguments();
explicit arguments( const std::string& prog_name );
arguments( int& argc, char** &argv );
arguments( int& argc, char** &argv,
const claw::math::ordered_set<std::string>& allowed );
void parse( int& argc, char** &argv );
void parse( int& argc, char** &argv,
const claw::math::ordered_set<std::string>& allowed );
bool has_value( const std::string& arg_name ) const;
bool only_integer_values( const std::string& arg_name ) const;
bool only_real_values( const std::string& arg_name ) const;
const std::string& get_program_name() const;
bool get_bool( const std::string& arg_name ) const;
int get_integer( const std::string& arg_name ) const;
double get_real( const std::string& arg_name ) const;
const std::string& get_string( const std::string& arg_name ) const;
std::list<int> get_all_of_integer( const std::string& arg_name ) const;
std::list<double> get_all_of_real( const std::string& arg_name ) const;
std::list<std::string>
get_all_of_string( const std::string& arg_name ) const;
void add_argument( const std::string& arg );
private:
void parse( int& argc, char** &argv, bool always_allowed,
const claw::math::ordered_set<std::string>& allowed );
bool split_argument
( const std::string& arg, std::string& name, std::string& value ) const;
void remove_null_arguments( int& argc, char** &argv ) const;
void process_boolean
( char* &arg, bool always_allowed,
const claw::math::ordered_set<std::string>& allowed );
private:
std::string m_program_name;
claw::math::ordered_set<std::string> m_flags;
valued_arguments_map m_pairs;
}; // class arguments
} // namespace claw
#endif // __CLAW_ARGUMENTS_HPP__
claw::arguments::get_real
double get_real(const std::string &arg_name) const
Get the real value of an argument.
Definition: arguments.cpp:215
claw::arguments::parse
void parse(int &argc, char **&argv)
Parse arguments.
Definition: arguments.cpp:97
ordered_set.hpp
A class to manage sets of ordered items.
claw::arguments::only_integer_values
bool only_integer_values(const std::string &arg_name) const
Tell if only integer values are associated to an argument.
Definition: arguments.cpp:133
claw::arguments
A class to manage the arguments of your program.
Definition: arguments.hpp:50
claw::arguments::get_all_of_string
std::list< std::string > get_all_of_string(const std::string &arg_name) const
Get all string values of an argument.
Definition: arguments.cpp:304
claw::arguments::get_integer
int get_integer(const std::string &arg_name) const
Get the integer value of an argument.
Definition: arguments.cpp:197
claw::arguments::get_bool
bool get_bool(const std::string &arg_name) const
Get the boolean state of an argument.
Definition: arguments.cpp:186
claw::arguments::get_all_of_integer
std::list< int > get_all_of_integer(const std::string &arg_name) const
Get all integer values of an argument.
Definition: arguments.cpp:248
claw::arguments::add_argument
void add_argument(const std::string &arg)
Add an argument in our list.
Definition: arguments.cpp:325
claw::arguments::arguments
arguments()
Constructor.
Definition: arguments.cpp:41
claw::arguments::only_real_values
bool only_real_values(const std::string &arg_name) const
Tell if only real values are associated to an argument.
Definition: arguments.cpp:155
claw::math::ordered_set< std::string >
claw::arguments::has_value
bool has_value(const std::string &arg_name) const
Tell if a value is associated to an argument.
Definition: arguments.cpp:123
claw
This is the main namespace.
Definition: algorithm.hpp:33
claw::arguments::get_program_name
const std::string & get_program_name() const
Get the name of the program.
Definition: arguments.cpp:176
claw::arguments::get_string
const std::string & get_string(const std::string &arg_name) const
Get the string value of an argument.
Definition: arguments.cpp:234
claw::arguments::get_all_of_real
std::list< double > get_all_of_real(const std::string &arg_name) const
Get all real values of an argument.
Definition: arguments.cpp:276