src/common/string.cpp

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