Adapted to API changes with respect to GetTextExtent (patch #1709152).

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

diff --git a/include/wx/string.h b/include/wx/string.h
index 83ca3c62ee4e0a9c1289c503e769c647c2e3e2b7..43bde5e5c1636290927bcc2a4c8d31af5a98f00b 100644 (file)
--- a/include/wx/string.h
+++ b/include/wx/string.h
@@ -51,7 +51,7 @@
     #include <StringMgr.h>
 #endif
 
     #include <StringMgr.h>
 #endif
 

-#include "wx/wxchar.h"      // for wxChar, wxStrlen() etc.
+#include "wx/wxcrt.h"       // for wxChar, wxStrlen() etc.

 #include "wx/strvararg.h"
 #include "wx/buffer.h"      // for wxCharBuffer
 #include "wx/strconv.h"     // for wxConvertXXX() macros and wxMBConv classes
 #include "wx/strvararg.h"
 #include "wx/buffer.h"      // for wxCharBuffer
 #include "wx/strconv.h"     // for wxConvertXXX() macros and wxMBConv classes


@@ -186,8 +186,9 @@ private:
 public:
     // Ctor constructs the object from char literal; they are needed to make
     // operator?: compile and they intentionally take char*, not const char*
 public:
     // Ctor constructs the object from char literal; they are needed to make
     // operator?: compile and they intentionally take char*, not const char*

-    wxCStrData(char *buf);
-    wxCStrData(wchar_t *buf);
+    inline wxCStrData(char *buf);
+    inline wxCStrData(wchar_t *buf);
+    inline wxCStrData(const wxCStrData& data);

 
     inline ~wxCStrData();
 
 
     inline ~wxCStrData();
 


@@ -216,6 +217,10 @@ public:
 
     inline wxString AsString() const;
 
 
     inline wxString AsString() const;
 

+    // returns the value as C string in internal representation (equivalent
+    // to AsString().wx_str(), but more efficient)
+    const wxStringCharType *AsInternal() const;
+

     // allow expressions like "c_str()[0]":
     inline wxUniChar operator[](size_t n) const;
     wxUniChar operator[](int n) const { return operator[](size_t(n)); }
     // allow expressions like "c_str()[0]":
     inline wxUniChar operator[](size_t n) const;
     wxUniChar operator[](int n) const { return operator[](size_t(n)); }


@@ -292,8 +297,8 @@ class WXDLLIMPEXP_BASE wxStringPrintfMixinBase
 protected:
     wxStringPrintfMixinBase() {}
 
 protected:
     wxStringPrintfMixinBase() {}
 

-    int DoPrintf(const wxChar *format, ...) ATTRIBUTE_PRINTF_2;
-    static wxString DoFormat(const wxChar *format, ...) ATTRIBUTE_PRINTF_1;
+    int DoPrintf(const wxString& format, ...);
+    static wxString DoFormat(const wxString& format, ...);

 };
 
 // this class contains template wrappers for wxString's vararg methods, it's
 };
 
 // this class contains template wrappers for wxString's vararg methods, it's


@@ -316,13 +321,27 @@ public:
     // these are duplicated wxString methods, they're also declared below
     // if !wxNEEDS_WXSTRING_PRINTF_MIXIN:
 
     // these are duplicated wxString methods, they're also declared below
     // if !wxNEEDS_WXSTRING_PRINTF_MIXIN:
 

