include/wx/stringimpl.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/stringimpl.h
   3 // Purpose:     wxStringImpl class, implementation of wxString
   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     This header implements std::string-like string class, wxStringImpl, that is
  14     used by wxString to store the data. Alternatively, if wxUSE_STL=1,
  15     wxStringImpl is just a typedef to std:: string class.
  16 */
  17
  18 #ifndef _WX_WXSTRINGIMPL_H__
  19 #define _WX_WXSTRINGIMPL_H__
  20
  21 // ----------------------------------------------------------------------------
  22 // headers
  23 // ----------------------------------------------------------------------------
  24
  25 #include "wx/defs.h"        // everybody should include this
  26 #include "wx/wxchar.h"      // for wxChar, wxStrlen() etc.
  27
  28 #include <stdlib.h>
  29
  30 // ---------------------------------------------------------------------------
  31 // macros
  32 // ---------------------------------------------------------------------------
  33
  34 // implementation only
  35 #define   wxASSERT_VALID_INDEX(i) \
  36     wxASSERT_MSG( (size_t)(i) <= length(), _T("invalid index in wxString") )
  37
  38
  39 // ----------------------------------------------------------------------------
  40 // global data
  41 // ----------------------------------------------------------------------------
  42
  43 // global pointer to empty string
  44 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString;
  45
  46
  47 // ----------------------------------------------------------------------------
  48 // deal with STL/non-STL/non-STL-but-wxUSE_STD_STRING
  49 // ----------------------------------------------------------------------------
  50
  51 #define wxUSE_STL_BASED_WXSTRING  wxUSE_STL
  52
  53 // in both cases we need to define wxStdString
  54 #if wxUSE_STL_BASED_WXSTRING || wxUSE_STD_STRING
  55
  56 #include "wx/beforestd.h"
  57 #include <string>
  58 #include "wx/afterstd.h"
  59
  60 #if wxUSE_UNICODE_WCHAR
  61     #ifdef HAVE_STD_WSTRING
  62         typedef std::wstring wxStdString;
  63     #else
  64         typedef std::basic_string<wxChar> wxStdString;
  65     #endif
  66 #else
  67     typedef std::string wxStdString;
  68 #endif
  69
  70 #endif // need <string>
  71
  72 #if wxUSE_STL_BASED_WXSTRING
  73
  74     // we always want ctor from std::string when using std::string internally
  75     #undef wxUSE_STD_STRING
  76     #define wxUSE_STD_STRING 1
  77
  78     #if (defined(__GNUG__) && (__GNUG__ < 3)) || \
  79         (defined(_MSC_VER) && (_MSC_VER <= 1200))
  80         #define wxSTRING_BASE_HASNT_CLEAR
  81     #endif
  82
  83     typedef wxStdString wxStringImpl;
  84 #else // if !wxUSE_STL_BASED_WXSTRING
  85
  86 // in non-STL mode, compare() is implemented in wxString and not wxStringImpl
  87 #undef HAVE_STD_STRING_COMPARE
  88
  89 // ---------------------------------------------------------------------------
  90 // string data prepended with some housekeeping info (used by wxString class),
  91 // is never used directly (but had to be put here to allow inlining)
  92 // ---------------------------------------------------------------------------
  93
  94 struct WXDLLIMPEXP_BASE wxStringData
  95 {
  96   int     nRefs;        // reference count
  97   size_t  nDataLength,  // actual string length
  98           nAllocLength; // allocated memory size
  99
 100   // mimics declaration 'wxChar data[nAllocLength]'
 101   wxChar* data() const { return (wxChar*)(this + 1); }
 102
 103   // empty string has a special ref count so it's never deleted
 104   bool  IsEmpty()   const { return (nRefs == -1); }
 105   bool  IsShared()  const { return (nRefs > 1);   }
 106
 107   // lock/unlock
 108   void  Lock()   { if ( !IsEmpty() ) nRefs++;                    }
 109
 110   // VC++ will refuse to inline Unlock but profiling shows that it is wrong
 111 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 112   __forceinline
 113 #endif
 114   // VC++ free must take place in same DLL as allocation when using non dll
 115   // run-time library (e.g. Multithreaded instead of Multithreaded DLL)
 116 #if defined(__VISUALC__) && defined(_MT) && !defined(_DLL)
 117   void  Unlock() { if ( !IsEmpty() && --nRefs == 0) Free();  }
 118   // we must not inline deallocation since allocation is not inlined
 119   void  Free();
 120 #else
 121   void  Unlock() { if ( !IsEmpty() && --nRefs == 0) free(this);  }
 122 #endif
 123
 124   // if we had taken control over string memory (GetWriteBuf), it's
 125   // intentionally put in invalid state
 126   void  Validate(bool b)  { nRefs = (b ? 1 : 0); }
 127   bool  IsValid() const   { return (nRefs != 0); }
 128 };
 129
 130 class WXDLLIMPEXP_BASE wxStringImpl
 131 {
 132 public:
 133   // an 'invalid' value for string index, moved to this place due to a CW bug
 134   static const size_t npos;
 135
 136 protected:
 137   // points to data preceded by wxStringData structure with ref count info
 138   wxStringCharType *m_pchData;
 139
 140   // accessor to string data
 141   wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; }
 142
 143   // string (re)initialization functions
 144     // initializes the string to the empty value (must be called only from
 145     // ctors, use Reinit() otherwise)
 146   void Init() { m_pchData = (wxStringCharType *)wxEmptyString; }
 147     // initializes the string with (a part of) C-string
 148   void InitWith(const wxStringCharType *psz, size_t nPos = 0, size_t nLen = npos);
 149     // as Init, but also frees old data
 150   void Reinit() { GetStringData()->Unlock(); Init(); }
 151
 152   // memory allocation
 153     // allocates memory for string of length nLen
 154   bool AllocBuffer(size_t nLen);
 155     // effectively copies data to string
 156   bool AssignCopy(size_t, const wxStringCharType *);
 157
 158   // append a (sub)string
 159   bool ConcatSelf(size_t nLen, const wxStringCharType *src, size_t nMaxLen);
 160   bool ConcatSelf(size_t nLen, const wxStringCharType *src)
 161     { return ConcatSelf(nLen, src, nLen); }
 162
 163   // functions called before writing to the string: they copy it if there
 164   // are other references to our data (should be the only owner when writing)
 165   bool CopyBeforeWrite();
 166   bool AllocBeforeWrite(size_t);
 167
 168     // compatibility with wxString
 169   bool Alloc(size_t nLen);
 170
 171 public:
 172   // standard types
 173   typedef wxStringCharType value_type;
 174   typedef wxStringCharType char_type;
 175   typedef size_t size_type;
 176   typedef value_type& reference;
 177   typedef const value_type& const_reference;
 178   typedef value_type* pointer;
 179   typedef const value_type* const_pointer;
 180
 181   // macro to define the bulk of iterator and const_iterator classes
 182   #define WX_DEFINE_STRINGIMPL_ITERATOR(iterator_name, ref_type, ptr_type)    \
 183     public:                                                                   \
 184         typedef wxStringCharType value_type;                                  \
 185         typedef ref_type reference;                                           \
 186         typedef ptr_type pointer;                                             \
 187                                                                               \
 188         iterator_name(pointer ptr) : m_ptr(ptr) { }                           \
 189                                                                               \
 190         reference operator*() const { return *m_ptr; }                        \
 191                                                                               \
 192         iterator_name& operator++() { m_ptr++; return *this; }                \
 193         iterator_name operator++(int)                                         \
 194         {                                                                     \
 195             const iterator_name tmp(*this);                                   \
 196             m_ptr++;                                                          \
 197             return tmp;                                                       \
 198         }                                                                     \
 199                                                                               \
 200         iterator_name& operator--() { m_ptr--; return *this; }                \
 201         iterator_name operator--(int)                                         \
 202         {                                                                     \
 203             const iterator_name tmp(*this);                                   \
 204             m_ptr--;                                                          \
 205             return tmp;                                                       \
 206         }                                                                     \
 207                                                                               \
 208         iterator_name operator+(int n) const                                  \
 209             { return iterator_name(m_ptr + n); }                              \
 210         iterator_name operator-(int n) const                                  \
 211             { return iterator_name(m_ptr - n); }                              \
 212         iterator_name& operator+=(int n)                                      \
 213             { m_ptr += n; return *this; }                                     \
 214         iterator_name& operator-=(int n)                                      \
 215             { m_ptr -= n; return *this; }                                     \
 216                                                                               \
 217         size_t operator-(const iterator_name& i) const                        \
 218             { return m_ptr - i.m_ptr; }                                       \
 219                                                                               \
 220         bool operator==(const iterator_name& i) const                         \
 221           { return m_ptr == i.m_ptr; }                                        \
 222         bool operator!=(const iterator_name& i) const                         \
 223           { return m_ptr != i.m_ptr; }                                        \
 224                                                                               \
 225         bool operator<(const iterator_name& i) const                          \
 226           { return m_ptr < i.m_ptr; }                                         \
 227         bool operator>(const iterator_name& i) const                          \
 228           { return m_ptr > i.m_ptr; }                                         \
 229         bool operator<=(const iterator_name& i) const                         \
 230           { return m_ptr <= i.m_ptr; }                                        \
 231         bool operator>=(const iterator_name& i) const                         \
 232           { return m_ptr >= i.m_ptr; }                                        \
 233                                                                               \
 234     private:                                                                  \
 235         /* for wxStringImpl use only */                                       \
 236         operator pointer() const { return m_ptr; }                            \
 237                                                                               \
 238         friend class WXDLLIMPEXP_BASE wxStringImpl;                           \
 239                                                                               \
 240         pointer m_ptr
 241
 242   class iterator
 243   {
 244     WX_DEFINE_STRINGIMPL_ITERATOR(iterator,
 245                                   wxStringCharType&,
 246                                   wxStringCharType*);
 247
 248     friend class const_iterator;
 249   };
 250
 251   class const_iterator
 252   {
 253   public:
 254       const_iterator(iterator i) : m_ptr(i.m_ptr) { }
 255
 256       WX_DEFINE_STRINGIMPL_ITERATOR(const_iterator,
 257                                     const wxStringCharType&,
 258                                     const wxStringCharType*);
 259   };
 260
 261
 262   // constructors and destructor
 263     // ctor for an empty string
 264   wxStringImpl() { Init(); }
 265     // copy ctor
 266   wxStringImpl(const wxStringImpl& stringSrc)
 267   {
 268     wxASSERT_MSG( stringSrc.GetStringData()->IsValid(),
 269                   _T("did you forget to call UngetWriteBuf()?") );
 270
 271     if ( stringSrc.empty() ) {
 272       // nothing to do for an empty string
 273       Init();
 274     }
 275     else {
 276       m_pchData = stringSrc.m_pchData;            // share same data
 277       GetStringData()->Lock();                    // => one more copy
 278     }
 279   }
 280     // string containing nRepeat copies of ch
 281   wxStringImpl(size_type nRepeat, wxStringCharType ch);
 282     // ctor takes first nLength characters from C string
 283     // (default value of npos means take all the string)
 284   wxStringImpl(const wxStringCharType *psz)
 285       { InitWith(psz, 0, npos); }
 286   wxStringImpl(const wxStringCharType *psz, size_t nLength)
 287       { InitWith(psz, 0, nLength); }
 288     // take nLen chars starting at nPos
 289   wxStringImpl(const wxStringImpl& str, size_t nPos, size_t nLen)
 290   {
 291     wxASSERT_MSG( str.GetStringData()->IsValid(),
 292                   _T("did you forget to call UngetWriteBuf()?") );
 293     Init();
 294     size_t strLen = str.length() - nPos; nLen = strLen < nLen ? strLen : nLen;
 295     InitWith(str.c_str(), nPos, nLen);
 296   }
 297     // take everything between start and end
 298   wxStringImpl(const_iterator start, const_iterator end);
 299
 300     // dtor is not virtual, this class must not be inherited from!
 301   ~wxStringImpl()
 302   {
 303 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 304       //RN - according to the above VC++ does indeed inline this,
 305       //even though it spits out two warnings
 306       #pragma warning (disable:4714)
 307 #endif
 308
 309       GetStringData()->Unlock();
 310   }
 311
 312 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 313     //re-enable inlining warning
 314     #pragma warning (default:4714)
 315 #endif
 316   // overloaded assignment
 317     // from another wxString
 318   wxStringImpl& operator=(const wxStringImpl& stringSrc);
 319     // from a character
 320   wxStringImpl& operator=(wxStringCharType ch);
 321     // from a C string
 322   wxStringImpl& operator=(const wxStringCharType *psz);
 323
 324     // return the length of the string
 325   size_type length() const { return GetStringData()->nDataLength; }
 326     // return the length of the string
 327   size_type size() const { return length(); }
 328     // return the maximum size of the string
 329   size_type max_size() const { return npos; }
 330     // resize the string, filling the space with c if c != 0
 331   void resize(size_t nSize, wxStringCharType ch = '\0');
 332     // delete the contents of the string
 333   void clear() { erase(0, npos); }
 334     // returns true if the string is empty
 335   bool empty() const { return length() == 0; }
 336     // inform string about planned change in size
 337   void reserve(size_t sz) { Alloc(sz); }
 338   size_type capacity() const { return GetStringData()->nAllocLength; }
 339
 340   // lib.string.access
 341     // return the character at position n
 342   value_type at(size_type n) const
 343     { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
 344     // returns the writable character at position n
 345   reference at(size_type n)
 346   {
 347     wxASSERT_VALID_INDEX( n );
 348     CopyBeforeWrite();
 349     return m_pchData[n];
 350   } // FIXME-UTF8: not useful for us...?
 351
 352   // lib.string.modifiers
 353     // append elements str[pos], ..., str[pos+n]
 354   wxStringImpl& append(const wxStringImpl& str, size_t pos, size_t n)
 355   {
 356     wxASSERT(pos <= str.length());
 357     ConcatSelf(n, str.c_str() + pos, str.length() - pos);
 358     return *this;
 359   }
 360     // append a string
 361   wxStringImpl& append(const wxStringImpl& str)
 362     { ConcatSelf(str.length(), str.c_str()); return *this; }
 363     // append first n (or all if n == npos) characters of sz
 364   wxStringImpl& append(const wxStringCharType *sz)
 365     { ConcatSelf(wxStrlen(sz), sz); return *this; }
 366   wxStringImpl& append(const wxStringCharType *sz, size_t n)
 367     { ConcatSelf(n, sz); return *this; }
 368     // append n copies of ch
 369   wxStringImpl& append(size_t n, wxStringCharType ch);
 370     // append from first to last
 371   wxStringImpl& append(const_iterator first, const_iterator last)
 372     { ConcatSelf(last - first, first); return *this; }
 373
 374     // same as `this_string = str'
 375   wxStringImpl& assign(const wxStringImpl& str)
 376     { return *this = str; }
 377     // same as ` = str[pos..pos + n]
 378   wxStringImpl& assign(const wxStringImpl& str, size_t pos, size_t n)
 379     { clear(); return append(str, pos, n); }
 380     // same as `= first n (or all if n == npos) characters of sz'
 381   wxStringImpl& assign(const wxStringCharType *sz)
 382     { clear(); return append(sz, wxStrlen(sz)); }
 383   wxStringImpl& assign(const wxStringCharType *sz, size_t n)
 384     { clear(); return append(sz, n); }
 385     // same as `= n copies of ch'
 386   wxStringImpl& assign(size_t n, wxStringCharType ch)
 387     { clear(); return append(n, ch); }
 388     // assign from first to last
 389   wxStringImpl& assign(const_iterator first, const_iterator last)
 390     { clear(); return append(first, last); }
 391
 392     // first valid index position
 393   const_iterator begin() const { return m_pchData; }
 394   iterator begin();
 395     // position one after the last valid one
 396   const_iterator end() const { return m_pchData + length(); }
 397   iterator end();
 398
 399     // insert another string
 400   wxStringImpl& insert(size_t nPos, const wxStringImpl& str)
 401   {
 402     wxASSERT( str.GetStringData()->IsValid() );
 403     return insert(nPos, str.c_str(), str.length());
 404   }
 405     // insert n chars of str starting at nStart (in str)
 406   wxStringImpl& insert(size_t nPos, const wxStringImpl& str, size_t nStart, size_t n)
 407   {
 408     wxASSERT( str.GetStringData()->IsValid() );
 409     wxASSERT( nStart < str.length() );
 410     size_t strLen = str.length() - nStart;
 411     n = strLen < n ? strLen : n;
 412     return insert(nPos, str.c_str() + nStart, n);
 413   }
 414     // insert first n (or all if n == npos) characters of sz
 415   wxStringImpl& insert(size_t nPos, const wxStringCharType *sz, size_t n = npos);
 416     // insert n copies of ch
 417   wxStringImpl& insert(size_t nPos, size_t n, wxStringCharType ch)// FIXME-UTF8: tricky
 418     { return insert(nPos, wxStringImpl(n, ch)); }
 419   iterator insert(iterator it, wxStringCharType ch) // FIXME-UTF8: tricky
 420     { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; }
 421   void insert(iterator it, const_iterator first, const_iterator last)
 422     { insert(it - begin(), first, last - first); }
 423   void insert(iterator it, size_type n, wxStringCharType ch)
 424     { insert(it - begin(), n, ch); }
 425
 426     // delete characters from nStart to nStart + nLen
 427   wxStringImpl& erase(size_type pos = 0, size_type n = npos);
 428   iterator erase(iterator first, iterator last)
 429   {
 430     size_t idx = first - begin();
 431     erase(idx, last - first);
 432     return begin() + idx;
 433   }
 434   iterator erase(iterator first);
 435
 436   // explicit conversion to C string (use this with printf()!)
 437   const wxStringCharType* c_str() const { return m_pchData; }
 438   const wxStringCharType* data() const { return m_pchData; }
 439
 440     // replaces the substring of length nLen starting at nStart
 441   wxStringImpl& replace(size_t nStart, size_t nLen, const wxStringCharType* sz);
 442     // replaces the substring of length nLen starting at nStart
 443   wxStringImpl& replace(size_t nStart, size_t nLen, const wxStringImpl& str)
 444     { return replace(nStart, nLen, str.c_str()); }
 445     // replaces the substring with nCount copies of ch
 446   wxStringImpl& replace(size_t nStart, size_t nLen, size_t nCount, wxStringCharType ch);
 447     // replaces a substring with another substring
 448   wxStringImpl& replace(size_t nStart, size_t nLen,
 449                         const wxStringImpl& str, size_t nStart2, size_t nLen2);
 450     // replaces the substring with first nCount chars of sz
 451   wxStringImpl& replace(size_t nStart, size_t nLen,
 452                         const wxStringCharType* sz, size_t nCount);
 453   wxStringImpl& replace(iterator first, iterator last, const_pointer s)
 454     { return replace(first - begin(), last - first, s); }
 455   wxStringImpl& replace(iterator first, iterator last, const_pointer s,
 456                         size_type n)
 457     { return replace(first - begin(), last - first, s, n); }
 458   wxStringImpl& replace(iterator first, iterator last, const wxStringImpl& s)
 459     { return replace(first - begin(), last - first, s); }
 460   wxStringImpl& replace(iterator first, iterator last, size_type n, wxStringCharType c)
 461     { return replace(first - begin(), last - first, n, c); }
 462   wxStringImpl& replace(iterator first, iterator last,
 463                         const_iterator first1, const_iterator last1)
 464     { return replace(first - begin(), last - first, first1, last1 - first1); }
 465
 466     // swap two strings
 467   void swap(wxStringImpl& str);
 468
 469     // All find() functions take the nStart argument which specifies the
 470     // position to start the search on, the default value is 0. All functions
 471     // return npos if there were no match.
 472
 473     // find a substring
 474   size_t find(const wxStringImpl& str, size_t nStart = 0) const;
 475
 476     // find first n characters of sz
 477   size_t find(const wxStringCharType* sz, size_t nStart = 0, size_t n = npos) const;
 478
 479     // find the first occurrence of character ch after nStart
 480   size_t find(wxStringCharType ch, size_t nStart = 0) const;
 481
 482     // rfind() family is exactly like find() but works right to left
 483
 484     // as find, but from the end
 485   size_t rfind(const wxStringImpl& str, size_t nStart = npos) const;
 486
 487     // as find, but from the end
 488   size_t rfind(const wxStringCharType* sz, size_t nStart = npos,
 489                size_t n = npos) const;
 490     // as find, but from the end
 491   size_t rfind(wxStringCharType ch, size_t nStart = npos) const;
 492
 493   size_type copy(wxStringCharType* s, size_type n, size_type pos = 0);
 494
 495   // substring extraction
 496   wxStringImpl substr(size_t nStart = 0, size_t nLen = npos) const;
 497
 498       // string += string
 499   wxStringImpl& operator+=(const wxStringImpl& s) { return append(s); }
 500       // string += C string
 501   wxStringImpl& operator+=(const wxStringCharType *psz) { return append(psz); }
 502       // string += char
 503   wxStringImpl& operator+=(wxStringCharType ch) { return append(1, ch); }
 504
 505 #if !wxUSE_UNICODE_UTF8
 506   // helpers for wxStringBuffer and wxStringBufferLength
 507   wxStringCharType *DoGetWriteBuf(size_t nLen);
 508   void DoUngetWriteBuf();
 509   void DoUngetWriteBuf(size_t nLen);
 510 #endif
 511
 512   friend class WXDLLIMPEXP_BASE wxString;
 513 };
 514
 515 #endif // !wxUSE_STL_BASED_WXSTRING
 516
 517 // don't pollute the library user's name space
 518 #undef wxASSERT_VALID_INDEX
 519
 520 #endif  // _WX_WXSTRINGIMPL_H__