Force wide char environment version initialization in wxGetEnvMap().

[wxWidgets.git] / include / wx / stringimpl.h

diff --git a/include/wx/stringimpl.h b/include/wx/stringimpl.h
index 4173d2c69b5b778d72a78a796a802ae5d47fd51e..674a3eb5f90ee34801b751f4ff1c6f7ac2a76051 100644 (file)
--- a/include/wx/stringimpl.h
+++ b/include/wx/stringimpl.h
@@ -11,7 +11,7 @@
 
 /*
     This header implements std::string-like string class, wxStringImpl, that is
 
 /*
     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.
 */
 
     wxStringImpl is just a typedef to std:: string class.
 */
 


@@ -23,7 +23,8 @@
 // ----------------------------------------------------------------------------
 
 #include "wx/defs.h"        // everybody should include this
 // ----------------------------------------------------------------------------
 
 #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>
 
 
 #include <stdlib.h>
 


@@ -33,7 +34,7 @@
 
 // implementation only
 #define   wxASSERT_VALID_INDEX(i) \
 
 // 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") )

 
 
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------


@@ -42,13 +43,22 @@
 
 // global pointer to empty string
 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString;
 
 // global pointer to empty string
 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString;

+#if wxUSE_UNICODE_UTF8
+// FIXME-UTF8: we should have only one wxEmptyString
+extern WXDLLIMPEXP_DATA_BASE(const wxStringCharType*) wxEmptyStringImpl;
+#endif

 
 
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------

-// 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
 
 // in both cases we need to define wxStdString
 #if wxUSE_STL_BASED_WXSTRING || wxUSE_STD_STRING


@@ -57,17 +67,20 @@ extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString;
 #include <string>
 #include "wx/afterstd.h"
 
 #include <string>
 #include "wx/afterstd.h"
 

+#ifdef HAVE_STD_WSTRING
+    typedef std::wstring wxStdWideString;
+#else
+    typedef std::basic_string<wchar_t> wxStdWideString;
+#endif
+

 #if wxUSE_UNICODE_WCHAR
 #if wxUSE_UNICODE_WCHAR

-    #ifdef HAVE_STD_WSTRING
-        typedef std::wstring wxStdString;
-    #else
-        typedef std::basic_string<wxChar> wxStdString;
-    #endif
+    typedef wxStdWideString wxStdString;

 #else
     typedef std::string wxStdString;
 #endif
 
 #else
     typedef std::string wxStdString;
 #endif
 

-#endif // need <string>
+#endif // wxUSE_STL_BASED_WXSTRING || wxUSE_STD_STRING
+

 
 #if wxUSE_STL_BASED_WXSTRING
 
 
 #if wxUSE_STL_BASED_WXSTRING
 


@@ -75,8 +88,10 @@ extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString;
     #undef wxUSE_STD_STRING
     #define wxUSE_STD_STRING 1
 
     #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)) || \
     #if (defined(__GNUG__) && (__GNUG__ < 3)) || \

-        (defined(_MSC_VER) && (_MSC_VER <= 1200))
+        !wxCHECK_VISUALC_VERSION(7) || defined(__EVC4__)

         #define wxSTRING_BASE_HASNT_CLEAR
     #endif
 
         #define wxSTRING_BASE_HASNT_CLEAR
     #endif
 


@@ -97,8 +112,8 @@ struct WXDLLIMPEXP_BASE wxStringData
   size_t  nDataLength,  // actual string length
           nAllocLength; // allocated memory size
 
   size_t  nDataLength,  // actual string length
           nAllocLength; // allocated memory size
 

-  // mimics declaration 'wxChar data[nAllocLength]'
-  wxChar* data() const { return (wxChar*)(this + 1); }
+  // mimics declaration 'wxStringCharType data[nAllocLength]'
+  wxStringCharType* data() const { return (wxStringCharType*)(this + 1); }

 
   // empty string has a special ref count so it's never deleted
   bool  IsEmpty()   const { return (nRefs == -1); }
 
   // empty string has a special ref count so it's never deleted
   bool  IsEmpty()   const { return (nRefs == -1); }


@@ -143,7 +158,11 @@ protected:
   // string (re)initialization functions
     // initializes the string to the empty value (must be called only from
     // ctors, use Reinit() otherwise)
   // string (re)initialization functions
     // initializes the string to the empty value (must be called only from
     // ctors, use Reinit() otherwise)

+#if wxUSE_UNICODE_UTF8
+  void Init() { m_pchData = (wxStringCharType *)wxEmptyStringImpl; } // FIXME-UTF8
+#else

   void Init() { m_pchData = (wxStringCharType *)wxEmptyString; }
   void Init() { m_pchData = (wxStringCharType *)wxEmptyString; }

