X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/68379eaf0ae64d105f8244b1db83e793f7dd83b0..8d4ff849370781952d46cd78eb628a575ab3c688:/include/wx/cppunit.h

diff --git a/include/wx/cppunit.h b/include/wx/cppunit.h
index dbdae16f4a..81dcbe2ef2 100644
--- a/include/wx/cppunit.h
+++ b/include/wx/cppunit.h
@@ -5,6 +5,7 @@
 // Created:     15.02.04
 // RCS-ID:      $Id$
 // Copyright:   (c) 2004 Vadim Zeitlin
+// Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CPPUNIT_H_
@@ -28,6 +29,19 @@
     #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.
@@ -38,8 +52,11 @@
 #include <cppunit/ui/text/TestRunner.h>
 #include <cppunit/TestCase.h>
 #include <cppunit/extensions/HelperMacros.h>
+#include <cppunit/CompilerOutputter.h>
 #include "wx/afterstd.h"
 
+#include "wx/string.h"
+
 
 ///////////////////////////////////////////////////////////////////////////////
 // Set of helpful test macros.
@@ -66,6 +83,144 @@
 #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 wxString& actual,
+             CppUnit::SourceLine sourceLine,
+             const std::string& message)
+{
+    assertEquals(wxString(expected), 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);
+}
+
+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, 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) \
+        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(size_t)
+
+// 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.