1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Declarations common to wx char/wchar_t usage (wide chars)
8 // Copyright: (c) wxWindows copyright
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "wxchar.h"
19 // only do SBCS or _UNICODE
21 // It may be OK anyway.
22 // # error "MBCS is not supported by wxChar"
25 // ----------------------------------------------------------------------------
26 // first deal with Unicode setting
27 // ----------------------------------------------------------------------------
29 // set wxUSE_UNICODE to 1 if UNICODE or _UNICODE is defined
30 #if defined(_UNICODE) || defined(UNICODE)
32 # define wxUSE_UNICODE 1
34 # ifndef wxUSE_UNICODE
35 # define wxUSE_UNICODE 0
39 // and vice versa: define UNICODE and _UNICODE if wxUSE_UNICODE is 1...
49 // Unicode support requires wchar_t
52 # define wxUSE_WCHAR_T 1
55 // ----------------------------------------------------------------------------
56 // define wxHAVE_TCHAR_FUNCTIONS for the compilers which support the
57 // wide-character functions
58 // ----------------------------------------------------------------------------
61 // VC++ and BC++ starting with 5.2 have TCHAR support
63 #define wxHAVE_TCHAR_FUNCTIONS
64 #elif defined(__BORLANDC__) && (__BORLANDC__ >= 0x520)
65 #define wxHAVE_TCHAR_FUNCTIONS
66 // w32api isn't yet tchar safe, will be soon, this is a placeholder
67 #elif defined(__GNUWIN32__) && wxCHECK_W32API_VERSION( 10, 0 )
68 #define wxHAVE_TCHAR_FUNCTIONS
73 #elif defined(__VISAGECPP__) && (__IBMCPP__ >= 400)
74 // VisualAge 4.0+ supports TCHAR
75 #define wxHAVE_TCHAR_FUNCTIONS
77 // but not stdio.h nor time nor conversion functions
78 #define wxNO_TCHAR_STDIO
79 #define wxNO_TCHAR_STDLIB
80 #define wxNO_TCHAR_TIME
81 #define wxNO_TCHAR_LOCALE
83 // supplemental VA V4 defs so at least we know what these are
84 // just define to standard defs
90 // locale.h functons -- not defined in tchar.h
91 #define wxSetlocale setlocale
92 // some stdio functions are defined others are not
94 #define wxFgetchar fgetchar
96 #define wxFputchar fputchar
97 #define wxFreopen freopen
99 #define wxPerror perror
101 #define wxRemove remove
102 #define wxRename rename
103 #define wxTmpnam tmpnam
104 #define wxUngetc ungetc
105 #define wxVsscanf vsscanf
106 // stdlib not defined in VA V4
112 #define wxGetenv getenv
113 #define wxSystem system
114 // time.h functions -- none defined in tchar.h
115 #define wxAsctime asctime
116 #define wxCtime ctime
117 #endif // compilers with (good) TCHAR support
119 #ifdef wxHAVE_TCHAR_FUNCTIONS
120 # define HAVE_WCSLEN 1
124 # if wxUSE_UNICODE // temporary - preserve binary compatibility
125 #if defined(__GNUWIN32__)
127 #define _TSCHAR TCHAR
128 #define _TUCHAR TCHAR
131 typedef _TCHAR wxChar
;
132 typedef _TSCHAR wxSChar
;
133 typedef _TUCHAR wxUChar
;
136 # define wxSChar signed char
137 # define wxUChar unsigned char
140 // wchar_t is available
141 #ifndef wxUSE_WCHAR_T
142 #define wxUSE_WCHAR_T 1
143 #endif // !defined(wxUSE_WCHAR_T)
146 #ifndef wxNO_TCHAR_CTYPE
150 # define wxIsalnum _istalnum
151 # define wxIsalpha _istalpha
152 # define wxIsctrl _istctrl
153 # define wxIsdigit _istdigit
154 # define wxIsgraph _istgraph
155 # define wxIslower _istlower
156 # define wxIsprint _istprint
157 # define wxIspunct _istpunct
158 # define wxIsspace _istspace
159 # define wxIsupper _istupper
160 # define wxIsxdigit _istxdigit
161 # define wxTolower _totlower
162 # define wxToupper _totupper
163 #endif // wxNO_TCHAR_CTYPE
166 #ifndef wxNO_TCHAR_LOCALE
167 # define wxSetlocale _tsetlocale
168 #endif // wxNO_TCHAR_LOCALE
170 // string.h functions
171 #ifndef wxNO_TCHAR_STRING
172 # define wxStrcat _tcscat
173 # define wxStrchr _tcschr
174 # define wxStrcmp _tcscmp
175 # define wxStrcoll _tcscoll
176 # define wxStrcpy _tcscpy
177 # define wxStrcspn _tcscspn
178 # define wxStrftime _tcsftime
179 # define wxStricmp _tcsicmp
180 # define wxStrnicmp _tcsnicmp
181 # define wxStrlen_ _tcslen // used in wxStrlen inline function
182 # define wxStrncat _tcsncat
183 # define wxStrncmp _tcsncmp
184 # define wxStrncpy _tcsncpy
185 # define wxStrpbrk _tcspbrk
186 # define wxStrrchr _tcsrchr
187 # define wxStrspn _tcsspn
188 # define wxStrstr _tcsstr
189 # define wxStrtod _tcstod
190 # define wxStrtol _tcstol
191 # define wxStrtoul _tcstoul
192 # define wxStrxfrm _tcsxfrm
193 #endif // wxNO_TCHAR_STRING
196 #ifndef wxNO_TCHAR_STDIO
197 # define wxFgetc _fgettc
198 # define wxFgetchar _fgettchar
199 # define wxFgets _fgetts
200 # define wxFopen _tfopen
201 # define wxFputc _fputtc
202 # define wxFputchar _fputtchar
203 # define wxFprintf _ftprintf
204 # define wxFreopen _tfreopen
205 # define wxFscanf _ftscanf
206 # define wxGetc _gettc
207 # define wxGetchar _gettchar
208 # define wxGets _getts
209 # define wxPerror _tperror
210 # define wxPrintf _tprintf
211 # define wxPutc _puttc
212 # define wxPutchar _puttchar
213 # define wxPuts _putts
214 # define wxRemove _tremove
215 # define wxRename _trename
216 # define wxScanf _tscanf
217 # define wxSprintf _stprintf
218 # define wxSscanf _stscanf
219 # define wxTmpnam _ttmpnam
220 # define wxUngetc _tungetc
221 # define wxVfprint _vftprintf
222 # define wxVprintf _vtprintf
223 # define wxVsscanf _vstscanf
224 # define wxVsprintf _vstprintf
225 #elif defined(__VISAGECPP__) && (__IBMCPP__ >= 400)
226 // it has some stdio.h functions, apparently
227 # define wxFgetc _fgettc
228 # define wxFgets _fgetts
229 # define wxFputc _fputtc
230 # define wxFprintf _ftprintf
231 # define wxFscanf _ftscanf
232 # define wxGetc _gettc
233 # define wxGetchar _gettchar
234 # define wxPrintf _tprintf
235 # define wxPutc _puttc
236 # define wxPutchar _puttchar
237 # define wxScanf _tscanf
238 # define wxSprintf _stprintf
239 # define wxSscanf _stscanf
240 # define wxVfprint _vftprintf
241 # define wxVprintf _vtprintf
242 # define wxVsprintf _vstprintf
243 #endif // wxNO_TCHAR_STDIO
245 // stdlib.h functions
246 #ifndef wxNO_TCHAR_STDLIB
250 # define wxAtoi _ttoi
251 # define wxAtol _ttol
252 # define wxGetenv _tgetenv
253 # define wxSystem _tsystem
254 #endif // wxNO_TCHAR_STDLIB
257 #ifndef wxNO_TCHAR_TIME
258 # define wxAsctime _tasctime
259 # define wxCtime _tctime
260 #endif // wxNO_TCHAR_TIME
262 #else // !TCHAR-aware compilers
264 // check whether we should include wchar.h or equivalent
265 # if !defined(wxUSE_WCHAR_T)
266 # if defined(__VISUALC__) && (__VISUALC__ < 900)
267 # define wxUSE_WCHAR_T 0 // wchar_t is not available for MSVC++ 1.5
268 # elif defined(__UNIX__)
269 # if defined(HAVE_WCSTR_H) || defined(HAVE_WCHAR_H) || defined(__FreeBSD__) || (defined(__APPLE__) && defined(__UNIX__))
270 # define wxUSE_WCHAR_T 1
272 # define wxUSE_WCHAR_T 0
274 # elif defined(__GNUWIN32__) && !defined(__MINGW32__) // Cygwin (not Mingw32) doesn't have wcslen.h, needed in buffer.h
275 # define wxUSE_WCHAR_T 0
276 # elif defined(__BORLANDC__) // WIN16 BC++
277 # define wxUSE_WCHAR_T 0
278 # elif defined(__WATCOMC__)
279 # define wxUSE_WCHAR_T 0
280 # elif defined(__VISAGECPP__) && (__IBMCPP__ >= 400)
281 # define wxUSE_WCHAR_T 1
283 // add additional compiler checks if this fails
284 # define wxUSE_WCHAR_T 1
286 # endif // !defined(wxUSE_WCHAR_T)
292 # if defined(__FreeBSD__) || (defined(__APPLE__) && defined(__UNIX__))
294 # define wxNEED_WCSLEN
301 // check whether we are doing Unicode
306 // this is probably glibc-specific
307 # if defined(__WCHAR_TYPE__)
309 typedef __WCHAR_TYPE__ wxChar
;
310 typedef signed __WCHAR_TYPE__ wxSChar
;
311 typedef unsigned __WCHAR_TYPE__ wxUChar
;
315 // ctype.h functions (wctype.h)
316 # define wxIsalnum iswalnum
317 # define wxIsalpha iswalpha
318 # define wxIsctrl iswcntrl
319 # define wxIsdigit iswdigit
320 # define wxIsgraph iswgraph
321 # define wxIslower iswlower
322 # define wxIsprint iswprint
323 # define wxIspunct iswpunct
324 # define wxIsspace iswspace
325 # define wxIsupper iswupper
326 # define wxIsxdigit iswxdigit
328 # if defined(__GLIBC__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ == 0)
329 // /usr/include/wctype.h incorrectly declares translations tables which
330 // provokes tons of compile-time warnings - try to correct this
331 # define wxTolower(wc) towctrans((wc), (wctrans_t)__ctype_tolower)
332 # define wxToupper(wc) towctrans((wc), (wctrans_t)__ctype_toupper)
334 # define wxTolower towlower
335 # define wxToupper towupper
338 // string.h functions (wchar.h)
339 # define wxStrcat wcscat
340 # define wxStrchr wcschr
341 # define wxStrcmp wcscmp
342 # define wxStrcoll wcscoll
343 # define wxStrcpy wcscpy
344 # define wxStrcspn wcscspn
345 # define wxStrlen_ wcslen // used in wxStrlen inline function
346 # define wxStrncat wcsncat
347 # define wxStrncmp wcsncmp
348 # define wxStrncpy wcsncpy
349 # define wxStrpbrk wcspbrk
350 # define wxStrrchr wcsrchr
351 # define wxStrspn wcsspn
352 # define wxStrstr wcsstr
353 # define wxStrtod wcstod
354 # define wxStrtok wcstok
355 # define wxStrtol wcstol
356 # define wxStrtoul wcstoul
357 # define wxStrxfrm wcsxfrm
359 // glibc doesn't have wc equivalents of the other stuff
360 # define wxNEED_WX_STDIO_H
361 # define wxNEED_WX_STDLIB_H
362 # define wxNEED_WX_TIME_H
365 # error "Please define your compiler's Unicode conventions in wxChar.h"
372 # if 0 // temporary - preserve binary compatibilty
374 typedef signed char wxSChar
;
375 typedef unsigned char wxUChar
;
378 # define wxSChar signed char
379 # define wxUChar unsigned char
382 # if defined(__FreeBSD__) || (defined(__APPLE__) && defined(__UNIX__))
386 # if !defined(__MINGW32__) || !defined(_T)
391 # define wxIsalnum isalnum
392 # define wxIsalpha isalpha
393 # define wxIsctrl isctrl
394 # define wxIsdigit isdigit
395 # define wxIsgraph isgraph
396 # define wxIslower islower
397 # define wxIsprint isprint
398 # define wxIspunct ispunct
399 # define wxIsspace isspace
400 # define wxIsupper isupper
401 # define wxIsxdigit isxdigit
402 # define wxTolower tolower
403 # define wxToupper toupper
406 # define wxSetlocale setlocale
408 // string.h functions
409 // #define wxStricmp strcasecmp
410 // wxStricmp is defined below!!
413 #define wxStrtok(str, sep, last) strtok_r(str, sep, last)
415 #define wxStrtok(str, sep, last) strtok(str, sep)
418 // leave the rest to defaults below
419 # define wxNEED_WX_STRING_H
420 # define wxNEED_WX_STDIO_H
421 # define wxNEED_WX_STDLIB_H
422 # define wxNEED_WX_TIME_H
425 #endif//TCHAR-aware compilers
427 // define wxStricmp for various compilers without Unicode possibilities
428 #if !defined(wxStricmp) && !wxUSE_UNICODE
429 # if defined(__BORLANDC__) || defined(__WATCOMC__) || defined(__SALFORDC__) || defined(__VISAGECPP__) || defined(__EMX__)
430 # define wxStricmp stricmp
431 # define wxStrnicmp strnicmp
432 # elif defined(__SC__) || defined(__VISUALC__) || (defined(__MWERKS__) && defined(__INTEL__))
433 # define wxStricmp _stricmp
434 # define wxStrnicmp _strnicmp
435 # elif defined(__UNIX__) || defined(__GNUWIN32__)
436 # define wxStricmp strcasecmp
437 # define wxStrnicmp strncasecmp
438 # elif defined(__MWERKS__) && !defined(__INTEL__)
439 // use wxWindows' implementation
441 // if you leave wxStricmp undefined, wxWindows' implementation will be used
442 # error "Please define string case-insensitive compare for your OS/compiler"
446 // if we need to define for standard headers, and we're not using Unicode,
447 // just define to standard C library routines
449 # ifdef wxNEED_WX_STRING_H
450 # define wxStrcat strcat
451 # define wxStrchr strchr
452 # define wxStrcmp strcmp
453 # define wxStrcoll strcoll
454 # define wxStrcpy strcpy
455 # define wxStrcspn strcspn
456 # define wxStrdup strdup
457 # define wxStrlen_ strlen // used in wxStrlen inline function
458 # define wxStrncat strncat
459 # define wxStrncmp strncmp
460 # define wxStrncpy strncpy
461 # define wxStrpbrk strpbrk
462 # define wxStrrchr strrchr
463 # define wxStrspn strspn
464 # define wxStrstr strstr
465 # define wxStrtod strtod
466 # define wxStrtol strtol
467 # define wxStrtoul strtoul
468 # define wxStrxfrm strxfrm
469 # undef wxNEED_WX_STRING_H
472 # ifdef wxNEED_WX_STDIO_H
473 # define wxFgetc fgetc
474 # define wxFgetchar fgetchar
475 # define wxFgets fgets
476 # define wxFopen fopen
477 # define wxFputc fputc
478 # define wxFputchar fputchar
479 # define wxFprintf fprintf
480 # define wxFreopen freopen
481 # define wxFscanf fscanf
483 # define wxGetchar getchar
485 # define wxPerror perror
486 # define wxPrintf printf
488 # define wxPutchar putchar
490 # define wxRemove remove
491 # define wxRename rename
492 # define wxScanf scanf
493 # define wxSprintf sprintf
494 # define wxSscanf sscanf
495 # define wxTmpnam tmpnam
496 # define wxUngetc ungetc
497 # define wxVfprint vfprintf
498 # define wxVprintf vprintf
499 # define wxVsscanf vsscanf
500 # define wxVsprintf vsprintf
501 # undef wxNEED_WX_STDIO_H
504 # ifdef wxNEED_WX_STDLIB_H
508 # define wxGetenv getenv
509 # define wxSystem system
510 # undef wxNEED_WX_STDLIB_H
513 # ifdef wxNEED_WX_TIME_H
514 # define wxAsctime asctime
515 # define wxCtime ctime
516 # define wxStrftime strftime
517 # undef wxNEED_WX_TIME_H
521 #if defined(wxNEED_WCSLEN) && wxUSE_UNICODE
522 # define wcslen wxStrlen
523 # undef wxNEED_WCSLEN
526 // checks whether the passed in pointer is NULL and if the string is empty
527 inline bool wxIsEmpty(const wxChar
*p
) { return !p
|| !*p
; }
529 #ifndef wxNEED_WX_STRING_H
530 // safe version of strlen() (returns 0 if passed NULL pointer)
531 inline size_t wxStrlen(const wxChar
*psz
)
532 { return psz
? wxStrlen_(psz
) : 0; }
536 // multibyte<->widechar conversion
537 WXDLLEXPORT
size_t wxMB2WC(wchar_t *buf
, const char *psz
, size_t n
);
538 WXDLLEXPORT
size_t wxWC2MB(char *buf
, const wchar_t *psz
, size_t n
);
540 # define wxMB2WX wxMB2WC
541 # define wxWX2MB wxWC2MB
542 # define wxWC2WX wxStrncpy
543 # define wxWX2WC wxStrncpy
545 # define wxMB2WX wxStrncpy
546 # define wxWX2MB wxStrncpy
547 # define wxWC2WX wxWC2MB
548 # define wxWX2WC wxMB2WC
551 // No wxUSE_WCHAR_T: we have to do something (JACS)
552 # define wxMB2WC wxStrncpy
553 # define wxWC2MB wxStrncpy
554 # define wxMB2WX wxStrncpy
555 # define wxWX2MB wxStrncpy
556 # define wxWC2WX wxWC2MB
557 # define wxWX2WC wxMB2WC
560 WXDLLEXPORT
bool wxOKlibc(); // for internal use
562 // if libc versions are not available, use replacements defined in wxchar.cpp
564 WXDLLEXPORT wxChar
* wxStrdup(const wxChar
*psz
);
568 WXDLLEXPORT
int wxStricmp(const wxChar
*psz1
, const wxChar
*psz2
);
572 WXDLLEXPORT wxChar
* wxStrtok(wxChar
*psz
, const wxChar
*delim
, wxChar
**save_ptr
);
577 WXDLLEXPORT wxWCharBuffer
wxSetlocale(int category
, const wxChar
*locale
);
580 #ifdef wxNEED_WCSLEN // for use in buffer.h
581 WXDLLEXPORT
size_t wcslen(const wchar_t *s
);
584 #ifdef wxNEED_WX_CTYPE_H
585 WXDLLEXPORT
int wxIsalnum(wxChar ch
);
586 WXDLLEXPORT
int wxIsalpha(wxChar ch
);
587 WXDLLEXPORT
int wxIsctrl(wxChar ch
);
588 WXDLLEXPORT
int wxIsdigit(wxChar ch
);
589 WXDLLEXPORT
int wxIsgraph(wxChar ch
);
590 WXDLLEXPORT
int wxIslower(wxChar ch
);
591 WXDLLEXPORT
int wxIsprint(wxChar ch
);
592 WXDLLEXPORT
int wxIspunct(wxChar ch
);
593 WXDLLEXPORT
int wxIsspace(wxChar ch
);
594 WXDLLEXPORT
int wxIsupper(wxChar ch
);
595 WXDLLEXPORT
int wxIsxdigit(wxChar ch
);
596 WXDLLEXPORT
int wxTolower(wxChar ch
);
597 WXDLLEXPORT
int wxToupper(wxChar ch
);
600 #ifdef wxNEED_WX_STRING_H
601 WXDLLEXPORT wxChar
* wxStrcat(wxChar
*dest
, const wxChar
*src
);
602 WXDLLEXPORT wxChar
* wxStrchr(const wxChar
*s
, wxChar c
);
603 WXDLLEXPORT
int wxStrcmp(const wxChar
*s1
, const wxChar
*s2
);
604 WXDLLEXPORT
int wxStrcoll(const wxChar
*s1
, const wxChar
*s2
);
605 WXDLLEXPORT wxChar
* wxStrcpy(wxChar
*dest
, const wxChar
*src
);
606 WXDLLEXPORT
size_t wxStrcspn(const wxChar
*s
, const wxChar
*reject
);
607 WXDLLEXPORT
size_t wxStrlen(const wxChar
*s
);
608 WXDLLEXPORT wxChar
* wxStrncat(wxChar
*dest
, const wxChar
*src
, size_t n
);
609 WXDLLEXPORT
int wxStrncmp(const wxChar
*s1
, const wxChar
*s2
, size_t n
);
610 WXDLLEXPORT wxChar
* wxStrncpy(wxChar
*dest
, const wxChar
*src
, size_t n
);
611 WXDLLEXPORT wxChar
* wxStrpbrk(const wxChar
*s
, const wxChar
*accept
);
612 WXDLLEXPORT wxChar
* wxStrrchr(const wxChar
*s
, wxChar c
);
613 WXDLLEXPORT
size_t wxStrspn(const wxChar
*s
, const wxChar
*accept
);
614 WXDLLEXPORT wxChar
* wxStrstr(const wxChar
*haystack
, const wxChar
*needle
);
615 WXDLLEXPORT
double wxStrtod(const wxChar
*nptr
, wxChar
**endptr
);
616 WXDLLEXPORT
long int wxStrtol(const wxChar
*nptr
, wxChar
**endptr
, int base
);
617 WXDLLEXPORT
unsigned long int wxStrtoul(const wxChar
*nptr
, wxChar
**endptr
, int base
);
618 WXDLLEXPORT
size_t wxStrxfrm(wxChar
*dest
, const wxChar
*src
, size_t n
);
621 #ifdef wxNEED_WX_STDIO_H
624 WXDLLEXPORT
FILE * wxFopen(const wxChar
*path
, const wxChar
*mode
);
625 WXDLLEXPORT
FILE * wxFreopen(const wxChar
*path
, const wxChar
*mode
, FILE *stream
);
626 WXDLLEXPORT
int wxRemove(const wxChar
*path
);
627 WXDLLEXPORT
int wxRename(const wxChar
*oldpath
, const wxChar
*newpath
);
628 WXDLLEXPORT
int wxPrintf(const wxChar
*fmt
, ...);
629 WXDLLEXPORT
int wxVprintf(const wxChar
*fmt
, va_list argptr
);
630 WXDLLEXPORT
int wxFprintf(FILE *stream
, const wxChar
*fmt
, ...);
631 WXDLLEXPORT
int wxVfprintf(FILE *stream
, const wxChar
*fmt
, va_list argptr
);
632 WXDLLEXPORT
int wxSprintf(wxChar
*buf
, const wxChar
*fmt
, ...);
633 WXDLLEXPORT
int wxVsprintf(wxChar
*buf
, const wxChar
*fmt
, va_list argptr
);
634 WXDLLEXPORT
int wxSscanf(const wxChar
*buf
, const wxChar
*fmt
, ...);
635 WXDLLEXPORT
int wxVsscanf(const wxChar
*buf
, const wxChar
*fmt
, va_list argptr
);
639 WXDLLEXPORT
double wxAtof(const wxChar
*psz
);
642 #ifdef wxNEED_WX_STDLIB_H
643 WXDLLEXPORT
int wxAtoi(const wxChar
*psz
);
644 WXDLLEXPORT
long wxAtol(const wxChar
*psz
);
645 WXDLLEXPORT wxChar
* wxGetenv(const wxChar
*name
);
646 WXDLLEXPORT
int wxSystem(const wxChar
*psz
);
649 #ifdef wxNEED_WX_TIME_H
650 WXDLLEXPORT
size_t wxStrftime(wxChar
*s
, size_t max
, const wxChar
*fmt
, const struct tm
*tm
);
653 // under VC++ 6.0 isspace() returns 1 for 8 bit chars which completely breaks
654 // the file parsing - this may be true for 5.0 as well, update #ifdef then
655 #if defined(__VISUALC__) && (__VISUALC__ >= 1200) && !wxUSE_UNICODE
657 #define wxIsspace(c) ((((unsigned)c) < 128) && isspace(c))
660 // ----------------------------------------------------------------------------
661 // common macros which are always defined
662 // ----------------------------------------------------------------------------
664 // although global macros with such names are really bad, we want to have
665 // another name for _T() which should be used to avoid confusion between _T()
666 // and _() in wxWindows sources
669 // a Unicode-friendly __FILE__ analog
671 #define __XFILE__(x) wxT(x)
672 #define __TFILE__ __XFILE__(__FILE__)