include/wx/string.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/string.h
   3 // Purpose:     wxString and wxArrayString classes
   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 licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 /*
  13     Efficient string class [more or less] compatible with MFC CString,
  14     wxWidgets version 1 wxString and std::string and some handy functions
  15     missing from string.h.
  16 */
  17
  18 #ifndef _WX_WXSTRINGH__
  19 #define _WX_WXSTRINGH__
  20
  21 // ----------------------------------------------------------------------------
  22 // headers
  23 // ----------------------------------------------------------------------------
  24
  25 #include "wx/defs.h"        // everybody should include this
  26
  27 #if defined(__WXMAC__) || defined(__VISAGECPP__)
  28     #include <ctype.h>
  29 #endif
  30
  31 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
  32    // problem in VACPP V4 with including stdlib.h multiple times
  33    // strconv includes it anyway
  34 #  include <stdio.h>
  35 #  include <string.h>
  36 #  include <stdarg.h>
  37 #  include <limits.h>
  38 #else
  39 #  include <string.h>
  40 #  include <stdio.h>
  41 #  include <stdarg.h>
  42 #  include <limits.h>
  43 #  include <stdlib.h>
  44 #endif
  45
  46 #ifdef HAVE_STRCASECMP_IN_STRINGS_H
  47     #include <strings.h>    // for strcasecmp()
  48 #endif // HAVE_STRCASECMP_IN_STRINGS_H
  49
  50 #ifdef __WXPALMOS__
  51     #include <StringMgr.h>
  52 #endif
  53
  54 #include "wx/wxchar.h"      // for wxChar
  55 #include "wx/buffer.h"      // for wxCharBuffer
  56 #include "wx/strconv.h"     // for wxConvertXXX() macros and wxMBConv classes
  57
  58 class WXDLLIMPEXP_BASE wxString;
  59
  60 // ---------------------------------------------------------------------------
  61 // macros
  62 // ---------------------------------------------------------------------------
  63
  64 // casts [unfortunately!] needed to call some broken functions which require
  65 // "char *" instead of "const char *"
  66 #define   WXSTRINGCAST (wxChar *)(const wxChar *)
  67 #define   wxCSTRINGCAST (wxChar *)(const wxChar *)
  68 #define   wxMBSTRINGCAST (char *)(const char *)
  69 #define   wxWCSTRINGCAST (wchar_t *)(const wchar_t *)
  70
  71 // implementation only
  72 #define   wxASSERT_VALID_INDEX(i) \
  73     wxASSERT_MSG( (size_t)(i) <= length(), _T("invalid index in wxString") )
  74
  75 // ----------------------------------------------------------------------------
  76 // constants
  77 // ----------------------------------------------------------------------------
  78
  79 // maximum possible length for a string means "take all string" everywhere
  80 #define wxSTRING_MAXLEN wxStringBase::npos
  81
  82 // ----------------------------------------------------------------------------
  83 // global data
  84 // ----------------------------------------------------------------------------
  85
  86 // global pointer to empty string
  87 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString;
  88
  89 // ---------------------------------------------------------------------------
  90 // global functions complementing standard C string library replacements for
  91 // strlen() and portable strcasecmp()
  92 //---------------------------------------------------------------------------
  93
  94 // Use wxXXX() functions from wxchar.h instead! These functions are for
  95 // backwards compatibility only.
  96
  97 // checks whether the passed in pointer is NULL and if the string is empty
  98 inline bool IsEmpty(const char *p) { return (!p || !*p); }
  99
 100 // safe version of strlen() (returns 0 if passed NULL pointer)
 101 inline size_t Strlen(const char *psz)
 102   { return psz ? strlen(psz) : 0; }
 103
 104 // portable strcasecmp/_stricmp
 105 inline int Stricmp(const char *psz1, const char *psz2)
 106 {
 107 #if defined(__VISUALC__) && defined(__WXWINCE__)
 108   register char c1, c2;
 109   do {
 110     c1 = tolower(*psz1++);
 111     c2 = tolower(*psz2++);
 112   } while ( c1 && (c1 == c2) );
 113
 114   return c1 - c2;
 115 #elif defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
 116   return _stricmp(psz1, psz2);
 117 #elif defined(__SC__)
 118   return _stricmp(psz1, psz2);
 119 #elif defined(__SALFORDC__)
 120   return stricmp(psz1, psz2);
 121 #elif defined(__BORLANDC__)
 122   return stricmp(psz1, psz2);
 123 #elif defined(__WATCOMC__)
 124   return stricmp(psz1, psz2);
 125 #elif defined(__DJGPP__)
 126   return stricmp(psz1, psz2);
 127 #elif defined(__EMX__)
 128   return stricmp(psz1, psz2);
 129 #elif defined(__WXPM__)
 130   return stricmp(psz1, psz2);
 131 #elif defined(__WXPALMOS__) || \
 132       defined(HAVE_STRCASECMP_IN_STRING_H) || \
 133       defined(HAVE_STRCASECMP_IN_STRINGS_H) || \
 134       defined(__GNUWIN32__)
 135   return strcasecmp(psz1, psz2);
 136 #elif defined(__MWERKS__) && !defined(__INTEL__)
 137   register char c1, c2;
 138   do {
 139     c1 = tolower(*psz1++);
 140     c2 = tolower(*psz2++);
 141   } while ( c1 && (c1 == c2) );
 142
 143   return c1 - c2;
 144 #else
 145   // almost all compilers/libraries provide this function (unfortunately under
 146   // different names), that's why we don't implement our own which will surely
 147   // be more efficient than this code (uncomment to use):
 148   /*
 149     register char c1, c2;
 150     do {
 151       c1 = tolower(*psz1++);
 152       c2 = tolower(*psz2++);
 153     } while ( c1 && (c1 == c2) );
 154
 155     return c1 - c2;
 156   */
 157
 158   #error  "Please define string case-insensitive compare for your OS/compiler"
 159 #endif  // OS/compiler
 160 }
 161
 162 // ----------------------------------------------------------------------------
 163 // deal with STL/non-STL/non-STL-but-wxUSE_STD_STRING
 164 // ----------------------------------------------------------------------------
 165
 166 // in both cases we need to define wxStdString
 167 #if wxUSE_STL || wxUSE_STD_STRING
 168
 169 #include "wx/beforestd.h"
 170 #include <string>
 171 #include "wx/afterstd.h"
 172
 173 #if wxUSE_UNICODE
 174     #ifdef HAVE_STD_WSTRING
 175         typedef std::wstring wxStdString;
 176     #else
 177         typedef std::basic_string<wxChar> wxStdString;
 178     #endif
 179 #else
 180     typedef std::string wxStdString;
 181 #endif
 182
 183 #endif // need <string>
 184
 185 #if wxUSE_STL
 186
 187     // we don't need an extra ctor from std::string when copy ctor already does
 188     // the work
 189     #undef wxUSE_STD_STRING
 190     #define wxUSE_STD_STRING 0
 191
 192     #if (defined(__GNUG__) && (__GNUG__ < 3)) || \
 193         (defined(_MSC_VER) && (_MSC_VER <= 1200))
 194         #define wxSTRING_BASE_HASNT_CLEAR
 195     #endif
 196
 197     typedef wxStdString wxStringBase;
 198 #else // if !wxUSE_STL
 199
 200 #if !defined(HAVE_STD_STRING_COMPARE) && \
 201     (!defined(__WX_SETUP_H__) || wxUSE_STL == 0)
 202     #define HAVE_STD_STRING_COMPARE
 203 #endif
 204
 205 // ---------------------------------------------------------------------------
 206 // string data prepended with some housekeeping info (used by wxString class),
 207 // is never used directly (but had to be put here to allow inlining)
 208 // ---------------------------------------------------------------------------
 209
 210 struct WXDLLIMPEXP_BASE wxStringData
 211 {
 212   int     nRefs;        // reference count
 213   size_t  nDataLength,  // actual string length
 214           nAllocLength; // allocated memory size
 215
 216   // mimics declaration 'wxChar data[nAllocLength]'
 217   wxChar* data() const { return (wxChar*)(this + 1); }
 218
 219   // empty string has a special ref count so it's never deleted
 220   bool  IsEmpty()   const { return (nRefs == -1); }
 221   bool  IsShared()  const { return (nRefs > 1);   }
 222
 223   // lock/unlock
 224   void  Lock()   { if ( !IsEmpty() ) nRefs++;                    }
 225
 226   // VC++ will refuse to inline Unlock but profiling shows that it is wrong
 227 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 228   __forceinline
 229 #endif
 230   // VC++ free must take place in same DLL as allocation when using non dll
 231   // run-time library (e.g. Multithreaded instead of Multithreaded DLL)
 232 #if defined(__VISUALC__) && defined(_MT) && !defined(_DLL)
 233   void  Unlock() { if ( !IsEmpty() && --nRefs == 0) Free();  }
 234   // we must not inline deallocation since allocation is not inlined
 235   void  Free();
 236 #else
 237   void  Unlock() { if ( !IsEmpty() && --nRefs == 0) free(this);  }
 238 #endif
 239
 240   // if we had taken control over string memory (GetWriteBuf), it's
 241   // intentionally put in invalid state
 242   void  Validate(bool b)  { nRefs = (b ? 1 : 0); }
 243   bool  IsValid() const   { return (nRefs != 0); }
 244 };
 245
 246 class WXDLLIMPEXP_BASE wxStringBase
 247 {
 248 #if !wxUSE_STL
 249 friend class WXDLLIMPEXP_BASE wxArrayString;
 250 #endif
 251 public :
 252   // an 'invalid' value for string index, moved to this place due to a CW bug
 253   static const size_t npos;
 254 protected:
 255   // points to data preceded by wxStringData structure with ref count info
 256   wxChar *m_pchData;
 257
 258   // accessor to string data
 259   wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; }
 260
 261   // string (re)initialization functions
 262     // initializes the string to the empty value (must be called only from
 263     // ctors, use Reinit() otherwise)
 264   void Init() { m_pchData = (wxChar *)wxEmptyString; }
 265     // initializes the string with (a part of) C-string
 266   void InitWith(const wxChar *psz, size_t nPos = 0, size_t nLen = npos);
 267     // as Init, but also frees old data
 268   void Reinit() { GetStringData()->Unlock(); Init(); }
 269
 270   // memory allocation
 271     // allocates memory for string of length nLen
 272   bool AllocBuffer(size_t nLen);
 273     // copies data to another string
 274   bool AllocCopy(wxString&, int, int) const;
 275     // effectively copies data to string
 276   bool AssignCopy(size_t, const wxChar *);
 277
 278   // append a (sub)string
 279   bool ConcatSelf(size_t nLen, const wxChar *src, size_t nMaxLen);
 280   bool ConcatSelf(size_t nLen, const wxChar *src)
 281     { return ConcatSelf(nLen, src, nLen); }
 282
 283   // functions called before writing to the string: they copy it if there
 284   // are other references to our data (should be the only owner when writing)
 285   bool CopyBeforeWrite();
 286   bool AllocBeforeWrite(size_t);
 287
 288     // compatibility with wxString
 289   bool Alloc(size_t nLen);
 290 public:
 291   // standard types
 292   typedef wxChar value_type;
 293   typedef wxChar char_type;
 294   typedef size_t size_type;
 295   typedef value_type& reference;
 296   typedef const value_type& const_reference;
 297   typedef value_type* pointer;
 298   typedef const value_type* const_pointer;
 299   typedef value_type *iterator;
 300   typedef const value_type *const_iterator;
 301
 302   // constructors and destructor
 303     // ctor for an empty string
 304   wxStringBase() { Init(); }
 305     // copy ctor
 306   wxStringBase(const wxStringBase& stringSrc)
 307   {
 308     wxASSERT_MSG( stringSrc.GetStringData()->IsValid(),
 309                   _T("did you forget to call UngetWriteBuf()?") );
 310
 311     if ( stringSrc.empty() ) {
 312       // nothing to do for an empty string
 313       Init();
 314     }
 315     else {
 316       m_pchData = stringSrc.m_pchData;            // share same data
 317       GetStringData()->Lock();                    // => one more copy
 318     }
 319   }
 320     // string containing nRepeat copies of ch
 321   wxStringBase(size_type nRepeat, wxChar ch);
 322     // ctor takes first nLength characters from C string
 323     // (default value of npos means take all the string)
 324   wxStringBase(const wxChar *psz)
 325       { InitWith(psz, 0, npos); }
 326   wxStringBase(const wxChar *psz, size_t nLength)
 327       { InitWith(psz, 0, nLength); }
 328   wxStringBase(const wxChar *psz,
 329                const wxMBConv& WXUNUSED(conv),
 330                size_t nLength = npos)
 331       { InitWith(psz, 0, nLength); }
 332     // take nLen chars starting at nPos
 333   wxStringBase(const wxStringBase& str, size_t nPos, size_t nLen)
 334   {
 335     wxASSERT_MSG( str.GetStringData()->IsValid(),
 336                   _T("did you forget to call UngetWriteBuf()?") );
 337     Init();
 338     size_t strLen = str.length() - nPos; nLen = strLen < nLen ? strLen : nLen;
 339     InitWith(str.c_str(), nPos, nLen);
 340   }
 341     // take all characters from pStart to pEnd
 342   wxStringBase(const void *pStart, const void *pEnd);
 343
 344     // dtor is not virtual, this class must not be inherited from!
 345   ~wxStringBase()
 346   {
 347 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 348       //RN - according to the above VC++ does indeed inline this,
 349       //even though it spits out two warnings
 350       #pragma warning (disable:4714)
 351 #endif
 352
 353       GetStringData()->Unlock();
 354   }
 355
 356 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 357     //re-enable inlining warning
 358     #pragma warning (default:4714)
 359 #endif
 360   // overloaded assignment
 361     // from another wxString
 362   wxStringBase& operator=(const wxStringBase& stringSrc);
 363     // from a character
 364   wxStringBase& operator=(wxChar ch);
 365     // from a C string
 366   wxStringBase& operator=(const wxChar *psz);
 367
 368     // return the length of the string
 369   size_type length() const { return GetStringData()->nDataLength; }
 370     // return the length of the string
 371   size_type size() const { return length(); }
 372     // return the maximum size of the string
 373   size_type max_size() const { return wxSTRING_MAXLEN; }
 374     // resize the string, filling the space with c if c != 0
 375   void resize(size_t nSize, wxChar ch = wxT('\0'));
 376     // delete the contents of the string
 377   void clear() { erase(0, npos); }
 378     // returns true if the string is empty
 379   bool empty() const { return length() == 0; }
 380     // inform string about planned change in size
 381   void reserve(size_t sz) { Alloc(sz); }
 382   size_type capacity() const { return GetStringData()->nAllocLength; }
 383
 384   // lib.string.access
 385     // return the character at position n
 386   value_type at(size_type n) const
 387     { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
 388     // returns the writable character at position n
 389   reference at(size_type n)
 390     { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
 391
 392   // lib.string.modifiers
 393     // append elements str[pos], ..., str[pos+n]
 394   wxStringBase& append(const wxStringBase& str, size_t pos, size_t n)
 395   {
 396     wxASSERT(pos <= str.length());
 397     ConcatSelf(n, str.c_str() + pos, str.length() - pos);
 398     return *this;
 399   }
 400     // append a string
 401   wxStringBase& append(const wxStringBase& str)
 402     { ConcatSelf(str.length(), str.c_str()); return *this; }
 403     // append first n (or all if n == npos) characters of sz
 404   wxStringBase& append(const wxChar *sz)
 405     { ConcatSelf(wxStrlen(sz), sz); return *this; }
 406   wxStringBase& append(const wxChar *sz, size_t n)
 407     { ConcatSelf(n, sz); return *this; }
 408     // append n copies of ch
 409   wxStringBase& append(size_t n, wxChar ch);
 410     // append from first to last
 411   wxStringBase& append(const_iterator first, const_iterator last)
 412     { ConcatSelf(last - first, first); return *this; }
 413
 414     // same as `this_string = str'
 415   wxStringBase& assign(const wxStringBase& str)
 416     { return *this = str; }
 417     // same as ` = str[pos..pos + n]
 418   wxStringBase& assign(const wxStringBase& str, size_t pos, size_t n)
 419     { clear(); return append(str, pos, n); }
 420     // same as `= first n (or all if n == npos) characters of sz'
 421   wxStringBase& assign(const wxChar *sz)
 422     { clear(); return append(sz, wxStrlen(sz)); }
 423   wxStringBase& assign(const wxChar *sz, size_t n)
 424     { clear(); return append(sz, n); }
 425     // same as `= n copies of ch'
 426   wxStringBase& assign(size_t n, wxChar ch)
 427     { clear(); return append(n, ch); }
 428     // assign from first to last
 429   wxStringBase& assign(const_iterator first, const_iterator last)
 430     { clear(); return append(first, last); }
 431
 432     // first valid index position
 433   const_iterator begin() const { return m_pchData; }
 434     // position one after the last valid one
 435   const_iterator end() const { return m_pchData + length(); }
 436
 437   // first valid index position
 438   iterator begin();
 439   // position one after the last valid one
 440   iterator end();
 441
 442     // insert another string
 443   wxStringBase& insert(size_t nPos, const wxStringBase& str)
 444   {
 445     wxASSERT( str.GetStringData()->IsValid() );
 446     return insert(nPos, str.c_str(), str.length());
 447   }
 448     // insert n chars of str starting at nStart (in str)
 449   wxStringBase& insert(size_t nPos, const wxStringBase& str, size_t nStart, size_t n)
 450   {
 451     wxASSERT( str.GetStringData()->IsValid() );
 452     wxASSERT( nStart < str.length() );
 453     size_t strLen = str.length() - nStart;
 454     n = strLen < n ? strLen : n;
 455     return insert(nPos, str.c_str() + nStart, n);
 456   }
 457     // insert first n (or all if n == npos) characters of sz
 458   wxStringBase& insert(size_t nPos, const wxChar *sz, size_t n = npos);
 459     // insert n copies of ch
 460   wxStringBase& insert(size_t nPos, size_t n, wxChar ch)
 461     { return insert(nPos, wxStringBase(n, ch)); }
 462   iterator insert(iterator it, wxChar ch)
 463     { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; }
 464   void insert(iterator it, const_iterator first, const_iterator last)
 465     { insert(it - begin(), first, last - first); }
 466   void insert(iterator it, size_type n, wxChar ch)
 467     { insert(it - begin(), n, ch); }
 468
 469     // delete characters from nStart to nStart + nLen
 470   wxStringBase& erase(size_type pos = 0, size_type n = npos);
 471   iterator erase(iterator first, iterator last)
 472   {
 473     size_t idx = first - begin();
 474     erase(idx, last - first);
 475     return begin() + idx;
 476   }
 477   iterator erase(iterator first);
 478
 479   // explicit conversion to C string (use this with printf()!)
 480   const wxChar* c_str() const { return m_pchData; }
 481   const wxChar* data() const { return m_pchData; }
 482
 483     // replaces the substring of length nLen starting at nStart
 484   wxStringBase& replace(size_t nStart, size_t nLen, const wxChar* sz);
 485     // replaces the substring of length nLen starting at nStart
 486   wxStringBase& replace(size_t nStart, size_t nLen, const wxStringBase& str)
 487     { return replace(nStart, nLen, str.c_str()); }
 488     // replaces the substring with nCount copies of ch
 489   wxStringBase& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch);
 490     // replaces a substring with another substring
 491   wxStringBase& replace(size_t nStart, size_t nLen,
 492                         const wxStringBase& str, size_t nStart2, size_t nLen2);
 493     // replaces the substring with first nCount chars of sz
 494   wxStringBase& replace(size_t nStart, size_t nLen,
 495                         const wxChar* sz, size_t nCount);
 496   wxStringBase& replace(iterator first, iterator last, const_pointer s)
 497     { return replace(first - begin(), last - first, s); }
 498   wxStringBase& replace(iterator first, iterator last, const_pointer s,
 499                         size_type n)
 500     { return replace(first - begin(), last - first, s, n); }
 501   wxStringBase& replace(iterator first, iterator last, const wxStringBase& s)
 502     { return replace(first - begin(), last - first, s); }
 503   wxStringBase& replace(iterator first, iterator last, size_type n, wxChar c)
 504     { return replace(first - begin(), last - first, n, c); }
 505   wxStringBase& replace(iterator first, iterator last,
 506                         const_iterator first1, const_iterator last1)
 507     { return replace(first - begin(), last - first, first1, last1 - first1); }
 508
 509     // swap two strings
 510   void swap(wxStringBase& str);
 511
 512     // All find() functions take the nStart argument which specifies the
 513     // position to start the search on, the default value is 0. All functions
 514     // return npos if there were no match.
 515
 516     // find a substring
 517   size_t find(const wxStringBase& str, size_t nStart = 0) const;
 518
 519     // find first n characters of sz
 520   size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const;
 521
 522     // find the first occurence of character ch after nStart
 523   size_t find(wxChar ch, size_t nStart = 0) const;
 524
 525     // rfind() family is exactly like find() but works right to left
 526
 527     // as find, but from the end
 528   size_t rfind(const wxStringBase& str, size_t nStart = npos) const;
 529
 530     // as find, but from the end
 531   size_t rfind(const wxChar* sz, size_t nStart = npos,
 532                size_t n = npos) const;
 533     // as find, but from the end
 534   size_t rfind(wxChar ch, size_t nStart = npos) const;
 535
 536     // find first/last occurence of any character in the set
 537
 538     // as strpbrk() but starts at nStart, returns npos if not found
 539   size_t find_first_of(const wxStringBase& str, size_t nStart = 0) const
 540     { return find_first_of(str.c_str(), nStart); }
 541     // same as above
 542   size_t find_first_of(const wxChar* sz, size_t nStart = 0) const;
 543   size_t find_first_of(const wxChar* sz, size_t nStart, size_t n) const;
 544     // same as find(char, size_t)
 545   size_t find_first_of(wxChar c, size_t nStart = 0) const
 546     { return find(c, nStart); }
 547     // find the last (starting from nStart) char from str in this string
 548   size_t find_last_of (const wxStringBase& str, size_t nStart = npos) const
 549     { return find_last_of(str.c_str(), nStart); }
 550     // same as above
 551   size_t find_last_of (const wxChar* sz, size_t nStart = npos) const;
 552   size_t find_last_of(const wxChar* sz, size_t nStart, size_t n) const;
 553     // same as above
 554   size_t find_last_of(wxChar c, size_t nStart = npos) const
 555     { return rfind(c, nStart); }
 556
 557     // find first/last occurence of any character not in the set
 558
 559     // as strspn() (starting from nStart), returns npos on failure
 560   size_t find_first_not_of(const wxStringBase& str, size_t nStart = 0) const
 561     { return find_first_not_of(str.c_str(), nStart); }
 562     // same as above
 563   size_t find_first_not_of(const wxChar* sz, size_t nStart = 0) const;
 564   size_t find_first_not_of(const wxChar* sz, size_t nStart, size_t n) const;
 565     // same as above
 566   size_t find_first_not_of(wxChar ch, size_t nStart = 0) const;
 567     //  as strcspn()
 568   size_t find_last_not_of(const wxStringBase& str, size_t nStart = npos) const
 569     { return find_last_not_of(str.c_str(), nStart); }
 570     // same as above
 571   size_t find_last_not_of(const wxChar* sz, size_t nStart = npos) const;
 572   size_t find_last_not_of(const wxChar* sz, size_t nStart, size_t n) const;
 573     // same as above
 574   size_t find_last_not_of(wxChar ch, size_t nStart = npos) const;
 575
 576     // All compare functions return -1, 0 or 1 if the [sub]string is less,
 577     // equal or greater than the compare() argument.
 578
 579     // comparison with another string
 580   int compare(const wxStringBase& str) const;
 581     // comparison with a substring
 582   int compare(size_t nStart, size_t nLen, const wxStringBase& str) const;
 583     // comparison of 2 substrings
 584   int compare(size_t nStart, size_t nLen,
 585               const wxStringBase& str, size_t nStart2, size_t nLen2) const;
 586     // comparison with a c string
 587   int compare(const wxChar* sz) const;
 588     // substring comparison with first nCount characters of sz
 589   int compare(size_t nStart, size_t nLen,
 590               const wxChar* sz, size_t nCount = npos) const;
 591
 592   size_type copy(wxChar* s, size_type n, size_type pos = 0);
 593
 594   // substring extraction
 595   wxStringBase substr(size_t nStart = 0, size_t nLen = npos) const;
 596
 597       // string += string
 598   wxStringBase& operator+=(const wxStringBase& s) { return append(s); }
 599       // string += C string
 600   wxStringBase& operator+=(const wxChar *psz) { return append(psz); }
 601       // string += char
 602   wxStringBase& operator+=(wxChar ch) { return append(1, ch); }
 603 };
 604
 605 #endif // !wxUSE_STL
 606
 607 // ----------------------------------------------------------------------------
 608 // wxString: string class trying to be compatible with std::string, MFC
 609 //           CString and wxWindows 1.x wxString all at once
 610 // ---------------------------------------------------------------------------
 611
 612 class WXDLLIMPEXP_BASE wxString : public wxStringBase
 613 {
 614 #if !wxUSE_STL
 615 friend class WXDLLIMPEXP_BASE wxArrayString;
 616 #endif
 617
 618   // NB: special care was taken in arranging the member functions in such order
 619   //     that all inline functions can be effectively inlined, verify that all
 620   //     performance critical functions are still inlined if you change order!
 621 private:
 622   // if we hadn't made these operators private, it would be possible to
 623   // compile "wxString s; s = 17;" without any warnings as 17 is implicitly
 624   // converted to char in C and we do have operator=(char)
 625   //
 626   // NB: we don't need other versions (short/long and unsigned) as attempt
 627   //     to assign another numeric type to wxString will now result in
 628   //     ambiguity between operator=(char) and operator=(int)
 629   wxString& operator=(int);
 630
 631   // these methods are not implemented - there is _no_ conversion from int to
 632   // string, you're doing something wrong if the compiler wants to call it!
 633   //
 634   // try `s << i' or `s.Printf("%d", i)' instead
 635   wxString(int);
 636
 637 public:
 638   // constructors and destructor
 639     // ctor for an empty string
 640   wxString() : wxStringBase() { }
 641     // copy ctor
 642   wxString(const wxStringBase& stringSrc) : wxStringBase(stringSrc) { }
 643   wxString(const wxString& stringSrc) : wxStringBase(stringSrc) { }
 644     // string containing nRepeat copies of ch
 645   wxString(wxChar ch, size_t nRepeat = 1)
 646       : wxStringBase(nRepeat, ch) { }
 647   wxString(size_t nRepeat, wxChar ch)
 648       : wxStringBase(nRepeat, ch) { }
 649     // ctor takes first nLength characters from C string
 650     // (default value of npos means take all the string)
 651   wxString(const wxChar *psz)
 652       : wxStringBase(psz ? psz : wxT("")) { }
 653   wxString(const wxChar *psz, size_t nLength)
 654       : wxStringBase(psz, nLength) { }
 655   wxString(const wxChar *psz,
 656            const wxMBConv& WXUNUSED(conv),
 657            size_t nLength = npos)
 658       : wxStringBase(psz, nLength == npos ? wxStrlen(psz) : nLength) { }
 659
 660   // even if we're not built with wxUSE_STL == 1 it is very convenient to allow
 661   // implicit conversions from std::string to wxString as this allows to use
 662   // the same strings in non-GUI and GUI code, however we don't want to
 663   // unconditionally add this ctor as it would make wx lib dependent on
 664   // libstdc++ on some Linux versions which is bad, so instead we ask the
 665   // client code to define this wxUSE_STD_STRING symbol if they need it
 666 #if wxUSE_STD_STRING
 667   wxString(const wxStdString& s)
 668       : wxStringBase(s.c_str()) { }
 669 #endif // wxUSE_STD_STRING
 670
 671 #if wxUSE_UNICODE
 672     // from multibyte string
 673   wxString(const char *psz, const wxMBConv& conv, size_t nLength = npos);
 674     // from wxWCharBuffer (i.e. return from wxGetString)
 675   wxString(const wxWCharBuffer& psz) : wxStringBase(psz.data()) { }
 676 #else // ANSI
 677     // from C string (for compilers using unsigned char)
 678   wxString(const unsigned char* psz)
 679       : wxStringBase((const char*)psz) { }
 680     // from part of C string (for compilers using unsigned char)
 681   wxString(const unsigned char* psz, size_t nLength)
 682       : wxStringBase((const char*)psz, nLength) { }
 683
 684 #if wxUSE_WCHAR_T
 685     // from wide (Unicode) string
 686   wxString(const wchar_t *pwz,
 687            const wxMBConv& conv = wxConvLibc,
 688            size_t nLength = npos);
 689 #endif // !wxUSE_WCHAR_T
 690
 691     // from wxCharBuffer
 692   wxString(const wxCharBuffer& psz)
 693       : wxStringBase(psz) { }
 694 #endif // Unicode/ANSI
 695
 696   // generic attributes & operations
 697     // as standard strlen()
 698   size_t Len() const { return length(); }
 699     // string contains any characters?
 700   bool IsEmpty() const { return empty(); }
 701     // empty string is "false", so !str will return true
 702   bool operator!() const { return empty(); }
 703     // truncate the string to given length
 704   wxString& Truncate(size_t uiLen);
 705     // empty string contents
 706   void Empty()
 707   {
 708     Truncate(0);
 709
 710     wxASSERT_MSG( empty(), _T("string not empty after call to Empty()?") );
 711   }
 712     // empty the string and free memory
 713   void Clear()
 714   {
 715     wxString tmp(wxEmptyString);
 716     swap(tmp);
 717   }
 718
 719   // contents test
 720     // Is an ascii value
 721   bool IsAscii() const;
 722     // Is a number
 723   bool IsNumber() const;
 724     // Is a word
 725   bool IsWord() const;
 726
 727   // data access (all indexes are 0 based)
 728     // read access
 729     wxChar  GetChar(size_t n) const
 730       { return at(n); }
 731     // read/write access
 732     wxChar& GetWritableChar(size_t n)
 733       { return at(n); }
 734     // write access
 735     void  SetChar(size_t n, wxChar ch)
 736       { at(n) = ch; }
 737
 738     // get last character
 739     wxChar  Last() const
 740       {
 741           wxASSERT_MSG( !empty(), _T("wxString: index out of bounds") );
 742
 743           return at(length() - 1);
 744       }
 745
 746     // get writable last character
 747     wxChar& Last()
 748       {
 749           wxASSERT_MSG( !empty(), _T("wxString: index out of bounds") );
 750           return at(length() - 1);
 751       }
 752
 753     /*
 754        Note that we we must define all of the overloads below to avoid
 755        ambiguity when using str[0]. Also note that for a conforming compiler we
 756        don't need const version of operatorp[] at all as indexed access to
 757        const string is provided by implicit conversion to "const wxChar *"
 758        below and defining them would only result in ambiguities, but some other
 759        compilers refuse to compile "str[0]" without them.
 760      */
 761
 762 #if defined(__BORLANDC__) || defined(__WATCOMC__) || defined(__MWERKS__)
 763     wxChar operator[](int n) const
 764       { return wxStringBase::at(n); }
 765     wxChar operator[](size_type n) const
 766       { return wxStringBase::at(n); }
 767 #ifndef wxSIZE_T_IS_UINT
 768     wxChar operator[](unsigned int n) const
 769       { return wxStringBase::at(n); }
 770 #endif // size_t != unsigned int
 771 #endif // broken compiler
 772
 773
 774     // operator versions of GetWriteableChar()
 775     wxChar& operator[](int n)
 776       { return wxStringBase::at(n); }
 777     wxChar& operator[](size_type n)
 778       { return wxStringBase::at(n); }
 779 #ifndef wxSIZE_T_IS_UINT
 780     wxChar& operator[](unsigned int n)
 781       { return wxStringBase::at(n); }
 782 #endif // size_t != unsigned int
 783
 784     // implicit conversion to C string
 785     operator const wxChar*() const { return c_str(); }
 786
 787     // identical to c_str(), for wxWin 1.6x compatibility
 788     const wxChar* wx_str()  const { return c_str(); }
 789     // identical to c_str(), for MFC compatibility
 790     const wxChar* GetData() const { return c_str(); }
 791
 792     // conversion to/from plain (i.e. 7 bit) ASCII: this is useful for
 793     // converting numbers or strings which are certain not to contain special
 794     // chars (typically system functions, X atoms, environment variables etc.)
 795     //
 796     // the behaviour of these functions with the strings containing anything
 797     // else than 7 bit ASCII characters is undefined, use at your own risk.
 798 #if wxUSE_UNICODE
 799     static wxString FromAscii(const char *ascii);  // string
 800     static wxString FromAscii(const char ascii);   // char
 801     const wxCharBuffer ToAscii() const;
 802 #else // ANSI
 803     static wxString FromAscii(const char *ascii) { return wxString( ascii ); }
 804     static wxString FromAscii(const char ascii) { return wxString( ascii ); }
 805     const char *ToAscii() const { return c_str(); }
 806 #endif // Unicode/!Unicode
 807
 808     // conversions with (possible) format conversions: have to return a
 809     // buffer with temporary data
 810     //
 811     // the functions defined (in either Unicode or ANSI) mode are mb_str() to
 812     // return an ANSI (multibyte) string, wc_str() to return a wide string and
 813     // fn_str() to return a string which should be used with the OS APIs
 814     // accepting the file names. The return value is always the same, but the
 815     // type differs because a function may either return pointer to the buffer
 816     // directly or have to use intermediate buffer for translation.
 817 #if wxUSE_UNICODE
 818     const wxCharBuffer mb_str(const wxMBConv& conv = wxConvLibc) const;
 819
 820     const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); }
 821
 822     const wxChar* wc_str() const { return c_str(); }
 823
 824     // for compatibility with !wxUSE_UNICODE version
 825     const wxChar* wc_str(const wxMBConv& WXUNUSED(conv)) const { return c_str(); }
 826
 827 #if wxMBFILES
 828     const wxCharBuffer fn_str() const { return mb_str(wxConvFile); }
 829 #else // !wxMBFILES
 830     const wxChar* fn_str() const { return c_str(); }
 831 #endif // wxMBFILES/!wxMBFILES
 832 #else // ANSI
 833     const wxChar* mb_str() const { return c_str(); }
 834
 835     // for compatibility with wxUSE_UNICODE version
 836     const wxChar* mb_str(const wxMBConv& WXUNUSED(conv)) const { return c_str(); }
 837
 838     const wxWX2MBbuf mbc_str() const { return mb_str(); }
 839
 840 #if wxUSE_WCHAR_T
 841     const wxWCharBuffer wc_str(const wxMBConv& conv) const;
 842 #endif // wxUSE_WCHAR_T
 843 #ifdef __WXOSX__
 844     const wxCharBuffer fn_str() const { return wxConvFile.cWC2WX( wc_str( wxConvLocal ) ); }
 845 #else
 846     const wxChar* fn_str() const { return c_str(); }
 847 #endif
 848 #endif // Unicode/ANSI
 849
 850   // overloaded assignment
 851     // from another wxString
 852   wxString& operator=(const wxStringBase& stringSrc)
 853     { return (wxString&)wxStringBase::operator=(stringSrc); }
 854     // from a character
 855   wxString& operator=(wxChar ch)
 856     { return (wxString&)wxStringBase::operator=(ch); }
 857     // from a C string - STL probably will crash on NULL,
 858     // so we need to compensate in that case
 859 #if wxUSE_STL
 860   wxString& operator=(const wxChar *psz)
 861     { if(psz) wxStringBase::operator=(psz); else Clear(); return *this; }
 862 #else
 863   wxString& operator=(const wxChar *psz)
 864     { return (wxString&)wxStringBase::operator=(psz); }
 865 #endif
 866
 867 #if wxUSE_UNICODE
 868     // from wxWCharBuffer
 869   wxString& operator=(const wxWCharBuffer& psz)
 870     { (void) operator=((const wchar_t *)psz); return *this; }
 871 #else // ANSI
 872     // from another kind of C string
 873   wxString& operator=(const unsigned char* psz);
 874 #if wxUSE_WCHAR_T
 875     // from a wide string
 876   wxString& operator=(const wchar_t *pwz);
 877 #endif
 878     // from wxCharBuffer
 879   wxString& operator=(const wxCharBuffer& psz)
 880     { (void) operator=((const char *)psz); return *this; }
 881 #endif // Unicode/ANSI
 882
 883   // string concatenation
 884     // in place concatenation
 885     /*
 886         Concatenate and return the result. Note that the left to right
 887         associativity of << allows to write things like "str << str1 << str2
 888         << ..." (unlike with +=)
 889      */
 890       // string += string
 891   wxString& operator<<(const wxString& s)
 892   {
 893 #if !wxUSE_STL
 894     wxASSERT_MSG( s.GetStringData()->IsValid(),
 895                   _T("did you forget to call UngetWriteBuf()?") );
 896 #endif
 897
 898     append(s);
 899     return *this;
 900   }
 901       // string += C string
 902   wxString& operator<<(const wxChar *psz)
 903     { append(psz); return *this; }
 904       // string += char
 905   wxString& operator<<(wxChar ch) { append(1, ch); return *this; }
 906
 907       // string += buffer (i.e. from wxGetString)
 908 #if wxUSE_UNICODE
 909   wxString& operator<<(const wxWCharBuffer& s)
 910     { (void)operator<<((const wchar_t *)s); return *this; }
 911   void operator+=(const wxWCharBuffer& s)
 912     { (void)operator<<((const wchar_t *)s); }
 913 #else // !wxUSE_UNICODE
 914   wxString& operator<<(const wxCharBuffer& s)
 915     { (void)operator<<((const char *)s); return *this; }
 916   void operator+=(const wxCharBuffer& s)
 917     { (void)operator<<((const char *)s); }
 918 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
 919
 920     // string += C string
 921   wxString& Append(const wxString& s)
 922     {
 923         // test for empty() to share the string if possible
 924         if ( empty() )
 925             *this = s;
 926         else
 927             append(s);
 928         return *this;
 929     }
 930   wxString& Append(const wxChar* psz)
 931     { append(psz); return *this; }
 932     // append count copies of given character
 933   wxString& Append(wxChar ch, size_t count = 1u)
 934     { append(count, ch); return *this; }
 935   wxString& Append(const wxChar* psz, size_t nLen)
 936     { append(psz, nLen); return *this; }
 937
 938     // prepend a string, return the string itself
 939   wxString& Prepend(const wxString& str)
 940     { *this = str + *this; return *this; }
 941
 942     // non-destructive concatenation
 943       // two strings
 944   friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string1,
 945                                              const wxString& string2);
 946       // string with a single char
 947   friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string, wxChar ch);
 948       // char with a string
 949   friend wxString WXDLLIMPEXP_BASE operator+(wxChar ch, const wxString& string);
 950       // string with C string
 951   friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string,
 952                                              const wxChar *psz);
 953       // C string with string
 954   friend wxString WXDLLIMPEXP_BASE operator+(const wxChar *psz,
 955                                              const wxString& string);
 956
 957   // stream-like functions
 958       // insert an int into string
 959   wxString& operator<<(int i)
 960     { return (*this) << Format(_T("%d"), i); }
 961       // insert an unsigned int into string
 962   wxString& operator<<(unsigned int ui)
 963     { return (*this) << Format(_T("%u"), ui); }
 964       // insert a long into string
 965   wxString& operator<<(long l)
 966     { return (*this) << Format(_T("%ld"), l); }
 967       // insert an unsigned long into string
 968   wxString& operator<<(unsigned long ul)
 969     { return (*this) << Format(_T("%lu"), ul); }
 970 #if defined wxLongLong_t && !defined wxLongLongIsLong
 971       // insert a long long if they exist and aren't longs
 972   wxString& operator<<(wxLongLong_t ll)
 973     {
 974       const wxChar *fmt = _T("%") wxLongLongFmtSpec _T("d");
 975       return (*this) << Format(fmt, ll);
 976     }
 977       // insert an unsigned long long
 978   wxString& operator<<(wxULongLong_t ull)
 979     {
 980       const wxChar *fmt = _T("%") wxLongLongFmtSpec _T("u");
 981       return (*this) << Format(fmt , ull);
 982     }
 983 #endif
 984       // insert a float into string
 985   wxString& operator<<(float f)
 986     { return (*this) << Format(_T("%f"), f); }
 987       // insert a double into string
 988   wxString& operator<<(double d)
 989     { return (*this) << Format(_T("%g"), d); }
 990
 991   // string comparison
 992     // case-sensitive comparison (returns a value < 0, = 0 or > 0)
 993   int Cmp(const wxChar *psz) const;
 994   int Cmp(const wxString& s) const;
 995     // same as Cmp() but not case-sensitive
 996   int CmpNoCase(const wxChar *psz) const;
 997   int CmpNoCase(const wxString& s) const;
 998     // test for the string equality, either considering case or not
 999     // (if compareWithCase then the case matters)
