]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/stringimpl.h
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / stringimpl.h
index 1b3f172c948bda220fa3bd0398a3f1196818a661..674a3eb5f90ee34801b751f4ff1c6f7ac2a76051 100644 (file)
@@ -11,7 +11,7 @@
 
 /*
     This header implements std::string-like string class, wxStringImpl, that is
-    used by wxString to store the data. Alternatively, if wxUSE_STL=1,
+    used by wxString to store the data. Alternatively, if wxUSE_STD_STRING=1,
     wxStringImpl is just a typedef to std:: string class.
 */
 
@@ -23,7 +23,8 @@
 // ----------------------------------------------------------------------------
 
 #include "wx/defs.h"        // everybody should include this
-#include "wx/wxchar.h"      // for wxChar, wxStrlen() etc.
+#include "wx/chartype.h"    // for wxChar
+#include "wx/wxcrtbase.h"   // for wxStrlen() etc.
 
 #include <stdlib.h>
 
@@ -33,7 +34,7 @@
 
 // implementation only
 #define   wxASSERT_VALID_INDEX(i) \
-    wxASSERT_MSG( (size_t)(i) <= length(), _T("invalid index in wxString") )
+    wxASSERT_MSG( (size_t)(i) <= length(), wxT("invalid index in wxString") )
 
 
 // ----------------------------------------------------------------------------
@@ -49,10 +50,15 @@ extern WXDLLIMPEXP_DATA_BASE(const wxStringCharType*) wxEmptyStringImpl;
 
 
 // ----------------------------------------------------------------------------
-// deal with STL/non-STL/non-STL-but-wxUSE_STD_STRING
+// deal with various build options
 // ----------------------------------------------------------------------------
 
-#define wxUSE_STL_BASED_WXSTRING  wxUSE_STL
+// we use STL-based string internally if we use std::string at all now, there
+// should be no reason to prefer our internal implement but if you really need
+// it you can predefine wxUSE_STL_BASED_WXSTRING as 0 when building the library
+#ifndef wxUSE_STL_BASED_WXSTRING
+    #define wxUSE_STL_BASED_WXSTRING  wxUSE_STD_STRING
+#endif
 
 // in both cases we need to define wxStdString
 #if wxUSE_STL_BASED_WXSTRING || wxUSE_STD_STRING
@@ -82,8 +88,10 @@ extern WXDLLIMPEXP_DATA_BASE(const wxStringCharType*) wxEmptyStringImpl;
     #undef wxUSE_STD_STRING
     #define wxUSE_STD_STRING 1
 
+    // the versions of std::string included with gcc 2.95 and VC6 (for which
+    // _MSC_VER == 1200) and eVC4 (_MSC_VER == 1201) lack clear() method
     #if (defined(__GNUG__) && (__GNUG__ < 3)) || \
-        (defined(_MSC_VER) && (_MSC_VER <= 1200))
+        !wxCHECK_VISUALC_VERSION(7) || defined(__EVC4__)
         #define wxSTRING_BASE_HASNT_CLEAR
     #endif
 
@@ -197,6 +205,7 @@ public:
         typedef ptr_type pointer;                                             \
         typedef int difference_type;                                          \
                                                                               \
+        iterator_name() : m_ptr(NULL) { }                                     \
         iterator_name(pointer ptr) : m_ptr(ptr) { }                           \
                                                                               \
         reference operator*() const { return *m_ptr; }                        \
@@ -217,21 +226,13 @@ public:
             return tmp;                                                       \
         }                                                                     \
                                                                               \
-        iterator_name operator+(int n) const                                  \
-            { return iterator_name(m_ptr + n); }                              \
-        iterator_name operator+(size_t n) const                               \
+        iterator_name operator+(ptrdiff_t n) const                            \
             { return iterator_name(m_ptr + n); }                              \
-        iterator_name operator-(int n) const                                  \
-            { return iterator_name(m_ptr - n); }                              \
-        iterator_name operator-(size_t n) const                               \
+        iterator_name operator-(ptrdiff_t n) const                            \
             { return iterator_name(m_ptr - n); }                              \
-        iterator_name& operator+=(int n)                                      \
+        iterator_name& operator+=(ptrdiff_t n)                                \
             { m_ptr += n; return *this; }                                     \
-        iterator_name& operator+=(size_t n)                                   \
-            { m_ptr += n; return *this; }                                     \
-        iterator_name& operator-=(int n)                                      \
-            { m_ptr -= n; return *this; }                                     \
-        iterator_name& operator-=(size_t n)                                   \
+        iterator_name& operator-=(ptrdiff_t n)                                \
             { m_ptr -= n; return *this; }                                     \
                                                                               \
         difference_type operator-(const iterator_name& i) const               \
