146 lines
4.1 KiB
C++
146 lines
4.1 KiB
C++
#ifndef OPTIONS_H
|
|
#define OPTIONS_H
|
|
|
|
//DUPLICATES NOT HANDLED: takes last one
|
|
//NO ORDER: no way to know options order
|
|
//RETURNS TRANSITIONAL STATE IF ERROR
|
|
|
|
#include <vector>
|
|
#include <string>
|
|
#include <iostream>
|
|
|
|
#include <exception>
|
|
|
|
/*! @file options.hpp
|
|
* @brief CLI option reading and processing
|
|
*
|
|
* Easy managing of POSIX/GNU style options
|
|
*/
|
|
|
|
|
|
namespace ztd
|
|
{
|
|
//! @brief Option exception
|
|
/*!
|
|
Thrown when errors are encountered during processing of options
|
|
*/
|
|
class option_error : public std::exception
|
|
{
|
|
public:
|
|
//! @brief option error types
|
|
enum error_type { unknown_option, takes_no_arg, missing_arg};
|
|
|
|
//! @brief Conctructor
|
|
option_error(error_type type, const std::string& option);
|
|
|
|
//! @brief Type of error
|
|
inline error_type type() { return errtype; }
|
|
//! @brief Error message
|
|
inline const char * what () const throw () {return msg.c_str();}
|
|
//! @brief Subject of said error
|
|
inline const char * option () const throw () {return opt.c_str();}
|
|
private:
|
|
error_type errtype;
|
|
std::string opt;
|
|
std::string msg;
|
|
};
|
|
//! @brief Convert argc/argv into vector<std::string>
|
|
std::vector<std::string> argVector(int argc, char** argv);
|
|
|
|
//! @brief Single option object
|
|
/*! Definition of a GNU/POSIX style option
|
|
*/
|
|
class option
|
|
{
|
|
public:
|
|
/* CTOR/DTOR */
|
|
//ctors
|
|
option();
|
|
//! @brief Create a char defined option
|
|
option(char c, bool arg=false, std::string helptext="", std::string argname="arg");
|
|
//! @brief Create a string defined option
|
|
option(std::string const& str, bool arg=false, std::string helptext="", std::string argname="arg");
|
|
//! @brief Create a char and string defined option
|
|
option(char c, std::string const& str, bool arg=false, std::string helptext="", std::string argname="arg");
|
|
//! @brief Create copy
|
|
option(const option& opt);
|
|
|
|
/* FUNCTIONS */
|
|
|
|
//! @brief Print option's help
|
|
/*!
|
|
@param leftpad Put @a leftpad spaces at start of the line
|
|
@param rightpad Help text starts at column @a leftpad + @a rightpad
|
|
*/
|
|
void print_help(int leftpad, int rightpad) const;
|
|
|
|
/* PROPERTIES */
|
|
|
|
bool shortDef; // has a char definition
|
|
char charName;
|
|
|
|
bool longDef; // has a string definition
|
|
std::string strName;
|
|
|
|
bool takesArgument; // option takes an argument
|
|
|
|
std::string help_text; // text to display in print_help
|
|
std::string arg_name; // name of the argument to display in print_help
|
|
|
|
/* PROCESSING STATUS */
|
|
|
|
//! @brief Option was activated
|
|
bool activated; // option was activated
|
|
|
|
//! @brief Option's argument
|
|
std::string argument; // argument of the option
|
|
|
|
};
|
|
|
|
//! @brief Set of POSIX/GNU style options
|
|
/*!
|
|
Process arguments through it to extract options
|
|
*/
|
|
class option_set
|
|
{
|
|
public:
|
|
/*CREATION FUNCTIONS*/
|
|
//! @brief Add option to the set
|
|
inline void add(option opt) { m_options.push_back(opt); }
|
|
|
|
/*PRINT FUNCTIONS*/
|
|
//! @brief Print help for the full option set
|
|
/*!
|
|
Output order follows option creation order
|
|
@param leftpad Put @a leftpad spaces at start of the line
|
|
@param rightpad Help text starts at column @a leftpad + @a rightpad
|
|
*/
|
|
void print_help(int leftpad=2, int rightpad=25) const;
|
|
|
|
/*QUERY FUNCTIONS*/
|
|
//! @brief Find char option
|
|
option* find(char c);
|
|
//! @brief Find string option
|
|
option* find(std::string const& str);
|
|
|
|
/*PROCESSING FUNCTIONS*/
|
|
//! @brief Process arguments through the option set
|
|
/*!
|
|
If errors are encountered, exceptions option_error are thrown
|
|
@param arguments vector of string containing arguments and options
|
|
@return Leftover arguments that are not options\n
|
|
*/
|
|
std::vector<std::string> process(std::vector<std::string> arguments);
|
|
//! @brief Process arguments through the option set
|
|
/*!
|
|
calls process(std::vector<std::string> arguments)
|
|
*/
|
|
inline std::vector<std::string> process(int argc, char** argv) { return this->process(ztd::argVector(argc, argv)); }
|
|
|
|
private:
|
|
std::vector<option> m_options;
|
|
};
|
|
|
|
} //ztd
|
|
|
|
#endif //OPTIONS_H
|