Catch Namespace Reference

Namespaces
namespace	Detail
namespace	detail
namespace	Generators
namespace	literals
namespace	Matchers

Classes
struct	always_false
class	AssertionHandler
struct	AssertionInfo
struct	AssertionReaction
struct	AutoReg
class	BinaryExpr
class	Capturer
struct	CaseSensitive
struct	Counts
struct	Decomposer
class	ExceptionTranslatorRegistrar
class	ExprLhs
class	GeneratorException
struct	IContext
struct	IExceptionTranslator
struct	IExceptionTranslatorRegistry
struct	IGeneratorTracker
struct	IMutableContext
struct	IMutableEnumValuesRegistry
struct	IResultCapture
struct	is_callable
struct	is_callable< Fun(Args...)>
struct	is_callable_tester
struct	is_range
struct	IStream
struct	ITestCaseRegistry
struct	ITestInvoker
struct	ITransientExpression
class	LazyExpression
struct	MessageBuilder
struct	MessageInfo
struct	MessageStream
struct	NameAndTags
class	NonCopyable
struct	pluralise
struct	RegistrarForTagAliases
struct	ResultDisposition
struct	ResultWas
class	ReusableStringStream
class	ScopedMessage
class	Section
struct	SectionEndInfo
struct	SectionInfo
class	SimplePcg32
struct	SourceLineInfo
struct	StreamEndStop
struct	StringMaker
struct	StringMaker< bool >
struct	StringMaker< Catch::Detail::Approx >
struct	StringMaker< char * >
struct	StringMaker< char >
struct	StringMaker< char const * >
struct	StringMaker< char[SZ]>
struct	StringMaker< double >
struct	StringMaker< float >
struct	StringMaker< int >
struct	StringMaker< long >
struct	StringMaker< long long >
struct	StringMaker< R C::* >
struct	StringMaker< R, typename std::enable_if< is_range< R >::value &&!::Catch::Detail::IsStreamInsertable< R >::value >::type >
struct	StringMaker< signed char >
struct	StringMaker< signed char[SZ]>
struct	StringMaker< std::nullptr_t >
struct	StringMaker< std::string >
struct	StringMaker< std::wstring >
struct	StringMaker< T * >
struct	StringMaker< T[SZ]>
struct	StringMaker< unsigned char >
struct	StringMaker< unsigned char[SZ]>
struct	StringMaker< unsigned int >
struct	StringMaker< unsigned long >
struct	StringMaker< unsigned long long >
struct	StringMaker< wchar_t * >
struct	StringMaker< wchar_t const * >
class	StringRef
	A non-owning string class (similar to the forthcoming std::string_view) Note that, because a StringRef may be a substring of another string, it may not be null terminated. More...
class	TestCase
struct	TestCaseInfo
struct	TestFailureException
class	TestInvokerAsMethod
class	Timer
struct	Totals
struct	true_given
class	UnaryExpr

Typedefs
template<typename Func , typename... U>
using	FunctionReturnType = typename std::remove_reference< typename std::remove_cv< typename std::result_of< Func(U...)>::type >::type >::type
using	exceptionTranslateFunction = std::string(*)()
using	ExceptionTranslators = std::vector< std::unique_ptr< IExceptionTranslator const > >
using	IConfigPtr = std::shared_ptr< IConfig const >

