clara::detail::Opt Class Reference

#include <clara.hpp>

Inheritance diagram for clara::detail::Opt:

Collaboration diagram for clara::detail::Opt:

Public Member Functions
template<typename LambdaT >
	Opt (LambdaT const &ref)
	Opt (bool &ref)
template<typename LambdaT >
	Opt (LambdaT const &ref, std::string const &hint)
template<typename T >
	Opt (T &ref, std::string const &hint)
auto	operator[] (std::string const &optName) -> Opt &
auto	getHelpColumns () const -> std::vector< HelpColumns >
auto	isMatch (std::string const &optToken) const -> bool
auto	parse (std::string const &, TokenStream const &tokens) const -> InternalParseResult override
auto	validate () const -> Result override
auto	parse (Args const &args) const -> InternalParseResult
Public Member Functions inherited from clara::detail::ParserRefImpl< Opt >
	ParserRefImpl (T &ref, std::string const &hint)
	ParserRefImpl (LambdaT const &ref, std::string const &hint)
auto	operator() (std::string const &description) -> Opt &
auto	optional () -> Opt &
auto	required () -> Opt &
auto	isOptional () const -> bool
auto	cardinality () const -> size_t override
auto	hint () const -> std::string
Public Member Functions inherited from clara::detail::ComposableParserImpl< Opt >
auto	operator| (T const &other) const -> Parser
auto	operator+ (T const &other) const -> Parser
Public Member Functions inherited from clara::detail::ParserBase
virtual	~ParserBase ()=default
auto	parse (Args const &args) const -> InternalParseResult

Protected Attributes
std::vector< std::string >	m_optNames
Protected Attributes inherited from clara::detail::ParserRefImpl< Opt >
Optionality	m_optionality
std::shared_ptr< BoundRef >	m_ref
std::string	m_hint
std::string	m_description

Additional Inherited Members
Protected Member Functions inherited from clara::detail::ParserRefImpl< Opt >
	ParserRefImpl (std::shared_ptr< BoundRef > const &ref)

Detailed Description

Definition at line 960 of file clara.hpp.

Constructor & Destructor Documentation

Opt() [1/4]

template<typename LambdaT >

clara::detail::Opt::Opt ( LambdaT const & ref )

inlineexplicit

Definition at line 966 of file clara.hpp.

: ParserRefImpl( std::make_shared<BoundFlagLambda<LambdaT>>( ref ) ) {}

Opt() [2/4]

clara::detail::Opt::Opt ( bool & ref )

inlineexplicit

Definition at line 968 of file clara.hpp.

: ParserRefImpl( std::make_shared<BoundFlagRef>( ref ) ) {}

Opt() [3/4]

template<typename LambdaT >

clara::detail::Opt::Opt ( LambdaT const & ref, std::string const & hint )

inline

Definition at line 971 of file clara.hpp.

: ParserRefImpl( ref, hint ) {}

Opt() [4/4]

template<typename T >

clara::detail::Opt::Opt ( T & ref, std::string const & hint )

inline

Definition at line 974 of file clara.hpp.

: ParserRefImpl( ref, hint ) {}

Member Function Documentation

getHelpColumns()

auto clara::detail::Opt::getHelpColumns ( ) const -> std::vector<HelpColumns>

inline

Definition at line 981 of file clara.hpp.

                                                              {
            std::ostringstream oss;
            bool first = true;
            for( auto const &opt : m_optNames ) {
                if (first)
                    first = false;
                else
                    oss << ", ";
                oss << opt;
            }
            if( !m_hint.empty() )
                oss << " <" << m_hint << ">";
            return { { oss.str(), m_description } };
        }

isMatch()

auto clara::detail::Opt::isMatch ( std::string const & optToken ) const -> bool

inline

Definition at line 996 of file clara.hpp.

                                                                {
            auto normalisedToken = normaliseOpt( optToken );
            for( auto const &name : m_optNames ) {
                if( normaliseOpt( name ) == normalisedToken )
                    return true;
            }
            return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

operator[]()

auto clara::detail::Opt::operator[] ( std::string const & optName ) -> Opt &

inline

Definition at line 976 of file clara.hpp.

                                                             {
            m_optNames.push_back( optName );
            return *this;
        }

parse() [1/2]

auto clara::detail::ParserBase::parse ( Args const & args ) const -> InternalParseResult

inline

Definition at line 816 of file clara.hpp.

                                                                    {
            return parse( args.exeName(), TokenStream( args ) );
        }

parse() [2/2]

auto clara::detail::Opt::parse ( std::string const & , TokenStream const & tokens ) const -> InternalParseResult

inlineoverridevirtual

Implements clara::detail::ParserBase.

Definition at line 1007 of file clara.hpp.

                                                                                                        {
            auto validationResult = validate();
            if( !validationResult )
                return InternalParseResult( validationResult );
 
            auto remainingTokens = tokens;
            if( remainingTokens && remainingTokens->type == TokenType::Option ) {
                auto const &token = *remainingTokens;
                if( isMatch(token.token ) ) {
                    if( m_ref->isFlag() ) {
                        auto flagRef = static_cast<detail::BoundFlagRefBase*>( m_ref.get() );
                        auto result = flagRef->setFlag( true );
                        if( !result )
                            return InternalParseResult( result );
                        if( result.value() == ParseResultType::ShortCircuitAll )
                            return InternalParseResult::ok( ParseState( result.value(), remainingTokens ) );
                    } else {
                        auto valueRef = static_cast<detail::BoundValueRefBase*>( m_ref.get() );
                        ++remainingTokens;
                        if( !remainingTokens )
                            return InternalParseResult::runtimeError( "Expected argument following " + token.token );
                        auto const &argToken = *remainingTokens;
                        if( argToken.type != TokenType::Argument )
                            return InternalParseResult::runtimeError( "Expected argument following " + token.token );
                        auto result = valueRef->setValue( argToken.token );
                        if( !result )
                            return InternalParseResult( result );
                        if( result.value() == ParseResultType::ShortCircuitAll )
                            return InternalParseResult::ok( ParseState( result.value(), remainingTokens ) );
                    }
                    return InternalParseResult::ok( ParseState( ParseResultType::Matched, ++remainingTokens ) );
                }
            }
            return InternalParseResult::ok( ParseState( ParseResultType::NoMatch, remainingTokens ) );
        }

Here is the call graph for this function:

validate()

auto clara::detail::Opt::validate ( ) const -> Result

inlineoverridevirtual

Reimplemented from clara::detail::ParserBase.

Definition at line 1043 of file clara.hpp.

                                                 {
            if( m_optNames.empty() )
                return Result::logicError( "No options supplied to Opt" );
            for( auto const &name : m_optNames ) {
                if( name.empty() )
                    return Result::logicError( "Option name cannot be empty" );
#ifdef CLARA_PLATFORM_WINDOWS
                if( name[0] != '-' && name[0] != '/' )
                    return Result::logicError( "Option name must begin with '-' or '/'" );
#else
                if( name[0] != '-' )
                    return Result::logicError( "Option name must begin with '-'" );
#endif
            }
            return ParserRefImpl::validate();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_optNames

std::vector<std::string> clara::detail::Opt::m_optNames

protected

Definition at line 962 of file clara.hpp.

---

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

• libraries/sys-vm/external/Catch2/third_party/clara.hpp