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