#include <ErrorFormatter.h>

Public Member Functions
	ErrorFormatter (OutputStream o, const char preLine=":", const char *postLine="")

int	run ()

void	enterWorld (const WorldDescription &)

void	enterSuite (const SuiteDescription &)

void	enterTest (const TestDescription &)

void	leaveTest (const TestDescription &)

void	leaveWorld (const WorldDescription &desc)

void	trace (const char file, unsigned line, const char expression)

void	warning (const char file, unsigned line, const char expression)

void	failedTest (const char file, unsigned line, const char expression)

void	failedAssert (const char file, unsigned line, const char expression)

void	failedAssertEquals (const char file, unsigned line, const char xStr, const char yStr, const char x, const char *y)

void	failedAssertSameData (const char file, unsigned line, const char xStr, const char yStr, const char sizeStr, const void x, const void y, unsigned size)

void	failedAssertDelta (const char file, unsigned line, const char xStr, const char yStr, const char dStr, const char x, const char y, const char *d)

void	failedAssertDiffers (const char file, unsigned line, const char xStr, const char yStr, const char value)

void	failedAssertLessThan (const char file, unsigned line, const char xStr, const char yStr, const char x, const char *y)

void	failedAssertLessThanEquals (const char file, unsigned line, const char xStr, const char yStr, const char x, const char *y)

void	failedAssertRelation (const char file, unsigned line, const char relation, const char xStr, const char yStr, const char x, const char y)

void	failedAssertPredicate (const char file, unsigned line, const char predicate, const char xStr, const char x)

void	failedAssertThrows (const char file, unsigned line, const char expression, const char *type, bool otherThrown)

void	failedAssertThrowsNot (const char file, unsigned line, const char expression)

Public Member Functions inherited from CxxTest::TestListener
	TestListener ()

virtual	~TestListener ()

virtual void	enterWorld (const WorldDescription &)

virtual void	enterSuite (const SuiteDescription &)

virtual void	enterTest (const TestDescription &)

virtual void	trace (const char , unsigned, const char )

virtual void	warning (const char , unsigned, const char )

virtual void	failedTest (const char , unsigned, const char )

virtual void	failedAssert (const char , unsigned, const char )

virtual void	failedAssertEquals (const char , unsigned, const char , const char , const char , const char *)

virtual void	failedAssertSameData (const char , unsigned, const char , const char , const char , const void , const void , unsigned)

virtual void	failedAssertDelta (const char , unsigned, const char , const char , const char , const char , const char , const char *)

virtual void	failedAssertDiffers (const char , unsigned, const char , const char , const char )

virtual void	failedAssertLessThan (const char , unsigned, const char , const char , const char , const char *)

virtual void	failedAssertLessThanEquals (const char , unsigned, const char , const char , const char , const char *)

virtual void	failedAssertPredicate (const char , unsigned, const char , const char , const char )

virtual void	failedAssertRelation (const char , unsigned, const char , const char , const char , const char , const char )

virtual void	failedAssertThrows (const char , unsigned, const char , const char *, bool)

virtual void	failedAssertThrowsNot (const char , unsigned, const char )

virtual void	leaveTest (const TestDescription &)

virtual void	leaveSuite (const SuiteDescription &)

virtual void	leaveWorld (const WorldDescription &)

Static Public Member Functions
static void	totalTests (OutputStream &o)

Protected Member Functions
OutputStream *	outputStream () const

Private Member Functions
	ErrorFormatter (const ErrorFormatter &)

ErrorFormatter &	operator= (const ErrorFormatter &)

OutputStream &	stop (const char *file, unsigned line)

void	newLine (void)

void	reportTest (void)

void	dump (const void *buffer, unsigned size)

void	dumpNull ()

void	dumpBuffer (const void *buffer, unsigned size)

Static Private Member Functions
static void	endl (OutputStream &o)

Private Attributes
bool	_dotting

bool	_reported

OutputStream *	_o

const char *	_preLine

const char *	_postLine

Detailed Description

Definition at line 33 of file ErrorFormatter.h.

