[wxWidgets.git] / include / wx / cppunit.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/cppunit.h
// Purpose:     wrapper header for CppUnit headers
// Author:      Vadim Zeitlin
// Created:     15.02.04
// RCS-ID:      $Id$
// Copyright:   (c) 2004 Vadim Zeitlin
// Licence:     wxWindows Licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_CPPUNIT_H_
#define _WX_CPPUNIT_H_

///////////////////////////////////////////////////////////////////////////////
// using CPPUNIT_TEST() macro results in this warning, disable it as there is
// no other way to get rid of it and it's not very useful anyhow
#ifdef __VISUALC__
    // typedef-name 'foo' used as synonym for class-name 'bar'
    #pragma warning(disable:4097)

    // unreachable code: we don't care about warnings in CppUnit headers
    #pragma warning(disable:4702)

    // 'id': identifier was truncated to 'num' characters in the debug info
    #pragma warning(disable:4786)
#endif // __VISUALC__

#ifdef __BORLANDC__
    #pragma warn -8022
#endif

#ifndef CPPUNIT_STD_NEED_ALLOCATOR
    #define CPPUNIT_STD_NEED_ALLOCATOR 0
#endif

///////////////////////////////////////////////////////////////////////////////
// Set the default format for the errors, which can be used by an IDE to jump
// to the error location. This default gets overridden by the cppunit headers
// for some compilers (e.g. VC++).

#ifndef CPPUNIT_COMPILER_LOCATION_FORMAT
    #define CPPUNIT_COMPILER_LOCATION_FORMAT "%p:%l:"
#endif


///////////////////////////////////////////////////////////////////////////////
// Include all needed cppunit headers.
//

#include "wx/beforestd.h"
#ifdef __VISUALC__
    // with cppunit 1.12 we get many bogus warnings 4701 (local variable may be
    // used without having been initialized) in TestAssert.h
    #pragma warning(disable:4701)
#endif

#include <cppunit/extensions/TestFactoryRegistry.h>
#include <cppunit/ui/text/TestRunner.h>
#include <cppunit/TestCase.h>
#include <cppunit/extensions/HelperMacros.h>
#include <cppunit/CompilerOutputter.h>

#ifdef __VISUALC__
    #pragma warning(default:4701)
#endif
#include "wx/afterstd.h"

#include "wx/string.h"


///////////////////////////////////////////////////////////////////////////////
// Set of helpful test macros.
//

