Documentation fixes.
[wine] / dlls / ntdll / wcstring.c
1 /*
2  * NTDLL wide-char functions
3  *
4  * Copyright 2000 Alexandre Julliard
5  * Copyright 2000 Jon Griffiths
6  */
7
8 #include "config.h"
9
10 #include <ctype.h>
11 #include <limits.h>
12 #include <stdlib.h>
13 #include <string.h>
14 #include <stdio.h>
15
16 #include "windef.h"
17 #include "winbase.h"
18 #include "winnls.h"
19 #include "wine/unicode.h"
20 #include "heap.h"
21 #include "debugtools.h"
22
23 DEFAULT_DEBUG_CHANNEL(ntdll);
24
25
26 /*********************************************************************
27  *           _wcsicmp    (NTDLL.@)
28  */
29 INT __cdecl NTDLL__wcsicmp( LPCWSTR str1, LPCWSTR str2 )
30 {
31     return strcmpiW( str1, str2 );
32 }
33
34
35 /*********************************************************************
36  *           _wcslwr    (NTDLL.@)
37  */
38 LPWSTR __cdecl NTDLL__wcslwr( LPWSTR str )
39 {
40     return strlwrW( str );
41 }
42
43
44 /*********************************************************************
45  *           _wcsnicmp    (NTDLL.@)
46  */
47 INT __cdecl NTDLL__wcsnicmp( LPCWSTR str1, LPCWSTR str2, INT n )
48 {
49     return strncmpiW( str1, str2, n );
50 }
51
52
53 /*********************************************************************
54  *           _wcsupr    (NTDLL.@)
55  */
56 LPWSTR __cdecl NTDLL__wcsupr( LPWSTR str )
57 {
58     return struprW( str );
59 }
60
61
62 /*********************************************************************
63  *           towlower    (NTDLL.@)
64  */
65 WCHAR __cdecl NTDLL_towlower( WCHAR ch )
66 {
67     return tolowerW(ch);
68 }
69
70
71 /*********************************************************************
72  *           towupper    (NTDLL.@)
73  */
74 WCHAR __cdecl NTDLL_towupper( WCHAR ch )
75 {
76     return toupperW(ch);
77 }
78
79
80 /***********************************************************************
81  *           wcscat    (NTDLL.@)
82  */
83 LPWSTR __cdecl NTDLL_wcscat( LPWSTR dst, LPCWSTR src )
84 {
85     return strcatW( dst, src );
86 }
87
88
89 /*********************************************************************
90  *           wcschr    (NTDLL.@)
91  */
92 LPWSTR __cdecl NTDLL_wcschr( LPCWSTR str, WCHAR ch )
93 {
94     return strchrW( str, ch );
95 }
96
97
98 /*********************************************************************
99  *           wcscmp    (NTDLL.@)
100  */
101 INT __cdecl NTDLL_wcscmp( LPCWSTR str1, LPCWSTR str2 )
102 {
103     return strcmpW( str1, str2 );
104 }
105
106
107 /***********************************************************************
108  *           wcscpy    (NTDLL.@)
109  */
110 LPWSTR __cdecl NTDLL_wcscpy( LPWSTR dst, LPCWSTR src )
111 {
112     return strcpyW( dst, src );
113 }
114
115
116 /*********************************************************************
117  *           wcscspn    (NTDLL.@)
118  */
119 INT __cdecl NTDLL_wcscspn( LPCWSTR str, LPCWSTR reject )
120 {
121     LPCWSTR start = str;
122     while (*str)
123     {
124         LPCWSTR p = reject;
125         while (*p && (*p != *str)) p++;
126         if (*p) break;
127         str++;
128     }
129     return str - start;
130 }
131
132
133 /***********************************************************************
134  *           wcslen    (NTDLL.@)
135  */
136 INT __cdecl NTDLL_wcslen( LPCWSTR str )
137 {
138     return strlenW( str );
139 }
140
141
142 /*********************************************************************
143  *           wcsncat    (NTDLL.@)
144  */
145 LPWSTR __cdecl NTDLL_wcsncat( LPWSTR s1, LPCWSTR s2, INT n )
146 {
147     LPWSTR ret = s1;
148     while (*s1) s1++;
149     while (n-- > 0) if (!(*s1++ = *s2++)) return ret;
150     *s1 = 0;
151     return ret;
152 }
153
154
155 /*********************************************************************
156  *           wcsncmp    (NTDLL.@)
157  */
158 INT __cdecl NTDLL_wcsncmp( LPCWSTR str1, LPCWSTR str2, INT n )
159 {
160     return strncmpW( str1, str2, n );
161 }
162
163
164 /*********************************************************************
165  *           wcsncpy    (NTDLL.@)
166  */
167 LPWSTR __cdecl NTDLL_wcsncpy( LPWSTR s1, LPCWSTR s2, INT n )
168 {
169     return strncpyW( s1, s2, n );
170 }
171
172
173 /*********************************************************************
174  *           wcspbrk    (NTDLL.@)
175  */
176 LPWSTR __cdecl NTDLL_wcspbrk( LPCWSTR str, LPCWSTR accept )
177 {
178     LPCWSTR p;
179     while (*str)
180     {
181         for (p = accept; *p; p++) if (*p == *str) return (LPWSTR)str;
182         str++;
183     }
184     return NULL;
185 }
186
187
188 /*********************************************************************
189  *           wcsrchr    (NTDLL.@)
190  */
191 LPWSTR __cdecl NTDLL_wcsrchr( LPWSTR str, WCHAR ch )
192 {
193     LPWSTR last = NULL;
194     while (*str)
195     {
196         if (*str == ch) last = str;
197         str++;
198     }
199     return last;
200 }
201
202
203 /*********************************************************************
204  *           wcsspn    (NTDLL.@)
205  */
206 INT __cdecl NTDLL_wcsspn( LPCWSTR str, LPCWSTR accept )
207 {
208     LPCWSTR start = str;
209     while (*str)
210     {
211         LPCWSTR p = accept;
212         while (*p && (*p != *str)) p++;
213         if (!*p) break;
214         str++;
215     }
216     return str - start;
217 }
218
219
220 /*********************************************************************
221  *           wcsstr    (NTDLL.@)
222  */
223 LPWSTR __cdecl NTDLL_wcsstr( LPCWSTR str, LPCWSTR sub )
224 {
225     return strstrW( str, sub );
226 }
227
228
229 /*********************************************************************
230  *           wcstok    (NTDLL.@)
231  */
232 LPWSTR __cdecl NTDLL_wcstok( LPWSTR str, LPCWSTR delim )
233 {
234     static LPWSTR next = NULL;
235     LPWSTR ret;
236
237     if (!str)
238         if (!(str = next)) return NULL;
239
240     while (*str && NTDLL_wcschr( delim, *str )) str++;
241     if (!*str) return NULL;
242     ret = str++;
243     while (*str && !NTDLL_wcschr( delim, *str )) str++;
244     if (*str) *str++ = 0;
245     next = str;
246     return ret;
247 }
248
249
250 /*********************************************************************
251  *           wcstombs    (NTDLL.@)
252  */
253 INT __cdecl NTDLL_wcstombs( LPSTR dst, LPCWSTR src, INT n )
254 {
255     INT ret;
256     if (n <= 0) return 0;
257     ret = WideCharToMultiByte( CP_ACP, 0, src, -1, dst, dst ? n : 0, NULL, NULL );
258     if (!ret) return n;  /* overflow */
259     return ret - 1;  /* do not count terminating NULL */
260 }
261
262
263 /*********************************************************************
264  *           mbstowcs    (NTDLL.@)
265  */
266 INT __cdecl NTDLL_mbstowcs( LPWSTR dst, LPCSTR src, INT n )
267 {
268     INT ret;
269     if (n <= 0) return 0;
270     ret = MultiByteToWideChar( CP_ACP, 0, src, -1, dst, dst ? n : 0 );
271     if (!ret) return n;  /* overflow */
272     return ret - 1;  /* do not count terminating NULL */
273 }
274
275
276 /*********************************************************************
277  *                  wcstol  (NTDLL.@)
278  * Like strtol, but for wide character strings.
279  */
280 INT __cdecl NTDLL_wcstol(LPWSTR s,LPWSTR *end,INT base)
281 {
282     LPSTR sA = HEAP_strdupWtoA(GetProcessHeap(),0,s),endA;
283     INT ret = strtol(sA,&endA,base);
284
285     HeapFree(GetProcessHeap(),0,sA);
286     if (end) *end = s+(endA-sA); /* pointer magic checked. */
287     return ret;
288 }
289
290
291 /*********************************************************************
292  *           iswctype    (NTDLL.@)
293  */
294 INT __cdecl NTDLL_iswctype( WCHAR wc, WCHAR wct )
295 {
296     return (get_char_typeW(wc) & 0xfff) & wct;
297 }
298
299
300 /*********************************************************************
301  *           iswalpha    (NTDLL.@)
302  */
303 INT __cdecl NTDLL_iswalpha( WCHAR wc )
304 {
305     return get_char_typeW(wc) & C1_ALPHA;
306 }
307
308
309 /*********************************************************************
310  *           _ultow    (NTDLL.@)
311  * Like _ultoa, but for wide character strings.
312  */
313 LPWSTR __cdecl _ultow(ULONG value, LPWSTR string, INT radix)
314 {
315     WCHAR tmp[33];
316     LPWSTR tp = tmp;
317     LPWSTR sp;
318     LONG i;
319     ULONG v = value;
320
321     if (radix > 36 || radix <= 1)
322         return 0;
323
324     while (v || tp == tmp)
325     {
326         i = v % radix;
327         v = v / radix;
328         if (i < 10)
329             *tp++ = i + '0';
330         else
331             *tp++ = i + 'a' - 10;
332     }
333
334     sp = string;
335     while (tp > tmp)
336         *sp++ = *--tp;
337     *sp = 0;
338     return string;
339 }
340
341 /*********************************************************************
342  *           _wtol    (NTDLL.@)
343  * Like atol, but for wide character strings.
344  */
345 LONG __cdecl _wtol(LPWSTR string)
346 {
347     char buffer[30];
348     NTDLL_wcstombs( buffer, string, sizeof(buffer) );
349     return atol( buffer );
350 }
351
352 /*********************************************************************
353  *           _wtoi    (NTDLL.@)
354  */
355 INT __cdecl _wtoi(LPWSTR string)
356 {
357     return _wtol(string);
358 }
359
360 /* INTERNAL: Wide char snprintf
361  * If you fix a bug in this function, fix it in msvcrt/wcs.c also!
362  */
363 static int __cdecl NTDLL_vsnwprintf(WCHAR *str, unsigned int len,
364                                     const WCHAR *format, va_list valist)
365 {
366   unsigned int written = 0;
367   const WCHAR *iter = format;
368   char bufa[256], fmtbufa[64], *fmta;
369
370   TRACE("(%d,%s)\n",len,debugstr_w(format));
371
372   while (*iter)
373   {
374     while (*iter && *iter != (WCHAR)L'%')
375     {
376      if (written++ >= len)
377        return -1;
378      *str++ = *iter++;
379     }
380     if (*iter == (WCHAR)L'%')
381     {
382       fmta = fmtbufa;
383       *fmta++ = *iter++;
384       while (*iter == (WCHAR)L'0' ||
385              *iter == (WCHAR)L'+' ||
386              *iter == (WCHAR)L'-' ||
387              *iter == (WCHAR)L' ' ||
388              *iter == (WCHAR)L'0' ||
389              *iter == (WCHAR)L'*' ||
390              *iter == (WCHAR)L'#')
391       {
392         if (*iter == (WCHAR)L'*')
393         {
394           char *buffiter = bufa;
395           int fieldlen = va_arg(valist, int);
396           sprintf(buffiter, "%d", fieldlen);
397           while (*buffiter)
398             *fmta++ = *buffiter++;
399         }
400         else
401           *fmta++ = *iter;
402         iter++;
403       }
404
405       while (isdigit(*iter))
406         *fmta++ = *iter++;
407
408       if (*iter == (WCHAR)L'.')
409       {
410         *fmta++ = *iter++;
411         if (*iter == (WCHAR)L'*')
412         {
413           char *buffiter = bufa;
414           int fieldlen = va_arg(valist, int);
415           sprintf(buffiter, "%d", fieldlen);
416           while (*buffiter)
417             *fmta++ = *buffiter++;
418         }
419         else
420           while (isdigit(*iter))
421             *fmta++ = *iter++;
422       }
423       if (*iter == (WCHAR)L'h' ||
424           *iter == (WCHAR)L'l')
425       {
426           *fmta++ = *iter++;
427           *fmta++ = *iter++;
428       }
429
430       switch (*iter)
431       {
432       case (WCHAR)L's':
433         {
434           static const WCHAR none[] = { '(', 'n', 'u', 'l', 'l', ')', 0 };
435           const WCHAR *wstr = va_arg(valist, const WCHAR *);
436           const WCHAR *striter = wstr ? wstr : none;
437           while (*striter)
438           {
439             if (written++ >= len)
440               return -1;
441             *str++ = *striter++;
442           }
443           iter++;
444           break;
445         }
446
447       case (WCHAR)L'c':
448         if (written++ >= len)
449           return -1;
450         *str++ = (WCHAR)va_arg(valist, int);
451         iter++;
452         break;
453
454       default:
455         {
456           /* For non wc types, use system sprintf and append to wide char output */
457           /* FIXME: for unrecognised types, should ignore % when printing */
458           char *bufaiter = bufa;
459           if (*iter == (WCHAR)L'p')
460             sprintf(bufaiter, "%08lX", va_arg(valist, long));
461           else
462           {
463             *fmta++ = *iter;
464             *fmta = '\0';
465             if (*iter == (WCHAR)L'f')
466               sprintf(bufaiter, fmtbufa, va_arg(valist, double));
467             else
468               sprintf(bufaiter, fmtbufa, va_arg(valist, void *));
469           }
470           while (*bufaiter)
471           {
472             if (written++ >= len)
473               return -1;
474             *str++ = *bufaiter++;
475           }
476           iter++;
477           break;
478         }
479       }
480     }
481   }
482   if (written >= len)
483     return -1;
484   *str++ = (WCHAR)L'\0';
485   return (int)written;
486 }
487
488
489 /***********************************************************************
490  *        _snwprintf (NTDLL.@)
491  */
492 int __cdecl _snwprintf(WCHAR *str, unsigned int len, const WCHAR *format, ...)
493 {
494   int retval;
495   va_list valist;
496   va_start(valist, format);
497   retval = NTDLL_vsnwprintf(str, len, format, valist);
498   va_end(valist);
499   return retval;
500 }
501
502
503 /***********************************************************************
504  *        swprintf (NTDLL.@)
505  */
506 int __cdecl NTDLL_swprintf(WCHAR *str, const WCHAR *format, ...)
507 {
508   int retval;
509   va_list valist;
510   va_start(valist, format);
511   retval = NTDLL_vsnwprintf(str, INT_MAX, format, valist);
512   va_end(valist);
513   return retval;
514 }