/////////////////////////////////////////////////////////////////////////////// // Name: tests/strings/vsnprintf.cpp // Purpose: wxVsnprintf unit test // Author: Francesco Montorsi // (part of this file was taken from CMP.c of TRIO package // written by Bjorn Reese and Daniel Stenberg) // Created: 2006-04-01 // RCS-ID: $Id: vsnprintf.cpp 58994 2009-02-18 15:49:09Z FM $ // Copyright: (c) 2006 Francesco Montorsi, Bjorn Reese and Daniel Stenberg /////////////////////////////////////////////////////////////////////////////// // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- #include "testprec.h" #ifdef __BORLANDC__ #pragma hdrstop #endif #if wxUSE_WXVSNPRINTF #ifndef WX_PRECOMP #include "wx/wx.h" #include "wx/wxchar.h" #endif // WX_PRECOMP #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 #define ASSERT_STR_EQUAL( a, b ) \ CPPUNIT_ASSERT_EQUAL( wxString(a), wxString(b) ); #define CMP6(expected, x, y, z, w, t) \ r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z, w, t); \ CPPUNIT_ASSERT( r > 0 ); \ ASSERT_STR_EQUAL( wxT(expected), buf ); #define CMP5(expected, x, y, z, w) \ r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z, w); \ CPPUNIT_ASSERT( r > 0 ); \ 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 > 0 ); \ ASSERT_STR_EQUAL( wxT(expected), buf ); #define CMP3(expected, x, y) \ r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y); \ CPPUNIT_ASSERT( r > 0 ); \ ASSERT_STR_EQUAL( wxT(expected), buf ); #define CMP2(expected, x) \ r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x)); \ CPPUNIT_ASSERT( r > 0 ); \ ASSERT_STR_EQUAL( wxT(expected), 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) ) // ---------------------------------------------------------------------------- // test class // ---------------------------------------------------------------------------- class VsnprintfTestCase : public CppUnit::TestCase { public: VsnprintfTestCase(); private: CPPUNIT_TEST_SUITE( VsnprintfTestCase ); 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 ); CPPUNIT_TEST( WrongFormatStrings ); CPPUNIT_TEST( Miscellaneous ); CPPUNIT_TEST_SUITE_END(); 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(); void BigToSmallBuffer(); void WrongFormatStrings(); void Miscellaneous(); void Misc(wxChar *buffer, int size); DECLARE_NO_COPY_CLASS(VsnprintfTestCase) }; // register in the unnamed registry so that these tests are run by default 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::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 #ifdef __VISUALC__ #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(__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() { // NB: there are no standards about the minimum exponent width // (and the width of the %e conversion specifier refers to the // mantissa, not to the exponent). // Since newer MSVC versions use 3 digits as minimum exponent // width while GNU libc uses 2 digits as minimum width, here we // workaround this problem using for the exponent values with at // least three digits. // Some examples: // printf("%e",2.342E+02); // -> under MSVC7.1 prints: 2.342000e+002 // -> under GNU libc 2.4 prints: 2.342000e+02 CMP3("2.342000e+112", "%e",2.342E+112); CMP3("-2.3420e-112", "%10.4e",-2.342E-112); CMP3("-2.3420e-112", "%11.4e",-2.342E-112); CMP3(" -2.3420e-112", "%15.4e",-2.342E-112); CMP3("-0.02342", "%G",-2.342E-02); CMP3("3.1415E-116", "%G",3.1415e-116); CMP3("0003.141500e+103", "%016e", 3141.5e100); CMP3(" 3.141500e+103", "%16e", 3141.5e100); CMP3("3.141500e+103 ", "%-16e", 3141.5e100); CMP3("3.142e+103", "%010.3e", 3141.5e100); } void VsnprintfTestCase::F() { CMP3("3.300000", "%5f", 3.3); CMP3("3.000000", "%5f", 3.0); CMP3("0.000100", "%5f", .999999E-4); CMP3("0.000990", "%5f", .99E-3); CMP3("3333.000000", "%5f", 3333.0); } void VsnprintfTestCase::G() { // NOTE: the same about E() testcase applies here... CMP3(" 3.3", "%5g", 3.3); CMP3(" 3", "%5g", 3.0); CMP3("9.99999e-115", "%5g", .999999E-114); CMP3("0.00099", "%5g", .99E-3); CMP3(" 3333", "%5g", 3333.0); CMP3(" 0.01", "%5g", 0.01); CMP3(" 3", "%5.g", 3.3); CMP3(" 3", "%5.g", 3.0); CMP3("1e-114", "%5.g", .999999E-114); CMP3("0.0001", "%5.g", 1.0E-4); CMP3("0.001", "%5.g", .99E-3); CMP3("3e+103", "%5.g", 3333.0E100); CMP3(" 0.01", "%5.g", 0.01); CMP3(" 3.3", "%5.2g", 3.3); CMP3(" 3", "%5.2g", 3.0); CMP3("1e-114", "%5.2g", .999999E-114); CMP3("0.00099", "%5.2g", .99E-3); CMP3("3.3e+103", "%5.2g", 3333.0E100); CMP3(" 0.01", "%5.2g", 0.01); } void VsnprintfTestCase::S() { CMP3(" abc", "%5s", wxT("abc")); CMP3(" a", "%5s", wxT("a")); CMP3("abcdefghi", "%5s", wxT("abcdefghi")); CMP3("abc ", "%-5s", wxT("abc")); CMP3("abcdefghi", "%-5s", wxT("abcdefghi")); 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 } 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 // you write %%% as argument of some *printf function !) // Compare(wxT("%"), wxT("%%%")); } #ifdef wxLongLong_t void VsnprintfTestCase::LongLong() { CMP3("123456789", "%lld", (wxLongLong_t)123456789); CMP3("-123456789", "%lld", (wxLongLong_t)-123456789); CMP3("123456789", "%llu", (wxULongLong_t)123456789); #ifdef __WXMSW__ CMP3("123456789", "%I64d", (wxLongLong_t)123456789); CMP3("123456789abcdef", "%I64x", wxLL(0x123456789abcdef)); #endif } #endif void VsnprintfTestCase::Misc(wxChar *buffer, int size) { // 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). 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 always return the number of characters which // test without positionals CMPTOSIZE(buffer, size, "123 444444444 - test - 555 -0.666", "%i %li - test - %d %.3f", 123, (long int)444444444, 555, -0.666); #if wxUSE_PRINTF_POS_PARAMS // test with positional CMPTOSIZE(buffer, size, "-0.666 123 - test - 444444444 555", "%4$.3f %1$i - test - %2$li %3$d", 123, (long int)444444444, 555, -0.666); #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'); } void VsnprintfTestCase::WrongFormatStrings() { // test how wxVsnprintf() behaves with wrong format string: #if wxUSE_PRINTF_POS_PARAMS // 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: r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %3$d"), 1, 2, 3); CPPUNIT_ASSERT(r == -1); // 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(r == -1); #endif // wxUSE_PRINTF_POS_PARAMS } void VsnprintfTestCase::BigToSmallBuffer() { wxChar buf[1024], buf2[16], buf3[4], buf4; Misc(buf, 1024); Misc(buf2, 16); Misc(buf3, 4); Misc(&buf4, 1); } static void DoMisc( int expectedLen, const wxString& expectedString, size_t max, const wxChar *format, ...) { const size_t BUFSIZE = 16; wxChar buf[BUFSIZE + 1]; size_t i; static int count = 0; wxASSERT(max <= BUFSIZE); for (i = 0; i < BUFSIZE; i++) buf[i] = '*'; buf[BUFSIZE] = 0; 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