include/wx/wxchar.h

   1 /*
   2  * Name:        wx/wxchar.h
   3  * Purpose:     Declarations common to wx char/wchar_t usage (wide chars)
   4  * Author:      Joel Farley, Ove Kåven
   5  * Modified by: Vadim Zeitlin, Robert Roebling, Ron Lee
   6  * Created:     1998/06/12
   7  * RCS-ID:      $Id$
   8  * Copyright:   (c) 1998-2002 wxWidgets dev team
   9  * Licence:     wxWindows licence
  10  */
  11
  12 /* THIS IS A C FILE, DON'T USE C++ FEATURES (IN PARTICULAR COMMENTS) IN IT */
  13
  14 #ifndef _WX_WXCHAR_H_
  15 #define _WX_WXCHAR_H_
  16
  17 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  18     #pragma interface "wxchar.h"
  19 #endif
  20
  21 #include "wx/defs.h"        /* for wxUSE_UNICODE */
  22
  23 /* check whether we have wchar_t and which size it is if we do */
  24 #if !defined(wxUSE_WCHAR_T)
  25     #if defined(__UNIX__)
  26         #if defined(HAVE_WCSTR_H) || defined(HAVE_WCHAR_H) || defined(__FreeBSD__) || defined(__DARWIN__)
  27             #define wxUSE_WCHAR_T 1
  28         #else
  29             #define wxUSE_WCHAR_T 0
  30         #endif
  31     #elif defined(__GNUWIN32__) && !defined(__MINGW32__)
  32         #define wxUSE_WCHAR_T 0
  33     #elif defined(__WATCOMC__)
  34         #define wxUSE_WCHAR_T 0
  35     #elif defined(__VISAGECPP__) && (__IBMCPP__ < 400)
  36         #define wxUSE_WCHAR_T 0
  37     #else
  38         /* add additional compiler checks if this fails */
  39         #define wxUSE_WCHAR_T 1
  40     #endif
  41 #endif /* !defined(wxUSE_WCHAR_T) */
  42
  43 /* Unicode support requires wchar_t */
  44 #if wxUSE_UNICODE && !wxUSE_WCHAR_T
  45     #error "wchar_t must be available in Unicode build"
  46 #endif /* Unicode */
  47
  48 /*
  49     Standard headers we need here.
  50
  51     NB: don't include any wxWidgets headers here because almost of them include
  52         this one!
  53  */
  54
  55 /* Required for wxPrintf() etc */
  56 #include <stdarg.h>
  57
  58 /* Almost all compiler have strdup(), but not quite all: CodeWarrior under Mac */
  59 /* and VC++ for Windows CE don't provide it */
  60 #if !(defined(__MWERKS__) && defined(__WXMAC__)) && !defined(__WXWINCE__)
  61     /* use #define, not inline wrapper, as it is tested with #ifndef below */
  62     #define wxStrdupA strdup
  63 #endif
  64
  65 /*
  66    non Unix compilers which do have wchar.h (but not tchar.h which is included
  67    below and which includes wchar.h anyhow).
  68
  69    Actually MinGW has tchar.h, but it does not include wchar.h
  70  */
  71 #if defined(__MWERKS__) || defined(__VISAGECPP__) || defined(__MINGW32__) || defined(__WATCOMC__)
  72     #ifndef HAVE_WCHAR_H
  73         #define HAVE_WCHAR_H
  74     #endif
  75 #endif
  76 #if defined(__MWERKS__) && !defined(__MACH__)
  77     #ifndef HAVE_WCSLEN
  78         #define HAVE_WCSLEN
  79     #endif
  80 #endif
  81
  82 #if wxUSE_WCHAR_T
  83     #ifdef HAVE_WCHAR_H
  84         /* the current (as of Nov 2002) version of cygwin has a bug in its */
  85         /* wchar.h -- there is no extern "C" around the declarations in it and */
  86         /* this results in linking errors later; also, at least on some */
  87         /* Cygwin versions, wchar.h requires sys/types.h */
  88         #ifdef __CYGWIN__
  89             #include <sys/types.h>
  90             extern "C" {
  91         #endif /* Cygwin */
  92                 #include <wchar.h>
  93         #ifdef __CYGWIN__
  94             }
  95         #endif /* Cygwin */
  96     #elif defined(HAVE_WCSTR_H)
  97         /* old compilers have relevant declarations here */
  98         #include <wcstr.h>
  99     #elif defined(__FreeBSD__) || defined(__DARWIN__) || defined(__EMX__)
 100         /* include stdlib.h for wchar_t */
 101         #include <stdlib.h>
 102     #endif /* HAVE_WCHAR_H */
 103 #endif /* wxUSE_WCHAR_T */
 104
 105 /* ---------------------------------------------------------------------------- */
 106 /* define wxHAVE_TCHAR_SUPPORT for the compilers which support the TCHAR type */
 107 /* mapped to either char or wchar_t depending on the ASCII/Unicode mode and have */
 108 /* the function mapping _tfoo() -> foo() or wfoo() */
 109 /* ---------------------------------------------------------------------------- */
 110
 111 /* VC++ and BC++ starting with 5.2 have TCHAR support */
 112 #ifdef __VISUALC__
 113     #define wxHAVE_TCHAR_SUPPORT
 114 #elif defined(__BORLANDC__) && (__BORLANDC__ >= 0x520)
 115     #define wxHAVE_TCHAR_SUPPORT
 116     #include <ctype.h>
 117 #elif defined(__WATCOMC__)
 118     #define wxHAVE_TCHAR_SUPPORT
 119 #elif defined(__DMC__)
 120     #define wxHAVE_TCHAR_SUPPORT
 121 #elif defined(__MINGW32__) && wxCHECK_W32API_VERSION( 1, 0 )
 122     #define wxHAVE_TCHAR_SUPPORT
 123     #include <stddef.h>
 124     #include <string.h>
 125     #include <ctype.h>
 126 #elif 0 && defined(__VISAGECPP__) && (__IBMCPP__ >= 400)
 127     /* VZ: the old VisualAge definitions were completely wrong and had no */
 128     /*     chance at all to work in Unicode build anyhow so let's pretend that */
 129     /*     VisualAge does _not_ support TCHAR for the moment (as indicated by */
 130     /*     "0 &&" above) until someone really has time to delve into Unicode */
 131     /*     issues under OS/2 */
 132
 133     /* VisualAge 4.0+ supports TCHAR */
 134     #define wxHAVE_TCHAR_SUPPORT
 135 #endif /* compilers with (good) TCHAR support */
 136
 137 #ifdef __MWERKS__
 138     #define HAVE_WPRINTF
 139 #endif
 140
 141 #ifdef wxHAVE_TCHAR_SUPPORT
 142     /* get TCHAR definition if we've got it */
 143     #include <tchar.h>
 144
 145     /* we surely do have wchar_t if we have TCHAR */
 146     #ifndef wxUSE_WCHAR_T
 147         #define wxUSE_WCHAR_T 1
 148     #endif /* !defined(wxUSE_WCHAR_T) */
 149
 150     /* and we also do have wcslen() */
 151     #ifndef HAVE_WCSLEN
 152         #define HAVE_WCSLEN
 153     #endif
 154 #endif /* wxHAVE_TCHAR_SUPPORT */
 155
 156 /* ---------------------------------------------------------------------------- */
 157 /* define wxChar type */
 158 /* ---------------------------------------------------------------------------- */
 159
 160 /* TODO: define wxCharInt to be equal to either int or wint_t? */
 161
 162 #if !wxUSE_UNICODE
 163     typedef char wxChar;
 164     typedef signed char wxSChar;
 165     typedef unsigned char wxUChar;
 166 #else /* Unicode */
 167     /* VZ: note that VC++ defines _T[SU]CHAR simply as wchar_t and not as */
 168     /*     signed/unsigned version of it which (a) makes sense to me (unlike */
 169     /*     char wchar_t is always unsigned) and (b) was how the previous */
 170     /*     definitions worked so keep it like this */
 171
 172     /* GNU libc has __WCHAR_TYPE__ which requires special treatment, see */
 173     /* comment below */
 174     #if !defined(__WCHAR_TYPE__) || \
 175         (!defined(__GNUC__) || wxCHECK_GCC_VERSION(2, 96))
 176         /* standard case */
 177         typedef wchar_t wxChar;
 178         typedef wchar_t wxSChar;
 179         typedef wchar_t wxUChar;
 180     #else /* __WCHAR_TYPE__ and gcc < 2.96 */
 181         /* VS: wxWidgets used to define wxChar as __WCHAR_TYPE__ here. However, */
 182         /*     this doesn't work with new GCC 3.x compilers because wchar_t is */
 183         /*     C++'s builtin type in the new standard. OTOH, old compilers (GCC */
 184         /*     2.x) won't accept new definition of wx{S,U}Char, therefore we */
 185         /*     have to define wxChar conditionally depending on detected */
 186         /*     compiler & compiler version. */
 187         /*     with old definition of wxChar. */
 188         typedef __WCHAR_TYPE__ wxChar;
 189         typedef __WCHAR_TYPE__ wxSChar;
 190         typedef __WCHAR_TYPE__ wxUChar;
 191     #endif /* __WCHAR_TYPE__ */
 192 #endif /* ASCII/Unicode */
 193
 194 /* ---------------------------------------------------------------------------- */
 195 /* define _T() and related macros */
 196 /* ---------------------------------------------------------------------------- */
 197
 198 /* BSD systems define _T() to be something different in ctype.h, override it */
 199 #if defined(__FreeBSD__) || defined(__DARWIN__)
 200     #include <ctype.h>
 201     #undef _T
 202 #endif
 203
 204 /* could already be defined by tchar.h (it's quasi standard) */
 205 #ifndef _T
 206     #if !wxUSE_UNICODE
 207         #define _T(x) x
 208     #else /* Unicode */
 209         #define _T(x) L ## x
 210     #endif /* ASCII/Unicode */
 211 #endif /* !defined(_T) */
 212
 213 /* although global macros with such names are normally bad, we want to have */
 214 /* another name for _T() which should be used to avoid confusion between _T() */
 215 /* and _() in wxWidgets sources */
 216 #define wxT(x)       _T(x)
 217
 218 /* Unicode-friendly __FILE__, __DATE__ and __TIME__ analogs */
 219 #ifndef __TFILE__
 220     #define __XFILE__(x) wxT(x)
 221     #define __TFILE__ __XFILE__(__FILE__)
 222 #endif
 223
 224 #ifndef __TDATE__
 225     #define __XDATE__(x) wxT(x)
 226     #define __TDATE__ __XDATE__(__DATE__)
 227 #endif
 228
 229 #ifndef __TTIME__
 230     #define __XTIME__(x) wxT(x)
 231     #define __TTIME__ __XTIME__(__TIME__)
 232 #endif
 233
 234 /*
 235     define wxFoo() function for each standard foo() function whose signature
 236     (exceptionally including the return type) includes any mention of char:
 237     wxFoo() is going to be a Unicode-friendly version of foo(), i.e. will have
 238     the same signature but with char replaced by wxChar which allows us to use
 239     it in Unicode build as well
 240  */
 241
 242 #ifdef wxHAVE_TCHAR_SUPPORT
 243     #include <ctype.h>
 244
 245     /* ctype.h functions */
 246     #define  wxIsalnum   _istalnum
 247     #define  wxIsalpha   _istalpha
 248     #define  wxIscntrl   _istcntrl
 249     #define  wxIsdigit   _istdigit
 250     #define  wxIsgraph   _istgraph
 251     #define  wxIslower   _istlower
 252     #define  wxIsprint   _istprint
 253     #define  wxIspunct   _istpunct
 254     #define  wxIsspace   _istspace
 255     #define  wxIsupper   _istupper
 256     #define  wxIsxdigit  _istxdigit
 257
 258     /*
 259        There is a bug in VC6 C RTL: toxxx() functions dosn't do anything with
 260        signed chars < 0, so "fix" it here.
 261      */
 262     #define  wxTolower(c) _totlower((wxUChar)(c))
 263     #define  wxToupper(c) _totupper((wxUChar)(c))
 264
 265     /* locale.h functons */
 266     #define  wxSetlocale _tsetlocale
 267
 268     /* string.h functions */
 269     #define  wxStrcat    _tcscat
 270     #define  wxStrchr    _tcschr
 271     #define  wxStrcmp    _tcscmp
 272     #define  wxStrcoll   _tcscoll
 273     #define  wxStrcpy    _tcscpy
 274     #define  wxStrcspn   _tcscspn
 275     #define  wxStrdupW   _wcsdup        /* notice the 'W'! */
 276     #define  wxStrftime  _tcsftime
 277     #define  wxStricmp   _tcsicmp
 278     #define  wxStrnicmp  _tcsnicmp
 279     #define  wxStrlen_   _tcslen        /* used in wxStrlen inline function */
 280     #define  wxStrncat   _tcsncat
 281     #define  wxStrncmp   _tcsncmp
 282     #define  wxStrncpy   _tcsncpy
 283     #define  wxStrpbrk   _tcspbrk
 284     #define  wxStrrchr   _tcsrchr
 285     #define  wxStrspn    _tcsspn
 286     #define  wxStrstr    _tcsstr
 287     #define  wxStrtod    _tcstod
 288     #define  wxStrtol    _tcstol
 289     #define  wxStrtoul   _tcstoul
 290     #define  wxStrxfrm   _tcsxfrm
 291
 292     /* stdio.h functions */
 293     #define  wxFgetc     _fgettc
 294     #define  wxFgetchar  _fgettchar
 295     #define  wxFgets     _fgetts
 296     #define  wxFopen     _tfopen
 297     #define  wxFputc     _fputtc
 298     #define  wxFputchar  _fputtchar
 299     #define  wxFprintf   _ftprintf
 300     #define  wxFputs     _fputts
 301     #define  wxFreopen   _tfreopen
 302     #define  wxFscanf    _ftscanf
 303     #define  wxGetc      _gettc
 304     #define  wxGetchar   _gettchar
 305     #define  wxGets      _getts
 306     #define  wxPerror    _tperror
 307     #define  wxPrintf    _tprintf
 308     #define  wxPutc      _puttc
 309     #define  wxPutchar   _puttchar
 310     #define  wxPuts      _putts
 311     #define  wxScanf     _tscanf
 312     #if defined(__DMC__)
 313         #if wxUSE_UNICODE
 314             /* Digital Mars adds count to _stprintf (C99) so prototype conversion see wxchar.cpp */
 315             int wxSprintf (wchar_t * __RESTRICT s, const wchar_t * __RESTRICT format, ... ) ;
 316         #else
 317             /* and there is a bug in D Mars tchar.h prior to 8.39.4n, so define as sprintf */
 318             #define wxSprintf sprintf
 319         #endif
 320     #else
 321         #define  wxSprintf   _stprintf
 322     #endif
 323
 324     #define  wxSscanf    _stscanf
 325     #define  wxTmpnam    _ttmpnam
 326     #define  wxUngetc    _tungetc
 327     #define  wxVfprintf  _vftprintf
 328     #define  wxVprintf   _vtprintf
 329     #define  wxVsscanf   _vstscanf
 330     #define  wxVsprintf  _vstprintf
 331
 332     /* special case: not all TCHAR-aware compilers have those */
 333     #if defined(__VISUALC__) || \
 334             (defined(__BORLANDC__) && __BORLANDC__ >= 0x540)
 335         #define wxVsnprintf_    _vsntprintf
 336         #define wxSnprintf_     _sntprintf
 337     #endif
 338
 339     /* special case: these functions are missing under Win9x with Unicows so we */
 340     /* have to implement them ourselves */
 341     #if wxUSE_UNICODE_MSLU
 342         #define  wxRemove    wxMSLU__tremove
 343         #define  wxRename    wxMSLU__trename
 344     #else
 345         #ifdef __WXWINCE__
 346             #define  wxRemove    DeleteFile
 347         #else
 348             #define  wxRemove    _tremove
 349             #define  wxRename    _trename
 350         #endif
 351     #endif
 352
 353     /* stdlib.h functions */
 354     #define  wxAtoi      _ttoi
 355     #define  wxAtol      _ttol
 356     /* #define  wxAtof   _tttof -- notice that there is no such thing (why?) */
 357     #define  wxGetenv    _tgetenv
 358     #define  wxSystem    _tsystem
 359
 360     /* time.h functions */
 361     #define  wxAsctime   _tasctime
 362     #define  wxCtime     _tctime
 363 #else /* !TCHAR-aware compilers */
 364     #if wxUSE_UNICODE
 365         #include <wctype.h>
 366
 367         /* this is probably glibc-specific */
 368         #if defined(__WCHAR_TYPE__) && !defined(__MWERKS__)
 369             /* ctype.h functions (wctype.h) */
 370             #define  wxIsalnum   iswalnum
 371             #define  wxIsalpha   iswalpha
 372             #define  wxIscntrl   iswcntrl
 373             #define  wxIsdigit   iswdigit
 374             #define  wxIsgraph   iswgraph
 375             #define  wxIslower   iswlower
 376             #define  wxIsprint   iswprint
 377             #define  wxIspunct   iswpunct
 378             #define  wxIsspace   iswspace
 379             #define  wxIsupper   iswupper
 380             #define  wxIsxdigit  iswxdigit
 381
 382             #if defined(__GLIBC__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ == 0)
 383                 /* /usr/include/wctype.h incorrectly declares translations */
 384                 /* tables which provokes tons of compile-time warnings -- try */
 385                 /* to correct this */
 386                 #define  wxTolower(wc)   towctrans((wc), (wctrans_t)__ctype_tolower)
 387                 #define  wxToupper(wc)   towctrans((wc), (wctrans_t)__ctype_toupper)
 388             #else /* !glibc 2.0 */
 389                 #define  wxTolower   towlower
 390                 #define  wxToupper   towupper
 391             #endif /* gcc/!gcc */
 392
 393             /* string.h functions (wchar.h) */
 394             #define  wxStrcat    wcscat
 395             #define  wxStrchr    wcschr
 396             #define  wxStrcmp    wcscmp
 397             #define  wxStrcoll   wcscoll
 398             #define  wxStrcpy    wcscpy
 399             #define  wxStrcspn   wcscspn
 400             #define  wxStrlen_   wxWcslen /* wxStrlen_() is used in wxStrlen() */
 401             #define  wxStrncat   wcsncat
 402             #define  wxStrncmp   wcsncmp
 403             #define  wxStrncpy   wcsncpy
 404             #define  wxStrpbrk   wcspbrk
 405             #define  wxStrrchr   wcsrchr
 406             #define  wxStrspn    wcsspn
 407             #define  wxStrstr    wcsstr
 408             #define  wxStrtod    wcstod
 409             #define  wxStrtol    wcstol
 410             #define  wxStrtoul   wcstoul
 411             #define  wxStrxfrm   wcsxfrm
 412
 413             #define  wxFgetc     fgetwc
 414             #define  wxFgetchar  fgetwchar
 415             #define  wxFgets     fgetws
 416             #define  wxFputc     fputwc
 417             #define  wxFputchar  fputwchar
 418             #define  wxGetc      getwc
 419             #define  wxGetchar   getwchar
 420             #define  wxGets      getws
 421             #define  wxUngetc    ungetwc
 422
 423             #ifdef HAVE_FPUTWS
 424                 #define wxFputs     fputws
 425             #else
 426                 #define wxNEED_FPUTS
 427                 #include <stdio.h>
 428                 int wxFputs(const wxChar *ch, FILE *stream);
 429             #endif
 430
 431             #ifdef HAVE_WPUTC
 432                 #define wxPutc      wputc
 433             #else
 434                 #define wxNEED_PUTC
 435                 #include <stdio.h>
 436                 int wxPutc(wxChar ch, FILE *stream);
 437             #endif
 438
 439             #ifdef HAVE_WPUTCHAR
 440                 #define wxPutchar   wputchar
 441             #else
 442                 #define wxPutchar(wch) wxPutc(wch, stdout)
 443             #endif
 444
 445             #ifdef HAVE_PUTWS
 446                 #define wxPuts      putws
 447             #else
 448                 #define wxPuts(ws) wxFputs(ws, stdout)
 449             #endif
 450
 451             /* we need %s to %ls conversion for printf and scanf etc */
 452             #define wxNEED_PRINTF_CONVERSION
 453
 454             /* glibc doesn't have wide char equivalents of the other stuff so */
 455             /* use our own versions */
 456             #define wxNEED_WX_STDIO_H
 457             #define wxNEED_WX_STDLIB_H
 458             #define wxNEED_WX_TIME_H
 459         #elif defined(__MWERKS__) && ( defined(__MSL__) || defined(__MACH__) )
 460             /* ctype.h functions (wctype.h) */
 461             #define  wxIsalnum   iswalnum
 462             #define  wxIsalpha   iswalpha
 463             #define  wxIscntrl   iswcntrl
 464             #define  wxIsdigit   iswdigit
 465             #define  wxIsgraph   iswgraph
 466             #define  wxIslower   iswlower
 467             #define  wxIsprint   iswprint
 468             #define  wxIspunct   iswpunct
 469             #define  wxIsspace   iswspace
 470             #define  wxIsupper   iswupper
 471             #define  wxIsxdigit  iswxdigit
 472             #define  wxTolower   towlower
 473             #define  wxToupper   towupper
 474
 475             /* string.h functions (wchar.h) */
 476             #define  wxStrcat    wcscat
 477             #define  wxStrchr    wcschr
 478             #define  wxStrcmp    wcscmp
 479             #define  wxStrcoll   wcscoll
 480             #define  wxStrcpy    wcscpy
 481             #define  wxStrcspn   wcscspn
 482             #define  wxStrlen_   wxWcslen /* wxStrlen_() is used in wxStrlen() */
 483             #define  wxStrncat   wcsncat
 484             #define  wxStrncmp   wcsncmp
 485             #define  wxStrncpy   wcsncpy
 486             #define  wxStrpbrk   wcspbrk
 487             #define  wxStrrchr   wcsrchr
 488             #define  wxStrspn    wcsspn
 489             #define  wxStrstr    wcsstr
 490             #define  wxStrtod    wcstod
 491             #define  wxStrtol    wcstol
 492             #define  wxStrtoul   wcstoul
 493             #define  wxStrxfrm   wcsxfrm
 494
 495             #define  wxFgetc     fgetwc
 496             #define  wxFgetchar  fgetwchar
 497             #define  wxFgets     fgetws
 498             #define  wxFputc     fputwc
 499             #define  wxFputchar  fputwchar
 500             #define  wxGetc      getwc
 501             #define  wxGetchar   getwchar
 502             #define  wxGets      getws
 503             #define  wxUngetc    ungetwc
 504
 505             #define wxNEED_PRINTF_CONVERSION
 506
 507             #define  wxPutc      putwc
 508             #define  wxPutchar   putwchar
 509             #define  wxFputs     fputws
 510
 511             /* stdio.h functions */
 512
 513             #define wxNEED_WX_STDIO_H
 514
 515             /* stdlib.h functions */
 516             #ifdef __MACH__
 517             #define wxNEED_WX_STDLIB_H
 518             #else
 519             #define  wxAtof      watof
 520             #define  wxAtoi      watoi
 521             #define  wxAtol      watol
 522             #define  wxGetenv(a)    ((wxChar*)NULL)
 523             #define  wxSystem(a)    ((int)NULL)
 524             #endif
 525             /* time.h functions */
 526             #define  wxAsctime   wasciitime
 527             #define  wxCtime     wctime
 528             /* #define  wxStrftime  wcsftime */
 529
 530             #define wxNEED_WX_TIME_H
 531         #else /* !metrowerks for apple */
 532             #error  "Please define wide character functions for your environment"
 533         #endif
 534     #else /* ASCII */
 535         #include <ctype.h>
 536         #include <string.h>
 537
 538         /* ctype.h functions */
 539         #define  wxIsalnum   isalnum
 540         #define  wxIsalpha   isalpha
 541         #define  wxIscntrl   iscntrl
 542         #define  wxIsdigit   isdigit
 543         #define  wxIsgraph   isgraph
 544         #define  wxIslower   islower
 545         #define  wxIsprint   isprint
 546         #define  wxIspunct   ispunct
 547         #define  wxIsspace   isspace
 548         #define  wxIsupper   isupper
 549         #define  wxIsxdigit  isxdigit
 550         #define  wxTolower   tolower
 551         #define  wxToupper   toupper
 552
 553          /* locale.h functons */
 554         #define  wxSetlocale setlocale
 555
 556          /* string.h functions */
 557         #define  wxStrcat    strcat
 558         #define  wxStrchr    strchr
 559         #define  wxStrcmp    strcmp
 560         #define  wxStrcoll   strcoll
 561         #define  wxStrcpy    strcpy
 562         #define  wxStrcspn   strcspn
 563
 564         /* wxStricmp and wxStrnicmp are defined below */
 565         #define  wxStrlen_   strlen /* used in wxStrlen inline function */
 566         #define  wxStrncat   strncat
 567         #define  wxStrncmp   strncmp
 568         #define  wxStrncpy   strncpy
 569         #define  wxStrpbrk   strpbrk
 570         #define  wxStrrchr   strrchr
 571         #define  wxStrspn    strspn
 572         #define  wxStrstr    strstr
 573         #define  wxStrtod    strtod
 574         #ifdef HAVE_STRTOK_R
 575             #define  wxStrtok(str, sep, last)    strtok_r(str, sep, last)
 576         #endif
 577         #define  wxStrtol    strtol
 578         #define  wxStrtoul   strtoul
 579         #define  wxStrxfrm   strxfrm
 580
 581         /* stdio.h functions */
 582         #define  wxFopen     fopen
 583         #define  wxFreopen   freopen
 584         #define  wxRemove    remove
 585         #define  wxRename    rename
 586
 587         #define  wxPerror    perror
 588         #define  wxTmpnam    tmpnam
 589
 590         #define  wxFgetc     fgetc
 591         #define  wxFgetchar  fgetchar
 592         #define  wxFgets     fgets
 593         #define  wxFputc     fputc
 594         #define  wxFputs     fputs
 595         #define  wxFputchar  fputchar
 596         #define  wxFprintf   fprintf
 597         #define  wxFscanf    fscanf
 598         #define  wxGetc      getc
 599         #define  wxGetchar   getchar
 600         #define  wxGets      gets
 601         #define  wxPrintf    printf
 602         #define  wxPutc      putc
 603         #define  wxPutchar   putchar
 604         #define  wxPuts      puts
 605         #define  wxScanf     scanf
 606         #define  wxSprintf   sprintf
 607         #define  wxSscanf    sscanf
 608         #define  wxUngetc    ungetc
 609         #define  wxVfprintf  vfprintf
 610         #define  wxVprintf   vprintf
 611         #define  wxVsscanf   vsscanf
 612         #define  wxVsprintf  vsprintf
 613
 614         /* stdlib.h functions */
 615         #define  wxAtof      atof
 616         #define  wxAtoi      atoi
 617         #define  wxAtol      atol
 618         #define  wxGetenv    getenv
 619         #define  wxSystem    system
 620
 621         /* time.h functions */
 622         #define  wxAsctime   asctime
 623         #define  wxCtime     ctime
 624         #define  wxStrftime  strftime
 625     #endif /* Unicode/ASCII */
 626 #endif /* TCHAR-aware compilers/the others */
 627
 628 /*
 629     various special cases
 630  */
 631
 632 /* define wxStricmp and wxStrnicmp for various compilers */
 633
 634 /* note that in Unicode mode we definitely are going to need our own version */
 635 #if !defined(wxStricmp) && !wxUSE_UNICODE
 636     #if defined(__BORLANDC__) || defined(__WATCOMC__) || \
 637             defined(__SALFORDC__) || defined(__VISAGECPP__) || \
 638             defined(__EMX__) || defined(__DJGPP__)
 639         #define wxStricmp stricmp
 640         #define wxStrnicmp strnicmp
 641     #elif defined(__SYMANTEC__) || defined(__VISUALC__) || \
 642             (defined(__MWERKS__) && defined(__INTEL__))
 643         #define wxStricmp _stricmp
 644         #define wxStrnicmp _strnicmp
 645     #elif defined(__UNIX__) || defined(__GNUWIN32__)
 646         #define wxStricmp strcasecmp
 647         #define wxStrnicmp strncasecmp
 648     /* #else -- use wxWidgets implementation */
 649     #endif
 650 #endif /* !defined(wxStricmp) */
 651
 652 /* define wxWcslen() which should be always available if wxUSE_WCHAR_T == 1 (as */
 653 /* it's used in wx/buffer.h -- and also might be used just below by wxStrlen() */
 654 /* when wxStrlen_() is #define'd as wxWcslen so do it before defining wxStrlen) */
 655 #if wxUSE_WCHAR_T
 656     #ifdef HAVE_WCSLEN
 657         #define wxWcslen wcslen
 658     #else
 659     #if defined( __WXMAC_XCODE__ ) && !defined( __cplusplus )
 660     /* xcode native targets are giving multiply defined symbols on regex */
 661         static
 662     #endif
 663         inline size_t wxWcslen(const wchar_t *s)
 664         {
 665             size_t n = 0;
 666             while ( *s++ )
 667                 n++;
 668
 669             return n;
 670         }
 671     #endif
 672 #endif /* wxUSE_WCHAR_T */
 673
 674 #ifdef __cplusplus
 675 /* checks whether the passed in pointer is NULL and if the string is empty */
 676 inline bool wxIsEmpty(const wxChar *p) { return !p || !*p; }
 677
 678 /* safe version of strlen() (returns 0 if passed NULL pointer) */
 679 inline size_t wxStrlen(const wxChar *psz) { return psz ? wxStrlen_(psz) : 0; }
 680 #endif
 681
 682 /*
 683     each of strdup() and wcsdup() may or may not be available but we need both
 684     of them anyhow for wx/buffer.h so we define the missing one(s) in
 685     wxchar.cpp and so we should always have both wxStrdupA and wxStrdupW
 686     defined -- if this is somehow not the case in some situations, please
 687     correct that and not the lines here
 688  */
 689 #if wxUSE_UNICODE
 690     #define wxStrdup wxStrdupW
 691 #else
 692     #define wxStrdup wxStrdupA
 693 #endif
 694
 695 #ifdef __cplusplus
 696 WXDLLIMPEXP_BASE bool wxOKlibc(); /* for internal use */
 697 #endif
 698
 699 /* printf() family saga */
 700
 701 /*
 702    For some systems vsnprintf() exists in the system libraries but not in the
 703    headers, so we need to declare it ourselves to be able to use it.
 704  */
 705 #if defined(HAVE_VSNPRINTF) && !defined(HAVE_VSNPRINTF_DECL)
 706     extern "C"
 707     int vsnprintf(char *str, size_t size, const char *format, va_list ap);
 708 #endif /* !HAVE_VSNPRINTF_DECL */
 709
 710 /*
 711    First of all, we always want to define safe snprintf() function to be used
 712    instead of sprintf(). Some compilers already have it (or rather vsnprintf()
 713    which we really need...), otherwise we implement it using our own printf()
 714    code.
 715
 716    We define function with a trailing underscore here because the real one is a
 717    wrapper around it as explained below
 718  */
 719 #ifndef wxVsnprintf_
 720     #if wxUSE_UNICODE
 721         #if defined(__MWERKS__)
 722             #define HAVE_WCSRTOMBS 1
 723             #define HAVE_VSWPRINTF 1
 724         #endif
 725         #if defined(__WATCOMC__)
 726             #define wxVsnprintf_    _vsnwprintf
 727             #define wxSnprintf_     _snwprintf
 728         #endif
 729         #if defined(HAVE__VSNWPRINTF)
 730             #define wxVsnprintf_    _vsnwprintf
 731         /* MinGW?MSVCRT has the wrong vswprintf */
 732         #elif defined(HAVE_VSWPRINTF) && !defined(__MINGW32__)
 733             #define wxVsnprintf_    vswprintf
 734         #endif
 735     #else /* ASCII */
 736         /* all versions of CodeWarrior supported by wxWidgets apparently have */
 737         /* vsnprintf() */
 738         #if defined(HAVE_VSNPRINTF) || defined(__MWERKS__) || defined(__WATCOMC__)
 739             /* assume we have snprintf() too if we have vsnprintf() */
 740             #define wxVsnprintf_    vsnprintf
 741             #define wxSnprintf_     snprintf
 742         #endif
 743     #endif
 744 #endif /* wxVsnprintf_ not defined yet */
 745
 746 #ifndef wxSnprintf_
 747     /* no [v]snprintf(), cook our own */
 748     WXDLLIMPEXP_BASE int wxSnprintf_(wxChar *buf, size_t len, const wxChar *format,
 749                                 ...) ATTRIBUTE_PRINTF_3;
 750 #endif
 751 #ifndef wxVsnprintf_
 752     WXDLLIMPEXP_BASE int wxVsnprintf_(wxChar *buf, size_t len, const wxChar *format,
 753                                  va_list argptr);
 754 #endif
 755
 756 /*
 757    In Unicode mode we need to have all standard functions such as wprintf() and
 758    so on but not all systems have them so use our own implementations in this
 759    case.
 760  */
 761 #if wxUSE_UNICODE && !defined(wxHAVE_TCHAR_SUPPORT) && !defined(HAVE_WPRINTF)
 762     #define wxNEED_WPRINTF
 763 #endif
 764
 765 /*
 766    More Unicode complications: although both ANSI C and C++ define a number of
 767    wide character functions such as wprintf(), not all environments have them.
 768    Worse, those which do have different behaviours: under Windows, %s format
 769    specifier changes its meaning in Unicode build and expects a Unicode string
 770    while under Unix/POSIX it still means an ASCII string even for wprintf() and
 771    %ls has to be used for wide strings.
 772
 773    We choose to always emulate Windows behaviour as more useful for us so even
 774    if we have wprintf() we still must wrap it in a non trivial wxPrintf().
 775
 776 */
 777
 778 #if defined(wxNEED_PRINTF_CONVERSION) || defined(wxNEED_WPRINTF)
 779     /*
 780         we need to implement all wide character printf and scanf functions
 781         either because we don't have them at all or because they don't have the
 782         semantics we need
 783      */
 784
 785     #include <stdio.h>  /* for FILE */
 786
 787     int wxScanf( const wxChar *format, ... ) ATTRIBUTE_PRINTF_1;
 788     int wxSscanf( const wxChar *str, const wxChar *format, ... ) ATTRIBUTE_PRINTF_2;
 789     int wxFscanf( FILE *stream, const wxChar *format, ... ) ATTRIBUTE_PRINTF_2;
 790     int wxVsscanf( const wxChar *str, const wxChar *format, va_list ap );
 791     int wxPrintf( const wxChar *format, ... ) ATTRIBUTE_PRINTF_1;
 792     int wxSprintf( wxChar *str, const wxChar *format, ... ) ATTRIBUTE_PRINTF_2;
 793     int wxFprintf( FILE *stream, const wxChar *format, ... ) ATTRIBUTE_PRINTF_2;
 794     int wxVfprintf( FILE *stream, const wxChar *format, va_list ap );
 795     int wxVprintf( const wxChar *format, va_list ap );
 796     int wxVsprintf( wxChar *str, const wxChar *format, va_list ap );
 797 #endif /* wxNEED_PRINTF_CONVERSION */
 798
 799 /* these 2 can be simply mapped to the versions with underscore at the end */
 800 /* if we don't have to do the conversion */
 801 /*
 802    However, if we don't have any vswprintf() at all we don't need to redefine
 803    anything as our own wxVsnprintf_() already behaves as needed.
 804 */
 805 #if defined(wxNEED_PRINTF_CONVERSION) && defined(wxVsnprintf_)
 806     int wxSnprintf( wxChar *str, size_t size, const wxChar *format, ... ) ATTRIBUTE_PRINTF_3;
 807     int wxVsnprintf( wxChar *str, size_t size, const wxChar *format, va_list ap );
 808 #else
 809     #define wxSnprintf wxSnprintf_
 810     #define wxVsnprintf wxVsnprintf_
 811 #endif
 812
 813 /*
 814     various functions which might not be available in libc and for which we
 815     provide our own replacements in wxchar.cpp
 816  */
 817
 818 /* ctype.h functions */
 819
 820 /* VZ: note that this is never defined currently */
 821 #ifdef wxNEED_WX_CTYPE_H
 822     WXDLLIMPEXP_BASE int wxIsalnum(wxChar ch);
 823     WXDLLIMPEXP_BASE int wxIsalpha(wxChar ch);
 824     WXDLLIMPEXP_BASE int wxIscntrl(wxChar ch);
 825     WXDLLIMPEXP_BASE int wxIsdigit(wxChar ch);
 826     WXDLLIMPEXP_BASE int wxIsgraph(wxChar ch);
 827     WXDLLIMPEXP_BASE int wxIslower(wxChar ch);
 828     WXDLLIMPEXP_BASE int wxIsprint(wxChar ch);
 829     WXDLLIMPEXP_BASE int wxIspunct(wxChar ch);
 830     WXDLLIMPEXP_BASE int wxIsspace(wxChar ch);
 831     WXDLLIMPEXP_BASE int wxIsupper(wxChar ch);
 832     WXDLLIMPEXP_BASE int wxIsxdigit(wxChar ch);
 833     WXDLLIMPEXP_BASE int wxTolower(wxChar ch);
 834     WXDLLIMPEXP_BASE int wxToupper(wxChar ch);
 835 #endif /* wxNEED_WX_CTYPE_H */
 836
 837 /* under VC++ 6.0 isspace() returns 1 for 8 bit chars which completely breaks */
 838 /* the file parsing -- this may be true for 5.0 as well, update #ifdef then */
 839 #if defined(__VISUALC__) && (__VISUALC__ >= 1200) && !wxUSE_UNICODE
 840     #undef wxIsspace
 841     #define wxIsspace(c) ((((unsigned)c) < 128) && isspace(c))
 842 #endif /* VC++ */
 843
 844 /*
 845    a few compilers don't have the (non standard but common) isascii function,
 846    define it ourselves for them
 847  */
 848 #ifndef isascii
 849     #if defined(__MWERKS__)
 850         #define wxNEED_ISASCII
 851     #elif defined(_WIN32_WCE)
 852         #if _WIN32_WCE <= 211
 853             #define wxNEED_ISASCII
 854         #endif
 855     #endif
 856 #endif /* isascii */
 857
 858 #ifdef wxNEED_ISASCII
 859     inline int isascii(int c) { return (unsigned)c < 0x80; }
 860 #endif
 861
 862 #ifdef _WIN32_WCE
 863     #if _WIN32_WCE <= 211
 864         #define isspace(c) ((c) == _T(' ') || (c) == _T('\t'))
 865     #endif
 866 #endif /* _WIN32_WCE */
 867
 868 /*
 869    we had goofed and defined wxIsctrl() instead of (correct) wxIscntrl() in the
 870    initial versions of this header -- now it is too late to remove it so
 871    although we fixed the function/macro name above, still provide the
 872    backwards-compatible synonym.
 873  */
 874 #define wxIsctrl wxIscntrl
 875
 876 /* string.h functions */
 877
 878 #ifndef strdup
 879     #if defined(__MWERKS__) && !defined(__MACH__) && (__MSL__ < 0x00008000)
 880         #define wxNEED_STRDUP
 881     #elif defined(__WXWINCE__)
 882         #if _WIN32_WCE <= 211
 883             #define wxNEED_STRDUP
 884         #endif
 885     #endif
 886 #endif /* strdup */
 887
 888 #ifdef wxNEED_STRDUP
 889     WXDLLIMPEXP_BASE char *strdup(const char* s);
 890 #endif
 891
 892 /* VZ: this is never defined neither currently */
 893 #ifdef wxNEED_WX_STRING_H
 894     WXDLLIMPEXP_BASE wxChar * wxStrcat(wxChar *dest, const wxChar *src);
 895     WXDLLIMPEXP_BASE const wxChar * wxStrchr(const wxChar *s, wxChar c);
 896     WXDLLIMPEXP_BASE wxChar * wxStrchr(wxChar *s, wxChar c)
 897         { return (wxChar *)wxStrchr((const wxChar *)s, c); }
 898     WXDLLIMPEXP_BASE int      wxStrcmp(const wxChar *s1, const wxChar *s2);
 899     WXDLLIMPEXP_BASE int      wxStrcoll(const wxChar *s1, const wxChar *s2);
 900     WXDLLIMPEXP_BASE wxChar * wxStrcpy(wxChar *dest, const wxChar *src);
 901     WXDLLIMPEXP_BASE size_t   wxStrcspn(const wxChar *s, const wxChar *reject);
 902     WXDLLIMPEXP_BASE size_t   wxStrlen(const wxChar *s);
 903     WXDLLIMPEXP_BASE wxChar * wxStrncat(wxChar *dest, const wxChar *src, size_t n);
 904     WXDLLIMPEXP_BASE int      wxStrncmp(const wxChar *s1, const wxChar *s2, size_t n);
 905     WXDLLIMPEXP_BASE wxChar * wxStrncpy(wxChar *dest, const wxChar *src, size_t n);
 906     WXDLLIMPEXP_BASE const wxChar * wxStrpbrk(const wxChar *s, const wxChar *accept);
 907     WXDLLIMPEXP_BASE wxChar * wxStrpbrk(wxChar *s, const wxChar *accept)
 908         { return (wxChar *)wxStrpbrk((const wxChar *)s, accept); }
 909     WXDLLIMPEXP_BASE const wxChar * wxStrrchr(const wxChar *s, wxChar c);
 910     WXDLLIMPEXP_BASE wxChar * wxStrrchr(wxChar *s, wxChar c)
 911         { return (wxChar *)wxStrrchr((const wxChar *)s, c); }
 912     WXDLLIMPEXP_BASE size_t   wxStrspn(const wxChar *s, const wxChar *accept);
 913     WXDLLIMPEXP_BASE const wxChar * wxStrstr(const wxChar *haystack, const wxChar *needle);
 914     WXDLLIMPEXP_BASE wxChar *wxStrstr(wxChar *haystack, const wxChar *needle)
 915         { return (wxChar *)wxStrstr((const wxChar *)haystack, needle); }
 916     WXDLLIMPEXP_BASE double   wxStrtod(const wxChar *nptr, wxChar **endptr);
 917     WXDLLIMPEXP_BASE long int wxStrtol(const wxChar *nptr, wxChar **endptr, int base);
 918     WXDLLIMPEXP_BASE unsigned long int wxStrtoul(const wxChar *nptr, wxChar **endptr, int base);
 919     WXDLLIMPEXP_BASE size_t   wxStrxfrm(wxChar *dest, const wxChar *src, size_t n);
 920 #endif /* wxNEED_WX_STRING_H */
 921
 922 #ifndef wxStrdupA
 923 WXDLLIMPEXP_BASE char *wxStrdupA(const char *psz);
 924 #endif
 925
 926 #ifndef wxStrdupW
 927 WXDLLIMPEXP_BASE wchar_t *wxStrdupW(const wchar_t *pwz);
 928 #endif
 929
 930 #ifndef wxStricmp
 931 WXDLLIMPEXP_BASE int wxStricmp(const wxChar *psz1, const wxChar *psz2);
 932 #endif
 933
 934 #ifndef wxStrnicmp
 935 WXDLLIMPEXP_BASE int wxStrnicmp(const wxChar *psz1, const wxChar *psz2, size_t len);
 936 #endif
 937
 938 #ifndef wxStrtok
 939 WXDLLIMPEXP_BASE wxChar * wxStrtok(wxChar *psz, const wxChar *delim, wxChar **save_ptr);
 940 #endif
 941
 942 #ifdef __cplusplus
 943 #ifndef wxSetlocale
 944 class WXDLLIMPEXP_BASE wxWCharBuffer;
 945 WXDLLIMPEXP_BASE wxWCharBuffer wxSetlocale(int category, const wxChar *locale);
 946 #endif
 947 #endif
 948
 949 /* stdio.h functions */
 950 #ifdef wxNEED_WX_STDIO_H
 951     #include <stdio.h>
 952     WXDLLIMPEXP_BASE FILE *   wxFopen(const wxChar *path, const wxChar *mode);
 953     WXDLLIMPEXP_BASE FILE *   wxFreopen(const wxChar *path, const wxChar *mode, FILE *stream);
 954     WXDLLIMPEXP_BASE int      wxRemove(const wxChar *path);
 955     WXDLLIMPEXP_BASE int      wxRename(const wxChar *oldpath, const wxChar *newpath);
 956
 957     /* *printf() family is handled separately */
 958 #endif /* wxNEED_WX_STDIO_H */
 959
 960
 961 /* stdlib.h functions */
 962 #ifndef wxAtof
 963 WXDLLIMPEXP_BASE double   wxAtof(const wxChar *psz);
 964 #endif
 965
 966 #ifdef wxNEED_WX_STDLIB_H
 967 WXDLLIMPEXP_BASE int      wxAtoi(const wxChar *psz);
 968 WXDLLIMPEXP_BASE long     wxAtol(const wxChar *psz);
 969 WXDLLIMPEXP_BASE wxChar * wxGetenv(const wxChar *name);
 970 WXDLLIMPEXP_BASE int      wxSystem(const wxChar *psz);
 971 #endif
 972
 973
 974 /* time.h functions */
 975 #ifdef wxNEED_WX_TIME_H
 976 #if defined(__MWERKS__) && defined(macintosh)
 977     #include <time.h>
 978 #endif
 979     WXDLLIMPEXP_BASE size_t wxStrftime(wxChar *s, size_t max,
 980                                   const wxChar *fmt, const struct tm *tm);
 981 #endif /* wxNEED_WX_TIME_H */
 982
 983 #ifndef wxCtime
 984 #include <time.h>
 985 WXDLLIMPEXP_BASE wxChar *wxCtime(const time_t *timep);
 986 #endif
 987
 988
 989 /* missing functions in some WinCE versions */
 990 #ifdef _WIN32_WCE
 991 #if (_WIN32_WCE < 300)
 992 WXDLLIMPEXP_BASE void *calloc( size_t num, size_t size );
 993 #endif
 994 #endif /* _WIN32_WCE */
 995
 996 /* multibyte to wide char conversion functions and macros */
 997
 998 #if wxUSE_WCHAR_T
 999     /* multibyte<->widechar conversion */
1000     WXDLLIMPEXP_BASE size_t wxMB2WC(wchar_t *buf, const char *psz, size_t n);
1001     WXDLLIMPEXP_BASE size_t wxWC2MB(char *buf, const wchar_t *psz, size_t n);
1002
1003     #if wxUSE_UNICODE
1004         #define wxMB2WX wxMB2WC
1005         #define wxWX2MB wxWC2MB
1006         #define wxWC2WX wxStrncpy
1007         #define wxWX2WC wxStrncpy
1008     #else
1009         #define wxMB2WX wxStrncpy
1010         #define wxWX2MB wxStrncpy
1011         #define wxWC2WX wxWC2MB
1012         #define wxWX2WC wxMB2WC
1013     #endif
1014 #else /* !wxUSE_UNICODE */
1015     /* No wxUSE_WCHAR_T: we have to do something (JACS) */
1016     #define wxMB2WC wxStrncpy
1017     #define wxWC2MB wxStrncpy
1018     #define wxMB2WX wxStrncpy
1019     #define wxWX2MB wxStrncpy
1020     #define wxWC2WX wxWC2MB
1021     #define wxWX2WC wxMB2WC
1022 #endif
1023
1024 #endif /* _WX_WXCHAR_H_ */
1025