catch2/internal/catch_capture.hpp

492 lines
12 KiB
C++
Raw Normal View History

2010-11-10 00:24:00 +01:00
/*
* catch_capture.hpp
* Catch
*
* Created by Phil on 18/10/2010.
* Copyright 2010 Two Blue Cubes Ltd. All rights reserved.
*
* Distributed under the Boost Software License, Version 1.0. (See accompanying
* file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
*
*/
#ifndef TWOBLUECUBES_CATCH_CAPTURE_HPP_INCLUDED
#define TWOBLUECUBES_CATCH_CAPTURE_HPP_INCLUDED
#include "catch_resultinfo.hpp"
2011-01-11 10:13:31 +01:00
#include "catch_result_type.h"
#include "catch_interfaces_capture.h"
#include "catch_debugger.hpp"
2010-11-10 00:24:00 +01:00
#include <sstream>
#include <cmath>
2010-11-10 00:24:00 +01:00
namespace Catch
{
namespace Detail
{
// The following code, contributed by Sam Partington, allows us to choose an implementation
// of toString() depending on whether a << overload is available
struct NonStreamable
{
// allow construction from anything...
template<typename Anything>
NonStreamable(Anything)
{}
};
// a local operator<< which may be called if there isn't a better one elsewhere...
inline NonStreamable operator << ( std::ostream&, const NonStreamable& ns )
{
return ns;
}
template<typename T>
struct IsStreamable
{
static NoType Deduce( const NonStreamable& );
static YesType Deduce( std::ostream& );
enum
{
value = sizeof( Deduce( Synth<std::ostream&>() << Synth<const T&>() ) )
== sizeof( YesType )
};
};
// << is available, so use it with ostringstream to make the string
template<typename T, bool streamable>
struct StringMaker
{
///////////////////////////////////////////////////////////////////////
static std::string apply
(
const T& value
)
{
std::ostringstream oss;
oss << value;
return oss.str();
}
};
// << not available - use a default string
template<typename T>
struct StringMaker<T, false>
{
///////////////////////////////////////////////////////////////////////
static std::string apply
(
const T&
)
{
return "{?}";
}
};
}// end namespace Detail
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename T>
std::string toString
(
const T& value
)
2010-11-10 00:24:00 +01:00
{
return Detail::StringMaker<T, Detail::IsStreamable<T>::value>::apply( value );
2010-11-10 00:24:00 +01:00
}
2011-01-11 20:48:48 +01:00
// Shortcut overloads
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
const std::string& value
)
{
return value;
}
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
const char* value
)
2011-01-11 20:48:48 +01:00
{
return value;
}
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
int value
)
{
std::ostringstream oss;
oss << value;
return oss.str();
}
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
const double value
)
{
std::ostringstream oss;
oss << value;
return oss.str();
}
2010-11-10 00:24:00 +01:00
class TestFailureException
{
};
class DummyExceptionType_DontUse
{
};
class MutableResultInfo : public ResultInfo
{
public:
///////////////////////////////////////////////////////////////////////////
MutableResultInfo
()
2010-11-10 00:24:00 +01:00
{}
///////////////////////////////////////////////////////////////////////////
MutableResultInfo
(
const char* expr,
bool isNot,
const char* filename,
std::size_t line,
const char* macroName
)
: ResultInfo( expr, ResultWas::Unknown, isNot, filename, line, macroName )
2010-11-10 00:24:00 +01:00
{
}
///////////////////////////////////////////////////////////////////////////
void setResultType
(
ResultWas::OfType result
)
2010-11-10 00:24:00 +01:00
{
// Flip bool results if isNot is set
if( m_isNot && result == ResultWas::Ok )
m_result = ResultWas::ExpressionFailed;
else if( m_isNot && result == ResultWas::ExpressionFailed )
m_result = ResultWas::Ok;
else
m_result = result;
}
///////////////////////////////////////////////////////////////////////////
void setMessage
(
const std::string& message
)
2010-11-10 00:24:00 +01:00
{
m_message = message;
}
2010-11-10 20:18:46 +01:00
///////////////////////////////////////////////////////////////////////////
2010-11-10 20:18:46 +01:00
template<typename RhsT>
MutableResultInfo& operator ||
(
const RhsT&
)
2010-11-10 20:18:46 +01:00
{
m_expressionIncomplete = true;
2010-11-10 20:18:46 +01:00
return *this;
}
2010-11-11 21:37:46 +01:00
2010-11-10 00:24:00 +01:00
private:
friend class ResultBuilder;
///////////////////////////////////////////////////////////////////////////
void setLhs
(
const std::string& lhs
)
2010-11-10 00:24:00 +01:00
{
m_lhs = lhs;
}
///////////////////////////////////////////////////////////////////////////
MutableResultInfo& setRhs
(
const std::string& op,
const std::string& rhs
)
2010-11-10 00:24:00 +01:00
{
m_op = op;
m_rhs = rhs;
return *this;
}
};
class ResultBuilder
{
public:
///////////////////////////////////////////////////////////////////////////
ResultBuilder
(
const char* expr,
bool isNot,
const char* filename,
std::size_t line,
const char* macroName
)
2010-11-10 00:24:00 +01:00
: m_result( expr, isNot, filename, line, macroName )
{}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename T>
ResultBuilder& operator->*
(
const T & operand
)
2010-11-10 00:24:00 +01:00
{
m_result.setLhs( toString( operand ) );
return *this;
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
MutableResultInfo& operator ==
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.setRhs( "==", toString( rhs ) );
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
MutableResultInfo& operator !=
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.setRhs( "!=", toString( rhs ) );
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
MutableResultInfo& operator <
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.setRhs( "<", toString( rhs ) );
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
MutableResultInfo& operator >
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.setRhs( ">", toString( rhs ) );
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
MutableResultInfo& operator <=
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.setRhs( "<=", toString( rhs ) );
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
MutableResultInfo& operator >=
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.setRhs( ">=", toString( rhs ) );
}
2010-11-10 20:18:46 +01:00
///////////////////////////////////////////////////////////////////////////
operator MutableResultInfo&
()
2010-11-10 00:24:00 +01:00
{
return m_result;
}
private:
MutableResultInfo m_result;
};
class ScopedInfo
{
public:
///////////////////////////////////////////////////////////////////////////
ScopedInfo
()
{
2011-01-11 10:13:31 +01:00
Hub::getResultCapture().pushScopedInfo( this );
}
///////////////////////////////////////////////////////////////////////////
~ScopedInfo
()
{
2011-01-11 10:13:31 +01:00
Hub::getResultCapture().popScopedInfo( this );
}
///////////////////////////////////////////////////////////////////////////
ScopedInfo& operator <<
(
const char* str
)
{
m_oss << str;
return *this;
}
///////////////////////////////////////////////////////////////////////////
std::string getInfo
()
const
{
return m_oss.str();
}
private:
std::ostringstream m_oss;
};
2010-11-10 00:24:00 +01:00
// !TBD Need to clean this all up
#define CATCH_absTol 1e-10
#define CATCH_relTol 1e-10
2010-11-12 09:12:01 +01:00
inline double catch_max( double x, double y )
{
return x > y ? x : y;
}
2010-11-10 00:24:00 +01:00
class Approx
{
public:
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
// !TBD more generic
Approx
(
double d
)
2010-11-10 00:24:00 +01:00
: m_d( d )
{
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename T>
friend bool operator ==
(
const T& lhs,
const Approx& rhs
)
2010-11-10 00:24:00 +01:00
{
// !TBD Use proper tolerance
// From: http://realtimecollisiondetection.net/blog/?p=89
// see also: http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm
2010-11-12 09:12:01 +01:00
return fabs( lhs - rhs.m_d ) <= catch_max( CATCH_absTol, CATCH_relTol * catch_max( fabs(lhs), fabs(rhs.m_d) ) );
2010-11-10 00:24:00 +01:00
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename T>
friend bool operator !=
(
const T& lhs,
const Approx& rhs
)
2010-11-10 00:24:00 +01:00
{
return ! operator==( lhs, rhs );
}
double m_d;
};
///////////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<>
inline std::string toString<Approx>
(
const Approx& value
)
2010-11-10 00:24:00 +01:00
{
std::ostringstream oss;
oss << "Approx( " << value.m_d << ")";
return oss.str();
}
///////////////////////////////////////////////////////////////////////////////
2010-12-30 00:13:22 +01:00
// This is just here to avoid compiler warnings with macro constants
inline bool isTrue
(
bool value
)
2010-12-30 00:13:22 +01:00
{
return value;
}
2010-11-10 00:24:00 +01:00
} // end namespace Catch
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_ACCEPT_RESULT( result, stopOnFailure ) \
2011-01-11 10:13:31 +01:00
if( Catch::ResultAction::Value action = Catch::Hub::getResultCapture().acceptResult( result ) ) \
{ \
if( action == Catch::ResultAction::DebugFailed ) BreakIntoDebugger(); \
2010-12-30 00:13:22 +01:00
if( Catch::isTrue( stopOnFailure ) ) throw Catch::TestFailureException(); \
}
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_TEST( expr, isNot, stopOnFailure, macroName ) \
2010-12-30 00:13:22 +01:00
{ \
2011-01-11 10:13:31 +01:00
Catch::Hub::getResultCapture().acceptExpression( Catch::ResultBuilder( #expr, isNot, __FILE__, __LINE__, macroName )->*expr ); \
2010-12-30 00:13:22 +01:00
INTERNAL_CATCH_ACCEPT_RESULT( expr, stopOnFailure ) \
}
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_THROWS( expr, exceptionType, nothrow, stopOnFailure, macroName ) \
2011-01-11 10:13:31 +01:00
Catch::Hub::getResultCapture().acceptExpression( Catch::ResultBuilder( #expr, false, __FILE__, __LINE__, macroName ) ); \
2010-11-10 00:24:00 +01:00
try \
{ \
expr; \
INTERNAL_CATCH_ACCEPT_RESULT( nothrow, stopOnFailure ) \
2010-11-10 00:24:00 +01:00
} \
catch( exceptionType ) \
{ \
INTERNAL_CATCH_ACCEPT_RESULT( !(nothrow), stopOnFailure ) \
2010-11-10 00:24:00 +01:00
}
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_THROWS_AS( expr, exceptionType, nothrow, stopOnFailure, macroName ) \
INTERNAL_CATCH_THROWS( expr, exceptionType, nothrow, stopOnFailure, macroName ) \
2010-11-10 00:24:00 +01:00
catch( ... ) \
{ \
INTERNAL_CATCH_ACCEPT_RESULT( false, stopOnFailure ) \
2010-11-10 00:24:00 +01:00
}
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_MSG( reason, resultType, stopOnFailure, macroName ) \
2010-12-30 00:13:22 +01:00
{ \
std::ostringstream INTERNAL_CATCH_UNIQUE_NAME( strm ); \
INTERNAL_CATCH_UNIQUE_NAME( strm ) << reason; \
2011-01-11 10:13:31 +01:00
Catch::Hub::getResultCapture().acceptExpression( Catch::MutableResultInfo( "", false, __FILE__, __LINE__, macroName ) ); \
Catch::Hub::getResultCapture().acceptMessage( INTERNAL_CATCH_UNIQUE_NAME( strm ).str() ); \
2010-12-30 00:13:22 +01:00
INTERNAL_CATCH_ACCEPT_RESULT( resultType, stopOnFailure ) \
}
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_SCOPED_INFO( log ) Catch::ScopedInfo INTERNAL_CATCH_UNIQUE_NAME( info ); INTERNAL_CATCH_UNIQUE_NAME( info ) << log
2010-11-10 00:24:00 +01:00
#endif // TWOBLUECUBES_CATCH_CAPTURE_HPP_INCLUDED