Add prototype for __wcslen, wcsnlen. Remove prototypes for wmemr*.
[kopensolaris-gnu/glibc.git] / wcsmbs / wchar.h
1 /* Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 /*
20  *      ISO C Standard, Amendment 1, 7.16.4
21  *      General wide-string utilities   <wchar.h>
22  */
23
24 #ifndef _WCHAR_H
25 #define _WCHAR_H 1
26
27 #include <features.h>
28
29 /* Get FILE definition.  */
30 #define __need_FILE
31 #include <stdio.h>
32
33 /* Get size_t, wchar_t, wint_t and NULL from <stddef.h>.  */
34 #define __need_size_t
35 #define __need_wchar_t
36 #define __need_wint_t
37 #define __need_NULL
38 #include <stddef.h>
39
40 /* We try to get wint_t from <stddef.h>, but not all GCC versions define it
41    there.  So define it ourselves if it remains undefined.  */
42 #ifndef _WINT_T
43 /* Integral type unchanged by default argument promotions that can
44    hold any value corresponding to members of the extended character
45    set, as well as at least one value that does not correspond to any
46    member of the extended character set.  */
47 # define _WINT_T
48 typedef unsigned int wint_t;
49 #endif
50
51
52 /* Conversion state information.  */
53 typedef struct
54 {
55   int count;            /* Number of bytes needed for the current character. */
56   wint_t value;         /* Value so far.  */
57 } mbstate_t;
58
59 #ifndef WCHAR_MIN
60 /* These constants might also be defined in <inttypes.h>.  */
61 # define WCHAR_MIN ((wchar_t) 0)
62 # define WCHAR_MAX (~WCHAR_MIN)
63 #endif
64
65 #ifndef WEOF
66 # define WEOF (0xffffffffu)
67 #endif
68
69 /* This incomplete type is defined in <time.h> but needed here because
70    of `wcsftime'.  */
71 struct tm;
72
73
74 __BEGIN_DECLS
75
76 /* Copy SRC to DEST.  */
77 extern wchar_t *wcscpy __P ((wchar_t *__restrict __dest,
78                              __const wchar_t *__restrict __src));
79 /* Copy no more than N wide-characters of SRC to DEST.  */
80 extern wchar_t *wcsncpy __P ((wchar_t *__restrict __dest,
81                               __const wchar_t *__restrict __src, size_t __n));
82
83 /* Append SRC onto DEST.  */
84 extern wchar_t *wcscat __P ((wchar_t *__restrict __dest,
85                              __const wchar_t *__restrict __src));
86 /* Append no more than N wide-characters of SRC onto DEST.  */
87 extern wchar_t *wcsncat __P ((wchar_t *__restrict __dest,
88                               __const wchar_t *__restrict __src, size_t __n));
89
90 /* Compare S1 and S2.  */
91 extern int wcscmp __P ((__const wchar_t *__s1, __const wchar_t *__s2));
92 /* Compare N wide-characters of S1 and S2.  */
93 extern int wcsncmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
94                          size_t __n));
95
96 #ifdef __USE_GNU
97 /* Compare S1 and S2, ignoring case.  */
98 extern int __wcscasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2));
99 extern int wcscasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2));
100
101 /* Compare no more than N chars of S1 and S2, ignoring case.  */
102 extern int __wcsncasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
103                                size_t __n));
104 extern int wcsncasecmp __P ((__const wchar_t *__s1, __const wchar_t *__s2,
105                              size_t __n));
106
107 /* Similar to the two functions above but take the information from
108    the provided locale and not the global locale.  */
109 # include <xlocale.h>
110
111 extern int __wcscasecmp_l __P ((__const wchar_t *__s1, __const wchar_t *__s2,
112                                 __locale_t __loc));
113
114 extern int __wcsncasecmp_l __P ((__const wchar_t *__s1, __const wchar_t *__s2,
115                                  size_t __n, __locale_t __loc));
116 #endif
117
118 /* Compare S1 and S2, both interpreted as appropriate to the
119    LC_COLLATE category of the current locale.  */
120 extern int wcscoll __P ((__const wchar_t *__s1, __const wchar_t *__s2));
121 /* Transform S2 into array pointed to by S1 such that if wcscmp is
122    applied to two transformed strings the result is the as applying
123    `wcscoll' to the original strings.  */
124 extern size_t wcsxfrm __P ((wchar_t *__restrict __s1,
125                             __const wchar_t *__restrict __s2, size_t __n));
126
127 #ifdef __USE_GNU
128 /* Similar to the two functions above but take the information from
129    the provided locale and not the global locale.  */
130
131 /* Compare S1 and S2, both interpreted as appropriate to the
132    LC_COLLATE category of the given locale.  */
133 extern int __wcscoll_l __P ((__const wchar_t *__s1, __const wchar_t *__s2,
134                              __locale_t __loc));
135 /* Transform S2 into array pointed to by S1 such that if wcscmp is
136    applied to two transformed strings the result is the as applying
137    `wcscoll' to the original strings.  */
138 extern size_t __wcsxfrm_l __P ((wchar_t *__s1, __const wchar_t *__s2,
139                                 size_t __n, __locale_t __loc));
140
141 /* Duplicate S, returning an identical malloc'd string.  */
142 extern wchar_t *wcsdup __P ((__const wchar_t *__s));
143 #endif
144
145 /* Find the first occurrence of WC in WCS.  */
146 extern wchar_t *wcschr __P ((__const wchar_t *__wcs, wchar_t __wc));
147 /* Find the last occurrence of WC in WCS.  */
148 extern wchar_t *wcsrchr __P ((__const wchar_t *__wcs, wchar_t __wc));
149
150 /* Return the length of the initial segmet of WCS which
151    consists entirely of wide characters not in REJECT.  */
152 extern size_t wcscspn __P ((__const wchar_t *__wcs,
153                             __const wchar_t *__reject));
154 /* Return the length of the initial segmet of WCS which
155    consists entirely of wide characters in  ACCEPT.  */
156 extern size_t wcsspn __P ((__const wchar_t *__wcs, __const wchar_t *__accept));
157 /* Find the first occurrence in WCS of any character in ACCEPT.  */
158 extern wchar_t *wcspbrk __P ((__const wchar_t *__wcs,
159                               __const wchar_t *__accept));
160 /* Find the first occurrence of NEEDLE in HAYSTACK.  */
161 extern wchar_t *wcsstr __P ((__const wchar_t *__haystack,
162                              __const wchar_t *__needle));
163 /* Divide WCS into tokens separated by characters in DELIM.  */
164 extern wchar_t *wcstok __P ((wchar_t *__restrict __s,
165                              __const wchar_t *__restrict __delim,
166                              wchar_t **__restrict __ptr));
167
168 /* Return the number of wide characters in S.  */
169 extern size_t __wcslen __P ((__const wchar_t *__s));
170 extern size_t wcslen __P ((__const wchar_t *__s));
171
172 #ifdef __USE_GNU
173 /* Return the number of wide characters in S, but at most MAXLEN.  */
174 extern size_t __wcsnlen __P ((__const wchar_t *__s, size_t __maxlen));
175 extern size_t wcsnlen __P ((__const wchar_t *__s, size_t __maxlen));
176 #endif
177
178
179 /* Search N wide characters of S for C.  */
180 extern wchar_t *wmemchr __P ((__const wchar_t *__s, wchar_t __c, size_t __n));
181
182 /* Compare N wide characters of S1 and S2.  */
183 extern int wmemcmp __P ((__const wchar_t *__restrict __s1,
184                          __const wchar_t *__restrict __s2, size_t __n));
185
186 /* Copy N wide characters of SRC to DEST.  */
187 extern wchar_t *wmemcpy __P ((wchar_t *__restrict __s1,
188                               __const wchar_t *__restrict __s2, size_t __n));
189
190 /* Copy N wide characters of SRC to DEST, guaranteeing
191    correct behavior for overlapping strings.  */
192 extern wchar_t *wmemmove __P ((wchar_t *__s1, __const wchar_t *__s2,
193                                size_t __n));
194
195 /* Set N wide characters of S to C.  */
196 extern wchar_t *wmemset __P ((wchar_t *__s, wchar_t __c, size_t __n));
197
198
199 /* Determine whether C constitutes a valid (one-byte) multibyte
200    character.  */
201 extern wint_t btowc __P ((int __c));
202
203 /* Determine whether C corresponds to a member of the extended
204    character set whose multibyte representation is a single byte.  */
205 extern int wctob __P ((wint_t __c));
206
207 /* Determine whether PS points to an object representing the initial
208    state.  */
209 extern int mbsinit __P ((__const mbstate_t *__ps));
210
211 /* Write wide character representation of multibyte character pointed
212    to by S to PWC.  */
213 extern size_t __mbrtowc __P ((wchar_t *__restrict __pwc,
214                               __const char *__restrict __s, size_t __n,
215                               mbstate_t *__restrict __p));
216 extern size_t mbrtowc __P ((wchar_t *__restrict __pwc,
217                             __const char *__restrict __s, size_t __n,
218                             mbstate_t *__p));
219
220 /* Write multibyte representation of wide character WC to S.  */
221 extern size_t __wcrtomb __P ((char *__restrict __s, wchar_t __wc,
222                               mbstate_t *__restrict __ps));
223 extern size_t wcrtomb __P ((char *__restrict __s, wchar_t __wc,
224                             mbstate_t *__restrict __ps));
225
226 /* Return number of bytes in multibyte character pointed to by S.  */
227 extern size_t __mbrlen __P ((__const char *__restrict __s, size_t __n,
228                              mbstate_t *__restrict __ps));
229 extern size_t mbrlen __P ((__const char *__restrict __s, size_t __n,
230                            mbstate_t *__restrict __ps));
231
232 #if defined __OPTIMIZE__ \
233     && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
234 /* Define inline function as optimization.  */
235 extern __inline size_t mbrlen (__const char *__restrict __s, size_t __n,
236                                mbstate_t *__restrict __ps)
237 { return (__ps != NULL
238           ? __mbrtowc (NULL, __s, __n, __ps) : __mbrlen (__s, __n, NULL)); }
239 #endif
240
241 /* Write wide character representation of multibyte character string
242    SRC to DST.  */
243 extern size_t __mbsrtowcs __P ((wchar_t *__restrict __dst,
244                                 __const char **__restrict __src,
245                                 size_t __len, mbstate_t *__restrict __ps));
246 extern size_t mbsrtowcs __P ((wchar_t *__restrict __dst,
247                               __const char **__restrict __src,
248                               size_t __len, mbstate_t *__restrict __ps));
249
250 /* Write multibyte character representation of wide character string
251    SRC to DST.  */
252 extern size_t __wcsrtombs __P ((char *__restrict __dst,
253                                 __const wchar_t **__restrict __src,
254                                 size_t __len, mbstate_t *__restrict __ps));
255 extern size_t wcsrtombs __P ((char *__restrict __dst,
256                               __const wchar_t **__restrict __src,
257                               size_t __len, mbstate_t *__restrict __ps));
258
259
260 #ifdef  __USE_GNU
261 /* Write wide character representation of at most NMC bytes of the
262    multibyte character string SRC to DST.  */
263 extern size_t __mbsnrtowcs __P ((wchar_t *__restrict __dst,
264                                  __const char **__restrict __src, size_t __nmc,
265                                  size_t __len, mbstate_t *__restrict __ps));
266 extern size_t mbsnrtowcs __P ((wchar_t *__restrict __dst,
267                                __const char **__restrict __src, size_t __nmc,
268                                size_t __len, mbstate_t *__restrict __ps));
269
270 /* Write multibyte character representation of at most NWC characters
271    from the wide character string SRC to DST.  */
272 extern size_t __wcsnrtombs __P ((char *__restrict __dst,
273                                  __const wchar_t **__restrict __src,
274                                  size_t __nwc, size_t __len,
275                                  mbstate_t *__restrict __ps));
276 extern size_t wcsnrtombs __P ((char *__restrict __dst,
277                                __const wchar_t **__restrict __src,
278                                size_t __nwc, size_t __len,
279                                mbstate_t *__restrict __ps));
280 #endif  /* use GNU */
281
282
283 /* The following functions are extensions found in X/Open CAE.  */
284 #ifdef __USE_XOPEN
285 /* Determine number of column positions required for C.  */
286 extern int wcwidth __P ((wint_t __c));
287
288 /* Determine number of column positions required for first N wide
289    characters (or fewer if S ends before this) in S.  */
290 extern int wcswidth __P ((__const wchar_t *__s, size_t __n));
291 #endif  /* Use X/Open.  */
292
293
294 /* Convert initial portion of the wide string NPTR to `double'
295    representation.  */
296 extern double wcstod __P ((__const wchar_t *__restrict __nptr,
297                            wchar_t **__restrict __endptr));
298
299 #ifdef __USE_GNU
300 /* Likewise for `float' and `long double' sizes of floating-point numbers.  */
301 extern float wcstof __P ((__const wchar_t *__restrict __nptr,
302                           wchar_t **__restrict __endptr));
303 extern __long_double_t wcstold __P ((__const wchar_t *__restrict __nptr,
304                                      wchar_t **__restrict __endptr));
305 #endif /* GNU */
306
307
308 /* Convert initial portion of wide string NPTR to `long int'
309    representation.  */
310 extern long int wcstol __P ((__const wchar_t *__restrict __nptr,
311                              wchar_t **__restrict __endptr, int __base));
312
313 /* Convert initial portion of wide string NPTR to `unsigned long int'
314    representation.  */
315 extern unsigned long int wcstoul __P ((__const wchar_t *__restrict __nptr,
316                                        wchar_t **__restrict __endptr,
317                                        int __base));
318
319 #if defined __GNUC__ && defined __USE_GNU
320 /* Convert initial portion of wide string NPTR to `long int'
321    representation.  */
322 extern long long int wcstoq __P ((__const wchar_t *__restrict __nptr,
323                                   wchar_t **__restrict __endptr, int __base));
324
325 /* Convert initial portion of wide string NPTR to `unsigned long long int'
326    representation.  */
327 extern unsigned long long int wcstouq __P ((__const wchar_t *__restrict __nptr,
328                                             wchar_t **__restrict __endptr,
329                                             int __base));
330 #endif /* GCC and use GNU.  */
331
332 #if defined __USE_ISOC9X || (defined __GNUC__ && defined __USE_GNU)
333 /* Convert initial portion of wide string NPTR to `long int'
334    representation.  */
335 extern long long int wcstoll __P ((__const wchar_t *__restrict __nptr,
336                                    wchar_t **__restrict __endptr, int __base));
337
338 /* Convert initial portion of wide string NPTR to `unsigned long long int'
339    representation.  */
340 extern unsigned long long int wcstoull __P ((__const wchar_t *
341                                              __restrict __nptr,
342                                              wchar_t **__restrict __endptr,
343                                              int __base));
344 #endif /* ISO C 9X or GCC and GNU.  */
345
346 #ifdef __USE_GNU
347 /* The concept of one static locale per category is not very well
348    thought out.  Many applications will need to process its data using
349    information from several different locales.  Another application is
350    the implementation of the internationalization handling in the
351    upcoming ISO C++ standard library.  To support this another set of
352    the functions using locale data exist which have an additional
353    argument.
354
355    Attention: all these functions are *not* standardized in any form.
356    This is a proof-of-concept implementation.  */
357
358 /* Structure for reentrant locale using functions.  This is an
359    (almost) opaque type for the user level programs.  */
360 # include <xlocale.h>
361
362 /* Special versions of the functions above which take the locale to
363    use as an additional parameter.  */
364 extern long int __wcstol_l __P ((__const wchar_t *__restrict __nptr,
365                                  wchar_t **__restrict __endptr, int __base,
366                                  __locale_t __loc));
367
368 extern unsigned long int __wcstoul_l __P ((__const wchar_t *__restrict __nptr,
369                                            wchar_t **__restrict __endptr,
370                                            int __base, __locale_t __loc));
371
372 extern long long int __wcstoll_l __P ((__const wchar_t *__restrict __nptr,
373                                        wchar_t **__restrict __endptr,
374                                        int __base, __locale_t __loc));
375
376 extern unsigned long long int __wcstoull_l __P ((__const wchar_t *__restrict
377                                                  __nptr,
378                                                  wchar_t **__restrict __endptr,
379                                                  int __base,
380                                                  __locale_t __loc));
381
382 extern double __wcstod_l __P ((__const wchar_t *__restrict __nptr,
383                                wchar_t **__restrict __endptr,
384                                __locale_t __loc));
385
386 extern float __wcstof_l __P ((__const wchar_t *__restrict __nptr,
387                               wchar_t **__restrict __endptr,
388                               __locale_t __loc));
389
390 extern __long_double_t __wcstold_l __P ((__const wchar_t *__restrict __nptr,
391                                          wchar_t **__restrict __endptr,
392                                          __locale_t __loc));
393 #endif /* GNU */
394
395
396 /* The internal entry points for `wcstoX' take an extra flag argument
397    saying whether or not to parse locale-dependent number grouping.  */
398 extern double __wcstod_internal __P ((__const wchar_t *__restrict __nptr,
399                                       wchar_t **__restrict __endptr,
400                                       int __group));
401 extern float __wcstof_internal __P ((__const wchar_t *__restrict __nptr,
402                                      wchar_t **__restrict __endptr,
403                                      int __group));
404 extern __long_double_t __wcstold_internal __P ((__const wchar_t *
405                                                 __restrict __nptr,
406                                                 wchar_t **__restrict __endptr,
407                                                 int __group));
408
409 #ifndef __wcstol_internal_defined
410 extern long int __wcstol_internal __P ((__const wchar_t *__restrict __nptr,
411                                         wchar_t **__restrict __endptr,
412                                         int __base, int __group));
413 # define __wcstol_internal_defined      1
414 #endif
415 #ifndef __wcstoul_internal_defined
416 extern unsigned long int __wcstoul_internal __P ((__const wchar_t *
417                                                   __restrict __nptr,
418                                                   wchar_t **
419                                                   __restrict __endptr,
420                                                   int __base, int __group));
421 # define __wcstoul_internal_defined     1
422 #endif
423 #ifndef __wcstoll_internal_defined
424 extern long long int __wcstoll_internal __P ((__const wchar_t *
425                                               __restrict __nptr,
426                                               wchar_t **__restrict __endptr,
427                                               int __base, int __group));
428 # define __wcstoll_internal_defined     1
429 #endif
430 #ifndef __wcstoull_internal_defined
431 extern unsigned long long int __wcstoull_internal __P ((__const wchar_t *
432                                                         __restrict __nptr,
433                                                         wchar_t **
434                                                         __restrict __endptr,
435                                                         int __base,
436                                                         int __group));
437 # define __wcstoull_internal_defined    1
438 #endif
439
440
441 #if defined __OPTIMIZE__ && __GNUC__ >= 2
442 /* Define inline functions which call the internal entry points.  */
443
444 extern __inline double wcstod (__const wchar_t *__restrict __nptr,
445                                wchar_t **__restrict __endptr)
446 { return __wcstod_internal (__nptr, __endptr, 0); }
447 extern __inline long int wcstol (__const wchar_t *__restrict __nptr,
448                                  wchar_t **__restrict __endptr, int __base)
449 { return __wcstol_internal (__nptr, __endptr, __base, 0); }
450 extern __inline unsigned long int wcstoul (__const wchar_t *__restrict __nptr,
451                                            wchar_t **__restrict __endptr,
452                                            int __base)
453 { return __wcstoul_internal (__nptr, __endptr, __base, 0); }
454
455 # ifdef __USE_GNU
456 extern __inline float wcstof (__const wchar_t *__restrict __nptr,
457                               wchar_t **__restrict __endptr)
458 { return __wcstof_internal (__nptr, __endptr, 0); }
459 extern __inline __long_double_t wcstold (__const wchar_t *__restrict __nptr,
460                                          wchar_t **__restrict __endptr)
461 { return __wcstold_internal (__nptr, __endptr, 0); }
462
463
464 extern __inline long long int wcstoq (__const wchar_t *__restrict __nptr,
465                                       wchar_t **__restrict __endptr,
466                                       int __base)
467 { return __wcstoll_internal (__nptr, __endptr, __base, 0); }
468 extern __inline unsigned long long int wcstouq (__const wchar_t *
469                                                 __restrict __nptr,
470                                                 wchar_t **__restrict __endptr,
471                                                 int __base)
472 { return __wcstoull_internal (__nptr, __endptr, __base, 0); }
473 # endif /* Use GNU.  */
474 #endif /* Optimizing GCC >=2.  */
475
476
477 #ifdef  __USE_GNU
478 /* Copy SRC to DEST, returning the address of the terminating L'\0' in
479    DEST.  */
480 extern wchar_t *__wcpcpy __P ((wchar_t *__dest, __const wchar_t *__src));
481 extern wchar_t *wcpcpy __P ((wchar_t *__dest, __const wchar_t *__src));
482
483 /* Copy no more than N characters of SRC to DEST, returning the address of
484    the last character written into DEST.  */
485 extern wchar_t *__wcpncpy __P ((wchar_t *__dest, __const wchar_t *__src,
486                                 size_t __n));
487 extern wchar_t *wcpncpy __P ((wchar_t *__dest, __const wchar_t *__src,
488                               size_t __n));
489 #endif  /* use GNU */
490
491
492 /* The X/Open standard demands that most of the functions defined in
493    the <wctype.h> header must also appear here.  This is probably
494    because some X/Open members wrote their implementation before the
495    ISO C standard was published and introduced the better solution.
496    We have to provide these definitions for compliance reasons but we
497    do this nonsense only if really necessary.  */
498 #if defined __USE_UNIX98 && !defined __USE_GNU
499 # define __need_iswxxx
500 # include <wctype.h>
501 #endif
502
503 __END_DECLS
504
505 #endif /* wchar.h  */