Catch Namespace Reference

Namespaces
namespace	Detail
namespace	Generators
namespace	Internal
namespace	Matchers
Classes
struct	AssertionInfo
class	AssertionResult
struct	AssertionResultData
struct	AutoReg
class	BetweenGenerator
class	CompositeGenerator
struct	CopyableStream
struct	Counts
class	ExceptionTranslatorRegistrar
class	ExpressionLhs
struct	IContext
struct	IExceptionTranslator
struct	IExceptionTranslatorRegistry
struct	IGenerator
struct	IGeneratorInfo
struct	IGeneratorsForTest
struct	IMutableContext
struct	IMutableRegistryHub
struct	IRegistryHub
struct	IResultCapture
struct	IRunner
struct	IShared
struct	ITagAliasRegistry
struct	ITestCase
struct	ITestCaseRegistry
struct	MessageBuilder
struct	MessageInfo
class	MethodTestCase
struct	NameAndDesc
class	NonCopyable
class	NotImplementedException
class	Option
struct	pluralise
class	Ptr
struct	RegistrarForTagAliases
class	ResultBuilder
struct	ResultDisposition
struct	ResultWas
class	SafeBool
class	ScopedMessage
class	Section
struct	SectionInfo
struct	SharedImpl
struct	SourceLineInfo
struct	StreamEndStop
struct	StringMaker
struct	StringMaker< R C::* >
struct	StringMaker< T * >
struct	TagAlias
class	TestCase
struct	TestCaseInfo
struct	TestFailureException
class	Timer
struct	Totals
class	ValuesGenerator
Typedefs
typedef std::string(*	exceptionTranslateFunction )()
typedef void(*	TestFunction )()
Functions
bool	alwaysFalse ()
bool	alwaysTrue ()
void	cleanUp ()
void	cleanUpContext ()
bool	contains (std::string const &s, std::string const &infix)
IGeneratorsForTest *	createGeneratorsForTest ()
Stream	createStream (std::string const &streamName)
template<typename ContainerT >
void	deleteAll (ContainerT &container)
template<typename AssociativeContainerT >
void	deleteAllValues (AssociativeContainerT &container)
bool	endsWith (std::string const &s, std::string const &suffix)
IContext &	getCurrentContext ()
IMutableContext &	getCurrentMutableContext ()
IMutableRegistryHub &	getMutableRegistryHub ()
IRegistryHub &	getRegistryHub ()
IResultCapture &	getResultCapture ()
bool	isDebuggerActive ()
bool	isFalseTest (int flags)
bool	isJustInfo (int flags)
bool	isOk (ResultWas::OfType resultType)
bool	isTrue (bool value)
TestCase	makeTestCase (ITestCase *testCase, std::string const &className, std::string const &name, std::string const &description, SourceLineInfo const &lineInfo)
template<typename T >
T const &	operator+ (T const &value, StreamEndStop)
std::ostream &	operator<< (std::ostream &os, SourceLineInfo const &info)
ResultDisposition::Flags	operator| (ResultDisposition::Flags lhs, ResultDisposition::Flags rhs)
bool	replaceInPlace (std::string &str, std::string const &replaceThis, std::string const &withThis)
bool	shouldContinueOnFailure (int flags)
bool	shouldSuppressFailure (int flags)
bool	startsWith (std::string const &s, std::string const &prefix)
void	throwLogicError (std::string const &message, SourceLineInfo const &locationInfo)
std::string	toLower (std::string const &s)
void	toLowerInPlace (std::string &s)
template<typename T >
std::string	toString (T const &value)
	converts any type to a string
std::string	toString (std::string const &value)
std::string	toString (std::wstring const &value)
std::string	toString (const char *const value)
std::string	toString (char *const value)
std::string	toString (const wchar_t *const value)
std::string	toString (wchar_t *const value)
std::string	toString (int value)
std::string	toString (unsigned long value)
std::string	toString (unsigned int value)
std::string	toString (const double value)
std::string	toString (const float value)
std::string	toString (bool value)
std::string	toString (char value)
std::string	toString (signed char value)
std::string	toString (unsigned char value)
template<typename T , typename Allocator >
std::string	toString (std::vector< T, Allocator > const &v)
template<>
std::string	toString< Detail::Approx > (Detail::Approx const &value)
std::string	translateActiveException ()
std::string	trim (std::string const &str)
void	writeToDebugConsole (std::string const &text)

---

Typedef Documentation

typedef std::string(* Catch::exceptionTranslateFunction)()

Definition at line 2054 of file catch.hpp.

typedef void(* Catch::TestFunction)()

Definition at line 555 of file catch.hpp.

---

Function Documentation

bool Catch::alwaysFalse