-    // int Printf(const wxChar *pszFormat, ...);
-    WX_DEFINE_VARARG_FUNC(int, Printf, DoPrintf)
-    // static wxString Format(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_1;
-    WX_DEFINE_VARARG_FUNC(static typename StringReturnType<T1>::type,
-                          Format, DoFormat)
-    // int sprintf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
-    WX_DEFINE_VARARG_FUNC(int, sprintf, DoPrintf)
+    // static wxString Format(const wString& format, ...) ATTRIBUTE_PRINTF_1;
+    WX_DEFINE_VARARG_FUNC2_SANS_N0(static typename StringReturnType<T1>::type,
+                                   Format, 1, (const wxString&),
+                                   DoFormat, DoFormat)
+    // We have to implement the version without template arguments manually
+    // because of the StringReturnType<> hack, although WX_DEFINE_VARARG_FUNC
+    // normally does it itself. It has to be a template so that we can use
+    // the hack, even though there's no real template parameter:
+    struct FormatDummyArg {} ;
+
+    template<typename T>
+    inline static typename StringReturnType<T>::type
+    Format(const wxString& fmt, FormatDummyArg dummy = FormatDummyArg())
+    {
+        return DoFormat(fmt);
+    }
+
+    // int Printf(const wxString& format, ...);
+    WX_DEFINE_VARARG_FUNC(int, Printf, 1, (const wxString&), DoPrintf)
+    // int sprintf(const wxString& format, ...) ATTRIBUTE_PRINTF_2;
+    WX_DEFINE_VARARG_FUNC(int, sprintf, 1, (const wxString&), DoPrintf)

 
 protected:
     wxStringPrintfMixin() : wxStringPrintfMixinBase() {}
 
 protected:
     wxStringPrintfMixin() : wxStringPrintfMixinBase() {}


@@ -879,7 +898,6 @@ public:
   // libstdc++ on some Linux versions which is bad, so instead we ask the
   // client code to define this wxUSE_STD_STRING symbol if they need it
 #if wxUSE_STD_STRING
   // libstdc++ on some Linux versions which is bad, so instead we ask the
   // client code to define this wxUSE_STD_STRING symbol if they need it
 #if wxUSE_STD_STRING

-

   #if wxUSE_UNICODE_WCHAR
     wxString(const wxStdWideString& str) : m_impl(str) {}
   #else // UTF-8 or ANSI
   #if wxUSE_UNICODE_WCHAR
     wxString(const wxStdWideString& str) : m_impl(str) {}
   #else // UTF-8 or ANSI


@@ -1484,16 +1502,27 @@ public:
   // formatted input/output
     // as sprintf(), returns the number of characters written or < 0 on error
     // (take 'this' into account in attribute parameter count)
   // formatted input/output
     // as sprintf(), returns the number of characters written or < 0 on error
     // (take 'this' into account in attribute parameter count)

-  // int Printf(const wxChar *pszFormat, ...);
-  WX_DEFINE_VARARG_FUNC(int, Printf, DoPrintf)
+  // int Printf(const wxString& format, ...);
+  WX_DEFINE_VARARG_FUNC(int, Printf, 1, (const wxString&), DoPrintf)
+#ifdef __WATCOMC__
+  WX_DEFINE_VARARG_FUNC(int, Printf, 1, (const char*), DoPrintf)
+  WX_DEFINE_VARARG_FUNC(int, Printf, 1, (const wchar_t*), DoPrintf)
+  WX_DEFINE_VARARG_FUNC(int, Printf, 1, (const wxCStrData&), DoPrintf)
+#endif

 #endif // !wxNEEDS_WXSTRING_PRINTF_MIXIN
     // as vprintf(), returns the number of characters written or < 0 on error
   int PrintfV(const wxString& format, va_list argptr);
 
 #ifndef wxNEEDS_WXSTRING_PRINTF_MIXIN
     // returns the string containing the result of Printf() to it
 #endif // !wxNEEDS_WXSTRING_PRINTF_MIXIN
     // as vprintf(), returns the number of characters written or < 0 on error
   int PrintfV(const wxString& format, va_list argptr);
 
 #ifndef wxNEEDS_WXSTRING_PRINTF_MIXIN
     // returns the string containing the result of Printf() to it

