synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/strconv.h b/include/wx/strconv.h
index 1aa5f97550b5971d46cb004aaaf4a5bd8cd95437..d7bf5841372c3f0f2979314336b5082c973d2c62 100644 (file)
--- a/include/wx/strconv.h
+++ b/include/wx/strconv.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        strconv.h
+// Name:        wx/strconv.h

 // Purpose:     conversion routines for char sets any Unicode
 // Author:      Ove Kaaven, Robert Roebling, Vadim Zeitlin
 // Modified by:
 // Purpose:     conversion routines for char sets any Unicode
 // Author:      Ove Kaaven, Robert Roebling, Vadim Zeitlin
 // Modified by:


@@ -25,21 +25,13 @@
 #  undef __BSEXCPT__
 #endif
 
 #  undef __BSEXCPT__
 #endif
 

-#ifndef __WXPALMOS5__

 #include <stdlib.h>
 #include <stdlib.h>

-#endif // ! __WXPALMOS5__
-
-#if wxUSE_WCHAR_T

 
 class WXDLLIMPEXP_FWD_BASE wxString;
 
 // the error value returned by wxMBConv methods
 #define wxCONV_FAILED ((size_t)-1)
 
 
 class WXDLLIMPEXP_FWD_BASE wxString;
 
 // the error value returned by wxMBConv methods
 #define wxCONV_FAILED ((size_t)-1)
 

-// the default value for some length parameters meaning that the string is
-// NUL-terminated
-#define wxNO_LEN ((size_t)-1)
-

 // ----------------------------------------------------------------------------
 // wxMBConv (abstract base class for conversions)
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxMBConv (abstract base class for conversions)
 // ----------------------------------------------------------------------------


@@ -65,19 +57,21 @@ public:
     // there is not enough space for everything, including the trailing NUL
     // character(s), in the output buffer, wxCONV_FAILED is returned.
     //
     // there is not enough space for everything, including the trailing NUL
     // character(s), in the output buffer, wxCONV_FAILED is returned.
     //

-    // In the special case when dstLen is 0 (outputBuf may be NULL then) the
-    // return value is the length of the needed buffer but nothing happens
-    // otherwise. If srcLen is wxNO_LEN, the entire string, up to and
+    // In the special case when dst is NULL (the value of dstLen is ignored
+    // then) the return value is the length of the needed buffer but nothing
+    // happens otherwise. If srcLen is wxNO_LEN, the entire string, up to and

     // including the trailing NUL(s), is converted, otherwise exactly srcLen
     // bytes are.
     //
     // Typical usage:
     //
     //          size_t dstLen = conv.ToWChar(NULL, 0, src);
     // including the trailing NUL(s), is converted, otherwise exactly srcLen
     // bytes are.
     //
     // Typical usage:
     //
     //          size_t dstLen = conv.ToWChar(NULL, 0, src);

-    //          if ( dstLen != wxCONV_FAILED )
+    //          if ( dstLen == wxCONV_FAILED )

     //              ... handle error ...
     //          wchar_t *wbuf = new wchar_t[dstLen];
     //          conv.ToWChar(wbuf, dstLen, src);
     //              ... handle error ...
     //          wchar_t *wbuf = new wchar_t[dstLen];
     //          conv.ToWChar(wbuf, dstLen, src);

+    //          ... work with wbuf ...
+    //          delete [] wbuf;

     //
     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
                            const char *src, size_t srcLen = wxNO_LEN) const;
     //
     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
                            const char *src, size_t srcLen = wxNO_LEN) const;


@@ -95,20 +89,29 @@ public:
     // Convenience functions for converting strings which may contain embedded
     // NULs and don't have to be NUL-terminated.
     //
     // Convenience functions for converting strings which may contain embedded
     // NULs and don't have to be NUL-terminated.
     //

