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, but it happens quite rarely,
 445   // so we don't waste our time checking for it
 446   // if ( nSrcLen > 0 )
 447   wxStringData *pData = GetStringData();
 448   size_t nLen = pData->nDataLength;
 449   size_t nNewLen = nLen + nSrcLen;
 450
 451   // alloc new buffer if current is too small
 452   if ( pData->IsShared() ) {
 453     STATISTICS_ADD(ConcatHit, 0);
 454
 455     // we have to allocate another buffer
 456     wxStringData* pOldData = GetStringData();
 457     AllocBuffer(nNewLen);
 458     memcpy(m_pchData, pOldData->data(), nLen*sizeof(char));
 459     pOldData->Unlock();
 460   }
 461   else if ( nNewLen > pData->nAllocLength ) {
 462     STATISTICS_ADD(ConcatHit, 0);
 463
 464     // we have to grow the buffer
 465     Alloc(nNewLen);
 466   }
 467   else {
 468     STATISTICS_ADD(ConcatHit, 1);
 469
 470     // the buffer is already big enough
 471   }
 472
 473   // should be enough space
 474   wxASSERT( nNewLen <= GetStringData()->nAllocLength );
 475
 476   // fast concatenation - all is done in our buffer
 477   memcpy(m_pchData + nLen, pszSrcData, nSrcLen*sizeof(char));
 478
 479   m_pchData[nNewLen] = '\0';              // put terminating '\0'
 480   GetStringData()->nDataLength = nNewLen; // and fix the length
 481 }
 482
 483 /*
 484  * concatenation functions come in 5 flavours:
 485  *  string + string
 486  *  char   + string      and      string + char
 487  *  C str  + string      and      string + C str
 488  */
 489
 490 wxString operator+(const wxString& string1, const wxString& string2)
 491 {
 492   wxASSERT( string1.GetStringData()->IsValid() );
 493   wxASSERT( string2.GetStringData()->IsValid() );
 494
 495   wxString s = string1;
 496   s += string2;
 497
 498   return s;
 499 }
 500
 501 wxString operator+(const wxString& string, char ch)
 502 {
 503   wxASSERT( string.GetStringData()->IsValid() );
 504
 505   wxString s = string;
 506   s += ch;
 507
 508   return s;
 509 }
 510
 511 wxString operator+(char ch, const wxString& string)
 512 {
 513   wxASSERT( string.GetStringData()->IsValid() );
 514
 515   wxString s = ch;
 516   s += string;
 517
 518   return s;
 519 }
 520
 521 wxString operator+(const wxString& string, const char *psz)
 522 {
 523   wxASSERT( string.GetStringData()->IsValid() );
 524
 525   wxString s;
 526   s.Alloc(Strlen(psz) + string.Len());
 527   s = string;
 528   s += psz;
 529
 530   return s;
 531 }
 532
 533 wxString operator+(const char *psz, const wxString& string)
 534 {
 535   wxASSERT( string.GetStringData()->IsValid() );
 536
 537   wxString s;
 538   s.Alloc(Strlen(psz) + string.Len());
 539   s = psz;
 540   s += string;
 541
 542   return s;
 543 }
 544
 545 // ===========================================================================
 546 // other common string functions
 547 // ===========================================================================
 548
 549 // ---------------------------------------------------------------------------
 550 // simple sub-string extraction
 551 // ---------------------------------------------------------------------------
 552
 553 // helper function: clone the data attached to this string
 554 void wxString::AllocCopy(wxString& dest, int nCopyLen, int nCopyIndex) const
 555 {
 556   if ( nCopyLen == 0 ) {
 557     dest.Init();
 558   }
 559   else {
 560     dest.AllocBuffer(nCopyLen);
 561     memcpy(dest.m_pchData, m_pchData + nCopyIndex, nCopyLen*sizeof(char));
 562   }
 563 }
 564
 565 // extract string of length nCount starting at nFirst
 566 // default value of nCount is 0 and means "till the end"
 567 wxString wxString::Mid(size_t nFirst, size_t nCount) const
 568 {
 569   // out-of-bounds requests return sensible things
 570   if ( nCount == 0 )
 571     nCount = GetStringData()->nDataLength - nFirst;
 572
 573   if ( nFirst + nCount > (size_t)GetStringData()->nDataLength )
 574     nCount = GetStringData()->nDataLength - nFirst;
 575   if ( nFirst > (size_t)GetStringData()->nDataLength )
 576     nCount = 0;
 577
 578   wxString dest;
 579   AllocCopy(dest, nCount, nFirst);
 580   return dest;
 581 }
 582
 583 // extract nCount last (rightmost) characters
 584 wxString wxString::Right(size_t nCount) const
 585 {
 586   if ( nCount > (size_t)GetStringData()->nDataLength )
 587     nCount = GetStringData()->nDataLength;
 588
 589   wxString dest;
 590   AllocCopy(dest, nCount, GetStringData()->nDataLength - nCount);
 591   return dest;
 592 }
 593
 594 // get all characters after the last occurence of ch
 595 // (returns the whole string if ch not found)
 596 wxString wxString::Right(char ch) const
 597 {
 598   wxString str;
 599   int iPos = Find(ch, TRUE);
 600   if ( iPos == NOT_FOUND )
 601     str = *this;
 602   else
 603     str = c_str() + iPos + 1;
 604
 605   return str;
 606 }
 607
 608 // extract nCount first (leftmost) characters
 609 wxString wxString::Left(size_t nCount) const
 610 {
 611   if ( nCount > (size_t)GetStringData()->nDataLength )
 612     nCount = GetStringData()->nDataLength;
 613
 614   wxString dest;
 615   AllocCopy(dest, nCount, 0);
 616   return dest;
 617 }
 618
 619 // get all characters before the first occurence of ch
 620 // (returns the whole string if ch not found)
 621 wxString wxString::Left(char ch) const
 622 {
 623   wxString str;
 624   for ( const char *pc = m_pchData; *pc != '\0' && *pc != ch; pc++ )
 625     str += *pc;
 626
 627   return str;
 628 }
 629
 630 /// get all characters before the last occurence of ch
 631 /// (returns empty string if ch not found)
 632 wxString wxString::Before(char ch) const
 633 {
 634   wxString str;
 635   int iPos = Find(ch, TRUE);
 636   if ( iPos != NOT_FOUND && iPos != 0 )
 637     str = wxString(c_str(), iPos);
 638
 639   return str;
 640 }
 641
 642 /// get all characters after the first occurence of ch
 643 /// (returns empty string if ch not found)
 644 wxString wxString::After(char ch) const
 645 {
 646   wxString str;
 647   int iPos = Find(ch);
 648   if ( iPos != NOT_FOUND )
 649     str = c_str() + iPos + 1;
 650
 651   return str;
 652 }
 653
 654 // replace first (or all) occurences of some substring with another one
 655 size_t wxString::Replace(const char *szOld, const char *szNew, bool bReplaceAll)
 656 {
 657   size_t uiCount = 0;   // count of replacements made
 658
 659   size_t uiOldLen = Strlen(szOld);
 660
 661   wxString strTemp;
 662   const char *pCurrent = m_pchData;
 663   const char *pSubstr;
 664   while ( *pCurrent != '\0' ) {
 665     pSubstr = strstr(pCurrent, szOld);
 666     if ( pSubstr == NULL ) {
 667       // strTemp is unused if no replacements were made, so avoid the copy
 668       if ( uiCount == 0 )
 669         return 0;
 670
 671       strTemp += pCurrent;    // copy the rest
 672       break;                  // exit the loop
 673     }
 674     else {
 675       // take chars before match
 676       strTemp.ConcatSelf(pSubstr - pCurrent, pCurrent);
 677       strTemp += szNew;
 678       pCurrent = pSubstr + uiOldLen;  // restart after match
 679
 680       uiCount++;
 681
 682       // stop now?
 683       if ( !bReplaceAll ) {
 684         strTemp += pCurrent;    // copy the rest
 685         break;                  // exit the loop
 686       }
 687     }
 688   }
 689
 690   // only done if there were replacements, otherwise would have returned above
 691   *this = strTemp;
 692
 693   return uiCount;
 694 }
 695
 696 bool wxString::IsAscii() const
 697 {
 698   const char *s = (const char*) *this;
 699   while(*s){
 700     if(!isascii(*s)) return(FALSE);
 701     s++;
 702   }
 703   return(TRUE);
 704 }
 705
 706 bool wxString::IsWord() const
 707 {
 708   const char *s = (const char*) *this;
 709   while(*s){
 710     if(!isalpha(*s)) return(FALSE);
 711     s++;
 712   }
 713   return(TRUE);
 714 }
 715
 716 bool wxString::IsNumber() const
 717 {
 718   const char *s = (const char*) *this;
 719   while(*s){
 720     if(!isdigit(*s)) return(FALSE);
 721     s++;
 722   }
 723   return(TRUE);
 724 }
 725
 726 wxString wxString::Strip(stripType w) const
 727 {
 728     wxString s = *this;
 729     if ( w & leading ) s.Trim(FALSE);
 730     if ( w & trailing ) s.Trim(TRUE);
 731     return s;
 732 }
 733
 734 // ---------------------------------------------------------------------------
 735 // case conversion
 736 // ---------------------------------------------------------------------------
 737
 738 wxString& wxString::MakeUpper()
 739 {
 740   CopyBeforeWrite();
 741
 742   for ( char *p = m_pchData; *p; p++ )
 743     *p = (char)toupper(*p);
 744
 745   return *this;
 746 }
 747
 748 wxString& wxString::MakeLower()
 749 {
 750   CopyBeforeWrite();
 751
 752   for ( char *p = m_pchData; *p; p++ )
 753     *p = (char)tolower(*p);
 754
 755   return *this;
 756 }
 757
 758 // ---------------------------------------------------------------------------
 759 // trimming and padding
 760 // ---------------------------------------------------------------------------
 761
 762 // trims spaces (in the sense of isspace) from left or right side
 763 wxString& wxString::Trim(bool bFromRight)
 764 {
 765   CopyBeforeWrite();
 766
 767   if ( bFromRight )
 768   {
 769     // find last non-space character
 770     char *psz = m_pchData + GetStringData()->nDataLength - 1;
 771     while ( isspace(*psz) && (psz >= m_pchData) )
 772       psz--;
 773
 774     // truncate at trailing space start
 775     *++psz = '\0';
 776     GetStringData()->nDataLength = psz - m_pchData;
 777   }
 778   else
 779   {
 780     // find first non-space character
 781     const char *psz = m_pchData;
 782     while ( isspace(*psz) )
 783       psz++;
 784
 785     // fix up data and length
 786     int nDataLength = GetStringData()->nDataLength - (psz - m_pchData);
 787     memmove(m_pchData, psz, (nDataLength + 1)*sizeof(char));
 788     GetStringData()->nDataLength = nDataLength;
 789   }
 790
 791   return *this;
 792 }
 793
 794 // adds nCount characters chPad to the string from either side
 795 wxString& wxString::Pad(size_t nCount, char chPad, bool bFromRight)
 796 {
 797   wxString s(chPad, nCount);
 798
 799   if ( bFromRight )
 800     *this += s;
 801   else
 802   {
 803     s += *this;
 804     *this = s;
 805   }
 806
 807   return *this;
 808 }
 809
 810 // truncate the string
 811 wxString& wxString::Truncate(size_t uiLen)
 812 {
 813   *(m_pchData + uiLen) = '\0';
 814   GetStringData()->nDataLength = uiLen;
 815
 816   return *this;
 817 }
 818
 819 // ---------------------------------------------------------------------------
 820 // finding (return NOT_FOUND if not found and index otherwise)
 821 // ---------------------------------------------------------------------------
 822
 823 // find a character
 824 int wxString::Find(char ch, bool bFromEnd) const
 825 {
 826   const char *psz = bFromEnd ? strrchr(m_pchData, ch) : strchr(m_pchData, ch);
 827
 828   return (psz == NULL) ? NOT_FOUND : psz - m_pchData;
 829 }
 830
 831 // find a sub-string (like strstr)
 832 int wxString::Find(const char *pszSub) const
 833 {
 834   const char *psz = strstr(m_pchData, pszSub);
 835
 836   return (psz == NULL) ? NOT_FOUND : psz - m_pchData;
 837 }
 838
 839 // ---------------------------------------------------------------------------
 840 // formatted output
 841 // ---------------------------------------------------------------------------
 842 int wxString::Printf(const char *pszFormat, ...)
 843 {
 844   va_list argptr;
 845   va_start(argptr, pszFormat);
 846
 847   int iLen = PrintfV(pszFormat, argptr);
 848
 849   va_end(argptr);
 850
 851   return iLen;
 852 }
 853
 854 int wxString::PrintfV(const char* pszFormat, va_list argptr)
 855 {
 856   static char s_szScratch[1024];
 857
 858   int iLen = vsprintf(s_szScratch, pszFormat, argptr);
 859   AllocBeforeWrite(iLen);
 860   strcpy(m_pchData, s_szScratch);
 861
 862   return iLen;
 863 }
 864
 865 // ----------------------------------------------------------------------------
 866 // misc other operations
 867 // ----------------------------------------------------------------------------
 868 bool wxString::Matches(const char *pszMask) const
 869 {
 870   // check char by char
 871   const char *pszTxt;
 872   for ( pszTxt = c_str(); *pszMask != '\0'; pszMask++, pszTxt++ ) {
 873     switch ( *pszMask ) {
 874       case '?':
 875         if ( *pszTxt == '\0' )
 876           return FALSE;
 877
 878         pszTxt++;
 879         pszMask++;
 880         break;
 881
 882       case '*':
 883         {
 884           // ignore special chars immediately following this one
 885           while ( *pszMask == '*' || *pszMask == '?' )
 886             pszMask++;
 887
 888           // if there is nothing more, match
 889           if ( *pszMask == '\0' )
 890             return TRUE;
 891
 892           // are there any other metacharacters in the mask?
 893           size_t uiLenMask;
 894           const char *pEndMask = strpbrk(pszMask, "*?");
 895
 896           if ( pEndMask != NULL ) {
 897             // we have to match the string between two metachars
 898             uiLenMask = pEndMask - pszMask;
 899           }
 900           else {
 901             // we have to match the remainder of the string
 902             uiLenMask = strlen(pszMask);
 903           }
 904
 905           wxString strToMatch(pszMask, uiLenMask);
 906           const char* pMatch = strstr(pszTxt, strToMatch);
 907           if ( pMatch == NULL )
 908             return FALSE;
 909
 910           // -1 to compensate "++" in the loop
 911           pszTxt = pMatch + uiLenMask - 1;
 912           pszMask += uiLenMask - 1;
 913         }
 914         break;
 915
 916       default:
 917         if ( *pszMask != *pszTxt )
 918           return FALSE;
 919         break;
 920     }
 921   }
 922
 923   // match only if nothing left
 924   return *pszTxt == '\0';
 925 }
 926
 927 // ---------------------------------------------------------------------------
 928 // standard C++ library string functions
 929 // ---------------------------------------------------------------------------
 930 #ifdef  STD_STRING_COMPATIBILITY
 931
 932 wxString& wxString::insert(size_t nPos, const wxString& str)
 933 {
 934   wxASSERT( str.GetStringData()->IsValid() );
 935   wxASSERT( nPos <= Len() );
 936
 937   if ( !str.IsEmpty() ) {
 938     wxString strTmp;
 939     char *pc = strTmp.GetWriteBuf(Len() + str.Len());
 940     strncpy(pc, c_str(), nPos);
 941     strcpy(pc + nPos, str);
 942     strcpy(pc + nPos + str.Len(), c_str() + nPos);
 943     strTmp.UngetWriteBuf();
 944     *this = strTmp;
 945   }
 946
 947   return *this;
 948 }
 949
 950 size_t wxString::find(const wxString& str, size_t nStart) const
 951 {
 952   wxASSERT( str.GetStringData()->IsValid() );
 953   wxASSERT( nStart <= Len() );
 954
 955   const char *p = strstr(c_str() + nStart, str);
 956
 957   return p == NULL ? npos : p - c_str();
 958 }
 959
 960 // VC++ 1.5 can't cope with the default argument in the header.
 961 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
 962 size_t wxString::find(const char* sz, size_t nStart, size_t n) const
 963 {
 964   return find(wxString(sz, n == npos ? 0 : n), nStart);
 965 }
 966 #endif
 967
 968 size_t wxString::find(char ch, size_t nStart) const
 969 {
 970   wxASSERT( nStart <= Len() );
 971
 972   const char *p = strchr(c_str() + nStart, ch);
 973
 974   return p == NULL ? npos : p - c_str();
 975 }
 976
 977 size_t wxString::rfind(const wxString& str, size_t nStart) const
 978 {
 979   wxASSERT( str.GetStringData()->IsValid() );
 980   wxASSERT( nStart <= Len() );
 981
 982   // # could be quicker than that
 983   const char *p = c_str() + (nStart == npos ? Len() : nStart);
 984   while ( p >= c_str() + str.Len() ) {
 985     if ( strncmp(p - str.Len(), str, str.Len()) == 0 )
 986       return p - str.Len() - c_str();
 987     p--;
 988   }
 989
 990   return npos;
 991 }
 992
 993 // VC++ 1.5 can't cope with the default argument in the header.
 994 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
 995 size_t wxString::rfind(const char* sz, size_t nStart, size_t n) const
 996 {
 997   return rfind(wxString(sz, n == npos ? 0 : n), nStart);
 998 }
 999
