1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: conversion routines for char sets any Unicode
4 // Author: Ove Kaaven, Robert Roebling, Vadim Zeitlin
8 // Copyright: (c) 1998 Ove Kaaven, Robert Roebling
9 // (c) 1998-2006 Vadim Zeitlin
10 // Licence: wxWindows licence
11 ///////////////////////////////////////////////////////////////////////////////
13 #ifndef _WX_STRCONV_H_
14 #define _WX_STRCONV_H_
17 #include "wx/chartype.h"
18 #include "wx/buffer.h"
20 #ifdef __DIGITALMARS__
24 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
32 class WXDLLIMPEXP_BASE wxString
;
34 // the error value returned by wxMBConv methods
35 #define wxCONV_FAILED ((size_t)-1)
37 // the default value for some length parameters meaning that the string is
39 #define wxNO_LEN ((size_t)-1)
41 // ----------------------------------------------------------------------------
42 // wxMBConv (abstract base class for conversions)
43 // ----------------------------------------------------------------------------
45 // When deriving a new class from wxMBConv you must reimplement ToWChar() and
46 // FromWChar() methods which are not pure virtual only for historical reasons,
47 // don't let the fact that the existing classes implement MB2WC/WC2MB() instead
50 // You also have to implement Clone() to allow copying the conversions
53 // And you might need to override GetMBNulLen() as well.
54 class WXDLLIMPEXP_BASE wxMBConv
57 // The functions doing actual conversion from/to narrow to/from wide
60 // On success, the return value is the length (i.e. the number of
61 // characters, not bytes) of the converted string including any trailing
62 // L'\0' or (possibly multiple) '\0'(s). If the conversion fails or if
63 // there is not enough space for everything, including the trailing NUL
64 // character(s), in the output buffer, wxCONV_FAILED is returned.
66 // In the special case when dstLen is 0 (outputBuf may be NULL then) the
67 // return value is the length of the needed buffer but nothing happens
68 // otherwise. If srcLen is wxNO_LEN, the entire string, up to and
69 // including the trailing NUL(s), is converted, otherwise exactly srcLen
74 // size_t dstLen = conv.ToWChar(NULL, 0, src);
75 // if ( dstLen != wxCONV_FAILED )
76 // ... handle error ...
77 // wchar_t *wbuf = new wchar_t[dstLen];
78 // conv.ToWChar(wbuf, dstLen, src);
80 virtual size_t ToWChar(wchar_t *dst
, size_t dstLen
,
81 const char *src
, size_t srcLen
= wxNO_LEN
) const;
83 virtual size_t FromWChar(char *dst
, size_t dstLen
,
84 const wchar_t *src
, size_t srcLen
= wxNO_LEN
) const;
87 // Convenience functions for translating NUL-terminated strings: returns
88 // the buffer containing the converted string or NULL pointer if the
90 const wxWCharBuffer
cMB2WC(const char *in
) const;
91 const wxCharBuffer
cWC2MB(const wchar_t *in
) const;
93 // Convenience functions for converting strings which may contain embedded
94 // NULs and don't have to be NUL-terminated.
96 // inLen is the length of the buffer including trailing NUL if any: if the
97 // last 4 bytes of the buffer are all NULs, these functions are more
98 // efficient as they avoid copying the string, but otherwise a copy is made
99 // internally which could be quite bad for (very) long strings.
101 // outLen receives, if not NULL, the length of the converted string or 0 if
102 // the conversion failed (returning 0 and not -1 in this case makes it
103 // difficult to distinguish between failed conversion and empty input but
104 // this is done for backwards compatibility)
106 cMB2WC(const char *in
, size_t inLen
, size_t *outLen
) const;
108 cWC2MB(const wchar_t *in
, size_t inLen
, size_t *outLen
) const;
110 // convenience functions for converting MB or WC to/from wxWin default
112 const wxWCharBuffer
cMB2WX(const char *psz
) const { return cMB2WC(psz
); }
113 const wxCharBuffer
cWX2MB(const wchar_t *psz
) const { return cWC2MB(psz
); }
114 const wchar_t* cWC2WX(const wchar_t *psz
) const { return psz
; }
115 const wchar_t* cWX2WC(const wchar_t *psz
) const { return psz
; }
117 const char* cMB2WX(const char *psz
) const { return psz
; }
118 const char* cWX2MB(const char *psz
) const { return psz
; }
119 const wxCharBuffer
cWC2WX(const wchar_t *psz
) const { return cWC2MB(psz
); }
120 const wxWCharBuffer
cWX2WC(const char *psz
) const { return cMB2WC(psz
); }
121 #endif // Unicode/ANSI
123 // this function is used in the implementation of cMB2WC() to distinguish
124 // between the following cases:
126 // a) var width encoding with strings terminated by a single NUL
127 // (usual multibyte encodings): return 1 in this case
128 // b) fixed width encoding with 2 bytes/char and so terminated by
129 // 2 NULs (UTF-16/UCS-2 and variants): return 2 in this case
130 // c) fixed width encoding with 4 bytes/char and so terminated by
131 // 4 NULs (UTF-32/UCS-4 and variants): return 4 in this case
133 // anything else is not supported currently and -1 should be returned
134 virtual size_t GetMBNulLen() const { return 1; }
136 // return the maximal value currently returned by GetMBNulLen() for any
138 static size_t GetMaxMBNulLen() { return 4 /* for UTF-32 */; }
140 #if wxUSE_UNICODE_UTF8
141 // return true if the converter's charset is UTF-8, i.e. char* strings
142 // decoded using this object can be directly copied to wxString's internal
143 // storage without converting to WC and than back to UTF-8 MB string
144 virtual bool IsUTF8() const { return false; }
147 // The old conversion functions. The existing classes currently mostly
148 // implement these ones but we're in transition to using To/FromWChar()
149 // instead and any new classes should implement just the new functions.
150 // For now, however, we provide default implementation of To/FromWChar() in
151 // this base class in terms of MB2WC/WC2MB() to avoid having to rewrite all
152 // the conversions at once.
154 // On success, the return value is the length (i.e. the number of
155 // characters, not bytes) not counting the trailing NUL(s) of the converted
156 // string. On failure, (size_t)-1 is returned. In the special case when
157 // outputBuf is NULL the return value is the same one but nothing is
158 // written to the buffer.
160 // Note that outLen is the length of the output buffer, not the length of
161 // the input (which is always supposed to be terminated by one or more
162 // NULs, as appropriate for the encoding)!
163 virtual size_t MB2WC(wchar_t *out
, const char *in
, size_t outLen
) const;
164 virtual size_t WC2MB(char *out
, const wchar_t *in
, size_t outLen
) const;
167 // make a heap-allocated copy of this object
168 virtual wxMBConv
*Clone() const = 0;
170 // virtual dtor for any base class
174 // ----------------------------------------------------------------------------
175 // wxMBConvLibc uses standard mbstowcs() and wcstombs() functions for
176 // conversion (hence it depends on the current locale)
177 // ----------------------------------------------------------------------------
179 class WXDLLIMPEXP_BASE wxMBConvLibc
: public wxMBConv
182 virtual size_t MB2WC(wchar_t *outputBuf
, const char *psz
, size_t outputSize
) const;
183 virtual size_t WC2MB(char *outputBuf
, const wchar_t *psz
, size_t outputSize
) const;
185 virtual wxMBConv
*Clone() const { return new wxMBConvLibc
; }
187 #if wxUSE_UNICODE_UTF8
188 virtual bool IsUTF8() const { return wxLocaleIsUtf8
; }
194 // ----------------------------------------------------------------------------
195 // wxConvBrokenFileNames is made for Unix in Unicode mode when
196 // files are accidentally written in an encoding which is not
197 // the system encoding. Typically, the system encoding will be
198 // UTF8 but there might be files stored in ISO8859-1 on disk.
199 // ----------------------------------------------------------------------------
201 class WXDLLIMPEXP_BASE wxConvBrokenFileNames
: public wxMBConv
204 wxConvBrokenFileNames(const wxString
& charset
);
205 wxConvBrokenFileNames(const wxConvBrokenFileNames
& conv
)
207 m_conv(conv
.m_conv
? conv
.m_conv
->Clone() : NULL
)
210 virtual ~wxConvBrokenFileNames() { delete m_conv
; }
212 virtual size_t MB2WC(wchar_t *out
, const char *in
, size_t outLen
) const
214 return m_conv
->MB2WC(out
, in
, outLen
);
217 virtual size_t WC2MB(char *out
, const wchar_t *in
, size_t outLen
) const
219 return m_conv
->WC2MB(out
, in
, outLen
);
222 virtual size_t GetMBNulLen() const
224 // cast needed to call a private function
225 return m_conv
->GetMBNulLen();
228 #if wxUSE_UNICODE_UTF8
229 virtual bool IsUTF8() const { return m_conv
->IsUTF8(); }
232 virtual wxMBConv
*Clone() const { return new wxConvBrokenFileNames(*this); }
235 // the conversion object we forward to
238 DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames
)
243 // ----------------------------------------------------------------------------
244 // wxMBConvUTF7 (for conversion using UTF7 encoding)
245 // ----------------------------------------------------------------------------
247 class WXDLLIMPEXP_BASE wxMBConvUTF7
: public wxMBConv
250 virtual size_t MB2WC(wchar_t *outputBuf
, const char *psz
, size_t outputSize
) const;
251 virtual size_t WC2MB(char *outputBuf
, const wchar_t *psz
, size_t outputSize
) const;
253 virtual wxMBConv
*Clone() const { return new wxMBConvUTF7
; }
256 // ----------------------------------------------------------------------------
257 // wxMBConvUTF8 (for conversion using UTF8 encoding)
258 // ----------------------------------------------------------------------------
260 class WXDLLIMPEXP_BASE wxMBConvUTF8
: public wxMBConv
263 // FIXME-UTF8: split this class into multiple classes, one strict and
264 // other lossy (PUA, OCTAL mappings)
267 MAP_INVALID_UTF8_NOT
= 0,
268 MAP_INVALID_UTF8_TO_PUA
= 1,
269 MAP_INVALID_UTF8_TO_OCTAL
= 2
272 wxMBConvUTF8(int options
= MAP_INVALID_UTF8_NOT
) : m_options(options
) { }
273 virtual size_t MB2WC(wchar_t *outputBuf
, const char *psz
, size_t outputSize
) const;
274 virtual size_t WC2MB(char *outputBuf
, const wchar_t *psz
, size_t outputSize
) const;
276 virtual wxMBConv
*Clone() const { return new wxMBConvUTF8(m_options
); }
278 #if wxUSE_UNICODE_UTF8
279 // NB: other mapping modes are not, strictly speaking, UTF-8, so we can't
280 // take the shortcut in that case
281 virtual bool IsUTF8() const { return m_options
== MAP_INVALID_UTF8_NOT
; }
288 // ----------------------------------------------------------------------------
289 // wxMBConvUTF16Base: for both LE and BE variants
290 // ----------------------------------------------------------------------------
292 class WXDLLIMPEXP_BASE wxMBConvUTF16Base
: public wxMBConv
295 enum { BYTES_PER_CHAR
= 2 };
297 virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR
; }
300 // return the length of the buffer using srcLen if it's not wxNO_LEN and
301 // computing the length ourselves if it is; also checks that the length is
302 // even if specified as we need an entire number of UTF-16 characters and
303 // returns wxNO_LEN which indicates error if it is odd
304 static size_t GetLength(const char *src
, size_t srcLen
);
307 // ----------------------------------------------------------------------------
308 // wxMBConvUTF16LE (for conversion using UTF16 Little Endian encoding)
309 // ----------------------------------------------------------------------------
311 class WXDLLIMPEXP_BASE wxMBConvUTF16LE
: public wxMBConvUTF16Base
314 virtual size_t ToWChar(wchar_t *dst
, size_t dstLen
,
315 const char *src
, size_t srcLen
= wxNO_LEN
) const;
316 virtual size_t FromWChar(char *dst
, size_t dstLen
,
317 const wchar_t *src
, size_t srcLen
= wxNO_LEN
) const;
318 virtual wxMBConv
*Clone() const { return new wxMBConvUTF16LE
; }
321 // ----------------------------------------------------------------------------
322 // wxMBConvUTF16BE (for conversion using UTF16 Big Endian encoding)
323 // ----------------------------------------------------------------------------
325 class WXDLLIMPEXP_BASE wxMBConvUTF16BE
: public wxMBConvUTF16Base
328 virtual size_t ToWChar(wchar_t *dst
, size_t dstLen
,
329 const char *src
, size_t srcLen
= wxNO_LEN
) const;
330 virtual size_t FromWChar(char *dst
, size_t dstLen
,
331 const wchar_t *src
, size_t srcLen
= wxNO_LEN
) const;
332 virtual wxMBConv
*Clone() const { return new wxMBConvUTF16BE
; }
335 // ----------------------------------------------------------------------------
336 // wxMBConvUTF32Base: base class for both LE and BE variants
337 // ----------------------------------------------------------------------------
339 class WXDLLIMPEXP_BASE wxMBConvUTF32Base
: public wxMBConv
342 enum { BYTES_PER_CHAR
= 4 };
344 virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR
; }
347 // this is similar to wxMBConvUTF16Base method with the same name except
348 // that, of course, it verifies that length is divisible by 4 if given and
350 static size_t GetLength(const char *src
, size_t srcLen
);
353 // ----------------------------------------------------------------------------
354 // wxMBConvUTF32LE (for conversion using UTF32 Little Endian encoding)
355 // ----------------------------------------------------------------------------
357 class WXDLLIMPEXP_BASE wxMBConvUTF32LE
: public wxMBConvUTF32Base
360 virtual size_t ToWChar(wchar_t *dst
, size_t dstLen
,
361 const char *src
, size_t srcLen
= wxNO_LEN
) const;
362 virtual size_t FromWChar(char *dst
, size_t dstLen
,
363 const wchar_t *src
, size_t srcLen
= wxNO_LEN
) const;
364 virtual wxMBConv
*Clone() const { return new wxMBConvUTF32LE
; }
367 // ----------------------------------------------------------------------------
368 // wxMBConvUTF32BE (for conversion using UTF32 Big Endian encoding)
369 // ----------------------------------------------------------------------------
371 class WXDLLIMPEXP_BASE wxMBConvUTF32BE
: public wxMBConvUTF32Base
374 virtual size_t ToWChar(wchar_t *dst
, size_t dstLen
,
375 const char *src
, size_t srcLen
= wxNO_LEN
) const;
376 virtual size_t FromWChar(char *dst
, size_t dstLen
,
377 const wchar_t *src
, size_t srcLen
= wxNO_LEN
) const;
378 virtual wxMBConv
*Clone() const { return new wxMBConvUTF32BE
; }
381 // ----------------------------------------------------------------------------
382 // wxCSConv (for conversion based on loadable char sets)
383 // ----------------------------------------------------------------------------
385 #include "wx/fontenc.h"
387 class WXDLLIMPEXP_BASE wxCSConv
: public wxMBConv
390 // we can be created either from charset name or from an encoding constant
391 // but we can't have both at once
392 wxCSConv(const wxString
& charset
);
393 wxCSConv(wxFontEncoding encoding
);
395 wxCSConv(const wxCSConv
& conv
);
398 wxCSConv
& operator=(const wxCSConv
& conv
);
400 virtual size_t ToWChar(wchar_t *dst
, size_t dstLen
,
401 const char *src
, size_t srcLen
= wxNO_LEN
) const;
402 virtual size_t FromWChar(char *dst
, size_t dstLen
,
403 const wchar_t *src
, size_t srcLen
= wxNO_LEN
) const;
404 virtual size_t MB2WC(wchar_t *outputBuf
, const char *psz
, size_t outputSize
) const;
405 virtual size_t WC2MB(char *outputBuf
, const wchar_t *psz
, size_t outputSize
) const;
406 virtual size_t GetMBNulLen() const;
408 #if wxUSE_UNICODE_UTF8
409 virtual bool IsUTF8() const;
412 virtual wxMBConv
*Clone() const { return new wxCSConv(*this); }
416 // return true if the conversion could be initilized successfully
420 // common part of all ctors
423 // creates m_convReal if necessary
424 void CreateConvIfNeeded() const;
426 // do create m_convReal (unconditionally)
427 wxMBConv
*DoCreate() const;
429 // set the name (may be only called when m_name == NULL), makes copy of
431 void SetName(const char *charset
);
434 // note that we can't use wxString here because of compilation
435 // dependencies: we're included from wx/string.h
437 wxFontEncoding m_encoding
;
439 // use CreateConvIfNeeded() before accessing m_convReal!
440 wxMBConv
*m_convReal
;
445 // ----------------------------------------------------------------------------
446 // declare predefined conversion objects
447 // ----------------------------------------------------------------------------
449 // Note: this macro is an implementation detail (see the comment in
450 // strconv.cpp). The wxGet_XXX() and wxGet_XXXPtr() functions shouldn't be
451 // used by user code and neither should XXXPtr, use the wxConvXXX macro
453 #define WX_DECLARE_GLOBAL_CONV(klass, name) \
454 extern WXDLLIMPEXP_DATA_BASE(klass*) name##Ptr; \
455 extern WXDLLIMPEXP_BASE klass* wxGet_##name##Ptr(); \
456 inline klass& wxGet_##name() \
459 name##Ptr = wxGet_##name##Ptr(); \
464 // conversion to be used with all standard functions affected by locale, e.g.
465 // strtol(), strftime(), ...
466 WX_DECLARE_GLOBAL_CONV(wxMBConv
, wxConvLibc
)
467 #define wxConvLibc wxGet_wxConvLibc()
469 // conversion ISO-8859-1/UTF-7/UTF-8 <-> wchar_t
470 WX_DECLARE_GLOBAL_CONV(wxCSConv
, wxConvISO8859_1
)
471 #define wxConvISO8859_1 wxGet_wxConvISO8859_1()
473 WX_DECLARE_GLOBAL_CONV(wxMBConvUTF8
, wxConvUTF8
)
474 #define wxConvUTF8 wxGet_wxConvUTF8()
476 WX_DECLARE_GLOBAL_CONV(wxMBConvUTF7
, wxConvUTF7
)
477 #define wxConvUTF7 wxGet_wxConvUTF7()
479 // conversion used for the file names on the systems where they're not Unicode
480 // (basically anything except Windows)
482 // this is used by all file functions, can be changed by the application
484 // by default UTF-8 under Mac OS X and wxConvLibc elsewhere (but it's not used
485 // under Windows normally)
486 extern WXDLLIMPEXP_DATA_BASE(wxMBConv
*) wxConvFileName
;
488 // backwards compatible define
489 #define wxConvFile (*wxConvFileName)
491 // the current conversion object, may be set to any conversion, is used by
492 // default in a couple of places inside wx (initially same as wxConvLibc)
493 extern WXDLLIMPEXP_DATA_BASE(wxMBConv
*) wxConvCurrent
;
495 // the conversion corresponding to the current locale
496 WX_DECLARE_GLOBAL_CONV(wxCSConv
, wxConvLocal
)
497 #define wxConvLocal wxGet_wxConvLocal()
499 // the conversion corresponding to the encoding of the standard UI elements
501 // by default this is the same as wxConvLocal but may be changed if the program
502 // needs to use a fixed encoding
503 extern WXDLLIMPEXP_DATA_BASE(wxMBConv
*) wxConvUI
;
505 #undef WX_DECLARE_GLOBAL_CONV
507 // ----------------------------------------------------------------------------
508 // endianness-dependent conversions
509 // ----------------------------------------------------------------------------
511 #ifdef WORDS_BIGENDIAN
512 typedef wxMBConvUTF16BE wxMBConvUTF16
;
513 typedef wxMBConvUTF32BE wxMBConvUTF32
;
515 typedef wxMBConvUTF16LE wxMBConvUTF16
;
516 typedef wxMBConvUTF32LE wxMBConvUTF32
;
519 // ----------------------------------------------------------------------------
520 // filename conversion macros
521 // ----------------------------------------------------------------------------
523 // filenames are multibyte on Unix and widechar on Windows
524 #if wxMBFILES && wxUSE_UNICODE
525 #define wxFNCONV(name) wxConvFileName->cWX2MB(name)
526 #define wxFNSTRINGCAST wxMBSTRINGCAST
528 #if defined( __WXOSX__ ) && wxMBFILES
529 #define wxFNCONV(name) wxConvFileName->cWC2MB( wxConvLocal.cWX2WC(name) )
531 #define wxFNCONV(name) name
533 #define wxFNSTRINGCAST WXSTRINGCAST
536 #else // !wxUSE_WCHAR_T
538 // ----------------------------------------------------------------------------
539 // stand-ins in absence of wchar_t
540 // ----------------------------------------------------------------------------
542 class WXDLLIMPEXP_BASE wxMBConv
545 const char* cMB2WX(const char *psz
) const { return psz
; }
546 const char* cWX2MB(const char *psz
) const { return psz
; }
549 #define wxConvFile wxConvLocal
551 extern WXDLLIMPEXP_DATA_BASE(wxMBConv
) wxConvLibc
,
555 extern WXDLLIMPEXP_DATA_BASE(wxMBConv
*) wxConvCurrent
;
557 #define wxFNCONV(name) name
558 #define wxFNSTRINGCAST WXSTRINGCAST
563 // ----------------------------------------------------------------------------
564 // macros for the most common conversions
565 // ----------------------------------------------------------------------------
568 #define wxConvertWX2MB(s) wxConvCurrent->cWX2MB(s)
569 #define wxConvertMB2WX(s) wxConvCurrent->cMB2WX(s)
571 // these functions should be used when the conversions really, really have
572 // to succeed (usually because we pass their results to a standard C
573 // function which would crash if we passed NULL to it), so these functions
574 // always return a valid pointer if their argument is non-NULL
576 // this function safety is achieved by trying wxConvLibc first, wxConvUTF8
577 // next if it fails and, finally, wxConvISO8859_1 which always succeeds
578 extern WXDLLIMPEXP_BASE wxWCharBuffer
wxSafeConvertMB2WX(const char *s
);
580 // this function uses wxConvLibc and wxConvUTF8(MAP_INVALID_UTF8_TO_OCTAL)
582 extern WXDLLIMPEXP_BASE wxCharBuffer
wxSafeConvertWX2MB(const wchar_t *ws
);
584 // no conversions to do
585 #define wxConvertWX2MB(s) (s)
586 #define wxConvertMB2WX(s) (s)
587 #define wxSafeConvertMB2WX(s) (s)
588 #define wxSafeConvertWX2MB(s) (s)
589 #endif // Unicode/ANSI
591 #endif // _WX_STRCONV_H_