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