1
/////////////////////////////////////////////////////////////////////////////
3
// Purpose: wxString class
4
// Author: Vadim Zeitlin, Ryan Norton
7
// RCS-ID: $Id: string.cpp,v 1.258.2.1 2005/11/30 13:30:08 VZ Exp $
8
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9
// (c) 2004 Ryan Norton <wxprojects@comcast.net>
10
// Licence: wxWindows licence
11
/////////////////////////////////////////////////////////////////////////////
15
* 1) all empty strings use g_strEmpty, nRefs = -1 (set in Init())
16
* 2) AllocBuffer() sets nRefs to 1, Lock() increments it by one
17
* 3) Unlock() decrements nRefs and frees memory if it goes to 0
20
// ===========================================================================
21
// headers, declarations, constants
22
// ===========================================================================
24
// For compilers that support precompilation, includes "wx.h".
25
#include "wx/wxprec.h"
33
#include "wx/string.h"
35
#include "wx/thread.h"
46
// allocating extra space for each string consumes more memory but speeds up
47
// the concatenation operations (nLen is the current string's length)
48
// NB: EXTRA_ALLOC must be >= 0!
49
#define EXTRA_ALLOC (19 - nLen % 16)
51
// ---------------------------------------------------------------------------
52
// static class variables definition
53
// ---------------------------------------------------------------------------
56
//According to STL _must_ be a -1 size_t
57
const size_t wxStringBase::npos = (size_t) -1;
60
// ----------------------------------------------------------------------------
62
// ----------------------------------------------------------------------------
66
extern const wxChar WXDLLIMPEXP_BASE *wxEmptyString = _T("");
70
// for an empty string, GetStringData() will return this address: this
71
// structure has the same layout as wxStringData and it's data() method will
72
// return the empty string (dummy pointer)
77
} g_strEmpty = { {-1, 0, 0}, wxT('\0') };
79
// empty C style string: points to 'string data' byte of g_strEmpty
80
extern const wxChar WXDLLIMPEXP_BASE *wxEmptyString = &g_strEmpty.dummy;
84
// ----------------------------------------------------------------------------
86
// ----------------------------------------------------------------------------
88
#if wxUSE_STD_IOSTREAM
90
// MS Visual C++ version 5.0 provides the new STL headers as well as the old
93
// ATTN: you can _not_ use both of these in the same program!
97
wxSTD istream& operator>>(wxSTD istream& is, wxString& WXUNUSED(str))
102
streambuf *sb = is.rdbuf();
105
int ch = sb->sbumpc ();
107
is.setstate(ios::eofbit);
110
else if ( isspace(ch) ) {
122
if ( str.length() == 0 )
123
is.setstate(ios::failbit);
128
wxSTD ostream& operator<<(wxSTD ostream& os, const wxString& str)
138
#endif // wxUSE_STD_IOSTREAM
140
// ----------------------------------------------------------------------------
142
// ----------------------------------------------------------------------------
144
// this small class is used to gather statistics for performance tuning
145
//#define WXSTRING_STATISTICS
146
#ifdef WXSTRING_STATISTICS
150
Averager(const wxChar *sz) { m_sz = sz; m_nTotal = m_nCount = 0; }
152
{ wxPrintf("wxString: average %s = %f\n", m_sz, ((float)m_nTotal)/m_nCount); }
154
void Add(size_t n) { m_nTotal += n; m_nCount++; }
157
size_t m_nCount, m_nTotal;
159
} g_averageLength("allocation size"),
160
g_averageSummandLength("summand length"),
161
g_averageConcatHit("hit probability in concat"),
162
g_averageInitialLength("initial string length");
164
#define STATISTICS_ADD(av, val) g_average##av.Add(val)
166
#define STATISTICS_ADD(av, val)
167
#endif // WXSTRING_STATISTICS
171
// ===========================================================================
172
// wxStringData class deallocation
173
// ===========================================================================
175
#if defined(__VISUALC__) && defined(_MT) && !defined(_DLL)
176
# pragma message (__FILE__ ": building with Multithreaded non DLL runtime has a performance impact on wxString!")
177
void wxStringData::Free()
183
// ===========================================================================
185
// ===========================================================================
187
// takes nLength elements of psz starting at nPos
188
void wxStringBase::InitWith(const wxChar *psz, size_t nPos, size_t nLength)
192
// if the length is not given, assume the string to be NUL terminated
193
if ( nLength == npos ) {
194
wxASSERT_MSG( nPos <= wxStrlen(psz), _T("index out of bounds") );
196
nLength = wxStrlen(psz + nPos);
199
STATISTICS_ADD(InitialLength, nLength);
202
// trailing '\0' is written in AllocBuffer()
203
if ( !AllocBuffer(nLength) ) {
204
wxFAIL_MSG( _T("out of memory in wxStringBase::InitWith") );
207
wxTmemcpy(m_pchData, psz + nPos, nLength);
211
// poor man's iterators are "void *" pointers
212
wxStringBase::wxStringBase(const void *pStart, const void *pEnd)
214
InitWith((const wxChar *)pStart, 0,
215
(const wxChar *)pEnd - (const wxChar *)pStart);
218
wxStringBase::wxStringBase(size_type n, wxChar ch)
224
// ---------------------------------------------------------------------------
226
// ---------------------------------------------------------------------------
228
// allocates memory needed to store a C string of length nLen
229
bool wxStringBase::AllocBuffer(size_t nLen)
231
// allocating 0 sized buffer doesn't make sense, all empty strings should
233
wxASSERT( nLen > 0 );
235
// make sure that we don't overflow
236
wxASSERT( nLen < (INT_MAX / sizeof(wxChar)) -
237
(sizeof(wxStringData) + EXTRA_ALLOC + 1) );
239
STATISTICS_ADD(Length, nLen);
242
// 1) one extra character for '\0' termination
243
// 2) sizeof(wxStringData) for housekeeping info
244
wxStringData* pData = (wxStringData*)
245
malloc(sizeof(wxStringData) + (nLen + EXTRA_ALLOC + 1)*sizeof(wxChar));
247
if ( pData == NULL ) {
248
// allocation failures are handled by the caller
253
pData->nDataLength = nLen;
254
pData->nAllocLength = nLen + EXTRA_ALLOC;
255
m_pchData = pData->data(); // data starts after wxStringData
256
m_pchData[nLen] = wxT('\0');
260
// must be called before changing this string
261
bool wxStringBase::CopyBeforeWrite()
263
wxStringData* pData = GetStringData();
265
if ( pData->IsShared() ) {
266
pData->Unlock(); // memory not freed because shared
267
size_t nLen = pData->nDataLength;
268
if ( !AllocBuffer(nLen) ) {
269
// allocation failures are handled by the caller
272
wxTmemcpy(m_pchData, pData->data(), nLen);
275
wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner
280
// must be called before replacing contents of this string
281
bool wxStringBase::AllocBeforeWrite(size_t nLen)
283
wxASSERT( nLen != 0 ); // doesn't make any sense
285
// must not share string and must have enough space
286
wxStringData* pData = GetStringData();
287
if ( pData->IsShared() || pData->IsEmpty() ) {
288
// can't work with old buffer, get new one
290
if ( !AllocBuffer(nLen) ) {
291
// allocation failures are handled by the caller
296
if ( nLen > pData->nAllocLength ) {
297
// realloc the buffer instead of calling malloc() again, this is more
299
STATISTICS_ADD(Length, nLen);
303
pData = (wxStringData*)
304
realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
306
if ( pData == NULL ) {
307
// allocation failures are handled by the caller
308
// keep previous data since reallocation failed
312
pData->nAllocLength = nLen;
313
m_pchData = pData->data();
317
wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner
319
// it doesn't really matter what the string length is as it's going to be
320
// overwritten later but, for extra safety, set it to 0 for now as we may
321
// have some junk in m_pchData
322
GetStringData()->nDataLength = 0;
327
wxStringBase& wxStringBase::append(size_t n, wxChar ch)
329
size_type len = length();
331
if ( !Alloc(len + n) || !CopyBeforeWrite() ) {
332
wxFAIL_MSG( _T("out of memory in wxStringBase::append") );
334
GetStringData()->nDataLength = len + n;
335
m_pchData[len + n] = '\0';
336
for ( size_t i = 0; i < n; ++i )
337
m_pchData[len + i] = ch;
341
void wxStringBase::resize(size_t nSize, wxChar ch)
343
size_t len = length();
347
erase(begin() + nSize, end());
349
else if ( nSize > len )
351
append(nSize - len, ch);
353
//else: we have exactly the specified length, nothing to do
356
// allocate enough memory for nLen characters
357
bool wxStringBase::Alloc(size_t nLen)
359
wxStringData *pData = GetStringData();
360
if ( pData->nAllocLength <= nLen ) {
361
if ( pData->IsEmpty() ) {
364
wxStringData* pData = (wxStringData*)
365
malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
367
if ( pData == NULL ) {
368
// allocation failure handled by caller
373
pData->nDataLength = 0;
374
pData->nAllocLength = nLen;
375
m_pchData = pData->data(); // data starts after wxStringData
376
m_pchData[0u] = wxT('\0');
378
else if ( pData->IsShared() ) {
379
pData->Unlock(); // memory not freed because shared
380
size_t nOldLen = pData->nDataLength;
381
if ( !AllocBuffer(nLen) ) {
382
// allocation failure handled by caller
385
// +1 to copy the terminator, too
386
memcpy(m_pchData, pData->data(), (nOldLen+1)*sizeof(wxChar));
387
GetStringData()->nDataLength = nOldLen;
392
pData = (wxStringData *)
393
realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
395
if ( pData == NULL ) {
396
// allocation failure handled by caller
397
// keep previous data since reallocation failed
401
// it's not important if the pointer changed or not (the check for this
402
// is not faster than assigning to m_pchData in all cases)
403
pData->nAllocLength = nLen;
404
m_pchData = pData->data();
407
//else: we've already got enough
411
wxStringBase::iterator wxStringBase::begin()
418
wxStringBase::iterator wxStringBase::end()
422
return m_pchData + length();
425
wxStringBase::iterator wxStringBase::erase(iterator it)
427
size_type idx = it - begin();
429
return begin() + idx;
432
wxStringBase& wxStringBase::erase(size_t nStart, size_t nLen)
434
wxASSERT(nStart <= length());
435
size_t strLen = length() - nStart;
436
// delete nLen or up to the end of the string characters
437
nLen = strLen < nLen ? strLen : nLen;
438
wxString strTmp(c_str(), nStart);
439
strTmp.append(c_str() + nStart + nLen, length() - nStart - nLen);
445
wxStringBase& wxStringBase::insert(size_t nPos, const wxChar *sz, size_t n)
447
wxASSERT( nPos <= length() );
449
if ( n == npos ) n = wxStrlen(sz);
450
if ( n == 0 ) return *this;
452
if ( !Alloc(length() + n) || !CopyBeforeWrite() ) {
453
wxFAIL_MSG( _T("out of memory in wxStringBase::insert") );
456
memmove(m_pchData + nPos + n, m_pchData + nPos,
457
(length() - nPos) * sizeof(wxChar));
458
memcpy(m_pchData + nPos, sz, n * sizeof(wxChar));
459
GetStringData()->nDataLength = length() + n;
460
m_pchData[length()] = '\0';
465
void wxStringBase::swap(wxStringBase& str)
467
wxChar* tmp = str.m_pchData;
468
str.m_pchData = m_pchData;
472
size_t wxStringBase::find(const wxStringBase& str, size_t nStart) const
474
wxASSERT( str.GetStringData()->IsValid() );
475
wxASSERT( nStart <= length() );
478
const wxChar* p = (const wxChar*)wxTmemchr(c_str() + nStart,
485
while(p - c_str() + str.length() <= length() &&
486
wxTmemcmp(p, str.c_str(), str.length()) )
488
//Previosly passed as the first argument to wxTmemchr,
489
//but C/C++ standard does not specify evaluation order
490
//of arguments to functions -
491
//http://embedded.com/showArticle.jhtml?articleID=9900607
495
p = (const wxChar*)wxTmemchr(p,
497
length() - (p - c_str()));
503
return (p - c_str() + str.length() <= length()) ? p - c_str() : npos;
506
size_t wxStringBase::find(const wxChar* sz, size_t nStart, size_t n) const
508
return find(wxStringBase(sz, n), nStart);
511
size_t wxStringBase::find(wxChar ch, size_t nStart) const
513
wxASSERT( nStart <= length() );
515
const wxChar *p = (const wxChar*)wxTmemchr(c_str() + nStart, ch, length() - nStart);
517
return p == NULL ? npos : p - c_str();
520
size_t wxStringBase::rfind(const wxStringBase& str, size_t nStart) const
522
wxASSERT( str.GetStringData()->IsValid() );
523
wxASSERT( nStart == npos || nStart <= length() );
525
if ( length() >= str.length() )
527
// avoids a corner case later
528
if ( length() == 0 && str.length() == 0 )
531
// "top" is the point where search starts from
532
size_t top = length() - str.length();
534
if ( nStart == npos )
535
nStart = length() - 1;
539
const wxChar *cursor = c_str() + top;
542
if ( wxTmemcmp(cursor, str.c_str(),
545
return cursor - c_str();
547
} while ( cursor-- > c_str() );
553
size_t wxStringBase::rfind(const wxChar* sz, size_t nStart, size_t n) const
555
return rfind(wxStringBase(sz, n), nStart);
558
size_t wxStringBase::rfind(wxChar ch, size_t nStart) const
560
if ( nStart == npos )
566
wxASSERT( nStart <= length() );
569
const wxChar *actual;
570
for ( actual = c_str() + ( nStart == npos ? length() : nStart + 1 );
571
actual > c_str(); --actual )
573
if ( *(actual - 1) == ch )
574
return (actual - 1) - c_str();
580
size_t wxStringBase::find_first_of(const wxChar* sz, size_t nStart) const
582
wxASSERT(nStart <= length());
584
size_t len = wxStrlen(sz);
587
for(i = nStart; i < this->length(); ++i)
589
if (wxTmemchr(sz, *(c_str() + i), len))
593
if(i == this->length())
599
size_t wxStringBase::find_first_of(const wxChar* sz, size_t nStart,
602
return find_first_of(wxStringBase(sz, n), nStart);
605
size_t wxStringBase::find_last_of(const wxChar* sz, size_t nStart) const
607
if ( nStart == npos )
609
nStart = length() - 1;
613
wxASSERT_MSG( nStart <= length(),
614
_T("invalid index in find_last_of()") );
617
size_t len = wxStrlen(sz);
619
for ( const wxChar *p = c_str() + nStart; p >= c_str(); --p )
621
if ( wxTmemchr(sz, *p, len) )
628
size_t wxStringBase::find_last_of(const wxChar* sz, size_t nStart,
631
return find_last_of(wxStringBase(sz, n), nStart);
634
size_t wxStringBase::find_first_not_of(const wxChar* sz, size_t nStart) const
636
if ( nStart == npos )
642
wxASSERT( nStart <= length() );
645
size_t len = wxStrlen(sz);
648
for(i = nStart; i < this->length(); ++i)
650
if (!wxTmemchr(sz, *(c_str() + i), len))
654
if(i == this->length())
660
size_t wxStringBase::find_first_not_of(const wxChar* sz, size_t nStart,
663
return find_first_not_of(wxStringBase(sz, n), nStart);
666
size_t wxStringBase::find_first_not_of(wxChar ch, size_t nStart) const
668
wxASSERT( nStart <= length() );
670
for ( const wxChar *p = c_str() + nStart; *p; p++ )
679
size_t wxStringBase::find_last_not_of(const wxChar* sz, size_t nStart) const
681
if ( nStart == npos )
683
nStart = length() - 1;
687
wxASSERT( nStart <= length() );
690
size_t len = wxStrlen(sz);
692
for ( const wxChar *p = c_str() + nStart; p >= c_str(); --p )
694
if ( !wxTmemchr(sz, *p,len) )
701
size_t wxStringBase::find_last_not_of(const wxChar* sz, size_t nStart,
704
return find_last_not_of(wxStringBase(sz, n), nStart);
707
size_t wxStringBase::find_last_not_of(wxChar ch, size_t nStart) const
709
if ( nStart == npos )
711
nStart = length() - 1;
715
wxASSERT( nStart <= length() );
718
for ( const wxChar *p = c_str() + nStart; p >= c_str(); --p )
727
wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
730
wxASSERT_MSG( nStart <= length(),
731
_T("index out of bounds in wxStringBase::replace") );
732
size_t strLen = length() - nStart;
733
nLen = strLen < nLen ? strLen : nLen;
736
strTmp.reserve(length()); // micro optimisation to avoid multiple mem allocs
738
//This is kind of inefficient, but its pretty good considering...
739
//we don't want to use character access operators here because on STL
740
//it will freeze the reference count of strTmp, which means a deep copy
741
//at the end when swap is called
743
//Also, we can't use append with the full character pointer and must
744
//do it manually because this string can contain null characters
745
for(size_t i1 = 0; i1 < nStart; ++i1)
746
strTmp.append(1, this->c_str()[i1]);
748
//its safe to do the full version here because
749
//sz must be a normal c string
752
for(size_t i2 = nStart + nLen; i2 < length(); ++i2)
753
strTmp.append(1, this->c_str()[i2]);
759
wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
760
size_t nCount, wxChar ch)
762
return replace(nStart, nLen, wxStringBase(nCount, ch).c_str());
765
wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
766
const wxStringBase& str,
767
size_t nStart2, size_t nLen2)
769
return replace(nStart, nLen, str.substr(nStart2, nLen2));
772
wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
773
const wxChar* sz, size_t nCount)
775
return replace(nStart, nLen, wxStringBase(sz, nCount).c_str());
778
wxStringBase wxStringBase::substr(size_t nStart, size_t nLen) const
781
nLen = length() - nStart;
782
return wxStringBase(*this, nStart, nLen);
785
// assigns one string to another
786
wxStringBase& wxStringBase::operator=(const wxStringBase& stringSrc)
788
wxASSERT( stringSrc.GetStringData()->IsValid() );
790
// don't copy string over itself
791
if ( m_pchData != stringSrc.m_pchData ) {
792
if ( stringSrc.GetStringData()->IsEmpty() ) {
797
GetStringData()->Unlock();
798
m_pchData = stringSrc.m_pchData;
799
GetStringData()->Lock();
806
// assigns a single character
807
wxStringBase& wxStringBase::operator=(wxChar ch)
809
if ( !AssignCopy(1, &ch) ) {
810
wxFAIL_MSG( _T("out of memory in wxStringBase::operator=(wxChar)") );
816
wxStringBase& wxStringBase::operator=(const wxChar *psz)
818
if ( !AssignCopy(wxStrlen(psz), psz) ) {
819
wxFAIL_MSG( _T("out of memory in wxStringBase::operator=(const wxChar *)") );
824
// helper function: does real copy
825
bool wxStringBase::AssignCopy(size_t nSrcLen, const wxChar *pszSrcData)
827
if ( nSrcLen == 0 ) {
831
if ( !AllocBeforeWrite(nSrcLen) ) {
832
// allocation failure handled by caller
835
memcpy(m_pchData, pszSrcData, nSrcLen*sizeof(wxChar));
836
GetStringData()->nDataLength = nSrcLen;
837
m_pchData[nSrcLen] = wxT('\0');
842
// ---------------------------------------------------------------------------
843
// string concatenation
844
// ---------------------------------------------------------------------------
846
// add something to this string
847
bool wxStringBase::ConcatSelf(size_t nSrcLen, const wxChar *pszSrcData,
850
STATISTICS_ADD(SummandLength, nSrcLen);
852
nSrcLen = nSrcLen < nMaxLen ? nSrcLen : nMaxLen;
854
// concatenating an empty string is a NOP
856
wxStringData *pData = GetStringData();
857
size_t nLen = pData->nDataLength;
858
size_t nNewLen = nLen + nSrcLen;
860
// alloc new buffer if current is too small
861
if ( pData->IsShared() ) {
862
STATISTICS_ADD(ConcatHit, 0);
864
// we have to allocate another buffer
865
wxStringData* pOldData = GetStringData();
866
if ( !AllocBuffer(nNewLen) ) {
867
// allocation failure handled by caller
870
memcpy(m_pchData, pOldData->data(), nLen*sizeof(wxChar));
873
else if ( nNewLen > pData->nAllocLength ) {
874
STATISTICS_ADD(ConcatHit, 0);
877
// we have to grow the buffer
878
if ( capacity() < nNewLen ) {
879
// allocation failure handled by caller
884
STATISTICS_ADD(ConcatHit, 1);
886
// the buffer is already big enough
889
// should be enough space
890
wxASSERT( nNewLen <= GetStringData()->nAllocLength );
892
// fast concatenation - all is done in our buffer
893
memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(wxChar));
895
m_pchData[nNewLen] = wxT('\0'); // put terminating '\0'
896
GetStringData()->nDataLength = nNewLen; // and fix the length
898
//else: the string to append was empty
902
// ---------------------------------------------------------------------------
903
// simple sub-string extraction
904
// ---------------------------------------------------------------------------
906
// helper function: clone the data attached to this string
907
bool wxStringBase::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const
909
if ( nCopyLen == 0 ) {
913
if ( !dest.AllocBuffer(nCopyLen) ) {
914
// allocation failure handled by caller
917
memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(wxChar));
924
#if !wxUSE_STL || !defined(HAVE_STD_STRING_COMPARE)
927
#define STRINGCLASS wxStringBase
929
#define STRINGCLASS wxString
932
static inline int wxDoCmp(const wxChar* s1, size_t l1,
933
const wxChar* s2, size_t l2)
936
return wxTmemcmp(s1, s2, l1);
939
int ret = wxTmemcmp(s1, s2, l1);
940
return ret == 0 ? -1 : ret;
944
int ret = wxTmemcmp(s1, s2, l2);
945
return ret == 0 ? +1 : ret;
949
int STRINGCLASS::compare(const wxStringBase& str) const
951
return ::wxDoCmp(data(), length(), str.data(), str.length());
954
int STRINGCLASS::compare(size_t nStart, size_t nLen,
955
const wxStringBase& str) const
957
wxASSERT(nStart <= length());
958
size_type strLen = length() - nStart;
959
nLen = strLen < nLen ? strLen : nLen;
960
return ::wxDoCmp(data() + nStart, nLen, str.data(), str.length());
963
int STRINGCLASS::compare(size_t nStart, size_t nLen,
964
const wxStringBase& str,
965
size_t nStart2, size_t nLen2) const
967
wxASSERT(nStart <= length());
968
wxASSERT(nStart2 <= str.length());
969
size_type strLen = length() - nStart,
970
strLen2 = str.length() - nStart2;
971
nLen = strLen < nLen ? strLen : nLen;
972
nLen2 = strLen2 < nLen2 ? strLen2 : nLen2;
973
return ::wxDoCmp(data() + nStart, nLen, str.data() + nStart2, nLen2);
976
int STRINGCLASS::compare(const wxChar* sz) const
978
size_t nLen = wxStrlen(sz);
979
return ::wxDoCmp(data(), length(), sz, nLen);
982
int STRINGCLASS::compare(size_t nStart, size_t nLen,
983
const wxChar* sz, size_t nCount) const
985
wxASSERT(nStart <= length());
986
size_type strLen = length() - nStart;
987
nLen = strLen < nLen ? strLen : nLen;
989
nCount = wxStrlen(sz);
991
return ::wxDoCmp(data() + nStart, nLen, sz, nCount);
996
#endif // !wxUSE_STL || !defined(HAVE_STD_STRING_COMPARE)
998
// ===========================================================================
999
// wxString class core
1000
// ===========================================================================
1002
// ---------------------------------------------------------------------------
1003
// construction and conversion
1004
// ---------------------------------------------------------------------------
1008
// from multibyte string
1009
wxString::wxString(const char *psz, wxMBConv& conv, size_t nLength)
1011
// if nLength != npos, then we have to make a NULL-terminated copy
1012
// of first nLength bytes of psz first because the input buffer to MB2WC
1013
// must always be NULL-terminated:
1014
wxCharBuffer inBuf((const char *)NULL);
1015
if (nLength != npos)
1017
wxASSERT( psz != NULL );
1018
wxCharBuffer tmp(nLength);
1019
memcpy(tmp.data(), psz, nLength);
1020
tmp.data()[nLength] = '\0';
1025
// first get the size of the buffer we need
1029
// calculate the needed size ourselves or use the provided one
1030
if (nLength == npos)
1037
// nothing to convert
1043
if ( (nLen != 0) && (nLen != (size_t)-1) )
1047
wxWCharBuffer theBuffer = conv.cMB2WC(psz, nLen, &nRealSize);
1051
assign( theBuffer.data() , nRealSize - 1 );
1055
//Convert wxString in Unicode mode to a multi-byte string
1056
const wxCharBuffer wxString::mb_str(wxMBConv& conv) const
1059
return conv.cWC2MB(c_str(), length(), &dwOutSize);
1066
wxString::wxString(const wchar_t *pwz, wxMBConv& conv, size_t nLength)
1068
// if nLength != npos, then we have to make a NULL-terminated copy
1069
// of first nLength chars of psz first because the input buffer to WC2MB
1070
// must always be NULL-terminated:
1071
wxWCharBuffer inBuf((const wchar_t *)NULL);
1072
if (nLength != npos)
1074
wxASSERT( pwz != NULL );
1075
wxWCharBuffer tmp(nLength);
1076
memcpy(tmp.data(), pwz, nLength * sizeof(wchar_t));
1077
tmp.data()[nLength] = '\0';
1082
// first get the size of the buffer we need
1086
// calculate the needed size ourselves or use the provided one
1087
if (nLength == npos)
1088
nLen = wxWcslen(pwz);
1094
// nothing to convert
1099
if ( (nLen != 0) && (nLen != (size_t)-1) )
1103
wxCharBuffer theBuffer = conv.cWC2MB(pwz, nLen, &nRealSize);
1107
assign( theBuffer.data() , nRealSize - 1 );
1111
//Converts this string to a wide character string if unicode
1112
//mode is not enabled and wxUSE_WCHAR_T is enabled
1113
const wxWCharBuffer wxString::wc_str(wxMBConv& conv) const
1116
return conv.cMB2WC(c_str(), length(), &dwOutSize);
1119
#endif // wxUSE_WCHAR_T
1121
#endif // Unicode/ANSI
1123
// shrink to minimal size (releasing extra memory)
1124
bool wxString::Shrink()
1126
wxString tmp(begin(), end());
1128
return tmp.length() == length();
1132
// get the pointer to writable buffer of (at least) nLen bytes
1133
wxChar *wxString::GetWriteBuf(size_t nLen)
1135
if ( !AllocBeforeWrite(nLen) ) {
1136
// allocation failure handled by caller
1140
wxASSERT( GetStringData()->nRefs == 1 );
1141
GetStringData()->Validate(false);
1146
// put string back in a reasonable state after GetWriteBuf
1147
void wxString::UngetWriteBuf()
1149
GetStringData()->nDataLength = wxStrlen(m_pchData);
1150
GetStringData()->Validate(true);
1153
void wxString::UngetWriteBuf(size_t nLen)
1155
GetStringData()->nDataLength = nLen;
1156
GetStringData()->Validate(true);
1160
// ---------------------------------------------------------------------------
1162
// ---------------------------------------------------------------------------
1164
// all functions are inline in string.h
1166
// ---------------------------------------------------------------------------
1167
// assignment operators
1168
// ---------------------------------------------------------------------------
1172
// same as 'signed char' variant
1173
wxString& wxString::operator=(const unsigned char* psz)
1175
*this = (const char *)psz;
1180
wxString& wxString::operator=(const wchar_t *pwz)
1191
* concatenation functions come in 5 flavours:
1193
* char + string and string + char
1194
* C str + string and string + C str
1197
wxString operator+(const wxString& str1, const wxString& str2)
1200
wxASSERT( str1.GetStringData()->IsValid() );
1201
wxASSERT( str2.GetStringData()->IsValid() );
1210
wxString operator+(const wxString& str, wxChar ch)
1213
wxASSERT( str.GetStringData()->IsValid() );
1222
wxString operator+(wxChar ch, const wxString& str)
1225
wxASSERT( str.GetStringData()->IsValid() );
1234
wxString operator+(const wxString& str, const wxChar *psz)
1237
wxASSERT( str.GetStringData()->IsValid() );
1241
if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
1242
wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1250
wxString operator+(const wxChar *psz, const wxString& str)
1253
wxASSERT( str.GetStringData()->IsValid() );
1257
if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
1258
wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1266
// ===========================================================================
1267
// other common string functions
1268
// ===========================================================================
1270
int wxString::Cmp(const wxString& s) const
1275
int wxString::Cmp(const wxChar* psz) const
1277
return compare(psz);
1280
static inline int wxDoCmpNoCase(const wxChar* s1, size_t l1,
1281
const wxChar* s2, size_t l2)
1287
for(i = 0; i < l1; ++i)
1289
if(wxTolower(s1[i]) != wxTolower(s2[i]))
1292
return i == l1 ? 0 : wxTolower(s1[i]) < wxTolower(s2[i]) ? -1 : 1;
1296
for(i = 0; i < l1; ++i)
1298
if(wxTolower(s1[i]) != wxTolower(s2[i]))
1301
return i == l1 ? -1 : wxTolower(s1[i]) < wxTolower(s2[i]) ? -1 : 1;
1305
for(i = 0; i < l2; ++i)
1307
if(wxTolower(s1[i]) != wxTolower(s2[i]))
1310
return i == l2 ? 1 : wxTolower(s1[i]) < wxTolower(s2[i]) ? -1 : 1;
1314
int wxString::CmpNoCase(const wxString& s) const
1316
return wxDoCmpNoCase(data(), length(), s.data(), s.length());
1319
int wxString::CmpNoCase(const wxChar* psz) const
1321
int nLen = wxStrlen(psz);
1323
return wxDoCmpNoCase(data(), length(), psz, nLen);
1330
#ifndef __SCHAR_MAX__
1331
#define __SCHAR_MAX__ 127
1335
wxString wxString::FromAscii(const char *ascii)
1338
return wxEmptyString;
1340
size_t len = strlen( ascii );
1345
wxStringBuffer buf(res, len);
1347
wchar_t *dest = buf;
1351
if ( (*dest++ = (wchar_t)(unsigned char)*ascii++) == L'\0' )
1359
wxString wxString::FromAscii(const char ascii)
1361
// What do we do with '\0' ?
1364
res += (wchar_t)(unsigned char) ascii;
1369
const wxCharBuffer wxString::ToAscii() const
1371
// this will allocate enough space for the terminating NUL too
1372
wxCharBuffer buffer(length());
1375
char *dest = buffer.data();
1377
const wchar_t *pwc = c_str();
1380
*dest++ = (char)(*pwc > SCHAR_MAX ? wxT('_') : *pwc);
1382
// the output string can't have embedded NULs anyhow, so we can safely
1383
// stop at first of them even if we do have any
1393
// extract string of length nCount starting at nFirst
1394
wxString wxString::Mid(size_t nFirst, size_t nCount) const
1396
size_t nLen = length();
1398
// default value of nCount is npos and means "till the end"
1399
if ( nCount == npos )
1401
nCount = nLen - nFirst;
1404
// out-of-bounds requests return sensible things
1405
if ( nFirst + nCount > nLen )
1407
nCount = nLen - nFirst;
1410
if ( nFirst > nLen )
1412
// AllocCopy() will return empty string
1413
return wxEmptyString;
1416
wxString dest(*this, nFirst, nCount);
1417
if ( dest.length() != nCount )
1419
wxFAIL_MSG( _T("out of memory in wxString::Mid") );
1425
// check that the string starts with prefix and return the rest of the string
1426
// in the provided pointer if it is not NULL, otherwise return false
1427
bool wxString::StartsWith(const wxChar *prefix, wxString *rest) const
1429
wxASSERT_MSG( prefix, _T("invalid parameter in wxString::StartsWith") );
1431
// first check if the beginning of the string matches the prefix: note
1432
// that we don't have to check that we don't run out of this string as
1433
// when we reach the terminating NUL, either prefix string ends too (and
1434
// then it's ok) or we break out of the loop because there is no match
1435
const wxChar *p = c_str();
1438
if ( *prefix++ != *p++ )
1447
// put the rest of the string into provided pointer
1454
// extract nCount last (rightmost) characters
1455
wxString wxString::Right(size_t nCount) const
1457
if ( nCount > length() )
1460
wxString dest(*this, length() - nCount, nCount);
1461
if ( dest.length() != nCount ) {
1462
wxFAIL_MSG( _T("out of memory in wxString::Right") );
1467
// get all characters after the last occurence of ch
1468
// (returns the whole string if ch not found)
1469
wxString wxString::AfterLast(wxChar ch) const
1472
int iPos = Find(ch, true);
1473
if ( iPos == wxNOT_FOUND )
1476
str = c_str() + iPos + 1;
1481
// extract nCount first (leftmost) characters
1482
wxString wxString::Left(size_t nCount) const
1484
if ( nCount > length() )
1487
wxString dest(*this, 0, nCount);
1488
if ( dest.length() != nCount ) {
1489
wxFAIL_MSG( _T("out of memory in wxString::Left") );
1494
// get all characters before the first occurence of ch
1495
// (returns the whole string if ch not found)
1496
wxString wxString::BeforeFirst(wxChar ch) const
1498
int iPos = Find(ch);
1499
if ( iPos == wxNOT_FOUND ) iPos = length();
1500
return wxString(*this, 0, iPos);
1503
/// get all characters before the last occurence of ch
1504
/// (returns empty string if ch not found)
1505
wxString wxString::BeforeLast(wxChar ch) const
1508
int iPos = Find(ch, true);
1509
if ( iPos != wxNOT_FOUND && iPos != 0 )
1510
str = wxString(c_str(), iPos);
1515
/// get all characters after the first occurence of ch
1516
/// (returns empty string if ch not found)
1517
wxString wxString::AfterFirst(wxChar ch) const
1520
int iPos = Find(ch);
1521
if ( iPos != wxNOT_FOUND )
1522
str = c_str() + iPos + 1;
1527
// replace first (or all) occurences of some substring with another one
1528
size_t wxString::Replace(const wxChar *szOld,
1529
const wxChar *szNew, bool bReplaceAll)
1531
// if we tried to replace an empty string we'd enter an infinite loop below
1532
wxCHECK_MSG( szOld && *szOld && szNew, 0,
1533
_T("wxString::Replace(): invalid parameter") );
1535
size_t uiCount = 0; // count of replacements made
1537
size_t uiOldLen = wxStrlen(szOld);
1538
size_t uiNewLen = wxStrlen(szNew);
1542
while ( this->c_str()[dwPos] != wxT('\0') )
1544
//DO NOT USE STRSTR HERE
1545
//this string can contain embedded null characters,
1546
//so strstr will function incorrectly
1547
dwPos = find(szOld, dwPos);
1548
if ( dwPos == npos )
1549
break; // exit the loop
1552
//replace this occurance of the old string with the new one
1553
replace(dwPos, uiOldLen, szNew, uiNewLen);
1555
//move up pos past the string that was replaced
1558
//increase replace count
1563
break; // exit the loop
1570
bool wxString::IsAscii() const
1572
const wxChar *s = (const wxChar*) *this;
1574
if(!isascii(*s)) return(false);
1580
bool wxString::IsWord() const
1582
const wxChar *s = (const wxChar*) *this;
1584
if(!wxIsalpha(*s)) return(false);
1590
bool wxString::IsNumber() const
1592
const wxChar *s = (const wxChar*) *this;
1594
if ((s[0] == wxT('-')) || (s[0] == wxT('+'))) s++;
1596
if(!wxIsdigit(*s)) return(false);
1602
wxString wxString::Strip(stripType w) const
1605
if ( w & leading ) s.Trim(false);
1606
if ( w & trailing ) s.Trim(true);
1610
// ---------------------------------------------------------------------------
1612
// ---------------------------------------------------------------------------
1614
wxString& wxString::MakeUpper()
1616
for ( iterator it = begin(), en = end(); it != en; ++it )
1617
*it = (wxChar)wxToupper(*it);
1622
wxString& wxString::MakeLower()
1624
for ( iterator it = begin(), en = end(); it != en; ++it )
1625
*it = (wxChar)wxTolower(*it);
1630
// ---------------------------------------------------------------------------
1631
// trimming and padding
1632
// ---------------------------------------------------------------------------
1634
// some compilers (VC++ 6.0 not to name them) return true for a call to
1635
// isspace('ļæ½') in the C locale which seems to be broken to me, but we have to
1636
// live with this by checking that the character is a 7 bit one - even if this
1637
// may fail to detect some spaces (I don't know if Unicode doesn't have
1638
// space-like symbols somewhere except in the first 128 chars), it is arguably
1639
// still better than trimming away accented letters
1640
inline int wxSafeIsspace(wxChar ch) { return (ch < 127) && wxIsspace(ch); }
1642
// trims spaces (in the sense of isspace) from left or right side
1643
wxString& wxString::Trim(bool bFromRight)
1645
// first check if we're going to modify the string at all
1648
(bFromRight && wxSafeIsspace(GetChar(Len() - 1))) ||
1649
(!bFromRight && wxSafeIsspace(GetChar(0u)))
1655
// find last non-space character
1656
iterator psz = begin() + length() - 1;
1657
while ( wxSafeIsspace(*psz) && (psz >= begin()) )
1660
// truncate at trailing space start
1666
// find first non-space character
1667
iterator psz = begin();
1668
while ( wxSafeIsspace(*psz) )
1671
// fix up data and length
1672
erase(begin(), psz);
1679
// adds nCount characters chPad to the string from either side
1680
wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight)
1682
wxString s(chPad, nCount);
1695
// truncate the string
1696
wxString& wxString::Truncate(size_t uiLen)
1698
if ( uiLen < Len() ) {
1699
erase(begin() + uiLen, end());
1701
//else: nothing to do, string is already short enough
1706
// ---------------------------------------------------------------------------
1707
// finding (return wxNOT_FOUND if not found and index otherwise)
1708
// ---------------------------------------------------------------------------
1711
int wxString::Find(wxChar ch, bool bFromEnd) const
1713
size_type idx = bFromEnd ? find_last_of(ch) : find_first_of(ch);
1715
return (idx == npos) ? wxNOT_FOUND : (int)idx;
1718
// find a sub-string (like strstr)
1719
int wxString::Find(const wxChar *pszSub) const
1721
size_type idx = find(pszSub);
1723
return (idx == npos) ? wxNOT_FOUND : (int)idx;
1726
// ----------------------------------------------------------------------------
1727
// conversion to numbers
1728
// ----------------------------------------------------------------------------
1730
bool wxString::ToLong(long *val, int base) const
1732
wxCHECK_MSG( val, false, _T("NULL pointer in wxString::ToLong") );
1733
wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") );
1735
const wxChar *start = c_str();
1737
*val = wxStrtol(start, &end, base);
1739
// return true only if scan was stopped by the terminating NUL and if the
1740
// string was not empty to start with
1741
return !*end && (end != start);
1744
bool wxString::ToULong(unsigned long *val, int base) const
1746
wxCHECK_MSG( val, false, _T("NULL pointer in wxString::ToULong") );
1747
wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") );
1749
const wxChar *start = c_str();
1751
*val = wxStrtoul(start, &end, base);
1753
// return true only if scan was stopped by the terminating NUL and if the
1754
// string was not empty to start with
1755
return !*end && (end != start);
1758
bool wxString::ToDouble(double *val) const
1760
wxCHECK_MSG( val, false, _T("NULL pointer in wxString::ToDouble") );
1762
const wxChar *start = c_str();
1764
*val = wxStrtod(start, &end);
1766
// return true only if scan was stopped by the terminating NUL and if the
1767
// string was not empty to start with
1768
return !*end && (end != start);
1771
// ---------------------------------------------------------------------------
1773
// ---------------------------------------------------------------------------
1776
wxString wxString::Format(const wxChar *pszFormat, ...)
1779
va_start(argptr, pszFormat);
1782
s.PrintfV(pszFormat, argptr);
1790
wxString wxString::FormatV(const wxChar *pszFormat, va_list argptr)
1793
s.PrintfV(pszFormat, argptr);
1797
int wxString::Printf(const wxChar *pszFormat, ...)
1800
va_start(argptr, pszFormat);
1802
int iLen = PrintfV(pszFormat, argptr);
1809
int wxString::PrintfV(const wxChar* pszFormat, va_list argptr)
1815
wxStringBuffer tmp(*this, size + 1);
1824
// wxVsnprintf() may modify the original arg pointer, so pass it
1827
wxVaCopy(argptrcopy, argptr);
1828
int len = wxVsnprintf(buf, size, pszFormat, argptrcopy);
1831
// some implementations of vsnprintf() don't NUL terminate
1832
// the string if there is not enough space for it so
1833
// always do it manually
1834
buf[size] = _T('\0');
1836
// vsnprintf() may return either -1 (traditional Unix behaviour) or the
1837
// total number of characters which would have been written if the
1838
// buffer were large enough (newer standards such as Unix98)
1839
if ( len >= 0 && len <= size )
1841
// ok, there was enough space
1845
// still not enough, double it again
1849
// we could have overshot
1855
// ----------------------------------------------------------------------------
1856
// misc other operations
1857
// ----------------------------------------------------------------------------
1859
// returns true if the string matches the pattern which may contain '*' and
1860
// '?' metacharacters (as usual, '?' matches any character and '*' any number
1862
bool wxString::Matches(const wxChar *pszMask) const
1864
// I disable this code as it doesn't seem to be faster (in fact, it seems
1865
// to be much slower) than the old, hand-written code below and using it
1866
// here requires always linking with libregex even if the user code doesn't
1868
#if 0 // wxUSE_REGEX
1869
// first translate the shell-like mask into a regex
1871
pattern.reserve(wxStrlen(pszMask));
1883
pattern += _T(".*");
1894
// these characters are special in a RE, quote them
1895
// (however note that we don't quote '[' and ']' to allow
1896
// using them for Unix shell like matching)
1897
pattern += _T('\\');
1901
pattern += *pszMask;
1909
return wxRegEx(pattern, wxRE_NOSUB | wxRE_EXTENDED).Matches(c_str());
1910
#else // !wxUSE_REGEX
1911
// TODO: this is, of course, awfully inefficient...
1913
// the char currently being checked
1914
const wxChar *pszTxt = c_str();
1916
// the last location where '*' matched
1917
const wxChar *pszLastStarInText = NULL;
1918
const wxChar *pszLastStarInMask = NULL;
1921
for ( ; *pszMask != wxT('\0'); pszMask++, pszTxt++ ) {
1922
switch ( *pszMask ) {
1924
if ( *pszTxt == wxT('\0') )
1927
// pszTxt and pszMask will be incremented in the loop statement
1933
// remember where we started to be able to backtrack later
1934
pszLastStarInText = pszTxt;
1935
pszLastStarInMask = pszMask;
1937
// ignore special chars immediately following this one
1938
// (should this be an error?)
1939
while ( *pszMask == wxT('*') || *pszMask == wxT('?') )
1942
// if there is nothing more, match
1943
if ( *pszMask == wxT('\0') )
1946
// are there any other metacharacters in the mask?
1948
const wxChar *pEndMask = wxStrpbrk(pszMask, wxT("*?"));
1950
if ( pEndMask != NULL ) {
1951
// we have to match the string between two metachars
1952
uiLenMask = pEndMask - pszMask;
1955
// we have to match the remainder of the string
1956
uiLenMask = wxStrlen(pszMask);
1959
wxString strToMatch(pszMask, uiLenMask);
1960
const wxChar* pMatch = wxStrstr(pszTxt, strToMatch);
1961
if ( pMatch == NULL )
1964
// -1 to compensate "++" in the loop
1965
pszTxt = pMatch + uiLenMask - 1;
1966
pszMask += uiLenMask - 1;
1971
if ( *pszMask != *pszTxt )
1977
// match only if nothing left
1978
if ( *pszTxt == wxT('\0') )
1981
// if we failed to match, backtrack if we can
1982
if ( pszLastStarInText ) {
1983
pszTxt = pszLastStarInText + 1;
1984
pszMask = pszLastStarInMask;
1986
pszLastStarInText = NULL;
1988
// don't bother resetting pszLastStarInMask, it's unnecessary
1994
#endif // wxUSE_REGEX/!wxUSE_REGEX
1997
// Count the number of chars
1998
int wxString::Freq(wxChar ch) const
2002
for (int i = 0; i < len; i++)
2004
if (GetChar(i) == ch)
2010
// convert to upper case, return the copy of the string
2011
wxString wxString::Upper() const
2012
{ wxString s(*this); return s.MakeUpper(); }
2014
// convert to lower case, return the copy of the string
2015
wxString wxString::Lower() const { wxString s(*this); return s.MakeLower(); }
2017
int wxString::sprintf(const wxChar *pszFormat, ...)
2020
va_start(argptr, pszFormat);
2021
int iLen = PrintfV(pszFormat, argptr);
2026
// ============================================================================
2028
// ============================================================================
2030
#include "wx/arrstr.h"
2032
wxArrayString::wxArrayString(size_t sz, const wxChar** a)
2037
for (size_t i=0; i < sz; i++)
2041
wxArrayString::wxArrayString(size_t sz, const wxString* a)
2046
for (size_t i=0; i < sz; i++)
2052
// size increment = min(50% of current size, ARRAY_MAXSIZE_INCREMENT)
2053
#define ARRAY_MAXSIZE_INCREMENT 4096
2055
#ifndef ARRAY_DEFAULT_INITIAL_SIZE // also defined in dynarray.h
2056
#define ARRAY_DEFAULT_INITIAL_SIZE (16)
2059
#define STRING(p) ((wxString *)(&(p)))
2062
void wxArrayString::Init(bool autoSort)
2066
m_pItems = (wxChar **) NULL;
2067
m_autoSort = autoSort;
2071
wxArrayString::wxArrayString(const wxArrayString& src)
2073
Init(src.m_autoSort);
2078
// assignment operator
2079
wxArrayString& wxArrayString::operator=(const wxArrayString& src)
2086
m_autoSort = src.m_autoSort;
2091
void wxArrayString::Copy(const wxArrayString& src)
2093
if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE )
2094
Alloc(src.m_nCount);
2096
for ( size_t n = 0; n < src.m_nCount; n++ )
2101
void wxArrayString::Grow(size_t nIncrement)
2103
// only do it if no more place
2104
if ( (m_nSize - m_nCount) < nIncrement ) {
2105
// if ARRAY_DEFAULT_INITIAL_SIZE were set to 0, the initially empty would
2106
// be never resized!
2107
#if ARRAY_DEFAULT_INITIAL_SIZE == 0
2108
#error "ARRAY_DEFAULT_INITIAL_SIZE must be > 0!"
2111
if ( m_nSize == 0 ) {
2112
// was empty, alloc some memory
2113
m_nSize = ARRAY_DEFAULT_INITIAL_SIZE;
2114
if (m_nSize < nIncrement)
2115
m_nSize = nIncrement;
2116
m_pItems = new wxChar *[m_nSize];
2119
// otherwise when it's called for the first time, nIncrement would be 0
2120
// and the array would never be expanded
2121
// add 50% but not too much
2122
size_t ndefIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE
2123
? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1;
2124
if ( ndefIncrement > ARRAY_MAXSIZE_INCREMENT )
2125
ndefIncrement = ARRAY_MAXSIZE_INCREMENT;
2126
if ( nIncrement < ndefIncrement )
2127
nIncrement = ndefIncrement;
2128
m_nSize += nIncrement;
2129
wxChar **pNew = new wxChar *[m_nSize];
2131
// copy data to new location
2132
memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
2134
// delete old memory (but do not release the strings!)
2135
wxDELETEA(m_pItems);
2142
void wxArrayString::Free()
2144
for ( size_t n = 0; n < m_nCount; n++ ) {
2145
STRING(m_pItems[n])->GetStringData()->Unlock();
2149
// deletes all the strings from the list
2150
void wxArrayString::Empty()
2157
// as Empty, but also frees memory
2158
void wxArrayString::Clear()
2165
wxDELETEA(m_pItems);
2169
wxArrayString::~wxArrayString()
2173
wxDELETEA(m_pItems);
2176
void wxArrayString::reserve(size_t nSize)
2181
// pre-allocates memory (frees the previous data!)
2182
void wxArrayString::Alloc(size_t nSize)
2184
// only if old buffer was not big enough
2185
if ( nSize > m_nSize ) {
2187
wxDELETEA(m_pItems);
2188
m_pItems = new wxChar *[nSize];
2195
// minimizes the memory usage by freeing unused memory
2196
void wxArrayString::Shrink()
2198
// only do it if we have some memory to free
2199
if( m_nCount < m_nSize ) {
2200
// allocates exactly as much memory as we need
2201
wxChar **pNew = new wxChar *[m_nCount];
2203
// copy data to new location
2204
memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
2210
#if WXWIN_COMPATIBILITY_2_4
2212
// return a wxString[] as required for some control ctors.
2213
wxString* wxArrayString::GetStringArray() const
2215
wxString *array = 0;
2219
array = new wxString[m_nCount];
2220
for( size_t i = 0; i < m_nCount; i++ )
2221
array[i] = m_pItems[i];
2227
void wxArrayString::Remove(size_t nIndex, size_t nRemove)
2229
RemoveAt(nIndex, nRemove);
2232
#endif // WXWIN_COMPATIBILITY_2_4
2234
// searches the array for an item (forward or backwards)
2235
int wxArrayString::Index(const wxChar *sz, bool bCase, bool bFromEnd) const
2238
// use binary search in the sorted array
2239
wxASSERT_MSG( bCase && !bFromEnd,
2240
wxT("search parameters ignored for auto sorted array") );
2249
res = wxStrcmp(sz, m_pItems[i]);
2261
// use linear search in unsorted array
2263
if ( m_nCount > 0 ) {
2264
size_t ui = m_nCount;
2266
if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) )
2273
for( size_t ui = 0; ui < m_nCount; ui++ ) {
2274
if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) )
2283
// add item at the end
2284
size_t wxArrayString::Add(const wxString& str, size_t nInsert)
2287
// insert the string at the correct position to keep the array sorted
2295
res = str.Cmp(m_pItems[i]);
2306
wxASSERT_MSG( lo == hi, wxT("binary search broken") );
2308
Insert(str, lo, nInsert);
2313
wxASSERT( str.GetStringData()->IsValid() );
2317
for (size_t i = 0; i < nInsert; i++)
2319
// the string data must not be deleted!
2320
str.GetStringData()->Lock();
2323
m_pItems[m_nCount + i] = (wxChar *)str.c_str(); // const_cast
2325
size_t ret = m_nCount;
2326
m_nCount += nInsert;
2331
// add item at the given position
2332
void wxArrayString::Insert(const wxString& str, size_t nIndex, size_t nInsert)
2334
wxASSERT( str.GetStringData()->IsValid() );
2336
wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArrayString::Insert") );
2337
wxCHECK_RET( m_nCount <= m_nCount + nInsert,
2338
wxT("array size overflow in wxArrayString::Insert") );
2342
memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex],
2343
(m_nCount - nIndex)*sizeof(wxChar *));
2345
for (size_t i = 0; i < nInsert; i++)
2347
str.GetStringData()->Lock();
2348
m_pItems[nIndex + i] = (wxChar *)str.c_str();
2350
m_nCount += nInsert;
2353
// range insert (STL 23.2.4.3)
2355
wxArrayString::insert(iterator it, const_iterator first, const_iterator last)
2357
const int idx = it - begin();
2362
// reset "it" since it can change inside Grow()
2365
while ( first != last )
2367
it = insert(it, *first);
2369
// insert returns an iterator to the last element inserted but we need
2370
// insert the next after this one, that is before the next one
2378
void wxArrayString::SetCount(size_t count)
2383
while ( m_nCount < count )
2384
m_pItems[m_nCount++] = (wxChar *)s.c_str();
2387
// removes item from array (by index)
2388
void wxArrayString::RemoveAt(size_t nIndex, size_t nRemove)
2390
wxCHECK_RET( nIndex < m_nCount, wxT("bad index in wxArrayString::Remove") );
2391
wxCHECK_RET( nIndex + nRemove <= m_nCount,
2392
wxT("removing too many elements in wxArrayString::Remove") );
2395
for (size_t i = 0; i < nRemove; i++)
2396
Item(nIndex + i).GetStringData()->Unlock();
2398
memmove(&m_pItems[nIndex], &m_pItems[nIndex + nRemove],
2399
(m_nCount - nIndex - nRemove)*sizeof(wxChar *));
2400
m_nCount -= nRemove;
2403
// removes item from array (by value)
2404
void wxArrayString::Remove(const wxChar *sz)
2406
int iIndex = Index(sz);
2408
wxCHECK_RET( iIndex != wxNOT_FOUND,
2409
wxT("removing inexistent element in wxArrayString::Remove") );
2414
void wxArrayString::assign(const_iterator first, const_iterator last)
2416
reserve(last - first);
2417
for(; first != last; ++first)
2421
// ----------------------------------------------------------------------------
2423
// ----------------------------------------------------------------------------
2425
// we can only sort one array at a time with the quick-sort based
2428
// need a critical section to protect access to gs_compareFunction and
2429
// gs_sortAscending variables
2430
static wxCriticalSection *gs_critsectStringSort = NULL;
2432
// call this before the value of the global sort vars is changed/after
2433
// you're finished with them
2434
#define START_SORT() wxASSERT( !gs_critsectStringSort ); \
2435
gs_critsectStringSort = new wxCriticalSection; \
2436
gs_critsectStringSort->Enter()
2437
#define END_SORT() gs_critsectStringSort->Leave(); \
2438
delete gs_critsectStringSort; \
2439
gs_critsectStringSort = NULL
2441
#define START_SORT()
2443
#endif // wxUSE_THREADS
2445
// function to use for string comparaison
2446
static wxArrayString::CompareFunction gs_compareFunction = NULL;
2448
// if we don't use the compare function, this flag tells us if we sort the
2449
// array in ascending or descending order
2450
static bool gs_sortAscending = true;
2452
// function which is called by quick sort
2453
extern "C" int wxC_CALLING_CONV // LINKAGEMODE
2454
wxStringCompareFunction(const void *first, const void *second)
2456
wxString *strFirst = (wxString *)first;
2457
wxString *strSecond = (wxString *)second;
2459
if ( gs_compareFunction ) {
2460
return gs_compareFunction(*strFirst, *strSecond);
2463
// maybe we should use wxStrcoll
2464
int result = strFirst->Cmp(*strSecond);
2466
return gs_sortAscending ? result : -result;
2470
// sort array elements using passed comparaison function
2471
void wxArrayString::Sort(CompareFunction compareFunction)
2475
wxASSERT( !gs_compareFunction ); // must have been reset to NULL
2476
gs_compareFunction = compareFunction;
2480
// reset it to NULL so that Sort(bool) will work the next time
2481
gs_compareFunction = NULL;
2488
typedef int (wxC_CALLING_CONV * wxStringCompareFn)(const void *first,
2489
const void *second);
2492
void wxArrayString::Sort(CompareFunction2 compareFunction)
2494
qsort(m_pItems, m_nCount, sizeof(wxChar *), (wxStringCompareFn)compareFunction);
2497
void wxArrayString::Sort(bool reverseOrder)
2499
Sort(reverseOrder ? wxStringSortDescending : wxStringSortAscending);
2502
void wxArrayString::DoSort()
2504
wxCHECK_RET( !m_autoSort, wxT("can't use this method with sorted arrays") );
2506
// just sort the pointers using qsort() - of course it only works because
2507
// wxString() *is* a pointer to its data
2508
qsort(m_pItems, m_nCount, sizeof(wxChar *), wxStringCompareFunction);
2511
bool wxArrayString::operator==(const wxArrayString& a) const
2513
if ( m_nCount != a.m_nCount )
2516
for ( size_t n = 0; n < m_nCount; n++ )
2518
if ( Item(n) != a[n] )
2525
#endif // !wxUSE_STL
2527
int wxCMPFUNC_CONV wxStringSortAscending(wxString* s1, wxString* s2)
2529
return s1->Cmp(*s2);
2532
int wxCMPFUNC_CONV wxStringSortDescending(wxString* s1, wxString* s2)
2534
return -s1->Cmp(*s2);