]>
git.saurik.com Git - wxWidgets.git/blob - tests/strings/vsnprintf.cpp
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( r == (int)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( r == (int)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( r == (int)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( r == (int)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( r == (int)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 #if wxUSE_WXVSNPRINTF
143 CPPUNIT_TEST( WrongFormatStrings
);
144 #endif // wxUSE_WXVSNPRINTF
145 CPPUNIT_TEST( Miscellaneous
);
146 CPPUNIT_TEST_SUITE_END();
166 void DoBigToSmallBuffer(T
*buffer
, int size
);
167 void BigToSmallBuffer();
169 #if wxUSE_WXVSNPRINTF
170 void WrongFormatStrings();
171 #endif // wxUSE_WXVSNPRINTF
173 // compares the expectedString and the result of wxVsnprintf() char by char
174 // for all its lenght (not only for first expectedLen chars) and also
175 // checks the return value
176 void DoMisc(int expectedLen
, const wxString
& expectedString
,
177 size_t max
, const wxChar
*format
, ...);
178 void Miscellaneous();
180 DECLARE_NO_COPY_CLASS(VsnprintfTestCase
)
183 // register in the unnamed registry so that these tests are run by default
184 CPPUNIT_TEST_SUITE_REGISTRATION( VsnprintfTestCase
);
186 // also include in it's own registry so that these tests can be run alone
187 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( VsnprintfTestCase
, "VsnprintfTestCase" );
189 void VsnprintfTestCase::setUp()
191 // this call is required to avoid check failures when running on machines
192 // with a locale where the decimal point is not '.'
193 wxSetlocale(LC_ALL
, "C");
196 void VsnprintfTestCase::C()
198 CMP5("hi!", "%c%c%c", wxT('h'), wxT('i'), wxT('!'));
201 // the NULL characters _can_ be passed to %c to e.g. create strings
202 // with embedded NULs (because strings are not always supposed to be
205 DoMisc(14, wxT("Hello \0 World!"), 16, wxT("Hello %c World!"), wxT('\0'));
208 void VsnprintfTestCase::D()
210 CMP3("+123456", "%+d", 123456);
211 CMP3("-123456", "%d", -123456);
212 CMP3(" 123456", "% d", 123456);
213 CMP3(" 123456", "%10d", 123456);
214 CMP3("0000123456", "%010d", 123456);
215 CMP3("-123456 ", "%-10d", -123456);
218 void VsnprintfTestCase::X()
220 CMP3("ABCD", "%X", 0xABCD);
221 CMP3("0XABCD", "%#X", 0xABCD);
222 CMP3("0xabcd", "%#x", 0xABCD);
225 void VsnprintfTestCase::O()
227 CMP3("1234567", "%o", 01234567);
228 CMP3("01234567", "%#o", 01234567);
231 void VsnprintfTestCase::P()
233 // WARNING: printing of pointers is not fully standard.
234 // GNU prints them as %#x except for NULL pointers which are
235 // printed as '(nil)'.
236 // MSVC always print them as %8X on 32 bit systems and as %16X
239 #if SIZEOF_VOID_P == 4
240 CMP3("00ABCDEF", "%p", (void*)0xABCDEF);
241 CMP3("00000000", "%p", (void*)NULL
);
242 #elif SIZEOF_VOID_P == 8
243 CMP3("0000ABCDEFABCDEF", "%p", (void*)0xABCDEFABCDEF);
244 CMP3("0000000000000000", "%p", (void*)NULL
);
246 #elif defined(__GNUG__)
247 CMP3("0xabcdef", "%p", (void*)0xABCDEF);
248 CMP3("(nil)", "%p", (void*)NULL
);
252 void VsnprintfTestCase::N()
256 wxSnprintf(buf
, MAX_TEST_LEN
, _T("%d %s%n\n"), 3, _T("bears"), &nchar
);
257 CPPUNIT_ASSERT_EQUAL( 7, nchar
);
260 void VsnprintfTestCase::E()
262 // NB: there are no standards about the minimum exponent width
263 // (and the width of the %e conversion specifier refers to the
264 // mantissa, not to the exponent).
265 // Since newer MSVC versions use 3 digits as minimum exponent
266 // width while GNU libc uses 2 digits as minimum width, here we
267 // workaround this problem using for the exponent values with at
268 // least three digits.
270 // printf("%e",2.342E+02);
271 // -> under MSVC7.1 prints: 2.342000e+002
272 // -> under GNU libc 2.4 prints: 2.342000e+02
273 CMP3("2.342000e+112", "%e",2.342E+112);
274 CMP3("-2.3420e-112", "%10.4e",-2.342E-112);
275 CMP3("-2.3420e-112", "%11.4e",-2.342E-112);
276 CMP3(" -2.3420e-112", "%15.4e",-2.342E-112);
278 CMP3("-0.02342", "%G",-2.342E-02);
279 CMP3("3.1415E-116", "%G",3.1415e-116);
280 CMP3("0003.141500e+103", "%016e", 3141.5e100
);
281 CMP3(" 3.141500e+103", "%16e", 3141.5e100
);
282 CMP3("3.141500e+103 ", "%-16e", 3141.5e100
);
283 CMP3("3.142e+103", "%010.3e", 3141.5e100
);
286 void VsnprintfTestCase::F()
288 CMP3("3.300000", "%5f", 3.3);
289 CMP3("3.000000", "%5f", 3.0);
290 CMP3("0.000100", "%5f", .999999E-4);
291 CMP3("0.000990", "%5f", .99E-3);
292 CMP3("3333.000000", "%5f", 3333.0);
295 void VsnprintfTestCase::G()
297 // NOTE: the same about E() testcase applies here...
299 CMP3(" 3.3", "%5g", 3.3);
300 CMP3(" 3", "%5g", 3.0);
301 CMP3("9.99999e-115", "%5g", .999999E-114);
302 CMP3("0.00099", "%5g", .99E-3);
303 CMP3(" 3333", "%5g", 3333.0);
304 CMP3(" 0.01", "%5g", 0.01);
306 CMP3(" 3", "%5.g", 3.3);
307 CMP3(" 3", "%5.g", 3.0);
308 CMP3("1e-114", "%5.g", .999999E-114);
309 CMP3("0.0001", "%5.g", 1.0E-4);
310 CMP3("0.001", "%5.g", .99E-3);
311 CMP3("3e+103", "%5.g", 3333.0E100
);
312 CMP3(" 0.01", "%5.g", 0.01);
314 CMP3(" 3.3", "%5.2g", 3.3);
315 CMP3(" 3", "%5.2g", 3.0);
316 CMP3("1e-114", "%5.2g", .999999E-114);
317 CMP3("0.00099", "%5.2g", .99E-3);
318 CMP3("3.3e+103", "%5.2g", 3333.0E100
);
319 CMP3(" 0.01", "%5.2g", 0.01);
322 void VsnprintfTestCase::S()
324 CMP3(" abc", "%5s", wxT("abc"));
325 CMP3(" a", "%5s", wxT("a"));
326 CMP3("abcdefghi", "%5s", wxT("abcdefghi"));
327 CMP3("abc ", "%-5s", wxT("abc"));
328 CMP3("abcdefghi", "%-5s", wxT("abcdefghi"));
330 CMP3("abcde", "%.5s", wxT("abcdefghi"));
332 // do the same tests but with Unicode characters:
335 // Unicode code points from U+03B1 to U+03B9 are the greek letters alpha-iota;
336 // UTF8 encoding of such code points is 0xCEB1 to 0xCEB9
338 #define ALPHA "\xCE\xB1"
340 #define ABC "\xCE\xB1\xCE\xB2\xCE\xB3"
342 #define ABCDE "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5"
343 // alpha+beta+gamma+delta+epsilon
344 #define ABCDEFGHI "\xCE\xB1\xCE\xB2\xCE\xB3\xCE\xB4\xCE\xB5\xCE\xB6\xCE\xB7\xCE\xB8\xCE\xB9"
345 // alpha+beta+gamma+delta+epsilon+zeta+eta+theta+iota
347 #define ALPHA_w wxT(ALPHA)
348 #define ABC_w wxT(ABC)
349 #define ABCDE_w wxT(ABCDE)
350 #define ABCDEFGHI_w wxT(ABCDEFGHI)
352 // CMP3 uses wxT() on the first argument so we need to be careful
353 // when using string concatenation that all parts of the string after
354 // the first explicitely use wxT():
355 CMP3(" " ABC_w
, "%5s", ABC
);
356 CMP3(" " ALPHA_w
, "%5s", ALPHA
);
357 CMP3(ABCDEFGHI
, "%5s", ABCDEFGHI
);
358 CMP3(ABC L
" ", "%-5s", ABC
);
359 CMP3(ABCDEFGHI
, "%-5s", ABCDEFGHI
);
360 CMP3(ABCDE
, "%.5s", ABCDEFGHI
);
363 // test a string which has a NULL character after "ab";
364 // obviously it should be handled exactly like just as "ab"
365 CMP3(" ab", "%5s", wxT("ab\0cdefghi"));
368 void VsnprintfTestCase::Asterisk()
370 CMP5(" 0.1", "%*.*f", 10, 1, 0.123);
371 CMP5(" 0.1230", "%*.*f", 10, 4, 0.123);
372 CMP5("0.1", "%*.*f", 3, 1, 0.123);
374 CMP4("%0.002", "%%%.*f", 3, 0.0023456789);
376 CMP4(" a", "%*c", 8, 'a');
377 CMP4(" four", "%*s", 8, "four");
378 CMP6(" four four", "%*s %*s", 8, "four", 6, "four");
381 void VsnprintfTestCase::Percent()
383 // some tests without any argument passed through ...
385 CMP2("%%%", "%%%%%%");
387 CMP3("% abc", "%%%5s", wxT("abc"));
388 CMP3("% abc%", "%%%5s%%", wxT("abc"));
390 // do not test odd number of '%' symbols as different implementations
391 // of snprintf() give different outputs as this situation is not considered
392 // by any standard (in fact, GCC will also warn you about a spurious % if
393 // you write %%% as argument of some *printf function !)
394 // Compare(wxT("%"), wxT("%%%"));
398 void VsnprintfTestCase::LongLong()
400 CMP3("123456789", "%lld", (wxLongLong_t
)123456789);
401 CMP3("-123456789", "%lld", (wxLongLong_t
)-123456789);
403 CMP3("123456789", "%llu", (wxULongLong_t
)123456789);
406 CMP3("123456789", "%I64d", (wxLongLong_t
)123456789);
407 CMP3("123456789abcdef", "%I64x", wxLL(0x123456789abcdef));
412 // this test is only for our own implementation, the system implementation
413 // doesn't always give errors for invalid format strings (e.g. glibc doesn't)
414 // and as it's not required too (the behaviour is "undefined" according to the
415 // spec), there is really no sense in testing for it
416 #if wxUSE_WXVSNPRINTF
418 void VsnprintfTestCase::WrongFormatStrings()
420 // test how wxVsnprintf() behaves with wrong format string:
423 // NB: the next 2 tests currently return an error but it would be nice
424 // if they didn't (see ticket #9367)
426 // two positionals with the same index:
427 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$s %1$s"), "hello");
428 CPPUNIT_ASSERT(r
!= -1);
430 // three positionals with the same index mixed with other pos args:
431 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%4$d %2$f %1$s %2$s %3$d"), "hello", "world", 3, 4);
432 CPPUNIT_ASSERT(r
!= -1);
435 // a missing positional arg: this should result in an error but not all
436 // implementations detect it (e.g. glibc doesn't)
437 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$d %3$d"), 1, 2, 3);
438 CPPUNIT_ASSERT_EQUAL(-1, r
);
440 // positional and non-positionals in the same format string:
441 r
= wxSnprintf(buf
, MAX_TEST_LEN
, wxT("%1$d %d %3$d"), 1, 2, 3);
442 CPPUNIT_ASSERT_EQUAL(-1, r
);
445 #endif // wxUSE_WXVSNPRINTF
447 // BigToSmallBuffer() test case helper:
449 void VsnprintfTestCase::DoBigToSmallBuffer(T
*buffer
, int size
)
451 // Remember that wx*printf could be mapped either to system
452 // implementation or to wx implementation.
453 // In the first case, when the output buffer is too small, the returned
454 // value can be the number of characters required for the output buffer
455 // (conforming to ISO C99; implemented in e.g. GNU libc >= 2.1), or
456 // just a negative number, usually -1; (this is how e.g. MSVC's
457 // *printf() behaves). Luckily, in all implementations, when the
458 // output buffer is too small, it's nonetheless filled up to its max size.
460 // Note that in the second case (i.e. when we're using our own implementation),
461 // wxVsnprintf() will return the number of characters written in the standard
463 // -1 if there was an error in the format string
464 // maxSize+1 if the output buffer is too small
467 errStr
<< "The size of the buffer was " << size
;
468 std::string
errMsg(errStr
.mb_str());
470 // test without positionals
471 CMPTOSIZE(buffer
, size
, errMsg
,
472 "123456789012 - test - 123 -4.567",
473 "%i%li - test - %d %.3f",
474 123, (long int)456789012, 123, -4.567);
476 #if wxUSE_PRINTF_POS_PARAMS
477 // test with positional
478 CMPTOSIZE(buffer
, size
, errMsg
,
479 "-4.567 123 - test - 456789012 123",
480 "%4$.3f %1$i - test - %2$li %3$d",
481 123, (long int)456789012, 123, -4.567);
484 // test unicode/ansi conversion specifiers
486 // NB: we use wxUnsafeSnprintf() as %hs and %hc are invalid in printf
487 // format and gcc would warn about this otherwise
489 r
= wxUnsafeSnprintf(buffer
, size
,
490 _T("unicode string/char: %ls/%lc -- ansi string/char: %hs/%hc"),
491 L
"unicode", L
'U', "ansi", 'A');
493 wxString(wxT("unicode string/char: unicode/U -- ansi string/char: ansi/A")).Left(size
- 1);
495 CPPUNIT_ASSERT( r
!= -1 );
496 CPPUNIT_ASSERT_EQUAL(
502 void VsnprintfTestCase::BigToSmallBuffer()
504 // VC6 can't compile this code
505 #if !defined(__VISUALC__) || (__VISUALC__ >= 1310)
507 wchar_t bufw
[1024], bufw2
[16], bufw3
[4], bufw4
;
508 DoBigToSmallBuffer(bufw
, 1024);
509 DoBigToSmallBuffer(bufw2
, 16);
510 DoBigToSmallBuffer(bufw3
, 4);
511 DoBigToSmallBuffer(&bufw4
, 1);
512 #endif // wxUSE_UNICODE
514 char bufa
[1024], bufa2
[16], bufa3
[4], bufa4
;
515 DoBigToSmallBuffer(bufa
, 1024);
516 DoBigToSmallBuffer(bufa2
, 16);
517 DoBigToSmallBuffer(bufa3
, 4);
518 DoBigToSmallBuffer(&bufa4
, 1);
522 // Miscellaneous() test case helper:
523 void VsnprintfTestCase::DoMisc(
525 const wxString
& expectedString
,
527 const wxChar
*format
, ...)
529 const size_t BUFSIZE
= MAX_TEST_LEN
- 1;
531 static int count
= 0;
533 wxASSERT(max
<= BUFSIZE
);
535 for (i
= 0; i
< BUFSIZE
; i
++)
540 va_start(ap
, format
);
542 int n
= wxVsnprintf(buf
, max
, format
, ap
);
546 // Prepare messages so that it is possible to see from the error which
548 wxString errStr
, overflowStr
;
549 errStr
<< _T("No.: ") << ++count
<< _T(", expected: ") << expectedLen
550 << _T(" '") << expectedString
<< _T("', result: ");
551 overflowStr
<< errStr
<< _T("buffer overflow");
552 errStr
<< n
<< _T(" '") << buf
<< _T("'");
554 // turn them into std::strings
555 std::string
errMsg(errStr
.mb_str());
556 std::string
overflowMsg(overflowStr
.mb_str());
558 CPPUNIT_ASSERT_MESSAGE(errMsg
,
559 (expectedLen
== -1 && size_t(n
) >= max
) || expectedLen
== n
);
561 CPPUNIT_ASSERT_MESSAGE(errMsg
, expectedString
== buf
);
563 for (i
= max
; i
< BUFSIZE
; i
++)
564 CPPUNIT_ASSERT_MESSAGE(overflowMsg
, buf
[i
] == '*');
567 void VsnprintfTestCase::Miscellaneous()
569 // expectedLen, expectedString, max, format, ...
570 DoMisc(5, wxT("-1234"), 8, wxT("%d"), -1234);
571 DoMisc(7, wxT("1234567"), 8, wxT("%d"), 1234567);
572 DoMisc(-1, wxT("1234567"), 8, wxT("%d"), 12345678);
573 DoMisc(-1, wxT("-123456"), 8, wxT("%d"), -1234567890);
575 DoMisc(6, wxT("123456"), 8, wxT("123456"));
576 DoMisc(7, wxT("1234567"), 8, wxT("1234567"));
577 DoMisc(-1, wxT("1234567"), 8, wxT("12345678"));
579 DoMisc(6, wxT("123450"), 8, wxT("12345%d"), 0);
580 DoMisc(7, wxT("1234560"), 8, wxT("123456%d"), 0);
581 DoMisc(-1, wxT("1234567"), 8, wxT("1234567%d"), 0);
582 DoMisc(-1, wxT("1234567"), 8, wxT("12345678%d"), 0);
584 DoMisc(6, wxT("12%45%"), 8, wxT("12%%45%%"));
585 DoMisc(7, wxT("12%45%7"), 8, wxT("12%%45%%7"));
586 DoMisc(-1, wxT("12%45%7"), 8, wxT("12%%45%%78"));
588 DoMisc(5, wxT("%%%%%"), 6, wxT("%%%%%%%%%%"));
589 DoMisc(6, wxT("%%%%12"), 7, wxT("%%%%%%%%%d"), 12);
592 #endif // wxUSE_WXVSNPRINTF