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 /////////////////////////////////////////////////////////////////////////////
13 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
14 #pragma implementation "string.h"
19 * 1) all empty strings use g_strEmpty, nRefs = -1 (set in Init())
20 * 2) AllocBuffer() sets nRefs to 1, Lock() increments it by one
21 * 3) Unlock() decrements nRefs and frees memory if it goes to 0
24 // ===========================================================================
25 // headers, declarations, constants
26 // ===========================================================================
28 // For compilers that support precompilation, includes "wx.h".
29 #include "wx/wxprec.h"
37 #include "wx/string.h"
39 #include "wx/thread.h"
50 // allocating extra space for each string consumes more memory but speeds up
51 // the concatenation operations (nLen is the current string's length)
52 // NB: EXTRA_ALLOC must be >= 0!
53 #define EXTRA_ALLOC (19 - nLen % 16)
55 // ---------------------------------------------------------------------------
56 // static class variables definition
57 // ---------------------------------------------------------------------------
59 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
60 // must define this static for VA or else you get multiply defined symbols
62 const unsigned int wxSTRING_MAXLEN
= UINT_MAX
- 100;
66 const size_t wxStringBase::npos
= wxSTRING_MAXLEN
;
69 // ----------------------------------------------------------------------------
71 // ----------------------------------------------------------------------------
75 extern const wxChar WXDLLIMPEXP_BASE
*wxEmptyString
= _T("");
79 // for an empty string, GetStringData() will return this address: this
80 // structure has the same layout as wxStringData and it's data() method will
81 // return the empty string (dummy pointer)
86 } g_strEmpty
= { {-1, 0, 0}, wxT('\0') };
88 // empty C style string: points to 'string data' byte of g_strEmpty
89 extern const wxChar WXDLLIMPEXP_BASE
*wxEmptyString
= &g_strEmpty
.dummy
;
93 // ----------------------------------------------------------------------------
95 // ----------------------------------------------------------------------------
97 #if wxUSE_STD_IOSTREAM
99 // MS Visual C++ version 5.0 provides the new STL headers as well as the old
102 // ATTN: you can _not_ use both of these in the same program!
106 wxSTD istream
& operator>>(wxSTD istream
& is
, wxString
& WXUNUSED(str
))
111 streambuf
*sb
= is
.rdbuf();
114 int ch
= sb
->sbumpc ();
116 is
.setstate(ios::eofbit
);
119 else if ( isspace(ch
) ) {
131 if ( str
.length() == 0 )
132 is
.setstate(ios::failbit
);
137 wxSTD ostream
& operator<<(wxSTD ostream
& os
, const wxString
& str
)
143 #endif // wxUSE_STD_IOSTREAM
145 // ----------------------------------------------------------------------------
147 // ----------------------------------------------------------------------------
149 // this small class is used to gather statistics for performance tuning
150 //#define WXSTRING_STATISTICS
151 #ifdef WXSTRING_STATISTICS
155 Averager(const wxChar
*sz
) { m_sz
= sz
; m_nTotal
= m_nCount
= 0; }
157 { wxPrintf("wxString: average %s = %f\n", m_sz
, ((float)m_nTotal
)/m_nCount
); }
159 void Add(size_t n
) { m_nTotal
+= n
; m_nCount
++; }
162 size_t m_nCount
, m_nTotal
;
164 } g_averageLength("allocation size"),
165 g_averageSummandLength("summand length"),
166 g_averageConcatHit("hit probability in concat"),
167 g_averageInitialLength("initial string length");
169 #define STATISTICS_ADD(av, val) g_average##av.Add(val)
171 #define STATISTICS_ADD(av, val)
172 #endif // WXSTRING_STATISTICS
176 // ===========================================================================
177 // wxStringData class deallocation
178 // ===========================================================================
180 #if defined(__VISUALC__) && defined(_MT) && !defined(_DLL)
181 # pragma message (__FILE__ ": building with Multithreaded non DLL runtime has a performance impact on wxString!")
182 void wxStringData::Free()
188 // ===========================================================================
190 // ===========================================================================
192 // takes nLength elements of psz starting at nPos
193 void wxStringBase::InitWith(const wxChar
*psz
, size_t nPos
, size_t nLength
)
197 // if the length is not given, assume the string to be NUL terminated
198 if ( nLength
== npos
) {
199 wxASSERT_MSG( nPos
<= wxStrlen(psz
), _T("index out of bounds") );
201 nLength
= wxStrlen(psz
+ nPos
);
204 STATISTICS_ADD(InitialLength
, nLength
);
207 // trailing '\0' is written in AllocBuffer()
208 if ( !AllocBuffer(nLength
) ) {
209 wxFAIL_MSG( _T("out of memory in wxStringBase::InitWith") );
212 wxTmemcpy(m_pchData
, psz
+ nPos
, nLength
);
216 // poor man's iterators are "void *" pointers
217 wxStringBase::wxStringBase(const void *pStart
, const void *pEnd
)
219 InitWith((const wxChar
*)pStart
, 0,
220 (const wxChar
*)pEnd
- (const wxChar
*)pStart
);
223 wxStringBase::wxStringBase(size_type n
, wxChar ch
)
229 // ---------------------------------------------------------------------------
231 // ---------------------------------------------------------------------------
233 // allocates memory needed to store a C string of length nLen
234 bool wxStringBase::AllocBuffer(size_t nLen
)
236 // allocating 0 sized buffer doesn't make sense, all empty strings should
238 wxASSERT( nLen
> 0 );
240 // make sure that we don't overflow
241 wxASSERT( nLen
< (INT_MAX
/ sizeof(wxChar
)) -
242 (sizeof(wxStringData
) + EXTRA_ALLOC
+ 1) );
244 STATISTICS_ADD(Length
, nLen
);
247 // 1) one extra character for '\0' termination
248 // 2) sizeof(wxStringData) for housekeeping info
249 wxStringData
* pData
= (wxStringData
*)
250 malloc(sizeof(wxStringData
) + (nLen
+ EXTRA_ALLOC
+ 1)*sizeof(wxChar
));
252 if ( pData
== NULL
) {
253 // allocation failures are handled by the caller
258 pData
->nDataLength
= nLen
;
259 pData
->nAllocLength
= nLen
+ EXTRA_ALLOC
;
260 m_pchData
= pData
->data(); // data starts after wxStringData
261 m_pchData
[nLen
] = wxT('\0');
265 // must be called before changing this string
266 bool wxStringBase::CopyBeforeWrite()
268 wxStringData
* pData
= GetStringData();
270 if ( pData
->IsShared() ) {
271 pData
->Unlock(); // memory not freed because shared
272 size_t nLen
= pData
->nDataLength
;
273 if ( !AllocBuffer(nLen
) ) {
274 // allocation failures are handled by the caller
277 wxTmemcpy(m_pchData
, pData
->data(), nLen
);
280 wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner
285 // must be called before replacing contents of this string
286 bool wxStringBase::AllocBeforeWrite(size_t nLen
)
288 wxASSERT( nLen
!= 0 ); // doesn't make any sense
290 // must not share string and must have enough space
291 wxStringData
* pData
= GetStringData();
292 if ( pData
->IsShared() || pData
->IsEmpty() ) {
293 // can't work with old buffer, get new one
295 if ( !AllocBuffer(nLen
) ) {
296 // allocation failures are handled by the caller
301 if ( nLen
> pData
->nAllocLength
) {
302 // realloc the buffer instead of calling malloc() again, this is more
304 STATISTICS_ADD(Length
, nLen
);
308 pData
= (wxStringData
*)
309 realloc(pData
, sizeof(wxStringData
) + (nLen
+ 1)*sizeof(wxChar
));
311 if ( pData
== NULL
) {
312 // allocation failures are handled by the caller
313 // keep previous data since reallocation failed
317 pData
->nAllocLength
= nLen
;
318 m_pchData
= pData
->data();
321 // now we have enough space, just update the string length
322 pData
->nDataLength
= nLen
;
325 wxASSERT( !GetStringData()->IsShared() ); // we must be the only owner
330 wxStringBase
& wxStringBase::append(size_t n
, wxChar ch
)
332 size_type len
= length();
334 if ( !CopyBeforeWrite() || !Alloc(len
+ n
) ) {
335 wxFAIL_MSG( _T("out of memory in wxStringBase::append") );
337 GetStringData()->nDataLength
= len
+ n
;
338 m_pchData
[len
+ n
] = '\0';
339 for ( size_t i
= 0; i
< n
; ++i
)
340 m_pchData
[len
+ i
] = ch
;
344 void wxStringBase::resize(size_t nSize
, wxChar ch
)
346 size_t len
= length();
350 erase(begin() + nSize
, end());
352 else if ( nSize
> len
)
354 append(nSize
- len
, ch
);
356 //else: we have exactly the specified length, nothing to do
359 // allocate enough memory for nLen characters
360 bool wxStringBase::Alloc(size_t nLen
)
362 wxStringData
*pData
= GetStringData();
363 if ( pData
->nAllocLength
<= nLen
) {
364 if ( pData
->IsEmpty() ) {
367 wxStringData
* pData
= (wxStringData
*)
368 malloc(sizeof(wxStringData
) + (nLen
+ 1)*sizeof(wxChar
));
370 if ( pData
== NULL
) {
371 // allocation failure handled by caller
376 pData
->nDataLength
= 0;
377 pData
->nAllocLength
= nLen
;
378 m_pchData
= pData
->data(); // data starts after wxStringData
379 m_pchData
[0u] = wxT('\0');
381 else if ( pData
->IsShared() ) {
382 pData
->Unlock(); // memory not freed because shared
383 size_t nOldLen
= pData
->nDataLength
;
384 if ( !AllocBuffer(nLen
) ) {
385 // allocation failure handled by caller
388 memcpy(m_pchData
, pData
->data(), nOldLen
*sizeof(wxChar
));
393 pData
= (wxStringData
*)
394 realloc(pData
, sizeof(wxStringData
) + (nLen
+ 1)*sizeof(wxChar
));
396 if ( pData
== NULL
) {
397 // allocation failure handled by caller
398 // keep previous data since reallocation failed
402 // it's not important if the pointer changed or not (the check for this
403 // is not faster than assigning to m_pchData in all cases)
404 pData
->nAllocLength
= nLen
;
405 m_pchData
= pData
->data();
408 //else: we've already got enough
412 wxStringBase::iterator
wxStringBase::begin()
419 wxStringBase::iterator
wxStringBase::end()
423 return m_pchData
+ length();
426 wxStringBase::iterator
wxStringBase::erase(iterator it
)
428 size_type idx
= it
- begin();
430 return begin() + idx
;
433 wxStringBase
& wxStringBase::erase(size_t nStart
, size_t nLen
)
435 wxASSERT(nStart
<= length());
436 size_t strLen
= length() - nStart
;
437 // delete nLen or up to the end of the string characters
438 nLen
= strLen
< nLen
? strLen
: nLen
;
439 wxString
strTmp(c_str(), nStart
);
440 strTmp
.append(c_str() + nStart
+ nLen
, length() - nStart
- nLen
);
446 wxStringBase
& wxStringBase::insert(size_t nPos
, const wxChar
*sz
, size_t n
)
448 wxASSERT( nPos
<= length() );
450 if ( n
== npos
) n
= wxStrlen(sz
);
451 if ( n
== 0 ) return *this;
453 if ( !CopyBeforeWrite() || !Alloc(length() + n
) ) {
454 wxFAIL_MSG( _T("out of memory in wxStringBase::insert") );
457 memmove(m_pchData
+ nPos
+ n
, m_pchData
+ nPos
,
458 (length() - nPos
) * sizeof(wxChar
));
459 memcpy(m_pchData
+ nPos
, sz
, n
* sizeof(wxChar
));
460 GetStringData()->nDataLength
= length() + n
;
461 m_pchData
[length()] = '\0';
466 void wxStringBase::swap(wxStringBase
& str
)
468 wxChar
* tmp
= str
.m_pchData
;
469 str
.m_pchData
= m_pchData
;
473 size_t wxStringBase::find(const wxStringBase
& str
, size_t nStart
) const
475 wxASSERT( str
.GetStringData()->IsValid() );
476 wxASSERT( nStart
<= length() );
479 const wxChar
* p
= (const wxChar
*)wxTmemchr(c_str() + nStart
,
486 while(p
- c_str() + str
.length() <= length() &&
487 wxTmemcmp(p
, str
.c_str(), str
.length()) )
490 p
= (const wxChar
*)wxTmemchr(++p
,
492 length() - (p
- c_str()));
498 return (p
- c_str() + str
.length() <= length()) ? p
- c_str() : npos
;
501 size_t wxStringBase::find(const wxChar
* sz
, size_t nStart
, size_t n
) const
503 return find(wxStringBase(sz
, n
), nStart
);
506 size_t wxStringBase::find(wxChar ch
, size_t nStart
) const
508 wxASSERT( nStart
<= length() );
510 const wxChar
*p
= (const wxChar
*)wxTmemchr(c_str() + nStart
, ch
, length() - nStart
);
512 return p
== NULL
? npos
: p
- c_str();
515 size_t wxStringBase::rfind(const wxStringBase
& str
, size_t nStart
) const
517 wxASSERT( str
.GetStringData()->IsValid() );
518 wxASSERT( nStart
== npos
|| nStart
<= length() );
520 if ( length() >= str
.length() )
522 // avoids a corner case later
523 if ( length() == 0 && str
.length() == 0 )
526 // "top" is the point where search starts from
527 size_t top
= length() - str
.length();
529 if ( nStart
== npos
)
530 nStart
= length() - 1;
534 const wxChar
*cursor
= c_str() + top
;
537 if ( wxTmemcmp(cursor
, str
.c_str(),
540 return cursor
- c_str();
542 } while ( cursor
-- > c_str() );
548 size_t wxStringBase::rfind(const wxChar
* sz
, size_t nStart
, size_t n
) const
550 return rfind(wxStringBase(sz
, n
), nStart
);
553 size_t wxStringBase::rfind(wxChar ch
, size_t nStart
) const
555 if ( nStart
== npos
)
561 wxASSERT( nStart
<= length() );
564 const wxChar
*actual
;
565 for ( actual
= c_str() + ( nStart
== npos
? length() : nStart
+ 1 );
566 actual
> c_str(); --actual
)
568 if ( *(actual
- 1) == ch
)
569 return (actual
- 1) - c_str();
575 size_t wxStringBase::find_first_of(const wxChar
* sz
, size_t nStart
) const
577 wxASSERT(nStart
<= length());
579 size_t len
= wxStrlen(sz
);
582 for(i
= nStart
; i
< this->length(); ++i
)
584 if (wxTmemchr(sz
, *(c_str() + i
), len
))
588 if(i
== this->length())
594 size_t wxStringBase::find_first_of(const wxChar
* sz
, size_t nStart
,
597 return find_first_of(wxStringBase(sz
, n
), nStart
);
600 size_t wxStringBase::find_last_of(const wxChar
* sz
, size_t nStart
) const
602 if ( nStart
== npos
)
604 nStart
= length() - 1;
608 wxASSERT_MSG( nStart
<= length(),
609 _T("invalid index in find_last_of()") );
612 size_t len
= wxStrlen(sz
);
614 for ( const wxChar
*p
= c_str() + nStart
; p
>= c_str(); --p
)
616 if ( wxTmemchr(sz
, *p
, len
) )
623 size_t wxStringBase::find_last_of(const wxChar
* sz
, size_t nStart
,
626 return find_last_of(wxStringBase(sz
, n
), nStart
);
629 size_t wxStringBase::find_first_not_of(const wxChar
* sz
, size_t nStart
) const
631 if ( nStart
== npos
)
637 wxASSERT( nStart
<= length() );
640 size_t len
= wxStrlen(sz
);
643 for(i
= nStart
; i
< this->length(); ++i
)
645 if (!wxTmemchr(sz
, *(c_str() + i
), len
))
649 if(i
== this->length())
655 size_t wxStringBase::find_first_not_of(const wxChar
* sz
, size_t nStart
,
658 return find_first_not_of(wxStringBase(sz
, n
), nStart
);
661 size_t wxStringBase::find_first_not_of(wxChar ch
, size_t nStart
) const
663 wxASSERT( nStart
<= length() );
665 for ( const wxChar
*p
= c_str() + nStart
; *p
; p
++ )
674 size_t wxStringBase::find_last_not_of(const wxChar
* sz
, size_t nStart
) const
676 if ( nStart
== npos
)
678 nStart
= length() - 1;
682 wxASSERT( nStart
<= length() );
685 size_t len
= wxStrlen(sz
);
687 for ( const wxChar
*p
= c_str() + nStart
; p
>= c_str(); --p
)
689 if ( !wxTmemchr(sz
, *p
,len
) )
696 size_t wxStringBase::find_last_not_of(const wxChar
* sz
, size_t nStart
,
699 return find_last_not_of(wxStringBase(sz
, n
), nStart
);
702 size_t wxStringBase::find_last_not_of(wxChar ch
, size_t nStart
) const
704 if ( nStart
== npos
)
706 nStart
= length() - 1;
710 wxASSERT( nStart
<= length() );
713 for ( const wxChar
*p
= c_str() + nStart
; p
>= c_str(); --p
)
722 wxStringBase
& wxStringBase::replace(size_t nStart
, size_t nLen
,
725 wxASSERT_MSG( nStart
<= length(),
726 _T("index out of bounds in wxStringBase::replace") );
727 size_t strLen
= length() - nStart
;
728 nLen
= strLen
< nLen
? strLen
: nLen
;
731 strTmp
.reserve(length()); // micro optimisation to avoid multiple mem allocs
734 strTmp
.append(c_str(), nStart
);
736 strTmp
.append(c_str() + nStart
+ nLen
);
742 wxStringBase
& wxStringBase::replace(size_t nStart
, size_t nLen
,
743 size_t nCount
, wxChar ch
)
745 return replace(nStart
, nLen
, wxStringBase(nCount
, ch
).c_str());
748 wxStringBase
& wxStringBase::replace(size_t nStart
, size_t nLen
,
749 const wxStringBase
& str
,
750 size_t nStart2
, size_t nLen2
)
752 return replace(nStart
, nLen
, str
.substr(nStart2
, nLen2
));
755 wxStringBase
& wxStringBase::replace(size_t nStart
, size_t nLen
,
756 const wxChar
* sz
, size_t nCount
)
758 return replace(nStart
, nLen
, wxStringBase(sz
, nCount
).c_str());
761 wxStringBase
wxStringBase::substr(size_t nStart
, size_t nLen
) const
764 nLen
= length() - nStart
;
765 return wxStringBase(*this, nStart
, nLen
);
768 // assigns one string to another
769 wxStringBase
& wxStringBase::operator=(const wxStringBase
& stringSrc
)
771 wxASSERT( stringSrc
.GetStringData()->IsValid() );
773 // don't copy string over itself
774 if ( m_pchData
!= stringSrc
.m_pchData
) {
775 if ( stringSrc
.GetStringData()->IsEmpty() ) {
780 GetStringData()->Unlock();
781 m_pchData
= stringSrc
.m_pchData
;
782 GetStringData()->Lock();
789 // assigns a single character
790 wxStringBase
& wxStringBase::operator=(wxChar ch
)
792 if ( !AssignCopy(1, &ch
) ) {
793 wxFAIL_MSG( _T("out of memory in wxStringBase::operator=(wxChar)") );
799 wxStringBase
& wxStringBase::operator=(const wxChar
*psz
)
801 if ( !AssignCopy(wxStrlen(psz
), psz
) ) {
802 wxFAIL_MSG( _T("out of memory in wxStringBase::operator=(const wxChar *)") );
807 // helper function: does real copy
808 bool wxStringBase::AssignCopy(size_t nSrcLen
, const wxChar
*pszSrcData
)
810 if ( nSrcLen
== 0 ) {
814 if ( !AllocBeforeWrite(nSrcLen
) ) {
815 // allocation failure handled by caller
818 memcpy(m_pchData
, pszSrcData
, nSrcLen
*sizeof(wxChar
));
819 GetStringData()->nDataLength
= nSrcLen
;
820 m_pchData
[nSrcLen
] = wxT('\0');
825 // ---------------------------------------------------------------------------
826 // string concatenation
827 // ---------------------------------------------------------------------------
829 // add something to this string
830 bool wxStringBase::ConcatSelf(size_t nSrcLen
, const wxChar
*pszSrcData
,
833 STATISTICS_ADD(SummandLength
, nSrcLen
);
835 nSrcLen
= nSrcLen
< nMaxLen
? nSrcLen
: nMaxLen
;
837 // concatenating an empty string is a NOP
839 wxStringData
*pData
= GetStringData();
840 size_t nLen
= pData
->nDataLength
;
841 size_t nNewLen
= nLen
+ nSrcLen
;
843 // alloc new buffer if current is too small
844 if ( pData
->IsShared() ) {
845 STATISTICS_ADD(ConcatHit
, 0);
847 // we have to allocate another buffer
848 wxStringData
* pOldData
= GetStringData();
849 if ( !AllocBuffer(nNewLen
) ) {
850 // allocation failure handled by caller
853 memcpy(m_pchData
, pOldData
->data(), nLen
*sizeof(wxChar
));
856 else if ( nNewLen
> pData
->nAllocLength
) {
857 STATISTICS_ADD(ConcatHit
, 0);
860 // we have to grow the buffer
861 if ( capacity() < nNewLen
) {
862 // allocation failure handled by caller
867 STATISTICS_ADD(ConcatHit
, 1);
869 // the buffer is already big enough
872 // should be enough space
873 wxASSERT( nNewLen
<= GetStringData()->nAllocLength
);
875 // fast concatenation - all is done in our buffer
876 memcpy(m_pchData
+ nLen
, pszSrcData
, nSrcLen
*sizeof(wxChar
));
878 m_pchData
[nNewLen
] = wxT('\0'); // put terminating '\0'
879 GetStringData()->nDataLength
= nNewLen
; // and fix the length
881 //else: the string to append was empty
885 // ---------------------------------------------------------------------------
886 // simple sub-string extraction
887 // ---------------------------------------------------------------------------
889 // helper function: clone the data attached to this string
890 bool wxStringBase::AllocCopy(wxString
& dest
, int nCopyLen
, int nCopyIndex
) const
892 if ( nCopyLen
== 0 ) {
896 if ( !dest
.AllocBuffer(nCopyLen
) ) {
897 // allocation failure handled by caller
900 memcpy(dest
.m_pchData
, m_pchData
+ nCopyIndex
, nCopyLen
*sizeof(wxChar
));
907 #if !wxUSE_STL || !defined(HAVE_STD_STRING_COMPARE)
910 #define STRINGCLASS wxStringBase
912 #define STRINGCLASS wxString
915 static inline int wxDoCmp(const wxChar
* s1
, size_t l1
,
916 const wxChar
* s2
, size_t l2
)
919 return wxTmemcmp(s1
, s2
, l1
);
922 int ret
= wxTmemcmp(s1
, s2
, l1
);
923 return ret
== 0 ? -1 : ret
;
927 int ret
= wxTmemcmp(s1
, s2
, l2
);
928 return ret
== 0 ? +1 : ret
;
932 int STRINGCLASS::compare(const wxStringBase
& str
) const
934 return ::wxDoCmp(data(), length(), str
.data(), str
.length());
937 int STRINGCLASS::compare(size_t nStart
, size_t nLen
,
938 const wxStringBase
& str
) const
940 wxASSERT(nStart
<= length());
941 size_type strLen
= length() - nStart
;
942 nLen
= strLen
< nLen
? strLen
: nLen
;
943 return ::wxDoCmp(data() + nStart
, nLen
, str
.data(), str
.length());
946 int STRINGCLASS::compare(size_t nStart
, size_t nLen
,
947 const wxStringBase
& str
,
948 size_t nStart2
, size_t nLen2
) const
950 wxASSERT(nStart
<= length());
951 wxASSERT(nStart2
<= str
.length());
952 size_type strLen
= length() - nStart
,
953 strLen2
= str
.length() - nStart2
;
954 nLen
= strLen
< nLen
? strLen
: nLen
;
955 nLen2
= strLen2
< nLen2
? strLen2
: nLen2
;
956 return ::wxDoCmp(data() + nStart
, nLen
, str
.data() + nStart2
, nLen2
);
959 int STRINGCLASS::compare(const wxChar
* sz
) const
961 size_t nLen
= wxStrlen(sz
);
962 return ::wxDoCmp(data(), length(), sz
, nLen
);
965 int STRINGCLASS::compare(size_t nStart
, size_t nLen
,
966 const wxChar
* sz
, size_t nCount
) const
968 wxASSERT(nStart
<= length());
969 size_type strLen
= length() - nStart
;
970 nLen
= strLen
< nLen
? strLen
: nLen
;
972 nCount
= wxStrlen(sz
);
974 return ::wxDoCmp(data() + nStart
, nLen
, sz
, nCount
);
979 #endif // !wxUSE_STL || !defined(HAVE_STD_STRING_COMPARE)
981 // ===========================================================================
982 // wxString class core
983 // ===========================================================================
985 // ---------------------------------------------------------------------------
986 // construction and conversion
987 // ---------------------------------------------------------------------------
991 // from multibyte string
992 wxString::wxString(const char *psz
, wxMBConv
& conv
, size_t nLength
)
994 // if nLength != npos, then we have to make a NULL-terminated copy
995 // of first nLength bytes of psz first because the input buffer to MB2WC
996 // must always be NULL-terminated:
997 wxCharBuffer
inBuf((const char *)NULL
);
1000 wxASSERT( psz
!= NULL
);
1001 wxCharBuffer
tmp(nLength
);
1002 memcpy(tmp
.data(), psz
, nLength
);
1003 tmp
.data()[nLength
] = '\0';
1008 // first get the size of the buffer we need
1012 // calculate the needed size ourselves or use the provided one
1013 if (nLength
== npos
)
1020 // nothing to convert
1026 if ( (nLen
!= 0) && (nLen
!= (size_t)-1) )
1030 wxWCharBuffer theBuffer
= conv
.cMB2WC(psz
, nLen
, &nRealSize
);
1034 assign( theBuffer
.data() , nRealSize
- 1 );
1038 //Convert wxString in Unicode mode to a multi-byte string
1039 const wxCharBuffer
wxString::mb_str(wxMBConv
& conv
) const
1042 return conv
.cWC2MB(c_str(), length(), &dwOutSize
);
1049 wxString::wxString(const wchar_t *pwz
, wxMBConv
& conv
, size_t nLength
)
1051 // if nLength != npos, then we have to make a NULL-terminated copy
1052 // of first nLength chars of psz first because the input buffer to WC2MB
1053 // must always be NULL-terminated:
1054 wxWCharBuffer
inBuf((const wchar_t *)NULL
);
1055 if (nLength
!= npos
)
1057 wxASSERT( pwz
!= NULL
);
1058 wxWCharBuffer
tmp(nLength
);
1059 memcpy(tmp
.data(), pwz
, nLength
* sizeof(wchar_t));
1060 tmp
.data()[nLength
] = '\0';
1065 // first get the size of the buffer we need
1069 // calculate the needed size ourselves or use the provided one
1070 if (nLength
== npos
)
1071 nLen
= wxWcslen(pwz
);
1077 // nothing to convert
1082 if ( (nLen
!= 0) && (nLen
!= (size_t)-1) )
1086 wxCharBuffer theBuffer
= conv
.cWC2MB(pwz
, nLen
, &nRealSize
);
1090 assign( theBuffer
.data() , nRealSize
- 1 );
1094 //Converts this string to a wide character string if unicode
1095 //mode is not enabled and wxUSE_WCHAR_T is enabled
1096 const wxWCharBuffer
wxString::wc_str(wxMBConv
& conv
) const
1099 return conv
.cMB2WC(c_str(), length(), &dwOutSize
);
1102 #endif // wxUSE_WCHAR_T
1104 #endif // Unicode/ANSI
1106 // shrink to minimal size (releasing extra memory)
1107 bool wxString::Shrink()
1109 wxString
tmp(begin(), end());
1111 return tmp
.length() == length();
1115 // get the pointer to writable buffer of (at least) nLen bytes
1116 wxChar
*wxString::GetWriteBuf(size_t nLen
)
1118 if ( !AllocBeforeWrite(nLen
) ) {
1119 // allocation failure handled by caller
1123 wxASSERT( GetStringData()->nRefs
== 1 );
1124 GetStringData()->Validate(false);
1129 // put string back in a reasonable state after GetWriteBuf
1130 void wxString::UngetWriteBuf()
1132 GetStringData()->nDataLength
= wxStrlen(m_pchData
);
1133 GetStringData()->Validate(true);
1136 void wxString::UngetWriteBuf(size_t nLen
)
1138 GetStringData()->nDataLength
= nLen
;
1139 GetStringData()->Validate(true);
1143 // ---------------------------------------------------------------------------
1145 // ---------------------------------------------------------------------------
1147 // all functions are inline in string.h
1149 // ---------------------------------------------------------------------------
1150 // assignment operators
1151 // ---------------------------------------------------------------------------
1155 // same as 'signed char' variant
1156 wxString
& wxString::operator=(const unsigned char* psz
)
1158 *this = (const char *)psz
;
1163 wxString
& wxString::operator=(const wchar_t *pwz
)
1174 * concatenation functions come in 5 flavours:
1176 * char + string and string + char
1177 * C str + string and string + C str
1180 wxString
operator+(const wxString
& str1
, const wxString
& str2
)
1183 wxASSERT( str1
.GetStringData()->IsValid() );
1184 wxASSERT( str2
.GetStringData()->IsValid() );
1193 wxString
operator+(const wxString
& str
, wxChar ch
)
1196 wxASSERT( str
.GetStringData()->IsValid() );
1205 wxString
operator+(wxChar ch
, const wxString
& str
)
1208 wxASSERT( str
.GetStringData()->IsValid() );
1217 wxString
operator+(const wxString
& str
, const wxChar
*psz
)
1220 wxASSERT( str
.GetStringData()->IsValid() );
1224 if ( !s
.Alloc(wxStrlen(psz
) + str
.Len()) ) {
1225 wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1233 wxString
operator+(const wxChar
*psz
, const wxString
& str
)
1236 wxASSERT( str
.GetStringData()->IsValid() );
1240 if ( !s
.Alloc(wxStrlen(psz
) + str
.Len()) ) {
1241 wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1249 // ===========================================================================
1250 // other common string functions
1251 // ===========================================================================
1253 int wxString::Cmp(const wxString
& s
) const
1258 int wxString::Cmp(const wxChar
* psz
) const
1260 return compare(psz
);
1263 static inline int wxDoCmpNoCase(const wxChar
* s1
, size_t l1
,
1264 const wxChar
* s2
, size_t l2
)
1270 for(i
= 0; i
< l1
; ++i
)
1272 if(wxTolower(s1
[i
]) != wxTolower(s2
[i
]))
1275 return i
== l1
? 0 : wxTolower(s1
[i
]) < wxTolower(s2
[i
]) ? -1 : 1;
1279 for(i
= 0; i
< l1
; ++i
)
1281 if(wxTolower(s1
[i
]) != wxTolower(s2
[i
]))
1284 return i
== l1
? -1 : wxTolower(s1
[i
]) < wxTolower(s2
[i
]) ? -1 : 1;
1288 for(i
= 0; i
< l2
; ++i
)
1290 if(wxTolower(s1
[i
]) != wxTolower(s2
[i
]))
1293 return i
== l2
? 1 : wxTolower(s1
[i
]) < wxTolower(s2
[i
]) ? -1 : 1;
1297 int wxString::CmpNoCase(const wxString
& s
) const
1299 return wxDoCmpNoCase(data(), length(), s
.data(), s
.length());
1302 int wxString::CmpNoCase(const wxChar
* psz
) const
1304 int nLen
= wxStrlen(psz
);
1306 return wxDoCmpNoCase(data(), length(), psz
, nLen
);
1313 #ifndef __SCHAR_MAX__
1314 #define __SCHAR_MAX__ 127
1318 wxString
wxString::FromAscii(const char *ascii
)
1321 return wxEmptyString
;
1323 size_t len
= strlen( ascii
);
1328 wxStringBuffer
buf(res
, len
);
1330 wchar_t *dest
= buf
;
1334 if ( (*dest
++ = (wchar_t)(unsigned char)*ascii
++) == L
'\0' )
1342 wxString
wxString::FromAscii(const char ascii
)
1344 // What do we do with '\0' ?
1347 res
+= (wchar_t)(unsigned char) ascii
;
1352 const wxCharBuffer
wxString::ToAscii() const
1354 // this will allocate enough space for the terminating NUL too
1355 wxCharBuffer
buffer(length());
1358 char *dest
= buffer
.data();
1360 const wchar_t *pwc
= c_str();
1363 *dest
++ = (char)(*pwc
> SCHAR_MAX
? wxT('_') : *pwc
);
1365 // the output string can't have embedded NULs anyhow, so we can safely
1366 // stop at first of them even if we do have any
1376 // extract string of length nCount starting at nFirst
1377 wxString
wxString::Mid(size_t nFirst
, size_t nCount
) const
1379 size_t nLen
= length();
1381 // default value of nCount is npos and means "till the end"
1382 if ( nCount
== npos
)
1384 nCount
= nLen
- nFirst
;
1387 // out-of-bounds requests return sensible things
1388 if ( nFirst
+ nCount
> nLen
)
1390 nCount
= nLen
- nFirst
;
1393 if ( nFirst
> nLen
)
1395 // AllocCopy() will return empty string
1399 wxString
dest(*this, nFirst
, nCount
);
1400 if ( dest
.length() != nCount
) {
1401 wxFAIL_MSG( _T("out of memory in wxString::Mid") );
1407 // check that the string starts with prefix and return the rest of the string
1408 // in the provided pointer if it is not NULL, otherwise return false
1409 bool wxString::StartsWith(const wxChar
*prefix
, wxString
*rest
) const
1411 wxASSERT_MSG( prefix
, _T("invalid parameter in wxString::StartsWith") );
1413 // first check if the beginning of the string matches the prefix: note
1414 // that we don't have to check that we don't run out of this string as
1415 // when we reach the terminating NUL, either prefix string ends too (and
1416 // then it's ok) or we break out of the loop because there is no match
1417 const wxChar
*p
= c_str();
1420 if ( *prefix
++ != *p
++ )
1429 // put the rest of the string into provided pointer
1436 // extract nCount last (rightmost) characters
1437 wxString
wxString::Right(size_t nCount
) const
1439 if ( nCount
> length() )
1442 wxString
dest(*this, length() - nCount
, nCount
);
1443 if ( dest
.length() != nCount
) {
1444 wxFAIL_MSG( _T("out of memory in wxString::Right") );
1449 // get all characters after the last occurence of ch
1450 // (returns the whole string if ch not found)
1451 wxString
wxString::AfterLast(wxChar ch
) const
1454 int iPos
= Find(ch
, true);
1455 if ( iPos
== wxNOT_FOUND
)
1458 str
= c_str() + iPos
+ 1;
1463 // extract nCount first (leftmost) characters
1464 wxString
wxString::Left(size_t nCount
) const
1466 if ( nCount
> length() )
1469 wxString
dest(*this, 0, nCount
);
1470 if ( dest
.length() != nCount
) {
1471 wxFAIL_MSG( _T("out of memory in wxString::Left") );
1476 // get all characters before the first occurence of ch
1477 // (returns the whole string if ch not found)
1478 wxString
wxString::BeforeFirst(wxChar ch
) const
1480 int iPos
= Find(ch
);
1481 if ( iPos
== wxNOT_FOUND
) iPos
= length();
1482 return wxString(*this, 0, iPos
);
1485 /// get all characters before the last occurence of ch
1486 /// (returns empty string if ch not found)
1487 wxString
wxString::BeforeLast(wxChar ch
) const
1490 int iPos
= Find(ch
, true);
1491 if ( iPos
!= wxNOT_FOUND
&& iPos
!= 0 )
1492 str
= wxString(c_str(), iPos
);
1497 /// get all characters after the first occurence of ch
1498 /// (returns empty string if ch not found)
1499 wxString
wxString::AfterFirst(wxChar ch
) const
1502 int iPos
= Find(ch
);
1503 if ( iPos
!= wxNOT_FOUND
)
1504 str
= c_str() + iPos
+ 1;
1509 // replace first (or all) occurences of some substring with another one
1511 wxString::Replace(const wxChar
*szOld
, const wxChar
*szNew
, bool bReplaceAll
)
1513 // if we tried to replace an empty string we'd enter an infinite loop below
1514 wxCHECK_MSG( szOld
&& *szOld
&& szNew
, 0,
1515 _T("wxString::Replace(): invalid parameter") );
1517 size_t uiCount
= 0; // count of replacements made
1519 size_t uiOldLen
= wxStrlen(szOld
);
1522 const wxChar
*pCurrent
= c_str();
1523 const wxChar
*pSubstr
;
1524 while ( *pCurrent
!= wxT('\0') ) {
1525 pSubstr
= wxStrstr(pCurrent
, szOld
);
1526 if ( pSubstr
== NULL
) {
1527 // strTemp is unused if no replacements were made, so avoid the copy
1531 strTemp
+= pCurrent
; // copy the rest
1532 break; // exit the loop
1535 // take chars before match
1536 size_type len
= strTemp
.length();
1537 strTemp
.append(pCurrent
, pSubstr
- pCurrent
);
1538 if ( strTemp
.length() != (size_t)(len
+ pSubstr
- pCurrent
) ) {
1539 wxFAIL_MSG( _T("out of memory in wxString::Replace") );
1543 pCurrent
= pSubstr
+ uiOldLen
; // restart after match
1548 if ( !bReplaceAll
) {
1549 strTemp
+= pCurrent
; // copy the rest
1550 break; // exit the loop
1555 // only done if there were replacements, otherwise would have returned above
1561 bool wxString::IsAscii() const
1563 const wxChar
*s
= (const wxChar
*) *this;
1565 if(!isascii(*s
)) return(false);
1571 bool wxString::IsWord() const
1573 const wxChar
*s
= (const wxChar
*) *this;
1575 if(!wxIsalpha(*s
)) return(false);
1581 bool wxString::IsNumber() const
1583 const wxChar
*s
= (const wxChar
*) *this;
1585 if ((s
[0] == wxT('-')) || (s
[0] == wxT('+'))) s
++;
1587 if(!wxIsdigit(*s
)) return(false);
1593 wxString
wxString::Strip(stripType w
) const
1596 if ( w
& leading
) s
.Trim(false);
1597 if ( w
& trailing
) s
.Trim(true);
1601 // ---------------------------------------------------------------------------
1603 // ---------------------------------------------------------------------------
1605 wxString
& wxString::MakeUpper()
1607 for ( iterator it
= begin(), en
= end(); it
!= en
; ++it
)
1608 *it
= (wxChar
)wxToupper(*it
);
1613 wxString
& wxString::MakeLower()
1615 for ( iterator it
= begin(), en
= end(); it
!= en
; ++it
)
1616 *it
= (wxChar
)wxTolower(*it
);
1621 // ---------------------------------------------------------------------------
1622 // trimming and padding
1623 // ---------------------------------------------------------------------------
1625 // some compilers (VC++ 6.0 not to name them) return true for a call to
1626 // isspace('ê') in the C locale which seems to be broken to me, but we have to
1627 // live with this by checking that the character is a 7 bit one - even if this
1628 // may fail to detect some spaces (I don't know if Unicode doesn't have
1629 // space-like symbols somewhere except in the first 128 chars), it is arguably
1630 // still better than trimming away accented letters
1631 inline int wxSafeIsspace(wxChar ch
) { return (ch
< 127) && wxIsspace(ch
); }
1633 // trims spaces (in the sense of isspace) from left or right side
1634 wxString
& wxString::Trim(bool bFromRight
)
1636 // first check if we're going to modify the string at all
1639 (bFromRight
&& wxSafeIsspace(GetChar(Len() - 1))) ||
1640 (!bFromRight
&& wxSafeIsspace(GetChar(0u)))
1646 // find last non-space character
1647 iterator psz
= begin() + length() - 1;
1648 while ( wxSafeIsspace(*psz
) && (psz
>= begin()) )
1651 // truncate at trailing space start
1657 // find first non-space character
1658 iterator psz
= begin();
1659 while ( wxSafeIsspace(*psz
) )
1662 // fix up data and length
1663 erase(begin(), psz
);
1670 // adds nCount characters chPad to the string from either side
1671 wxString
& wxString::Pad(size_t nCount
, wxChar chPad
, bool bFromRight
)
1673 wxString
s(chPad
, nCount
);
1686 // truncate the string
1687 wxString
& wxString::Truncate(size_t uiLen
)
1689 if ( uiLen
< Len() ) {
1690 erase(begin() + uiLen
, end());
1692 //else: nothing to do, string is already short enough
1697 // ---------------------------------------------------------------------------
1698 // finding (return wxNOT_FOUND if not found and index otherwise)
1699 // ---------------------------------------------------------------------------
1702 int wxString::Find(wxChar ch
, bool bFromEnd
) const
1704 size_type idx
= bFromEnd
? find_last_of(ch
) : find_first_of(ch
);
1706 return (idx
== npos
) ? wxNOT_FOUND
: (int)idx
;
1709 // find a sub-string (like strstr)
1710 int wxString::Find(const wxChar
*pszSub
) const
1712 size_type idx
= find(pszSub
);
1714 return (idx
== npos
) ? wxNOT_FOUND
: (int)idx
;
1717 // ----------------------------------------------------------------------------
1718 // conversion to numbers
1719 // ----------------------------------------------------------------------------
1721 bool wxString::ToLong(long *val
, int base
) const
1723 wxCHECK_MSG( val
, false, _T("NULL pointer in wxString::ToLong") );
1724 wxASSERT_MSG( !base
|| (base
> 1 && base
<= 36), _T("invalid base") );
1726 const wxChar
*start
= c_str();
1728 *val
= wxStrtol(start
, &end
, base
);
1730 // return true only if scan was stopped by the terminating NUL and if the
1731 // string was not empty to start with
1732 return !*end
&& (end
!= start
);
1735 bool wxString::ToULong(unsigned long *val
, int base
) const
1737 wxCHECK_MSG( val
, false, _T("NULL pointer in wxString::ToULong") );
1738 wxASSERT_MSG( !base
|| (base
> 1 && base
<= 36), _T("invalid base") );
1740 const wxChar
*start
= c_str();
1742 *val
= wxStrtoul(start
, &end
, base
);
1744 // return true only if scan was stopped by the terminating NUL and if the
1745 // string was not empty to start with
1746 return !*end
&& (end
!= start
);
1749 bool wxString::ToDouble(double *val
) const
1751 wxCHECK_MSG( val
, false, _T("NULL pointer in wxString::ToDouble") );
1753 const wxChar
*start
= c_str();
1755 *val
= wxStrtod(start
, &end
);
1757 // return true only if scan was stopped by the terminating NUL and if the
1758 // string was not empty to start with
1759 return !*end
&& (end
!= start
);
1762 // ---------------------------------------------------------------------------
1764 // ---------------------------------------------------------------------------
1767 wxString
wxString::Format(const wxChar
*pszFormat
, ...)
1770 va_start(argptr
, pszFormat
);
1773 s
.PrintfV(pszFormat
, argptr
);
1781 wxString
wxString::FormatV(const wxChar
*pszFormat
, va_list argptr
)
1784 s
.PrintfV(pszFormat
, argptr
);
1788 int wxString::Printf(const wxChar
*pszFormat
, ...)
1791 va_start(argptr
, pszFormat
);
1793 int iLen
= PrintfV(pszFormat
, argptr
);
1800 int wxString::PrintfV(const wxChar
* pszFormat
, va_list argptr
)
1808 wxStringBuffer
tmp(*this, size
+ 1);
1817 // wxVsnprintf() may modify the original arg pointer, so pass it
1820 wxVaCopy(argptrcopy
, argptr
);
1821 len
= wxVsnprintf(buf
, size
, pszFormat
, argptrcopy
);
1824 // some implementations of vsnprintf() don't NUL terminate
1825 // the string if there is not enough space for it so
1826 // always do it manually
1827 buf
[size
] = _T('\0');
1830 // vsnprintf() may return either -1 (traditional Unix behaviour) or the
1831 // total number of characters which would have been written if the
1832 // buffer were large enough
1833 if ( len
>= 0 && len
<= size
)
1835 // ok, there was enough space
1839 // still not enough, double it again
1843 // we could have overshot
1849 // ----------------------------------------------------------------------------
1850 // misc other operations
1851 // ----------------------------------------------------------------------------
1853 // returns true if the string matches the pattern which may contain '*' and
1854 // '?' metacharacters (as usual, '?' matches any character and '*' any number
1856 bool wxString::Matches(const wxChar
*pszMask
) const
1858 // I disable this code as it doesn't seem to be faster (in fact, it seems
1859 // to be much slower) than the old, hand-written code below and using it
1860 // here requires always linking with libregex even if the user code doesn't
1862 #if 0 // wxUSE_REGEX
1863 // first translate the shell-like mask into a regex
1865 pattern
.reserve(wxStrlen(pszMask
));
1877 pattern
+= _T(".*");
1888 // these characters are special in a RE, quote them
1889 // (however note that we don't quote '[' and ']' to allow
1890 // using them for Unix shell like matching)
1891 pattern
+= _T('\\');
1895 pattern
+= *pszMask
;
1903 return wxRegEx(pattern
, wxRE_NOSUB
| wxRE_EXTENDED
).Matches(c_str());
1904 #else // !wxUSE_REGEX
1905 // TODO: this is, of course, awfully inefficient...
1907 // the char currently being checked
1908 const wxChar
*pszTxt
= c_str();
1910 // the last location where '*' matched
1911 const wxChar
*pszLastStarInText
= NULL
;
1912 const wxChar
*pszLastStarInMask
= NULL
;
1915 for ( ; *pszMask
!= wxT('\0'); pszMask
++, pszTxt
++ ) {
1916 switch ( *pszMask
) {
1918 if ( *pszTxt
== wxT('\0') )
1921 // pszTxt and pszMask will be incremented in the loop statement
1927 // remember where we started to be able to backtrack later
1928 pszLastStarInText
= pszTxt
;
1929 pszLastStarInMask
= pszMask
;
1931 // ignore special chars immediately following this one
1932 // (should this be an error?)
1933 while ( *pszMask
== wxT('*') || *pszMask
== wxT('?') )
1936 // if there is nothing more, match
1937 if ( *pszMask
== wxT('\0') )
1940 // are there any other metacharacters in the mask?
1942 const wxChar
*pEndMask
= wxStrpbrk(pszMask
, wxT("*?"));
1944 if ( pEndMask
!= NULL
) {
1945 // we have to match the string between two metachars
1946 uiLenMask
= pEndMask
- pszMask
;
1949 // we have to match the remainder of the string
1950 uiLenMask
= wxStrlen(pszMask
);
1953 wxString
strToMatch(pszMask
, uiLenMask
);
1954 const wxChar
* pMatch
= wxStrstr(pszTxt
, strToMatch
);
1955 if ( pMatch
== NULL
)
1958 // -1 to compensate "++" in the loop
1959 pszTxt
= pMatch
+ uiLenMask
- 1;
1960 pszMask
+= uiLenMask
- 1;
1965 if ( *pszMask
!= *pszTxt
)
1971 // match only if nothing left
1972 if ( *pszTxt
== wxT('\0') )
1975 // if we failed to match, backtrack if we can
1976 if ( pszLastStarInText
) {
1977 pszTxt
= pszLastStarInText
+ 1;
1978 pszMask
= pszLastStarInMask
;
1980 pszLastStarInText
= NULL
;
1982 // don't bother resetting pszLastStarInMask, it's unnecessary
1988 #endif // wxUSE_REGEX/!wxUSE_REGEX
1991 // Count the number of chars
1992 int wxString::Freq(wxChar ch
) const
1996 for (int i
= 0; i
< len
; i
++)
1998 if (GetChar(i
) == ch
)
2004 // convert to upper case, return the copy of the string
2005 wxString
wxString::Upper() const
2006 { wxString
s(*this); return s
.MakeUpper(); }
2008 // convert to lower case, return the copy of the string
2009 wxString
wxString::Lower() const { wxString
s(*this); return s
.MakeLower(); }
2011 int wxString::sprintf(const wxChar
*pszFormat
, ...)
2014 va_start(argptr
, pszFormat
);
2015 int iLen
= PrintfV(pszFormat
, argptr
);
2020 // ============================================================================
2022 // ============================================================================
2024 #include "wx/arrstr.h"
2028 // size increment = min(50% of current size, ARRAY_MAXSIZE_INCREMENT)
2029 #define ARRAY_MAXSIZE_INCREMENT 4096
2031 #ifndef ARRAY_DEFAULT_INITIAL_SIZE // also defined in dynarray.h
2032 #define ARRAY_DEFAULT_INITIAL_SIZE (16)
2035 #define STRING(p) ((wxString *)(&(p)))
2038 void wxArrayString::Init(bool autoSort
)
2042 m_pItems
= (wxChar
**) NULL
;
2043 m_autoSort
= autoSort
;
2047 wxArrayString::wxArrayString(const wxArrayString
& src
)
2049 Init(src
.m_autoSort
);
2054 // assignment operator
2055 wxArrayString
& wxArrayString::operator=(const wxArrayString
& src
)
2062 m_autoSort
= src
.m_autoSort
;
2067 void wxArrayString::Copy(const wxArrayString
& src
)
2069 if ( src
.m_nCount
> ARRAY_DEFAULT_INITIAL_SIZE
)
2070 Alloc(src
.m_nCount
);
2072 for ( size_t n
= 0; n
< src
.m_nCount
; n
++ )
2077 void wxArrayString::Grow(size_t nIncrement
)
2079 // only do it if no more place
2080 if ( (m_nSize
- m_nCount
) < nIncrement
) {
2081 // if ARRAY_DEFAULT_INITIAL_SIZE were set to 0, the initially empty would
2082 // be never resized!
2083 #if ARRAY_DEFAULT_INITIAL_SIZE == 0
2084 #error "ARRAY_DEFAULT_INITIAL_SIZE must be > 0!"
2087 if ( m_nSize
== 0 ) {
2088 // was empty, alloc some memory
2089 m_nSize
= ARRAY_DEFAULT_INITIAL_SIZE
;
2090 if (m_nSize
< nIncrement
)
2091 m_nSize
= nIncrement
;
2092 m_pItems
= new wxChar
*[m_nSize
];
2095 // otherwise when it's called for the first time, nIncrement would be 0
2096 // and the array would never be expanded
2097 // add 50% but not too much
2098 size_t ndefIncrement
= m_nSize
< ARRAY_DEFAULT_INITIAL_SIZE
2099 ? ARRAY_DEFAULT_INITIAL_SIZE
: m_nSize
>> 1;
2100 if ( ndefIncrement
> ARRAY_MAXSIZE_INCREMENT
)
2101 ndefIncrement
= ARRAY_MAXSIZE_INCREMENT
;
2102 if ( nIncrement
< ndefIncrement
)
2103 nIncrement
= ndefIncrement
;
2104 m_nSize
+= nIncrement
;
2105 wxChar
**pNew
= new wxChar
*[m_nSize
];
2107 // copy data to new location
2108 memcpy(pNew
, m_pItems
, m_nCount
*sizeof(wxChar
*));
2110 // delete old memory (but do not release the strings!)
2111 wxDELETEA(m_pItems
);
2118 void wxArrayString::Free()
2120 for ( size_t n
= 0; n
< m_nCount
; n
++ ) {
2121 STRING(m_pItems
[n
])->GetStringData()->Unlock();
2125 // deletes all the strings from the list
2126 void wxArrayString::Empty()
2133 // as Empty, but also frees memory
2134 void wxArrayString::Clear()
2141 wxDELETEA(m_pItems
);
2145 wxArrayString::~wxArrayString()
2149 wxDELETEA(m_pItems
);
2152 void wxArrayString::reserve(size_t nSize
)
2157 // pre-allocates memory (frees the previous data!)
2158 void wxArrayString::Alloc(size_t nSize
)
2160 // only if old buffer was not big enough
2161 if ( nSize
> m_nSize
) {
2163 wxDELETEA(m_pItems
);
2164 m_pItems
= new wxChar
*[nSize
];
2171 // minimizes the memory usage by freeing unused memory
2172 void wxArrayString::Shrink()
2174 // only do it if we have some memory to free
2175 if( m_nCount
< m_nSize
) {
2176 // allocates exactly as much memory as we need
2177 wxChar
**pNew
= new wxChar
*[m_nCount
];
2179 // copy data to new location
2180 memcpy(pNew
, m_pItems
, m_nCount
*sizeof(wxChar
*));
2186 #if WXWIN_COMPATIBILITY_2_4
2188 // return a wxString[] as required for some control ctors.
2189 wxString
* wxArrayString::GetStringArray() const
2191 wxString
*array
= 0;
2195 array
= new wxString
[m_nCount
];
2196 for( size_t i
= 0; i
< m_nCount
; i
++ )
2197 array
[i
] = m_pItems
[i
];
2203 #endif // WXWIN_COMPATIBILITY_2_4
2205 // searches the array for an item (forward or backwards)
2206 int wxArrayString::Index(const wxChar
*sz
, bool bCase
, bool bFromEnd
) const
2209 // use binary search in the sorted array
2210 wxASSERT_MSG( bCase
&& !bFromEnd
,
2211 wxT("search parameters ignored for auto sorted array") );
2220 res
= wxStrcmp(sz
, m_pItems
[i
]);
2232 // use linear search in unsorted array
2234 if ( m_nCount
> 0 ) {
2235 size_t ui
= m_nCount
;
2237 if ( STRING(m_pItems
[--ui
])->IsSameAs(sz
, bCase
) )
2244 for( size_t ui
= 0; ui
< m_nCount
; ui
++ ) {
2245 if( STRING(m_pItems
[ui
])->IsSameAs(sz
, bCase
) )
2254 // add item at the end
2255 size_t wxArrayString::Add(const wxString
& str
, size_t nInsert
)
2258 // insert the string at the correct position to keep the array sorted
2266 res
= str
.Cmp(m_pItems
[i
]);
2277 wxASSERT_MSG( lo
== hi
, wxT("binary search broken") );
2279 Insert(str
, lo
, nInsert
);
2284 wxASSERT( str
.GetStringData()->IsValid() );
2288 for (size_t i
= 0; i
< nInsert
; i
++)
2290 // the string data must not be deleted!
2291 str
.GetStringData()->Lock();
2294 m_pItems
[m_nCount
+ i
] = (wxChar
*)str
.c_str(); // const_cast
2296 size_t ret
= m_nCount
;
2297 m_nCount
+= nInsert
;
2302 // add item at the given position
2303 void wxArrayString::Insert(const wxString
& str
, size_t nIndex
, size_t nInsert
)
2305 wxASSERT( str
.GetStringData()->IsValid() );
2307 wxCHECK_RET( nIndex
<= m_nCount
, wxT("bad index in wxArrayString::Insert") );
2308 wxCHECK_RET( m_nCount
<= m_nCount
+ nInsert
,
2309 wxT("array size overflow in wxArrayString::Insert") );
2313 memmove(&m_pItems
[nIndex
+ nInsert
], &m_pItems
[nIndex
],
2314 (m_nCount
- nIndex
)*sizeof(wxChar
*));
2316 for (size_t i
= 0; i
< nInsert
; i
++)
2318 str
.GetStringData()->Lock();
2319 m_pItems
[nIndex
+ i
] = (wxChar
*)str
.c_str();
2321 m_nCount
+= nInsert
;
2324 // range insert (STL 23.2.4.3)
2326 wxArrayString::insert(iterator it
, const_iterator first
, const_iterator last
)
2328 const int idx
= it
- begin();
2333 // reset "it" since it can change inside Grow()
2336 while ( first
!= last
)
2338 it
= insert(it
, *first
);
2340 // insert returns an iterator to the last element inserted but we need
2341 // insert the next after this one, that is before the next one
2349 void wxArrayString::SetCount(size_t count
)
2354 while ( m_nCount
< count
)
2355 m_pItems
[m_nCount
++] = (wxChar
*)s
.c_str();
2358 // removes item from array (by index)
2359 void wxArrayString::RemoveAt(size_t nIndex
, size_t nRemove
)
2361 wxCHECK_RET( nIndex
< m_nCount
, wxT("bad index in wxArrayString::Remove") );
2362 wxCHECK_RET( nIndex
+ nRemove
<= m_nCount
,
2363 wxT("removing too many elements in wxArrayString::Remove") );
2366 for (size_t i
= 0; i
< nRemove
; i
++)
2367 Item(nIndex
+ i
).GetStringData()->Unlock();
2369 memmove(&m_pItems
[nIndex
], &m_pItems
[nIndex
+ nRemove
],
2370 (m_nCount
- nIndex
- nRemove
)*sizeof(wxChar
*));
2371 m_nCount
-= nRemove
;
2374 // removes item from array (by value)
2375 void wxArrayString::Remove(const wxChar
*sz
)
2377 int iIndex
= Index(sz
);
2379 wxCHECK_RET( iIndex
!= wxNOT_FOUND
,
2380 wxT("removing inexistent element in wxArrayString::Remove") );
2385 void wxArrayString::assign(const_iterator first
, const_iterator last
)
2387 reserve(last
- first
);
2388 for(; first
!= last
; ++first
)
2392 // ----------------------------------------------------------------------------
2394 // ----------------------------------------------------------------------------
2396 // we can only sort one array at a time with the quick-sort based
2399 // need a critical section to protect access to gs_compareFunction and
2400 // gs_sortAscending variables
2401 static wxCriticalSection
*gs_critsectStringSort
= NULL
;
2403 // call this before the value of the global sort vars is changed/after
2404 // you're finished with them
2405 #define START_SORT() wxASSERT( !gs_critsectStringSort ); \
2406 gs_critsectStringSort = new wxCriticalSection; \
2407 gs_critsectStringSort->Enter()
2408 #define END_SORT() gs_critsectStringSort->Leave(); \
2409 delete gs_critsectStringSort; \
2410 gs_critsectStringSort = NULL
2412 #define START_SORT()
2414 #endif // wxUSE_THREADS
2416 // function to use for string comparaison
2417 static wxArrayString::CompareFunction gs_compareFunction
= NULL
;
2419 // if we don't use the compare function, this flag tells us if we sort the
2420 // array in ascending or descending order
2421 static bool gs_sortAscending
= true;
2423 // function which is called by quick sort
2424 extern "C" int wxC_CALLING_CONV
// LINKAGEMODE
2425 wxStringCompareFunction(const void *first
, const void *second
)
2427 wxString
*strFirst
= (wxString
*)first
;
2428 wxString
*strSecond
= (wxString
*)second
;
2430 if ( gs_compareFunction
) {
2431 return gs_compareFunction(*strFirst
, *strSecond
);
2434 // maybe we should use wxStrcoll
2435 int result
= strFirst
->Cmp(*strSecond
);
2437 return gs_sortAscending
? result
: -result
;
2441 // sort array elements using passed comparaison function
2442 void wxArrayString::Sort(CompareFunction compareFunction
)
2446 wxASSERT( !gs_compareFunction
); // must have been reset to NULL
2447 gs_compareFunction
= compareFunction
;
2451 // reset it to NULL so that Sort(bool) will work the next time
2452 gs_compareFunction
= NULL
;
2457 typedef int (wxC_CALLING_CONV
* wxStringCompareFn
)(const void *first
, const void *second
);
2459 void wxArrayString::Sort(CompareFunction2 compareFunction
)
2461 qsort(m_pItems
, m_nCount
, sizeof(wxChar
*), (wxStringCompareFn
)compareFunction
);
2464 void wxArrayString::Sort(bool reverseOrder
)
2466 Sort(reverseOrder
? wxStringSortDescending
: wxStringSortAscending
);
2469 void wxArrayString::DoSort()
2471 wxCHECK_RET( !m_autoSort
, wxT("can't use this method with sorted arrays") );
2473 // just sort the pointers using qsort() - of course it only works because
2474 // wxString() *is* a pointer to its data
2475 qsort(m_pItems
, m_nCount
, sizeof(wxChar
*), wxStringCompareFunction
);
2478 bool wxArrayString::operator==(const wxArrayString
& a
) const
2480 if ( m_nCount
!= a
.m_nCount
)
2483 for ( size_t n
= 0; n
< m_nCount
; n
++ )
2485 if ( Item(n
) != a
[n
] )
2492 #endif // !wxUSE_STL
2494 int wxCMPFUNC_CONV
wxStringSortAscending(wxString
* s1
, wxString
* s2
)
2496 return s1
->Cmp(*s2
);
2499 int wxCMPFUNC_CONV
wxStringSortDescending(wxString
* s1
, wxString
* s2
)
2501 return -s1
->Cmp(*s2
);