X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6a02087565a52d5c2a2ef7652d56a6a06bfa304..907ea7d5cc64befac486b269b3ab5b87dfc246d5:/include/wx/strconv.h?ds=inline diff --git a/include/wx/strconv.h b/include/wx/strconv.h index 7f5ee6c2a5..9ec0cdbc61 100644 --- 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: @@ -29,17 +29,11 @@ #include #endif // ! __WXPALMOS5__ -#if wxUSE_WCHAR_T - 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) // ---------------------------------------------------------------------------- @@ -65,19 +59,21 @@ public: // 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); - // if ( dstLen != wxCONV_FAILED ) + // if ( dstLen == wxCONV_FAILED ) // ... 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; @@ -112,6 +108,12 @@ public: 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); } @@ -240,7 +242,7 @@ private: // the conversion object we forward to wxMBConv *m_conv; - DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames) + wxDECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames); }; #endif // __UNIX__ @@ -279,7 +281,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 - class DecoderState : StateMode + class DecoderState : private StateMode { private: // current state: this one is private as we want to enforce the use of @@ -311,7 +313,7 @@ private: // encoder state is simpler as we always receive entire Unicode characters // on input - class EncoderState : StateMode + class EncoderState : private StateMode { private: Mode mode; @@ -513,32 +515,43 @@ public: 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(); - // 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; - // 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); + // 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; - // 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; - bool m_deferred; }; @@ -625,7 +638,7 @@ extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI; #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 @@ -633,33 +646,6 @@ extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI; #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 // ----------------------------------------------------------------------------