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