src/common/string.cpp

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