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 license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  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 #if wxUSE_WCSRTOMBS
  50   #include <wchar.h>    // for wcsrtombs(), see comments where it's used
  51 #endif // GNU
  52
  53 #ifdef  WXSTRING_IS_WXOBJECT
  54   IMPLEMENT_DYNAMIC_CLASS(wxString, wxObject)
  55 #endif  //WXSTRING_IS_WXOBJECT
  56
  57 #if wxUSE_UNICODE
  58 #undef wxUSE_EXPERIMENTAL_PRINTF
  59 #define wxUSE_EXPERIMENTAL_PRINTF 1
  60 #endif
  61
  62 // allocating extra space for each string consumes more memory but speeds up
  63 // the concatenation operations (nLen is the current string's length)
  64 // NB: EXTRA_ALLOC must be >= 0!
  65 #define EXTRA_ALLOC       (19 - nLen % 16)
  66
  67 // ---------------------------------------------------------------------------
  68 // static class variables definition
  69 // ---------------------------------------------------------------------------
  70
  71 #ifdef  wxSTD_STRING_COMPATIBILITY
  72   const size_t wxString::npos = wxSTRING_MAXLEN;
  73 #endif // wxSTD_STRING_COMPATIBILITY
  74
  75 // ----------------------------------------------------------------------------
  76 // static data
  77 // ----------------------------------------------------------------------------
  78
  79 // for an empty string, GetStringData() will return this address: this
  80 // structure has the same layout as wxStringData and it's data() method will
  81 // return the empty string (dummy pointer)
  82 static const struct
  83 {
  84   wxStringData data;
  85   wxChar dummy;
  86 } g_strEmpty = { {-1, 0, 0}, wxT('\0') };
  87
  88 // empty C style string: points to 'string data' byte of g_strEmpty
  89 extern const wxChar WXDLLEXPORT *wxEmptyString = &g_strEmpty.dummy;
  90
  91 // ----------------------------------------------------------------------------
  92 // conditional compilation
  93 // ----------------------------------------------------------------------------
  94
  95 #if !defined(__WXSW__) && wxUSE_UNICODE
  96   #ifdef wxUSE_EXPERIMENTAL_PRINTF
  97     #undef wxUSE_EXPERIMENTAL_PRINTF
  98   #endif
  99   #define wxUSE_EXPERIMENTAL_PRINTF 1
 100 #endif
 101
 102 // we want to find out if the current platform supports vsnprintf()-like
 103 // function: for Unix this is done with configure, for Windows we test the
 104 // compiler explicitly.
 105 //
 106 // FIXME currently, this is only for ANSI (!Unicode) strings, so we call this
 107 //       function wxVsnprintfA (A for ANSI), should also find one for Unicode
 108 //       strings in Unicode build
 109 #ifdef __WXMSW__
 110     #if defined(__VISUALC__) || defined(wxUSE_NORLANDER_HEADERS)
 111         #define wxVsnprintfA     _vsnprintf
 112     #endif
 113 #else   // !Windows
 114     #ifdef HAVE_VSNPRINTF
 115         #define wxVsnprintfA       vsnprintf
 116     #endif
 117 #endif  // Windows/!Windows
 118
 119 #ifndef wxVsnprintfA
 120     // in this case we'll use vsprintf() (which is ANSI and thus should be
 121     // always available), but it's unsafe because it doesn't check for buffer
 122     // size - so give a warning
 123     #define wxVsnprintfA(buf, len, format, arg) vsprintf(buf, format, arg)
 124
 125     #if defined(__VISUALC__)
 126         #pragma message("Using sprintf() because no snprintf()-like function defined")
 127     #elif defined(__GNUG__) && !defined(__UNIX__)
 128         #warning "Using sprintf() because no snprintf()-like function defined"
 129     #elif defined(__MWERKS__)
 130         #warning "Using sprintf() because no snprintf()-like function defined"
 131     #endif //compiler
 132 #endif // no vsnprintf
 133
 134 #ifdef _AIX
 135   // AIX has vsnprintf, but there's no prototype in the system headers.
 136   extern "C" int vsnprintf(char* str, size_t n, const char* format, va_list ap);
 137 #endif
 138
 139 // ----------------------------------------------------------------------------
 140 // global functions
 141 // ----------------------------------------------------------------------------
 142
 143 #if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM
 144
 145 // MS Visual C++ version 5.0 provides the new STL headers as well as the old
 146 // iostream ones.
 147 //
 148 // ATTN: you can _not_ use both of these in the same program!
 149
 150 istream& operator>>(istream& is, wxString& WXUNUSED(str))
 151 {
 152 #if 0
 153   int w = is.width(0);
 154   if ( is.ipfx(0) ) {
 155     streambuf *sb = is.rdbuf();
 156     str.erase();
 157     while ( true ) {
 158       int ch = sb->sbumpc ();
 159       if ( ch == EOF ) {
 160         is.setstate(ios::eofbit);
 161         break;
 162       }
 163       else if ( isspace(ch) ) {
 164         sb->sungetc();
 165         break;
 166       }
 167
 168       str += ch;
 169       if ( --w == 1 )
 170         break;
 171     }
 172   }
 173
 174   is.isfx();
 175   if ( str.length() == 0 )
 176     is.setstate(ios::failbit);
 177 #endif
 178   return is;
 179 }
 180
 181 ostream& operator<<(ostream& os, const wxString& str)
 182 {
 183   os << str.c_str();
 184   return os;
 185 }
 186
 187 #endif  //std::string compatibility
 188
 189 extern int WXDLLEXPORT wxVsnprintf(wxChar *buf, size_t len,
 190                                    const wxChar *format, va_list argptr)
 191 {
 192 #if wxUSE_UNICODE
 193     // FIXME should use wvsnprintf() or whatever if it's available
 194     wxString s;
 195     int iLen = s.PrintfV(format, argptr);
 196     if ( iLen != -1 )
 197     {
 198         wxStrncpy(buf, s.c_str(), iLen);
 199     }
 200
 201     return iLen;
 202 #else // ANSI
 203     // vsnprintf() will not terminate the string with '\0' if there is not
 204     // enough place, but we want the string to always be NUL terminated
 205     int rc = wxVsnprintfA(buf, len - 1, format, argptr);
 206     if ( rc == -1 )
 207     {
 208         buf[len] = 0;
 209     }
 210
 211     return rc;
 212 #endif // Unicode/ANSI
 213 }
 214
 215 extern int WXDLLEXPORT wxSnprintf(wxChar *buf, size_t len,
 216                                   const wxChar *format, ...)
 217 {
 218     va_list argptr;
 219     va_start(argptr, format);
 220
 221     int iLen = wxVsnprintf(buf, len, format, argptr);
 222
 223     va_end(argptr);
 224
 225     return iLen;
 226 }
 227
 228 // ----------------------------------------------------------------------------
 229 // private classes
 230 // ----------------------------------------------------------------------------
 231
 232 // this small class is used to gather statistics for performance tuning
 233 //#define WXSTRING_STATISTICS
 234 #ifdef  WXSTRING_STATISTICS
 235   class Averager
 236   {
 237   public:
 238     Averager(const char *sz) { m_sz = sz; m_nTotal = m_nCount = 0; }
 239    ~Averager()
 240    { printf("wxString: average %s = %f\n", m_sz, ((float)m_nTotal)/m_nCount); }
 241
 242     void Add(size_t n) { m_nTotal += n; m_nCount++; }
 243
 244   private:
 245     size_t m_nCount, m_nTotal;
 246     const char *m_sz;
 247   } g_averageLength("allocation size"),
 248     g_averageSummandLength("summand length"),
 249     g_averageConcatHit("hit probability in concat"),
 250     g_averageInitialLength("initial string length");
 251
 252   #define STATISTICS_ADD(av, val) g_average##av.Add(val)
 253 #else
 254   #define STATISTICS_ADD(av, val)
 255 #endif // WXSTRING_STATISTICS
 256
 257 // ===========================================================================
 258 // wxString class core
 259 // ===========================================================================
 260
 261 // ---------------------------------------------------------------------------
 262 // construction
 263 // ---------------------------------------------------------------------------
 264
 265 // constructs string of <nLength> copies of character <ch>
 266 wxString::wxString(wxChar ch, size_t nLength)
 267 {
 268   Init();
 269
 270   if ( nLength > 0 ) {
 271     AllocBuffer(nLength);
 272
 273 #if wxUSE_UNICODE
 274     // memset only works on char
 275     for (size_t n=0; n<nLength; n++) m_pchData[n] = ch;
 276 #else
 277     memset(m_pchData, ch, nLength);
 278 #endif
 279   }
 280 }
 281
 282 // takes nLength elements of psz starting at nPos
 283 void wxString::InitWith(const wxChar *psz, size_t nPos, size_t nLength)
 284 {
 285   Init();
 286
 287   wxASSERT( nPos <= wxStrlen(psz) );
 288
 289   if ( nLength == wxSTRING_MAXLEN )
 290     nLength = wxStrlen(psz + nPos);
 291
 292   STATISTICS_ADD(InitialLength, nLength);
 293
 294   if ( nLength > 0 ) {
 295     // trailing '\0' is written in AllocBuffer()
 296     AllocBuffer(nLength);
 297     memcpy(m_pchData, psz + nPos, nLength*sizeof(wxChar));
 298   }
 299 }
 300
 301 #ifdef  wxSTD_STRING_COMPATIBILITY
 302
 303 // poor man's iterators are "void *" pointers
 304 wxString::wxString(const void *pStart, const void *pEnd)
 305 {
 306   InitWith((const wxChar *)pStart, 0,
 307            (const wxChar *)pEnd - (const wxChar *)pStart);
 308 }
 309
 310 #endif  //std::string compatibility
 311
 312 #if wxUSE_UNICODE
 313
 314 // from multibyte string
 315 wxString::wxString(const char *psz, wxMBConv& conv, size_t nLength)
 316 {
 317   // first get necessary size
 318   size_t nLen = psz ? conv.MB2WC((wchar_t *) NULL, psz, 0) : 0;
 319
 320   // nLength is number of *Unicode* characters here!
 321   if ((nLen != (size_t)-1) && (nLen > nLength))
 322     nLen = nLength;
 323
 324   // empty?
 325   if ( (nLen != 0) && (nLen != (size_t)-1) ) {
 326     AllocBuffer(nLen);
 327     conv.MB2WC(m_pchData, psz, nLen);
 328   }
 329   else {
 330     Init();
 331   }
 332 }
 333
 334 #else // ANSI
 335
 336 #if wxUSE_WCHAR_T
 337 // from wide string
 338 wxString::wxString(const wchar_t *pwz)
 339 {
 340   // first get necessary size
 341   size_t nLen = pwz ? wxWC2MB((char *) NULL, pwz, 0) : 0;
 342
 343   // empty?
 344   if ( (nLen != 0) && (nLen != (size_t)-1) ) {
 345     AllocBuffer(nLen);
 346     wxWC2MB(m_pchData, pwz, nLen);
 347   }
 348   else {
 349     Init();
 350   }
 351 }
 352 #endif // wxUSE_WCHAR_T
 353
 354 #endif // Unicode/ANSI
 355
 356 // ---------------------------------------------------------------------------
 357 // memory allocation
 358 // ---------------------------------------------------------------------------
 359
 360 // allocates memory needed to store a C string of length nLen
 361 void wxString::AllocBuffer(size_t nLen)
 362 {
 363   wxASSERT( nLen >  0         );    //
 364   wxASSERT( nLen <= INT_MAX-1 );    // max size (enough room for 1 extra)
 365
 366   STATISTICS_ADD(Length, nLen);
 367
 368   // allocate memory:
 369   // 1) one extra character for '\0' termination
 370   // 2) sizeof(wxStringData) for housekeeping info
 371   wxStringData* pData = (wxStringData*)
 372     malloc(sizeof(wxStringData) + (nLen + EXTRA_ALLOC + 1)*sizeof(wxChar));
 373   pData->nRefs        = 1;
 374   pData->nDataLength  = nLen;
 375   pData->nAllocLength = nLen + EXTRA_ALLOC;
 376   m_pchData           = pData->data();  // data starts after wxStringData
 377   m_pchData[nLen]     = wxT('\0');
 378 }
 379
 380 // must be called before changing this string
 381 void wxString::CopyBeforeWrite()
 382 {
 383   wxStringData* pData = GetStringData();
 384
 385   if ( pData->IsShared() ) {
 386     pData->Unlock();                // memory not freed because shared
 387     size_t nLen = pData->nDataLength;
 388     AllocBuffer(nLen);
 389     memcpy(m_pchData, pData->data(), nLen*sizeof(wxChar));
 390   }
 391
 392   wxASSERT( !GetStringData()->IsShared() );  // we must be the only owner
 393 }
 394
 395 // must be called before replacing contents of this string
 396 void wxString::AllocBeforeWrite(size_t nLen)
 397 {
 398   wxASSERT( nLen != 0 );  // doesn't make any sense
 399
 400   // must not share string and must have enough space
 401   wxStringData* pData = GetStringData();
 402   if ( pData->IsShared() || pData->IsEmpty() ) {
 403     // can't work with old buffer, get new one
 404     pData->Unlock();
 405     AllocBuffer(nLen);
 406   }
 407   else {
 408     if ( nLen > pData->nAllocLength ) {
 409       // realloc the buffer instead of calling malloc() again, this is more
 410       // efficient
 411       STATISTICS_ADD(Length, nLen);
 412
 413       nLen += EXTRA_ALLOC;
 414
 415       wxStringData *pDataOld = pData;
 416       pData = (wxStringData*)
 417           realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
 418       if ( !pData ) {
 419         // out of memory
 420         free(pDataOld);
 421
 422         // FIXME we're going to crash...
 423         return;
 424       }
 425
 426       pData->nAllocLength = nLen;
 427       m_pchData = pData->data();
 428     }
 429
 430     // now we have enough space, just update the string length
 431     pData->nDataLength = nLen;
 432   }
 433
 434   wxASSERT( !GetStringData()->IsShared() );  // we must be the only owner
 435 }
 436
 437 // allocate enough memory for nLen characters
 438 void wxString::Alloc(size_t nLen)
 439 {
 440   wxStringData *pData = GetStringData();
 441   if ( pData->nAllocLength <= nLen ) {
 442     if ( pData->IsEmpty() ) {
 443       nLen += EXTRA_ALLOC;
 444
 445       wxStringData* pData = (wxStringData*)
 446         malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
 447       pData->nRefs = 1;
 448       pData->nDataLength = 0;
 449       pData->nAllocLength = nLen;
 450       m_pchData = pData->data();  // data starts after wxStringData
 451       m_pchData[0u] = wxT('\0');
 452     }
 453     else if ( pData->IsShared() ) {
 454       pData->Unlock();                // memory not freed because shared
 455       size_t nOldLen = pData->nDataLength;
 456       AllocBuffer(nLen);
 457       memcpy(m_pchData, pData->data(), nOldLen*sizeof(wxChar));
 458     }
 459     else {
 460       nLen += EXTRA_ALLOC;
 461
 462       wxStringData *pDataOld = pData;
 463       wxStringData *p = (wxStringData *)
 464         realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
 465
 466       if ( p == NULL ) {
 467         // don't leak memory
 468         free(pDataOld);
 469
 470         // FIXME what to do on memory error?
 471         return;
 472       }
 473
 474       // it's not important if the pointer changed or not (the check for this
 475       // is not faster than assigning to m_pchData in all cases)
 476       p->nAllocLength = nLen;
 477       m_pchData = p->data();
 478     }
 479   }
 480   //else: we've already got enough
 481 }
 482
 483 // shrink to minimal size (releasing extra memory)
 484 void wxString::Shrink()
 485 {
 486   wxStringData *pData = GetStringData();
 487
 488   // this variable is unused in release build, so avoid the compiler warning
 489   // by just not declaring it
 490 #ifdef __WXDEBUG__
 491   void *p =
 492 #endif
 493   realloc(pData, sizeof(wxStringData) + (pData->nDataLength + 1)*sizeof(wxChar));
 494
 495   // we rely on a reasonable realloc() implementation here - so far I haven't
 496   // seen any which wouldn't behave like this
 497
 498   wxASSERT( p != NULL );  // can't free memory?
 499   wxASSERT( p == pData ); // we're decrementing the size - block shouldn't move!
 500 }
 501
 502 // get the pointer to writable buffer of (at least) nLen bytes
 503 wxChar *wxString::GetWriteBuf(size_t nLen)
 504 {
 505   AllocBeforeWrite(nLen);
 506
 507   wxASSERT( GetStringData()->nRefs == 1 );
 508   GetStringData()->Validate(FALSE);
 509
 510   return m_pchData;
 511 }
 512
 513 // put string back in a reasonable state after GetWriteBuf
 514 void wxString::UngetWriteBuf()
 515 {
 516   GetStringData()->nDataLength = wxStrlen(m_pchData);
 517   GetStringData()->Validate(TRUE);
 518 }
 519
 520 // ---------------------------------------------------------------------------
 521 // data access
 522 // ---------------------------------------------------------------------------
 523
 524 // all functions are inline in string.h
 525
 526 // ---------------------------------------------------------------------------
 527 // assignment operators
 528 // ---------------------------------------------------------------------------
 529
 530 // helper function: does real copy
 531 void wxString::AssignCopy(size_t nSrcLen, const wxChar *pszSrcData)
 532 {
 533   if ( nSrcLen == 0 ) {
 534     Reinit();
 535   }
 536   else {
 537     AllocBeforeWrite(nSrcLen);
 538     memcpy(m_pchData, pszSrcData, nSrcLen*sizeof(wxChar));
 539     GetStringData()->nDataLength = nSrcLen;
 540     m_pchData[nSrcLen] = wxT('\0');
 541   }
 542 }
 543
 544 // assigns one string to another
 545 wxString& wxString::operator=(const wxString& stringSrc)
 546 {
 547   wxASSERT( stringSrc.GetStringData()->IsValid() );
 548
 549   // don't copy string over itself
 550   if ( m_pchData != stringSrc.m_pchData ) {
 551     if ( stringSrc.GetStringData()->IsEmpty() ) {
 552       Reinit();
 553     }
 554     else {
 555       // adjust references
 556       GetStringData()->Unlock();
 557       m_pchData = stringSrc.m_pchData;
 558       GetStringData()->Lock();
 559     }
 560   }
 561
 562   return *this;
 563 }
 564
 565 // assigns a single character
 566 wxString& wxString::operator=(wxChar ch)
 567 {
 568   AssignCopy(1, &ch);
 569   return *this;
 570 }
 571
 572 // assigns C string
 573 wxString& wxString::operator=(const wxChar *psz)
 574 {
 575   AssignCopy(wxStrlen(psz), psz);
 576   return *this;
 577 }
 578
 579 #if !wxUSE_UNICODE
 580
 581 // same as 'signed char' variant
 582 wxString& wxString::operator=(const unsigned char* psz)
 583 {
 584   *this = (const char *)psz;
 585   return *this;
 586 }
 587
 588 #if wxUSE_WCHAR_T
 589 wxString& wxString::operator=(const wchar_t *pwz)
 590 {
 591   wxString str(pwz);
 592   *this = str;
 593   return *this;
 594 }
 595 #endif
 596
 597 #endif
 598
 599 // ---------------------------------------------------------------------------
 600 // string concatenation
 601 // ---------------------------------------------------------------------------
 602
 603 // add something to this string
 604 void wxString::ConcatSelf(int nSrcLen, const wxChar *pszSrcData)
 605 {
 606   STATISTICS_ADD(SummandLength, nSrcLen);
 607
 608   // concatenating an empty string is a NOP
 609   if ( nSrcLen > 0 ) {
 610     wxStringData *pData = GetStringData();
 611     size_t nLen = pData->nDataLength;
 612     size_t nNewLen = nLen + nSrcLen;
 613
 614     // alloc new buffer if current is too small
 615     if ( pData->IsShared() ) {
 616       STATISTICS_ADD(ConcatHit, 0);
 617
 618       // we have to allocate another buffer
 619       wxStringData* pOldData = GetStringData();
 620       AllocBuffer(nNewLen);
 621       memcpy(m_pchData, pOldData->data(), nLen*sizeof(wxChar));
 622       pOldData->Unlock();
 623     }
 624     else if ( nNewLen > pData->nAllocLength ) {
 625       STATISTICS_ADD(ConcatHit, 0);
 626
 627       // we have to grow the buffer
 628       Alloc(nNewLen);
 629     }
 630     else {
 631       STATISTICS_ADD(ConcatHit, 1);
 632
 633       // the buffer is already big enough
 634     }
 635
 636     // should be enough space
 637     wxASSERT( nNewLen <= GetStringData()->nAllocLength );
 638
 639     // fast concatenation - all is done in our buffer
 640     memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(wxChar));
 641
 642     m_pchData[nNewLen] = wxT('\0');          // put terminating '\0'
 643     GetStringData()->nDataLength = nNewLen; // and fix the length
 644   }
 645   //else: the string to append was empty
 646 }
 647
 648 /*
 649  * concatenation functions come in 5 flavours:
 650  *  string + string
 651  *  char   + string      and      string + char
 652  *  C str  + string      and      string + C str
 653  */
 654
 655 wxString operator+(const wxString& string1, const wxString& string2)
 656 {
 657   wxASSERT( string1.GetStringData()->IsValid() );
 658   wxASSERT( string2.GetStringData()->IsValid() );
 659
 660   wxString s = string1;
 661   s += string2;
 662
 663   return s;
 664 }
 665
 666 wxString operator+(const wxString& string, wxChar ch)
 667 {
 668   wxASSERT( string.GetStringData()->IsValid() );
 669
 670   wxString s = string;
 671   s += ch;
 672
 673   return s;
 674 }
 675
 676 wxString operator+(wxChar ch, const wxString& string)
 677 {
 678   wxASSERT( string.GetStringData()->IsValid() );
 679
 680   wxString s = ch;
 681   s += string;
 682
 683   return s;
 684 }
 685
 686 wxString operator+(const wxString& string, const wxChar *psz)
 687 {
 688   wxASSERT( string.GetStringData()->IsValid() );
 689
 690   wxString s;
 691   s.Alloc(wxStrlen(psz) + string.Len());
 692   s = string;
 693   s += psz;
 694
 695   return s;
 696 }
 697
 698 wxString operator+(const wxChar *psz, const wxString& string)
 699 {
 700   wxASSERT( string.GetStringData()->IsValid() );
 701
 702   wxString s;
 703   s.Alloc(wxStrlen(psz) + string.Len());
 704   s = psz;
 705   s += string;
 706
 707   return s;
 708 }
 709
 710 // ===========================================================================
 711 // other common string functions
 712 // ===========================================================================
 713
 714 // ---------------------------------------------------------------------------
 715 // simple sub-string extraction
 716 // ---------------------------------------------------------------------------
 717
 718 // helper function: clone the data attached to this string
 719 void wxString::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const
 720 {
 721   if ( nCopyLen == 0 ) {
 722     dest.Init();
 723   }
 724   else {
 725     dest.AllocBuffer(nCopyLen);
 726     memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(wxChar));
 727   }
 728 }
 729
 730 // extract string of length nCount starting at nFirst
 731 wxString wxString::Mid(size_t nFirst, size_t nCount) const
 732 {
 733   wxStringData *pData = GetStringData();
 734   size_t nLen = pData->nDataLength;
 735
 736   // default value of nCount is wxSTRING_MAXLEN and means "till the end"
 737   if ( nCount == wxSTRING_MAXLEN )
 738   {
 739     nCount = nLen - nFirst;
 740   }
 741
 742   // out-of-bounds requests return sensible things
 743   if ( nFirst + nCount > nLen )
 744   {
 745     nCount = nLen - nFirst;
 746   }
 747
 748   if ( nFirst > nLen )
 749   {
 750     // AllocCopy() will return empty string
 751     nCount = 0;
 752   }
 753
 754   wxString dest;
 755   AllocCopy(dest, nCount, nFirst);
 756
 757   return dest;
 758 }
 759
 760 // extract nCount last (rightmost) characters
 761 wxString wxString::Right(size_t nCount) const
 762 {
 763   if ( nCount > (size_t)GetStringData()->nDataLength )
 764     nCount = GetStringData()->nDataLength;
 765
 766   wxString dest;
 767   AllocCopy(dest, nCount, GetStringData()->nDataLength - nCount);
 768   return dest;
 769 }
 770
 771 // get all characters after the last occurence of ch
 772 // (returns the whole string if ch not found)
 773 wxString wxString::AfterLast(wxChar ch) const
 774 {
 775   wxString str;
 776   int iPos = Find(ch, TRUE);
 777   if ( iPos == wxNOT_FOUND )
 778     str = *this;
 779   else
 780     str = c_str() + iPos + 1;
 781
 782   return str;
 783 }
 784
 785 // extract nCount first (leftmost) characters
 786 wxString wxString::Left(size_t nCount) const
 787 {
 788   if ( nCount > (size_t)GetStringData()->nDataLength )
 789     nCount = GetStringData()->nDataLength;
 790
 791   wxString dest;
 792   AllocCopy(dest, nCount, 0);
 793   return dest;
 794 }
 795
 796 // get all characters before the first occurence of ch
 797 // (returns the whole string if ch not found)
 798 wxString wxString::BeforeFirst(wxChar ch) const
 799 {
 800   wxString str;
 801   for ( const wxChar *pc = m_pchData; *pc != wxT('\0') && *pc != ch; pc++ )
 802     str += *pc;
 803
 804   return str;
 805 }
 806
 807 /// get all characters before the last occurence of ch
 808 /// (returns empty string if ch not found)
 809 wxString wxString::BeforeLast(wxChar ch) const
 810 {
 811   wxString str;
 812   int iPos = Find(ch, TRUE);
 813   if ( iPos != wxNOT_FOUND && iPos != 0 )
 814     str = wxString(c_str(), iPos);
 815
 816   return str;
 817 }
 818
 819 /// get all characters after the first occurence of ch
 820 /// (returns empty string if ch not found)
 821 wxString wxString::AfterFirst(wxChar ch) const
 822 {
 823   wxString str;
 824   int iPos = Find(ch);
 825   if ( iPos != wxNOT_FOUND )
 826     str = c_str() + iPos + 1;
 827
 828   return str;
 829 }
 830
 831 // replace first (or all) occurences of some substring with another one
 832 size_t wxString::Replace(const wxChar *szOld, const wxChar *szNew, bool bReplaceAll)
 833 {
 834   size_t uiCount = 0;   // count of replacements made
 835
 836   size_t uiOldLen = wxStrlen(szOld);
 837
 838   wxString strTemp;
 839   const wxChar *pCurrent = m_pchData;
 840   const wxChar *pSubstr;
 841   while ( *pCurrent != wxT('\0') ) {
 842     pSubstr = wxStrstr(pCurrent, szOld);
 843     if ( pSubstr == NULL ) {
 844       // strTemp is unused if no replacements were made, so avoid the copy
 845       if ( uiCount == 0 )
 846         return 0;
 847
 848       strTemp += pCurrent;    // copy the rest
 849       break;                  // exit the loop
 850     }
 851     else {
 852       // take chars before match
 853       strTemp.ConcatSelf(pSubstr - pCurrent, pCurrent);
 854       strTemp += szNew;
 855       pCurrent = pSubstr + uiOldLen;  // restart after match
 856
 857       uiCount++;
 858
 859       // stop now?
 860       if ( !bReplaceAll ) {
 861         strTemp += pCurrent;    // copy the rest
 862         break;                  // exit the loop
 863       }
 864     }
 865   }
 866
 867   // only done if there were replacements, otherwise would have returned above
 868   *this = strTemp;
 869
 870   return uiCount;
 871 }
 872
 873 bool wxString::IsAscii() const
 874 {
 875   const wxChar *s = (const wxChar*) *this;
 876   while(*s){
 877     if(!isascii(*s)) return(FALSE);
 878     s++;
 879   }
 880   return(TRUE);
 881 }
 882
 883 bool wxString::IsWord() const
 884 {
 885   const wxChar *s = (const wxChar*) *this;
 886   while(*s){
 887     if(!wxIsalpha(*s)) return(FALSE);
 888     s++;
 889   }
 890   return(TRUE);
 891 }
 892
 893 bool wxString::IsNumber() const
 894 {
 895   const wxChar *s = (const wxChar*) *this;
 896   while(*s){
 897     if(!wxIsdigit(*s)) return(FALSE);
 898     s++;
 899   }
 900   return(TRUE);
 901 }
 902
 903 wxString wxString::Strip(stripType w) const
 904 {
 905     wxString s = *this;
 906     if ( w & leading ) s.Trim(FALSE);
 907     if ( w & trailing ) s.Trim(TRUE);
 908     return s;
 909 }
 910
 911 // ---------------------------------------------------------------------------
 912 // case conversion
 913 // ---------------------------------------------------------------------------
 914
 915 wxString& wxString::MakeUpper()
 916 {
 917   CopyBeforeWrite();
 918
 919   for ( wxChar *p = m_pchData; *p; p++ )
 920     *p = (wxChar)wxToupper(*p);
 921
 922   return *this;
 923 }
 924
 925 wxString& wxString::MakeLower()
 926 {
 927   CopyBeforeWrite();
 928
 929   for ( wxChar *p = m_pchData; *p; p++ )
 930     *p = (wxChar)wxTolower(*p);
 931
 932   return *this;
 933 }
 934
 935 // ---------------------------------------------------------------------------
 936 // trimming and padding
 937 // ---------------------------------------------------------------------------
 938
 939 // trims spaces (in the sense of isspace) from left or right side
 940 wxString& wxString::Trim(bool bFromRight)
 941 {
 942   // first check if we're going to modify the string at all
 943   if ( !IsEmpty() &&
 944        (
 945         (bFromRight && wxIsspace(GetChar(Len() - 1))) ||
 946         (!bFromRight && wxIsspace(GetChar(0u)))
 947        )
 948      )
 949   {
 950     // ok, there is at least one space to trim
 951     CopyBeforeWrite();
 952
 953     if ( bFromRight )
 954     {
 955       // find last non-space character
 956       wxChar *psz = m_pchData + GetStringData()->nDataLength - 1;
 957       while ( wxIsspace(*psz) && (psz >= m_pchData) )
 958         psz--;
 959
 960       // truncate at trailing space start
 961       *++psz = wxT('\0');
 962       GetStringData()->nDataLength = psz - m_pchData;
 963     }
 964     else
 965     {
 966       // find first non-space character
 967       const wxChar *psz = m_pchData;
 968       while ( wxIsspace(*psz) )
 969         psz++;
 970
 971       // fix up data and length
 972       int nDataLength = GetStringData()->nDataLength - (psz - (const wxChar*) m_pchData);
 973       memmove(m_pchData, psz, (nDataLength + 1)*sizeof(wxChar));
 974       GetStringData()->nDataLength = nDataLength;
 975     }
 976   }
 977
 978   return *this;
 979 }
 980
 981 // adds nCount characters chPad to the string from either side
 982 wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight)
 983 {
 984   wxString s(chPad, nCount);
 985
 986   if ( bFromRight )
 987     *this += s;
 988   else
 989   {
 990     s += *this;
 991     *this = s;
 992   }
 993
 994   return *this;
 995 }
 996
 997 // truncate the string
 998 wxString& wxString::Truncate(size_t uiLen)
 999 {
1000   if ( uiLen < Len() ) {
1001     CopyBeforeWrite();
1002
1003     *(m_pchData + uiLen) = wxT('\0');
1004     GetStringData()->nDataLength = uiLen;
1005   }
1006   //else: nothing to do, string is already short enough
1007
1008   return *this;
1009 }
1010
1011 // ---------------------------------------------------------------------------
1012 // finding (return wxNOT_FOUND if not found and index otherwise)
1013 // ---------------------------------------------------------------------------
1014
1015 // find a character
1016 int wxString::Find(wxChar ch, bool bFromEnd) const
1017 {
1018   const wxChar *psz = bFromEnd ? wxStrrchr(m_pchData, ch) : wxStrchr(m_pchData, ch);
1019
1020   return (psz == NULL) ? wxNOT_FOUND : psz - (const wxChar*) m_pchData;
1021 }
1022
1023 // find a sub-string (like strstr)
1024 int wxString::Find(const wxChar *pszSub) const
1025 {
1026   const wxChar *psz = wxStrstr(m_pchData, pszSub);
1027
1028   return (psz == NULL) ? wxNOT_FOUND : psz - (const wxChar*) m_pchData;
1029 }
1030
1031 // ---------------------------------------------------------------------------
1032 // stream-like operators
1033 // ---------------------------------------------------------------------------
1034 wxString& wxString::operator<<(int i)
1035 {
1036     wxString res;
1037     res.Printf(wxT("%d"), i);
1038
1039     return (*this) << res;
1040 }
1041
1042 wxString& wxString::operator<<(float f)
1043 {
1044     wxString res;
1045     res.Printf(wxT("%f"), f);
1046
1047     return (*this) << res;
1048 }
1049
1050 wxString& wxString::operator<<(double d)
1051 {
1052     wxString res;
1053     res.Printf(wxT("%g"), d);
1054
1055     return (*this) << res;
1056 }
1057
1058 // ---------------------------------------------------------------------------
1059 // formatted output
1060 // ---------------------------------------------------------------------------
1061
1062 int wxString::Printf(const wxChar *pszFormat, ...)
1063 {
1064   va_list argptr;
1065   va_start(argptr, pszFormat);
1066
1067   int iLen = PrintfV(pszFormat, argptr);
1068
1069   va_end(argptr);
1070
1071   return iLen;
1072 }
1073
1074 int wxString::PrintfV(const wxChar* pszFormat, va_list argptr)
1075 {
1076 #if wxUSE_EXPERIMENTAL_PRINTF
1077   // the new implementation
1078
1079   // buffer to avoid dynamic memory allocation each time for small strings
1080   char szScratch[1024];
1081
1082   Reinit();
1083   for (size_t n = 0; pszFormat[n]; n++)
1084     if (pszFormat[n] == wxT('%')) {
1085       static char s_szFlags[256] = "%";
1086       size_t flagofs = 1;
1087       bool adj_left = FALSE, in_prec = FALSE,
1088            prec_dot = FALSE, done = FALSE;
1089       int ilen = 0;
1090       size_t min_width = 0, max_width = wxSTRING_MAXLEN;
1091       do {
1092 #define CHECK_PREC if (in_prec && !prec_dot) { s_szFlags[flagofs++] = '.'; prec_dot = TRUE; }
1093         switch (pszFormat[++n]) {
1094         case wxT('\0'):
1095           done = TRUE;
1096           break;
1097         case wxT('%'):
1098           *this += wxT('%');
1099           done = TRUE;
1100           break;
1101         case wxT('#'):
1102         case wxT('0'):
1103         case wxT(' '):
1104         case wxT('+'):
1105         case wxT('\''):
1106           CHECK_PREC
1107           s_szFlags[flagofs++] = pszFormat[n];
1108           break;
1109         case wxT('-'):
1110           CHECK_PREC
1111           adj_left = TRUE;
1112           s_szFlags[flagofs++] = pszFormat[n];
1113           break;
1114         case wxT('.'):
1115           CHECK_PREC
1116           in_prec = TRUE;
1117           prec_dot = FALSE;
1118           max_width = 0;
1119           // dot will be auto-added to s_szFlags if non-negative number follows
1120           break;
1121         case wxT('h'):
1122           ilen = -1;
1123           CHECK_PREC
1124           s_szFlags[flagofs++] = pszFormat[n];
1125           break;
1126         case wxT('l'):
1127           ilen = 1;
1128           CHECK_PREC
1129           s_szFlags[flagofs++] = pszFormat[n];
1130           break;
1131         case wxT('q'):
1132         case wxT('L'):
1133           ilen = 2;
1134           CHECK_PREC
1135           s_szFlags[flagofs++] = pszFormat[n];
1136           break;
1137         case wxT('Z'):
1138           ilen = 3;
1139           CHECK_PREC
1140           s_szFlags[flagofs++] = pszFormat[n];
1141           break;
1142         case wxT('*'):
1143           {
1144             int len = va_arg(argptr, int);
1145             if (in_prec) {
1146               if (len<0) break;
1147               CHECK_PREC
1148               max_width = len;
1149             } else {
1150               if (len<0) {
1151                 adj_left = !adj_left;
1152                 s_szFlags[flagofs++] = '-';
1153                 len = -len;
1154               }
1155               min_width = len;
1156             }
1157             flagofs += ::sprintf(s_szFlags+flagofs,"%d",len);
1158           }
1159           break;
1160         case wxT('1'): case wxT('2'): case wxT('3'):
1161         case wxT('4'): case wxT('5'): case wxT('6'):
1162         case wxT('7'): case wxT('8'): case wxT('9'):
1163           {
1164             int len = 0;
1165             CHECK_PREC
1166             while ((pszFormat[n]>=wxT('0')) && (pszFormat[n]<=wxT('9'))) {
1167               s_szFlags[flagofs++] = pszFormat[n];
1168               len = len*10 + (pszFormat[n] - wxT('0'));
1169               n++;
1170             }
1171             if (in_prec) max_width = len;
1172             else min_width = len;
1173             n--; // the main loop pre-increments n again
1174           }
1175           break;
1176         case wxT('d'):
1177         case wxT('i'):
1178         case wxT('o'):
1179         case wxT('u'):
1180         case wxT('x'):
1181         case wxT('X'):
1182           CHECK_PREC
1183           s_szFlags[flagofs++] = pszFormat[n];
1184           s_szFlags[flagofs] = '\0';
1185           if (ilen == 0 ) {
1186             int val = va_arg(argptr, int);
1187             ::sprintf(szScratch, s_szFlags, val);
1188           }
1189           else if (ilen == -1) {
1190             short int val = va_arg(argptr, short int);
1191             ::sprintf(szScratch, s_szFlags, val);
1192           }
1193           else if (ilen == 1) {
1194             long int val = va_arg(argptr, long int);
1195             ::sprintf(szScratch, s_szFlags, val);
1196           }
1197           else if (ilen == 2) {
1198 #if SIZEOF_LONG_LONG
1199             long long int val = va_arg(argptr, long long int);
1200             ::sprintf(szScratch, s_szFlags, val);
1201 #else
1202             long int val = va_arg(argptr, long int);
1203             ::sprintf(szScratch, s_szFlags, val);
1204 #endif
1205           }
1206           else if (ilen == 3) {
1207             size_t val = va_arg(argptr, size_t);
1208             ::sprintf(szScratch, s_szFlags, val);
1209           }
1210           *this += wxString(szScratch);
1211           done = TRUE;
1212           break;
1213         case wxT('e'):
1214         case wxT('E'):
1215         case wxT('f'):
1216         case wxT('g'):
1217         case wxT('G'):
1218           CHECK_PREC
1219           s_szFlags[flagofs++] = pszFormat[n];
1220           s_szFlags[flagofs] = '\0';
1221           if (ilen == 2) {
1222             long double val = va_arg(argptr, long double);
1223             ::sprintf(szScratch, s_szFlags, val);
1224           } else {
1225             double val = va_arg(argptr, double);
1226             ::sprintf(szScratch, s_szFlags, val);
1227           }
1228           *this += wxString(szScratch);
1229           done = TRUE;
1230           break;
1231         case wxT('p'):
1232           {
1233             void *val = va_arg(argptr, void *);
1234             CHECK_PREC
1235             s_szFlags[flagofs++] = pszFormat[n];
1236             s_szFlags[flagofs] = '\0';
1237             ::sprintf(szScratch, s_szFlags, val);
1238             *this += wxString(szScratch);
1239             done = TRUE;
1240           }
1241           break;
1242         case wxT('c'):
1243           {
1244             wxChar val = va_arg(argptr, int);
1245             // we don't need to honor padding here, do we?
1246             *this += val;
1247             done = TRUE;
1248           }
1249           break;
1250         case wxT('s'):
1251           if (ilen == -1) {
1252             // wx extension: we'll let %hs mean non-Unicode strings
1253             char *val = va_arg(argptr, char *);
1254 #if wxUSE_UNICODE
1255             // ASCII->Unicode constructor handles max_width right
1256             wxString s(val, wxConvLibc, max_width);
1257 #else
1258             size_t len = wxSTRING_MAXLEN;
1259             if (val) {
1260               for (len = 0; val[len] && (len<max_width); len++);
1261             } else val = wxT("(null)");
1262             wxString s(val, len);
1263 #endif
1264             if (s.Len() < min_width)
1265               s.Pad(min_width - s.Len(), wxT(' '), adj_left);
1266             *this += s;
1267           } else {
1268             wxChar *val = va_arg(argptr, wxChar *);
1269             size_t len = wxSTRING_MAXLEN;
1270             if (val) {
1271               for (len = 0; val[len] && (len<max_width); len++);
1272             } else val = wxT("(null)");
1273             wxString s(val, len);
1274             if (s.Len() < min_width)
1275               s.Pad(min_width - s.Len(), wxT(' '), adj_left);
1276             *this += s;
1277           }
1278           done = TRUE;
1279           break;
1280         case wxT('n'):
1281           if (ilen == 0) {
1282             int *val = va_arg(argptr, int *);
1283             *val = Len();
1284           }
1285           else if (ilen == -1) {
1286             short int *val = va_arg(argptr, short int *);
1287             *val = Len();
1288           }
1289           else if (ilen >= 1) {
1290             long int *val = va_arg(argptr, long int *);
1291             *val = Len();
1292           }
1293           done = TRUE;
1294           break;
1295         default:
1296           if (wxIsalpha(pszFormat[n]))
1297             // probably some flag not taken care of here yet
1298             s_szFlags[flagofs++] = pszFormat[n];
1299           else {
1300             // bad format
1301             *this += wxT('%'); // just to pass the glibc tst-printf.c
1302             n--;
1303             done = TRUE;
1304           }
1305           break;
1306         }
1307 #undef CHECK_PREC
1308       } while (!done);
1309     } else *this += pszFormat[n];
1310
1311 #else
1312   // buffer to avoid dynamic memory allocation each time for small strings
1313   char szScratch[1024];
1314
1315   // NB: wxVsnprintf() may return either less than the buffer size or -1 if
1316   //     there is not enough place depending on implementation
1317   int iLen = wxVsnprintfA(szScratch, WXSIZEOF(szScratch), pszFormat, argptr);
1318   if ( iLen != -1 ) {
1319     // the whole string is in szScratch
1320     *this = szScratch;
1321   }
1322   else {
1323       bool outOfMemory = FALSE;
1324       int size = 2*WXSIZEOF(szScratch);
1325       while ( !outOfMemory ) {
1326           char *buf = GetWriteBuf(size);
1327           if ( buf )
1328             iLen = wxVsnprintfA(buf, size, pszFormat, argptr);
1329           else
1330             outOfMemory = TRUE;
1331
1332           UngetWriteBuf();
1333
1334           if ( iLen != -1 ) {
1335               // ok, there was enough space
1336               break;
1337           }
1338
1339           // still not enough, double it again
1340           size *= 2;
1341       }
1342
1343       if ( outOfMemory ) {
1344           // out of memory
1345           return -1;
1346       }
1347   }
1348 #endif // wxUSE_EXPERIMENTAL_PRINTF/!wxUSE_EXPERIMENTAL_PRINTF
1349
1350   return Len();
1351 }
1352
1353 // ----------------------------------------------------------------------------
1354 // misc other operations
1355 // ----------------------------------------------------------------------------
1356
1357 // returns TRUE if the string matches the pattern which may contain '*' and
1358 // '?' metacharacters (as usual, '?' matches any character and '*' any number
1359 // of them)
1360 bool wxString::Matches(const wxChar *pszMask) const
1361 {
1362   // check char by char
1363   const wxChar *pszTxt;
1364   for ( pszTxt = c_str(); *pszMask != wxT('\0'); pszMask++, pszTxt++ ) {
1365     switch ( *pszMask ) {
1366       case wxT('?'):
1367         if ( *pszTxt == wxT('\0') )
1368           return FALSE;
1369
1370         // pszText and pszMask will be incremented in the loop statement
1371
1372         break;
1373
1374       case wxT('*'):
1375         {
1376           // ignore special chars immediately following this one
1377           while ( *pszMask == wxT('*') || *pszMask == wxT('?') )
1378             pszMask++;
1379
1380           // if there is nothing more, match
1381           if ( *pszMask == wxT('\0') )
1382             return TRUE;
1383
1384           // are there any other metacharacters in the mask?
1385           size_t uiLenMask;
1386           const wxChar *pEndMask = wxStrpbrk(pszMask, wxT("*?"));
1387
1388           if ( pEndMask != NULL ) {
1389             // we have to match the string between two metachars
1390             uiLenMask = pEndMask - pszMask;
1391           }
1392           else {
1393             // we have to match the remainder of the string
1394             uiLenMask = wxStrlen(pszMask);
1395           }
1396
1397           wxString strToMatch(pszMask, uiLenMask);
1398           const wxChar* pMatch = wxStrstr(pszTxt, strToMatch);
1399           if ( pMatch == NULL )
1400             return FALSE;
1401
1402           // -1 to compensate "++" in the loop
1403           pszTxt = pMatch + uiLenMask - 1;
1404           pszMask += uiLenMask - 1;
1405         }
1406         break;
1407
1408       default:
1409         if ( *pszMask != *pszTxt )
1410           return FALSE;
1411         break;
1412     }
1413   }
1414
1415   // match only if nothing left
1416   return *pszTxt == wxT('\0');
1417 }
1418
1419 // Count the number of chars
1420 int wxString::Freq(wxChar ch) const
1421 {
1422     int count = 0;
1423     int len = Len();
1424     for (int i = 0; i < len; i++)
1425     {
1426         if (GetChar(i) == ch)
1427             count ++;
1428     }
1429     return count;
1430 }
1431
1432 // convert to upper case, return the copy of the string
1433 wxString wxString::Upper() const
1434 { wxString s(*this); return s.MakeUpper(); }
1435
1436 // convert to lower case, return the copy of the string
1437 wxString wxString::Lower() const { wxString s(*this); return s.MakeLower(); }
1438
1439 int wxString::sprintf(const wxChar *pszFormat, ...)
1440   {
1441     va_list argptr;
1442     va_start(argptr, pszFormat);
1443     int iLen = PrintfV(pszFormat, argptr);
1444     va_end(argptr);
1445     return iLen;
1446   }
1447
1448 // ---------------------------------------------------------------------------
1449 // standard C++ library string functions
1450 // ---------------------------------------------------------------------------
1451 #ifdef  wxSTD_STRING_COMPATIBILITY
1452
1453 wxString& wxString::insert(size_t nPos, const wxString& str)
1454 {
1455   wxASSERT( str.GetStringData()->IsValid() );
1456   wxASSERT( nPos <= Len() );
1457
1458   if ( !str.IsEmpty() ) {
1459     wxString strTmp;
1460     wxChar *pc = strTmp.GetWriteBuf(Len() + str.Len());
1461     wxStrncpy(pc, c_str(), nPos);
1462     wxStrcpy(pc + nPos, str);
1463     wxStrcpy(pc + nPos + str.Len(), c_str() + nPos);
1464     strTmp.UngetWriteBuf();
1465     *this = strTmp;
1466   }
1467
1468   return *this;
1469 }
1470
1471 size_t wxString::find(const wxString& str, size_t nStart) const
1472 {
1473   wxASSERT( str.GetStringData()->IsValid() );
1474   wxASSERT( nStart <= Len() );
1475
1476   const wxChar *p = wxStrstr(c_str() + nStart, str);
1477
1478   return p == NULL ? npos : p - c_str();
1479 }
1480
1481 // VC++ 1.5 can't cope with the default argument in the header.
1482 #if !defined(__VISUALC__) || defined(__WIN32__)
1483 size_t wxString::find(const wxChar* sz, size_t nStart, size_t n) const
1484 {
1485   return find(wxString(sz, n == npos ? 0 : n), nStart);
1486 }
1487 #endif // VC++ 1.5
1488
1489 // Gives a duplicate symbol (presumably a case-insensitivity problem)
1490 #if !defined(__BORLANDC__)
1491 size_t wxString::find(wxChar ch, size_t nStart) const
1492 {
1493   wxASSERT( nStart <= Len() );
1494
1495   const wxChar *p = wxStrchr(c_str() + nStart, ch);
1496
1497   return p == NULL ? npos : p - c_str();
1498 }
1499 #endif
1500
1501 size_t wxString::rfind(const wxString& str, size_t nStart) const
1502 {
1503   wxASSERT( str.GetStringData()->IsValid() );
1504   wxASSERT( nStart <= Len() );
1505
1506   // TODO could be made much quicker than that
1507   const wxChar *p = c_str() + (nStart == npos ? Len() : nStart);
1508   while ( p >= c_str() + str.Len() ) {
1509     if ( wxStrncmp(p - str.Len(), str, str.Len()) == 0 )
1510       return p - str.Len() - c_str();
1511     p--;
1512   }
1513
1514   return npos;
1515 }
1516
1517 // VC++ 1.5 can't cope with the default argument in the header.
1518 #if !defined(__VISUALC__) || defined(__WIN32__)
1519 size_t wxString::rfind(const wxChar* sz, size_t nStart, size_t n) const
1520 {
1521     return rfind(wxString(sz, n == npos ? 0 : n), nStart);
1522 }
1523
1524 size_t wxString::rfind(wxChar ch, size_t nStart) const
1525 {
1526     if ( nStart == npos )
1527     {
1528         nStart = Len();
1529     }
1530     else
1531     {
1532         wxASSERT( nStart <= Len() );
1533     }
1534
1535     const wxChar *p = wxStrrchr(c_str(), ch);
1536
1537     if ( p == NULL )
1538         return npos;
1539
1540     size_t result = p - c_str();
1541     return ( result > nStart ) ? npos : result;
1542 }
1543 #endif // VC++ 1.5
1544
1545 size_t wxString::find_first_of(const wxChar* sz, size_t nStart) const
1546 {
1547     const wxChar *start = c_str() + nStart;
1548     const wxChar *firstOf = wxStrpbrk(start, sz);
1549     if ( firstOf )
1550         return firstOf - start;
1551     else
1552         return npos;
1553 }
1554
1555 size_t wxString::find_last_of(const wxChar* sz, size_t nStart) const
1556 {
1557     if ( nStart == npos )
1558     {
1559         nStart = Len();
1560     }
1561     else
1562     {
1563         wxASSERT( nStart <= Len() );
1564     }
1565
1566     for ( const wxChar *p = c_str() + length() - 1; p >= c_str(); p-- )
1567     {
1568         if ( wxStrchr(sz, *p) )
1569             return p - c_str();
1570     }
1571
1572     return npos;
1573 }
1574
1575 size_t wxString::find_first_not_of(const wxChar* sz, size_t nStart) const
1576 {
1577     if ( nStart == npos )
1578     {
1579         nStart = Len();
1580     }
1581     else
1582     {
1583         wxASSERT( nStart <= Len() );
1584     }
1585
1586     size_t nAccept = wxStrspn(c_str() + nStart, sz);
1587     if ( nAccept >= length() - nStart )
1588         return npos;
1589     else
1590         return nAccept;
1591 }
1592
1593 size_t wxString::find_first_not_of(wxChar ch, size_t nStart) const
1594 {
1595     wxASSERT( nStart <= Len() );
1596
1597     for ( const wxChar *p = c_str() + nStart; *p; p++ )
1598     {
1599         if ( *p != ch )
1600             return p - c_str();
1601     }
1602
1603     return npos;
1604 }
1605
1606 size_t wxString::find_last_not_of(const wxChar* sz, size_t nStart) const
1607 {
1608     if ( nStart == npos )
1609     {
1610         nStart = Len();
1611     }
1612     else
1613     {
1614         wxASSERT( nStart <= Len() );
1615     }
1616
1617     for ( const wxChar *p = c_str() + nStart - 1; p >= c_str(); p-- )
1618     {
1619         if ( !wxStrchr(sz, *p) )
1620             return p - c_str();
1621     }
1622
1623     return npos;
1624 }
1625
1626 size_t wxString::find_last_not_of(wxChar ch, size_t nStart) const
1627 {
1628     if ( nStart == npos )
1629     {
1630         nStart = Len();
1631     }
1632     else
1633     {
1634         wxASSERT( nStart <= Len() );
1635     }
1636
1637     for ( const wxChar *p = c_str() + nStart - 1; p >= c_str(); p-- )
1638     {
1639         if ( *p != ch )
1640             return p - c_str();
1641     }
1642
1643     return npos;
1644 }
1645
1646 wxString& wxString::erase(size_t nStart, size_t nLen)
1647 {
1648   wxString strTmp(c_str(), nStart);
1649   if ( nLen != npos ) {
1650     wxASSERT( nStart + nLen <= Len() );
1651
1652     strTmp.append(c_str() + nStart + nLen);
1653   }
1654
1655   *this = strTmp;
1656   return *this;
1657 }
1658
1659 wxString& wxString::replace(size_t nStart, size_t nLen, const wxChar *sz)
1660 {
1661   wxASSERT( nStart + nLen <= wxStrlen(sz) );
1662
1663   wxString strTmp;
1664   if ( nStart != 0 )
1665     strTmp.append(c_str(), nStart);
1666   strTmp += sz;
1667   strTmp.append(c_str() + nStart + nLen);
1668
1669   *this = strTmp;
1670   return *this;
1671 }
1672
1673 wxString& wxString::replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch)
1674 {
1675   return replace(nStart, nLen, wxString(ch, nCount));
1676 }
1677
1678 wxString& wxString::replace(size_t nStart, size_t nLen,
1679                             const wxString& str, size_t nStart2, size_t nLen2)
1680 {
1681   return replace(nStart, nLen, str.substr(nStart2, nLen2));
1682 }
1683
1684 wxString& wxString::replace(size_t nStart, size_t nLen,
1685                         const wxChar* sz, size_t nCount)
1686 {
1687   return replace(nStart, nLen, wxString(sz, nCount));
1688 }
1689
1690 #endif  //std::string compatibility
1691
1692 // ============================================================================
1693 // ArrayString
1694 // ============================================================================
1695
1696 // size increment = max(50% of current size, ARRAY_MAXSIZE_INCREMENT)
1697 #define   ARRAY_MAXSIZE_INCREMENT       4096
1698 #ifndef   ARRAY_DEFAULT_INITIAL_SIZE    // also defined in dynarray.h
1699   #define   ARRAY_DEFAULT_INITIAL_SIZE    (16)
1700 #endif
1701
1702 #define   STRING(p)   ((wxString *)(&(p)))
1703
1704 // ctor
1705 wxArrayString::wxArrayString(bool autoSort)
1706 {
1707   m_nSize  =
1708   m_nCount = 0;
1709   m_pItems = (wxChar **) NULL;
1710   m_autoSort = autoSort;
1711 }
1712
1713 // copy ctor
1714 wxArrayString::wxArrayString(const wxArrayString& src)
1715 {
1716   m_nSize  =
1717   m_nCount = 0;
1718   m_pItems = (wxChar **) NULL;
1719   m_autoSort = src.m_autoSort;
1720
1721   *this = src;
1722 }
1723
1724 // assignment operator
1725 wxArrayString& wxArrayString::operator=(const wxArrayString& src)
1726 {
1727   if ( m_nSize > 0 )
1728     Clear();
1729
1730   Copy(src);
1731
1732   return *this;
1733 }
1734
1735 void wxArrayString::Copy(const wxArrayString& src)
1736 {
1737   if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE )
1738     Alloc(src.m_nCount);
1739
1740   // we can't just copy the pointers here because otherwise we would share
1741   // the strings with another array because strings are ref counted
1742 #if 0
1743   if ( m_nCount != 0 )
1744     memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(wxChar *));
1745 #endif // 0
1746
1747   for ( size_t n = 0; n < src.m_nCount; n++ )
1748     Add(src[n]);
1749
1750   // if the other array is auto sorted too, we're already sorted, but
1751   // otherwise we should rearrange the items
1752   if ( m_autoSort && !src.m_autoSort )
1753     Sort();
1754 }
1755
1756 // grow the array
1757 void wxArrayString::Grow()
1758 {
1759   // only do it if no more place
1760   if( m_nCount == m_nSize ) {
1761     if( m_nSize == 0 ) {
1762       // was empty, alloc some memory
1763       m_nSize = ARRAY_DEFAULT_INITIAL_SIZE;
1764       m_pItems = new wxChar *[m_nSize];
1765     }
1766     else {
1767       // otherwise when it's called for the first time, nIncrement would be 0
1768       // and the array would never be expanded
1769 #if defined(__VISAGECPP__) && defined(__WXDEBUG__)
1770       int array_size = ARRAY_DEFAULT_INITIAL_SIZE;
1771       wxASSERT( array_size != 0 );
1772 #else
1773       wxASSERT( ARRAY_DEFAULT_INITIAL_SIZE != 0 );
1774 #endif
1775
1776       // add 50% but not too much
1777       size_t nIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE
1778                           ? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1;
1779       if ( nIncrement > ARRAY_MAXSIZE_INCREMENT )
1780         nIncrement = ARRAY_MAXSIZE_INCREMENT;
1781       m_nSize += nIncrement;
1782       wxChar **pNew = new wxChar *[m_nSize];
1783
1784       // copy data to new location
1785       memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
1786
1787       // delete old memory (but do not release the strings!)
1788       wxDELETEA(m_pItems);
1789
1790       m_pItems = pNew;
1791     }
1792   }
1793 }
1794
1795 void wxArrayString::Free()
1796 {
1797   for ( size_t n = 0; n < m_nCount; n++ ) {
1798     STRING(m_pItems[n])->GetStringData()->Unlock();
1799   }
1800 }
1801
1802 // deletes all the strings from the list
1803 void wxArrayString::Empty()
1804 {
1805   Free();
1806
1807   m_nCount = 0;
1808 }
1809
1810 // as Empty, but also frees memory
1811 void wxArrayString::Clear()
1812 {
1813   Free();
1814
1815   m_nSize  =
1816   m_nCount = 0;
1817
1818   wxDELETEA(m_pItems);
1819 }
1820
1821 // dtor
1822 wxArrayString::~wxArrayString()
1823 {
1824   Free();
1825
1826   wxDELETEA(m_pItems);
1827 }
1828
1829 // pre-allocates memory (frees the previous data!)
1830 void wxArrayString::Alloc(size_t nSize)
1831 {
1832   wxASSERT( nSize > 0 );
1833
1834   // only if old buffer was not big enough
1835   if ( nSize > m_nSize ) {
1836     Free();
1837     wxDELETEA(m_pItems);
1838     m_pItems = new wxChar *[nSize];
1839     m_nSize  = nSize;
1840   }
1841
1842   m_nCount = 0;
1843 }
1844
1845 // minimizes the memory usage by freeing unused memory
1846 void wxArrayString::Shrink()
1847 {
1848   // only do it if we have some memory to free
1849   if( m_nCount < m_nSize ) {
1850     // allocates exactly as much memory as we need
1851     wxChar **pNew = new wxChar *[m_nCount];
1852
1853     // copy data to new location
1854     memcpy(pNew, m_pItems, m_nCount*sizeof(wxChar *));
1855     delete [] m_pItems;
1856     m_pItems = pNew;
1857   }
1858 }
1859
1860 // searches the array for an item (forward or backwards)
1861 int wxArrayString::Index(const wxChar *sz, bool bCase, bool bFromEnd) const
1862 {
1863   if ( m_autoSort ) {
1864     // use binary search in the sorted array
1865     wxASSERT_MSG( bCase && !bFromEnd,
1866                   wxT("search parameters ignored for auto sorted array") );
1867
1868     size_t i,
1869            lo = 0,
1870            hi = m_nCount;
1871     int res;
1872     while ( lo < hi ) {
1873       i = (lo + hi)/2;
1874
1875       res = wxStrcmp(sz, m_pItems[i]);
1876       if ( res < 0 )
1877         hi = i;
1878       else if ( res > 0 )
1879         lo = i + 1;
1880       else
1881         return i;
1882     }
1883
1884     return wxNOT_FOUND;
1885   }
1886   else {
1887     // use linear search in unsorted array
1888     if ( bFromEnd ) {
1889       if ( m_nCount > 0 ) {
1890         size_t ui = m_nCount;
1891         do {
1892           if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) )
1893             return ui;
1894         }
1895         while ( ui != 0 );
1896       }
1897     }
1898     else {
1899       for( size_t ui = 0; ui < m_nCount; ui++ ) {
1900         if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) )
1901           return ui;
1902       }
1903     }
1904   }
1905
1906   return wxNOT_FOUND;
1907 }
1908
1909 // add item at the end
1910 size_t wxArrayString::Add(const wxString& str)
1911 {
1912   if ( m_autoSort ) {
1913     // insert the string at the correct position to keep the array sorted
1914     size_t i,
1915            lo = 0,
1916            hi = m_nCount;
1917     int res;
1918     while ( lo < hi ) {
1919       i = (lo + hi)/2;
1920
1921       res = wxStrcmp(str, m_pItems[i]);
1922       if ( res < 0 )
1923         hi = i;
1924       else if ( res > 0 )
1925         lo = i + 1;
1926       else {
1927         lo = hi = i;
1928         break;
1929       }
1930     }
1931
1932     wxASSERT_MSG( lo == hi, wxT("binary search broken") );
1933
1934     Insert(str, lo);
1935
1936     return (size_t)lo;
1937   }
1938   else {
1939     wxASSERT( str.GetStringData()->IsValid() );
1940
1941     Grow();
1942
1943     // the string data must not be deleted!
1944     str.GetStringData()->Lock();
1945
1946     // just append
1947     m_pItems[m_nCount] = (wxChar *)str.c_str(); // const_cast
1948
1949     return m_nCount++;
1950   }
1951 }
1952
1953 // add item at the given position
1954 void wxArrayString::Insert(const wxString& str, size_t nIndex)
1955 {
1956   wxASSERT( str.GetStringData()->IsValid() );
1957
1958   wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArrayString::Insert") );
1959
1960   Grow();
1961
1962   memmove(&m_pItems[nIndex + 1], &m_pItems[nIndex],
1963           (m_nCount - nIndex)*sizeof(wxChar *));
1964
1965   str.GetStringData()->Lock();
1966   m_pItems[nIndex] = (wxChar *)str.c_str();
1967
1968   m_nCount++;
1969 }
1970
1971 // removes item from array (by index)
1972 void wxArrayString::Remove(size_t nIndex)
1973 {
1974   wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArrayString::Remove") );
1975
1976   // release our lock
1977   Item(nIndex).GetStringData()->Unlock();
1978
1979   memmove(&m_pItems[nIndex], &m_pItems[nIndex + 1],
1980           (m_nCount - nIndex - 1)*sizeof(wxChar *));
1981   m_nCount--;
1982 }
1983
1984 // removes item from array (by value)
1985 void wxArrayString::Remove(const wxChar *sz)
1986 {
1987   int iIndex = Index(sz);
1988
1989   wxCHECK_RET( iIndex != wxNOT_FOUND,
1990                wxT("removing inexistent element in wxArrayString::Remove") );
1991
1992   Remove(iIndex);
1993 }
1994
1995 // ----------------------------------------------------------------------------
1996 // sorting
1997 // ----------------------------------------------------------------------------
1998
1999 // we can only sort one array at a time with the quick-sort based
2000 // implementation
2001 #if wxUSE_THREADS
2002   // need a critical section to protect access to gs_compareFunction and
2003   // gs_sortAscending variables
2004   static wxCriticalSection *gs_critsectStringSort = NULL;
2005
2006   // call this before the value of the global sort vars is changed/after
2007   // you're finished with them
2008   #define START_SORT()     wxASSERT( !gs_critsectStringSort );                \
2009                            gs_critsectStringSort = new wxCriticalSection;     \
2010                            gs_critsectStringSort->Enter()
2011   #define END_SORT()       gs_critsectStringSort->Leave();                    \
2012                            delete gs_critsectStringSort;                      \
2013                            gs_critsectStringSort = NULL
2014 #else // !threads
2015   #define START_SORT()
2016   #define END_SORT()
2017 #endif // wxUSE_THREADS
2018
2019 // function to use for string comparaison
2020 static wxArrayString::CompareFunction gs_compareFunction = NULL;
2021
2022 // if we don't use the compare function, this flag tells us if we sort the
2023 // array in ascending or descending order
2024 static bool gs_sortAscending = TRUE;
2025
2026 // function which is called by quick sort
2027 static int LINKAGEMODE wxStringCompareFunction(const void *first, const void *second)
2028 {
2029   wxString *strFirst = (wxString *)first;
2030   wxString *strSecond = (wxString *)second;
2031
2032   if ( gs_compareFunction ) {
2033     return gs_compareFunction(*strFirst, *strSecond);
2034   }
2035   else {
2036     // maybe we should use wxStrcoll
2037     int result = wxStrcmp(strFirst->c_str(), strSecond->c_str());
2038
2039     return gs_sortAscending ? result : -result;
2040   }
2041 }
2042
2043 // sort array elements using passed comparaison function
2044 void wxArrayString::Sort(CompareFunction compareFunction)
2045 {
2046   START_SORT();
2047
2048   wxASSERT( !gs_compareFunction );  // must have been reset to NULL
2049   gs_compareFunction = compareFunction;
2050
2051   DoSort();
2052
2053   END_SORT();
2054 }
2055
2056 void wxArrayString::Sort(bool reverseOrder)
2057 {
2058   START_SORT();
2059
2060   wxASSERT( !gs_compareFunction );  // must have been reset to NULL
2061   gs_sortAscending = !reverseOrder;
2062
2063   DoSort();
2064
2065   END_SORT();
2066 }
2067
2068 void wxArrayString::DoSort()
2069 {
2070   wxCHECK_RET( !m_autoSort, wxT("can't use this method with sorted arrays") );
2071
2072   // just sort the pointers using qsort() - of course it only works because
2073   // wxString() *is* a pointer to its data
2074   qsort(m_pItems, m_nCount, sizeof(wxChar *), wxStringCompareFunction);
2075 }
2076