Constructor & Destructor Documentation

◆ ErrorFormatter() [1/2]

CxxTest::ErrorFormatter::ErrorFormatter	(	OutputStream *	o,
		const char *	preLine = `":"`,
		const char *	postLine = `""`
	)

inline

Definition at line 36 of file ErrorFormatter.h.

                                                                :", const char *postLine = "" ) :
            _dotting( true ),
            _reported( false ),
            _o(o),
            _preLine(preLine),
            _postLine(postLine)
        {
        }

◆ ErrorFormatter() [2/2]

CxxTest::ErrorFormatter::ErrorFormatter ( const ErrorFormatter & )

private

Member Function Documentation

◆ dump()

void CxxTest::ErrorFormatter::dump	(	const void *	buffer,
		unsigned	size
	)

inlineprivate

Definition at line 240 of file ErrorFormatter.h.

        {
            if ( !buffer )
                dumpNull();
            else
                dumpBuffer( buffer, size );
        }

◆ dumpBuffer()

void CxxTest::ErrorFormatter::dumpBuffer	(	const void *	buffer,
		unsigned	size
	)

inlineprivate

Definition at line 253 of file ErrorFormatter.h.

        {
            unsigned dumpSize = size;
            if ( maxDumpSize() && dumpSize > maxDumpSize() )
                dumpSize = maxDumpSize();
 
            const unsigned char *p = (const unsigned char *)buffer;
            (*_o) << "   { ";
            for ( unsigned i = 0; i < dumpSize; ++ i )
                (*_o) << byteToHex( *p++ ) << " ";
            if ( dumpSize < size )
                (*_o) << "... ";
            (*_o) << "}" << endl;
        }

◆ dumpNull()

void CxxTest::ErrorFormatter::dumpNull ( )

inlineprivate

Definition at line 248 of file ErrorFormatter.h.

        {
            (*_o) << "   (null)" << endl;
        }

◆ endl()

static void CxxTest::ErrorFormatter::endl ( OutputStream & o )

inlinestaticprivate

Definition at line 268 of file ErrorFormatter.h.

        {
            OutputStream::endl( o );
        }

◆ enterSuite()

void CxxTest::ErrorFormatter::enterSuite ( const SuiteDescription & )

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 66 of file ErrorFormatter.h.

        {
            _reported = false;
        }

◆ enterTest()

void CxxTest::ErrorFormatter::enterTest ( const TestDescription & )

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 71 of file ErrorFormatter.h.

        {
            _reported = false;
        }

◆ enterWorld()

void CxxTest::ErrorFormatter::enterWorld ( const WorldDescription & )

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 51 of file ErrorFormatter.h.

        {
            (*_o) << "Running " << totalTests;
            _o->flush();
            _dotting = true;
            _reported = false;
        }

◆ failedAssert()

void CxxTest::ErrorFormatter::failedAssert	(	const char *	file,
		unsigned	line,
		const char *	expression
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 114 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Assertion failed: " <<
                expression << endl;
        }

◆ failedAssertDelta()

