wined3d: Get rid of the WINED3DGAMMARAMP typedef.
[wine] / include / wine / unicode.h
1 /*
2  * Wine internal Unicode definitions
3  *
4  * Copyright 2000 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #ifndef __WINE_WINE_UNICODE_H
22 #define __WINE_WINE_UNICODE_H
23
24 #include <stdarg.h>
25
26 #include <windef.h>
27 #include <winbase.h>
28 #include <winnls.h>
29
30 #ifdef __WINE_WINE_TEST_H
31 #error This file should not be used in Wine tests
32 #endif
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 #ifndef WINE_UNICODE_API
39 # if defined(_MSC_VER) || defined(__MINGW32__)
40 #  define WINE_UNICODE_API DECLSPEC_IMPORT
41 # else
42 #  define WINE_UNICODE_API
43 # endif
44 #endif
45
46 #ifndef WINE_UNICODE_INLINE
47 #define WINE_UNICODE_INLINE static inline
48 #endif
49
50 /* code page info common to SBCS and DBCS */
51 struct cp_info
52 {
53     unsigned int          codepage;          /* codepage id */
54     unsigned int          char_size;         /* char size (1 or 2 bytes) */
55     WCHAR                 def_char;          /* default char value (can be double-byte) */
56     WCHAR                 def_unicode_char;  /* default Unicode char value */
57     const char           *name;              /* code page name */
58 };
59
60 struct sbcs_table
61 {
62     struct cp_info        info;
63     const WCHAR          *cp2uni;            /* code page -> Unicode map */
64     const WCHAR          *cp2uni_glyphs;     /* code page -> Unicode map with glyph chars */
65     const unsigned char  *uni2cp_low;        /* Unicode -> code page map */
66     const unsigned short *uni2cp_high;
67 };
68
69 struct dbcs_table
70 {
71     struct cp_info        info;
72     const WCHAR          *cp2uni;            /* code page -> Unicode map */
73     const unsigned char  *cp2uni_leadbytes;
74     const unsigned short *uni2cp_low;        /* Unicode -> code page map */
75     const unsigned short *uni2cp_high;
76     unsigned char         lead_bytes[12];    /* lead bytes ranges */
77 };
78
79 union cptable
80 {
81     struct cp_info    info;
82     struct sbcs_table sbcs;
83     struct dbcs_table dbcs;
84 };
85
86 extern const union cptable *wine_cp_get_table( unsigned int codepage );
87 extern const union cptable *wine_cp_enum_table( unsigned int index );
88
89 extern int wine_cp_mbstowcs( const union cptable *table, int flags,
90                              const char *src, int srclen,
91                              WCHAR *dst, int dstlen );
92 extern int wine_cp_wcstombs( const union cptable *table, int flags,
93                              const WCHAR *src, int srclen,
94                              char *dst, int dstlen, const char *defchar, int *used );
95 extern int wine_cpsymbol_mbstowcs( const char *src, int srclen, WCHAR *dst, int dstlen );
96 extern int wine_cpsymbol_wcstombs( const WCHAR *src, int srclen, char *dst, int dstlen );
97 extern int wine_utf8_mbstowcs( int flags, const char *src, int srclen, WCHAR *dst, int dstlen );
98 extern int wine_utf8_wcstombs( int flags, const WCHAR *src, int srclen, char *dst, int dstlen );
99
100 extern int wine_compare_string( int flags, const WCHAR *str1, int len1, const WCHAR *str2, int len2 );
101 extern int wine_get_sortkey( int flags, const WCHAR *src, int srclen, char *dst, int dstlen );
102 extern int wine_fold_string( int flags, const WCHAR *src, int srclen , WCHAR *dst, int dstlen );
103
104 extern int strcmpiW( const WCHAR *str1, const WCHAR *str2 );
105 extern int strncmpiW( const WCHAR *str1, const WCHAR *str2, int n );
106 extern int memicmpW( const WCHAR *str1, const WCHAR *str2, int n );
107 extern WCHAR *strstrW( const WCHAR *str, const WCHAR *sub );
108 extern long int strtolW( const WCHAR *nptr, WCHAR **endptr, int base );
109 extern unsigned long int strtoulW( const WCHAR *nptr, WCHAR **endptr, int base );
110 extern int sprintfW( WCHAR *str, const WCHAR *format, ... );
111 extern int snprintfW( WCHAR *str, size_t len, const WCHAR *format, ... );
112 extern int vsprintfW( WCHAR *str, const WCHAR *format, va_list valist );
113 extern int vsnprintfW( WCHAR *str, size_t len, const WCHAR *format, va_list valist );
114
115 WINE_UNICODE_INLINE int wine_is_dbcs_leadbyte( const union cptable *table, unsigned char ch )
116 {
117     return (table->info.char_size == 2) && (table->dbcs.cp2uni_leadbytes[ch]);
118 }
119
120 WINE_UNICODE_INLINE WCHAR tolowerW( WCHAR ch )
121 {
122     extern WINE_UNICODE_API const WCHAR wine_casemap_lower[];
123     return ch + wine_casemap_lower[wine_casemap_lower[ch >> 8] + (ch & 0xff)];
124 }
125
126 WINE_UNICODE_INLINE WCHAR toupperW( WCHAR ch )
127 {
128     extern WINE_UNICODE_API const WCHAR wine_casemap_upper[];
129     return ch + wine_casemap_upper[wine_casemap_upper[ch >> 8] + (ch & 0xff)];
130 }
131
132 /* the character type contains the C1_* flags in the low 12 bits */
133 /* and the C2_* type in the high 4 bits */
134 WINE_UNICODE_INLINE unsigned short get_char_typeW( WCHAR ch )
135 {
136     extern WINE_UNICODE_API const unsigned short wine_wctype_table[];
137     return wine_wctype_table[wine_wctype_table[ch >> 8] + (ch & 0xff)];
138 }
139
140 WINE_UNICODE_INLINE int iscntrlW( WCHAR wc )
141 {
142     return get_char_typeW(wc) & C1_CNTRL;
143 }
144
145 WINE_UNICODE_INLINE int ispunctW( WCHAR wc )
146 {
147     return get_char_typeW(wc) & C1_PUNCT;
148 }
149
150 WINE_UNICODE_INLINE int isspaceW( WCHAR wc )
151 {
152     return get_char_typeW(wc) & C1_SPACE;
153 }
154
155 WINE_UNICODE_INLINE int isdigitW( WCHAR wc )
156 {
157     return get_char_typeW(wc) & C1_DIGIT;
158 }
159
160 WINE_UNICODE_INLINE int isxdigitW( WCHAR wc )
161 {
162     return get_char_typeW(wc) & C1_XDIGIT;
163 }
164
165 WINE_UNICODE_INLINE int islowerW( WCHAR wc )
166 {
167     return get_char_typeW(wc) & C1_LOWER;
168 }
169
170 WINE_UNICODE_INLINE int isupperW( WCHAR wc )
171 {
172     return get_char_typeW(wc) & C1_UPPER;
173 }
174
175 WINE_UNICODE_INLINE int isalnumW( WCHAR wc )
176 {
177     return get_char_typeW(wc) & (C1_ALPHA|C1_DIGIT|C1_LOWER|C1_UPPER);
178 }
179
180 WINE_UNICODE_INLINE int isalphaW( WCHAR wc )
181 {
182     return get_char_typeW(wc) & (C1_ALPHA|C1_LOWER|C1_UPPER);
183 }
184
185 WINE_UNICODE_INLINE int isgraphW( WCHAR wc )
186 {
187     return get_char_typeW(wc) & (C1_ALPHA|C1_PUNCT|C1_DIGIT|C1_LOWER|C1_UPPER);
188 }
189
190 WINE_UNICODE_INLINE int isprintW( WCHAR wc )
191 {
192     return get_char_typeW(wc) & (C1_ALPHA|C1_BLANK|C1_PUNCT|C1_DIGIT|C1_LOWER|C1_UPPER);
193 }
194
195 /* some useful string manipulation routines */
196
197 WINE_UNICODE_INLINE unsigned int strlenW( const WCHAR *str )
198 {
199     const WCHAR *s = str;
200     while (*s) s++;
201     return s - str;
202 }
203
204 WINE_UNICODE_INLINE WCHAR *strcpyW( WCHAR *dst, const WCHAR *src )
205 {
206     WCHAR *p = dst;
207     while ((*p++ = *src++));
208     return dst;
209 }
210
211 /* strncpy doesn't do what you think, don't use it */
212 #define strncpyW(d,s,n) error do_not_use_strncpyW_use_lstrcpynW_or_memcpy_instead
213
214 WINE_UNICODE_INLINE int strcmpW( const WCHAR *str1, const WCHAR *str2 )
215 {
216     while (*str1 && (*str1 == *str2)) { str1++; str2++; }
217     return *str1 - *str2;
218 }
219
220 WINE_UNICODE_INLINE int strncmpW( const WCHAR *str1, const WCHAR *str2, int n )
221 {
222     if (n <= 0) return 0;
223     while ((--n > 0) && *str1 && (*str1 == *str2)) { str1++; str2++; }
224     return *str1 - *str2;
225 }
226
227 WINE_UNICODE_INLINE WCHAR *strcatW( WCHAR *dst, const WCHAR *src )
228 {
229     strcpyW( dst + strlenW(dst), src );
230     return dst;
231 }
232
233 WINE_UNICODE_INLINE WCHAR *strchrW( const WCHAR *str, WCHAR ch )
234 {
235     do { if (*str == ch) return (WCHAR *)(ULONG_PTR)str; } while (*str++);
236     return NULL;
237 }
238
239 WINE_UNICODE_INLINE WCHAR *strrchrW( const WCHAR *str, WCHAR ch )
240 {
241     WCHAR *ret = NULL;
242     do { if (*str == ch) ret = (WCHAR *)(ULONG_PTR)str; } while (*str++);
243     return ret;
244 }
245
246 WINE_UNICODE_INLINE WCHAR *strpbrkW( const WCHAR *str, const WCHAR *accept )
247 {
248     for ( ; *str; str++) if (strchrW( accept, *str )) return (WCHAR *)(ULONG_PTR)str;
249     return NULL;
250 }
251
252 WINE_UNICODE_INLINE size_t strspnW( const WCHAR *str, const WCHAR *accept )
253 {
254     const WCHAR *ptr;
255     for (ptr = str; *ptr; ptr++) if (!strchrW( accept, *ptr )) break;
256     return ptr - str;
257 }
258
259 WINE_UNICODE_INLINE size_t strcspnW( const WCHAR *str, const WCHAR *reject )
260 {
261     const WCHAR *ptr;
262     for (ptr = str; *ptr; ptr++) if (strchrW( reject, *ptr )) break;
263     return ptr - str;
264 }
265
266 WINE_UNICODE_INLINE WCHAR *strlwrW( WCHAR *str )
267 {
268     WCHAR *ret;
269     for (ret = str; *str; str++) *str = tolowerW(*str);
270     return ret;
271 }
272
273 WINE_UNICODE_INLINE WCHAR *struprW( WCHAR *str )
274 {
275     WCHAR *ret;
276     for (ret = str; *str; str++) *str = toupperW(*str);
277     return ret;
278 }
279
280 WINE_UNICODE_INLINE WCHAR *memchrW( const WCHAR *ptr, WCHAR ch, size_t n )
281 {
282     const WCHAR *end;
283     for (end = ptr + n; ptr < end; ptr++) if (*ptr == ch) return (WCHAR *)(ULONG_PTR)ptr;
284     return NULL;
285 }
286
287 WINE_UNICODE_INLINE WCHAR *memrchrW( const WCHAR *ptr, WCHAR ch, size_t n )
288 {
289     const WCHAR *end;
290     WCHAR *ret = NULL;
291     for (end = ptr + n; ptr < end; ptr++) if (*ptr == ch) ret = (WCHAR *)(ULONG_PTR)ptr;
292     return ret;
293 }
294
295 WINE_UNICODE_INLINE long int atolW( const WCHAR *str )
296 {
297     return strtolW( str, (WCHAR **)0, 10 );
298 }
299
300 WINE_UNICODE_INLINE int atoiW( const WCHAR *str )
301 {
302     return (int)atolW( str );
303 }
304
305 #undef WINE_UNICODE_INLINE
306
307 #ifdef __cplusplus
308 }
309 #endif
310
311 #endif  /* __WINE_WINE_UNICODE_H */