// Base macro for wrapping CPPUNIT_TEST macros and so making them conditional
// tests, meaning that the test only get registered and thus run when a given
// runtime condition is true.
// In case the condition is evaluated as false a skip message is logged
// (the message will only be shown in verbose mode).
#define WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, anyTest) \
    if (Condition) \
        { anyTest; } \
    else \
        wxLogInfo(wxString::Format(_T("skipping: %s.%s\n  reason: %s equals false\n"), \
                                    wxString(suiteName, wxConvUTF8).c_str(), \
                                    wxString(#testMethod, wxConvUTF8).c_str(), \
                                    wxString(#Condition, wxConvUTF8).c_str()))

// Conditional CPPUNIT_TEST macro.
#define WXTEST_WITH_CONDITION(suiteName, Condition, testMethod) \
    WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST(testMethod))
// Conditional CPPUNIT_TEST_FAIL macro.
#define WXTEST_FAIL_WITH_CONDITION(suiteName, Condition, testMethod) \
    WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST_FAIL(testMethod))

CPPUNIT_NS_BEGIN

// provide an overload of cppunit assertEquals(T, T) which can be used to
// compare wxStrings directly with C strings
inline void
assertEquals(const char *expected,
             const char *actual,
             CppUnit::SourceLine sourceLine,
             const std::string& message)
{
    assertEquals(wxString(expected), wxString(actual), sourceLine, message);
}

inline void
assertEquals(const char *expected,
             const wxString& actual,
             CppUnit::SourceLine sourceLine,
             const std::string& message)
{
    assertEquals(wxString(expected), actual, sourceLine, message);
}

inline void
assertEquals(const wxString& expected,
             const char *actual,
             CppUnit::SourceLine sourceLine,
             const std::string& message)
{
    assertEquals(expected, wxString(actual), sourceLine, message);
}

inline void
assertEquals(const wchar_t *expected,
             const wxString& actual,
             CppUnit::SourceLine sourceLine,
             const std::string& message)
{
    assertEquals(wxString(expected), actual, sourceLine, message);
}

inline void
assertEquals(const wxString& expected,
             const wchar_t *actual,
             CppUnit::SourceLine sourceLine,
             const std::string& message)
{
    assertEquals(expected, wxString(actual), sourceLine, message);
}

CPPUNIT_NS_END

// define an assertEquals() overload for the given types, this is a helper and
// shouldn't be used directly because of VC6 complications, see below
#define WX_CPPUNIT_ASSERT_EQUALS(T1, T2)                                      \
    inline void                                                               \
    assertEquals(T1 expected,                                                 \
                 T2 actual,                                                   \
                 CppUnit::SourceLine sourceLine,                              \
                 const std::string& message)                                  \
    {                                                                         \
        if ( !assertion_traits<T1>::equal(expected,actual) )                  \
        {                                                                     \
            Asserter::failNotEqual( assertion_traits<T1>::toString(expected), \
                                    assertion_traits<T2>::toString(actual),   \
                                    sourceLine,                               \
                                    message );                                \
        }                                                                     \
    }

// this macro allows us to specify (usually literal) ints as expected values
// for functions returning integral types different from "int"
//
// FIXME-VC6: due to incorrect resolution of overloaded/template functions in
//            this compiler (it basically doesn't use the template version at
//            all if any overloaded function matches partially even if none of
//            them matches fully) we also need to provide extra overloads

#ifdef __VISUALC6__
    #define WX_CPPUNIT_ALLOW_EQUALS_TO_INT(T) \
        CPPUNIT_NS_BEGIN \
            WX_CPPUNIT_ASSERT_EQUALS(int, T) \
            WX_CPPUNIT_ASSERT_EQUALS(T, int) \
            WX_CPPUNIT_ASSERT_EQUALS(T, T) \
        CPPUNIT_NS_END

    CPPUNIT_NS_BEGIN
        WX_CPPUNIT_ASSERT_EQUALS(int, int)
    CPPUNIT_NS_END
#else // !VC6
    #define WX_CPPUNIT_ALLOW_EQUALS_TO_INT(T) \
        CPPUNIT_NS_BEGIN \
            WX_CPPUNIT_ASSERT_EQUALS(int, T) \
            WX_CPPUNIT_ASSERT_EQUALS(T, int) \
        CPPUNIT_NS_END
#endif // VC6/!VC6

WX_CPPUNIT_ALLOW_EQUALS_TO_INT(long)
WX_CPPUNIT_ALLOW_EQUALS_TO_INT(short)
WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned)
WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned long)

#if defined(wxLongLong_t) && !defined(wxLongLongIsLong)
WX_CPPUNIT_ALLOW_EQUALS_TO_INT(wxLongLong_t)
WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned wxLongLong_t)
#endif

// Use this macro to compare a wxArrayString with the pipe-separated elements
// of the given string
//
// NB: it's a macro and not a function to have the correct line numbers in the
//     test failure messages
#define WX_ASSERT_STRARRAY_EQUAL(s, a)                                        \
    {                                                                         \
        wxArrayString expected(wxSplit(s, '|', '\0'));                        \
                                                                              \
        CPPUNIT_ASSERT_EQUAL( expected.size(), a.size() );                    \
                                                                              \
        for ( size_t n = 0; n < a.size(); n++ )                               \
        {                                                                     \
            CPPUNIT_ASSERT_EQUAL( expected[n], a[n] );                        \
        }                                                                     \
    }

