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