void CxxTest::ErrorFormatter::failedAssertDelta	(	const char *	file,
		unsigned	line,
		const char *	xStr,
		const char *	yStr,
		const char *	dStr,
		const char *	x,
		const char *	y,
		const char *	d
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 141 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected (" <<
                xStr << " == " << yStr << ") up to " << dStr << " (" << d << "), found (" <<
                x << " != " << y << ")" << endl;
        }

◆ failedAssertDiffers()

void CxxTest::ErrorFormatter::failedAssertDiffers	(	const char *	file,
		unsigned	line,
		const char *	xStr,
		const char *	yStr,
		const char *	value
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 150 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected (" <<
                xStr << " != " << yStr << "), found (" <<
                value << ")" << endl;
        }

◆ failedAssertEquals()

void CxxTest::ErrorFormatter::failedAssertEquals	(	const char *	file,
		unsigned	line,
		const char *	xStr,
		const char *	yStr,
		const char *	x,
		const char *	y
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 120 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected (" <<
                xStr << " == " << yStr << "), found (" <<
                x << " != " << y << ")" << endl;
        }

◆ failedAssertLessThan()

void CxxTest::ErrorFormatter::failedAssertLessThan	(	const char *	file,
		unsigned	line,
		const char *	xStr,
		const char *	yStr,
		const char *	x,
		const char *	y
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 159 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected (" <<
                xStr << " < " << yStr << "), found (" <<
                x << " >= " << y << ")" << endl;
        }

◆ failedAssertLessThanEquals()

void CxxTest::ErrorFormatter::failedAssertLessThanEquals	(	const char *	file,
		unsigned	line,
		const char *	xStr,
		const char *	yStr,
		const char *	x,
		const char *	y
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 168 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected (" <<
                xStr << " <= " << yStr << "), found (" <<
                x << " > " << y << ")" << endl;
        }

◆ failedAssertPredicate()

void CxxTest::ErrorFormatter::failedAssertPredicate	(	const char *	file,
		unsigned	line,
		const char *	predicate,
		const char *	xStr,
		const char *	x
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 185 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected " << predicate << "( " <<
                xStr << " ), found !" << predicate << "( " << x << " )" << endl;
        }

◆ failedAssertRelation()

void CxxTest::ErrorFormatter::failedAssertRelation	(	const char *	file,
		unsigned	line,
		const char *	relation,
		const char *	xStr,
		const char *	yStr,
		const char *	x,
		const char *	y
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 177 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected " << relation << "( " <<
                xStr << ", " << yStr << " ), found !" << relation << "( " << x << ", " << y << " )" << endl;
        }

◆ failedAssertSameData()

void CxxTest::ErrorFormatter::failedAssertSameData	(	const char *	file,
		unsigned	line,
		const char *	xStr,
		const char *	yStr,
		const char *	sizeStr,
		const void *	x,
		const void *	y,
		unsigned	size
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 129 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected " << sizeStr << " (" << size << ") bytes to be equal at (" <<
                xStr << ") and (" << yStr << "), found:" << endl;
            dump( x, size );
            (*_o) << "     differs from" << endl;
            dump( y, size );
        }

◆ failedAssertThrows()

void CxxTest::ErrorFormatter::failedAssertThrows	(	const char *	file,
		unsigned	line,
		const char *	expression,
		const char *	type,
		bool	otherThrown
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 192 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected (" << expression << ") to throw (" <<
                type << ") but it " << (otherThrown ? "threw something else" : "didn't throw") <<
                endl;
        }

◆ failedAssertThrowsNot()

void CxxTest::ErrorFormatter::failedAssertThrowsNot	(	const char *	file,
		unsigned	line,
		const char *	expression
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 201 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Expected (" << expression << ") not to throw, but it did" <<
                endl;
        }

◆ failedTest()

void CxxTest::ErrorFormatter::failedTest	(	const char *	file,
		unsigned	line,
		const char *	expression
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 108 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Error: Test failed: " <<
                expression << endl;
        }

◆ leaveTest()

void CxxTest::ErrorFormatter::leaveTest ( const TestDescription & )

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 76 of file ErrorFormatter.h.

        {
            if ( !tracker().testFailed() ) {
                ((*_o) << ".").flush();
                _dotting = true;
            }
        }

◆ leaveWorld()

void CxxTest::ErrorFormatter::leaveWorld ( const WorldDescription & desc )

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 84 of file ErrorFormatter.h.

        {
            if ( !tracker().failedTests() ) {
                (*_o) << "OK!" << endl;
                return;
            }
            newLine();
            (*_o) << "Failed " << tracker().failedTests() << " of " << totalTests << endl;
            unsigned numPassed = desc.numTotalTests() - tracker().failedTests();
            (*_o) << "Success rate: " << (numPassed * 100 / desc.numTotalTests()) << "%" << endl;
        }

◆ newLine()

void CxxTest::ErrorFormatter::newLine ( void )

inlineprivate

Definition at line 224 of file ErrorFormatter.h.

        {
            if ( _dotting ) {
                (*_o) << endl;
                _dotting = false;
            }
        }

◆ operator=()

ErrorFormatter & CxxTest::ErrorFormatter::operator= ( const ErrorFormatter & )

private

◆ outputStream()

OutputStream * CxxTest::ErrorFormatter::outputStream ( ) const

inlineprotected

Definition at line 208 of file ErrorFormatter.h.

        {
            return _o;
        }

◆ reportTest()

void CxxTest::ErrorFormatter::reportTest ( void )

inlineprivate

Definition at line 232 of file ErrorFormatter.h.

        {
            if( _reported )
                return;
            (*_o) << "In " << tracker().suite().suiteName() << "::" << tracker().test().testName() << ":" << endl;
            _reported = true;
        }

◆ run()

int CxxTest::ErrorFormatter::run ( )

inline

Definition at line 45 of file ErrorFormatter.h.

        {
            TestRunner::runAllTests( *this );
            return tracker().failedTests();
        }

◆ stop()

OutputStream & CxxTest::ErrorFormatter::stop	(	const char *	file,
		unsigned	line
	)

inlineprivate

Definition at line 217 of file ErrorFormatter.h.

        {
            newLine();
            reportTest();
            return (*_o) << file << _preLine << line << _postLine << ": ";
        }

◆ totalTests()

static void CxxTest::ErrorFormatter::totalTests ( OutputStream & o )

inlinestatic

Definition at line 59 of file ErrorFormatter.h.

        {
            char s[WorldDescription::MAX_STRLEN_TOTAL_TESTS];
            const WorldDescription &wd = tracker().world();
            o << wd.strTotalTests( s ) << (wd.numTotalTests() == 1 ? " test" : " tests");
        }

◆ trace()

void CxxTest::ErrorFormatter::trace	(	const char *	file,
		unsigned	line,
		const char *	expression
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 96 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Trace: " <<
                expression << endl;
        }

◆ warning()

void CxxTest::ErrorFormatter::warning	(	const char *	file,
		unsigned	line,
		const char *	expression
	)

inlinevirtual

Reimplemented from CxxTest::TestListener.

Definition at line 102 of file ErrorFormatter.h.

        {
            stop( file, line ) << "Warning: " <<
                expression << endl;
        }

Field Documentation

◆ _dotting

bool CxxTest::ErrorFormatter::_dotting

private

Definition at line 273 of file ErrorFormatter.h.

◆ _o

OutputStream* CxxTest::ErrorFormatter::_o

private

Definition at line 275 of file ErrorFormatter.h.

◆ _postLine

const char* CxxTest::ErrorFormatter::_postLine

private

Definition at line 277 of file ErrorFormatter.h.

◆ _preLine

const char* CxxTest::ErrorFormatter::_preLine

private

Definition at line 276 of file ErrorFormatter.h.

◆ _reported

bool CxxTest::ErrorFormatter::_reported

private

Definition at line 274 of file ErrorFormatter.h.

The documentation for this class was generated from the following file:

libpolys/tests/cxxtest/ErrorFormatter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ErrorFormatter() [1/2]

◆ ErrorFormatter() [2/2]

Member Function Documentation

◆ dump()

◆ dumpBuffer()

◆ dumpNull()

◆ endl()

◆ enterSuite()

◆ enterTest()

◆ enterWorld()

◆ failedAssert()

◆ failedAssertDelta()

◆ failedAssertDiffers()

◆ failedAssertEquals()

◆ failedAssertLessThan()

◆ failedAssertLessThanEquals()

◆ failedAssertPredicate()

◆ failedAssertRelation()

◆ failedAssertSameData()

◆ failedAssertThrows()

◆ failedAssertThrowsNot()

◆ failedTest()

◆ leaveTest()

◆ leaveWorld()

◆ newLine()

◆ operator=()

◆ outputStream()

◆ reportTest()

◆ run()

◆ stop()

◆ totalTests()

◆ trace()

◆ warning()

Field Documentation

◆ _dotting

◆ _o

◆ _postLine

◆ _preLine

◆ _reported