X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/10b7d13cdb173dae4988987b73fa9194bf6bf7ab..6aea1e4a7067d8e7cbac03833b64a363baefcb16:/tests/strings/vsnprintf.cpp?ds=sidebyside diff --git a/tests/strings/vsnprintf.cpp b/tests/strings/vsnprintf.cpp index a0e073be70..e77d87c28c 100644 --- a/tests/strings/vsnprintf.cpp +++ b/tests/strings/vsnprintf.cpp @@ -19,50 +19,95 @@ #pragma hdrstop #endif +#include "wx/crt.h" + +#if wxUSE_WXVSNPRINTF + #ifndef WX_PRECOMP #include "wx/wx.h" #include "wx/wxchar.h" #endif // WX_PRECOMP +// NOTE: for more info about the specification of wxVsnprintf() behaviour you can +// refer to the following page of the GNU libc manual: +// http://www.gnu.org/software/libc/manual/html_node/Formatted-Output.html -#define MAX_TEST_LEN 1024 +// ---------------------------------------------------------------------------- +// global utilities for testing +// ---------------------------------------------------------------------------- + +#define MAX_TEST_LEN 1024 + // temporary buffers static wxChar buf[MAX_TEST_LEN]; +int r; -// these macros makes it possible to write all tests without repeating a lot of times wxT() macro +// these macros makes it possible to write all tests without repeating a lot +// of times the wxT() macro +// NOTE: you should use expected strings with these macros which do not exceed +// MAX_TEST_LEN as these macro do check if the return value is == (int)wxStrlen(buf) #define ASSERT_STR_EQUAL( a, b ) \ - CPPUNIT_ASSERT( wxString(a) == wxString(b) ); + CPPUNIT_ASSERT_EQUAL( wxString(a), wxString(b) ); + +#define CMP6(expected, fmt, y, z, w, t) \ + r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w, t); \ + CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \ + ASSERT_STR_EQUAL( wxT(expected), buf ); -#define CMP5(expected, x, y, z, w) \ - wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z, w); \ - \ +#define CMP5(expected, fmt, y, z, w) \ + r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w); \ + CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \ ASSERT_STR_EQUAL( wxT(expected), buf ); -#define CMP4(expected, x, y, z) \ - wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z); \ - \ +#define CMP4(expected, fmt, y, z) \ + r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z); \ + CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \ ASSERT_STR_EQUAL( wxT(expected), buf ); -#define CMP3(expected, x, y) \ - wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y); \ - \ +#define CMP3(expected, fmt, y) \ + r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y); \ + CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \ ASSERT_STR_EQUAL( wxT(expected), buf ); -#define CMP2(expected, x) \ - wxSnprintf(buf, MAX_TEST_LEN, wxT(x)); \ - \ +#define CMP2(expected, fmt) \ + r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt)); \ + CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \ ASSERT_STR_EQUAL( wxT(expected), buf ); -#define CMPTOSIZE(buffer, size, expected, fmt, x, y, z, w) \ - wxSnprintf(buffer, size, wxT(fmt), x, y, z, w); \ - \ - CPPUNIT_ASSERT( wxString(wxT(expected)).Left(size - 1) == buffer ) +// 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, 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 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 +// suppressed! +template +static int +wxUnsafeSnprintf(T *buf, size_t len, const wxChar *fmt, ...) +{ + va_list args; + va_start(args, fmt); + int rc = wxVsnprintf(buf, len, fmt, args); + va_end(args); + + return rc; +} // ---------------------------------------------------------------------------- // test class @@ -71,27 +116,66 @@ static wxChar buf[MAX_TEST_LEN]; class VsnprintfTestCase : public CppUnit::TestCase { public: - VsnprintfTestCase(); + VsnprintfTestCase() {} + + virtual void setUp(); private: CPPUNIT_TEST_SUITE( VsnprintfTestCase ); + CPPUNIT_TEST( C ); + CPPUNIT_TEST( D ); + CPPUNIT_TEST( X ); + CPPUNIT_TEST( O ); + CPPUNIT_TEST( P ); + CPPUNIT_TEST( N ); CPPUNIT_TEST( E ); CPPUNIT_TEST( F ); CPPUNIT_TEST( G ); CPPUNIT_TEST( S ); CPPUNIT_TEST( Asterisk ); + CPPUNIT_TEST( Percent ); +#ifdef wxLongLong_t + CPPUNIT_TEST( LongLong ); +#endif CPPUNIT_TEST( BigToSmallBuffer ); +#if wxUSE_WXVSNPRINTF + CPPUNIT_TEST( WrongFormatStrings ); +#endif // wxUSE_WXVSNPRINTF + CPPUNIT_TEST( Miscellaneous ); CPPUNIT_TEST_SUITE_END(); + void C(); + void D(); + void X(); + void O(); + void P(); + void N(); void E(); void F(); void G(); void S(); void Asterisk(); + void Percent(); +#ifdef wxLongLong_t + void LongLong(); +#endif + void Unicode(); + template + void DoBigToSmallBuffer(T *buffer, int size); void BigToSmallBuffer(); - void Misc(wxChar *buffer, int size); + +#if wxUSE_WXVSNPRINTF + void WrongFormatStrings(); +#endif // wxUSE_WXVSNPRINTF + + // 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) }; @@ -102,8 +186,79 @@ 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() +{ + CMP5("hi!", "%c%c%c", wxT('h'), wxT('i'), wxT('!')); + + // NOTE: + // the NULL characters _can_ be passed to %c to e.g. create strings + // with embedded NULs (because strings are not always supposed to be + // NUL-terminated). + + DoMisc(14, wxT("Hello \0 World!"), 16, wxT("Hello %c World!"), wxT('\0')); +} + +void VsnprintfTestCase::D() +{ + CMP3("+123456", "%+d", 123456); + CMP3("-123456", "%d", -123456); + CMP3(" 123456", "% d", 123456); + CMP3(" 123456", "%10d", 123456); + CMP3("0000123456", "%010d", 123456); + CMP3("-123456 ", "%-10d", -123456); +} + +void VsnprintfTestCase::X() +{ + CMP3("ABCD", "%X", 0xABCD); + CMP3("0XABCD", "%#X", 0xABCD); + CMP3("0xabcd", "%#x", 0xABCD); +} + +void VsnprintfTestCase::O() +{ + CMP3("1234567", "%o", 01234567); + CMP3("01234567", "%#o", 01234567); +} + +void VsnprintfTestCase::P() +{ + // WARNING: printing of pointers is not fully standard. + // GNU prints them as %#x except for NULL pointers which are + // printed as '(nil)'. + // MSVC always print them as %8X on 32 bit systems and as %16X + // on 64 bit systems + // 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); + #elif SIZEOF_VOID_P == 8 + 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); +#endif +} + +void VsnprintfTestCase::N() +{ + int nchar; + + wxSnprintf(buf, MAX_TEST_LEN, _T("%d %s%n\n"), 3, _T("bears"), &nchar); + CPPUNIT_ASSERT_EQUAL( 7, nchar ); } void VsnprintfTestCase::E() @@ -178,10 +333,70 @@ void VsnprintfTestCase::S() CMP3("abcde", "%.5s", wxT("abcdefghi")); + // do the same tests but with Unicode characters: +#if wxUSE_UNICODE + + // 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")); +} + +void VsnprintfTestCase::Asterisk() +{ + CMP5(" 0.1", "%*.*f", 10, 1, 0.123); + CMP5(" 0.1230", "%*.*f", 10, 4, 0.123); + 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() +{ // some tests without any argument passed through ... CMP2("%", "%%"); CMP2("%%%", "%%%%%%"); + CMP3("% abc", "%%%5s", wxT("abc")); + CMP3("% abc%", "%%%5s%%", wxT("abc")); + // do not test odd number of '%' symbols as different implementations // of snprintf() give different outputs as this situation is not considered // by any standard (in fact, GCC will also warn you about a spurious % if @@ -189,58 +404,199 @@ void VsnprintfTestCase::S() // Compare(wxT("%"), wxT("%%%")); } -void VsnprintfTestCase::Asterisk() +#ifdef wxLongLong_t +void VsnprintfTestCase::LongLong() { - CMP5(" 0.1", "%*.*f", 10, 1, 0.123); - CMP5(" 0.1230", "%*.*f", 10, 4, 0.123); - CMP5("0.1", "%*.*f", 3, 1, 0.123); + CMP3("123456789", "%lld", (wxLongLong_t)123456789); + CMP3("-123456789", "%lld", (wxLongLong_t)-123456789); - CMP4("%0.002", "%%%.*f", 3, 0.0023456789); + CMP3("123456789", "%llu", (wxULongLong_t)123456789); + +#ifdef __WXMSW__ + CMP3("123456789", "%I64d", (wxLongLong_t)123456789); + 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::Misc(wxChar *buffer, int size) +void VsnprintfTestCase::WrongFormatStrings() { - // NB: remember that wx*printf could be mapped either to system - // implementation or to wx implementation. - // In the first case, when the output buffer is too small, the returned - // value can be the number of characters required for the output buffer - // (conforming to ISO C99; implemented in e.g. GNU libc >= 2.1), or - // just a negative number, usually -1; (this is how e.g. MSVC's - // *printf() behaves). Fortunately, in all implementations, when the - // output buffer is too small, it's nonetheless filled up to its max - // size. + // 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 +void VsnprintfTestCase::DoBigToSmallBuffer(T *buffer, int size) +{ + // Remember that wx*printf could be mapped either to system + // implementation or to wx implementation. + // In the first case, when the output buffer is too small, the returned + // value can be the number of characters required for the output buffer + // (conforming to ISO C99; implemented in e.g. GNU libc >= 2.1), or + // just a negative number, usually -1; (this is how e.g. MSVC's + // *printf() behaves). Luckily, in all implementations, when the + // output buffer is too small, it's nonetheless filled up to its max size. + // + // Note that in the second case (i.e. when we're using our own implementation), + // wxVsnprintf() will return the number of characters written in the standard + // output or + // -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 - // NB: this line will output two warnings like these, on GCC: - // warning: use of 'h' length modifier with 's' type character (i.e. - // GCC warns you that 'h' is not legal on 's' conv spec) but they must - // be ignored as here we explicitely want to test the wxSnprintf() - // behaviour in such case - - CMPTOSIZE(buffer, size, - "unicode string: unicode!! W - ansi string: ansi!! w\n\n", - "unicode string: %ls %lc - ansi string: %hs %hc\n\n", - L"unicode!!", L'W', "ansi!!", 'w'); + // + // NB: we use wxUnsafeSnprintf() as %hs and %hc are invalid in printf + // format and gcc would warn about this otherwise + + r = wxUnsafeSnprintf(buffer, size, + _T("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( + expected, + wxString(buffer) + ); } void VsnprintfTestCase::BigToSmallBuffer() { - wxChar buf[1024], buf2[16], buf3[4], buf4; + // VC6 can't compile this code +#if !defined(__VISUALC__) || (__VISUALC__ >= 1310) +#if wxUSE_UNICODE + wchar_t bufw[1024], bufw2[16], bufw3[4], bufw4; + DoBigToSmallBuffer(bufw, 1024); + DoBigToSmallBuffer(bufw2, 16); + DoBigToSmallBuffer(bufw3, 4); + DoBigToSmallBuffer(&bufw4, 1); +#endif // wxUSE_UNICODE + + 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, + size_t max, + const wxChar *format, ...) +{ + const size_t BUFSIZE = MAX_TEST_LEN - 1; + size_t i; + static int count = 0; + + wxASSERT(max <= BUFSIZE); + + for (i = 0; i < BUFSIZE; i++) + buf[i] = '*'; + buf[BUFSIZE] = 0; - Misc(buf, 1024); - Misc(buf2, 16); - Misc(buf3, 4); - Misc(&buf4, 1); + va_list ap; + va_start(ap, format); + + int n = wxVsnprintf(buf, max, format, ap); + + va_end(ap); + + // 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("'"); + + // turn them into std::strings + std::string errMsg(errStr.mb_str()); + std::string overflowMsg(overflowStr.mb_str()); + + CPPUNIT_ASSERT_MESSAGE(errMsg, + (expectedLen == -1 && size_t(n) >= max) || expectedLen == n); + + CPPUNIT_ASSERT_MESSAGE(errMsg, expectedString == buf); + + for (i = max; i < BUFSIZE; i++) + CPPUNIT_ASSERT_MESSAGE(overflowMsg, buf[i] == '*'); } + +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); +} + +#endif // wxUSE_WXVSNPRINTF