include/wx/string.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        string.h
   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 #ifndef _WX_WXSTRINGH__
  13 #define _WX_WXSTRINGH__
  14
  15 #ifdef __GNUG__
  16 #pragma interface "string.h"
  17 #endif
  18
  19 /* Dependencies (should be included before this header):
  20  *         string.h
  21  *         stdio.h
  22  *         stdarg.h
  23  *         limits.h
  24  */
  25 #include <string.h>
  26 #include <stdio.h>
  27 #include <stdarg.h>
  28 #include <limits.h>
  29 #include <stdlib.h>
  30
  31 #ifndef  WX_PRECOMP
  32   #include "wx/defs.h"     // Robert Roebling
  33   #ifdef    WXSTRING_IS_WXOBJECT
  34     #include "wx/object.h"
  35   #endif
  36 #endif
  37
  38 #include "wx/debug.h"
  39
  40 /** @name wxString library
  41     @memo Efficient wxString class [more or less] compatible with MFC CString,
  42           wxWindows wxString and std::string and some handy functions
  43           missing from string.h.
  44   */
  45 //@{
  46
  47 // ---------------------------------------------------------------------------
  48 // macros
  49 // ---------------------------------------------------------------------------
  50
  51 /** @name Macros
  52     @memo You can switch off wxString/std::string compatibility if desired
  53  */
  54 /// compile the std::string compatibility functions
  55 #define   STD_STRING_COMPATIBILITY
  56
  57 /// define to derive wxString from wxObject
  58 #undef    WXSTRING_IS_WXOBJECT
  59
  60 /// maximum possible length for a string means "take all string" everywhere
  61 //  (as sizeof(StringData) is unknown here we substract 100)
  62 #define   STRING_MAXLEN     (UINT_MAX - 100)
  63
  64 // 'naughty' cast
  65 #define   WXSTRINGCAST (char *)(const char *)
  66
  67 // NB: works only inside wxString class
  68 #define   ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) < Len() )
  69
  70 // ---------------------------------------------------------------------------
  71 /** @name Global functions complementing standard C string library
  72     @memo replacements for strlen() and portable strcasecmp()
  73  */
  74 // ---------------------------------------------------------------------------
  75
  76 /// checks whether the passed in pointer is NULL and if the string is empty
  77 inline bool WXDLLEXPORT IsEmpty(const char *p) { return !p || !*p; }
  78
  79 /// safe version of strlen() (returns 0 if passed NULL pointer)
  80 inline size_t  WXDLLEXPORT Strlen(const char *psz)
  81   { return psz ? strlen(psz) : 0; }
  82
  83 /// portable strcasecmp/_stricmp
  84 inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2)
  85 {
  86 #if     defined(_MSC_VER)
  87   return _stricmp(psz1, psz2);
  88 #elif defined(__BORLANDC__)
  89   return stricmp(psz1, psz2);
  90 #elif   defined(__UNIX__) || defined(__GNUWIN32__)
  91   return strcasecmp(psz1, psz2);
  92 #else
  93   // almost all compilers/libraries provide this function (unfortunately under
  94   // different names), that's why we don't implement our own which will surely
  95   // be more efficient than this code (uncomment to use):
  96   /*
  97     register char c1, c2;
  98     do {
  99       c1 = tolower(*psz1++);
 100       c2 = tolower(*psz2++);
 101     } while ( c1 && (c1 == c2) );
 102
 103     return c1 - c2;
 104   */
 105
 106   #error  "Please define string case-insensitive compare for your OS/compiler"
 107 #endif  // OS/compiler
 108 }
 109
 110 // ----------------------------------------------------------------------------
 111 // global data
 112 // ----------------------------------------------------------------------------
 113
 114 // global pointer to empty string
 115 WXDLLEXPORT_DATA(extern const char*) g_szNul;
 116
 117 // return an empty wxString
 118 class WXDLLEXPORT wxString; // not yet defined
 119 inline const wxString& wxGetEmptyString() { return *(wxString *)&g_szNul; }
 120
 121 // ---------------------------------------------------------------------------
 122 // string data prepended with some housekeeping info (used by wxString class),
 123 // is never used directly (but had to be put here to allow inlining)
 124 // ---------------------------------------------------------------------------
 125 struct WXDLLEXPORT wxStringData
 126 {
 127   int     nRefs;        // reference count
 128   size_t  nDataLength,  // actual string length
 129           nAllocLength; // allocated memory size
 130
 131   // mimics declaration 'char data[nAllocLength]'
 132   char* data() const { return (char*)(this + 1); }
 133
 134   // empty string has a special ref count so it's never deleted
 135   bool  IsEmpty()   const { return nRefs == -1; }
 136   bool  IsShared()  const { return nRefs > 1;   }
 137
 138   // lock/unlock
 139   void  Lock()   { if ( !IsEmpty() ) nRefs++;                    }
 140   void  Unlock() { if ( !IsEmpty() && --nRefs == 0) free(this);  }
 141
 142   // if we had taken control over string memory (GetWriteBuf), it's
 143   // intentionally put in invalid state
 144   void  Validate(bool b)  { nRefs = b ? 1 : 0; }
 145   bool  IsValid() const   { return nRefs != 0; }
 146 };
 147
 148 // ---------------------------------------------------------------------------
 149 /**
 150     This is (yet another one) String class for C++ programmers. It doesn't use
 151     any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
 152     thus you should be able to compile it with practicaly any C++ compiler.
 153     This class uses copy-on-write technique, i.e. identical strings share the
 154     same memory as long as neither of them is changed.
 155
 156     This class aims to be as compatible as possible with the new standard
 157     std::string class, but adds some additional functions and should be
 158     at least as efficient than the standard implementation.
 159
 160     Performance note: it's more efficient to write functions which take
 161     "const String&" arguments than "const char *" if you assign the argument
 162     to another string.
 163
 164     It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
 165
 166     To do:
 167       - ressource support (string tables in ressources)
 168       - more wide character (UNICODE) support
 169       - regular expressions support
 170
 171 @memo     A non-template portable wxString class implementing copy-on-write.
 172 @author   VZ
 173 @version  1.3
 174 */
 175 // ---------------------------------------------------------------------------
 176 #ifdef  WXSTRING_IS_WXOBJECT
 177   class WXDLLEXPORT wxString : public wxObject
 178   {
 179     DECLARE_DYNAMIC_CLASS(wxString)
 180 #else   //WXSTRING_IS_WXOBJECT
 181   class WXDLLEXPORT wxString
 182   {
 183 #endif  //WXSTRING_IS_WXOBJECT
 184
 185 friend class WXDLLEXPORT wxArrayString;
 186
 187   // NB: special care was taken in arrangin the member functions in such order
 188   //     that all inline functions can be effectively inlined
 189 private:
 190   // points to data preceded by wxStringData structure with ref count info
 191   char *m_pchData;
 192
 193   // accessor to string data
 194   wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; }
 195
 196   // string (re)initialization functions
 197     // initializes the string to the empty value (must be called only from
 198     // ctors, use Reinit() otherwise)
 199   void Init() { m_pchData = (char *)g_szNul; }
 200     // initializaes the string with (a part of) C-string
 201   void InitWith(const char *psz, size_t nPos = 0, size_t nLen = STRING_MAXLEN);
 202     // as Init, but also frees old data
 203   void Reinit() { GetStringData()->Unlock(); Init(); }
 204
 205   // memory allocation
 206     // allocates memory for string of lenght nLen
 207   void AllocBuffer(size_t nLen);
 208     // copies data to another string
 209   void AllocCopy(wxString&, int, int) const;
 210     // effectively copies data to string
 211   void AssignCopy(size_t, const char *);
 212
 213   // append a (sub)string
 214   void ConcatSelf(int nLen, const char *src);
 215
 216   // functions called before writing to the string: they copy it if there
 217   // are other references to our data (should be the only owner when writing)
 218   void CopyBeforeWrite();
 219   void AllocBeforeWrite(size_t);
 220
 221 public:
 222   /** @name constructors & dtor */
 223   //@{
 224     /// ctor for an empty string
 225   wxString() { Init(); }
 226     /// copy ctor
 227   wxString(const wxString& stringSrc)
 228   {
 229     wxASSERT( stringSrc.GetStringData()->IsValid() );
 230
 231     if ( stringSrc.IsEmpty() ) {
 232       // nothing to do for an empty string
 233       Init();
 234     }
 235     else {
 236       m_pchData = stringSrc.m_pchData;            // share same data
 237       GetStringData()->Lock();                    // => one more copy
 238     }
 239   }
 240     /// string containing nRepeat copies of ch
 241   wxString(char ch, size_t nRepeat = 1);
 242     /// ctor takes first nLength characters from C string
 243     // (default value of STRING_MAXLEN means take all the string)
 244   wxString(const char *psz, size_t nLength = STRING_MAXLEN)
 245     { InitWith(psz, 0, nLength); }
 246     /// from C string (for compilers using unsigned char)
 247   wxString(const unsigned char* psz, size_t nLength = STRING_MAXLEN);
 248     /// from wide (UNICODE) string
 249   wxString(const wchar_t *pwz);
 250     /// dtor is not virtual, this class must not be inherited from!
 251  ~wxString() { GetStringData()->Unlock(); }
 252   //@}
 253
 254   /** @name generic attributes & operations */
 255   //@{
 256     /// as standard strlen()
 257   size_t Len() const { return GetStringData()->nDataLength; }
 258     /// string contains any characters?
 259   bool IsEmpty() const { return Len() == 0; }
 260     /// empty string contents
 261   void Empty()
 262   {
 263     if ( !IsEmpty() )
 264       Reinit();
 265
 266     // should be empty
 267     wxASSERT( GetStringData()->nDataLength == 0 );
 268   }
 269     /// empty the string and free memory
 270   void Clear()
 271   {
 272     if ( !GetStringData()->IsEmpty() )
 273       Reinit();
 274
 275     wxASSERT( GetStringData()->nDataLength == 0 );  // should be empty
 276     wxASSERT( GetStringData()->nAllocLength == 0 ); // and not own any memory
 277   }
 278
 279     /// Is an ascii value
 280   bool IsAscii() const;
 281     /// Is a number
 282   bool IsNumber() const;
 283     /// Is a word
 284   bool IsWord() const;
 285   //@}
 286
 287   /** @name data access (all indexes are 0 based) */
 288   //@{
 289     /// read access
 290     char  GetChar(size_t n) const
 291       { ASSERT_VALID_INDEX( n );  return m_pchData[n]; }
 292     /// read/write access
 293     char& GetWritableChar(size_t n)
 294       { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
 295     /// write access
 296     void  SetChar(size_t n, char ch)
 297       { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; }
 298
 299     /// get last character
 300     char  Last() const
 301       { wxASSERT( !IsEmpty() ); return m_pchData[Len() - 1]; }
 302     /// get writable last character
 303     char& Last()
 304       { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData[Len()-1]; }
 305
 306     /// operator version of GetChar
 307     char  operator[](size_t n) const
 308       { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
 309     /// operator version of GetChar
 310     char  operator[](int n) const
 311       { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
 312     /// operator version of GetWritableChar
 313     char& operator[](size_t n)
 314       { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
 315
 316     /// implicit conversion to C string
 317     operator const char*() const { return m_pchData; }
 318     /// explicit conversion to C string (use this with printf()!)
 319     const char* c_str()   const { return m_pchData; }
 320     ///
 321     const char* GetData() const { return m_pchData; }
 322   //@}
 323
 324   /** @name overloaded assignment */
 325   //@{
 326     ///
 327   wxString& operator=(const wxString& stringSrc);
 328     ///
 329   wxString& operator=(char ch);
 330     ///
 331   wxString& operator=(const char *psz);
 332     ///
 333   wxString& operator=(const unsigned char* psz);
 334     ///
 335   wxString& operator=(const wchar_t *pwz);
 336   //@}
 337
 338   /** @name string concatenation */
 339   //@{
 340     /** @name in place concatenation */
 341     /** @name concatenate and return the result
 342         left to right associativity of << allows to write
 343         things like "str << str1 << str2 << ..."          */
 344     //@{
 345       /// as +=
 346   wxString& operator<<(const wxString& s)
 347   {
 348     wxASSERT( s.GetStringData()->IsValid() );
 349
 350     ConcatSelf(s.Len(), s);
 351     return *this;
 352   }
 353       /// as +=
 354   wxString& operator<<(const char *psz)
 355     { ConcatSelf(Strlen(psz), psz); return *this; }
 356       /// as +=
 357   wxString& operator<<(char ch) { ConcatSelf(1, &ch); return *this; }
 358     //@}
 359
 360     //@{
 361       /// string += string
 362   void operator+=(const wxString& s) { (void)operator<<(s); }
 363       /// string += C string
 364   void operator+=(const char *psz) { (void)operator<<(psz); }
 365       /// string += char
 366   void operator+=(char ch) { (void)operator<<(ch); }
 367     //@}
 368
 369     /** @name return resulting string */
 370     //@{
 371       ///
 372   friend wxString WXDLLEXPORT operator+(const wxString& string1,  const wxString& string2);
 373       ///
 374   friend wxString WXDLLEXPORT operator+(const wxString& string, char ch);
 375       ///
 376   friend wxString WXDLLEXPORT operator+(char ch, const wxString& string);
 377       ///
 378   friend wxString WXDLLEXPORT operator+(const wxString& string, const char *psz);
 379       ///
 380   friend wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
 381     //@}
 382   //@}
 383
 384   /** @name stream-like functions */
 385   //@{
 386         /// insert an int into string
 387     wxString& operator<<(int i);
 388         /// insert a float into string
 389     wxString& operator<<(float f);
 390         /// insert a double into string
 391     wxString& operator<<(double d);
 392   //@}
 393
 394   /** @name string comparison */
 395   //@{
 396     /**
 397     case-sensitive comparison
 398     @return 0 if equal, +1 if greater or -1 if less
 399     @see CmpNoCase, IsSameAs
 400     */
 401   int  Cmp(const char *psz) const { return strcmp(c_str(), psz); }
 402     /**
 403     case-insensitive comparison, return code as for wxString::Cmp()
 404     @see: Cmp, IsSameAs
 405     */
 406   int  CmpNoCase(const char *psz) const { return Stricmp(c_str(), psz); }
 407     /**
 408     test for string equality, case-sensitive (default) or not
 409     @param   bCase is TRUE by default (case matters)
 410     @return  TRUE if strings are equal, FALSE otherwise
 411     @see     Cmp, CmpNoCase
 412     */
 413   bool IsSameAs(const char *psz, bool bCase = TRUE) const
 414     { return !(bCase ? Cmp(psz) : CmpNoCase(psz)); }
 415   //@}
 416
 417   /** @name other standard string operations */
 418   //@{
 419     /** @name simple sub-string extraction
 420      */
 421     //@{
 422       /**
 423       return substring starting at nFirst of length
 424       nCount (or till the end if nCount = default value)
 425       */
 426   wxString Mid(size_t nFirst, size_t nCount = STRING_MAXLEN) const;
 427       /// get first nCount characters
 428   wxString Left(size_t nCount) const;
 429       /// get all characters before the first occurence of ch
 430       /// (returns the whole string if ch not found)
 431   wxString Left(char ch) const;
 432       /// get all characters before the last occurence of ch
 433       /// (returns empty string if ch not found)
 434   wxString Before(char ch) const;
 435       /// get all characters after the first occurence of ch
 436       /// (returns empty string if ch not found)
 437   wxString After(char ch) const;
 438       /// get last nCount characters
 439   wxString Right(size_t nCount) const;
 440       /// get all characters after the last occurence of ch
 441       /// (returns the whole string if ch not found)
 442   wxString Right(char ch) const;
 443     //@}
 444
 445     /** @name case conversion */
 446     //@{
 447       ///
 448   wxString& MakeUpper();
 449       ///
 450   wxString& MakeLower();
 451     //@}
 452
 453     /** @name trimming/padding whitespace (either side) and truncating */
 454     //@{
 455       /// remove spaces from left or from right (default) side
 456   wxString& Trim(bool bFromRight = TRUE);
 457       /// add nCount copies chPad in the beginning or at the end (default)
 458   wxString& Pad(size_t nCount, char chPad = ' ', bool bFromRight = TRUE);
 459       /// truncate string to given length
 460   wxString& Truncate(size_t uiLen);
 461     //@}
 462
 463     /** @name searching and replacing */
 464     //@{
 465       /// searching (return starting index, or -1 if not found)
 466   int Find(char ch, bool bFromEnd = FALSE) const;   // like strchr/strrchr
 467       /// searching (return starting index, or -1 if not found)
 468   int Find(const char *pszSub) const;               // like strstr
 469       /**
 470       replace first (or all) occurences of substring with another one
 471       @param  bReplaceAll: global replace (default) or only the first occurence
 472       @return the number of replacements made
 473       */
 474   size_t Replace(const char *szOld, const char *szNew, bool bReplaceAll = TRUE);
 475     //@}
 476
 477     /// check if the string contents matches a mask containing '*' and '?'
 478   bool Matches(const char *szMask) const;
 479   //@}
 480
 481   /** @name formated input/output */
 482   //@{
 483     /// as sprintf(), returns the number of characters written or < 0 on error
 484   int Printf(const char *pszFormat, ...);
 485     /// as vprintf(), returns the number of characters written or < 0 on error
 486   int PrintfV(const char* pszFormat, va_list argptr);
 487   //@}
 488
 489   /** @name raw access to string memory */
 490   //@{
 491     /// ensure that string has space for at least nLen characters
 492     // only works if the data of this string is not shared
 493   void Alloc(size_t nLen);
 494     /// minimize the string's memory
 495     // only works if the data of this string is not shared
 496   void Shrink();
 497     /**
 498         get writable buffer of at least nLen bytes.
 499         Unget() *must* be called a.s.a.p. to put string back in a reasonable
 500         state!
 501      */
 502   char *GetWriteBuf(size_t nLen);
 503     /// call this immediately after GetWriteBuf() has been used
 504   void UngetWriteBuf();
 505   //@}
 506
 507   /** @name wxWindows compatibility functions */
 508   //@{
 509     /// values for second parameter of CompareTo function
 510   enum caseCompare {exact, ignoreCase};
 511     /// values for first parameter of Strip function
 512   enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
 513     /// same as Printf()
 514   inline int sprintf(const char *pszFormat, ...)
 515   {
 516     va_list argptr;
 517     va_start(argptr, pszFormat);
 518     int iLen = PrintfV(pszFormat, argptr);
 519     va_end(argptr);
 520     return iLen;
 521   }
 522
 523     /// same as Cmp
 524   inline int CompareTo(const char* psz, caseCompare cmp = exact) const
 525     { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
 526
 527     /// same as Mid (substring extraction)
 528   inline wxString  operator()(size_t start, size_t len) const
 529     { return Mid(start, len); }
 530
 531     /// same as += or <<
 532   inline wxString& Append(const char* psz) { return *this << psz; }
 533   inline wxString& Append(char ch, int count = 1)
 534     { wxString str(ch, count); (*this) += str; return *this; }
 535
 536     ///
 537   wxString& Prepend(const wxString& str)
 538     { *this = str + *this; return *this; }
 539     /// same as Len
 540   size_t Length() const { return Len(); }
 541     /// same as MakeLower
 542   void LowerCase() { MakeLower(); }
 543     /// same as MakeUpper
 544   void UpperCase() { MakeUpper(); }
 545     /// same as Trim except that it doesn't change this string
 546   wxString Strip(stripType w = trailing) const;
 547
 548     /// same as Find (more general variants not yet supported)
 549   size_t Index(const char* psz) const { return Find(psz); }
 550   size_t Index(char ch)         const { return Find(ch);  }
 551     /// same as Truncate
 552   wxString& Remove(size_t pos) { return Truncate(pos); }
 553   wxString& RemoveLast() { return Truncate(Len() - 1); }
 554
 555   wxString& Remove(size_t nStart, size_t nLen) { return erase( nStart, nLen ); }
 556
 557   int First( const char ch ) const { return Find(ch); }
 558   int First( const char* psz ) const { return Find(psz); }
 559   int First( const wxString &str ) const { return Find(str); }
 560
 561   int Last( const char ch ) const { return Find(ch, TRUE); }
 562
 563     /// same as IsEmpty
 564   bool IsNull() const { return IsEmpty(); }
 565   //@}
 566
 567 #ifdef  STD_STRING_COMPATIBILITY
 568   /** @name std::string compatibility functions */
 569
 570   /// an 'invalid' value for string index
 571   static const size_t npos;
 572
 573   //@{
 574     /** @name constructors */
 575     //@{
 576       /// take nLen chars starting at nPos
 577       wxString(const wxString& str, size_t nPos, size_t nLen = npos)
 578       {
 579         wxASSERT( str.GetStringData()->IsValid() );
 580         InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
 581       }
 582       /// take all characters from pStart to pEnd
 583       wxString(const void *pStart, const void *pEnd);
 584     //@}
 585     /** @name lib.string.capacity */
 586     //@{
 587       /// return the length of the string
 588       size_t size() const { return Len(); }
 589       /// return the length of the string
 590       size_t length() const { return Len(); }
 591       /// return the maximum size of the string
 592       size_t max_size() const { return STRING_MAXLEN; }
 593       /// resize the string, filling the space with c if c != 0
 594       void resize(size_t nSize, char ch = '\0');
 595       /// delete the contents of the string
 596       void clear() { Empty(); }
 597       /// returns true if the string is empty
 598       bool empty() const { return IsEmpty(); }
 599     //@}
 600     /** @name lib.string.access */
 601     //@{
 602       /// return the character at position n
 603       char at(size_t n) const { return GetChar(n); }
 604       /// returns the writable character at position n
 605       char& at(size_t n) { return GetWritableChar(n); }
 606     //@}
 607     /** @name lib.string.modifiers */
 608     //@{
 609       /** @name append something to the end of this one */
 610       //@{
 611         /// append a string
 612         wxString& append(const wxString& str)
 613           { *this += str; return *this; }
 614         /// append elements str[pos], ..., str[pos+n]
 615         wxString& append(const wxString& str, size_t pos, size_t n)
 616           { ConcatSelf(n, str.c_str() + pos); return *this; }
 617         /// append first n (or all if n == npos) characters of sz
 618         wxString& append(const char *sz, size_t n = npos)
 619           { ConcatSelf(n == npos ? Strlen(sz) : n, sz); return *this; }
 620
 621         /// append n copies of ch
 622         wxString& append(size_t n, char ch) { return Pad(n, ch); }
 623       //@}
 624
 625       /** @name replaces the contents of this string with another one */
 626       //@{
 627         /// same as `this_string = str'
 628         wxString& assign(const wxString& str) { return (*this) = str; }
 629         /// same as ` = str[pos..pos + n]
 630         wxString& assign(const wxString& str, size_t pos, size_t n)
 631           { return *this = wxString((const char *)str + pos, n); }
 632         /// same as `= first n (or all if n == npos) characters of sz'
 633         wxString& assign(const char *sz, size_t n = npos)
 634           { return *this = wxString(sz, n); }
 635         /// same as `= n copies of ch'
 636         wxString& assign(size_t n, char ch)
 637           { return *this = wxString(ch, n); }
 638
 639       //@}
 640
 641       /** @name inserts something at position nPos into this one */
 642       //@{
 643         /// insert another string
 644         wxString& insert(size_t nPos, const wxString& str);
 645         /// insert n chars of str starting at nStart (in str)
 646         wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
 647           { return insert(nPos, wxString((const char *)str + nStart, n)); }
 648
 649         /// insert first n (or all if n == npos) characters of sz
 650         wxString& insert(size_t nPos, const char *sz, size_t n = npos)
 651           { return insert(nPos, wxString(sz, n)); }
 652         /// insert n copies of ch
 653         wxString& insert(size_t nPos, size_t n, char ch)
 654           { return insert(nPos, wxString(ch, n)); }
 655
 656       //@}
 657
 658       /** @name deletes a part of the string */
 659       //@{
 660         /// delete characters from nStart to nStart + nLen
 661         wxString& erase(size_t nStart = 0, size_t nLen = npos);
 662       //@}
 663
 664       /** @name replaces a substring of this string with another one */
 665       //@{
 666          /// replaces the substring of length nLen starting at nStart
 667          wxString& replace(size_t nStart, size_t nLen, const char* sz);
 668          /// replaces the substring with nCount copies of ch
 669          wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch);
 670          /// replaces a substring with another substring
 671          wxString& replace(size_t nStart, size_t nLen,
 672                          const wxString& str, size_t nStart2, size_t nLen2);
 673          /// replaces the substring with first nCount chars of sz
 674          wxString& replace(size_t nStart, size_t nLen,
 675                          const char* sz, size_t nCount);
 676       //@}
 677     //@}
 678
 679     /// swap two strings
 680     void swap(wxString& str);
 681
 682     /** @name string operations */
 683     //@{
 684       /** All find() functions take the nStart argument which specifies
 685           the position to start the search on, the default value is 0.
 686
 687           All functions return npos if there were no match.
 688
 689           @name string search
 690       */
 691       //@{
 692         /**
 693             @name find a match for the string/character in this string
 694         */
 695         //@{
 696           /// find a substring
 697           size_t find(const wxString& str, size_t nStart = 0) const;
 698
 699           // VC++ 1.5 can't cope with this syntax.
 700 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
 701           /// find first n characters of sz
 702           size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
 703 #endif
 704           /// find the first occurence of character ch after nStart
 705           size_t find(char ch, size_t nStart = 0) const;
 706
 707           // wxWin compatibility
 708           inline bool Contains(const wxString& str) const { return Find(str) != -1; }
 709
 710         //@}
 711
 712         /**
 713           @name rfind() family is exactly like find() but works right to left
 714         */
 715         //@{
 716         /// as find, but from the end
 717         size_t rfind(const wxString& str, size_t nStart = npos) const;
 718         /// as find, but from the end
 719         // VC++ 1.5 can't cope with this syntax.
 720 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
 721         size_t rfind(const char* sz, size_t nStart = npos,
 722                      size_t n = npos) const;
 723         /// as find, but from the end
 724         size_t rfind(char ch, size_t nStart = npos) const;
 725 #endif
 726         //@}
 727
 728         /**
 729           @name find first/last occurence of any character in the set
 730         */
 731         //@{
 732           ///
 733           size_t find_first_of(const wxString& str, size_t nStart = 0) const;
 734           ///
 735           size_t find_first_of(const char* sz, size_t nStart = 0) const;
 736           /// same as find(char, size_t)
 737           size_t find_first_of(char c, size_t nStart = 0) const;
 738
 739           ///
 740           size_t find_last_of (const wxString& str, size_t nStart = npos) const;
 741           ///
 742           size_t find_last_of (const char* s, size_t nStart = npos) const;
 743           /// same as rfind(char, size_t)
 744           size_t find_last_of (char c, size_t nStart = npos) const;
 745         //@}
 746
 747         /**
 748           @name find first/last occurence of any character not in the set
 749         */
 750         //@{
 751           ///
 752           size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
 753           ///
 754           size_t find_first_not_of(const char* s, size_t nStart = 0) const;
 755           ///
 756           size_t find_first_not_of(char ch, size_t nStart = 0) const;
 757
 758           ///
 759           size_t find_last_not_of(const wxString& str, size_t nStart=npos) const;
 760           ///
 761           size_t find_last_not_of(const char* s, size_t nStart = npos) const;
 762           ///
 763           size_t find_last_not_of(char ch, size_t nStart = npos) const;
 764         //@}
 765       //@}
 766
 767       /**
 768         All compare functions return -1, 0 or 1 if the [sub]string
 769         is less, equal or greater than the compare() argument.
 770
 771         @name comparison
 772       */
 773       //@{
 774         /// just like strcmp()
 775         int compare(const wxString& str) const { return Cmp(str); }
 776         /// comparison with a substring
 777         int compare(size_t nStart, size_t nLen, const wxString& str) const;
 778         /// comparison of 2 substrings
 779         int compare(size_t nStart, size_t nLen,
 780                     const wxString& str, size_t nStart2, size_t nLen2) const;
 781         /// just like strcmp()
 782         int compare(const char* sz) const { return Cmp(sz); }
 783         /// substring comparison with first nCount characters of sz
 784         int compare(size_t nStart, size_t nLen,
 785                     const char* sz, size_t nCount = npos) const;
 786       //@}
 787     wxString substr(size_t nStart = 0, size_t nLen = npos) const;
 788   //@}
 789 #endif
 790 };
 791
 792 // ----------------------------------------------------------------------------
 793 /** The string array uses it's knowledge of internal structure of the String
 794     class to optimize string storage. Normally, we would store pointers to
 795     string, but as String is, in fact, itself a pointer (sizeof(String) is
 796     sizeof(char *)) we store these pointers instead. The cast to "String *"
 797     is really all we need to turn such pointer into a string!
 798
 799     Of course, it can be called a dirty hack, but we use twice less memory
 800     and this approach is also more speed efficient, so it's probably worth it.
 801
 802     Usage notes: when a string is added/inserted, a new copy of it is created,
 803     so the original string may be safely deleted. When a string is retrieved
 804     from the array (operator[] or Item() method), a reference is returned.
 805
 806     @name wxArrayString
 807     @memo probably the most commonly used array type - array of strings
 808  */
 809 // ----------------------------------------------------------------------------
 810 class WXDLLEXPORT wxArrayString
 811 {
 812 public:
 813   /** @name ctors and dtor */
 814   //@{
 815     /// default ctor
 816   wxArrayString();
 817     /// copy ctor
 818   wxArrayString(const wxArrayString& array);
 819     /// assignment operator
 820   wxArrayString& operator=(const wxArrayString& src);
 821     /// not virtual, this class can't be derived from
 822  ~wxArrayString();
 823   //@}
 824
 825   /** @name memory management */
 826   //@{
 827     /// empties the list, but doesn't release memory
 828   void Empty();
 829     /// empties the list and releases memory
 830   void Clear();
 831     /// preallocates memory for given number of items
 832   void Alloc(size_t nCount);
 833     /// minimzes the memory usage (by freeing all extra memory)
 834   void Shrink();
 835   //@}
 836
 837   /** @name simple accessors */
 838   //@{
 839     /// number of elements in the array
 840   size_t  Count() const   { return m_nCount;      }
 841     /// is it empty?
 842   bool  IsEmpty() const { return m_nCount == 0; }
 843   //@}
 844
 845   /** @name items access (range checking is done in debug version) */
 846   //@{
 847     /// get item at position uiIndex
 848   wxString& Item(size_t nIndex) const
 849     { wxASSERT( nIndex < m_nCount ); return *(wxString *)&(m_pItems[nIndex]); }
 850     /// same as Item()
 851   wxString& operator[](size_t nIndex) const { return Item(nIndex); }
 852     /// get last item
 853   wxString& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
 854   //@}
 855
 856   /** @name item management */
 857   //@{
 858     /**
 859       Search the element in the array, starting from the either side
 860       @param if bFromEnd reverse search direction
 861       @param if bCase, comparison is case sensitive (default)
 862       @return index of the first item matched or NOT_FOUND
 863       @see NOT_FOUND
 864      */
 865   int  Index (const char *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const;
 866     /// add new element at the end
 867   void Add   (const wxString& str);
 868     /// add new element at given position
 869   void Insert(const wxString& str, size_t uiIndex);
 870     /// remove first item matching this value
 871   void Remove(const char *sz);
 872     /// remove item by index
 873   void Remove(size_t nIndex);
 874   //@}
 875
 876   /// sort array elements
 877   void Sort(bool bCase = TRUE, bool bReverse = FALSE);
 878
 879 private:
 880   void    Grow();     // makes array bigger if needed
 881   void    Free();     // free the string stored
 882
 883   size_t    m_nSize,    // current size of the array
 884           m_nCount;   // current number of elements
 885
 886   char  **m_pItems;   // pointer to data
 887 };
 888
 889 // ---------------------------------------------------------------------------
 890 /** @name wxString comparison functions
 891     @memo Comparisons are case sensitive
 892  */
 893 // ---------------------------------------------------------------------------
 894 //@{
 895 inline bool operator==(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) == 0; }
 896 ///
 897 inline bool operator==(const wxString& s1, const char  * s2) { return s1.Cmp(s2) == 0; }
 898 ///
 899 inline bool operator==(const char  * s1, const wxString& s2) { return s2.Cmp(s1) == 0; }
 900 ///
 901 inline bool operator!=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) != 0; }
 902 ///
 903 inline bool operator!=(const wxString& s1, const char  * s2) { return s1.Cmp(s2) != 0; }
 904 ///
 905 inline bool operator!=(const char  * s1, const wxString& s2) { return s2.Cmp(s1) != 0; }
 906 ///
 907 inline bool operator< (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) <  0; }
 908 ///
 909 inline bool operator< (const wxString& s1, const char  * s2) { return s1.Cmp(s2) <  0; }
 910 ///
 911 inline bool operator< (const char  * s1, const wxString& s2) { return s2.Cmp(s1) >  0; }
 912 ///
 913 inline bool operator> (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) >  0; }
 914 ///
 915 inline bool operator> (const wxString& s1, const char  * s2) { return s1.Cmp(s2) >  0; }
 916 ///
 917 inline bool operator> (const char  * s1, const wxString& s2) { return s2.Cmp(s1) <  0; }
 918 ///
 919 inline bool operator<=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) <= 0; }
 920 ///
 921 inline bool operator<=(const wxString& s1, const char  * s2) { return s1.Cmp(s2) <= 0; }
 922 ///
 923 inline bool operator<=(const char  * s1, const wxString& s2) { return s2.Cmp(s1) >= 0; }
 924 ///
 925 inline bool operator>=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) >= 0; }
 926 ///
 927 inline bool operator>=(const wxString& s1, const char  * s2) { return s1.Cmp(s2) >= 0; }
 928 ///
 929 inline bool operator>=(const char  * s1, const wxString& s2) { return s2.Cmp(s1) <= 0; }
 930 //@}
 931 wxString WXDLLEXPORT operator+(const wxString& string1,  const wxString& string2);
 932 wxString WXDLLEXPORT operator+(const wxString& string, char ch);
 933 wxString WXDLLEXPORT operator+(char ch, const wxString& string);
 934 wxString WXDLLEXPORT operator+(const wxString& string, const char *psz);
 935 wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
 936
 937 // ---------------------------------------------------------------------------
 938 /** @name Global functions complementing standard C string library
 939     @memo replacements for strlen() and portable strcasecmp()
 940  */
 941 // ---------------------------------------------------------------------------
 942
 943 #ifdef  STD_STRING_COMPATIBILITY
 944
 945 // fwd decl
 946 // Known not to work with wxUSE_IOSTREAMH set to 0, so
 947 // replacing with includes (on advice of ungod@pasdex.com.au)
 948 // class WXDLLEXPORT istream;
 949 #if wxUSE_IOSTREAMH
 950 // N.B. BC++ doesn't have istream.h, ostream.h
 951 #include <iostream.h>
 952 #else
 953 #include <istream>
 954 #  ifdef _MSC_VER
 955       using namespace std;
 956 #  endif
 957 #endif
 958
 959 WXDLLEXPORT istream& operator>>(istream& is, wxString& str);
 960
 961 #endif  //std::string compatibility
 962
 963 #endif  // _WX_WXSTRINGH__
 964
 965 //@}