src/common/string.cpp

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