use gettimeofday() instead of clock_gettime() as the latter lives in librt which...

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

diff --git a/include/wx/strconv.h b/include/wx/strconv.h
index 73620ad1253f7446a562d618348611b97ffd2639..ba28c8a81ab8792f24578b14d76420418b49155f 100644 (file)
--- a/include/wx/strconv.h
+++ b/include/wx/strconv.h
@@ -1,11 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        strconv.h
 // Purpose:     conversion routines for char sets any Unicode
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        strconv.h
 // Purpose:     conversion routines for char sets any Unicode

-// Author:      Robert Roebling, Ove Kaaven
+// Author:      Ove Kaaven, Robert Roebling, Vadim Zeitlin

 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) 1998 Ove Kaaven, Robert Roebling, Vadim Zeitlin
+// Copyright:   (c) 1998 Ove Kaaven, Robert Roebling
+//              (c) 1998-2006 Vadim Zeitlin

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -31,6 +32,10 @@
 // the error value returned by wxMBConv methods
 #define wxCONV_FAILED ((size_t)-1)
 
 // 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)
 // ----------------------------------------------------------------------------


@@ -54,12 +59,13 @@ public:
     // characters, not bytes) of the converted string including any trailing
     // L'\0' or (possibly multiple) '\0'(s). If the conversion fails or if
     // there is not enough space for everything, including the trailing NUL
     // characters, not bytes) of the converted string including any trailing
     // L'\0' or (possibly multiple) '\0'(s). If the conversion fails or if
     // there is not enough space for everything, including the trailing NUL

-    // character(s), in the output buffer, (size_t)-1 is returned.
+    // 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
     //
     // 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 -1, the entire string, up to and including the
-    // trailing NUL(s), is converted, otherwise exactly srcLen bytes are.
+    // 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:
     //
     //
     // Typical usage:
     //


@@ -70,10 +76,10 @@ public:
     //          conv.ToWChar(wbuf, dstLen, src);
     //
     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
     //          conv.ToWChar(wbuf, dstLen, src);
     //
     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,

-                           const char *src, size_t srcLen = -1) const;
+                           const char *src, size_t srcLen = wxNO_LEN) const;

 
     virtual size_t FromWChar(char *dst, size_t dstLen,
 
     virtual size_t FromWChar(char *dst, size_t dstLen,

-                             const wchar_t *src, size_t srcLen = -1) const;
+                             const wchar_t *src, size_t srcLen = wxNO_LEN) const;

 
 
     // Convenience functions for translating NUL-terminated strings: returns
 
 
     // Convenience functions for translating NUL-terminated strings: returns


@@ -185,7 +191,8 @@ class WXDLLIMPEXP_BASE wxConvBrokenFileNames : public wxMBConv
 public:
     wxConvBrokenFileNames(const wxChar *charset);
     wxConvBrokenFileNames(const wxConvBrokenFileNames& conv)
 public:
     wxConvBrokenFileNames(const wxChar *charset);
     wxConvBrokenFileNames(const wxConvBrokenFileNames& conv)

-        : m_conv(conv.m_conv ? conv.m_conv->Clone() : NULL)
+        : wxMBConv(),
+          m_conv(conv.m_conv ? conv.m_conv->Clone() : NULL)

     {
     }
     virtual ~wxConvBrokenFileNames() { delete m_conv; }
     {
     }
     virtual ~wxConvBrokenFileNames() { delete m_conv; }


