Root Class Reference

#include <Root.hh>

Inheritance diagram for Root:

Public Member Functions
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

Protected Member Functions
	Root (NotCurses *ncinst)
bool	is_notcurses_stopped () const noexcept

Static Protected Member Functions
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard (TValue ret, TValue error_value)
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard_cond (TValue ret, bool error_value)

Static Protected Attributes
static constexpr char	ncpp_invalid_state_message [] = "notcurses++ is in an invalid state (already stopped?)"

Detailed Description

Definition at line 20 of file Root.hh.

Constructor & Destructor Documentation

Root()

Root ( NotCurses *  ncinst )

inlineexplicitprotected

Definition at line 34 of file Root.hh.

            : nc (ncinst)
        {}

Member Function Documentation

error_guard()

template<typename TRet = bool, typename TValue = int>

static TRet error_guard ( TValue  ret, TValue  error_value  )

inlinestaticprotected

Definition at line 39 of file Root.hh.

        {
            static constexpr bool ret_is_bool = std::is_same_v<TRet, bool>;
 
            if constexpr (!ret_is_bool) {
                static_assert (std::is_same_v<TRet, TValue>, "Both TRet and TValue must be the same type unless TValue is 'bool'");
            }
 
            if (ret != error_value) {
                if constexpr (ret_is_bool) {
                    return true;
                } else {
                    return ret;
                }
            }
 
#if defined (NCPP_EXCEPTIONS_PLEASE)
            throw call_error ("Call returned an error value");
#else
            if constexpr (ret_is_bool) {
                return false;
            } else {
                return ret;
            }
#endif
        }

error_guard_cond()

template<typename TRet = bool, typename TValue = int>

static TRet error_guard_cond ( TValue  ret, bool  error_value  )

inlinestaticprotected

Definition at line 67 of file Root.hh.

        {
            static constexpr bool ret_is_bool = std::is_same_v<TRet, bool>;
 
            if constexpr (!ret_is_bool) {
                static_assert (std::is_same_v<TRet, TValue>, "Both TRet and TValue must be the same type unless TValue is 'bool'");
            }
 
            if (!error_value) {
                if constexpr (ret_is_bool) {
                    return true;
                } else {
                    return ret;
                }
            }
 
#if defined (NCPP_EXCEPTIONS_PLEASE)
            throw call_error ("Call returned an error value");
#else
            if constexpr (ret_is_bool) {
                return false;
            } else {
                return ret;
            }
#endif
        }

get_notcurses()

notcurses * get_notcurses

(

)

const

get_notcurses_cpp()

NotCurses * get_notcurses_cpp ( ) const

inline

Definition at line 28 of file Root.hh.

        {
            return nc;
        }

is_notcurses_stopped()

bool is_notcurses_stopped ( ) const

protectednoexcept

Field Documentation

ncpp_invalid_state_message

constexpr char ncpp_invalid_state_message[] = "notcurses++ is in an invalid state (already stopped?)"

staticconstexprprotected

Definition at line 23 of file Root.hh.

---

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

• /home/dank/src/dankamongmen/notcurses/include/ncpp/Root.hh