libnifalcon  1.0.1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
optparse::OptionParser Class Reference

#include <OptionParser.h>

+ Inheritance diagram for optparse::OptionParser:
+ Collaboration diagram for optparse::OptionParser:

Public Member Functions

 OptionParser ()
 
virtual ~OptionParser ()
 
OptionParserusage (const std::string &u)
 
OptionParserversion (const std::string &v)
 
OptionParserdescription (const std::string &d)
 
OptionParseradd_help_option (bool h)
 
OptionParseradd_version_option (bool v)
 
OptionParserprog (const std::string &p)
 
OptionParserepilog (const std::string &e)
 
OptionParserset_defaults (const std::string &dest, const std::string &val)
 
OptionParserenable_interspersed_args ()
 
OptionParserdisable_interspersed_args ()
 
OptionParseradd_option_group (const OptionGroup &group)
 
const std::string & usage () const
 
const std::string & version () const
 
const std::string & description () const
 
bool add_help_option () const
 
bool add_version_option () const
 
const std::string & prog () const
 
const std::string & epilog () const
 
bool interspersed_args () const
 
Optionadd_option (const std::string &opt)
 
Optionadd_option (const std::string &opt1, const std::string &opt2)
 
Optionadd_option (const std::string &opt1, const std::string &opt2, const std::string &opt3)
 
Optionadd_option (const std::vector< std::string > &opt)
 
Valuesparse_args (int argc, char const *const *argv)
 
Valuesparse_args (const std::vector< std::string > &args)
 
template<typename InputIterator >
Valuesparse_args (InputIterator begin, InputIterator end)
 
const std::list< std::string > & args () const
 
std::vector< std::string > args ()
 
std::string format_help () const
 
std::string format_option_help (unsigned int indent=2) const
 
void print_help () const
 
void set_usage (const std::string &u)
 
std::string get_usage () const
 
void print_usage (std::ostream &out) const
 
void print_usage () const
 
std::string get_version () const
 
void print_version (std::ostream &out) const
 
void print_version () const
 
void error (const std::string &msg) const
 
void exit () const
 

Private Member Functions

const Optionlookup_short_opt (const std::string &opt) const
 
const Optionlookup_long_opt (const std::string &opt) const
 
void handle_short_opt (const std::string &opt, const std::string &arg)
 
void handle_long_opt (const std::string &optstr)
 
void process_opt (const Option &option, const std::string &opt, const std::string &value)
 
std::string format_usage (const std::string &u) const
 

Private Attributes

std::string _usage
 
std::string _version
 
std::string _description
 
bool _add_help_option
 
bool _add_version_option
 
std::string _prog
 
std::string _epilog
 
bool _interspersed_args
 
Values _values
 
std::list< Option_opts
 
optMap _optmap_s
 
optMap _optmap_l
 
strMap _defaults
 
std::list< OptionGroup const * > _groups
 
std::list< std::string > _remaining
 
std::list< std::string > _leftover
 

Constructor & Destructor Documentation

optparse::OptionParser::OptionParser ( )
virtual optparse::OptionParser::~OptionParser ( )
inlinevirtual

Member Function Documentation

OptionParser& optparse::OptionParser::add_help_option ( bool  h)
inline
bool optparse::OptionParser::add_help_option ( ) const
inline
Option& optparse::OptionParser::add_option ( const std::string &  opt)
Option& optparse::OptionParser::add_option ( const std::string &  opt1,
const std::string &  opt2 
)
Option& optparse::OptionParser::add_option ( const std::string &  opt1,
const std::string &  opt2,
const std::string &  opt3 
)
Option& optparse::OptionParser::add_option ( const std::vector< std::string > &  opt)
OptionParser & optparse::OptionParser::add_option_group ( const OptionGroup group)
OptionParser& optparse::OptionParser::add_version_option ( bool  v)
inline
bool optparse::OptionParser::add_version_option ( ) const
inline
const std::list<std::string>& optparse::OptionParser::args ( ) const
inline
std::vector<std::string> optparse::OptionParser::args ( )
inline
OptionParser& optparse::OptionParser::description ( const std::string &  d)
inline
const std::string& optparse::OptionParser::description ( ) const
inline
OptionParser& optparse::OptionParser::disable_interspersed_args ( )
inline
OptionParser& optparse::OptionParser::enable_interspersed_args ( )
inline
OptionParser& optparse::OptionParser::epilog ( const std::string &  e)
inline
const std::string& optparse::OptionParser::epilog ( ) const
inline
void optparse::OptionParser::error ( const std::string &  msg) const
void optparse::OptionParser::exit ( ) const
string optparse::OptionParser::format_help ( ) const
string optparse::OptionParser::format_option_help ( unsigned int  indent = 2) const
string optparse::OptionParser::format_usage ( const std::string &  u) const
private
string optparse::OptionParser::get_usage ( ) const
string optparse::OptionParser::get_version ( ) const
void optparse::OptionParser::handle_long_opt ( const std::string &  optstr)
private
void optparse::OptionParser::handle_short_opt ( const std::string &  opt,
const std::string &  arg 
)
private
bool optparse::OptionParser::interspersed_args ( ) const
inline
const Option & optparse::OptionParser::lookup_long_opt ( const std::string &  opt) const
private
const Option & optparse::OptionParser::lookup_short_opt ( const std::string &  opt) const
private
Values & optparse::OptionParser::parse_args ( int  argc,
char const *const *  argv 
)
Values& optparse::OptionParser::parse_args ( const std::vector< std::string > &  args)
template<typename InputIterator >
Values& optparse::OptionParser::parse_args ( InputIterator  begin,
InputIterator  end 
)
inline
void optparse::OptionParser::print_help ( ) const
void optparse::OptionParser::print_usage ( std::ostream &  out) const
void optparse::OptionParser::print_usage ( ) const
void optparse::OptionParser::print_version ( std::ostream &  out) const
void optparse::OptionParser::print_version ( ) const
void optparse::OptionParser::process_opt ( const Option option,
const std::string &  opt,
const std::string &  value 
)
private
OptionParser& optparse::OptionParser::prog ( const std::string &  p)
inline
const std::string& optparse::OptionParser::prog ( ) const
inline
OptionParser& optparse::OptionParser::set_defaults ( const std::string &  dest,
const std::string &  val 
)
inline
void optparse::OptionParser::set_usage ( const std::string &  u)
OptionParser& optparse::OptionParser::usage ( const std::string &  u)
inline
const std::string& optparse::OptionParser::usage ( ) const
inline
OptionParser& optparse::OptionParser::version ( const std::string &  v)
inline
const std::string& optparse::OptionParser::version ( ) const
inline

Member Data Documentation

bool optparse::OptionParser::_add_help_option
private
bool optparse::OptionParser::_add_version_option
private
strMap optparse::OptionParser::_defaults
private
std::string optparse::OptionParser::_description
private
std::string optparse::OptionParser::_epilog
private
std::list<OptionGroup const*> optparse::OptionParser::_groups
private
bool optparse::OptionParser::_interspersed_args
private
std::list<std::string> optparse::OptionParser::_leftover
private
optMap optparse::OptionParser::_optmap_l
private
optMap optparse::OptionParser::_optmap_s
private
std::list<Option> optparse::OptionParser::_opts
private
std::string optparse::OptionParser::_prog
private
std::list<std::string> optparse::OptionParser::_remaining
private
std::string optparse::OptionParser::_usage
private
Values optparse::OptionParser::_values
private
std::string optparse::OptionParser::_version
private

The documentation for this class was generated from the following files: