]> git.saurik.com Git - wxWidgets.git/blobdiff - tests/strings/vsnprintf.cpp
Fix another off-by-1 bug in wxMBConv::ToWChar().
[wxWidgets.git] / tests / strings / vsnprintf.cpp
index 7a92b857841ae62e422514f014fcbe03d370cb0d..c34f8fa0611fe3368cc165c0c00c05e1b15fdcdb 100644 (file)
     #pragma hdrstop
 #endif
 
+#include "wx/crt.h"
+
+#if wxUSE_WXVSNPRINTF
+
 #ifndef WX_PRECOMP
     #include "wx/wx.h"
     #include "wx/wxchar.h"
@@ -49,37 +53,44 @@ int r;
 #define ASSERT_STR_EQUAL( a, b ) \
     CPPUNIT_ASSERT_EQUAL( wxString(a), wxString(b) );
 
-#define CMP5(expected, x, y, z, w)                    \
-    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z, w); \
-    CPPUNIT_ASSERT( r == (int)wxStrlen(buf) );        \
+#define CMP6(expected, fmt, y, z, w, t)                    \
+    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w, t); \
+    CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) );          \
     ASSERT_STR_EQUAL( wxT(expected), buf );
 
-#define CMP4(expected, x, y, z)                     \
-    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z);  \
-    CPPUNIT_ASSERT( r == (int)wxStrlen(buf) );      \
+#define CMP5(expected, fmt, y, z, w)                    \
+    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w); \
+    CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) );          \
     ASSERT_STR_EQUAL( wxT(expected), buf );
 
-#define CMP3(expected, x, y)                        \
-    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y);     \
-    CPPUNIT_ASSERT( r == (int)wxStrlen(buf) );      \
+#define CMP4(expected, fmt, y, z)                     \
+    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z);  \
+    CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) );          \
     ASSERT_STR_EQUAL( wxT(expected), buf );
 
-#define CMP2(expected, x)                           \
-    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x));        \
-    CPPUNIT_ASSERT( r == (int)wxStrlen(buf) );      \
+#define CMP3(expected, fmt, y)                        \
+    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y);     \
+    CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) );          \
+    ASSERT_STR_EQUAL( wxT(expected), buf );
+
+#define CMP2(expected, fmt)                           \
+    r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt));        \
+    CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) );          \
     ASSERT_STR_EQUAL( wxT(expected), buf );
 
 // NOTE: this macro is used also with too-small buffers (see Miscellaneous())
 //       test function, thus the return value can be > size and thus we
 //       cannot check if r == (int)wxStrlen(buf)
-#define CMPTOSIZE(buffer, size, expected, fmt, x, y, z, w)          \
-    r=wxSnprintf(buffer, size, wxT(fmt), x, y, z, w);               \
-    CPPUNIT_ASSERT( r > 0 );                                        \
-    CPPUNIT_ASSERT_EQUAL( wxString(wxT(expected)).Left(size - 1),   \
-                          wxString(buffer) )
+#define CMPTOSIZE(buffer, size, failuremsg, expected, fmt, x, y, z, w)  \
+    r=wxSnprintf(buffer, size, wxT(fmt), x, y, z, w);                   \
+    CPPUNIT_ASSERT( r > 0 );                                            \
+    CPPUNIT_ASSERT_EQUAL_MESSAGE(                                       \
+        failuremsg,                                                     \
+        wxString(wxT(expected)).Left(size - 1),                         \
+        wxString(buffer))
 
 // this is the same as wxSnprintf() but it passes the format string to
-// wxVsnprintf() without using ATTRIBUTE_PRINTF and thus suppresses the gcc
+// wxVsnprintf() without using WX_ATTRIBUTE_PRINTF and thus suppresses the gcc
 // checks (and resulting warnings) for the format string
 //
 // use with extreme care and only when you're really sure the warnings must be
@@ -105,7 +116,9 @@ wxUnsafeSnprintf(T *buf, size_t len, const wxChar *fmt, ...)
 class VsnprintfTestCase : public CppUnit::TestCase
 {
 public:
-    VsnprintfTestCase();
+    VsnprintfTestCase() {}
+
+    virtual void setUp();
 
 private:
     CPPUNIT_TEST_SUITE( VsnprintfTestCase );
@@ -149,18 +162,20 @@ private:
 #endif
     void Unicode();
 
+    template<typename T> 
+        void DoBigToSmallBuffer(T *buffer, int size);
     void BigToSmallBuffer();
+
 #if wxUSE_WXVSNPRINTF
     void WrongFormatStrings();
 #endif // wxUSE_WXVSNPRINTF
-    void Miscellaneous();
-    template<typename T> void Misc(T *buffer, int size);
 
     // compares the expectedString and the result of wxVsnprintf() char by char
     // for all its lenght (not only for first expectedLen chars) and also
     // checks the return value
     void DoMisc(int expectedLen, const wxString& expectedString,
                 size_t max, const wxChar *format, ...);
+    void Miscellaneous();
 
     DECLARE_NO_COPY_CLASS(VsnprintfTestCase)
 };
