Source cleaning: whitespaces, tabs, -1/wxNOT_FOUND, TRUE/true, FALSE/false.

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

diff --git a/include/wx/strconv.h b/include/wx/strconv.h
index 16be8b1aee7aeb4c7f9600f5e598fb76bc5c85e6..59aefd6a5c3de1d9b489a2967776c36a358b7b41 100644 (file)
--- a/include/wx/strconv.h
+++ b/include/wx/strconv.h
@@ -33,20 +33,24 @@
 #if wxUSE_WCHAR_T
 
 // ----------------------------------------------------------------------------
-// wxMBConv (base class for conversions, using libc conversion itself)
+// wxMBConv (abstract base class for conversions)
 // ----------------------------------------------------------------------------
 
 class WXDLLIMPEXP_BASE wxMBConv
 {
 public:
     // the actual conversion takes place here
-    virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
-    virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const;
+    //
+    // note that n is the size of the output buffer, not the length of input
+    // (the latter is always supposed to be NUL-terminated)
+    virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const = 0;
+    virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const = 0;
 
-    // No longer inline since BC++ complains.
+    // MB <-> WC
     const wxWCharBuffer cMB2WC(const char *psz) const;
     const wxCharBuffer cWC2MB(const wchar_t *psz) 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); }
     const wxCharBuffer cWX2MB(const wchar_t *psz) const { return cWC2MB(psz); }
@@ -63,7 +67,22 @@ public:
     virtual ~wxMBConv();
 };
 
-WXDLLIMPEXP_DATA_BASE(extern wxMBConv) wxConvLibc;
+// ----------------------------------------------------------------------------
+// wxMBConvLibc uses standard mbstowcs() and wcstombs() functions for
+//              conversion (hence it depends on the current locale)
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxMBConvLibc : public wxMBConv
+{
+public:
+    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;
+};
+
+// not very accurately named because it is not necessarily of type wxMBConvLibc
+// (but the name can't eb changed because of backwards compatibility) default
+// conversion
+WXDLLIMPEXP_DATA_BASE(extern wxMBConv&) wxConvLibc;
 
 // ----------------------------------------------------------------------------
 // wxMBConvUTF7 (for conversion using UTF7 encoding)
@@ -72,11 +91,11 @@ WXDLLIMPEXP_DATA_BASE(extern wxMBConv) wxConvLibc;
 class WXDLLIMPEXP_BASE wxMBConvUTF7 : public wxMBConv
 {
 public:
-    virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
-    virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) 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;
 };
 
-WXDLLIMPEXP_DATA_BASE(extern wxMBConvUTF7) wxConvUTF7;
+WXDLLIMPEXP_DATA_BASE(extern wxMBConvUTF7&) wxConvUTF7;
 
 // ----------------------------------------------------------------------------
 // wxMBConvUTF8 (for conversion using UTF8 encoding)
@@ -85,49 +104,122 @@ WXDLLIMPEXP_DATA_BASE(extern wxMBConvUTF7) wxConvUTF7;
 class WXDLLIMPEXP_BASE wxMBConvUTF8 : public wxMBConv
 {
 public:
-    virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
-    virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) 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;
+};
+
+WXDLLIMPEXP_DATA_BASE(extern wxMBConvUTF8&) wxConvUTF8;
+
+// ----------------------------------------------------------------------------
+// wxMBConvUTF16LE (for conversion using UTF16 Little Endian encoding)
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxMBConvUTF16LE : public wxMBConv
+{
+public:
+    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;
+};
+
+// ----------------------------------------------------------------------------
+// wxMBConvUTF16BE (for conversion using UTF16 Big Endian encoding)
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxMBConvUTF16BE : public wxMBConv
+{
+public:
+    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;
+};
+
+// ----------------------------------------------------------------------------
+// wxMBConvUCS4LE (for conversion using UTF32 Little Endian encoding)
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxMBConvUTF32LE : public wxMBConv
+{
+public:
+    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;
 };
 
-WXDLLIMPEXP_DATA_BASE(extern wxMBConvUTF8) wxConvUTF8;
+// ----------------------------------------------------------------------------
+// wxMBConvUCS4BE (for conversion using UTF32 Big Endian encoding)
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxMBConvUTF32BE : public wxMBConv
+{
+public:
+    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;
+};
 
 // ----------------------------------------------------------------------------
 // wxCSConv (for conversion based on loadable char sets)
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxCharacterSet;
+#include "wx/fontenc.h"
 
 class WXDLLIMPEXP_BASE wxCSConv : public wxMBConv
 {
 public:
+    // we can be created either from charset name or from an encoding constant
+    // but we can't have both at once
     wxCSConv(const wxChar *charset);
+    wxCSConv(wxFontEncoding encoding);
+
     wxCSConv(const wxCSConv& conv);
     virtual ~wxCSConv();
 
     wxCSConv& operator=(const wxCSConv& conv);
 
-    void LoadNow();
-
-    virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
-    virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) 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;
 
     void Clear() ;
 
 private:
+    // common part of all ctors
+    void Init();
+
+    // creates m_convReal if necessary
+    void CreateConvIfNeeded() const;
+
+    // do create m_convReal (unconditionally)
+    wxMBConv *DoCreate() const;
+
+    // set the name (may be only called when m_name == NULL), makes copy of
+    // charset string
     void SetName(const wxChar *charset);
 
+
     // note that we can't use wxString here because of compilation
     // dependencies: we're included from wx/string.h
     wxChar *m_name;
-    wxCharacterSet *m_cset;
+    wxFontEncoding m_encoding;
+
+    // use CreateConvIfNeeded() before accessing m_convReal!
+    wxMBConv *m_convReal;
     bool m_deferred;
 };
 
 #define wxConvFile wxConvLocal
-WXDLLIMPEXP_DATA_BASE(extern wxCSConv) wxConvLocal;
-WXDLLIMPEXP_DATA_BASE(extern wxCSConv) wxConvISO8859_1;
+WXDLLIMPEXP_DATA_BASE(extern wxCSConv&) wxConvLocal;
+WXDLLIMPEXP_DATA_BASE(extern wxCSConv&) wxConvISO8859_1;
 WXDLLIMPEXP_DATA_BASE(extern wxMBConv *) wxConvCurrent;
 
+// ----------------------------------------------------------------------------
+// endianness-dependent conversions
+// ----------------------------------------------------------------------------
+
+#ifdef WORDS_BIGENDIAN
+    typedef wxMBConvUTF16BE wxMBConvUTF16;
+    typedef wxMBConvUTF32BE wxMBConvUTF32;
+#else
+    typedef wxMBConvUTF16LE wxMBConvUTF16;
+    typedef wxMBConvUTF32LE wxMBConvUTF32;
+#endif
+
 // ----------------------------------------------------------------------------
 // filename conversion macros
 // ----------------------------------------------------------------------------
@@ -161,7 +253,12 @@ public:
     const char* cWX2MB(const char *psz) const { return psz; }
 };
 
-WXDLLIMPEXP_DATA_BASE(extern wxMBConv) wxConvLibc, wxConvFile, wxConvLocal, wxConvISO8859_1, wxConvUTF8;
+#define wxConvFile wxConvLocal
+
+WXDLLIMPEXP_DATA_BASE(extern wxMBConv) wxConvLibc,
+                                       wxConvLocal,
+                                       wxConvISO8859_1,
+                                       wxConvUTF8;
 WXDLLIMPEXP_DATA_BASE(extern wxMBConv *) wxConvCurrent;
 
 #define wxFNCONV(name) name