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