-    // inLen is the length of the buffer including trailing NUL if any: if the
-    // last 4 bytes of the buffer are all NULs, these functions are more
-    // efficient as they avoid copying the string, but otherwise a copy is made
-    // internally which could be quite bad for (very) long strings.
+    // inLen is the length of the buffer including trailing NUL if any or
+    // wxNO_LEN if the input is NUL-terminated.

     //
     // outLen receives, if not NULL, the length of the converted string or 0 if
     // the conversion failed (returning 0 and not -1 in this case makes it
     // difficult to distinguish between failed conversion and empty input but
     //
     // outLen receives, if not NULL, the length of the converted string or 0 if
     // the conversion failed (returning 0 and not -1 in this case makes it
     // difficult to distinguish between failed conversion and empty input but

-    // this is done for backwards compatibility)
+    // this is done for backwards compatibility). Notice that the rules for
+    // whether outLen accounts or not for the last NUL are the same as for
+    // To/FromWChar() above: if inLen is specified, outLen is exactly the
+    // number of characters converted, whether the last one of them was NUL or
+    // not. But if inLen == wxNO_LEN then outLen doesn't account for the last
+    // NUL even though it is present.

     const wxWCharBuffer
         cMB2WC(const char *in, size_t inLen, size_t *outLen) const;
     const wxCharBuffer
         cWC2MB(const wchar_t *in, size_t inLen, size_t *outLen) const;
 
     const wxWCharBuffer
         cMB2WC(const char *in, size_t inLen, size_t *outLen) const;
     const wxCharBuffer
         cWC2MB(const wchar_t *in, size_t inLen, size_t *outLen) const;
 

+    // And yet more convenience functions for converting the entire buffers:
+    // these are the simplest and least error-prone as you never need to bother
+    // with lengths/sizes directly.
+    const wxWCharBuffer cMB2WC(const wxScopedCharBuffer& in) const;
+    const wxCharBuffer cWC2MB(const wxScopedWCharBuffer& in) const;
+

     // convenience functions for converting MB or WC to/from wxWin default
 #if wxUSE_UNICODE
     const wxWCharBuffer cMB2WX(const char *psz) const { return cMB2WC(psz); }
     // convenience functions for converting MB or WC to/from wxWin default
 #if wxUSE_UNICODE
     const wxWCharBuffer cMB2WX(const char *psz) const { return cMB2WC(psz); }


@@ -237,7 +240,7 @@ private:
     // the conversion object we forward to
     wxMBConv *m_conv;
 
     // the conversion object we forward to
     wxMBConv *m_conv;
 

-    DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames)
+    wxDECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames);

 };
 
 #endif // __UNIX__
 };
 
 #endif // __UNIX__


@@ -276,7 +279,7 @@ private:
     // the current decoder state: this is only used by ToWChar() if srcLen
     // parameter is not wxNO_LEN, when working on the entire NUL-terminated
     // strings we neither update nor use the state
     // the current decoder state: this is only used by ToWChar() if srcLen
     // parameter is not wxNO_LEN, when working on the entire NUL-terminated
     // strings we neither update nor use the state

