tests/strings/vararg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        tests/strings/vararg.cpp
   3 // Purpose:     Test for wx vararg look-alike macros
   4 // Author:      Vaclav Slavik
   5 // Created:     2007-02-20
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2007 REA Elektronik GmbH
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 // ----------------------------------------------------------------------------
  12 // headers
  13 // ----------------------------------------------------------------------------
  14
  15 #include "testprec.h"
  16
  17 #ifdef __BORLANDC__
  18     #pragma hdrstop
  19 #endif
  20
  21 #ifndef WX_PRECOMP
  22     #include "wx/wx.h"
  23 #endif // WX_PRECOMP
  24
  25 #include "wx/string.h"
  26
  27 // ----------------------------------------------------------------------------
  28 // test class
  29 // ----------------------------------------------------------------------------
  30
  31 class VarArgTestCase : public CppUnit::TestCase
  32 {
  33 public:
  34     VarArgTestCase() {}
  35
  36 private:
  37     CPPUNIT_TEST_SUITE( VarArgTestCase );
  38         CPPUNIT_TEST( StringPrintf );
  39         CPPUNIT_TEST( CharPrintf );
  40 #if wxUSE_STD_STRING
  41         CPPUNIT_TEST( StdString );
  42 #endif
  43 #if wxUSE_LONGLONG
  44         CPPUNIT_TEST( LongLongPrintf );
  45 #endif
  46         CPPUNIT_TEST( Sscanf );
  47         CPPUNIT_TEST( RepeatedPrintf );
  48         CPPUNIT_TEST( ArgsValidation );
  49     CPPUNIT_TEST_SUITE_END();
  50
  51     void StringPrintf();
  52     void CharPrintf();
  53 #if wxUSE_STD_STRING
  54     void StdString();
  55 #endif
  56 #if wxUSE_LONGLONG
  57     void LongLongPrintf();
  58 #endif
  59     void Sscanf();
  60     void RepeatedPrintf();
  61     void ArgsValidation();
  62
  63     DECLARE_NO_COPY_CLASS(VarArgTestCase)
  64 };
  65
  66 // register in the unnamed registry so that these tests are run by default
  67 CPPUNIT_TEST_SUITE_REGISTRATION( VarArgTestCase );
  68
  69 // also include in its own registry so that these tests can be run alone
  70 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( VarArgTestCase, "VarArgTestCase" );
  71
  72 void VarArgTestCase::StringPrintf()
  73 {
  74     wxString s, s2;
  75
  76     // test passing literals:
  77     s.Printf("%s %i", "foo", 42);
  78     CPPUNIT_ASSERT( s == "foo 42" );
  79     s.Printf("%s %s %i", wxT("bar"), "=", 11);
  80
  81     // test passing c_str():
  82     CPPUNIT_ASSERT( s == "bar = 11" );
  83     s2.Printf("(%s)", s.c_str());
  84     CPPUNIT_ASSERT( s2 == "(bar = 11)" );
  85     s2.Printf(wxT("[%s](%s)"), s.c_str(), "str");
  86     CPPUNIT_ASSERT( s2 == "[bar = 11](str)" );
  87
  88     s2.Printf("%s mailbox", wxString("Opening").c_str());
  89     CPPUNIT_ASSERT( s2 == "Opening mailbox" );
  90
  91     // test passing wxString directly:
  92     s2.Printf(wxT("[%s](%s)"), s, "str");
  93     CPPUNIT_ASSERT( s2 == "[bar = 11](str)" );
  94
  95     // test passing wxCharBufferType<T>:
  96     s = "FooBar";
  97     s2.Printf(wxT("(%s)"), s.mb_str());
  98     CPPUNIT_ASSERT( s2 == "(FooBar)" );
  99     s2.Printf(wxT("value=%s;"), s.wc_str());
 100     CPPUNIT_ASSERT( s2 == "value=FooBar;" );
 101
 102     // this tests correct passing of wxCStrData constructed from string
 103     // literal:
 104     bool cond = true;
 105     s2.Printf(wxT("foo %s"), !cond ? s.c_str() : wxT("bar"));
 106 }
 107
 108 void VarArgTestCase::CharPrintf()
 109 {
 110     wxString foo("foo");
 111     wxString s;
 112
 113     // test using wchar_t:
 114     s.Printf("char=%c", L'c');
 115     CPPUNIT_ASSERT_EQUAL( "char=c", s );
 116
 117     // test wxUniCharRef:
 118     s.Printf("string[1] is %c", foo[1]);
 119     CPPUNIT_ASSERT_EQUAL( "string[1] is o", s );
 120
 121     // test char
 122     char c = 'z';
 123     s.Printf("%c to %c", 'a', c);
 124     CPPUNIT_ASSERT_EQUAL( "a to z", s );
 125
 126     // test char used as integer:
 127     #ifdef _MSC_VER
 128         #pragma warning(disable:4305) // truncation of constant value in VC6
 129         #pragma warning(disable:4309) // truncation of constant value
 130     #endif
 131     c = 240;
 132     #ifdef _MSC_VER
 133         #pragma warning(default:4305) // truncation of constant value in VC6
 134         #pragma warning(default:4309)
 135     #endif
 136     s.Printf("value is %i (int)", c);
 137     CPPUNIT_ASSERT_EQUAL( wxString("value is -16 (int)"), s );
 138
 139     unsigned char u = 240;
 140     s.Printf("value is %i (int)", u);
 141     CPPUNIT_ASSERT_EQUAL( "value is 240 (int)", s );
 142 }
 143
 144 #if wxUSE_STD_STRING
 145 void VarArgTestCase::StdString()
 146 {
 147     // test passing std::[w]string
 148     wxString s;
 149
 150     std::string mb("multi-byte");
 151     std::string wc("widechar");
 152
 153     s.Printf("string %s(%i).", mb, 1);
 154     CPPUNIT_ASSERT_EQUAL( "string multi-byte(1).", s );
 155
 156     s.Printf("string %s(%i).", wc, 2);
 157     CPPUNIT_ASSERT_EQUAL( "string widechar(2).", s );
 158 }
 159 #endif // wxUSE_STD_STRING
 160
 161 #if wxUSE_LONGLONG
 162 void VarArgTestCase::LongLongPrintf()
 163 {
 164     const char * const llfmt = "%" wxLongLongFmtSpec "d";
 165
 166     CPPUNIT_ASSERT_EQUAL( "17", wxString::Format(llfmt, wxLL(17)) );
 167
 168     wxLongLong ll = 1234567890;
 169     CPPUNIT_ASSERT_EQUAL( "1234567890", wxString::Format(llfmt, ll) );
 170 }
 171 #endif // wxUSE_LONGLONG
 172
 173 void VarArgTestCase::Sscanf()
 174 {
 175     int i = 0;
 176     char str[20];
 177     wchar_t wstr[20];
 178
 179     wxString input("42 test");
 180
 181     wxSscanf(input, "%d %s", &i, &str);
 182     CPPUNIT_ASSERT( i == 42 );
 183     CPPUNIT_ASSERT( wxStrcmp(str, "test") == 0 );
 184
 185     i = 0;
 186     wxSscanf(input, L"%d %s", &i, &wstr);
 187     CPPUNIT_ASSERT( i == 42 );
 188     CPPUNIT_ASSERT( wxStrcmp(wstr, "test") == 0 );
 189 }
 190
 191 void VarArgTestCase::RepeatedPrintf()
 192 {
 193     wxCharBuffer buffer(2);
 194     char *p = buffer.data();
 195     *p = 'h';
 196     p++;
 197     *p = 'i';
 198
 199     wxString s;
 200     s = wxString::Format("buffer %s, len %d", buffer, (int)wxStrlen(buffer));
 201     CPPUNIT_ASSERT_EQUAL("buffer hi, len 2", s);
 202
 203     s = wxString::Format("buffer %s, len %d", buffer, (int)wxStrlen(buffer));
 204     CPPUNIT_ASSERT_EQUAL("buffer hi, len 2", s);
 205 }
 206
 207 void VarArgTestCase::ArgsValidation()
 208 {
 209     void *ptr = this;
 210     int written;
 211     short int swritten;
 212
 213     // these are valid:
 214     wxString::Format("a string(%s,%s), ptr %p, int %i",
 215                      wxString(), "foo", "char* as pointer", 1);
 216
 217     // Microsoft has helpfully disabled support for "%n" in their CRT by
 218     // default starting from VC8 and somehow even calling
 219     // _set_printf_count_output() doesn't help here, so don't use "%n" at all
 220     // with it.
 221 #if wxCHECK_VISUALC_VERSION(8)
 222     #define wxNO_PRINTF_PERCENT_N
 223 #endif // VC8+
 224
 225     // Similarly, many modern Linux distributions ship with g++ that uses
 226     // -D_FORTIFY_SOURCE=2 flag by default and this option prevents "%n" from
 227     // being used in a string outside of read-only memory, meaning that it
 228     // can't be used in wxString to which we (may, depending on build options)
 229     // assign it, so also disable testing of "%n" in this case lest we die with
 230     // an abort inside vswprintf().
 231 #if defined(_FORTIFY_SOURCE)
 232     #if _FORTIFY_SOURCE >= 2
 233         #define wxNO_PRINTF_PERCENT_N
 234     #endif
 235 #endif
 236
 237 #ifndef wxNO_PRINTF_PERCENT_N
 238     wxString::Format("foo%i%n", 42, &written);
 239     CPPUNIT_ASSERT_EQUAL( 5, written );
 240 #endif
 241
 242     // but these are not:
 243     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("%i: too many arguments", 42, 1, 2, 3) );
 244     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("%i", "foo") );
 245     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("%s", (void*)this) );
 246
 247     // for some reason assert is not generated with VC6, don't know what's
 248     // going there so disable it for now to make the test suite pass when using
 249     // this compiler until someone has time to debug this (FIXME-VC6)
 250 #ifndef __VISUALC6__
 251     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("%d", ptr) );
 252 #endif
 253
 254     // we don't check wxNO_PRINTF_PERCENT_N here as these expressions should
 255     // result in an assert in our code before the CRT functions are even called
 256     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("foo%i%n", &written) );
 257     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("foo%n", ptr) );
 258     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("foo%i%n", 42, &swritten) );
 259
 260     // the following test (correctly) fails at compile-time with <type_traits>
 261 #if !defined(HAVE_TYPE_TRAITS) && !defined(HAVE_TR1_TYPE_TRAITS)
 262     wxObject obj;
 263     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("%s", obj) );
 264
 265     wxObject& ref = obj;
 266     WX_ASSERT_FAILS_WITH_ASSERT( wxString::Format("%s", ref) );
 267 #endif
 268
 269     // %c should accept integers too
 270     wxString::Format("%c", 80);
 271     wxString::Format("%c", wxChar(80) + wxChar(1));
 272
 273     // check size_t handling
 274     size_t len = sizeof(*this);
 275 #ifdef __WINDOWS__
 276     wxString::Format("%Iu", len);
 277 #else
 278     wxString::Format("%zu", len);
 279 #endif
 280 }