(

)

[inline]

Definition at line 311 of file catch.hpp.

bool Catch::alwaysTrue

(

)

[inline]

Definition at line 310 of file catch.hpp.

void Catch::cleanUp

(

)

void Catch::cleanUpContext

(

)

bool Catch::contains	(	std::string const &	s,
		std::string const &	infix
	)

IGeneratorsForTest* Catch::createGeneratorsForTest

(

)

Stream Catch::createStream

(

std::string const &

streamName

)

template<typename ContainerT >

void Catch::deleteAll

(

ContainerT &

container

)

[inline]

Definition at line 257 of file catch.hpp.

template<typename AssociativeContainerT >

void Catch::deleteAllValues

(

AssociativeContainerT &

container

)

[inline]

Definition at line 264 of file catch.hpp.

bool Catch::endsWith	(	std::string const &	s,
		std::string const &	suffix
	)

IContext& Catch::getCurrentContext

(

)

IMutableContext& Catch::getCurrentMutableContext

(

)

IMutableRegistryHub& Catch::getMutableRegistryHub

(

)

IRegistryHub& Catch::getRegistryHub

(

)

IResultCapture& Catch::getResultCapture

(

)

bool Catch::isDebuggerActive

(

)

bool Catch::isFalseTest

(

int

flags

)

[inline]

Definition at line 694 of file catch.hpp.

bool Catch::isJustInfo

(

int

flags

)

[inline]

Definition at line 676 of file catch.hpp.

bool Catch::isOk

(

ResultWas::OfType

resultType

)

[inline]

Definition at line 673 of file catch.hpp.

bool Catch::isTrue

(

bool

value

)

[inline]

Definition at line 309 of file catch.hpp.

TestCase Catch::makeTestCase	(	ITestCase *	testCase,
		std::string const &	className,
		std::string const &	name,
		std::string const &	description,
		SourceLineInfo const &	lineInfo
	)

template<typename T >

T const& Catch::operator+	(	T const &	value,
		StreamEndStop
	)

Definition at line 325 of file catch.hpp.

std::ostream& Catch::operator<<	(	std::ostream &	os,
		SourceLineInfo const &	info
	)

ResultDisposition::Flags Catch::operator|	(	ResultDisposition::Flags	lhs,
		ResultDisposition::Flags	rhs
	)		[inline]

Definition at line 689 of file catch.hpp.

bool Catch::replaceInPlace	(	std::string &	str,
		std::string const &	replaceThis,
		std::string const &	withThis
	)

bool Catch::shouldContinueOnFailure

(

int

flags

)

[inline]

Definition at line 693 of file catch.hpp.

bool Catch::shouldSuppressFailure

(

int

flags

)

[inline]

Definition at line 695 of file catch.hpp.

bool Catch::startsWith	(	std::string const &	s,
		std::string const &	prefix
	)

void Catch::throwLogicError	(	std::string const &	message,
		SourceLineInfo const &	locationInfo
	)

std::string Catch::toLower

(

std::string const &

s

)

void Catch::toLowerInPlace

(

std::string &

s

)

template<typename T >

std::string Catch::toString

(

T const &

value

)

converts any type to a string

The default template forwards on to ostringstream - except when an ostringstream overload does not exist - in which case it attempts to detect that and writes {?}. Overload (not specialise) this template for custom typs that you don't want to provide an ostream overload for.

Definition at line 1283 of file catch.hpp.

std::string Catch::toString

(

std::string const &

value

)

std::string Catch::toString

(

std::wstring const &

value

)

std::string Catch::toString

(

const char *const

value

)

std::string Catch::toString

(

char *const

value

)

std::string Catch::toString

(

const wchar_t *const

value

)

std::string Catch::toString

(

wchar_t *const

value

)

std::string Catch::toString

(

int

value

)

std::string Catch::toString

(

unsigned long

value

)

std::string Catch::toString

(

unsigned int

value

)

std::string Catch::toString

(

const double

value

)

std::string Catch::toString

(

const float

value

)

std::string Catch::toString

(

bool

value

)

std::string Catch::toString

(

char

value

)

std::string Catch::toString

(

signed char

value

)

std::string Catch::toString

(

unsigned char

value

)

template<typename T , typename Allocator >

std::string Catch::toString

(

std::vector< T, Allocator > const &

v

)

Definition at line 1222 of file catch.hpp.

template<>

std::string Catch::toString< Detail::Approx >

(

Detail::Approx const &

value

)

[inline]

Definition at line 2179 of file catch.hpp.

std::string Catch::translateActiveException

(

)

std::string Catch::trim

(

std::string const &

str

)

void Catch::writeToDebugConsole

(

std::string const &

text

)