1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxString class
4 // Author: Vadim Zeitlin, Ryan Norton
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 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
, const wxMBConv
& conv
, size_t nLength
)
1012 if ( psz
&& nLength
!= 0 )
1014 if ( nLength
== npos
)
1020 wxWCharBuffer wbuf
= conv
.cMB2WC(psz
, nLength
, &nLenWide
);
1023 assign(wbuf
, nLenWide
);
1027 //Convert wxString in Unicode mode to a multi-byte string
1028 const wxCharBuffer
wxString::mb_str(const wxMBConv
& conv
) const
1030 return conv
.cWC2MB(c_str(), length() + 1 /* size, not length */, NULL
);
1038 wxString::wxString(const wchar_t *pwz
, const wxMBConv
& conv
, size_t nLength
)
1041 if ( pwz
&& nLength
!= 0 )
1043 if ( nLength
== npos
)
1049 wxCharBuffer buf
= conv
.cWC2MB(pwz
, nLength
, &nLenMB
);
1052 assign(buf
, nLenMB
);
1056 //Converts this string to a wide character string if unicode
1057 //mode is not enabled and wxUSE_WCHAR_T is enabled
1058 const wxWCharBuffer
wxString::wc_str(const wxMBConv
& conv
) const
1060 return conv
.cMB2WC(c_str(), length() + 1 /* size, not length */, NULL
);
1063 #endif // wxUSE_WCHAR_T
1065 #endif // Unicode/ANSI
1067 // shrink to minimal size (releasing extra memory)
1068 bool wxString::Shrink()
1070 wxString
tmp(begin(), end());
1072 return tmp
.length() == length();
1076 // get the pointer to writable buffer of (at least) nLen bytes
1077 wxChar
*wxString::GetWriteBuf(size_t nLen
)
1079 if ( !AllocBeforeWrite(nLen
) ) {
1080 // allocation failure handled by caller
1084 wxASSERT( GetStringData()->nRefs
== 1 );
1085 GetStringData()->Validate(false);
1090 // put string back in a reasonable state after GetWriteBuf
1091 void wxString::UngetWriteBuf()
1093 GetStringData()->nDataLength
= wxStrlen(m_pchData
);
1094 GetStringData()->Validate(true);
1097 void wxString::UngetWriteBuf(size_t nLen
)
1099 GetStringData()->nDataLength
= nLen
;
1100 GetStringData()->Validate(true);
1104 // ---------------------------------------------------------------------------
1106 // ---------------------------------------------------------------------------
1108 // all functions are inline in string.h
1110 // ---------------------------------------------------------------------------
1111 // assignment operators
1112 // ---------------------------------------------------------------------------
1116 // same as 'signed char' variant
1117 wxString
& wxString::operator=(const unsigned char* psz
)
1119 *this = (const char *)psz
;
1124 wxString
& wxString::operator=(const wchar_t *pwz
)
1135 * concatenation functions come in 5 flavours:
1137 * char + string and string + char
1138 * C str + string and string + C str
1141 wxString
operator+(const wxString
& str1
, const wxString
& str2
)
1144 wxASSERT( str1
.GetStringData()->IsValid() );
1145 wxASSERT( str2
.GetStringData()->IsValid() );
1154 wxString
operator+(const wxString
& str
, wxChar ch
)
1157 wxASSERT( str
.GetStringData()->IsValid() );
1166 wxString
operator+(wxChar ch
, const wxString
& str
)
1169 wxASSERT( str
.GetStringData()->IsValid() );
1178 wxString
operator+(const wxString
& str
, const wxChar
*psz
)
1181 wxASSERT( str
.GetStringData()->IsValid() );
1185 if ( !s
.Alloc(wxStrlen(psz
) + str
.Len()) ) {
1186 wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1194 wxString
operator+(const wxChar
*psz
, const wxString
& str
)
1197 wxASSERT( str
.GetStringData()->IsValid() );
1201 if ( !s
.Alloc(wxStrlen(psz
) + str
.Len()) ) {
1202 wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1210 // ===========================================================================
1211 // other common string functions
1212 // ===========================================================================
1214 int wxString::Cmp(const wxString
& s
) const
1219 int wxString::Cmp(const wxChar
* psz
) const
1221 return compare(psz
);
1224 static inline int wxDoCmpNoCase(const wxChar
* s1
, size_t l1
,
1225 const wxChar
* s2
, size_t l2
)
1231 for(i
= 0; i
< l1
; ++i
)
1233 if(wxTolower(s1
[i
]) != wxTolower(s2
[i
]))
1236 return i
== l1
? 0 : wxTolower(s1
[i
]) < wxTolower(s2
[i
]) ? -1 : 1;
1240 for(i
= 0; i
< l1
; ++i
)
1242 if(wxTolower(s1
[i
]) != wxTolower(s2
[i
]))
1245 return i
== l1
? -1 : wxTolower(s1
[i
]) < wxTolower(s2
[i
]) ? -1 : 1;
1249 for(i
= 0; i
< l2
; ++i
)
1251 if(wxTolower(s1
[i
]) != wxTolower(s2
[i
]))
1254 return i
== l2
? 1 : wxTolower(s1
[i
]) < wxTolower(s2
[i
]) ? -1 : 1;
1258 int wxString::CmpNoCase(const wxString
& s
) const
1260 return wxDoCmpNoCase(data(), length(), s
.data(), s
.length());
1263 int wxString::CmpNoCase(const wxChar
* psz
) const
1265 int nLen
= wxStrlen(psz
);
1267 return wxDoCmpNoCase(data(), length(), psz
, nLen
);
1274 #ifndef __SCHAR_MAX__
1275 #define __SCHAR_MAX__ 127
1279 wxString
wxString::FromAscii(const char *ascii
)
1282 return wxEmptyString
;
1284 size_t len
= strlen( ascii
);
1289 wxStringBuffer
buf(res
, len
);
1291 wchar_t *dest
= buf
;
1295 if ( (*dest
++ = (wchar_t)(unsigned char)*ascii
++) == L
'\0' )
1303 wxString
wxString::FromAscii(const char ascii
)
1305 // What do we do with '\0' ?
1308 res
+= (wchar_t)(unsigned char) ascii
;
1313 const wxCharBuffer
wxString::ToAscii() const
1315 // this will allocate enough space for the terminating NUL too
1316 wxCharBuffer
buffer(length());
1319 char *dest
= buffer
.data();
1321 const wchar_t *pwc
= c_str();
1324 *dest
++ = (char)(*pwc
> SCHAR_MAX
? wxT('_') : *pwc
);
1326 // the output string can't have embedded NULs anyhow, so we can safely
1327 // stop at first of them even if we do have any
1337 // extract string of length nCount starting at nFirst
1338 wxString
wxString::Mid(size_t nFirst
, size_t nCount
) const
1340 size_t nLen
= length();
1342 // default value of nCount is npos and means "till the end"
1343 if ( nCount
== npos
)
1345 nCount
= nLen
- nFirst
;
1348 // out-of-bounds requests return sensible things
1349 if ( nFirst
+ nCount
> nLen
)
1351 nCount
= nLen
- nFirst
;
1354 if ( nFirst
> nLen
)
1356 // AllocCopy() will return empty string
1357 return wxEmptyString
;
1360 wxString
dest(*this, nFirst
, nCount
);
1361 if ( dest
.length() != nCount
)
1363 wxFAIL_MSG( _T("out of memory in wxString::Mid") );
1369 // check that the string starts with prefix and return the rest of the string
1370 // in the provided pointer if it is not NULL, otherwise return false
1371 bool wxString::StartsWith(const wxChar
*prefix
, wxString
*rest
) const
1373 wxASSERT_MSG( prefix
, _T("invalid parameter in wxString::StartsWith") );
1375 // first check if the beginning of the string matches the prefix: note
1376 // that we don't have to check that we don't run out of this string as
1377 // when we reach the terminating NUL, either prefix string ends too (and
1378 // then it's ok) or we break out of the loop because there is no match
1379 const wxChar
*p
= c_str();
1382 if ( *prefix
++ != *p
++ )
1391 // put the rest of the string into provided pointer
1398 // extract nCount last (rightmost) characters
1399 wxString
wxString::Right(size_t nCount
) const
1401 if ( nCount
> length() )
1404 wxString
dest(*this, length() - nCount
, nCount
);
1405 if ( dest
.length() != nCount
) {
1406 wxFAIL_MSG( _T("out of memory in wxString::Right") );
1411 // get all characters after the last occurence of ch
1412 // (returns the whole string if ch not found)
1413 wxString
wxString::AfterLast(wxChar ch
) const
1416 int iPos
= Find(ch
, true);
1417 if ( iPos
== wxNOT_FOUND
)
1420 str
= c_str() + iPos
+ 1;
1425 // extract nCount first (leftmost) characters
1426 wxString
wxString::Left(size_t nCount
) const
1428 if ( nCount
> length() )
1431 wxString
dest(*this, 0, nCount
);
1432 if ( dest
.length() != nCount
) {
1433 wxFAIL_MSG( _T("out of memory in wxString::Left") );
1438 // get all characters before the first occurence of ch
1439 // (returns the whole string if ch not found)
1440 wxString
wxString::BeforeFirst(wxChar ch
) const
1442 int iPos
= Find(ch
);
1443 if ( iPos
== wxNOT_FOUND
) iPos
= length();
1444 return wxString(*this, 0, iPos
);
1447 /// get all characters before the last occurence of ch
1448 /// (returns empty string if ch not found)
1449 wxString
wxString::BeforeLast(wxChar ch
) const
1452 int iPos
= Find(ch
, true);
1453 if ( iPos
!= wxNOT_FOUND
&& iPos
!= 0 )
1454 str
= wxString(c_str(), iPos
);
1459 /// get all characters after the first occurence of ch
1460 /// (returns empty string if ch not found)
1461 wxString
wxString::AfterFirst(wxChar ch
) const
1464 int iPos
= Find(ch
);
1465 if ( iPos
!= wxNOT_FOUND
)
1466 str
= c_str() + iPos
+ 1;
1471 // replace first (or all) occurences of some substring with another one
1472 size_t wxString::Replace(const wxChar
*szOld
,
1473 const wxChar
*szNew
, bool bReplaceAll
)
1475 // if we tried to replace an empty string we'd enter an infinite loop below
1476 wxCHECK_MSG( szOld
&& *szOld
&& szNew
, 0,
1477 _T("wxString::Replace(): invalid parameter") );
1479 size_t uiCount
= 0; // count of replacements made
1481 size_t uiOldLen
= wxStrlen(szOld
);
1482 size_t uiNewLen
= wxStrlen(szNew
);
1486 while ( this->c_str()[dwPos
] != wxT('\0') )
1488 //DO NOT USE STRSTR HERE
1489 //this string can contain embedded null characters,
1490 //so strstr will function incorrectly
1491 dwPos
= find(szOld
, dwPos
);
1492 if ( dwPos
== npos
)
1493 break; // exit the loop
1496 //replace this occurance of the old string with the new one
1497 replace(dwPos
, uiOldLen
, szNew
, uiNewLen
);
1499 //move up pos past the string that was replaced
1502 //increase replace count
1507 break; // exit the loop
1514 bool wxString::IsAscii() const
1516 const wxChar
*s
= (const wxChar
*) *this;
1518 if(!isascii(*s
)) return(false);
1524 bool wxString::IsWord() const
1526 const wxChar
*s
= (const wxChar
*) *this;
1528 if(!wxIsalpha(*s
)) return(false);
1534 bool wxString::IsNumber() const
1536 const wxChar
*s
= (const wxChar
*) *this;
1538 if ((s
[0] == wxT('-')) || (s
[0] == wxT('+'))) s
++;
1540 if(!wxIsdigit(*s
)) return(false);
1546 wxString
wxString::Strip(stripType w
) const
1549 if ( w
& leading
) s
.Trim(false);
1550 if ( w
& trailing
) s
.Trim(true);
1554 // ---------------------------------------------------------------------------
1556 // ---------------------------------------------------------------------------
1558 wxString
& wxString::MakeUpper()
1560 for ( iterator it
= begin(), en
= end(); it
!= en
; ++it
)
1561 *it
= (wxChar
)wxToupper(*it
);
1566 wxString
& wxString::MakeLower()
1568 for ( iterator it
= begin(), en
= end(); it
!= en
; ++it
)
1569 *it
= (wxChar
)wxTolower(*it
);
1574 // ---------------------------------------------------------------------------
1575 // trimming and padding
1576 // ---------------------------------------------------------------------------
1578 // some compilers (VC++ 6.0 not to name them) return true for a call to
1579 // isspace('ê') in the C locale which seems to be broken to me, but we have to
1580 // live with this by checking that the character is a 7 bit one - even if this
1581 // may fail to detect some spaces (I don't know if Unicode doesn't have
1582 // space-like symbols somewhere except in the first 128 chars), it is arguably
1583 // still better than trimming away accented letters
1584 inline int wxSafeIsspace(wxChar ch
) { return (ch
< 127) && wxIsspace(ch
); }
1586 // trims spaces (in the sense of isspace) from left or right side
1587 wxString
& wxString::Trim(bool bFromRight
)
1589 // first check if we're going to modify the string at all
1592 (bFromRight
&& wxSafeIsspace(GetChar(Len() - 1))) ||
1593 (!bFromRight
&& wxSafeIsspace(GetChar(0u)))
1599 // find last non-space character
1600 iterator psz
= begin() + length() - 1;
1601 while ( wxSafeIsspace(*psz
) && (psz
>= begin()) )
1604 // truncate at trailing space start
1610 // find first non-space character
1611 iterator psz
= begin();
1612 while ( wxSafeIsspace(*psz
) )
1615 // fix up data and length
1616 erase(begin(), psz
);
1623 // adds nCount characters chPad to the string from either side
1624 wxString
& wxString::Pad(size_t nCount
, wxChar chPad
, bool bFromRight
)
1626 wxString
s(chPad
, nCount
);
1639 // truncate the string
1640 wxString
& wxString::Truncate(size_t uiLen
)
1642 if ( uiLen
< Len() ) {
1643 erase(begin() + uiLen
, end());
1645 //else: nothing to do, string is already short enough
1650 // ---------------------------------------------------------------------------
1651 // finding (return wxNOT_FOUND if not found and index otherwise)
1652 // ---------------------------------------------------------------------------
1655 int wxString::Find(wxChar ch
, bool bFromEnd
) const
1657 size_type idx
= bFromEnd
? find_last_of(ch
) : find_first_of(ch
);
1659 return (idx
== npos
) ? wxNOT_FOUND
: (int)idx
;
1662 // find a sub-string (like strstr)
1663 int wxString::Find(const wxChar
*pszSub
) const
1665 size_type idx
= find(pszSub
);
1667 return (idx
== npos
) ? wxNOT_FOUND
: (int)idx
;
1670 // ----------------------------------------------------------------------------
1671 // conversion to numbers
1672 // ----------------------------------------------------------------------------
1674 bool wxString::ToLong(long *val
, int base
) const
1676 wxCHECK_MSG( val
, false, _T("NULL pointer in wxString::ToLong") );
1677 wxASSERT_MSG( !base
|| (base
> 1 && base
<= 36), _T("invalid base") );
1679 const wxChar
*start
= c_str();
1681 *val
= wxStrtol(start
, &end
, base
);
1683 // return true only if scan was stopped by the terminating NUL and if the
1684 // string was not empty to start with
1685 return !*end
&& (end
!= start
);
1688 bool wxString::ToULong(unsigned long *val
, int base
) const
1690 wxCHECK_MSG( val
, false, _T("NULL pointer in wxString::ToULong") );
1691 wxASSERT_MSG( !base
|| (base
> 1 && base
<= 36), _T("invalid base") );
1693 const wxChar
*start
= c_str();
1695 *val
= wxStrtoul(start
, &end
, base
);
1697 // return true only if scan was stopped by the terminating NUL and if the
1698 // string was not empty to start with
1699 return !*end
&& (end
!= start
);
1702 bool wxString::ToDouble(double *val
) const
1704 wxCHECK_MSG( val
, false, _T("NULL pointer in wxString::ToDouble") );
1706 const wxChar
*start
= c_str();
1708 *val
= wxStrtod(start
, &end
);
1710 // return true only if scan was stopped by the terminating NUL and if the
1711 // string was not empty to start with
1712 return !*end
&& (end
!= start
);
1715 // ---------------------------------------------------------------------------
1717 // ---------------------------------------------------------------------------
1720 wxString
wxString::Format(const wxChar
*pszFormat
, ...)
1723 va_start(argptr
, pszFormat
);
1726 s
.PrintfV(pszFormat
, argptr
);
1734 wxString
wxString::FormatV(const wxChar
*pszFormat
, va_list argptr
)
1737 s
.PrintfV(pszFormat
, argptr
);
1741 int wxString::Printf(const wxChar
*pszFormat
, ...)
1744 va_start(argptr
, pszFormat
);
1746 int iLen
= PrintfV(pszFormat
, argptr
);
1753 int wxString::PrintfV(const wxChar
* pszFormat
, va_list argptr
)
1759 wxStringBuffer
tmp(*this, size
+ 1);
1768 // wxVsnprintf() may modify the original arg pointer, so pass it
1771 wxVaCopy(argptrcopy
, argptr
);
1772 int len
= wxVsnprintf(buf
, size
, pszFormat
, argptrcopy
);
1775 // some implementations of vsnprintf() don't NUL terminate
1776 // the string if there is not enough space for it so
1777 // always do it manually
1778 buf
[size
] = _T('\0');
1780 // vsnprintf() may return either -1 (traditional Unix behaviour) or the
1781 // total number of characters which would have been written if the
1782 // buffer were large enough (newer standards such as Unix98)
1785 // still not enough, as we don't know how much we need, double the
1786 // current size of the buffer
1789 else if ( len
> size
)
1793 else // ok, there was enough space
1799 // we could have overshot
1805 // ----------------------------------------------------------------------------
1806 // misc other operations
1807 // ----------------------------------------------------------------------------
1809 // returns true if the string matches the pattern which may contain '*' and
1810 // '?' metacharacters (as usual, '?' matches any character and '*' any number
1812 bool wxString::Matches(const wxChar
*pszMask
) const
1814 // I disable this code as it doesn't seem to be faster (in fact, it seems
1815 // to be much slower) than the old, hand-written code below and using it
1816 // here requires always linking with libregex even if the user code doesn't
1818 #if 0 // wxUSE_REGEX
1819 // first translate the shell-like mask into a regex
1821 pattern
.reserve(wxStrlen(pszMask
));
1833 pattern
+= _T(".*");
1844 // these characters are special in a RE, quote them
1845 // (however note that we don't quote '[' and ']' to allow
1846 // using them for Unix shell like matching)
1847 pattern
+= _T('\\');
1851 pattern
+= *pszMask
;
1859 return wxRegEx(pattern
, wxRE_NOSUB
| wxRE_EXTENDED
).Matches(c_str());
1860 #else // !wxUSE_REGEX
1861 // TODO: this is, of course, awfully inefficient...
1863 // the char currently being checked
1864 const wxChar
*pszTxt
= c_str();
1866 // the last location where '*' matched
1867 const wxChar
*pszLastStarInText
= NULL
;
1868 const wxChar
*pszLastStarInMask
= NULL
;
1871 for ( ; *pszMask
!= wxT('\0'); pszMask
++, pszTxt
++ ) {
1872 switch ( *pszMask
) {
1874 if ( *pszTxt
== wxT('\0') )
1877 // pszTxt and pszMask will be incremented in the loop statement
1883 // remember where we started to be able to backtrack later
1884 pszLastStarInText
= pszTxt
;
1885 pszLastStarInMask
= pszMask
;
1887 // ignore special chars immediately following this one
1888 // (should this be an error?)
1889 while ( *pszMask
== wxT('*') || *pszMask
== wxT('?') )
1892 // if there is nothing more, match
1893 if ( *pszMask
== wxT('\0') )
1896 // are there any other metacharacters in the mask?
1898 const wxChar
*pEndMask
= wxStrpbrk(pszMask
, wxT("*?"));
1900 if ( pEndMask
!= NULL
) {
1901 // we have to match the string between two metachars
1902 uiLenMask
= pEndMask
- pszMask
;
1905 // we have to match the remainder of the string
1906 uiLenMask
= wxStrlen(pszMask
);
1909 wxString
strToMatch(pszMask
, uiLenMask
);
1910 const wxChar
* pMatch
= wxStrstr(pszTxt
, strToMatch
);
1911 if ( pMatch
== NULL
)
1914 // -1 to compensate "++" in the loop
1915 pszTxt
= pMatch
+ uiLenMask
- 1;
1916 pszMask
+= uiLenMask
- 1;
1921 if ( *pszMask
!= *pszTxt
)
1927 // match only if nothing left
1928 if ( *pszTxt
== wxT('\0') )
1931 // if we failed to match, backtrack if we can
1932 if ( pszLastStarInText
) {
1933 pszTxt
= pszLastStarInText
+ 1;
1934 pszMask
= pszLastStarInMask
;
1936 pszLastStarInText
= NULL
;
1938 // don't bother resetting pszLastStarInMask, it's unnecessary
1944 #endif // wxUSE_REGEX/!wxUSE_REGEX
1947 // Count the number of chars
1948 int wxString::Freq(wxChar ch
) const
1952 for (int i
= 0; i
< len
; i
++)
1954 if (GetChar(i
) == ch
)
1960 // convert to upper case, return the copy of the string
1961 wxString
wxString::Upper() const
1962 { wxString
s(*this); return s
.MakeUpper(); }
1964 // convert to lower case, return the copy of the string
1965 wxString
wxString::Lower() const { wxString
s(*this); return s
.MakeLower(); }
1967 int wxString::sprintf(const wxChar
*pszFormat
, ...)
1970 va_start(argptr
, pszFormat
);
1971 int iLen
= PrintfV(pszFormat
, argptr
);
1976 // ============================================================================
1978 // ============================================================================
1980 #include "wx/arrstr.h"
1982 wxArrayString::wxArrayString(size_t sz
, const wxChar
** a
)
1987 for (size_t i
=0; i
< sz
; i
++)
1991 wxArrayString::wxArrayString(size_t sz
, const wxString
* a
)
1996 for (size_t i
=0; i
< sz
; i
++)
2002 // size increment = min(50% of current size, ARRAY_MAXSIZE_INCREMENT)
2003 #define ARRAY_MAXSIZE_INCREMENT 4096
2005 #ifndef ARRAY_DEFAULT_INITIAL_SIZE // also defined in dynarray.h
2006 #define ARRAY_DEFAULT_INITIAL_SIZE (16)
2009 #define STRING(p) ((wxString *)(&(p)))
2012 void wxArrayString::Init(bool autoSort
)
2016 m_pItems
= (wxChar
**) NULL
;
2017 m_autoSort
= autoSort
;
2021 wxArrayString::wxArrayString(const wxArrayString
& src
)
2023 Init(src
.m_autoSort
);
2028 // assignment operator
2029 wxArrayString
& wxArrayString::operator=(const wxArrayString
& src
)
2036 m_autoSort
= src
.m_autoSort
;
2041 void wxArrayString::Copy(const wxArrayString
& src
)
2043 if ( src
.m_nCount
> ARRAY_DEFAULT_INITIAL_SIZE
)
2044 Alloc(src
.m_nCount
);
2046 for ( size_t n
= 0; n
< src
.m_nCount
; n
++ )
2051 void wxArrayString::Grow(size_t nIncrement
)
2053 // only do it if no more place
2054 if ( (m_nSize
- m_nCount
) < nIncrement
) {
2055 // if ARRAY_DEFAULT_INITIAL_SIZE were set to 0, the initially empty would
2056 // be never resized!
2057 #if ARRAY_DEFAULT_INITIAL_SIZE == 0
2058 #error "ARRAY_DEFAULT_INITIAL_SIZE must be > 0!"
2061 if ( m_nSize
== 0 ) {
2062 // was empty, alloc some memory
2063 m_nSize
= ARRAY_DEFAULT_INITIAL_SIZE
;
2064 if (m_nSize
< nIncrement
)
2065 m_nSize
= nIncrement
;
2066 m_pItems
= new wxChar
*[m_nSize
];
2069 // otherwise when it's called for the first time, nIncrement would be 0
2070 // and the array would never be expanded
2071 // add 50% but not too much
2072 size_t ndefIncrement
= m_nSize
< ARRAY_DEFAULT_INITIAL_SIZE
2073 ? ARRAY_DEFAULT_INITIAL_SIZE
: m_nSize
>> 1;
2074 if ( ndefIncrement
> ARRAY_MAXSIZE_INCREMENT
)
2075 ndefIncrement
= ARRAY_MAXSIZE_INCREMENT
;
2076 if ( nIncrement
< ndefIncrement
)
2077 nIncrement
= ndefIncrement
;
2078 m_nSize
+= nIncrement
;
2079 wxChar
**pNew
= new wxChar
*[m_nSize
];
2081 // copy data to new location
2082 memcpy(pNew
, m_pItems
, m_nCount
*sizeof(wxChar
*));
2084 // delete old memory (but do not release the strings!)
2085 wxDELETEA(m_pItems
);
2092 void wxArrayString::Free()
2094 for ( size_t n
= 0; n
< m_nCount
; n
++ ) {
2095 STRING(m_pItems
[n
])->GetStringData()->Unlock();
2099 // deletes all the strings from the list
2100 void wxArrayString::Empty()
2107 // as Empty, but also frees memory
2108 void wxArrayString::Clear()
2115 wxDELETEA(m_pItems
);
2119 wxArrayString::~wxArrayString()
2123 wxDELETEA(m_pItems
);
2126 void wxArrayString::reserve(size_t nSize
)
2131 // pre-allocates memory (frees the previous data!)
2132 void wxArrayString::Alloc(size_t nSize
)
2134 // only if old buffer was not big enough
2135 if ( nSize
> m_nSize
) {
2137 wxDELETEA(m_pItems
);
2138 m_pItems
= new wxChar
*[nSize
];
2145 // minimizes the memory usage by freeing unused memory
2146 void wxArrayString::Shrink()
2148 // only do it if we have some memory to free
2149 if( m_nCount
< m_nSize
) {
2150 // allocates exactly as much memory as we need
2151 wxChar
**pNew
= new wxChar
*[m_nCount
];
2153 // copy data to new location
2154 memcpy(pNew
, m_pItems
, m_nCount
*sizeof(wxChar
*));
2160 #if WXWIN_COMPATIBILITY_2_4
2162 // return a wxString[] as required for some control ctors.
2163 wxString
* wxArrayString::GetStringArray() const
2165 wxString
*array
= 0;
2169 array
= new wxString
[m_nCount
];
2170 for( size_t i
= 0; i
< m_nCount
; i
++ )
2171 array
[i
] = m_pItems
[i
];
2177 void wxArrayString::Remove(size_t nIndex
, size_t nRemove
)
2179 RemoveAt(nIndex
, nRemove
);
2182 #endif // WXWIN_COMPATIBILITY_2_4
2184 // searches the array for an item (forward or backwards)
2185 int wxArrayString::Index(const wxChar
*sz
, bool bCase
, bool bFromEnd
) const
2188 // use binary search in the sorted array
2189 wxASSERT_MSG( bCase
&& !bFromEnd
,
2190 wxT("search parameters ignored for auto sorted array") );
2199 res
= wxStrcmp(sz
, m_pItems
[i
]);
2211 // use linear search in unsorted array
2213 if ( m_nCount
> 0 ) {
2214 size_t ui
= m_nCount
;
2216 if ( STRING(m_pItems
[--ui
])->IsSameAs(sz
, bCase
) )
2223 for( size_t ui
= 0; ui
< m_nCount
; ui
++ ) {
2224 if( STRING(m_pItems
[ui
])->IsSameAs(sz
, bCase
) )
2233 // add item at the end
2234 size_t wxArrayString::Add(const wxString
& str
, size_t nInsert
)
2237 // insert the string at the correct position to keep the array sorted
2245 res
= str
.Cmp(m_pItems
[i
]);
2256 wxASSERT_MSG( lo
== hi
, wxT("binary search broken") );
2258 Insert(str
, lo
, nInsert
);
2263 wxASSERT( str
.GetStringData()->IsValid() );
2267 for (size_t i
= 0; i
< nInsert
; i
++)
2269 // the string data must not be deleted!
2270 str
.GetStringData()->Lock();
2273 m_pItems
[m_nCount
+ i
] = (wxChar
*)str
.c_str(); // const_cast
2275 size_t ret
= m_nCount
;
2276 m_nCount
+= nInsert
;
2281 // add item at the given position
2282 void wxArrayString::Insert(const wxString
& str
, size_t nIndex
, size_t nInsert
)
2284 wxASSERT( str
.GetStringData()->IsValid() );
2286 wxCHECK_RET( nIndex
<= m_nCount
, wxT("bad index in wxArrayString::Insert") );
2287 wxCHECK_RET( m_nCount
<= m_nCount
+ nInsert
,
2288 wxT("array size overflow in wxArrayString::Insert") );
2292 memmove(&m_pItems
[nIndex
+ nInsert
], &m_pItems
[nIndex
],
2293 (m_nCount
- nIndex
)*sizeof(wxChar
*));
2295 for (size_t i
= 0; i
< nInsert
; i
++)
2297 str
.GetStringData()->Lock();
2298 m_pItems
[nIndex
+ i
] = (wxChar
*)str
.c_str();
2300 m_nCount
+= nInsert
;
2303 // range insert (STL 23.2.4.3)
2305 wxArrayString::insert(iterator it
, const_iterator first
, const_iterator last
)
2307 const int idx
= it
- begin();
2312 // reset "it" since it can change inside Grow()
2315 while ( first
!= last
)
2317 it
= insert(it
, *first
);
2319 // insert returns an iterator to the last element inserted but we need
2320 // insert the next after this one, that is before the next one
2328 void wxArrayString::SetCount(size_t count
)
2333 while ( m_nCount
< count
)
2334 m_pItems
[m_nCount
++] = (wxChar
*)s
.c_str();
2337 // removes item from array (by index)
2338 void wxArrayString::RemoveAt(size_t nIndex
, size_t nRemove
)
2340 wxCHECK_RET( nIndex
< m_nCount
, wxT("bad index in wxArrayString::Remove") );
2341 wxCHECK_RET( nIndex
+ nRemove
<= m_nCount
,
2342 wxT("removing too many elements in wxArrayString::Remove") );
2345 for (size_t i
= 0; i
< nRemove
; i
++)
2346 Item(nIndex
+ i
).GetStringData()->Unlock();
2348 memmove(&m_pItems
[nIndex
], &m_pItems
[nIndex
+ nRemove
],
2349 (m_nCount
- nIndex
- nRemove
)*sizeof(wxChar
*));
2350 m_nCount
-= nRemove
;
2353 // removes item from array (by value)
2354 void wxArrayString::Remove(const wxChar
*sz
)
2356 int iIndex
= Index(sz
);
2358 wxCHECK_RET( iIndex
!= wxNOT_FOUND
,
2359 wxT("removing inexistent element in wxArrayString::Remove") );
2364 void wxArrayString::assign(const_iterator first
, const_iterator last
)
2366 reserve(last
- first
);
2367 for(; first
!= last
; ++first
)
2371 // ----------------------------------------------------------------------------
2373 // ----------------------------------------------------------------------------
2375 // we can only sort one array at a time with the quick-sort based
2378 // need a critical section to protect access to gs_compareFunction and
2379 // gs_sortAscending variables
2380 static wxCriticalSection
*gs_critsectStringSort
= NULL
;
2382 // call this before the value of the global sort vars is changed/after
2383 // you're finished with them
2384 #define START_SORT() wxASSERT( !gs_critsectStringSort ); \
2385 gs_critsectStringSort = new wxCriticalSection; \
2386 gs_critsectStringSort->Enter()
2387 #define END_SORT() gs_critsectStringSort->Leave(); \
2388 delete gs_critsectStringSort; \
2389 gs_critsectStringSort = NULL
2391 #define START_SORT()
2393 #endif // wxUSE_THREADS
2395 // function to use for string comparaison
2396 static wxArrayString::CompareFunction gs_compareFunction
= NULL
;
2398 // if we don't use the compare function, this flag tells us if we sort the
2399 // array in ascending or descending order
2400 static bool gs_sortAscending
= true;
2402 // function which is called by quick sort
2403 extern "C" int wxC_CALLING_CONV
// LINKAGEMODE
2404 wxStringCompareFunction(const void *first
, const void *second
)
2406 wxString
*strFirst
= (wxString
*)first
;
2407 wxString
*strSecond
= (wxString
*)second
;
2409 if ( gs_compareFunction
) {
2410 return gs_compareFunction(*strFirst
, *strSecond
);
2413 // maybe we should use wxStrcoll
2414 int result
= strFirst
->Cmp(*strSecond
);
2416 return gs_sortAscending
? result
: -result
;
2420 // sort array elements using passed comparaison function
2421 void wxArrayString::Sort(CompareFunction compareFunction
)
2425 wxASSERT( !gs_compareFunction
); // must have been reset to NULL
2426 gs_compareFunction
= compareFunction
;
2430 // reset it to NULL so that Sort(bool) will work the next time
2431 gs_compareFunction
= NULL
;
2438 typedef int (wxC_CALLING_CONV
* wxStringCompareFn
)(const void *first
,
2439 const void *second
);
2442 void wxArrayString::Sort(CompareFunction2 compareFunction
)
2444 qsort(m_pItems
, m_nCount
, sizeof(wxChar
*), (wxStringCompareFn
)compareFunction
);
2447 void wxArrayString::Sort(bool reverseOrder
)
2449 Sort(reverseOrder
? wxStringSortDescending
: wxStringSortAscending
);
2452 void wxArrayString::DoSort()
2454 wxCHECK_RET( !m_autoSort
, wxT("can't use this method with sorted arrays") );
2456 // just sort the pointers using qsort() - of course it only works because
2457 // wxString() *is* a pointer to its data
2458 qsort(m_pItems
, m_nCount
, sizeof(wxChar
*), wxStringCompareFunction
);
2461 bool wxArrayString::operator==(const wxArrayString
& a
) const
2463 if ( m_nCount
!= a
.m_nCount
)
2466 for ( size_t n
= 0; n
< m_nCount
; n
++ )
2468 if ( Item(n
) != a
[n
] )
2475 #endif // !wxUSE_STL
2477 int wxCMPFUNC_CONV
wxStringSortAscending(wxString
* s1
, wxString
* s2
)
2479 return s1
->Cmp(*s2
);
2482 int wxCMPFUNC_CONV
wxStringSortDescending(wxString
* s1
, wxString
* s2
)
2484 return -s1
->Cmp(*s2
);