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 #ifdef __WXMSW__
 310     /// operator version of GetChar
 311     char  operator[](int n) const
 312       { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
 313 #endif
 314     /// operator version of GetWritableChar
 315     char& operator[](size_t n)
 316       { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
 317
 318     /// implicit conversion to C string
 319     operator const char*() const { return m_pchData; }
 320     /// explicit conversion to C string (use this with printf()!)
 321     const char* c_str()   const { return m_pchData; }
 322     ///
 323     const char* GetData() const { return m_pchData; }
 324   //@}
 325
 326   /** @name overloaded assignment */
 327   //@{
 328     ///
 329   wxString& operator=(const wxString& stringSrc);
 330     ///
 331   wxString& operator=(char ch);
 332     ///
 333   wxString& operator=(const char *psz);
 334     ///
 335   wxString& operator=(const unsigned char* psz);
 336     ///
 337   wxString& operator=(const wchar_t *pwz);
 338   //@}
 339
 340   /** @name string concatenation */
 341   //@{
 342     /** @name in place concatenation */
 343     /** @name concatenate and return the result
 344         left to right associativity of << allows to write
 345         things like "str << str1 << str2 << ..."          */
 346     //@{
 347       /// as +=
 348   wxString& operator<<(const wxString& s)
 349   {
 350     wxASSERT( s.GetStringData()->IsValid() );
 351
 352     ConcatSelf(s.Len(), s);
 353     return *this;
 354   }
 355       /// as +=
 356   wxString& operator<<(const char *psz)
 357     { ConcatSelf(Strlen(psz), psz); return *this; }
 358       /// as +=
 359   wxString& operator<<(char ch) { ConcatSelf(1, &ch); return *this; }
 360     //@}
 361
 362     //@{
 363       /// string += string
 364   void operator+=(const wxString& s) { (void)operator<<(s); }
 365       /// string += C string
 366   void operator+=(const char *psz) { (void)operator<<(psz); }
 367       /// string += char
 368   void operator+=(char ch) { (void)operator<<(ch); }
 369     //@}
 370
 371     /** @name return resulting string */
 372     //@{
 373       ///
 374   friend wxString WXDLLEXPORT operator+(const wxString& string1,  const wxString& string2);
 375       ///
 376   friend wxString WXDLLEXPORT operator+(const wxString& string, char ch);
 377       ///
 378   friend wxString WXDLLEXPORT operator+(char ch, const wxString& string);
 379       ///
 380   friend wxString WXDLLEXPORT operator+(const wxString& string, const char *psz);
 381       ///
 382   friend wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
 383     //@}
 384   //@}
 385
 386   /** @name stream-like functions */
 387   //@{
 388         /// insert an int into string
 389     wxString& operator<<(int i);
 390         /// insert a float into string
 391     wxString& operator<<(float f);
 392         /// insert a double into string
 393     wxString& operator<<(double d);
 394   //@}
 395
 396   /** @name string comparison */
 397   //@{
 398     /**
 399     case-sensitive comparison
 400     @return 0 if equal, +1 if greater or -1 if less
 401     @see CmpNoCase, IsSameAs
 402     */
 403   int  Cmp(const char *psz) const { return strcmp(c_str(), psz); }
 404     /**
 405     case-insensitive comparison, return code as for wxString::Cmp()
 406     @see: Cmp, IsSameAs
 407     */
 408   int  CmpNoCase(const char *psz) const { return Stricmp(c_str(), psz); }
 409     /**
 410     test for string equality, case-sensitive (default) or not
 411     @param   bCase is TRUE by default (case matters)
 412     @return  TRUE if strings are equal, FALSE otherwise
 413     @see     Cmp, CmpNoCase
 414     */
 415   bool IsSameAs(const char *psz, bool bCase = TRUE) const
 416     { return !(bCase ? Cmp(psz) : CmpNoCase(psz)); }
 417   //@}
 418
 419   /** @name other standard string operations */
 420   //@{
 421     /** @name simple sub-string extraction
 422      */
 423     //@{
 424       /**
 425       return substring starting at nFirst of length
 426       nCount (or till the end if nCount = default value)
 427       */
 428   wxString Mid(size_t nFirst, size_t nCount = STRING_MAXLEN) const;
 429       /// get first nCount characters
 430   wxString Left(size_t nCount) const;
 431       /// get all characters before the first occurence of ch
 432       /// (returns the whole string if ch not found)
 433   wxString Left(char ch) const;
 434       /// get all characters before the last occurence of ch
 435       /// (returns empty string if ch not found)
 436   wxString Before(char ch) const;
 437       /// get all characters after the first occurence of ch
 438       /// (returns empty string if ch not found)
 439   wxString After(char ch) const;
 440       /// get last nCount characters
 441   wxString Right(size_t nCount) const;
 442       /// get all characters after the last occurence of ch
 443       /// (returns the whole string if ch not found)
 444   wxString Right(char ch) const;
 445     //@}
 446
 447     /** @name case conversion */
 448     //@{
 449       ///
 450   wxString& MakeUpper();
 451       ///
 452   wxString& MakeLower();
 453     //@}
 454
 455     /** @name trimming/padding whitespace (either side) and truncating */
 456     //@{
 457       /// remove spaces from left or from right (default) side
 458   wxString& Trim(bool bFromRight = TRUE);
 459       /// add nCount copies chPad in the beginning or at the end (default)
 460   wxString& Pad(size_t nCount, char chPad = ' ', bool bFromRight = TRUE);
 461       /// truncate string to given length
 462   wxString& Truncate(size_t uiLen);
 463     //@}
 464
 465     /** @name searching and replacing */
 466     //@{
 467       /// searching (return starting index, or -1 if not found)
 468   int Find(char ch, bool bFromEnd = FALSE) const;   // like strchr/strrchr
 469       /// searching (return starting index, or -1 if not found)
 470   int Find(const char *pszSub) const;               // like strstr
 471       /**
 472       replace first (or all) occurences of substring with another one
 473       @param  bReplaceAll: global replace (default) or only the first occurence
 474       @return the number of replacements made
 475       */
 476   size_t Replace(const char *szOld, const char *szNew, bool bReplaceAll = TRUE);
 477     //@}
 478
 479     /// check if the string contents matches a mask containing '*' and '?'
 480   bool Matches(const char *szMask) const;
 481   //@}
 482
 483   /** @name formated input/output */
 484   //@{
 485     /// as sprintf(), returns the number of characters written or < 0 on error
 486   int Printf(const char *pszFormat, ...);
 487     /// as vprintf(), returns the number of characters written or < 0 on error
 488   int PrintfV(const char* pszFormat, va_list argptr);
 489   //@}
 490
 491   /** @name raw access to string memory */
 492   //@{
 493     /// ensure that string has space for at least nLen characters
 494     // only works if the data of this string is not shared
 495   void Alloc(size_t nLen);
 496     /// minimize the string's memory
 497     // only works if the data of this string is not shared
 498   void Shrink();
 499     /**
 500         get writable buffer of at least nLen bytes.
 501         Unget() *must* be called a.s.a.p. to put string back in a reasonable
 502         state!
 503      */
 504   char *GetWriteBuf(size_t nLen);
 505     /// call this immediately after GetWriteBuf() has been used
 506   void UngetWriteBuf();
 507   //@}
 508
 509   /** @name wxWindows compatibility functions */
 510   //@{
 511     /// values for second parameter of CompareTo function
 512   enum caseCompare {exact, ignoreCase};
 513     /// values for first parameter of Strip function
 514   enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
 515     /// same as Printf()
 516   inline int sprintf(const char *pszFormat, ...)
 517   {
 518     va_list argptr;
 519     va_start(argptr, pszFormat);
 520     int iLen = PrintfV(pszFormat, argptr);
 521     va_end(argptr);
 522     return iLen;
 523   }
 524
 525     /// same as Cmp
 526   inline int CompareTo(const char* psz, caseCompare cmp = exact) const
 527     { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
 528
 529     /// same as Mid (substring extraction)
 530   inline wxString  operator()(size_t start, size_t len) const
 531     { return Mid(start, len); }
 532
 533     /// same as += or <<
 534   inline wxString& Append(const char* psz) { return *this << psz; }
 535   inline wxString& Append(char ch, int count = 1)
 536     { wxString str(ch, count); (*this) += str; return *this; }
 537
 538     ///
 539   wxString& Prepend(const wxString& str)
 540     { *this = str + *this; return *this; }
 541     /// same as Len
 542   size_t Length() const { return Len(); }
 543     /// same as MakeLower
 544   void LowerCase() { MakeLower(); }
 545     /// same as MakeUpper
 546   void UpperCase() { MakeUpper(); }
 547     /// same as Trim except that it doesn't change this string
 548   wxString Strip(stripType w = trailing) const;
 549
 550     /// same as Find (more general variants not yet supported)
 551   size_t Index(const char* psz) const { return Find(psz); }
 552   size_t Index(char ch)         const { return Find(ch);  }
 553     /// same as Truncate
 554   wxString& Remove(size_t pos) { return Truncate(pos); }
 555   wxString& RemoveLast() { return Truncate(Len() - 1); }
 556
 557   wxString& Remove(size_t nStart, size_t nLen) { return erase( nStart, nLen ); }
 558
 559   int First( const char ch ) const { return Find(ch); }
 560   int First( const char* psz ) const { return Find(psz); }
 561   int First( const wxString &str ) const { return Find(str); }
 562
 563   int Last( const char ch ) const { return Find(ch, TRUE); }
 564
 565     /// same as IsEmpty
 566   bool IsNull() const { return IsEmpty(); }
 567   //@}
 568
 569 #ifdef  STD_STRING_COMPATIBILITY
 570   /** @name std::string compatibility functions */
 571
 572   /// an 'invalid' value for string index
 573   static const size_t npos;
 574
 575   //@{
 576     /** @name constructors */
 577     //@{
 578       /// take nLen chars starting at nPos
 579       wxString(const wxString& str, size_t nPos, size_t nLen = npos)
 580       {
 581         wxASSERT( str.GetStringData()->IsValid() );
 582         InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
 583       }
 584       /// take all characters from pStart to pEnd
 585       wxString(const void *pStart, const void *pEnd);
 586     //@}
 587     /** @name lib.string.capacity */
 588     //@{
 589       /// return the length of the string
 590       size_t size() const { return Len(); }
 591       /// return the length of the string
 592       size_t length() const { return Len(); }
 593       /// return the maximum size of the string
 594       size_t max_size() const { return STRING_MAXLEN; }
 595       /// resize the string, filling the space with c if c != 0
 596       void resize(size_t nSize, char ch = '\0');
 597       /// delete the contents of the string
 598       void clear() { Empty(); }
 599       /// returns true if the string is empty
 600       bool empty() const { return IsEmpty(); }
 601     //@}
 602     /** @name lib.string.access */
 603     //@{
 604       /// return the character at position n
 605       char at(size_t n) const { return GetChar(n); }
 606       /// returns the writable character at position n
 607       char& at(size_t n) { return GetWritableChar(n); }
 608     //@}
 609     /** @name lib.string.modifiers */
 610     //@{
 611       /** @name append something to the end of this one */
 612       //@{
 613         /// append a string
 614         wxString& append(const wxString& str)
 615           { *this += str; return *this; }
 616         /// append elements str[pos], ..., str[pos+n]
 617         wxString& append(const wxString& str, size_t pos, size_t n)
 618           { ConcatSelf(n, str.c_str() + pos); return *this; }
 619         /// append first n (or all if n == npos) characters of sz
 620         wxString& append(const char *sz, size_t n = npos)
 621           { ConcatSelf(n == npos ? Strlen(sz) : n, sz); return *this; }
 622
 623         /// append n copies of ch
 624         wxString& append(size_t n, char ch) { return Pad(n, ch); }
 625       //@}
 626
 627       /** @name replaces the contents of this string with another one */
 628       //@{
 629         /// same as `this_string = str'
 630         wxString& assign(const wxString& str) { return (*this) = str; }
 631         /// same as ` = str[pos..pos + n]
 632         wxString& assign(const wxString& str, size_t pos, size_t n)
 633           { return *this = wxString((const char *)str + pos, n); }
 634         /// same as `= first n (or all if n == npos) characters of sz'
 635         wxString& assign(const char *sz, size_t n = npos)
 636           { return *this = wxString(sz, n); }
 637         /// same as `= n copies of ch'
 638         wxString& assign(size_t n, char ch)
 639           { return *this = wxString(ch, n); }
 640
 641       //@}
 642
 643       /** @name inserts something at position nPos into this one */
 644       //@{
 645         /// insert another string
 646         wxString& insert(size_t nPos, const wxString& str);
 647         /// insert n chars of str starting at nStart (in str)
 648         wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
 649           { return insert(nPos, wxString((const char *)str + nStart, n)); }
 650
 651         /// insert first n (or all if n == npos) characters of sz
 652         wxString& insert(size_t nPos, const char *sz, size_t n = npos)
 653           { return insert(nPos, wxString(sz, n)); }
 654         /// insert n copies of ch
 655         wxString& insert(size_t nPos, size_t n, char ch)
 656           { return insert(nPos, wxString(ch, n)); }
 657
 658       //@}
 659
 660       /** @name deletes a part of the string */
 661       //@{
 662         /// delete characters from nStart to nStart + nLen
 663         wxString& erase(size_t nStart = 0, size_t nLen = npos);
 664       //@}
 665
 666       /** @name replaces a substring of this string with another one */
 667       //@{
 668          /// replaces the substring of length nLen starting at nStart
 669          wxString& replace(size_t nStart, size_t nLen, const char* sz);
 670          /// replaces the substring with nCount copies of ch
 671          wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch);
 672          /// replaces a substring with another substring
 673          wxString& replace(size_t nStart, size_t nLen,
 674                          const wxString& str, size_t nStart2, size_t nLen2);
 675          /// replaces the substring with first nCount chars of sz
 676          wxString& replace(size_t nStart, size_t nLen,
 677                          const char* sz, size_t nCount);
 678       //@}
 679     //@}
 680
 681     /// swap two strings
 682     void swap(wxString& str);
 683
 684     /** @name string operations */
 685     //@{
 686       /** All find() functions take the nStart argument which specifies
 687           the position to start the search on, the default value is 0.
 688
 689           All functions return npos if there were no match.
 690
 691           @name string search
 692       */
 693       //@{
 694         /**
 695             @name find a match for the string/character in this string
 696         */
 697         //@{
 698           /// find a substring
 699           size_t find(const wxString& str, size_t nStart = 0) const;
 700
 701           // VC++ 1.5 can't cope with this syntax.
 702 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
 703           /// find first n characters of sz
 704           size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
 705 #endif
 706           /// find the first occurence of character ch after nStart
 707           size_t find(char ch, size_t nStart = 0) const;
 708
 709           // wxWin compatibility
 710           inline bool Contains(const wxString& str) const { return Find(str) != -1; }
 711
 712         //@}
 713
 714         /**
 715           @name rfind() family is exactly like find() but works right to left
 716         */
 717         //@{
 718         /// as find, but from the end
 719         size_t rfind(const wxString& str, size_t nStart = npos) const;
 720         /// as find, but from the end
 721         // VC++ 1.5 can't cope with this syntax.
 722 #if ! (defined(_MSC_VER) && !defined(__WIN32__))
 723         size_t rfind(const char* sz, size_t nStart = npos,
 724                      size_t n = npos) const;
 725         /// as find, but from the end
 726         size_t rfind(char ch, size_t nStart = npos) const;
 727 #endif
 728         //@}
 729
 730         /**
 731           @name find first/last occurence of any character in the set
 732         */
 733         //@{
 734           ///
 735           size_t find_first_of(const wxString& str, size_t nStart = 0) const;
 736           ///
 737           size_t find_first_of(const char* sz, size_t nStart = 0) const;
 738           /// same as find(char, size_t)
 739           size_t find_first_of(char c, size_t nStart = 0) const;
 740
 741           ///
 742           size_t find_last_of (const wxString& str, size_t nStart = npos) const;
 743           ///
 744           size_t find_last_of (const char* s, size_t nStart = npos) const;
 745           /// same as rfind(char, size_t)
 746           size_t find_last_of (char c, size_t nStart = npos) const;
 747         //@}
 748
 749         /**
 750           @name find first/last occurence of any character not in the set
 751         */
 752         //@{
 753           ///
 754           size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
 755           ///
 756           size_t find_first_not_of(const char* s, size_t nStart = 0) const;
 757           ///
 758           size_t find_first_not_of(char ch, size_t nStart = 0) const;
 759
 760           ///
 761           size_t find_last_not_of(const wxString& str, size_t nStart=npos) const;
 762           ///
 763           size_t find_last_not_of(const char* s, size_t nStart = npos) const;
 764           ///
 765           size_t find_last_not_of(char ch, size_t nStart = npos) const;
 766         //@}
 767       //@}
 768
 769       /**
 770         All compare functions return -1, 0 or 1 if the [sub]string
 771         is less, equal or greater than the compare() argument.
 772
 773         @name comparison
 774       */
 775       //@{
 776         /// just like strcmp()
 777         int compare(const wxString& str) const { return Cmp(str); }
 778         /// comparison with a substring
 779         int compare(size_t nStart, size_t nLen, const wxString& str) const;
 780         /// comparison of 2 substrings
 781         int compare(size_t nStart, size_t nLen,
 782                     const wxString& str, size_t nStart2, size_t nLen2) const;
 783         /// just like strcmp()
 784         int compare(const char* sz) const { return Cmp(sz); }
 785         /// substring comparison with first nCount characters of sz
 786         int compare(size_t nStart, size_t nLen,
 787                     const char* sz, size_t nCount = npos) const;
 788       //@}
 789     wxString substr(size_t nStart = 0, size_t nLen = npos) const;
 790   //@}
 791 #endif
 792 };
 793
 794 // ----------------------------------------------------------------------------
 795 /** The string array uses it's knowledge of internal structure of the String
 796     class to optimize string storage. Normally, we would store pointers to
 797     string, but as String is, in fact, itself a pointer (sizeof(String) is
 798     sizeof(char *)) we store these pointers instead. The cast to "String *"
 799     is really all we need to turn such pointer into a string!
 800
 801     Of course, it can be called a dirty hack, but we use twice less memory
 802     and this approach is also more speed efficient, so it's probably worth it.
 803
 804     Usage notes: when a string is added/inserted, a new copy of it is created,
 805     so the original string may be safely deleted. When a string is retrieved
 806     from the array (operator[] or Item() method), a reference is returned.
 807
 808     @name wxArrayString
 809     @memo probably the most commonly used array type - array of strings
 810  */
 811 // ----------------------------------------------------------------------------
 812 class WXDLLEXPORT wxArrayString
 813 {
 814 public:
 815   /** @name ctors and dtor */
 816   //@{
 817     /// default ctor
 818   wxArrayString();
 819     /// copy ctor
 820   wxArrayString(const wxArrayString& array);
 821     /// assignment operator
 822   wxArrayString& operator=(const wxArrayString& src);
 823     /// not virtual, this class can't be derived from
 824  ~wxArrayString();
 825   //@}
 826
 827   /** @name memory management */
 828   //@{
 829     /// empties the list, but doesn't release memory
 830   void Empty();
 831     /// empties the list and releases memory
 832   void Clear();
 833     /// preallocates memory for given number of items
 834   void Alloc(size_t nCount);
 835     /// minimzes the memory usage (by freeing all extra memory)
 836   void Shrink();
 837   //@}
 838
 839   /** @name simple accessors */
 840   //@{
 841     /// number of elements in the array
 842   size_t  Count() const   { return m_nCount;      }
 843     /// is it empty?
 844   bool  IsEmpty() const { return m_nCount == 0; }
 845   //@}
 846
 847   /** @name items access (range checking is done in debug version) */
 848   //@{
 849     /// get item at position uiIndex
 850   wxString& Item(size_t nIndex) const
 851     { wxASSERT( nIndex < m_nCount ); return *(wxString *)&(m_pItems[nIndex]); }
 852     /// same as Item()
 853   wxString& operator[](size_t nIndex) const { return Item(nIndex); }
 854     /// get last item
 855   wxString& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
 856   //@}
 857
 858   /** @name item management */
 859   //@{
 860     /**
 861       Search the element in the array, starting from the either side
 862       @param if bFromEnd reverse search direction
 863       @param if bCase, comparison is case sensitive (default)
 864       @return index of the first item matched or NOT_FOUND
 865       @see NOT_FOUND
 866      */
 867   int  Index (const char *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const;
 868     /// add new element at the end
 869   void Add   (const wxString& str);
 870     /// add new element at given position
 871   void Insert(const wxString& str, size_t uiIndex);
 872     /// remove first item matching this value
 873   void Remove(const char *sz);
 874     /// remove item by index
 875   void Remove(size_t nIndex);
 876   //@}
 877
 878   /// sort array elements
 879   void Sort(bool bCase = TRUE, bool bReverse = FALSE);
 880
 881 private:
 882   void    Grow();     // makes array bigger if needed
 883   void    Free();     // free the string stored
 884
 885   size_t    m_nSize,    // current size of the array
 886           m_nCount;   // current number of elements
 887
 888   char  **m_pItems;   // pointer to data
 889 };
 890
 891 // ---------------------------------------------------------------------------
 892 /** @name wxString comparison functions
 893     @memo Comparisons are case sensitive
 894  */
 895 // ---------------------------------------------------------------------------
 896 //@{
 897 inline bool operator==(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) == 0; }
 898 ///
 899 inline bool operator==(const wxString& s1, const char  * s2) { return s1.Cmp(s2) == 0; }
 900 ///
 901 inline bool operator==(const char  * s1, const wxString& s2) { return s2.Cmp(s1) == 0; }
 902 ///
 903 inline bool operator!=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) != 0; }
 904 ///
 905 inline bool operator!=(const wxString& s1, const char  * s2) { return s1.Cmp(s2) != 0; }
 906 ///
 907 inline bool operator!=(const char  * s1, const wxString& s2) { return s2.Cmp(s1) != 0; }
 908 ///
 909 inline bool operator< (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) <  0; }
 910 ///
 911 inline bool operator< (const wxString& s1, const char  * s2) { return s1.Cmp(s2) <  0; }
 912 ///
 913 inline bool operator< (const char  * s1, const wxString& s2) { return s2.Cmp(s1) >  0; }
 914 ///
 915 inline bool operator> (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) >  0; }
 916 ///
 917 inline bool operator> (const wxString& s1, const char  * s2) { return s1.Cmp(s2) >  0; }
 918 ///
 919 inline bool operator> (const char  * s1, const wxString& s2) { return s2.Cmp(s1) <  0; }
 920 ///
 921 inline bool operator<=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) <= 0; }
 922 ///
 923 inline bool operator<=(const wxString& s1, const char  * s2) { return s1.Cmp(s2) <= 0; }
 924 ///
 925 inline bool operator<=(const char  * s1, const wxString& s2) { return s2.Cmp(s1) >= 0; }
 926 ///
 927 inline bool operator>=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) >= 0; }
 928 ///
 929 inline bool operator>=(const wxString& s1, const char  * s2) { return s1.Cmp(s2) >= 0; }
 930 ///
 931 inline bool operator>=(const char  * s1, const wxString& s2) { return s2.Cmp(s1) <= 0; }
 932 //@}
 933 wxString WXDLLEXPORT operator+(const wxString& string1,  const wxString& string2);
 934 wxString WXDLLEXPORT operator+(const wxString& string, char ch);
 935 wxString WXDLLEXPORT operator+(char ch, const wxString& string);
 936 wxString WXDLLEXPORT operator+(const wxString& string, const char *psz);
 937 wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
 938
 939 // ---------------------------------------------------------------------------
 940 /** @name Global functions complementing standard C string library
 941     @memo replacements for strlen() and portable strcasecmp()
 942  */
 943 // ---------------------------------------------------------------------------
 944
 945 #ifdef  STD_STRING_COMPATIBILITY
 946
 947 // fwd decl
 948 // Known not to work with wxUSE_IOSTREAMH set to 0, so
 949 // replacing with includes (on advice of ungod@pasdex.com.au)
 950 // class WXDLLEXPORT istream;
 951 #if wxUSE_IOSTREAMH
 952 // N.B. BC++ doesn't have istream.h, ostream.h
 953 #include <iostream.h>
 954 #else
 955 #include <istream>
 956 #  ifdef _MSC_VER
 957       using namespace std;
 958 #  endif
 959 #endif
 960
 961 WXDLLEXPORT istream& operator>>(istream& is, wxString& str);
 962
 963 #endif  //std::string compatibility
 964
 965 #endif  // _WX_WXSTRINGH__
 966
 967 //@}