X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/05392dc8c6a8b027f36985e6a91a358c7634f187..032e024c1c6ab6a20226604baab9d00558620e72:/include/wx/strconv.h diff --git a/include/wx/strconv.h b/include/wx/strconv.h index a4a18e5e43..0847360a8f 100644 --- a/include/wx/strconv.h +++ b/include/wx/strconv.h @@ -36,10 +36,6 @@ 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 +61,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; @@ -95,20 +93,29 @@ public: // 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 - // 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; + // 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); } @@ -237,7 +244,7 @@ private: // the conversion object we forward to wxMBConv *m_conv; - DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames) + wxDECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames); }; #endif // __UNIX__ @@ -276,7 +283,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 @@ -308,7 +315,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; @@ -510,7 +517,7 @@ 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: @@ -524,13 +531,19 @@ private: wxMBConv *DoCreate() const; // set the name (may be only called when m_name == NULL), makes copy of - // charset string + // the charset string void SetName(const char *charset); + // m_name may be NULL in which case m_encoding should be used + // // note that we can't use wxString here because of compilation // dependencies: we're included from wx/string.h char *m_name; + + // may be wxFONTENCODING_SYSTEM in which case m_name is used + // + // if m_name is NULL, then we should use the default system encoding wxFontEncoding m_encoding; // use CreateConvIfNeeded() before accessing m_convReal! @@ -622,7 +635,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