src/common/string.cpp

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