Functions
unsigned int	rngSeed ()
std::ostream &	operator<< (std::ostream &os, SourceLineInfo const &info)
template<typename T >
T const &	operator+ (T const &value, StreamEndStop)
bool	isThrowSafe (TestCase const &testCase, IConfig const &config)
bool	matchTest (TestCase const &testCase, TestSpec const &testSpec, IConfig const &config)
std::vector< TestCase >	filterTests (std::vector< TestCase > const &testCases, TestSpec const &testSpec, IConfig const &config)
std::vector< TestCase > const &	getAllTestCasesSorted (IConfig const &config)
auto	operator+= (std::string &lhs, StringRef const &sr) -> std::string &
auto	operator<< (std::ostream &os, StringRef const &sr) -> std::ostream &
constexpr auto	operator""_sr (char const *rawChars, std::size_t size) noexcept -> StringRef
auto	makeTestInvoker (void(*testAsFunction)()) noexcept -> ITestInvoker *
template<typename C >
auto	makeTestInvoker (void(C::*testAsMethod)()) noexcept -> ITestInvoker *
bool	isOk (ResultWas::OfType resultType)
bool	isJustInfo (int flags)
ResultDisposition::Flags	operator| (ResultDisposition::Flags lhs, ResultDisposition::Flags rhs)
bool	shouldContinueOnFailure (int flags)
bool	isFalseTest (int flags)
bool	shouldSuppressFailure (int flags)
std::ostream &	cout ()
std::ostream &	cerr ()
std::ostream &	clog ()
auto	makeStream (StringRef const &filename) -> IStream const *
template<typename Range >
std::string	rangeToString (Range const &range)
template<typename Allocator >
std::string	rangeToString (std::vector< bool, Allocator > const &v)
void	formatReconstructedExpression (std::ostream &os, std::string const &lhs, StringRef op, std::string const &rhs)
template<typename LhsT , typename RhsT >
auto	compareEqual (LhsT const &lhs, RhsT const &rhs) -> bool
template<typename T >
auto	compareEqual (T *const &lhs, int rhs) -> bool
template<typename T >
auto	compareEqual (T *const &lhs, long rhs) -> bool
template<typename T >
auto	compareEqual (int lhs, T *const &rhs) -> bool
template<typename T >
auto	compareEqual (long lhs, T *const &rhs) -> bool
template<typename LhsT , typename RhsT >
auto	compareNotEqual (LhsT const &lhs, RhsT &&rhs) -> bool
template<typename T >
auto	compareNotEqual (T *const &lhs, int rhs) -> bool
template<typename T >
auto	compareNotEqual (T *const &lhs, long rhs) -> bool
template<typename T >
auto	compareNotEqual (int lhs, T *const &rhs) -> bool
template<typename T >
auto	compareNotEqual (long lhs, T *const &rhs) -> bool
void	handleExpression (ITransientExpression const &expr)
template<typename T >
void	handleExpression (ExprLhs< T > const &expr)
IResultCapture &	getResultCapture ()
void	handleExceptionMatchExpr (AssertionHandler &handler, std::string const &str, StringRef const &matcherString)
auto	getCurrentNanosecondsSinceEpoch () -> uint64_t
auto	getEstimatedClockResolution () -> uint64_t
bool	startsWith (std::string const &s, std::string const &prefix)
bool	startsWith (std::string const &s, char prefix)
bool	endsWith (std::string const &s, std::string const &suffix)
bool	endsWith (std::string const &s, char suffix)
bool	contains (std::string const &s, std::string const &infix)
void	toLowerInPlace (std::string &s)
std::string	toLower (std::string const &s)
std::string	trim (std::string const &str)
	Returns a new string without whitespace at the start/end.
StringRef	trim (StringRef ref)
	Returns a substring of the original ref without whitespace. Beware lifetimes!
std::vector< StringRef >	splitStringRef (StringRef str, char delimiter)
bool	replaceInPlace (std::string &str, std::string const &replaceThis, std::string const &withThis)
void	throw_exception (std::exception const &e)
void	throw_logic_error (std::string const &msg)
void	throw_domain_error (std::string const &msg)
void	throw_runtime_error (std::string const &msg)
IMutableContext &	getCurrentMutableContext ()
IContext &	getCurrentContext ()
void	cleanUpContext ()
SimplePcg32 &	rng ()
TestCase	makeTestCase (ITestInvoker *testCase, std::string const &className, NameAndTags const &nameAndTags, SourceLineInfo const &lineInfo)

Typedef Documentation

FunctionReturnType

template<typename Func , typename... U>

using FunctionReturnType = typename std::remove_reference<typename std::remove_cv<typename std::result_of<Func(U...)>::type>::type>::type

exceptionTranslateFunction

using exceptionTranslateFunction = std::string(*)()

ExceptionTranslators

using ExceptionTranslators = std::vector<std::unique_ptr<IExceptionTranslator const> >

