tim::argparse::argument_parser::argument Struct Reference

#include "timemory/utility/argparse.hpp"

Collaboration diagram for tim::argparse::argument_parser::argument:

Public Types
enum	Position : int {   LastArgument = -1 ,   IgnoreArgument = -2 }
enum	Count : int { ANY = -1 }
using	callback_t = std::function< void(void *&)>

Public Member Functions
	~argument ()
argument &	name (const std::string &name)
argument &	names (const std::vector< std::string > &names)
argument &	description (const std::string &description)
argument &	dtype (const std::string &_dtype)
argument &	required (bool req)
argument &	position (int position)
argument &	max_count (int count)
argument &	min_count (int count)
argument &	count (int count)
template<typename T >
argument &	set_default (const T &val)
template<typename T >
argument &	set_default (T &val)
template<typename T >
argument &	choices (const std::initializer_list< T > &_choices)
template<template< typename... > class ContainerT, typename T , typename... ExtraT, typename ContT = ContainerT<T, ExtraT...>, enable_if_t< helpers::is_container< ContT >::value > = 0>
argument &	choices (const ContainerT< T, ExtraT... > &_choices)
template<typename ActionFuncT >
argument &	action (ActionFuncT &&_func)
bool	found () const
template<typename T >
std::enable_if_t< helpers::is_container< T >::value, T >	get ()
template<typename T >
std::enable_if_t< !helpers::is_container< T >::value &&!std::is_same< T, bool >::value, T >	get ()
template<typename T >
std::enable_if_t< std::is_same< T, bool >::value, T >	get ()
size_t	size () const
std::string	get_name () const

Friends
struct	argument_parser
std::ostream &	operator<< (std::ostream &os, const argument &arg)

Detailed Description

Definition at line 360 of file argparse.hpp.

Member Typedef Documentation

callback_t

using tim::argparse::argument_parser::argument::callback_t = std::function<void(void*&)>

Definition at line 362 of file argparse.hpp.

Member Enumeration Documentation

Count

enum tim::argparse::argument_parser::argument::Count : int

Enumerator
ANY

Definition at line 370 of file argparse.hpp.

        {
            ANY = -1
        };

Position

enum tim::argparse::argument_parser::argument::Position : int

Enumerator
LastArgument
IgnoreArgument

Definition at line 364 of file argparse.hpp.

        {
            LastArgument   = -1,
            IgnoreArgument = -2
        };

Constructor & Destructor Documentation

~argument()

tim::argparse::argument_parser::argument::~argument ( )

inline

Definition at line 375 of file argparse.hpp.

{ m_destroy(m_default); }

Member Function Documentation

action()

template<typename ActionFuncT >

argument & tim::argparse::argument_parser::argument::action ( ActionFuncT &&  _func )

inline

Definition at line 495 of file argparse.hpp.

        {
            m_actions.push_back(std::forward<ActionFuncT>(_func));
            return *this;
        }

Referenced by tim::tsettings< Tp, Vp >::add_argument().

choices() [1/2]

template<template< typename... > class ContainerT, typename T , typename... ExtraT, typename ContT = ContainerT<T, ExtraT...>, enable_if_t< helpers::is_container< ContT >::value > = 0>

argument & tim::argparse::argument_parser::argument::choices ( const ContainerT< T, ExtraT... > &  _choices )

inline

Definition at line 483 of file argparse.hpp.

        {
            for(auto&& itr : _choices)
            {
                std::stringstream ss;
                ss << itr;
                m_choices.insert(ss.str());
            }
            return *this;
        }

choices() [2/2]

template<typename T >

argument & tim::argparse::argument_parser::argument::choices ( const std::initializer_list< T > &  _choices )

inline

Definition at line 469 of file argparse.hpp.

        {
            for(auto&& itr : _choices)
            {
                std::stringstream ss;
                ss << itr;
                m_choices.insert(ss.str());
            }
            return *this;
        }

Referenced by tim::tsettings< Tp, Vp >::add_argument().

count()

argument & tim::argparse::argument_parser::argument::count ( int  count )

inline

Definition at line 435 of file argparse.hpp.

        {
            m_count = count;
            return *this;
        }

References count().

Referenced by tim::tsettings< Tp, Vp >::add_argument(), count(), max_count(), and min_count().

description()

argument & tim::argparse::argument_parser::argument::description ( const std::string &  description )

inline

Definition at line 390 of file argparse.hpp.

        {
            m_desc = description;
            return *this;
        }

References description().

Referenced by tim::argparse::argument_parser::add_argument(), and description().

dtype()

argument & tim::argparse::argument_parser::argument::dtype ( const std::string &  _dtype )

inline

Definition at line 396 of file argparse.hpp.

        {
            m_dtype = _dtype;
            return *this;
        }

found()

bool tim::argparse::argument_parser::argument::found ( ) const

inline

Definition at line 501 of file argparse.hpp.

{ return m_found; }

Referenced by get().

get() [1/3]

template<typename T >

std::enable_if_t< helpers::is_container< T >::value, T > tim::argparse::argument_parser::argument::get ( )

inline

Definition at line 504 of file argparse.hpp.

        {
            T                      t = T{};
            typename T::value_type vt;
            for(auto& s : m_values)
            {
                std::istringstream in(s);
                in >> vt;
                t.insert(t.end(), vt);
            }
            if(m_values.empty() && m_default &&
               m_default_tidx == std::type_index{ typeid(T) })
                t = (*static_cast<T*>(m_default));
            return t;
        }

