]> git.saurik.com Git - wxWidgets.git/blame - include/wx/cppunit.h
compilation fix after r60017
[wxWidgets.git] / include / wx / cppunit.h
CommitLineData
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:"
43#endif
20f46e8d 44
044a69a4
VS
45
46///////////////////////////////////////////////////////////////////////////////
47// Include all needed cppunit headers.
48//
49
86132a69
VZ
50#include "wx/beforestd.h"
51#include <cppunit/extensions/TestFactoryRegistry.h>
52#include <cppunit/ui/text/TestRunner.h>
53#include <cppunit/TestCase.h>
54#include <cppunit/extensions/HelperMacros.h>
14dc53b2 55#include <cppunit/CompilerOutputter.h>
86132a69
VZ
56#include "wx/afterstd.h"
57
3d9b0b53
VZ
58#include "wx/string.h"
59
044a69a4
VS
60
61///////////////////////////////////////////////////////////////////////////////
62// Set of helpful test macros.
63//
64
65// Base macro for wrapping CPPUNIT_TEST macros and so making them conditional
66// tests, meaning that the test only get registered and thus run when a given
68379eaf 67// runtime condition is true.
044a69a4
VS
68// In case the condition is evaluated as false a skip message is logged
69// (the message will only be shown in verbose mode).
70#define WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, anyTest) \
71 if (Condition) \
72 { anyTest; } \
73 else \
74 wxLogInfo(wxString::Format(_T("skipping: %s.%s\n reason: %s equals false\n"), \
75 wxString(suiteName, wxConvUTF8).c_str(), \
76 wxString(#testMethod, wxConvUTF8).c_str(), \
77 wxString(#Condition, wxConvUTF8).c_str()))
78
79// Conditional CPPUNIT_TEST macro.
80#define WXTEST_WITH_CONDITION(suiteName, Condition, testMethod) \
81 WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST(testMethod))
82// Conditional CPPUNIT_TEST_FAIL macro.
83#define WXTEST_FAIL_WITH_CONDITION(suiteName, Condition, testMethod) \
84 WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST_FAIL(testMethod))
85
1de532f5
VZ
86CPPUNIT_NS_BEGIN
87
88// provide an overload of cppunit assertEquals(T, T) which can be used to
89// compare wxStrings directly with C strings
90inline void
91assertEquals(const char *expected,
92 const wxString& actual,
93 CppUnit::SourceLine sourceLine,
94 const std::string& message)
95{
96 assertEquals(wxString(expected), actual, sourceLine, message);
97}
98
599d1291
VZ
99inline void
100assertEquals(const wxString& expected,
101 const char *actual,
102 CppUnit::SourceLine sourceLine,
103 const std::string& message)
104{
105 assertEquals(expected, wxString(actual), sourceLine, message);
106}
107
1de532f5
VZ
108inline void
109assertEquals(const wchar_t *expected,
110 const wxString& actual,
111 CppUnit::SourceLine sourceLine,
112 const std::string& message)
113{
114 assertEquals(wxString(expected), actual, sourceLine, message);
115}
116
599d1291
VZ
117inline void
118assertEquals(const wxString& expected,
119 const wchar_t *actual,
120 CppUnit::SourceLine sourceLine,
121 const std::string& message)
122{
123 assertEquals(expected, wxString(actual), sourceLine, message);
124}
125
b2eabfe8
VZ
126CPPUNIT_NS_END
127
128// define an assertEquals() overload for the given types, this is a helper and
129// shouldn't be used directly because of VC6 complications, see below
527587d3
VZ
130#define WX_CPPUNIT_ASSERT_EQUALS(T1, T2) \
131 inline void \
132 assertEquals(T1 expected, \
133 T2 actual, \
134 CppUnit::SourceLine sourceLine, \
135 const std::string& message) \
136 { \
137 if ( !assertion_traits<T1>::equal(expected,actual) ) \
138 { \
139 Asserter::failNotEqual( assertion_traits<T1>::toString(expected), \
140 assertion_traits<T2>::toString(actual), \
141 sourceLine, \
142 message ); \
143 } \
144 }
145
b2eabfe8
VZ
146// this macro allows us to specify (usually literal) ints as expected values
147// for functions returning integral types different from "int"
148//
149// FIXME-VC6: due to incorrect resolution of overloaded/template functions in
150// this compiler (it basically doesn't use the template version at
151// all if any overloaded function matches partially even if none of
152// them matches fully) we also need to provide extra overloads
6fc905e0 153
b2eabfe8
VZ
154#ifdef __VISUALC6__
155 #define WX_CPPUNIT_ALLOW_EQUALS_TO_INT(T) \
156 CPPUNIT_NS_BEGIN \
157 WX_CPPUNIT_ASSERT_EQUALS(int, T) \
599d1291 158 WX_CPPUNIT_ASSERT_EQUALS(T, int) \
b2eabfe8
VZ
159 WX_CPPUNIT_ASSERT_EQUALS(T, T) \
160 CPPUNIT_NS_END
161
162 CPPUNIT_NS_BEGIN
163 WX_CPPUNIT_ASSERT_EQUALS(int, int)
164 CPPUNIT_NS_END
165#else // !VC6
166 #define WX_CPPUNIT_ALLOW_EQUALS_TO_INT(T) \
167 CPPUNIT_NS_BEGIN \
168 WX_CPPUNIT_ASSERT_EQUALS(int, T) \
599d1291 169 WX_CPPUNIT_ASSERT_EQUALS(T, int) \
b2eabfe8
VZ
170 CPPUNIT_NS_END
171#endif // VC6/!VC6
172
173WX_CPPUNIT_ALLOW_EQUALS_TO_INT(long)
174WX_CPPUNIT_ALLOW_EQUALS_TO_INT(short)
306f34a3
VZ
175WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned)
176WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned long)
044a69a4 177
5769cf0f
VZ
178// Use this macro to compare a wxArrayString with the pipe-separated elements
179// of the given string
180//
181// NB: it's a macro and not a function to have the correct line numbers in the
182// test failure messages
183#define WX_ASSERT_STRARRAY_EQUAL(s, a) \
184 { \
185 wxArrayString expected(wxSplit(s, '|', '\0')); \
186 \
187 CPPUNIT_ASSERT_EQUAL( expected.size(), a.size() ); \
188 \
189 for ( size_t n = 0; n < a.size(); n++ ) \
190 { \
191 CPPUNIT_ASSERT_EQUAL( expected[n], a[n] ); \
192 } \
193 }
b7c746d0
VZ
194
195// Use this macro to assert with the given formatted message (it should contain
196// the format string and arguments in a separate pair of parentheses)
197#define WX_ASSERT_MESSAGE(msg, cond) \
198 CPPUNIT_ASSERT_MESSAGE(std::string(wxString::Format msg .mb_str()), (cond))
199
e18865ec
VZ
200#define WX_ASSERT_EQUAL_MESSAGE(msg, expected, actual) \
201 CPPUNIT_ASSERT_EQUAL_MESSAGE(std::string(wxString::Format msg .mb_str()), \
202 (expected), (actual))
203
2c940453 204///////////////////////////////////////////////////////////////////////////////
6919e3bb
VZ
205// define stream inserter for wxString if it's not defined in the main library,
206// we need it to output the test failures involving wxString
207#if !wxUSE_STD_IOSTREAM
2c940453 208
ef0aeb72
MW
209#include "wx/string.h"
210
5098c258
VZ
211#include <iostream>
212
2c940453
MW
213inline std::ostream& operator<<(std::ostream& o, const wxString& s)
214{
dad49cc7
VZ
215#if wxUSE_UNICODE
216 return o << (const char *)wxSafeConvertWX2MB(s.wc_str());
217#else
218 return o << s.c_str();
219#endif
2c940453
MW
220}
221
55d9f029
VZ
222#endif // !wxUSE_STD_IOSTREAM
223
aa709c26
VZ
224// VC6 doesn't provide overloads for operator<<(__int64) in its stream classes
225// so do it ourselves
226#if defined(__VISUALC6__) && defined(wxLongLong_t)
5098c258
VZ
227
228#include "wx/longlong.h"
229
230inline std::ostream& operator<<(std::ostream& ostr, wxLongLong_t ll)
231{
232 ostr << wxLongLong(ll).ToString();
233
234 return ostr;
235}
236
237inline std::ostream& operator<<(std::ostream& ostr, unsigned wxLongLong_t llu)
238{
239 ostr << wxULongLong(llu).ToString();
240
241 return ostr;
242}
243
aa709c26 244#endif // VC6 && wxLongLong_t
5098c258 245
044a69a4
VS
246///////////////////////////////////////////////////////////////////////////////
247// Some more compiler warning tweaking and auto linking.
248//
249
20f46e8d
VS
250#ifdef __BORLANDC__
251 #pragma warn .8022
252#endif
253
86132a69
VZ
254#ifdef _MSC_VER
255 #pragma warning(default:4702)
256#endif // _MSC_VER
257
258// for VC++ automatically link in cppunit library
259#ifdef __VISUALC__
260 #ifdef NDEBUG
261 #pragma comment(lib, "cppunit.lib")
262 #else // Debug
263 #pragma comment(lib, "cppunitd.lib")
264 #endif // Release/Debug
265#endif
266
267#endif // _WX_CPPUNIT_H_
268