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