src/common/string.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        string.cpp
   3 // Purpose:     wxString class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13   #pragma implementation "string.h"
  14 #endif
  15
  16 /*
  17  * About ref counting:
  18  *  1) all empty strings use g_strEmpty, nRefs = -1 (set in Init())
  19  *  2) AllocBuffer() sets nRefs to 1, Lock() increments it by one
  20  *  3) Unlock() decrements nRefs and frees memory if it goes to 0
  21  */
  22
  23 // ===========================================================================
  24 // headers, declarations, constants
  25 // ===========================================================================
  26
  27 // For compilers that support precompilation, includes "wx.h".
  28 #include "wx/wxprec.h"
  29
  30 #ifdef __BORLANDC__
  31   #pragma hdrstop
  32 #endif
  33
  34 #ifndef WX_PRECOMP
  35   #include "wx/defs.h"
  36   #include "wx/string.h"
  37   #include "wx/intl.h"
  38   #include "wx/thread.h"
  39 #endif
  40
  41 #include <ctype.h>
  42 #include <string.h>
  43 #include <stdlib.h>
  44
  45 #ifdef __SALFORDC__
  46   #include <clib.h>
  47 #endif
  48
  49 // allocating extra space for each string consumes more memory but speeds up
  50 // the concatenation operations (nLen is the current string's length)
  51 // NB: EXTRA_ALLOC must be >= 0!
  52 #define EXTRA_ALLOC       (19 - nLen % 16)
  53
  54 // ---------------------------------------------------------------------------
  55 // static class variables definition
  56 // ---------------------------------------------------------------------------
  57
  58 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
  59 // must define this static for VA or else you get multiply defined symbols
  60 // everywhere
  61 const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100;
  62 #endif // Visual Age
  63
  64 #if !wxUSE_STL
  65   const size_t wxStringBase::npos = wxSTRING_MAXLEN;
  66 #endif
  67
  68 // ----------------------------------------------------------------------------
  69 // static data
  70 // ----------------------------------------------------------------------------
  71
  72 #if wxUSE_STL
  73
  74 extern const wxChar WXDLLIMPEXP_BASE *wxEmptyString = _T("");
  75
  76 #else
  77
  78 // for an empty string, GetStringData() will return this address: this
  79 // structure has the same layout as wxStringData and it's data() method will
  80 // return the empty string (dummy pointer)
  81 static const struct
  82 {
  83   wxStringData data;
  84   wxChar dummy;
  85 } g_strEmpty = { {-1, 0, 0}, wxT('\0') };
  86
  87 // empty C style string: points to 'string data' byte of g_strEmpty
  88 extern const wxChar WXDLLIMPEXP_BASE *wxEmptyString = &g_strEmpty.dummy;
  89
  90 #endif
  91
  92 // ----------------------------------------------------------------------------
  93 // global functions
  94 // ----------------------------------------------------------------------------
  95
  96 #if wxUSE_STD_IOSTREAM
  97
  98 // MS Visual C++ version 5.0 provides the new STL headers as well as the old
  99 // iostream ones.
 100 //
 101 // ATTN: you can _not_ use both of these in the same program!
 102
 103 #include <iostream>
 104
 105 wxSTD istream& operator>>(wxSTD istream& is, wxString& WXUNUSED(str))
 106 {
 107 #if 0
 108   int w = is.width(0);
 109   if ( is.ipfx(0) ) {
 110     streambuf *sb = is.rdbuf();
 111     str.erase();
 112     while ( true ) {
 113       int ch = sb->sbumpc ();
 114       if ( ch == EOF ) {
 115         is.setstate(ios::eofbit);
 116         break;
 117       }
 118       else if ( isspace(ch) ) {
 119         sb->sungetc();
 120         break;
 121       }
 122
 123       str += ch;
 124       if ( --w == 1 )
 125         break;
 126     }
 127   }
 128
 129   is.isfx();
 130   if ( str.length() == 0 )
 131     is.setstate(ios::failbit);
 132 #endif
 133   return is;
 134 }
 135
 136 wxSTD ostream& operator<<(wxSTD ostream& os, const wxString& str)
 137 {
 138   os << str.c_str();
 139   return os;
 140 }
 141
 142 #endif // wxUSE_STD_IOSTREAM
 143
 144 // ----------------------------------------------------------------------------
 145 // private classes
 146 // ----------------------------------------------------------------------------
 147
 148 // this small class is used to gather statistics for performance tuning
 149 //#define WXSTRING_STATISTICS
 150 #ifdef  WXSTRING_STATISTICS
 151   class Averager
 152   {
 153   public:
 154     Averager(const wxChar *sz) { m_sz = sz; m_nTotal = m_nCount = 0; }
 155    ~Averager()
 156    { wxPrintf("wxString: average %s = %f\n", m_sz, ((float)m_nTotal)/m_nCount); }
 157
 158     void Add(size_t n) { m_nTotal += n; m_nCount++; }
 159
 160   private:
 161     size_t m_nCount, m_nTotal;
 162     const wxChar *m_sz;
 163   } g_averageLength("allocation size"),
 164     g_averageSummandLength("summand length"),
 165     g_averageConcatHit("hit probability in concat"),
 166     g_averageInitialLength("initial string length");
 167
 168   #define STATISTICS_ADD(av, val) g_average##av.Add(val)
 169 #else
 170   #define STATISTICS_ADD(av, val)
 171 #endif // WXSTRING_STATISTICS
 172
 173 #if !wxUSE_STL
 174
 175 // ===========================================================================
 176 // wxStringData class deallocation
 177 // ===========================================================================
 178
 179 #if defined(__VISUALC__) && defined(_MT) && !defined(_DLL)
 180 #  pragma message (__FILE__ ": building with Multithreaded non DLL runtime has a performance impact on wxString!")
 181 void wxStringData::Free()
 182 {
 183     free(this);
 184 }
 185 #endif
 186
 187 // ===========================================================================
 188 // wxStringBase
 189 // ===========================================================================
 190
 191 // takes nLength elements of psz starting at nPos
 192 void wxStringBase::InitWith(const wxChar *psz, size_t nPos, size_t nLength)
 193 {
 194   Init();
 195
 196   // if the length is not given, assume the string to be NUL terminated
 197   if ( nLength == npos ) {
 198     wxASSERT_MSG( nPos <= wxStrlen(psz), _T("index out of bounds") );
 199
 200     nLength = wxStrlen(psz + nPos);
 201   }
 202
 203   STATISTICS_ADD(InitialLength, nLength);
 204
 205   if ( nLength > 0 ) {
 206     // trailing '\0' is written in AllocBuffer()
 207     if ( !AllocBuffer(nLength) ) {
 208       wxFAIL_MSG( _T("out of memory in wxStringBase::InitWith") );
 209       return;
 210     }
 211     memcpy(m_pchData, psz + nPos, nLength*sizeof(wxChar));
 212   }
 213 }
 214
 215 // poor man's iterators are "void *" pointers
 216 wxStringBase::wxStringBase(const void *pStart, const void *pEnd)
 217 {
 218   InitWith((const wxChar *)pStart, 0,
 219            (const wxChar *)pEnd - (const wxChar *)pStart);
 220 }
 221
 222 wxStringBase::wxStringBase(size_type n, wxChar ch)
 223 {
 224   Init();
 225   append(n, ch);
 226 }
 227
 228 // ---------------------------------------------------------------------------
 229 // memory allocation
 230 // ---------------------------------------------------------------------------
 231
 232 // allocates memory needed to store a C string of length nLen
 233 bool wxStringBase::AllocBuffer(size_t nLen)
 234 {
 235   // allocating 0 sized buffer doesn't make sense, all empty strings should
 236   // reuse g_strEmpty
 237   wxASSERT( nLen >  0 );
 238
 239   // make sure that we don't overflow
 240   wxASSERT( nLen < (INT_MAX / sizeof(wxChar)) -
 241                    (sizeof(wxStringData) + EXTRA_ALLOC + 1) );
 242
 243   STATISTICS_ADD(Length, nLen);
 244
 245   // allocate memory:
 246   // 1) one extra character for '\0' termination
 247   // 2) sizeof(wxStringData) for housekeeping info
 248   wxStringData* pData = (wxStringData*)
 249     malloc(sizeof(wxStringData) + (nLen + EXTRA_ALLOC + 1)*sizeof(wxChar));
 250
 251   if ( pData == NULL ) {
 252     // allocation failures are handled by the caller
 253     return FALSE;
 254   }
 255
 256   pData->nRefs        = 1;
 257   pData->nDataLength  = nLen;
 258   pData->nAllocLength = nLen + EXTRA_ALLOC;
 259   m_pchData           = pData->data();  // data starts after wxStringData
 260   m_pchData[nLen]     = wxT('\0');
 261   return TRUE;
 262 }
 263
 264 // must be called before changing this string
 265 bool wxStringBase::CopyBeforeWrite()
 266 {
 267   wxStringData* pData = GetStringData();
 268
 269   if ( pData->IsShared() ) {
 270     pData->Unlock();                // memory not freed because shared
 271     size_t nLen = pData->nDataLength;
 272     if ( !AllocBuffer(nLen) ) {
 273       // allocation failures are handled by the caller
 274       return FALSE;
 275     }
 276     memcpy(m_pchData, pData->data(), nLen*sizeof(wxChar));
 277   }
 278
 279   wxASSERT( !GetStringData()->IsShared() );  // we must be the only owner
 280
 281   return TRUE;
 282 }
 283
 284 // must be called before replacing contents of this string
 285 bool wxStringBase::AllocBeforeWrite(size_t nLen)
 286 {
 287   wxASSERT( nLen != 0 );  // doesn't make any sense
 288
 289   // must not share string and must have enough space
 290   wxStringData* pData = GetStringData();
 291   if ( pData->IsShared() || pData->IsEmpty() ) {
 292     // can't work with old buffer, get new one
 293     pData->Unlock();
 294     if ( !AllocBuffer(nLen) ) {
 295       // allocation failures are handled by the caller
 296       return FALSE;
 297     }
 298   }
 299   else {
 300     if ( nLen > pData->nAllocLength ) {
 301       // realloc the buffer instead of calling malloc() again, this is more
 302       // efficient
 303       STATISTICS_ADD(Length, nLen);
 304
 305       nLen += EXTRA_ALLOC;
 306
 307       pData = (wxStringData*)
 308           realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
 309
 310       if ( pData == NULL ) {
 311         // allocation failures are handled by the caller
 312         // keep previous data since reallocation failed
 313         return FALSE;
 314       }
 315
 316       pData->nAllocLength = nLen;
 317       m_pchData = pData->data();
 318     }
 319
 320     // now we have enough space, just update the string length
 321     pData->nDataLength = nLen;
 322   }
 323
 324   wxASSERT( !GetStringData()->IsShared() );  // we must be the only owner
 325
 326   return TRUE;
 327 }
 328
 329 wxStringBase& wxStringBase::append(size_t n, wxChar ch)
 330 {
 331     size_type len = length();
 332
 333     if ( !CopyBeforeWrite() || !Alloc(len + n) ) {
 334       wxFAIL_MSG( _T("out of memory in wxStringBase::append") );
 335     }
 336     GetStringData()->nDataLength = len + n;
 337     m_pchData[len + n] = '\0';
 338     for ( size_t i = 0; i < n; ++i )
 339         m_pchData[len + i] = ch;
 340     return *this;
 341 }
 342
 343 void wxStringBase::resize(size_t nSize, wxChar ch)
 344 {
 345     size_t len = length();
 346
 347     if ( nSize < len )
 348     {
 349         erase(begin() + nSize, end());
 350     }
 351     else if ( nSize > len )
 352     {
 353         append(nSize - len, ch);
 354     }
 355     //else: we have exactly the specified length, nothing to do
 356 }
 357
 358 // allocate enough memory for nLen characters
 359 bool wxStringBase::Alloc(size_t nLen)
 360 {
 361   wxStringData *pData = GetStringData();
 362   if ( pData->nAllocLength <= nLen ) {
 363     if ( pData->IsEmpty() ) {
 364       nLen += EXTRA_ALLOC;
 365
 366       wxStringData* pData = (wxStringData*)
 367           malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
 368
 369       if ( pData == NULL ) {
 370         // allocation failure handled by caller
 371         return FALSE;
 372       }
 373
 374       pData->nRefs = 1;
 375       pData->nDataLength = 0;
 376       pData->nAllocLength = nLen;
 377       m_pchData = pData->data();  // data starts after wxStringData
 378       m_pchData[0u] = wxT('\0');
 379     }
 380     else if ( pData->IsShared() ) {
 381       pData->Unlock();                // memory not freed because shared
 382       size_t nOldLen = pData->nDataLength;
 383       if ( !AllocBuffer(nLen) ) {
 384         // allocation failure handled by caller
 385         return FALSE;
 386       }
 387       memcpy(m_pchData, pData->data(), nOldLen*sizeof(wxChar));
 388     }
 389     else {
 390       nLen += EXTRA_ALLOC;
 391
 392       pData = (wxStringData *)
 393         realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
 394
 395       if ( pData == NULL ) {
 396         // allocation failure handled by caller
 397         // keep previous data since reallocation failed
 398         return FALSE;
 399       }
 400
 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();
 405     }
 406   }
 407   //else: we've already got enough
 408   return TRUE;
 409 }
 410
 411 wxStringBase::iterator wxStringBase::begin()
 412 {
 413     if (length() > 0)
 414         CopyBeforeWrite();
 415     return m_pchData;
 416 }
 417
 418 wxStringBase::iterator wxStringBase::end()
 419 {
 420     if (length() > 0)
 421         CopyBeforeWrite();
 422     return m_pchData + length();
 423 }
 424
 425 wxStringBase::iterator wxStringBase::erase(iterator it)
 426 {
 427     size_type idx = it - begin();
 428     erase(idx, 1);
 429     return begin() + idx;
 430 }
 431
 432 wxStringBase& wxStringBase::erase(size_t nStart, size_t nLen)
 433 {
 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);
 440
 441   swap(strTmp);
 442   return *this;
 443 }
 444
 445 wxStringBase& wxStringBase::insert(size_t nPos, const wxChar *sz, size_t n)
 446 {
 447   wxASSERT( nPos <= length() );
 448
 449   if ( n == npos ) n = wxStrlen(sz);
 450   if ( n == 0 ) return *this;
 451
 452   if ( !CopyBeforeWrite() || !Alloc(length() + n) ) {
 453     wxFAIL_MSG( _T("out of memory in wxStringBase::insert") );
 454   }
 455
 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';
 461
 462   return *this;
 463 }
 464
 465 void wxStringBase::swap(wxStringBase& str)
 466 {
 467     wxChar* tmp = str.m_pchData;
 468     str.m_pchData = m_pchData;
 469     m_pchData = tmp;
 470 }
 471
 472 size_t wxStringBase::find(const wxStringBase& str, size_t nStart) const
 473 {
 474   wxASSERT( str.GetStringData()->IsValid() );
 475   wxASSERT( nStart <= length() );
 476
 477   const wxChar *p = wxStrstr(c_str() + nStart, str.c_str());
 478
 479   return p == NULL ? npos : p - c_str();
 480 }
 481
 482 size_t wxStringBase::find(const wxChar* sz, size_t nStart, size_t n) const
 483 {
 484   return find(wxStringBase(sz, n), nStart);
 485 }
 486
 487 size_t wxStringBase::find(wxChar ch, size_t nStart) const
 488 {
 489   wxASSERT( nStart <= length() );
 490
 491   const wxChar *p = wxStrchr(c_str() + nStart, ch);
 492
 493   return p == NULL ? npos : p - c_str();
 494 }
 495
 496 size_t wxStringBase::rfind(const wxStringBase& str, size_t nStart) const
 497 {
 498     wxASSERT( str.GetStringData()->IsValid() );
 499     wxASSERT( nStart == npos || nStart <= length() );
 500
 501     if ( length() >= str.length() )
 502     {
 503         // avoids a corner case later
 504         if ( length() == 0 && str.length() == 0 )
 505             return 0;
 506
 507         // "top" is the point where search starts from
 508         size_t top = length() - str.length();
 509
 510         if ( nStart == npos )
 511             nStart = length() - 1;
 512         if ( nStart < top )
 513             top = nStart;
 514
 515         const wxChar *cursor = c_str() + top;
 516         do
 517         {
 518             if ( memcmp(cursor, str.c_str(),
 519                         str.length() * sizeof(wxChar)) == 0 )
 520             {
 521                 return cursor - c_str();
 522             }
 523         } while ( cursor-- > c_str() );
 524     }
 525
 526     return npos;
 527 }
 528
 529 size_t wxStringBase::rfind(const wxChar* sz, size_t nStart, size_t n) const
 530 {
 531     return rfind(wxStringBase(sz, n), nStart);
 532 }
 533
 534 size_t wxStringBase::rfind(wxChar ch, size_t nStart) const
 535 {
 536     if ( nStart == npos )
 537     {
 538         nStart = length();
 539     }
 540     else
 541     {
 542         wxASSERT( nStart <= length() );
 543     }
 544
 545     const wxChar *actual;
 546     for ( actual = c_str() + ( nStart == npos ? length() : nStart + 1 );
 547           actual > c_str(); --actual )
 548     {
 549         if ( *(actual - 1) == ch )
 550             return (actual - 1) - c_str();
 551     }
 552
 553     return npos;
 554 }
 555
 556 size_t wxStringBase::find_first_of(const wxChar* sz, size_t nStart) const
 557 {
 558     const wxChar *start = c_str() + nStart;
 559     const wxChar *firstOf = wxStrpbrk(start, sz);
 560     if ( firstOf )
 561         return firstOf - c_str();
 562     else
 563         return npos;
 564 }
 565
 566 size_t wxStringBase::find_first_of(const wxChar* sz, size_t nStart,
 567                                    size_t n) const
 568 {
 569     return find_first_of(wxStringBase(sz, n), nStart);
 570 }
 571
 572 size_t wxStringBase::find_last_of(const wxChar* sz, size_t nStart) const
 573 {
 574     if ( nStart == npos )
 575     {
 576         nStart = length() - 1;
 577     }
 578     else
 579     {
 580         wxASSERT_MSG( nStart <= length(),
 581                         _T("invalid index in find_last_of()") );
 582     }
 583
 584     for ( const wxChar *p = c_str() + nStart; p >= c_str(); --p )
 585     {
 586         if ( wxStrchr(sz, *p) )
 587             return p - c_str();
 588     }
 589
 590     return npos;
 591 }
 592
 593 size_t wxStringBase::find_last_of(const wxChar* sz, size_t nStart,
 594                                    size_t n) const
 595 {
 596     return find_last_of(wxStringBase(sz, n), nStart);
 597 }
 598
 599 size_t wxStringBase::find_first_not_of(const wxChar* sz, size_t nStart) const
 600 {
 601     if ( nStart == npos )
 602     {
 603         nStart = length();
 604     }
 605     else
 606     {
 607         wxASSERT( nStart <= length() );
 608     }
 609
 610     size_t nAccept = wxStrspn(c_str() + nStart, sz);
 611     if ( nAccept >= length() - nStart )
 612         return npos;
 613     else
 614         return nStart + nAccept;
 615 }
 616
 617 size_t wxStringBase::find_first_not_of(const wxChar* sz, size_t nStart,
 618                                        size_t n) const
 619 {
 620     return find_first_not_of(wxStringBase(sz, n), nStart);
 621 }
 622
 623 size_t wxStringBase::find_first_not_of(wxChar ch, size_t nStart) const
 624 {
 625     wxASSERT( nStart <= length() );
 626
 627     for ( const wxChar *p = c_str() + nStart; *p; p++ )
 628     {
 629         if ( *p != ch )
 630             return p - c_str();
 631     }
 632
 633     return npos;
 634 }
 635
 636 size_t wxStringBase::find_last_not_of(const wxChar* sz, size_t nStart) const
 637 {
 638     if ( nStart == npos )
 639     {
 640         nStart = length() - 1;
 641     }
 642     else
 643     {
 644         wxASSERT( nStart <= length() );
 645     }
 646
 647     for ( const wxChar *p = c_str() + nStart; p >= c_str(); --p )
 648     {
 649         if ( !wxStrchr(sz, *p) )
 650             return p - c_str();
 651     }
 652
 653     return npos;
 654 }
 655
 656 size_t wxStringBase::find_last_not_of(const wxChar* sz, size_t nStart,
 657                                       size_t n) const
 658 {
 659     return find_last_not_of(wxStringBase(sz, n), nStart);
 660 }
 661
 662 size_t wxStringBase::find_last_not_of(wxChar ch, size_t nStart) const
 663 {
 664     if ( nStart == npos )
 665     {
 666         nStart = length() - 1;
 667     }
 668     else
 669     {
 670         wxASSERT( nStart <= length() );
 671     }
 672
 673     for ( const wxChar *p = c_str() + nStart; p >= c_str(); --p )
 674     {
 675         if ( *p != ch )
 676             return p - c_str();
 677     }
 678
 679     return npos;
 680 }
 681
 682 wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
 683                                     const wxChar *sz)
 684 {
 685   wxASSERT_MSG( nStart <= length(),
 686                 _T("index out of bounds in wxStringBase::replace") );
 687   size_t strLen = length() - nStart;
 688   nLen = strLen < nLen ? strLen : nLen;
 689
 690   wxStringBase strTmp;
 691   strTmp.reserve(length()); // micro optimisation to avoid multiple mem allocs
 692
 693   if ( nStart != 0 )
 694     strTmp.append(c_str(), nStart);
 695   strTmp.append(sz);
 696   strTmp.append(c_str() + nStart + nLen);
 697
 698   swap(strTmp);
 699   return *this;
 700 }
 701
 702 wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
 703                                     size_t nCount, wxChar ch)
 704 {
 705   return replace(nStart, nLen, wxStringBase(ch, nCount).c_str());
 706 }
 707
 708 wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
 709                                     const wxStringBase& str,
 710                                     size_t nStart2, size_t nLen2)
 711 {
 712   return replace(nStart, nLen, str.substr(nStart2, nLen2));
 713 }
 714
 715 wxStringBase& wxStringBase::replace(size_t nStart, size_t nLen,
 716                                     const wxChar* sz, size_t nCount)
 717 {
 718   return replace(nStart, nLen, wxStringBase(sz, nCount).c_str());
 719 }
 720
 721 wxStringBase wxStringBase::substr(size_t nStart, size_t nLen) const
 722 {
 723   if ( nLen == npos )
 724     nLen = length() - nStart;
 725   return wxStringBase(*this, nStart, nLen);
 726 }
 727
 728 // assigns one string to another
 729 wxStringBase& wxStringBase::operator=(const wxStringBase& stringSrc)
 730 {
 731   wxASSERT( stringSrc.GetStringData()->IsValid() );
 732
 733   // don't copy string over itself
 734   if ( m_pchData != stringSrc.m_pchData ) {
 735     if ( stringSrc.GetStringData()->IsEmpty() ) {
 736       Reinit();
 737     }
 738     else {
 739       // adjust references
 740       GetStringData()->Unlock();
 741       m_pchData = stringSrc.m_pchData;
 742       GetStringData()->Lock();
 743     }
 744   }
 745
 746   return *this;
 747 }
 748
 749 // assigns a single character
 750 wxStringBase& wxStringBase::operator=(wxChar ch)
 751 {
 752   if ( !AssignCopy(1, &ch) ) {
 753     wxFAIL_MSG( _T("out of memory in wxStringBase::operator=(wxChar)") );
 754   }
 755   return *this;
 756 }
 757
 758 // assigns C string
 759 wxStringBase& wxStringBase::operator=(const wxChar *psz)
 760 {
 761   if ( !AssignCopy(wxStrlen(psz), psz) ) {
 762     wxFAIL_MSG( _T("out of memory in wxStringBase::operator=(const wxChar *)") );
 763   }
 764   return *this;
 765 }
 766
 767 // helper function: does real copy
 768 bool wxStringBase::AssignCopy(size_t nSrcLen, const wxChar *pszSrcData)
 769 {
 770   if ( nSrcLen == 0 ) {
 771     Reinit();
 772   }
 773   else {
 774     if ( !AllocBeforeWrite(nSrcLen) ) {
 775       // allocation failure handled by caller
 776       return FALSE;
 777     }
 778     memcpy(m_pchData, pszSrcData, nSrcLen*sizeof(wxChar));
 779     GetStringData()->nDataLength = nSrcLen;
 780     m_pchData[nSrcLen] = wxT('\0');
 781   }
 782   return TRUE;
 783 }
 784
 785 // ---------------------------------------------------------------------------
 786 // string concatenation
 787 // ---------------------------------------------------------------------------
 788
 789 // add something to this string
 790 bool wxStringBase::ConcatSelf(size_t nSrcLen, const wxChar *pszSrcData,
 791                               size_t nMaxLen)
 792 {
 793   STATISTICS_ADD(SummandLength, nSrcLen);
 794
 795   nSrcLen = nSrcLen < nMaxLen ? nSrcLen : nMaxLen;
 796
 797   // concatenating an empty string is a NOP
 798   if ( nSrcLen > 0 ) {
 799     wxStringData *pData = GetStringData();
 800     size_t nLen = pData->nDataLength;
 801     size_t nNewLen = nLen + nSrcLen;
 802
 803     // alloc new buffer if current is too small
 804     if ( pData->IsShared() ) {
 805       STATISTICS_ADD(ConcatHit, 0);
 806
 807       // we have to allocate another buffer
 808       wxStringData* pOldData = GetStringData();
 809       if ( !AllocBuffer(nNewLen) ) {
 810           // allocation failure handled by caller
 811           return FALSE;
 812       }
 813       memcpy(m_pchData, pOldData->data(), nLen*sizeof(wxChar));
 814       pOldData->Unlock();
 815     }
 816     else if ( nNewLen > pData->nAllocLength ) {
 817       STATISTICS_ADD(ConcatHit, 0);
 818
 819       reserve(nNewLen);
 820       // we have to grow the buffer
 821       if ( capacity() < nNewLen ) {
 822           // allocation failure handled by caller
 823           return FALSE;
 824       }
 825     }
 826     else {
 827       STATISTICS_ADD(ConcatHit, 1);
 828
 829       // the buffer is already big enough
 830     }
 831
 832     // should be enough space
 833     wxASSERT( nNewLen <= GetStringData()->nAllocLength );
 834
 835     // fast concatenation - all is done in our buffer
 836     memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(wxChar));
 837
 838     m_pchData[nNewLen] = wxT('\0');          // put terminating '\0'
 839     GetStringData()->nDataLength = nNewLen; // and fix the length
 840   }
 841   //else: the string to append was empty
 842   return TRUE;
 843 }
 844
 845 // ---------------------------------------------------------------------------
 846 // simple sub-string extraction
 847 // ---------------------------------------------------------------------------
 848
 849 // helper function: clone the data attached to this string
 850 bool wxStringBase::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const
 851 {
 852   if ( nCopyLen == 0 ) {
 853     dest.Init();
 854   }
 855   else {
 856     if ( !dest.AllocBuffer(nCopyLen) ) {
 857       // allocation failure handled by caller
 858       return FALSE;
 859     }
 860     memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(wxChar));
 861   }
 862   return TRUE;
 863 }
 864
 865 #endif // !wxUSE_STL
 866
 867 #if !wxUSE_STL || !defined(HAVE_STD_STRING_COMPARE)
 868
 869 #if !wxUSE_STL
 870     #define STRINGCLASS wxStringBase
 871 #else
 872     #define STRINGCLASS wxString
 873 #endif
 874
 875 static inline int wxDoCmp(const wxChar* s1, size_t l1,
 876                           const wxChar* s2, size_t l2)
 877 {
 878     if( l1 == l2 )
 879         return wxStrncmp(s1, s2, l1);
 880     else if( l1 < l2 )
 881     {
 882         int ret = wxStrncmp(s1, s2, l1);
 883         return ret == 0 ? -1 : ret;
 884     }
 885     else if( l1 > l2 )
 886     {
 887         int ret = wxStrncmp(s1, s2, l2);
 888         return ret == 0 ? +1 : ret;
 889     }
 890
 891     wxFAIL;   // must never get there
 892     return 0; // quiet compilers
 893 }
 894
 895 #if wxUSE_STL
 896
 897 int STRINGCLASS::compare(const wxStringBase& str) const
 898 {
 899     return ::wxDoCmp(data(), length(), str.data(), str.length());
 900 }
 901
 902 #endif
 903
 904 int STRINGCLASS::compare(size_t nStart, size_t nLen,
 905                          const wxStringBase& str) const
 906 {
 907     wxASSERT(nStart <= length());
 908     size_type strLen = length() - nStart;
 909     nLen = strLen < nLen ? strLen : nLen;
 910     return ::wxDoCmp(data() + nStart, nLen, str.data(), str.length());
 911 }
 912
 913 int STRINGCLASS::compare(size_t nStart, size_t nLen,
 914                          const wxStringBase& str,
 915                          size_t nStart2, size_t nLen2) const
 916 {
 917     wxASSERT(nStart <= length());
 918     wxASSERT(nStart2 <= str.length());
 919     size_type strLen  =     length() - nStart,
 920               strLen2 = str.length() - nStart2;
 921     nLen  = strLen  < nLen  ? strLen  : nLen;
 922     nLen2 = strLen2 < nLen2 ? strLen2 : nLen2;
 923     return ::wxDoCmp(data() + nStart, nLen, str.data() + nStart2, nLen2);
 924 }
 925
 926 #if wxUSE_STL
 927
 928 int STRINGCLASS::compare(const wxChar* sz) const
 929 {
 930     size_t nLen = wxStrlen(sz);
 931     return ::wxDoCmp(data(), length(), sz, nLen);
 932 }
 933
 934 #endif
 935
 936 int STRINGCLASS::compare(size_t nStart, size_t nLen,
 937                          const wxChar* sz, size_t nCount) const
 938 {
 939     wxASSERT(nStart <= length());
 940     size_type strLen = length() - nStart;
 941     nLen = strLen < nLen ? strLen : nLen;
 942     if( nCount == npos )
 943         nCount = wxStrlen(sz);
 944
 945     return ::wxDoCmp(data() + nStart, nLen, sz, nCount);
 946 }
 947
 948 #undef STRINGCLASS
 949
 950 #endif // !wxUSE_STL || !defined(HAVE_STD_STRING_COMPARE)
 951
 952 // ===========================================================================
 953 // wxString class core
 954 // ===========================================================================
 955
 956 // ---------------------------------------------------------------------------
 957 // construction
 958 // ---------------------------------------------------------------------------
 959
 960 #if wxUSE_UNICODE
 961
 962 // from multibyte string
 963 wxString::wxString(const char *psz, wxMBConv& conv, size_t nLength)
 964 {
 965     // if nLength != npos, then we have to make a NULL-terminated copy
 966     // of first nLength bytes of psz first because the input buffer to MB2WC
 967     // must always be NULL-terminated:
 968     wxCharBuffer inBuf((const char *)NULL);
 969     if (nLength != npos)
 970     {
 971         wxCharBuffer tmp(nLength);
 972         memcpy(tmp.data(), psz, nLength);
 973         tmp.data()[nLength] = '\0';
 974         inBuf = tmp;
 975         psz = inBuf.data();
 976     }
 977
 978     // first get the size of the buffer we need
 979     size_t nLen;
 980     if ( psz )
 981     {
 982         // calculate the needed size ourselves or use the provided one
 983         nLen = conv.MB2WC(NULL, psz, 0);
 984     }
 985     else
 986     {
 987         // nothing to convert
 988         nLen = 0;
 989     }
 990
 991     // anything to do?
 992     if ( (nLen != 0) && (nLen != (size_t)-1) )
 993     {
 994         if ( !Alloc(nLen) )
 995         {
 996             wxFAIL_MSG( _T("out of memory in wxString::wxString") );
 997         }
 998         else
 999         {
1000             wxWCharBuffer buf(nLen);
1001             // MB2WC wants the buffer size, not the string length hence +1
1002             nLen = conv.MB2WC(buf.data(), psz, nLen + 1);
1003
1004             if ( nLen != (size_t)-1 )
1005             {
1006                 // initialized ok, set the real length as nLength specified by
1007                 // the caller could be greater than the real string length
1008                 assign(buf.data(), nLen);
1009                 return;
1010             }
1011             //else: the conversion failed -- leave the string empty (what else?)
1012         }
1013     }
1014 }
1015
1016 #else // ANSI
1017
1018 #if wxUSE_WCHAR_T
1019 // from wide string
1020 wxString::wxString(const wchar_t *pwz, wxMBConv& conv, size_t nLength)
1021 {
1022     // if nLength != npos, then we have to make a NULL-terminated copy
1023     // of first nLength chars of psz first because the input buffer to WC2MB
1024     // must always be NULL-terminated:
1025     wxWCharBuffer inBuf((const wchar_t *)NULL);
1026     if (nLength != npos)
1027     {
1028         wxWCharBuffer tmp(nLength);
1029         memcpy(tmp.data(), pwz, nLength * sizeof(wchar_t));
1030         tmp.data()[nLength] = '\0';
1031         inBuf = tmp;
1032         pwz = inBuf.data();
1033     }
1034
1035     // first get the size of the buffer we need
1036     size_t nLen;
1037     if ( pwz )
1038     {
1039         // calculate the needed size ourselves or use the provided one
1040         nLen = conv.WC2MB(NULL, pwz, 0);
1041     }
1042     else
1043     {
1044         // nothing to convert
1045         nLen = 0;
1046     }
1047
1048     // anything to do?
1049     if ( (nLen != 0) && (nLen != (size_t)-1) )
1050     {
1051         if ( !Alloc(nLen) )
1052         {
1053             wxFAIL_MSG( _T("out of memory in wxString::wxString") );
1054         }
1055         else
1056         {
1057             wxCharBuffer buf(nLen);
1058             // WC2MB wants the buffer size, not the string length
1059             if ( conv.WC2MB(buf.data(), pwz, nLen + 1) != (size_t)-1 )
1060             {
1061                 // initialized ok
1062                 assign(buf.data(), nLen);
1063                 return;
1064             }
1065             //else: the conversion failed -- leave the string empty (what else?)
1066         }
1067     }
1068
1069     // leave empty
1070 }
1071 #endif // wxUSE_WCHAR_T
1072
1073 #endif // Unicode/ANSI
1074
1075 // shrink to minimal size (releasing extra memory)
1076 bool wxString::Shrink()
1077 {
1078   wxString tmp(begin(), end());
1079   swap(tmp);
1080   return tmp.length() == length();
1081 }
1082
1083 #if !wxUSE_STL
1084 // get the pointer to writable buffer of (at least) nLen bytes
1085 wxChar *wxString::GetWriteBuf(size_t nLen)
1086 {
1087   if ( !AllocBeforeWrite(nLen) ) {
1088     // allocation failure handled by caller
1089     return NULL;
1090   }
1091
1092   wxASSERT( GetStringData()->nRefs == 1 );
1093   GetStringData()->Validate(FALSE);
1094
1095   return m_pchData;
1096 }
1097
1098 // put string back in a reasonable state after GetWriteBuf
1099 void wxString::UngetWriteBuf()
1100 {
1101   GetStringData()->nDataLength = wxStrlen(m_pchData);
1102   GetStringData()->Validate(TRUE);
1103 }
1104
1105 void wxString::UngetWriteBuf(size_t nLen)
1106 {
1107   GetStringData()->nDataLength = nLen;
1108   GetStringData()->Validate(TRUE);
1109 }
1110 #endif
1111
1112 // ---------------------------------------------------------------------------
1113 // data access
1114 // ---------------------------------------------------------------------------
1115
1116 // all functions are inline in string.h
1117
1118 // ---------------------------------------------------------------------------
1119 // assignment operators
1120 // ---------------------------------------------------------------------------
1121
1122 #if !wxUSE_UNICODE
1123
1124 // same as 'signed char' variant
1125 wxString& wxString::operator=(const unsigned char* psz)
1126 {
1127   *this = (const char *)psz;
1128   return *this;
1129 }
1130
1131 #if wxUSE_WCHAR_T
1132 wxString& wxString::operator=(const wchar_t *pwz)
1133 {
1134   wxString str(pwz);
1135   swap(str);
1136   return *this;
1137 }
1138 #endif
1139
1140 #endif
1141
1142 /*
1143  * concatenation functions come in 5 flavours:
1144  *  string + string
1145  *  char   + string      and      string + char
1146  *  C str  + string      and      string + C str
1147  */
1148
1149 wxString operator+(const wxString& str1, const wxString& str2)
1150 {
1151 #if !wxUSE_STL
1152   wxASSERT( str1.GetStringData()->IsValid() );
1153   wxASSERT( str2.GetStringData()->IsValid() );
1154 #endif
1155
1156   wxString s = str1;
1157   s += str2;
1158
1159   return s;
1160 }
1161
1162 wxString operator+(const wxString& str, wxChar ch)
1163 {
1164 #if !wxUSE_STL
1165   wxASSERT( str.GetStringData()->IsValid() );
1166 #endif
1167
1168   wxString s = str;
1169   s += ch;
1170
1171   return s;
1172 }
1173
1174 wxString operator+(wxChar ch, const wxString& str)
1175 {
1176 #if !wxUSE_STL
1177   wxASSERT( str.GetStringData()->IsValid() );
1178 #endif
1179
1180   wxString s = ch;
1181   s += str;
1182
1183   return s;
1184 }
1185
1186 wxString operator+(const wxString& str, const wxChar *psz)
1187 {
1188 #if !wxUSE_STL
1189   wxASSERT( str.GetStringData()->IsValid() );
1190 #endif
1191
1192   wxString s;
1193   if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
1194     wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1195   }
1196   s = str;
1197   s += psz;
1198
1199   return s;
1200 }
1201
1202 wxString operator+(const wxChar *psz, const wxString& str)
1203 {
1204 #if !wxUSE_STL
1205   wxASSERT( str.GetStringData()->IsValid() );
1206 #endif
1207
1208   wxString s;
1209   if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
1210     wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1211   }
1212   s = psz;
1213   s += str;
1214
1215   return s;
1216 }
1217
1218 // ===========================================================================
1219 // other common string functions
1220 // ===========================================================================
1221
1222 #if wxUSE_UNICODE
1223
1224 wxString wxString::FromAscii(const char *ascii)
1225 {
1226     if (!ascii)
1227        return wxEmptyString;
1228
1229     size_t len = strlen( ascii );
1230     wxString res;
1231
1232     if ( len )
1233     {
1234         wxStringBuffer buf(res, len);
1235
1236         wchar_t *dest = buf;
1237
1238         for ( ;; )
1239         {
1240            if ( (*dest++ = (wchar_t)(unsigned char)*ascii++) == L'\0' )
1241                break;
1242         }
1243     }
1244
1245     return res;
1246 }
1247
1248 wxString wxString::FromAscii(const char ascii)
1249 {
1250     // What do we do with '\0' ?
1251
1252     wxString res;
1253     res += (wchar_t)(unsigned char) ascii;
1254
1255     return res;
1256 }
1257
1258 const wxCharBuffer wxString::ToAscii() const
1259 {
1260     // this will allocate enough space for the terminating NUL too
1261     wxCharBuffer buffer(length());
1262
1263     signed char *dest = (signed char *)buffer.data();
1264
1265     const wchar_t *pwc = c_str();
1266     for ( ;; )
1267     {
1268         *dest++ = *pwc > SCHAR_MAX ? '_' : *pwc;
1269
1270         // the output string can't have embedded NULs anyhow, so we can safely
1271         // stop at first of them even if we do have any
1272         if ( !*pwc++ )
1273             break;
1274     }
1275
1276     return buffer;
1277 }
1278
1279 #endif // Unicode
1280
1281 // extract string of length nCount starting at nFirst
1282 wxString wxString::Mid(size_t nFirst, size_t nCount) const
1283 {
1284   size_t nLen = length();
1285
1286   // default value of nCount is npos and means "till the end"
1287   if ( nCount == npos )
1288   {
1289     nCount = nLen - nFirst;
1290   }
1291
1292   // out-of-bounds requests return sensible things
1293   if ( nFirst + nCount > nLen )
1294   {
1295     nCount = nLen - nFirst;
1296   }
1297
1298   if ( nFirst > nLen )
1299   {
1300     // AllocCopy() will return empty string
1301     nCount = 0;
1302   }
1303
1304   wxString dest(*this, nFirst, nCount);
1305   if ( dest.length() != nCount ) {
1306       wxFAIL_MSG( _T("out of memory in wxString::Mid") );
1307   }
1308
1309   return dest;
1310 }
1311
1312 // check that the string starts with prefix and return the rest of the string
1313 // in the provided pointer if it is not NULL, otherwise return FALSE
1314 bool wxString::StartsWith(const wxChar *prefix, wxString *rest) const
1315 {
1316     wxASSERT_MSG( prefix, _T("invalid parameter in wxString::StartsWith") );
1317
1318     // first check if the beginning of the string matches the prefix: note
1319     // that we don't have to check that we don't run out of this string as
1320     // when we reach the terminating NUL, either prefix string ends too (and
1321     // then it's ok) or we break out of the loop because there is no match
1322     const wxChar *p = c_str();
1323     while ( *prefix )
1324     {
1325         if ( *prefix++ != *p++ )
1326         {
1327             // no match
1328             return FALSE;
1329         }
1330     }
1331
1332     if ( rest )
1333     {
1334         // put the rest of the string into provided pointer
1335         *rest = p;
1336     }
1337
1338     return TRUE;
1339 }
1340
1341 // extract nCount last (rightmost) characters
1342 wxString wxString::Right(size_t nCount) const
1343 {
1344   if ( nCount > length() )
1345     nCount = length();
1346
1347   wxString dest(*this, length() - nCount, nCount);
1348   if ( dest.length() != nCount ) {
1349     wxFAIL_MSG( _T("out of memory in wxString::Right") );
1350   }
1351   return dest;
1352 }
1353
1354 // get all characters after the last occurence of ch
1355 // (returns the whole string if ch not found)
1356 wxString wxString::AfterLast(wxChar ch) const
1357 {
1358   wxString str;
1359   int iPos = Find(ch, TRUE);
1360   if ( iPos == wxNOT_FOUND )
1361     str = *this;
1362   else
1363     str = c_str() + iPos + 1;
1364
1365   return str;
1366 }
1367
1368 // extract nCount first (leftmost) characters
1369 wxString wxString::Left(size_t nCount) const
1370 {
1371   if ( nCount > length() )
1372     nCount = length();
1373
1374   wxString dest(*this, 0, nCount);
1375   if ( dest.length() != nCount ) {
1376     wxFAIL_MSG( _T("out of memory in wxString::Left") );
1377   }
1378   return dest;
1379 }
1380
1381 // get all characters before the first occurence of ch
1382 // (returns the whole string if ch not found)
1383 wxString wxString::BeforeFirst(wxChar ch) const
1384 {
1385   int iPos = Find(ch);
1386   if ( iPos == wxNOT_FOUND ) iPos = length();
1387   return wxString(*this, 0, iPos);
1388 }
1389
1390 /// get all characters before the last occurence of ch
1391 /// (returns empty string if ch not found)
1392 wxString wxString::BeforeLast(wxChar ch) const
1393 {
1394   wxString str;
1395   int iPos = Find(ch, TRUE);
1396   if ( iPos != wxNOT_FOUND && iPos != 0 )
1397     str = wxString(c_str(), iPos);
1398
1399   return str;
1400 }
1401
1402 /// get all characters after the first occurence of ch
1403 /// (returns empty string if ch not found)
1404 wxString wxString::AfterFirst(wxChar ch) const
1405 {
1406   wxString str;
1407   int iPos = Find(ch);
1408   if ( iPos != wxNOT_FOUND )
1409     str = c_str() + iPos + 1;
1410
1411   return str;
1412 }
1413
1414 // replace first (or all) occurences of some substring with another one
1415 size_t
1416 wxString::Replace(const wxChar *szOld, const wxChar *szNew, bool bReplaceAll)
1417 {
1418     // if we tried to replace an empty string we'd enter an infinite loop below
1419     wxCHECK_MSG( szOld && *szOld && szNew, 0,
1420                  _T("wxString::Replace(): invalid parameter") );
1421
1422   size_t uiCount = 0;   // count of replacements made
1423
1424   size_t uiOldLen = wxStrlen(szOld);
1425
1426   wxString strTemp;
1427   const wxChar *pCurrent = c_str();
1428   const wxChar *pSubstr;
1429   while ( *pCurrent != wxT('\0') ) {
1430     pSubstr = wxStrstr(pCurrent, szOld);
1431     if ( pSubstr == NULL ) {
1432       // strTemp is unused if no replacements were made, so avoid the copy
1433       if ( uiCount == 0 )
1434         return 0;
1435
1436       strTemp += pCurrent;    // copy the rest
1437       break;                  // exit the loop
1438     }
1439     else {
1440       // take chars before match
1441       size_type len = strTemp.length();
1442       strTemp.append(pCurrent, pSubstr - pCurrent);
1443       if ( strTemp.length() != (size_t)(len + pSubstr - pCurrent) ) {
1444         wxFAIL_MSG( _T("out of memory in wxString::Replace") );
1445         return 0;
1446       }
1447       strTemp += szNew;
1448       pCurrent = pSubstr + uiOldLen;  // restart after match
1449
1450       uiCount++;
1451
1452       // stop now?
1453       if ( !bReplaceAll ) {
1454         strTemp += pCurrent;    // copy the rest
1455         break;                  // exit the loop
1456       }
1457     }
1458   }
1459
1460   // only done if there were replacements, otherwise would have returned above
1461   swap(strTemp);
1462
1463   return uiCount;
1464 }
1465
1466 bool wxString::IsAscii() const
1467 {
1468   const wxChar *s = (const wxChar*) *this;
1469   while(*s){
1470     if(!isascii(*s)) return(FALSE);
1471     s++;
1472   }
1473   return(TRUE);
1474 }
1475
1476 bool wxString::IsWord() const
1477 {
1478   const wxChar *s = (const wxChar*) *this;
1479   while(*s){
1480     if(!wxIsalpha(*s)) return(FALSE);
1481     s++;
1482   }
1483   return(TRUE);
1484 }
1485
1486 bool wxString::IsNumber() const
1487 {
1488   const wxChar *s = (const wxChar*) *this;
1489   if (wxStrlen(s))
1490      if ((s[0] == '-') || (s[0] == '+')) s++;
1491   while(*s){
1492     if(!wxIsdigit(*s)) return(FALSE);
1493     s++;
1494   }
1495   return(TRUE);
1496 }
1497
1498 wxString wxString::Strip(stripType w) const
1499 {
1500     wxString s = *this;
1501     if ( w & leading ) s.Trim(FALSE);
1502     if ( w & trailing ) s.Trim(TRUE);
1503     return s;
1504 }
1505
1506 // ---------------------------------------------------------------------------
1507 // case conversion
1508 // ---------------------------------------------------------------------------
1509
1510 wxString& wxString::MakeUpper()
1511 {
1512   for ( iterator it = begin(), en = end(); it != en; ++it )
1513     *it = (wxChar)wxToupper(*it);
1514
1515   return *this;
1516 }
1517
1518 wxString& wxString::MakeLower()
1519 {
1520   for ( iterator it = begin(), en = end(); it != en; ++it )
1521     *it = (wxChar)wxTolower(*it);
1522
1523   return *this;
1524 }
1525
1526 // ---------------------------------------------------------------------------
1527 // trimming and padding
1528 // ---------------------------------------------------------------------------
1529
1530 // some compilers (VC++ 6.0 not to name them) return TRUE for a call to
1531 // isspace('ê') in the C locale which seems to be broken to me, but we have to
1532 // live with this by checking that the character is a 7 bit one - even if this
1533 // may fail to detect some spaces (I don't know if Unicode doesn't have
1534 // space-like symbols somewhere except in the first 128 chars), it is arguably
1535 // still better than trimming away accented letters
1536 inline int wxSafeIsspace(wxChar ch) { return (ch < 127) && wxIsspace(ch); }
1537
1538 // trims spaces (in the sense of isspace) from left or right side
1539 wxString& wxString::Trim(bool bFromRight)
1540 {
1541   // first check if we're going to modify the string at all
1542   if ( !IsEmpty() &&
1543        (
1544         (bFromRight && wxSafeIsspace(GetChar(Len() - 1))) ||
1545         (!bFromRight && wxSafeIsspace(GetChar(0u)))
1546        )
1547      )
1548   {
1549     if ( bFromRight )
1550     {
1551       // find last non-space character
1552       iterator psz = begin() + length() - 1;
1553       while ( wxSafeIsspace(*psz) && (psz >= begin()) )
1554         psz--;
1555
1556       // truncate at trailing space start
1557       *++psz = wxT('\0');
1558       erase(psz, end());
1559     }
1560     else
1561     {
1562       // find first non-space character
1563       iterator psz = begin();
1564       while ( wxSafeIsspace(*psz) )
1565         psz++;
1566
1567       // fix up data and length
1568       erase(begin(), psz);
1569     }
1570   }
1571
1572   return *this;
1573 }
1574
1575 // adds nCount characters chPad to the string from either side
1576 wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight)
1577 {
1578   wxString s(chPad, nCount);
1579
1580   if ( bFromRight )
1581     *this += s;
1582   else
1583   {
1584     s += *this;
1585     swap(s);
1586   }
1587
1588   return *this;
1589 }
1590
1591 // truncate the string
1592 wxString& wxString::Truncate(size_t uiLen)
1593 {
1594   if ( uiLen < Len() ) {
1595     erase(begin() + uiLen, end());
1596   }
1597   //else: nothing to do, string is already short enough
1598
1599   return *this;
1600 }
1601
1602 // ---------------------------------------------------------------------------
1603 // finding (return wxNOT_FOUND if not found and index otherwise)
1604 // ---------------------------------------------------------------------------
1605
1606 // find a character
1607 int wxString::Find(wxChar ch, bool bFromEnd) const
1608 {
1609   size_type idx = bFromEnd ? find_last_of(ch) : find_first_of(ch);
1610
1611   return (idx == npos) ? wxNOT_FOUND : (int)idx;
1612 }
1613
1614 // find a sub-string (like strstr)
1615 int wxString::Find(const wxChar *pszSub) const
1616 {
1617   size_type idx = find(pszSub);
1618
1619   return (idx == npos) ? wxNOT_FOUND : (int)idx;
1620 }
1621
1622 // ----------------------------------------------------------------------------
1623 // conversion to numbers
1624 // ----------------------------------------------------------------------------
1625
1626 bool wxString::ToLong(long *val, int base) const
1627 {
1628     wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToLong") );
1629     wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") );
1630
1631     const wxChar *start = c_str();
1632     wxChar *end;
1633     *val = wxStrtol(start, &end, base);
1634
1635     // return TRUE only if scan was stopped by the terminating NUL and if the
1636     // string was not empty to start with
1637     return !*end && (end != start);
1638 }
1639
1640 bool wxString::ToULong(unsigned long *val, int base) const
1641 {
1642     wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToULong") );
1643     wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") );
1644
1645     const wxChar *start = c_str();
1646     wxChar *end;
1647     *val = wxStrtoul(start, &end, base);
1648
1649     // return TRUE only if scan was stopped by the terminating NUL and if the
1650     // string was not empty to start with
1651     return !*end && (end != start);
1652 }
1653
1654 bool wxString::ToDouble(double *val) const
1655 {
1656     wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToDouble") );
1657
1658     const wxChar *start = c_str();
1659     wxChar *end;
1660     *val = wxStrtod(start, &end);
1661
1662     // return TRUE only if scan was stopped by the terminating NUL and if the
1663     // string was not empty to start with
1664     return !*end && (end != start);
1665 }
1666
1667 // ---------------------------------------------------------------------------
1668 // formatted output
1669 // ---------------------------------------------------------------------------
1670
1671 /* static */
1672 wxString wxString::Format(const wxChar *pszFormat, ...)
1673 {
1674     va_list argptr;
1675     va_start(argptr, pszFormat);
1676
1677     wxString s;
1678     s.PrintfV(pszFormat, argptr);
1679
1680     va_end(argptr);
1681
1682     return s;
1683 }
1684
1685 /* static */
1686 wxString wxString::FormatV(const wxChar *pszFormat, va_list argptr)
1687 {
1688     wxString s;
1689     s.PrintfV(pszFormat, argptr);
1690     return s;
1691 }
1692
1693 int wxString::Printf(const wxChar *pszFormat, ...)
1694 {
1695   va_list argptr;
1696   va_start(argptr, pszFormat);
1697
1698   int iLen = PrintfV(pszFormat, argptr);
1699
1700   va_end(argptr);
1701
1702   return iLen;
1703 }
1704
1705 int wxString::PrintfV(const wxChar* pszFormat, va_list argptr)
1706 {
1707     int size = 1024;
1708     int len;
1709
1710     for ( ;; )
1711     {
1712         {
1713             wxStringBuffer tmp(*this, size + 1);
1714             wxChar* buf = tmp;
1715
1716             if ( !buf )
1717             {
1718                 // out of memory
1719                 return -1;
1720             }
1721
1722             len = wxVsnprintf(buf, size, pszFormat, argptr);
1723
1724             // some implementations of vsnprintf() don't NUL terminate
1725             // the string if there is not enough space for it so
1726             // always do it manually
1727             buf[size] = _T('\0');
1728         }
1729
1730         // vsnprintf() may return either -1 (traditional Unix behaviour) or the
1731         // total number of characters which would have been written if the
1732         // buffer were large enough
1733         if ( len >= 0 && len <= size )
1734         {
1735             // ok, there was enough space
1736             break;
1737         }
1738
1739         // still not enough, double it again
1740         size *= 2;
1741     }
1742
1743     // we could have overshot
1744     Shrink();
1745
1746     return Len();
1747 }
1748
1749 // ----------------------------------------------------------------------------
1750 // misc other operations
1751 // ----------------------------------------------------------------------------
1752
1753 // returns TRUE if the string matches the pattern which may contain '*' and
1754 // '?' metacharacters (as usual, '?' matches any character and '*' any number
1755 // of them)
1756 bool wxString::Matches(const wxChar *pszMask) const
1757 {
1758     // I disable this code as it doesn't seem to be faster (in fact, it seems
1759     // to be much slower) than the old, hand-written code below and using it
1760     // here requires always linking with libregex even if the user code doesn't
1761     // use it
1762 #if 0 // wxUSE_REGEX
1763     // first translate the shell-like mask into a regex
1764     wxString pattern;
1765     pattern.reserve(wxStrlen(pszMask));
1766
1767     pattern += _T('^');
1768     while ( *pszMask )
1769     {
1770         switch ( *pszMask )
1771         {
1772             case _T('?'):
1773                 pattern += _T('.');
1774                 break;
1775
1776             case _T('*'):
1777                 pattern += _T(".*");
1778                 break;
1779
1780             case _T('^'):
1781             case _T('.'):
1782             case _T('$'):
1783             case _T('('):
1784             case _T(')'):
1785             case _T('|'):
1786             case _T('+'):
1787             case _T('\\'):
1788                 // these characters are special in a RE, quote them
1789                 // (however note that we don't quote '[' and ']' to allow
1790                 // using them for Unix shell like matching)
1791                 pattern += _T('\\');
1792                 // fall through
1793
1794             default:
1795                 pattern += *pszMask;
1796         }
1797
1798         pszMask++;
1799     }
1800     pattern += _T('$');
1801
1802     // and now use it
1803     return wxRegEx(pattern, wxRE_NOSUB | wxRE_EXTENDED).Matches(c_str());
1804 #else // !wxUSE_REGEX
1805   // TODO: this is, of course, awfully inefficient...
1806
1807   // the char currently being checked
1808   const wxChar *pszTxt = c_str();
1809
1810   // the last location where '*' matched
1811   const wxChar *pszLastStarInText = NULL;
1812   const wxChar *pszLastStarInMask = NULL;
1813
1814 match:
1815   for ( ; *pszMask != wxT('\0'); pszMask++, pszTxt++ ) {
1816     switch ( *pszMask ) {
1817       case wxT('?'):
1818         if ( *pszTxt == wxT('\0') )
1819           return FALSE;
1820
1821         // pszTxt and pszMask will be incremented in the loop statement
1822
1823         break;
1824
1825       case wxT('*'):
1826         {
1827           // remember where we started to be able to backtrack later
1828           pszLastStarInText = pszTxt;
1829           pszLastStarInMask = pszMask;
1830
1831           // ignore special chars immediately following this one
1832           // (should this be an error?)
1833           while ( *pszMask == wxT('*') || *pszMask == wxT('?') )
1834             pszMask++;
1835
1836           // if there is nothing more, match
1837           if ( *pszMask == wxT('\0') )
1838             return TRUE;
1839
1840           // are there any other metacharacters in the mask?
1841           size_t uiLenMask;
1842           const wxChar *pEndMask = wxStrpbrk(pszMask, wxT("*?"));
1843
1844           if ( pEndMask != NULL ) {
1845             // we have to match the string between two metachars
1846             uiLenMask = pEndMask - pszMask;
1847           }
1848           else {
1849             // we have to match the remainder of the string
1850             uiLenMask = wxStrlen(pszMask);
1851           }
1852
1853           wxString strToMatch(pszMask, uiLenMask);
1854           const wxChar* pMatch = wxStrstr(pszTxt, strToMatch);
1855           if ( pMatch == NULL )
1856             return FALSE;
1857
1858           // -1 to compensate "++" in the loop
1859           pszTxt = pMatch + uiLenMask - 1;
1860           pszMask += uiLenMask - 1;
1861         }
1862         break;
1863
1864       default:
1865         if ( *pszMask != *pszTxt )
1866           return FALSE;
1867         break;
1868     }
1869   }
1870
1871   // match only if nothing left
1872   if ( *pszTxt == wxT('\0') )
1873     return TRUE;
1874
1875   // if we failed to match, backtrack if we can
1876   if ( pszLastStarInText ) {
1877     pszTxt = pszLastStarInText + 1;
1878     pszMask = pszLastStarInMask;
1879
1880     pszLastStarInText = NULL;
1881
1882     // don't bother resetting pszLastStarInMask, it's unnecessary
1883
1884     goto match;
1885   }
1886
1887   return FALSE;
1888 #endif // wxUSE_REGEX/!wxUSE_REGEX
1889 }
1890
1891 // Count the number of chars
1892 int wxString::Freq(wxChar ch) const
1893 {
1894     int count = 0;
1895     int len = Len();
1896     for (int i = 0; i < len; i++)
1897     {
1898         if (GetChar(i) == ch)
1899             count ++;
1900     }
1901     return count;
1902 }
1903
1904 // convert to upper case, return the copy of the string
1905 wxString wxString::Upper() const
1906 { wxString s(*this); return s.MakeUpper(); }
1907
1908 // convert to lower case, return the copy of the string
1909 wxString wxString::Lower() const { wxString s(*this); return s.MakeLower(); }
1910
1911 int wxString::sprintf(const wxChar *pszFormat, ...)
1912   {
1913     va_list argptr;
1914     va_start(argptr, pszFormat);
1915     int iLen = PrintfV(pszFormat, argptr);
1916     va_end(argptr);
1917     return iLen;
1918   }
1919
1920 // ============================================================================
1921 // ArrayString
1922 // ============================================================================
1923
1924 #include "wx/arrstr.h"
1925
1926 #if !wxUSE_STL
1927
1928 // size increment = min(50% of current size, ARRAY_MAXSIZE_INCREMENT)
1929 #define   ARRAY_MAXSIZE_INCREMENT       4096
1930
1931 #ifndef   ARRAY_DEFAULT_INITIAL_SIZE    // also defined in dynarray.h
1932 #define   ARRAY_DEFAULT_INITIAL_SIZE    (16)
1933 #endif
1934
1935 #define   STRING(p)   ((wxString *)(&(p)))
1936
1937 // ctor
1938 void wxArrayString::Init(bool autoSort)
1939 {
1940   m_nSize  =
1941   m_nCount = 0;
1942   m_pItems = (wxChar **) NULL;
1943   m_autoSort = autoSort;
1944 }
1945
1946 // copy ctor
1947 wxArrayString::wxArrayString(const wxArrayString& src)
1948 {
1949   Init(src.m_autoSort);
1950
1951   *this = src;
1952 }
1953
1954 // assignment operator
1955 wxArrayString& wxArrayString::operator=(const wxArrayString& src)
1956 {
1957   if ( m_nSize > 0 )
1958     Clear();
1959
1960   Copy(src);
1961
1962   m_autoSort = src.m_autoSort;
1963
1964   return *this;
1965 }
1966
1967 void wxArrayString::Copy(const wxArrayString& src)
1968 {
1969   if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE )
1970     Alloc(src.m_nCount);
1971
1972   for ( size_t n = 0; n < src.m_nCount; n++ )
1973     Add(src[n]);
1974 }
1975
1976 // grow the array
1977 void wxArrayString::Grow(size_t nIncrement)
1978 {
1979   // only do it if no more place
1980   if ( (m_nSize - m_nCount) < nIncrement ) {
1981     // if ARRAY_DEFAULT_INITIAL_SIZE were set to 0, the initially empty would
1982     // be never resized!
1983     #if ARRAY_DEFAULT_INITIAL_SIZE == 0
1984       #error "ARRAY_DEFAULT_INITIAL_SIZE must be > 0!"
1985     #endif
1986
1987     if ( m_nSize == 0 ) {
1988       // was empty, alloc some memory
1989       m_nSize = ARRAY_DEFAULT_INITIAL_SIZE;
1990       if (m_nSize < nIncrement)
1991           m_nSize = nIncrement;
1992       m_pItems = new wxChar *[m_nSize];
1993     }
1994     else {
1995       // otherwise when it's called for the first time, nIncrement would be 0
1996       // and the array would never be expanded
1997       // add 50% but not too much
1998       size_t ndefIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE
1999                           ? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1;
2000       if ( ndefIncrement > ARRAY_MAXSIZE_INCREMENT )
2001         ndefIncrement = ARRAY_MAXSIZE_INCREMENT;
2002       if ( nIncrement < ndefIncrement )
2003         nIncrement = ndefIncrement;
2004       m_nSize += nIncrement;
2005       wxChar **pNew = new wxChar *[m_nSize];
2006
2007       // copy data to new location
2008       memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
2009
2010       // delete old memory (but do not release the strings!)
2011       wxDELETEA(m_pItems);
2012
2013       m_pItems = pNew;
2014     }
2015   }
2016 }
2017
2018 void wxArrayString::Free()
2019 {
2020   for ( size_t n = 0; n < m_nCount; n++ ) {
2021     STRING(m_pItems[n])->GetStringData()->Unlock();
2022   }
2023 }
2024
2025 // deletes all the strings from the list
2026 void wxArrayString::Empty()
2027 {
2028   Free();
2029
2030   m_nCount = 0;
2031 }
2032
2033 // as Empty, but also frees memory
2034 void wxArrayString::Clear()
2035 {
2036   Free();
2037
2038   m_nSize  =
2039   m_nCount = 0;
2040
2041   wxDELETEA(m_pItems);
2042 }
2043
2044 // dtor
2045 wxArrayString::~wxArrayString()
2046 {
2047   Free();
2048
2049   wxDELETEA(m_pItems);
2050 }
2051
2052 void wxArrayString::reserve(size_t nSize)
2053 {
2054     Alloc(nSize);
2055 }
2056
2057 // pre-allocates memory (frees the previous data!)
2058 void wxArrayString::Alloc(size_t nSize)
2059 {
2060   // only if old buffer was not big enough
2061   if ( nSize > m_nSize ) {
2062     Free();
2063     wxDELETEA(m_pItems);
2064     m_pItems = new wxChar *[nSize];
2065     m_nSize  = nSize;
2066   }
2067
2068   m_nCount = 0;
2069 }
2070
2071 // minimizes the memory usage by freeing unused memory
2072 void wxArrayString::Shrink()
2073 {
2074   // only do it if we have some memory to free
2075   if( m_nCount < m_nSize ) {
2076     // allocates exactly as much memory as we need
2077     wxChar **pNew = new wxChar *[m_nCount];
2078
2079     // copy data to new location
2080     memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
2081     delete [] m_pItems;
2082     m_pItems = pNew;
2083   }
2084 }
2085
2086 #if WXWIN_COMPATIBILITY_2_4
2087
2088 // return a wxString[] as required for some control ctors.
2089 wxString* wxArrayString::GetStringArray() const
2090 {
2091     wxString *array = 0;
2092
2093     if( m_nCount > 0 )
2094     {
2095         array = new wxString[m_nCount];
2096         for( size_t i = 0; i < m_nCount; i++ )
2097             array[i] = m_pItems[i];
2098     }
2099
2100     return array;
2101 }
2102
2103 #endif // WXWIN_COMPATIBILITY_2_4
2104
2105 // searches the array for an item (forward or backwards)
2106 int wxArrayString::Index(const wxChar *sz, bool bCase, bool bFromEnd) const
2107 {
2108   if ( m_autoSort ) {
2109     // use binary search in the sorted array
2110     wxASSERT_MSG( bCase && !bFromEnd,
2111                   wxT("search parameters ignored for auto sorted array") );
2112
2113     size_t i,
2114            lo = 0,
2115            hi = m_nCount;
2116     int res;
2117     while ( lo < hi ) {
2118       i = (lo + hi)/2;
2119
2120       res = wxStrcmp(sz, m_pItems[i]);
2121       if ( res < 0 )
2122         hi = i;
2123       else if ( res > 0 )
2124         lo = i + 1;
2125       else
2126         return i;
2127     }
2128
2129     return wxNOT_FOUND;
2130   }
2131   else {
2132     // use linear search in unsorted array
2133     if ( bFromEnd ) {
2134       if ( m_nCount > 0 ) {
2135         size_t ui = m_nCount;
2136         do {
2137           if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) )
2138             return ui;
2139         }
2140         while ( ui != 0 );
2141       }
2142     }
2143     else {
2144       for( size_t ui = 0; ui < m_nCount; ui++ ) {
2145         if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) )
2146           return ui;
2147       }
2148     }
2149   }
2150
2151   return wxNOT_FOUND;
2152 }
2153
2154 // add item at the end
2155 size_t wxArrayString::Add(const wxString& str, size_t nInsert)
2156 {
2157   if ( m_autoSort ) {
2158     // insert the string at the correct position to keep the array sorted
2159     size_t i,
2160            lo = 0,
2161            hi = m_nCount;
2162     int res;
2163     while ( lo < hi ) {
2164       i = (lo + hi)/2;
2165
2166       res = wxStrcmp(str, m_pItems[i]);
2167       if ( res < 0 )
2168         hi = i;
2169       else if ( res > 0 )
2170         lo = i + 1;
2171       else {
2172         lo = hi = i;
2173         break;
2174       }
2175     }
2176
2177     wxASSERT_MSG( lo == hi, wxT("binary search broken") );
2178
2179     Insert(str, lo, nInsert);
2180
2181     return (size_t)lo;
2182   }
2183   else {
2184     wxASSERT( str.GetStringData()->IsValid() );
2185
2186     Grow(nInsert);
2187
2188     for (size_t i = 0; i < nInsert; i++)
2189     {
2190         // the string data must not be deleted!
2191         str.GetStringData()->Lock();
2192
2193         // just append
2194         m_pItems[m_nCount + i] = (wxChar *)str.c_str(); // const_cast
2195     }
2196     size_t ret = m_nCount;
2197     m_nCount += nInsert;
2198     return ret;
2199   }
2200 }
2201
2202 // add item at the given position
2203 void wxArrayString::Insert(const wxString& str, size_t nIndex, size_t nInsert)
2204 {
2205   wxASSERT( str.GetStringData()->IsValid() );
2206
2207   wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArrayString::Insert") );
2208   wxCHECK_RET( m_nCount <= m_nCount + nInsert,
2209                wxT("array size overflow in wxArrayString::Insert") );
2210
2211   Grow(nInsert);
2212
2213   memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex],
2214           (m_nCount - nIndex)*sizeof(wxChar *));
2215
2216   for (size_t i = 0; i < nInsert; i++)
2217   {
2218       str.GetStringData()->Lock();
2219       m_pItems[nIndex + i] = (wxChar *)str.c_str();
2220   }
2221   m_nCount += nInsert;
2222 }
2223
2224 // range insert (STL 23.2.4.3)
2225 void
2226 wxArrayString::insert(iterator it, const_iterator first, const_iterator last)
2227 {
2228     const int idx = it - begin();
2229
2230     // grow it once
2231     Grow(last - first);
2232
2233     // reset "it" since it can change inside Grow()
2234     it = begin() + idx;
2235
2236     while ( first != last )
2237     {
2238         it = insert(it, *first);
2239
2240         // insert returns an iterator to the last element inserted but we need
2241         // insert the next after this one, that is before the next one
2242         ++it;
2243
2244         ++first;
2245     }
2246 }
2247
2248 // expand the array
2249 void wxArrayString::SetCount(size_t count)
2250 {
2251     Alloc(count);
2252
2253     wxString s;
2254     while ( m_nCount < count )
2255         m_pItems[m_nCount++] = (wxChar *)s.c_str();
2256 }
2257
2258 // removes item from array (by index)
2259 void wxArrayString::RemoveAt(size_t nIndex, size_t nRemove)
2260 {
2261   wxCHECK_RET( nIndex < m_nCount, wxT("bad index in wxArrayString::Remove") );
2262   wxCHECK_RET( nIndex + nRemove <= m_nCount,
2263                wxT("removing too many elements in wxArrayString::Remove") );
2264
2265   // release our lock
2266   for (size_t i = 0; i < nRemove; i++)
2267       Item(nIndex + i).GetStringData()->Unlock();
2268
2269   memmove(&m_pItems[nIndex], &m_pItems[nIndex + nRemove],
2270           (m_nCount - nIndex - nRemove)*sizeof(wxChar *));
2271   m_nCount -= nRemove;
2272 }
2273
2274 // removes item from array (by value)
2275 void wxArrayString::Remove(const wxChar *sz)
2276 {
2277   int iIndex = Index(sz);
2278
2279   wxCHECK_RET( iIndex != wxNOT_FOUND,
2280                wxT("removing inexistent element in wxArrayString::Remove") );
2281
2282   RemoveAt(iIndex);
2283 }
2284
2285 void wxArrayString::assign(const_iterator first, const_iterator last)
2286 {
2287     reserve(last - first);
2288     for(; first != last; ++first)
2289         push_back(*first);
2290 }
2291
2292 // ----------------------------------------------------------------------------
2293 // sorting
2294 // ----------------------------------------------------------------------------
2295
2296 // we can only sort one array at a time with the quick-sort based
2297 // implementation
2298 #if wxUSE_THREADS
2299   // need a critical section to protect access to gs_compareFunction and
2300   // gs_sortAscending variables
2301   static wxCriticalSection *gs_critsectStringSort = NULL;
2302
2303   // call this before the value of the global sort vars is changed/after
2304   // you're finished with them
2305   #define START_SORT()     wxASSERT( !gs_critsectStringSort );                \
2306                            gs_critsectStringSort = new wxCriticalSection;     \
2307                            gs_critsectStringSort->Enter()
2308   #define END_SORT()       gs_critsectStringSort->Leave();                    \
2309                            delete gs_critsectStringSort;                      \
2310                            gs_critsectStringSort = NULL
2311 #else // !threads
2312   #define START_SORT()
2313   #define END_SORT()
2314 #endif // wxUSE_THREADS
2315
2316 // function to use for string comparaison
2317 static wxArrayString::CompareFunction gs_compareFunction = NULL;
2318
2319 // if we don't use the compare function, this flag tells us if we sort the
2320 // array in ascending or descending order
2321 static bool gs_sortAscending = TRUE;
2322
2323 // function which is called by quick sort
2324 extern "C" int wxC_CALLING_CONV     // LINKAGEMODE
2325 wxStringCompareFunction(const void *first, const void *second)
2326 {
2327   wxString *strFirst = (wxString *)first;
2328   wxString *strSecond = (wxString *)second;
2329
2330   if ( gs_compareFunction ) {
2331     return gs_compareFunction(*strFirst, *strSecond);
2332   }
2333   else {
2334     // maybe we should use wxStrcoll
2335     int result = wxStrcmp(strFirst->c_str(), strSecond->c_str());
2336
2337     return gs_sortAscending ? result : -result;
2338   }
2339 }
2340
2341 // sort array elements using passed comparaison function
2342 void wxArrayString::Sort(CompareFunction compareFunction)
2343 {
2344   START_SORT();
2345
2346   wxASSERT( !gs_compareFunction );  // must have been reset to NULL
2347   gs_compareFunction = compareFunction;
2348
2349   DoSort();
2350
2351   // reset it to NULL so that Sort(bool) will work the next time
2352   gs_compareFunction = NULL;
2353
2354   END_SORT();
2355 }
2356
2357 typedef  int (wxC_CALLING_CONV * wxStringCompareFn)(const void *first, const void *second);
2358
2359 void wxArrayString::Sort(CompareFunction2 compareFunction)
2360 {
2361   qsort(m_pItems, m_nCount, sizeof(wxChar *), (wxStringCompareFn)compareFunction);
2362 }
2363
2364 void wxArrayString::Sort(bool reverseOrder)
2365 {
2366   Sort(reverseOrder ? wxStringSortDescending : wxStringSortAscending);
2367 }
2368
2369 void wxArrayString::DoSort()
2370 {
2371   wxCHECK_RET( !m_autoSort, wxT("can't use this method with sorted arrays") );
2372
2373   // just sort the pointers using qsort() - of course it only works because
2374   // wxString() *is* a pointer to its data
2375   qsort(m_pItems, m_nCount, sizeof(wxChar *), wxStringCompareFunction);
2376 }
2377
2378 bool wxArrayString::operator==(const wxArrayString& a) const
2379 {
2380     if ( m_nCount != a.m_nCount )
2381         return FALSE;
2382
2383     for ( size_t n = 0; n < m_nCount; n++ )
2384     {
2385         if ( Item(n) != a[n] )
2386             return FALSE;
2387     }
2388
2389     return TRUE;
2390 }
2391
2392 #endif // !wxUSE_STL
2393
2394 int wxCMPFUNC_CONV wxStringSortAscending(wxString* s1, wxString* s2)
2395 {
2396     return wxStrcmp(s1->c_str(), s2->c_str());
2397 }
2398
2399 int wxCMPFUNC_CONV wxStringSortDescending(wxString* s1, wxString* s2)
2400 {
2401     return -wxStrcmp(s1->c_str(), s2->c_str());
2402 }