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 // the error value returned by wxMBConv methods
  33 #define wxCONV_FAILED ((size_t)-1)
  34
  35 // the default value for some length parameters meaning that the string is
  36 // NUL-terminated
  37 #define wxNO_LEN ((size_t)-1)
  38
  39 // ----------------------------------------------------------------------------
  40 // wxMBConv (abstract base class for conversions)
  41 // ----------------------------------------------------------------------------
  42
  43 // When deriving a new class from wxMBConv you must reimplement ToWChar() and
  44 // FromWChar() methods which are not pure virtual only for historical reasons,
  45 // don't let the fact that the existing classes implement MB2WC/WC2MB() instead
  46 // confuse you.
  47 //
  48 // You also have to implement Clone() to allow copying the conversions
  49 // polymorphically.
  50 //
  51 // And you might need to override GetMBNulLen() as well.
  52 class WXDLLIMPEXP_BASE wxMBConv
  53 {
  54 public:
  55     // The functions doing actual conversion from/to narrow to/from wide
  56     // character strings.
  57     //
  58     // On success, the return value is the length (i.e. the number of
  59     // characters, not bytes) of the converted string including any trailing
  60     // L'\0' or (possibly multiple) '\0'(s). If the conversion fails or if
  61     // there is not enough space for everything, including the trailing NUL
  62     // character(s), in the output buffer, wxCONV_FAILED is returned.
  63     //
  64     // In the special case when dstLen is 0 (outputBuf may be NULL then) the
  65     // return value is the length of the needed buffer but nothing happens
  66     // otherwise. If srcLen is wxNO_LEN, the entire string, up to and
  67     // including the trailing NUL(s), is converted, otherwise exactly srcLen
  68     // bytes are.
  69     //
  70     // Typical usage:
  71     //
  72     //          size_t dstLen = conv.ToWChar(NULL, 0, src);
  73     //          if ( dstLen != wxCONV_FAILED )
  74     //              ... handle error ...
  75     //          wchar_t *wbuf = new wchar_t[dstLen];
  76     //          conv.ToWChar(wbuf, dstLen, src);
  77     //
  78     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
  79                            const char *src, size_t srcLen = wxNO_LEN) const;
  80
  81     virtual size_t FromWChar(char *dst, size_t dstLen,
  82                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;
  83
  84
  85     // Convenience functions for translating NUL-terminated strings: returns
  86     // the buffer containing the converted string or NULL pointer if the
  87     // conversion failed.
  88     const wxWCharBuffer cMB2WC(const char *in) const;
  89     const wxCharBuffer cWC2MB(const wchar_t *in) const;
  90
  91     // Convenience functions for converting strings which may contain embedded
  92     // NULs and don't have to be NUL-terminated.
  93     //
  94     // inLen is the length of the buffer including trailing NUL if any: if the
  95     // last 4 bytes of the buffer are all NULs, these functions are more
  96     // efficient as they avoid copying the string, but otherwise a copy is made
  97     // internally which could be quite bad for (very) long strings.
  98     //
  99     // outLen receives, if not NULL, the length of the converted string or 0 if
 100     // the conversion failed (returning 0 and not -1 in this case makes it
 101     // difficult to distinguish between failed conversion and empty input but
 102     // this is done for backwards compatibility)
 103     const wxWCharBuffer
 104         cMB2WC(const char *in, size_t inLen, size_t *outLen) const;
 105     const wxCharBuffer
 106         cWC2MB(const wchar_t *in, size_t inLen, size_t *outLen) const;
 107
 108     // convenience functions for converting MB or WC to/from wxWin default
 109 #if wxUSE_UNICODE
 110     const wxWCharBuffer cMB2WX(const char *psz) const { return cMB2WC(psz); }
 111     const wxCharBuffer cWX2MB(const wchar_t *psz) const { return cWC2MB(psz); }
 112     const wchar_t* cWC2WX(const wchar_t *psz) const { return psz; }
 113     const wchar_t* cWX2WC(const wchar_t *psz) const { return psz; }
 114 #else // ANSI
 115     const char* cMB2WX(const char *psz) const { return psz; }
 116     const char* cWX2MB(const char *psz) const { return psz; }
 117     const wxCharBuffer cWC2WX(const wchar_t *psz) const { return cWC2MB(psz); }
 118     const wxWCharBuffer cWX2WC(const char *psz) const { return cMB2WC(psz); }
 119 #endif // Unicode/ANSI
 120
 121     // this function is used in the implementation of cMB2WC() to distinguish
 122     // between the following cases:
 123     //
 124     //      a) var width encoding with strings terminated by a single NUL
 125     //         (usual multibyte encodings): return 1 in this case
 126     //      b) fixed width encoding with 2 bytes/char and so terminated by
 127     //         2 NULs (UTF-16/UCS-2 and variants): return 2 in this case
 128     //      c) fixed width encoding with 4 bytes/char and so terminated by
 129     //         4 NULs (UTF-32/UCS-4 and variants): return 4 in this case
 130     //
 131     // anything else is not supported currently and -1 should be returned
 132     virtual size_t GetMBNulLen() const { return 1; }
 133
 134     // return the maximal value currently returned by GetMBNulLen() for any
 135     // encoding
 136     static size_t GetMaxMBNulLen() { return 4 /* for UTF-32 */; }
 137
 138 #if wxUSE_UNICODE_UTF8
 139     // return true if the converter's charset is UTF-8, i.e. char* strings
 140     // decoded using this object can be directly copied to wxString's internal
 141     // storage without converting to WC and than back to UTF-8 MB string
 142     virtual bool IsUTF8() const { return false; }
 143 #endif
 144
 145     // The old conversion functions. The existing classes currently mostly
 146     // implement these ones but we're in transition to using To/FromWChar()
 147     // instead and any new classes should implement just the new functions.
 148     // For now, however, we provide default implementation of To/FromWChar() in
 149     // this base class in terms of MB2WC/WC2MB() to avoid having to rewrite all
 150     // the conversions at once.
 151     //
 152     // On success, the return value is the length (i.e. the number of
 153     // characters, not bytes) not counting the trailing NUL(s) of the converted
 154     // string. On failure, (size_t)-1 is returned. In the special case when
 155     // outputBuf is NULL the return value is the same one but nothing is
 156     // written to the buffer.
 157     //
 158     // Note that outLen is the length of the output buffer, not the length of
 159     // the input (which is always supposed to be terminated by one or more
 160     // NULs, as appropriate for the encoding)!
 161     virtual size_t MB2WC(wchar_t *out, const char *in, size_t outLen) const;
 162     virtual size_t WC2MB(char *out, const wchar_t *in, size_t outLen) const;
 163
 164
 165     // make a heap-allocated copy of this object
 166     virtual wxMBConv *Clone() const = 0;
 167
 168     // virtual dtor for any base class
 169     virtual ~wxMBConv();
 170 };
 171
 172 // ----------------------------------------------------------------------------
 173 // wxMBConvLibc uses standard mbstowcs() and wcstombs() functions for
 174 //              conversion (hence it depends on the current locale)
 175 // ----------------------------------------------------------------------------
 176
 177 class WXDLLIMPEXP_BASE wxMBConvLibc : public wxMBConv
 178 {
 179 public:
 180     virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
 181     virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;
 182
 183     virtual wxMBConv *Clone() const { return new wxMBConvLibc; }
 184
 185 #if wxUSE_UNICODE_UTF8
 186     virtual bool IsUTF8() const { return wxLocaleIsUtf8; }
 187 #endif
 188 };
 189
 190 #ifdef __UNIX__
 191
 192 // ----------------------------------------------------------------------------
 193 // wxConvBrokenFileNames is made for Unix in Unicode mode when
 194 // files are accidentally written in an encoding which is not
 195 // the system encoding. Typically, the system encoding will be
 196 // UTF8 but there might be files stored in ISO8859-1 on disk.
 197 // ----------------------------------------------------------------------------
 198
 199 class WXDLLIMPEXP_BASE wxConvBrokenFileNames : public wxMBConv
 200 {
 201 public:
 202     wxConvBrokenFileNames(const wxChar *charset);
 203     wxConvBrokenFileNames(const wxConvBrokenFileNames& conv)
 204         : wxMBConv(),
 205           m_conv(conv.m_conv ? conv.m_conv->Clone() : NULL)
 206     {
 207     }
 208     virtual ~wxConvBrokenFileNames() { delete m_conv; }
 209
 210     virtual size_t MB2WC(wchar_t *out, const char *in, size_t outLen) const
 211     {
 212         return m_conv->MB2WC(out, in, outLen);
 213     }
 214
 215     virtual size_t WC2MB(char *out, const wchar_t *in, size_t outLen) const
 216     {
 217         return m_conv->WC2MB(out, in, outLen);
 218     }
 219
 220     virtual size_t GetMBNulLen() const
 221     {
 222         // cast needed to call a private function
 223         return m_conv->GetMBNulLen();
 224     }
 225
 226     virtual wxMBConv *Clone() const { return new wxConvBrokenFileNames(*this); }
 227
 228 private:
 229     // the conversion object we forward to
 230     wxMBConv *m_conv;
 231
 232     DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames)
 233 };
 234
 235 #endif // __UNIX__
 236
 237 // ----------------------------------------------------------------------------
 238 // wxMBConvUTF7 (for conversion using UTF7 encoding)
 239 // ----------------------------------------------------------------------------
 240
 241 class WXDLLIMPEXP_BASE wxMBConvUTF7 : public wxMBConv
 242 {
 243 public:
 244     virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
 245     virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;
 246
 247     virtual wxMBConv *Clone() const { return new wxMBConvUTF7; }
 248 };
 249
 250 // ----------------------------------------------------------------------------
 251 // wxMBConvUTF8 (for conversion using UTF8 encoding)
 252 // ----------------------------------------------------------------------------
 253
 254 class WXDLLIMPEXP_BASE wxMBConvUTF8 : public wxMBConv
 255 {
 256 public:
 257     // FIXME-UTF8: split this class into multiple classes, one strict and
 258     //             other lossy (PUA, OCTAL mappings)
 259     enum
 260     {
 261         MAP_INVALID_UTF8_NOT = 0,
 262         MAP_INVALID_UTF8_TO_PUA = 1,
 263         MAP_INVALID_UTF8_TO_OCTAL = 2
 264     };
 265
 266     wxMBConvUTF8(int options = MAP_INVALID_UTF8_NOT) : m_options(options) { }
 267     virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
 268     virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;
 269
 270     virtual wxMBConv *Clone() const { return new wxMBConvUTF8(m_options); }
 271
 272 #if wxUSE_UNICODE_UTF8
 273     // NB: other mapping modes are not, strictly speaking, UTF-8, so we can't
 274     //     take the shortcut in that case
 275     virtual bool IsUTF8() const { return m_options == MAP_INVALID_UTF8_NOT; }
 276 #endif
 277
 278 private:
 279     int m_options;
 280 };
 281
 282 // ----------------------------------------------------------------------------
 283 // wxMBConvUTF16Base: for both LE and BE variants
 284 // ----------------------------------------------------------------------------
 285
 286 class WXDLLIMPEXP_BASE wxMBConvUTF16Base : public wxMBConv
 287 {
 288 public:
 289     enum { BYTES_PER_CHAR = 2 };
 290
 291     virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR; }
 292
 293 protected:
 294     // return the length of the buffer using srcLen if it's not wxNO_LEN and
 295     // computing the length ourselves if it is; also checks that the length is
 296     // even if specified as we need an entire number of UTF-16 characters and
 297     // returns wxNO_LEN which indicates error if it is odd
 298     static size_t GetLength(const char *src, size_t srcLen);
 299 };
 300
 301 // ----------------------------------------------------------------------------
 302 // wxMBConvUTF16LE (for conversion using UTF16 Little Endian encoding)
 303 // ----------------------------------------------------------------------------
 304
 305 class WXDLLIMPEXP_BASE wxMBConvUTF16LE : public wxMBConvUTF16Base
 306 {
 307 public:
 308     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
 309                            const char *src, size_t srcLen = wxNO_LEN) const;
 310     virtual size_t FromWChar(char *dst, size_t dstLen,
 311                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;
 312     virtual wxMBConv *Clone() const { return new wxMBConvUTF16LE; }
 313 };
 314
 315 // ----------------------------------------------------------------------------
 316 // wxMBConvUTF16BE (for conversion using UTF16 Big Endian encoding)
 317 // ----------------------------------------------------------------------------
 318
 319 class WXDLLIMPEXP_BASE wxMBConvUTF16BE : public wxMBConvUTF16Base
 320 {
 321 public:
 322     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
 323                            const char *src, size_t srcLen = wxNO_LEN) const;
 324     virtual size_t FromWChar(char *dst, size_t dstLen,
 325                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;
 326     virtual wxMBConv *Clone() const { return new wxMBConvUTF16BE; }
 327 };
 328
 329 // ----------------------------------------------------------------------------
 330 // wxMBConvUTF32Base: base class for both LE and BE variants
 331 // ----------------------------------------------------------------------------
 332
 333 class WXDLLIMPEXP_BASE wxMBConvUTF32Base : public wxMBConv
 334 {
 335 public:
 336     enum { BYTES_PER_CHAR = 4 };
 337
 338     virtual size_t GetMBNulLen() const { return BYTES_PER_CHAR; }
 339
 340 protected:
 341     // this is similar to wxMBConvUTF16Base method with the same name except
 342     // that, of course, it verifies that length is divisible by 4 if given and
 343     // not by 2
 344     static size_t GetLength(const char *src, size_t srcLen);
 345 };
 346
 347 // ----------------------------------------------------------------------------
 348 // wxMBConvUTF32LE (for conversion using UTF32 Little Endian encoding)
 349 // ----------------------------------------------------------------------------
 350
 351 class WXDLLIMPEXP_BASE wxMBConvUTF32LE : public wxMBConvUTF32Base
 352 {
 353 public:
 354     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
 355                            const char *src, size_t srcLen = wxNO_LEN) const;
 356     virtual size_t FromWChar(char *dst, size_t dstLen,
 357                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;
 358     virtual wxMBConv *Clone() const { return new wxMBConvUTF32LE; }
 359 };
 360
 361 // ----------------------------------------------------------------------------
 362 // wxMBConvUTF32BE (for conversion using UTF32 Big Endian encoding)
 363 // ----------------------------------------------------------------------------
 364
 365 class WXDLLIMPEXP_BASE wxMBConvUTF32BE : public wxMBConvUTF32Base
 366 {
 367 public:
 368     virtual size_t ToWChar(wchar_t *dst, size_t dstLen,
 369                            const char *src, size_t srcLen = wxNO_LEN) const;
 370     virtual size_t FromWChar(char *dst, size_t dstLen,
 371                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;
 372     virtual wxMBConv *Clone() const { return new wxMBConvUTF32BE; }
 373 };
 374
 375 // ----------------------------------------------------------------------------
 376 // wxCSConv (for conversion based on loadable char sets)
 377 // ----------------------------------------------------------------------------
 378
 379 #include "wx/fontenc.h"
 380
 381 class WXDLLIMPEXP_BASE wxCSConv : public wxMBConv
 382 {
 383 public:
 384     // we can be created either from charset name or from an encoding constant
 385     // but we can't have both at once
 386     wxCSConv(const wxChar *charset);
 387     wxCSConv(wxFontEncoding encoding);
 388
 389     wxCSConv(const wxCSConv& conv);
 390     virtual ~wxCSConv();
 391
 392     wxCSConv& operator=(const wxCSConv& conv);
 393
 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;
 398     virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
 399     virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;
 400     virtual size_t GetMBNulLen() const;
 401
 402     virtual wxMBConv *Clone() const { return new wxCSConv(*this); }
 403
 404     void Clear();
 405
 406     // return true if the conversion could be initilized successfully
 407     bool IsOk() const;
 408
 409 private:
 410     // common part of all ctors
 411     void Init();
 412
 413     // creates m_convReal if necessary
 414     void CreateConvIfNeeded() const;
 415
 416     // do create m_convReal (unconditionally)
 417     wxMBConv *DoCreate() const;
 418
 419     // set the name (may be only called when m_name == NULL), makes copy of
 420     // charset string
 421     void SetName(const wxChar *charset);
 422
 423
 424     // note that we can't use wxString here because of compilation
 425     // dependencies: we're included from wx/string.h
 426     wxChar *m_name;
 427     wxFontEncoding m_encoding;
 428
 429     // use CreateConvIfNeeded() before accessing m_convReal!
 430     wxMBConv *m_convReal;
 431     bool m_deferred;
 432 };
 433
 434
 435 // ----------------------------------------------------------------------------
 436 // declare predefined conversion objects
 437 // ----------------------------------------------------------------------------
 438
 439 // Note: this macro is an implementation detail (see the comment in
 440 // strconv.cpp). The wxGet_XXX() and wxGet_XXXPtr() functions shouldn't be
 441 // used by user code and neither should XXXPtr, use the wxConvXXX macro
 442 // instead.
 443 #define WX_DECLARE_GLOBAL_CONV(klass, name)                             \
 444     extern WXDLLIMPEXP_DATA_BASE(klass*) name##Ptr;                     \
 445     extern WXDLLIMPEXP_BASE klass* wxGet_##name##Ptr();                 \
 446     inline klass& wxGet_##name()                                        \
 447     {                                                                   \
 448         if ( !name##Ptr )                                               \
 449             name##Ptr = wxGet_##name##Ptr();                            \
 450         return *name##Ptr;                                              \
 451     }
 452
 453
 454 // conversion to be used with all standard functions affected by locale, e.g.
 455 // strtol(), strftime(), ...
 456 WX_DECLARE_GLOBAL_CONV(wxMBConv, wxConvLibc)
 457 #define wxConvLibc wxGet_wxConvLibc()
 458
 459 // conversion ISO-8859-1/UTF-7/UTF-8 <-> wchar_t
 460 WX_DECLARE_GLOBAL_CONV(wxCSConv, wxConvISO8859_1)
 461 #define wxConvISO8859_1 wxGet_wxConvISO8859_1()
 462
 463 WX_DECLARE_GLOBAL_CONV(wxMBConvUTF8, wxConvUTF8)
 464 #define wxConvUTF8 wxGet_wxConvUTF8()
 465
 466 WX_DECLARE_GLOBAL_CONV(wxMBConvUTF7, wxConvUTF7)
 467 #define wxConvUTF7 wxGet_wxConvUTF7()
 468
 469 // conversion used for the file names on the systems where they're not Unicode
 470 // (basically anything except Windows)
 471 //
 472 // this is used by all file functions, can be changed by the application
 473 //
 474 // by default UTF-8 under Mac OS X and wxConvLibc elsewhere (but it's not used
 475 // under Windows normally)
 476 extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvFileName;
 477
 478 // backwards compatible define
 479 #define wxConvFile (*wxConvFileName)
 480
 481 // the current conversion object, may be set to any conversion, is used by
 482 // default in a couple of places inside wx (initially same as wxConvLibc)
 483 extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent;
 484
 485 // the conversion corresponding to the current locale
 486 WX_DECLARE_GLOBAL_CONV(wxCSConv, wxConvLocal)
 487 #define wxConvLocal wxGet_wxConvLocal()
 488
 489 // the conversion corresponding to the encoding of the standard UI elements
 490 //
 491 // by default this is the same as wxConvLocal but may be changed if the program
 492 // needs to use a fixed encoding
 493 extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI;
 494
 495 #undef WX_DECLARE_GLOBAL_CONV
 496
 497 // ----------------------------------------------------------------------------
 498 // endianness-dependent conversions
 499 // ----------------------------------------------------------------------------
 500
 501 #ifdef WORDS_BIGENDIAN
 502     typedef wxMBConvUTF16BE wxMBConvUTF16;
 503     typedef wxMBConvUTF32BE wxMBConvUTF32;
 504 #else
 505     typedef wxMBConvUTF16LE wxMBConvUTF16;
 506     typedef wxMBConvUTF32LE wxMBConvUTF32;
 507 #endif
 508
 509 // ----------------------------------------------------------------------------
 510 // filename conversion macros
 511 // ----------------------------------------------------------------------------
 512
 513 // filenames are multibyte on Unix and widechar on Windows
 514 #if defined(__UNIX__) || defined(__WXMAC__)
 515     #define wxMBFILES 1
 516 #else
 517     #define wxMBFILES 0
 518 #endif
 519
 520 #if wxMBFILES && wxUSE_UNICODE
 521     #define wxFNCONV(name) wxConvFileName->cWX2MB(name)
 522     #define wxFNSTRINGCAST wxMBSTRINGCAST
 523 #else
 524 #if defined( __WXOSX__ ) && wxMBFILES
 525     #define wxFNCONV(name) wxConvFileName->cWC2MB( wxConvLocal.cWX2WC(name) )
 526 #else
 527     #define wxFNCONV(name) name
 528 #endif
 529     #define wxFNSTRINGCAST WXSTRINGCAST
 530 #endif
 531
 532 #else // !wxUSE_WCHAR_T
 533
 534 // ----------------------------------------------------------------------------
 535 // stand-ins in absence of wchar_t
 536 // ----------------------------------------------------------------------------
 537
 538 class WXDLLIMPEXP_BASE wxMBConv
 539 {
 540 public:
 541     const char* cMB2WX(const char *psz) const { return psz; }
 542     const char* cWX2MB(const char *psz) const { return psz; }
 543 };
 544
 545 #define wxConvFile wxConvLocal
 546
 547 extern WXDLLIMPEXP_DATA_BASE(wxMBConv) wxConvLibc,
 548                                        wxConvLocal,
 549                                        wxConvISO8859_1,
 550                                        wxConvUTF8;
 551 extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvCurrent;
 552
 553 #define wxFNCONV(name) name
 554 #define wxFNSTRINGCAST WXSTRINGCAST
 555
 556 #endif
 557   // wxUSE_WCHAR_T
 558
 559 // ----------------------------------------------------------------------------
 560 // macros for the most common conversions
 561 // ----------------------------------------------------------------------------
 562
 563 #if wxUSE_UNICODE
 564     #define wxConvertWX2MB(s)   wxConvCurrent->cWX2MB(s)
 565     #define wxConvertMB2WX(s)   wxConvCurrent->cMB2WX(s)
 566
 567     // these functions should be used when the conversions really, really have
 568     // to succeed (usually because we pass their results to a standard C
 569     // function which would crash if we passed NULL to it), so these functions
 570     // always return a valid pointer if their argument is non-NULL
 571
 572     // this function safety is achieved by trying wxConvLibc first, wxConvUTF8
 573     // next if it fails and, finally, wxConvISO8859_1 which always succeeds
 574     extern WXDLLIMPEXP_BASE wxWCharBuffer wxSafeConvertMB2WX(const char *s);
 575
 576     // this function uses wxConvLibc and wxConvUTF8(MAP_INVALID_UTF8_TO_OCTAL)
 577     // if it fails
 578     extern WXDLLIMPEXP_BASE wxCharBuffer wxSafeConvertWX2MB(const wchar_t *ws);
 579 #else // ANSI
 580     // no conversions to do
 581     #define wxConvertWX2MB(s)   (s)
 582     #define wxConvertMB2WX(s)   (s)
 583     #define wxSafeConvertMB2WX(s) (s)
 584     #define wxSafeConvertWX2MB(s) (s)
 585 #endif // Unicode/ANSI
 586
 587 #endif // _WX_STRCONV_H_
 588