// Use this macro to assert with the given formatted message (it should contain
// the format string and arguments in a separate pair of parentheses)
#define WX_ASSERT_MESSAGE(msg, cond) \
    CPPUNIT_ASSERT_MESSAGE(std::string(wxString::Format msg .mb_str()), (cond))

#define WX_ASSERT_EQUAL_MESSAGE(msg, expected, actual) \
    CPPUNIT_ASSERT_EQUAL_MESSAGE(std::string(wxString::Format msg .mb_str()), \
                                 (expected), (actual))

///////////////////////////////////////////////////////////////////////////////
// define stream inserter for wxString if it's not defined in the main library,
// we need it to output the test failures involving wxString
#if !wxUSE_STD_IOSTREAM

#include "wx/string.h"

#include <iostream>

inline std::ostream& operator<<(std::ostream& o, const wxString& s)
{
#if wxUSE_UNICODE
    return o << (const char *)wxSafeConvertWX2MB(s.wc_str());
#else
    return o << s.c_str();
#endif
}

#endif // !wxUSE_STD_IOSTREAM

// VC6 doesn't provide overloads for operator<<(__int64) in its stream classes
// so do it ourselves
#if defined(__VISUALC6__) && defined(wxLongLong_t)

#include "wx/longlong.h"

inline std::ostream& operator<<(std::ostream& ostr, wxLongLong_t ll)
{
    ostr << wxLongLong(ll).ToString();

    return ostr;
}

inline std::ostream& operator<<(std::ostream& ostr, unsigned wxLongLong_t llu)
{
    ostr << wxULongLong(llu).ToString();

    return ostr;
}

#endif // VC6 && wxLongLong_t

///////////////////////////////////////////////////////////////////////////////
// Some more compiler warning tweaking and auto linking.
//

#ifdef __BORLANDC__
    #pragma warn .8022
#endif

#ifdef _MSC_VER
  #pragma warning(default:4702)
#endif // _MSC_VER

// for VC++ automatically link in cppunit library
#ifdef __VISUALC__
  #ifdef NDEBUG
    #pragma comment(lib, "cppunit.lib")
  #else // Debug
    #pragma comment(lib, "cppunitd.lib")
  #endif // Release/Debug
#endif

#endif // _WX_CPPUNIT_H_
Commit	Line	Data
86132a69 VZ	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/cppunit.h
	3	// Purpose: wrapper header for CppUnit headers
	4	// Author: Vadim Zeitlin
	5	// Created: 15.02.04
	6	// RCS-ID: $Id$
	7	// Copyright: (c) 2004 Vadim Zeitlin
99d80019	8	// Licence: wxWindows Licence
86132a69 VZ	9	/////////////////////////////////////////////////////////////////////////////
	10
	11	#ifndef _WX_CPPUNIT_H_
	12	#define _WX_CPPUNIT_H_
	13
044a69a4	14	///////////////////////////////////////////////////////////////////////////////
86132a69 VZ	15	// using CPPUNIT_TEST() macro results in this warning, disable it as there is
	16	// no other way to get rid of it and it's not very useful anyhow
	17	#ifdef __VISUALC__
	18	// typedef-name 'foo' used as synonym for class-name 'bar'
	19	#pragma warning(disable:4097)
	20
	21	// unreachable code: we don't care about warnings in CppUnit headers
	22	#pragma warning(disable:4702)
	23
	24	// 'id': identifier was truncated to 'num' characters in the debug info
	25	#pragma warning(disable:4786)
	26	#endif // __VISUALC__
	27
20f46e8d VS	28	#ifdef __BORLANDC__
	29	#pragma warn -8022
	30	#endif
d2001a56	31
53e372c2 MW	32	#ifndef CPPUNIT_STD_NEED_ALLOCATOR
	33	#define CPPUNIT_STD_NEED_ALLOCATOR 0
	34	#endif
	35
