X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/20f46e8dc8ba9246f7174e9d9153f61282f53a07..0b822969a677939811d9fb966177031fb5fc625b:/include/wx/cppunit.h

diff --git a/include/wx/cppunit.h b/include/wx/cppunit.h
index daca99cb6a..a7affd50ae 100644
--- a/include/wx/cppunit.h
+++ b/include/wx/cppunit.h
@@ -5,11 +5,13 @@
 // 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__
@@ -27,13 +29,132 @@
     #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"
 #include <cppunit/extensions/TestFactoryRegistry.h>
 #include <cppunit/ui/text/TestRunner.h>
 #include <cppunit/TestCase.h>
 #include <cppunit/extensions/HelperMacros.h>
+#include <cppunit/CompilerOutputter.h>
 #include "wx/afterstd.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))
+
+// Use this macro to compare a wxString with a literal string.
+#define WX_ASSERT_STR_EQUAL(p, s) CPPUNIT_ASSERT_EQUAL(wxString(p), s)
+
+// Use this macro to compare a size_t with a literal integer
+#define WX_ASSERT_SIZET_EQUAL(n, m) CPPUNIT_ASSERT_EQUAL(((size_t)n), m)
+
+// 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 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
+}
+
+// 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
+
+#endif // !wxUSE_STD_IOSTREAM
+
+///////////////////////////////////////////////////////////////////////////////
+// Some more compiler warning tweaking and auto linking.
+//
+
 #ifdef __BORLANDC__
     #pragma warn .8022
 #endif