@@ -261,7 +268,16 @@ private:
 class WXDLLIMPEXP_BASE wxMBConvUTF16Base : public wxMBConv
 {
 public:
 class WXDLLIMPEXP_BASE wxMBConvUTF16Base : public wxMBConv
 {
 public:

-    virtual size_t GetMBNulLen() const { return 2; }
+    enum { BYTES_PER_CHAR = 2 };
+
+    virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR; }
+
+protected:
+    // return the length of the buffer using srcLen if it's not wxNO_LEN and
+    // computing the length ourselves if it is; also checks that the length is
+    // even if specified as we need an entire number of UTF-16 characters and
+    // returns wxNO_LEN which indicates error if it is odd
+    static size_t GetLength(const char *src, size_t srcLen);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -271,8 +287,10 @@ public:
 class WXDLLIMPEXP_BASE wxMBConvUTF16LE : public wxMBConvUTF16Base
 {
 public:
 class WXDLLIMPEXP_BASE wxMBConvUTF16LE : public wxMBConvUTF16Base
 {
 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;
+    virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
+                           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 wxMBConv *Clone() const { return new wxMBConvUTF16LE; }
 };
 
     virtual wxMBConv *Clone() const { return new wxMBConvUTF16LE; }
 };
 


@@ -283,8 +301,10 @@ public:
 class WXDLLIMPEXP_BASE wxMBConvUTF16BE : public wxMBConvUTF16Base
 {
 public:
 class WXDLLIMPEXP_BASE wxMBConvUTF16BE : public wxMBConvUTF16Base
 {
 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;
+    virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
+                           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 wxMBConv *Clone() const { return new wxMBConvUTF16BE; }
 };
 
     virtual wxMBConv *Clone() const { return new wxMBConvUTF16BE; }
 };
 


@@ -295,7 +315,15 @@ public:
 class WXDLLIMPEXP_BASE wxMBConvUTF32Base : public wxMBConv
 {
 public:
 class WXDLLIMPEXP_BASE wxMBConvUTF32Base : public wxMBConv
 {
 public:

-    virtual size_t GetMBNulLen() const { return 4; }
+    enum { BYTES_PER_CHAR = 4 };
+
+    virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR; }
+
+protected:
+    // this is similar to wxMBConvUTF16Base method with the same name except
+    // that, of course, it verifies that length is divisible by 4 if given and
+    // not by 2
+    static size_t GetLength(const char *src, size_t srcLen);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -305,8 +333,10 @@ public:
 class WXDLLIMPEXP_BASE wxMBConvUTF32LE : public wxMBConvUTF32Base
 {
 public:
 class WXDLLIMPEXP_BASE wxMBConvUTF32LE : public wxMBConvUTF32Base
 {
 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;
+    virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
+                           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 wxMBConv *Clone() const { return new wxMBConvUTF32LE; }
 };
 
     virtual wxMBConv *Clone() const { return new wxMBConvUTF32LE; }
 };
 


@@ -317,8 +347,10 @@ public:
 class WXDLLIMPEXP_BASE wxMBConvUTF32BE : public wxMBConvUTF32Base
 {
 public:
 class WXDLLIMPEXP_BASE wxMBConvUTF32BE : public wxMBConvUTF32Base
 {
 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;
+    virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
+                           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 wxMBConv *Clone() const { return new wxMBConvUTF32BE; }
 };
 
     virtual wxMBConv *Clone() const { return new wxMBConvUTF32BE; }
 };
 


@@ -341,13 +373,21 @@ public:
 
     wxCSConv& operator=(const wxCSConv& conv);
 
 
     wxCSConv& operator=(const wxCSConv& conv);
 

+    virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
+                           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;
     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;

+

     virtual wxMBConv *Clone() const { return new wxCSConv(*this); }
 
     void Clear();
 
     virtual wxMBConv *Clone() const { return new wxCSConv(*this); }
 
     void Clear();
 

+    // return true if the conversion could be initilized successfully
+    bool IsOk() const;
+

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


@@ -403,9 +443,14 @@ extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvFileName;
 // default in a couple of places inside wx (initially same as wxConvLibc)
 extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent;
 
 // default in a couple of places inside wx (initially same as wxConvLibc)
 extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent;
 

-// ???
+// the conversion corresponding to the current locale

 extern WXDLLIMPEXP_DATA_BASE(wxCSConv&) wxConvLocal;
 
 extern WXDLLIMPEXP_DATA_BASE(wxCSConv&) wxConvLocal;
 

+// the conversion corresponding to the encoding of the standard UI elements
+//
+// by default this is the same as wxConvLocal but may be changed if the program
+// needs to use a fixed encoding
+extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI;

 
 // ----------------------------------------------------------------------------
 // endianness-dependent conversions
 
 // ----------------------------------------------------------------------------
 // endianness-dependent conversions


@@ -423,8 +468,8 @@ extern WXDLLIMPEXP_DATA_BASE(wxCSConv&) wxConvLocal;
 // filename conversion macros
 // ----------------------------------------------------------------------------
 
 // filename conversion macros
 // ----------------------------------------------------------------------------
 

-// filenames are multibyte on Unix and probably widechar on Windows?
-#if defined(__UNIX__) || defined(__BORLANDC__) || defined(__WXMAC__ )
+// filenames are multibyte on Unix and widechar on Windows
+#if defined(__UNIX__) || defined(__WXMAC__)

     #define wxMBFILES 1
 #else
     #define wxMBFILES 0
     #define wxMBFILES 1
 #else
     #define wxMBFILES 0