dsound: Implement QueryInterface for KsPropertySet objects.
[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 #ifndef WINE_UNICODE_API
35 #define WINE_UNICODE_API DECLSPEC_IMPORT
36 #endif
37
38 #ifndef WINE_UNICODE_INLINE
39 #define WINE_UNICODE_INLINE extern inline
40 #endif
41
42 /* code page info common to SBCS and DBCS */
43 struct cp_info
44 {
45     unsigned int          codepage;          /* codepage id */
46     unsigned int          char_size;         /* char size (1 or 2 bytes) */
47     WCHAR                 def_char;          /* default char value (can be double-byte) */
48     WCHAR                 def_unicode_char;  /* default Unicode char value */
49     const char           *name;              /* code page name */
50 };
51
52 struct sbcs_table
53 {
54     struct cp_info        info;
55     const WCHAR          *cp2uni;            /* code page -> Unicode map */
56     const unsigned char  *uni2cp_low;        /* Unicode -> code page map */
57     const unsigned short *uni2cp_high;
58 };
59
60 struct dbcs_table
61 {
62     struct cp_info        info;
63     const WCHAR          *cp2uni;            /* code page -> Unicode map */
64     const unsigned char  *cp2uni_leadbytes;
65     const unsigned short *uni2cp_low;        /* Unicode -> code page map */
66     const unsigned short *uni2cp_high;
67     unsigned char         lead_bytes[12];    /* lead bytes ranges */
68 };
69
70 union cptable
71 {
72     struct cp_info    info;
73     struct sbcs_table sbcs;
74     struct dbcs_table dbcs;
75 };
76
77 extern const union cptable *wine_cp_get_table( unsigned int codepage );
78 extern const union cptable *wine_cp_enum_table( unsigned int index );
79
80 extern int wine_cp_mbstowcs( const union cptable *table, int flags,
81                              const char *src, int srclen,
82                              WCHAR *dst, int dstlen );
83 extern int wine_cp_wcstombs( const union cptable *table, int flags,
84                              const WCHAR *src, int srclen,
85                              char *dst, int dstlen, const char *defchar, int *used );
86 extern int wine_cpsymbol_mbstowcs( const char *src, int srclen, WCHAR *dst, int dstlen );
87 extern int wine_cpsymbol_wcstombs( const WCHAR *src, int srclen, char *dst, int dstlen );
88 extern int wine_utf8_mbstowcs( int flags, const char *src, int srclen, WCHAR *dst, int dstlen );
89 extern int wine_utf8_wcstombs( int flags, const WCHAR *src, int srclen, char *dst, int dstlen );
90
91 extern int wine_compare_string( int flags, const WCHAR *str1, int len1, const WCHAR *str2, int len2 );
92 extern int wine_get_sortkey( int flags, const WCHAR *src, int srclen, char *dst, int dstlen );
93 extern int wine_fold_string( int flags, const WCHAR *src, int srclen , WCHAR *dst, int dstlen );
94
95 extern int strcmpiW( const WCHAR *str1, const WCHAR *str2 );
96 extern int strncmpiW( const WCHAR *str1, const WCHAR *str2, int n );
97 extern int memicmpW( const WCHAR *str1, const WCHAR *str2, int n );
98 extern WCHAR *strstrW( const WCHAR *str, const WCHAR *sub );
99 extern long int strtolW( const WCHAR *nptr, WCHAR **endptr, int base );
100 extern unsigned long int strtoulW( const WCHAR *nptr, WCHAR **endptr, int base );
101 extern int sprintfW( WCHAR *str, const WCHAR *format, ... );
102 extern int snprintfW( WCHAR *str, size_t len, const WCHAR *format, ... );
103 extern int vsprintfW( WCHAR *str, const WCHAR *format, va_list valist );
104 extern int vsnprintfW( WCHAR *str, size_t len, const WCHAR *format, va_list valist );
105
106 WINE_UNICODE_INLINE int wine_is_dbcs_leadbyte( const union cptable *table, unsigned char ch );
107 WINE_UNICODE_INLINE int wine_is_dbcs_leadbyte( const union cptable *table, unsigned char ch )
108 {
109     return (table->info.char_size == 2) && (table->dbcs.cp2uni_leadbytes[ch]);
110 }
111
112 WINE_UNICODE_INLINE WCHAR tolowerW( WCHAR ch );
113 WINE_UNICODE_INLINE WCHAR tolowerW( WCHAR ch )
114 {
115     extern WINE_UNICODE_API const WCHAR wine_casemap_lower[];
116     return ch + wine_casemap_lower[wine_casemap_lower[ch >> 8] + (ch & 0xff)];
117 }
118
119 WINE_UNICODE_INLINE WCHAR toupperW( WCHAR ch );
120 WINE_UNICODE_INLINE WCHAR toupperW( WCHAR ch )
121 {
122     extern WINE_UNICODE_API const WCHAR wine_casemap_upper[];
123     return ch + wine_casemap_upper[wine_casemap_upper[ch >> 8] + (ch & 0xff)];
124 }
125
126 /* the character type contains the C1_* flags in the low 12 bits */
127 /* and the C2_* type in the high 4 bits */
128 WINE_UNICODE_INLINE unsigned short get_char_typeW( WCHAR ch );
129 WINE_UNICODE_INLINE unsigned short get_char_typeW( WCHAR ch )
130 {
131     extern WINE_UNICODE_API const unsigned short wine_wctype_table[];
132     return wine_wctype_table[wine_wctype_table[ch >> 8] + (ch & 0xff)];
133 }
134
135 WINE_UNICODE_INLINE int iscntrlW( WCHAR wc );
136 WINE_UNICODE_INLINE int iscntrlW( WCHAR wc )
137 {
138     return get_char_typeW(wc) & C1_CNTRL;
139 }
140
141 WINE_UNICODE_INLINE int ispunctW( WCHAR wc );
142 WINE_UNICODE_INLINE int ispunctW( WCHAR wc )
143 {
144     return get_char_typeW(wc) & C1_PUNCT;
145 }
146
147 WINE_UNICODE_INLINE int isspaceW( WCHAR wc );
148 WINE_UNICODE_INLINE int isspaceW( WCHAR wc )
149 {
150     return get_char_typeW(wc) & C1_SPACE;
151 }
152
153 WINE_UNICODE_INLINE int isdigitW( WCHAR wc );
154 WINE_UNICODE_INLINE int isdigitW( WCHAR wc )
155 {
156     return get_char_typeW(wc) & C1_DIGIT;
157 }
158
159 WINE_UNICODE_INLINE int isxdigitW( WCHAR wc );
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 WINE_UNICODE_INLINE int islowerW( WCHAR wc )
167 {
168     return get_char_typeW(wc) & C1_LOWER;
169 }
170
171 WINE_UNICODE_INLINE int isupperW( WCHAR wc );
172 WINE_UNICODE_INLINE int isupperW( WCHAR wc )
173 {
174     return get_char_typeW(wc) & C1_UPPER;
175 }
176
177 WINE_UNICODE_INLINE int isalnumW( WCHAR wc );
178 WINE_UNICODE_INLINE int isalnumW( WCHAR wc )
179 {
180     return get_char_typeW(wc) & (C1_ALPHA|C1_DIGIT|C1_LOWER|C1_UPPER);
181 }
182
183 WINE_UNICODE_INLINE int isalphaW( WCHAR wc );
184 WINE_UNICODE_INLINE int isalphaW( WCHAR wc )
185 {
186     return get_char_typeW(wc) & (C1_ALPHA|C1_LOWER|C1_UPPER);
187 }
188
189 WINE_UNICODE_INLINE int isgraphW( WCHAR wc );
190 WINE_UNICODE_INLINE int isgraphW( WCHAR wc )
191 {
192     return get_char_typeW(wc) & (C1_ALPHA|C1_PUNCT|C1_DIGIT|C1_LOWER|C1_UPPER);
193 }
194
195 WINE_UNICODE_INLINE int isprintW( WCHAR wc );
196 WINE_UNICODE_INLINE int isprintW( WCHAR wc )
197 {
198     return get_char_typeW(wc) & (C1_ALPHA|C1_BLANK|C1_PUNCT|C1_DIGIT|C1_LOWER|C1_UPPER);
199 }
200
201 /* some useful string manipulation routines */
202
203 WINE_UNICODE_INLINE unsigned int strlenW( const WCHAR *str );
204 WINE_UNICODE_INLINE unsigned int strlenW( const WCHAR *str )
205 {
206     const WCHAR *s = str;
207     while (*s) s++;
208     return s - str;
209 }
210
211 WINE_UNICODE_INLINE WCHAR *strcpyW( WCHAR *dst, const WCHAR *src );
212 WINE_UNICODE_INLINE WCHAR *strcpyW( WCHAR *dst, const WCHAR *src )
213 {
214     WCHAR *p = dst;
215     while ((*p++ = *src++));
216     return dst;
217 }
218
219 /* strncpy doesn't do what you think, don't use it */
220 #define strncpyW(d,s,n) error do_not_use_strncpyW_use_lstrcpynW_or_memcpy_instead
221
222 WINE_UNICODE_INLINE int strcmpW( const WCHAR *str1, const WCHAR *str2 );
223 WINE_UNICODE_INLINE int strcmpW( const WCHAR *str1, const WCHAR *str2 )
224 {
225     while (*str1 && (*str1 == *str2)) { str1++; str2++; }
226     return *str1 - *str2;
227 }
228
229 WINE_UNICODE_INLINE int strncmpW( const WCHAR *str1, const WCHAR *str2, int n );
230 WINE_UNICODE_INLINE int strncmpW( const WCHAR *str1, const WCHAR *str2, int n )
231 {
232     if (n <= 0) return 0;
233     while ((--n > 0) && *str1 && (*str1 == *str2)) { str1++; str2++; }
234     return *str1 - *str2;
235 }
236
237 WINE_UNICODE_INLINE WCHAR *strcatW( WCHAR *dst, const WCHAR *src );
238 WINE_UNICODE_INLINE WCHAR *strcatW( WCHAR *dst, const WCHAR *src )
239 {
240     strcpyW( dst + strlenW(dst), src );
241     return dst;
242 }
243
244 WINE_UNICODE_INLINE WCHAR *strchrW( const WCHAR *str, WCHAR ch );
245 WINE_UNICODE_INLINE WCHAR *strchrW( const WCHAR *str, WCHAR ch )
246 {
247     do { if (*str == ch) return (WCHAR *)str; } while (*str++);
248     return NULL;
249 }
250
251 WINE_UNICODE_INLINE WCHAR *strrchrW( const WCHAR *str, WCHAR ch );
252 WINE_UNICODE_INLINE WCHAR *strrchrW( const WCHAR *str, WCHAR ch )
253 {
254     WCHAR *ret = NULL;
255     do { if (*str == ch) ret = (WCHAR *)str; } while (*str++);
256     return ret;
257 }
258
259 WINE_UNICODE_INLINE WCHAR *strpbrkW( const WCHAR *str, const WCHAR *accept );
260 WINE_UNICODE_INLINE WCHAR *strpbrkW( const WCHAR *str, const WCHAR *accept )
261 {
262     for ( ; *str; str++) if (strchrW( accept, *str )) return (WCHAR *)str;
263     return NULL;
264 }
265
266 WINE_UNICODE_INLINE size_t strspnW( const WCHAR *str, const WCHAR *accept );
267 WINE_UNICODE_INLINE size_t strspnW( const WCHAR *str, const WCHAR *accept )
268 {
269     const WCHAR *ptr;
270     for (ptr = str; *ptr; ptr++) if (!strchrW( accept, *ptr )) break;
271     return ptr - str;
272 }
273
274 WINE_UNICODE_INLINE size_t strcspnW( const WCHAR *str, const WCHAR *reject );
275 WINE_UNICODE_INLINE size_t strcspnW( const WCHAR *str, const WCHAR *reject )
276 {
277     const WCHAR *ptr;
278     for (ptr = str; *ptr; ptr++) if (strchrW( reject, *ptr )) break;
279     return ptr - str;
280 }
281
282 WINE_UNICODE_INLINE WCHAR *strlwrW( WCHAR *str );
283 WINE_UNICODE_INLINE WCHAR *strlwrW( WCHAR *str )
284 {
285     WCHAR *ret = str;
286     while ((*str = tolowerW(*str))) str++;
287     return ret;
288 }
289
290 WINE_UNICODE_INLINE WCHAR *struprW( WCHAR *str );
291 WINE_UNICODE_INLINE WCHAR *struprW( WCHAR *str )
292 {
293     WCHAR *ret = str;
294     while ((*str = toupperW(*str))) str++;
295     return ret;
296 }
297
298 WINE_UNICODE_INLINE WCHAR *memchrW( const WCHAR *ptr, WCHAR ch, size_t n );
299 WINE_UNICODE_INLINE WCHAR *memchrW( const WCHAR *ptr, WCHAR ch, size_t n )
300 {
301     const WCHAR *end;
302     for (end = ptr + n; ptr < end; ptr++) if (*ptr == ch) return (WCHAR *)ptr;
303     return NULL;
304 }
305
306 WINE_UNICODE_INLINE WCHAR *memrchrW( const WCHAR *ptr, WCHAR ch, size_t n );
307 WINE_UNICODE_INLINE WCHAR *memrchrW( const WCHAR *ptr, WCHAR ch, size_t n )
308 {
309     const WCHAR *end, *ret = NULL;
310     for (end = ptr + n; ptr < end; ptr++) if (*ptr == ch) ret = ptr;
311     return (WCHAR *)ret;
312 }
313
314 WINE_UNICODE_INLINE long int atolW( const WCHAR *str );
315 WINE_UNICODE_INLINE long int atolW( const WCHAR *str )
316 {
317     return strtolW( str, (WCHAR **)0, 10 );
318 }
319
320 WINE_UNICODE_INLINE int atoiW( const WCHAR *str );
321 WINE_UNICODE_INLINE int atoiW( const WCHAR *str )
322 {
323     return (int)atolW( str );
324 }
325
326 #undef WINE_UNICODE_INLINE
327
328 #endif  /* __WINE_WINE_UNICODE_H */