-    class DecoderState : StateMode
+    class DecoderState : private StateMode

     {
     private:
         // current state: this one is private as we want to enforce the use of
     {
     private:
         // current state: this one is private as we want to enforce the use of


@@ -308,7 +311,7 @@ private:
 
     // encoder state is simpler as we always receive entire Unicode characters
     // on input
 
     // encoder state is simpler as we always receive entire Unicode characters
     // on input

-    class EncoderState : StateMode
+    class EncoderState : private StateMode

     {
     private:
         Mode mode;
     {
     private:
         Mode mode;


@@ -500,8 +503,6 @@ public:
                            const char *src, size_t srcLen = wxNO_LEN) const;
     virtual size_t FromWChar(char *dst, size_t dstLen,
                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;
                            const char *src, size_t srcLen = wxNO_LEN) const;
     virtual size_t FromWChar(char *dst, size_t dstLen,
                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;

-    virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
-    virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;

     virtual size_t GetMBNulLen() const;
 
 #if wxUSE_UNICODE_UTF8
     virtual size_t GetMBNulLen() const;
 
 #if wxUSE_UNICODE_UTF8


@@ -512,32 +513,43 @@ public:
 
     void Clear();
 
 
     void Clear();
 

-    // return true if the conversion could be initilized successfully
+    // return true if the conversion could be initialized successfully

     bool IsOk() const;
 
 private:
     // common part of all ctors
     void Init();
 
     bool IsOk() const;
 
 private:
     // common part of all ctors
     void Init();
 

-    // creates m_convReal if necessary
-    void CreateConvIfNeeded() const;
-
-    // do create m_convReal (unconditionally)
+    // Creates the conversion to use, called from all ctors to initialize
+    // m_convReal.

     wxMBConv *DoCreate() const;
 
     wxMBConv *DoCreate() const;
 

-    // set the name (may be only called when m_name == NULL), makes copy of
-    // charset string
+    // Set the name (may be only called when m_name == NULL), makes copy of
+    // the charset string.

     void SetName(const char *charset);
 
     void SetName(const char *charset);
 

+    // Set m_encoding field respecting the rules below, i.e. making sure it has
+    // a valid value if m_name == NULL (thus this should be always called after
+    // SetName()).
+    //
+    // Input encoding may be valid or not.
+    void SetEncoding(wxFontEncoding encoding);
+

 
 

-    // note that we can't use wxString here because of compilation
-    // dependencies: we're included from wx/string.h
+    // The encoding we use is specified by the two fields below:
+    //
+    //  1. If m_name != NULL, m_encoding corresponds to it if it's one of
+    //     encodings we know about (i.e. member of wxFontEncoding) or is
+    //     wxFONTENCODING_SYSTEM otherwise.
+    //
+    //  2. If m_name == NULL, m_encoding is always valid, i.e. not one of
+    //     wxFONTENCODING_{SYSTEM,DEFAULT,MAX}.

     char *m_name;
     wxFontEncoding m_encoding;
 
     char *m_name;
     wxFontEncoding m_encoding;
 

-    // use CreateConvIfNeeded() before accessing m_convReal!
+    // The conversion object for our encoding or NULL if we failed to create it
+    // in which case we fall back to hard-coded ISO8859-1 conversion.

     wxMBConv *m_convReal;
     wxMBConv *m_convReal;

-    bool m_deferred;

 };
 
 
 };
 
 


@@ -624,7 +636,7 @@ extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI;
     #define wxFNCONV(name) wxConvFileName->cWX2MB(name)
     #define wxFNSTRINGCAST wxMBSTRINGCAST
 #else
     #define wxFNCONV(name) wxConvFileName->cWX2MB(name)
     #define wxFNSTRINGCAST wxMBSTRINGCAST
 #else

-#if defined( __WXOSX__ ) && wxMBFILES
+#if defined( __WXOSX_OR_COCOA__ ) && wxMBFILES

     #define wxFNCONV(name) wxConvFileName->cWC2MB( wxConvLocal.cWX2WC(name) )
 #else
     #define wxFNCONV(name) name
     #define wxFNCONV(name) wxConvFileName->cWC2MB( wxConvLocal.cWX2WC(name) )
 #else
     #define wxFNCONV(name) name


@@ -632,33 +644,6 @@ extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI;
     #define wxFNSTRINGCAST WXSTRINGCAST
 #endif
 
     #define wxFNSTRINGCAST WXSTRINGCAST
 #endif
 

-#else // !wxUSE_WCHAR_T
-
-// ----------------------------------------------------------------------------
-// stand-ins in absence of wchar_t
-// ----------------------------------------------------------------------------
-
-class WXDLLIMPEXP_BASE wxMBConv
-{
-public:
-    const char* cMB2WX(const char *psz) const { return psz; }
-    const char* cWX2MB(const char *psz) const { return psz; }
-};
-
-#define wxConvFile wxConvLocal
-
-extern WXDLLIMPEXP_DATA_BASE(wxMBConv) wxConvLibc,
-                                       wxConvLocal,
-                                       wxConvISO8859_1,
-                                       wxConvUTF8;
-extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent;
-
-#define wxFNCONV(name) name
-#define wxFNSTRINGCAST WXSTRINGCAST
-
-#endif
-  // wxUSE_WCHAR_T
-

 // ----------------------------------------------------------------------------
 // macros for the most common conversions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // macros for the most common conversions
 // ----------------------------------------------------------------------------