@@ -171,8 +186,11 @@ CPPUNIT_TEST_SUITE_REGISTRATION( VsnprintfTestCase );
 // also include in it's own registry so that these tests can be run alone
 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( VsnprintfTestCase, "VsnprintfTestCase" );
 
-VsnprintfTestCase::VsnprintfTestCase()
+void VsnprintfTestCase::setUp()
 {
+    // this call is required to avoid check failures when running on machines
+    // with a locale where the decimal point is not '.'
+    wxSetlocale(LC_ALL, "C");
 }
 
 void VsnprintfTestCase::C()
@@ -217,7 +235,8 @@ void VsnprintfTestCase::P()
     //          printed as '(nil)'.
     //          MSVC always print them as %8X on 32 bit systems and as %16X
     //          on 64 bit systems
-#ifdef __VISUALC__
+    //          mingw32 uses MSVC CRT by default so uses the same rules
+#if defined(__VISUALC__) || (defined(__MINGW32__) && !__USE_MINGW_ANSI_STDIO)
     #if SIZEOF_VOID_P == 4
         CMP3("00ABCDEF", "%p", (void*)0xABCDEF);
         CMP3("00000000", "%p", (void*)NULL);
@@ -225,6 +244,9 @@ void VsnprintfTestCase::P()
         CMP3("0000ABCDEFABCDEF", "%p", (void*)0xABCDEFABCDEF);
         CMP3("0000000000000000", "%p", (void*)NULL);
     #endif
+#elif defined(__MINGW32__) 
+    CMP3("0xabcdef", "%p", (void*)0xABCDEF); 
+    CMP3("0", "%p", (void*)NULL); 
 #elif defined(__GNUG__)
     CMP3("0xabcdef", "%p", (void*)0xABCDEF);
     CMP3("(nil)", "%p", (void*)NULL);
@@ -235,7 +257,7 @@ void VsnprintfTestCase::N()
 {
     int nchar;
 
-    wxSnprintf(buf, MAX_TEST_LEN, _T("%d %s%n\n"), 3, _T("bears"), &nchar);
+    wxSnprintf(buf, MAX_TEST_LEN, wxT("%d %s%n\n"), 3, wxT("bears"), &nchar);
     CPPUNIT_ASSERT_EQUAL( 7, nchar );
 }
 
@@ -312,31 +334,43 @@ void VsnprintfTestCase::S()
     CMP3("abcde", "%.5s", wxT("abcdefghi"));
 
     // do the same tests but with Unicode characters:
-#if wxUSE_UNICODE && !defined(__VISUALC__) // FIXME: this doesn't compile with VC7
-    #define ALPHA     "\x3B1"
-    #define BETA      "\x3B2"
-    #define GAMMA     "\x3B3"
-    #define DELTA     "\x3B4"
-    #define EPSILON   "\x3B5"
-    #define ZETA      "\x3B6"
-    #define ETA       "\x3B7"
-    #define THETA     "\x3B8"
-    #define IOTA      "\x3B9"
-
-    #define ABC         ALPHA BETA GAMMA
-    #define ABCDE       ALPHA BETA GAMMA DELTA EPSILON
-    #define ABCDEFGHI   ALPHA BETA GAMMA DELTA EPSILON ZETA ETA THETA IOTA
-
-    CMP3("  " ABC, "%5s", wxT(ABC));
-    CMP3("    " ALPHA, "%5s", wxT(ALPHA));
-    CMP3(ABCDEFGHI, "%5s", wxT(ABCDEFGHI));
-    CMP3(ABC "  ", "%-5s", wxT(ABC));
-    CMP3(ABCDEFGHI, "%-5s", wxT(ABCDEFGHI));
-
-    CMP3(ABCDE, "%.5s", wxT(ABCDEFGHI));
-#endif
+#if wxUSE_UNICODE
 
