Catch Namespace Reference

Namespaces
	Detail
	detail
	Generators
	literals
	Matchers

Classes
struct	CaseSensitive
class	NonCopyable
struct	SourceLineInfo
struct	StreamEndStop
struct	RegistrarForTagAliases
struct	ITestInvoker
struct	ITestCaseRegistry
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...
struct	always_false
struct	true_given
struct	is_callable_tester
struct	is_callable
struct	is_callable< Fun(Args...)>
class	TestInvokerAsMethod
struct	NameAndTags
struct	AutoReg
struct	ResultWas
struct	ResultDisposition
struct	AssertionInfo
struct	IStream
class	ReusableStringStream
struct	IMutableEnumValuesRegistry
struct	StringMaker
struct	StringMaker< std::string >
struct	StringMaker< char const * >
struct	StringMaker< char * >
struct	StringMaker< std::wstring >
struct	StringMaker< wchar_t const * >
struct	StringMaker< wchar_t * >
struct	StringMaker< char[SZ]>
struct	StringMaker< signed char[SZ]>
struct	StringMaker< unsigned char[SZ]>
struct	StringMaker< int >
struct	StringMaker< long >
struct	StringMaker< long long >
struct	StringMaker< unsigned int >
struct	StringMaker< unsigned long >
struct	StringMaker< unsigned long long >
struct	StringMaker< bool >
struct	StringMaker< char >
struct	StringMaker< signed char >
struct	StringMaker< unsigned char >
struct	StringMaker< std::nullptr_t >
struct	StringMaker< float >
struct	StringMaker< double >
struct	StringMaker< T * >
struct	StringMaker< R C::* >
struct	is_range
struct	StringMaker< R, typename std::enable_if< is_range< R >::value &&!::Catch::Detail::IsStreamInsertable< R >::value >::type >
struct	StringMaker< T[SZ]>
struct	ITransientExpression
class	BinaryExpr
class	UnaryExpr
class	ExprLhs
struct	Decomposer
struct	IResultCapture
struct	TestFailureException
class	LazyExpression
struct	AssertionReaction
class	AssertionHandler
struct	MessageInfo
struct	MessageStream
struct	MessageBuilder
class	ScopedMessage
class	Capturer
struct	Counts
struct	Totals
struct	SectionInfo
struct	SectionEndInfo
class	Timer
class	Section
struct	IRegistryHub
struct	IMutableRegistryHub
struct	IExceptionTranslator
struct	IExceptionTranslatorRegistry
class	ExceptionTranslatorRegistrar
struct	StringMaker< Catch::Detail::Approx >
struct	pluralise
class	MatchExpr
struct	IGeneratorTracker
class	GeneratorException
struct	IContext
struct	IMutableContext
class	Option
struct	WarnAbout
struct	ShowDurations
struct	RunTests
struct	UseColour
struct	WaitForKeypress
struct	IConfig
class	SimplePcg32
struct	TestCaseInfo
class	TestCase
struct	IRunner

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	IReporterFactoryPtr = std::shared_ptr< IReporterFactory >
using	exceptionTranslateFunction = std::string(*)()
using	ExceptionTranslators = std::vector< std::unique_ptr< IExceptionTranslator const > >
using	StringMatcher = Matchers::Impl::MatcherBase< std::string >
using	IConfigPtr = std::shared_ptr< IConfig const >

Enumerations
enum class	Verbosity { Quiet = 0 , Normal , High }

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
IRegistryHub const &	getRegistryHub ()
IMutableRegistryHub &	getMutableRegistryHub ()
void	cleanUp ()
std::string	translateActiveException ()
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. More...
StringRef	trim (StringRef ref)
	Returns a substring of the original ref without whitespace. Beware lifetimes! More...
std::vector< StringRef >	splitStringRef (StringRef str, char delimiter)
bool	replaceInPlace (std::string &str, std::string const &replaceThis, std::string const &withThis)
void	handleExceptionMatchExpr (AssertionHandler &handler, StringMatcher const &matcher, StringRef const &matcherString)
template<typename ArgT , typename MatcherT >
auto	makeMatchExpr (ArgT const &arg, MatcherT const &matcher, StringRef const &matcherString) -> MatchExpr< ArgT, MatcherT >
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

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

IReporterFactoryPtr

using IReporterFactoryPtr = std::shared_ptr<IReporterFactory>

exceptionTranslateFunction

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

ExceptionTranslators

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

StringMatcher

using StringMatcher = Matchers::Impl::MatcherBase<std::string>

IConfigPtr

typedef std::shared_ptr< IConfig const > IConfigPtr

Enumeration Type Documentation

Verbosity

enum Verbosity

strong

Enumerator
Quiet
Normal
High

Function Documentation

rngSeed()

