doctest Namespace Reference

Namespaces
namespace	assertType
namespace	Color
namespace	detail
namespace	TestCaseFailureReason

Classes
struct	Approx
struct	AssertData
class	Contains
class	Context
struct	ContextOptions
	OCLINT too many fields. More...
struct	CurrentTestCaseStats
struct	description
struct	expected_failures
struct	IContextScope
struct	IReporter
struct	IsNaN
struct	may_fail
struct	MessageData
struct	no_breaks
struct	no_output
struct	QueryData
struct	should_fail
class	size_t
struct	skip
class	String
struct	StringMaker
struct	SubcaseSignature
struct	test_suite
struct	TestCaseData
struct	TestCaseException
struct	TestRunStats
struct	timeout

Functions
String	operator+ (const String &lhs, const String &rhs)
bool	operator== (const String &lhs, const String &rhs)
bool	operator!= (const String &lhs, const String &rhs)
bool	operator< (const String &lhs, const String &rhs)
bool	operator> (const String &lhs, const String &rhs)
bool	operator<= (const String &lhs, const String &rhs)
bool	operator>= (const String &lhs, const String &rhs)
String	toString (const Contains &in)
bool	operator== (const String &lhs, const Contains &rhs)
bool	operator== (const Contains &lhs, const String &rhs)
bool	operator!= (const String &lhs, const Contains &rhs)
bool	operator!= (const Contains &lhs, const String &rhs)
const char *	assertString (assertType::Enum at)
const char *	failureString (assertType::Enum at)
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 T &value)
String	toString (String in)
String	toString (std::nullptr_t)
String	toString (bool in)
String	toString (float in)
String	toString (double in)
String	toString (double long in)
String	toString (char in)
String	toString (char signed in)
String	toString (char unsigned in)
String	toString (short in)
String	toString (short unsigned in)
String	toString (signed in)
String	toString (unsigned in)
String	toString (long in)
String	toString (long unsigned in)
String	toString (long long in)
String	toString (long long unsigned in)
String	toString (const Approx &in)
const ContextOptions *	getContextOptions ()
String	toString (IsNaN< float > in)
String	toString (IsNaN< double > in)
String	toString (IsNaN< double long > in)
template<typename T>
int	registerExceptionTranslator (String(*translateFunction)(T))
template<typename Reporter>
int	registerReporter (const char *name, int priority, bool isReporter)

Variables
bool	is_running_in_test

Function Documentation

assertString()

const char * doctest::assertString

(

assertType::Enum

at

)

failureString()

const char * doctest::failureString

(

assertType::Enum

at

)

getContextOptions()

const ContextOptions * doctest::getContextOptions

(

)

operator!=() [1/3]

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

operator!=() [2/3]

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

operator!=() [3/3]

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

operator+()

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

operator<()

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

operator<=()

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

operator==() [1/3]

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

operator==() [2/3]

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

operator==() [3/3]

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

operator>()

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

operator>=()

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

registerExceptionTranslator()

template<typename T>

int doctest::registerExceptionTranslator

(

String(*

translateFunction )(T)

)

Definition at line 1935 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;
}

registerReporter()

template<typename Reporter>

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

Definition at line 2110 of file doctest.h.

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

skipPathFromFilename()

const char * doctest::skipPathFromFilename

(

const char *

file

)

toString() [1/24]

template<typename T>

String doctest::toString

(

)

Definition at line 1093 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
}

toString() [2/24]

String doctest::toString

(

bool

in

)

toString() [3/24]

String doctest::toString

(

char

in

)

toString() [4/24]

String doctest::toString

(

char signed

in

)

toString() [5/24]

String doctest::toString

(

char unsigned

in

)

toString() [6/24]

String doctest::toString

(

const Approx &

in

)

toString() [7/24]

String doctest::toString

(

const Contains &

in

)

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 T &

value

)

Definition at line 1106 of file doctest.h.

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

toString() [9/24]

String doctest::toString

(

double

in

)

toString() [10/24]

String doctest::toString

(

double long

in

)

toString() [11/24]

String doctest::toString

(

float

in

)

toString() [12/24]

String doctest::toString

(

IsNaN< double >

in

)

toString() [13/24]

String doctest::toString

(

IsNaN< double long >

in

)

toString() [14/24]

String doctest::toString

(

IsNaN< float >

in

)

toString() [15/24]

String doctest::toString

(

long

in

)

toString() [16/24]

String doctest::toString

(

long long

in

)

toString() [17/24]

String doctest::toString

(

long long unsigned

in

)

toString() [18/24]

String doctest::toString

(

long unsigned

in

)

toString() [19/24]

String doctest::toString

(

short

in

)

toString() [20/24]

String doctest::toString

(

short unsigned

in

)

toString() [21/24]

String doctest::toString

(

signed

in

)

toString() [22/24]

String doctest::toString

(

std::nullptr_t

)

toString() [23/24]

String doctest::toString

(

String

in

)

toString() [24/24]

String doctest::toString

(

unsigned

in

)

Variable Documentation

is_running_in_test

bool doctest::is_running_in_test

extern