jade::basic_args< TChar > Class Template Reference

A template for a class that helps process command-line arguments. More...

#include <jade.args.hpp>

Collaboration diagram for jade::basic_args< TChar >:

Public Types
typedef TChar	char_type
	The character type. More...

Public Member Functions
template<typename TValue >
	basic_args (const std::initializer_list< TValue > &values)
	Initializes a new instance of the class based on the specified arguments. The first argument is ignored. More...
	basic_args (const int argc, const char_type *argv[])
	Initializes a new instance of the class based on the specified arguments. The first argument is ignored. More...
size_t	get_length () const
bool	is_empty () const
template<typename TValue >
TValue	pop ()
template<typename TValue >
TValue	read (char_type const *const long_name, char_type const *const short_name, const TValue fallback=TValue())
	Reads and removes an option with one argument. If the option was not specified, then the fallback value is returned. More...
bool	read_flag (char_type const *const long_name, char_type const *const short_name)
	Reads and removes an option with no arguments. If the options was not specified, then false is returned. More...
void	validate_empty () const
	Throws an exception if there are more arguments to be processed. More...
void	validate_length (const size_t length) const
	Throws an exception if the number of remaining arguments is not the expected number. More...

Detailed Description

template<typename TChar>
class jade::basic_args< TChar >

A template for a class that helps process command-line arguments.

Definition at line 18 of file jade.args.hpp.

Member Typedef Documentation

char_type

template<typename TChar >

typedef TChar jade::basic_args< TChar >::char_type

The character type.

Definition at line 21 of file jade.args.hpp.

Constructor & Destructor Documentation

basic_args() [1/2]

template<typename TChar >

template<typename TValue >

jade::basic_args< TChar >::basic_args ( const std::initializer_list< TValue > &  values )

inlineexplicit

Initializes a new instance of the class based on the specified arguments. The first argument is ignored.

Parameters

values

The command line arguments.

Definition at line 30 of file jade.args.hpp.

            : _m ()
            #ifndef NDEBUG
            , is_flag_read (false)
            #endif // NDEBUG
        {
            auto iter = values.begin();
 
            if (iter == values.end())
                throw error("invalid command-line arguments");
 
            while (++iter != values.end())
            {
                if (*iter == nullptr)
                    throw error("invalid command-line arguments");
 
                _m.emplace_back(*iter);
            }
        }

basic_args() [2/2]

template<typename TChar >

jade::basic_args< TChar >::basic_args ( const int  argc, const char_type *  argv[]  )

inline

Initializes a new instance of the class based on the specified arguments. The first argument is ignored.

Parameters

argc	The argument count.
argv	The argument values.

Definition at line 54 of file jade.args.hpp.

            : _m ()
            #ifndef NDEBUG
            , is_flag_read (false)
            #endif // NDEBUG
        {
            if (argc < 1 || argv == nullptr)
                throw error("invalid command-line arguments");
 
            for (auto i = 1; i < argc; i++)
            {
                const auto s = argv[i];
                if (s == nullptr)
                    throw error("invalid command-line arguments");
 
                _m.emplace_back(s);
            }
        }

Member Function Documentation

get_length()

template<typename TChar >

size_t jade::basic_args< TChar >::get_length ( ) const

inline

Returns

The number of arguments remaining to be processed.

Definition at line 78 of file jade.args.hpp.

        {
            return _m.size();
        }

Here is the caller graph for this function:

is_empty()

template<typename TChar >

bool jade::basic_args< TChar >::is_empty ( ) const

inline

Returns

True if there are no more arguments to be processed.

Definition at line 86 of file jade.args.hpp.

        {
            return _m.empty();
        }

pop()

template<typename TChar >

template<typename TValue >

TValue jade::basic_args< TChar >::pop ( )

inline

Returns

The next argument from the stack or throws an exception if there are no more arguments to be processed.

Definition at line 96 of file jade.args.hpp.

        {
            if (_m.empty())
                throw error("not enough arguments");
 
            const auto value = _parse<TValue>(0);
            _m.erase(_m.begin());
            return value;
        }

Here is the caller graph for this function:

read()

template<typename TChar >

template<typename TValue >

TValue jade::basic_args< TChar >::read ( char_type const *const  long_name, char_type const *const  short_name, const TValue  fallback = TValue()  )

inline

Reads and removes an option with one argument. If the option was not specified, then the fallback value is returned.

Parameters

long_name	The long option name.
short_name	The short option name.
fallback	The optional fallback value.

Returns

The value after the flag or the fallback value.

Definition at line 117 of file jade.args.hpp.

        {
            assert(!is_flag_read);
 
            const auto index = _find(long_name, short_name);
            if (index < 0)
                return fallback;
 
            if (index + 1 >= int(get_length()))
                throw error() << "missing argument for option " << long_name;
 
            const auto value = _parse<TValue>(size_t(index + 1));
            _m.erase(_m.begin() + index, _m.begin() + index + 2);
            return value;
        }

Here is the call graph for this function:

read_flag()

template<typename TChar >

bool jade::basic_args< TChar >::read_flag ( char_type const *const  long_name, char_type const *const  short_name  )

inline

Reads and removes an option with no arguments. If the options was not specified, then false is returned.

Returns

True if the flag is found; otherwise, false.

Parameters

long_name	The long option name.
short_name	The short option name.

Definition at line 142 of file jade.args.hpp.

        {
            const auto index = _find(long_name, short_name);
            if (index < 0)
                return false;
 
            #ifndef NDEBUG
            is_flag_read = true;
            #endif // NDEBUG
 
            _m.erase(_m.begin() + index);
            return true;
        }

validate_empty()

template<typename TChar >

void jade::basic_args< TChar >::validate_empty ( ) const

inline

Throws an exception if there are more arguments to be processed.

Definition at line 161 of file jade.args.hpp.

        {
            if (_m.empty())
                return;
 
            if (_m[0][0] == '-')
                throw error() << "unexpected option " << _m[0];
 
            throw error() << "unexpected argument '" << _m[0] << "'";
        }

Here is the caller graph for this function:

validate_length()

template<typename TChar >

void jade::basic_args< TChar >::validate_length ( const size_t  length ) const

inline

Throws an exception if the number of remaining arguments is not the expected number.

Parameters

length

The number of remaining arguments.

Definition at line 176 of file jade.args.hpp.

        {
            if (_m.size() != length)
                throw error("invalid syntax; try --help");
        }

---

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

• jade.args.hpp