X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/55d99c7a77789ff4904bf96eddca3715eb5af9b9..4ee4c7b948e76377a6947d3ffbe5099870d0c3e9:/src/common/string.cpp?ds=sidebyside diff --git a/src/common/string.cpp b/src/common/string.cpp index 9d16b5302a..dcac014916 100644 --- a/src/common/string.cpp +++ b/src/common/string.cpp @@ -1,25 +1,15 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: string.cpp +// Name: src/common/string.cpp // Purpose: wxString class -// Author: Vadim Zeitlin +// Author: Vadim Zeitlin, Ryan Norton // Modified by: // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin +// (c) 2004 Ryan Norton // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ - #pragma implementation "string.h" -#endif - -/* - * About ref counting: - * 1) all empty strings use g_strEmpty, nRefs = -1 (set in Init()) - * 2) AllocBuffer() sets nRefs to 1, Lock() increments it by one - * 3) Unlock() decrements nRefs and frees memory if it goes to 0 - */ - // =========================================================================== // headers, declarations, constants // =========================================================================== @@ -28,492 +18,570 @@ #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop + #pragma hdrstop #endif #ifndef WX_PRECOMP - #include "wx/defs.h" - #include "wx/string.h" - #include "wx/intl.h" - #include "wx/thread.h" + #include "wx/string.h" + #include "wx/wxcrtvararg.h" + #include "wx/log.h" #endif #include + +#ifndef __WXWINCE__ + #include +#endif + #include #include -#ifdef __SALFORDC__ - #include +#include "wx/hashmap.h" +#include "wx/vector.h" +#include "wx/xlocale.h" + +#ifdef __WXMSW__ + #include "wx/msw/wrapwin.h" +#endif // __WXMSW__ + +// string handling functions used by wxString: +#if wxUSE_UNICODE_UTF8 + #define wxStringMemcpy memcpy + #define wxStringMemcmp memcmp + #define wxStringMemchr memchr + #define wxStringStrlen strlen +#else + #define wxStringMemcpy wxTmemcpy + #define wxStringMemcmp wxTmemcmp + #define wxStringMemchr wxTmemchr + #define wxStringStrlen wxStrlen #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) +// define a function declared in wx/buffer.h here as we don't have buffer.cpp +// and don't want to add it just because of this simple function +namespace wxPrivate +{ + +// wxXXXBuffer classes can be (implicitly) used during global statics +// initialization so wrap the status UntypedBufferData variable in a function +// to make it safe to access it even before all global statics are initialized +UntypedBufferData *GetUntypedNullData() +{ + static UntypedBufferData s_untypedNullData(NULL, 0); + + return &s_untypedNullData; +} + +} // namespace wxPrivate // --------------------------------------------------------------------------- // static class variables definition // --------------------------------------------------------------------------- -#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 +//According to STL _must_ be a -1 size_t +const size_t wxString::npos = (size_t) -1; -#ifdef wxSTD_STRING_COMPATIBILITY - const size_t wxString::npos = wxSTRING_MAXLEN; -#endif // wxSTD_STRING_COMPATIBILITY +#if wxUSE_STRING_POS_CACHE -// ---------------------------------------------------------------------------- -// static data -// ---------------------------------------------------------------------------- +#ifdef wxHAS_COMPILER_TLS + +wxTLS_TYPE(wxString::Cache) wxString::ms_cache; -// 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 +#else // !wxHAS_COMPILER_TLS + +struct wxStrCacheInitializer { - wxStringData data; - wxChar dummy; -} g_strEmpty = { {-1, 0, 0}, wxT('\0') }; + wxStrCacheInitializer() + { + // calling this function triggers s_cache initialization in it, and + // from now on it becomes safe to call from multiple threads + wxString::GetCache(); + } +}; -// empty C style string: points to 'string data' byte of g_strEmpty -extern const wxChar WXDLLEXPORT *wxEmptyString = &g_strEmpty.dummy; +/* +wxString::Cache& wxString::GetCache() +{ + static wxTLS_TYPE(Cache) s_cache; -// ---------------------------------------------------------------------------- -// global functions -// ---------------------------------------------------------------------------- + return wxTLS_VALUE(s_cache); +} +*/ -#if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM +static wxStrCacheInitializer gs_stringCacheInit; -// 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! +#endif // wxHAS_COMPILER_TLS/!wxHAS_COMPILER_TLS -wxSTD istream& operator>>(wxSTD istream& is, wxString& WXUNUSED(str)) -{ -#if 0 - int w = is.width(0); - if ( is.ipfx(0) ) { - streambuf *sb = is.rdbuf(); - str.erase(); - while ( true ) { - int ch = sb->sbumpc (); - if ( ch == EOF ) { - is.setstate(ios::eofbit); - break; - } - else if ( isspace(ch) ) { - sb->sungetc(); - break; - } +// gdb seems to be unable to display thread-local variables correctly, at least +// not my 6.4.98 version under amd64, so provide this debugging helper to do it +#if wxDEBUG_LEVEL >= 2 - str += ch; - if ( --w == 1 ) - break; +struct wxStrCacheDumper +{ + static void ShowAll() + { + puts("*** wxString cache dump:"); + for ( unsigned n = 0; n < wxString::Cache::SIZE; n++ ) + { + const wxString::Cache::Element& + c = wxString::GetCacheBegin()[n]; + + printf("\t%u%s\t%p: pos=(%lu, %lu), len=%ld\n", + n, + n == wxString::LastUsedCacheElement() ? " [*]" : "", + c.str, + (unsigned long)c.pos, + (unsigned long)c.impl, + (long)c.len); + } } - } +}; - is.isfx(); - if ( str.length() == 0 ) - is.setstate(ios::failbit); -#endif - return is; -} +void wxDumpStrCache() { wxStrCacheDumper::ShowAll(); } -wxSTD ostream& operator<<(wxSTD ostream& os, const wxString& str) +#endif // wxDEBUG_LEVEL >= 2 + +#ifdef wxPROFILE_STRING_CACHE + +wxString::CacheStats wxString::ms_cacheStats; + +struct wxStrCacheStatsDumper { - os << str.c_str(); - return os; -} + ~wxStrCacheStatsDumper() + { + const wxString::CacheStats& stats = wxString::ms_cacheStats; -#endif //std::string compatibility + if ( stats.postot ) + { + puts("*** wxString cache statistics:"); + printf("\tTotal non-trivial calls to PosToImpl(): %u\n", + stats.postot); + printf("\tHits %u (of which %u not used) or %.2f%%\n", + stats.poshits, + stats.mishits, + 100.*float(stats.poshits - stats.mishits)/stats.postot); + printf("\tAverage position requested: %.2f\n", + float(stats.sumpos) / stats.postot); + printf("\tAverage offset after cached hint: %.2f\n", + float(stats.sumofs) / stats.postot); + } + + if ( stats.lentot ) + { + printf("\tNumber of calls to length(): %u, hits=%.2f%%\n", + stats.lentot, 100.*float(stats.lenhits)/stats.lentot); + } + } +}; + +static wxStrCacheStatsDumper s_showCacheStats; + +#endif // wxPROFILE_STRING_CACHE + +#endif // wxUSE_STRING_POS_CACHE // ---------------------------------------------------------------------------- -// private classes +// global functions // ---------------------------------------------------------------------------- -// 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 -// =========================================================================== +#if wxUSE_STD_IOSTREAM -// --------------------------------------------------------------------------- -// construction -// --------------------------------------------------------------------------- +#include -// constructs string of copies of character -wxString::wxString(wxChar ch, size_t nLength) +wxSTD ostream& operator<<(wxSTD ostream& os, const wxCStrData& str) { - Init(); - - if ( nLength > 0 ) { - if ( !AllocBuffer(nLength) ) { - wxFAIL_MSG( _T("out of memory in wxString::wxString") ); - return; - } +#if wxUSE_UNICODE && !wxUSE_UNICODE_UTF8 + const wxScopedCharBuffer buf(str.AsCharBuf()); + if ( !buf ) + os.clear(wxSTD ios_base::failbit); + else + os << buf.data(); -#if wxUSE_UNICODE - // memset only works on chars - for ( size_t n = 0; n < nLength; n++ ) - m_pchData[n] = ch; + return os; #else - memset(m_pchData, ch, nLength); + return os << str.AsInternal(); #endif - } } -// takes nLength elements of psz starting at nPos -void wxString::InitWith(const wxChar *psz, size_t nPos, size_t nLength) +wxSTD ostream& operator<<(wxSTD ostream& os, const wxString& str) { - Init(); + return os << str.c_str(); +} - // 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") ); +wxSTD ostream& operator<<(wxSTD ostream& os, const wxScopedCharBuffer& str) +{ + return os << str.data(); +} - nLength = wxStrlen(psz + nPos); - } +#ifndef __BORLANDC__ +wxSTD ostream& operator<<(wxSTD ostream& os, const wxScopedWCharBuffer& str) +{ + return os << str.data(); +} +#endif - STATISTICS_ADD(InitialLength, nLength); +#if wxUSE_UNICODE && defined(HAVE_WOSTREAM) - if ( nLength > 0 ) { - // trailing '\0' is written in AllocBuffer() - if ( !AllocBuffer(nLength) ) { - wxFAIL_MSG( _T("out of memory in wxString::InitWith") ); - return; - } - memcpy(m_pchData, psz + nPos, nLength*sizeof(wxChar)); - } +wxSTD wostream& operator<<(wxSTD wostream& wos, const wxString& str) +{ + return wos << str.wc_str(); } -#ifdef wxSTD_STRING_COMPATIBILITY +wxSTD wostream& operator<<(wxSTD wostream& wos, const wxCStrData& str) +{ + return wos << str.AsWChar(); +} -// poor man's iterators are "void *" pointers -wxString::wxString(const void *pStart, const void *pEnd) +wxSTD wostream& operator<<(wxSTD wostream& wos, const wxScopedWCharBuffer& str) { - InitWith((const wxChar *)pStart, 0, - (const wxChar *)pEnd - (const wxChar *)pStart); + return wos << str.data(); } -#endif //std::string compatibility +#endif // wxUSE_UNICODE && defined(HAVE_WOSTREAM) -#if wxUSE_UNICODE +#endif // wxUSE_STD_IOSTREAM + +// =========================================================================== +// wxString class core +// =========================================================================== -// from multibyte string -wxString::wxString(const char *psz, wxMBConv& conv, size_t nLength) +#if wxUSE_UNICODE_UTF8 + +void wxString::PosLenToImpl(size_t pos, size_t len, + size_t *implPos, size_t *implLen) const { - // 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 + if ( pos == npos ) { - // nothing to convert - nLen = 0; + *implPos = npos; } - - // anything to do? - if ( (nLen != 0) && (nLen != (size_t)-1) ) + else // have valid start position { - if ( !AllocBuffer(nLen) ) + const const_iterator b = GetIterForNthChar(pos); + *implPos = wxStringImpl::const_iterator(b.impl()) - m_impl.begin(); + if ( len == npos ) { - wxFAIL_MSG( _T("out of memory in wxString::wxString") ); - return; + *implLen = npos; } - - // MB2WC wants the buffer size, not the string length - if ( conv.MB2WC(m_pchData, psz, nLen + 1) != (size_t)-1 ) + else // have valid length too { - // initialized ok - return; + // we need to handle the case of length specifying a substring + // going beyond the end of the string, just as std::string does + const const_iterator e(end()); + const_iterator i(b); + while ( len && i <= e ) + { + ++i; + --len; + } + + *implLen = i.impl() - b.impl(); } - //else: the conversion failed -- leave the string empty (what else?) } - - Init(); } -#else // ANSI +#endif // wxUSE_UNICODE_UTF8 -#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 +// ---------------------------------------------------------------------------- +// wxCStrData converted strings caching +// ---------------------------------------------------------------------------- + +// FIXME-UTF8: temporarily disabled because it doesn't work with global +// string objects; re-enable after fixing this bug and benchmarking +// performance to see if using a hash is a good idea at all +#if 0 + +// For backward compatibility reasons, it must be possible to assign the value +// returned by wxString::c_str() to a char* or wchar_t* variable and work with +// it. Returning wxCharBuffer from (const char*)c_str() wouldn't do the trick, +// because the memory would be freed immediately, but it has to be valid as long +// as the string is not modified, so that code like this still works: +// +// const wxChar *s = str.c_str(); +// while ( s ) { ... } + +// FIXME-UTF8: not thread safe! +// FIXME-UTF8: we currently clear the cached conversion only when the string is +// destroyed, but we should do it when the string is modified, to +// keep memory usage down +// FIXME-UTF8: we do the conversion every time As[W]Char() is called, but if we +// invalidated the cache on every change, we could keep the previous +// conversion +// FIXME-UTF8: add tracing of usage of these two methods - new code is supposed +// to use mb_str() or wc_str() instead of (const [w]char*)c_str() + +template +static inline void DeleteStringFromConversionCache(T& hash, const wxString *s) +{ + typename T::iterator i = hash.find(wxConstCast(s, wxString)); + if ( i != hash.end() ) { - // nothing to convert - nLen = 0; + free(i->second); + hash.erase(i); } +} - // anything to do? - if ( (nLen != 0) && (nLen != (size_t)-1) ) - { - if ( !AllocBuffer(nLen) ) - { - wxFAIL_MSG( _T("out of memory in wxString::wxString") ); - return; - } +#if wxUSE_UNICODE +// NB: non-STL implementation doesn't compile with "const wxString*" key type, +// so we have to use wxString* here and const-cast when used +WX_DECLARE_HASH_MAP(wxString*, char*, wxPointerHash, wxPointerEqual, + wxStringCharConversionCache); +static wxStringCharConversionCache gs_stringsCharCache; - // 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?) - } +const char* wxCStrData::AsChar() const +{ + // remove previously cache value, if any (see FIXMEs above): + DeleteStringFromConversionCache(gs_stringsCharCache, m_str); - Init(); + // convert the string and keep it: + const char *s = gs_stringsCharCache[wxConstCast(m_str, wxString)] = + m_str->mb_str().release(); + + return s + m_offset; } -#endif // wxUSE_WCHAR_T +#endif // wxUSE_UNICODE -#endif // Unicode/ANSI +#if !wxUSE_UNICODE_WCHAR +WX_DECLARE_HASH_MAP(wxString*, wchar_t*, wxPointerHash, wxPointerEqual, + wxStringWCharConversionCache); +static wxStringWCharConversionCache gs_stringsWCharCache; -// --------------------------------------------------------------------------- -// memory allocation -// --------------------------------------------------------------------------- +const wchar_t* wxCStrData::AsWChar() const +{ + // remove previously cache value, if any (see FIXMEs above): + DeleteStringFromConversionCache(gs_stringsWCharCache, m_str); -// allocates memory needed to store a C string of length nLen -bool wxString::AllocBuffer(size_t nLen) + // convert the string and keep it: + const wchar_t *s = gs_stringsWCharCache[wxConstCast(m_str, wxString)] = + m_str->wc_str().release(); + + return s + m_offset; +} +#endif // !wxUSE_UNICODE_WCHAR + +wxString::~wxString() { - // allocating 0 sized buffer doesn't make sense, all empty strings should - // reuse g_strEmpty - wxASSERT( nLen > 0 ); +#if wxUSE_UNICODE + // FIXME-UTF8: do this only if locale is not UTF8 if wxUSE_UNICODE_UTF8 + DeleteStringFromConversionCache(gs_stringsCharCache, this); +#endif +#if !wxUSE_UNICODE_WCHAR + DeleteStringFromConversionCache(gs_stringsWCharCache, this); +#endif +} +#endif - // make sure that we don't overflow - wxASSERT( nLen < (INT_MAX / sizeof(wxChar)) - - (sizeof(wxStringData) + EXTRA_ALLOC + 1) ); +// =========================================================================== +// wxString class core +// =========================================================================== - STATISTICS_ADD(Length, nLen); +// --------------------------------------------------------------------------- +// construction and conversion +// --------------------------------------------------------------------------- - // allocate memory: - // 1) one extra character for '\0' termination - // 2) sizeof(wxStringData) for housekeeping info - wxStringData* pData = (wxStringData*) - malloc(sizeof(wxStringData) + (nLen + EXTRA_ALLOC + 1)*sizeof(wxChar)); +#if wxUSE_UNICODE_WCHAR +/* static */ +wxString::SubstrBufFromMB wxString::ConvertStr(const char *psz, size_t nLength, + const wxMBConv& conv) +{ + // anything to do? + if ( !psz || nLength == 0 ) + return SubstrBufFromMB(wxWCharBuffer(L""), 0); - if ( pData == NULL ) { - // allocation failures are handled by the caller - return FALSE; - } + if ( nLength == npos ) + nLength = wxNO_LEN; - pData->nRefs = 1; - pData->nDataLength = nLen; - pData->nAllocLength = nLen + EXTRA_ALLOC; - m_pchData = pData->data(); // data starts after wxStringData - m_pchData[nLen] = wxT('\0'); - return TRUE; + size_t wcLen; + wxScopedWCharBuffer wcBuf(conv.cMB2WC(psz, nLength, &wcLen)); + if ( !wcLen ) + return SubstrBufFromMB(wxWCharBuffer(L""), 0); + else + return SubstrBufFromMB(wcBuf, wcLen); } +#endif // wxUSE_UNICODE_WCHAR -// must be called before changing this string -bool wxString::CopyBeforeWrite() +#if wxUSE_UNICODE_UTF8 +/* static */ +wxString::SubstrBufFromMB wxString::ConvertStr(const char *psz, size_t nLength, + const wxMBConv& conv) { - wxStringData* pData = GetStringData(); + // anything to do? + if ( !psz || nLength == 0 ) + return SubstrBufFromMB(wxCharBuffer(""), 0); - if ( pData->IsShared() ) { - pData->Unlock(); // memory not freed because shared - size_t nLen = pData->nDataLength; - if ( !AllocBuffer(nLen) ) { - // allocation failures are handled by the caller - return FALSE; + // if psz is already in UTF-8, we don't have to do the roundtrip to + // wchar_t* and back: + if ( conv.IsUTF8() ) + { + // we need to validate the input because UTF8 iterators assume valid + // UTF-8 sequence and psz may be invalid: + if ( wxStringOperations::IsValidUtf8String(psz, nLength) ) + { + // we must pass the real string length to SubstrBufFromMB ctor + if ( nLength == npos ) + nLength = psz ? strlen(psz) : 0; + return SubstrBufFromMB(wxScopedCharBuffer::CreateNonOwned(psz, nLength), + nLength); + } + // else: do the roundtrip through wchar_t* } - memcpy(m_pchData, pData->data(), nLen*sizeof(wxChar)); - } - wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner + if ( nLength == npos ) + nLength = wxNO_LEN; - return TRUE; + // first convert to wide string: + size_t wcLen; + wxScopedWCharBuffer wcBuf(conv.cMB2WC(psz, nLength, &wcLen)); + if ( !wcLen ) + return SubstrBufFromMB(wxCharBuffer(""), 0); + + // and then to UTF-8: + SubstrBufFromMB buf(ConvertStr(wcBuf, wcLen, wxMBConvStrictUTF8())); + // widechar -> UTF-8 conversion isn't supposed to ever fail: + wxASSERT_MSG( buf.data, wxT("conversion to UTF-8 failed") ); + + return buf; } +#endif // wxUSE_UNICODE_UTF8 -// must be called before replacing contents of this string -bool wxString::AllocBeforeWrite(size_t nLen) +#if wxUSE_UNICODE_UTF8 || !wxUSE_UNICODE +/* static */ +wxString::SubstrBufFromWC wxString::ConvertStr(const wchar_t *pwz, size_t nLength, + const wxMBConv& conv) { - wxASSERT( nLen != 0 ); // doesn't make any sense + // anything to do? + if ( !pwz || nLength == 0 ) + return SubstrBufFromWC(wxCharBuffer(""), 0); - // must not share string and must have enough space - wxStringData* pData = GetStringData(); - if ( pData->IsShared() || pData->IsEmpty() ) { - // can't work with old buffer, get new one - pData->Unlock(); - 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); + if ( nLength == npos ) + nLength = wxNO_LEN; - nLen += EXTRA_ALLOC; + size_t mbLen; + wxScopedCharBuffer mbBuf(conv.cWC2MB(pwz, nLength, &mbLen)); + if ( !mbLen ) + return SubstrBufFromWC(wxCharBuffer(""), 0); + else + return SubstrBufFromWC(mbBuf, mbLen); +} +#endif // wxUSE_UNICODE_UTF8 || !wxUSE_UNICODE - pData = (wxStringData*) - realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar)); +// This std::string::c_str()-like method returns a wide char pointer to string +// contents. In wxUSE_UNICODE_WCHAR case it is trivial as it can simply return +// a pointer to the internal representation. Otherwise a conversion is required +// and it returns a temporary buffer. +// +// However for compatibility with c_str() and to avoid breaking existing code +// doing +// +// for ( const wchar_t *p = s.wc_str(); *p; p++ ) +// ... use *p... +// +// we actually need to ensure that the returned buffer is _not_ temporary and +// so we use wxString::m_convertedToWChar to store the returned data +#if !wxUSE_UNICODE_WCHAR + +const wchar_t *wxString::AsWChar(const wxMBConv& conv) const +{ + const char * const strMB = m_impl.c_str(); + const size_t lenMB = m_impl.length(); + + // find out the size of the buffer needed + const size_t lenWC = conv.ToWChar(NULL, 0, strMB, lenMB); + if ( lenWC == wxCONV_FAILED ) + return NULL; + + // keep the same buffer if the string size didn't change: this is not only + // an optimization but also ensure that code which modifies string + // character by character (without changing its length) can continue to use + // the pointer returned by a previous wc_str() call even after changing the + // string + + // TODO-UTF8: we could check for ">" instead of "!=" here as this would + // allow to save on buffer reallocations but at the cost of + // consuming (even) more memory, we should benchmark this to + // determine if it's worth doing + if ( !m_convertedToWChar.m_str || lenWC != m_convertedToWChar.m_len ) + { + if ( !const_cast(this)->m_convertedToWChar.Extend(lenWC) ) + return NULL; + } - if ( pData == NULL ) { - // allocation failures are handled by the caller - // keep previous data since reallocation failed - return FALSE; - } + // finally do convert + m_convertedToWChar.m_str[lenWC] = L'\0'; + if ( conv.ToWChar(m_convertedToWChar.m_str, lenWC, + strMB, lenMB) == wxCONV_FAILED ) + return NULL; - pData->nAllocLength = nLen; - m_pchData = pData->data(); - } + return m_convertedToWChar.m_str; +} - // now we have enough space, just update the string length - pData->nDataLength = nLen; - } +#endif // !wxUSE_UNICODE_WCHAR - wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner - return TRUE; -} +// Same thing for mb_str() which returns a normal char pointer to string +// contents: this always requires converting it to the specified encoding in +// non-ANSI build except if we need to convert to UTF-8 and this is what we +// already use internally. +#if wxUSE_UNICODE -// allocate enough memory for nLen characters -bool wxString::Alloc(size_t nLen) +const char *wxString::AsChar(const wxMBConv& conv) const { - wxStringData *pData = GetStringData(); - if ( pData->nAllocLength <= nLen ) { - if ( pData->IsEmpty() ) { - nLen += EXTRA_ALLOC; +#if wxUSE_UNICODE_UTF8 + if ( conv.IsUTF8() ) + return m_impl.c_str(); - wxStringData* pData = (wxStringData*) - malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar)); + const wchar_t * const strWC = AsWChar(wxMBConvStrictUTF8()); + const size_t lenWC = m_convertedToWChar.m_len; +#else // wxUSE_UNICODE_WCHAR + const wchar_t * const strWC = m_impl.c_str(); + const size_t lenWC = m_impl.length(); +#endif // wxUSE_UNICODE_UTF8/wxUSE_UNICODE_WCHAR - if ( pData == NULL ) { - // allocation failure handled by caller - return FALSE; - } + const size_t lenMB = conv.FromWChar(NULL, 0, strWC, lenWC); + if ( lenMB == wxCONV_FAILED ) + return NULL; - 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(); + if ( !m_convertedToChar.m_str || lenMB != m_convertedToChar.m_len ) + { + if ( !const_cast(this)->m_convertedToChar.Extend(lenMB) ) + return NULL; } - } - //else: we've already got enough - return TRUE; + + m_convertedToChar.m_str[lenMB] = '\0'; + if ( conv.FromWChar(m_convertedToChar.m_str, lenMB, + strWC, lenWC) == wxCONV_FAILED ) + return NULL; + + return m_convertedToChar.m_str; } +#endif // wxUSE_UNICODE + // 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(); - } - - pData->nAllocLength = nLen; - - return TRUE; + wxString tmp(begin(), end()); + swap(tmp); + return tmp.length() == length(); } -// get the pointer to writable buffer of (at least) nLen bytes -wxChar *wxString::GetWriteBuf(size_t nLen) +// deprecated compatibility code: +#if WXWIN_COMPATIBILITY_2_8 && !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8 +wxStringCharType *wxString::GetWriteBuf(size_t nLen) { - if ( !AllocBeforeWrite(nLen) ) { - // allocation failure handled by caller - return NULL; - } - - wxASSERT( GetStringData()->nRefs == 1 ); - GetStringData()->Validate(FALSE); - - return m_pchData; + return DoGetWriteBuf(nLen); } -// put string back in a reasonable state after GetWriteBuf void wxString::UngetWriteBuf() { - GetStringData()->nDataLength = wxStrlen(m_pchData); - GetStringData()->Validate(TRUE); + DoUngetWriteBuf(); } void wxString::UngetWriteBuf(size_t nLen) { - GetStringData()->nDataLength = nLen; - GetStringData()->Validate(TRUE); + DoUngetWriteBuf(nLen); } +#endif // WXWIN_COMPATIBILITY_2_8 && !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8 + // --------------------------------------------------------------------------- // data access @@ -522,1640 +590,1586 @@ void wxString::UngetWriteBuf(size_t nLen) // all functions are inline in string.h // --------------------------------------------------------------------------- -// assignment operators +// concatenation operators // --------------------------------------------------------------------------- -// helper function: does real copy -bool wxString::AssignCopy(size_t nSrcLen, const wxChar *pszSrcData) -{ - if ( nSrcLen == 0 ) { - Reinit(); - } - else { - if ( !AllocBeforeWrite(nSrcLen) ) { - // allocation failure handled by caller - return FALSE; - } - memcpy(m_pchData, pszSrcData, nSrcLen*sizeof(wxChar)); - GetStringData()->nDataLength = nSrcLen; - m_pchData[nSrcLen] = wxT('\0'); - } - return TRUE; -} +/* + * concatenation functions come in 5 flavours: + * string + string + * char + string and string + char + * C str + string and string + C str + */ -// assigns one string to another -wxString& wxString::operator=(const wxString& stringSrc) +wxString operator+(const wxString& str1, const wxString& str2) { - wxASSERT( stringSrc.GetStringData()->IsValid() ); +#if !wxUSE_STL_BASED_WXSTRING + wxASSERT( str1.IsValid() ); + wxASSERT( str2.IsValid() ); +#endif - // don't copy string over itself - if ( m_pchData != stringSrc.m_pchData ) { - if ( stringSrc.GetStringData()->IsEmpty() ) { - Reinit(); - } - else { - // adjust references - GetStringData()->Unlock(); - m_pchData = stringSrc.m_pchData; - GetStringData()->Lock(); - } - } + wxString s = str1; + s += str2; - return *this; + return s; } -// assigns a single character -wxString& wxString::operator=(wxChar ch) +wxString operator+(const wxString& str, wxUniChar ch) { - if ( !AssignCopy(1, &ch) ) { - wxFAIL_MSG( _T("out of memory in wxString::operator=(wxChar)") ); - } - return *this; -} +#if !wxUSE_STL_BASED_WXSTRING + wxASSERT( str.IsValid() ); +#endif + wxString s = str; + s += ch; -// assigns C string -wxString& wxString::operator=(const wxChar *psz) -{ - if ( !AssignCopy(wxStrlen(psz), psz) ) { - wxFAIL_MSG( _T("out of memory in wxString::operator=(const wxChar *)") ); - } - return *this; + return s; } -#if !wxUSE_UNICODE - -// same as 'signed char' variant -wxString& wxString::operator=(const unsigned char* psz) +wxString operator+(wxUniChar ch, const wxString& str) { - *this = (const char *)psz; - return *this; -} +#if !wxUSE_STL_BASED_WXSTRING + wxASSERT( str.IsValid() ); +#endif -#if wxUSE_WCHAR_T -wxString& wxString::operator=(const wchar_t *pwz) -{ - wxString str(pwz); - *this = str; - return *this; + wxString s = ch; + s += str; + + return s; } -#endif +wxString operator+(const wxString& str, const char *psz) +{ +#if !wxUSE_STL_BASED_WXSTRING + wxASSERT( str.IsValid() ); #endif -// --------------------------------------------------------------------------- -// string concatenation -// --------------------------------------------------------------------------- - -// add something to this string -bool wxString::ConcatSelf(int nSrcLen, const wxChar *pszSrcData) -{ - STATISTICS_ADD(SummandLength, nSrcLen); - - // concatenating an empty string is a NOP - 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() ) { - STATISTICS_ADD(ConcatHit, 0); - - // we have to allocate another buffer - wxStringData* pOldData = GetStringData(); - if ( !AllocBuffer(nNewLen) ) { - // allocation failure handled by caller - return FALSE; - } - memcpy(m_pchData, pOldData->data(), nLen*sizeof(wxChar)); - pOldData->Unlock(); - } - else if ( nNewLen > pData->nAllocLength ) { - STATISTICS_ADD(ConcatHit, 0); - - // we have to grow the buffer - if ( !Alloc(nNewLen) ) { - // allocation failure handled by caller - return FALSE; - } + wxString s; + if ( !s.Alloc(strlen(psz) + str.length()) ) { + wxFAIL_MSG( wxT("out of memory in wxString::operator+") ); } - else { - STATISTICS_ADD(ConcatHit, 1); + s += str; + s += psz; - // the buffer is already big enough - } + return s; +} - // should be enough space - wxASSERT( nNewLen <= GetStringData()->nAllocLength ); +wxString operator+(const wxString& str, const wchar_t *pwz) +{ +#if !wxUSE_STL_BASED_WXSTRING + wxASSERT( str.IsValid() ); +#endif - // fast concatenation - all is done in our buffer - memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(wxChar)); + wxString s; + if ( !s.Alloc(wxWcslen(pwz) + str.length()) ) { + wxFAIL_MSG( wxT("out of memory in wxString::operator+") ); + } + s += str; + s += pwz; - m_pchData[nNewLen] = wxT('\0'); // put terminating '\0' - GetStringData()->nDataLength = nNewLen; // and fix the length - } - //else: the string to append was empty - return TRUE; + return s; } -/* - * concatenation functions come in 5 flavours: - * string + string - * char + string and string + char - * C str + string and string + C str - */ - -wxString operator+(const wxString& str1, const wxString& str2) +wxString operator+(const char *psz, const wxString& str) { - wxASSERT( str1.GetStringData()->IsValid() ); - wxASSERT( str2.GetStringData()->IsValid() ); +#if !wxUSE_STL_BASED_WXSTRING + wxASSERT( str.IsValid() ); +#endif - wxString s = str1; - s += str2; + wxString s; + if ( !s.Alloc(strlen(psz) + str.length()) ) { + wxFAIL_MSG( wxT("out of memory in wxString::operator+") ); + } + s = psz; + s += str; - return s; + return s; } -wxString operator+(const wxString& str, wxChar ch) +wxString operator+(const wchar_t *pwz, const wxString& str) { - wxASSERT( str.GetStringData()->IsValid() ); +#if !wxUSE_STL_BASED_WXSTRING + wxASSERT( str.IsValid() ); +#endif - wxString s = str; - s += ch; + wxString s; + if ( !s.Alloc(wxWcslen(pwz) + str.length()) ) { + wxFAIL_MSG( wxT("out of memory in wxString::operator+") ); + } + s = pwz; + s += str; - return s; + return s; } -wxString operator+(wxChar ch, const wxString& str) +// --------------------------------------------------------------------------- +// string comparison +// --------------------------------------------------------------------------- + +bool wxString::IsSameAs(wxUniChar c, bool compareWithCase) const { - wxASSERT( str.GetStringData()->IsValid() ); + return (length() == 1) && (compareWithCase ? GetChar(0u) == c + : wxToupper(GetChar(0u)) == wxToupper(c)); +} - wxString s = ch; - s += str; +#ifdef HAVE_STD_STRING_COMPARE - return s; -} +// NB: Comparison code (both if HAVE_STD_STRING_COMPARE and if not) works with +// UTF-8 encoded strings too, thanks to UTF-8's design which allows us to +// sort strings in characters code point order by sorting the byte sequence +// in byte values order (i.e. what strcmp() and memcmp() do). -wxString operator+(const wxString& str, const wxChar *psz) +int wxString::compare(const wxString& str) const { - wxASSERT( str.GetStringData()->IsValid() ); - - wxString s; - if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) { - wxFAIL_MSG( _T("out of memory in wxString::operator+") ); - } - s = str; - s += psz; + return m_impl.compare(str.m_impl); +} - return s; +int wxString::compare(size_t nStart, size_t nLen, + const wxString& str) const +{ + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); + return m_impl.compare(pos, len, str.m_impl); } -wxString operator+(const wxChar *psz, const wxString& str) +int wxString::compare(size_t nStart, size_t nLen, + const wxString& str, + size_t nStart2, size_t nLen2) const { - wxASSERT( str.GetStringData()->IsValid() ); + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); - wxString s; - if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) { - wxFAIL_MSG( _T("out of memory in wxString::operator+") ); - } - s = psz; - s += str; + size_t pos2, len2; + str.PosLenToImpl(nStart2, nLen2, &pos2, &len2); - return s; + return m_impl.compare(pos, len, str.m_impl, pos2, len2); } -// =========================================================================== -// other common string functions -// =========================================================================== - -#if wxUSE_UNICODE - -wxString wxString::FromAscii(const char *ascii) +int wxString::compare(const char* sz) const { - 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; + return m_impl.compare(ImplStr(sz)); } -wxString wxString::FromAscii(const char ascii) +int wxString::compare(const wchar_t* sz) const { - // What do we do with '\0' ? - - wxString res; - res += (wchar_t)(unsigned char) ascii; - - return res; + return m_impl.compare(ImplStr(sz)); } -const wxCharBuffer wxString::ToAscii() const +int wxString::compare(size_t nStart, size_t nLen, + const char* sz, size_t nCount) const { - // this will allocate enough space for the terminating NUL too - wxCharBuffer buffer(length()); + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); - signed char *dest = (signed char *)buffer.data(); + SubstrBufFromMB str(ImplStr(sz, nCount)); - const wchar_t *pwc = c_str(); - for ( ;; ) - { - *dest++ = *pwc > SCHAR_MAX ? '_' : *pwc; + return m_impl.compare(pos, len, str.data, str.len); +} - // 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; - } +int wxString::compare(size_t nStart, size_t nLen, + const wchar_t* sz, size_t nCount) const +{ + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); - return buffer; -} + SubstrBufFromWC str(ImplStr(sz, nCount)); -#endif // Unicode + return m_impl.compare(pos, len, str.data, str.len); +} -// --------------------------------------------------------------------------- -// simple sub-string extraction -// --------------------------------------------------------------------------- +#else // !HAVE_STD_STRING_COMPARE -// helper function: clone the data attached to this string -bool wxString::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const +static inline int wxDoCmp(const wxStringCharType* s1, size_t l1, + const wxStringCharType* s2, size_t l2) { - if ( nCopyLen == 0 ) { - dest.Init(); - } - else { - if ( !dest.AllocBuffer(nCopyLen) ) { - // allocation failure handled by caller - return FALSE; + if( l1 == l2 ) + return wxStringMemcmp(s1, s2, l1); + else if( l1 < l2 ) + { + int ret = wxStringMemcmp(s1, s2, l1); + return ret == 0 ? -1 : ret; + } + else + { + int ret = wxStringMemcmp(s1, s2, l2); + return ret == 0 ? +1 : ret; } - memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(wxChar)); - } - return TRUE; } -// extract string of length nCount starting at nFirst -wxString wxString::Mid(size_t nFirst, size_t nCount) const +int wxString::compare(const wxString& str) 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 ( nFirst + nCount > nLen ) - { - nCount = nLen - nFirst; - } + return ::wxDoCmp(m_impl.data(), m_impl.length(), + str.m_impl.data(), str.m_impl.length()); +} - if ( nFirst > nLen ) - { - // AllocCopy() will return empty string - nCount = 0; - } +int wxString::compare(size_t nStart, size_t nLen, + const wxString& str) const +{ + wxASSERT(nStart <= length()); + size_type strLen = length() - nStart; + nLen = strLen < nLen ? strLen : nLen; - wxString dest; - if ( !AllocCopy(dest, nCount, nFirst) ) { - wxFAIL_MSG( _T("out of memory in wxString::Mid") ); - } + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); - return dest; + return ::wxDoCmp(m_impl.data() + pos, len, + str.m_impl.data(), str.m_impl.length()); } -// 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 +int wxString::compare(size_t nStart, size_t nLen, + const wxString& str, + size_t nStart2, size_t nLen2) const { - wxASSERT_MSG( prefix, _T("invalid parameter in wxString::StartsWith") ); + wxASSERT(nStart <= length()); + wxASSERT(nStart2 <= str.length()); + size_type strLen = length() - nStart, + strLen2 = str.length() - nStart2; + nLen = strLen < nLen ? strLen : nLen; + nLen2 = strLen2 < nLen2 ? strLen2 : nLen2; - // 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; - } + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); + size_t pos2, len2; + str.PosLenToImpl(nStart2, nLen2, &pos2, &len2); - return TRUE; + return ::wxDoCmp(m_impl.data() + pos, len, + str.m_impl.data() + pos2, len2); } -// extract nCount last (rightmost) characters -wxString wxString::Right(size_t nCount) const +int wxString::compare(const char* sz) const { - if ( nCount > (size_t)GetStringData()->nDataLength ) - nCount = GetStringData()->nDataLength; - - wxString dest; - if ( !AllocCopy(dest, nCount, GetStringData()->nDataLength - nCount) ) { - wxFAIL_MSG( _T("out of memory in wxString::Right") ); - } - return dest; + SubstrBufFromMB str(ImplStr(sz, npos)); + if ( str.len == npos ) + str.len = wxStringStrlen(str.data); + return ::wxDoCmp(m_impl.data(), m_impl.length(), str.data, str.len); } -// get all characters after the last occurence of ch -// (returns the whole string if ch not found) -wxString wxString::AfterLast(wxChar ch) const +int wxString::compare(const wchar_t* sz) const { - wxString str; - int iPos = Find(ch, TRUE); - if ( iPos == wxNOT_FOUND ) - str = *this; - else - str = c_str() + iPos + 1; - - return str; + SubstrBufFromWC str(ImplStr(sz, npos)); + if ( str.len == npos ) + str.len = wxStringStrlen(str.data); + return ::wxDoCmp(m_impl.data(), m_impl.length(), str.data, str.len); } -// extract nCount first (leftmost) characters -wxString wxString::Left(size_t nCount) const +int wxString::compare(size_t nStart, size_t nLen, + const char* sz, size_t nCount) const { - if ( nCount > (size_t)GetStringData()->nDataLength ) - nCount = GetStringData()->nDataLength; + wxASSERT(nStart <= length()); + size_type strLen = length() - nStart; + nLen = strLen < nLen ? strLen : nLen; - wxString dest; - if ( !AllocCopy(dest, nCount, 0) ) { - wxFAIL_MSG( _T("out of memory in wxString::Left") ); - } - return dest; -} + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); -// get all characters before the first occurence of ch -// (returns the whole string if ch not found) -wxString wxString::BeforeFirst(wxChar ch) const -{ - wxString str; - for ( const wxChar *pc = m_pchData; *pc != wxT('\0') && *pc != ch; pc++ ) - str += *pc; + SubstrBufFromMB str(ImplStr(sz, nCount)); + if ( str.len == npos ) + str.len = wxStringStrlen(str.data); - return str; + return ::wxDoCmp(m_impl.data() + pos, len, str.data, str.len); } -/// get all characters before the last occurence of ch -/// (returns empty string if ch not found) -wxString wxString::BeforeLast(wxChar ch) const +int wxString::compare(size_t nStart, size_t nLen, + const wchar_t* sz, size_t nCount) const { - wxString str; - int iPos = Find(ch, TRUE); - if ( iPos != wxNOT_FOUND && iPos != 0 ) - str = wxString(c_str(), iPos); + wxASSERT(nStart <= length()); + size_type strLen = length() - nStart; + nLen = strLen < nLen ? strLen : nLen; - return str; -} + size_t pos, len; + PosLenToImpl(nStart, nLen, &pos, &len); -/// get all characters after the first occurence of ch -/// (returns empty string if ch not found) -wxString wxString::AfterFirst(wxChar ch) const -{ - wxString str; - int iPos = Find(ch); - if ( iPos != wxNOT_FOUND ) - str = c_str() + iPos + 1; + SubstrBufFromWC str(ImplStr(sz, nCount)); + if ( str.len == npos ) + str.len = wxStringStrlen(str.data); - return str; + return ::wxDoCmp(m_impl.data() + pos, len, str.data, str.len); } -// replace first (or all) occurences of some substring with another one -size_t wxString::Replace(const wxChar *szOld, const wxChar *szNew, bool bReplaceAll) -{ - size_t uiCount = 0; // count of replacements made - - size_t uiOldLen = wxStrlen(szOld); +#endif // HAVE_STD_STRING_COMPARE/!HAVE_STD_STRING_COMPARE - wxString strTemp; - 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 ) - return 0; - strTemp += pCurrent; // copy the rest - break; // exit the loop - } - else { - // take chars before match - 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 - - uiCount++; - - // stop now? - if ( !bReplaceAll ) { - strTemp += pCurrent; // copy the rest - break; // exit the loop - } - } - } +// --------------------------------------------------------------------------- +// find_{first,last}_[not]_of functions +// --------------------------------------------------------------------------- - // only done if there were replacements, otherwise would have returned above - *this = strTemp; +#if !wxUSE_STL_BASED_WXSTRING || wxUSE_UNICODE_UTF8 - return uiCount; -} +// NB: All these functions are implemented with the argument being wxChar*, +// i.e. widechar string in any Unicode build, even though native string +// representation is char* in the UTF-8 build. This is because we couldn't +// use memchr() to determine if a character is in a set encoded as UTF-8. -bool wxString::IsAscii() const +size_t wxString::find_first_of(const wxChar* sz, size_t nStart) const { - const wxChar *s = (const wxChar*) *this; - while(*s){ - if(!isascii(*s)) return(FALSE); - s++; - } - return(TRUE); + return find_first_of(sz, nStart, wxStrlen(sz)); } -bool wxString::IsWord() const +size_t wxString::find_first_not_of(const wxChar* sz, size_t nStart) const { - const wxChar *s = (const wxChar*) *this; - while(*s){ - if(!wxIsalpha(*s)) return(FALSE); - s++; - } - return(TRUE); + return find_first_not_of(sz, nStart, wxStrlen(sz)); } -bool wxString::IsNumber() const +size_t wxString::find_first_of(const wxChar* sz, size_t nStart, size_t n) const { - const wxChar *s = (const wxChar*) *this; - if (wxStrlen(s)) - if ((s[0] == '-') || (s[0] == '+')) s++; - while(*s){ - if(!wxIsdigit(*s)) return(FALSE); - s++; - } - return(TRUE); + wxASSERT_MSG( nStart <= length(), wxT("invalid index") ); + + size_t idx = nStart; + for ( const_iterator i = begin() + nStart; i != end(); ++idx, ++i ) + { + if ( wxTmemchr(sz, *i, n) ) + return idx; + } + + return npos; } -wxString wxString::Strip(stripType w) const +size_t wxString::find_first_not_of(const wxChar* sz, size_t nStart, size_t n) const { - wxString s = *this; - if ( w & leading ) s.Trim(FALSE); - if ( w & trailing ) s.Trim(TRUE); - return s; -} + wxASSERT_MSG( nStart <= length(), wxT("invalid index") ); -// --------------------------------------------------------------------------- -// case conversion -// --------------------------------------------------------------------------- + size_t idx = nStart; + for ( const_iterator i = begin() + nStart; i != end(); ++idx, ++i ) + { + if ( !wxTmemchr(sz, *i, n) ) + return idx; + } -wxString& wxString::MakeUpper() -{ - if ( !CopyBeforeWrite() ) { - wxFAIL_MSG( _T("out of memory in wxString::MakeUpper") ); - return *this; - } + return npos; +} - for ( wxChar *p = m_pchData; *p; p++ ) - *p = (wxChar)wxToupper(*p); - return *this; +size_t wxString::find_last_of(const wxChar* sz, size_t nStart) const +{ + return find_last_of(sz, nStart, wxStrlen(sz)); } -wxString& wxString::MakeLower() +size_t wxString::find_last_not_of(const wxChar* sz, size_t nStart) const { - if ( !CopyBeforeWrite() ) { - wxFAIL_MSG( _T("out of memory in wxString::MakeLower") ); - return *this; - } + return find_last_not_of(sz, nStart, wxStrlen(sz)); +} - for ( wxChar *p = m_pchData; *p; p++ ) - *p = (wxChar)wxTolower(*p); +size_t wxString::find_last_of(const wxChar* sz, size_t nStart, size_t n) const +{ + size_t len = length(); - return *this; -} + if ( nStart == npos ) + { + nStart = len - 1; + } + else + { + wxASSERT_MSG( nStart <= len, wxT("invalid index") ); + } -// --------------------------------------------------------------------------- -// trimming and padding -// --------------------------------------------------------------------------- + size_t idx = nStart; + for ( const_reverse_iterator i = rbegin() + (len - nStart - 1); + i != rend(); --idx, ++i ) + { + if ( wxTmemchr(sz, *i, n) ) + return idx; + } -// 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); } + return npos; +} -// trims spaces (in the sense of isspace) from left or right side -wxString& wxString::Trim(bool bFromRight) +size_t wxString::find_last_not_of(const wxChar* sz, size_t nStart, size_t n) const { - // first check if we're going to modify the string at all - if ( !IsEmpty() && - ( - (bFromRight && wxSafeIsspace(GetChar(Len() - 1))) || - (!bFromRight && wxSafeIsspace(GetChar(0u))) - ) - ) - { - // ok, there is at least one space to trim - if ( !CopyBeforeWrite() ) { - wxFAIL_MSG( _T("out of memory in wxString::Trim") ); - return *this; - } + size_t len = length(); - if ( bFromRight ) + if ( nStart == npos ) { - // 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; + nStart = len - 1; } 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; + wxASSERT_MSG( nStart <= len, wxT("invalid index") ); } - } - return *this; + size_t idx = nStart; + for ( const_reverse_iterator i = rbegin() + (len - nStart - 1); + i != rend(); --idx, ++i ) + { + if ( !wxTmemchr(sz, *i, n) ) + return idx; + } + + return npos; } -// adds nCount characters chPad to the string from either side -wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight) +size_t wxString::find_first_not_of(wxUniChar ch, size_t nStart) const { - wxString s(chPad, nCount); + wxASSERT_MSG( nStart <= length(), wxT("invalid index") ); - if ( bFromRight ) - *this += s; - else - { - s += *this; - *this = s; - } + size_t idx = nStart; + for ( const_iterator i = begin() + nStart; i != end(); ++idx, ++i ) + { + if ( *i != ch ) + return idx; + } - return *this; + return npos; } -// truncate the string -wxString& wxString::Truncate(size_t uiLen) +size_t wxString::find_last_not_of(wxUniChar ch, size_t nStart) const { - if ( uiLen < Len() ) { - if ( !CopyBeforeWrite() ) { - wxFAIL_MSG( _T("out of memory in wxString::Truncate") ); - return *this; + size_t len = length(); + + if ( nStart == npos ) + { + nStart = len - 1; + } + else + { + wxASSERT_MSG( nStart <= len, wxT("invalid index") ); } - *(m_pchData + uiLen) = wxT('\0'); - GetStringData()->nDataLength = uiLen; - } - //else: nothing to do, string is already short enough + size_t idx = nStart; + for ( const_reverse_iterator i = rbegin() + (len - nStart - 1); + i != rend(); --idx, ++i ) + { + if ( *i != ch ) + return idx; + } - return *this; + return npos; } -// --------------------------------------------------------------------------- -// finding (return wxNOT_FOUND if not found and index otherwise) -// --------------------------------------------------------------------------- +// the functions above were implemented for wchar_t* arguments in Unicode +// build and char* in ANSI build; below are implementations for the other +// version: +#if wxUSE_UNICODE + #define wxOtherCharType char + #define STRCONV (const wxChar*)wxConvLibc.cMB2WC +#else + #define wxOtherCharType wchar_t + #define STRCONV (const wxChar*)wxConvLibc.cWC2MB +#endif -// find a character -int wxString::Find(wxChar ch, bool bFromEnd) const -{ - const wxChar *psz = bFromEnd ? wxStrrchr(m_pchData, ch) : wxStrchr(m_pchData, ch); +size_t wxString::find_first_of(const wxOtherCharType* sz, size_t nStart) const + { return find_first_of(STRCONV(sz), nStart); } + +size_t wxString::find_first_of(const wxOtherCharType* sz, size_t nStart, + size_t n) const + { return find_first_of(STRCONV(sz, n, NULL), nStart, n); } +size_t wxString::find_last_of(const wxOtherCharType* sz, size_t nStart) const + { return find_last_of(STRCONV(sz), nStart); } +size_t wxString::find_last_of(const wxOtherCharType* sz, size_t nStart, + size_t n) const + { return find_last_of(STRCONV(sz, n, NULL), nStart, n); } +size_t wxString::find_first_not_of(const wxOtherCharType* sz, size_t nStart) const + { return find_first_not_of(STRCONV(sz), nStart); } +size_t wxString::find_first_not_of(const wxOtherCharType* sz, size_t nStart, + size_t n) const + { return find_first_not_of(STRCONV(sz, n, NULL), nStart, n); } +size_t wxString::find_last_not_of(const wxOtherCharType* sz, size_t nStart) const + { return find_last_not_of(STRCONV(sz), nStart); } +size_t wxString::find_last_not_of(const wxOtherCharType* sz, size_t nStart, + size_t n) const + { return find_last_not_of(STRCONV(sz, n, NULL), nStart, n); } + +#undef wxOtherCharType +#undef STRCONV + +#endif // !wxUSE_STL_BASED_WXSTRING || wxUSE_UNICODE_UTF8 - return (psz == NULL) ? wxNOT_FOUND : psz - (const wxChar*) m_pchData; -} +// =========================================================================== +// other common string functions +// =========================================================================== -// find a sub-string (like strstr) -int wxString::Find(const wxChar *pszSub) const +int wxString::CmpNoCase(const wxString& s) const { - const wxChar *psz = wxStrstr(m_pchData, pszSub); +#if defined(__WXMSW__) && !wxUSE_UNICODE_UTF8 + // prefer to use CompareString() if available as it's more efficient than + // doing it manual or even using wxStricmp() (see #10375) + switch ( ::CompareString(LOCALE_USER_DEFAULT, NORM_IGNORECASE, + m_impl.c_str(), m_impl.length(), + s.m_impl.c_str(), s.m_impl.length()) ) + { + case CSTR_LESS_THAN: + return -1; - return (psz == NULL) ? wxNOT_FOUND : psz - (const wxChar*) m_pchData; -} + case CSTR_EQUAL: + return 0; -// ---------------------------------------------------------------------------- -// conversion to numbers -// ---------------------------------------------------------------------------- + case CSTR_GREATER_THAN: + return 1; -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") ); + default: + wxFAIL_MSG( "unexpected CompareString() return value" ); + // fall through + + case 0: + wxLogLastError("CompareString"); + // use generic code below + } +#endif // __WXMSW__ && !wxUSE_UNICODE_UTF8 - const wxChar *start = c_str(); - wxChar *end; - *val = wxStrtol(start, &end, base); + // do the comparison manually: notice that we can't use wxStricmp() as it + // doesn't handle embedded NULs - // 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); -} + // FIXME-UTF8: use wxUniChar::ToLower/ToUpper once added + const_iterator i1 = begin(); + const_iterator end1 = end(); + const_iterator i2 = s.begin(); + const_iterator end2 = s.end(); -bool wxString::ToULong(unsigned long *val, int base) const -{ - wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToULong") ); - wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") ); + for ( ; i1 != end1 && i2 != end2; ++i1, ++i2 ) + { + wxUniChar lower1 = (wxChar)wxTolower(*i1); + wxUniChar lower2 = (wxChar)wxTolower(*i2); + if ( lower1 != lower2 ) + return lower1 < lower2 ? -1 : 1; + } - const wxChar *start = c_str(); - wxChar *end; - *val = wxStrtoul(start, &end, base); + size_t len1 = length(); + size_t len2 = s.length(); - // 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); + if ( len1 < len2 ) + return -1; + else if ( len1 > len2 ) + return 1; + return 0; } -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); -} +#if wxUSE_UNICODE -// --------------------------------------------------------------------------- -// formatted output -// --------------------------------------------------------------------------- +#ifdef __MWERKS__ +#ifndef __SCHAR_MAX__ +#define __SCHAR_MAX__ 127 +#endif +#endif -/* static */ -wxString wxString::Format(const wxChar *pszFormat, ...) +wxString wxString::FromAscii(const char *ascii, size_t len) { - va_list argptr; - va_start(argptr, pszFormat); + if (!ascii || len == 0) + return wxEmptyString; - wxString s; - s.PrintfV(pszFormat, argptr); + wxString res; - va_end(argptr); + { + wxStringInternalBuffer buf(res, len); + wxStringCharType *dest = buf; - return s; + for ( ; len > 0; --len ) + { + unsigned char c = (unsigned char)*ascii++; + wxASSERT_MSG( c < 0x80, + wxT("Non-ASCII value passed to FromAscii().") ); + + *dest++ = (wchar_t)c; + } + } + + return res; } -/* static */ -wxString wxString::FormatV(const wxChar *pszFormat, va_list argptr) +wxString wxString::FromAscii(const char *ascii) { - wxString s; - s.PrintfV(pszFormat, argptr); - return s; + return FromAscii(ascii, wxStrlen(ascii)); } -int wxString::Printf(const wxChar *pszFormat, ...) +wxString wxString::FromAscii(char ascii) { - va_list argptr; - va_start(argptr, pszFormat); + // What do we do with '\0' ? - int iLen = PrintfV(pszFormat, argptr); + unsigned char c = (unsigned char)ascii; - va_end(argptr); + wxASSERT_MSG( c < 0x80, wxT("Non-ASCII value passed to FromAscii().") ); - return iLen; + // NB: the cast to wchar_t causes interpretation of 'ascii' as Latin1 value + return wxString(wxUniChar((wchar_t)c)); } -int wxString::PrintfV(const wxChar* pszFormat, va_list argptr) +const wxScopedCharBuffer wxString::ToAscii() const { - int size = 1024; - for ( ;; ) + // this will allocate enough space for the terminating NUL too + wxCharBuffer buffer(length()); + char *dest = buffer.data(); + + for ( const_iterator i = begin(); i != end(); ++i ) { - wxChar *buf = GetWriteBuf(size + 1); - if ( !buf ) - { - // out of memory - return -1; - } - - int len = wxVsnprintf(buf, size, pszFormat, argptr); - - // 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'); + wxUniChar c(*i); + // FIXME-UTF8: unify substituted char ('_') with wxUniChar ('?') + *dest++ = c.IsAscii() ? (char)c : '_'; - UngetWriteBuf(); - - if ( len >= 0 ) - { - // ok, there was enough space + // 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 ( !c ) break; - } - - // still not enough, double it again - size *= 2; } - // we could have overshot - Shrink(); - - return Len(); + return buffer; } -// ---------------------------------------------------------------------------- -// misc other operations -// ---------------------------------------------------------------------------- +#endif // wxUSE_UNICODE -// 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 +// extract string of length nCount starting at nFirst +wxString wxString::Mid(size_t nFirst, size_t nCount) 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)); + size_t nLen = length(); - pattern += _T('^'); - while ( *pszMask ) + // default value of nCount is npos and means "till the end" + if ( nCount == npos ) { - 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++; + nCount = nLen - nFirst; } - 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; + // out-of-bounds requests return sensible things + if ( nFirst + nCount > nLen ) + { + nCount = nLen - nFirst; } - } - // 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 + if ( nFirst > nLen ) + { + // AllocCopy() will return empty string + return wxEmptyString; + } - goto match; - } + wxString dest(*this, nFirst, nCount); + if ( dest.length() != nCount ) + { + wxFAIL_MSG( wxT("out of memory in wxString::Mid") ); + } - return FALSE; -#endif // wxUSE_REGEX/!wxUSE_REGEX + return dest; } -// Count the number of chars -int wxString::Freq(wxChar ch) const +// check that the string 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 wxString& prefix, wxString *rest) const { - int count = 0; - int len = Len(); - for (int i = 0; i < len; i++) + if ( compare(0, prefix.length(), prefix) != 0 ) + return false; + + if ( rest ) { - if (GetChar(i) == ch) - count ++; + // put the rest of the string into provided pointer + rest->assign(*this, prefix.length(), npos); } - return count; + + return true; } -// 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(); } +// check that the string ends with suffix and return the rest of it in the +// provided pointer if it is not NULL, otherwise return false +bool wxString::EndsWith(const wxString& suffix, wxString *rest) const +{ + int start = length() - suffix.length(); -int wxString::sprintf(const wxChar *pszFormat, ...) - { - va_list argptr; - va_start(argptr, pszFormat); - int iLen = PrintfV(pszFormat, argptr); - va_end(argptr); - return iLen; - } + if ( start < 0 || compare(start, npos, suffix) != 0 ) + return false; -// --------------------------------------------------------------------------- -// standard C++ library string functions -// --------------------------------------------------------------------------- + if ( rest ) + { + // put the rest of the string into provided pointer + rest->assign(*this, 0, start); + } + + return true; +} -#ifdef wxSTD_STRING_COMPATIBILITY -void wxString::resize(size_t nSize, wxChar ch) +// extract nCount last (rightmost) characters +wxString wxString::Right(size_t nCount) const { - size_t len = length(); + if ( nCount > length() ) + nCount = 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 + wxString dest(*this, length() - nCount, nCount); + if ( dest.length() != nCount ) { + wxFAIL_MSG( wxT("out of memory in wxString::Right") ); + } + return dest; } -void wxString::swap(wxString& str) +// get all characters after the last occurrence of ch +// (returns the whole string if ch not found) +wxString wxString::AfterLast(wxUniChar ch) const { - // 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; + wxString str; + int iPos = Find(ch, true); + if ( iPos == wxNOT_FOUND ) str = *this; - *this = tmp; + else + str.assign(*this, iPos + 1, npos); + + return str; } -wxString& wxString::insert(size_t nPos, const wxString& str) +// extract nCount first (leftmost) characters +wxString wxString::Left(size_t nCount) const { - wxASSERT( str.GetStringData()->IsValid() ); - wxASSERT( nPos <= Len() ); + if ( nCount > length() ) + nCount = length(); - 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; + wxString dest(*this, 0, nCount); + if ( dest.length() != nCount ) { + wxFAIL_MSG( wxT("out of memory in wxString::Left") ); } - - return *this; + return dest; } -size_t wxString::find(const wxString& str, size_t nStart) const +// get all characters before the first occurrence of ch +// (returns the whole string if ch not found) +wxString wxString::BeforeFirst(wxUniChar ch) const { - wxASSERT( str.GetStringData()->IsValid() ); - wxASSERT( nStart <= Len() ); + int iPos = Find(ch); + if ( iPos == wxNOT_FOUND ) + iPos = length(); + return wxString(*this, 0, iPos); +} - const wxChar *p = wxStrstr(c_str() + nStart, str); +/// get all characters before the last occurrence of ch +/// (returns empty string if ch not found) +wxString wxString::BeforeLast(wxUniChar ch) const +{ + wxString str; + int iPos = Find(ch, true); + if ( iPos != wxNOT_FOUND && iPos != 0 ) + str = wxString(c_str(), iPos); - return p == NULL ? npos : p - c_str(); + return str; } -// VC++ 1.5 can't cope with the default argument in the header. -#if !defined(__VISUALC__) || defined(__WIN32__) -size_t wxString::find(const wxChar* sz, size_t nStart, size_t n) const +/// get all characters after the first occurrence of ch +/// (returns empty string if ch not found) +wxString wxString::AfterFirst(wxUniChar ch) const { - return find(wxString(sz, n), nStart); + wxString str; + int iPos = Find(ch); + if ( iPos != wxNOT_FOUND ) + str.assign(*this, iPos + 1, npos); + + return str; } -#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 +// replace first (or all) occurrences of some substring with another one +size_t wxString::Replace(const wxString& strOld, + const wxString& strNew, bool bReplaceAll) { - wxASSERT( nStart <= Len() ); + // if we tried to replace an empty string we'd enter an infinite loop below + wxCHECK_MSG( !strOld.empty(), 0, + wxT("wxString::Replace(): invalid parameter") ); - const wxChar *p = wxStrchr(c_str() + nStart, ch); + wxSTRING_INVALIDATE_CACHE(); - return p == NULL ? npos : p - c_str(); -} -#endif + size_t uiCount = 0; // count of replacements made -size_t wxString::rfind(const wxString& str, size_t nStart) const -{ - wxASSERT( str.GetStringData()->IsValid() ); - wxASSERT( nStart == npos || nStart <= Len() ); + // optimize the special common case: replacement of one character by + // another one (in UTF-8 case we can only do this for ASCII characters) + // + // benchmarks show that this special version is around 3 times faster + // (depending on the proportion of matching characters and UTF-8/wchar_t + // build) + if ( strOld.m_impl.length() == 1 && strNew.m_impl.length() == 1 ) + { + const wxStringCharType chOld = strOld.m_impl[0], + chNew = strNew.m_impl[0]; - // TODO could be made much quicker than that - const wxChar *p = c_str() + (nStart == npos ? Len() : nStart); - while ( p >= c_str() + str.Len() ) { - if ( wxStrncmp(p - str.Len(), str, str.Len()) == 0 ) - return p - str.Len() - c_str(); - p--; - } + // this loop is the simplified version of the one below + for ( size_t pos = 0; ; ) + { + pos = m_impl.find(chOld, pos); + if ( pos == npos ) + break; - return npos; -} + m_impl[pos++] = chNew; -// VC++ 1.5 can't cope with the default argument in the header. -#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 ? wxSTRING_MAXLEN : n), nStart); -} + uiCount++; -size_t wxString::rfind(wxChar ch, size_t nStart) const -{ - if ( nStart == npos ) - { - nStart = Len(); + if ( !bReplaceAll ) + break; + } } - else + else if ( !bReplaceAll) { - wxASSERT( nStart <= Len() ); + size_t pos = m_impl.find(strOld, 0); + if ( pos != npos ) + { + m_impl.replace(pos, strOld.m_impl.length(), strNew.m_impl); + uiCount = 1; + } } + else // replace all occurrences + { + const size_t uiOldLen = strOld.m_impl.length(); + const size_t uiNewLen = strNew.m_impl.length(); - const wxChar *p = wxStrrchr(c_str(), ch); + // first scan the string to find all positions at which the replacement + // should be made + wxVector replacePositions; - if ( p == NULL ) - return npos; + size_t pos; + for ( pos = m_impl.find(strOld.m_impl, 0); + pos != npos; + pos = m_impl.find(strOld.m_impl, pos + uiOldLen)) + { + replacePositions.push_back(pos); + ++uiCount; + } - size_t result = p - c_str(); - return ( result > nStart ) ? npos : result; -} -#endif // VC++ 1.5 + if ( !uiCount ) + return 0; -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; + // allocate enough memory for the whole new string + wxString tmp; + tmp.m_impl.reserve(m_impl.length() + uiCount*(uiNewLen - uiOldLen)); + + // copy this string to tmp doing replacements on the fly + size_t replNum = 0; + for ( pos = 0; replNum < uiCount; replNum++ ) + { + const size_t nextReplPos = replacePositions[replNum]; + + if ( pos != nextReplPos ) + { + tmp.m_impl.append(m_impl, pos, nextReplPos - pos); + } + + tmp.m_impl.append(strNew.m_impl); + pos = nextReplPos + uiOldLen; + } + + if ( pos != m_impl.length() ) + { + // append the rest of the string unchanged + tmp.m_impl.append(m_impl, pos, m_impl.length() - pos); + } + + swap(tmp); + } + + return uiCount; } -size_t wxString::find_last_of(const wxChar* sz, size_t nStart) const +bool wxString::IsAscii() const { - if ( nStart == npos ) + for ( const_iterator i = begin(); i != end(); ++i ) { - nStart = Len(); - } - else - { - wxASSERT( nStart <= Len() ); + if ( !(*i).IsAscii() ) + return false; } - for ( const wxChar *p = c_str() + length() - 1; p >= c_str(); p-- ) + return true; +} + +bool wxString::IsWord() const +{ + for ( const_iterator i = begin(); i != end(); ++i ) { - if ( wxStrchr(sz, *p) ) - return p - c_str(); + if ( !wxIsalpha(*i) ) + return false; } - return npos; + return true; } -size_t wxString::find_first_not_of(const wxChar* sz, size_t nStart) const +bool wxString::IsNumber() const { - if ( nStart == npos ) - { - nStart = Len(); - } - else + if ( empty() ) + return true; + + const_iterator i = begin(); + + if ( *i == wxT('-') || *i == wxT('+') ) + ++i; + + for ( ; i != end(); ++i ) { - wxASSERT( nStart <= Len() ); + if ( !wxIsdigit(*i) ) + return false; } - size_t nAccept = wxStrspn(c_str() + nStart, sz); - if ( nAccept >= length() - nStart ) - return npos; - else - return nAccept; + return true; } -size_t wxString::find_first_not_of(wxChar ch, size_t nStart) const +wxString wxString::Strip(stripType w) const { - wxASSERT( nStart <= Len() ); + wxString s = *this; + if ( w & leading ) s.Trim(false); + if ( w & trailing ) s.Trim(true); + return s; +} - for ( const wxChar *p = c_str() + nStart; *p; p++ ) - { - if ( *p != ch ) - return p - c_str(); - } +// --------------------------------------------------------------------------- +// case conversion +// --------------------------------------------------------------------------- - return npos; +wxString& wxString::MakeUpper() +{ + for ( iterator it = begin(), en = end(); it != en; ++it ) + *it = (wxChar)wxToupper(*it); + + return *this; } -size_t wxString::find_last_not_of(const wxChar* sz, size_t nStart) const +wxString& wxString::MakeLower() { - if ( nStart == npos ) - { - nStart = Len(); - } - else - { - wxASSERT( nStart <= Len() ); - } + for ( iterator it = begin(), en = end(); it != en; ++it ) + *it = (wxChar)wxTolower(*it); - for ( const wxChar *p = c_str() + nStart - 1; p >= c_str(); p-- ) + return *this; +} + +wxString& wxString::MakeCapitalized() +{ + const iterator en = end(); + iterator it = begin(); + if ( it != en ) { - if ( !wxStrchr(sz, *p) ) - return p - c_str(); + *it = (wxChar)wxToupper(*it); + for ( ++it; it != en; ++it ) + *it = (wxChar)wxTolower(*it); } - return npos; + return *this; } -size_t wxString::find_last_not_of(wxChar ch, size_t nStart) const +// --------------------------------------------------------------------------- +// trimming and padding +// --------------------------------------------------------------------------- + +// some compilers (VC++ 6.0 not to name them) return true for a call to +// isspace('\xEA') 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) { - if ( nStart == npos ) - { - nStart = Len(); - } - else + // first check if we're going to modify the string at all + if ( !empty() && + ( + (bFromRight && wxSafeIsspace(GetChar(length() - 1))) || + (!bFromRight && wxSafeIsspace(GetChar(0u))) + ) + ) { - wxASSERT( nStart <= Len() ); - } + if ( bFromRight ) + { + // find last non-space character + reverse_iterator psz = rbegin(); + while ( (psz != rend()) && wxSafeIsspace(*psz) ) + ++psz; - for ( const wxChar *p = c_str() + nStart - 1; p >= c_str(); p-- ) - { - if ( *p != ch ) - return p - c_str(); + // truncate at trailing space start + erase(psz.base(), end()); + } + else + { + // find first non-space character + iterator psz = begin(); + while ( (psz != end()) && wxSafeIsspace(*psz) ) + ++psz; + + // fix up data and length + erase(begin(), psz); + } } - return npos; + return *this; } -wxString& wxString::erase(size_t nStart, size_t nLen) +// adds nCount characters chPad to the string from either side +wxString& wxString::Pad(size_t nCount, wxUniChar chPad, bool bFromRight) { - wxString strTmp(c_str(), nStart); - if ( nLen != npos ) { - wxASSERT( nStart + nLen <= Len() ); + wxString s(chPad, nCount); - strTmp.append(c_str() + nStart + nLen); - } + if ( bFromRight ) + *this += s; + else + { + s += *this; + swap(s); + } - *this = strTmp; - return *this; + return *this; } -wxString& wxString::replace(size_t nStart, size_t nLen, const wxChar *sz) +// truncate the string +wxString& wxString::Truncate(size_t uiLen) { - 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 << c_str() + nStart + nLen; + if ( uiLen < length() ) + { + erase(begin() + uiLen, end()); + } + //else: nothing to do, string is already short enough - *this = strTmp; - return *this; + return *this; } -wxString& wxString::replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch) -{ - return replace(nStart, nLen, wxString(ch, nCount)); -} +// --------------------------------------------------------------------------- +// finding (return wxNOT_FOUND if not found and index otherwise) +// --------------------------------------------------------------------------- -wxString& wxString::replace(size_t nStart, size_t nLen, - const wxString& str, size_t nStart2, size_t nLen2) +// find a character +int wxString::Find(wxUniChar ch, bool bFromEnd) const { - return replace(nStart, nLen, str.substr(nStart2, nLen2)); -} + size_type idx = bFromEnd ? find_last_of(ch) : find_first_of(ch); -wxString& wxString::replace(size_t nStart, size_t nLen, - const wxChar* sz, size_t nCount) -{ - return replace(nStart, nLen, wxString(sz, nCount)); + return (idx == npos) ? wxNOT_FOUND : (int)idx; } -#endif //std::string compatibility - -// ============================================================================ -// ArrayString -// ============================================================================ +// ---------------------------------------------------------------------------- +// conversion to numbers +// ---------------------------------------------------------------------------- -// size increment = min(50% of current size, ARRAY_MAXSIZE_INCREMENT) -#define ARRAY_MAXSIZE_INCREMENT 4096 +// The implementation of all the functions below is exactly the same so factor +// it out. Note that number extraction works correctly on UTF-8 strings, so +// we can use wxStringCharType and wx_str() for maximum efficiency. -#ifndef ARRAY_DEFAULT_INITIAL_SIZE // also defined in dynarray.h -#define ARRAY_DEFAULT_INITIAL_SIZE (16) +#ifndef __WXWINCE__ + #define DO_IF_NOT_WINCE(x) x +#else + #define DO_IF_NOT_WINCE(x) #endif -#define STRING(p) ((wxString *)(&(p))) +#define WX_STRING_TO_X_TYPE_START \ + wxCHECK_MSG( pVal, false, wxT("NULL output pointer") ); \ + DO_IF_NOT_WINCE( errno = 0; ) \ + const wxStringCharType *start = wx_str(); \ + wxStringCharType *end; -// ctor -void wxArrayString::Init(bool autoSort) -{ - m_nSize = - m_nCount = 0; - m_pItems = (wxChar **) NULL; - m_autoSort = autoSort; -} +// notice that we return false without modifying the output parameter at all if +// nothing could be parsed but we do modify it and return false then if we did +// parse something successfully but not the entire string +#define WX_STRING_TO_X_TYPE_END \ + if ( end == start DO_IF_NOT_WINCE(|| errno == ERANGE) ) \ + return false; \ + *pVal = val; \ + return !*end; -// copy ctor -wxArrayString::wxArrayString(const wxArrayString& src) +bool wxString::ToLong(long *pVal, int base) const { - Init(src.m_autoSort); + wxASSERT_MSG( !base || (base > 1 && base <= 36), wxT("invalid base") ); - *this = src; + WX_STRING_TO_X_TYPE_START + long val = wxStrtol(start, &end, base); + WX_STRING_TO_X_TYPE_END } -// assignment operator -wxArrayString& wxArrayString::operator=(const wxArrayString& src) +bool wxString::ToULong(unsigned long *pVal, int base) const { - if ( m_nSize > 0 ) - Clear(); - - Copy(src); - - m_autoSort = src.m_autoSort; + wxASSERT_MSG( !base || (base > 1 && base <= 36), wxT("invalid base") ); - return *this; + WX_STRING_TO_X_TYPE_START + unsigned long val = wxStrtoul(start, &end, base); + WX_STRING_TO_X_TYPE_END } -void wxArrayString::Copy(const wxArrayString& src) +bool wxString::ToLongLong(wxLongLong_t *pVal, int base) const { - if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE ) - Alloc(src.m_nCount); + wxASSERT_MSG( !base || (base > 1 && base <= 36), wxT("invalid base") ); - for ( size_t n = 0; n < src.m_nCount; n++ ) - Add(src[n]); + WX_STRING_TO_X_TYPE_START + wxLongLong_t val = wxStrtoll(start, &end, base); + WX_STRING_TO_X_TYPE_END } -// grow the array -void wxArrayString::Grow(size_t nIncrement) +bool wxString::ToULongLong(wxULongLong_t *pVal, int base) const { - // only do it if no more place - 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 + wxASSERT_MSG( !base || (base > 1 && base <= 36), wxT("invalid base") ); - if ( m_nSize == 0 ) { - // was empty, alloc some memory - m_nSize = ARRAY_DEFAULT_INITIAL_SIZE; - 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 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; - wxChar **pNew = new wxChar *[m_nSize]; - - // copy data to new location - memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *)); - - // delete old memory (but do not release the strings!) - wxDELETEA(m_pItems); - - m_pItems = pNew; - } - } + WX_STRING_TO_X_TYPE_START + wxULongLong_t val = wxStrtoull(start, &end, base); + WX_STRING_TO_X_TYPE_END } -void wxArrayString::Free() +bool wxString::ToDouble(double *pVal) const { - for ( size_t n = 0; n < m_nCount; n++ ) { - STRING(m_pItems[n])->GetStringData()->Unlock(); - } + WX_STRING_TO_X_TYPE_START + double val = wxStrtod(start, &end); + WX_STRING_TO_X_TYPE_END } -// deletes all the strings from the list -void wxArrayString::Empty() +#if wxUSE_XLOCALE + +bool wxString::ToCLong(long *pVal, int base) const { - Free(); + wxASSERT_MSG( !base || (base > 1 && base <= 36), wxT("invalid base") ); - m_nCount = 0; + WX_STRING_TO_X_TYPE_START +#if (wxUSE_UNICODE_UTF8 || !wxUSE_UNICODE) && defined(wxHAS_XLOCALE_SUPPORT) + long val = wxStrtol_lA(start, &end, base, wxCLocale); +#else + long val = wxStrtol_l(start, &end, base, wxCLocale); +#endif + WX_STRING_TO_X_TYPE_END } -// as Empty, but also frees memory -void wxArrayString::Clear() +bool wxString::ToCULong(unsigned long *pVal, int base) const { - Free(); - - m_nSize = - m_nCount = 0; + wxASSERT_MSG( !base || (base > 1 && base <= 36), wxT("invalid base") ); - wxDELETEA(m_pItems); + WX_STRING_TO_X_TYPE_START +#if (wxUSE_UNICODE_UTF8 || !wxUSE_UNICODE) && defined(wxHAS_XLOCALE_SUPPORT) + unsigned long val = wxStrtoul_lA(start, &end, base, wxCLocale); +#else + unsigned long val = wxStrtoul_l(start, &end, base, wxCLocale); +#endif + WX_STRING_TO_X_TYPE_END } -// dtor -wxArrayString::~wxArrayString() +bool wxString::ToCDouble(double *pVal) const { - Free(); - - wxDELETEA(m_pItems); + WX_STRING_TO_X_TYPE_START +#if (wxUSE_UNICODE_UTF8 || !wxUSE_UNICODE) && defined(wxHAS_XLOCALE_SUPPORT) + double val = wxStrtod_lA(start, &end, wxCLocale); +#else + double val = wxStrtod_l(start, &end, wxCLocale); +#endif + WX_STRING_TO_X_TYPE_END } -// pre-allocates memory (frees the previous data!) -void wxArrayString::Alloc(size_t nSize) -{ - // only if old buffer was not big enough - if ( nSize > m_nSize ) { - Free(); - wxDELETEA(m_pItems); - m_pItems = new wxChar *[nSize]; - m_nSize = nSize; - } +#endif // wxUSE_XLOCALE - m_nCount = 0; -} +// --------------------------------------------------------------------------- +// formatted output +// --------------------------------------------------------------------------- -// minimizes the memory usage by freeing unused memory -void wxArrayString::Shrink() +#if !wxUSE_UTF8_LOCALE_ONLY +/* static */ +#ifdef wxNEEDS_WXSTRING_PRINTF_MIXIN +wxString wxStringPrintfMixinBase::DoFormatWchar(const wxChar *format, ...) +#else +wxString wxString::DoFormatWchar(const wxChar *format, ...) +#endif { - // 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]; + va_list argptr; + va_start(argptr, format); - // copy data to new location - memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *)); - delete [] m_pItems; - m_pItems = pNew; - } + wxString s; + s.PrintfV(format, argptr); + + va_end(argptr); + + return s; } +#endif // !wxUSE_UTF8_LOCALE_ONLY -// return a wxString[] as required for some control ctors. -wxString* wxArrayString::GetStringArray() const +#if wxUSE_UNICODE_UTF8 +/* static */ +wxString wxString::DoFormatUtf8(const char *format, ...) { - wxString *array = 0; + va_list argptr; + va_start(argptr, format); - if( m_nCount > 0 ) - { - array = new wxString[m_nCount]; - for( size_t i = 0; i < m_nCount; i++ ) - array[i] = m_pItems[i]; - } + wxString s; + s.PrintfV(format, argptr); - return array; + va_end(argptr); + + return s; +} +#endif // wxUSE_UNICODE_UTF8 + +/* static */ +wxString wxString::FormatV(const wxString& format, va_list argptr) +{ + wxString s; + s.PrintfV(format, argptr); + return s; } -// searches the array for an item (forward or backwards) -int wxArrayString::Index(const wxChar *sz, bool bCase, bool bFromEnd) const +#if !wxUSE_UTF8_LOCALE_ONLY +#ifdef wxNEEDS_WXSTRING_PRINTF_MIXIN +int wxStringPrintfMixinBase::DoPrintfWchar(const wxChar *format, ...) +#else +int wxString::DoPrintfWchar(const wxChar *format, ...) +#endif { - if ( m_autoSort ) { - // use binary search in the sorted array - wxASSERT_MSG( bCase && !bFromEnd, - wxT("search parameters ignored for auto sorted array") ); + va_list argptr; + va_start(argptr, format); - size_t i, - lo = 0, - hi = m_nCount; - int res; - while ( lo < hi ) { - i = (lo + hi)/2; +#ifdef wxNEEDS_WXSTRING_PRINTF_MIXIN + // get a pointer to the wxString instance; we have to use dynamic_cast<> + // because it's the only cast that works safely for downcasting when + // multiple inheritance is used: + wxString *str = static_cast(this); +#else + wxString *str = this; +#endif - res = wxStrcmp(sz, m_pItems[i]); - if ( res < 0 ) - hi = i; - else if ( res > 0 ) - lo = i + 1; - else - return i; - } + int iLen = str->PrintfV(format, argptr); - return wxNOT_FOUND; - } - else { - // 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; - } - } - } + va_end(argptr); - return wxNOT_FOUND; + return iLen; } +#endif // !wxUSE_UTF8_LOCALE_ONLY -// add item at the end -size_t wxArrayString::Add(const wxString& str, size_t nInsert) +#if wxUSE_UNICODE_UTF8 +int wxString::DoPrintfUtf8(const char *format, ...) { - 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; - } - } + va_list argptr; + va_start(argptr, format); - wxASSERT_MSG( lo == hi, wxT("binary search broken") ); + int iLen = PrintfV(format, argptr); - Insert(str, lo, nInsert); + va_end(argptr); - return (size_t)lo; - } - else { - wxASSERT( str.GetStringData()->IsValid() ); + return iLen; +} +#endif // wxUSE_UNICODE_UTF8 - Grow(nInsert); +/* + Uses wxVsnprintf and places the result into the this string. + + In ANSI build, wxVsnprintf is effectively vsnprintf but in Unicode build + it is vswprintf. Due to a discrepancy between vsnprintf and vswprintf in + the ISO C99 (and thus SUSv3) standard the return value for the case of + an undersized buffer is inconsistent. For conforming vsnprintf + implementations the function must return the number of characters that + would have been printed had the buffer been large enough. For conforming + vswprintf implementations the function must return a negative number + and set errno. + + What vswprintf sets errno to is undefined but Darwin seems to set it to + EOVERFLOW. The only expected errno are EILSEQ and EINVAL. Both of + those are defined in the standard and backed up by several conformance + statements. Note that ENOMEM mentioned in the manual page does not + apply to swprintf, only wprintf and fwprintf. + + Official manual page: + http://www.opengroup.org/onlinepubs/009695399/functions/swprintf.html + + Some conformance statements (AIX, Solaris): + http://www.opengroup.org/csq/view.mhtml?RID=ibm%2FSD1%2F3 + http://www.theopengroup.org/csq/view.mhtml?norationale=1&noreferences=1&RID=Fujitsu%2FSE2%2F10 + + Since EILSEQ and EINVAL are rather common but EOVERFLOW is not and since + EILSEQ and EINVAL are specifically defined to mean the error is other than + an undersized buffer and no other errno are defined we treat those two + as meaning hard errors and everything else gets the old behavior which + is to keep looping and increasing buffer size until the function succeeds. + + In practice it's impossible to determine before compilation which behavior + may be used. The vswprintf function may have vsnprintf-like behavior or + vice-versa. Behavior detected on one release can theoretically change + with an updated release. Not to mention that configure testing for it + would require the test to be run on the host system, not the build system + which makes cross compilation difficult. Therefore, we make no assumptions + about behavior and try our best to handle every known case, including the + case where wxVsnprintf returns a negative number and fails to set errno. + + There is yet one more non-standard implementation and that is our own. + Fortunately, that can be detected at compile-time. + + On top of all that, ISO C99 explicitly defines snprintf to write a null + character to the last position of the specified buffer. That would be at + at the given buffer size minus 1. It is supposed to do this even if it + turns out that the buffer is sized too small. + + Darwin (tested on 10.5) follows the C99 behavior exactly. + + Glibc 2.6 almost follows the C99 behavior except vswprintf never sets + errno even when it fails. However, it only seems to ever fail due + to an undersized buffer. +*/ +#if wxUSE_UNICODE_UTF8 +template +#else +// we only need one version in non-UTF8 builds and at least two Windows +// compilers have problems with this function template, so use just one +// normal function here +#endif +static int DoStringPrintfV(wxString& str, + const wxString& format, va_list argptr) +{ + int size = 1024; - for (size_t i = 0; i < nInsert; i++) + for ( ;; ) { - // the string data must not be deleted! - str.GetStringData()->Lock(); +#if wxUSE_UNICODE_UTF8 + BufferType tmp(str, size + 1); + typename BufferType::CharType *buf = tmp; +#else + wxStringBuffer tmp(str, size + 1); + wxChar *buf = tmp; +#endif - // just append - m_pItems[m_nCount + i] = (wxChar *)str.c_str(); // const_cast - } - size_t ret = m_nCount; - m_nCount += nInsert; - return ret; - } -} + if ( !buf ) + { + // out of memory -// add item at the given position -void wxArrayString::Insert(const wxString& str, size_t nIndex, size_t nInsert) -{ - wxASSERT( str.GetStringData()->IsValid() ); + // in UTF-8 build, leaving uninitialized junk in the buffer + // could result in invalid non-empty UTF-8 string, so just + // reset the string to empty on failure: + buf[0] = '\0'; + return -1; + } - 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") ); + // wxVsnprintf() may modify the original arg pointer, so pass it + // only a copy + va_list argptrcopy; + wxVaCopy(argptrcopy, argptr); - Grow(nInsert); +#ifndef __WXWINCE__ + // Set errno to 0 to make it determinate if wxVsnprintf fails to set it. + errno = 0; +#endif + int len = wxVsnprintf(buf, size, format, argptrcopy); + va_end(argptrcopy); + + // some implementations of vsnprintf() don't NUL terminate + // the string if there is not enough space for it so + // always do it manually + // FIXME: This really seems to be the wrong and would be an off-by-one + // bug except the code above allocates an extra character. + buf[size] = wxT('\0'); + + // vsnprintf() may return either -1 (traditional Unix behaviour) or the + // total number of characters which would have been written if the + // buffer were large enough (newer standards such as Unix98) + if ( len < 0 ) + { + // NB: wxVsnprintf() may call either wxCRT_VsnprintfW or + // wxCRT_VsnprintfA in UTF-8 build; wxUSE_WXVSNPRINTF + // is true if *both* of them use our own implementation, + // otherwise we can't be sure +#if wxUSE_WXVSNPRINTF + // we know that our own implementation of wxVsnprintf() returns -1 + // only for a format error - thus there's something wrong with + // the user's format string + buf[0] = '\0'; + return -1; +#else // possibly using system version + // assume it only returns error if there is not enough space, but + // as we don't know how much we need, double the current size of + // the buffer +#ifndef __WXWINCE__ + if( (errno == EILSEQ) || (errno == EINVAL) ) + // If errno was set to one of the two well-known hard errors + // then fail immediately to avoid an infinite loop. + return -1; + else +#endif // __WXWINCE__ + // still not enough, as we don't know how much we need, double the + // current size of the buffer + size *= 2; +#endif // wxUSE_WXVSNPRINTF/!wxUSE_WXVSNPRINTF + } + else if ( len >= size ) + { +#if wxUSE_WXVSNPRINTF + // we know that our own implementation of wxVsnprintf() returns + // size+1 when there's not enough space but that's not the size + // of the required buffer! + size *= 2; // so we just double the current size of the buffer +#else + // some vsnprintf() implementations NUL-terminate the buffer and + // some don't in len == size case, to be safe always add 1 + // FIXME: I don't quite understand this comment. The vsnprintf + // function is specifically defined to return the number of + // characters printed not including the null terminator. + // So OF COURSE you need to add 1 to get the right buffer size. + // The following line is definitely correct, no question. + size = len + 1; +#endif + } + else // ok, there was enough space + { + break; + } + } - memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex], - (m_nCount - nIndex)*sizeof(wxChar *)); + // we could have overshot + str.Shrink(); - for (size_t i = 0; i < nInsert; i++) - { - str.GetStringData()->Lock(); - m_pItems[nIndex + i] = (wxChar *)str.c_str(); - } - m_nCount += nInsert; + return str.length(); } -// expand the array -void wxArrayString::SetCount(size_t count) +int wxString::PrintfV(const wxString& format, va_list argptr) { - Alloc(count); +#if wxUSE_UNICODE_UTF8 + #if wxUSE_STL_BASED_WXSTRING + typedef wxStringTypeBuffer Utf8Buffer; + #else + typedef wxStringInternalBuffer Utf8Buffer; + #endif +#endif - wxString s; - while ( m_nCount < count ) - m_pItems[m_nCount++] = (wxChar *)s.c_str(); +#if wxUSE_UTF8_LOCALE_ONLY + return DoStringPrintfV(*this, format, argptr); +#else + #if wxUSE_UNICODE_UTF8 + if ( wxLocaleIsUtf8 ) + return DoStringPrintfV(*this, format, argptr); + else + // wxChar* version + return DoStringPrintfV(*this, format, argptr); + #else + return DoStringPrintfV(*this, format, argptr); + #endif // UTF8/WCHAR +#endif } -// removes item from array (by index) -void wxArrayString::Remove(size_t nIndex, size_t nRemove) +// ---------------------------------------------------------------------------- +// 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 wxString& mask) const { - 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") ); + // 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)); - // release our lock - for (size_t i = 0; i < nRemove; i++) - Item(nIndex + i).GetStringData()->Unlock(); + pattern += wxT('^'); + while ( *pszMask ) + { + switch ( *pszMask ) + { + case wxT('?'): + pattern += wxT('.'); + break; - memmove(&m_pItems[nIndex], &m_pItems[nIndex + nRemove], - (m_nCount - nIndex - nRemove)*sizeof(wxChar *)); - m_nCount -= nRemove; -} + case wxT('*'): + pattern += wxT(".*"); + break; -// removes item from array (by value) -void wxArrayString::Remove(const wxChar *sz) -{ - int iIndex = Index(sz); + case wxT('^'): + case wxT('.'): + case wxT('$'): + case wxT('('): + case wxT(')'): + case wxT('|'): + case wxT('+'): + case wxT('\\'): + // 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 += wxT('\\'); + // fall through - wxCHECK_RET( iIndex != wxNOT_FOUND, - wxT("removing inexistent element in wxArrayString::Remove") ); + default: + pattern += *pszMask; + } - Remove(iIndex); -} + pszMask++; + } + pattern += wxT('$'); -// ---------------------------------------------------------------------------- -// sorting -// ---------------------------------------------------------------------------- + // and now use it + return wxRegEx(pattern, wxRE_NOSUB | wxRE_EXTENDED).Matches(c_str()); +#else // !wxUSE_REGEX + // TODO: this is, of course, awfully inefficient... -// 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()); + // FIXME-UTF8: implement using iterators, remove #if +#if wxUSE_UNICODE_UTF8 + const wxScopedWCharBuffer maskBuf = mask.wc_str(); + const wxScopedWCharBuffer txtBuf = wc_str(); + const wxChar *pszMask = maskBuf.data(); + const wxChar *pszTxt = txtBuf.data(); +#else + const wxChar *pszMask = mask.wx_str(); + // the char currently being checked + const wxChar *pszTxt = wx_str(); +#endif - return gs_sortAscending ? result : -result; - } -} + // the last location where '*' matched + const wxChar *pszLastStarInText = NULL; + const wxChar *pszLastStarInMask = NULL; -// sort array elements using passed comparaison function -void wxArrayString::Sort(CompareFunction compareFunction) -{ - START_SORT(); +match: + for ( ; *pszMask != wxT('\0'); pszMask++, pszTxt++ ) { + switch ( *pszMask ) { + case wxT('?'): + if ( *pszTxt == wxT('\0') ) + return false; - wxASSERT( !gs_compareFunction ); // must have been reset to NULL - gs_compareFunction = compareFunction; + // pszTxt and pszMask will be incremented in the loop statement - DoSort(); + break; - // reset it to NULL so that Sort(bool) will work the next time - gs_compareFunction = NULL; + case wxT('*'): + { + // remember where we started to be able to backtrack later + pszLastStarInText = pszTxt; + pszLastStarInMask = pszMask; - END_SORT(); -} + // ignore special chars immediately following this one + // (should this be an error?) + while ( *pszMask == wxT('*') || *pszMask == wxT('?') ) + pszMask++; -void wxArrayString::Sort(bool reverseOrder) -{ - START_SORT(); + // if there is nothing more, match + if ( *pszMask == wxT('\0') ) + return true; - wxASSERT( !gs_compareFunction ); // must have been reset to NULL - gs_sortAscending = !reverseOrder; + // are there any other metacharacters in the mask? + size_t uiLenMask; + const wxChar *pEndMask = wxStrpbrk(pszMask, wxT("*?")); - DoSort(); + 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); + } - END_SORT(); -} + wxString strToMatch(pszMask, uiLenMask); + const wxChar* pMatch = wxStrstr(pszTxt, strToMatch); + if ( pMatch == NULL ) + return false; -void wxArrayString::DoSort() -{ - wxCHECK_RET( !m_autoSort, wxT("can't use this method with sorted arrays") ); + // -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; + } - // 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); + return false; +#endif // wxUSE_REGEX/!wxUSE_REGEX } -bool wxArrayString::operator==(const wxArrayString& a) const +// Count the number of chars +int wxString::Freq(wxUniChar ch) const { - if ( m_nCount != a.m_nCount ) - return FALSE; - - for ( size_t n = 0; n < m_nCount; n++ ) + int count = 0; + for ( const_iterator i = begin(); i != end(); ++i ) { - if ( Item(n) != a[n] ) - return FALSE; + if ( *i == ch ) + count ++; } - - return TRUE; + return count; }