get() [2/3]

template<typename T >

std::enable_if_t< !helpers::is_container< T >::value &&!std::is_same< T, bool >::value, T > tim::argparse::argument_parser::argument::get ( )

inline

Definition at line 523 of file argparse.hpp.

        {
            auto               inp = get<std::string>();
            std::istringstream iss{ inp };
            T                  t = T{};
            iss >> t >> std::ws;
            if(inp.empty() && m_default && m_default_tidx == std::type_index{ typeid(T) })
                t = (*static_cast<T*>(m_default));
            return t;
        }

get() [3/3]

template<typename T >

std::enable_if_t< std::is_same< T, bool >::value, T > tim::argparse::argument_parser::argument::get ( )

inline

Definition at line 535 of file argparse.hpp.

        {
            if(m_count == 0)
                return found();
 
            auto inp = get<std::string>();
            if(inp.empty() && m_default && m_default_tidx == std::type_index{ typeid(T) })
                return (*static_cast<T*>(m_default));
            else if(inp.empty())
                return found();
 
            return get_bool(inp, found());
        }

References found(), and tim::get_bool().

get_name()

std::string tim::argparse::argument_parser::argument::get_name ( ) const

inline

Definition at line 551 of file argparse.hpp.

        {
            std::stringstream ss;
            for(const auto& itr : m_names)
                ss << "/" << itr;
            return ss.str().substr(1);
        }

max_count()

argument & tim::argparse::argument_parser::argument::max_count ( int  count )

inline

Definition at line 423 of file argparse.hpp.

        {
            m_max_count = count;
            return *this;
        }

References count().

Referenced by tim::tsettings< Tp, Vp >::add_argument().

min_count()

argument & tim::argparse::argument_parser::argument::min_count ( int  count )

inline

Definition at line 429 of file argparse.hpp.

        {
            m_min_count = count;
            return *this;
        }

References count().

name()

argument & tim::argparse::argument_parser::argument::name ( const std::string &  name )

inline

Definition at line 377 of file argparse.hpp.

        {
            m_names.push_back(name);
            return *this;
        }

References name().

Referenced by name().

names()

argument & tim::argparse::argument_parser::argument::names ( const std::vector< std::string > &  names )

inline

Definition at line 383 of file argparse.hpp.

        {
            for(const auto& itr : names)
                m_names.push_back(itr);
            return *this;
        }

References names().

Referenced by tim::argparse::argument_parser::add_argument(), tim::argparse::argument_parser::enable_help(), and names().

position()

argument & tim::argparse::argument_parser::argument::position ( int  position )

inline

Definition at line 408 of file argparse.hpp.

        {
            if(position != Position::LastArgument)
            {
                // position + 1 because technically argument zero is the name of the
                // executable
                m_position = position + 1;
            }
            else
            {
                m_position = position;
            }
            return *this;
        }

References position().

Referenced by position().

required()

argument & tim::argparse::argument_parser::argument::required ( bool  req )

inline

Definition at line 402 of file argparse.hpp.

        {
            m_required = req;
            return *this;
        }

Referenced by tim::argparse::argument_parser::add_argument().

set_default() [1/2]

template<typename T >

argument & tim::argparse::argument_parser::argument::set_default ( const T &  val )

inline

Definition at line 442 of file argparse.hpp.

        {
            m_found        = true;
            m_default_tidx = std::type_index{ typeid(decay_t<T>) };
            m_callback     = [&](void*& obj) {
                m_destroy(obj);
                if(!obj)
                    obj = (void*) new T{};
                (*static_cast<T*>(obj)) = val;
            };
            m_destroy = [](void*& obj) {
                if(obj)
                    delete static_cast<T*>(obj);
            };
            return *this;
        }

set_default() [2/2]

template<typename T >

argument & tim::argparse::argument_parser::argument::set_default ( T &  val )

inline

Definition at line 460 of file argparse.hpp.

        {
            m_found        = true;
            m_default_tidx = std::type_index{ typeid(decay_t<T>) };
            m_callback     = [&](void*& obj) { obj = (void*) &val; };
            return *this;
        }

size()

size_t tim::argparse::argument_parser::argument::size ( ) const

inline

Definition at line 549 of file argparse.hpp.

{ return m_values.size(); }

Friends And Related Function Documentation

argument_parser

friend struct argument_parser

friend

Definition at line 608 of file argparse.hpp.

operator<<

std::ostream & operator<< ( std::ostream &  os, const argument &  arg  )

friend

Definition at line 591 of file argparse.hpp.

        {
            std::stringstream ss;
            ss << "names: ";
            for(const auto& itr : arg.m_names)
                ss << itr << " ";
            ss << ", index: " << arg.m_index << ", count: " << arg.m_count
               << ", min count: " << arg.m_min_count << ", max count: " << arg.m_max_count
               << ", found: " << std::boolalpha << arg.m_found
               << ", required: " << std::boolalpha << arg.m_required
               << ", position: " << arg.m_position << ", values: ";
            for(const auto& itr : arg.m_values)
                ss << itr << " ";
            os << ss.str();
            return os;
        }

---

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

• timemory/utility/argparse.hpp