-  // static wxString Format(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_1;
-  WX_DEFINE_VARARG_FUNC(static wxString, Format, DoFormat)
+  // static wxString Format(const wxString& format, ...) ATTRIBUTE_PRINTF_1;
+  WX_DEFINE_VARARG_FUNC(static wxString, Format, 1, (const wxString&), DoFormat)
+#ifdef __WATCOMC__
+  // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+  WX_DEFINE_VARARG_FUNC(static wxString, Format, 1, (const char*), DoFormat)
+  WX_DEFINE_VARARG_FUNC(static wxString, Format, 1, (const wchar_t*), DoFormat)
+  WX_DEFINE_VARARG_FUNC(static wxString, Format, 1, (const wxCStrData&), DoFormat)
+#endif

 #endif
     // the same as above, but takes a va_list
   static wxString FormatV(const wxString& format, va_list argptr);
 #endif
     // the same as above, but takes a va_list
   static wxString FormatV(const wxString& format, va_list argptr);


@@ -1529,8 +1558,14 @@ public:
 #ifndef wxNEEDS_WXSTRING_PRINTF_MIXIN
   // use Printf()
   // (take 'this' into account in attribute parameter count)
 #ifndef wxNEEDS_WXSTRING_PRINTF_MIXIN
   // use Printf()
   // (take 'this' into account in attribute parameter count)

-  // int sprintf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
-  WX_DEFINE_VARARG_FUNC(int, sprintf, DoPrintf)
+  // int sprintf(const wxString& format, ...) ATTRIBUTE_PRINTF_2;
+  WX_DEFINE_VARARG_FUNC(int, sprintf, 1, (const wxString&), DoPrintf)
+#ifdef __WATCOMC__
+  // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+  WX_DEFINE_VARARG_FUNC(int, sprintf, 1, (const char*), DoPrintf)
+  WX_DEFINE_VARARG_FUNC(int, sprintf, 1, (const wchar_t*), DoPrintf)
+  WX_DEFINE_VARARG_FUNC(int, sprintf, 1, (const wxCStrData&), DoPrintf)
+#endif

 #endif // wxNEEDS_WXSTRING_PRINTF_MIXIN
 
     // use Cmp()
 #endif // wxNEEDS_WXSTRING_PRINTF_MIXIN
 
     // use Cmp()


@@ -2200,7 +2235,7 @@ public:
   wxString& operator+=(wchar_t ch) { return *this += wxUniChar(ch); }
 
 private:
   wxString& operator+=(wchar_t ch) { return *this += wxUniChar(ch); }
 
 private:

-#if !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8
+#if !wxUSE_STL_BASED_WXSTRING

   // helpers for wxStringBuffer and wxStringBufferLength
   wxStringCharType *DoGetWriteBuf(size_t nLen)
     { return m_impl.DoGetWriteBuf(nLen); }
   // helpers for wxStringBuffer and wxStringBufferLength
   wxStringCharType *DoGetWriteBuf(size_t nLen)
     { return m_impl.DoGetWriteBuf(nLen); }


@@ -2208,14 +2243,11 @@ private:
     { m_impl.DoUngetWriteBuf(); }
   void DoUngetWriteBuf(size_t nLen)
     { m_impl.DoUngetWriteBuf(nLen); }
     { m_impl.DoUngetWriteBuf(); }
   void DoUngetWriteBuf(size_t nLen)
     { m_impl.DoUngetWriteBuf(nLen); }

-
-  friend class WXDLLIMPEXP_BASE wxStringBuffer;
-  friend class WXDLLIMPEXP_BASE wxStringBufferLength;
-#endif // !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8
+#endif // !wxUSE_STL_BASED_WXSTRING

 
 #ifndef wxNEEDS_WXSTRING_PRINTF_MIXIN
 
 #ifndef wxNEEDS_WXSTRING_PRINTF_MIXIN

-  int DoPrintf(const wxChar *format, ...) ATTRIBUTE_PRINTF_2;
-  static wxString DoFormat(const wxChar *format, ...) ATTRIBUTE_PRINTF_1;
+  int DoPrintf(const wxString& format, ...);
+  static wxString DoFormat(const wxString& format, ...);

 #endif
 
 #if !wxUSE_STL_BASED_WXSTRING
 #endif
 
 #if !wxUSE_STL_BASED_WXSTRING


@@ -2253,7 +2285,10 @@ private:
 #if !wxUSE_UNICODE_WCHAR
   ConvertedBuffer<wchar_t> m_convertedToWChar;
 #endif
 #if !wxUSE_UNICODE_WCHAR
   ConvertedBuffer<wchar_t> m_convertedToWChar;
 #endif