1000 size_t wxString::rfind(char ch, size_t nStart) const
1001 {
1002   wxASSERT( nStart <= Len() );
1003
1004   const char *p = strrchr(c_str() + nStart, ch);
1005
1006   return p == NULL ? npos : p - c_str();
1007 }
1008 #endif
1009
1010 wxString wxString::substr(size_t nStart, size_t nLen) const
1011 {
1012   // npos means 'take all'
1013   if ( nLen == npos )
1014     nLen = 0;
1015
1016   wxASSERT( nStart + nLen <= Len() );
1017
1018   return wxString(c_str() + nStart, nLen == npos ? 0 : nLen);
1019 }
1020
1021 wxString& wxString::erase(size_t nStart, size_t nLen)
1022 {
1023   wxString strTmp(c_str(), nStart);
1024   if ( nLen != npos ) {
1025     wxASSERT( nStart + nLen <= Len() );
1026
1027     strTmp.append(c_str() + nStart + nLen);
1028   }
1029
1030   *this = strTmp;
1031   return *this;
1032 }
1033
1034 wxString& wxString::replace(size_t nStart, size_t nLen, const char *sz)
1035 {
1036   wxASSERT( nStart + nLen <= Strlen(sz) );
1037
1038   wxString strTmp;
1039   if ( nStart != 0 )
1040     strTmp.append(c_str(), nStart);
1041   strTmp += sz;
1042   strTmp.append(c_str() + nStart + nLen);
1043
1044   *this = strTmp;
1045   return *this;
1046 }
1047
1048 wxString& wxString::replace(size_t nStart, size_t nLen, size_t nCount, char ch)
1049 {
1050   return replace(nStart, nLen, wxString(ch, nCount));
1051 }
1052
1053 wxString& wxString::replace(size_t nStart, size_t nLen,
1054                             const wxString& str, size_t nStart2, size_t nLen2)
1055 {
1056   return replace(nStart, nLen, str.substr(nStart2, nLen2));
1057 }
1058
1059 wxString& wxString::replace(size_t nStart, size_t nLen,
1060                         const char* sz, size_t nCount)
1061 {
1062   return replace(nStart, nLen, wxString(sz, nCount));
1063 }
1064
1065 #endif  //std::string compatibility
1066
1067 // ============================================================================
1068 // ArrayString
1069 // ============================================================================
1070
1071 // size increment = max(50% of current size, ARRAY_MAXSIZE_INCREMENT)
1072 #define   ARRAY_MAXSIZE_INCREMENT       4096
1073 #ifndef   ARRAY_DEFAULT_INITIAL_SIZE    // also defined in dynarray.h
1074   #define   ARRAY_DEFAULT_INITIAL_SIZE    (16)
1075 #endif
1076
1077 #define   STRING(p)   ((wxString *)(&(p)))
1078
1079 // ctor
1080 wxArrayString::wxArrayString()
1081 {
1082   m_nSize  =
1083   m_nCount = 0;
1084   m_pItems = (char **) NULL;
1085 }
1086
1087 // copy ctor
1088 wxArrayString::wxArrayString(const wxArrayString& src)
1089 {
1090   m_nSize  =
1091   m_nCount = 0;
1092   m_pItems = (char **) NULL;
1093
1094   *this = src;
1095 }
1096
1097 // assignment operator
1098 wxArrayString& wxArrayString::operator=(const wxArrayString& src)
1099 {
1100   if ( m_nSize > 0 )
1101     Clear();
1102
1103   if ( src.m_nCount > ARRAY_DEFAULT_INITIAL_SIZE )
1104     Alloc(src.m_nCount);
1105
1106   // we can't just copy the pointers here because otherwise we would share
1107   // the strings with another array
1108   for ( size_t n = 0; n < src.m_nCount; n++ )
1109     Add(src[n]);
1110
1111   if ( m_nCount != 0 )
1112     memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(char *));
1113
1114   return *this;
1115 }
1116
1117 // grow the array
1118 void wxArrayString::Grow()
1119 {
1120   // only do it if no more place
1121   if( m_nCount == m_nSize ) {
1122     if( m_nSize == 0 ) {
1123       // was empty, alloc some memory
1124       m_nSize = ARRAY_DEFAULT_INITIAL_SIZE;
1125       m_pItems = new char *[m_nSize];
1126     }
1127     else {
1128       // otherwise when it's called for the first time, nIncrement would be 0
1129       // and the array would never be expanded
1130       wxASSERT( ARRAY_DEFAULT_INITIAL_SIZE != 0 );
1131
1132       // add 50% but not too much
1133       size_t nIncrement = m_nSize < ARRAY_DEFAULT_INITIAL_SIZE
1134                           ? ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1;
1135       if ( nIncrement > ARRAY_MAXSIZE_INCREMENT )
1136         nIncrement = ARRAY_MAXSIZE_INCREMENT;
1137       m_nSize += nIncrement;
1138       char **pNew = new char *[m_nSize];
1139
1140       // copy data to new location
1141       memcpy(pNew, m_pItems, m_nCount*sizeof(char *));
1142
1143       // delete old memory (but do not release the strings!)
1144       wxDELETEA(m_pItems);
1145
1146       m_pItems = pNew;
1147     }
1148   }
1149 }
1150
1151 void wxArrayString::Free()
1152 {
1153   for ( size_t n = 0; n < m_nCount; n++ ) {
1154     STRING(m_pItems[n])->GetStringData()->Unlock();
1155   }
1156 }
1157
1158 // deletes all the strings from the list
1159 void wxArrayString::Empty()
1160 {
1161   Free();
1162
1163   m_nCount = 0;
1164 }
1165
1166 // as Empty, but also frees memory
1167 void wxArrayString::Clear()
1168 {
1169   Free();
1170
1171   m_nSize  =
1172   m_nCount = 0;
1173
1174   wxDELETEA(m_pItems);
1175 }
1176
1177 // dtor
1178 wxArrayString::~wxArrayString()
1179 {
1180   Free();
1181
1182   wxDELETEA(m_pItems);
1183 }
1184
1185 // pre-allocates memory (frees the previous data!)
1186 void wxArrayString::Alloc(size_t nSize)
1187 {
1188   wxASSERT( nSize > 0 );
1189
1190   // only if old buffer was not big enough
1191   if ( nSize > m_nSize ) {
1192     Free();
1193     wxDELETEA(m_pItems);
1194     m_pItems = new char *[nSize];
1195     m_nSize  = nSize;
1196   }
1197
1198   m_nCount = 0;
1199 }
1200
1201 // searches the array for an item (forward or backwards)
1202 int wxArrayString::Index(const char *sz, bool bCase, bool bFromEnd) const
1203 {
1204   if ( bFromEnd ) {
1205     if ( m_nCount > 0 ) {
1206       size_t ui = m_nCount;
1207       do {
1208         if ( STRING(m_pItems[--ui])->IsSameAs(sz, bCase) )
1209           return ui;
1210       }
1211       while ( ui != 0 );
1212     }
1213   }
1214   else {
1215     for( size_t ui = 0; ui < m_nCount; ui++ ) {
1216       if( STRING(m_pItems[ui])->IsSameAs(sz, bCase) )
1217         return ui;
1218     }
1219   }
1220
1221   return NOT_FOUND;
1222 }
1223
1224 // add item at the end
1225 void wxArrayString::Add(const wxString& str)
1226 {
1227   wxASSERT( str.GetStringData()->IsValid() );
1228
1229   Grow();
1230
1231   // the string data must not be deleted!
1232   str.GetStringData()->Lock();
1233   m_pItems[m_nCount++] = (char *)str.c_str();
1234 }
1235
1236 // add item at the given position
1237 void wxArrayString::Insert(const wxString& str, size_t nIndex)
1238 {
1239   wxASSERT( str.GetStringData()->IsValid() );
1240
1241   wxCHECK_RET( nIndex <= m_nCount, ("bad index in wxArrayString::Insert") );
1242
1243   Grow();
1244
1245   memmove(&m_pItems[nIndex + 1], &m_pItems[nIndex],
1246           (m_nCount - nIndex)*sizeof(char *));
1247
1248   str.GetStringData()->Lock();
1249   m_pItems[nIndex] = (char *)str.c_str();
1250
1251   m_nCount++;
1252 }
1253
1254 // removes item from array (by index)
1255 void wxArrayString::Remove(size_t nIndex)
1256 {
1257   wxCHECK_RET( nIndex <= m_nCount, _("bad index in wxArrayString::Remove") );
1258
1259   // release our lock
1260   Item(nIndex).GetStringData()->Unlock();
1261
1262   memmove(&m_pItems[nIndex], &m_pItems[nIndex + 1],
1263           (m_nCount - nIndex - 1)*sizeof(char *));
1264   m_nCount--;
1265 }
1266
1267 // removes item from array (by value)
1268 void wxArrayString::Remove(const char *sz)
1269 {
1270   int iIndex = Index(sz);
1271
1272   wxCHECK_RET( iIndex != NOT_FOUND,
1273                _("removing inexistent element in wxArrayString::Remove") );
1274
1275   Remove(iIndex);
1276 }
1277
1278 // sort array elements using passed comparaison function
1279
1280 void wxArrayString::Sort(bool WXUNUSED(bCase), bool WXUNUSED(bReverse) )
1281 {
1282   //@@@@ TO DO
1283   //qsort(m_pItems, m_nCount, sizeof(char *), fCmp);
1284 }