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