14dc53b2 MW	36	///////////////////////////////////////////////////////////////////////////////
	37	// Set the default format for the errors, which can be used by an IDE to jump
	38	// to the error location. This default gets overridden by the cppunit headers
	39	// for some compilers (e.g. VC++).
	40
d2001a56	41	#ifndef CPPUNIT_COMPILER_LOCATION_FORMAT
14dc53b2 MW	42	#define CPPUNIT_COMPILER_LOCATION_FORMAT "%p:%l:"
14dc53b2 MW	43	#endif
20f46e8d	44
044a69a4 VS	45
	46	///////////////////////////////////////////////////////////////////////////////
	47	// Include all needed cppunit headers.
	48	//
	49
86132a69	50	#include "wx/beforestd.h"
895cae46 VZ	51	#ifdef __VISUALC__
	52	// with cppunit 1.12 we get many bogus warnings 4701 (local variable may be
	53	// used without having been initialized) in TestAssert.h
	54	#pragma warning(disable:4701)
	55	#endif
	56
86132a69 VZ	57	#include <cppunit/extensions/TestFactoryRegistry.h>
	58	#include <cppunit/ui/text/TestRunner.h>
	59	#include <cppunit/TestCase.h>
	60	#include <cppunit/extensions/HelperMacros.h>
14dc53b2	61	#include <cppunit/CompilerOutputter.h>
895cae46 VZ	62
	63	#ifdef __VISUALC__
	64	#pragma warning(default:4701)
	65	#endif
86132a69 VZ	66	#include "wx/afterstd.h"
86132a69 VZ	67
3d9b0b53 VZ	68	#include "wx/string.h"
3d9b0b53 VZ	69
044a69a4 VS	70
	71	///////////////////////////////////////////////////////////////////////////////
	72	// Set of helpful test macros.
	73	//
	74
	75	// Base macro for wrapping CPPUNIT_TEST macros and so making them conditional
	76	// tests, meaning that the test only get registered and thus run when a given
