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: cppunit.h 61872 2009-09-09 22:37:05Z VZ $
7 // Copyright:   (c) 2004 Vadim Zeitlin
8 // Licence:     wxWindows Licence
9 /////////////////////////////////////////////////////////////////////////////
10 
11 #ifndef _WX_CPPUNIT_H_
12 #define _WX_CPPUNIT_H_
13 
14 ///////////////////////////////////////////////////////////////////////////////
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 
28 #ifdef __BORLANDC__
29     #pragma warn -8022
30 #endif
31 
32 #ifndef CPPUNIT_STD_NEED_ALLOCATOR
33     #define CPPUNIT_STD_NEED_ALLOCATOR 0
34 #endif
35 
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 
41 #ifndef CPPUNIT_COMPILER_LOCATION_FORMAT
42     #define CPPUNIT_COMPILER_LOCATION_FORMAT "%p:%l:"
43 #endif
44 
45 
46 ///////////////////////////////////////////////////////////////////////////////
47 // Include all needed cppunit headers.
48 //
49 
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>
55 #include <cppunit/CompilerOutputter.h>
56 #include "wx/afterstd.h"
57 
58 
59 ///////////////////////////////////////////////////////////////////////////////
60 // Set of helpful test macros.
61 //
62 
63 // Base macro for wrapping CPPUNIT_TEST macros and so making them conditional
64 // tests, meaning that the test only get registered and thus run when a given
65 // runtime condition is true.
66 // In case the condition is evaluated as false a skip message is logged
67 // (the message will only be shown in verbose mode).
68 #define WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, anyTest) \
69     if (Condition) \
70         { anyTest; } \
71     else \
72         wxLogInfo(wxString::Format(wxT("skipping: %s.%s\n  reason: %s equals false\n"), \
73                                     wxString(suiteName, wxConvUTF8).c_str(), \
74                                     wxString(#testMethod, wxConvUTF8).c_str(), \
75                                     wxString(#Condition, wxConvUTF8).c_str()))
76 
77 // Conditional CPPUNIT_TEST macro.
78 #define WXTEST_WITH_CONDITION(suiteName, Condition, testMethod) \
79     WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST(testMethod))
80 // Conditional CPPUNIT_TEST_FAIL macro.
81 #define WXTEST_FAIL_WITH_CONDITION(suiteName, Condition, testMethod) \
82     WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST_FAIL(testMethod))
83 
84 // Use this macro to compare a wxString with a literal string.
85 #define WX_ASSERT_STR_EQUAL(p, s) CPPUNIT_ASSERT_EQUAL(wxString(p), s)
86 
87 // Use this macro to compare a size_t with a literal integer
88 #define WX_ASSERT_SIZET_EQUAL(n, m) CPPUNIT_ASSERT_EQUAL(((size_t)n), m)
89 
90 // Use this macro to compare the expected time_t value with the result of not
91 // necessarily time_t type
92 #define WX_ASSERT_TIME_T_EQUAL(t, n) CPPUNIT_ASSERT_EQUAL((t), (time_t)(n))
93 
94 
95 ///////////////////////////////////////////////////////////////////////////////
96 // stream inserter for wxString
97 //
98 
99 #include "wx/string.h"
100 
101 inline std::ostream& operator<<(std::ostream& o, const wxString& s)
102 {
103     return o << s.mb_str();
104 }
105 
106 
107 ///////////////////////////////////////////////////////////////////////////////
108 // Some more compiler warning tweaking and auto linking.
109 //
110 
111 #ifdef __BORLANDC__
112     #pragma warn .8022
113 #endif
114 
115 #ifdef _MSC_VER
116   #pragma warning(default:4702)
117 #endif // _MSC_VER
118 
119 // for VC++ automatically link in cppunit library
120 #ifdef __VISUALC__
121   #ifdef NDEBUG
122     #pragma comment(lib, "cppunit.lib")
123   #else // Debug
124     #pragma comment(lib, "cppunitd.lib")
125   #endif // Release/Debug
126 #endif
127 
128 #endif // _WX_CPPUNIT_H_
129 
130