IConfigPtr

typedef std::shared_ptr< IConfig const > IConfigPtr

Function Documentation

rngSeed()

unsigned int rngSeed

(

)

operator<<() [1/2]

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

operator+()

template<typename T >

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

isThrowSafe()

bool isThrowSafe	(	TestCase const &	testCase,
		IConfig const &	config
	)

matchTest()

bool matchTest	(	TestCase const &	testCase,
		TestSpec const &	testSpec,
		IConfig const &	config
	)

filterTests()

std::vector< TestCase > filterTests	(	std::vector< TestCase > const &	testCases,
		TestSpec const &	testSpec,
		IConfig const &	config
	)

getAllTestCasesSorted()

std::vector< TestCase > const & getAllTestCasesSorted

(

IConfig const &

config

)

operator+=()

auto operator+=	(	std::string &	lhs,
		StringRef const &	sr
	)		-> std::string &

operator<<() [2/2]

auto operator<<	(	std::ostream &	os,
		StringRef const &	sr
	)		-> std::ostream &

operator""_sr()

constexpr auto operator""_sr ( char const *  rawChars, std::size_t  size  ) -> StringRef

constexprnoexcept

makeTestInvoker() [1/2]

auto makeTestInvoker ( void(*)()  testAsFunction ) -> ITestInvoker *

noexcept

makeTestInvoker() [2/2]

template<typename C >

auto makeTestInvoker ( void(C::*)()  testAsMethod ) -> ITestInvoker*

noexcept

isOk()

bool isOk

(

ResultWas::OfType

resultType

)

isJustInfo()

bool isJustInfo

(

int

flags

)

operator|()

ResultDisposition::Flags operator|	(	ResultDisposition::Flags	lhs,
		ResultDisposition::Flags	rhs
	)

shouldContinueOnFailure()

bool shouldContinueOnFailure

(

int

flags

)

isFalseTest()

bool isFalseTest

(

int

flags

)

References ResultDisposition::FalseTest.

shouldSuppressFailure()

bool shouldSuppressFailure

(

int

flags

)

cout()

std::ostream & cout

(

)

cerr()

std::ostream & cerr

(

)

clog()

std::ostream & clog

(

)

makeStream()

auto makeStream

(

StringRef const &

filename

)

-> IStream const *

rangeToString() [1/2]

template<typename Range >

std::string rangeToString

(

Range const &

range

)

Referenced by StringMaker< R, typename std::enable_if< is_range< R >::value &&!::Catch::Detail::IsStreamInsertable< R >::value >::type >::convert(), and StringMaker< T[SZ]>::convert().

rangeToString() [2/2]

template<typename Allocator >

std::string rangeToString

(

std::vector< bool, Allocator > const &

v

)

References ReusableStringStream::str(), and Catch::Detail::stringify().

formatReconstructedExpression()

void formatReconstructedExpression	(	std::ostream &	os,
		std::string const &	lhs,
		StringRef	op,
		std::string const &	rhs
	)

compareEqual() [1/5]

template<typename LhsT , typename RhsT >

auto compareEqual	(	LhsT const &	lhs,
		RhsT const &	rhs
	)		-> bool

Referenced by ExprLhs< LhsT >::operator==().

compareEqual() [2/5]

template<typename T >

auto compareEqual	(	T *const &	lhs,
		int	rhs
	)		-> bool

compareEqual() [3/5]

template<typename T >

auto compareEqual	(	T *const &	lhs,
		long	rhs
	)		-> bool

compareEqual() [4/5]

template<typename T >

auto compareEqual	(	int	lhs,
		T *const &	rhs
	)		-> bool

compareEqual() [5/5]

template<typename T >

auto compareEqual	(	long	lhs,
		T *const &	rhs
	)		-> bool

compareNotEqual() [1/5]

template<typename LhsT , typename RhsT >

auto compareNotEqual	(	LhsT const &	lhs,
		RhsT &&	rhs
	)		-> bool

Referenced by ExprLhs< LhsT >::operator!=().

compareNotEqual() [2/5]

template<typename T >

auto compareNotEqual	(	T *const &	lhs,
		int	rhs
	)		-> bool

