Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'printf-out-of-mem'

Browse Source 
Fix crash in wxString::PrintfV() due to integer overflow/running out of
memory.

See https://github.com/wxWidgets/wxWidgets/pull/2131
This commit is contained in:
Vadim Zeitlin
2020-12-04 20:01:30 +01:00
parent e98ac38dcb 344cc940a0
commit dc33f27e10
4 changed files with 235 additions and 317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
src/common/string.cpp
View File

@@ -1964,12 +1964,16 @@ int wxString::DoPrintfUtf8(const char *format, ...)
the ISO C99 (and thus SUSv3) standard the return value for the case of the ISO C99 (and thus SUSv3) standard the return value for the case of
an undersized buffer is inconsistent. For conforming vsnprintf an undersized buffer is inconsistent. For conforming vsnprintf
implementations the function must return the number of characters that implementations the function must return the number of characters that
would have been printed had the buffer been large enough. For conforming would have been printed had the buffer been large enough, which is useful.
vswprintf implementations the function must return a negative number Unfortunately, for conforming vswprintf implementations, the function must
and set errno. just return a negative number and is not even required to set errno, which
makes the standard behaviour totally useless as there is no way to
determine if the error occurred due to a (fatal) problem with either the
format string or the arguments or to a (correctable) problem with the
buffer just not being big enough.
What vswprintf sets errno to is undefined but Darwin seems to set it to In practice some implementations (including our own implementation of
EOVERFLOW. The only expected errno are EILSEQ and EINVAL. Both of vsprintf(), if we use it) do set errno to EILSEQ or EINVAL. Both of
those are defined in the standard and backed up by several conformance those are defined in the standard and backed up by several conformance
statements. Note that ENOMEM mentioned in the manual page does not statements. Note that ENOMEM mentioned in the manual page does not
apply to swprintf, only wprintf and fwprintf. apply to swprintf, only wprintf and fwprintf.
@@ -1981,34 +1985,14 @@ int wxString::DoPrintfUtf8(const char *format, ...)
http://www.opengroup.org/csq/view.mhtml?RID=ibm%2FSD1%2F3 http://www.opengroup.org/csq/view.mhtml?RID=ibm%2FSD1%2F3
http://www.theopengroup.org/csq/view.mhtml?norationale=1&noreferences=1&RID=Fujitsu%2FSE2%2F10 http://www.theopengroup.org/csq/view.mhtml?norationale=1&noreferences=1&RID=Fujitsu%2FSE2%2F10
Since EILSEQ and EINVAL are rather common but EOVERFLOW is not and since So we can check for these specific errno values to detect invalid format
EILSEQ and EINVAL are specifically defined to mean the error is other than string or arguments. Unfortunately not all implementations set them and, in
an undersized buffer and no other errno are defined we treat those two particular, glibc, use under Linux, never sets errno at all. This means
as meaning hard errors and everything else gets the old behaviour which that we have no choice but to try increasing the buffer size because we
is to keep looping and increasing buffer size until the function succeeds. can't distinguish between the unrecoverable errors and buffer just being too
small. Of course, continuing increasing the size forever will sooner or
In practice it's impossible to determine before compilation which behaviour later result in out of memory error and crashing, so we also have to impose
may be used. The vswprintf function may have vsnprintf-like behaviour or some arbitrary limit on it.
vice-versa. Behaviour detected on one release can theoretically change
with an updated release. Not to mention that configure testing for it
would require the test to be run on the host system, not the build system
which makes cross compilation difficult. Therefore, we make no assumptions
about behaviour and try our best to handle every known case, including the
case where wxVsnprintf returns a negative number and fails to set errno.
There is yet one more non-standard implementation and that is our own.
Fortunately, that can be detected at compile-time.
On top of all that, ISO C99 explicitly defines snprintf to write a null
character to the last position of the specified buffer. That would be at
at the given buffer size minus 1. It is supposed to do this even if it
turns out that the buffer is sized too small.
Darwin (tested on 10.5) follows the C99 behaviour exactly.
Glibc 2.6 almost follows the C99 behaviour except vswprintf never sets
errno even when it fails. However, it only seems to ever fail due
to an undersized buffer.
*/ */
#if wxUSE_UNICODE_UTF8 #if wxUSE_UNICODE_UTF8
template<typename BufferType> template<typename BufferType>
@@ -2020,7 +2004,7 @@ template<typename BufferType>
static int DoStringPrintfV(wxString& str, static int DoStringPrintfV(wxString& str,
const wxString& format, va_list argptr) const wxString& format, va_list argptr)
{ {
int size = 1024; size_t size = 1024;
for ( ;; ) for ( ;; )
{ {
@@ -2055,52 +2039,43 @@ static int DoStringPrintfV(wxString& str,
// bug except the code above allocates an extra character. // bug except the code above allocates an extra character.
buf[size] = wxT('\0'); buf[size] = wxT('\0');
// vsnprintf() may return either -1 (traditional Unix behaviour) or the // Handle all possible results that we can get depending on the build
// total number of characters which would have been written if the // options.
// buffer were large enough (newer standards such as Unix98)
if ( len < 0 ) if ( len < 0 )
{ {
// NB: wxVsnprintf() may call either wxCRT_VsnprintfW or
// wxCRT_VsnprintfA in UTF-8 build; wxUSE_WXVSNPRINTF
// is true if *both* of them use our own implementation,
// otherwise we can't be sure
#if wxUSE_WXVSNPRINTF
// we know that our own implementation of wxVsnprintf() returns -1
// only for a format error - thus there's something wrong with
// the user's format string
buf[0] = '\0';
return -1;
#else // possibly using system version
// assume it only returns error if there is not enough space, but // assume it only returns error if there is not enough space, but
// as we don't know how much we need, double the current size of // as we don't know how much we need, double the current size of
// the buffer // the buffer
if( (errno == EILSEQ) || (errno == EINVAL) ) if( (errno == EILSEQ) || (errno == EINVAL) )
// If errno was set to one of the two well-known hard errors {
// then fail immediately to avoid an infinite loop. // If errno was set to one of the two well-known hard errors
// then fail immediately to avoid an infinite loop.
return -1; return -1;
else }
// still not enough, as we don't know how much we need, double the // still not enough, as we don't know how much we need, double the
// current size of the buffer // current size of the buffer -- unless it's already too big, as we
size *= 2; // have to stop at some point to avoid running out of memory and
#endif // wxUSE_WXVSNPRINTF/!wxUSE_WXVSNPRINTF // crashing or worse (e.g. triggering OOM killer and accidentally
// killing some other innocent process)
// The limit is completely arbitrary, it's supposed to be big
// enough to never become a problem in practice, but not so big as
// to result in out of memory crashes.
static const size_t MAX_BUFFER_SIZE = 128*1024*1024;
if ( size >= MAX_BUFFER_SIZE )
return -1;
// Note that doubling the size here will never overflow for size
// less than the limit.
size *= 2;
} }
else if ( len >= size ) else if ( static_cast<size_t>(len) >= size )
{ {
#if wxUSE_WXVSNPRINTF // we got back the needed size, but it doesn't include space for
// we know that our own implementation of wxVsnprintf() returns // NUL, so add it ourselves
// size+1 when there's not enough space but that's not the size
// of the required buffer!
size *= 2; // so we just double the current size of the buffer
#else
// some vsnprintf() implementations NUL-terminate the buffer and
// some don't in len == size case, to be safe always add 1
// FIXME: I don't quite understand this comment. The vsnprintf
// function is specifically defined to return the number of
// characters printed not including the null terminator.
// So OF COURSE you need to add 1 to get the right buffer size.
// The following line is definitely correct, no question.
size = len + 1; size = len + 1;
#endif
} }
else // ok, there was enough space else // ok, there was enough space
{ {

11
src/common/wxprintf.cpp
View File

@@ -25,6 +25,7 @@
#include "wx/private/wxprintf.h" #include "wx/private/wxprintf.h"
#include <errno.h>
// ============================================================================ // ============================================================================
// printf() implementation // printf() implementation
@@ -106,6 +107,9 @@ static int wxDoVsnprintf(CharType *buf, size_t lenMax,
if (parser.posarg_present && parser.nonposarg_present) if (parser.posarg_present && parser.nonposarg_present)
{ {
buf[0] = 0; buf[0] = 0;
// Indicate to the caller that it's an unrecoverable error and not just
// due to the buffer being too small.
errno = EINVAL;
return -1; // format strings with both positional and return -1; // format strings with both positional and
} // non-positional conversion specifier are unsupported !! } // non-positional conversion specifier are unsupported !!
@@ -131,6 +135,7 @@ static int wxDoVsnprintf(CharType *buf, size_t lenMax,
if (!ok) if (!ok)
{ {
buf[0] = 0; buf[0] = 0;
errno = EINVAL;
return -1; return -1;
} }
@@ -154,7 +159,7 @@ static int wxDoVsnprintf(CharType *buf, size_t lenMax,
if (lenCur == lenMax) if (lenCur == lenMax)
{ {
buf[lenMax - 1] = 0; buf[lenMax - 1] = 0;
return lenMax+1; // not enough space in the output buffer ! return -1; // not enough space in the output buffer !
} }
// process this specifier directly in the output buffer // process this specifier directly in the output buffer
@@ -163,7 +168,7 @@ static int wxDoVsnprintf(CharType *buf, size_t lenMax,
if (n == -1) if (n == -1)
{ {
buf[lenMax-1] = wxT('\0'); // be sure to always NUL-terminate the string buf[lenMax-1] = wxT('\0'); // be sure to always NUL-terminate the string
return lenMax+1; // not enough space in the output buffer ! return -1; // not enough space in the output buffer !
} }
lenCur += n; lenCur += n;
@@ -183,7 +188,7 @@ static int wxDoVsnprintf(CharType *buf, size_t lenMax,
if (buf[lenCur]) if (buf[lenCur])
{ {
buf[lenCur] = 0; buf[lenCur] = 0;
return lenMax+1; // not enough space in the output buffer ! return -1; // not enough space in the output buffer !
} }
// Don't do: // Don't do:

26
tests/strings/vararg.cpp
View File

@@ -274,3 +274,29 @@ TEST_CASE("VeryLongArg", "[wxString][Format][vararg]")
REQUIRE( s.length() == LENGTH ); REQUIRE( s.length() == LENGTH );
CHECK( s == veryLongString ); CHECK( s == veryLongString );
} }
namespace
{
// Helpers for the "PrintfError" test: we must pass by these functions
// because specifying "%c" directly inline would convert it to "%lc" and avoid
// the error.
wxString CallPrintfV(const char* format, ...)
{
va_list ap;
va_start(ap, format);
wxString s;
s.PrintfV(wxString::FromAscii(format), ap);
va_end(ap);
return s;
}
} // anonymous namespace
TEST_CASE("PrintfError", "[wxString][Format][vararg][error]")
{
// Check that using invalid argument doesn't keep doubling the buffer until
// we run out of memory and die.
const int invalidChar = 0x1780;
REQUIRE_NOTHROW( CallPrintfV("%c", invalidChar) );
}

402
tests/strings/vsnprintf.cpp
View File

@@ -40,49 +40,24 @@
static wxChar buf[MAX_TEST_LEN]; static wxChar buf[MAX_TEST_LEN];
int r; int r;
// these macros makes it possible to write all tests without repeating a lot // Helper macro verifying both the return value of wxSnprintf() and its output.
// of times the wxT() macro //
// NOTE: you should use expected strings with these macros which do not exceed // NOTE: the expected string length with this macro must not exceed MAX_TEST_LEN
// MAX_TEST_LEN as these macro do check if the return value is == (int)wxStrlen(buf)
#define ASSERT_STR_EQUAL( a, b ) \ #define CMP(expected, fmt, ...) \
CPPUNIT_ASSERT_EQUAL( wxString(a), wxString(b) ); r=wxSnprintf(buf, MAX_TEST_LEN, fmt, ##__VA_ARGS__); \
CHECK( r == (int)wxStrlen(buf) ); \
#define CMP6(expected, fmt, y, z, w, t) \ CHECK( buf == wxString(expected) )
r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w, t); \
CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
ASSERT_STR_EQUAL( wxT(expected), buf );
#define CMP5(expected, fmt, y, z, w) \
r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z, w); \
CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
ASSERT_STR_EQUAL( wxT(expected), buf );
#define CMP4(expected, fmt, y, z) \
r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y, z); \
CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
ASSERT_STR_EQUAL( wxT(expected), buf );
#define CMP3(expected, fmt, y) \
r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt), y); \
CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
ASSERT_STR_EQUAL( wxT(expected), buf );
#define CMP2(expected, fmt) \
r=wxSnprintf(buf, MAX_TEST_LEN, wxT(fmt)); \
CPPUNIT_ASSERT_EQUAL( r, wxStrlen(buf) ); \
ASSERT_STR_EQUAL( wxT(expected), buf );
// Another helper which takes the size explicitly instead of using MAX_TEST_LEN
//
// NOTE: this macro is used also with too-small buffers (see Miscellaneous()) // NOTE: this macro is used also with too-small buffers (see Miscellaneous())
// test function, thus the return value can be > size and thus we // test function, thus the return value can be either -1 or > size and we
// cannot check if r == (int)wxStrlen(buf) // cannot check if r == (int)wxStrlen(buf)
#define CMPTOSIZE(buffer, size, failuremsg, expected, fmt, x, y, z, w) \ #define CMPTOSIZE(buffer, size, failuremsg, expected, fmt, ...) \
r=wxSnprintf(buffer, size, wxT(fmt), x, y, z, w); \ r=wxSnprintf(buffer, size, fmt, ##__VA_ARGS__); \
CPPUNIT_ASSERT( r > 0 ); \ INFO(failuremsg); \
CPPUNIT_ASSERT_EQUAL_MESSAGE( \ CHECK( buffer == wxString(expected).Left(size - 1) )
failuremsg, \
wxString(wxT(expected)).Left(size - 1), \
wxString(buffer))
// this is the same as wxSnprintf() but it passes the format string to // this is the same as wxSnprintf() but it passes the format string to
// wxVsnprintf() without using WX_ATTRIBUTE_PRINTF and thus suppresses the gcc // wxVsnprintf() without using WX_ATTRIBUTE_PRINTF and thus suppresses the gcc
@@ -105,93 +80,32 @@ wxUnsafeSnprintf(T *buf, size_t len, const wxChar *fmt, ...)
} }
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// test class // test fixture
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
class VsnprintfTestCase : public CppUnit::TestCase // Explicitly set C locale to avoid check failures when running on machines
// with a locale where the decimal point is not '.'
class VsnprintfTestCase : CLocaleSetter
{ {
public: public:
VsnprintfTestCase() {} VsnprintfTestCase() : CLocaleSetter() { }
virtual void setUp() wxOVERRIDE;
private:
CPPUNIT_TEST_SUITE( VsnprintfTestCase );
CPPUNIT_TEST( C );
CPPUNIT_TEST( D );
CPPUNIT_TEST( X );
CPPUNIT_TEST( O );
CPPUNIT_TEST( P );
CPPUNIT_TEST( N );
CPPUNIT_TEST( E );
CPPUNIT_TEST( F );
CPPUNIT_TEST( G );
CPPUNIT_TEST( S );
CPPUNIT_TEST( Asterisk );
CPPUNIT_TEST( Percent );
#ifdef wxLongLong_t
CPPUNIT_TEST( LongLong );
#endif
CPPUNIT_TEST( BigToSmallBuffer );
CPPUNIT_TEST( WrongFormatStrings );
CPPUNIT_TEST( Miscellaneous );
CPPUNIT_TEST( GlibcMisc1 );
CPPUNIT_TEST( GlibcMisc2 );
CPPUNIT_TEST_SUITE_END();
void C();
void D();
void X();
void O();
void P();
void N();
void E();
void F();
void G();
void S();
void Asterisk();
void Percent();
#ifdef wxLongLong_t
void LongLong();
#endif
void Unicode();
protected:
template<typename T> template<typename T>
void DoBigToSmallBuffer(T *buffer, int size); void DoBigToSmallBuffer(T *buffer, int size);
void BigToSmallBuffer();
void WrongFormatStrings();
// compares the expectedString and the result of wxVsnprintf() char by char // compares the expectedString and the result of wxVsnprintf() char by char
// for all its length (not only for first expectedLen chars) and also // for all its length (not only for first expectedLen chars) and also
// checks the return value // checks the return value
void DoMisc(int expectedLen, const wxString& expectedString, void DoMisc(int expectedLen, const wxString& expectedString,
size_t max, const wxChar *format, ...); size_t max, const wxChar *format, ...);
void Miscellaneous();
void GlibcMisc1();
void GlibcMisc2();
wxDECLARE_NO_COPY_CLASS(VsnprintfTestCase); wxDECLARE_NO_COPY_CLASS(VsnprintfTestCase);
}; };
// register in the unnamed registry so that these tests are run by default TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::C", "[vsnprintf]")
CPPUNIT_TEST_SUITE_REGISTRATION( VsnprintfTestCase );
// also include in its own registry so that these tests can be run alone
CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( VsnprintfTestCase, "VsnprintfTestCase" );
void VsnprintfTestCase::setUp()
{ {
// this call is required to avoid check failures when running on machines CMP("hi!", "%c%c%c", wxT('h'), wxT('i'), wxT('!'));
// with a locale where the decimal point is not '.'
wxSetlocale(LC_ALL, "C");
}
void VsnprintfTestCase::C()
{
CMP5("hi!", "%c%c%c", wxT('h'), wxT('i'), wxT('!'));
// NOTE: // NOTE:
// the NULL characters _can_ be passed to %c to e.g. create strings // the NULL characters _can_ be passed to %c to e.g. create strings
@@ -201,30 +115,30 @@ void VsnprintfTestCase::C()
DoMisc(14, wxT("Hello \0 World!"), 16, wxT("Hello %c World!"), wxT('\0')); DoMisc(14, wxT("Hello \0 World!"), 16, wxT("Hello %c World!"), wxT('\0'));
} }
void VsnprintfTestCase::D() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::D", "[vsnprintf]")
{ {
CMP3("+123456", "%+d", 123456); CMP("+123456", "%+d", 123456);
CMP3("-123456", "%d", -123456); CMP("-123456", "%d", -123456);
CMP3(" 123456", "% d", 123456); CMP(" 123456", "% d", 123456);
CMP3(" 123456", "%10d", 123456); CMP(" 123456", "%10d", 123456);
CMP3("0000123456", "%010d", 123456); CMP("0000123456", "%010d", 123456);
CMP3("-123456 ", "%-10d", -123456); CMP("-123456 ", "%-10d", -123456);
} }
void VsnprintfTestCase::X() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::X", "[vsnprintf]")
{ {
CMP3("ABCD", "%X", 0xABCD); CMP("ABCD", "%X", 0xABCD);
CMP3("0XABCD", "%#X", 0xABCD); CMP("0XABCD", "%#X", 0xABCD);
CMP3("0xabcd", "%#x", 0xABCD); CMP("0xabcd", "%#x", 0xABCD);
} }
void VsnprintfTestCase::O() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::O", "[vsnprintf]")
{ {
CMP3("1234567", "%o", 01234567); CMP("1234567", "%o", 01234567);
CMP3("01234567", "%#o", 01234567); CMP("01234567", "%#o", 01234567);
} }
void VsnprintfTestCase::P() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::P", "[vsnprintf]")
{ {
// The exact format used for "%p" is not specified by the standard and so // The exact format used for "%p" is not specified by the standard and so
// varies among different platforms, so we need to expect different results // varies among different platforms, so we need to expect different results
@@ -235,37 +149,37 @@ void VsnprintfTestCase::P()
#if defined(__VISUALC__) || (defined(__MINGW32__) && \ #if defined(__VISUALC__) || (defined(__MINGW32__) && \
(!defined(__USE_MINGW_ANSI_STDIO) || !__USE_MINGW_ANSI_STDIO)) (!defined(__USE_MINGW_ANSI_STDIO) || !__USE_MINGW_ANSI_STDIO))
#if SIZEOF_VOID_P == 4 #if SIZEOF_VOID_P == 4
CMP3("00ABCDEF", "%p", (void*)0xABCDEF); CMP("00ABCDEF", "%p", (void*)0xABCDEF);
CMP3("00000000", "%p", (void*)NULL); CMP("00000000", "%p", (void*)NULL);
#elif SIZEOF_VOID_P == 8 #elif SIZEOF_VOID_P == 8
CMP3("0000ABCDEFABCDEF", "%p", (void*)0xABCDEFABCDEF); CMP("0000ABCDEFABCDEF", "%p", (void*)0xABCDEFABCDEF);
CMP3("0000000000000000", "%p", (void*)NULL); CMP("0000000000000000", "%p", (void*)NULL);
#endif #endif
#elif defined(__MINGW32__) #elif defined(__MINGW32__)
#if SIZEOF_VOID_P == 4 #if SIZEOF_VOID_P == 4
CMP3("00abcdef", "%p", (void*)0xABCDEF); CMP("00abcdef", "%p", (void*)0xABCDEF);
CMP3("00000000", "%p", (void*)NULL); CMP("00000000", "%p", (void*)NULL);
#elif SIZEOF_VOID_P == 8 #elif SIZEOF_VOID_P == 8
CMP3("0000abcdefabcdef", "%p", (void*)0xABCDEFABCDEF); CMP("0000abcdefabcdef", "%p", (void*)0xABCDEFABCDEF);
CMP3("0000000000000000", "%p", (void*)NULL); CMP("0000000000000000", "%p", (void*)NULL);
#endif #endif
#elif defined(__GNUG__) #elif defined(__GNUG__)
// glibc prints pointers as %#x except for NULL pointers which are printed // glibc prints pointers as %#x except for NULL pointers which are printed
// as '(nil)'. // as '(nil)'.
CMP3("0xabcdef", "%p", (void*)0xABCDEF); CMP("0xabcdef", "%p", (void*)0xABCDEF);
CMP3("(nil)", "%p", (void*)NULL); CMP("(nil)", "%p", (void*)NULL);
#endif #endif
} }
void VsnprintfTestCase::N() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::N", "[vsnprintf]")
{ {
int nchar; int nchar;
wxSnprintf(buf, MAX_TEST_LEN, wxT("%d %s%n\n"), 3, wxT("bears"), &nchar); wxSnprintf(buf, MAX_TEST_LEN, wxT("%d %s%n\n"), 3, wxT("bears"), &nchar);
CPPUNIT_ASSERT_EQUAL( 7, nchar ); CHECK( nchar == 7 );
} }
void VsnprintfTestCase::E() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::E", "[vsnprintf]")
{ {
// NB: Use at least three digits for the exponent to workaround // NB: Use at least three digits for the exponent to workaround
// differences between MSVC, MinGW and GNU libc. // differences between MSVC, MinGW and GNU libc.
@@ -275,64 +189,64 @@ void VsnprintfTestCase::E()
// printf("%e",2.342E+02); // printf("%e",2.342E+02);
// -> under MSVC7.1 prints: 2.342000e+002 // -> under MSVC7.1 prints: 2.342000e+002
// -> under GNU libc 2.4 prints: 2.342000e+02 // -> under GNU libc 2.4 prints: 2.342000e+02
CMP3("2.342000e+112", "%e",2.342E+112); CMP("2.342000e+112", "%e",2.342E+112);
CMP3("-2.3420e-112", "%10.4e",-2.342E-112); CMP("-2.3420e-112", "%10.4e",-2.342E-112);
CMP3("-2.3420e-112", "%11.4e",-2.342E-112); CMP("-2.3420e-112", "%11.4e",-2.342E-112);
CMP3(" -2.3420e-112", "%15.4e",-2.342E-112); CMP(" -2.3420e-112", "%15.4e",-2.342E-112);
CMP3("-0.02342", "%G",-2.342E-02); CMP("-0.02342", "%G",-2.342E-02);
CMP3("3.1415E-116", "%G",3.1415e-116); CMP("3.1415E-116", "%G",3.1415e-116);
CMP3("0003.141500e+103", "%016e", 3141.5e100); CMP("0003.141500e+103", "%016e", 3141.5e100);
CMP3(" 3.141500e+103", "%16e", 3141.5e100); CMP(" 3.141500e+103", "%16e", 3141.5e100);
CMP3("3.141500e+103 ", "%-16e", 3141.5e100); CMP("3.141500e+103 ", "%-16e", 3141.5e100);
CMP3("3.142e+103", "%010.3e", 3141.5e100); CMP("3.142e+103", "%010.3e", 3141.5e100);
} }
void VsnprintfTestCase::F() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::F", "[vsnprintf]")
{ {
CMP3("3.300000", "%5f", 3.3); CMP("3.300000", "%5f", 3.3);
CMP3("3.000000", "%5f", 3.0); CMP("3.000000", "%5f", 3.0);
CMP3("0.000100", "%5f", .999999E-4); CMP("0.000100", "%5f", .999999E-4);
CMP3("0.000990", "%5f", .99E-3); CMP("0.000990", "%5f", .99E-3);
CMP3("3333.000000", "%5f", 3333.0); CMP("3333.000000", "%5f", 3333.0);
} }
void VsnprintfTestCase::G() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::G", "[vsnprintf]")
{ {
// NOTE: the same about E() testcase applies here... // NOTE: the same about E() testcase applies here...
CMP3(" 3.3", "%5g", 3.3); CMP(" 3.3", "%5g", 3.3);
CMP3(" 3", "%5g", 3.0); CMP(" 3", "%5g", 3.0);
CMP3("9.99999e-115", "%5g", .999999E-114); CMP("9.99999e-115", "%5g", .999999E-114);
CMP3("0.00099", "%5g", .99E-3); CMP("0.00099", "%5g", .99E-3);
CMP3(" 3333", "%5g", 3333.0); CMP(" 3333", "%5g", 3333.0);
CMP3(" 0.01", "%5g", 0.01); CMP(" 0.01", "%5g", 0.01);
CMP3(" 3", "%5.g", 3.3); CMP(" 3", "%5.g", 3.3);
CMP3(" 3", "%5.g", 3.0); CMP(" 3", "%5.g", 3.0);
CMP3("1e-114", "%5.g", .999999E-114); CMP("1e-114", "%5.g", .999999E-114);
CMP3("0.0001", "%5.g", 1.0E-4); CMP("0.0001", "%5.g", 1.0E-4);
CMP3("0.001", "%5.g", .99E-3); CMP("0.001", "%5.g", .99E-3);
CMP3("3e+103", "%5.g", 3333.0E100); CMP("3e+103", "%5.g", 3333.0E100);
CMP3(" 0.01", "%5.g", 0.01); CMP(" 0.01", "%5.g", 0.01);
CMP3(" 3.3", "%5.2g", 3.3); CMP(" 3.3", "%5.2g", 3.3);
CMP3(" 3", "%5.2g", 3.0); CMP(" 3", "%5.2g", 3.0);
CMP3("1e-114", "%5.2g", .999999E-114); CMP("1e-114", "%5.2g", .999999E-114);
CMP3("0.00099", "%5.2g", .99E-3); CMP("0.00099", "%5.2g", .99E-3);
CMP3("3.3e+103", "%5.2g", 3333.0E100); CMP("3.3e+103", "%5.2g", 3333.0E100);
CMP3(" 0.01", "%5.2g", 0.01); CMP(" 0.01", "%5.2g", 0.01);
} }
void VsnprintfTestCase::S() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::S", "[vsnprintf]")
{ {
CMP3(" abc", "%5s", wxT("abc")); CMP(" abc", "%5s", wxT("abc"));
CMP3(" a", "%5s", wxT("a")); CMP(" a", "%5s", wxT("a"));
CMP3("abcdefghi", "%5s", wxT("abcdefghi")); CMP("abcdefghi", "%5s", wxT("abcdefghi"));
CMP3("abc ", "%-5s", wxT("abc")); CMP("abc ", "%-5s", wxT("abc"));
CMP3("abcdefghi", "%-5s", wxT("abcdefghi")); CMP("abcdefghi", "%-5s", wxT("abcdefghi"));
CMP3("abcde", "%.5s", wxT("abcdefghi")); CMP("abcde", "%.5s", wxT("abcdefghi"));
// do the same tests but with Unicode characters: // do the same tests but with Unicode characters:
#if wxUSE_UNICODE #if wxUSE_UNICODE
@@ -351,52 +265,48 @@ void VsnprintfTestCase::S()
// the 'expected' and 'arg' parameters of this macro are supposed to be // the 'expected' and 'arg' parameters of this macro are supposed to be
// UTF-8 strings // UTF-8 strings
#define CMP3_UTF8(expected, fmt, arg) \ #define CMP_UTF8(expected, fmt, arg) \
CPPUNIT_ASSERT_EQUAL \ CHECK \
( \ ( \
wxString::FromUTF8(expected).length(), \ (int)wxString::FromUTF8(expected).length() == \
wxSnprintf(buf, MAX_TEST_LEN, fmt, wxString::FromUTF8(arg)) \ wxSnprintf(buf, MAX_TEST_LEN, fmt, wxString::FromUTF8(arg)) \
); \ ); \
CPPUNIT_ASSERT_EQUAL \ CHECK( wxString::FromUTF8(expected) == buf )
( \
wxString::FromUTF8(expected), \
buf \
)
CMP3_UTF8(" " ABC, "%5s", ABC); CMP_UTF8(" " ABC, "%5s", ABC);
CMP3_UTF8(" " ALPHA, "%5s", ALPHA); CMP_UTF8(" " ALPHA, "%5s", ALPHA);
CMP3_UTF8(ABCDEFGHI, "%5s", ABCDEFGHI); CMP_UTF8(ABCDEFGHI, "%5s", ABCDEFGHI);
CMP3_UTF8(ABC " ", "%-5s", ABC); CMP_UTF8(ABC " ", "%-5s", ABC);
CMP3_UTF8(ABCDEFGHI, "%-5s", ABCDEFGHI); CMP_UTF8(ABCDEFGHI, "%-5s", ABCDEFGHI);
CMP3_UTF8(ABCDE, "%.5s", ABCDEFGHI); CMP_UTF8(ABCDE, "%.5s", ABCDEFGHI);
#endif // wxUSE_UNICODE #endif // wxUSE_UNICODE
// test a string which has a NULL character after "ab"; // test a string which has a NULL character after "ab";
// obviously it should be handled exactly like just as "ab" // obviously it should be handled exactly like just as "ab"
CMP3(" ab", "%5s", wxT("ab\0cdefghi")); CMP(" ab", "%5s", wxT("ab\0cdefghi"));
} }
void VsnprintfTestCase::Asterisk() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::Asterisk", "[vsnprintf]")
{ {
CMP5(" 0.1", "%*.*f", 10, 1, 0.123); CMP(" 0.1", "%*.*f", 10, 1, 0.123);
CMP5(" 0.1230", "%*.*f", 10, 4, 0.123); CMP(" 0.1230", "%*.*f", 10, 4, 0.123);
CMP5("0.1", "%*.*f", 3, 1, 0.123); CMP("0.1", "%*.*f", 3, 1, 0.123);
CMP4("%0.002", "%%%.*f", 3, 0.0023456789); CMP("%0.002", "%%%.*f", 3, 0.0023456789);
CMP4(" a", "%*c", 8, 'a'); CMP(" a", "%*c", 8, 'a');
CMP4(" four", "%*s", 8, "four"); CMP(" four", "%*s", 8, "four");
CMP6(" four four", "%*s %*s", 8, "four", 6, "four"); CMP(" four four", "%*s %*s", 8, "four", 6, "four");
} }
void VsnprintfTestCase::Percent() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::Percent", "[vsnprintf]")
{ {
// some tests without any argument passed through ... // some tests without any argument passed through ...
CMP2("%", "%%"); CMP("%", "%%");
CMP2("%%%", "%%%%%%"); CMP("%%%", "%%%%%%");
CMP3("% abc", "%%%5s", wxT("abc")); CMP("% abc", "%%%5s", wxT("abc"));
CMP3("% abc%", "%%%5s%%", wxT("abc")); CMP("% abc%", "%%%5s%%", wxT("abc"));
// do not test odd number of '%' symbols as different implementations // do not test odd number of '%' symbols as different implementations
// of snprintf() give different outputs as this situation is not considered // of snprintf() give different outputs as this situation is not considered
@@ -406,21 +316,21 @@ void VsnprintfTestCase::Percent()
} }
#ifdef wxLongLong_t #ifdef wxLongLong_t
void VsnprintfTestCase::LongLong() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::LongLong", "[vsnprintf]")
{ {
CMP3("123456789", "%lld", (wxLongLong_t)123456789); CMP("123456789", "%lld", (wxLongLong_t)123456789);
CMP3("-123456789", "%lld", (wxLongLong_t)-123456789); CMP("-123456789", "%lld", (wxLongLong_t)-123456789);
CMP3("123456789", "%llu", (wxULongLong_t)123456789); CMP("123456789", "%llu", (wxULongLong_t)123456789);
#ifdef __WINDOWS__ #ifdef __WINDOWS__
CMP3("123456789", "%I64d", (wxLongLong_t)123456789); CMP("123456789", "%I64d", (wxLongLong_t)123456789);
CMP3("123456789abcdef", "%I64x", wxLL(0x123456789abcdef)); CMP("123456789abcdef", "%I64x", wxLL(0x123456789abcdef));
#endif #endif
} }
#endif #endif
void VsnprintfTestCase::WrongFormatStrings() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::WrongFormatStrings", "[vsnprintf]")
{ {
// test how wxVsnprintf() behaves with wrong format string: // test how wxVsnprintf() behaves with wrong format string:
@@ -429,8 +339,10 @@ void VsnprintfTestCase::WrongFormatStrings()
wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %3$d"), 1, 2, 3) ); wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %3$d"), 1, 2, 3) );
// positional and non-positionals in the same format string: // positional and non-positionals in the same format string:
errno = 0;
r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %d %3$d"), 1, 2, 3); r = wxSnprintf(buf, MAX_TEST_LEN, wxT("%1$d %d %3$d"), 1, 2, 3);
CPPUNIT_ASSERT_EQUAL(-1, r); CHECK( r == -1 );
CHECK( errno == EINVAL );
} }
// BigToSmallBuffer() test case helper: // BigToSmallBuffer() test case helper:
@@ -481,14 +393,10 @@ void VsnprintfTestCase::DoBigToSmallBuffer(T *buffer, int size)
wxString expected = wxString expected =
wxString(wxT("unicode string/char: unicode/U -- ansi string/char: ansi/A")).Left(size - 1); wxString(wxT("unicode string/char: unicode/U -- ansi string/char: ansi/A")).Left(size - 1);
CPPUNIT_ASSERT( r != -1 ); CHECK( expected == buffer );
CPPUNIT_ASSERT_EQUAL(
expected,
wxString(buffer)
);
} }
void VsnprintfTestCase::BigToSmallBuffer() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::BigToSmallBuffer", "[vsnprintf]")
{ {
#if wxUSE_UNICODE #if wxUSE_UNICODE
wchar_t bufw[1024], bufw2[16], bufw3[4], bufw4; wchar_t bufw[1024], bufw2[16], bufw3[4], bufw4;
@@ -541,18 +449,22 @@ void VsnprintfTestCase::DoMisc(
std::string errMsg(errStr.mb_str()); std::string errMsg(errStr.mb_str());
std::string overflowMsg(overflowStr.mb_str()); std::string overflowMsg(overflowStr.mb_str());
INFO(errMsg);
if ( size_t(n) < max ) if ( size_t(n) < max )
CPPUNIT_ASSERT_MESSAGE(errMsg, expectedLen == n); CHECK(expectedLen == n);
else else
CPPUNIT_ASSERT_MESSAGE(errMsg, expectedLen == -1); CHECK(expectedLen == -1);
CPPUNIT_ASSERT_MESSAGE(errMsg, expectedString == buf); CHECK(expectedString == buf);
for (i = max; i < BUFSIZE; i++) for (i = max; i < BUFSIZE; i++)
CPPUNIT_ASSERT_MESSAGE(overflowMsg, buf[i] == '*'); {
INFO(overflowMsg);
CHECK(buf[i] == '*');
}
} }
void VsnprintfTestCase::Miscellaneous() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::Miscellaneous", "[vsnprintf]")
{ {
// expectedLen, expectedString, max, format, ... // expectedLen, expectedString, max, format, ...
DoMisc(5, wxT("-1234"), 8, wxT("%d"), -1234); DoMisc(5, wxT("-1234"), 8, wxT("%d"), -1234);
@@ -586,48 +498,48 @@ void VsnprintfTestCase::Miscellaneous()
* 2. you leave this copyright notice intact. * 2. you leave this copyright notice intact.
*/ */
void VsnprintfTestCase::GlibcMisc1() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::GlibcMisc1", "[vsnprintf]")
{ {
CMP3(" ", "%5.s", "xyz"); CMP(" ", "%5.s", "xyz");
CMP3(" 33", "%5.f", 33.3); CMP(" 33", "%5.f", 33.3);
#if defined(wxDEFAULT_MANTISSA_SIZE_3) #if defined(wxDEFAULT_MANTISSA_SIZE_3)
CMP3(" 3e+008", "%8.e", 33.3e7); CMP(" 3e+008", "%8.e", 33.3e7);
CMP3(" 3E+008", "%8.E", 33.3e7); CMP(" 3E+008", "%8.E", 33.3e7);
CMP3("3e+001", "%.g", 33.3); CMP("3e+001", "%.g", 33.3);
CMP3("3E+001", "%.G", 33.3); CMP("3E+001", "%.G", 33.3);
#else #else
CMP3(" 3e+08", "%8.e", 33.3e7); CMP(" 3e+08", "%8.e", 33.3e7);
CMP3(" 3E+08", "%8.E", 33.3e7); CMP(" 3E+08", "%8.E", 33.3e7);
CMP3("3e+01", "%.g", 33.3); CMP("3e+01", "%.g", 33.3);
CMP3("3E+01", "%.G", 33.3); CMP("3E+01", "%.G", 33.3);
#endif #endif
} }
void VsnprintfTestCase::GlibcMisc2() TEST_CASE_METHOD(VsnprintfTestCase, "Vsnprintf::GlibcMisc2", "[vsnprintf]")
{ {
int prec; int prec;
wxString test_format; wxString test_format;
prec = 0; prec = 0;
CMP4("3", "%.*g", prec, 3.3); CMP("3", "%.*g", prec, 3.3);
prec = 0; prec = 0;
CMP4("3", "%.*G", prec, 3.3); CMP("3", "%.*G", prec, 3.3);
prec = 0; prec = 0;
CMP4(" 3", "%7.*G", prec, 3.33); CMP(" 3", "%7.*G", prec, 3.33);
prec = 3; prec = 3;
CMP4(" 041", "%04.*o", prec, 33); CMP(" 041", "%04.*o", prec, 33);
prec = 7; prec = 7;
CMP4(" 0000033", "%09.*u", prec, 33); CMP(" 0000033", "%09.*u", prec, 33);
prec = 3; prec = 3;
CMP4(" 021", "%04.*x", prec, 33); CMP(" 021", "%04.*x", prec, 33);
prec = 3; prec = 3;
CMP4(" 021", "%04.*X", prec, 33); CMP(" 021", "%04.*X", prec, 33);
} }
#endif // wxUSE_WXVSNPRINTF #endif // wxUSE_WXVSNPRINTF