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