+#endif

     // initializes the string with (a part of) C-string
   void InitWith(const wxStringCharType *psz, size_t nPos = 0, size_t nLen = npos);
     // as Init, but also frees old data
     // initializes the string with (a part of) C-string
   void InitWith(const wxStringCharType *psz, size_t nPos = 0, size_t nLen = npos);
     // as Init, but also frees old data


@@ -177,8 +196,96 @@ public:
   typedef const value_type& const_reference;
   typedef value_type* pointer;
   typedef const value_type* const_pointer;
   typedef const value_type& const_reference;
   typedef value_type* pointer;
   typedef const value_type* const_pointer;

-  typedef value_type *iterator;
-  typedef const value_type *const_iterator;
+
+  // macro to define the bulk of iterator and const_iterator classes
+  #define WX_DEFINE_STRINGIMPL_ITERATOR(iterator_name, ref_type, ptr_type)    \
+    public:                                                                   \
+        typedef wxStringCharType value_type;                                  \
+        typedef ref_type reference;                                           \
+        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; }                        \
+                                                                              \
+        iterator_name& operator++() { m_ptr++; return *this; }                \
+        iterator_name operator++(int)                                         \
+        {                                                                     \
+            const iterator_name tmp(*this);                                   \
+            m_ptr++;                                                          \
+            return tmp;                                                       \
+        }                                                                     \
+                                                                              \
+        iterator_name& operator--() { m_ptr--; return *this; }                \
+        iterator_name operator--(int)                                         \
+        {                                                                     \
+            const iterator_name tmp(*this);                                   \
+            m_ptr--;                                                          \
+            return tmp;                                                       \
+        }                                                                     \
+                                                                              \
+        iterator_name operator+(ptrdiff_t n) const                            \
+            { return iterator_name(m_ptr + n); }                              \
+        iterator_name operator-(ptrdiff_t n) const                            \
+            { return iterator_name(m_ptr - n); }                              \
+        iterator_name& operator+=(ptrdiff_t n)                                \
+            { m_ptr += n; return *this; }                                     \
+        iterator_name& operator-=(ptrdiff_t n)                                \
+            { m_ptr -= n; return *this; }                                     \
+                                                                              \
+        difference_type operator-(const iterator_name& i) const               \
+            { return m_ptr - i.m_ptr; }                                       \
+                                                                              \
+        bool operator==(const iterator_name& i) const                         \
+          { return m_ptr == i.m_ptr; }                                        \
+        bool operator!=(const iterator_name& i) const                         \
+          { return m_ptr != i.m_ptr; }                                        \
+                                                                              \
+        bool operator<(const iterator_name& i) const                          \
+          { return m_ptr < i.m_ptr; }                                         \
+        bool operator>(const iterator_name& i) const                          \
+          { return m_ptr > i.m_ptr; }                                         \
+        bool operator<=(const iterator_name& i) const                         \
+          { return m_ptr <= i.m_ptr; }                                        \
+        bool operator>=(const iterator_name& i) const                         \
+          { return m_ptr >= i.m_ptr; }                                        \
+                                                                              \
+    private:                                                                  \
+        /* for wxStringImpl use only */                                       \
+        pointer GetPtr() const { return m_ptr; }                              \
+                                                                              \
+        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 WXDLLIMPEXP_FWD_BASE const_iterator;
+
+  class WXDLLIMPEXP_BASE iterator
+  {
+    WX_DEFINE_STRINGIMPL_ITERATOR(iterator,
+                                  wxStringCharType&,
+                                  wxStringCharType*);
+
+    friend class const_iterator;
+  };
+
+  class WXDLLIMPEXP_BASE const_iterator
+  {
+  public:
+      const_iterator(iterator i) : m_ptr(i.m_ptr) { }
+
+      WX_DEFINE_STRINGIMPL_ITERATOR(const_iterator,
+                                    const wxStringCharType&,
+                                    const wxStringCharType*);
+  };
+
+  #undef WX_DEFINE_STRINGIMPL_ITERATOR
+

 
   // constructors and destructor
     // ctor for an empty string
 
   // constructors and destructor
     // ctor for an empty string


