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 #endif
  39
  40 #include <ctype.h>
  41 #include <string.h>
  42 #include <stdlib.h>
  43
  44 #ifdef  WXSTRING_IS_WXOBJECT
  45   IMPLEMENT_DYNAMIC_CLASS(wxString, wxObject)
  46 #endif  //WXSTRING_IS_WXOBJECT
  47
  48 // allocating extra space for each string consumes more memory but speeds up
  49 // the concatenation operations (nLen is the current string's length)
  50 // NB: EXTRA_ALLOC must be >= 0!
  51 #define EXTRA_ALLOC       (19 - nLen % 16)
  52
  53 // ---------------------------------------------------------------------------
  54 // static class variables definition
  55 // ---------------------------------------------------------------------------
  56
  57 #ifdef  STD_STRING_COMPATIBILITY
  58   const size_t wxString::npos = STRING_MAXLEN;
  59 #endif
  60
  61 // ----------------------------------------------------------------------------
  62 // static data
  63 // ----------------------------------------------------------------------------
  64
  65 // for an empty string, GetStringData() will return this address: this
  66 // structure has the same layout as wxStringData and it's data() method will
  67 // return the empty string (dummy pointer)
  68 static const struct
  69 {
  70   wxStringData data;
  71   char dummy;
  72 } g_strEmpty = { {-1, 0, 0}, '\0' };
  73
  74 // empty C style string: points to 'string data' byte of g_strEmpty
  75 extern const char *g_szNul = &g_strEmpty.dummy;
  76
  77 // ----------------------------------------------------------------------------
  78 // global functions
  79 // ----------------------------------------------------------------------------
  80
  81 #ifdef  STD_STRING_COMPATIBILITY
  82
  83 // MS Visual C++ version 5.0 provides the new STL headers as well as the old
  84 // iostream ones.
  85 //
  86 // ATTN: you can _not_ use both of these in the same program!
  87 #if 0 // def  _MSC_VER
  88   #include  <iostream>
  89   #define   NAMESPACE   std::
  90 #else
  91   #include  <iostream.h>
  92   #define   NAMESPACE
  93 #endif  //Visual C++
  94
  95 NAMESPACE istream& operator>>(NAMESPACE istream& is, wxString& WXUNUSED(str))
  96 {
  97 #if 0
  98   int w = is.width(0);
  99   if ( is.ipfx(0) ) {
 100     NAMESPACE streambuf *sb = is.rdbuf();
 101     str.erase();
 102     while ( true ) {
 103       int ch = sb->sbumpc ();
 104       if ( ch == EOF ) {
 105         is.setstate(NAMESPACE ios::eofbit);
 106         break;
 107       }
 108       else if ( isspace(ch) ) {
 109         sb->sungetc();
 110         break;
 111       }
 112
 113       str += ch;
 114       if ( --w == 1 )
 115         break;
 116     }
 117   }
 118
 119   is.isfx();
 120   if ( str.length() == 0 )
 121     is.setstate(NAMESPACE ios::failbit);
 122 #endif
 123   return is;
 124 }
 125
 126 #endif  //std::string compatibility
 127
 128 // ----------------------------------------------------------------------------
 129 // private classes
 130 // ----------------------------------------------------------------------------
 131
 132 // this small class is used to gather statistics for performance tuning
 133 //#define WXSTRING_STATISTICS
 134 #ifdef  WXSTRING_STATISTICS
 135   class Averager
 136   {
 137   public:
 138     Averager(const char *sz) { m_sz = sz; m_nTotal = m_nCount = 0; }
 139    ~Averager()
 140    { printf("wxString: average %s = %f\n", m_sz, ((float)m_nTotal)/m_nCount); }
 141
 142     void Add(size_t n) { m_nTotal += n; m_nCount++; }
 143
 144   private:
 145     size_t m_nCount, m_nTotal;
 146     const char *m_sz;
 147   } g_averageLength("allocation size"),
 148     g_averageSummandLength("summand length"),
 149     g_averageConcatHit("hit probability in concat"),
 150     g_averageInitialLength("initial string length");
 151
 152   #define STATISTICS_ADD(av, val) g_average##av.Add(val)
 153 #else
 154   #define STATISTICS_ADD(av, val)
 155 #endif // WXSTRING_STATISTICS
 156
 157 // ===========================================================================
 158 // wxString class core
 159 // ===========================================================================
 160
 161 // ---------------------------------------------------------------------------
 162 // construction
 163 // ---------------------------------------------------------------------------
 164
 165 // constructs string of <nLength> copies of character <ch>
 166 wxString::wxString(char ch, size_t nLength)
 167 {
 168   Init();
 169
 170   if ( nLength > 0 ) {
 171     AllocBuffer(nLength);
 172
 173     wxASSERT( sizeof(char) == 1 );  // can't use memset if not
 174
 175     memset(m_pchData, ch, nLength);
 176   }
 177 }
 178
 179 // takes nLength elements of psz starting at nPos
 180 void wxString::InitWith(const char *psz, size_t nPos, size_t nLength)
 181 {
 182   Init();
 183
 184   wxASSERT( nPos <= Strlen(psz) );
 185
 186   if ( nLength == STRING_MAXLEN )
 187     nLength = Strlen(psz + nPos);
 188
 189   STATISTICS_ADD(InitialLength, nLength);
 190
 191   if ( nLength > 0 ) {
 192     // trailing '\0' is written in AllocBuffer()
 193     AllocBuffer(nLength);
 194     memcpy(m_pchData, psz + nPos, nLength*sizeof(char));
 195   }
 196 }
 197
 198 // the same as previous constructor, but for compilers using unsigned char
 199 wxString::wxString(const unsigned char* psz, size_t nLength)
 200 {
 201   InitWith((const char *)psz, 0, nLength);
 202 }
 203
 204 #ifdef  STD_STRING_COMPATIBILITY
 205
 206 // poor man's iterators are "void *" pointers
 207 wxString::wxString(const void *pStart, const void *pEnd)
 208 {
 209   InitWith((const char *)pStart, 0,
 210            (const char *)pEnd - (const char *)pStart);
 211 }
 212
 213 #endif  //std::string compatibility
 214
 215 // from wide string
 216 wxString::wxString(const wchar_t *pwz)
 217 {
 218   // first get necessary size
 219   size_t nLen = wcstombs((char *) NULL, pwz, 0);
 220
 221   // empty?
 222   if ( nLen != 0 ) {
 223     AllocBuffer(nLen);
 224     wcstombs(m_pchData, pwz, nLen);
 225   }
 226   else {
 227     Init();
 228   }
 229 }
 230
 231 // ---------------------------------------------------------------------------
 232 // memory allocation
 233 // ---------------------------------------------------------------------------
 234
 235 // allocates memory needed to store a C string of length nLen
 236 void wxString::AllocBuffer(size_t nLen)
 237 {
 238   wxASSERT( nLen >  0         );    //
 239   wxASSERT( nLen <= INT_MAX-1 );    // max size (enough room for 1 extra)
 240
 241   STATISTICS_ADD(Length, nLen);
 242
 243   // allocate memory:
 244   // 1) one extra character for '\0' termination
 245   // 2) sizeof(wxStringData) for housekeeping info
 246   wxStringData* pData = (wxStringData*)
 247     malloc(sizeof(wxStringData) + (nLen + EXTRA_ALLOC + 1)*sizeof(char));
 248   pData->nRefs        = 1;
 249   pData->nDataLength  = nLen;
 250   pData->nAllocLength = nLen + EXTRA_ALLOC;
 251   m_pchData           = pData->data();  // data starts after wxStringData
 252   m_pchData[nLen]     = '\0';
 253 }
 254
 255 // must be called before changing this string
 256 void wxString::CopyBeforeWrite()
 257 {
 258   wxStringData* pData = GetStringData();
 259
 260   if ( pData->IsShared() ) {
 261     pData->Unlock();                // memory not freed because shared
 262     size_t nLen = pData->nDataLength;
 263     AllocBuffer(nLen);
 264     memcpy(m_pchData, pData->data(), nLen*sizeof(char));
 265   }
 266
 267   wxASSERT( !GetStringData()->IsShared() );  // we must be the only owner
 268 }
 269
 270 // must be called before replacing contents of this string
 271 void wxString::AllocBeforeWrite(size_t nLen)
 272 {
 273   wxASSERT( nLen != 0 );  // doesn't make any sense
 274
 275   // must not share string and must have enough space
 276   wxStringData* pData = GetStringData();
 277   if ( pData->IsShared() || (nLen > pData->nAllocLength) ) {
 278     // can't work with old buffer, get new one
 279     pData->Unlock();
 280     AllocBuffer(nLen);
 281   }
 282
 283   wxASSERT( !GetStringData()->IsShared() );  // we must be the only owner
 284 }
 285
 286 // allocate enough memory for nLen characters
 287 void wxString::Alloc(size_t nLen)
 288 {
 289   wxStringData *pData = GetStringData();
 290   if ( pData->nAllocLength <= nLen ) {
 291     if ( pData->IsEmpty() ) {
 292       nLen += EXTRA_ALLOC;
 293
 294       wxStringData* pData = (wxStringData*)
 295         malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(char));
 296       pData->nRefs = 1;
 297       pData->nDataLength = 0;
 298       pData->nAllocLength = nLen;
 299       m_pchData = pData->data();  // data starts after wxStringData
 300       m_pchData[0u] = '\0';
 301     }
 302     else if ( pData->IsShared() ) {
 303       pData->Unlock();                // memory not freed because shared
 304       size_t nOldLen = pData->nDataLength;
 305       AllocBuffer(nLen);
 306       memcpy(m_pchData, pData->data(), nOldLen*sizeof(char));
 307     }
 308     else {
 309       nLen += EXTRA_ALLOC;
 310
 311       wxStringData *p = (wxStringData *)
 312         realloc(pData, sizeof(wxStringData) + (nLen + 1)*sizeof(char));
 313
 314       if ( p == NULL ) {
 315         // @@@ what to do on memory error?
 316         return;
 317       }
 318
 319       // it's not important if the pointer changed or not (the check for this
 320       // is not faster than assigning to m_pchData in all cases)
 321       p->nAllocLength = nLen;
 322       m_pchData = p->data();
 323     }
 324   }
 325   //else: we've already got enough
 326 }
 327
 328 // shrink to minimal size (releasing extra memory)
 329 void wxString::Shrink()
 330 {
 331   wxStringData *pData = GetStringData();
 332
 333   // this variable is unused in release build, so avoid the compiler warning by
 334   // just not declaring it
 335 #ifdef __WXDEBUG__
 336   void *p =
 337 #endif
 338   realloc(pData, sizeof(wxStringData) + (pData->nDataLength + 1)*sizeof(char));
 339
 340   wxASSERT( p != NULL );  // can't free memory?
 341   wxASSERT( p == pData ); // we're decrementing the size - block shouldn't move!
 342 }
 343
 344 // get the pointer to writable buffer of (at least) nLen bytes
 345 char *wxString::GetWriteBuf(size_t nLen)
 346 {
 347   AllocBeforeWrite(nLen);
 348
 349   wxASSERT( GetStringData()->nRefs == 1 );
 350   GetStringData()->Validate(FALSE);
 351
 352   return m_pchData;
 353 }
 354
 355 // put string back in a reasonable state after GetWriteBuf
 356 void wxString::UngetWriteBuf()
 357 {
 358   GetStringData()->nDataLength = strlen(m_pchData);
 359   GetStringData()->Validate(TRUE);
 360 }
 361
 362 // ---------------------------------------------------------------------------
 363 // data access
 364 // ---------------------------------------------------------------------------
 365
 366 // all functions are inline in string.h
 367
 368 // ---------------------------------------------------------------------------
 369 // assignment operators
 370 // ---------------------------------------------------------------------------
 371
 372 // helper function: does real copy
 373 void wxString::AssignCopy(size_t nSrcLen, const char *pszSrcData)
 374 {
 375   if ( nSrcLen == 0 ) {
 376     Reinit();
 377   }
 378   else {
 379     AllocBeforeWrite(nSrcLen);
 380     memcpy(m_pchData, pszSrcData, nSrcLen*sizeof(char));
 381     GetStringData()->nDataLength = nSrcLen;
 382     m_pchData[nSrcLen] = '\0';
 383   }
 384 }
 385
 386 // assigns one string to another
 387 wxString& wxString::operator=(const wxString& stringSrc)
 388 {
 389   wxASSERT( stringSrc.GetStringData()->IsValid() );
 390
 391   // don't copy string over itself
 392   if ( m_pchData != stringSrc.m_pchData ) {
 393     if ( stringSrc.GetStringData()->IsEmpty() ) {
 394       Reinit();
 395     }
 396     else {
 397       // adjust references
 398       GetStringData()->Unlock();
 399       m_pchData = stringSrc.m_pchData;
 400       GetStringData()->Lock();
 401     }
 402   }
 403
 404   return *this;
 405 }
 406
 407 // assigns a single character
 408 wxString& wxString::operator=(char ch)
 409 {
 410   AssignCopy(1, &ch);
 411   return *this;
 412 }
 413
 414 // assigns C string
 415 wxString& wxString::operator=(const char *psz)
 416 {
 417   AssignCopy(Strlen(psz), psz);
 418   return *this;
 419 }
 420
 421 // same as 'signed char' variant
 422 wxString& wxString::operator=(const unsigned char* psz)
 423 {
 424   *this = (const char *)psz;
 425   return *this;
 426 }
 427
 428 wxString& wxString::operator=(const wchar_t *pwz)
 429 {
 430   wxString str(pwz);
 431   *this = str;
 432   return *this;
 433 }
 434
 435 // ---------------------------------------------------------------------------
 436 // string concatenation
 437 // ---------------------------------------------------------------------------
 438
 439 // add something to this string
 440 void wxString::ConcatSelf(int nSrcLen, const char *pszSrcData)
 441 {
 442   STATISTICS_ADD(SummandLength, nSrcLen);
 443
 444   // concatenating an empty string is a NOP
 445   if ( nSrcLen > 0 ) {
 446     wxStringData *pData = GetStringData();
 447     size_t nLen = pData->nDataLength;
 448     size_t nNewLen = nLen + nSrcLen;
 449
 450     // alloc new buffer if current is too small
 451     if ( pData->IsShared() ) {
 452       STATISTICS_ADD(ConcatHit, 0);
 453
 454       // we have to allocate another buffer
 455       wxStringData* pOldData = GetStringData();
 456       AllocBuffer(nNewLen);
 457       memcpy(m_pchData, pOldData->data(), nLen*sizeof(char));
 458       pOldData->Unlock();
 459     }
 460     else if ( nNewLen > pData->nAllocLength ) {
 461       STATISTICS_ADD(ConcatHit, 0);
 462
 463       // we have to grow the buffer
 464       Alloc(nNewLen);
 465     }
 466     else {
 467       STATISTICS_ADD(ConcatHit, 1);
 468
 469       // the buffer is already big enough
 470     }
 471
 472     // should be enough space
 473     wxASSERT( nNewLen <= GetStringData()->nAllocLength );
 474
 475     // fast concatenation - all is done in our buffer
 476     memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(char));
 477
 478     m_pchData[nNewLen] = '\0';              // put terminating '\0'
 479     GetStringData()->nDataLength = nNewLen; // and fix the length
 480   }
 481   //else: the string to append was empty
 482 }
 483
 484 /*
 485  * concatenation functions come in 5 flavours:
 486  *  string + string
 487  *  char   + string      and      string + char
 488  *  C str  + string      and      string + C str
 489  */
 490
 491 wxString operator+(const wxString& string1, const wxString& string2)
 492 {
 493   wxASSERT( string1.GetStringData()->IsValid() );
 494   wxASSERT( string2.GetStringData()->IsValid() );
 495
 496   wxString s = string1;
 497   s += string2;
 498
 499   return s;
 500 }
 501
 502 wxString operator+(const wxString& string, char ch)
 503 {
 504   wxASSERT( string.GetStringData()->IsValid() );
 505
 506   wxString s = string;
 507   s += ch;
 508
 509   return s;
 510 }
 511
 512 wxString operator+(char ch, const wxString& string)
 513 {
 514   wxASSERT( string.GetStringData()->IsValid() );
 515
 516   wxString s = ch;
 517   s += string;
 518
 519   return s;
 520 }
 521
 522 wxString operator+(const wxString& string, const char *psz)
 523 {
 524   wxASSERT( string.GetStringData()->IsValid() );
 525
 526   wxString s;
 527   s.Alloc(Strlen(psz) + string.Len());
 528   s = string;
 529   s += psz;
 530
 531   return s;
 532 }
 533
 534 wxString operator+(const char *psz, const wxString& string)
 535 {
 536   wxASSERT( string.GetStringData()->IsValid() );
 537
 538   wxString s;
 539   s.Alloc(Strlen(psz) + string.Len());
 540   s = psz;
 541   s += string;
 542
 543   return s;
 544 }
 545
 546 // ===========================================================================
 547 // other common string functions
 548 // ===========================================================================
 549
 550 // ---------------------------------------------------------------------------
 551 // simple sub-string extraction
 552 // ---------------------------------------------------------------------------
 553
 554 // helper function: clone the data attached to this string
 555 void wxString::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const
 556 {
 557   if ( nCopyLen == 0 ) {
 558     dest.Init();
 559   }
 560   else {
 561     dest.AllocBuffer(nCopyLen);
 562     memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(char));
 563   }
 564 }
 565
 566 // extract string of length nCount starting at nFirst
 567 wxString wxString::Mid(size_t nFirst, size_t nCount) const
 568 {
 569   wxStringData *pData = GetStringData();
 570   size_t nLen = pData->nDataLength;
 571
 572   // default value of nCount is STRING_MAXLEN and means "till the end"
 573   if ( nCount == STRING_MAXLEN )
 574   {
 575     nCount = nLen - nFirst;
 576   }
 577
 578   // out-of-bounds requests return sensible things
 579   if ( nFirst + nCount > nLen )
 580   {
 581     nCount = nLen - nFirst;
 582   }
 583
 584   if ( nFirst > nLen )
 585   {
 586     // AllocCopy() will return empty string
 587     nCount = 0;
 588   }
 589
 590   wxString dest;
 591   AllocCopy(dest, nCount, nFirst);
 592
 593   return dest;
 594 }
 595
 596 // extract nCount last (rightmost) characters
 597 wxString wxString::Right(size_t nCount) const
 598 {
 599   if ( nCount > (size_t)GetStringData()->nDataLength )
 600     nCount = GetStringData()->nDataLength;
 601
 602   wxString dest;
 603   AllocCopy(dest, nCount, GetStringData()->nDataLength - nCount);
 604   return dest;
 605 }
 606
 607 // get all characters after the last occurence of ch
 608 // (returns the whole string if ch not found)
 609 wxString wxString::Right(char ch) const
 610 {
 611   wxString str;
 612   int iPos = Find(ch, TRUE);
 613   if ( iPos == NOT_FOUND )
 614     str = *this;
 615   else
 616     str = c_str() + iPos + 1;
 617
 618   return str;
 619 }
 620
 621 // extract nCount first (leftmost) characters
 622 wxString wxString::Left(size_t nCount) const
 623 {
 624   if ( nCount > (size_t)GetStringData()->nDataLength )
 625     nCount = GetStringData()->nDataLength;
 626
 627   wxString dest;
 628   AllocCopy(dest, nCount, 0);
 629   return dest;
 630 }
 631
 632 // get all characters before the first occurence of ch
 633 // (returns the whole string if ch not found)
 634 wxString wxString::Left(char ch) const
 635 {
 636   wxString str;
 637   for ( const char *pc = m_pchData; *pc != '\0' && *pc != ch; pc++ )
 638     str += *pc;
 639
 640   return str;
 641 }
 642
 643 /// get all characters before the last occurence of ch
 644 /// (returns empty string if ch not found)
 645 wxString wxString::Before(char ch) const
 646 {
 647   wxString str;
 648   int iPos = Find(ch, TRUE);
 649   if ( iPos != NOT_FOUND && iPos != 0 )
 650     str = wxString(c_str(), iPos);
 651
 652   return str;
 653 }
 654
 655 /// get all characters after the first occurence of ch
 656 /// (returns empty string if ch not found)
 657 wxString wxString::After(char ch) const
 658 {
 659   wxString str;
 660   int iPos = Find(ch);
 661   if ( iPos != NOT_FOUND )
 662     str = c_str() + iPos + 1;
 663
 664   return str;
 665 }
 666
 667 // replace first (or all) occurences of some substring with another one
 668 size_t wxString::Replace(const char *szOld, const char *szNew, bool bReplaceAll)
 669 {
 670   size_t uiCount = 0;   // count of replacements made
 671
 672   size_t uiOldLen = Strlen(szOld);
 673
 674   wxString strTemp;
 675   const char *pCurrent = m_pchData;
 676   const char *pSubstr;
 677   while ( *pCurrent != '\0' ) {
 678     pSubstr = strstr(pCurrent, szOld);
 679     if ( pSubstr == NULL ) {
 680       // strTemp is unused if no replacements were made, so avoid the copy
 681       if ( uiCount == 0 )
 682         return 0;
 683
 684       strTemp += pCurrent;    // copy the rest
 685       break;                  // exit the loop
 686     }
 687     else {
 688       // take chars before match
 689       strTemp.ConcatSelf(pSubstr - pCurrent, pCurrent);
 690       strTemp += szNew;
 691       pCurrent = pSubstr + uiOldLen;  // restart after match
 692
 693       uiCount++;
 694
 695       // stop now?
 696       if ( !bReplaceAll ) {
 697         strTemp += pCurrent;    // copy the rest
 698         break;                  // exit the loop
 699       }
 700     }
 701   }
 702
 703   // only done if there were replacements, otherwise would have returned above
 704   *this = strTemp;
 705
 706   return uiCount;
 707 }
 708
 709 bool wxString::IsAscii() const
 710 {
 711   const char *s = (const char*) *this;
 712   while(*s){
 713     if(!isascii(*s)) return(FALSE);
 714     s++;
 715   }
 716   return(TRUE);
 717 }
 718
 719 bool wxString::IsWord() const
 720 {
 721   const char *s = (const char*) *this;
 722   while(*s){
 723     if(!isalpha(*s)) return(FALSE);
 724     s++;
 725   }
 726   return(TRUE);
 727 }
 728
 729 bool wxString::IsNumber() const
 730 {
 731   const char *s = (const char*) *this;
 732   while(*s){
 733     if(!isdigit(*s)) return(FALSE);
 734     s++;
 735   }
 736   return(TRUE);
 737 }
 738
 739 wxString wxString::Strip(stripType w) const
 740 {
 741     wxString s = *this;
 742     if ( w & leading ) s.Trim(FALSE);
 743     if ( w & trailing ) s.Trim(TRUE);
 744     return s;
 745 }
 746
 747 // ---------------------------------------------------------------------------
 748 // case conversion
 749 // ---------------------------------------------------------------------------
 750
 751 wxString& wxString::MakeUpper()
 752 {
 753   CopyBeforeWrite();
 754
 755   for ( char *p = m_pchData; *p; p++ )
 756     *p = (char)toupper(*p);
 757
 758   return *this;
 759 }
 760
 761 wxString& wxString::MakeLower()
 762 {
 763   CopyBeforeWrite();
 764
 765   for ( char *p = m_pchData; *p; p++ )
 766     *p = (char)tolower(*p);
 767
 768   return *this;
 769 }
 770
 771 // ---------------------------------------------------------------------------
 772 // trimming and padding
 773 // ---------------------------------------------------------------------------
 774
 775 // trims spaces (in the sense of isspace) from left or right side
 776 wxString& wxString::Trim(bool bFromRight)
 777 {
 778   CopyBeforeWrite();
 779
 780   if ( bFromRight )
 781   {
 782     // find last non-space character
 783     char *psz = m_pchData + GetStringData()->nDataLength - 1;
 784     while ( isspace(*psz) && (psz >= m_pchData) )
 785       psz--;
 786
 787     // truncate at trailing space start
 788     *++psz = '\0';
 789     GetStringData()->nDataLength = psz - m_pchData;
 790   }
 791   else
 792   {
 793     // find first non-space character
 794     const char *psz = m_pchData;
 795     while ( isspace(*psz) )
 796       psz++;
 797
 798     // fix up data and length
 799     int nDataLength = GetStringData()->nDataLength - (psz - m_pchData);
 800     memmove(m_pchData, psz, (nDataLength + 1)*sizeof(char));
 801     GetStringData()->nDataLength = nDataLength;
 802   }
 803
 804   return *this;
 805 }
 806
 807 // adds nCount characters chPad to the string from either side
 808 wxString& wxString::Pad(size_t nCount, char chPad, bool bFromRight)
 809 {
 810   wxString s(chPad, nCount);
 811
 812   if ( bFromRight )
 813     *this += s;
 814   else
 815   {
 816     s += *this;
 817     *this = s;
 818   }
 819
 820   return *this;
 821 }
 822
 823 // truncate the string
 824 wxString& wxString::Truncate(size_t uiLen)
 825 {
 826   *(m_pchData + uiLen) = '\0';
 827   GetStringData()->nDataLength = uiLen;
 828
 829   return *this;
 830 }
 831
 832 // ---------------------------------------------------------------------------
 833 // finding (return NOT_FOUND if not found and index otherwise)
 834 // ---------------------------------------------------------------------------
 835
 836 // find a character
 837 int wxString::Find(char ch, bool bFromEnd) const
 838 {
 839   const char *psz = bFromEnd ? strrchr(m_pchData, ch) : strchr(m_pchData, ch);
 840
 841   return (psz == NULL) ? NOT_FOUND : psz - m_pchData;
 842 }
 843
 844 // find a sub-string (like strstr)
 845 int wxString::Find(const char *pszSub) const
 846 {
 847   const char *psz = strstr(m_pchData, pszSub);
 848
 849   return (psz == NULL) ? NOT_FOUND : psz - m_pchData;
 850 }
 851
 852 // ---------------------------------------------------------------------------
 853 // formatted output
 854 // ---------------------------------------------------------------------------
 855 int wxString::Printf(const char *pszFormat, ...)
 856 {
 857   va_list argptr;
 858   va_start(argptr, pszFormat);
 859
 860   int iLen = PrintfV(pszFormat, argptr);
 861
 862   va_end(argptr);
 863
 864   return iLen;
 865 }
 866
 867 int wxString::PrintfV(const char* pszFormat, va_list argptr)
 868 {
 869   static char s_szScratch[1024];
 870
 871   int iLen = vsprintf(s_szScratch, pszFormat, argptr);
 872   AllocBeforeWrite(iLen);
 873   strcpy(m_pchData, s_szScratch);
 874
 875   return iLen;
 876 }
 877
 878 // ----------------------------------------------------------------------------
 879 // misc other operations
 880 // ----------------------------------------------------------------------------
 881 bool wxString::Matches(const char *pszMask) const
 882 {
 883   // check char by char
 884   const char *pszTxt;
 885   for ( pszTxt = c_str(); *pszMask != '\0'; pszMask++, pszTxt++ ) {
 886     switch ( *pszMask ) {
 887       case '?':
 888         if ( *pszTxt == '\0' )
 889           return FALSE;
 890
 891         pszTxt++;
 892         pszMask++;
 893         break;
 894
 895       case '*':
 896         {
 897           // ignore special chars immediately following this one
 898           while ( *pszMask == '*' || *pszMask == '?' )
 899             pszMask++;
 900
 901           // if there is nothing more, match
 902           if ( *pszMask == '\0' )
 903             return TRUE;
 904
 905           // are there any other metacharacters in the mask?
 906           size_t uiLenMask;
 907           const char *pEndMask = strpbrk(pszMask, "*?");
 908
 909           if ( pEndMask != NULL ) {
 910             // we have to match the string between two metachars
 911             uiLenMask = pEndMask - pszMask;
 912           }
 913           else {
 914             // we have to match the remainder of the string
 915             uiLenMask = strlen(pszMask);
 916           }
 917
 918           wxString strToMatch(pszMask, uiLenMask);
 919           const char* pMatch = strstr(pszTxt, strToMatch);
 920           if ( pMatch == NULL )
 921             return FALSE;
 922
 923           // -1 to compensate "++" in the loop
 924           pszTxt = pMatch + uiLenMask - 1;
 925           pszMask += uiLenMask - 1;
 926         }
 927         break;
 928
 929       default:
 930         if ( *pszMask != *pszTxt )
 931           return FALSE;
 932         break;
 933     }
 934   }
 935
 936   // match only if nothing left
 937   return *pszTxt == '\0';
 938 }
 939
 940 // ---------------------------------------------------------------------------
 941 // standard C++ library string functions
 942 // ---------------------------------------------------------------------------
 943 #ifdef  STD_STRING_COMPATIBILITY
 944
 945 wxString& wxString::insert(size_t nPos, const wxString& str)
 946 {
 947   wxASSERT( str.GetStringData()->IsValid() );
 948   wxASSERT( nPos <= Len() );
 949
 950   if ( !str.IsEmpty() ) {
 951     wxString strTmp;
 952     char *pc = strTmp.GetWriteBuf(Len() + str.Len());
 953     strncpy(pc, c_str(), nPos);
 954     strcpy(pc + nPos, str);
 955     strcpy(pc + nPos + str.Len(), c_str() + nPos);
 956     strTmp.UngetWriteBuf();
 957     *this = strTmp;
 958   }
 959
 960   return *this;
 961 }
 962
 963 size_t wxString::find(const wxString& str, size_t nStart) const
 964 {
 965   wxASSERT( str.GetStringData()->IsValid() );
 966   wxASSERT( nStart <= Len() );
 967
 968   const char *p = strstr(c_str() + nStart, str);
 969
 970   return p == NULL ? npos : p - c_str();
 971 }
 972
 973 // VC++ 1.5 can't cope with the default argument in the header.
 974 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
 975 size_t wxString::find(const char* sz, size_t nStart, size_t n) const
 976 {
 977   return find(wxString(sz, n == npos ? 0 : n), nStart);
 978 }
 979 #endif
 980
 981 size_t wxString::find(char ch, size_t nStart) const
 982 {
 983   wxASSERT( nStart <= Len() );
 984
 985   const char *p = strchr(c_str() + nStart, ch);
 986
 987   return p == NULL ? npos : p - c_str();
 988 }
 989
 990 size_t wxString::rfind(const wxString& str, size_t nStart) const
 991 {
 992   wxASSERT( str.GetStringData()->IsValid() );
 993   wxASSERT( nStart <= Len() );
 994
 995   // # could be quicker than that
 996   const char *p = c_str() + (nStart == npos ? Len() : nStart);
 997   while ( p >= c_str() + str.Len() ) {
 998     if ( strncmp(p - str.Len(), str, str.Len()) == 0 )
 999       return p - str.Len() - c_str();
1000     p--;
1001   }
1002
1003   return npos;
1004 }
1005
1006 // VC++ 1.5 can't cope with the default argument in the header.
1007 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
1008 size_t wxString::rfind(const char* sz, size_t nStart, size_t n) const
1009 {
1010   return rfind(wxString(sz, n == npos ? 0 : n), nStart);
1011 }
1012
1013 size_t wxString::rfind(char ch, size_t nStart) const
1014 {
1015   wxASSERT( nStart <= Len() );
1016
1017   const char *p = strrchr(c_str() + nStart, ch);
1018
1019   return p == NULL ? npos : p - c_str();
1020 }
1021 #endif
1022
1023 wxString wxString::substr(size_t nStart, size_t nLen) const
1024 {
1025   // npos means 'take all'
1026   if ( nLen == npos )
1027     nLen = 0;
1028
1029   wxASSERT( nStart + nLen <= Len() );
1030
1031   return wxString(c_str() + nStart, nLen == npos ? 0 : nLen);
1032 }
1033
1034 wxString& wxString::erase(size_t nStart, size_t nLen)
1035 {
1036   wxString strTmp(c_str(), nStart);
1037   if ( nLen != npos ) {
1038     wxASSERT( nStart + nLen <= Len() );
1039
1040     strTmp.append(c_str() + nStart + nLen);
1041   }
1042
1043   *this = strTmp;
1044   return *this;
1045 }
1046
1047 wxString& wxString::replace(size_t nStart, size_t nLen, const char *sz)
1048 {
1049   wxASSERT( nStart + nLen <= Strlen(sz) );
1050
1051   wxString strTmp;
1052   if ( nStart != 0 )
1053     strTmp.append(c_str(), nStart);
1054   strTmp += sz;
1055   strTmp.append(c_str() + nStart + nLen);
1056
1057   *this = strTmp;
1058   return *this;
1059 }
1060
1061 wxString& wxString::replace(size_t nStart, size_t nLen, size_t nCount, char ch)
1062 {
1063   return replace(nStart, nLen, wxString(ch, nCount));
1064 }
1065
1066 wxString& wxString::replace(size_t nStart, size_t nLen,
1067                             const wxString& str, size_t nStart2, size_t nLen2)
1068 {
1069   return replace(nStart, nLen, str.substr(nStart2, nLen2));
1070 }
1071
1072 wxString& wxString::replace(size_t nStart, size_t nLen,
1073                         const char* sz, size_t nCount)
1074 {
1075   return replace(nStart, nLen, wxString(sz, nCount));
1076 }
1077
1078 #endif  //std::string compatibility
1079
1080 // ============================================================================
1081 // ArrayString
1082 // ============================================================================
1083
1084 // size increment = max(50% of current size, ARRAY_MAXSIZE_INCREMENT)
1085 #define   ARRAY_MAXSIZE_INCREMENT       4096
1086 #ifndef   ARRAY_DEFAULT_INITIAL_SIZE    // also defined in dynarray.h
1087   #define   ARRAY_DEFAULT_INITIAL_SIZE    (16)
1088 #endif
1089
1090 #define   STRING(p)   ((wxString *)(&(p)))
1091
1092 // ctor
1093 wxArrayString::wxArrayString()
1094 {
1095   m_nSize  =
1096   m_nCount = 0;
1097   m_pItems = (char **) NULL;
1098 }
1099
1100 // copy ctor
1101 wxArrayString::wxArrayString(const wxArrayString& src)
1102 {
1103   m_nSize  =
1104   m_nCount = 0;
1105   m_pItems = (char **) NULL;
1106
1107   *this = src;
1108 }
1109
1110 // assignment operator
1111 wxArrayString& wxArrayString::operator=(const wxArrayString& src)
1112 {
1113   if ( m_nSize > 0 )
1114     Clear();
1115
1116   if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE )
1117     Alloc(src.m_nCount);
1118
1119   // we can't just copy the pointers here because otherwise we would share
1120   // the strings with another array
1121   for ( size_t n = 0; n < src.m_nCount; n++ )
1122     Add(src[n]);
1123
1124   if ( m_nCount != 0 )
1125     memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(char *));
1126
1127   return *this;
1128 }
1129
1130 // grow the array
1131 void wxArrayString::Grow()
1132 {
1133   // only do it if no more place
1134   if( m_nCount == m_nSize ) {
1135     if( m_nSize == 0 ) {
1136       // was empty, alloc some memory
1137       m_nSize = ARRAY_DEFAULT_INITIAL_SIZE;
1138       m_pItems = new char *[m_nSize];
1139     }
1140     else {
1141       // otherwise when it's called for the first time, nIncrement would be 0
1142       // and the array would never be expanded
1143       wxASSERT( ARRAY_DEFAULT_INITIAL_SIZE != 0 );
1144
1145       // add 50% but not too much
1146       size_t nIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE
1147                           ? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1;
1148       if ( nIncrement > ARRAY_MAXSIZE_INCREMENT )
1149         nIncrement = ARRAY_MAXSIZE_INCREMENT;
1150       m_nSize += nIncrement;
1151       char **pNew = new char *[m_nSize];
1152
1153       // copy data to new location
1154       memcpy(pNew, m_pItems, m_nCount*sizeof(char *));
1155
1156       // delete old memory (but do not release the strings!)
1157       wxDELETEA(m_pItems);
1158
1159       m_pItems = pNew;
1160     }
1161   }
1162 }
1163
1164 void wxArrayString::Free()
1165 {
1166   for ( size_t n = 0; n < m_nCount; n++ ) {
1167     STRING(m_pItems[n])->GetStringData()->Unlock();
1168   }
1169 }
1170
1171 // deletes all the strings from the list
1172 void wxArrayString::Empty()
1173 {
1174   Free();
1175
1176   m_nCount = 0;
1177 }
1178
1179 // as Empty, but also frees memory
1180 void wxArrayString::Clear()
1181 {
1182   Free();
1183
1184   m_nSize  =
1185   m_nCount = 0;
1186
1187   wxDELETEA(m_pItems);
1188 }
1189
1190 // dtor
1191 wxArrayString::~wxArrayString()
1192 {
1193   Free();
1194
1195   wxDELETEA(m_pItems);
1196 }
1197
1198 // pre-allocates memory (frees the previous data!)
1199 void wxArrayString::Alloc(size_t nSize)
1200 {
1201   wxASSERT( nSize > 0 );
1202
1203   // only if old buffer was not big enough
1204   if ( nSize > m_nSize ) {
1205     Free();
1206     wxDELETEA(m_pItems);
1207     m_pItems = new char *[nSize];
1208     m_nSize  = nSize;
1209   }
1210
1211   m_nCount = 0;
1212 }
1213
1214 // searches the array for an item (forward or backwards)
1215 int wxArrayString::Index(const char *sz, bool bCase, bool bFromEnd) const
1216 {
1217   if ( bFromEnd ) {
1218     if ( m_nCount > 0 ) {
1219       size_t ui = m_nCount;
1220       do {
1221         if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) )
1222           return ui;
1223       }
1224       while ( ui != 0 );
1225     }
1226   }
1227   else {
1228     for( size_t ui = 0; ui < m_nCount; ui++ ) {
1229       if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) )
1230         return ui;
1231     }
1232   }
1233
1234   return NOT_FOUND;
1235 }
1236
1237 // add item at the end
1238 void wxArrayString::Add(const wxString& str)
1239 {
1240   wxASSERT( str.GetStringData()->IsValid() );
1241
1242   Grow();
1243
1244   // the string data must not be deleted!
1245   str.GetStringData()->Lock();
1246   m_pItems[m_nCount++] = (char *)str.c_str();
1247 }
1248
1249 // add item at the given position
1250 void wxArrayString::Insert(const wxString& str, size_t nIndex)
1251 {
1252   wxASSERT( str.GetStringData()->IsValid() );
1253
1254   wxCHECK_RET( nIndex <= m_nCount, ("bad index in wxArrayString::Insert") );
1255
1256   Grow();
1257
1258   memmove(&m_pItems[nIndex + 1], &m_pItems[nIndex],
1259           (m_nCount - nIndex)*sizeof(char *));
1260
1261   str.GetStringData()->Lock();
1262   m_pItems[nIndex] = (char *)str.c_str();
1263
1264   m_nCount++;
1265 }
1266
1267 // removes item from array (by index)
1268 void wxArrayString::Remove(size_t nIndex)
1269 {
1270   wxCHECK_RET( nIndex <= m_nCount, _("bad index in wxArrayString::Remove") );
1271
1272   // release our lock
1273   Item(nIndex).GetStringData()->Unlock();
1274
1275   memmove(&m_pItems[nIndex], &m_pItems[nIndex + 1],
1276           (m_nCount - nIndex - 1)*sizeof(char *));
1277   m_nCount--;
1278 }
1279
1280 // removes item from array (by value)
1281 void wxArrayString::Remove(const char *sz)
1282 {
1283   int iIndex = Index(sz);
1284
1285   wxCHECK_RET( iIndex != NOT_FOUND,
1286                _("removing inexistent element in wxArrayString::Remove") );
1287
1288   Remove(iIndex);
1289 }
1290
1291 // sort array elements using passed comparaison function
1292
1293 void wxArrayString::Sort(bool WXUNUSED(bCase), bool WXUNUSED(bReverse) )
1294 {
1295   //@@@@ TO DO
1296   //qsort(m_pItems, m_nCount, sizeof(char *), fCmp);
1297 }