doctest::detail Namespace Reference

Namespaces
namespace	assertAction
namespace	binaryAssertComparison
namespace	types

Classes
class	ContextScope
struct	ContextScopeBase
struct	deferred_false
class	ExceptionTranslator
	OCLINT destructor of virtual class. More...
struct	Expression_lhs
struct	ExpressionDecomposer
struct	filldata
struct	filldata< const char[N]>
struct	filldata< const void * >
struct	filldata< T * >
struct	filldata< T[N]>
struct	has_insertion_operator
struct	has_insertion_operator< T, decltype(operator<<(declval< std::ostream & >(), declval< const T & >()), void())>
struct	IExceptionTranslator
struct	MessageBuilder
struct	RelationalComparator
struct	RelationalComparator< 0, L, R >
struct	RelationalComparator< 1, L, R >
struct	RelationalComparator< 2, L, R >
struct	RelationalComparator< 3, L, R >
struct	RelationalComparator< 4, L, R >
struct	RelationalComparator< 5, L, R >
struct	Result
struct	ResultBuilder
struct	should_stringify_as_underlying_type
struct	StringMakerBase
struct	StringMakerBase< true >
struct	Subcase
struct	TestCase
struct	TestFailureException
struct	TestSuite

Typedefs
using	funcType = void (*)()
using	assert_handler = void (*)(const AssertData&)
using	reporterCreatorFunc = IReporter* (*)(const ContextOptions&)