@@ -187,7 +294,7 @@ public:
   wxStringImpl(const wxStringImpl& stringSrc)
   {
     wxASSERT_MSG( stringSrc.GetStringData()->IsValid(),
   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
 
     if ( stringSrc.empty() ) {
       // nothing to do for an empty string


@@ -210,30 +317,42 @@ public:
   wxStringImpl(const wxStringImpl& str, size_t nPos, size_t nLen)
   {
     wxASSERT_MSG( str.GetStringData()->IsValid(),
   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);
   }
     Init();
     size_t strLen = str.length() - nPos; nLen = strLen < nLen ? strLen : nLen;
     InitWith(str.c_str(), nPos, nLen);
   }

-    // take all characters from pStart to pEnd
-  wxStringImpl(const void *pStart, const void *pEnd);
+    // take everything between start and end
+  wxStringImpl(const_iterator start, const_iterator end);
+
+
+    // ctor from and conversion to std::string
+#if wxUSE_STD_STRING
+  wxStringImpl(const wxStdString& impl)
+      { InitWith(impl.c_str(), 0, impl.length()); }
+
+  operator wxStdString() const
+      { return wxStdString(c_str(), length()); }
+#endif

 
 

-    // dtor is not virtual, this class must not be inherited from!
-  ~wxStringImpl()
-  {

 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 #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)
+    // 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
 
 #endif
 

+    // dtor is not virtual, this class must not be inherited from!
+  ~wxStringImpl()
+  {

       GetStringData()->Unlock();
   }
 
 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
       GetStringData()->Unlock();
   }
 
 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)

-    //re-enable inlining warning
-    #pragma warning (default:4714)
+    #pragma warning(pop)

 #endif
 #endif

+

   // overloaded assignment
     // from another wxString
   wxStringImpl& operator=(const wxStringImpl& stringSrc);
   // overloaded assignment
     // from another wxString
   wxStringImpl& operator=(const wxStringImpl& stringSrc);


@@ -260,9 +379,11 @@ public:
 
   // lib.string.access
     // return the character at position n
 
   // 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
   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 );
   reference at(size_type n)
   {
     wxASSERT_VALID_INDEX( n );


@@ -290,25 +411,25 @@ public:
   wxStringImpl& append(size_t n, wxStringCharType ch);
     // append from first to last
   wxStringImpl& append(const_iterator first, const_iterator last)
   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)
 
     // 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)
     // same as `= first n (or all if n == npos) characters of sz'
   wxStringImpl& assign(const wxStringCharType *sz)

-    { clear(); return append(sz, wxStrlen(sz)); }
+    { return replace(0, npos, sz, wxStrlen(sz)); }

   wxStringImpl& assign(const wxStringCharType *sz, size_t n)
   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)
     // 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)
     // 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; }
 
     // first valid index position
   const_iterator begin() const { return m_pchData; }


@@ -335,12 +456,12 @@ public:
     // insert first n (or all if n == npos) characters of sz
   wxStringImpl& insert(size_t nPos, const wxStringCharType *sz, size_t n = npos);
     // insert n copies of ch
     // insert first n (or all if n == npos) characters of sz
   wxStringImpl& insert(size_t nPos, const wxStringCharType *sz, size_t n = npos);
     // insert n copies of ch

-  wxStringImpl& insert(size_t nPos, size_t n, wxStringCharType ch)// FIXME-UTF8: tricky
+  wxStringImpl& insert(size_t nPos, size_t n, wxStringCharType ch)

     { return insert(nPos, wxStringImpl(n, ch)); }
     { return insert(nPos, wxStringImpl(n, ch)); }

-  iterator insert(iterator it, wxStringCharType ch) // FIXME-UTF8: tricky
+  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)
     { 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); }
 
   void insert(iterator it, size_type n, wxStringCharType ch)
     { insert(it - begin(), n, ch); }
 


@@ -359,18 +480,23 @@ public:
   const wxStringCharType* data() const { return m_pchData; }
 
     // replaces the substring of length nLen starting at nStart
   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)
     // 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
     // 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,
     // 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);
     // 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,
   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,


@@ -382,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, 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);
 
     // swap two strings
   void swap(wxStringImpl& str);


@@ -397,7 +523,7 @@ public:
     // find first n characters of sz
   size_t find(const wxStringCharType* sz, size_t nStart = 0, size_t n = npos) const;
 
     // find first n characters of sz
   size_t find(const wxStringCharType* sz, size_t nStart = 0, size_t n = npos) const;
 

-    // find the first occurence of character ch after nStart
+    // find the first occurrence of character ch after nStart

   size_t find(wxStringCharType ch, size_t nStart = 0) const;
 
     // rfind() family is exactly like find() but works right to left
   size_t find(wxStringCharType ch, size_t nStart = 0) const;
 
     // rfind() family is exactly like find() but works right to left


@@ -423,14 +549,12 @@ public:
       // string += char
   wxStringImpl& operator+=(wxStringCharType ch) { return append(1, ch); }
 
       // 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);
   // helpers for wxStringBuffer and wxStringBufferLength
   wxStringCharType *DoGetWriteBuf(size_t nLen);
   void DoUngetWriteBuf();
   void DoUngetWriteBuf(size_t nLen);

-#endif

 
 

-  friend class WXDLLIMPEXP_BASE wxString;
+  friend class WXDLLIMPEXP_FWD_BASE wxString;

 };
 
 #endif // !wxUSE_STL_BASED_WXSTRING
 };
 
 #endif // !wxUSE_STL_BASED_WXSTRING