-    // test a string which have the NULL character after "ab";
+    // Unicode code points from U+03B1 to U+03B9 are the greek letters alpha-iota;
+    // UTF8 encoding of such code points is 0xCEB1 to 0xCEB9
+
+#define ALPHA       "\xCE\xB1"
+        // alpha
+#define ABC         "\xCE\xB1\xCE\xB2\xCE\xB3"
+        // alpha+beta+gamma
+#define ABCDE       "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5"
+        // alpha+beta+gamma+delta+epsilon
+#define ABCDEFGHI   "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5\xCE\xB6\xCE\xB7\xCE\xB8\xCE\xB9"
+        // alpha+beta+gamma+delta+epsilon+zeta+eta+theta+iota
+
+    // the 'expected' and 'arg' parameters of this macro are supposed to be
+    // UTF-8 strings
+#define CMP3_UTF8(expected, fmt, arg)                                         \
+    CPPUNIT_ASSERT_EQUAL                                                      \
+    (                                                                         \
+        wxString::FromUTF8(expected).length(),                                \
+        wxSnprintf(buf, MAX_TEST_LEN, fmt, wxString::FromUTF8(arg))           \
+    );                                                                        \
+    CPPUNIT_ASSERT_EQUAL                                                      \
+    (                                                                         \
+        wxString::FromUTF8(expected),                                         \
+        buf                                                                   \
+    )
+
+    CMP3_UTF8("  " ABC,     "%5s",  ABC);
+    CMP3_UTF8("    " ALPHA, "%5s",  ALPHA);
+    CMP3_UTF8(ABCDEFGHI,    "%5s",  ABCDEFGHI);
+    CMP3_UTF8(ABC "  ",     "%-5s", ABC);
+    CMP3_UTF8(ABCDEFGHI,    "%-5s", ABCDEFGHI);
+    CMP3_UTF8(ABCDE,        "%.5s", ABCDEFGHI);
+#endif // wxUSE_UNICODE
+
+    // test a string which has a NULL character after "ab";
     // obviously it should be handled exactly like just as "ab"
     CMP3("   ab", "%5s", wxT("ab\0cdefghi"));
 }
@@ -348,6 +382,10 @@ void VsnprintfTestCase::Asterisk()
     CMP5("0.1", "%*.*f", 3, 1, 0.123);
 
     CMP4("%0.002", "%%%.*f", 3, 0.0023456789);
+
+    CMP4("       a", "%*c", 8, 'a');
+    CMP4("    four", "%*s", 8, "four");
+    CMP6("    four   four", "%*s %*s", 8, "four", 6, "four");
 }
 
 void VsnprintfTestCase::Percent()
@@ -376,13 +414,49 @@ void VsnprintfTestCase::LongLong()
 
 #ifdef __WXMSW__
     CMP3("123456789", "%I64d", (wxLongLong_t)123456789);
-    CMP3("123456789abcdef", "%I64x", (wxLongLong_t)0x123456789abcdef);
+    CMP3("123456789abcdef", "%I64x", wxLL(0x123456789abcdef));
 #endif
 }
 #endif
 
+// this test is only for our own implementation, the system implementation
+// doesn't always give errors for invalid format strings (e.g. glibc doesn't)
+// and as it's not required too (the behaviour is "undefined" according to the
+// spec), there is really no sense in testing for it
+#if wxUSE_WXVSNPRINTF
+
+void VsnprintfTestCase::WrongFormatStrings()
+{
+    // test how wxVsnprintf() behaves with wrong format string:
+
+#if 0
+    // NB: the next 2 tests currently return an error but it would be nice
+    //     if they didn't (see ticket #9367)
+
+    // two positionals with the same index:
+    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$s %1$s"), "hello");
+    CPPUNIT_ASSERT(r != -1);
+
+    // three positionals with the same index mixed with other pos args:
+    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%4$d %2$f %1$s %2$s %3$d"), "hello", "world", 3, 4);
+    CPPUNIT_ASSERT(r != -1);
+#endif
+
+    // a missing positional arg: this should result in an error but not all
+    // implementations detect it (e.g. glibc doesn't)
+    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %3$d"), 1, 2, 3);
+    CPPUNIT_ASSERT_EQUAL(-1, r);
+
+    // positional and non-positionals in the same format string:
+    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %d %3$d"), 1, 2, 3);
+    CPPUNIT_ASSERT_EQUAL(-1, r);
+}
+
+#endif // wxUSE_WXVSNPRINTF
+
+// BigToSmallBuffer() test case helper:
 template<typename T>
