doctest Namespace Reference

Namespaces
namespace	assertType
namespace	Color
namespace	detail
namespace	TestCaseFailureReason

Data Structures
struct	Approx
struct	AssertData
class	Contains
class	Context
struct	ContextOptions
	OCLINT too many fields. More...
struct	CurrentTestCaseStats
struct	IContextScope
struct	IReporter
struct	IsNaN
struct	MessageData
struct	QueryData
class	String
struct	StringMaker
struct	SubcaseSignature
struct	TestCaseData
struct	TestCaseException
struct	TestRunStats

Functions
DOCTEST_INTERFACE String	operator+ (const String &lhs, const String &rhs)
DOCTEST_INTERFACE bool	operator== (const String &lhs, const String &rhs)
DOCTEST_INTERFACE bool	operator!= (const String &lhs, const String &rhs)
DOCTEST_INTERFACE bool	operator< (const String &lhs, const String &rhs)
DOCTEST_INTERFACE bool	operator> (const String &lhs, const String &rhs)
DOCTEST_INTERFACE bool	operator<= (const String &lhs, const String &rhs)
DOCTEST_INTERFACE bool	operator>= (const String &lhs, const String &rhs)
DOCTEST_INTERFACE String	toString (const Contains &in)
DOCTEST_INTERFACE bool	operator== (const String &lhs, const Contains &rhs)
DOCTEST_INTERFACE bool	operator== (const Contains &lhs, const String &rhs)
DOCTEST_INTERFACE bool	operator!= (const String &lhs, const Contains &rhs)
DOCTEST_INTERFACE bool	operator!= (const Contains &lhs, const String &rhs)
DOCTEST_INTERFACE const char *	assertString (assertType::Enum at)
DOCTEST_INTERFACE const char *	failureString (assertType::Enum at)
DOCTEST_INTERFACE const char *	skipPathFromFilename (const char *file)
template<typename T >
String	toString ()
template<typename T , typename detail::types::enable_if<!detail::should_stringify_as_underlying_type< T >::value, bool >::type = true>
String	toString (const DOCTEST_REF_WRAP(T) value)
DOCTEST_INTERFACE String	toString (String in)
DOCTEST_INTERFACE String	toString (std::nullptr_t)
DOCTEST_INTERFACE String	toString (bool in)
DOCTEST_INTERFACE String	toString (float in)
DOCTEST_INTERFACE String	toString (double in)
DOCTEST_INTERFACE String	toString (double long in)
DOCTEST_INTERFACE String	toString (char in)
DOCTEST_INTERFACE String	toString (char signed in)
DOCTEST_INTERFACE String	toString (char unsigned in)
DOCTEST_INTERFACE String	toString (short in)
DOCTEST_INTERFACE String	toString (short unsigned in)
DOCTEST_INTERFACE String	toString (signed in)
DOCTEST_INTERFACE String	toString (unsigned in)
DOCTEST_INTERFACE String	toString (long in)
DOCTEST_INTERFACE String	toString (long unsigned in)
DOCTEST_INTERFACE String	toString (long long in)
DOCTEST_INTERFACE String	toString (long long unsigned in)
DOCTEST_INTERFACE String	toString (const Approx &in)
DOCTEST_INTERFACE const ContextOptions *	getContextOptions ()
DOCTEST_INTERFACE String	toString (IsNaN< float > in)
DOCTEST_INTERFACE String	toString (IsNaN< double > in)
DOCTEST_INTERFACE String	toString (IsNaN< double long > in)
	DOCTEST_DEFINE_DECORATOR (test_suite, const char *, "")
	DOCTEST_DEFINE_DECORATOR (description, const char *, "")
	DOCTEST_DEFINE_DECORATOR (skip, bool, true)
	DOCTEST_DEFINE_DECORATOR (no_breaks, bool, true)
	DOCTEST_DEFINE_DECORATOR (no_output, bool, true)
	DOCTEST_DEFINE_DECORATOR (timeout, double, 0)
	DOCTEST_DEFINE_DECORATOR (may_fail, bool, true)
	DOCTEST_DEFINE_DECORATOR (should_fail, bool, true)
	DOCTEST_DEFINE_DECORATOR (expected_failures, int, 0)
template<typename T >
int	registerExceptionTranslator (String(*translateFunction)(T))
template<typename Reporter >
int	registerReporter (const char *name, int priority, bool isReporter)

