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