X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9efd3367c0a3a2a4e6d7edebda6cd5799576dc3a..ff818ab87b3b9ba8478e7fd6b2052319f530fd55:/src/common/string.cpp diff --git a/src/common/string.cpp b/src/common/string.cpp index 913693a80a..791c5ce049 100644 --- a/src/common/string.cpp +++ b/src/common/string.cpp @@ -6,11 +6,11 @@ // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifdef __GNUG__ -#pragma implementation "string.h" + #pragma implementation "string.h" #endif /* @@ -28,80 +28,88 @@ #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif #ifndef WX_PRECOMP -#include "wx/defs.h" -#include "wx/string.h" + #include "wx/defs.h" + #include "wx/string.h" + #include "wx/intl.h" + #include "wx/thread.h" #endif #include #include #include -#ifdef WXSTRING_IS_WXOBJECT - IMPLEMENT_DYNAMIC_CLASS(wxString, wxObject) -#endif //WXSTRING_IS_WXOBJECT +#ifdef __SALFORDC__ + #include +#endif + +// allocating extra space for each string consumes more memory but speeds up +// the concatenation operations (nLen is the current string's length) +// NB: EXTRA_ALLOC must be >= 0! +#define EXTRA_ALLOC (19 - nLen % 16) // --------------------------------------------------------------------------- // static class variables definition // --------------------------------------------------------------------------- -#ifdef STD_STRING_COMPATIBILITY - const size_t wxString::npos = STRING_MAXLEN; -#endif +#if defined(__VISAGECPP__) && __IBMCPP__ >= 400 +// must define this static for VA or else you get multiply defined symbols +// everywhere +const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100; +#endif // Visual Age -// =========================================================================== -// static class data, special inlines -// =========================================================================== +#ifdef wxSTD_STRING_COMPATIBILITY + const size_t wxString::npos = wxSTRING_MAXLEN; +#endif // wxSTD_STRING_COMPATIBILITY + +// ---------------------------------------------------------------------------- +// static data +// ---------------------------------------------------------------------------- + +// for an empty string, GetStringData() will return this address: this +// structure has the same layout as wxStringData and it's data() method will +// return the empty string (dummy pointer) +static const struct +{ + wxStringData data; + wxChar dummy; +} g_strEmpty = { {-1, 0, 0}, wxT('\0') }; -// for an empty string, GetStringData() will return this address -static int g_strEmpty[] = { -1, // ref count (locked) - 0, // current length - 0, // allocated memory - 0 }; // string data -// empty string shares memory with g_strEmpty -static wxStringData *g_strNul = (wxStringData*)&g_strEmpty; // empty C style string: points to 'string data' byte of g_strEmpty -extern const char *g_szNul = (const char *)(&g_strEmpty[3]); +extern const wxChar WXDLLEXPORT *wxEmptyString = &g_strEmpty.dummy; -// =========================================================================== +// ---------------------------------------------------------------------------- // global functions -// =========================================================================== +// ---------------------------------------------------------------------------- -#ifdef STD_STRING_COMPATIBILITY +#if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM // MS Visual C++ version 5.0 provides the new STL headers as well as the old // iostream ones. // // ATTN: you can _not_ use both of these in the same program! -#if 0 // def _MSC_VER - #include - #define NAMESPACE std:: -#else - #include - #define NAMESPACE -#endif //Visual C++ -NAMESPACE istream& operator>>(NAMESPACE istream& is, wxString& WXUNUSED(str)) +wxSTD istream& operator>>(wxSTD istream& is, wxString& WXUNUSED(str)) { #if 0 int w = is.width(0); if ( is.ipfx(0) ) { - NAMESPACE streambuf *sb = is.rdbuf(); + streambuf *sb = is.rdbuf(); str.erase(); while ( true ) { int ch = sb->sbumpc (); if ( ch == EOF ) { - is.setstate(NAMESPACE ios::eofbit); + is.setstate(ios::eofbit); break; } else if ( isspace(ch) ) { sb->sungetc(); break; } - + str += ch; if ( --w == 1 ) break; @@ -110,13 +118,48 @@ NAMESPACE istream& operator>>(NAMESPACE istream& is, wxString& WXUNUSED(str)) is.isfx(); if ( str.length() == 0 ) - is.setstate(NAMESPACE ios::failbit); + is.setstate(ios::failbit); #endif return is; } +wxSTD ostream& operator<<(wxSTD ostream& os, const wxString& str) +{ + os << str.c_str(); + return os; +} + #endif //std::string compatibility +// ---------------------------------------------------------------------------- +// private classes +// ---------------------------------------------------------------------------- + +// this small class is used to gather statistics for performance tuning +//#define WXSTRING_STATISTICS +#ifdef WXSTRING_STATISTICS + class Averager + { + public: + Averager(const wxChar *sz) { m_sz = sz; m_nTotal = m_nCount = 0; } + ~Averager() + { wxPrintf("wxString: average %s = %f\n", m_sz, ((float)m_nTotal)/m_nCount); } + + void Add(size_t n) { m_nTotal += n; m_nCount++; } + + private: + size_t m_nCount, m_nTotal; + const wxChar *m_sz; + } g_averageLength("allocation size"), + g_averageSummandLength("summand length"), + g_averageConcatHit("hit probability in concat"), + g_averageInitialLength("initial string length"); + + #define STATISTICS_ADD(av, val) g_average##av.Add(val) +#else + #define STATISTICS_ADD(av, val) +#endif // WXSTRING_STATISTICS + // =========================================================================== // wxString class core // =========================================================================== @@ -125,184 +168,351 @@ NAMESPACE istream& operator>>(NAMESPACE istream& is, wxString& WXUNUSED(str)) // construction // --------------------------------------------------------------------------- -// construct an empty string -wxString::wxString() -{ - Init(); -} - -// copy constructor -wxString::wxString(const wxString& stringSrc) -{ - wxASSERT( stringSrc.GetStringData()->IsValid() ); - - if ( stringSrc.IsEmpty() ) { - // nothing to do for an empty string - Init(); - } - else { - m_pchData = stringSrc.m_pchData; // share same data - GetStringData()->Lock(); // => one more copy - } -} - // constructs string of copies of character -wxString::wxString(char ch, size_t nLength) +wxString::wxString(wxChar ch, size_t nLength) { Init(); if ( nLength > 0 ) { - AllocBuffer(nLength); - - wxASSERT( sizeof(char) == 1 ); // can't use memset if not + if ( !AllocBuffer(nLength) ) { + wxFAIL_MSG( _T("out of memory in wxString::wxString") ); + return; + } +#if wxUSE_UNICODE + // memset only works on chars + for ( size_t n = 0; n < nLength; n++ ) + m_pchData[n] = ch; +#else memset(m_pchData, ch, nLength); +#endif } } // takes nLength elements of psz starting at nPos -void wxString::InitWith(const char *psz, size_t nPos, size_t nLength) +void wxString::InitWith(const wxChar *psz, size_t nPos, size_t nLength) { Init(); - wxASSERT( nPos <= Strlen(psz) ); + // if the length is not given, assume the string to be NUL terminated + if ( nLength == wxSTRING_MAXLEN ) { + wxASSERT_MSG( nPos <= wxStrlen(psz), _T("index out of bounds") ); + + nLength = wxStrlen(psz + nPos); + } - if ( nLength == STRING_MAXLEN ) - nLength = Strlen(psz + nPos); + STATISTICS_ADD(InitialLength, nLength); if ( nLength > 0 ) { // trailing '\0' is written in AllocBuffer() - AllocBuffer(nLength); - memcpy(m_pchData, psz + nPos, nLength*sizeof(char)); + if ( !AllocBuffer(nLength) ) { + wxFAIL_MSG( _T("out of memory in wxString::InitWith") ); + return; + } + memcpy(m_pchData, psz + nPos, nLength*sizeof(wxChar)); } } - -// take first nLength characters of C string psz -// (default value of STRING_MAXLEN means take all the string) -wxString::wxString(const char *psz, size_t nLength) -{ - InitWith(psz, 0, nLength); -} -// the same as previous constructor, but for compilers using unsigned char -wxString::wxString(const unsigned char* psz, size_t nLength) -{ - InitWith((const char *)psz, 0, nLength); -} - -#ifdef STD_STRING_COMPATIBILITY - -// ctor from a substring -wxString::wxString(const wxString& s, size_t nPos, size_t nLen) -{ - InitWith(s.c_str(), nPos, nLen == npos ? 0 : nLen); -} +#ifdef wxSTD_STRING_COMPATIBILITY // poor man's iterators are "void *" pointers wxString::wxString(const void *pStart, const void *pEnd) { - InitWith((const char *)pStart, 0, - (const char *)pEnd - (const char *)pStart); + InitWith((const wxChar *)pStart, 0, + (const wxChar *)pEnd - (const wxChar *)pStart); } #endif //std::string compatibility -// from wide string -wxString::wxString(const wchar_t *pwz) +#if wxUSE_UNICODE + +// from multibyte string +wxString::wxString(const char *psz, wxMBConv& conv, size_t nLength) { - // first get necessary size - size_t nLen = wcstombs(NULL, pwz, 0); + // first get the size of the buffer we need + size_t nLen; + if ( psz ) + { + // calculate the needed size ourselves or use a provide one + nLen = nLength == wxSTRING_MAXLEN ? conv.MB2WC(NULL, psz, 0) : nLength; + } + else + { + // nothing to convert + nLen = 0; + } + + // anything to do? + if ( (nLen != 0) && (nLen != (size_t)-1) ) + { + if ( !AllocBuffer(nLen) ) + { + wxFAIL_MSG( _T("out of memory in wxString::wxString") ); + return; + } + + // MB2WC wants the buffer size, not the string length + if ( conv.MB2WC(m_pchData, psz, nLen + 1) != (size_t)-1 ) + { + // initialized ok + return; + } + //else: the conversion failed -- leave the string empty (what else?) + } - // empty? - if ( nLen != 0 ) { - AllocBuffer(nLen); - wcstombs(m_pchData, pwz, nLen); - } - else { Init(); - } } +#else // ANSI + +#if wxUSE_WCHAR_T +// from wide string +wxString::wxString(const wchar_t *pwz, wxMBConv& conv, size_t nLength) +{ + // first get the size of the buffer we need + size_t nLen; + if ( pwz ) + { + // calculate the needed size ourselves or use a provide one + nLen = nLength == wxSTRING_MAXLEN ? conv.WC2MB(NULL, pwz, 0) : nLength; + } + else + { + // nothing to convert + nLen = 0; + } + + // anything to do? + if ( (nLen != 0) && (nLen != (size_t)-1) ) + { + if ( !AllocBuffer(nLen) ) + { + wxFAIL_MSG( _T("out of memory in wxString::wxString") ); + return; + } + + // WC2MB wants the buffer size, not the string length + if ( conv.WC2MB(m_pchData, pwz, nLen + 1) != (size_t)-1 ) + { + // initialized ok + return; + } + //else: the conversion failed -- leave the string empty (what else?) + } + + Init(); +} +#endif // wxUSE_WCHAR_T + +#endif // Unicode/ANSI + // --------------------------------------------------------------------------- // memory allocation // --------------------------------------------------------------------------- // allocates memory needed to store a C string of length nLen -void wxString::AllocBuffer(size_t nLen) +bool wxString::AllocBuffer(size_t nLen) { - wxASSERT( nLen > 0 ); // - wxASSERT( nLen <= INT_MAX-1 ); // max size (enough room for 1 extra) + // allocating 0 sized buffer doesn't make sense, all empty strings should + // reuse g_strEmpty + wxASSERT( nLen > 0 ); + + // make sure that we don't overflow + wxASSERT( nLen < (INT_MAX / sizeof(wxChar)) - + (sizeof(wxStringData) + EXTRA_ALLOC + 1) ); + + STATISTICS_ADD(Length, nLen); // allocate memory: // 1) one extra character for '\0' termination // 2) sizeof(wxStringData) for housekeeping info - wxStringData* pData = (wxStringData*)new char[sizeof(wxStringData) + - (nLen + 1)*sizeof(char)]; + wxStringData* pData = (wxStringData*) + malloc(sizeof(wxStringData) + (nLen + EXTRA_ALLOC + 1)*sizeof(wxChar)); + + if ( pData == NULL ) { + // allocation failures are handled by the caller + return FALSE; + } + pData->nRefs = 1; - pData->data()[nLen] = '\0'; pData->nDataLength = nLen; - pData->nAllocLength = nLen; + pData->nAllocLength = nLen + EXTRA_ALLOC; m_pchData = pData->data(); // data starts after wxStringData -} - -// releases the string memory and reinits it -void wxString::Reinit() -{ - GetStringData()->Unlock(); - Init(); -} - -// wrapper around wxString::Reinit -void wxString::Empty() -{ - if ( GetStringData()->nDataLength != 0 ) - Reinit(); - - wxASSERT( GetStringData()->nDataLength == 0 ); - wxASSERT( GetStringData()->nAllocLength == 0 ); + m_pchData[nLen] = wxT('\0'); + return TRUE; } // must be called before changing this string -void wxString::CopyBeforeWrite() +bool wxString::CopyBeforeWrite() { wxStringData* pData = GetStringData(); if ( pData->IsShared() ) { pData->Unlock(); // memory not freed because shared - AllocBuffer(pData->nDataLength); - memcpy(m_pchData, pData->data(), (pData->nDataLength + 1)*sizeof(char)); + size_t nLen = pData->nDataLength; + if ( !AllocBuffer(nLen) ) { + // allocation failures are handled by the caller + return FALSE; + } + memcpy(m_pchData, pData->data(), nLen*sizeof(wxChar)); } - wxASSERT( !pData->IsShared() ); // we must be the only owner + wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner + + return TRUE; } // must be called before replacing contents of this string -void wxString::AllocBeforeWrite(size_t nLen) +bool wxString::AllocBeforeWrite(size_t nLen) { wxASSERT( nLen != 0 ); // doesn't make any sense // must not share string and must have enough space - register wxStringData* pData = GetStringData(); - if ( pData->IsShared() || (nLen > pData->nAllocLength) ) { + wxStringData* pData = GetStringData(); + if ( pData->IsShared() || pData->IsEmpty() ) { // can't work with old buffer, get new one pData->Unlock(); - AllocBuffer(nLen); + if ( !AllocBuffer(nLen) ) { + // allocation failures are handled by the caller + return FALSE; + } + } + else { + if ( nLen > pData->nAllocLength ) { + // realloc the buffer instead of calling malloc() again, this is more + // efficient + STATISTICS_ADD(Length, nLen); + + nLen += EXTRA_ALLOC; + + pData = (wxStringData*) + realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar)); + + if ( pData == NULL ) { + // allocation failures are handled by the caller + // keep previous data since reallocation failed + return FALSE; + } + + pData->nAllocLength = nLen; + m_pchData = pData->data(); + } + + // now we have enough space, just update the string length + pData->nDataLength = nLen; + } + + wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner + + return TRUE; +} + +// allocate enough memory for nLen characters +bool wxString::Alloc(size_t nLen) +{ + wxStringData *pData = GetStringData(); + if ( pData->nAllocLength <= nLen ) { + if ( pData->IsEmpty() ) { + nLen += EXTRA_ALLOC; + + wxStringData* pData = (wxStringData*) + malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar)); + + if ( pData == NULL ) { + // allocation failure handled by caller + return FALSE; + } + + pData->nRefs = 1; + pData->nDataLength = 0; + pData->nAllocLength = nLen; + m_pchData = pData->data(); // data starts after wxStringData + m_pchData[0u] = wxT('\0'); + } + else if ( pData->IsShared() ) { + pData->Unlock(); // memory not freed because shared + size_t nOldLen = pData->nDataLength; + if ( !AllocBuffer(nLen) ) { + // allocation failure handled by caller + return FALSE; + } + memcpy(m_pchData, pData->data(), nOldLen*sizeof(wxChar)); + } + else { + nLen += EXTRA_ALLOC; + + pData = (wxStringData *) + realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar)); + + if ( pData == NULL ) { + // allocation failure handled by caller + // keep previous data since reallocation failed + return FALSE; + } + + // it's not important if the pointer changed or not (the check for this + // is not faster than assigning to m_pchData in all cases) + pData->nAllocLength = nLen; + m_pchData = pData->data(); + } + } + //else: we've already got enough + return TRUE; +} + +// shrink to minimal size (releasing extra memory) +bool wxString::Shrink() +{ + wxStringData *pData = GetStringData(); + + size_t nLen = pData->nDataLength; + void *p = realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar)); + + if ( p == NULL) { + wxFAIL_MSG( _T("out of memory reallocating wxString data") ); + // keep previous data since reallocation failed + return FALSE; + } + + if ( p != pData ) + { + // contrary to what one might believe, some realloc() implementation do + // move the memory block even when its size is reduced + pData = (wxStringData *)p; + + m_pchData = pData->data(); } - wxASSERT( !pData->IsShared() ); // we must be the only owner + pData->nAllocLength = nLen; + + return TRUE; } // get the pointer to writable buffer of (at least) nLen bytes -char *wxString::GetWriteBuf(size_t nLen) +wxChar *wxString::GetWriteBuf(size_t nLen) { - AllocBeforeWrite(nLen); + if ( !AllocBeforeWrite(nLen) ) { + // allocation failure handled by caller + return NULL; + } + + wxASSERT( GetStringData()->nRefs == 1 ); + GetStringData()->Validate(FALSE); + return m_pchData; } -// dtor frees memory if no other strings use it -wxString::~wxString() +// put string back in a reasonable state after GetWriteBuf +void wxString::UngetWriteBuf() { - GetStringData()->Unlock(); + GetStringData()->nDataLength = wxStrlen(m_pchData); + GetStringData()->Validate(TRUE); +} + +void wxString::UngetWriteBuf(size_t nLen) +{ + GetStringData()->nDataLength = nLen; + GetStringData()->Validate(TRUE); } // --------------------------------------------------------------------------- @@ -315,23 +525,29 @@ wxString::~wxString() // assignment operators // --------------------------------------------------------------------------- -// helper function: does real copy -void wxString::AssignCopy(size_t nSrcLen, const char *pszSrcData) +// helper function: does real copy +bool wxString::AssignCopy(size_t nSrcLen, const wxChar *pszSrcData) { if ( nSrcLen == 0 ) { Reinit(); } else { - AllocBeforeWrite(nSrcLen); - memcpy(m_pchData, pszSrcData, nSrcLen*sizeof(char)); + if ( !AllocBeforeWrite(nSrcLen) ) { + // allocation failure handled by caller + return FALSE; + } + memcpy(m_pchData, pszSrcData, nSrcLen*sizeof(wxChar)); GetStringData()->nDataLength = nSrcLen; - m_pchData[nSrcLen] = '\0'; + m_pchData[nSrcLen] = wxT('\0'); } + return TRUE; } // assigns one string to another wxString& wxString::operator=(const wxString& stringSrc) { + wxASSERT( stringSrc.GetStringData()->IsValid() ); + // don't copy string over itself if ( m_pchData != stringSrc.m_pchData ) { if ( stringSrc.GetStringData()->IsEmpty() ) { @@ -349,19 +565,26 @@ wxString& wxString::operator=(const wxString& stringSrc) } // assigns a single character -wxString& wxString::operator=(char ch) +wxString& wxString::operator=(wxChar ch) { - AssignCopy(1, &ch); + if ( !AssignCopy(1, &ch) ) { + wxFAIL_MSG( _T("out of memory in wxString::operator=(wxChar)") ); + } return *this; } + // assigns C string -wxString& wxString::operator=(const char *psz) +wxString& wxString::operator=(const wxChar *psz) { - AssignCopy(Strlen(psz), psz); + if ( !AssignCopy(wxStrlen(psz), psz) ) { + wxFAIL_MSG( _T("out of memory in wxString::operator=(const wxChar *)") ); + } return *this; } +#if !wxUSE_UNICODE + // same as 'signed char' variant wxString& wxString::operator=(const unsigned char* psz) { @@ -369,186 +592,283 @@ wxString& wxString::operator=(const unsigned char* psz) return *this; } +#if wxUSE_WCHAR_T wxString& wxString::operator=(const wchar_t *pwz) { wxString str(pwz); *this = str; return *this; } +#endif + +#endif // --------------------------------------------------------------------------- // string concatenation // --------------------------------------------------------------------------- -// concatenate two sources -// NB: assume that 'this' is a new wxString object -void wxString::ConcatCopy(int nSrc1Len, const char *pszSrc1Data, - int nSrc2Len, const char *pszSrc2Data) -{ - int nNewLen = nSrc1Len + nSrc2Len; - if ( nNewLen != 0 ) - { - AllocBuffer(nNewLen); - memcpy(m_pchData, pszSrc1Data, nSrc1Len*sizeof(char)); - memcpy(m_pchData + nSrc1Len, pszSrc2Data, nSrc2Len*sizeof(char)); - } -} - // add something to this string -void wxString::ConcatSelf(int nSrcLen, const char *pszSrcData) +bool wxString::ConcatSelf(size_t nSrcLen, const wxChar *pszSrcData) { + STATISTICS_ADD(SummandLength, nSrcLen); + // concatenating an empty string is a NOP - if ( nSrcLen != 0 ) { - register wxStringData *pData = GetStringData(); + if ( nSrcLen > 0 ) { + wxStringData *pData = GetStringData(); + size_t nLen = pData->nDataLength; + size_t nNewLen = nLen + nSrcLen; // alloc new buffer if current is too small - if ( pData->IsShared() || - pData->nDataLength + nSrcLen > pData->nAllocLength ) { - // we have to grow the buffer, use the ConcatCopy routine - // (which will allocate memory) + if ( pData->IsShared() ) { + STATISTICS_ADD(ConcatHit, 0); + + // we have to allocate another buffer wxStringData* pOldData = GetStringData(); - ConcatCopy(pOldData->nDataLength, m_pchData, nSrcLen, pszSrcData); + if ( !AllocBuffer(nNewLen) ) { + // allocation failure handled by caller + return FALSE; + } + memcpy(m_pchData, pOldData->data(), nLen*sizeof(wxChar)); pOldData->Unlock(); } - else { - // fast concatenation when buffer big enough - memcpy(m_pchData + pData->nDataLength, pszSrcData, nSrcLen*sizeof(char)); - pData->nDataLength += nSrcLen; + else if ( nNewLen > pData->nAllocLength ) { + STATISTICS_ADD(ConcatHit, 0); - // should be enough space - wxASSERT( pData->nDataLength <= pData->nAllocLength ); + // we have to grow the buffer + if ( !Alloc(nNewLen) ) { + // allocation failure handled by caller + return FALSE; + } + } + else { + STATISTICS_ADD(ConcatHit, 1); - m_pchData[pData->nDataLength] = '\0'; // put terminating '\0' + // the buffer is already big enough } + + // should be enough space + wxASSERT( nNewLen <= GetStringData()->nAllocLength ); + + // fast concatenation - all is done in our buffer + memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(wxChar)); + + m_pchData[nNewLen] = wxT('\0'); // put terminating '\0' + GetStringData()->nDataLength = nNewLen; // and fix the length } + //else: the string to append was empty + return TRUE; } /* - * string may be concatenated with other string, C string or a character + * concatenation functions come in 5 flavours: + * string + string + * char + string and string + char + * C str + string and string + C str */ -void wxString::operator+=(const wxString& string) +wxString operator+(const wxString& str1, const wxString& str2) { - ConcatSelf(string.Len(), string); -} + wxASSERT( str1.GetStringData()->IsValid() ); + wxASSERT( str2.GetStringData()->IsValid() ); -void wxString::operator+=(const char *psz) -{ - ConcatSelf(Strlen(psz), psz); + wxString s = str1; + s += str2; + + return s; } -void wxString::operator+=(char ch) +wxString operator+(const wxString& str, wxChar ch) { - ConcatSelf(1, &ch); -} + wxASSERT( str.GetStringData()->IsValid() ); -/* - * Same as above but return the result - */ + wxString s = str; + s += ch; -wxString& wxString::operator<<(const wxString& string) -{ - ConcatSelf(string.Len(), string); - return *this; + return s; } -wxString& wxString::operator<<(const char *psz) +wxString operator+(wxChar ch, const wxString& str) { - ConcatSelf(Strlen(psz), psz); - return *this; -} + wxASSERT( str.GetStringData()->IsValid() ); -wxString& wxString::operator<<(char ch) -{ - ConcatSelf(1, &ch); - return *this; -} + wxString s = ch; + s += str; -/* - * concatenation functions come in 5 flavours: - * string + string - * char + string and string + char - * C str + string and string + C str - */ + return s; +} -wxString operator+(const wxString& string1, const wxString& string2) +wxString operator+(const wxString& str, const wxChar *psz) { + wxASSERT( str.GetStringData()->IsValid() ); + wxString s; - s.ConcatCopy(string1.GetStringData()->nDataLength, string1.m_pchData, - string2.GetStringData()->nDataLength, string2.m_pchData); + if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) { + wxFAIL_MSG( _T("out of memory in wxString::operator+") ); + } + s = str; + s += psz; + return s; } -wxString operator+(const wxString& string1, char ch) +wxString operator+(const wxChar *psz, const wxString& str) { + wxASSERT( str.GetStringData()->IsValid() ); + wxString s; - s.ConcatCopy(string1.GetStringData()->nDataLength, string1.m_pchData, 1, &ch); + if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) { + wxFAIL_MSG( _T("out of memory in wxString::operator+") ); + } + s = psz; + s += str; + return s; } -wxString operator+(char ch, const wxString& string) +// =========================================================================== +// other common string functions +// =========================================================================== + +#if wxUSE_UNICODE + +wxString wxString::FromAscii(const char *ascii) { - wxString s; - s.ConcatCopy(1, &ch, string.GetStringData()->nDataLength, string.m_pchData); - return s; + if (!ascii) + return wxEmptyString; + + size_t len = strlen( ascii ); + wxString res; + + if ( len ) + { + wxStringBuffer buf(res, len); + + wchar_t *dest = buf; + + for ( ;; ) + { + if ( (*dest++ = (wchar_t)(unsigned char)*ascii++) == L'\0' ) + break; + } + } + + return res; } -wxString operator+(const wxString& string, const char *psz) +wxString wxString::FromAscii(const char ascii) { - wxString s; - s.ConcatCopy(string.GetStringData()->nDataLength, string.m_pchData, - Strlen(psz), psz); - return s; + // What do we do with '\0' ? + + wxString res; + res += (wchar_t)(unsigned char) ascii; + + return res; } -wxString operator+(const char *psz, const wxString& string) +const wxCharBuffer wxString::ToAscii() const { - wxString s; - s.ConcatCopy(Strlen(psz), psz, - string.GetStringData()->nDataLength, string.m_pchData); - return s; + // this will allocate enough space for the terminating NUL too + wxCharBuffer buffer(length()); + + signed char *dest = (signed char *)buffer.data(); + + const wchar_t *pwc = c_str(); + for ( ;; ) + { + *dest++ = *pwc > SCHAR_MAX ? '_' : *pwc; + + // the output string can't have embedded NULs anyhow, so we can safely + // stop at first of them even if we do have any + if ( !*pwc++ ) + break; + } + + return buffer; } -// =========================================================================== -// other common string functions -// =========================================================================== +#endif // Unicode // --------------------------------------------------------------------------- // simple sub-string extraction // --------------------------------------------------------------------------- // helper function: clone the data attached to this string -void wxString::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const +bool wxString::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const { - if ( nCopyLen == 0 ) - { + if ( nCopyLen == 0 ) { dest.Init(); } - else - { - dest.AllocBuffer(nCopyLen); - memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(char)); + else { + if ( !dest.AllocBuffer(nCopyLen) ) { + // allocation failure handled by caller + return FALSE; + } + memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(wxChar)); } + return TRUE; } // extract string of length nCount starting at nFirst -// default value of nCount is 0 and means "till the end" wxString wxString::Mid(size_t nFirst, size_t nCount) const { + wxStringData *pData = GetStringData(); + size_t nLen = pData->nDataLength; + + // default value of nCount is wxSTRING_MAXLEN and means "till the end" + if ( nCount == wxSTRING_MAXLEN ) + { + nCount = nLen - nFirst; + } + // out-of-bounds requests return sensible things - if ( nCount == 0 ) - nCount = GetStringData()->nDataLength - nFirst; + if ( nFirst + nCount > nLen ) + { + nCount = nLen - nFirst; + } - if ( nFirst + nCount > (size_t)GetStringData()->nDataLength ) - nCount = GetStringData()->nDataLength - nFirst; - if ( nFirst > (size_t)GetStringData()->nDataLength ) + if ( nFirst > nLen ) + { + // AllocCopy() will return empty string nCount = 0; + } wxString dest; - AllocCopy(dest, nCount, nFirst); + if ( !AllocCopy(dest, nCount, nFirst) ) { + wxFAIL_MSG( _T("out of memory in wxString::Mid") ); + } + return dest; } +// check that the tring starts with prefix and return the rest of the string +// in the provided pointer if it is not NULL, otherwise return FALSE +bool wxString::StartsWith(const wxChar *prefix, wxString *rest) const +{ + wxASSERT_MSG( prefix, _T("invalid parameter in wxString::StartsWith") ); + + // first check if the beginning of the string matches the prefix: note + // that we don't have to check that we don't run out of this string as + // when we reach the terminating NUL, either prefix string ends too (and + // then it's ok) or we break out of the loop because there is no match + const wxChar *p = c_str(); + while ( *prefix ) + { + if ( *prefix++ != *p++ ) + { + // no match + return FALSE; + } + } + + if ( rest ) + { + // put the rest of the string into provided pointer + *rest = p; + } + + return TRUE; +} + // extract nCount last (rightmost) characters wxString wxString::Right(size_t nCount) const { @@ -556,17 +876,19 @@ wxString wxString::Right(size_t nCount) const nCount = GetStringData()->nDataLength; wxString dest; - AllocCopy(dest, nCount, GetStringData()->nDataLength - nCount); + if ( !AllocCopy(dest, nCount, GetStringData()->nDataLength - nCount) ) { + wxFAIL_MSG( _T("out of memory in wxString::Right") ); + } return dest; } // get all characters after the last occurence of ch // (returns the whole string if ch not found) -wxString wxString::Right(char ch) const +wxString wxString::AfterLast(wxChar ch) const { wxString str; int iPos = Find(ch, TRUE); - if ( iPos == NOT_FOUND ) + if ( iPos == wxNOT_FOUND ) str = *this; else str = c_str() + iPos + 1; @@ -581,16 +903,18 @@ wxString wxString::Left(size_t nCount) const nCount = GetStringData()->nDataLength; wxString dest; - AllocCopy(dest, nCount, 0); + if ( !AllocCopy(dest, nCount, 0) ) { + wxFAIL_MSG( _T("out of memory in wxString::Left") ); + } return dest; } // get all characters before the first occurence of ch // (returns the whole string if ch not found) -wxString wxString::Left(char ch) const +wxString wxString::BeforeFirst(wxChar ch) const { wxString str; - for ( const char *pc = m_pchData; *pc != '\0' && *pc != ch; pc++ ) + for ( const wxChar *pc = m_pchData; *pc != wxT('\0') && *pc != ch; pc++ ) str += *pc; return str; @@ -598,11 +922,11 @@ wxString wxString::Left(char ch) const /// get all characters before the last occurence of ch /// (returns empty string if ch not found) -wxString wxString::Before(char ch) const +wxString wxString::BeforeLast(wxChar ch) const { wxString str; int iPos = Find(ch, TRUE); - if ( iPos != NOT_FOUND && iPos != 0 ) + if ( iPos != wxNOT_FOUND && iPos != 0 ) str = wxString(c_str(), iPos); return str; @@ -610,28 +934,28 @@ wxString wxString::Before(char ch) const /// get all characters after the first occurence of ch /// (returns empty string if ch not found) -wxString wxString::After(char ch) const +wxString wxString::AfterFirst(wxChar ch) const { wxString str; int iPos = Find(ch); - if ( iPos != NOT_FOUND ) + if ( iPos != wxNOT_FOUND ) str = c_str() + iPos + 1; return str; } // replace first (or all) occurences of some substring with another one -uint wxString::Replace(const char *szOld, const char *szNew, bool bReplaceAll) +size_t wxString::Replace(const wxChar *szOld, const wxChar *szNew, bool bReplaceAll) { - uint uiCount = 0; // count of replacements made + size_t uiCount = 0; // count of replacements made - uint uiOldLen = Strlen(szOld); + size_t uiOldLen = wxStrlen(szOld); wxString strTemp; - const char *pCurrent = m_pchData; - const char *pSubstr; - while ( *pCurrent != '\0' ) { - pSubstr = strstr(pCurrent, szOld); + const wxChar *pCurrent = m_pchData; + const wxChar *pSubstr; + while ( *pCurrent != wxT('\0') ) { + pSubstr = wxStrstr(pCurrent, szOld); if ( pSubstr == NULL ) { // strTemp is unused if no replacements were made, so avoid the copy if ( uiCount == 0 ) @@ -642,7 +966,10 @@ uint wxString::Replace(const char *szOld, const char *szNew, bool bReplaceAll) } else { // take chars before match - strTemp.ConcatSelf(pSubstr - pCurrent, pCurrent); + if ( !strTemp.ConcatSelf(pSubstr - pCurrent, pCurrent) ) { + wxFAIL_MSG( _T("out of memory in wxString::Replace") ); + return 0; + } strTemp += szNew; pCurrent = pSubstr + uiOldLen; // restart after match @@ -664,38 +991,36 @@ uint wxString::Replace(const char *szOld, const char *szNew, bool bReplaceAll) bool wxString::IsAscii() const { - const char *s = (const char*) *this; + const wxChar *s = (const wxChar*) *this; while(*s){ if(!isascii(*s)) return(FALSE); s++; } return(TRUE); } - + bool wxString::IsWord() const { - const char *s = (const char*) *this; + const wxChar *s = (const wxChar*) *this; while(*s){ - if(!isalpha(*s)) return(FALSE); + if(!wxIsalpha(*s)) return(FALSE); s++; } return(TRUE); } - + bool wxString::IsNumber() const { - const char *s = (const char*) *this; + const wxChar *s = (const wxChar*) *this; + if (wxStrlen(s)) + if ((s[0] == '-') || (s[0] == '+')) s++; while(*s){ - if(!isdigit(*s)) return(FALSE); + if(!wxIsdigit(*s)) return(FALSE); s++; } return(TRUE); } -// kludge: we don't have declaraton of wxStringData here, so we add offsets -// manually to get to the "length" field of wxStringData structure -bool wxString::IsEmpty() const { return Len() == 0; } - wxString wxString::Strip(stripType w) const { wxString s = *this; @@ -704,53 +1029,32 @@ wxString wxString::Strip(stripType w) const return s; } -/// case-insensitive strcmp() (platform independent) -int Stricmp(const char *psz1, const char *psz2) -{ -#if defined(_MSC_VER) - return _stricmp(psz1, psz2); -#elif defined(__BORLANDC__) - return stricmp(psz1, psz2); -#elif defined(__UNIX__) || defined(__GNUWIN32__) - return strcasecmp(psz1, psz2); -#else - // almost all compilers/libraries provide this function (unfortunately under - // different names), that's why we don't implement our own which will surely - // be more efficient than this code (uncomment to use): - /* - register char c1, c2; - do { - c1 = tolower(*psz1++); - c2 = tolower(*psz2++); - } while ( c1 && (c1 == c2) ); - - return c1 - c2; - */ - - #error "Please define string case-insensitive compare for your OS/compiler" -#endif // OS/compiler -} - // --------------------------------------------------------------------------- // case conversion // --------------------------------------------------------------------------- wxString& wxString::MakeUpper() { - CopyBeforeWrite(); + if ( !CopyBeforeWrite() ) { + wxFAIL_MSG( _T("out of memory in wxString::MakeUpper") ); + return *this; + } - for ( char *p = m_pchData; *p; p++ ) - *p = (char)toupper(*p); + for ( wxChar *p = m_pchData; *p; p++ ) + *p = (wxChar)wxToupper(*p); return *this; } wxString& wxString::MakeLower() { - CopyBeforeWrite(); - - for ( char *p = m_pchData; *p; p++ ) - *p = (char)tolower(*p); + if ( !CopyBeforeWrite() ) { + wxFAIL_MSG( _T("out of memory in wxString::MakeLower") ); + return *this; + } + + for ( wxChar *p = m_pchData; *p; p++ ) + *p = (wxChar)wxTolower(*p); return *this; } @@ -759,40 +1063,61 @@ wxString& wxString::MakeLower() // trimming and padding // --------------------------------------------------------------------------- +// some compilers (VC++ 6.0 not to name them) return TRUE for a call to +// isspace('ê') in the C locale which seems to be broken to me, but we have to +// live with this by checking that the character is a 7 bit one - even if this +// may fail to detect some spaces (I don't know if Unicode doesn't have +// space-like symbols somewhere except in the first 128 chars), it is arguably +// still better than trimming away accented letters +inline int wxSafeIsspace(wxChar ch) { return (ch < 127) && wxIsspace(ch); } + // trims spaces (in the sense of isspace) from left or right side wxString& wxString::Trim(bool bFromRight) { - CopyBeforeWrite(); - - if ( bFromRight ) - { - // find last non-space character - char *psz = m_pchData + GetStringData()->nDataLength - 1; - while ( isspace(*psz) && (psz >= m_pchData) ) - psz--; - - // truncate at trailing space start - *++psz = '\0'; - GetStringData()->nDataLength = psz - m_pchData; - } - else + // first check if we're going to modify the string at all + if ( !IsEmpty() && + ( + (bFromRight && wxSafeIsspace(GetChar(Len() - 1))) || + (!bFromRight && wxSafeIsspace(GetChar(0u))) + ) + ) { - // find first non-space character - const char *psz = m_pchData; - while ( isspace(*psz) ) - psz++; - - // fix up data and length - int nDataLength = GetStringData()->nDataLength - (psz - m_pchData); - memmove(m_pchData, psz, (nDataLength + 1)*sizeof(char)); - GetStringData()->nDataLength = nDataLength; + // ok, there is at least one space to trim + if ( !CopyBeforeWrite() ) { + wxFAIL_MSG( _T("out of memory in wxString::Trim") ); + return *this; + } + + if ( bFromRight ) + { + // find last non-space character + wxChar *psz = m_pchData + GetStringData()->nDataLength - 1; + while ( wxSafeIsspace(*psz) && (psz >= m_pchData) ) + psz--; + + // truncate at trailing space start + *++psz = wxT('\0'); + GetStringData()->nDataLength = psz - m_pchData; + } + else + { + // find first non-space character + const wxChar *psz = m_pchData; + while ( wxSafeIsspace(*psz) ) + psz++; + + // fix up data and length + int nDataLength = GetStringData()->nDataLength - (psz - (const wxChar*) m_pchData); + memmove(m_pchData, psz, (nDataLength + 1)*sizeof(wxChar)); + GetStringData()->nDataLength = nDataLength; + } } return *this; } // adds nCount characters chPad to the string from either side -wxString& wxString::Pad(size_t nCount, char chPad, bool bFromRight) +wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight) { wxString s(chPad, nCount); @@ -810,36 +1135,112 @@ wxString& wxString::Pad(size_t nCount, char chPad, bool bFromRight) // truncate the string wxString& wxString::Truncate(size_t uiLen) { - *(m_pchData + uiLen) = '\0'; - GetStringData()->nDataLength = uiLen; + if ( uiLen < Len() ) { + if ( !CopyBeforeWrite() ) { + wxFAIL_MSG( _T("out of memory in wxString::Truncate") ); + return *this; + } + + *(m_pchData + uiLen) = wxT('\0'); + GetStringData()->nDataLength = uiLen; + } + //else: nothing to do, string is already short enough return *this; } // --------------------------------------------------------------------------- -// finding (return NOT_FOUND if not found and index otherwise) +// finding (return wxNOT_FOUND if not found and index otherwise) // --------------------------------------------------------------------------- // find a character -int wxString::Find(char ch, bool bFromEnd) const +int wxString::Find(wxChar ch, bool bFromEnd) const { - const char *psz = bFromEnd ? strrchr(m_pchData, ch) : strchr(m_pchData, ch); + const wxChar *psz = bFromEnd ? wxStrrchr(m_pchData, ch) : wxStrchr(m_pchData, ch); - return (psz == NULL) ? NOT_FOUND : psz - m_pchData; + return (psz == NULL) ? wxNOT_FOUND : psz - (const wxChar*) m_pchData; } // find a sub-string (like strstr) -int wxString::Find(const char *pszSub) const +int wxString::Find(const wxChar *pszSub) const +{ + const wxChar *psz = wxStrstr(m_pchData, pszSub); + + return (psz == NULL) ? wxNOT_FOUND : psz - (const wxChar*) m_pchData; +} + +// ---------------------------------------------------------------------------- +// conversion to numbers +// ---------------------------------------------------------------------------- + +bool wxString::ToLong(long *val, int base) const +{ + wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToLong") ); + wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") ); + + const wxChar *start = c_str(); + wxChar *end; + *val = wxStrtol(start, &end, base); + + // return TRUE only if scan was stopped by the terminating NUL and if the + // string was not empty to start with + return !*end && (end != start); +} + +bool wxString::ToULong(unsigned long *val, int base) const { - const char *psz = strstr(m_pchData, pszSub); + wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToULong") ); + wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") ); - return (psz == NULL) ? NOT_FOUND : psz - m_pchData; + const wxChar *start = c_str(); + wxChar *end; + *val = wxStrtoul(start, &end, base); + + // return TRUE only if scan was stopped by the terminating NUL and if the + // string was not empty to start with + return !*end && (end != start); +} + +bool wxString::ToDouble(double *val) const +{ + wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToDouble") ); + + const wxChar *start = c_str(); + wxChar *end; + *val = wxStrtod(start, &end); + + // return TRUE only if scan was stopped by the terminating NUL and if the + // string was not empty to start with + return !*end && (end != start); } // --------------------------------------------------------------------------- // formatted output // --------------------------------------------------------------------------- -int wxString::Printf(const char *pszFormat, ...) + +/* static */ +wxString wxString::Format(const wxChar *pszFormat, ...) +{ + va_list argptr; + va_start(argptr, pszFormat); + + wxString s; + s.PrintfV(pszFormat, argptr); + + va_end(argptr); + + return s; +} + +/* static */ +wxString wxString::FormatV(const wxChar *pszFormat, va_list argptr) +{ + wxString s; + s.PrintfV(pszFormat, argptr); + return s; +} + +int wxString::Printf(const wxChar *pszFormat, ...) { va_list argptr; va_start(argptr, pszFormat); @@ -851,103 +1252,435 @@ int wxString::Printf(const char *pszFormat, ...) return iLen; } -int wxString::PrintfV(const char* pszFormat, va_list argptr) +int wxString::PrintfV(const wxChar* pszFormat, va_list argptr) { - static char s_szScratch[1024]; + int size = 1024; + for ( ;; ) + { + wxChar *buf = GetWriteBuf(size + 1); + if ( !buf ) + { + // out of memory + return -1; + } - int iLen = vsprintf(s_szScratch, pszFormat, argptr); - AllocBeforeWrite(iLen); - strcpy(m_pchData, s_szScratch); + int len = wxVsnprintf(buf, size, pszFormat, argptr); - return iLen; + // some implementations of vsnprintf() don't NUL terminate the string + // if there is not enough space for it so always do it manually + buf[size] = _T('\0'); + + UngetWriteBuf(); + + if ( len >= 0 ) + { + // ok, there was enough space + break; + } + + // still not enough, double it again + size *= 2; + } + + // we could have overshot + Shrink(); + + return Len(); +} + +// ---------------------------------------------------------------------------- +// misc other operations +// ---------------------------------------------------------------------------- + +// returns TRUE if the string matches the pattern which may contain '*' and +// '?' metacharacters (as usual, '?' matches any character and '*' any number +// of them) +bool wxString::Matches(const wxChar *pszMask) const +{ + // I disable this code as it doesn't seem to be faster (in fact, it seems + // to be much slower) than the old, hand-written code below and using it + // here requires always linking with libregex even if the user code doesn't + // use it +#if 0 // wxUSE_REGEX + // first translate the shell-like mask into a regex + wxString pattern; + pattern.reserve(wxStrlen(pszMask)); + + pattern += _T('^'); + while ( *pszMask ) + { + switch ( *pszMask ) + { + case _T('?'): + pattern += _T('.'); + break; + + case _T('*'): + pattern += _T(".*"); + break; + + case _T('^'): + case _T('.'): + case _T('$'): + case _T('('): + case _T(')'): + case _T('|'): + case _T('+'): + case _T('\\'): + // these characters are special in a RE, quote them + // (however note that we don't quote '[' and ']' to allow + // using them for Unix shell like matching) + pattern += _T('\\'); + // fall through + + default: + pattern += *pszMask; + } + + pszMask++; + } + pattern += _T('$'); + + // and now use it + return wxRegEx(pattern, wxRE_NOSUB | wxRE_EXTENDED).Matches(c_str()); +#else // !wxUSE_REGEX + // TODO: this is, of course, awfully inefficient... + + // the char currently being checked + const wxChar *pszTxt = c_str(); + + // the last location where '*' matched + const wxChar *pszLastStarInText = NULL; + const wxChar *pszLastStarInMask = NULL; + +match: + for ( ; *pszMask != wxT('\0'); pszMask++, pszTxt++ ) { + switch ( *pszMask ) { + case wxT('?'): + if ( *pszTxt == wxT('\0') ) + return FALSE; + + // pszTxt and pszMask will be incremented in the loop statement + + break; + + case wxT('*'): + { + // remember where we started to be able to backtrack later + pszLastStarInText = pszTxt; + pszLastStarInMask = pszMask; + + // ignore special chars immediately following this one + // (should this be an error?) + while ( *pszMask == wxT('*') || *pszMask == wxT('?') ) + pszMask++; + + // if there is nothing more, match + if ( *pszMask == wxT('\0') ) + return TRUE; + + // are there any other metacharacters in the mask? + size_t uiLenMask; + const wxChar *pEndMask = wxStrpbrk(pszMask, wxT("*?")); + + if ( pEndMask != NULL ) { + // we have to match the string between two metachars + uiLenMask = pEndMask - pszMask; + } + else { + // we have to match the remainder of the string + uiLenMask = wxStrlen(pszMask); + } + + wxString strToMatch(pszMask, uiLenMask); + const wxChar* pMatch = wxStrstr(pszTxt, strToMatch); + if ( pMatch == NULL ) + return FALSE; + + // -1 to compensate "++" in the loop + pszTxt = pMatch + uiLenMask - 1; + pszMask += uiLenMask - 1; + } + break; + + default: + if ( *pszMask != *pszTxt ) + return FALSE; + break; + } + } + + // match only if nothing left + if ( *pszTxt == wxT('\0') ) + return TRUE; + + // if we failed to match, backtrack if we can + if ( pszLastStarInText ) { + pszTxt = pszLastStarInText + 1; + pszMask = pszLastStarInMask; + + pszLastStarInText = NULL; + + // don't bother resetting pszLastStarInMask, it's unnecessary + + goto match; + } + + return FALSE; +#endif // wxUSE_REGEX/!wxUSE_REGEX +} + +// Count the number of chars +int wxString::Freq(wxChar ch) const +{ + int count = 0; + int len = Len(); + for (int i = 0; i < len; i++) + { + if (GetChar(i) == ch) + count ++; + } + return count; } +// convert to upper case, return the copy of the string +wxString wxString::Upper() const +{ wxString s(*this); return s.MakeUpper(); } + +// convert to lower case, return the copy of the string +wxString wxString::Lower() const { wxString s(*this); return s.MakeLower(); } + +int wxString::sprintf(const wxChar *pszFormat, ...) + { + va_list argptr; + va_start(argptr, pszFormat); + int iLen = PrintfV(pszFormat, argptr); + va_end(argptr); + return iLen; + } + // --------------------------------------------------------------------------- // standard C++ library string functions // --------------------------------------------------------------------------- -#ifdef STD_STRING_COMPATIBILITY + +#ifdef wxSTD_STRING_COMPATIBILITY + +void wxString::resize(size_t nSize, wxChar ch) +{ + size_t len = length(); + + if ( nSize < len ) + { + Truncate(nSize); + } + else if ( nSize > len ) + { + *this += wxString(ch, nSize - len); + } + //else: we have exactly the specified length, nothing to do +} + +void wxString::swap(wxString& str) +{ + // this is slightly less efficient than fiddling with m_pchData directly, + // but it is still quite efficient as we don't copy the string here because + // ref count always stays positive + wxString tmp = str; + str = *this; + *this = tmp; +} wxString& wxString::insert(size_t nPos, const wxString& str) { + wxASSERT( str.GetStringData()->IsValid() ); wxASSERT( nPos <= Len() ); - wxString strTmp; - char *pc = strTmp.GetWriteBuf(Len() + str.Len() + 1); - strncpy(pc, c_str(), nPos); - strcpy(pc + nPos, str); - strcpy(pc + nPos + str.Len(), c_str() + nPos); - *this = strTmp; - - return *this; + if ( !str.IsEmpty() ) { + wxString strTmp; + wxChar *pc = strTmp.GetWriteBuf(Len() + str.Len()); + wxStrncpy(pc, c_str(), nPos); + wxStrcpy(pc + nPos, str); + wxStrcpy(pc + nPos + str.Len(), c_str() + nPos); + strTmp.UngetWriteBuf(); + *this = strTmp; + } + + return *this; } size_t wxString::find(const wxString& str, size_t nStart) const { + wxASSERT( str.GetStringData()->IsValid() ); wxASSERT( nStart <= Len() ); - const char *p = strstr(c_str() + nStart, str); - + const wxChar *p = wxStrstr(c_str() + nStart, str); + return p == NULL ? npos : p - c_str(); } // VC++ 1.5 can't cope with the default argument in the header. -#if ! (defined(_MSC_VER) && !defined(__WIN32__)) -size_t wxString::find(const char* sz, size_t nStart, size_t n) const +#if !defined(__VISUALC__) || defined(__WIN32__) +size_t wxString::find(const wxChar* sz, size_t nStart, size_t n) const { - return find(wxString(sz, n == npos ? 0 : n), nStart); + return find(wxString(sz, n), nStart); } -#endif - -size_t wxString::find(char ch, size_t nStart) const +#endif // VC++ 1.5 + +// Gives a duplicate symbol (presumably a case-insensitivity problem) +#if !defined(__BORLANDC__) +size_t wxString::find(wxChar ch, size_t nStart) const { wxASSERT( nStart <= Len() ); - const char *p = strchr(c_str() + nStart, ch); - + const wxChar *p = wxStrchr(c_str() + nStart, ch); + return p == NULL ? npos : p - c_str(); } +#endif size_t wxString::rfind(const wxString& str, size_t nStart) const { - wxASSERT( nStart <= Len() ); + wxASSERT( str.GetStringData()->IsValid() ); + wxASSERT( nStart == npos || nStart <= Len() ); - // # could be quicker than that - const char *p = c_str() + (nStart == npos ? Len() : nStart); + // TODO could be made much quicker than that + const wxChar *p = c_str() + (nStart == npos ? Len() : nStart); while ( p >= c_str() + str.Len() ) { - if ( strncmp(p - str.Len(), str, str.Len()) == 0 ) + if ( wxStrncmp(p - str.Len(), str, str.Len()) == 0 ) return p - str.Len() - c_str(); p--; } - + return npos; } - + // VC++ 1.5 can't cope with the default argument in the header. -#if ! (defined(_MSC_VER) && !defined(__WIN32__)) -size_t wxString::rfind(const char* sz, size_t nStart, size_t n) const +#if !defined(__VISUALC__) || defined(__WIN32__) +size_t wxString::rfind(const wxChar* sz, size_t nStart, size_t n) const { - return rfind(wxString(sz, n == npos ? 0 : n), nStart); + return rfind(wxString(sz, n == npos ? wxSTRING_MAXLEN : n), nStart); } -size_t wxString::rfind(char ch, size_t nStart) const +size_t wxString::rfind(wxChar ch, size_t nStart) const { - wxASSERT( nStart <= Len() ); + if ( nStart == npos ) + { + nStart = Len(); + } + else + { + wxASSERT( nStart <= Len() ); + } - const char *p = strrchr(c_str() + nStart, ch); - - return p == NULL ? npos : p - c_str(); + const wxChar *p = wxStrrchr(c_str(), ch); + + if ( p == NULL ) + return npos; + + size_t result = p - c_str(); + return ( result > nStart ) ? npos : result; +} +#endif // VC++ 1.5 + +size_t wxString::find_first_of(const wxChar* sz, size_t nStart) const +{ + const wxChar *start = c_str() + nStart; + const wxChar *firstOf = wxStrpbrk(start, sz); + if ( firstOf ) + return firstOf - c_str(); + else + return npos; +} + +size_t wxString::find_last_of(const wxChar* sz, size_t nStart) const +{ + if ( nStart == npos ) + { + nStart = Len(); + } + else + { + wxASSERT( nStart <= Len() ); + } + + for ( const wxChar *p = c_str() + length() - 1; p >= c_str(); p-- ) + { + if ( wxStrchr(sz, *p) ) + return p - c_str(); + } + + return npos; +} + +size_t wxString::find_first_not_of(const wxChar* sz, size_t nStart) const +{ + if ( nStart == npos ) + { + nStart = Len(); + } + else + { + wxASSERT( nStart <= Len() ); + } + + size_t nAccept = wxStrspn(c_str() + nStart, sz); + if ( nAccept >= length() - nStart ) + return npos; + else + return nAccept; } -#endif -wxString wxString::substr(size_t nStart, size_t nLen) const +size_t wxString::find_first_not_of(wxChar ch, size_t nStart) const { - // npos means 'take all' - if ( nLen == npos ) - nLen = 0; + wxASSERT( nStart <= Len() ); - wxASSERT( nStart + nLen <= Len() ); + for ( const wxChar *p = c_str() + nStart; *p; p++ ) + { + if ( *p != ch ) + return p - c_str(); + } - return wxString(c_str() + nStart, nLen == npos ? 0 : nLen); + return npos; +} + +size_t wxString::find_last_not_of(const wxChar* sz, size_t nStart) const +{ + if ( nStart == npos ) + { + nStart = Len(); + } + else + { + wxASSERT( nStart <= Len() ); + } + + for ( const wxChar *p = c_str() + nStart - 1; p >= c_str(); p-- ) + { + if ( !wxStrchr(sz, *p) ) + return p - c_str(); + } + + return npos; +} + +size_t wxString::find_last_not_of(wxChar ch, size_t nStart) const +{ + if ( nStart == npos ) + { + nStart = Len(); + } + else + { + wxASSERT( nStart <= Len() ); + } + + for ( const wxChar *p = c_str() + nStart - 1; p >= c_str(); p-- ) + { + if ( *p != ch ) + return p - c_str(); + } + + return npos; } wxString& wxString::erase(size_t nStart, size_t nLen) @@ -963,33 +1696,35 @@ wxString& wxString::erase(size_t nStart, size_t nLen) return *this; } -wxString& wxString::replace(size_t nStart, size_t nLen, const char *sz) +wxString& wxString::replace(size_t nStart, size_t nLen, const wxChar *sz) { - wxASSERT( nStart + nLen <= Strlen(sz) ); + wxASSERT_MSG( nStart + nLen <= Len(), + _T("index out of bounds in wxString::replace") ); wxString strTmp; + strTmp.Alloc(Len()); // micro optimisation to avoid multiple mem allocs + if ( nStart != 0 ) strTmp.append(c_str(), nStart); - strTmp += sz; - strTmp.append(c_str() + nStart + nLen); - + strTmp << sz << c_str() + nStart + nLen; + *this = strTmp; return *this; } -wxString& wxString::replace(size_t nStart, size_t nLen, size_t nCount, char ch) +wxString& wxString::replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch) { return replace(nStart, nLen, wxString(ch, nCount)); } -wxString& wxString::replace(size_t nStart, size_t nLen, - const wxString& str, size_t nStart2, size_t nLen2) +wxString& wxString::replace(size_t nStart, size_t nLen, + const wxString& str, size_t nStart2, size_t nLen2) { return replace(nStart, nLen, str.substr(nStart2, nLen2)); } -wxString& wxString::replace(size_t nStart, size_t nLen, - const char* sz, size_t nCount) +wxString& wxString::replace(size_t nStart, size_t nLen, + const wxChar* sz, size_t nCount) { return replace(nStart, nLen, wxString(sz, nCount)); } @@ -1000,79 +1735,90 @@ wxString& wxString::replace(size_t nStart, size_t nLen, // ArrayString // ============================================================================ -// size increment = max(50% of current size, ARRAY_MAXSIZE_INCREMENT) +// size increment = min(50% of current size, ARRAY_MAXSIZE_INCREMENT) #define ARRAY_MAXSIZE_INCREMENT 4096 + #ifndef ARRAY_DEFAULT_INITIAL_SIZE // also defined in dynarray.h - #define ARRAY_DEFAULT_INITIAL_SIZE (16) +#define ARRAY_DEFAULT_INITIAL_SIZE (16) #endif #define STRING(p) ((wxString *)(&(p))) // ctor -wxArrayString::wxArrayString() +void wxArrayString::Init(bool autoSort) { m_nSize = m_nCount = 0; - m_pItems = NULL; + m_pItems = (wxChar **) NULL; + m_autoSort = autoSort; } // copy ctor wxArrayString::wxArrayString(const wxArrayString& src) { - m_nSize = src.m_nSize; - m_nCount = src.m_nCount; + Init(src.m_autoSort); - if ( m_nSize != 0 ) - m_pItems = new char *[m_nSize]; - else - m_pItems = NULL; - - if ( m_nCount != 0 ) - memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(char *)); + *this = src; } -// copy operator +// assignment operator wxArrayString& wxArrayString::operator=(const wxArrayString& src) { - DELETEA(m_pItems); + if ( m_nSize > 0 ) + Clear(); - m_nSize = src.m_nSize; - m_nCount = src.m_nCount; - - if ( m_nSize != 0 ) - m_pItems = new char *[m_nSize]; - else - m_pItems = NULL; + Copy(src); - if ( m_nCount != 0 ) - memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(char *)); + m_autoSort = src.m_autoSort; return *this; } +void wxArrayString::Copy(const wxArrayString& src) +{ + if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE ) + Alloc(src.m_nCount); + + for ( size_t n = 0; n < src.m_nCount; n++ ) + Add(src[n]); +} + // grow the array -void wxArrayString::Grow() +void wxArrayString::Grow(size_t nIncrement) { // only do it if no more place - if( m_nCount == m_nSize ) { - if( m_nSize == 0 ) { + if ( (m_nSize - m_nCount) < nIncrement ) { + // if ARRAY_DEFAULT_INITIAL_SIZE were set to 0, the initially empty would + // be never resized! + #if ARRAY_DEFAULT_INITIAL_SIZE == 0 + #error "ARRAY_DEFAULT_INITIAL_SIZE must be > 0!" + #endif + + if ( m_nSize == 0 ) { // was empty, alloc some memory m_nSize = ARRAY_DEFAULT_INITIAL_SIZE; - m_pItems = new char *[m_nSize]; + if (m_nSize < nIncrement) + m_nSize = nIncrement; + m_pItems = new wxChar *[m_nSize]; } else { + // otherwise when it's called for the first time, nIncrement would be 0 + // and the array would never be expanded // add 50% but not too much - size_t nIncrement = m_nSize >> 1; - if ( nIncrement > ARRAY_MAXSIZE_INCREMENT ) - nIncrement = ARRAY_MAXSIZE_INCREMENT; + size_t ndefIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE + ? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1; + if ( ndefIncrement > ARRAY_MAXSIZE_INCREMENT ) + ndefIncrement = ARRAY_MAXSIZE_INCREMENT; + if ( nIncrement < ndefIncrement ) + nIncrement = ndefIncrement; m_nSize += nIncrement; - char **pNew = new char *[m_nSize]; + wxChar **pNew = new wxChar *[m_nSize]; // copy data to new location - memcpy(pNew, m_pItems, m_nCount*sizeof(char *)); + memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *)); // delete old memory (but do not release the strings!) - DELETEA(m_pItems); + wxDELETEA(m_pItems); m_pItems = pNew; } @@ -1099,11 +1845,10 @@ void wxArrayString::Clear() { Free(); - m_nSize = + m_nSize = m_nCount = 0; - DELETEA(m_pItems); - m_pItems = NULL; + wxDELETEA(m_pItems); } // dtor @@ -1111,105 +1856,306 @@ wxArrayString::~wxArrayString() { Free(); - DELETEA(m_pItems); + wxDELETEA(m_pItems); } // pre-allocates memory (frees the previous data!) void wxArrayString::Alloc(size_t nSize) { - wxASSERT( nSize > 0 ); - // only if old buffer was not big enough if ( nSize > m_nSize ) { Free(); - DELETEA(m_pItems); - m_pItems = new char *[nSize]; + wxDELETEA(m_pItems); + m_pItems = new wxChar *[nSize]; m_nSize = nSize; } m_nCount = 0; } -// searches the array for an item (forward or backwards) +// minimizes the memory usage by freeing unused memory +void wxArrayString::Shrink() +{ + // only do it if we have some memory to free + if( m_nCount < m_nSize ) { + // allocates exactly as much memory as we need + wxChar **pNew = new wxChar *[m_nCount]; -// Robert Roebling (changed to bool from bool) + // copy data to new location + memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *)); + delete [] m_pItems; + m_pItems = pNew; + } +} -int wxArrayString::Index(const char *sz, bool bCase, bool bFromEnd) const +// return a wxString[] as required for some control ctors. +wxString* wxArrayString::GetStringArray() const { - if ( bFromEnd ) { - if ( m_nCount > 0 ) { - uint ui = m_nCount; - do { - if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) ) - return ui; - } - while ( ui != 0 ); + wxString *array = 0; + + if( m_nCount > 0 ) + { + array = new wxString[m_nCount]; + for( size_t i = 0; i < m_nCount; i++ ) + array[i] = m_pItems[i]; + } + + return array; +} + +// searches the array for an item (forward or backwards) +int wxArrayString::Index(const wxChar *sz, bool bCase, bool bFromEnd) const +{ + if ( m_autoSort ) { + // use binary search in the sorted array + wxASSERT_MSG( bCase && !bFromEnd, + wxT("search parameters ignored for auto sorted array") ); + + size_t i, + lo = 0, + hi = m_nCount; + int res; + while ( lo < hi ) { + i = (lo + hi)/2; + + res = wxStrcmp(sz, m_pItems[i]); + if ( res < 0 ) + hi = i; + else if ( res > 0 ) + lo = i + 1; + else + return i; } + + return wxNOT_FOUND; } else { - for( uint ui = 0; ui < m_nCount; ui++ ) { - if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) ) - return ui; + // use linear search in unsorted array + if ( bFromEnd ) { + if ( m_nCount > 0 ) { + size_t ui = m_nCount; + do { + if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) ) + return ui; + } + while ( ui != 0 ); + } + } + else { + for( size_t ui = 0; ui < m_nCount; ui++ ) { + if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) ) + return ui; + } } } - return NOT_FOUND; + return wxNOT_FOUND; } // add item at the end -void wxArrayString::Add(const wxString& src) -{ - Grow(); +size_t wxArrayString::Add(const wxString& str, size_t nInsert) +{ + if ( m_autoSort ) { + // insert the string at the correct position to keep the array sorted + size_t i, + lo = 0, + hi = m_nCount; + int res; + while ( lo < hi ) { + i = (lo + hi)/2; + + res = wxStrcmp(str, m_pItems[i]); + if ( res < 0 ) + hi = i; + else if ( res > 0 ) + lo = i + 1; + else { + lo = hi = i; + break; + } + } + + wxASSERT_MSG( lo == hi, wxT("binary search broken") ); + + Insert(str, lo, nInsert); + + return (size_t)lo; + } + else { + wxASSERT( str.GetStringData()->IsValid() ); + + Grow(nInsert); - // the string data must not be deleted! - src.GetStringData()->Lock(); - m_pItems[m_nCount++] = (char *)src.c_str(); + for (size_t i = 0; i < nInsert; i++) + { + // the string data must not be deleted! + str.GetStringData()->Lock(); + + // just append + m_pItems[m_nCount + i] = (wxChar *)str.c_str(); // const_cast + } + size_t ret = m_nCount; + m_nCount += nInsert; + return ret; + } } // add item at the given position -void wxArrayString::Insert(const wxString& src, size_t nIndex) +void wxArrayString::Insert(const wxString& str, size_t nIndex, size_t nInsert) { - wxCHECK_RET( nIndex <= m_nCount, "bad index in wxArrayString::Insert" ); + wxASSERT( str.GetStringData()->IsValid() ); - Grow(); + wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArrayString::Insert") ); + wxCHECK_RET( m_nCount <= m_nCount + nInsert, + wxT("array size overflow in wxArrayString::Insert") ); - memmove(&m_pItems[nIndex + 1], &m_pItems[nIndex], - (m_nCount - nIndex)*sizeof(char *)); + Grow(nInsert); - src.GetStringData()->Lock(); - m_pItems[nIndex] = (char *)src.c_str(); + memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex], + (m_nCount - nIndex)*sizeof(wxChar *)); - m_nCount++; + for (size_t i = 0; i < nInsert; i++) + { + str.GetStringData()->Lock(); + m_pItems[nIndex + i] = (wxChar *)str.c_str(); + } + m_nCount += nInsert; +} + +// expand the array +void wxArrayString::SetCount(size_t count) +{ + Alloc(count); + + wxString s; + while ( m_nCount < count ) + m_pItems[m_nCount++] = (wxChar *)s.c_str(); } // removes item from array (by index) -void wxArrayString::Remove(size_t nIndex) +void wxArrayString::Remove(size_t nIndex, size_t nRemove) { - wxCHECK_RET( nIndex <= m_nCount, "bad index in wxArrayString::Remove" ); + wxCHECK_RET( nIndex < m_nCount, wxT("bad index in wxArrayString::Remove") ); + wxCHECK_RET( nIndex + nRemove <= m_nCount, + wxT("removing too many elements in wxArrayString::Remove") ); // release our lock - Item(nIndex).GetStringData()->Unlock(); + for (size_t i = 0; i < nRemove; i++) + Item(nIndex + i).GetStringData()->Unlock(); - memmove(&m_pItems[nIndex], &m_pItems[nIndex + 1], - (m_nCount - nIndex - 1)*sizeof(char *)); - m_nCount--; + memmove(&m_pItems[nIndex], &m_pItems[nIndex + nRemove], + (m_nCount - nIndex - nRemove)*sizeof(wxChar *)); + m_nCount -= nRemove; } // removes item from array (by value) -void wxArrayString::Remove(const char *sz) +void wxArrayString::Remove(const wxChar *sz) { int iIndex = Index(sz); - wxCHECK_RET( iIndex != NOT_FOUND, - "removing inexistent element in wxArrayString::Remove" ); + wxCHECK_RET( iIndex != wxNOT_FOUND, + wxT("removing inexistent element in wxArrayString::Remove") ); - Remove((size_t)iIndex); + Remove(iIndex); +} + +// ---------------------------------------------------------------------------- +// sorting +// ---------------------------------------------------------------------------- + +// we can only sort one array at a time with the quick-sort based +// implementation +#if wxUSE_THREADS + // need a critical section to protect access to gs_compareFunction and + // gs_sortAscending variables + static wxCriticalSection *gs_critsectStringSort = NULL; + + // call this before the value of the global sort vars is changed/after + // you're finished with them + #define START_SORT() wxASSERT( !gs_critsectStringSort ); \ + gs_critsectStringSort = new wxCriticalSection; \ + gs_critsectStringSort->Enter() + #define END_SORT() gs_critsectStringSort->Leave(); \ + delete gs_critsectStringSort; \ + gs_critsectStringSort = NULL +#else // !threads + #define START_SORT() + #define END_SORT() +#endif // wxUSE_THREADS + +// function to use for string comparaison +static wxArrayString::CompareFunction gs_compareFunction = NULL; + +// if we don't use the compare function, this flag tells us if we sort the +// array in ascending or descending order +static bool gs_sortAscending = TRUE; + +// function which is called by quick sort +extern "C" int wxC_CALLING_CONV // LINKAGEMODE +wxStringCompareFunction(const void *first, const void *second) +{ + wxString *strFirst = (wxString *)first; + wxString *strSecond = (wxString *)second; + + if ( gs_compareFunction ) { + return gs_compareFunction(*strFirst, *strSecond); + } + else { + // maybe we should use wxStrcoll + int result = wxStrcmp(strFirst->c_str(), strSecond->c_str()); + + return gs_sortAscending ? result : -result; + } } // sort array elements using passed comparaison function +void wxArrayString::Sort(CompareFunction compareFunction) +{ + START_SORT(); + + wxASSERT( !gs_compareFunction ); // must have been reset to NULL + gs_compareFunction = compareFunction; + + DoSort(); + + // reset it to NULL so that Sort(bool) will work the next time + gs_compareFunction = NULL; + + END_SORT(); +} -void wxArrayString::Sort(bool bCase, bool bReverse) +void wxArrayString::Sort(bool reverseOrder) { - //@@@@ TO DO - //qsort(m_pItems, m_nCount, sizeof(char *), fCmp); + START_SORT(); + + wxASSERT( !gs_compareFunction ); // must have been reset to NULL + gs_sortAscending = !reverseOrder; + + DoSort(); + + END_SORT(); +} + +void wxArrayString::DoSort() +{ + wxCHECK_RET( !m_autoSort, wxT("can't use this method with sorted arrays") ); + + // just sort the pointers using qsort() - of course it only works because + // wxString() *is* a pointer to its data + qsort(m_pItems, m_nCount, sizeof(wxChar *), wxStringCompareFunction); } + +bool wxArrayString::operator==(const wxArrayString& a) const +{ + if ( m_nCount != a.m_nCount ) + return FALSE; + + for ( size_t n = 0; n < m_nCount; n++ ) + { + if ( Item(n) != a[n] ) + return FALSE; + } + + return TRUE; +} +