X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/607d9061788c0277705f9c9c16ca00a22b019918..6c41a418df66b66711eba536526a3085f690782e:/src/common/string.cpp diff --git a/src/common/string.cpp b/src/common/string.cpp index 6247bb0fab..54a87d7ba5 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 license ///////////////////////////////////////////////////////////////////////////// #ifdef __GNUG__ -#pragma implementation "string.h" + #pragma implementation "string.h" #endif /* @@ -28,80 +28,126 @@ #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" #endif #include #include #include +#ifdef __SALFORDC__ + #include +#endif + +#if wxUSE_WCSRTOMBS + #include // for wcsrtombs(), see comments where it's used +#endif // GNU + #ifdef WXSTRING_IS_WXOBJECT IMPLEMENT_DYNAMIC_CLASS(wxString, wxObject) #endif //WXSTRING_IS_WXOBJECT +// 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 +#ifdef wxSTD_STRING_COMPATIBILITY + const size_t wxString::npos = wxSTRING_MAXLEN; +#endif // wxSTD_STRING_COMPATIBILITY -// =========================================================================== -// static class data, special inlines -// =========================================================================== +// ---------------------------------------------------------------------------- +// 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; + char dummy; +} g_strEmpty = { {-1, 0, 0}, '\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 char WXDLLEXPORT *g_szNul = &g_strEmpty.dummy; + +// ---------------------------------------------------------------------------- +// conditional compilation +// ---------------------------------------------------------------------------- + +// we want to find out if the current platform supports vsnprintf()-like +// function: for Unix this is done with configure, for Windows we test the +// compiler explicitly. +#ifdef __WXMSW__ + #ifdef __VISUALC__ + #define wxVsprintf _vsnprintf + #endif +#else // !Windows + #ifdef HAVE_VSNPRINTF + #define wxVsprintf vsnprintf + #endif +#endif // Windows/!Windows + +#ifndef wxVsprintf + // in this case we'll use vsprintf() (which is ANSI and thus should be + // always available), but it's unsafe because it doesn't check for buffer + // size - so give a warning + #define wxVsprintf(buffer,len,format,argptr) vsprintf(buffer,format, argptr) + + #if defined(__VISUALC__) + #pragma message("Using sprintf() because no snprintf()-like function defined") + #elif defined(__GNUG__) && !defined(__UNIX__) + #warning "Using sprintf() because no snprintf()-like function defined" + #elif defined(__MWERKS__) + #warning "Using sprintf() because no snprintf()-like function defined" + #endif //compiler +#endif // no vsnprintf + +#ifdef _AIX + // AIX has vsnprintf, but there's no prototype in the system headers. + extern "C" int vsnprintf(char* str, size_t n, const char* format, va_list ap); +#endif -// =========================================================================== +// ---------------------------------------------------------------------------- // global functions -// =========================================================================== +// ---------------------------------------------------------------------------- -#ifdef STD_STRING_COMPATIBILITY +#ifdef wxSTD_STRING_COMPATIBILITY // 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)) +istream& operator>>(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 +156,42 @@ 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; } #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 char *sz) { m_sz = sz; m_nTotal = m_nCount = 0; } + ~Averager() + { printf("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 char *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,27 +200,6 @@ 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) { @@ -153,7 +207,7 @@ wxString::wxString(char ch, size_t nLength) if ( nLength > 0 ) { AllocBuffer(nLength); - + wxASSERT( sizeof(char) == 1 ); // can't use memset if not memset(m_pchData, ch, nLength); @@ -167,41 +221,30 @@ void wxString::InitWith(const char *psz, size_t nPos, size_t nLength) wxASSERT( nPos <= Strlen(psz) ); - if ( nLength == STRING_MAXLEN ) + if ( nLength == wxSTRING_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)); } } - -// 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, + InitWith((const char *)pStart, 0, (const char *)pEnd - (const char *)pStart); } @@ -211,7 +254,17 @@ wxString::wxString(const void *pStart, const void *pEnd) wxString::wxString(const wchar_t *pwz) { // first get necessary size - size_t nLen = wcstombs(NULL, pwz, 0); + + // NB: GNU libc5 wcstombs() is completely broken, don't use it (it doesn't + // honor the 3rd parameter, thus it will happily crash here). +#if wxUSE_WCSRTOMBS + // don't know if it's really needed (or if we can pass NULL), but better safe + // than quick + mbstate_t mbstate; + size_t nLen = wcsrtombs((char *) NULL, &pwz, 0, &mbstate); +#else // !GNU libc + size_t nLen = wcstombs((char *) NULL, pwz, 0); +#endif // GNU // empty? if ( nLen != 0 ) { @@ -233,33 +286,18 @@ void wxString::AllocBuffer(size_t nLen) wxASSERT( nLen > 0 ); // wxASSERT( nLen <= INT_MAX-1 ); // max size (enough room for 1 extra) + 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(char)); 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] = '\0'; } // must be called before changing this string @@ -269,11 +307,12 @@ void wxString::CopyBeforeWrite() 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; + AllocBuffer(nLen); + memcpy(m_pchData, pData->data(), nLen*sizeof(char)); } - wxASSERT( !pData->IsShared() ); // we must be the only owner + wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner } // must be called before replacing contents of this string @@ -282,27 +321,94 @@ void 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(); + wxStringData* pData = GetStringData(); if ( pData->IsShared() || (nLen > pData->nAllocLength) ) { // can't work with old buffer, get new one pData->Unlock(); AllocBuffer(nLen); } + else { + // update the string length + pData->nDataLength = nLen; + } + + wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner +} + +// allocate enough memory for nLen characters +void 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(char)); + pData->nRefs = 1; + pData->nDataLength = 0; + pData->nAllocLength = nLen; + m_pchData = pData->data(); // data starts after wxStringData + m_pchData[0u] = '\0'; + } + else if ( pData->IsShared() ) { + pData->Unlock(); // memory not freed because shared + size_t nOldLen = pData->nDataLength; + AllocBuffer(nLen); + memcpy(m_pchData, pData->data(), nOldLen*sizeof(char)); + } + else { + nLen += EXTRA_ALLOC; + + wxStringData *p = (wxStringData *) + realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(char)); + + if ( p == NULL ) { + // @@@ what to do on memory error? + return; + } + + // 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) + p->nAllocLength = nLen; + m_pchData = p->data(); + } + } + //else: we've already got enough +} + +// shrink to minimal size (releasing extra memory) +void wxString::Shrink() +{ + wxStringData *pData = GetStringData(); - wxASSERT( !pData->IsShared() ); // we must be the only owner + // this variable is unused in release build, so avoid the compiler warning by + // just not declaring it +#ifdef __WXDEBUG__ + void *p = +#endif + realloc(pData, sizeof(wxStringData) + (pData->nDataLength + 1)*sizeof(char)); + + wxASSERT( p != NULL ); // can't free memory? + wxASSERT( p == pData ); // we're decrementing the size - block shouldn't move! } // get the pointer to writable buffer of (at least) nLen bytes char *wxString::GetWriteBuf(size_t nLen) { AllocBeforeWrite(nLen); + + 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 = strlen(m_pchData); + GetStringData()->Validate(TRUE); } // --------------------------------------------------------------------------- @@ -315,7 +421,7 @@ wxString::~wxString() // assignment operators // --------------------------------------------------------------------------- -// helper function: does real copy +// helper function: does real copy void wxString::AssignCopy(size_t nSrcLen, const char *pszSrcData) { if ( nSrcLen == 0 ) { @@ -332,6 +438,8 @@ void wxString::AssignCopy(size_t nSrcLen, const char *pszSrcData) // 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() ) { @@ -380,91 +488,52 @@ wxString& wxString::operator=(const wchar_t *pwz) // 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) { + 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); + AllocBuffer(nNewLen); + memcpy(m_pchData, pOldData->data(), nLen*sizeof(char)); 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 ); - - m_pchData[pData->nDataLength] = '\0'; // put terminating '\0' + // we have to grow the buffer + Alloc(nNewLen); } - } -} + else { + STATISTICS_ADD(ConcatHit, 1); -/* - * string may be concatenated with other string, C string or a character - */ + // the buffer is already big enough + } -void wxString::operator+=(const wxString& string) -{ - ConcatSelf(string.Len(), string); -} + // should be enough space + wxASSERT( nNewLen <= GetStringData()->nAllocLength ); -void wxString::operator+=(const char *psz) -{ - ConcatSelf(Strlen(psz), psz); -} + // fast concatenation - all is done in our buffer + memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(char)); -void wxString::operator+=(char ch) -{ - ConcatSelf(1, &ch); + m_pchData[nNewLen] = '\0'; // put terminating '\0' + GetStringData()->nDataLength = nNewLen; // and fix the length + } + //else: the string to append was empty } /* - * Same as above but return the result - */ - -wxString& wxString::operator<<(const wxString& string) -{ - ConcatSelf(string.Len(), string); - return *this; -} - -wxString& wxString::operator<<(const char *psz) -{ - ConcatSelf(Strlen(psz), psz); - return *this; -} - -wxString& wxString::operator<<(char ch) -{ - ConcatSelf(1, &ch); - return *this; -} - -/* * concatenation functions come in 5 flavours: * string + string * char + string and string + char @@ -473,39 +542,56 @@ wxString& wxString::operator<<(char ch) wxString operator+(const wxString& string1, const wxString& string2) { - wxString s; - s.ConcatCopy(string1.GetStringData()->nDataLength, string1.m_pchData, - string2.GetStringData()->nDataLength, string2.m_pchData); + wxASSERT( string1.GetStringData()->IsValid() ); + wxASSERT( string2.GetStringData()->IsValid() ); + + wxString s = string1; + s += string2; + return s; } -wxString operator+(const wxString& string1, char ch) +wxString operator+(const wxString& string, char ch) { - wxString s; - s.ConcatCopy(string1.GetStringData()->nDataLength, string1.m_pchData, 1, &ch); + wxASSERT( string.GetStringData()->IsValid() ); + + wxString s = string; + s += ch; + return s; } wxString operator+(char ch, const wxString& string) { - wxString s; - s.ConcatCopy(1, &ch, string.GetStringData()->nDataLength, string.m_pchData); + wxASSERT( string.GetStringData()->IsValid() ); + + wxString s = ch; + s += string; + return s; } wxString operator+(const wxString& string, const char *psz) { + wxASSERT( string.GetStringData()->IsValid() ); + wxString s; - s.ConcatCopy(string.GetStringData()->nDataLength, string.m_pchData, - Strlen(psz), psz); + s.Alloc(Strlen(psz) + string.Len()); + s = string; + s += psz; + return s; } wxString operator+(const char *psz, const wxString& string) { + wxASSERT( string.GetStringData()->IsValid() ); + wxString s; - s.ConcatCopy(Strlen(psz), psz, - string.GetStringData()->nDataLength, string.m_pchData); + s.Alloc(Strlen(psz) + string.Len()); + s = psz; + s += string; + return s; } @@ -520,32 +606,42 @@ wxString operator+(const char *psz, const wxString& string) // helper function: clone the data attached to this string void wxString::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const { - if ( nCopyLen == 0 ) - { + if ( nCopyLen == 0 ) { dest.Init(); } - else - { + else { dest.AllocBuffer(nCopyLen); memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(char)); } } // 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); + return dest; } @@ -562,11 +658,11 @@ wxString wxString::Right(size_t nCount) const // 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(char 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; @@ -587,7 +683,7 @@ wxString wxString::Left(size_t nCount) const // 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(char ch) const { wxString str; for ( const char *pc = m_pchData; *pc != '\0' && *pc != ch; pc++ ) @@ -598,11 +694,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(char 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,26 +706,26 @@ 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(char 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 char *szOld, const char *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 = Strlen(szOld); wxString strTemp; const char *pCurrent = m_pchData; - const char *pSubstr; + const char *pSubstr; while ( *pCurrent != '\0' ) { pSubstr = strstr(pCurrent, szOld); if ( pSubstr == NULL ) { @@ -671,7 +767,7 @@ bool wxString::IsAscii() const } return(TRUE); } - + bool wxString::IsWord() const { const char *s = (const char*) *this; @@ -681,7 +777,7 @@ bool wxString::IsWord() const } return(TRUE); } - + bool wxString::IsNumber() const { const char *s = (const char*) *this; @@ -692,10 +788,6 @@ bool wxString::IsNumber() const 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,33 +796,6 @@ 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 // --------------------------------------------------------------------------- @@ -748,7 +813,7 @@ wxString& wxString::MakeUpper() wxString& wxString::MakeLower() { CopyBeforeWrite(); - + for ( char *p = m_pchData; *p; p++ ) *p = (char)tolower(*p); @@ -762,30 +827,40 @@ wxString& wxString::MakeLower() // trims spaces (in the sense of isspace) from left or right side wxString& wxString::Trim(bool bFromRight) { - CopyBeforeWrite(); - - if ( bFromRight ) + // first check if we're going to modify the string at all + if ( !IsEmpty() && + ( + (bFromRight && isspace(GetChar(Len() - 1))) || + (!bFromRight && isspace(GetChar(0u))) + ) + ) { - // 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 - { - // 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 + 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 + { + // find first non-space character + const char *psz = m_pchData; + while ( isspace(*psz) ) + psz++; + + // fix up data and length + int nDataLength = GetStringData()->nDataLength - (psz - (const char*) m_pchData); + memmove(m_pchData, psz, (nDataLength + 1)*sizeof(char)); + GetStringData()->nDataLength = nDataLength; + } } return *this; @@ -810,14 +885,19 @@ 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() ) { + CopyBeforeWrite(); + + *(m_pchData + uiLen) = '\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 @@ -825,7 +905,7 @@ int wxString::Find(char ch, bool bFromEnd) const { const char *psz = bFromEnd ? strrchr(m_pchData, ch) : strchr(m_pchData, ch); - return (psz == NULL) ? NOT_FOUND : psz - m_pchData; + return (psz == NULL) ? wxNOT_FOUND : psz - (const char*) m_pchData; } // find a sub-string (like strstr) @@ -833,7 +913,34 @@ int wxString::Find(const char *pszSub) const { const char *psz = strstr(m_pchData, pszSub); - return (psz == NULL) ? NOT_FOUND : psz - m_pchData; + return (psz == NULL) ? wxNOT_FOUND : psz - (const char*) m_pchData; +} + +// --------------------------------------------------------------------------- +// stream-like operators +// --------------------------------------------------------------------------- +wxString& wxString::operator<<(int i) +{ + wxString res; + res.Printf("%d", i); + + return (*this) << res; +} + +wxString& wxString::operator<<(float f) +{ + wxString res; + res.Printf("%f", f); + + return (*this) << res; +} + +wxString& wxString::operator<<(double d) +{ + wxString res; + res.Printf("%g", d); + + return (*this) << res; } // --------------------------------------------------------------------------- @@ -853,84 +960,192 @@ int wxString::Printf(const char *pszFormat, ...) int wxString::PrintfV(const char* pszFormat, va_list argptr) { + // static buffer to avoid dynamic memory allocation each time static char s_szScratch[1024]; - int iLen = vsprintf(s_szScratch, pszFormat, argptr); + // NB: wxVsprintf() may return either less than the buffer size or -1 if there + // is not enough place depending on implementation + int iLen = wxVsprintf(s_szScratch, WXSIZEOF(s_szScratch), pszFormat, argptr); + char *buffer; + if ( iLen < (int)WXSIZEOF(s_szScratch) ) { + buffer = s_szScratch; + } + else { + int size = WXSIZEOF(s_szScratch) * 2; + buffer = (char *)malloc(size); + while ( buffer != NULL ) { + iLen = wxVsprintf(buffer, WXSIZEOF(s_szScratch), pszFormat, argptr); + if ( iLen < size ) { + // ok, there was enough space + break; + } + + // still not enough, double it again + buffer = (char *)realloc(buffer, size *= 2); + } + + if ( !buffer ) { + // out of memory + return -1; + } + } + AllocBeforeWrite(iLen); - strcpy(m_pchData, s_szScratch); + strcpy(m_pchData, buffer); + + if ( buffer != s_szScratch ) + free(buffer); return iLen; } -int wxString::Scanf(const char *pszFormat, ...) const +// ---------------------------------------------------------------------------- +// misc other operations +// ---------------------------------------------------------------------------- +bool wxString::Matches(const char *pszMask) const { - va_list argptr; - va_start(argptr, pszFormat); + // check char by char + const char *pszTxt; + for ( pszTxt = c_str(); *pszMask != '\0'; pszMask++, pszTxt++ ) { + switch ( *pszMask ) { + case '?': + if ( *pszTxt == '\0' ) + return FALSE; - int iLen = ScanfV(pszFormat, argptr); + pszTxt++; + pszMask++; + break; - va_end(argptr); + case '*': + { + // ignore special chars immediately following this one + while ( *pszMask == '*' || *pszMask == '?' ) + pszMask++; + + // if there is nothing more, match + if ( *pszMask == '\0' ) + return TRUE; + + // are there any other metacharacters in the mask? + size_t uiLenMask; + const char *pEndMask = strpbrk(pszMask, "*?"); + + 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 = strlen(pszMask); + } + + wxString strToMatch(pszMask, uiLenMask); + const char* pMatch = strstr(pszTxt, strToMatch); + if ( pMatch == NULL ) + return FALSE; + + // -1 to compensate "++" in the loop + pszTxt = pMatch + uiLenMask - 1; + pszMask += uiLenMask - 1; + } + break; - return iLen; + default: + if ( *pszMask != *pszTxt ) + return FALSE; + break; + } + } + + // match only if nothing left + return *pszTxt == '\0'; } -int wxString::ScanfV(const char *pszFormat, va_list argptr) const +// Count the number of chars +int wxString::Freq(char ch) const { -#ifdef __WINDOWS__ - wxMessageBox("ScanfV not implemented"); - return 0; -#else - return vsscanf(c_str(), pszFormat, argptr); -#endif + 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 char *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 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; + char *pc = strTmp.GetWriteBuf(Len() + str.Len()); + strncpy(pc, c_str(), nPos); + strcpy(pc + nPos, str); + strcpy(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); - + 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__)) +#if !defined(__VISUALC__) || defined(__WIN32__) size_t wxString::find(const char* sz, size_t nStart, size_t n) const { return find(wxString(sz, n == npos ? 0 : n), nStart); } -#endif - +#endif // VC++ 1.5 + +// Gives a duplicate symbol (presumably a case-insensitivity problem) +#if !defined(__BORLANDC__) size_t wxString::find(char ch, size_t nStart) const { wxASSERT( nStart <= Len() ); const char *p = strchr(c_str() + nStart, ch); - + return p == NULL ? npos : p - c_str(); } +#endif size_t wxString::rfind(const wxString& str, size_t nStart) const { + wxASSERT( str.GetStringData()->IsValid() ); wxASSERT( nStart <= Len() ); // # could be quicker than that @@ -940,12 +1155,12 @@ size_t wxString::rfind(const wxString& str, size_t nStart) const 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__)) +#if !defined(__VISUALC__) || defined(__WIN32__) size_t wxString::rfind(const char* sz, size_t nStart, size_t n) const { return rfind(wxString(sz, n == npos ? 0 : n), nStart); @@ -956,10 +1171,10 @@ size_t wxString::rfind(char ch, size_t nStart) const wxASSERT( nStart <= Len() ); const char *p = strrchr(c_str() + nStart, ch); - + return p == NULL ? npos : p - c_str(); } -#endif +#endif // VC++ 1.5 wxString wxString::substr(size_t nStart, size_t nLen) const { @@ -994,7 +1209,7 @@ wxString& wxString::replace(size_t nStart, size_t nLen, const char *sz) strTmp.append(c_str(), nStart); strTmp += sz; strTmp.append(c_str() + nStart + nLen); - + *this = strTmp; return *this; } @@ -1004,13 +1219,13 @@ wxString& wxString::replace(size_t nStart, size_t nLen, size_t nCount, char 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, +wxString& wxString::replace(size_t nStart, size_t nLen, const char* sz, size_t nCount) { return replace(nStart, nLen, wxString(sz, nCount)); @@ -1035,36 +1250,32 @@ wxArrayString::wxArrayString() { m_nSize = m_nCount = 0; - m_pItems = NULL; + m_pItems = (char **) NULL; } // copy ctor wxArrayString::wxArrayString(const wxArrayString& src) { - m_nSize = src.m_nSize; - m_nCount = src.m_nCount; - - if ( m_nSize != 0 ) - m_pItems = new char *[m_nSize]; - else - m_pItems = NULL; + m_nSize = + m_nCount = 0; + m_pItems = (char **) 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 ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE ) + Alloc(src.m_nCount); - if ( m_nSize != 0 ) - m_pItems = new char *[m_nSize]; - else - m_pItems = NULL; + // we can't just copy the pointers here because otherwise we would share + // the strings with another array + for ( size_t n = 0; n < src.m_nCount; n++ ) + Add(src[n]); if ( m_nCount != 0 ) memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(char *)); @@ -1083,8 +1294,13 @@ void wxArrayString::Grow() m_pItems = new char *[m_nSize]; } else { + // otherwise when it's called for the first time, nIncrement would be 0 + // and the array would never be expanded + wxASSERT( ARRAY_DEFAULT_INITIAL_SIZE != 0 ); + // add 50% but not too much - size_t nIncrement = m_nSize >> 1; + size_t nIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE + ? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1; if ( nIncrement > ARRAY_MAXSIZE_INCREMENT ) nIncrement = ARRAY_MAXSIZE_INCREMENT; m_nSize += nIncrement; @@ -1094,7 +1310,7 @@ void wxArrayString::Grow() memcpy(pNew, m_pItems, m_nCount*sizeof(char *)); // delete old memory (but do not release the strings!) - DELETEA(m_pItems); + wxDELETEA(m_pItems); m_pItems = pNew; } @@ -1121,11 +1337,10 @@ void wxArrayString::Clear() { Free(); - m_nSize = + m_nSize = m_nCount = 0; - DELETEA(m_pItems); - m_pItems = NULL; + wxDELETEA(m_pItems); } // dtor @@ -1133,7 +1348,7 @@ wxArrayString::~wxArrayString() { Free(); - DELETEA(m_pItems); + wxDELETEA(m_pItems); } // pre-allocates memory (frees the previous data!) @@ -1144,7 +1359,7 @@ void wxArrayString::Alloc(size_t nSize) // only if old buffer was not big enough if ( nSize > m_nSize ) { Free(); - DELETEA(m_pItems); + wxDELETEA(m_pItems); m_pItems = new char *[nSize]; m_nSize = nSize; } @@ -1153,14 +1368,11 @@ void wxArrayString::Alloc(size_t nSize) } // searches the array for an item (forward or backwards) - -// Robert Roebling (changed to bool from bool) - int wxArrayString::Index(const char *sz, bool bCase, bool bFromEnd) const { if ( bFromEnd ) { if ( m_nCount > 0 ) { - uint ui = m_nCount; + size_t ui = m_nCount; do { if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) ) return ui; @@ -1169,37 +1381,41 @@ int wxArrayString::Index(const char *sz, bool bCase, bool bFromEnd) const } } else { - for( uint ui = 0; ui < m_nCount; ui++ ) { + 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) +void wxArrayString::Add(const wxString& str) { + wxASSERT( str.GetStringData()->IsValid() ); + Grow(); // the string data must not be deleted! - src.GetStringData()->Lock(); - m_pItems[m_nCount++] = (char *)src.c_str(); + str.GetStringData()->Lock(); + m_pItems[m_nCount++] = (char *)str.c_str(); } // add item at the given position -void wxArrayString::Insert(const wxString& src, size_t nIndex) +void wxArrayString::Insert(const wxString& str, size_t nIndex) { - wxCHECK_RET( nIndex <= m_nCount, "bad index in wxArrayString::Insert" ); + wxASSERT( str.GetStringData()->IsValid() ); + + wxCHECK_RET( nIndex <= m_nCount, ("bad index in wxArrayString::Insert") ); Grow(); - memmove(&m_pItems[nIndex + 1], &m_pItems[nIndex], + memmove(&m_pItems[nIndex + 1], &m_pItems[nIndex], (m_nCount - nIndex)*sizeof(char *)); - src.GetStringData()->Lock(); - m_pItems[nIndex] = (char *)src.c_str(); + str.GetStringData()->Lock(); + m_pItems[nIndex] = (char *)str.c_str(); m_nCount++; } @@ -1207,12 +1423,12 @@ void wxArrayString::Insert(const wxString& src, size_t nIndex) // removes item from array (by index) void wxArrayString::Remove(size_t nIndex) { - wxCHECK_RET( nIndex <= m_nCount, "bad index in wxArrayString::Remove" ); + wxCHECK_RET( nIndex <= m_nCount, _("bad index in wxArrayString::Remove") ); // release our lock Item(nIndex).GetStringData()->Unlock(); - memmove(&m_pItems[nIndex], &m_pItems[nIndex + 1], + memmove(&m_pItems[nIndex], &m_pItems[nIndex + 1], (m_nCount - nIndex - 1)*sizeof(char *)); m_nCount--; } @@ -1222,16 +1438,89 @@ void wxArrayString::Remove(const char *sz) { int iIndex = Index(sz); - wxCHECK_RET( iIndex != NOT_FOUND, - "removing inexistent element in wxArrayString::Remove" ); + wxCHECK_RET( iIndex != wxNOT_FOUND, + _("removing inexistent element in wxArrayString::Remove") ); + + Remove(iIndex); +} + +// ---------------------------------------------------------------------------- +// sorting +// ---------------------------------------------------------------------------- + +// we can only sort one array at a time with the quick-sort based +// implementation +#if wxUSE_THREADS + #include + + // 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 +static int wxStringCompareFunction(const void *first, const void *second) +{ + wxString *strFirst = (wxString *)first; + wxString *strSecond = (wxString *)second; + + if ( gs_compareFunction ) { + return gs_compareFunction(*strFirst, *strSecond); + } + else { + int result = strcmp(strFirst->c_str(), strSecond->c_str()); - Remove((size_t)iIndex); + 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(); + + END_SORT(); +} + +void wxArrayString::Sort(bool reverseOrder) +{ + START_SORT(); + + wxASSERT( !gs_compareFunction ); // must have been reset to NULL + gs_sortAscending = !reverseOrder; + + DoSort(); + + END_SORT(); +} -void wxArrayString::Sort(bool bCase, bool bReverse) +void wxArrayString::DoSort() { - //@@@@ TO DO - //qsort(m_pItems, m_nCount, sizeof(char *), fCmp); + // 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(char *), wxStringCompareFunction); }