1000   bool IsSameAs(const wxChar *psz, bool compareWithCase = true) const
1001     { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
1002     // comparison with a single character: returns true if equal
1003   bool IsSameAs(wxChar c, bool compareWithCase = true) const
1004     {
1005       return (length() == 1) && (compareWithCase ? GetChar(0u) == c
1006                               : wxToupper(GetChar(0u)) == wxToupper(c));
1007     }
1008
1009   // simple sub-string extraction
1010       // return substring starting at nFirst of length nCount (or till the end
1011       // if nCount = default value)
1012   wxString Mid(size_t nFirst, size_t nCount = npos) const;
1013
1014       // operator version of Mid()
1015   wxString  operator()(size_t start, size_t len) const
1016     { return Mid(start, len); }
1017
1018       // check that the string starts with prefix and return the rest of the
1019       // string in the provided pointer if it is not NULL, otherwise return
1020       // false
1021   bool StartsWith(const wxChar *prefix, wxString *rest = NULL) const;
1022
1023       // get first nCount characters
1024   wxString Left(size_t nCount) const;
1025       // get last nCount characters
1026   wxString Right(size_t nCount) const;
1027       // get all characters before the first occurance of ch
1028       // (returns the whole string if ch not found)
1029   wxString BeforeFirst(wxChar ch) const;
1030       // get all characters before the last occurence of ch
1031       // (returns empty string if ch not found)
1032   wxString BeforeLast(wxChar ch) const;
1033       // get all characters after the first occurence of ch
1034       // (returns empty string if ch not found)
1035   wxString AfterFirst(wxChar ch) const;
1036       // get all characters after the last occurence of ch
1037       // (returns the whole string if ch not found)
1038   wxString AfterLast(wxChar ch) const;
1039
1040     // for compatibility only, use more explicitly named functions above
1041   wxString Before(wxChar ch) const { return BeforeLast(ch); }
1042   wxString After(wxChar ch) const { return AfterFirst(ch); }
1043
1044   // case conversion
1045       // convert to upper case in place, return the string itself
1046   wxString& MakeUpper();
1047       // convert to upper case, return the copy of the string
1048       // Here's something to remember: BC++ doesn't like returns in inlines.
1049   wxString Upper() const ;
1050       // convert to lower case in place, return the string itself
1051   wxString& MakeLower();
1052       // convert to lower case, return the copy of the string
1053   wxString Lower() const ;
1054
1055   // trimming/padding whitespace (either side) and truncating
1056       // remove spaces from left or from right (default) side
1057   wxString& Trim(bool bFromRight = true);
1058       // add nCount copies chPad in the beginning or at the end (default)
1059   wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = true);
1060
1061   // searching and replacing
1062       // searching (return starting index, or -1 if not found)
1063   int Find(wxChar ch, bool bFromEnd = false) const;   // like strchr/strrchr
1064       // searching (return starting index, or -1 if not found)
1065   int Find(const wxChar *pszSub) const;               // like strstr
1066       // replace first (or all of bReplaceAll) occurences of substring with
1067       // another string, returns the number of replacements made
1068   size_t Replace(const wxChar *szOld,
1069                  const wxChar *szNew,
1070                  bool bReplaceAll = true);
1071
1072     // check if the string contents matches a mask containing '*' and '?'
1073   bool Matches(const wxChar *szMask) const;
1074
1075     // conversion to numbers: all functions return true only if the whole
1076     // string is a number and put the value of this number into the pointer
1077     // provided, the base is the numeric base in which the conversion should be
1078     // done and must be comprised between 2 and 36 or be 0 in which case the
1079     // standard C rules apply (leading '0' => octal, "0x" => hex)
1080         // convert to a signed integer
1081     bool ToLong(long *val, int base = 10) const;
1082         // convert to an unsigned integer
1083     bool ToULong(unsigned long *val, int base = 10) const;
1084         // convert to a double
1085     bool ToDouble(double *val) const;
1086
1087   // formatted input/output
1088     // as sprintf(), returns the number of characters written or < 0 on error
1089     // (take 'this' into account in attribute parameter count)
1090   int Printf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
1091     // as vprintf(), returns the number of characters written or < 0 on error
1092   int PrintfV(const wxChar* pszFormat, va_list argptr);
1093
1094     // returns the string containing the result of Printf() to it
1095   static wxString Format(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_1;
1096     // the same as above, but takes a va_list
1097   static wxString FormatV(const wxChar *pszFormat, va_list argptr);
1098
1099   // raw access to string memory
1100     // ensure that string has space for at least nLen characters
1101     // only works if the data of this string is not shared
1102   bool Alloc(size_t nLen) { reserve(nLen); /*return capacity() >= nLen;*/ return true; }
1103     // minimize the string's memory
1104     // only works if the data of this string is not shared
1105   bool Shrink();
1106 #if !wxUSE_STL
1107     // get writable buffer of at least nLen bytes. Unget() *must* be called
1108     // a.s.a.p. to put string back in a reasonable state!
1109   wxChar *GetWriteBuf(size_t nLen);
1110     // call this immediately after GetWriteBuf() has been used
1111   void UngetWriteBuf();
1112   void UngetWriteBuf(size_t nLen);
1113 #endif
1114
1115   // wxWidgets version 1 compatibility functions
1116
1117   // use Mid()
1118   wxString SubString(size_t from, size_t to) const
1119       { return Mid(from, (to - from + 1)); }
1120     // values for second parameter of CompareTo function
1121   enum caseCompare {exact, ignoreCase};
1122     // values for first parameter of Strip function
1123   enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
1124
1125   // use Printf()
1126   // (take 'this' into account in attribute parameter count)
1127   int sprintf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
1128
1129     // use Cmp()
1130   inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const
1131     { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
1132
1133     // use Len
1134   size_t Length() const { return length(); }
1135     // Count the number of characters
1136   int Freq(wxChar ch) const;
1137     // use MakeLower
1138   void LowerCase() { MakeLower(); }
1139     // use MakeUpper
1140   void UpperCase() { MakeUpper(); }
1141     // use Trim except that it doesn't change this string
1142   wxString Strip(stripType w = trailing) const;
1143
1144     // use Find (more general variants not yet supported)
1145   size_t Index(const wxChar* psz) const { return Find(psz); }
1146   size_t Index(wxChar ch)         const { return Find(ch);  }
1147     // use Truncate
1148   wxString& Remove(size_t pos) { return Truncate(pos); }
1149   wxString& RemoveLast(size_t n = 1) { return Truncate(length() - n); }
1150
1151   wxString& Remove(size_t nStart, size_t nLen)
1152       { return (wxString&)erase( nStart, nLen ); }
1153
1154     // use Find()
1155   int First( const wxChar ch ) const { return Find(ch); }
1156   int First( const wxChar* psz ) const { return Find(psz); }
1157   int First( const wxString &str ) const { return Find(str); }
1158   int Last( const wxChar ch ) const { return Find(ch, true); }
1159   bool Contains(const wxString& str) const { return Find(str) != wxNOT_FOUND; }
1160
1161     // use empty()
1162   bool IsNull() const { return empty(); }
1163
1164   // std::string compatibility functions
1165
1166     // take nLen chars starting at nPos
1167   wxString(const wxString& str, size_t nPos, size_t nLen)
1168       : wxStringBase(str, nPos, nLen) { }
1169     // take all characters from pStart to pEnd
1170   wxString(const void *pStart, const void *pEnd)
1171       : wxStringBase((const wxChar*)pStart, (const wxChar*)pEnd) { }
1172 #if wxUSE_STL
1173   wxString(const_iterator first, const_iterator last)
1174       : wxStringBase(first, last) { }
1175 #endif
1176
1177   // lib.string.modifiers
1178     // append elements str[pos], ..., str[pos+n]
1179   wxString& append(const wxString& str, size_t pos, size_t n)
1180     { return (wxString&)wxStringBase::append(str, pos, n); }
1181     // append a string
1182   wxString& append(const wxString& str)
1183     { return (wxString&)wxStringBase::append(str); }
1184     // append first n (or all if n == npos) characters of sz
1185   wxString& append(const wxChar *sz)
1186     { return (wxString&)wxStringBase::append(sz); }
1187   wxString& append(const wxChar *sz, size_t n)
1188     { return (wxString&)wxStringBase::append(sz, n); }
1189     // append n copies of ch
1190   wxString& append(size_t n, wxChar ch)
1191     { return (wxString&)wxStringBase::append(n, ch); }
1192     // append from first to last
1193   wxString& append(const_iterator first, const_iterator last)
1194     { return (wxString&)wxStringBase::append(first, last); }
1195
1196     // same as `this_string = str'
1197   wxString& assign(const wxString& str)
1198     { return (wxString&)wxStringBase::assign(str); }
1199     // same as ` = str[pos..pos + n]
1200   wxString& assign(const wxString& str, size_t pos, size_t n)
1201     { return (wxString&)wxStringBase::assign(str, pos, n); }
1202     // same as `= first n (or all if n == npos) characters of sz'
1203   wxString& assign(const wxChar *sz)
1204     { return (wxString&)wxStringBase::assign(sz); }
1205   wxString& assign(const wxChar *sz, size_t n)
1206     { return (wxString&)wxStringBase::assign(sz, n); }
1207     // same as `= n copies of ch'
1208   wxString& assign(size_t n, wxChar ch)
1209     { return (wxString&)wxStringBase::assign(n, ch); }
1210     // assign from first to last
1211   wxString& assign(const_iterator first, const_iterator last)
1212     { return (wxString&)wxStringBase::assign(first, last); }
1213
1214     // string comparison
1215 #if !defined(HAVE_STD_STRING_COMPARE)
1216   int compare(const wxStringBase& str) const;
1217     // comparison with a substring
1218   int compare(size_t nStart, size_t nLen, const wxStringBase& str) const;
1219     // comparison of 2 substrings
1220   int compare(size_t nStart, size_t nLen,
1221               const wxStringBase& str, size_t nStart2, size_t nLen2) const;
1222     // just like strcmp()
1223   int compare(const wxChar* sz) const;
1224     // substring comparison with first nCount characters of sz
1225   int compare(size_t nStart, size_t nLen,
1226               const wxChar* sz, size_t nCount = npos) const;
1227 #endif // !defined HAVE_STD_STRING_COMPARE
1228
1229     // insert another string
1230   wxString& insert(size_t nPos, const wxString& str)
1231     { return (wxString&)wxStringBase::insert(nPos, str); }
1232     // insert n chars of str starting at nStart (in str)
1233   wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
1234     { return (wxString&)wxStringBase::insert(nPos, str, nStart, n); }
1235     // insert first n (or all if n == npos) characters of sz
1236   wxString& insert(size_t nPos, const wxChar *sz)
1237     { return (wxString&)wxStringBase::insert(nPos, sz); }
1238   wxString& insert(size_t nPos, const wxChar *sz, size_t n)
1239     { return (wxString&)wxStringBase::insert(nPos, sz, n); }
1240     // insert n copies of ch
1241   wxString& insert(size_t nPos, size_t n, wxChar ch)
1242     { return (wxString&)wxStringBase::insert(nPos, n, ch); }
1243   iterator insert(iterator it, wxChar ch)
1244     { return wxStringBase::insert(it, ch); }
1245   void insert(iterator it, const_iterator first, const_iterator last)
1246     { wxStringBase::insert(it, first, last); }
1247   void insert(iterator it, size_type n, wxChar ch)
1248     { wxStringBase::insert(it, n, ch); }
1249
1250     // delete characters from nStart to nStart + nLen
1251   wxString& erase(size_type pos = 0, size_type n = npos)
1252     { return (wxString&)wxStringBase::erase(pos, n); }
1253   iterator erase(iterator first, iterator last)
1254     { return wxStringBase::erase(first, last); }
1255   iterator erase(iterator first)
1256     { return wxStringBase::erase(first); }
1257
1258 #ifdef wxSTRING_BASE_HASNT_CLEAR
1259   void clear() { erase(); }
1260 #endif
1261
1262     // replaces the substring of length nLen starting at nStart
1263   wxString& replace(size_t nStart, size_t nLen, const wxChar* sz)
1264     { return (wxString&)wxStringBase::replace(nStart, nLen, sz); }
1265     // replaces the substring of length nLen starting at nStart
1266   wxString& replace(size_t nStart, size_t nLen, const wxString& str)
1267     { return (wxString&)wxStringBase::replace(nStart, nLen, str); }
1268     // replaces the substring with nCount copies of ch
1269   wxString& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch)
1270     { return (wxString&)wxStringBase::replace(nStart, nLen, nCount, ch); }
1271     // replaces a substring with another substring
1272   wxString& replace(size_t nStart, size_t nLen,
1273                     const wxString& str, size_t nStart2, size_t nLen2)
1274     { return (wxString&)wxStringBase::replace(nStart, nLen, str,
1275                                               nStart2, nLen2); }
1276      // replaces the substring with first nCount chars of sz
1277   wxString& replace(size_t nStart, size_t nLen,
1278                     const wxChar* sz, size_t nCount)
1279     { return (wxString&)wxStringBase::replace(nStart, nLen, sz, nCount); }
1280   wxString& replace(iterator first, iterator last, const_pointer s)
1281     { return (wxString&)wxStringBase::replace(first, last, s); }
1282   wxString& replace(iterator first, iterator last, const_pointer s,
1283                     size_type n)
1284     { return (wxString&)wxStringBase::replace(first, last, s, n); }
1285   wxString& replace(iterator first, iterator last, const wxString& s)
1286     { return (wxString&)wxStringBase::replace(first, last, s); }
1287   wxString& replace(iterator first, iterator last, size_type n, wxChar c)
1288     { return (wxString&)wxStringBase::replace(first, last, n, c); }
1289   wxString& replace(iterator first, iterator last,
1290                     const_iterator first1, const_iterator last1)
1291     { return (wxString&)wxStringBase::replace(first, last, first1, last1); }
1292
1293       // string += string
1294   wxString& operator+=(const wxString& s)
1295     { return (wxString&)wxStringBase::operator+=(s); }
1296       // string += C string
1297   wxString& operator+=(const wxChar *psz)
1298     { return (wxString&)wxStringBase::operator+=(psz); }
1299       // string += char
1300   wxString& operator+=(wxChar ch)
1301     { return (wxString&)wxStringBase::operator+=(ch); }
1302 };
1303
1304 // notice that even though for many compilers the friend declarations above are
1305 // enough, from the point of view of C++ standard we must have the declarations
1306 // here as friend ones are not injected in the enclosing namespace and without
1307 // them the code fails to compile with conforming compilers such as xlC or g++4
1308 wxString WXDLLIMPEXP_BASE operator+(const wxString& string1,  const wxString& string2);
1309 wxString WXDLLIMPEXP_BASE operator+(const wxString& string, wxChar ch);
1310 wxString WXDLLIMPEXP_BASE operator+(wxChar ch, const wxString& string);
1311 wxString WXDLLIMPEXP_BASE operator+(const wxString& string, const wxChar *psz);
1312 wxString WXDLLIMPEXP_BASE operator+(const wxChar *psz, const wxString& string);
1313
1314
1315 // define wxArrayString, for compatibility
1316 #if WXWIN_COMPATIBILITY_2_4 && !wxUSE_STL
1317     #include "wx/arrstr.h"
1318 #endif
1319
1320 #if wxUSE_STL
1321     // return an empty wxString (not very useful with wxUSE_STL == 1)
1322     inline const wxString wxGetEmptyString() { return wxString(); }
1323 #else // !wxUSE_STL
1324     // return an empty wxString (more efficient than wxString() here)
1325     inline const wxString& wxGetEmptyString()
1326     {
1327         return *(wxString *)&wxEmptyString;
1328     }
1329 #endif // wxUSE_STL/!wxUSE_STL
1330
1331 // ----------------------------------------------------------------------------
1332 // wxStringBuffer: a tiny class allowing to get a writable pointer into string
1333 // ----------------------------------------------------------------------------
1334
1335 #if wxUSE_STL
1336
1337 class WXDLLIMPEXP_BASE wxStringBuffer
1338 {
1339 public:
1340     wxStringBuffer(wxString& str, size_t lenWanted = 1024)
1341         : m_str(str), m_buf(lenWanted)
1342         { }
1343
1344     ~wxStringBuffer() { m_str.assign(m_buf.data(), wxStrlen(m_buf.data())); }
1345
1346     operator wxChar*() { return m_buf.data(); }
1347
1348 private:
1349     wxString& m_str;
1350 #if wxUSE_UNICODE
1351     wxWCharBuffer m_buf;
1352 #else
1353     wxCharBuffer m_buf;
1354 #endif
1355
1356     DECLARE_NO_COPY_CLASS(wxStringBuffer)
1357 };
1358
1359 class WXDLLIMPEXP_BASE wxStringBufferLength
1360 {
1361 public:
1362     wxStringBufferLength(wxString& str, size_t lenWanted = 1024)
1363         : m_str(str), m_buf(lenWanted), m_len(0), m_lenSet(false)
1364         { }
1365
1366     ~wxStringBufferLength()
1367     {
1368         wxASSERT(m_lenSet);
1369         m_str.assign(m_buf.data(), m_len);
1370     }
1371
1372     operator wxChar*() { return m_buf.data(); }
1373     void SetLength(size_t length) { m_len = length; m_lenSet = true; }
1374
1375 private:
1376     wxString& m_str;
1377 #if wxUSE_UNICODE
1378     wxWCharBuffer m_buf;
1379 #else
1380     wxCharBuffer  m_buf;
1381 #endif
1382     size_t        m_len;
1383     bool          m_lenSet;
1384
1385     DECLARE_NO_COPY_CLASS(wxStringBufferLength)
1386 };
1387
1388 #else // if !wxUSE_STL
1389
1390 class WXDLLIMPEXP_BASE wxStringBuffer
1391 {
1392 public:
1393     wxStringBuffer(wxString& str, size_t lenWanted = 1024)
1394         : m_str(str), m_buf(NULL)
1395         { m_buf = m_str.GetWriteBuf(lenWanted); }
1396
1397     ~wxStringBuffer() { m_str.UngetWriteBuf(); }
1398
1399     operator wxChar*() const { return m_buf; }
1400
1401 private:
1402     wxString& m_str;
1403     wxChar   *m_buf;
1404
1405     DECLARE_NO_COPY_CLASS(wxStringBuffer)
1406 };
1407
1408 class WXDLLIMPEXP_BASE wxStringBufferLength
1409 {
1410 public:
1411     wxStringBufferLength(wxString& str, size_t lenWanted = 1024)
1412         : m_str(str), m_buf(NULL), m_len(0), m_lenSet(false)
1413     {
1414         m_buf = m_str.GetWriteBuf(lenWanted);
1415         wxASSERT(m_buf != NULL);
1416     }
1417
1418     ~wxStringBufferLength()
1419     {
1420         wxASSERT(m_lenSet);
1421         m_str.UngetWriteBuf(m_len);
1422     }
1423
1424     operator wxChar*() const { return m_buf; }
1425     void SetLength(size_t length) { m_len = length; m_lenSet = true; }
1426
1427 private:
1428     wxString& m_str;
1429     wxChar   *m_buf;
1430     size_t    m_len;
1431     bool      m_lenSet;
1432
1433     DECLARE_NO_COPY_CLASS(wxStringBufferLength)
1434 };
1435
1436 #endif // !wxUSE_STL
1437
1438 // ---------------------------------------------------------------------------
1439 // wxString comparison functions: operator versions are always case sensitive
1440 // ---------------------------------------------------------------------------
1441
1442 // note that when wxUSE_STL == 1 the comparison operators taking std::string
1443 // are used and defining them also for wxString would only result in
1444 // compilation ambiguities when comparing std::string and wxString
1445 #if !wxUSE_STL
1446
1447 inline bool operator==(const wxString& s1, const wxString& s2)
1448     { return (s1.Len() == s2.Len()) && (s1.Cmp(s2) == 0); }
1449 inline bool operator==(const wxString& s1, const wxChar  * s2)
1450     { return s1.Cmp(s2) == 0; }
1451 inline bool operator==(const wxChar  * s1, const wxString& s2)
1452     { return s2.Cmp(s1) == 0; }
1453 inline bool operator!=(const wxString& s1, const wxString& s2)
1454     { return (s1.Len() != s2.Len()) || (s1.Cmp(s2) != 0); }
1455 inline bool operator!=(const wxString& s1, const wxChar  * s2)
1456     { return s1.Cmp(s2) != 0; }
1457 inline bool operator!=(const wxChar  * s1, const wxString& s2)
1458     { return s2.Cmp(s1) != 0; }
1459 inline bool operator< (const wxString& s1, const wxString& s2)
1460     { return s1.Cmp(s2) < 0; }
1461 inline bool operator< (const wxString& s1, const wxChar  * s2)
1462     { return s1.Cmp(s2) <  0; }
1463 inline bool operator< (const wxChar  * s1, const wxString& s2)
1464     { return s2.Cmp(s1) >  0; }
1465 inline bool operator> (const wxString& s1, const wxString& s2)
1466     { return s1.Cmp(s2) >  0; }
1467 inline bool operator> (const wxString& s1, const wxChar  * s2)
1468     { return s1.Cmp(s2) >  0; }
1469 inline bool operator> (const wxChar  * s1, const wxString& s2)
1470     { return s2.Cmp(s1) <  0; }
1471 inline bool operator<=(const wxString& s1, const wxString& s2)
1472     { return s1.Cmp(s2) <= 0; }
1473 inline bool operator<=(const wxString& s1, const wxChar  * s2)
1474     { return s1.Cmp(s2) <= 0; }
1475 inline bool operator<=(const wxChar  * s1, const wxString& s2)
1476     { return s2.Cmp(s1) >= 0; }
1477 inline bool operator>=(const wxString& s1, const wxString& s2)
1478     { return s1.Cmp(s2) >= 0; }
1479 inline bool operator>=(const wxString& s1, const wxChar  * s2)
1480     { return s1.Cmp(s2) >= 0; }
1481 inline bool operator>=(const wxChar  * s1, const wxString& s2)
1482     { return s2.Cmp(s1) <= 0; }
1483
1484 #if wxUSE_UNICODE
1485 inline bool operator==(const wxString& s1, const wxWCharBuffer& s2)
1486     { return (s1.Cmp((const wchar_t *)s2) == 0); }
1487 inline bool operator==(const wxWCharBuffer& s1, const wxString& s2)
1488     { return (s2.Cmp((const wchar_t *)s1) == 0); }
1489 inline bool operator!=(const wxString& s1, const wxWCharBuffer& s2)
1490     { return (s1.Cmp((const wchar_t *)s2) != 0); }
1491 inline bool operator!=(const wxWCharBuffer& s1, const wxString& s2)
1492     { return (s2.Cmp((const wchar_t *)s1) != 0); }
1493 #else // !wxUSE_UNICODE
1494 inline bool operator==(const wxString& s1, const wxCharBuffer& s2)
1495     { return (s1.Cmp((const char *)s2) == 0); }
1496 inline bool operator==(const wxCharBuffer& s1, const wxString& s2)
1497     { return (s2.Cmp((const char *)s1) == 0); }
1498 inline bool operator!=(const wxString& s1, const wxCharBuffer& s2)
1499     { return (s1.Cmp((const char *)s2) != 0); }
1500 inline bool operator!=(const wxCharBuffer& s1, const wxString& s2)
1501     { return (s2.Cmp((const char *)s1) != 0); }
1502 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1503
1504 #if wxUSE_UNICODE
1505 inline wxString operator+(const wxString& string, const wxWCharBuffer& buf)
1506     { return string + (const wchar_t *)buf; }
1507 inline wxString operator+(const wxWCharBuffer& buf, const wxString& string)
1508     { return (const wchar_t *)buf + string; }
1509 #else // !wxUSE_UNICODE
1510 inline wxString operator+(const wxString& string, const wxCharBuffer& buf)
1511     { return string + (const char *)buf; }
1512 inline wxString operator+(const wxCharBuffer& buf, const wxString& string)
1513     { return (const char *)buf + string; }
1514 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1515
1516 #endif // !wxUSE_STL
1517
1518 // comparison with char (those are not defined by std::[w]string and so should
1519 // be always available)
1520 inline bool operator==(wxChar c, const wxString& s) { return s.IsSameAs(c); }
1521 inline bool operator==(const wxString& s, wxChar c) { return s.IsSameAs(c); }
1522 inline bool operator!=(wxChar c, const wxString& s) { return !s.IsSameAs(c); }
1523 inline bool operator!=(const wxString& s, wxChar c) { return !s.IsSameAs(c); }
1524
1525 // ---------------------------------------------------------------------------
1526 // Implementation only from here until the end of file
1527 // ---------------------------------------------------------------------------
1528
1529 // don't pollute the library user's name space
1530 #undef wxASSERT_VALID_INDEX
1531
1532 #if wxUSE_STD_IOSTREAM
1533
1534 #include "wx/iosfwrap.h"
1535
1536 WXDLLIMPEXP_BASE wxSTD istream& operator>>(wxSTD istream&, wxString&);
1537 WXDLLIMPEXP_BASE wxSTD ostream& operator<<(wxSTD ostream&, const wxString&);
1538
1539 #endif  // wxSTD_STRING_COMPATIBILITY
1540
1541 #endif  // _WX_WXSTRINGH__