]> git.saurik.com Git - wxWidgets.git/blame - include/wx/strconv.h
use symbolic name for the shell menu bar too; include resources.h in wince.rc directl...
[wxWidgets.git] / include / wx / strconv.h
CommitLineData
6001e347
RR
1///////////////////////////////////////////////////////////////////////////////
2// Name: strconv.h
3// Purpose: conversion routines for char sets any Unicode
467e0479 4// Author: Ove Kaaven, Robert Roebling, Vadim Zeitlin
6001e347
RR
5// Modified by:
6// Created: 29/01/98
7// RCS-ID: $Id$
467e0479
VZ
8// Copyright: (c) 1998 Ove Kaaven, Robert Roebling
9// (c) 1998-2006 Vadim Zeitlin
65571936 10// Licence: wxWindows licence
6001e347
RR
11///////////////////////////////////////////////////////////////////////////////
12
d36c9347
VZ
13#ifndef _WX_STRCONV_H_
14#define _WX_STRCONV_H_
6001e347 15
6001e347 16#include "wx/defs.h"
e3f6cbd9 17#include "wx/chartype.h"
6001e347
RR
18#include "wx/buffer.h"
19
7db39dd6
CE
20#ifdef __DIGITALMARS__
21#include "typeinfo.h"
22#endif
23
9dea36ef
DW
24#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
25# undef __BSEXCPT__
26#endif
dccce9ea 27
6001e347
RR
28#include <stdlib.h>
29
30#if wxUSE_WCHAR_T
31
b5dbe15d 32class WXDLLIMPEXP_FWD_BASE wxString;
86501081 33
483b0434
VZ
34// the error value returned by wxMBConv methods
35#define wxCONV_FAILED ((size_t)-1)
36
467e0479
VZ
37// the default value for some length parameters meaning that the string is
38// NUL-terminated
39#define wxNO_LEN ((size_t)-1)
40
e90c1d2a 41// ----------------------------------------------------------------------------
bde4baac 42// wxMBConv (abstract base class for conversions)
e90c1d2a 43// ----------------------------------------------------------------------------
6001e347 44
509da451
VZ
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
48// confuse you.
49//
d36c9347
VZ
50// You also have to implement Clone() to allow copying the conversions
51// polymorphically.
52//
509da451 53// And you might need to override GetMBNulLen() as well.
bddd7a8d 54class WXDLLIMPEXP_BASE wxMBConv
6001e347
RR
55{
56public:
483b0434
VZ
57 // The functions doing actual conversion from/to narrow to/from wide
58 // character strings.
bde4baac 59 //
483b0434
VZ
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
467e0479 64 // character(s), in the output buffer, wxCONV_FAILED is returned.
483b0434
VZ
65 //
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
467e0479
VZ
68 // otherwise. If srcLen is wxNO_LEN, the entire string, up to and
69 // including the trailing NUL(s), is converted, otherwise exactly srcLen
70 // bytes are.
483b0434
VZ
71 //
72 // Typical usage:
73 //
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);
79 //
80 virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
467e0479 81 const char *src, size_t srcLen = wxNO_LEN) const;
483b0434
VZ
82
83 virtual size_t FromWChar(char *dst, size_t dstLen,
467e0479 84 const wchar_t *src, size_t srcLen = wxNO_LEN) const;
483b0434 85
e90c1d2a 86
483b0434
VZ
87 // Convenience functions for translating NUL-terminated strings: returns
88 // the buffer containing the converted string or NULL pointer if the
89 // conversion failed.
eec47cc6
VZ
90 const wxWCharBuffer cMB2WC(const char *in) const;
91 const wxCharBuffer cWC2MB(const wchar_t *in) const;
6001e347 92
483b0434
VZ
93 // Convenience functions for converting strings which may contain embedded
94 // NULs and don't have to be NUL-terminated.
f5fb6871 95 //
eec47cc6
VZ
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.
100 //
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)
105 const wxWCharBuffer
106 cMB2WC(const char *in, size_t inLen, size_t *outLen) const;
107 const wxCharBuffer
108 cWC2MB(const wchar_t *in, size_t inLen, size_t *outLen) const;
f5fb6871 109
bde4baac 110 // convenience functions for converting MB or WC to/from wxWin default
6001e347 111#if wxUSE_UNICODE
e90c1d2a
VZ
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; }
f6bcfd97 115 const wchar_t* cWX2WC(const wchar_t *psz) const { return psz; }
e90c1d2a
VZ
116#else // ANSI
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
2b5f62a0 122
c1464d9d
VZ
123 // this function is used in the implementation of cMB2WC() to distinguish
124 // between the following cases:
eec47cc6 125 //
c1464d9d
VZ
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
132 //
133 // anything else is not supported currently and -1 should be returned
7ef3ab50
VZ
134 virtual size_t GetMBNulLen() const { return 1; }
135
483b0434
VZ
136 // return the maximal value currently returned by GetMBNulLen() for any
137 // encoding
138 static size_t GetMaxMBNulLen() { return 4 /* for UTF-32 */; }
139
111d9948
VS
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; }
145#endif
483b0434
VZ
146
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.
153 //
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.
159 //
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)!
509da451
VZ
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;
483b0434
VZ
165
166
d36c9347
VZ
167 // make a heap-allocated copy of this object
168 virtual wxMBConv *Clone() const = 0;
169
7ef3ab50
VZ
170 // virtual dtor for any base class
171 virtual ~wxMBConv();
6001e347
RR
172};
173
bde4baac
VZ
174// ----------------------------------------------------------------------------
175// wxMBConvLibc uses standard mbstowcs() and wcstombs() functions for
176// conversion (hence it depends on the current locale)
177// ----------------------------------------------------------------------------
178
179class WXDLLIMPEXP_BASE wxMBConvLibc : public wxMBConv
180{
181public:
75736a9c
DS
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;
d36c9347
VZ
184
185 virtual wxMBConv *Clone() const { return new wxMBConvLibc; }
111d9948
VS
186
187#if wxUSE_UNICODE_UTF8
188 virtual bool IsUTF8() const { return wxLocaleIsUtf8; }
189#endif
bde4baac
VZ
190};
191
5576edf8
RR
192#ifdef __UNIX__
193
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// ----------------------------------------------------------------------------
200
201class WXDLLIMPEXP_BASE wxConvBrokenFileNames : public wxMBConv
202{
203public:
86501081 204 wxConvBrokenFileNames(const wxString& charset);
d36c9347 205 wxConvBrokenFileNames(const wxConvBrokenFileNames& conv)
2e2cf78d
VZ
206 : wxMBConv(),
207 m_conv(conv.m_conv ? conv.m_conv->Clone() : NULL)
d36c9347
VZ
208 {
209 }
5576edf8
RR
210 virtual ~wxConvBrokenFileNames() { delete m_conv; }
211
eec47cc6
VZ
212 virtual size_t MB2WC(wchar_t *out, const char *in, size_t outLen) const
213 {
214 return m_conv->MB2WC(out, in, outLen);
215 }
216
217 virtual size_t WC2MB(char *out, const wchar_t *in, size_t outLen) const
218 {
219 return m_conv->WC2MB(out, in, outLen);
220 }
5576edf8 221
7ef3ab50 222 virtual size_t GetMBNulLen() const
eec47cc6 223 {
22886fb3 224 // cast needed to call a private function
7ef3ab50 225 return m_conv->GetMBNulLen();
eec47cc6
VZ
226 }
227
ba98e032
VS
228#if wxUSE_UNICODE_UTF8
229 virtual bool IsUTF8() const { return m_conv->IsUTF8(); }
230#endif
231
d36c9347
VZ
232 virtual wxMBConv *Clone() const { return new wxConvBrokenFileNames(*this); }
233
7ef3ab50 234private:
5576edf8
RR
235 // the conversion object we forward to
236 wxMBConv *m_conv;
d36c9347
VZ
237
238 DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames)
5576edf8
RR
239};
240
eec47cc6 241#endif // __UNIX__
5576edf8 242
e90c1d2a 243// ----------------------------------------------------------------------------
6001e347 244// wxMBConvUTF7 (for conversion using UTF7 encoding)
e90c1d2a 245// ----------------------------------------------------------------------------
6001e347 246
bddd7a8d 247class WXDLLIMPEXP_BASE wxMBConvUTF7 : public wxMBConv
6001e347
RR
248{
249public:
75736a9c
DS
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;
d36c9347
VZ
252
253 virtual wxMBConv *Clone() const { return new wxMBConvUTF7; }
6001e347
RR
254};
255
e90c1d2a 256// ----------------------------------------------------------------------------
6001e347 257// wxMBConvUTF8 (for conversion using UTF8 encoding)
e90c1d2a 258// ----------------------------------------------------------------------------
6001e347 259
0286d08d
VZ
260// this is the real UTF-8 conversion class, it has to be called "strict UTF-8"
261// for compatibility reasons: the wxMBConvUTF8 class below also supports lossy
262// conversions if it is created with non default options
263class WXDLLIMPEXP_BASE wxMBConvStrictUTF8 : public wxMBConv
264{
265public:
266 // compiler-generated default ctor and other methods are ok
267
268 virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
269 const char *src, size_t srcLen = wxNO_LEN) const;
270 virtual size_t FromWChar(char *dst, size_t dstLen,
271 const wchar_t *src, size_t srcLen = wxNO_LEN) const;
272
273 virtual wxMBConv *Clone() const { return new wxMBConvStrictUTF8(); }
274
275#if wxUSE_UNICODE_UTF8
276 // NB: other mapping modes are not, strictly speaking, UTF-8, so we can't
277 // take the shortcut in that case
278 virtual bool IsUTF8() const { return true; }
279#endif
280};
281
282class WXDLLIMPEXP_BASE wxMBConvUTF8 : public wxMBConvStrictUTF8
6001e347
RR
283{
284public:
d36c9347
VZ
285 enum
286 {
ea8ce907
RR
287 MAP_INVALID_UTF8_NOT = 0,
288 MAP_INVALID_UTF8_TO_PUA = 1,
289 MAP_INVALID_UTF8_TO_OCTAL = 2
290 };
291
292 wxMBConvUTF8(int options = MAP_INVALID_UTF8_NOT) : m_options(options) { }
75736a9c
DS
293 virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
294 virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;
eec47cc6 295
d36c9347
VZ
296 virtual wxMBConv *Clone() const { return new wxMBConvUTF8(m_options); }
297
111d9948
VS
298#if wxUSE_UNICODE_UTF8
299 // NB: other mapping modes are not, strictly speaking, UTF-8, so we can't
300 // take the shortcut in that case
301 virtual bool IsUTF8() const { return m_options == MAP_INVALID_UTF8_NOT; }
302#endif
303
ea8ce907
RR
304private:
305 int m_options;
6001e347
RR
306};
307
eec47cc6
VZ
308// ----------------------------------------------------------------------------
309// wxMBConvUTF16Base: for both LE and BE variants
310// ----------------------------------------------------------------------------
311
312class WXDLLIMPEXP_BASE wxMBConvUTF16Base : public wxMBConv
313{
7ef3ab50 314public:
467e0479
VZ
315 enum { BYTES_PER_CHAR = 2 };
316
317 virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR; }
318
319protected:
320 // return the length of the buffer using srcLen if it's not wxNO_LEN and
321 // computing the length ourselves if it is; also checks that the length is
322 // even if specified as we need an entire number of UTF-16 characters and
323 // returns wxNO_LEN which indicates error if it is odd
324 static size_t GetLength(const char *src, size_t srcLen);
eec47cc6
VZ
325};
326
e90c1d2a 327// ----------------------------------------------------------------------------
c91830cb
VZ
328// wxMBConvUTF16LE (for conversion using UTF16 Little Endian encoding)
329// ----------------------------------------------------------------------------
330
eec47cc6 331class WXDLLIMPEXP_BASE wxMBConvUTF16LE : public wxMBConvUTF16Base
c91830cb
VZ
332{
333public:
467e0479
VZ
334 virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
335 const char *src, size_t srcLen = wxNO_LEN) const;
336 virtual size_t FromWChar(char *dst, size_t dstLen,
337 const wchar_t *src, size_t srcLen = wxNO_LEN) const;
d36c9347 338 virtual wxMBConv *Clone() const { return new wxMBConvUTF16LE; }
c91830cb
VZ
339};
340
341// ----------------------------------------------------------------------------
342// wxMBConvUTF16BE (for conversion using UTF16 Big Endian encoding)
343// ----------------------------------------------------------------------------
344
eec47cc6 345class WXDLLIMPEXP_BASE wxMBConvUTF16BE : public wxMBConvUTF16Base
c91830cb
VZ
346{
347public:
467e0479
VZ
348 virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
349 const char *src, size_t srcLen = wxNO_LEN) const;
350 virtual size_t FromWChar(char *dst, size_t dstLen,
351 const wchar_t *src, size_t srcLen = wxNO_LEN) const;
d36c9347 352 virtual wxMBConv *Clone() const { return new wxMBConvUTF16BE; }
c91830cb
VZ
353};
354
eec47cc6
VZ
355// ----------------------------------------------------------------------------
356// wxMBConvUTF32Base: base class for both LE and BE variants
357// ----------------------------------------------------------------------------
358
359class WXDLLIMPEXP_BASE wxMBConvUTF32Base : public wxMBConv
360{
7ef3ab50 361public:
467e0479
VZ
362 enum { BYTES_PER_CHAR = 4 };
363
364 virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR; }
365
366protected:
367 // this is similar to wxMBConvUTF16Base method with the same name except
368 // that, of course, it verifies that length is divisible by 4 if given and
369 // not by 2
370 static size_t GetLength(const char *src, size_t srcLen);
eec47cc6
VZ
371};
372
c91830cb 373// ----------------------------------------------------------------------------
8b9e1f43 374// wxMBConvUTF32LE (for conversion using UTF32 Little Endian encoding)
c91830cb
VZ
375// ----------------------------------------------------------------------------
376
eec47cc6 377class WXDLLIMPEXP_BASE wxMBConvUTF32LE : public wxMBConvUTF32Base
c91830cb
VZ
378{
379public:
467e0479
VZ
380 virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
381 const char *src, size_t srcLen = wxNO_LEN) const;
382 virtual size_t FromWChar(char *dst, size_t dstLen,
383 const wchar_t *src, size_t srcLen = wxNO_LEN) const;
d36c9347 384 virtual wxMBConv *Clone() const { return new wxMBConvUTF32LE; }
c91830cb
VZ
385};
386
387// ----------------------------------------------------------------------------
8b9e1f43 388// wxMBConvUTF32BE (for conversion using UTF32 Big Endian encoding)
c91830cb
VZ
389// ----------------------------------------------------------------------------
390
eec47cc6 391class WXDLLIMPEXP_BASE wxMBConvUTF32BE : public wxMBConvUTF32Base
c91830cb
VZ
392{
393public:
467e0479
VZ
394 virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
395 const char *src, size_t srcLen = wxNO_LEN) const;
396 virtual size_t FromWChar(char *dst, size_t dstLen,
397 const wchar_t *src, size_t srcLen = wxNO_LEN) const;
d36c9347 398 virtual wxMBConv *Clone() const { return new wxMBConvUTF32BE; }
c91830cb
VZ
399};
400
401// ----------------------------------------------------------------------------
e90c1d2a
VZ
402// wxCSConv (for conversion based on loadable char sets)
403// ----------------------------------------------------------------------------
6001e347 404
8b04d4c4
VZ
405#include "wx/fontenc.h"
406
bddd7a8d 407class WXDLLIMPEXP_BASE wxCSConv : public wxMBConv
6001e347 408{
6001e347 409public:
e95354ec
VZ
410 // we can be created either from charset name or from an encoding constant
411 // but we can't have both at once
86501081 412 wxCSConv(const wxString& charset);
8b04d4c4 413 wxCSConv(wxFontEncoding encoding);
e95354ec 414
54380f29 415 wxCSConv(const wxCSConv& conv);
e90c1d2a
VZ
416 virtual ~wxCSConv();
417
54380f29 418 wxCSConv& operator=(const wxCSConv& conv);
2b5f62a0 419
1c714a5d
VZ
420 virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
421 const char *src, size_t srcLen = wxNO_LEN) const;
422 virtual size_t FromWChar(char *dst, size_t dstLen,
423 const wchar_t *src, size_t srcLen = wxNO_LEN) const;
75736a9c
DS
424 virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
425 virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;
7ef3ab50 426 virtual size_t GetMBNulLen() const;
1c714a5d 427
ba98e032
VS
428#if wxUSE_UNICODE_UTF8
429 virtual bool IsUTF8() const;
430#endif
431
d36c9347 432 virtual wxMBConv *Clone() const { return new wxCSConv(*this); }
e90c1d2a 433
d36c9347 434 void Clear();
65e50848 435
0f0298b1
VZ
436 // return true if the conversion could be initilized successfully
437 bool IsOk() const;
0f0298b1 438
e90c1d2a 439private:
8b04d4c4
VZ
440 // common part of all ctors
441 void Init();
442
e95354ec
VZ
443 // creates m_convReal if necessary
444 void CreateConvIfNeeded() const;
445
446 // do create m_convReal (unconditionally)
447 wxMBConv *DoCreate() const;
448
bda3d86a
VZ
449 // set the name (may be only called when m_name == NULL), makes copy of
450 // charset string
86501081 451 void SetName(const char *charset);
e90c1d2a 452
e95354ec 453
dccce9ea
VZ
454 // note that we can't use wxString here because of compilation
455 // dependencies: we're included from wx/string.h
86501081 456 char *m_name;
8b04d4c4 457 wxFontEncoding m_encoding;
e95354ec
VZ
458
459 // use CreateConvIfNeeded() before accessing m_convReal!
460 wxMBConv *m_convReal;
e90c1d2a 461 bool m_deferred;
6001e347
RR
462};
463
c3c1a9a9 464
f5a1953b
VZ
465// ----------------------------------------------------------------------------
466// declare predefined conversion objects
467// ----------------------------------------------------------------------------
d5c8817c 468
1e50d914
VS
469// Note: this macro is an implementation detail (see the comment in
470// strconv.cpp). The wxGet_XXX() and wxGet_XXXPtr() functions shouldn't be
471// used by user code and neither should XXXPtr, use the wxConvXXX macro
472// instead.
473#define WX_DECLARE_GLOBAL_CONV(klass, name) \
474 extern WXDLLIMPEXP_DATA_BASE(klass*) name##Ptr; \
092ee46f 475 extern WXDLLIMPEXP_BASE klass* wxGet_##name##Ptr(); \
1e50d914
VS
476 inline klass& wxGet_##name() \
477 { \
478 if ( !name##Ptr ) \
479 name##Ptr = wxGet_##name##Ptr(); \
480 return *name##Ptr; \
481 }
482
483
f5a1953b
VZ
484// conversion to be used with all standard functions affected by locale, e.g.
485// strtol(), strftime(), ...
1e50d914
VS
486WX_DECLARE_GLOBAL_CONV(wxMBConv, wxConvLibc)
487#define wxConvLibc wxGet_wxConvLibc()
f5a1953b
VZ
488
489// conversion ISO-8859-1/UTF-7/UTF-8 <-> wchar_t
1e50d914
VS
490WX_DECLARE_GLOBAL_CONV(wxCSConv, wxConvISO8859_1)
491#define wxConvISO8859_1 wxGet_wxConvISO8859_1()
492
0286d08d 493WX_DECLARE_GLOBAL_CONV(wxMBConvStrictUTF8, wxConvUTF8)
1e50d914
VS
494#define wxConvUTF8 wxGet_wxConvUTF8()
495
496WX_DECLARE_GLOBAL_CONV(wxMBConvUTF7, wxConvUTF7)
497#define wxConvUTF7 wxGet_wxConvUTF7()
f5a1953b
VZ
498
499// conversion used for the file names on the systems where they're not Unicode
500// (basically anything except Windows)
501//
502// this is used by all file functions, can be changed by the application
503//
504// by default UTF-8 under Mac OS X and wxConvLibc elsewhere (but it's not used
505// under Windows normally)
506extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvFileName;
507
508// backwards compatible define
509#define wxConvFile (*wxConvFileName)
510
511// the current conversion object, may be set to any conversion, is used by
512// default in a couple of places inside wx (initially same as wxConvLibc)
16cba29d 513extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent;
6001e347 514
0e052272 515// the conversion corresponding to the current locale
1e50d914
VS
516WX_DECLARE_GLOBAL_CONV(wxCSConv, wxConvLocal)
517#define wxConvLocal wxGet_wxConvLocal()
f5a1953b 518
d5bef0a3
VZ
519// the conversion corresponding to the encoding of the standard UI elements
520//
521// by default this is the same as wxConvLocal but may be changed if the program
522// needs to use a fixed encoding
523extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI;
524
1e50d914
VS
525#undef WX_DECLARE_GLOBAL_CONV
526
e95354ec
VZ
527// ----------------------------------------------------------------------------
528// endianness-dependent conversions
529// ----------------------------------------------------------------------------
530
531#ifdef WORDS_BIGENDIAN
532 typedef wxMBConvUTF16BE wxMBConvUTF16;
533 typedef wxMBConvUTF32BE wxMBConvUTF32;
534#else
535 typedef wxMBConvUTF16LE wxMBConvUTF16;
536 typedef wxMBConvUTF32LE wxMBConvUTF32;
537#endif
538
e90c1d2a 539// ----------------------------------------------------------------------------
6001e347 540// filename conversion macros
e90c1d2a 541// ----------------------------------------------------------------------------
6001e347 542
bc4b4779 543// filenames are multibyte on Unix and widechar on Windows
80df4d31 544#if wxMBFILES && wxUSE_UNICODE
f5a1953b 545 #define wxFNCONV(name) wxConvFileName->cWX2MB(name)
e90c1d2a 546 #define wxFNSTRINGCAST wxMBSTRINGCAST
d5c8817c
SC
547#else
548#if defined( __WXOSX__ ) && wxMBFILES
f5a1953b 549 #define wxFNCONV(name) wxConvFileName->cWC2MB( wxConvLocal.cWX2WC(name) )
6001e347 550#else
e90c1d2a 551 #define wxFNCONV(name) name
d5c8817c 552#endif
e90c1d2a 553 #define wxFNSTRINGCAST WXSTRINGCAST
6001e347
RR
554#endif
555
f5a1953b 556#else // !wxUSE_WCHAR_T
6001e347 557
e90c1d2a 558// ----------------------------------------------------------------------------
6001e347 559// stand-ins in absence of wchar_t
e90c1d2a 560// ----------------------------------------------------------------------------
6001e347 561
bddd7a8d 562class WXDLLIMPEXP_BASE wxMBConv
6001e347
RR
563{
564public:
e90c1d2a
VZ
565 const char* cMB2WX(const char *psz) const { return psz; }
566 const char* cWX2MB(const char *psz) const { return psz; }
6001e347 567};
e90c1d2a 568
bde4baac
VZ
569#define wxConvFile wxConvLocal
570
16cba29d 571extern WXDLLIMPEXP_DATA_BASE(wxMBConv) wxConvLibc,
8b04d4c4
VZ
572 wxConvLocal,
573 wxConvISO8859_1,
574 wxConvUTF8;
16cba29d 575extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent;
6001e347
RR
576
577#define wxFNCONV(name) name
e90c1d2a 578#define wxFNSTRINGCAST WXSTRINGCAST
6001e347
RR
579
580#endif
581 // wxUSE_WCHAR_T
582
e90c1d2a
VZ
583// ----------------------------------------------------------------------------
584// macros for the most common conversions
585// ----------------------------------------------------------------------------
586
587#if wxUSE_UNICODE
588 #define wxConvertWX2MB(s) wxConvCurrent->cWX2MB(s)
589 #define wxConvertMB2WX(s) wxConvCurrent->cMB2WX(s)
69c928ef
VZ
590
591 // these functions should be used when the conversions really, really have
592 // to succeed (usually because we pass their results to a standard C
593 // function which would crash if we passed NULL to it), so these functions
594 // always return a valid pointer if their argument is non-NULL
595
596 // this function safety is achieved by trying wxConvLibc first, wxConvUTF8
597 // next if it fails and, finally, wxConvISO8859_1 which always succeeds
598 extern WXDLLIMPEXP_BASE wxWCharBuffer wxSafeConvertMB2WX(const char *s);
599
600 // this function uses wxConvLibc and wxConvUTF8(MAP_INVALID_UTF8_TO_OCTAL)
601 // if it fails
602 extern WXDLLIMPEXP_BASE wxCharBuffer wxSafeConvertWX2MB(const wchar_t *ws);
e90c1d2a
VZ
603#else // ANSI
604 // no conversions to do
605 #define wxConvertWX2MB(s) (s)
606 #define wxConvertMB2WX(s) (s)
69c928ef
VZ
607 #define wxSafeConvertMB2WX(s) (s)
608 #define wxSafeConvertWX2MB(s) (s)
e90c1d2a
VZ
609#endif // Unicode/ANSI
610
d36c9347 611#endif // _WX_STRCONV_H_
6001e347 612