catch2/internal/catch_capture.hpp

718 lines
18 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"
2011-03-09 20:45:05 +01:00
#include "catch_evaluate.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
)
{
2011-03-25 20:39:11 +01:00
return "\"" + value + "\"";
}
2011-03-25 20:39:11 +01:00
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
2011-02-23 21:02:18 +01:00
const char* const value
)
2011-01-11 20:48:48 +01:00
{
2011-03-25 20:39:11 +01:00
return value ? toString( std::string( value ) ) : std::string( "{null string}" );
}
2011-02-23 21:02:18 +01:00
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
char* const value
)
{
return toString( static_cast<const char* const>( 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();
}
2011-03-10 15:09:32 +01:00
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
bool value
)
{
return value ? "true" : "false";
}
///////////////////////////////////////////////////////////////////////////////
inline std::string toString
(
void* p
)
{
if( !p )
return INTERNAL_CATCH_STRINGIFY( NULL );
std::ostringstream oss;
oss << p;
return oss.str();
}
///////////////////////////////////////////////////////////////////////////////
template<typename T>
inline std::string toString
(
T* p
)
{
return toString( static_cast<void*>( p ) );
}
///////////////////////////////////////////////////////////////////////////////
template<typename T>
inline std::string toString
(
const T* p
)
{
return toString( static_cast<void*>( const_cast<T*>( p ) ) );
}
struct TestFailureException
2010-11-10 00:24:00 +01:00
{
};
struct DummyExceptionType_DontUse
2010-11-10 00:24:00 +01:00
{
};
struct STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison;
2010-11-10 00:24:00 +01:00
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,
2011-03-10 15:09:32 +01:00
const char* macroName,
const char* message = ""
)
2011-03-10 15:09:32 +01:00
: ResultInfo( expr, ResultWas::Unknown, isNot, filename, line, macroName, message )
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;
}
///////////////////////////////////////////////////////////////////////////
template<typename RhsT>
STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator ||
(
const RhsT&
);
2010-11-10 20:18:46 +01:00
///////////////////////////////////////////////////////////////////////////
2010-11-10 20:18:46 +01:00
template<typename RhsT>
STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator &&
(
const RhsT&
);
2010-11-10 00:24:00 +01:00
private:
friend class ResultBuilder;
template<typename T> friend class Expression;
template<typename T> friend class PtrExpression;
///////////////////////////////////////////////////////////////////////////
2011-03-10 15:09:32 +01:00
MutableResultInfo& captureBoolExpression
(
2011-03-10 15:09:32 +01:00
bool result
)
2010-11-10 00:24:00 +01:00
{
2011-03-10 15:09:32 +01:00
m_lhs = toString( result );
m_op = m_isNot ? "!" : "";
setResultType( result ? ResultWas::Ok : ResultWas::ExpressionFailed );
2010-11-10 00:24:00 +01:00
return *this;
}
2011-03-09 20:45:05 +01:00
///////////////////////////////////////////////////////////////////////////
template<Internal::Operator Op, typename T1, typename T2>
2011-03-10 15:09:32 +01:00
MutableResultInfo& captureExpression
2011-03-09 20:45:05 +01:00
(
const T1& lhs,
const T2& rhs
)
{
setResultType( Internal::compare<Op>( lhs, rhs ) ? ResultWas::Ok : ResultWas::ExpressionFailed );
2011-03-10 15:09:32 +01:00
m_lhs = toString( lhs );
2011-03-09 20:45:05 +01:00
m_rhs = toString( rhs );
m_op = Internal::OperatorTraits<Op>::getName();
2011-03-09 20:45:05 +01:00
return *this;
}
2010-11-10 00:24:00 +01:00
};
2011-03-09 20:45:05 +01:00
2011-03-10 15:09:32 +01:00
template<typename T>
class Expression
2010-11-10 00:24:00 +01:00
{
2011-03-15 19:43:13 +01:00
void operator = ( const Expression& );
2010-11-10 00:24:00 +01:00
public:
///////////////////////////////////////////////////////////////////////////
2011-03-10 15:09:32 +01:00
Expression
(
2011-03-10 15:09:32 +01:00
MutableResultInfo& result,
const T& lhs
)
2011-03-10 15:09:32 +01:00
: m_result( result ),
m_lhs( lhs )
{
}
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////
2011-03-10 15:09:32 +01:00
template<typename RhsT>
MutableResultInfo& operator ==
(
2011-03-10 15:09:32 +01:00
const RhsT& rhs
)
2011-03-09 20:45:05 +01:00
{
return m_result.captureExpression<Internal::IsEqualTo>( m_lhs, rhs );
2011-03-09 20:45:05 +01:00
}
2011-03-10 15:09:32 +01:00
2011-03-09 20:45:05 +01:00
///////////////////////////////////////////////////////////////////////////
2011-03-10 15:09:32 +01:00
template<typename RhsT>
MutableResultInfo& operator !=
2011-03-09 20:45:05 +01:00
(
2011-03-10 15:09:32 +01:00
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.captureExpression<Internal::IsNotEqualTo>( m_lhs, rhs );
2010-11-10 00:24:00 +01:00
}
2011-03-10 15:09:32 +01:00
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
2011-03-10 15:09:32 +01:00
MutableResultInfo& operator <
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.captureExpression<Internal::IsLessThan>( m_lhs, rhs );
2011-03-10 15:09:32 +01:00
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
2011-03-10 15:09:32 +01:00
MutableResultInfo& operator >
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.captureExpression<Internal::IsGreaterThan>( m_lhs, rhs );
2011-03-10 15:09:32 +01:00
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
2011-03-10 15:09:32 +01:00
MutableResultInfo& operator <=
(
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.captureExpression<Internal::IsLessThanOrEqualTo>( m_lhs, rhs );
2011-03-10 15:09:32 +01:00
}
///////////////////////////////////////////////////////////////////////////
2010-11-10 00:24:00 +01:00
template<typename RhsT>
2011-03-10 15:09:32 +01:00
MutableResultInfo& operator >=
(
2011-03-10 15:09:32 +01:00
const RhsT& rhs
)
2010-11-10 00:24:00 +01:00
{
return m_result.captureExpression<Internal::IsGreaterThanOrEqualTo>( m_lhs, rhs );
2011-03-10 15:09:32 +01:00
}
///////////////////////////////////////////////////////////////////////////
2011-03-10 15:09:32 +01:00
operator MutableResultInfo&
()
{
return m_result.captureBoolExpression( m_lhs );
}
///////////////////////////////////////////////////////////////////////////
template<typename RhsT>
STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator +
(
const RhsT&
);
///////////////////////////////////////////////////////////////////////////
template<typename RhsT>
STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator -
(
const RhsT&
);
2011-03-10 15:09:32 +01:00
private:
MutableResultInfo& m_result;
const T& m_lhs;
};
2011-03-18 20:08:33 +01:00
template<typename LhsT>
class PtrExpression
{
public:
2011-03-18 20:08:33 +01:00
///////////////////////////////////////////////////////////////////////////
PtrExpression
(
MutableResultInfo& result,
const LhsT* lhs
)
2011-03-21 19:00:19 +01:00
: m_result( &result ),
2011-03-18 20:08:33 +01:00
m_lhs( lhs )
{}
///////////////////////////////////////////////////////////////////////////
template<typename RhsT>
MutableResultInfo& operator ==
(
const RhsT* rhs
)
{
2011-03-21 19:00:19 +01:00
return m_result->captureExpression<Internal::IsEqualTo>( m_lhs, rhs );
2011-03-18 20:08:33 +01:00
}
2011-03-18 20:08:33 +01:00
///////////////////////////////////////////////////////////////////////////
// This catches NULL
MutableResultInfo& operator ==
(
LhsT* rhs
)
{
2011-03-21 19:00:19 +01:00
return m_result->captureExpression<Internal::IsEqualTo>( m_lhs, rhs );
2011-03-18 20:08:33 +01:00
}
///////////////////////////////////////////////////////////////////////////
template<typename RhsT>
MutableResultInfo& operator !=
(
const RhsT* rhs
)
{
2011-03-21 19:00:19 +01:00
return m_result->captureExpression<Internal::IsNotEqualTo>( m_lhs, rhs );
2011-03-18 20:08:33 +01:00
}
///////////////////////////////////////////////////////////////////////////
// This catches NULL
MutableResultInfo& operator !=
(
LhsT* rhs
)
{
2011-03-21 19:00:19 +01:00
return m_result->captureExpression<Internal::IsNotEqualTo>( m_lhs, rhs );
2011-03-18 20:08:33 +01:00
}
private:
2011-03-21 19:00:19 +01:00
MutableResultInfo* m_result;
2011-03-18 20:08:33 +01:00
const LhsT* m_lhs;
};
2011-03-10 15:09:32 +01:00
class ResultBuilder
{
public:
///////////////////////////////////////////////////////////////////////////
ResultBuilder
(
2011-03-10 15:09:32 +01:00
const char* filename,
std::size_t line,
const char* macroName,
const char* expr = "",
bool isNot = false
)
: m_result( expr, isNot, filename, line, macroName )
{}
///////////////////////////////////////////////////////////////////////////
template<typename T>
Expression<T> operator->*
(
const T & operand
)
2010-11-10 00:24:00 +01:00
{
2011-03-10 15:09:32 +01:00
Expression<T> expr( m_result, operand );
return expr;
}
///////////////////////////////////////////////////////////////////////////
template<typename T>
PtrExpression<T> operator->*
(
const T* operand
)
{
PtrExpression<T> expr( m_result, operand );
return expr;
}
///////////////////////////////////////////////////////////////////////////
template<typename T>
PtrExpression<T> operator->*
(
T* operand
)
{
PtrExpression<T> expr( m_result, operand );
return expr;
}
///////////////////////////////////////////////////////////////////////////
2011-03-10 15:09:32 +01:00
template<typename T>
ResultBuilder& operator <<
(
2011-03-10 15:09:32 +01:00
const T & value
)
2010-11-10 00:24:00 +01:00
{
2011-03-10 15:09:32 +01:00
m_messageStream << value;
return *this;
}
///////////////////////////////////////////////////////////////////////////
ResultBuilder& setResultType
(
ResultWas::OfType resultType
)
{
m_result.setResultType( resultType );
return *this;
}
///////////////////////////////////////////////////////////////////////////
operator MutableResultInfo&
()
2010-11-10 00:24:00 +01:00
{
2011-03-10 15:09:32 +01:00
m_result.setMessage( m_messageStream.str() );
2010-11-10 00:24:00 +01:00
return m_result;
}
private:
2011-03-10 15:09:32 +01:00
MutableResultInfo m_result;
std::ostringstream m_messageStream;
2010-11-10 00:24:00 +01:00
};
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
explicit 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
///////////////////////////////////////////////////////////////////////////////
2011-03-14 20:21:35 +01:00
#define INTERNAL_CATCH_ACCEPT_EXPR( expr, stopOnFailure ) \
if( Catch::ResultAction::Value action = Catch::Hub::getResultCapture().acceptExpression( expr ) ) \
{ \
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 ) \
2011-03-14 20:21:35 +01:00
INTERNAL_CATCH_ACCEPT_EXPR( ( Catch::ResultBuilder( __FILE__, __LINE__, macroName, #expr, isNot )->*expr ), stopOnFailure );
2010-11-10 00:24:00 +01:00
2011-03-14 09:45:55 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_NO_THROW( expr, stopOnFailure, macroName ) \
try \
{ \
expr; \
2011-03-14 20:21:35 +01:00
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( __FILE__, __LINE__, macroName, #expr ).setResultType( Catch::ResultWas::Ok ), stopOnFailure ); \
2011-03-14 09:45:55 +01:00
} \
catch( ... ) \
{ \
2011-03-14 20:21:35 +01:00
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( __FILE__, __LINE__, macroName, #expr ).setResultType( Catch::ResultWas::ThrewException ), stopOnFailure ); \
2011-03-14 09:45:55 +01:00
}
///////////////////////////////////////////////////////////////////////////////
2011-03-14 09:49:42 +01:00
#define INTERNAL_CATCH_THROWS( expr, exceptionType, stopOnFailure, macroName ) \
2010-11-10 00:24:00 +01:00
try \
{ \
expr; \
2011-03-14 20:21:35 +01:00
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( __FILE__, __LINE__, macroName, #expr ).setResultType( Catch::ResultWas::DidntThrowException ), stopOnFailure ); \
} \
catch( Catch::TestFailureException& ) \
{ \
throw; \
2010-11-10 00:24:00 +01:00
} \
catch( exceptionType ) \
{ \
2011-03-14 20:21:35 +01:00
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( __FILE__, __LINE__, macroName, #expr ).setResultType( Catch::ResultWas::Ok ), stopOnFailure ); \
2010-11-10 00:24:00 +01:00
}
///////////////////////////////////////////////////////////////////////////////
2011-03-14 09:49:42 +01:00
#define INTERNAL_CATCH_THROWS_AS( expr, exceptionType, stopOnFailure, macroName ) \
INTERNAL_CATCH_THROWS( expr, exceptionType, stopOnFailure, macroName ) \
2011-03-14 09:45:55 +01:00
catch( ... ) \
{ \
2011-03-14 20:21:35 +01:00
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( __FILE__, __LINE__, macroName, #expr ).setResultType( Catch::ResultWas::ThrewException ), stopOnFailure ); \
2011-03-14 09:45:55 +01:00
}
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_MSG( reason, resultType, stopOnFailure, macroName ) \
2011-03-10 15:09:32 +01:00
Catch::Hub::getResultCapture().acceptExpression( ( Catch::ResultBuilder( __FILE__, __LINE__, macroName ) << reason ).setResultType( resultType ) );
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////////
2011-03-10 15:09:32 +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