Variables
DOCTEST_INTERFACE bool	is_running_in_test
template struct DOCTEST_INTERFACE_DECL	IsNaN< float >
template struct DOCTEST_INTERFACE_DECL	IsNaN< double >
template struct DOCTEST_INTERFACE_DECL	IsNaN< long double >

Function Documentation

assertString()

DOCTEST_INTERFACE const char * doctest::assertString

(

assertType::Enum

at

)

DOCTEST_DEFINE_DECORATOR() [1/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	description	,
		const char *	,
		""	)

DOCTEST_DEFINE_DECORATOR() [2/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	expected_failures	,
		int	,
		0	)

DOCTEST_DEFINE_DECORATOR() [3/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	may_fail	,
		bool	,
		true	)

DOCTEST_DEFINE_DECORATOR() [4/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	no_breaks	,
		bool	,
		true	)

DOCTEST_DEFINE_DECORATOR() [5/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	no_output	,
		bool	,
		true	)

DOCTEST_DEFINE_DECORATOR() [6/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	should_fail	,
		bool	,
		true	)

DOCTEST_DEFINE_DECORATOR() [7/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	skip	,
		bool	,
		true	)

DOCTEST_DEFINE_DECORATOR() [8/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	test_suite	,
		const char *	,
		""	)

DOCTEST_DEFINE_DECORATOR() [9/9]

doctest::DOCTEST_DEFINE_DECORATOR	(	timeout	,
		double	,
		0	)

failureString()

DOCTEST_INTERFACE const char * doctest::failureString

(

assertType::Enum

at

)

getContextOptions()

DOCTEST_INTERFACE const ContextOptions * doctest::getContextOptions

(

)

References getContextOptions().

Referenced by doctest::detail::ResultBuilder::binary_assert(), getContextOptions(), doctest::detail::Expression_lhs< L >::operator Result(), and doctest::detail::ResultBuilder::unary_assert().

operator!=() [1/3]

DOCTEST_INTERFACE bool doctest::operator!=	(	const Contains &	lhs,
		const String &	rhs )

operator!=() [2/3]

DOCTEST_INTERFACE bool doctest::operator!=	(	const String &	lhs,
		const Contains &	rhs )

operator!=() [3/3]

DOCTEST_INTERFACE bool doctest::operator!=	(	const String &	lhs,
		const String &	rhs )

operator+()

DOCTEST_INTERFACE String doctest::operator+	(	const String &	lhs,
		const String &	rhs )

operator<()

DOCTEST_INTERFACE bool doctest::operator<	(	const String &	lhs,
		const String &	rhs )

operator<=()

DOCTEST_INTERFACE bool doctest::operator<=	(	const String &	lhs,
		const String &	rhs )

operator==() [1/3]

DOCTEST_INTERFACE bool doctest::operator==	(	const Contains &	lhs,
		const String &	rhs )

operator==() [2/3]

DOCTEST_INTERFACE bool doctest::operator==	(	const String &	lhs,
		const Contains &	rhs )

operator==() [3/3]

DOCTEST_INTERFACE bool doctest::operator==	(	const String &	lhs,
		const String &	rhs )

operator>()

DOCTEST_INTERFACE bool doctest::operator>	(	const String &	lhs,
		const String &	rhs )

operator>=()

DOCTEST_INTERFACE bool doctest::operator>=	(	const String &	lhs,
		const String &	rhs )

registerExceptionTranslator()

template<typename T >

int doctest::registerExceptionTranslator

(

String(*)(T)

translateFunction

)

Definition at line 1936 of file doctest.h.

                                                                {
    DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wexit-time-destructors")
    static detail::ExceptionTranslator<T> exceptionTranslator(translateFunction);
    DOCTEST_CLANG_SUPPRESS_WARNING_POP
    detail::registerExceptionTranslatorImpl(&exceptionTranslator);
    return 0;
}

References DOCTEST_CLANG_SUPPRESS_WARNING_POP, DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH, and registerExceptionTranslator().

Referenced by registerExceptionTranslator().

registerReporter()

template<typename Reporter >

int doctest::registerReporter	(	const char *	name,
		int	priority,
		bool	isReporter )

Definition at line 2111 of file doctest.h.

                                                                      {
    detail::registerReporterImpl(name, priority, detail::reporterCreator<Reporter>, isReporter);
    return 0;
}

References name, priority, and registerReporter().

