]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/wxchar.h
HTML_xxxx constants changed to wxHTML_xxxx (with backward compatibility through WXWIN...
[wxWidgets.git] / include / wx / wxchar.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wxchar.h
3// Purpose: Declarations common to wx char/wchar_t usage (wide chars)
4// Author: Joel Farley
5// Modified by:
6// Created: 1998/06/12
7// RCS-ID: $Id$
8// Copyright: (c) wxWindows copyright
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_WXCHAR_H_
13#define _WX_WXCHAR_H_
14
15//#ifdef __GNUG__
16//#pragma interface "wxchar.h"
17//#endif
18
19// only do SBCS or _UNICODE
20#if defined (_MBCS )
21# error "MBCS is not supported by wxChar"
22#endif
23
24// set wxUSE_UNICODE to 1 if UNICODE or _UNICODE is defined
25#if defined(_UNICODE) || defined(UNICODE)
26# undef wxUSE_UNICODE
27# define wxUSE_UNICODE 1
28#else
29# ifndef wxUSE_UNICODE
30# define wxUSE_UNICODE 0
31# endif
32#endif
33
34// and vice versa: define UNICODE and _UNICODE if wxUSE_UNICODE is 1...
35#if wxUSE_UNICODE
36# ifndef _UNICODE
37# define _UNICODE
38# endif
39# ifndef UNICODE
40# define UNICODE
41# endif
42#endif
43
44// Windows (VC++) has broad TCHAR support
45#if defined(__VISUALC__) && defined(__WIN32__)
46
47# define HAVE_WCSLEN 1
48
49# include <tchar.h>
50
51# if wxUSE_UNICODE // temporary - preserve binary compatibility
52typedef _TCHAR wxChar;
53typedef _TSCHAR wxSChar;
54typedef _TUCHAR wxUChar;
55# else
56# define wxChar char
57# define wxSChar signed char
58# define wxUChar unsigned char
59# endif
60 // wchar_t is available
61# undef wxUSE_WCHAR_T
62# define wxUSE_WCHAR_T 1
63
64 // ctype.h functions
65# define wxIsalnum _istalnum
66# define wxIsalpha _istalpha
67# define wxIsctrl _istctrl
68# define wxIsdigit _istdigit
69# define wxIsgraph _istgraph
70# define wxIslower _istlower
71# define wxIsprint _istprint
72# define wxIspunct _istpunct
73# define wxIsspace _istspace
74# define wxIsupper _istupper
75# define wxIsxdigit _istxdigit
76# define wxTolower _totlower
77# define wxToupper _totupper
78
79 // locale.h functons
80# define wxSetlocale _tsetlocale
81
82 // string.h functions
83# define wxStrcat _tcscat
84# define wxStrchr _tcschr
85# define wxStrcmp _tcscmp
86# define wxStrcoll _tcscoll
87# define wxStrcpy _tcscpy
88# define wxStrcspn _tcscspn
89# define wxStrftime _tcsftime
90# define wxStricmp _tcsicmp
91# define wxStrlen_ _tcslen // used in wxStrlen inline function
92# define wxStrncat _tcsncat
93# define wxStrncmp _tcsncmp
94# define wxStrncpy _tcsncpy
95# define wxStrpbrk _tcspbrk
96# define wxStrrchr _tcsrchr
97# define wxStrspn _tcsspn
98# define wxStrstr _tcsstr
99# define wxStrtod _tcstod
100// is there a _tcstok[_r] ?
101# define wxStrtol _tcstol
102# define wxStrtoul _tcstoul
103# define wxStrxfrm _tcsxfrm
104
105 // stdio.h functions
106# define wxFgetc _fgettc
107# define wxFgetchar _fgettchar
108# define wxFgets _fgetts
109# define wxFopen _tfopen
110# define wxFputc _fputtc
111# define wxFputchar _fputtchar
112# define wxFprintf _ftprintf
113# define wxFreopen _tfreopen
114# define wxFscanf _ftscanf
115# define wxGetc _gettc
116# define wxGetchar _gettchar
117# define wxGets _getts
118# define wxPerror _tperror
119# define wxPrintf _tprintf
120# define wxPutc _puttc
121# define wxPutchar _puttchar
122# define wxPuts _putts
123# define wxRemove _tremove
124# define wxRename _trename
125# define wxScanf _tscanf
126# define wxSprintf _stprintf
127# define wxSscanf _stscanf
128# define wxTmpnam _ttmpnam
129# define wxUngetc _tungetc
130# define wxVfprint _vftprintf
131# define wxVprintf _vtprintf
132# define wxVsscanf _vstscanf
133# define wxVsprintf _vstprintf
134
135 // stdlib.h functions
136# if !wxUSE_UNICODE
137# define wxAtof atof
138# endif
139# define wxAtoi _ttoi
140# define wxAtol _ttol
141# define wxGetenv _tgetenv
142# define wxSystem _tsystem
143
144 // time.h functions
145# define wxAsctime _tasctime
146# define wxCtime _tctime
147
148// #elif defined(XXX)
149 // #include XXX-specific files here
150 // typeddef YYY wxChar;
151
152 // translate wxZZZ names
153
154#elif defined(__BORLANDC__) && defined(__WIN32__)
155
156// Borland C++ 4.52 doesn't have much tchar support
157// maybe Borland C++ 5.02 has, can't check right now
158// but I'll use the Win32 API instead here
159
160# include <tchar.h>
161# if wxUSE_UNICODE // temporary - preserve binary compatibility
162typedef _TCHAR wxChar;
163typedef _TSCHAR wxSChar;
164typedef _TUCHAR wxUChar;
165# else
166# define wxChar char
167# define wxSChar signed char
168# define wxUChar unsigned char
169# endif
170 // wchar_t is available
171# undef wxUSE_WCHAR_T
172# define wxUSE_WCHAR_T 1
173
174# define wxNEED_WX_CTYPE_H
175// #define wxStrtok strtok_r // Borland C++ 4.52 doesn't have strtok_r
176# define wxNEED_WX_STRING_H
177# define wxNEED_WX_STDIO_H
178# define wxNEED_WX_STDLIB_H
179# define wxNEED_WX_TIME_H
180# define wxNEED_WCSLEN
181
182#else//!TCHAR-aware compilers
183
184// check whether we should include wchar.h or equivalent
185# if wxUSE_UNICODE
186# undef wxUSE_WCHAR_T
187# define wxUSE_WCHAR_T 1 // wchar_t *must* be available in Unicode mode
188# elif !defined(wxUSE_WCHAR_T)
189# if defined(__VISUALC__) && (__VISUALC__ < 900)
190# define wxUSE_WCHAR_T 0 // wchar_t is not available for MSVC++ 1.5
191# elif defined(__UNIX__)
192# if defined(HAVE_WCSTR_H) || defined(HAVE_WCHAR_H) || defined(__FreeBSD__)
193# define wxUSE_WCHAR_T 1
194# else
195# define wxUSE_WCHAR_T 0
196# endif
197# elif defined(__GNUWIN32__) && !defined(__MINGW32__) // Cygwin (not Mingw32) doesn't have wcslen.h, needed in buffer.h
198# define wxUSE_WCHAR_T 0
199# elif defined(__BORLANDC__) // WIN16 BC++
200# define wxUSE_WCHAR_T 0
201# elif defined(__WATCOMC__)
202# define wxUSE_WCHAR_T 0
203# else
204 // add additional compiler checks if this fails
205# define wxUSE_WCHAR_T 1
206# endif
207# endif//wxUSE_UNICODE
208
209# if wxUSE_WCHAR_T
210# ifdef HAVE_WCSTR_H
211# include <wcstr.h>
212# else
213# ifndef __FreeBSD__
214# include <wchar.h>
215# else
216# include <stdlib.h>
217# define wxNEED_WCSLEN
218# endif
219# endif
220# endif
221
222// check whether we are doing Unicode
223# if wxUSE_UNICODE
224
225# include <wctype.h>
226
227// this is probably glibc-specific
228# if defined(__WCHAR_TYPE__)
229
230typedef __WCHAR_TYPE__ wxChar;
231typedef signed __WCHAR_TYPE__ wxSChar;
232typedef unsigned __WCHAR_TYPE__ wxUChar;
233
234# define _T(x) L##x
235
236 // ctype.h functions (wctype.h)
237# define wxIsalnum iswalnum
238# define wxIsalpha iswalpha
239# define wxIsctrl iswcntrl
240# define wxIsdigit iswdigit
241# define wxIsgraph iswgraph
242# define wxIslower iswlower
243# define wxIsprint iswprint
244# define wxIspunct iswpunct
245# define wxIsspace iswspace
246# define wxIsupper iswupper
247# define wxIsxdigit iswxdigit
248
249# if defined(__GLIBC__) && (__GLIBC__ == 2) && (__GLIBC_MINOR__ == 0)
250 // /usr/include/wctype.h incorrectly declares translations tables which
251 // provokes tons of compile-time warnings - try to correct this
252# define wxTolower(wc) towctrans((wc), (wctrans_t)__ctype_tolower)
253# define wxToupper(wc) towctrans((wc), (wctrans_t)__ctype_toupper)
254# else
255# define wxTolower towlower
256# define wxToupper towupper
257# endif // gcc/!gcc
258
259 // string.h functions (wchar.h)
260# define wxStrcat wcscat
261# define wxStrchr wcschr
262# define wxStrcmp wcscmp
263# define wxStrcoll wcscoll
264# define wxStrcpy wcscpy
265# define wxStrcspn wcscspn
266# define wxStrlen_ wcslen // used in wxStrlen inline function
267# define wxStrncat wcsncat
268# define wxStrncmp wcsncmp
269# define wxStrncpy wcsncpy
270# define wxStrpbrk wcspbrk
271# define wxStrrchr wcsrchr
272# define wxStrspn wcsspn
273# define wxStrstr wcsstr
274# define wxStrtod wcstod
275# define wxStrtok wcstok
276# define wxStrtol wcstol
277# define wxStrtoul wcstoul
278# define wxStrxfrm wcsxfrm
279
280// glibc doesn't have wc equivalents of the other stuff
281# define wxNEED_WX_STDIO_H
282# define wxNEED_WX_STDLIB_H
283# define wxNEED_WX_TIME_H
284
285# else//!glibc
286# error "Please define your compiler's Unicode conventions in wxChar.h"
287# endif
288# else//!Unicode
289
290# include <ctype.h>
291# include <string.h>
292
293# if 0 // temporary - preserve binary compatibilty
294 typedef char wxChar;
295 typedef signed char wxSChar;
296 typedef unsigned char wxUChar;
297# else
298# define wxChar char
299# define wxSChar signed char
300# define wxUChar unsigned char
301# endif
302
303# ifdef __FreeBSD__
304# undef _T
305# endif
306
307# if !defined(__MINGW32__) || !defined(_T)
308# define _T(x) x
309# endif
310
311 // ctype.h functions
312# define wxIsalnum isalnum
313# define wxIsalpha isalpha
314# define wxIsctrl isctrl
315# define wxIsdigit isdigit
316# define wxIsgraph isgraph
317# define wxIslower islower
318# define wxIsprint isprint
319# define wxIspunct ispunct
320# define wxIsspace isspace
321# define wxIsupper isupper
322# define wxIsxdigit isxdigit
323# define wxTolower tolower
324# define wxToupper toupper
325
326 // locale.h functons
327# define wxSetlocale setlocale
328
329 // string.h functions
330 // #define wxStricmp strcasecmp
331 // wxStricmp is defined below!!
332
333 #ifdef HAVE_STRTOK_R
334 #define wxStrtok(str, sep, last) strtok_r(str, sep, last)
335 #else
336 #define wxStrtok(str, sep, last) strtok(str, sep)
337 #endif
338
339 // leave the rest to defaults below
340# define wxNEED_WX_STRING_H
341# define wxNEED_WX_STDIO_H
342# define wxNEED_WX_STDLIB_H
343# define wxNEED_WX_TIME_H
344
345# endif//Unicode
346#endif//TCHAR-aware compilers
347
348// define wxStricmp for various compilers without Unicode possibilities
349#if !defined(wxStricmp) && !wxUSE_UNICODE
350# if defined(__BORLANDC__) || defined(__WATCOMC__) || defined(__SALFORDC__) || defined(__VISAGECPP__) || defined(__EMX__)
351# define wxStricmp stricmp
352# elif defined(__SC__) || defined(__VISUALC__) || (defined(__MWERKS__) && defined(__INTEL__))
353# define wxStricmp _stricmp
354# elif defined(__UNIX__) || defined(__GNUWIN32__)
355# define wxStricmp strcasecmp
356# elif defined(__MWERKS__) && !defined(__INTEL__)
357 // use wxWindows' implementation
358# else
359 // if you leave wxStricmp undefined, wxWindows' implementation will be used
360# error "Please define string case-insensitive compare for your OS/compiler"
361# endif
362#endif
363
364// if we need to define for standard headers, and we're not using Unicode,
365// just define to standard C library routines
366#if !wxUSE_UNICODE
367# ifdef wxNEED_WX_STRING_H
368# define wxStrcat strcat
369# define wxStrchr strchr
370# define wxStrcmp strcmp
371# define wxStrcoll strcoll
372# define wxStrcpy strcpy
373# define wxStrcspn strcspn
374# define wxStrdup strdup
375# define wxStrlen_ strlen // used in wxStrlen inline function
376# define wxStrncat strncat
377# define wxStrncmp strncmp
378# define wxStrncpy strncpy
379# define wxStrpbrk strpbrk
380# define wxStrrchr strrchr
381# define wxStrspn strspn
382# define wxStrstr strstr
383# define wxStrtod strtod
384# define wxStrtol strtol
385# define wxStrtoul strtoul
386# define wxStrxfrm strxfrm
387# undef wxNEED_WX_STRING_H
388# endif
389
390# ifdef wxNEED_WX_STDIO_H
391# define wxFgetc fgetc
392# define wxFgetchar fgetchar
393# define wxFgets fgets
394# define wxFopen fopen
395# define wxFputc fputc
396# define wxFputchar fputchar
397# define wxFprintf fprintf
398# define wxFreopen freopen
399# define wxFscanf fscanf
400# define wxGetc getc
401# define wxGetchar getchar
402# define wxGets gets
403# define wxPerror perror
404# define wxPrintf printf
405# define wxPutc putc
406# define wxPutchar putchar
407# define wxPuts puts
408# define wxRemove remove
409# define wxRename rename
410# define wxScanf scanf
411# define wxSprintf sprintf
412# define wxSscanf sscanf
413# define wxTmpnam tmpnam
414# define wxUngetc ungetc
415# define wxVfprint vfprintf
416# define wxVprintf vprintf
417# define wxVsscanf vsscanf
418# define wxVsprintf vsprintf
419# undef wxNEED_WX_STDIO_H
420# endif
421
422# ifdef wxNEED_WX_STDLIB_H
423# define wxAtof atof
424# define wxAtoi atoi
425# define wxAtol atol
426# define wxGetenv getenv
427# define wxSystem system
428# undef wxNEED_WX_STDLIB_H
429# endif
430
431# ifdef wxNEED_WX_TIME_H
432# define wxAsctime asctime
433# define wxCtime ctime
434# define wxStrftime strftime
435# undef wxNEED_WX_TIME_H
436# endif
437#endif //!Unicode
438
439#if defined(wxNEED_WCSLEN) && wxUSE_UNICODE
440# define wcslen wxStrlen
441# undef wxNEED_WCSLEN
442#endif
443
444/// checks whether the passed in pointer is NULL and if the string is empty
445WXDLLEXPORT inline bool wxIsEmpty(const wxChar *p) { return !p || !*p; }
446
447#ifndef wxNEED_WX_STRING_H
448/// safe version of strlen() (returns 0 if passed NULL pointer)
449WXDLLEXPORT inline size_t wxStrlen(const wxChar *psz)
450 { return psz ? wxStrlen_(psz) : 0; }
451#endif
452
453#if wxUSE_WCHAR_T
454// multibyte<->widechar conversion
455WXDLLEXPORT size_t wxMB2WC(wchar_t *buf, const char *psz, size_t n);
456WXDLLEXPORT size_t wxWC2MB(char *buf, const wchar_t *psz, size_t n);
457# if wxUSE_UNICODE
458# define wxMB2WX wxMB2WC
459# define wxWX2MB wxWC2MB
460# define wxWC2WX wxStrncpy
461# define wxWX2WC wxStrncpy
462# else
463# define wxMB2WX wxStrncpy
464# define wxWX2MB wxStrncpy
465# define wxWC2WX wxWC2MB
466# define wxWX2WC wxMB2WC
467# endif
468#else
469// No wxUSE_WCHAR_T: we have to do something (JACS)
470# define wxMB2WC wxStrncpy
471# define wxWC2MB wxStrncpy
472# define wxMB2WX wxStrncpy
473# define wxWX2MB wxStrncpy
474# define wxWC2WX wxWC2MB
475# define wxWX2WC wxMB2WC
476#endif
477
478WXDLLEXPORT bool wxOKlibc(); // for internal use
479
480// if libc versions are not available, use replacements defined in wxchar.cpp
481#ifndef wxStrdup
482WXDLLEXPORT wxChar * wxStrdup(const wxChar *psz);
483#endif
484
485#ifndef wxStricmp
486WXDLLEXPORT int wxStricmp(const wxChar *psz1, const wxChar *psz2);
487#endif
488
489#ifndef wxStrtok
490WXDLLEXPORT wxChar * wxStrtok(wxChar *psz, const wxChar *delim, wxChar **save_ptr);
491#endif
492
493#ifndef wxSetlocale
494WXDLLEXPORT wxChar * wxSetlocale(int category, const wxChar *locale);
495#endif
496
497#ifdef wxNEED_WCSLEN // for use in buffer.h
498WXDLLEXPORT size_t wcslen(const wchar_t *s);
499#endif
500
501#ifdef wxNEED_WX_CTYPE_H
502WXDLLEXPORT int wxIsalnum(wxChar ch);
503WXDLLEXPORT int wxIsalpha(wxChar ch);
504WXDLLEXPORT int wxIsctrl(wxChar ch);
505WXDLLEXPORT int wxIsdigit(wxChar ch);
506WXDLLEXPORT int wxIsgraph(wxChar ch);
507WXDLLEXPORT int wxIslower(wxChar ch);
508WXDLLEXPORT int wxIsprint(wxChar ch);
509WXDLLEXPORT int wxIspunct(wxChar ch);
510WXDLLEXPORT int wxIsspace(wxChar ch);
511WXDLLEXPORT int wxIsupper(wxChar ch);
512WXDLLEXPORT int wxIsxdigit(wxChar ch);
513WXDLLEXPORT int wxTolower(wxChar ch);
514WXDLLEXPORT int wxToupper(wxChar ch);
515#endif
516
517#ifdef wxNEED_WX_STRING_H
518WXDLLEXPORT wxChar * wxStrcat(wxChar *dest, const wxChar *src);
519WXDLLEXPORT wxChar * wxStrchr(const wxChar *s, wxChar c);
520WXDLLEXPORT int wxStrcmp(const wxChar *s1, const wxChar *s2);
521WXDLLEXPORT int wxStrcoll(const wxChar *s1, const wxChar *s2);
522WXDLLEXPORT wxChar * wxStrcpy(wxChar *dest, const wxChar *src);
523WXDLLEXPORT size_t wxStrcspn(const wxChar *s, const wxChar *reject);
524WXDLLEXPORT size_t wxStrlen(const wxChar *s);
525WXDLLEXPORT wxChar * wxStrncat(wxChar *dest, const wxChar *src, size_t n);
526WXDLLEXPORT int wxStrncmp(const wxChar *s1, const wxChar *s2, size_t n);
527WXDLLEXPORT wxChar * wxStrncpy(wxChar *dest, const wxChar *src, size_t n);
528WXDLLEXPORT wxChar * wxStrpbrk(const wxChar *s, const wxChar *accept);
529WXDLLEXPORT wxChar * wxStrrchr(const wxChar *s, wxChar c);
530WXDLLEXPORT size_t wxStrspn(const wxChar *s, const wxChar *accept);
531WXDLLEXPORT wxChar * wxStrstr(const wxChar *haystack, const wxChar *needle);
532WXDLLEXPORT double wxStrtod(const wxChar *nptr, wxChar **endptr);
533WXDLLEXPORT long int wxStrtol(const wxChar *nptr, wxChar **endptr, int base);
534WXDLLEXPORT unsigned long int wxStrtoul(const wxChar *nptr, wxChar **endptr, int base);
535WXDLLEXPORT size_t wxStrxfrm(wxChar *dest, const wxChar *src, size_t n);
536#endif
537
538#ifdef wxNEED_WX_STDIO_H
539# include <stdio.h>
540# include <stdarg.h>
541WXDLLEXPORT FILE * wxFopen(const wxChar *path, const wxChar *mode);
542WXDLLEXPORT FILE * wxFreopen(const wxChar *path, const wxChar *mode, FILE *stream);
543WXDLLEXPORT int wxPrintf(const wxChar *fmt, ...);
544WXDLLEXPORT int wxVprintf(const wxChar *fmt, va_list argptr);
545WXDLLEXPORT int wxFprintf(FILE *stream, const wxChar *fmt, ...);
546WXDLLEXPORT int wxVfprintf(FILE *stream, const wxChar *fmt, va_list argptr);
547WXDLLEXPORT int wxSprintf(wxChar *buf, const wxChar *fmt, ...);
548WXDLLEXPORT int wxVsprintf(wxChar *buf, const wxChar *fmt, va_list argptr);
549WXDLLEXPORT int wxSscanf(const wxChar *buf, const wxChar *fmt, ...);
550WXDLLEXPORT int wxVsscanf(const wxChar *buf, const wxChar *fmt, va_list argptr);
551#endif
552
553#ifndef wxAtof
554WXDLLEXPORT double wxAtof(const wxChar *psz);
555#endif
556
557#ifdef wxNEED_WX_STDLIB_H
558WXDLLEXPORT int wxAtoi(const wxChar *psz);
559WXDLLEXPORT long wxAtol(const wxChar *psz);
560WXDLLEXPORT wxChar * wxGetenv(const wxChar *name);
561WXDLLEXPORT int wxSystem(const wxChar *psz);
562#endif
563
564#ifdef wxNEED_WX_TIME_H
565WXDLLEXPORT size_t wxStrftime(wxChar *s, size_t max, const wxChar *fmt, const struct tm *tm);
566#endif
567
568// although global macros with such names are really bad, we want to have
569// another name for _T() which should be used to avoid confusion between _T()
570// and _() in wxWindows sources
571#define wxT(x) _T(x)
572
573// a Unicode-friendly __FILE__ analog
574#ifndef __TFILE__
575 #define __XFILE__(x) wxT(x)
576 #define __TFILE__ __XFILE__(__FILE__)
577#endif
578
579#endif
580 //_WX_WXCHAR_H_
581