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 wxStrlen_ _tcslen // used in wxStrlen inline function
181 # define wxStrncat _tcsncat
182 # define wxStrncmp _tcsncmp
183 # define wxStrncpy _tcsncpy
184 # define wxStrpbrk _tcspbrk
185 # define wxStrrchr _tcsrchr
186 # define wxStrspn _tcsspn
187 # define wxStrstr _tcsstr
188 # define wxStrtod _tcstod
189 # define wxStrtol _tcstol
190 # define wxStrtoul _tcstoul
191 # define wxStrxfrm _tcsxfrm
192 #endif // wxNO_TCHAR_STRING
195 #ifndef wxNO_TCHAR_STDIO
196 # define wxFgetc _fgettc
197 # define wxFgetchar _fgettchar
198 # define wxFgets _fgetts
199 # define wxFopen _tfopen
200 # define wxFputc _fputtc
201 # define wxFputchar _fputtchar
202 # define wxFprintf _ftprintf
203 # define wxFreopen _tfreopen
204 # define wxFscanf _ftscanf
205 # define wxGetc _gettc
206 # define wxGetchar _gettchar
207 # define wxGets _getts
208 # define wxPerror _tperror
209 # define wxPrintf _tprintf
210 # define wxPutc _puttc
211 # define wxPutchar _puttchar
212 # define wxPuts _putts
213 # define wxRemove _tremove
214 # define wxRename _trename
215 # define wxScanf _tscanf
216 # define wxSprintf _stprintf
217 # define wxSscanf _stscanf
218 # define wxTmpnam _ttmpnam
219 # define wxUngetc _tungetc
220 # define wxVfprint _vftprintf
221 # define wxVprintf _vtprintf
222 # define wxVsscanf _vstscanf
223 # define wxVsprintf _vstprintf
224 #elif defined(__VISAGECPP__) && (__IBMCPP__ >= 400)
225 // it has some stdio.h functions, apparently
226 # define wxFgetc _fgettc
227 # define wxFgets _fgetts
228 # define wxFputc _fputtc
229 # define wxFprintf _ftprintf
230 # define wxFscanf _ftscanf
231 # define wxGetc _gettc
232 # define wxGetchar _gettchar
233 # define wxPrintf _tprintf
234 # define wxPutc _puttc
235 # define wxPutchar _puttchar
236 # define wxScanf _tscanf
237 # define wxSprintf _stprintf
238 # define wxSscanf _stscanf
239 # define wxVfprint _vftprintf
240 # define wxVprintf _vtprintf
241 # define wxVsprintf _vstprintf
242 #endif // wxNO_TCHAR_STDIO
244 // stdlib.h functions
245 #ifndef wxNO_TCHAR_STDLIB
249 # define wxAtoi _ttoi
250 # define wxAtol _ttol
251 # define wxGetenv _tgetenv
252 # define wxSystem _tsystem
253 #endif // wxNO_TCHAR_STDLIB
256 #ifndef wxNO_TCHAR_TIME
257 # define wxAsctime _tasctime
258 # define wxCtime _tctime
259 #endif // wxNO_TCHAR_TIME
261 #else // !TCHAR-aware compilers
263 // check whether we should include wchar.h or equivalent
264 # if !defined(wxUSE_WCHAR_T)
265 # if defined(__VISUALC__) && (__VISUALC__ < 900)
266 # define wxUSE_WCHAR_T 0 // wchar_t is not available for MSVC++ 1.5
267 # elif defined(__UNIX__)
268 # if defined(HAVE_WCSTR_H) || defined(HAVE_WCHAR_H) || defined(__FreeBSD__)
269 # define wxUSE_WCHAR_T 1
271 # define wxUSE_WCHAR_T 0
273 # elif defined(__GNUWIN32__) && !defined(__MINGW32__) // Cygwin (not Mingw32) doesn't have wcslen.h, needed in buffer.h
274 # define wxUSE_WCHAR_T 0
275 # elif defined(__BORLANDC__) // WIN16 BC++
276 # define wxUSE_WCHAR_T 0
277 # elif defined(__WATCOMC__)
278 # define wxUSE_WCHAR_T 0
279 # elif defined(__VISAGECPP__) && (__IBMCPP__ >= 400)
280 # define wxUSE_WCHAR_T 1
282 // add additional compiler checks if this fails
283 # define wxUSE_WCHAR_T 1
285 # endif // !defined(wxUSE_WCHAR_T)
291 # if defined(__FreeBSD__) || (defined(__APPLE__) && defined(__UNIX__))
293 # define wxNEED_WCSLEN
300 // check whether we are doing Unicode
305 // this is probably glibc-specific
306 # if defined(__WCHAR_TYPE__)
308 typedef __WCHAR_TYPE__ wxChar
;
309 typedef signed __WCHAR_TYPE__ wxSChar
;
310 typedef unsigned __WCHAR_TYPE__ wxUChar
;
314 // ctype.h functions (wctype.h)
315 # define wxIsalnum iswalnum
316 # define wxIsalpha iswalpha
317 # define wxIsctrl iswcntrl
318 # define wxIsdigit iswdigit
319 # define wxIsgraph iswgraph
320 # define wxIslower iswlower
321 # define wxIsprint iswprint
322 # define wxIspunct iswpunct
323 # define wxIsspace iswspace
324 # define wxIsupper iswupper
325 # define wxIsxdigit iswxdigit
327 # if defined(__GLIBC__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ == 0)
328 // /usr/include/wctype.h incorrectly declares translations tables which
329 // provokes tons of compile-time warnings - try to correct this
330 # define wxTolower(wc) towctrans((wc), (wctrans_t)__ctype_tolower)
331 # define wxToupper(wc) towctrans((wc), (wctrans_t)__ctype_toupper)
333 # define wxTolower towlower
334 # define wxToupper towupper
337 // string.h functions (wchar.h)
338 # define wxStrcat wcscat
339 # define wxStrchr wcschr
340 # define wxStrcmp wcscmp
341 # define wxStrcoll wcscoll
342 # define wxStrcpy wcscpy
343 # define wxStrcspn wcscspn
344 # define wxStrlen_ wcslen // used in wxStrlen inline function
345 # define wxStrncat wcsncat
346 # define wxStrncmp wcsncmp
347 # define wxStrncpy wcsncpy
348 # define wxStrpbrk wcspbrk
349 # define wxStrrchr wcsrchr
350 # define wxStrspn wcsspn
351 # define wxStrstr wcsstr
352 # define wxStrtod wcstod
353 # define wxStrtok wcstok
354 # define wxStrtol wcstol
355 # define wxStrtoul wcstoul
356 # define wxStrxfrm wcsxfrm
358 // glibc doesn't have wc equivalents of the other stuff
359 # define wxNEED_WX_STDIO_H
360 # define wxNEED_WX_STDLIB_H
361 # define wxNEED_WX_TIME_H
364 # error "Please define your compiler's Unicode conventions in wxChar.h"
371 # if 0 // temporary - preserve binary compatibilty
373 typedef signed char wxSChar
;
374 typedef unsigned char wxUChar
;
377 # define wxSChar signed char
378 # define wxUChar unsigned char
381 # if defined(__FreeBSD__) || (defined(__APPLE__) && defined(__UNIX__))
385 # if !defined(__MINGW32__) || !defined(_T)
390 # define wxIsalnum isalnum
391 # define wxIsalpha isalpha
392 # define wxIsctrl isctrl
393 # define wxIsdigit isdigit
394 # define wxIsgraph isgraph
395 # define wxIslower islower
396 # define wxIsprint isprint
397 # define wxIspunct ispunct
398 # define wxIsspace isspace
399 # define wxIsupper isupper
400 # define wxIsxdigit isxdigit
401 # define wxTolower tolower
402 # define wxToupper toupper
405 # define wxSetlocale setlocale
407 // string.h functions
408 // #define wxStricmp strcasecmp
409 // wxStricmp is defined below!!
412 #define wxStrtok(str, sep, last) strtok_r(str, sep, last)
414 #define wxStrtok(str, sep, last) strtok(str, sep)
417 // leave the rest to defaults below
418 # define wxNEED_WX_STRING_H
419 # define wxNEED_WX_STDIO_H
420 # define wxNEED_WX_STDLIB_H
421 # define wxNEED_WX_TIME_H
424 #endif//TCHAR-aware compilers
426 // define wxStricmp for various compilers without Unicode possibilities
427 #if !defined(wxStricmp) && !wxUSE_UNICODE
428 # if defined(__BORLANDC__) || defined(__WATCOMC__) || defined(__SALFORDC__) || defined(__VISAGECPP__) || defined(__EMX__)
429 # define wxStricmp stricmp
430 # define wxStrnicmp strnicmp
431 # elif defined(__SC__) || defined(__VISUALC__) || (defined(__MWERKS__) && defined(__INTEL__))
432 # define wxStricmp _stricmp
433 # define wxStrnicmp _strnicmp
434 # elif defined(__UNIX__) || defined(__GNUWIN32__)
435 # define wxStricmp strcasecmp
436 # define wxStrnicmp strncasecmp
437 # elif defined(__MWERKS__) && !defined(__INTEL__)
438 // use wxWindows' implementation
440 // if you leave wxStricmp undefined, wxWindows' implementation will be used
441 # error "Please define string case-insensitive compare for your OS/compiler"
445 // if we need to define for standard headers, and we're not using Unicode,
446 // just define to standard C library routines
448 # ifdef wxNEED_WX_STRING_H
449 # define wxStrcat strcat
450 # define wxStrchr strchr
451 # define wxStrcmp strcmp
452 # define wxStrcoll strcoll
453 # define wxStrcpy strcpy
454 # define wxStrcspn strcspn
455 # define wxStrdup strdup
456 # define wxStrlen_ strlen // used in wxStrlen inline function
457 # define wxStrncat strncat
458 # define wxStrncmp strncmp
459 # define wxStrncpy strncpy
460 # define wxStrpbrk strpbrk
461 # define wxStrrchr strrchr
462 # define wxStrspn strspn
463 # define wxStrstr strstr
464 # define wxStrtod strtod
465 # define wxStrtol strtol
466 # define wxStrtoul strtoul
467 # define wxStrxfrm strxfrm
468 # undef wxNEED_WX_STRING_H
471 # ifdef wxNEED_WX_STDIO_H
472 # define wxFgetc fgetc
473 # define wxFgetchar fgetchar
474 # define wxFgets fgets
475 # define wxFopen fopen
476 # define wxFputc fputc
477 # define wxFputchar fputchar
478 # define wxFprintf fprintf
479 # define wxFreopen freopen
480 # define wxFscanf fscanf
482 # define wxGetchar getchar
484 # define wxPerror perror
485 # define wxPrintf printf
487 # define wxPutchar putchar
489 # define wxRemove remove
490 # define wxRename rename
491 # define wxScanf scanf
492 # define wxSprintf sprintf
493 # define wxSscanf sscanf
494 # define wxTmpnam tmpnam
495 # define wxUngetc ungetc
496 # define wxVfprint vfprintf
497 # define wxVprintf vprintf
498 # define wxVsscanf vsscanf
499 # define wxVsprintf vsprintf
500 # undef wxNEED_WX_STDIO_H
503 # ifdef wxNEED_WX_STDLIB_H
507 # define wxGetenv getenv
508 # define wxSystem system
509 # undef wxNEED_WX_STDLIB_H
512 # ifdef wxNEED_WX_TIME_H
513 # define wxAsctime asctime
514 # define wxCtime ctime
515 # define wxStrftime strftime
516 # undef wxNEED_WX_TIME_H
520 #if defined(wxNEED_WCSLEN) && wxUSE_UNICODE
521 # define wcslen wxStrlen
522 # undef wxNEED_WCSLEN
525 // checks whether the passed in pointer is NULL and if the string is empty
526 inline bool wxIsEmpty(const wxChar
*p
) { return !p
|| !*p
; }
528 #ifndef wxNEED_WX_STRING_H
529 // safe version of strlen() (returns 0 if passed NULL pointer)
530 inline size_t wxStrlen(const wxChar
*psz
)
531 { return psz
? wxStrlen_(psz
) : 0; }
535 // multibyte<->widechar conversion
536 WXDLLEXPORT
size_t wxMB2WC(wchar_t *buf
, const char *psz
, size_t n
);
537 WXDLLEXPORT
size_t wxWC2MB(char *buf
, const wchar_t *psz
, size_t n
);
539 # define wxMB2WX wxMB2WC
540 # define wxWX2MB wxWC2MB
541 # define wxWC2WX wxStrncpy
542 # define wxWX2WC wxStrncpy
544 # define wxMB2WX wxStrncpy
545 # define wxWX2MB wxStrncpy
546 # define wxWC2WX wxWC2MB
547 # define wxWX2WC wxMB2WC
550 // No wxUSE_WCHAR_T: we have to do something (JACS)
551 # define wxMB2WC wxStrncpy
552 # define wxWC2MB wxStrncpy
553 # define wxMB2WX wxStrncpy
554 # define wxWX2MB wxStrncpy
555 # define wxWC2WX wxWC2MB
556 # define wxWX2WC wxMB2WC
559 WXDLLEXPORT
bool wxOKlibc(); // for internal use
561 // if libc versions are not available, use replacements defined in wxchar.cpp
563 WXDLLEXPORT wxChar
* wxStrdup(const wxChar
*psz
);
567 WXDLLEXPORT
int wxStricmp(const wxChar
*psz1
, const wxChar
*psz2
);
571 WXDLLEXPORT wxChar
* wxStrtok(wxChar
*psz
, const wxChar
*delim
, wxChar
**save_ptr
);
576 WXDLLEXPORT wxWCharBuffer
wxSetlocale(int category
, const wxChar
*locale
);
579 #ifdef wxNEED_WCSLEN // for use in buffer.h
580 WXDLLEXPORT
size_t wcslen(const wchar_t *s
);
583 #ifdef wxNEED_WX_CTYPE_H
584 WXDLLEXPORT
int wxIsalnum(wxChar ch
);
585 WXDLLEXPORT
int wxIsalpha(wxChar ch
);
586 WXDLLEXPORT
int wxIsctrl(wxChar ch
);
587 WXDLLEXPORT
int wxIsdigit(wxChar ch
);
588 WXDLLEXPORT
int wxIsgraph(wxChar ch
);
589 WXDLLEXPORT
int wxIslower(wxChar ch
);
590 WXDLLEXPORT
int wxIsprint(wxChar ch
);
591 WXDLLEXPORT
int wxIspunct(wxChar ch
);
592 WXDLLEXPORT
int wxIsspace(wxChar ch
);
593 WXDLLEXPORT
int wxIsupper(wxChar ch
);
594 WXDLLEXPORT
int wxIsxdigit(wxChar ch
);
595 WXDLLEXPORT
int wxTolower(wxChar ch
);
596 WXDLLEXPORT
int wxToupper(wxChar ch
);
599 #ifdef wxNEED_WX_STRING_H
600 WXDLLEXPORT wxChar
* wxStrcat(wxChar
*dest
, const wxChar
*src
);
601 WXDLLEXPORT wxChar
* wxStrchr(const wxChar
*s
, wxChar c
);
602 WXDLLEXPORT
int wxStrcmp(const wxChar
*s1
, const wxChar
*s2
);
603 WXDLLEXPORT
int wxStrcoll(const wxChar
*s1
, const wxChar
*s2
);
604 WXDLLEXPORT wxChar
* wxStrcpy(wxChar
*dest
, const wxChar
*src
);
605 WXDLLEXPORT
size_t wxStrcspn(const wxChar
*s
, const wxChar
*reject
);
606 WXDLLEXPORT
size_t wxStrlen(const wxChar
*s
);
607 WXDLLEXPORT wxChar
* wxStrncat(wxChar
*dest
, const wxChar
*src
, size_t n
);
608 WXDLLEXPORT
int wxStrncmp(const wxChar
*s1
, const wxChar
*s2
, size_t n
);
609 WXDLLEXPORT wxChar
* wxStrncpy(wxChar
*dest
, const wxChar
*src
, size_t n
);
610 WXDLLEXPORT wxChar
* wxStrpbrk(const wxChar
*s
, const wxChar
*accept
);
611 WXDLLEXPORT wxChar
* wxStrrchr(const wxChar
*s
, wxChar c
);
612 WXDLLEXPORT
size_t wxStrspn(const wxChar
*s
, const wxChar
*accept
);
613 WXDLLEXPORT wxChar
* wxStrstr(const wxChar
*haystack
, const wxChar
*needle
);
614 WXDLLEXPORT
double wxStrtod(const wxChar
*nptr
, wxChar
**endptr
);
615 WXDLLEXPORT
long int wxStrtol(const wxChar
*nptr
, wxChar
**endptr
, int base
);
616 WXDLLEXPORT
unsigned long int wxStrtoul(const wxChar
*nptr
, wxChar
**endptr
, int base
);
617 WXDLLEXPORT
size_t wxStrxfrm(wxChar
*dest
, const wxChar
*src
, size_t n
);
620 #ifdef wxNEED_WX_STDIO_H
623 WXDLLEXPORT
FILE * wxFopen(const wxChar
*path
, const wxChar
*mode
);
624 WXDLLEXPORT
FILE * wxFreopen(const wxChar
*path
, const wxChar
*mode
, FILE *stream
);
625 WXDLLEXPORT
int wxRemove(const wxChar
*path
);
626 WXDLLEXPORT
int wxRename(const wxChar
*oldpath
, const wxChar
*newpath
);
627 WXDLLEXPORT
int wxPrintf(const wxChar
*fmt
, ...);
628 WXDLLEXPORT
int wxVprintf(const wxChar
*fmt
, va_list argptr
);
629 WXDLLEXPORT
int wxFprintf(FILE *stream
, const wxChar
*fmt
, ...);
630 WXDLLEXPORT
int wxVfprintf(FILE *stream
, const wxChar
*fmt
, va_list argptr
);
631 WXDLLEXPORT
int wxSprintf(wxChar
*buf
, const wxChar
*fmt
, ...);
632 WXDLLEXPORT
int wxVsprintf(wxChar
*buf
, const wxChar
*fmt
, va_list argptr
);
633 WXDLLEXPORT
int wxSscanf(const wxChar
*buf
, const wxChar
*fmt
, ...);
634 WXDLLEXPORT
int wxVsscanf(const wxChar
*buf
, const wxChar
*fmt
, va_list argptr
);
638 WXDLLEXPORT
double wxAtof(const wxChar
*psz
);
641 #ifdef wxNEED_WX_STDLIB_H
642 WXDLLEXPORT
int wxAtoi(const wxChar
*psz
);
643 WXDLLEXPORT
long wxAtol(const wxChar
*psz
);
644 WXDLLEXPORT wxChar
* wxGetenv(const wxChar
*name
);
645 WXDLLEXPORT
int wxSystem(const wxChar
*psz
);
648 #ifdef wxNEED_WX_TIME_H
649 WXDLLEXPORT
size_t wxStrftime(wxChar
*s
, size_t max
, const wxChar
*fmt
, const struct tm
*tm
);
652 // under VC++ 6.0 isspace() returns 1 for 8 bit chars which completely breaks
653 // the file parsing - this may be true for 5.0 as well, update #ifdef then
654 #if defined(__VISUALC__) && (__VISUALC__ >= 1200) && !wxUSE_UNICODE
656 #define wxIsspace(c) ((((unsigned)c) < 128) && isspace(c))
659 // ----------------------------------------------------------------------------
660 // common macros which are always defined
661 // ----------------------------------------------------------------------------
663 // although global macros with such names are really bad, we want to have
664 // another name for _T() which should be used to avoid confusion between _T()
665 // and _() in wxWindows sources
668 // a Unicode-friendly __FILE__ analog
670 #define __XFILE__(x) wxT(x)
671 #define __TFILE__ __XFILE__(__FILE__)