+

   friend class WXDLLIMPEXP_BASE wxCStrData;
   friend class WXDLLIMPEXP_BASE wxCStrData;

+  friend class wxImplStringBuffer;
+  friend class wxImplStringBufferLength;

 };
 
 #ifdef wxNEEDS_WXSTRING_PRINTF_MIXIN
 };
 
 #ifdef wxNEEDS_WXSTRING_PRINTF_MIXIN


@@ -2321,107 +2356,170 @@ inline wxString operator+(wchar_t ch, const wxString& string)
 // wxStringBuffer: a tiny class allowing to get a writable pointer into string
 // ----------------------------------------------------------------------------
 
 // wxStringBuffer: a tiny class allowing to get a writable pointer into string
 // ----------------------------------------------------------------------------
 

-#if wxUSE_STL_BASED_WXSTRING || wxUSE_UNICODE_UTF8
+#if !wxUSE_STL_BASED_WXSTRING
+// string buffer for direct access to string data in their native
+// representation:
+class wxImplStringBuffer
+{
+public:
+    typedef wxStringCharType CharType;
+
+    wxImplStringBuffer(wxString& str, size_t lenWanted = 1024)
+        : m_str(str), m_buf(NULL)
+        { m_buf = m_str.DoGetWriteBuf(lenWanted); }
+
+    ~wxImplStringBuffer() { m_str.DoUngetWriteBuf(); }
+
+    operator wxStringCharType*() const { return m_buf; }
+
+private:
+    wxString&         m_str;
+    wxStringCharType *m_buf;
+
+    DECLARE_NO_COPY_CLASS(wxImplStringBuffer)
+};

 
 

-class WXDLLIMPEXP_BASE wxStringBuffer
+class wxImplStringBufferLength

 {
 public:
 {
 public:

-    wxStringBuffer(wxString& str, size_t lenWanted = 1024)
+    typedef wxStringCharType CharType;
+
+    wxImplStringBufferLength(wxString& str, size_t lenWanted = 1024)
+        : m_str(str), m_buf(NULL), m_len(0), m_lenSet(false)
+    {
+        m_buf = m_str.DoGetWriteBuf(lenWanted);
+        wxASSERT(m_buf != NULL);
+    }
+
+    ~wxImplStringBufferLength()
+    {
+        wxASSERT(m_lenSet);
+        m_str.DoUngetWriteBuf(m_len);
+    }
+
+    operator wxStringCharType*() const { return m_buf; }
+    void SetLength(size_t length) { m_len = length; m_lenSet = true; }
+
+private:
+    wxString&         m_str;
+    wxStringCharType *m_buf;
+    size_t            m_len;
+    bool              m_lenSet;
+
+    DECLARE_NO_COPY_CLASS(wxImplStringBufferLength)
+};
+
+#endif // !wxUSE_STL_BASED_WXSTRING
+
+template<typename T>
+class wxStringTypeBufferBase
+{
+public:
+    typedef T CharType;
+
+    wxStringTypeBufferBase(wxString& str, size_t lenWanted = 1024)

         : m_str(str), m_buf(lenWanted)
         { }
 
         : m_str(str), m_buf(lenWanted)
         { }
 

-    ~wxStringBuffer() { m_str.assign(m_buf.data(), wxStrlen(m_buf.data())); }

 
 

-    operator wxChar*() { return m_buf.data(); }
+    operator CharType*() { return m_buf.data(); }

 
 

-private:
+protected:

     wxString& m_str;
     wxString& m_str;

-#if wxUSE_UNICODE
-    wxWCharBuffer m_buf;
-#else
-    wxCharBuffer m_buf;
-#endif
-
-    DECLARE_NO_COPY_CLASS(wxStringBuffer)
+    wxCharTypeBuffer<CharType> m_buf;

 };
 
 };
 