-void VsnprintfTestCase::Misc(T *buffer, int size)
+void VsnprintfTestCase::DoBigToSmallBuffer(T *buffer, int size)
 {
     // Remember that wx*printf could be mapped either to system
     // implementation or to wx implementation.
@@ -399,16 +473,22 @@ void VsnprintfTestCase::Misc(T *buffer, int size)
     //   -1         if there was an error in the format string
     //   maxSize+1  if the output buffer is too small
 
+    wxString errStr;
+    errStr << "The size of the buffer was " << size;
+    std::string errMsg(errStr.mb_str());
+
     // test without positionals
-    CMPTOSIZE(buffer, size, "123 444444444 - test - 555 -0.666",
-              "%i %li - test - %d %.3f",
-              123, (long int)444444444, 555, -0.666);
+    CMPTOSIZE(buffer, size, errMsg,
+              "123456789012 - test - 123 -4.567",
+              "%i%li - test - %d %.3f",
+              123, (long int)456789012, 123, -4.567);
 
 #if wxUSE_PRINTF_POS_PARAMS
     // test with positional
-    CMPTOSIZE(buffer, size, "-0.666 123 - test - 444444444 555",
+    CMPTOSIZE(buffer, size, errMsg,
+              "-4.567 123 - test - 456789012 123",
               "%4$.3f %1$i - test - %2$li %3$d",
-              123, (long int)444444444, 555, -0.666);
+              123, (long int)456789012, 123, -4.567);
 #endif
 
     // test unicode/ansi conversion specifiers
@@ -417,68 +497,39 @@ void VsnprintfTestCase::Misc(T *buffer, int size)
     //     format and gcc would warn about this otherwise
 
     r = wxUnsafeSnprintf(buffer, size,
-                         _T("unicode string: %ls %lc - ansi string: %hs %hc\n\n"),
-                         L"unicode!!", L'W', "ansi!!", 'w');
+                         wxT("unicode string/char: %ls/%lc -- ansi string/char: %hs/%hc"),
+                         L"unicode", L'U', "ansi", 'A');
+    wxString expected =
+        wxString(wxT("unicode string/char: unicode/U -- ansi string/char: ansi/A")).Left(size - 1);
+
     CPPUNIT_ASSERT( r != -1 );
     CPPUNIT_ASSERT_EQUAL(
-        wxString(wxT("unicode string: unicode!! W - ansi string: ansi!! w\n\n")).Left(size - 1),
+        expected,
         wxString(buffer)
     );
 }
 
-
-// this test is only for our own implementation, the system implementation
-// doesn't always give errors for invalid format strings (e.g. glibc doesn't)
-// and as it's not required too (the behaviour is "undefined" according to the
-// spec), there is really no sense in testing for it (and the first 2 formats
-// in this test are not invalid at all in fact)
-#if wxUSE_WXVSNPRINTF
-
-void VsnprintfTestCase::WrongFormatStrings()
-{
-    // test how wxVsnprintf() behaves with wrong format string:
-
-    // NB: the next 2 tests currently return an error but they shouldn't,
-    //     according to POSIX reusing the parameters is allowed
-
-    // two positionals with the same index:
-    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$s %1$s"), "hello");
-    CPPUNIT_ASSERT(r != -1);
-
-    // three positionals with the same index mixed with other pos args:
-    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%4$d %2$f %1$s %2$s %3$d"), "hello", "world", 3, 4);
-    CPPUNIT_ASSERT(r != -1);
-
-    // a missing positional arg: this should result in an error but not all
-    // implementations detect it (e.g. glibc doesn't)
-    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %3$d"), 1, 2, 3);
-    CPPUNIT_ASSERT_EQUAL(-1, r);
-
-    // positional and non-positionals in the same format string:
-    r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %d %3$d"), 1, 2, 3);
-    CPPUNIT_ASSERT_EQUAL(-1, r);
-}
-
-#endif // wxUSE_WXVSNPRINTF
-
 void VsnprintfTestCase::BigToSmallBuffer()
 {
-    char bufa[1024], bufa2[16], bufa3[4], bufa4;
-
+    // VC6 can't compile this code
+#if !defined(__VISUALC__) || (__VISUALC__ >= 1310)
 #if wxUSE_UNICODE
     wchar_t bufw[1024], bufw2[16], bufw3[4], bufw4;
-    Misc(bufw, 1024);
-    Misc(bufw2, 16);
-    Misc(bufw3, 4);
-    Misc(&bufw4, 1);
+    DoBigToSmallBuffer(bufw, 1024);
+    DoBigToSmallBuffer(bufw2, 16);
+    DoBigToSmallBuffer(bufw3, 4);
+    DoBigToSmallBuffer(&bufw4, 1);
 #endif // wxUSE_UNICODE
 
-    Misc(bufa, 1024);
-    Misc(bufa2, 16);
-    Misc(bufa3, 4);
-    Misc(&bufa4, 1);
+    char bufa[1024], bufa2[16], bufa3[4], bufa4;
+    DoBigToSmallBuffer(bufa, 1024);
+    DoBigToSmallBuffer(bufa2, 16);
+    DoBigToSmallBuffer(bufa3, 4);
+    DoBigToSmallBuffer(&bufa4, 1);
+#endif // !VC6
 }
 