68379eaf	77	// runtime condition is true.
044a69a4 VS	78	// In case the condition is evaluated as false a skip message is logged
	79	// (the message will only be shown in verbose mode).
	80	#define WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, anyTest) \
	81	if (Condition) \
	82	{ anyTest; } \
	83	else \
	84	wxLogInfo(wxString::Format(_T("skipping: %s.%s\n reason: %s equals false\n"), \
	85	wxString(suiteName, wxConvUTF8).c_str(), \
	86	wxString(#testMethod, wxConvUTF8).c_str(), \
	87	wxString(#Condition, wxConvUTF8).c_str()))
	88
	89	// Conditional CPPUNIT_TEST macro.
	90	#define WXTEST_WITH_CONDITION(suiteName, Condition, testMethod) \
	91	WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST(testMethod))
	92	// Conditional CPPUNIT_TEST_FAIL macro.
	93	#define WXTEST_FAIL_WITH_CONDITION(suiteName, Condition, testMethod) \
	94	WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST_FAIL(testMethod))
	95
1de532f5 VZ	96	CPPUNIT_NS_BEGIN
	97
	98	// provide an overload of cppunit assertEquals(T, T) which can be used to
	99	// compare wxStrings directly with C strings
390b8241 VZ	100	inline void
	101	assertEquals(const char *expected,
	102	const char *actual,
	103	CppUnit::SourceLine sourceLine,
	104	const std::string& message)
	105	{
	106	assertEquals(wxString(expected), wxString(actual), sourceLine, message);
	107	}
	108
1de532f5 VZ	109	inline void
	110	assertEquals(const char *expected,
	111	const wxString& actual,
	112	CppUnit::SourceLine sourceLine,
	113	const std::string& message)
	114	{
	115	assertEquals(wxString(expected), actual, sourceLine, message);
	116	}
	117
599d1291 VZ	118	inline void
	119	assertEquals(const wxString& expected,
	120	const char *actual,
	121	CppUnit::SourceLine sourceLine,
	122	const std::string& message)
	123	{
	124	assertEquals(expected, wxString(actual), sourceLine, message);
	125	}
	126
1de532f5 VZ	127	inline void
	128	assertEquals(const wchar_t *expected,
	129	const wxString& actual,
	130	CppUnit::SourceLine sourceLine,
	131	const std::string& message)
	132	{
	133	assertEquals(wxString(expected), actual, sourceLine, message);
	134	}
	135
599d1291 VZ	136	inline void
	137	assertEquals(const wxString& expected,
	138	const wchar_t *actual,
	139	CppUnit::SourceLine sourceLine,
	140	const std::string& message)
	141	{
	142	assertEquals(expected, wxString(actual), sourceLine, message);
	143	}
	144
b2eabfe8 VZ	145	CPPUNIT_NS_END
	146
	147	// define an assertEquals() overload for the given types, this is a helper and
	148	// shouldn't be used directly because of VC6 complications, see below
527587d3 VZ	149	#define WX_CPPUNIT_ASSERT_EQUALS(T1, T2) \
	150	inline void \
	151	assertEquals(T1 expected, \
	152	T2 actual, \
	153	CppUnit::SourceLine sourceLine, \
	154	const std::string& message) \
	155	{ \
	156	if ( !assertion_traits<T1>::equal(expected,actual) ) \
	157	{ \
	158	Asserter::failNotEqual( assertion_traits<T1>::toString(expected), \
	159	assertion_traits<T2>::toString(actual), \
	160	sourceLine, \
	161	message ); \
	162	} \
	163	}
	164
b2eabfe8 VZ	165	// this macro allows us to specify (usually literal) ints as expected values
	166	// for functions returning integral types different from "int"
	167	//
	168	// FIXME-VC6: due to incorrect resolution of overloaded/template functions in
	169	// this compiler (it basically doesn't use the template version at
	170	// all if any overloaded function matches partially even if none of
	171	// them matches fully) we also need to provide extra overloads
6fc905e0	172
b2eabfe8 VZ	173	#ifdef __VISUALC6__
	174	#define WX_CPPUNIT_ALLOW_EQUALS_TO_INT(T) \
	175	CPPUNIT_NS_BEGIN \
	176	WX_CPPUNIT_ASSERT_EQUALS(int, T) \
599d1291	177	WX_CPPUNIT_ASSERT_EQUALS(T, int) \
b2eabfe8 VZ	178	WX_CPPUNIT_ASSERT_EQUALS(T, T) \
	179	CPPUNIT_NS_END
	180
	181	CPPUNIT_NS_BEGIN
	182	WX_CPPUNIT_ASSERT_EQUALS(int, int)
	183	CPPUNIT_NS_END
	184	#else // !VC6
	185	#define WX_CPPUNIT_ALLOW_EQUALS_TO_INT(T) \
	186	CPPUNIT_NS_BEGIN \
	187	WX_CPPUNIT_ASSERT_EQUALS(int, T) \
599d1291	188	WX_CPPUNIT_ASSERT_EQUALS(T, int) \
b2eabfe8 VZ	189	CPPUNIT_NS_END
	190	#endif // VC6/!VC6
	191
	192	WX_CPPUNIT_ALLOW_EQUALS_TO_INT(long)
	193	WX_CPPUNIT_ALLOW_EQUALS_TO_INT(short)
306f34a3 VZ	194	WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned)
306f34a3 VZ	195	WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned long)
044a69a4	196
61b1a51b VZ	197	#if defined(wxLongLong_t) && !defined(wxLongLongIsLong)
	198	WX_CPPUNIT_ALLOW_EQUALS_TO_INT(wxLongLong_t)
	199	WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned wxLongLong_t)
	200	#endif
	201