-class WXDLLIMPEXP_BASE wxStringBufferLength
+template<typename T>
+class wxStringTypeBufferLengthBase

 {
 public:
 {
 public:

-    wxStringBufferLength(wxString& str, size_t lenWanted = 1024)
+    typedef T CharType;
+
+    wxStringTypeBufferLengthBase(wxString& str, size_t lenWanted = 1024)

         : m_str(str), m_buf(lenWanted), m_len(0), m_lenSet(false)
         { }
 
         : m_str(str), m_buf(lenWanted), m_len(0), m_lenSet(false)
         { }
 

-    ~wxStringBufferLength()
+    ~wxStringTypeBufferLengthBase()

     {
         wxASSERT(m_lenSet);
         m_str.assign(m_buf.data(), m_len);
     }
 
     {
         wxASSERT(m_lenSet);
         m_str.assign(m_buf.data(), m_len);
     }
 

-    operator wxChar*() { return m_buf.data(); }
+    operator CharType*() { return m_buf.data(); }

     void SetLength(size_t length) { m_len = length; m_lenSet = true; }
 
     void SetLength(size_t length) { m_len = length; m_lenSet = true; }
 

-private:
+protected:

     wxString& m_str;
     wxString& m_str;

-#if wxUSE_UNICODE
-    wxWCharBuffer m_buf;
-#else
-    wxCharBuffer  m_buf;
-#endif
+    wxCharTypeBuffer<CharType> m_buf;

     size_t        m_len;
     bool          m_lenSet;
     size_t        m_len;
     bool          m_lenSet;

-
-    DECLARE_NO_COPY_CLASS(wxStringBufferLength)

 };
 
 };
 

-#else // if !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8
+template<typename T>
+class wxStringTypeBuffer : public wxStringTypeBufferBase<T>
+{
+public:
+    wxStringTypeBuffer(wxString& str, size_t lenWanted = 1024)
+        : wxStringTypeBufferBase<T>(str, lenWanted) {}
+    ~wxStringTypeBuffer()
+    {
+        this->m_str.assign(this->m_buf.data());
+    }
+
+    DECLARE_NO_COPY_CLASS(wxStringTypeBuffer)
+};

 
 

-class WXDLLIMPEXP_BASE wxStringBuffer
+template<typename T>
+class wxStringTypeBufferLength : public wxStringTypeBufferLengthBase<T>

 {
 public:
 {
 public:

-    wxStringBuffer(wxString& str, size_t lenWanted = 1024)
-        : m_str(str), m_buf(NULL)
-        { m_buf = m_str.DoGetWriteBuf(lenWanted); }
+    wxStringTypeBufferLength(wxString& str, size_t lenWanted = 1024)
+        : wxStringTypeBufferLengthBase<T>(str, lenWanted) {}

 
 

-    ~wxStringBuffer() { m_str.DoUngetWriteBuf(); }
+    ~wxStringTypeBufferLength()
+    {
+        wxASSERT(this->m_lenSet);
+        this->m_str.assign(this->m_buf.data(), this->m_len);
+    }

 
 

-    operator wxChar*() const { return m_buf; }
+    DECLARE_NO_COPY_CLASS(wxStringTypeBufferLength)
+};

 
 

-private:
-    wxString& m_str;
-    wxChar   *m_buf;
+#if wxUSE_STL_BASED_WXSTRING
+class wxImplStringBuffer : public wxStringTypeBufferBase<wxStringCharType>
+{
+public:
+    wxImplStringBuffer(wxString& str, size_t lenWanted = 1024)
+        : wxStringTypeBufferBase<wxStringCharType>(str, lenWanted) {}
+    ~wxImplStringBuffer()
+        { m_str.m_impl.assign(m_buf.data()); }

 
 

-    DECLARE_NO_COPY_CLASS(wxStringBuffer)
+    DECLARE_NO_COPY_CLASS(wxImplStringBuffer)

 };
 
 };
 

