src/common/string.cpp

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