src/common/string.cpp

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