unsigned int Catch::rngSeed

(

)

operator<<() [1/2]

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

operator+()

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

References Catch::Generators::value().

isThrowSafe()

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

matchTest()

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

filterTests()

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

getAllTestCasesSorted()

std::vector<TestCase> const& Catch::getAllTestCasesSorted

(

IConfig const &

config

)

operator+=()

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

operator<<() [2/2]

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

operator""_sr()

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

constexprnoexcept

makeTestInvoker() [1/2]

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

noexcept

makeTestInvoker() [2/2]

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

noexcept

isOk()

bool Catch::isOk

(

ResultWas::OfType

resultType

)

isJustInfo()

bool Catch::isJustInfo

(

int

flags

)

operator|()

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

shouldContinueOnFailure()

bool Catch::shouldContinueOnFailure

(

int

flags

)

isFalseTest()

bool Catch::isFalseTest

(

int

flags

)

References ResultDisposition::FalseTest.

shouldSuppressFailure()

bool Catch::shouldSuppressFailure

(

int

flags

)

cout()

std::ostream& Catch::cout

(

)

Referenced by FolderADAA< pts >::evaluate().

cerr()

std::ostream& Catch::cerr

(

)

clog()

std::ostream& Catch::clog

(

)

makeStream()

auto Catch::makeStream

(

StringRef const &

filename

)

-> IStream const *

rangeToString() [1/2]

std::string Catch::rangeToString

(

Range const &

range

)

References Catch::Generators::range(), and rangeToString().

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]

std::string Catch::rangeToString

(

std::vector< bool, Allocator > const &

v

)

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

Referenced by rangeToString().

formatReconstructedExpression()

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

compareEqual() [1/5]

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

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

compareEqual() [2/5]

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

compareEqual() [3/5]

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

compareEqual() [4/5]

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

compareEqual() [5/5]

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

compareNotEqual() [1/5]

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

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

compareNotEqual() [2/5]

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

compareNotEqual() [3/5]

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

compareNotEqual() [4/5]

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

compareNotEqual() [5/5]

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

handleExpression() [1/2]

void Catch::handleExpression

(

ITransientExpression const &

expr

)

Referenced by handleExpression().

handleExpression() [2/2]

void Catch::handleExpression

(

ExprLhs< T > const &

expr

)

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

getResultCapture()

IResultCapture& Catch::getResultCapture

(

)

handleExceptionMatchExpr() [1/2]

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

getCurrentNanosecondsSinceEpoch()

auto Catch::getCurrentNanosecondsSinceEpoch

(

)

-> uint64_t

getEstimatedClockResolution()

auto Catch::getEstimatedClockResolution

(

)

-> uint64_t

getRegistryHub()

IRegistryHub const& Catch::getRegistryHub

(

)

getMutableRegistryHub()

IMutableRegistryHub& Catch::getMutableRegistryHub

(

)

Referenced by ExceptionTranslatorRegistrar::ExceptionTranslatorRegistrar().

cleanUp()

void Catch::cleanUp

(

)

translateActiveException()

std::string Catch::translateActiveException

(

)

startsWith() [1/2]

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

startsWith() [2/2]

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

endsWith() [1/2]

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

endsWith() [2/2]

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

contains()

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

toLowerInPlace()

void Catch::toLowerInPlace

(

std::string &

s

)

toLower()

std::string Catch::toLower

(

std::string const &

s

)

trim() [1/2]

std::string Catch::trim

(

std::string const &

str

)

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

trim() [2/2]

StringRef Catch::trim

(

StringRef

ref

)

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

splitStringRef()

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

replaceInPlace()

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

handleExceptionMatchExpr() [2/2]

void Catch::handleExceptionMatchExpr	(	AssertionHandler &	handler,
		StringMatcher const &	matcher,
		StringRef const &	matcherString
	)

makeMatchExpr()

auto Catch::makeMatchExpr	(	ArgT const &	arg,
		MatcherT const &	matcher,
		StringRef const &	matcherString
	)		-> MatchExpr<ArgT, MatcherT>

throw_exception()

void Catch::throw_exception

(

std::exception const &

e

)

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

throw_logic_error()

void Catch::throw_logic_error

(

std::string const &

msg

)

throw_domain_error()

void Catch::throw_domain_error

(

std::string const &

msg

)

throw_runtime_error()

void Catch::throw_runtime_error

(

std::string const &

msg

)

getCurrentMutableContext()

IMutableContext& Catch::getCurrentMutableContext

(

)

Referenced by getCurrentContext().

getCurrentContext()

IContext& Catch::getCurrentContext

(

)

References getCurrentMutableContext().

cleanUpContext()

void Catch::cleanUpContext

(

)

rng()

SimplePcg32& Catch::rng

(

)

makeTestCase()

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