Functions
template<typename T >
T &&	declval ()
template<class T >
constexpr T &&	forward (typename types::remove_reference< T >::type &t) noexcept
template<class T >
constexpr T &&	forward (typename types::remove_reference< T >::type &&t) noexcept
std::ostream *	tlssPush ()
String	tlssPop ()
template<typename T >
void	filloss (std::ostream *stream, const T &in)
template<typename T , size_t N>
void	filloss (std::ostream *stream, const T(&in)[N])
template<typename T >
String	toStream (const T &in)
bool	checkIfShouldThrow (assertType::Enum at)
void	throwException ()
template<typename L , typename R >
String	stringifyBinaryExpr (const L &lhs, const char *op, const R &rhs)
template<typename L , typename R >
bool	eq (const L &lhs, const R &rhs)
template<typename L , typename R >
bool	ne (const L &lhs, const R &rhs)
template<typename L , typename R >
bool	lt (const L &lhs, const R &rhs)
template<typename L , typename R >
bool	gt (const L &lhs, const R &rhs)
template<typename L , typename R >
bool	le (const L &lhs, const R &rhs)
template<typename L , typename R >
bool	ge (const L &lhs, const R &rhs)
int	regTest (const TestCase &tc)
int	setTestSuite (const TestSuite &ts)
bool	isDebuggerActive ()
template<typename T >
int	instantiationHelper (const T &)
void	failed_out_of_a_testing_context (const AssertData &ad)
bool	decomp_assert (assertType::Enum at, const char *file, int line, const char *expr, const Result &result)
template<int comparison, typename L , typename R >
	__attribute__ ((noinline)) bool binary_assert(assertType
template<typename L >
	__attribute__ ((noinline)) bool unary_assert(assertType
void	registerExceptionTranslatorImpl (const IExceptionTranslator *et)
template<typename L >
ContextScope< L >	MakeContextScope (const L &lambda)
void	registerReporterImpl (const char *name, int prio, reporterCreatorFunc c, bool isReporter)
template<typename Reporter >
IReporter *	reporterCreator (const ContextOptions &o)

Typedef Documentation

assert_handler

using doctest::detail::assert_handler = void (*)(const AssertData&)

Definition at line 1960 of file doctest.h.

funcType

using doctest::detail::funcType = void (*)()

Definition at line 1612 of file doctest.h.

reporterCreatorFunc

using doctest::detail::reporterCreatorFunc = IReporter* (*)(const ContextOptions&)

Definition at line 2099 of file doctest.h.

Function Documentation

__attribute__() [1/2]

template<int comparison, typename L , typename R >

doctest::detail::__attribute__

(

(noinline)

)

Definition at line 1764 of file doctest.h.

                                                                       {
        bool failed = !RelationalComparator<comparison, L, R>()(lhs, rhs);
 
        // ###################################################################################
        // IF THE DEBUGGER BREAKS HERE - GO 1 LEVEL UP IN THE CALLSTACK FOR THE FAILING ASSERT
        // THIS IS THE EFFECT OF HAVING 'DOCTEST_CONFIG_SUPER_FAST_ASSERTS' DEFINED
        // ###################################################################################
        DOCTEST_ASSERT_OUT_OF_TESTS(stringifyBinaryExpr(lhs, ", ", rhs));
        DOCTEST_ASSERT_IN_TESTS(stringifyBinaryExpr(lhs, ", ", rhs));
        return !failed;
    }

__attribute__() [2/2]

template<typename L >

doctest::detail::__attribute__

(

(noinline)

)

OCLINT bitwise operator in conditional

Definition at line 1779 of file doctest.h.

                                                                                        {
        bool failed = !val;
 
        if(at & assertType::is_false) 
            failed = !failed;
 
        // ###################################################################################
        // IF THE DEBUGGER BREAKS HERE - GO 1 LEVEL UP IN THE CALLSTACK FOR THE FAILING ASSERT
        // THIS IS THE EFFECT OF HAVING 'DOCTEST_CONFIG_SUPER_FAST_ASSERTS' DEFINED
        // ###################################################################################
        DOCTEST_ASSERT_OUT_OF_TESTS((DOCTEST_STRINGIFY(val)));
        DOCTEST_ASSERT_IN_TESTS((DOCTEST_STRINGIFY(val)));
        return !failed;
    }

checkIfShouldThrow()

bool doctest::detail::checkIfShouldThrow

(

assertType::Enum

at

)

declval()

template<typename T >

T && doctest::detail::declval

(

)

decomp_assert()

bool doctest::detail::decomp_assert	(	assertType::Enum	at,
		const char *	file,
		int	line,
		const char *	expr,
		const Result &	result )

eq()

template<typename L , typename R >

bool doctest::detail::eq	(	const L &	lhs,
		const R &	rhs )

Definition at line 1474 of file doctest.h.

failed_out_of_a_testing_context()

void doctest::detail::failed_out_of_a_testing_context

(

const AssertData &

ad

)

filloss() [1/2]

template<typename T >

void doctest::detail::filloss	(	std::ostream *	stream,
		const T &	in )

Definition at line 1052 of file doctest.h.

                                                  {
        filldata<T>::fill(stream, in);
    }

filloss() [2/2]

template<typename T , size_t N>

void doctest::detail::filloss	(	std::ostream *	stream,
		const T(&)	in[N] )

Definition at line 1057 of file doctest.h.

                                                       { // NOLINT(*-avoid-c-arrays)
        // T[N], T(&)[N], T(&&)[N] have same behaviour.
        // Hence remove reference.
        filloss<typename types::remove_reference<decltype(in)>::type>(stream, in);
    }

forward() [1/2]

template<class T >

constexpr T && doctest::detail::forward ( typename types::remove_reference< T >::type && t )

constexprnoexcept

Definition at line 988 of file doctest.h.

                                                                                                   {
        return static_cast<T&&>(t);
    }

forward() [2/2]

template<class T >

constexpr T && doctest::detail::forward ( typename types::remove_reference< T >::type & t )

constexprnoexcept

Definition at line 983 of file doctest.h.

                                                                                                  {
        return static_cast<T&&>(t);
    }

ge()

template<typename L , typename R >

bool doctest::detail::ge	(	const L &	lhs,
		const R &	rhs )

Definition at line 1479 of file doctest.h.

gt()

template<typename L , typename R >

bool doctest::detail::gt	(	const L &	lhs,
		const R &	rhs )

Definition at line 1477 of file doctest.h.

instantiationHelper()

template<typename T >

int doctest::detail::instantiationHelper

(

const T &

)

Definition at line 1653 of file doctest.h.

{ return 0; }

isDebuggerActive()

bool doctest::detail::isDebuggerActive

(

)

le()

template<typename L , typename R >

bool doctest::detail::le	(	const L &	lhs,
		const R &	rhs )

Definition at line 1478 of file doctest.h.

lt()

template<typename L , typename R >

bool doctest::detail::lt	(	const L &	lhs,
		const R &	rhs )

Definition at line 1476 of file doctest.h.

MakeContextScope()

template<typename L >

ContextScope< L > doctest::detail::MakeContextScope

(

const L &

lambda

)

Definition at line 1909 of file doctest.h.

                                                      {
        return ContextScope<L>(lambda);
    }

ne()

template<typename L , typename R >

bool doctest::detail::ne	(	const L &	lhs,
		const R &	rhs )

Definition at line 1475 of file doctest.h.

registerExceptionTranslatorImpl()

void doctest::detail::registerExceptionTranslatorImpl

(

const IExceptionTranslator *

et

)

registerReporterImpl()

void doctest::detail::registerReporterImpl	(	const char *	name,
		int	prio,
		reporterCreatorFunc	c,
		bool	isReporter )

regTest()

int doctest::detail::regTest

(

const TestCase &

tc

)

reporterCreator()

template<typename Reporter >

IReporter * doctest::detail::reporterCreator

(

const ContextOptions &

o

)

Definition at line 2104 of file doctest.h.

                                                        {
        return new Reporter(o);
    }

setTestSuite()

int doctest::detail::setTestSuite

(

const TestSuite &

ts

)

stringifyBinaryExpr()

template<typename L , typename R >

String doctest::detail::stringifyBinaryExpr	(	const L &	lhs,
		const char *	op,
		const R &	rhs )

Definition at line 1354 of file doctest.h.

                                                              {
        return (DOCTEST_STRINGIFY(lhs)) + op + (DOCTEST_STRINGIFY(rhs));
    }

throwException()

void doctest::detail::throwException

(

)

tlssPop()

String doctest::detail::tlssPop

(

)

tlssPush()

std::ostream * doctest::detail::tlssPush

(

)

toStream()

template<typename T >

String doctest::detail::toStream

(

const T &

in

)

Definition at line 1064 of file doctest.h.

                                 {
        std::ostream* stream = tlssPush();
        filloss(stream, in);
        return tlssPop();
    }