+// Miscellaneous() test case helper:
 void VsnprintfTestCase::DoMisc(
         int expectedLen,
         const wxString& expectedString,
@@ -505,10 +556,10 @@ void VsnprintfTestCase::DoMisc(
     // Prepare messages so that it is possible to see from the error which
     // test was running.
     wxString errStr, overflowStr;
-    errStr << _T("No.: ") << ++count << _T(", expected: ") << expectedLen
-           << _T(" '") << expectedString << _T("', result: ");
-    overflowStr << errStr << _T("buffer overflow");
-    errStr << n << _T(" '") << buf << _T("'");
+    errStr << wxT("No.: ") << ++count << wxT(", expected: ") << expectedLen
+           << wxT(" '") << expectedString << wxT("', result: ");
+    overflowStr << errStr << wxT("buffer overflow");
+    errStr << n << wxT(" '") << buf << wxT("'");
 
     // turn them into std::strings
     std::string errMsg(errStr.mb_str());
@@ -526,24 +577,26 @@ void VsnprintfTestCase::DoMisc(
 void VsnprintfTestCase::Miscellaneous()
 {
     // expectedLen, expectedString, max, format, ...
-    DoMisc(5, wxT("-1234"), 8, wxT("%d"), -1234);
-    DoMisc(7, wxT("1234567"), 8,  wxT("%d"), 1234567);
-    DoMisc(-1, wxT("1234567"), 8,  wxT("%d"), 12345678);
-    DoMisc(-1, wxT("-123456"), 8,  wxT("%d"), -1234567890);
-
-    DoMisc(6, wxT("123456"), 8,  wxT("123456"));
-    DoMisc(7, wxT("1234567"), 8,  wxT("1234567"));
-    DoMisc(-1, wxT("1234567"), 8,  wxT("12345678"));
-
-    DoMisc(6, wxT("123450"), 8,  wxT("12345%d"), 0);
-    DoMisc(7, wxT("1234560"), 8,  wxT("123456%d"), 0);
-    DoMisc(-1, wxT("1234567"), 8,  wxT("1234567%d"), 0);
-    DoMisc(-1, wxT("1234567"), 8,  wxT("12345678%d"), 0);
-
-    DoMisc(6, wxT("12%45%"), 8,  wxT("12%%45%%"));
-    DoMisc(7, wxT("12%45%7"), 8,  wxT("12%%45%%7"));
-    DoMisc(-1, wxT("12%45%7"), 8,  wxT("12%%45%%78"));
-
-    DoMisc(5, wxT("%%%%%"), 6,  wxT("%%%%%%%%%%"));
-    DoMisc(6, wxT("%%%%12"), 7,  wxT("%%%%%%%%%d"), 12);
+    DoMisc(5,  wxT("-1234"),   8, wxT("%d"), -1234);
+    DoMisc(7,  wxT("1234567"), 8, wxT("%d"), 1234567);
+    DoMisc(-1, wxT("1234567"), 8, wxT("%d"), 12345678);
+    DoMisc(-1, wxT("-123456"), 8, wxT("%d"), -1234567890);
+
+    DoMisc(6,  wxT("123456"),  8, wxT("123456"));
+    DoMisc(7,  wxT("1234567"), 8, wxT("1234567"));
+    DoMisc(-1, wxT("1234567"), 8, wxT("12345678"));
+
+    DoMisc(6,  wxT("123450"),  8, wxT("12345%d"), 0);
+    DoMisc(7,  wxT("1234560"), 8, wxT("123456%d"), 0);
+    DoMisc(-1, wxT("1234567"), 8, wxT("1234567%d"), 0);
+    DoMisc(-1, wxT("1234567"), 8, wxT("12345678%d"), 0);
+
+    DoMisc(6,  wxT("12%45%"),  8, wxT("12%%45%%"));
+    DoMisc(7,  wxT("12%45%7"), 8, wxT("12%%45%%7"));
+    DoMisc(-1, wxT("12%45%7"), 8, wxT("12%%45%%78"));
+
+    DoMisc(5,  wxT("%%%%%"),   6, wxT("%%%%%%%%%%"));
+    DoMisc(6,  wxT("%%%%12"),  7, wxT("%%%%%%%%%d"), 12);
 }
+
+#endif // wxUSE_WXVSNPRINTF