catch2/include/internal/catch_capture.hpp

481 lines
15 KiB
C++
Raw Normal View History

2010-11-10 00:24:00 +01:00
/*
* 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_builder.hpp"
#include "catch_tostring.hpp"
2010-11-10 00:24:00 +01:00
#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"
2011-04-28 09:03:28 +02:00
#include "catch_hub.h"
#include "catch_common.h"
2010-11-10 00:24:00 +01:00
#include <sstream>
namespace Catch
{
2011-09-29 10:01:59 +02:00
2012-05-08 08:59:54 +02:00
struct TestFailureException{};
struct DummyExceptionType_DontUse{};
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
(
ResultInfoBuilder& result,
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>
ResultInfoBuilder& 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>
ResultInfoBuilder& 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>
ResultInfoBuilder& 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>
ResultInfoBuilder& 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>
ResultInfoBuilder& 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>
ResultInfoBuilder& 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
}
///////////////////////////////////////////////////////////////////////////
ResultInfoBuilder& operator ==
(
bool rhs
)
{
return m_result.captureExpression<Internal::IsEqualTo>( m_lhs, rhs );
}
///////////////////////////////////////////////////////////////////////////
ResultInfoBuilder& operator !=
(
bool rhs
)
{
return m_result.captureExpression<Internal::IsNotEqualTo>( m_lhs, rhs );
}
///////////////////////////////////////////////////////////////////////////
operator ResultInfoBuilder&
2011-03-10 15:09:32 +01:00
()
{
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:
ResultInfoBuilder& m_result;
T m_lhs;
2011-03-10 15:09:32 +01:00
};
2011-03-18 20:08:33 +01:00
template<typename LhsT>
class PtrExpression
{
public:
2011-03-18 20:08:33 +01:00
///////////////////////////////////////////////////////////////////////////
PtrExpression
(
ResultInfoBuilder& result,
2011-03-18 20:08:33 +01:00
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>
ResultInfoBuilder& operator ==
2011-03-18 20:08:33 +01:00
(
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
ResultInfoBuilder& operator ==
2011-03-18 20:08:33 +01:00
(
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>
ResultInfoBuilder& operator !=
2011-03-18 20:08:33 +01:00
(
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
ResultInfoBuilder& operator !=
2011-03-18 20:08:33 +01:00
(
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
}
2011-04-08 20:38:50 +02:00
///////////////////////////////////////////////////////////////////////////
operator ResultInfoBuilder&
2011-04-08 20:38:50 +02:00
()
{
2011-04-26 09:35:52 +02:00
return m_result->captureBoolExpression( m_lhs );
2011-04-08 20:38:50 +02:00
}
2011-03-18 20:08:33 +01:00
private:
ResultInfoBuilder* m_result;
2011-03-18 20:08:33 +01:00
const LhsT* m_lhs;
};
2012-03-04 12:14:21 +01:00
2011-03-10 15:09:32 +01:00
class ResultBuilder
{
public:
///////////////////////////////////////////////////////////////////////////
ResultBuilder
(
const SourceLineInfo& lineInfo,
2011-03-10 15:09:32 +01:00
const char* macroName,
const char* expr = "",
bool isNot = false
)
: m_result( expr, isNot, lineInfo, macroName ),
m_messageStream()
2011-03-10 15:09:32 +01:00
{}
///////////////////////////////////////////////////////////////////////////
template<typename T>
Expression<const T&> operator->*
2011-03-10 15:09:32 +01:00
(
const T & operand
)
2010-11-10 00:24:00 +01:00
{
Expression<const T&> expr( m_result, operand );
2011-03-10 15:09:32 +01:00
return expr;
}
2011-06-29 20:22:56 +02:00
///////////////////////////////////////////////////////////////////////////
Expression<const char*> operator->*
(
2011-07-15 09:07:44 +02:00
const char* const& operand
2011-06-29 20:22:56 +02:00
)
{
Expression<const char*> 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;
}
///////////////////////////////////////////////////////////////////////////
Expression<bool> operator->*
(
bool value
)
{
Expression<bool> expr( m_result, value );
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
{
m_messageStream << Catch::toString( value );
2011-03-10 15:09:32 +01:00
return *this;
}
2012-03-04 12:14:21 +01:00
///////////////////////////////////////////////////////////////////////////
template<typename MatcherT, typename ArgT>
ResultBuilder& acceptMatcher
(
const MatcherT& matcher,
const ArgT& arg,
const std::string& matcherCallAsString
)
{
std::string matcherAsString = Catch::toString( matcher );
if( matcherAsString == "{?}" )
matcherAsString = matcherCallAsString;
m_result.setLhs( Catch::toString( arg ) );
m_result.setRhs( matcherAsString );
m_result.setOp( "matches" );
m_result.setResultType( matcher( arg ) ? ResultWas::Ok : ResultWas::ExpressionFailed );
return *this;
}
2012-03-17 19:20:06 +01:00
///////////////////////////////////////////////////////////////////////////
template<typename MatcherT, typename ArgT>
ResultBuilder& acceptMatcher
(
const MatcherT& matcher,
ArgT* arg,
const std::string& matcherCallAsString
)
{
std::string matcherAsString = Catch::toString( matcher );
if( matcherAsString == "{?}" )
matcherAsString = matcherCallAsString;
m_result.setLhs( Catch::toString( arg ) );
m_result.setRhs( matcherAsString );
m_result.setOp( "matches" );
m_result.setResultType( matcher( arg ) ? ResultWas::Ok : ResultWas::ExpressionFailed );
return *this;
}
2011-03-10 15:09:32 +01:00
///////////////////////////////////////////////////////////////////////////
ResultBuilder& setResultType
(
ResultWas::OfType resultType
)
{
m_result.setResultType( resultType );
return *this;
}
///////////////////////////////////////////////////////////////////////////
operator ResultInfoBuilder&
()
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:
ResultInfoBuilder m_result;
2011-03-10 15:09:32 +01:00
std::ostringstream m_messageStream;
2010-11-10 00:24:00 +01:00
};
class ScopedInfo
{
public:
ScopedInfo() : m_oss() {
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 );
}
template<typename T>
ScopedInfo& operator << ( const T& value ) {
m_oss << value;
return *this;
}
std::string getInfo () const {
return m_oss.str();
}
private:
std::ostringstream m_oss;
};
2010-12-30 00:13:22 +01:00
// This is just here to avoid compiler warnings with macro constants
inline bool isTrue( bool value ){ return value; }
2010-11-10 00:24:00 +01:00
} // end namespace Catch
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_ACCEPT_EXPR( expr, stopOnFailure, originalExpr ) \
if( Catch::ResultAction::Value internal_catch_action = Catch::Hub::getResultCapture().acceptExpression( expr ) ) \
{ \
if( internal_catch_action == Catch::ResultAction::DebugFailed ) BreakIntoDebugger(); \
2010-12-30 00:13:22 +01:00
if( Catch::isTrue( stopOnFailure ) ) throw Catch::TestFailureException(); \
if( Catch::isTrue( false ) ){ bool this_is_here_to_invoke_warnings = ( originalExpr ); Catch::isTrue( this_is_here_to_invoke_warnings ); } \
}
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_TEST( expr, isNot, stopOnFailure, macroName ) \
do{ try{ \
INTERNAL_CATCH_ACCEPT_EXPR( ( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #expr, isNot )->*expr ), stopOnFailure, expr ); \
}catch( Catch::TestFailureException& ){ \
throw; \
} catch( ... ){ \
INTERNAL_CATCH_ACCEPT_EXPR( ( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #expr ) << Catch::Hub::getExceptionTranslatorRegistry().translateActiveException() ).setResultType( Catch::ResultWas::ThrewException ), false, expr ); \
throw; \
}}while( Catch::isTrue( false ) )
2010-11-10 00:24:00 +01:00
2012-02-10 09:30:13 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_IF( expr, isNot, stopOnFailure, macroName ) \
INTERNAL_CATCH_TEST( expr, isNot, stopOnFailure, macroName ); \
if( Catch::Hub::getResultCapture().getLastResult()->ok() )
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_ELSE( expr, isNot, stopOnFailure, macroName ) \
INTERNAL_CATCH_TEST( expr, isNot, stopOnFailure, macroName ); \
if( !Catch::Hub::getResultCapture().getLastResult()->ok() )
2011-03-14 09:45:55 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_NO_THROW( expr, stopOnFailure, macroName ) \
try \
{ \
expr; \
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #expr ).setResultType( Catch::ResultWas::Ok ), stopOnFailure, false ); \
2011-03-14 09:45:55 +01:00
} \
catch( ... ) \
{ \
INTERNAL_CATCH_ACCEPT_EXPR( ( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #expr ) << Catch::Hub::getExceptionTranslatorRegistry().translateActiveException() ).setResultType( Catch::ResultWas::ThrewException ), stopOnFailure, false ); \
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; \
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #expr ).setResultType( Catch::ResultWas::DidntThrowException ), stopOnFailure, false ); \
2011-03-14 20:21:35 +01:00
} \
catch( Catch::TestFailureException& ) \
{ \
throw; \
2010-11-10 00:24:00 +01:00
} \
catch( exceptionType ) \
{ \
INTERNAL_CATCH_ACCEPT_EXPR( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #expr ).setResultType( Catch::ResultWas::Ok ), stopOnFailure, false ); \
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( ... ) \
{ \
INTERNAL_CATCH_ACCEPT_EXPR( ( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #expr ) << Catch::Hub::getExceptionTranslatorRegistry().translateActiveException() ).setResultType( Catch::ResultWas::ThrewException ), stopOnFailure, false ); \
2011-03-14 09:45:55 +01:00
}
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CATCH_MSG( reason, resultType, stopOnFailure, macroName ) \
Catch::Hub::getResultCapture().acceptExpression( ( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, 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
2012-03-04 12:14:21 +01:00
///////////////////////////////////////////////////////////////////////////////
#define INTERNAL_CHECK_THAT( arg, matcher, stopOnFailure, macroName ) \
do{ try{ \
INTERNAL_CATCH_ACCEPT_EXPR( ( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #arg " " #matcher, false ).acceptMatcher( matcher, arg, #matcher ) ), stopOnFailure, false ); \
2012-03-04 12:14:21 +01:00
}catch( Catch::TestFailureException& ){ \
throw; \
} catch( ... ){ \
INTERNAL_CATCH_ACCEPT_EXPR( ( Catch::ResultBuilder( CATCH_INTERNAL_LINEINFO, macroName, #arg " " #matcher ) << Catch::Hub::getExceptionTranslatorRegistry().translateActiveException() ).setResultType( Catch::ResultWas::ThrewException ), false, false ); \
2012-03-04 12:14:21 +01:00
throw; \
}}while( Catch::isTrue( false ) )
2010-11-10 00:24:00 +01:00
#endif // TWOBLUECUBES_CATCH_CAPTURE_HPP_INCLUDED