@@ -253,18 +254,18 @@ public:
                                                                               \
     private:                                                                  \
         /* for wxStringImpl use only */                                       \
-        operator pointer() const { return m_ptr; }                            \
+        pointer GetPtr() const { return m_ptr; }                              \
                                                                               \
-        friend class WXDLLIMPEXP_BASE wxStringImpl;                           \
+        friend class wxStringImpl;                                            \
                                                                               \
         pointer m_ptr
 
   // we need to declare const_iterator in wxStringImpl scope, the friend
   // declaration inside iterator class itself is not enough, or at least not
   // for g++ 3.4 (g++ 4 is ok)
-  class const_iterator;
+  class WXDLLIMPEXP_FWD_BASE const_iterator;
 
-  class iterator
+  class WXDLLIMPEXP_BASE iterator
   {
     WX_DEFINE_STRINGIMPL_ITERATOR(iterator,
                                   wxStringCharType&,
@@ -273,7 +274,7 @@ public:
     friend class const_iterator;
   };
 
-  class const_iterator
+  class WXDLLIMPEXP_BASE const_iterator
   {
   public:
       const_iterator(iterator i) : m_ptr(i.m_ptr) { }
@@ -293,7 +294,7 @@ public:
   wxStringImpl(const wxStringImpl& stringSrc)
   {
     wxASSERT_MSG( stringSrc.GetStringData()->IsValid(),
-                  _T("did you forget to call UngetWriteBuf()?") );
+                  wxT("did you forget to call UngetWriteBuf()?") );
 
     if ( stringSrc.empty() ) {
       // nothing to do for an empty string
@@ -316,7 +317,7 @@ public:
   wxStringImpl(const wxStringImpl& str, size_t nPos, size_t nLen)
   {
     wxASSERT_MSG( str.GetStringData()->IsValid(),
-                  _T("did you forget to call UngetWriteBuf()?") );
+                  wxT("did you forget to call UngetWriteBuf()?") );
     Init();
     size_t strLen = str.length() - nPos; nLen = strLen < nLen ? strLen : nLen;
     InitWith(str.c_str(), nPos, nLen);
@@ -334,23 +335,24 @@ public:
       { return wxStdString(c_str(), length()); }
 #endif
 
+#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
+    // disable warning about Unlock() below not being inlined (first, it
+    // seems to be inlined nevertheless and second, even if it isn't, there
+    // is nothing we can do about this
+    #pragma warning(push)
+    #pragma warning (disable:4714)
+#endif
 
     // dtor is not virtual, this class must not be inherited from!
   ~wxStringImpl()
   {
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
-      //RN - according to the above VC++ does indeed inline this,
-      //even though it spits out two warnings
-      #pragma warning (disable:4714)
-#endif
-
       GetStringData()->Unlock();
   }
 
 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
-    //re-enable inlining warning
-    #pragma warning (default:4714)
+    #pragma warning(pop)
 #endif
+
   // overloaded assignment
     // from another wxString
   wxStringImpl& operator=(const wxStringImpl& stringSrc);
@@ -377,9 +379,11 @@ public:
 
   // lib.string.access
     // return the character at position n
+  value_type operator[](size_type n) const { return m_pchData[n]; }
   value_type at(size_type n) const
     { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
     // returns the writable character at position n
+  reference operator[](size_type n) { CopyBeforeWrite(); return m_pchData[n]; }
   reference at(size_type n)
   {
     wxASSERT_VALID_INDEX( n );
@@ -400,32 +404,32 @@ public:
     { ConcatSelf(str.length(), str.c_str()); return *this; }
     // append first n (or all if n == npos) characters of sz
   wxStringImpl& append(const wxStringCharType *sz)
-    { ConcatSelf(Strsize(sz), sz); return *this; }
+    { ConcatSelf(wxStrlen(sz), sz); return *this; }
   wxStringImpl& append(const wxStringCharType *sz, size_t n)
     { ConcatSelf(n, sz); return *this; }
     // append n copies of ch
   wxStringImpl& append(size_t n, wxStringCharType ch);
     // append from first to last
   wxStringImpl& append(const_iterator first, const_iterator last)
-    { ConcatSelf(last - first, first); return *this; }
+    { ConcatSelf(last - first, first.GetPtr()); return *this; }
 
     // same as `this_string = str'
   wxStringImpl& assign(const wxStringImpl& str)
     { return *this = str; }
     // same as ` = str[pos..pos + n]
   wxStringImpl& assign(const wxStringImpl& str, size_t pos, size_t n)
-    { clear(); return append(str, pos, n); }
+    { return replace(0, npos, str, pos, n); }
     // same as `= first n (or all if n == npos) characters of sz'
   wxStringImpl& assign(const wxStringCharType *sz)
-    { clear(); return append(sz, Strsize(sz)); }
+    { return replace(0, npos, sz, wxStrlen(sz)); }
   wxStringImpl& assign(const wxStringCharType *sz, size_t n)
-    { clear(); return append(sz, n); }
+    { return replace(0, npos, sz, n); }
     // same as `= n copies of ch'
   wxStringImpl& assign(size_t n, wxStringCharType ch)
-    { clear(); return append(n, ch); }
+    { return replace(0, npos, n, ch); }
     // assign from first to last
   wxStringImpl& assign(const_iterator first, const_iterator last)
-    { clear(); return append(first, last); }
+    { return replace(begin(), end(), first, last); }
 
     // first valid index position
   const_iterator begin() const { return m_pchData; }
@@ -457,7 +461,7 @@ public:
   iterator insert(iterator it, wxStringCharType ch)
     { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; }
   void insert(iterator it, const_iterator first, const_iterator last)
-    { insert(it - begin(), first, last - first); }
+    { insert(it - begin(), first.GetPtr(), last - first); }
   void insert(iterator it, size_type n, wxStringCharType ch)
     { insert(it - begin(), n, ch); }
 
@@ -476,18 +480,23 @@ public:
   const wxStringCharType* data() const { return m_pchData; }
 
     // replaces the substring of length nLen starting at nStart
-  wxStringImpl& replace(size_t nStart, size_t nLen, const wxStringCharType* sz);
+  wxStringImpl& replace(size_t nStart, size_t nLen, const wxStringCharType* sz)
+    { return replace(nStart, nLen, sz, npos); }
     // replaces the substring of length nLen starting at nStart
   wxStringImpl& replace(size_t nStart, size_t nLen, const wxStringImpl& str)
-    { return replace(nStart, nLen, str.c_str()); }
+    { return replace(nStart, nLen, str.c_str(), str.length()); }
     // replaces the substring with nCount copies of ch
-  wxStringImpl& replace(size_t nStart, size_t nLen, size_t nCount, wxStringCharType ch);
+  wxStringImpl& replace(size_t nStart, size_t nLen,
+                        size_t nCount, wxStringCharType ch)
+    { return replace(nStart, nLen, wxStringImpl(nCount, ch)); }
     // replaces a substring with another substring
   wxStringImpl& replace(size_t nStart, size_t nLen,
-                        const wxStringImpl& str, size_t nStart2, size_t nLen2);
+                        const wxStringImpl& str, size_t nStart2, size_t nLen2)
+    { return replace(nStart, nLen, str.substr(nStart2, nLen2)); }
     // replaces the substring with first nCount chars of sz
   wxStringImpl& replace(size_t nStart, size_t nLen,
                         const wxStringCharType* sz, size_t nCount);
+
   wxStringImpl& replace(iterator first, iterator last, const_pointer s)
     { return replace(first - begin(), last - first, s); }
   wxStringImpl& replace(iterator first, iterator last, const_pointer s,
@@ -499,7 +508,7 @@ public:
     { return replace(first - begin(), last - first, n, c); }
   wxStringImpl& replace(iterator first, iterator last,
                         const_iterator first1, const_iterator last1)
-    { return replace(first - begin(), last - first, first1, last1 - first1); }
+    { return replace(first - begin(), last - first, first1.GetPtr(), last1 - first1); }
 
     // swap two strings
   void swap(wxStringImpl& str);
@@ -540,21 +549,12 @@ public:
       // string += char
   wxStringImpl& operator+=(wxStringCharType ch) { return append(1, ch); }
 
-#if !wxUSE_UNICODE_UTF8
   // helpers for wxStringBuffer and wxStringBufferLength
   wxStringCharType *DoGetWriteBuf(size_t nLen);
   void DoUngetWriteBuf();
   void DoUngetWriteBuf(size_t nLen);
-#endif
-
-private:
-#if wxUSE_UNICODE_UTF8
-  static size_t Strsize(const wxStringCharType *s) { return strlen(s); }
-#else
-  static size_t Strsize(const wxStringCharType *s) { return wxStrlen(s); }
-#endif
 
-  friend class WXDLLIMPEXP_BASE wxString;
+  friend class WXDLLIMPEXP_FWD_BASE wxString;
 };
 
 #endif // !wxUSE_STL_BASED_WXSTRING