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