X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/483b0434bfa1b10d2522ac0affe8758e629c21ee..dc484d491b15355285a89da275c58c2ef247d1f4:/include/wx/strconv.h diff --git a/include/wx/strconv.h b/include/wx/strconv.h index 61738e0cff..c56ae9af2f 100644 --- a/include/wx/strconv.h +++ b/include/wx/strconv.h @@ -1,16 +1,17 @@ /////////////////////////////////////////////////////////////////////////////// // 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$ -// Copyright: (c) 1998 Ove Kaaven, Robert Roebling, Vadim Zeitlin +// Copyright: (c) 1998 Ove Kaaven, Robert Roebling +// (c) 1998-2006 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#ifndef _WX_WXSTRCONVH__ -#define _WX_WXSTRCONVH__ +#ifndef _WX_STRCONV_H_ +#define _WX_STRCONV_H_ #include "wx/defs.h" #include "wx/wxchar.h" @@ -31,10 +32,23 @@ // 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) // ---------------------------------------------------------------------------- +// When deriving a new class from wxMBConv you must reimplement ToWChar() and +// FromWChar() methods which are not pure virtual only for historical reasons, +// don't let the fact that the existing classes implement MB2WC/WC2MB() instead +// confuse you. +// +// You also have to implement Clone() to allow copying the conversions +// polymorphically. +// +// And you might need to override GetMBNulLen() as well. class WXDLLIMPEXP_BASE wxMBConv { public: @@ -45,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 - // 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 - // 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: // @@ -61,10 +76,10 @@ public: // 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, - 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 @@ -137,10 +152,13 @@ public: // Note that outLen is the length of the output buffer, not the length of // the input (which is always supposed to be terminated by one or more // NULs, as appropriate for the encoding)! - virtual size_t MB2WC(wchar_t *out, const char *in, size_t outLen) const = 0; - virtual size_t WC2MB(char *out, const wchar_t *in, size_t outLen) const = 0; + virtual size_t MB2WC(wchar_t *out, const char *in, size_t outLen) const; + virtual size_t WC2MB(char *out, const wchar_t *in, size_t outLen) const; + // make a heap-allocated copy of this object + virtual wxMBConv *Clone() const = 0; + // virtual dtor for any base class virtual ~wxMBConv(); }; @@ -155,6 +173,8 @@ 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; + + virtual wxMBConv *Clone() const { return new wxMBConvLibc; } }; #ifdef __UNIX__ @@ -170,6 +190,11 @@ class WXDLLIMPEXP_BASE wxConvBrokenFileNames : public wxMBConv { public: wxConvBrokenFileNames(const wxChar *charset); + wxConvBrokenFileNames(const wxConvBrokenFileNames& conv) + : wxMBConv(), + m_conv(conv.m_conv ? conv.m_conv->Clone() : NULL) + { + } virtual ~wxConvBrokenFileNames() { delete m_conv; } virtual size_t MB2WC(wchar_t *out, const char *in, size_t outLen) const @@ -188,9 +213,13 @@ public: return m_conv->GetMBNulLen(); } + virtual wxMBConv *Clone() const { return new wxConvBrokenFileNames(*this); } + private: // the conversion object we forward to wxMBConv *m_conv; + + DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames) }; #endif // __UNIX__ @@ -204,6 +233,8 @@ class WXDLLIMPEXP_BASE wxMBConvUTF7 : 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; + + virtual wxMBConv *Clone() const { return new wxMBConvUTF7; } }; // ---------------------------------------------------------------------------- @@ -213,7 +244,8 @@ public: class WXDLLIMPEXP_BASE wxMBConvUTF8 : public wxMBConv { public: - enum { + enum + { MAP_INVALID_UTF8_NOT = 0, MAP_INVALID_UTF8_TO_PUA = 1, MAP_INVALID_UTF8_TO_OCTAL = 2 @@ -223,6 +255,8 @@ 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 wxMBConv *Clone() const { return new wxMBConvUTF8(m_options); } + private: int m_options; }; @@ -234,7 +268,16 @@ private: 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); }; // ---------------------------------------------------------------------------- @@ -244,8 +287,11 @@ 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; } }; // ---------------------------------------------------------------------------- @@ -255,8 +301,11 @@ 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; } }; // ---------------------------------------------------------------------------- @@ -266,7 +315,15 @@ 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); }; // ---------------------------------------------------------------------------- @@ -276,8 +333,11 @@ 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; } }; // ---------------------------------------------------------------------------- @@ -287,8 +347,11 @@ 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; } }; // ---------------------------------------------------------------------------- @@ -313,8 +376,9 @@ 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 GetMBNulLen() const; + virtual wxMBConv *Clone() const { return new wxCSConv(*this); } - void Clear() ; + void Clear(); private: // common part of all ctors @@ -371,9 +435,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; -// ??? +// the conversion corresponding to the current locale 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 @@ -450,6 +519,5 @@ extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent; #define wxConvertMB2WX(s) (s) #endif // Unicode/ANSI -#endif - // _WX_WXSTRCONVH__ +#endif // _WX_STRCONV_H_