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)
   7 // Created:     2006-04-01
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2006 Francesco Montorsi, Bjorn Reese and Daniel Stenberg
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ----------------------------------------------------------------------------
  13 // headers
  14 // ----------------------------------------------------------------------------
  15
  16 #include "testprec.h"
  17
  18 #ifdef __BORLANDC__
  19     #pragma hdrstop
  20 #endif
  21
  22 #ifndef WX_PRECOMP
  23     #include "wx/wx.h"
  24     #include "wx/wxchar.h"
  25 #endif // WX_PRECOMP
  26
  27
  28
  29 #define MAX_TEST_LEN        1024
  30
  31
  32 // temporary buffers
  33 static wxChar buf[MAX_TEST_LEN];
  34
  35 // these macros makes it possible to write all tests without repeating a lot of times wxT() macro
  36
  37 #define ASSERT_STR_EQUAL( a, b ) \
  38     CPPUNIT_ASSERT_EQUAL( wxString(a), wxString(b) );
  39
  40 #define CMP5(expected, x, y, z, w)                  \
  41     wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z, w); \
  42                                                     \
  43     ASSERT_STR_EQUAL( wxT(expected), buf );
  44
  45 #define CMP4(expected, x, y, z)                     \
  46     wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y, z);    \
  47                                                     \
  48     ASSERT_STR_EQUAL( wxT(expected), buf );
  49
  50 #define CMP3(expected, x, y)                        \
  51     wxSnprintf(buf, MAX_TEST_LEN, wxT(x), y);       \
  52                                                     \
  53     ASSERT_STR_EQUAL( wxT(expected), buf );
  54
  55 #define CMP2(expected, x)                           \
  56     wxSnprintf(buf, MAX_TEST_LEN, wxT(x));          \
  57                                                     \
  58     ASSERT_STR_EQUAL( wxT(expected), buf );
  59
  60 #define CMPTOSIZE(buffer, size, expected, fmt, x, y, z, w)          \
  61     wxSnprintf(buffer, size, wxT(fmt), x, y, z, w);                 \
  62                                                                     \
  63     CPPUNIT_ASSERT_EQUAL( wxString(wxT(expected)).Left(size - 1),   \
  64                           wxString(buffer) )
  65
  66
  67
  68 // ----------------------------------------------------------------------------
  69 // test class
  70 // ----------------------------------------------------------------------------
  71
  72 class VsnprintfTestCase : public CppUnit::TestCase
  73 {
  74 public:
  75     VsnprintfTestCase();
  76
  77 private:
  78     CPPUNIT_TEST_SUITE( VsnprintfTestCase );
  79         CPPUNIT_TEST( E );
  80         CPPUNIT_TEST( F );
  81         CPPUNIT_TEST( G );
  82         CPPUNIT_TEST( S );
  83         CPPUNIT_TEST( Asterisk );
  84
  85         CPPUNIT_TEST( BigToSmallBuffer );
  86     CPPUNIT_TEST_SUITE_END();
  87
  88     void E();
  89     void F();
  90     void G();
  91     void S();
  92     void Asterisk();
  93
  94     void BigToSmallBuffer();
  95     void Misc(wxChar *buffer, int size);
  96
  97     DECLARE_NO_COPY_CLASS(VsnprintfTestCase)
  98 };
  99
 100 // register in the unnamed registry so that these tests are run by default
 101 CPPUNIT_TEST_SUITE_REGISTRATION( VsnprintfTestCase );
 102
 103 // also include in it's own registry so that these tests can be run alone
 104 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( VsnprintfTestCase, "VsnprintfTestCase" );
 105
 106 VsnprintfTestCase::VsnprintfTestCase()
 107 {
 108 }
 109
 110 void VsnprintfTestCase::E()
 111 {
 112     // NB: there are no standards about the minimum exponent width
 113     //     (and the width of the %e conversion specifier refers to the
 114     //      mantissa, not to the exponent).
 115     //     Since newer MSVC versions use 3 digits as minimum exponent
 116     //     width while GNU libc uses 2 digits as minimum width, here we
 117     //     workaround this problem using for the exponent values with at
 118     //     least three digits.
 119     //     Some examples:
 120     //       printf("%e",2.342E+02);
 121     //     -> under MSVC7.1 prints:      2.342000e+002
 122     //     -> under GNU libc 2.4 prints: 2.342000e+02
 123     CMP3("2.342000e+112", "%e",2.342E+112);
 124     CMP3("-2.3420e-112", "%10.4e",-2.342E-112);
 125     CMP3("-2.3420e-112", "%11.4e",-2.342E-112);
 126     CMP3("   -2.3420e-112", "%15.4e",-2.342E-112);
 127
 128     CMP3("-0.02342", "%G",-2.342E-02);
 129     CMP3("3.1415E-116", "%G",3.1415e-116);
 130     CMP3("0003.141500e+103", "%016e", 3141.5e100);
 131     CMP3("   3.141500e+103", "%16e", 3141.5e100);
 132     CMP3("3.141500e+103   ", "%-16e", 3141.5e100);
 133     CMP3("3.142e+103", "%010.3e", 3141.5e100);
 134 }
 135
 136 void VsnprintfTestCase::F()
 137 {
 138     CMP3("3.300000", "%5f", 3.3);
 139     CMP3("3.000000", "%5f", 3.0);
 140     CMP3("0.000100", "%5f", .999999E-4);
 141     CMP3("0.000990", "%5f", .99E-3);
 142     CMP3("3333.000000", "%5f", 3333.0);
 143 }
 144
 145 void VsnprintfTestCase::G()
 146 {
 147     // NOTE: the same about E() testcase applies here...
 148
 149     CMP3("  3.3", "%5g", 3.3);
 150     CMP3("    3", "%5g", 3.0);
 151     CMP3("9.99999e-115", "%5g", .999999E-114);
 152     CMP3("0.00099", "%5g", .99E-3);
 153     CMP3(" 3333", "%5g", 3333.0);
 154     CMP3(" 0.01", "%5g", 0.01);
 155
 156     CMP3("    3", "%5.g", 3.3);
 157     CMP3("    3", "%5.g", 3.0);
 158     CMP3("1e-114", "%5.g", .999999E-114);
 159     CMP3("0.0001", "%5.g", 1.0E-4);
 160     CMP3("0.001", "%5.g", .99E-3);
 161     CMP3("3e+103", "%5.g", 3333.0E100);
 162     CMP3(" 0.01", "%5.g", 0.01);
 163
 164     CMP3("  3.3", "%5.2g", 3.3);
 165     CMP3("    3", "%5.2g", 3.0);
 166     CMP3("1e-114", "%5.2g", .999999E-114);
 167     CMP3("0.00099", "%5.2g", .99E-3);
 168     CMP3("3.3e+103", "%5.2g", 3333.0E100);
 169     CMP3(" 0.01", "%5.2g", 0.01);
 170 }
 171
 172 void VsnprintfTestCase::S()
 173 {
 174     CMP3("  abc", "%5s", wxT("abc"));
 175     CMP3("    a", "%5s", wxT("a"));
 176     CMP3("abcdefghi", "%5s", wxT("abcdefghi"));
 177     CMP3("abc  ", "%-5s", wxT("abc"));
 178     CMP3("abcdefghi", "%-5s", wxT("abcdefghi"));
 179
 180     CMP3("abcde", "%.5s", wxT("abcdefghi"));
 181
 182     // some tests without any argument passed through ...
 183     CMP2("%", "%%");
 184     CMP2("%%%", "%%%%%%");
 185
 186     // do not test odd number of '%' symbols as different implementations
 187     // of snprintf() give different outputs as this situation is not considered
 188     // by any standard (in fact, GCC will also warn you about a spurious % if
 189     // you write %%% as argument of some *printf function !)
 190     // Compare(wxT("%"), wxT("%%%"));
 191 }
 192
 193 void VsnprintfTestCase::Asterisk()
 194 {
 195     CMP5("       0.1", "%*.*f", 10, 1, 0.123);
 196     CMP5("    0.1230", "%*.*f", 10, 4, 0.123);
 197     CMP5("0.1", "%*.*f", 3, 1, 0.123);
 198
 199     CMP4("%0.002", "%%%.*f", 3, 0.0023456789);
 200 }
 201
 202 void VsnprintfTestCase::Misc(wxChar *buffer, int size)
 203 {
 204     // NB: remember that wx*printf could be mapped either to system
 205     //     implementation or to wx implementation.
 206     //     In the first case, when the output buffer is too small, the returned
 207     //     value can be the number of characters required for the output buffer
 208     //     (conforming to ISO C99; implemented in e.g. GNU libc >= 2.1), or
 209     //     just a negative number, usually -1; (this is how e.g. MSVC's
 210     //     *printf() behaves).  Fortunately, in all implementations, when the
 211     //     output buffer is too small, it's nonetheless filled up to its max
 212     //     size.
 213
 214     // test without positionals
 215     CMPTOSIZE(buffer, size, "123 444444444 - test - 555 -0.666",
 216               "%i %li - test - %d %.3f",
 217               123, (long int)444444444, 555, -0.666);
 218
 219 #if wxUSE_PRINTF_POS_PARAMS
 220     // test with positional
 221     CMPTOSIZE(buffer, size, "-0.666 123 - test - 444444444 555",
 222               "%4$.3f %1$i - test - %2$li %3$d",
 223               123, (long int)444444444, 555, -0.666);
 224 #endif
 225
 226     // test unicode/ansi conversion specifiers
 227     // NB: this line will output two warnings like these, on GCC:
 228     //     warning: use of 'h' length modifier with 's' type character (i.e.
 229     //     GCC warns you that 'h' is not legal on 's' conv spec) but they must
 230     //     be ignored as here we explicitely want to test the wxSnprintf()
 231     //     behaviour in such case
 232
 233     CMPTOSIZE(buffer, size,
 234               "unicode string: unicode!! W - ansi string: ansi!! w\n\n",
 235               "unicode string: %ls %lc - ansi string: %hs %hc\n\n",
 236               L"unicode!!", L'W', "ansi!!", 'w');
 237 }
 238
 239 void VsnprintfTestCase::BigToSmallBuffer()
 240 {
 241     wxChar buf[1024], buf2[16], buf3[4], buf4;
 242
 243     Misc(buf, 1024);
 244     Misc(buf2, 16);
 245     Misc(buf3, 4);
 246     Misc(&buf4, 1);
 247 }