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