CYB::API::Assert Class Reference

Contains assertion functions. More...

#include <Assert.hpp>

Static Public Member Functions
static void	HCF (void) noexcept
	Indicates unreachable code. Implementation can be overriden by defining ASSERTION_OVERRIDE. More...
static void	Unimplemented (const char *const AFunction, const char *const AFile, const unsigned int ALine) noexcept
	Indicates an unimplemented function, calls HCF if ASSERTION_OVERRIDE is not defined. More...
static void	True (const bool AExpression) noexcept
	Assertion function. AExpression should always be evaluated. More...
static void	False (const bool AExpression) noexcept
	False assertion function. AExpression should always be evaluated. More...
template<typename AType >
static void	Equal (const AType &ALHS, const AType &ARHS) noexcept
	Equivalence assertion function. May not be evaluated. More...
template<typename AType , typename... AOtherTypes>
static void	Equal (const AType &ALHS, const AType &ARHS, AOtherTypes &&...ARHSs) noexcept
	Equal against one or more things assertion function. May not be evaluated. More...
template<typename AType >
static void	NotEqual (const AType &ALHS, const AType &ARHS) noexcept
	Unequivalence assertion function. May not be evaluated. More...
template<typename AType >
static void	LessThan (const AType &ALHS, const AType &ARHS) noexcept
	Less than assertion function. May not be evaluated. More...
template<typename AType >
static void	LessThanOrEqual (const AType &ALHS, const AType &ARHS) noexcept
	Less than or equal assertion function. May not be evaluated. More...

Detailed Description

Contains assertion functions.

Definition at line 36 of file Assert.hpp.

Member Function Documentation

template<typename AType >

static void CYB::API::Assert::Equal ( const AType &  ALHS, const AType &  ARHS  )

staticnoexcept

Equivalence assertion function. May not be evaluated.

Parameters

ALHS	the left hand side of the equation
ARHS	the right hand side of the equation

Template Parameters

AType

The type of ALHS and ARHS

Thread Safety

This function requires no thread safety

Here is the caller graph for this function:

template<typename AType , typename... AOtherTypes>

static void CYB::API::Assert::Equal ( const AType &  ALHS, const AType &  ARHS, AOtherTypes &&...  ARHSs  )

staticnoexcept

Equal against one or more things assertion function. May not be evaluated.

Parameters

ALHS	the left hand side of the equations
ARHS	the right hand side of the current equations
ARHSs	the right hand sides of the remaining equations

Template Parameters

AType	The type of ALHS
AOtherTypes	The types of ARHSs must be comparable with AType

Thread Safety

This function requires no thread safety

static void CYB::API::Assert::False ( const bool  AExpression )

staticnoexcept

False assertion function. AExpression should always be evaluated.

Parameters

AExpression

The expression to check. Will call HCF if true

Thread Safety

This function requires no thread safety

Here is the caller graph for this function:

void CYB::API::Assert::HCF ( void  )

staticnoexcept

Indicates unreachable code. Implementation can be overriden by defining ASSERTION_OVERRIDE.

Thread Safety

This function requires no thread safety

Definition at line 26 of file CYBEntry.cpp.

                                                {
    BREAK;
#ifdef TARGET_OS_WINDOWS
    __assume(false);
#else
    __builtin_unreachable();
#endif
}

Here is the caller graph for this function:

template<typename AType >

static void CYB::API::Assert::LessThan ( const AType &  ALHS, const AType &  ARHS  )

staticnoexcept

Less than assertion function. May not be evaluated.

Parameters

ALHS	the left hand side of the equation
ARHS	the right hand side of the equation

Template Parameters

AType

The type of ALHS and ARHS

Thread Safety

This function requires no thread safety

Here is the caller graph for this function:

template<typename AType >

static void CYB::API::Assert::LessThanOrEqual ( const AType &  ALHS, const AType &  ARHS  )

staticnoexcept

Less than or equal assertion function. May not be evaluated.

Parameters

ALHS	the left hand side of the equation
ARHS	the right hand side of the equation

Template Parameters

AType

The type of ALHS and ARHS

Thread Safety

This function requires no thread safety

Here is the caller graph for this function:

template<typename AType >

static void CYB::API::Assert::NotEqual ( const AType &  ALHS, const AType &  ARHS  )

staticnoexcept

Unequivalence assertion function. May not be evaluated.

Parameters

ALHS	the left hand side of the equation
ARHS	the right hand side of the equation

Template Parameters

AType

The type of ALHS and ARHS

Thread Safety

This function requires no thread safety

Here is the caller graph for this function:

static void CYB::API::Assert::True ( const bool  AExpression )

staticnoexcept

Assertion function. AExpression should always be evaluated.

Parameters

AExpression

The expression to check. Will call HCF if false

Thread Safety

This function requires no thread safety

Here is the caller graph for this function:

void CYB::API::Assert::Unimplemented ( const char *const  AFunction, const char *const  AFile, const unsigned int  ALine  )

staticnoexcept

Indicates an unimplemented function, calls HCF if ASSERTION_OVERRIDE is not defined.

Parameters

AFunction	Should be FUNCTION
AFile	Should be FILE
ALine	Should be LINE

Thread Safety

This function requires no thread safety

Definition at line 44 of file CYBEntry.cpp.

                                                                                                                        {
    static_cast<void>(AFunction);
    static_cast<void>(AFile);
    static_cast<void>(ALine);
    API::Assert::HCF();
}

Here is the call graph for this function:

---

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

• Engine/API/Declarations/Assert.hpp
• Executable/CYBEntry.cpp