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         wxASSERT( psz != NULL );
 972         wxCharBuffer tmp(nLength);
 973         memcpy(tmp.data(), psz, nLength);
 974         tmp.data()[nLength] = '\0';
 975         inBuf = tmp;
 976         psz = inBuf.data();
 977     }
 978
 979     // first get the size of the buffer we need
 980     size_t nLen;
 981     if ( psz )
 982     {
 983         // calculate the needed size ourselves or use the provided one
 984         nLen = conv.MB2WC(NULL, psz, 0);
 985     }
 986     else
 987     {
 988         // nothing to convert
 989         nLen = 0;
 990     }
 991
 992     // anything to do?
 993     if ( (nLen != 0) && (nLen != (size_t)-1) )
 994     {
 995         if ( !Alloc(nLen) )
 996         {
 997             wxFAIL_MSG( _T("out of memory in wxString::wxString") );
 998         }
 999         else
1000         {
1001             wxWCharBuffer buf(nLen);
1002             // MB2WC wants the buffer size, not the string length hence +1
1003             nLen = conv.MB2WC(buf.data(), psz, nLen + 1);
1004
1005             if ( nLen != (size_t)-1 )
1006             {
1007                 // initialized ok, set the real length as nLength specified by
1008                 // the caller could be greater than the real string length
1009                 assign(buf.data(), nLen);
1010                 return;
1011             }
1012             //else: the conversion failed -- leave the string empty (what else?)
1013         }
1014     }
1015 }
1016
1017 #else // ANSI
1018
1019 #if wxUSE_WCHAR_T
1020 // from wide string
1021 wxString::wxString(const wchar_t *pwz, wxMBConv& conv, size_t nLength)
1022 {
1023     // if nLength != npos, then we have to make a NULL-terminated copy
1024     // of first nLength chars of psz first because the input buffer to WC2MB
1025     // must always be NULL-terminated:
1026     wxWCharBuffer inBuf((const wchar_t *)NULL);
1027     if (nLength != npos)
1028     {
1029         wxASSERT( pwz != NULL );
1030         wxWCharBuffer tmp(nLength);
1031         memcpy(tmp.data(), pwz, nLength * sizeof(wchar_t));
1032         tmp.data()[nLength] = '\0';
1033         inBuf = tmp;
1034         pwz = inBuf.data();
1035     }
1036
1037     // first get the size of the buffer we need
1038     size_t nLen;
1039     if ( pwz )
1040     {
1041         // calculate the needed size ourselves or use the provided one
1042         nLen = conv.WC2MB(NULL, pwz, 0);
1043     }
1044     else
1045     {
1046         // nothing to convert
1047         nLen = 0;
1048     }
1049
1050     // anything to do?
1051     if ( (nLen != 0) && (nLen != (size_t)-1) )
1052     {
1053         if ( !Alloc(nLen) )
1054         {
1055             wxFAIL_MSG( _T("out of memory in wxString::wxString") );
1056         }
1057         else
1058         {
1059             wxCharBuffer buf(nLen);
1060             // WC2MB wants the buffer size, not the string length
1061             if ( conv.WC2MB(buf.data(), pwz, nLen + 1) != (size_t)-1 )
1062             {
1063                 // initialized ok
1064                 assign(buf.data(), nLen);
1065                 return;
1066             }
1067             //else: the conversion failed -- leave the string empty (what else?)
1068         }
1069     }
1070
1071     // leave empty
1072 }
1073 #endif // wxUSE_WCHAR_T
1074
1075 #endif // Unicode/ANSI
1076
1077 // shrink to minimal size (releasing extra memory)
1078 bool wxString::Shrink()
1079 {
1080   wxString tmp(begin(), end());
1081   swap(tmp);
1082   return tmp.length() == length();
1083 }
1084
1085 #if !wxUSE_STL
1086 // get the pointer to writable buffer of (at least) nLen bytes
1087 wxChar *wxString::GetWriteBuf(size_t nLen)
1088 {
1089   if ( !AllocBeforeWrite(nLen) ) {
1090     // allocation failure handled by caller
1091     return NULL;
1092   }
1093
1094   wxASSERT( GetStringData()->nRefs == 1 );
1095   GetStringData()->Validate(FALSE);
1096
1097   return m_pchData;
1098 }
1099
1100 // put string back in a reasonable state after GetWriteBuf
1101 void wxString::UngetWriteBuf()
1102 {
1103   GetStringData()->nDataLength = wxStrlen(m_pchData);
1104   GetStringData()->Validate(TRUE);
1105 }
1106
1107 void wxString::UngetWriteBuf(size_t nLen)
1108 {
1109   GetStringData()->nDataLength = nLen;
1110   GetStringData()->Validate(TRUE);
1111 }
1112 #endif
1113
1114 // ---------------------------------------------------------------------------
1115 // data access
1116 // ---------------------------------------------------------------------------
1117
1118 // all functions are inline in string.h
1119
1120 // ---------------------------------------------------------------------------
1121 // assignment operators
1122 // ---------------------------------------------------------------------------
1123
1124 #if !wxUSE_UNICODE
1125
1126 // same as 'signed char' variant
1127 wxString& wxString::operator=(const unsigned char* psz)
1128 {
1129   *this = (const char *)psz;
1130   return *this;
1131 }
1132
1133 #if wxUSE_WCHAR_T
1134 wxString& wxString::operator=(const wchar_t *pwz)
1135 {
1136   wxString str(pwz);
1137   swap(str);
1138   return *this;
1139 }
1140 #endif
1141
1142 #endif
1143
1144 /*
1145  * concatenation functions come in 5 flavours:
1146  *  string + string
1147  *  char   + string      and      string + char
1148  *  C str  + string      and      string + C str
1149  */
1150
1151 wxString operator+(const wxString& str1, const wxString& str2)
1152 {
1153 #if !wxUSE_STL
1154   wxASSERT( str1.GetStringData()->IsValid() );
1155   wxASSERT( str2.GetStringData()->IsValid() );
1156 #endif
1157
1158   wxString s = str1;
1159   s += str2;
1160
1161   return s;
1162 }
1163
1164 wxString operator+(const wxString& str, wxChar ch)
1165 {
1166 #if !wxUSE_STL
1167   wxASSERT( str.GetStringData()->IsValid() );
1168 #endif
1169
1170   wxString s = str;
1171   s += ch;
1172
1173   return s;
1174 }
1175
1176 wxString operator+(wxChar ch, const wxString& str)
1177 {
1178 #if !wxUSE_STL
1179   wxASSERT( str.GetStringData()->IsValid() );
1180 #endif
1181
1182   wxString s = ch;
1183   s += str;
1184
1185   return s;
1186 }
1187
1188 wxString operator+(const wxString& str, const wxChar *psz)
1189 {
1190 #if !wxUSE_STL
1191   wxASSERT( str.GetStringData()->IsValid() );
1192 #endif
1193
1194   wxString s;
1195   if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
1196     wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1197   }
1198   s = str;
1199   s += psz;
1200
1201   return s;
1202 }
1203
1204 wxString operator+(const wxChar *psz, const wxString& str)
1205 {
1206 #if !wxUSE_STL
1207   wxASSERT( str.GetStringData()->IsValid() );
1208 #endif
1209
1210   wxString s;
1211   if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
1212     wxFAIL_MSG( _T("out of memory in wxString::operator+") );
1213   }
1214   s = psz;
1215   s += str;
1216
1217   return s;
1218 }
1219
1220 // ===========================================================================
1221 // other common string functions
1222 // ===========================================================================
1223
1224 #if wxUSE_UNICODE
1225
1226 wxString wxString::FromAscii(const char *ascii)
1227 {
1228     if (!ascii)
1229        return wxEmptyString;
1230
1231     size_t len = strlen( ascii );
1232     wxString res;
1233
1234     if ( len )
1235     {
1236         wxStringBuffer buf(res, len);
1237
1238         wchar_t *dest = buf;
1239
1240         for ( ;; )
1241         {
1242            if ( (*dest++ = (wchar_t)(unsigned char)*ascii++) == L'\0' )
1243                break;
1244         }
1245     }
1246
1247     return res;
1248 }
1249
1250 wxString wxString::FromAscii(const char ascii)
1251 {
1252     // What do we do with '\0' ?
1253
1254     wxString res;
1255     res += (wchar_t)(unsigned char) ascii;
1256
1257     return res;
1258 }
1259
1260 const wxCharBuffer wxString::ToAscii() const
1261 {
1262     // this will allocate enough space for the terminating NUL too
1263     wxCharBuffer buffer(length());
1264
1265     signed char *dest = (signed char *)buffer.data();
1266
1267     const wchar_t *pwc = c_str();
1268     for ( ;; )
1269     {
1270         *dest++ = *pwc > SCHAR_MAX ? '_' : *pwc;
1271
1272         // the output string can't have embedded NULs anyhow, so we can safely
1273         // stop at first of them even if we do have any
1274         if ( !*pwc++ )
1275             break;
1276     }
1277
1278     return buffer;
1279 }
1280
1281 #endif // Unicode
1282
1283 // extract string of length nCount starting at nFirst
1284 wxString wxString::Mid(size_t nFirst, size_t nCount) const
1285 {
1286   size_t nLen = length();
1287
1288   // default value of nCount is npos and means "till the end"
1289   if ( nCount == npos )
1290   {
1291     nCount = nLen - nFirst;
1292   }
1293
1294   // out-of-bounds requests return sensible things
1295   if ( nFirst + nCount > nLen )
1296   {
1297     nCount = nLen - nFirst;
1298   }
1299
1300   if ( nFirst > nLen )
1301   {
1302     // AllocCopy() will return empty string
1303     nCount = 0;
1304   }
1305
1306   wxString dest(*this, nFirst, nCount);
1307   if ( dest.length() != nCount ) {
1308       wxFAIL_MSG( _T("out of memory in wxString::Mid") );
1309   }
1310
1311   return dest;
1312 }
1313
1314 // check that the string starts with prefix and return the rest of the string
1315 // in the provided pointer if it is not NULL, otherwise return FALSE
1316 bool wxString::StartsWith(const wxChar *prefix, wxString *rest) const
1317 {
1318     wxASSERT_MSG( prefix, _T("invalid parameter in wxString::StartsWith") );
1319
1320     // first check if the beginning of the string matches the prefix: note
1321     // that we don't have to check that we don't run out of this string as
1322     // when we reach the terminating NUL, either prefix string ends too (and
1323     // then it's ok) or we break out of the loop because there is no match
1324     const wxChar *p = c_str();
1325     while ( *prefix )
1326     {
1327         if ( *prefix++ != *p++ )
1328         {
1329             // no match
1330             return FALSE;
1331         }
1332     }
1333
1334     if ( rest )
1335     {
1336         // put the rest of the string into provided pointer
1337         *rest = p;
1338     }
1339
1340     return TRUE;
1341 }
1342
1343 // extract nCount last (rightmost) characters
1344 wxString wxString::Right(size_t nCount) const
1345 {
1346   if ( nCount > length() )
1347     nCount = length();
1348
1349   wxString dest(*this, length() - nCount, nCount);
1350   if ( dest.length() != nCount ) {
1351     wxFAIL_MSG( _T("out of memory in wxString::Right") );
1352   }
1353   return dest;
1354 }
1355
1356 // get all characters after the last occurence of ch
1357 // (returns the whole string if ch not found)
1358 wxString wxString::AfterLast(wxChar ch) const
1359 {
1360   wxString str;
1361   int iPos = Find(ch, TRUE);
1362   if ( iPos == wxNOT_FOUND )
1363     str = *this;
1364   else
1365     str = c_str() + iPos + 1;
1366
1367   return str;
1368 }
1369
1370 // extract nCount first (leftmost) characters
1371 wxString wxString::Left(size_t nCount) const
1372 {
1373   if ( nCount > length() )
1374     nCount = length();
1375
1376   wxString dest(*this, 0, nCount);
1377   if ( dest.length() != nCount ) {
1378     wxFAIL_MSG( _T("out of memory in wxString::Left") );
1379   }
1380   return dest;
1381 }
1382
1383 // get all characters before the first occurence of ch
1384 // (returns the whole string if ch not found)
1385 wxString wxString::BeforeFirst(wxChar ch) const
1386 {
1387   int iPos = Find(ch);
1388   if ( iPos == wxNOT_FOUND ) iPos = length();
1389   return wxString(*this, 0, iPos);
1390 }
1391
1392 /// get all characters before the last occurence of ch
1393 /// (returns empty string if ch not found)
1394 wxString wxString::BeforeLast(wxChar ch) const
1395 {
1396   wxString str;
1397   int iPos = Find(ch, TRUE);
1398   if ( iPos != wxNOT_FOUND && iPos != 0 )
1399     str = wxString(c_str(), iPos);
1400
1401   return str;
1402 }
1403
1404 /// get all characters after the first occurence of ch
1405 /// (returns empty string if ch not found)
1406 wxString wxString::AfterFirst(wxChar ch) const
1407 {
1408   wxString str;
1409   int iPos = Find(ch);
1410   if ( iPos != wxNOT_FOUND )
1411     str = c_str() + iPos + 1;
1412
1413   return str;
1414 }
1415
1416 // replace first (or all) occurences of some substring with another one
1417 size_t
1418 wxString::Replace(const wxChar *szOld, const wxChar *szNew, bool bReplaceAll)
1419 {
1420     // if we tried to replace an empty string we'd enter an infinite loop below
1421     wxCHECK_MSG( szOld && *szOld && szNew, 0,
1422                  _T("wxString::Replace(): invalid parameter") );
1423
1424   size_t uiCount = 0;   // count of replacements made
1425
1426   size_t uiOldLen = wxStrlen(szOld);
1427
1428   wxString strTemp;
1429   const wxChar *pCurrent = c_str();
1430   const wxChar *pSubstr;
1431   while ( *pCurrent != wxT('\0') ) {
1432     pSubstr = wxStrstr(pCurrent, szOld);
1433     if ( pSubstr == NULL ) {
1434       // strTemp is unused if no replacements were made, so avoid the copy
1435       if ( uiCount == 0 )
1436         return 0;
1437
1438       strTemp += pCurrent;    // copy the rest
1439       break;                  // exit the loop
1440     }
1441     else {
1442       // take chars before match
1443       size_type len = strTemp.length();
1444       strTemp.append(pCurrent, pSubstr - pCurrent);
1445       if ( strTemp.length() != (size_t)(len + pSubstr - pCurrent) ) {
1446         wxFAIL_MSG( _T("out of memory in wxString::Replace") );
1447         return 0;
1448       }
1449       strTemp += szNew;
1450       pCurrent = pSubstr + uiOldLen;  // restart after match
1451
1452       uiCount++;
1453
1454       // stop now?
1455       if ( !bReplaceAll ) {
1456         strTemp += pCurrent;    // copy the rest
1457         break;                  // exit the loop
1458       }
1459     }
1460   }
1461
1462   // only done if there were replacements, otherwise would have returned above
1463   swap(strTemp);
1464
1465   return uiCount;
1466 }
1467
1468 bool wxString::IsAscii() const
1469 {
1470   const wxChar *s = (const wxChar*) *this;
1471   while(*s){
1472     if(!isascii(*s)) return(FALSE);
1473     s++;
1474   }
1475   return(TRUE);
1476 }
1477
1478 bool wxString::IsWord() const
1479 {
1480   const wxChar *s = (const wxChar*) *this;
1481   while(*s){
1482     if(!wxIsalpha(*s)) return(FALSE);
1483     s++;
1484   }
1485   return(TRUE);
1486 }
1487
1488 bool wxString::IsNumber() const
1489 {
1490   const wxChar *s = (const wxChar*) *this;
1491   if (wxStrlen(s))
1492      if ((s[0] == '-') || (s[0] == '+')) s++;
1493   while(*s){
1494     if(!wxIsdigit(*s)) return(FALSE);
1495     s++;
1496   }
1497   return(TRUE);
1498 }
1499
1500 wxString wxString::Strip(stripType w) const
1501 {
1502     wxString s = *this;
1503     if ( w & leading ) s.Trim(FALSE);
1504     if ( w & trailing ) s.Trim(TRUE);
1505     return s;
1506 }
1507
1508 // ---------------------------------------------------------------------------
1509 // case conversion
1510 // ---------------------------------------------------------------------------
1511
1512 wxString& wxString::MakeUpper()
1513 {
1514   for ( iterator it = begin(), en = end(); it != en; ++it )
1515     *it = (wxChar)wxToupper(*it);
1516
1517   return *this;
1518 }
1519
1520 wxString& wxString::MakeLower()
1521 {
1522   for ( iterator it = begin(), en = end(); it != en; ++it )
1523     *it = (wxChar)wxTolower(*it);
1524
1525   return *this;
1526 }
1527
1528 // ---------------------------------------------------------------------------
1529 // trimming and padding
1530 // ---------------------------------------------------------------------------
1531
1532 // some compilers (VC++ 6.0 not to name them) return TRUE for a call to
1533 // isspace('ê') in the C locale which seems to be broken to me, but we have to
1534 // live with this by checking that the character is a 7 bit one - even if this
1535 // may fail to detect some spaces (I don't know if Unicode doesn't have
1536 // space-like symbols somewhere except in the first 128 chars), it is arguably
1537 // still better than trimming away accented letters
1538 inline int wxSafeIsspace(wxChar ch) { return (ch < 127) && wxIsspace(ch); }
1539
1540 // trims spaces (in the sense of isspace) from left or right side
1541 wxString& wxString::Trim(bool bFromRight)
1542 {
1543   // first check if we're going to modify the string at all
1544   if ( !IsEmpty() &&
1545        (
1546         (bFromRight && wxSafeIsspace(GetChar(Len() - 1))) ||
1547         (!bFromRight && wxSafeIsspace(GetChar(0u)))
1548        )
1549      )
1550   {
1551     if ( bFromRight )
1552     {
1553       // find last non-space character
1554       iterator psz = begin() + length() - 1;
1555       while ( wxSafeIsspace(*psz) && (psz >= begin()) )
1556         psz--;
1557
1558       // truncate at trailing space start
1559       *++psz = wxT('\0');
1560       erase(psz, end());
1561     }
1562     else
1563     {
1564       // find first non-space character
1565       iterator psz = begin();
1566       while ( wxSafeIsspace(*psz) )
1567         psz++;
1568
1569       // fix up data and length
1570       erase(begin(), psz);
1571     }
1572   }
1573
1574   return *this;
1575 }
1576
1577 // adds nCount characters chPad to the string from either side
1578 wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight)
1579 {
1580   wxString s(chPad, nCount);
1581
1582   if ( bFromRight )
1583     *this += s;
1584   else
1585   {
1586     s += *this;
1587     swap(s);
1588   }
1589
1590   return *this;
1591 }
1592
1593 // truncate the string
1594 wxString& wxString::Truncate(size_t uiLen)
1595 {
1596   if ( uiLen < Len() ) {
1597     erase(begin() + uiLen, end());
1598   }
1599   //else: nothing to do, string is already short enough
1600
1601   return *this;
1602 }
1603
1604 // ---------------------------------------------------------------------------
1605 // finding (return wxNOT_FOUND if not found and index otherwise)
1606 // ---------------------------------------------------------------------------
1607
1608 // find a character
1609 int wxString::Find(wxChar ch, bool bFromEnd) const
1610 {
1611   size_type idx = bFromEnd ? find_last_of(ch) : find_first_of(ch);
1612
1613   return (idx == npos) ? wxNOT_FOUND : (int)idx;
1614 }
1615
1616 // find a sub-string (like strstr)
1617 int wxString::Find(const wxChar *pszSub) const
1618 {
1619   size_type idx = find(pszSub);
1620
1621   return (idx == npos) ? wxNOT_FOUND : (int)idx;
1622 }
1623
1624 // ----------------------------------------------------------------------------
1625 // conversion to numbers
1626 // ----------------------------------------------------------------------------
1627
1628 bool wxString::ToLong(long *val, int base) const
1629 {
1630     wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToLong") );
1631     wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") );
1632
1633     const wxChar *start = c_str();
1634     wxChar *end;
1635     *val = wxStrtol(start, &end, base);
1636
1637     // return TRUE only if scan was stopped by the terminating NUL and if the
1638     // string was not empty to start with
1639     return !*end && (end != start);
1640 }
1641
1642 bool wxString::ToULong(unsigned long *val, int base) const
1643 {
1644     wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToULong") );
1645     wxASSERT_MSG( !base || (base > 1 && base <= 36), _T("invalid base") );
1646
1647     const wxChar *start = c_str();
1648     wxChar *end;
1649     *val = wxStrtoul(start, &end, base);
1650
1651     // return TRUE only if scan was stopped by the terminating NUL and if the
1652     // string was not empty to start with
1653     return !*end && (end != start);
1654 }
1655
1656 bool wxString::ToDouble(double *val) const
1657 {
1658     wxCHECK_MSG( val, FALSE, _T("NULL pointer in wxString::ToDouble") );
1659
1660     const wxChar *start = c_str();
1661     wxChar *end;
1662     *val = wxStrtod(start, &end);
1663
1664     // return TRUE only if scan was stopped by the terminating NUL and if the
1665     // string was not empty to start with
1666     return !*end && (end != start);
1667 }
1668
1669 // ---------------------------------------------------------------------------
1670 // formatted output
1671 // ---------------------------------------------------------------------------
1672
1673 /* static */
1674 wxString wxString::Format(const wxChar *pszFormat, ...)
1675 {
1676     va_list argptr;
1677     va_start(argptr, pszFormat);
1678
1679     wxString s;
1680     s.PrintfV(pszFormat, argptr);
1681
1682     va_end(argptr);
1683
1684     return s;
1685 }
1686
1687 /* static */
1688 wxString wxString::FormatV(const wxChar *pszFormat, va_list argptr)
1689 {
1690     wxString s;
1691     s.PrintfV(pszFormat, argptr);
1692     return s;
1693 }
1694
1695 int wxString::Printf(const wxChar *pszFormat, ...)
1696 {
1697   va_list argptr;
1698   va_start(argptr, pszFormat);
1699
1700   int iLen = PrintfV(pszFormat, argptr);
1701
1702   va_end(argptr);
1703
1704   return iLen;
1705 }
1706
1707 int wxString::PrintfV(const wxChar* pszFormat, va_list argptr)
1708 {
1709     int size = 1024;
1710     int len;
1711
1712     for ( ;; )
1713     {
1714         {
1715             wxStringBuffer tmp(*this, size + 1);
1716             wxChar* buf = tmp;
1717
1718             if ( !buf )
1719             {
1720                 // out of memory
1721                 return -1;
1722             }
1723
1724             len = wxVsnprintf(buf, size, pszFormat, argptr);
1725
1726             // some implementations of vsnprintf() don't NUL terminate
1727             // the string if there is not enough space for it so
1728             // always do it manually
1729             buf[size] = _T('\0');
1730         }
1731
1732         // vsnprintf() may return either -1 (traditional Unix behaviour) or the
1733         // total number of characters which would have been written if the
1734         // buffer were large enough
1735         if ( len >= 0 && len <= size )
1736         {
1737             // ok, there was enough space
1738             break;
1739         }
1740
1741         // still not enough, double it again
1742         size *= 2;
1743     }
1744
1745     // we could have overshot
1746     Shrink();
1747
1748     return Len();
1749 }
1750
1751 // ----------------------------------------------------------------------------
1752 // misc other operations
1753 // ----------------------------------------------------------------------------
1754
1755 // returns TRUE if the string matches the pattern which may contain '*' and
1756 // '?' metacharacters (as usual, '?' matches any character and '*' any number
1757 // of them)
1758 bool wxString::Matches(const wxChar *pszMask) const
1759 {
1760     // I disable this code as it doesn't seem to be faster (in fact, it seems
1761     // to be much slower) than the old, hand-written code below and using it
1762     // here requires always linking with libregex even if the user code doesn't
1763     // use it
1764 #if 0 // wxUSE_REGEX
1765     // first translate the shell-like mask into a regex
1766     wxString pattern;
1767     pattern.reserve(wxStrlen(pszMask));
1768
1769     pattern += _T('^');
1770     while ( *pszMask )
1771     {
1772         switch ( *pszMask )
1773         {
1774             case _T('?'):
1775                 pattern += _T('.');
1776                 break;
1777
1778             case _T('*'):
1779                 pattern += _T(".*");
1780                 break;
1781
1782             case _T('^'):
1783             case _T('.'):
1784             case _T('$'):
1785             case _T('('):
1786             case _T(')'):
1787             case _T('|'):
1788             case _T('+'):
1789             case _T('\\'):
1790                 // these characters are special in a RE, quote them
1791                 // (however note that we don't quote '[' and ']' to allow
1792                 // using them for Unix shell like matching)
1793                 pattern += _T('\\');
1794                 // fall through
1795
1796             default:
1797                 pattern += *pszMask;
1798         }
1799
1800         pszMask++;
1801     }
1802     pattern += _T('$');
1803
1804     // and now use it
1805     return wxRegEx(pattern, wxRE_NOSUB | wxRE_EXTENDED).Matches(c_str());
1806 #else // !wxUSE_REGEX
1807   // TODO: this is, of course, awfully inefficient...
1808
1809   // the char currently being checked
1810   const wxChar *pszTxt = c_str();
1811
1812   // the last location where '*' matched
1813   const wxChar *pszLastStarInText = NULL;
1814   const wxChar *pszLastStarInMask = NULL;
1815
1816 match:
1817   for ( ; *pszMask != wxT('\0'); pszMask++, pszTxt++ ) {
1818     switch ( *pszMask ) {
1819       case wxT('?'):
1820         if ( *pszTxt == wxT('\0') )
1821           return FALSE;
1822
1823         // pszTxt and pszMask will be incremented in the loop statement
1824
1825         break;
1826
1827       case wxT('*'):
1828         {
1829           // remember where we started to be able to backtrack later
1830           pszLastStarInText = pszTxt;
1831           pszLastStarInMask = pszMask;
1832
1833           // ignore special chars immediately following this one
1834           // (should this be an error?)
1835           while ( *pszMask == wxT('*') || *pszMask == wxT('?') )
1836             pszMask++;
1837
1838           // if there is nothing more, match
1839           if ( *pszMask == wxT('\0') )
1840             return TRUE;
1841
1842           // are there any other metacharacters in the mask?
1843           size_t uiLenMask;
1844           const wxChar *pEndMask = wxStrpbrk(pszMask, wxT("*?"));
1845
1846           if ( pEndMask != NULL ) {
1847             // we have to match the string between two metachars
1848             uiLenMask = pEndMask - pszMask;
1849           }
1850           else {
1851             // we have to match the remainder of the string
1852             uiLenMask = wxStrlen(pszMask);
1853           }
1854
1855           wxString strToMatch(pszMask, uiLenMask);
1856           const wxChar* pMatch = wxStrstr(pszTxt, strToMatch);
1857           if ( pMatch == NULL )
1858             return FALSE;
1859
1860           // -1 to compensate "++" in the loop
1861           pszTxt = pMatch + uiLenMask - 1;
1862           pszMask += uiLenMask - 1;
1863         }
1864         break;
1865
1866       default:
1867         if ( *pszMask != *pszTxt )
1868           return FALSE;
1869         break;
1870     }
1871   }
1872
1873   // match only if nothing left
1874   if ( *pszTxt == wxT('\0') )
1875     return TRUE;
1876
1877   // if we failed to match, backtrack if we can
1878   if ( pszLastStarInText ) {
1879     pszTxt = pszLastStarInText + 1;
1880     pszMask = pszLastStarInMask;
1881
1882     pszLastStarInText = NULL;
1883
1884     // don't bother resetting pszLastStarInMask, it's unnecessary
1885
1886     goto match;
1887   }
1888
1889   return FALSE;
1890 #endif // wxUSE_REGEX/!wxUSE_REGEX
1891 }
1892
1893 // Count the number of chars
1894 int wxString::Freq(wxChar ch) const
1895 {
1896     int count = 0;
1897     int len = Len();
1898     for (int i = 0; i < len; i++)
1899     {
1900         if (GetChar(i) == ch)
1901             count ++;
1902     }
1903     return count;
1904 }
1905
1906 // convert to upper case, return the copy of the string
1907 wxString wxString::Upper() const
1908 { wxString s(*this); return s.MakeUpper(); }
1909
1910 // convert to lower case, return the copy of the string
1911 wxString wxString::Lower() const { wxString s(*this); return s.MakeLower(); }
1912
1913 int wxString::sprintf(const wxChar *pszFormat, ...)
1914   {
1915     va_list argptr;
1916     va_start(argptr, pszFormat);
1917     int iLen = PrintfV(pszFormat, argptr);
1918     va_end(argptr);
1919     return iLen;
1920   }
1921
1922 // ============================================================================
1923 // ArrayString
1924 // ============================================================================
1925
1926 #include "wx/arrstr.h"
1927
1928 #if !wxUSE_STL
1929
1930 // size increment = min(50% of current size, ARRAY_MAXSIZE_INCREMENT)
1931 #define   ARRAY_MAXSIZE_INCREMENT       4096
1932
1933 #ifndef   ARRAY_DEFAULT_INITIAL_SIZE    // also defined in dynarray.h
1934 #define   ARRAY_DEFAULT_INITIAL_SIZE    (16)
1935 #endif
1936
1937 #define   STRING(p)   ((wxString *)(&(p)))
1938
1939 // ctor
1940 void wxArrayString::Init(bool autoSort)
1941 {
1942   m_nSize  =
1943   m_nCount = 0;
1944   m_pItems = (wxChar **) NULL;
1945   m_autoSort = autoSort;
1946 }
1947
1948 // copy ctor
1949 wxArrayString::wxArrayString(const wxArrayString& src)
1950 {
1951   Init(src.m_autoSort);
1952
1953   *this = src;
1954 }
1955
1956 // assignment operator
1957 wxArrayString& wxArrayString::operator=(const wxArrayString& src)
1958 {
1959   if ( m_nSize > 0 )
1960     Clear();
1961
1962   Copy(src);
1963
1964   m_autoSort = src.m_autoSort;
1965
1966   return *this;
1967 }
1968
1969 void wxArrayString::Copy(const wxArrayString& src)
1970 {
1971   if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE )
1972     Alloc(src.m_nCount);
1973
1974   for ( size_t n = 0; n < src.m_nCount; n++ )
1975     Add(src[n]);
1976 }
1977
1978 // grow the array
1979 void wxArrayString::Grow(size_t nIncrement)
1980 {
1981   // only do it if no more place
1982   if ( (m_nSize - m_nCount) < nIncrement ) {
1983     // if ARRAY_DEFAULT_INITIAL_SIZE were set to 0, the initially empty would
1984     // be never resized!
1985     #if ARRAY_DEFAULT_INITIAL_SIZE == 0
1986       #error "ARRAY_DEFAULT_INITIAL_SIZE must be > 0!"
1987     #endif
1988
1989     if ( m_nSize == 0 ) {
1990       // was empty, alloc some memory
1991       m_nSize = ARRAY_DEFAULT_INITIAL_SIZE;
1992       if (m_nSize < nIncrement)
1993           m_nSize = nIncrement;
1994       m_pItems = new wxChar *[m_nSize];
1995     }
1996     else {
1997       // otherwise when it's called for the first time, nIncrement would be 0
1998       // and the array would never be expanded
1999       // add 50% but not too much
2000       size_t ndefIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE
2001                           ? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1;
2002       if ( ndefIncrement > ARRAY_MAXSIZE_INCREMENT )
2003         ndefIncrement = ARRAY_MAXSIZE_INCREMENT;
2004       if ( nIncrement < ndefIncrement )
2005         nIncrement = ndefIncrement;
2006       m_nSize += nIncrement;
2007       wxChar **pNew = new wxChar *[m_nSize];
2008
2009       // copy data to new location
2010       memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
2011
2012       // delete old memory (but do not release the strings!)
2013       wxDELETEA(m_pItems);
2014
2015       m_pItems = pNew;
2016     }
2017   }
2018 }
2019
2020 void wxArrayString::Free()
2021 {
2022   for ( size_t n = 0; n < m_nCount; n++ ) {
2023     STRING(m_pItems[n])->GetStringData()->Unlock();
2024   }
2025 }
2026
2027 // deletes all the strings from the list
2028 void wxArrayString::Empty()
2029 {
2030   Free();
2031
2032   m_nCount = 0;
2033 }
2034
2035 // as Empty, but also frees memory
2036 void wxArrayString::Clear()
2037 {
2038   Free();
2039
2040   m_nSize  =
2041   m_nCount = 0;
2042
2043   wxDELETEA(m_pItems);
2044 }
2045
2046 // dtor
2047 wxArrayString::~wxArrayString()
2048 {
2049   Free();
2050
2051   wxDELETEA(m_pItems);
2052 }
2053
2054 void wxArrayString::reserve(size_t nSize)
2055 {
2056     Alloc(nSize);
2057 }
2058
2059 // pre-allocates memory (frees the previous data!)
2060 void wxArrayString::Alloc(size_t nSize)
2061 {
2062   // only if old buffer was not big enough
2063   if ( nSize > m_nSize ) {
2064     Free();
2065     wxDELETEA(m_pItems);
2066     m_pItems = new wxChar *[nSize];
2067     m_nSize  = nSize;
2068   }
2069
2070   m_nCount = 0;
2071 }
2072
2073 // minimizes the memory usage by freeing unused memory
2074 void wxArrayString::Shrink()
2075 {
2076   // only do it if we have some memory to free
2077   if( m_nCount < m_nSize ) {
2078     // allocates exactly as much memory as we need
2079     wxChar **pNew = new wxChar *[m_nCount];
2080
2081     // copy data to new location
2082     memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
2083     delete [] m_pItems;
2084     m_pItems = pNew;
2085   }
2086 }
2087
2088 #if WXWIN_COMPATIBILITY_2_4
2089
2090 // return a wxString[] as required for some control ctors.
2091 wxString* wxArrayString::GetStringArray() const
2092 {
2093     wxString *array = 0;
2094
2095     if( m_nCount > 0 )
2096     {
2097         array = new wxString[m_nCount];
2098         for( size_t i = 0; i < m_nCount; i++ )
2099             array[i] = m_pItems[i];
2100     }
2101
2102     return array;
2103 }
2104
2105 #endif // WXWIN_COMPATIBILITY_2_4
2106
2107 // searches the array for an item (forward or backwards)
2108 int wxArrayString::Index(const wxChar *sz, bool bCase, bool bFromEnd) const
2109 {
2110   if ( m_autoSort ) {
2111     // use binary search in the sorted array
2112     wxASSERT_MSG( bCase && !bFromEnd,
2113                   wxT("search parameters ignored for auto sorted array") );
2114
2115     size_t i,
2116            lo = 0,
2117            hi = m_nCount;
2118     int res;
2119     while ( lo < hi ) {
2120       i = (lo + hi)/2;
2121
2122       res = wxStrcmp(sz, m_pItems[i]);
2123       if ( res < 0 )
2124         hi = i;
2125       else if ( res > 0 )
2126         lo = i + 1;
2127       else
2128         return i;
2129     }
2130
2131     return wxNOT_FOUND;
2132   }
2133   else {
2134     // use linear search in unsorted array
2135     if ( bFromEnd ) {
2136       if ( m_nCount > 0 ) {
2137         size_t ui = m_nCount;
2138         do {
2139           if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) )
2140             return ui;
2141         }
2142         while ( ui != 0 );
2143       }
2144     }
2145     else {
2146       for( size_t ui = 0; ui < m_nCount; ui++ ) {
2147         if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) )
2148           return ui;
2149       }
2150     }
2151   }
2152
2153   return wxNOT_FOUND;
2154 }
2155
2156 // add item at the end
2157 size_t wxArrayString::Add(const wxString& str, size_t nInsert)
2158 {
2159   if ( m_autoSort ) {
2160     // insert the string at the correct position to keep the array sorted
2161     size_t i,
2162            lo = 0,
2163            hi = m_nCount;
2164     int res;
2165     while ( lo < hi ) {
2166       i = (lo + hi)/2;
2167
2168       res = wxStrcmp(str, m_pItems[i]);
2169       if ( res < 0 )
2170         hi = i;
2171       else if ( res > 0 )
2172         lo = i + 1;
2173       else {
2174         lo = hi = i;
2175         break;
2176       }
2177     }
2178
2179     wxASSERT_MSG( lo == hi, wxT("binary search broken") );
2180
2181     Insert(str, lo, nInsert);
2182
2183     return (size_t)lo;
2184   }
2185   else {
2186     wxASSERT( str.GetStringData()->IsValid() );
2187
2188     Grow(nInsert);
2189
2190     for (size_t i = 0; i < nInsert; i++)
2191     {
2192         // the string data must not be deleted!
2193         str.GetStringData()->Lock();
2194
2195         // just append
2196         m_pItems[m_nCount + i] = (wxChar *)str.c_str(); // const_cast
2197     }
2198     size_t ret = m_nCount;
2199     m_nCount += nInsert;
2200     return ret;
2201   }
2202 }
2203
2204 // add item at the given position
2205 void wxArrayString::Insert(const wxString& str, size_t nIndex, size_t nInsert)
2206 {
2207   wxASSERT( str.GetStringData()->IsValid() );
2208
2209   wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArrayString::Insert") );
2210   wxCHECK_RET( m_nCount <= m_nCount + nInsert,
2211                wxT("array size overflow in wxArrayString::Insert") );
2212
2213   Grow(nInsert);
2214
2215   memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex],
2216           (m_nCount - nIndex)*sizeof(wxChar *));
2217
2218   for (size_t i = 0; i < nInsert; i++)
2219   {
2220       str.GetStringData()->Lock();
2221       m_pItems[nIndex + i] = (wxChar *)str.c_str();
2222   }
2223   m_nCount += nInsert;
2224 }
2225
2226 // range insert (STL 23.2.4.3)
2227 void
2228 wxArrayString::insert(iterator it, const_iterator first, const_iterator last)
2229 {
2230     const int idx = it - begin();
2231
2232     // grow it once
2233     Grow(last - first);
2234
2235     // reset "it" since it can change inside Grow()
2236     it = begin() + idx;
2237
2238     while ( first != last )
2239     {
2240         it = insert(it, *first);
2241
2242         // insert returns an iterator to the last element inserted but we need
2243         // insert the next after this one, that is before the next one
2244         ++it;
2245
2246         ++first;
2247     }
2248 }
2249
2250 // expand the array
2251 void wxArrayString::SetCount(size_t count)
2252 {
2253     Alloc(count);
2254
2255     wxString s;
2256     while ( m_nCount < count )
2257         m_pItems[m_nCount++] = (wxChar *)s.c_str();
2258 }
2259
2260 // removes item from array (by index)
2261 void wxArrayString::RemoveAt(size_t nIndex, size_t nRemove)
2262 {
2263   wxCHECK_RET( nIndex < m_nCount, wxT("bad index in wxArrayString::Remove") );
2264   wxCHECK_RET( nIndex + nRemove <= m_nCount,
2265                wxT("removing too many elements in wxArrayString::Remove") );
2266
2267   // release our lock
2268   for (size_t i = 0; i < nRemove; i++)
2269       Item(nIndex + i).GetStringData()->Unlock();
2270
2271   memmove(&m_pItems[nIndex], &m_pItems[nIndex + nRemove],
2272           (m_nCount - nIndex - nRemove)*sizeof(wxChar *));
2273   m_nCount -= nRemove;
2274 }
2275
2276 // removes item from array (by value)
2277 void wxArrayString::Remove(const wxChar *sz)
2278 {
2279   int iIndex = Index(sz);
2280
2281   wxCHECK_RET( iIndex != wxNOT_FOUND,
2282                wxT("removing inexistent element in wxArrayString::Remove") );
2283
2284   RemoveAt(iIndex);
2285 }
2286
2287 void wxArrayString::assign(const_iterator first, const_iterator last)
2288 {
2289     reserve(last - first);
2290     for(; first != last; ++first)
2291         push_back(*first);
2292 }
2293
2294 // ----------------------------------------------------------------------------
2295 // sorting
2296 // ----------------------------------------------------------------------------
2297
2298 // we can only sort one array at a time with the quick-sort based
2299 // implementation
2300 #if wxUSE_THREADS
2301   // need a critical section to protect access to gs_compareFunction and
2302   // gs_sortAscending variables
2303   static wxCriticalSection *gs_critsectStringSort = NULL;
2304
2305   // call this before the value of the global sort vars is changed/after
2306   // you're finished with them
2307   #define START_SORT()     wxASSERT( !gs_critsectStringSort );                \
2308                            gs_critsectStringSort = new wxCriticalSection;     \
2309                            gs_critsectStringSort->Enter()
2310   #define END_SORT()       gs_critsectStringSort->Leave();                    \
2311                            delete gs_critsectStringSort;                      \
2312                            gs_critsectStringSort = NULL
2313 #else // !threads
2314   #define START_SORT()
2315   #define END_SORT()
2316 #endif // wxUSE_THREADS
2317
2318 // function to use for string comparaison
2319 static wxArrayString::CompareFunction gs_compareFunction = NULL;
2320
2321 // if we don't use the compare function, this flag tells us if we sort the
2322 // array in ascending or descending order
2323 static bool gs_sortAscending = TRUE;
2324
2325 // function which is called by quick sort
2326 extern "C" int wxC_CALLING_CONV     // LINKAGEMODE
2327 wxStringCompareFunction(const void *first, const void *second)
2328 {
2329   wxString *strFirst = (wxString *)first;
2330   wxString *strSecond = (wxString *)second;
2331
2332   if ( gs_compareFunction ) {
2333     return gs_compareFunction(*strFirst, *strSecond);
2334   }
2335   else {
2336     // maybe we should use wxStrcoll
2337     int result = wxStrcmp(strFirst->c_str(), strSecond->c_str());
2338
2339     return gs_sortAscending ? result : -result;
2340   }
2341 }
2342
2343 // sort array elements using passed comparaison function
2344 void wxArrayString::Sort(CompareFunction compareFunction)
2345 {
2346   START_SORT();
2347
2348   wxASSERT( !gs_compareFunction );  // must have been reset to NULL
2349   gs_compareFunction = compareFunction;
2350
2351   DoSort();
2352
2353   // reset it to NULL so that Sort(bool) will work the next time
2354   gs_compareFunction = NULL;
2355
2356   END_SORT();
2357 }
2358
2359 typedef  int (wxC_CALLING_CONV * wxStringCompareFn)(const void *first, const void *second);
2360
2361 void wxArrayString::Sort(CompareFunction2 compareFunction)
2362 {
2363   qsort(m_pItems, m_nCount, sizeof(wxChar *), (wxStringCompareFn)compareFunction);
2364 }
2365
2366 void wxArrayString::Sort(bool reverseOrder)
2367 {
2368   Sort(reverseOrder ? wxStringSortDescending : wxStringSortAscending);
2369 }
2370
2371 void wxArrayString::DoSort()
2372 {
2373   wxCHECK_RET( !m_autoSort, wxT("can't use this method with sorted arrays") );
2374
2375   // just sort the pointers using qsort() - of course it only works because
2376   // wxString() *is* a pointer to its data
2377   qsort(m_pItems, m_nCount, sizeof(wxChar *), wxStringCompareFunction);
2378 }
2379
2380 bool wxArrayString::operator==(const wxArrayString& a) const
2381 {
2382     if ( m_nCount != a.m_nCount )
2383         return FALSE;
2384
2385     for ( size_t n = 0; n < m_nCount; n++ )
2386     {
2387         if ( Item(n) != a[n] )
2388             return FALSE;
2389     }
2390
2391     return TRUE;
2392 }
2393
2394 #endif // !wxUSE_STL
2395
2396 int wxCMPFUNC_CONV wxStringSortAscending(wxString* s1, wxString* s2)
2397 {
2398     return wxStrcmp(s1->c_str(), s2->c_str());
2399 }
2400
2401 int wxCMPFUNC_CONV wxStringSortDescending(wxString* s1, wxString* s2)
2402 {
2403     return -wxStrcmp(s1->c_str(), s2->c_str());
2404 }