-class WXDLLIMPEXP_BASE wxStringBufferLength
+class wxImplStringBufferLength : public wxStringTypeBufferLengthBase<wxStringCharType>

 {
 public:
 {
 public:

-    wxStringBufferLength(wxString& str, size_t lenWanted = 1024)
-        : m_str(str), m_buf(NULL), m_len(0), m_lenSet(false)
-    {
-        m_buf = m_str.DoGetWriteBuf(lenWanted);
-        wxASSERT(m_buf != NULL);
-    }
+    wxImplStringBufferLength(wxString& str, size_t lenWanted = 1024)
+        : wxStringTypeBufferLengthBase<wxStringCharType>(str, lenWanted) {}

 
 

-    ~wxStringBufferLength()
+    ~wxImplStringBufferLength()

     {
         wxASSERT(m_lenSet);
     {
         wxASSERT(m_lenSet);

-        m_str.DoUngetWriteBuf(m_len);
+        m_str.m_impl.assign(m_buf.data(), m_len);

     }
 
     }
 

-    operator wxChar*() const { return m_buf; }
-    void SetLength(size_t length) { m_len = length; m_lenSet = true; }
-
-private:
-    wxString& m_str;
-    wxChar   *m_buf;
-    size_t    m_len;
-    bool      m_lenSet;
-
-    DECLARE_NO_COPY_CLASS(wxStringBufferLength)
+    DECLARE_NO_COPY_CLASS(wxImplStringBufferLength)

 };
 };

+#endif // wxUSE_STL_BASED_WXSTRING

 
 

+
+#if wxUSE_STL_BASED_WXSTRING || wxUSE_UNICODE_UTF8
+typedef wxStringTypeBuffer<wxChar>        wxStringBuffer;
+typedef wxStringTypeBufferLength<wxChar>  wxStringBufferLength;
+#else // if !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8
+typedef wxImplStringBuffer                wxStringBuffer;
+typedef wxImplStringBufferLength          wxStringBufferLength;

 #endif // !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8
 
 // ---------------------------------------------------------------------------
 #endif // !wxUSE_STL_BASED_WXSTRING && !wxUSE_UNICODE_UTF8
 
 // ---------------------------------------------------------------------------


@@ -2552,6 +2650,13 @@ inline wxCStrData::wxCStrData(char *buf)
 inline wxCStrData::wxCStrData(wchar_t *buf)
     : m_str(new wxString(buf)), m_offset(0), m_owned(true) {}
 
 inline wxCStrData::wxCStrData(wchar_t *buf)
     : m_str(new wxString(buf)), m_offset(0), m_owned(true) {}
 

+inline wxCStrData::wxCStrData(const wxCStrData& data)
+    : m_str(data.m_owned ? new wxString(*data.m_str) : data.m_str),
+      m_offset(data.m_offset),
+      m_owned(data.m_owned)
+{
+}
+

 inline wxCStrData::~wxCStrData()
 {
     if ( m_owned )
 inline wxCStrData::~wxCStrData()
 {
     if ( m_owned )


@@ -2600,6 +2705,11 @@ inline wxString wxCStrData::AsString() const
         return m_str->Mid(m_offset);
 }
 
         return m_str->Mid(m_offset);
 }
 

+inline const wxStringCharType *wxCStrData::AsInternal() const
+{
+    return wxStringOperations::AddToIter(m_str->wx_str(), m_offset);
+}
+

 inline wxUniChar wxCStrData::operator*() const
 {
     if ( m_str->empty() )
 inline wxUniChar wxCStrData::operator*() const
 {
     if ( m_str->empty() )


@@ -2646,4 +2756,12 @@ inline wxWCharBuffer::wxWCharBuffer(const wxCStrData& cstr)
 {
 }
 
 {
 }
 

+#if WXWIN_COMPATIBILITY_2_8
+    // lot of code out there doesn't explicitly include wx/wxchar.h, but uses
+    // CRT wrappers that are now declared in wx/wxcrt.h and wx/wxcrtvararg.h,
+    // so let's include this header now that wxString is defined and it's safe
+    // to do it:
+    #include "wx/wxchar.h"
+#endif
+

 #endif  // _WX_WXSTRING_H_
 #endif  // _WX_WXSTRING_H_