compareNotEqual() [3/5]

template<typename T >

auto compareNotEqual	(	T *const &	lhs,
		long	rhs
	)		-> bool

compareNotEqual() [4/5]

template<typename T >

auto compareNotEqual	(	int	lhs,
		T *const &	rhs
	)		-> bool

compareNotEqual() [5/5]

template<typename T >

auto compareNotEqual	(	long	lhs,
		T *const &	rhs
	)		-> bool

handleExpression() [1/2]

void handleExpression

(

ITransientExpression const &

expr

)

Referenced by handleExpression().

handleExpression() [2/2]

template<typename T >

void handleExpression

(

ExprLhs< T > const &

expr

)

References handleExpression(), and ExprLhs< LhsT >::makeUnaryExpr().

getResultCapture()

IResultCapture & getResultCapture

(

)

handleExceptionMatchExpr()

void handleExceptionMatchExpr	(	AssertionHandler &	handler,
		std::string const &	str,
		StringRef const &	matcherString
	)

getCurrentNanosecondsSinceEpoch()

auto getCurrentNanosecondsSinceEpoch

(

)

-> uint64_t

References getCurrentNanosecondsSinceEpoch().

Referenced by getCurrentNanosecondsSinceEpoch().

getEstimatedClockResolution()

auto getEstimatedClockResolution

(

)

-> uint64_t

References getEstimatedClockResolution().

Referenced by getEstimatedClockResolution().

startsWith() [1/2]

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

References startsWith().

Referenced by startsWith(), and startsWith().

startsWith() [2/2]

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

References startsWith().

endsWith() [1/2]

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

References endsWith().

Referenced by endsWith(), and endsWith().

endsWith() [2/2]

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

References endsWith().

contains()

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

References contains().

Referenced by contains().

toLowerInPlace()

void toLowerInPlace

(

std::string &

s

)

References toLowerInPlace().

Referenced by toLowerInPlace().

toLower()

std::string toLower

(

std::string const &

s

)

References toLower().

Referenced by toLower().

trim() [1/2]

std::string trim

(

std::string const &

str

)

Returns a new string without whitespace at the start/end.

References trim().

Referenced by trim(), and trim().

trim() [2/2]

StringRef trim

(

StringRef

ref

)

Returns a substring of the original ref without whitespace. Beware lifetimes!

References trim().

splitStringRef()

std::vector< StringRef > splitStringRef	(	StringRef	str,
		char	delimiter
	)

References splitStringRef().

Referenced by splitStringRef().

replaceInPlace()

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

References replaceInPlace().

Referenced by replaceInPlace().

throw_exception()

void throw_exception

(

std::exception const &

e

)

References throw_exception().

Referenced by ChunkGenerator< T >::ChunkGenerator(), FilterGenerator< T, Predicate >::FilterGenerator(), IGeneratorTracker::setGenerator(), and throw_exception().

throw_logic_error()

void throw_logic_error

(

std::string const &

msg

)

References throw_logic_error().

Referenced by throw_logic_error().

throw_domain_error()

void throw_domain_error

(

std::string const &

msg

)

References throw_domain_error().

Referenced by throw_domain_error().

throw_runtime_error()

void throw_runtime_error

(

std::string const &

msg

)

References throw_runtime_error().

Referenced by throw_runtime_error().

getCurrentMutableContext()

IMutableContext & getCurrentMutableContext

(

)

Referenced by getCurrentContext(), and IMutableContext::setConfig().

getCurrentContext()

IContext & getCurrentContext

(

)

References getCurrentContext(), and getCurrentMutableContext().

Referenced by getCurrentContext().

cleanUpContext()

void cleanUpContext

(

)

References cleanUpContext().

Referenced by cleanUpContext().

rng()

SimplePcg32 & rng

(

)

References rng().

Referenced by rng().

makeTestCase()

TestCase makeTestCase	(	ITestInvoker *	testCase,
		std::string const &	className,
		NameAndTags const &	nameAndTags,
		SourceLineInfo const &	lineInfo
	)

References makeTestCase().

Referenced by makeTestCase().