clanguml::common::or_regex< T > Struct Template Reference

Convenience class for configuration options with regex support. More...

Detailed Description

template<typename T>
struct clanguml::common::or_regex< T >

Convenience class for configuration options with regex support.

This template class provides a convenient way of handling configuraiton options, which can be either some basic type like std::string or regex.

Template Parameters

T	Type of alternative to regex (e.g. std::string)

Definition at line 276 of file types.h.

#include <types.h>

Public Member Functions
	or_regex ()=default
	or_regex (T v)
	Constructor from alternative type.
	or_regex (std::regex r, std::string p)
	Constructor from regex.
or_regex &	operator= (const T &v)
or_regex &	operator= (const regex &v)
bool	operator== (const T &v) const
template<typename Ret >
std::optional< Ret >	get () const
std::string	to_string () const
const std::variant< T, regex > &	value () const
bool	is_regex () const

Private Attributes
std::variant< T, regex >	value_

Constructor & Destructor Documentation

or_regex() [1/3]

template<typename T >

clanguml::common::or_regex< T >::or_regex ( )

default

or_regex() [2/3]

template<typename T >

clanguml::common::or_regex< T >::or_regex ( T  v )

inline

Constructor from alternative type.

Definition at line 282 of file types.h.

        : value_{std::move(v)}
    {
    }

or_regex() [3/3]

template<typename T >

clanguml::common::or_regex< T >::or_regex ( std::regex  r, std::string  p  )

inline

Constructor from regex.

Parameters

r	Parsed regular expression
p	Raw regular expression pattern used for regenerating config and debugging

Definition at line 294 of file types.h.

        : value_{regex{std::move(r), std::move(p)}}
    {
    }

Member Function Documentation

get()

template<typename T >

template<typename Ret >

std::optional< Ret > clanguml::common::or_regex< T >::get ( ) const

inline

Definition at line 319 of file types.h.

    {
        if (!std::holds_alternative<Ret>(value_))
            return std::nullopt;
 
        return std::get<Ret>(value_);
    }

is_regex()

template<typename T >

bool clanguml::common::or_regex< T >::is_regex ( ) const

inline

Definition at line 337 of file types.h.

{ return std::holds_alternative<regex>(value_); }

operator=() [1/2]

template<typename T >

or_regex & clanguml::common::or_regex< T >::operator= ( const regex &  v )

inline

Definition at line 305 of file types.h.

    {
        value_ = v;
        return *this;
    }

operator=() [2/2]

template<typename T >

or_regex & clanguml::common::or_regex< T >::operator= ( const T &  v )

inline

Definition at line 299 of file types.h.

    {
        value_ = v;
        return *this;
    }

operator==()

template<typename T >

bool clanguml::common::or_regex< T >::operator== ( const T &  v ) const

inline

Definition at line 311 of file types.h.

    {
        if (std::holds_alternative<regex>(value_))
            return std::regex_match(v, std::get<regex>(value_).regexp);
 
        return std::get<T>(value_) == v;
    }

to_string()

template<typename T >

std::string clanguml::common::or_regex< T >::to_string ( ) const

inline

Definition at line 327 of file types.h.

    {
        if (std::holds_alternative<regex>(value_))
            return std::get<regex>(value_).pattern;
 
        return clanguml::common::to_string(std::get<T>(value_));
    }

value()

template<typename T >

const std::variant< T, regex > & clanguml::common::or_regex< T >::value ( ) const

inline

Definition at line 335 of file types.h.

{ return value_; }

Member Data Documentation

value_

template<typename T >

std::variant<T, regex> clanguml::common::or_regex< T >::value_

private

Definition at line 340 of file types.h.

---

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

• src/common/types.h