1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: tests/strings/vsnprintf.cpp
3 // Purpose: wxVsnprintf unit test
4 // Author: Francesco Montorsi
5 // (part of this file was taken from CMP.c of TRIO package
6 // written by Bjorn Reese and Daniel Stenberg)
9 // Copyright: (c) 2006 Francesco Montorsi, Bjorn Reese and Daniel Stenberg
10 ///////////////////////////////////////////////////////////////////////////////
12 // ----------------------------------------------------------------------------
14 // ----------------------------------------------------------------------------
28 #include "wx/wxchar.h"
32 // NOTE: for more info about the specification of wxVsnprintf() behaviour you can
33 // refer to the following page of the GNU libc manual:
34 // http://www.gnu.org/software/libc/manual/html_node/Formatted-Output.html
38 // ----------------------------------------------------------------------------
39 // global utilities for testing
40 // ----------------------------------------------------------------------------
42 #define MAX_TEST_LEN 1024
45 static wxChar buf
[MAX_TEST_LEN
];
48 // these macros makes it possible to write all tests without repeating a lot
49 // of times the wxT() macro
50 // NOTE: you should use expected strings with these macros which do not exceed
51 // MAX_TEST_LEN as these macro do check if the return value is == (int)wxStrlen(buf)
53 #define ASSERT_STR_EQUAL( a, b ) \
54 CPPUNIT_ASSERT_EQUAL( wxString(a), wxString(b) );
56 #define CMP6(expected, fmt, y, z, w, t) \
57 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w, t); \
58 CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
59 ASSERT_STR_EQUAL( wxT(expected), buf );
61 #define CMP5(expected, fmt, y, z, w) \
62 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w); \
63 CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
64 ASSERT_STR_EQUAL( wxT(expected), buf );
66 #define CMP4(expected, fmt, y, z) \
67 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z); \
68 CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
69 ASSERT_STR_EQUAL( wxT(expected), buf );
71 #define CMP3(expected, fmt, y) \
72 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y); \
73 CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
74 ASSERT_STR_EQUAL( wxT(expected), buf );
76 #define CMP2(expected, fmt) \
77 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt)); \
78 CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
79 ASSERT_STR_EQUAL( wxT(expected), buf );
81 // NOTE: this macro is used also with too-small buffers (see Miscellaneous())
82 // test function, thus the return value can be > size and thus we
83 // cannot check if r == (int)wxStrlen(buf)
84 #define CMPTOSIZE(buffer, size, failuremsg, expected, fmt, x, y, z, w) \
85 r=wxSnprintf(buffer, size, wxT(fmt), x, y, z, w); \
86 CPPUNIT_ASSERT( r > 0 ); \
87 CPPUNIT_ASSERT_EQUAL_MESSAGE( \
89 wxString(wxT(expected)).Left(size - 1), \
92 // this is the same as wxSnprintf() but it passes the format string to
93 // wxVsnprintf() without using WX_ATTRIBUTE_PRINTF and thus suppresses the gcc
94 // checks (and resulting warnings) for the format string
96 // use with extreme care and only when you're really sure the warnings must be
100 wxUnsafeSnprintf(T
*buf
, size_t len
, const wxChar
*fmt
, ...)
105 int rc
= wxVsnprintf(buf
, len
, fmt
, args
);
112 // ----------------------------------------------------------------------------
114 // ----------------------------------------------------------------------------
116 class VsnprintfTestCase
: public CppUnit
::TestCase
119 VsnprintfTestCase() {}
121 virtual void setUp();
124 CPPUNIT_TEST_SUITE( VsnprintfTestCase
);
135 CPPUNIT_TEST( Asterisk
);
136 CPPUNIT_TEST( Percent
);
138 CPPUNIT_TEST( LongLong
);
141 CPPUNIT_TEST( BigToSmallBuffer
);
142 CPPUNIT_TEST( WrongFormatStrings
);
143 CPPUNIT_TEST( Miscellaneous
);
144 CPPUNIT_TEST( GlibcMisc1
);
145 CPPUNIT_TEST( GlibcMisc2
);
146 CPPUNIT_TEST_SUITE_END();
166 void DoBigToSmallBuffer(T
*buffer
, int size
);
167 void BigToSmallBuffer();
169 void WrongFormatStrings();
171 // compares the expectedString and the result of wxVsnprintf() char by char
172 // for all its lenght (not only for first expectedLen chars) and also
173 // checks the return value
174 void DoMisc(int expectedLen
, const wxString
& expectedString
,
175 size_t max
, const wxChar
*format
, ...);
176 void Miscellaneous();
181 DECLARE_NO_COPY_CLASS(VsnprintfTestCase
)
184 // register in the unnamed registry so that these tests are run by default
185 CPPUNIT_TEST_SUITE_REGISTRATION( VsnprintfTestCase
);
187 // also include in it's own registry so that these tests can be run alone
188 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( VsnprintfTestCase
, "VsnprintfTestCase" );
190 void VsnprintfTestCase
::setUp()
192 // this call is required to avoid check failures when running on machines
193 // with a locale where the decimal point is not '.'
194 wxSetlocale(LC_ALL
, "C");
197 void VsnprintfTestCase
::C()
199 CMP5("hi!", "%c%c%c", wxT('h'), wxT('i'), wxT('!'));
202 // the NULL characters _can_ be passed to %c to e.g. create strings
203 // with embedded NULs (because strings are not always supposed to be
206 DoMisc(14, wxT("Hello \0 World!"), 16, wxT("Hello %c World!"), wxT('\0'));
209 void VsnprintfTestCase
::D()
211 CMP3("+123456", "%+d", 123456);
212 CMP3("-123456", "%d", -123456);
213 CMP3(" 123456", "% d", 123456);
214 CMP3(" 123456", "%10d", 123456);
215 CMP3("0000123456", "%010d", 123456);
216 CMP3("-123456 ", "%-10d", -123456);
219 void VsnprintfTestCase
::X()
221 CMP3("ABCD", "%X", 0xABCD);
222 CMP3("0XABCD", "%#X", 0xABCD);
223 CMP3("0xabcd", "%#x", 0xABCD);
226 void VsnprintfTestCase
::O()
228 CMP3("1234567", "%o", 01234567);
229 CMP3("01234567", "%#o", 01234567);
232 void VsnprintfTestCase
::P()
234 // WARNING: printing of pointers is not fully standard.
235 // GNU prints them as %#x except for NULL pointers which are
236 // printed as '(nil)'.
237 // MSVC always print them as %8X on 32 bit systems and as %16X
239 // mingw32 uses MSVC CRT by default so uses the same rules
240 #if defined(__VISUALC__) || (defined(__MINGW32__) && !__USE_MINGW_ANSI_STDIO)
241 #if SIZEOF_VOID_P == 4
242 CMP3("00ABCDEF", "%p", (void*)0xABCDEF);
243 CMP3("00000000", "%p", (void*)NULL
);
244 #elif SIZEOF_VOID_P == 8
245 CMP3("0000ABCDEFABCDEF", "%p", (void*)0xABCDEFABCDEF);
246 CMP3("0000000000000000", "%p", (void*)NULL
);
248 #elif defined(__MINGW32__)
249 CMP3("0xabcdef", "%p", (void*)0xABCDEF);
250 CMP3("0", "%p", (void*)NULL
);
251 #elif defined(__GNUG__)
252 CMP3("0xabcdef", "%p", (void*)0xABCDEF);
253 CMP3("(nil)", "%p", (void*)NULL
);
257 void VsnprintfTestCase
::N()
261 wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%d %s%n\n"), 3, wxT("bears"), &nchar
);
262 CPPUNIT_ASSERT_EQUAL( 7, nchar
);
265 void VsnprintfTestCase
::E()
267 // NB: there are no standards about the minimum exponent width
268 // (and the width of the %e conversion specifier refers to the
269 // mantissa, not to the exponent).
270 // Since newer MSVC versions use 3 digits as minimum exponent
271 // width while GNU libc uses 2 digits as minimum width, here we
272 // workaround this problem using for the exponent values with at
273 // least three digits.
275 // printf("%e",2.342E+02);
276 // -> under MSVC7.1 prints: 2.342000e+002
277 // -> under GNU libc 2.4 prints: 2.342000e+02
278 CMP3("2.342000e+112", "%e",2.342E+112);
279 CMP3("-2.3420e-112", "%10.4e",-2.342E-112);
280 CMP3("-2.3420e-112", "%11.4e",-2.342E-112);
281 CMP3(" -2.3420e-112", "%15.4e",-2.342E-112);
283 CMP3("-0.02342", "%G",-2.342E-02);
284 CMP3("3.1415E-116", "%G",3.1415e-116);
285 CMP3("0003.141500e+103", "%016e", 3141.5e100
);
286 CMP3(" 3.141500e+103", "%16e", 3141.5e100
);
287 CMP3("3.141500e+103 ", "%-16e", 3141.5e100
);
288 CMP3("3.142e+103", "%010.3e", 3141.5e100
);
291 void VsnprintfTestCase
::F()
293 CMP3("3.300000", "%5f", 3.3);
294 CMP3("3.000000", "%5f", 3.0);
295 CMP3("0.000100", "%5f", .999999E-4);
296 CMP3("0.000990", "%5f", .99E-3);
297 CMP3("3333.000000", "%5f", 3333.0);
300 void VsnprintfTestCase
::G()
302 // NOTE: the same about E() testcase applies here...
304 CMP3(" 3.3", "%5g", 3.3);
305 CMP3(" 3", "%5g", 3.0);
306 CMP3("9.99999e-115", "%5g", .999999E-114);
307 CMP3("0.00099", "%5g", .99E-3);
308 CMP3(" 3333", "%5g", 3333.0);
309 CMP3(" 0.01", "%5g", 0.01);
311 CMP3(" 3", "%5.g", 3.3);
312 CMP3(" 3", "%5.g", 3.0);
313 CMP3("1e-114", "%5.g", .999999E-114);
314 CMP3("0.0001", "%5.g", 1.0E-4);
315 CMP3("0.001", "%5.g", .99E-3);
316 CMP3("3e+103", "%5.g", 3333.0E100
);
317 CMP3(" 0.01", "%5.g", 0.01);
319 CMP3(" 3.3", "%5.2g", 3.3);
320 CMP3(" 3", "%5.2g", 3.0);
321 CMP3("1e-114", "%5.2g", .999999E-114);
322 CMP3("0.00099", "%5.2g", .99E-3);
323 CMP3("3.3e+103", "%5.2g", 3333.0E100
);
324 CMP3(" 0.01", "%5.2g", 0.01);
327 void VsnprintfTestCase
::S()
329 CMP3(" abc", "%5s", wxT("abc"));
330 CMP3(" a", "%5s", wxT("a"));
331 CMP3("abcdefghi", "%5s", wxT("abcdefghi"));
332 CMP3("abc ", "%-5s", wxT("abc"));
333 CMP3("abcdefghi", "%-5s", wxT("abcdefghi"));
335 CMP3("abcde", "%.5s", wxT("abcdefghi"));
337 // do the same tests but with Unicode characters:
340 // Unicode code points from U+03B1 to U+03B9 are the greek letters alpha-iota;
341 // UTF8 encoding of such code points is 0xCEB1 to 0xCEB9
343 #define ALPHA "\xCE\xB1"
345 #define ABC "\xCE\xB1\xCE\xB2\xCE\xB3"
347 #define ABCDE "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5"
348 // alpha+beta+gamma+delta+epsilon
349 #define ABCDEFGHI "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5\xCE\xB6\xCE\xB7\xCE\xB8\xCE\xB9"
350 // alpha+beta+gamma+delta+epsilon+zeta+eta+theta+iota
352 // the 'expected' and 'arg' parameters of this macro are supposed to be
354 #define CMP3_UTF8(expected, fmt, arg) \
355 CPPUNIT_ASSERT_EQUAL \
357 wxString::FromUTF8(expected).length(), \
358 wxSnprintf(buf, MAX_TEST_LEN, fmt, wxString::FromUTF8(arg)) \
360 CPPUNIT_ASSERT_EQUAL \
362 wxString::FromUTF8(expected), \
366 CMP3_UTF8(" " ABC
, "%5s", ABC
);
367 CMP3_UTF8(" " ALPHA
, "%5s", ALPHA
);
368 CMP3_UTF8(ABCDEFGHI
, "%5s", ABCDEFGHI
);
369 CMP3_UTF8(ABC
" ", "%-5s", ABC
);
370 CMP3_UTF8(ABCDEFGHI
, "%-5s", ABCDEFGHI
);
371 CMP3_UTF8(ABCDE
, "%.5s", ABCDEFGHI
);
372 #endif // wxUSE_UNICODE
374 // test a string which has a NULL character after "ab";
375 // obviously it should be handled exactly like just as "ab"
376 CMP3(" ab", "%5s", wxT("ab\0cdefghi"));
379 void VsnprintfTestCase
::Asterisk()
381 CMP5(" 0.1", "%*.*f", 10, 1, 0.123);
382 CMP5(" 0.1230", "%*.*f", 10, 4, 0.123);
383 CMP5("0.1", "%*.*f", 3, 1, 0.123);
385 CMP4("%0.002", "%%%.*f", 3, 0.0023456789);
387 CMP4(" a", "%*c", 8, 'a');
388 CMP4(" four", "%*s", 8, "four");
389 CMP6(" four four", "%*s %*s", 8, "four", 6, "four");
392 void VsnprintfTestCase
::Percent()
394 // some tests without any argument passed through ...
396 CMP2("%%%", "%%%%%%");
398 CMP3("% abc", "%%%5s", wxT("abc"));
399 CMP3("% abc%", "%%%5s%%", wxT("abc"));
401 // do not test odd number of '%' symbols as different implementations
402 // of snprintf() give different outputs as this situation is not considered
403 // by any standard (in fact, GCC will also warn you about a spurious % if
404 // you write %%% as argument of some *printf function !)
405 // Compare(wxT("%"), wxT("%%%"));
409 void VsnprintfTestCase
::LongLong()
411 CMP3("123456789", "%lld", (wxLongLong_t
)123456789);
412 CMP3("-123456789", "%lld", (wxLongLong_t
)-123456789);
414 CMP3("123456789", "%llu", (wxULongLong_t
)123456789);
417 CMP3("123456789", "%I64d", (wxLongLong_t
)123456789);
418 CMP3("123456789abcdef", "%I64x", wxLL(0x123456789abcdef));
423 void VsnprintfTestCase
::WrongFormatStrings()
425 // test how wxVsnprintf() behaves with wrong format string:
428 // NB: the next 2 tests currently return an error but it would be nice
429 // if they didn't (see ticket #9367)
431 // two positionals with the same index:
432 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$s %1$s"), "hello");
433 CPPUNIT_ASSERT(r
!= -1);
435 // three positionals with the same index mixed with other pos args:
436 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%4$d %2$f %1$s %2$s %3$d"), "hello", "world", 3, 4);
437 CPPUNIT_ASSERT(r
!= -1);
440 // a missing positional arg should result in an assert
441 WX_ASSERT_FAILS_WITH_ASSERT(
442 wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$d %3$d"), 1, 2, 3) );
444 // positional and non-positionals in the same format string:
445 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$d %d %3$d"), 1, 2, 3);
446 CPPUNIT_ASSERT_EQUAL(-1, r
);
449 // BigToSmallBuffer() test case helper:
451 void VsnprintfTestCase
::DoBigToSmallBuffer(T
*buffer
, int size
)
453 // Remember that wx*printf could be mapped either to system
454 // implementation or to wx implementation.
455 // In the first case, when the output buffer is too small, the returned
456 // value can be the number of characters required for the output buffer
457 // (conforming to ISO C99; implemented in e.g. GNU libc >= 2.1), or
458 // just a negative number, usually -1; (this is how e.g. MSVC's
459 // *printf() behaves). Luckily, in all implementations, when the
460 // output buffer is too small, it's nonetheless filled up to its max size.
462 // Note that in the second case (i.e. when we're using our own implementation),
463 // wxVsnprintf() will return the number of characters written in the standard
465 // -1 if there was an error in the format string
466 // maxSize+1 if the output buffer is too small
469 errStr
<< "The size of the buffer was " << size
;
470 std
::string
errMsg(errStr
.mb_str());
472 // test without positionals
473 CMPTOSIZE(buffer
, size
, errMsg
,
474 "123456789012 - test - 123 -4.567",
475 "%i%li - test - %d %.3f",
476 123, (long int)456789012, 123, -4.567);
478 #if wxUSE_PRINTF_POS_PARAMS
479 // test with positional
480 CMPTOSIZE(buffer
, size
, errMsg
,
481 "-4.567 123 - test - 456789012 123",
482 "%4$.3f %1$i - test - %2$li %3$d",
483 123, (long int)456789012, 123, -4.567);
486 // test unicode/ansi conversion specifiers
488 // NB: we use wxUnsafeSnprintf() as %hs and %hc are invalid in printf
489 // format and gcc would warn about this otherwise
491 r
= wxUnsafeSnprintf(buffer
, size
,
492 wxT("unicode string/char: %ls/%lc -- ansi string/char: %hs/%hc"),
493 L
"unicode", L
'U', "ansi", 'A');
495 wxString(wxT("unicode string/char: unicode/U -- ansi string/char: ansi/A")).Left(size
- 1);
497 CPPUNIT_ASSERT( r
!= -1 );
498 CPPUNIT_ASSERT_EQUAL(
504 void VsnprintfTestCase
::BigToSmallBuffer()
506 // VC6 can't compile this code
507 #if !defined(__VISUALC__) || (__VISUALC__ >= 1310)
509 wchar_t bufw
[1024], bufw2
[16], bufw3
[4], bufw4
;
510 DoBigToSmallBuffer(bufw
, 1024);
511 DoBigToSmallBuffer(bufw2
, 16);
512 DoBigToSmallBuffer(bufw3
, 4);
513 DoBigToSmallBuffer(&bufw4
, 1);
514 #endif // wxUSE_UNICODE
516 char bufa
[1024], bufa2
[16], bufa3
[4], bufa4
;
517 DoBigToSmallBuffer(bufa
, 1024);
518 DoBigToSmallBuffer(bufa2
, 16);
519 DoBigToSmallBuffer(bufa3
, 4);
520 DoBigToSmallBuffer(&bufa4
, 1);
524 // Miscellaneous() test case helper:
525 void VsnprintfTestCase
::DoMisc(
527 const wxString
& expectedString
,
529 const wxChar
*format
, ...)
531 const size_t BUFSIZE
= MAX_TEST_LEN
- 1;
533 static int count
= 0;
535 wxASSERT(max
<= BUFSIZE
);
537 for (i
= 0; i
< BUFSIZE
; i
++)
542 va_start(ap
, format
);
544 int n
= wxVsnprintf(buf
, max
, format
, ap
);
548 // Prepare messages so that it is possible to see from the error which
550 wxString errStr
, overflowStr
;
551 errStr
<< wxT("No.: ") << ++count
<< wxT(", expected: ") << expectedLen
552 << wxT(" '") << expectedString
<< wxT("', result: ");
553 overflowStr
<< errStr
<< wxT("buffer overflow");
554 errStr
<< n
<< wxT(" '") << buf
<< wxT("'");
556 // turn them into std::strings
557 std
::string
errMsg(errStr
.mb_str());
558 std
::string
overflowMsg(overflowStr
.mb_str());
560 CPPUNIT_ASSERT_MESSAGE(errMsg
,
561 (expectedLen
== -1 && size_t(n
) >= max
) || expectedLen
== n
);
563 CPPUNIT_ASSERT_MESSAGE(errMsg
, expectedString
== buf
);
565 for (i
= max
; i
< BUFSIZE
; i
++)
566 CPPUNIT_ASSERT_MESSAGE(overflowMsg
, buf
[i
] == '*');
569 void VsnprintfTestCase
::Miscellaneous()
571 // expectedLen, expectedString, max, format, ...
572 DoMisc(5, wxT("-1234"), 8, wxT("%d"), -1234);
573 DoMisc(7, wxT("1234567"), 8, wxT("%d"), 1234567);
574 DoMisc(-1, wxT("1234567"), 8, wxT("%d"), 12345678);
575 DoMisc(-1, wxT("-123456"), 8, wxT("%d"), -1234567890);
577 DoMisc(6, wxT("123456"), 8, wxT("123456"));
578 DoMisc(7, wxT("1234567"), 8, wxT("1234567"));
579 DoMisc(-1, wxT("1234567"), 8, wxT("12345678"));
581 DoMisc(6, wxT("123450"), 8, wxT("12345%d"), 0);
582 DoMisc(7, wxT("1234560"), 8, wxT("123456%d"), 0);
583 DoMisc(-1, wxT("1234567"), 8, wxT("1234567%d"), 0);
584 DoMisc(-1, wxT("1234567"), 8, wxT("12345678%d"), 0);
586 DoMisc(6, wxT("12%45%"), 8, wxT("12%%45%%"));
587 DoMisc(7, wxT("12%45%7"), 8, wxT("12%%45%%7"));
588 DoMisc(-1, wxT("12%45%7"), 8, wxT("12%%45%%78"));
590 DoMisc(5, wxT("%%%%%"), 6, wxT("%%%%%%%%%%"));
591 DoMisc(6, wxT("%%%%12"), 7, wxT("%%%%%%%%%d"), 12);
595 /* (C) Copyright C E Chew
597 * Feel free to copy, use and distribute this software provided:
599 * 1. you do not pretend that you wrote it
600 * 2. you leave this copyright notice intact.
603 void VsnprintfTestCase
::GlibcMisc1()
605 CMP3(" ", "%5.s", "xyz");
606 CMP3(" 33", "%5.f", 33.3);
607 #if defined(__VISUALC__)
608 // see the previous notes about the minimum width of mantissa:
609 CMP3(" 3e+008", "%8.e", 33.3e7
);
610 CMP3(" 3E+008", "%8.E", 33.3e7
);
611 CMP3("3e+001", "%.g", 33.3);
612 CMP3("3E+001", "%.G", 33.3);
614 CMP3(" 3e+08", "%8.e", 33.3e7
);
615 CMP3(" 3E+08", "%8.E", 33.3e7
);
616 CMP3("3e+01", "%.g", 33.3);
617 CMP3("3E+01", "%.G", 33.3);
621 void VsnprintfTestCase
::GlibcMisc2()
624 wxString test_format
;
627 CMP4("3", "%.*g", prec
, 3.3);
630 CMP4("3", "%.*G", prec
, 3.3);
633 CMP4(" 3", "%7.*G", prec
, 3.33);
636 CMP4(" 041", "%04.*o", prec
, 33);
639 CMP4(" 0000033", "%09.*u", prec
, 33);
642 CMP4(" 021", "%04.*x", prec
, 33);
645 CMP4(" 021", "%04.*X", prec
, 33);
648 #endif // wxUSE_WXVSNPRINTF