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 CMP5(expected, x, y, z, w) \
57 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z, w); \
58 CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \
59 ASSERT_STR_EQUAL( wxT(expected), buf );
61 #define CMP4(expected, x, y, z) \
62 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z); \
63 CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \
64 ASSERT_STR_EQUAL( wxT(expected), buf );
66 #define CMP3(expected, x, y) \
67 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y); \
68 CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \
69 ASSERT_STR_EQUAL( wxT(expected), buf );
71 #define CMP2(expected, x) \
72 r=wxSnprintf(buf, MAX_TEST_LEN, wxT(x)); \
73 CPPUNIT_ASSERT( r == (int)wxStrlen(buf) ); \
74 ASSERT_STR_EQUAL( wxT(expected), buf );
76 // NOTE: this macro is used also with too-small buffers (see Miscellaneous())
77 // test function, thus the return value can be > size and thus we
78 // cannot check if r == (int)wxStrlen(buf)
79 #define CMPTOSIZE(buffer, size, expected, fmt, x, y, z, w) \
80 r=wxSnprintf(buffer, size, wxT(fmt), x, y, z, w); \
81 CPPUNIT_ASSERT( r > 0 ); \
82 CPPUNIT_ASSERT_EQUAL( wxString(wxT(expected)).Left(size - 1), \
85 // this is the same as wxSnprintf() but it passes the format string to
86 // wxVsnprintf() without using ATTRIBUTE_PRINTF and thus suppresses the gcc
87 // checks (and resulting warnings) for the format string
89 // use with extreme care and only when you're really sure the warnings must be
93 wxUnsafeSnprintf(T
*buf
, size_t len
, const wxChar
*fmt
, ...)
98 int rc
= wxVsnprintf(buf
, len
, fmt
, args
);
105 // ----------------------------------------------------------------------------
107 // ----------------------------------------------------------------------------
109 class VsnprintfTestCase
: public CppUnit
::TestCase
115 CPPUNIT_TEST_SUITE( VsnprintfTestCase
);
126 CPPUNIT_TEST( Asterisk
);
127 CPPUNIT_TEST( Percent
);
129 CPPUNIT_TEST( LongLong
);
132 CPPUNIT_TEST( BigToSmallBuffer
);
133 #if wxUSE_WXVSNPRINTF
134 CPPUNIT_TEST( WrongFormatStrings
);
135 #endif // wxUSE_WXVSNPRINTF
136 CPPUNIT_TEST( Miscellaneous
);
137 CPPUNIT_TEST_SUITE_END();
156 void BigToSmallBuffer();
157 #if wxUSE_WXVSNPRINTF
158 void WrongFormatStrings();
159 #endif // wxUSE_WXVSNPRINTF
160 void Miscellaneous();
161 template<typename T
> void Misc(T
*buffer
, int size
);
163 // compares the expectedString and the result of wxVsnprintf() char by char
164 // for all its lenght (not only for first expectedLen chars) and also
165 // checks the return value
166 void DoMisc(int expectedLen
, const wxString
& expectedString
,
167 size_t max
, const wxChar
*format
, ...);
169 DECLARE_NO_COPY_CLASS(VsnprintfTestCase
)
172 // register in the unnamed registry so that these tests are run by default
173 CPPUNIT_TEST_SUITE_REGISTRATION( VsnprintfTestCase
);
175 // also include in it's own registry so that these tests can be run alone
176 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( VsnprintfTestCase
, "VsnprintfTestCase" );
178 VsnprintfTestCase
::VsnprintfTestCase()
180 // this call is required to avoid check failures when running on machines
181 // with a locale where the decimal point is not '.'
182 wxSetlocale(LC_NUMERIC
, "English");
185 void VsnprintfTestCase
::C()
187 CMP5("hi!", "%c%c%c", wxT('h'), wxT('i'), wxT('!'));
190 // the NULL characters _can_ be passed to %c to e.g. create strings
191 // with embedded NULs (because strings are not always supposed to be
194 DoMisc(14, wxT("Hello \0 World!"), 16, wxT("Hello %c World!"), wxT('\0'));
197 void VsnprintfTestCase
::D()
199 CMP3("+123456", "%+d", 123456);
200 CMP3("-123456", "%d", -123456);
201 CMP3(" 123456", "% d", 123456);
202 CMP3(" 123456", "%10d", 123456);
203 CMP3("0000123456", "%010d", 123456);
204 CMP3("-123456 ", "%-10d", -123456);
207 void VsnprintfTestCase
::X()
209 CMP3("ABCD", "%X", 0xABCD);
210 CMP3("0XABCD", "%#X", 0xABCD);
211 CMP3("0xabcd", "%#x", 0xABCD);
214 void VsnprintfTestCase
::O()
216 CMP3("1234567", "%o", 01234567);
217 CMP3("01234567", "%#o", 01234567);
220 void VsnprintfTestCase
::P()
222 // WARNING: printing of pointers is not fully standard.
223 // GNU prints them as %#x except for NULL pointers which are
224 // printed as '(nil)'.
225 // MSVC always print them as %8X on 32 bit systems and as %16X
228 #if SIZEOF_VOID_P == 4
229 CMP3("00ABCDEF", "%p", (void*)0xABCDEF);
230 CMP3("00000000", "%p", (void*)NULL
);
231 #elif SIZEOF_VOID_P == 8
232 CMP3("0000ABCDEFABCDEF", "%p", (void*)0xABCDEFABCDEF);
233 CMP3("0000000000000000", "%p", (void*)NULL
);
235 #elif defined(__GNUG__)
236 CMP3("0xabcdef", "%p", (void*)0xABCDEF);
237 CMP3("(nil)", "%p", (void*)NULL
);
241 void VsnprintfTestCase
::N()
245 wxSnprintf(buf
, MAX_TEST_LEN
, _T("%d %s%n\n"), 3, _T("bears"), &nchar
);
246 CPPUNIT_ASSERT_EQUAL( 7, nchar
);
249 void VsnprintfTestCase
::E()
251 // NB: there are no standards about the minimum exponent width
252 // (and the width of the %e conversion specifier refers to the
253 // mantissa, not to the exponent).
254 // Since newer MSVC versions use 3 digits as minimum exponent
255 // width while GNU libc uses 2 digits as minimum width, here we
256 // workaround this problem using for the exponent values with at
257 // least three digits.
259 // printf("%e",2.342E+02);
260 // -> under MSVC7.1 prints: 2.342000e+002
261 // -> under GNU libc 2.4 prints: 2.342000e+02
262 CMP3("2.342000e+112", "%e",2.342E+112);
263 CMP3("-2.3420e-112", "%10.4e",-2.342E-112);
264 CMP3("-2.3420e-112", "%11.4e",-2.342E-112);
265 CMP3(" -2.3420e-112", "%15.4e",-2.342E-112);
267 CMP3("-0.02342", "%G",-2.342E-02);
268 CMP3("3.1415E-116", "%G",3.1415e-116);
269 CMP3("0003.141500e+103", "%016e", 3141.5e100
);
270 CMP3(" 3.141500e+103", "%16e", 3141.5e100
);
271 CMP3("3.141500e+103 ", "%-16e", 3141.5e100
);
272 CMP3("3.142e+103", "%010.3e", 3141.5e100
);
275 void VsnprintfTestCase
::F()
277 CMP3("3.300000", "%5f", 3.3);
278 CMP3("3.000000", "%5f", 3.0);
279 CMP3("0.000100", "%5f", .999999E-4);
280 CMP3("0.000990", "%5f", .99E-3);
281 CMP3("3333.000000", "%5f", 3333.0);
284 void VsnprintfTestCase
::G()
286 // NOTE: the same about E() testcase applies here...
288 CMP3(" 3.3", "%5g", 3.3);
289 CMP3(" 3", "%5g", 3.0);
290 CMP3("9.99999e-115", "%5g", .999999E-114);
291 CMP3("0.00099", "%5g", .99E-3);
292 CMP3(" 3333", "%5g", 3333.0);
293 CMP3(" 0.01", "%5g", 0.01);
295 CMP3(" 3", "%5.g", 3.3);
296 CMP3(" 3", "%5.g", 3.0);
297 CMP3("1e-114", "%5.g", .999999E-114);
298 CMP3("0.0001", "%5.g", 1.0E-4);
299 CMP3("0.001", "%5.g", .99E-3);
300 CMP3("3e+103", "%5.g", 3333.0E100
);
301 CMP3(" 0.01", "%5.g", 0.01);
303 CMP3(" 3.3", "%5.2g", 3.3);
304 CMP3(" 3", "%5.2g", 3.0);
305 CMP3("1e-114", "%5.2g", .999999E-114);
306 CMP3("0.00099", "%5.2g", .99E-3);
307 CMP3("3.3e+103", "%5.2g", 3333.0E100
);
308 CMP3(" 0.01", "%5.2g", 0.01);
311 void VsnprintfTestCase
::S()
313 CMP3(" abc", "%5s", wxT("abc"));
314 CMP3(" a", "%5s", wxT("a"));
315 CMP3("abcdefghi", "%5s", wxT("abcdefghi"));
316 CMP3("abc ", "%-5s", wxT("abc"));
317 CMP3("abcdefghi", "%-5s", wxT("abcdefghi"));
319 CMP3("abcde", "%.5s", wxT("abcdefghi"));
321 // do the same tests but with Unicode characters:
322 #if wxUSE_UNICODE && !defined(__VISUALC__) // FIXME: this doesn't compile with VC7
323 #define ALPHA "\x3B1"
325 #define GAMMA "\x3B3"
326 #define DELTA "\x3B4"
327 #define EPSILON "\x3B5"
330 #define THETA "\x3B8"
333 #define ABC ALPHA BETA GAMMA
334 #define ABCDE ALPHA BETA GAMMA DELTA EPSILON
335 #define ABCDEFGHI ALPHA BETA GAMMA DELTA EPSILON ZETA ETA THETA IOTA
337 CMP3(" " ABC
, "%5s", wxT(ABC
));
338 CMP3(" " ALPHA
, "%5s", wxT(ALPHA
));
339 CMP3(ABCDEFGHI
, "%5s", wxT(ABCDEFGHI
));
340 CMP3(ABC
" ", "%-5s", wxT(ABC
));
341 CMP3(ABCDEFGHI
, "%-5s", wxT(ABCDEFGHI
));
343 CMP3(ABCDE
, "%.5s", wxT(ABCDEFGHI
));
346 // test a string which have the NULL character after "ab";
347 // obviously it should be handled exactly like just as "ab"
348 CMP3(" ab", "%5s", wxT("ab\0cdefghi"));
351 void VsnprintfTestCase
::Asterisk()
353 CMP5(" 0.1", "%*.*f", 10, 1, 0.123);
354 CMP5(" 0.1230", "%*.*f", 10, 4, 0.123);
355 CMP5("0.1", "%*.*f", 3, 1, 0.123);
357 CMP4("%0.002", "%%%.*f", 3, 0.0023456789);
360 void VsnprintfTestCase
::Percent()
362 // some tests without any argument passed through ...
364 CMP2("%%%", "%%%%%%");
366 CMP3("% abc", "%%%5s", wxT("abc"));
367 CMP3("% abc%", "%%%5s%%", wxT("abc"));
369 // do not test odd number of '%' symbols as different implementations
370 // of snprintf() give different outputs as this situation is not considered
371 // by any standard (in fact, GCC will also warn you about a spurious % if
372 // you write %%% as argument of some *printf function !)
373 // Compare(wxT("%"), wxT("%%%"));
377 void VsnprintfTestCase
::LongLong()
379 CMP3("123456789", "%lld", (wxLongLong_t
)123456789);
380 CMP3("-123456789", "%lld", (wxLongLong_t
)-123456789);
382 CMP3("123456789", "%llu", (wxULongLong_t
)123456789);
385 CMP3("123456789", "%I64d", (wxLongLong_t
)123456789);
386 CMP3("123456789abcdef", "%I64x", wxLL(0x123456789abcdef));
392 void VsnprintfTestCase
::Misc(T
*buffer
, int size
)
394 // Remember that wx*printf could be mapped either to system
395 // implementation or to wx implementation.
396 // In the first case, when the output buffer is too small, the returned
397 // value can be the number of characters required for the output buffer
398 // (conforming to ISO C99; implemented in e.g. GNU libc >= 2.1), or
399 // just a negative number, usually -1; (this is how e.g. MSVC's
400 // *printf() behaves). Luckily, in all implementations, when the
401 // output buffer is too small, it's nonetheless filled up to its max size.
403 // Note that in the second case (i.e. when we're using our own implementation),
404 // wxVsnprintf() will return the number of characters written in the standard
406 // -1 if there was an error in the format string
407 // maxSize+1 if the output buffer is too small
409 // test without positionals
410 CMPTOSIZE(buffer
, size
, "123 444444444 - test - 555 -0.666",
411 "%i %li - test - %d %.3f",
412 123, (long int)444444444, 555, -0.666);
414 #if wxUSE_PRINTF_POS_PARAMS
415 // test with positional
416 CMPTOSIZE(buffer
, size
, "-0.666 123 - test - 444444444 555",
417 "%4$.3f %1$i - test - %2$li %3$d",
418 123, (long int)444444444, 555, -0.666);
421 // test unicode/ansi conversion specifiers
423 // NB: we use wxUnsafeSnprintf() as %hs and %hc are invalid in printf
424 // format and gcc would warn about this otherwise
426 r
= wxUnsafeSnprintf(buffer
, size
,
427 _T("unicode string: %ls %lc - ansi string: %hs %hc\n\n"),
428 L
"unicode!!", L
'W', "ansi!!", 'w');
430 wxString(wxT("unicode string: unicode!! W - ansi string: ansi!! w\n\n")).Left(size
- 1);
432 CPPUNIT_ASSERT( r
!= -1 );
433 CPPUNIT_ASSERT_EQUAL(
440 // this test is only for our own implementation, the system implementation
441 // doesn't always give errors for invalid format strings (e.g. glibc doesn't)
442 // and as it's not required too (the behaviour is "undefined" according to the
443 // spec), there is really no sense in testing for it (and the first 2 formats
444 // in this test are not invalid at all in fact)
445 #if wxUSE_WXVSNPRINTF
447 void VsnprintfTestCase
::WrongFormatStrings()
449 // test how wxVsnprintf() behaves with wrong format string:
452 // NB: the next 2 tests currently return an error but it would be nice
453 // if they didn't (see ticket #9367)
455 // two positionals with the same index:
456 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$s %1$s"), "hello");
457 CPPUNIT_ASSERT(r
!= -1);
459 // three positionals with the same index mixed with other pos args:
460 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%4$d %2$f %1$s %2$s %3$d"), "hello", "world", 3, 4);
461 CPPUNIT_ASSERT(r
!= -1);
464 // a missing positional arg: this should result in an error but not all
465 // implementations detect it (e.g. glibc doesn't)
466 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$d %3$d"), 1, 2, 3);
467 CPPUNIT_ASSERT_EQUAL(-1, r
);
469 // positional and non-positionals in the same format string:
470 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$d %d %3$d"), 1, 2, 3);
471 CPPUNIT_ASSERT_EQUAL(-1, r
);
474 #endif // wxUSE_WXVSNPRINTF
476 void VsnprintfTestCase
::BigToSmallBuffer()
478 // VC6 can't compile this code
479 #if !defined(__VISUALC__) || (__VISUALC__ >= 1310)
481 wchar_t bufw
[1024], bufw2
[16], bufw3
[4], bufw4
;
486 #endif // wxUSE_UNICODE
488 char bufa
[1024], bufa2
[16], bufa3
[4], bufa4
;
496 void VsnprintfTestCase
::DoMisc(
498 const wxString
& expectedString
,
500 const wxChar
*format
, ...)
502 const size_t BUFSIZE
= MAX_TEST_LEN
- 1;
504 static int count
= 0;
506 wxASSERT(max
<= BUFSIZE
);
508 for (i
= 0; i
< BUFSIZE
; i
++)
513 va_start(ap
, format
);
515 int n
= wxVsnprintf(buf
, max
, format
, ap
);
519 // Prepare messages so that it is possible to see from the error which
521 wxString errStr
, overflowStr
;
522 errStr
<< _T("No.: ") << ++count
<< _T(", expected: ") << expectedLen
523 << _T(" '") << expectedString
<< _T("', result: ");
524 overflowStr
<< errStr
<< _T("buffer overflow");
525 errStr
<< n
<< _T(" '") << buf
<< _T("'");
527 // turn them into std::strings
528 std
::string
errMsg(errStr
.mb_str());
529 std
::string
overflowMsg(overflowStr
.mb_str());
531 CPPUNIT_ASSERT_MESSAGE(errMsg
,
532 (expectedLen
== -1 && size_t(n
) >= max
) || expectedLen
== n
);
534 CPPUNIT_ASSERT_MESSAGE(errMsg
, expectedString
== buf
);
536 for (i
= max
; i
< BUFSIZE
; i
++)
537 CPPUNIT_ASSERT_MESSAGE(overflowMsg
, buf
[i
] == '*');
540 void VsnprintfTestCase
::Miscellaneous()
542 // expectedLen, expectedString, max, format, ...
543 DoMisc(5, wxT("-1234"), 8, wxT("%d"), -1234);
544 DoMisc(7, wxT("1234567"), 8, wxT("%d"), 1234567);
545 DoMisc(-1, wxT("1234567"), 8, wxT("%d"), 12345678);
546 DoMisc(-1, wxT("-123456"), 8, wxT("%d"), -1234567890);
548 DoMisc(6, wxT("123456"), 8, wxT("123456"));
549 DoMisc(7, wxT("1234567"), 8, wxT("1234567"));
550 DoMisc(-1, wxT("1234567"), 8, wxT("12345678"));
552 DoMisc(6, wxT("123450"), 8, wxT("12345%d"), 0);
553 DoMisc(7, wxT("1234560"), 8, wxT("123456%d"), 0);
554 DoMisc(-1, wxT("1234567"), 8, wxT("1234567%d"), 0);
555 DoMisc(-1, wxT("1234567"), 8, wxT("12345678%d"), 0);
557 DoMisc(6, wxT("12%45%"), 8, wxT("12%%45%%"));
558 DoMisc(7, wxT("12%45%7"), 8, wxT("12%%45%%7"));
559 DoMisc(-1, wxT("12%45%7"), 8, wxT("12%%45%%78"));
561 DoMisc(5, wxT("%%%%%"), 6, wxT("%%%%%%%%%%"));
562 DoMisc(6, wxT("%%%%12"), 7, wxT("%%%%%%%%%d"), 12);
565 #endif // wxUSE_WXVSNPRINTF