5769cf0f VZ	202	// Use this macro to compare a wxArrayString with the pipe-separated elements
	203	// of the given string
	204	//
	205	// NB: it's a macro and not a function to have the correct line numbers in the
	206	// test failure messages
	207	#define WX_ASSERT_STRARRAY_EQUAL(s, a) \
	208	{ \
	209	wxArrayString expected(wxSplit(s, '\|', '\0')); \
	210	\
	211	CPPUNIT_ASSERT_EQUAL( expected.size(), a.size() ); \
	212	\
	213	for ( size_t n = 0; n < a.size(); n++ ) \
	214	{ \
	215	CPPUNIT_ASSERT_EQUAL( expected[n], a[n] ); \
	216	} \
	217	}
b7c746d0 VZ	218
	219	// Use this macro to assert with the given formatted message (it should contain
	220	// the format string and arguments in a separate pair of parentheses)
	221	#define WX_ASSERT_MESSAGE(msg, cond) \
	222	CPPUNIT_ASSERT_MESSAGE(std::string(wxString::Format msg .mb_str()), (cond))
	223
e18865ec VZ	224	#define WX_ASSERT_EQUAL_MESSAGE(msg, expected, actual) \
	225	CPPUNIT_ASSERT_EQUAL_MESSAGE(std::string(wxString::Format msg .mb_str()), \
	226	(expected), (actual))
	227
2c940453	228	///////////////////////////////////////////////////////////////////////////////
6919e3bb VZ	229	// define stream inserter for wxString if it's not defined in the main library,
	230	// we need it to output the test failures involving wxString
	231	#if !wxUSE_STD_IOSTREAM
2c940453	232
ef0aeb72 MW	233	#include "wx/string.h"
ef0aeb72 MW	234
5098c258 VZ	235	#include <iostream>
5098c258 VZ	236
2c940453 MW	237	inline std::ostream& operator<<(std::ostream& o, const wxString& s)
2c940453 MW	238	{
dad49cc7 VZ	239	#if wxUSE_UNICODE
	240	return o << (const char *)wxSafeConvertWX2MB(s.wc_str());
	241	#else
	242	return o << s.c_str();
	243	#endif
2c940453 MW	244	}
2c940453 MW	245
55d9f029 VZ	246	#endif // !wxUSE_STD_IOSTREAM
55d9f029 VZ	247
aa709c26 VZ	248	// VC6 doesn't provide overloads for operator<<(__int64) in its stream classes
	249	// so do it ourselves
	250	#if defined(__VISUALC6__) && defined(wxLongLong_t)
5098c258 VZ	251
	252	#include "wx/longlong.h"
	253
	254	inline std::ostream& operator<<(std::ostream& ostr, wxLongLong_t ll)
	255	{
	256	ostr << wxLongLong(ll).ToString();
	257
	258	return ostr;
	259	}
	260
	261	inline std::ostream& operator<<(std::ostream& ostr, unsigned wxLongLong_t llu)
	262	{
	263	ostr << wxULongLong(llu).ToString();
	264
	265	return ostr;
	266	}
	267
aa709c26	268	#endif // VC6 && wxLongLong_t
5098c258	269
044a69a4 VS	270	///////////////////////////////////////////////////////////////////////////////
	271	// Some more compiler warning tweaking and auto linking.
	272	//
	273
20f46e8d VS	274	#ifdef __BORLANDC__
	275	#pragma warn .8022
	276	#endif
	277
86132a69 VZ	278	#ifdef _MSC_VER
	279	#pragma warning(default:4702)
	280	#endif // _MSC_VER
	281
	282	// for VC++ automatically link in cppunit library
	283	#ifdef __VISUALC__
	284	#ifdef NDEBUG
	285	#pragma comment(lib, "cppunit.lib")
	286	#else // Debug
	287	#pragma comment(lib, "cppunitd.lib")
	288	#endif // Release/Debug
	289	#endif
	290
	291	#endif // _WX_CPPUNIT_H_
	292