include/wx/cppunit.h

   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
   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 #include "wx/string.h"
  59
  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
  67 // runtime condition is true.
  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
  86 CPPUNIT_NS_BEGIN
  87
  88 // provide an overload of cppunit assertEquals(T, T) which can be used to
  89 // compare wxStrings directly with C strings
  90 inline void
  91 assertEquals(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
  99 inline void
 100 assertEquals(const wchar_t *expected,
 101              const wxString& actual,
 102              CppUnit::SourceLine sourceLine,
 103              const std::string& message)
 104 {
 105     assertEquals(wxString(expected), actual, sourceLine, message);
 106 }
 107
 108 // and another to be able to specify (usually literal) ints as expected values
 109 // for functions returning any of unsigned {int,long} or size_t
 110 inline void
 111 assertEquals(int expected,
 112              unsigned actual,
 113              CppUnit::SourceLine sourceLine,
 114              const std::string& message)
 115 {
 116     assertEquals(unsigned(expected), actual, sourceLine, message);
 117 }
 118
 119 inline void
 120 assertEquals(int expected,
 121              unsigned long actual,
 122              CppUnit::SourceLine sourceLine,
 123              const std::string& message)
 124 {
 125     assertEquals((unsigned long)expected, actual, sourceLine, message);
 126 }
 127
 128 // we also need this one to resolve ambiguity in the tests comparing unsigned
 129 // short (e.g. wxDateTime_t returned by several wxDateTime methods) with
 130 // literal integer constants
 131 inline void
 132 assertEquals(int expected,
 133              unsigned short actual,
 134              CppUnit::SourceLine sourceLine,
 135              const std::string& message)
 136 {
 137     assertEquals((unsigned short)expected, actual, sourceLine, message);
 138 }
 139
 140 // this one is useful for wxTextCtrl functions which return longs
 141 inline void
 142 assertEquals(int expected,
 143              long actual,
 144              CppUnit::SourceLine sourceLine,
 145              const std::string& message)
 146 {
 147     assertEquals((long)expected, actual, sourceLine, message);
 148 }
 149
 150 CPPUNIT_NS_END
 151
 152 // Use this macro to compare a wxArrayString with the pipe-separated elements
 153 // of the given string
 154 //
 155 // NB: it's a macro and not a function to have the correct line numbers in the
 156 //     test failure messages
 157 #define WX_ASSERT_STRARRAY_EQUAL(s, a)                                        \
 158     {                                                                         \
 159         wxArrayString expected(wxSplit(s, '|', '\0'));                        \
 160                                                                               \
 161         CPPUNIT_ASSERT_EQUAL( expected.size(), a.size() );                    \
 162                                                                               \
 163         for ( size_t n = 0; n < a.size(); n++ )                               \
 164         {                                                                     \
 165             CPPUNIT_ASSERT_EQUAL( expected[n], a[n] );                        \
 166         }                                                                     \
 167     }
 168
 169 // Use this macro to assert with the given formatted message (it should contain
 170 // the format string and arguments in a separate pair of parentheses)
 171 #define WX_ASSERT_MESSAGE(msg, cond) \
 172     CPPUNIT_ASSERT_MESSAGE(std::string(wxString::Format msg .mb_str()), (cond))
 173
 174 ///////////////////////////////////////////////////////////////////////////////
 175 // define stream inserter for wxString if it's not defined in the main library,
 176 // we need it to output the test failures involving wxString
 177 #if !wxUSE_STD_IOSTREAM
 178
 179 #include "wx/string.h"
 180
 181 #include <iostream>
 182
 183 inline std::ostream& operator<<(std::ostream& o, const wxString& s)
 184 {
 185 #if wxUSE_UNICODE
 186     return o << (const char *)wxSafeConvertWX2MB(s.wc_str());
 187 #else
 188     return o << s.c_str();
 189 #endif
 190 }
 191
 192 // VC6 doesn't provide overloads for operator<<(__int64) in its stream classes
 193 // so do it ourselves
 194 #if defined(__VISUALC6__) && defined(wxLongLong_t)
 195
 196 #include "wx/longlong.h"
 197
 198 inline std::ostream& operator<<(std::ostream& ostr, wxLongLong_t ll)
 199 {
 200     ostr << wxLongLong(ll).ToString();
 201
 202     return ostr;
 203 }
 204
 205 inline std::ostream& operator<<(std::ostream& ostr, unsigned wxLongLong_t llu)
 206 {
 207     ostr << wxULongLong(llu).ToString();
 208
 209     return ostr;
 210 }
 211
 212 #endif // VC6 && wxLongLong_t
 213
 214 #endif // !wxUSE_STD_IOSTREAM
 215
 216 ///////////////////////////////////////////////////////////////////////////////
 217 // Some more compiler warning tweaking and auto linking.
 218 //
 219
 220 #ifdef __BORLANDC__
 221     #pragma warn .8022
 222 #endif
 223
 224 #ifdef _MSC_VER
 225   #pragma warning(default:4702)
 226 #endif // _MSC_VER
 227
 228 // for VC++ automatically link in cppunit library
 229 #ifdef __VISUALC__
 230   #ifdef NDEBUG
 231     #pragma comment(lib, "cppunit.lib")
 232   #else // Debug
 233     #pragma comment(lib, "cppunitd.lib")
 234   #endif // Release/Debug
 235 #endif
 236
 237 #endif // _WX_CPPUNIT_H_
 238