Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / cppunit.h

diff --git a/include/wx/cppunit.h b/include/wx/cppunit.h
index 3b4281cfa14808138453b14e5f44dab610896a8e..f6aee85817e147e349f9828d8ef8c3322c5ddf32 100644 (file)
--- a/include/wx/cppunit.h
+++ b/include/wx/cppunit.h
@@ -48,13 +48,31 @@
 //
 
 #include "wx/beforestd.h"
 //
 
 #include "wx/beforestd.h"

+#ifdef __VISUALC__
+    #pragma warning(push)
+
+    // with cppunit 1.12 we get many bogus warnings 4701 (local variable may be
+    // used without having been initialized) in TestAssert.h
+    #pragma warning(disable:4701)
+
+    // and also 4100 (unreferenced formal parameter) in extensions/
+    // ExceptionTestCaseDecorator.h
+    #pragma warning(disable:4100)
+#endif
+

 #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 <cppunit/extensions/TestFactoryRegistry.h>
 #include <cppunit/ui/text/TestRunner.h>
 #include <cppunit/TestCase.h>
 #include <cppunit/extensions/HelperMacros.h>
 #include <cppunit/CompilerOutputter.h>

+
+#ifdef __VISUALC__
+    #pragma warning(pop)
+#endif

 #include "wx/afterstd.h"
 
 #include "wx/afterstd.h"
 

+#include "wx/string.h"
+

 
 ///////////////////////////////////////////////////////////////////////////////
 // Set of helpful test macros.
 
 ///////////////////////////////////////////////////////////////////////////////
 // Set of helpful test macros.


@@ -69,7 +87,7 @@
     if (Condition) \
         { anyTest; } \
     else \
     if (Condition) \
         { anyTest; } \
     else \

-        wxLogInfo(wxString::Format(_T("skipping: %s.%s\n  reason: %s equals false\n"), \
+        wxLogInfo(wxString::Format(wxT("skipping: %s.%s\n  reason: %s equals false\n"), \

                                     wxString(suiteName, wxConvUTF8).c_str(), \
                                     wxString(#testMethod, wxConvUTF8).c_str(), \
                                     wxString(#Condition, wxConvUTF8).c_str()))
                                     wxString(suiteName, wxConvUTF8).c_str(), \
                                     wxString(#testMethod, wxConvUTF8).c_str(), \
                                     wxString(#Condition, wxConvUTF8).c_str()))


@@ -81,11 +99,115 @@
 #define WXTEST_FAIL_WITH_CONDITION(suiteName, Condition, testMethod) \
     WXTEST_ANY_WITH_CONDITION(suiteName, Condition, testMethod, CPPUNIT_TEST_FAIL(testMethod))
 
 #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)
+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 char *actual,
+             CppUnit::SourceLine sourceLine,
+             const std::string& message)
+{
+    assertEquals(wxString(expected), wxString(actual), sourceLine, message);
+}
+
+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 wxString& expected,
+             const char *actual,
+             CppUnit::SourceLine sourceLine,
+             const std::string& message)
+{
+    assertEquals(expected, wxString(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);
+}
+
+inline void
+assertEquals(const wxString& expected,
+             const wchar_t *actual,
+             CppUnit::SourceLine sourceLine,
+             const std::string& message)
+{
+    assertEquals(expected, wxString(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 );                                \
+        }                                                                     \
+    }

 
 

-// 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)
+// 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, int) \
+            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) \
+            WX_CPPUNIT_ASSERT_EQUALS(T, int) \
+        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(unsigned)
+WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned long)
+
+#if defined( __VMS ) && defined( __ia64 )
+WX_CPPUNIT_ALLOW_EQUALS_TO_INT(std::basic_streambuf<char>::pos_type);
+#endif
+
+#ifdef wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG
+WX_CPPUNIT_ALLOW_EQUALS_TO_INT(wxLongLong_t)
+WX_CPPUNIT_ALLOW_EQUALS_TO_INT(unsigned wxLongLong_t)
+#endif // wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG

 
 // Use this macro to compare a wxArrayString with the pipe-separated elements
 // of the given string
 
 // Use this macro to compare a wxArrayString with the pipe-separated elements
 // of the given string


@@ -104,15 +226,15 @@
         }                                                                     \
     }
 
         }                                                                     \
     }
 

-// Use this macro to compare the expected time_t value with the result of not
-// necessarily time_t type
-#define WX_ASSERT_TIME_T_EQUAL(t, n) CPPUNIT_ASSERT_EQUAL((t), (time_t)(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))
 
 // 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
 ///////////////////////////////////////////////////////////////////////////////
 // define stream inserter for wxString if it's not defined in the main library,
 // we need it to output the test failures involving wxString


@@ -131,6 +253,8 @@ inline std::ostream& operator<<(std::ostream& o, const wxString& s)
 #endif
 }
 
 #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)
 // VC6 doesn't provide overloads for operator<<(__int64) in its stream classes
 // so do it ourselves
 #if defined(__VISUALC6__) && defined(wxLongLong_t)


@@ -153,8 +277,6 @@ inline std::ostream& operator<<(std::ostream& ostr, unsigned wxLongLong_t llu)
 
 #endif // VC6 && wxLongLong_t
 
 
 #endif // VC6 && wxLongLong_t
 

-#endif // !wxUSE_STD_IOSTREAM
-

 ///////////////////////////////////////////////////////////////////////////////
 // Some more compiler warning tweaking and auto linking.
 //
 ///////////////////////////////////////////////////////////////////////////////
 // Some more compiler warning tweaking and auto linking.
 //