Referenced by registerReporter().

skipPathFromFilename()

DOCTEST_INTERFACE const char * doctest::skipPathFromFilename

(

const char *

file

)

toString() [1/24]

template<typename T >

String doctest::toString

(

)

Definition at line 1094 of file doctest.h.

                  {
#if DOCTEST_CLANG == 0 && DOCTEST_GCC == 0 && DOCTEST_ICC == 0
    String ret = __FUNCSIG__; // class doctest::String __cdecl doctest::toString<TYPE>(void)
    String::size_type beginPos = ret.find('<');
    return ret.substr(beginPos + 1, ret.size() - beginPos - static_cast<String::size_type>(sizeof(">(void)")));
#else
    String ret = __PRETTY_FUNCTION__; // doctest::String toString() [with T = TYPE]
    String::size_type begin = ret.find('=') + 2;
    return ret.substr(begin, ret.size() - begin - 1);
#endif
}

References doctest::String::find(), doctest::String::size(), doctest::String::substr(), and toString().

toString() [2/24]

DOCTEST_INTERFACE String doctest::toString

(

bool

in

)

References toString().

toString() [3/24]

DOCTEST_INTERFACE String doctest::toString

(

char

in

)

References toString().

toString() [4/24]

DOCTEST_INTERFACE String doctest::toString

(

char signed

in

)

References toString().

toString() [5/24]

DOCTEST_INTERFACE String doctest::toString

(

char unsigned

in

)

References toString().

toString() [6/24]

DOCTEST_INTERFACE String doctest::toString

(

const Approx &

in

)

References toString().

toString() [7/24]

DOCTEST_INTERFACE String doctest::toString

(

const Contains &

in

)

Referenced by toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), toString(), and toString().

toString() [8/24]

template<typename T , typename detail::types::enable_if<!detail::should_stringify_as_underlying_type< T >::value, bool >::type = true>

String doctest::toString

(

const DOCTEST_REF_WRAP(T)

value

)

Definition at line 1107 of file doctest.h.

                                                 {
    return StringMaker<T>::convert(value);
}

References toString(), and value.

toString() [9/24]

DOCTEST_INTERFACE String doctest::toString

(

double

in

)

References toString().

toString() [10/24]

DOCTEST_INTERFACE String doctest::toString

(

double long

in

)

References toString().

toString() [11/24]

DOCTEST_INTERFACE String doctest::toString

(

float

in

)

References toString().

toString() [12/24]

DOCTEST_INTERFACE String doctest::toString

(

IsNaN< double >

in

)

References toString().

toString() [13/24]

DOCTEST_INTERFACE String doctest::toString

(

IsNaN< double long >

in

)

References toString().

toString() [14/24]

DOCTEST_INTERFACE String doctest::toString

(

IsNaN< float >

in

)

References toString().

toString() [15/24]

DOCTEST_INTERFACE String doctest::toString

(

long

in

)

References toString().

toString() [16/24]

DOCTEST_INTERFACE String doctest::toString

(

long long

in

)

References toString().

toString() [17/24]

DOCTEST_INTERFACE String doctest::toString

(

long long unsigned

in

)

References toString().

toString() [18/24]

DOCTEST_INTERFACE String doctest::toString

(

long unsigned

in

)

References toString().

toString() [19/24]

DOCTEST_INTERFACE String doctest::toString

(

short

in

)

References toString().

toString() [20/24]

DOCTEST_INTERFACE String doctest::toString

(

short unsigned

in

)

References toString().

toString() [21/24]

DOCTEST_INTERFACE String doctest::toString

(

signed

in

)

References toString().

toString() [22/24]

DOCTEST_INTERFACE String doctest::toString

(

std::nullptr_t

)

References toString().

toString() [23/24]

DOCTEST_INTERFACE String doctest::toString

(

String

in

)

References toString().

toString() [24/24]

DOCTEST_INTERFACE String doctest::toString

(

unsigned

in

)

References toString().

Variable Documentation

is_running_in_test

DOCTEST_INTERFACE bool doctest::is_running_in_test

extern

IsNaN< double >

template struct DOCTEST_INTERFACE_DECL doctest::IsNaN< double >

extern

IsNaN< float >

template struct DOCTEST_INTERFACE_DECL doctest::IsNaN< float >

extern

IsNaN< long double >

template struct DOCTEST_INTERFACE_DECL doctest::IsNaN< long double >

extern