2.5-18.1
[glibc.git] / wcsmbs / wchar.h
blobf54abfaa9610fae384f3c72d9cc8c1a50417d90f
1 /* Copyright (C) 1995-2004,2005,2006 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
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 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, write to the Free
16 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17 02111-1307 USA. */
20 * ISO C99 Standard: 7.24
21 * Extended multibyte and wide character utilities <wchar.h>
24 #ifndef _WCHAR_H
26 #ifndef __need_mbstate_t
27 # define _WCHAR_H 1
28 # include <features.h>
29 #endif
31 #ifdef _WCHAR_H
32 /* Get FILE definition. */
33 # define __need___FILE
34 # ifdef __USE_UNIX98
35 # define __need_FILE
36 # endif
37 # include <stdio.h>
38 /* Get va_list definition. */
39 # define __need___va_list
40 # include <stdarg.h>
42 /* Get size_t, wchar_t, wint_t and NULL from <stddef.h>. */
43 # define __need_size_t
44 # define __need_wchar_t
45 # define __need_NULL
46 #endif
47 #define __need_wint_t
48 #include <stddef.h>
50 #include <bits/wchar.h>
52 /* We try to get wint_t from <stddef.h>, but not all GCC versions define it
53 there. So define it ourselves if it remains undefined. */
54 #ifndef _WINT_T
55 /* Integral type unchanged by default argument promotions that can
56 hold any value corresponding to members of the extended character
57 set, as well as at least one value that does not correspond to any
58 member of the extended character set. */
59 # define _WINT_T
60 typedef unsigned int wint_t;
61 #else
62 /* Work around problems with the <stddef.h> file which doesn't put
63 wint_t in the std namespace. */
64 # if defined __cplusplus && defined _GLIBCPP_USE_NAMESPACES \
65 && defined __WINT_TYPE__
66 __BEGIN_NAMESPACE_STD
67 typedef __WINT_TYPE__ wint_t;
68 __END_NAMESPACE_STD
69 # endif
70 #endif
73 #ifndef __mbstate_t_defined
74 # define __mbstate_t_defined 1
75 /* Conversion state information. */
76 typedef struct
78 int __count;
79 union
81 wint_t __wch;
82 char __wchb[4];
83 } __value; /* Value so far. */
84 } __mbstate_t;
85 #endif
86 #undef __need_mbstate_t
89 /* The rest of the file is only used if used if __need_mbstate_t is not
90 defined. */
91 #ifdef _WCHAR_H
93 __BEGIN_NAMESPACE_C99
94 /* Public type. */
95 typedef __mbstate_t mbstate_t;
96 __END_NAMESPACE_C99
97 #ifdef __USE_GNU
98 __USING_NAMESPACE_C99(mbstate_t)
99 #endif
101 #ifndef WCHAR_MIN
102 /* These constants might also be defined in <inttypes.h>. */
103 # define WCHAR_MIN __WCHAR_MIN
104 # define WCHAR_MAX __WCHAR_MAX
105 #endif
107 #ifndef WEOF
108 # define WEOF (0xffffffffu)
109 #endif
111 /* For XPG4 compliance we have to define the stuff from <wctype.h> here
112 as well. */
113 #if defined __USE_XOPEN && !defined __USE_UNIX98
114 # include <wctype.h>
115 #endif
118 __BEGIN_DECLS
120 __BEGIN_NAMESPACE_STD
121 /* This incomplete type is defined in <time.h> but needed here because
122 of `wcsftime'. */
123 struct tm;
124 /* XXX We have to clean this up at some point. Since tm is in the std
125 namespace but wcsftime is in __c99 the type wouldn't be found
126 without inserting it in the global namespace. */
127 __USING_NAMESPACE_STD(tm)
128 __END_NAMESPACE_STD
131 __BEGIN_NAMESPACE_C99
132 /* Copy SRC to DEST. */
133 extern wchar_t *wcscpy (wchar_t *__restrict __dest,
134 __const wchar_t *__restrict __src) __THROW;
135 /* Copy no more than N wide-characters of SRC to DEST. */
136 extern wchar_t *wcsncpy (wchar_t *__restrict __dest,
137 __const wchar_t *__restrict __src, size_t __n)
138 __THROW;
140 /* Append SRC onto DEST. */
141 extern wchar_t *wcscat (wchar_t *__restrict __dest,
142 __const wchar_t *__restrict __src) __THROW;
143 /* Append no more than N wide-characters of SRC onto DEST. */
144 extern wchar_t *wcsncat (wchar_t *__restrict __dest,
145 __const wchar_t *__restrict __src, size_t __n)
146 __THROW;
148 /* Compare S1 and S2. */
149 extern int wcscmp (__const wchar_t *__s1, __const wchar_t *__s2)
150 __THROW __attribute_pure__;
151 /* Compare N wide-characters of S1 and S2. */
152 extern int wcsncmp (__const wchar_t *__s1, __const wchar_t *__s2, size_t __n)
153 __THROW __attribute_pure__;
154 __END_NAMESPACE_C99
156 #ifdef __USE_GNU
157 /* Compare S1 and S2, ignoring case. */
158 extern int wcscasecmp (__const wchar_t *__s1, __const wchar_t *__s2) __THROW;
160 /* Compare no more than N chars of S1 and S2, ignoring case. */
161 extern int wcsncasecmp (__const wchar_t *__s1, __const wchar_t *__s2,
162 size_t __n) __THROW;
164 /* Similar to the two functions above but take the information from
165 the provided locale and not the global locale. */
166 # include <xlocale.h>
168 extern int wcscasecmp_l (__const wchar_t *__s1, __const wchar_t *__s2,
169 __locale_t __loc) __THROW;
171 extern int wcsncasecmp_l (__const wchar_t *__s1, __const wchar_t *__s2,
172 size_t __n, __locale_t __loc) __THROW;
173 #endif
175 __BEGIN_NAMESPACE_C99
176 /* Compare S1 and S2, both interpreted as appropriate to the
177 LC_COLLATE category of the current locale. */
178 extern int wcscoll (__const wchar_t *__s1, __const wchar_t *__s2) __THROW;
179 /* Transform S2 into array pointed to by S1 such that if wcscmp is
180 applied to two transformed strings the result is the as applying
181 `wcscoll' to the original strings. */
182 extern size_t wcsxfrm (wchar_t *__restrict __s1,
183 __const wchar_t *__restrict __s2, size_t __n) __THROW;
184 __END_NAMESPACE_C99
186 #ifdef __USE_GNU
187 /* Similar to the two functions above but take the information from
188 the provided locale and not the global locale. */
190 /* Compare S1 and S2, both interpreted as appropriate to the
191 LC_COLLATE category of the given locale. */
192 extern int wcscoll_l (__const wchar_t *__s1, __const wchar_t *__s2,
193 __locale_t __loc) __THROW;
195 /* Transform S2 into array pointed to by S1 such that if wcscmp is
196 applied to two transformed strings the result is the as applying
197 `wcscoll' to the original strings. */
198 extern size_t wcsxfrm_l (wchar_t *__s1, __const wchar_t *__s2,
199 size_t __n, __locale_t __loc) __THROW;
201 /* Duplicate S, returning an identical malloc'd string. */
202 extern wchar_t *wcsdup (__const wchar_t *__s) __THROW __attribute_malloc__;
203 #endif
205 __BEGIN_NAMESPACE_C99
206 /* Find the first occurrence of WC in WCS. */
207 extern wchar_t *wcschr (__const wchar_t *__wcs, wchar_t __wc)
208 __THROW __attribute_pure__;
209 /* Find the last occurrence of WC in WCS. */
210 extern wchar_t *wcsrchr (__const wchar_t *__wcs, wchar_t __wc)
211 __THROW __attribute_pure__;
212 __END_NAMESPACE_C99
214 #ifdef __USE_GNU
215 /* This function is similar to `wcschr'. But it returns a pointer to
216 the closing NUL wide character in case C is not found in S. */
217 extern wchar_t *wcschrnul (__const wchar_t *__s, wchar_t __wc)
218 __THROW __attribute_pure__;
219 #endif
221 __BEGIN_NAMESPACE_C99
222 /* Return the length of the initial segmet of WCS which
223 consists entirely of wide characters not in REJECT. */
224 extern size_t wcscspn (__const wchar_t *__wcs, __const wchar_t *__reject)
225 __THROW __attribute_pure__;
226 /* Return the length of the initial segmet of WCS which
227 consists entirely of wide characters in ACCEPT. */
228 extern size_t wcsspn (__const wchar_t *__wcs, __const wchar_t *__accept)
229 __THROW __attribute_pure__;
230 /* Find the first occurrence in WCS of any character in ACCEPT. */
231 extern wchar_t *wcspbrk (__const wchar_t *__wcs, __const wchar_t *__accept)
232 __THROW __attribute_pure__;
233 /* Find the first occurrence of NEEDLE in HAYSTACK. */
234 extern wchar_t *wcsstr (__const wchar_t *__haystack, __const wchar_t *__needle)
235 __THROW __attribute_pure__;
237 /* Divide WCS into tokens separated by characters in DELIM. */
238 extern wchar_t *wcstok (wchar_t *__restrict __s,
239 __const wchar_t *__restrict __delim,
240 wchar_t **__restrict __ptr) __THROW;
242 /* Return the number of wide characters in S. */
243 extern size_t wcslen (__const wchar_t *__s) __THROW __attribute_pure__;
244 __END_NAMESPACE_C99
246 #ifdef __USE_XOPEN
247 /* Another name for `wcsstr' from XPG4. */
248 extern wchar_t *wcswcs (__const wchar_t *__haystack, __const wchar_t *__needle)
249 __THROW __attribute_pure__;
250 #endif
252 #ifdef __USE_GNU
253 /* Return the number of wide characters in S, but at most MAXLEN. */
254 extern size_t wcsnlen (__const wchar_t *__s, size_t __maxlen)
255 __THROW __attribute_pure__;
256 #endif
259 __BEGIN_NAMESPACE_C99
260 /* Search N wide characters of S for C. */
261 extern wchar_t *wmemchr (__const wchar_t *__s, wchar_t __c, size_t __n)
262 __THROW __attribute_pure__;
264 /* Compare N wide characters of S1 and S2. */
265 extern int wmemcmp (__const wchar_t *__restrict __s1,
266 __const wchar_t *__restrict __s2, size_t __n)
267 __THROW __attribute_pure__;
269 /* Copy N wide characters of SRC to DEST. */
270 extern wchar_t *wmemcpy (wchar_t *__restrict __s1,
271 __const wchar_t *__restrict __s2, size_t __n) __THROW;
273 /* Copy N wide characters of SRC to DEST, guaranteeing
274 correct behavior for overlapping strings. */
275 extern wchar_t *wmemmove (wchar_t *__s1, __const wchar_t *__s2, size_t __n)
276 __THROW;
278 /* Set N wide characters of S to C. */
279 extern wchar_t *wmemset (wchar_t *__s, wchar_t __c, size_t __n) __THROW;
280 __END_NAMESPACE_C99
282 #ifdef __USE_GNU
283 /* Copy N wide characters of SRC to DEST and return pointer to following
284 wide character. */
285 extern wchar_t *wmempcpy (wchar_t *__restrict __s1,
286 __const wchar_t *__restrict __s2, size_t __n)
287 __THROW;
288 #endif
291 __BEGIN_NAMESPACE_C99
292 /* Determine whether C constitutes a valid (one-byte) multibyte
293 character. */
294 extern wint_t btowc (int __c) __THROW;
296 /* Determine whether C corresponds to a member of the extended
297 character set whose multibyte representation is a single byte. */
298 extern int wctob (wint_t __c) __THROW;
300 /* Determine whether PS points to an object representing the initial
301 state. */
302 extern int mbsinit (__const mbstate_t *__ps) __THROW __attribute_pure__;
304 /* Write wide character representation of multibyte character pointed
305 to by S to PWC. */
306 extern size_t mbrtowc (wchar_t *__restrict __pwc,
307 __const char *__restrict __s, size_t __n,
308 mbstate_t *__p) __THROW;
310 /* Write multibyte representation of wide character WC to S. */
311 extern size_t wcrtomb (char *__restrict __s, wchar_t __wc,
312 mbstate_t *__restrict __ps) __THROW;
314 /* Return number of bytes in multibyte character pointed to by S. */
315 extern size_t __mbrlen (__const char *__restrict __s, size_t __n,
316 mbstate_t *__restrict __ps) __THROW;
317 extern size_t mbrlen (__const char *__restrict __s, size_t __n,
318 mbstate_t *__restrict __ps) __THROW;
319 __END_NAMESPACE_C99
321 #ifdef __USE_EXTERN_INLINES
322 /* Define inline function as optimization. */
324 # ifndef __cplusplus
325 /* We can use the BTOWC and WCTOB optimizations since we know that all
326 locales must use ASCII encoding for the values in the ASCII range
327 and because the wchar_t encoding is always ISO 10646. */
328 extern wint_t __btowc_alias (int __c) __asm ("btowc");
329 extern __inline wint_t
330 __NTH (btowc (int __c))
331 { return (__builtin_constant_p (__c) && __c >= '\0' && __c <= '\x7f'
332 ? (wint_t) __c : __btowc_alias (__c)); }
334 extern int __wctob_alias (wint_t __c) __asm ("wctob");
335 extern __inline int
336 __NTH (wctob (wint_t __wc))
337 { return (__builtin_constant_p (__wc) && __wc >= L'\0' && __wc <= L'\x7f'
338 ? (int) __wc : __wctob_alias (__wc)); }
339 # endif
341 extern __inline size_t
342 __NTH (mbrlen (__const char *__restrict __s, size_t __n,
343 mbstate_t *__restrict __ps))
344 { return (__ps != NULL
345 ? mbrtowc (NULL, __s, __n, __ps) : __mbrlen (__s, __n, NULL)); }
346 #endif
348 __BEGIN_NAMESPACE_C99
349 /* Write wide character representation of multibyte character string
350 SRC to DST. */
351 extern size_t mbsrtowcs (wchar_t *__restrict __dst,
352 __const char **__restrict __src, size_t __len,
353 mbstate_t *__restrict __ps) __THROW;
355 /* Write multibyte character representation of wide character string
356 SRC to DST. */
357 extern size_t wcsrtombs (char *__restrict __dst,
358 __const wchar_t **__restrict __src, size_t __len,
359 mbstate_t *__restrict __ps) __THROW;
360 __END_NAMESPACE_C99
363 #ifdef __USE_GNU
364 /* Write wide character representation of at most NMC bytes of the
365 multibyte character string SRC to DST. */
366 extern size_t mbsnrtowcs (wchar_t *__restrict __dst,
367 __const char **__restrict __src, size_t __nmc,
368 size_t __len, mbstate_t *__restrict __ps) __THROW;
370 /* Write multibyte character representation of at most NWC characters
371 from the wide character string SRC to DST. */
372 extern size_t wcsnrtombs (char *__restrict __dst,
373 __const wchar_t **__restrict __src,
374 size_t __nwc, size_t __len,
375 mbstate_t *__restrict __ps) __THROW;
376 #endif /* use GNU */
379 /* The following functions are extensions found in X/Open CAE. */
380 #ifdef __USE_XOPEN
381 /* Determine number of column positions required for C. */
382 extern int wcwidth (wchar_t __c) __THROW;
384 /* Determine number of column positions required for first N wide
385 characters (or fewer if S ends before this) in S. */
386 extern int wcswidth (__const wchar_t *__s, size_t __n) __THROW;
387 #endif /* Use X/Open. */
390 __BEGIN_NAMESPACE_C99
391 /* Convert initial portion of the wide string NPTR to `double'
392 representation. */
393 extern double wcstod (__const wchar_t *__restrict __nptr,
394 wchar_t **__restrict __endptr) __THROW;
396 #ifdef __USE_ISOC99
397 /* Likewise for `float' and `long double' sizes of floating-point numbers. */
398 extern float wcstof (__const wchar_t *__restrict __nptr,
399 wchar_t **__restrict __endptr) __THROW;
400 extern long double wcstold (__const wchar_t *__restrict __nptr,
401 wchar_t **__restrict __endptr) __THROW;
402 #endif /* C99 */
405 /* Convert initial portion of wide string NPTR to `long int'
406 representation. */
407 extern long int wcstol (__const wchar_t *__restrict __nptr,
408 wchar_t **__restrict __endptr, int __base) __THROW;
410 /* Convert initial portion of wide string NPTR to `unsigned long int'
411 representation. */
412 extern unsigned long int wcstoul (__const wchar_t *__restrict __nptr,
413 wchar_t **__restrict __endptr, int __base)
414 __THROW;
416 #if defined __USE_ISOC99 || (defined __GNUC__ && defined __USE_GNU)
417 /* Convert initial portion of wide string NPTR to `long int'
418 representation. */
419 __extension__
420 extern long long int wcstoll (__const wchar_t *__restrict __nptr,
421 wchar_t **__restrict __endptr, int __base)
422 __THROW;
424 /* Convert initial portion of wide string NPTR to `unsigned long long int'
425 representation. */
426 __extension__
427 extern unsigned long long int wcstoull (__const wchar_t *__restrict __nptr,
428 wchar_t **__restrict __endptr,
429 int __base) __THROW;
430 #endif /* ISO C99 or GCC and GNU. */
431 __END_NAMESPACE_C99
433 #if defined __GNUC__ && defined __USE_GNU
434 /* Convert initial portion of wide string NPTR to `long int'
435 representation. */
436 __extension__
437 extern long long int wcstoq (__const wchar_t *__restrict __nptr,
438 wchar_t **__restrict __endptr, int __base)
439 __THROW;
441 /* Convert initial portion of wide string NPTR to `unsigned long long int'
442 representation. */
443 __extension__
444 extern unsigned long long int wcstouq (__const wchar_t *__restrict __nptr,
445 wchar_t **__restrict __endptr,
446 int __base) __THROW;
447 #endif /* GCC and use GNU. */
449 #ifdef __USE_GNU
450 /* The concept of one static locale per category is not very well
451 thought out. Many applications will need to process its data using
452 information from several different locales. Another application is
453 the implementation of the internationalization handling in the
454 upcoming ISO C++ standard library. To support this another set of
455 the functions using locale data exist which have an additional
456 argument.
458 Attention: all these functions are *not* standardized in any form.
459 This is a proof-of-concept implementation. */
461 /* Structure for reentrant locale using functions. This is an
462 (almost) opaque type for the user level programs. */
463 # include <xlocale.h>
465 /* Special versions of the functions above which take the locale to
466 use as an additional parameter. */
467 extern long int wcstol_l (__const wchar_t *__restrict __nptr,
468 wchar_t **__restrict __endptr, int __base,
469 __locale_t __loc) __THROW;
471 extern unsigned long int wcstoul_l (__const wchar_t *__restrict __nptr,
472 wchar_t **__restrict __endptr,
473 int __base, __locale_t __loc) __THROW;
475 __extension__
476 extern long long int wcstoll_l (__const wchar_t *__restrict __nptr,
477 wchar_t **__restrict __endptr,
478 int __base, __locale_t __loc) __THROW;
480 __extension__
481 extern unsigned long long int wcstoull_l (__const wchar_t *__restrict __nptr,
482 wchar_t **__restrict __endptr,
483 int __base, __locale_t __loc)
484 __THROW;
486 extern double wcstod_l (__const wchar_t *__restrict __nptr,
487 wchar_t **__restrict __endptr, __locale_t __loc)
488 __THROW;
490 extern float wcstof_l (__const wchar_t *__restrict __nptr,
491 wchar_t **__restrict __endptr, __locale_t __loc)
492 __THROW;
494 extern long double wcstold_l (__const wchar_t *__restrict __nptr,
495 wchar_t **__restrict __endptr,
496 __locale_t __loc) __THROW;
497 #endif /* GNU */
500 /* The internal entry points for `wcstoX' take an extra flag argument
501 saying whether or not to parse locale-dependent number grouping. */
502 extern double __wcstod_internal (__const wchar_t *__restrict __nptr,
503 wchar_t **__restrict __endptr, int __group)
504 __THROW;
505 extern float __wcstof_internal (__const wchar_t *__restrict __nptr,
506 wchar_t **__restrict __endptr, int __group)
507 __THROW;
508 extern long double __wcstold_internal (__const wchar_t *__restrict __nptr,
509 wchar_t **__restrict __endptr,
510 int __group) __THROW;
512 #if !defined __wcstol_internal_defined \
513 && defined __OPTIMIZE__ && __GNUC__ >= 2
514 extern long int __wcstol_internal (__const wchar_t *__restrict __nptr,
515 wchar_t **__restrict __endptr,
516 int __base, int __group) __THROW;
517 # define __wcstol_internal_defined 1
518 #endif
519 #if !defined __wcstoul_internal_defined \
520 && defined __OPTIMIZE__ && __GNUC__ >= 2
521 extern unsigned long int __wcstoul_internal (__const wchar_t *__restrict __npt,
522 wchar_t **__restrict __endptr,
523 int __base, int __group) __THROW;
524 # define __wcstoul_internal_defined 1
525 #endif
526 #if !defined __wcstoll_internal_defined \
527 && defined __OPTIMIZE__ && __GNUC__ >= 2
528 __extension__
529 extern long long int __wcstoll_internal (__const wchar_t *__restrict __nptr,
530 wchar_t **__restrict __endptr,
531 int __base, int __group) __THROW;
532 # define __wcstoll_internal_defined 1
533 #endif
534 #if !defined __wcstoull_internal_defined \
535 && defined __OPTIMIZE__ && __GNUC__ >= 2
536 __extension__
537 extern unsigned long long int __wcstoull_internal (__const wchar_t *
538 __restrict __nptr,
539 wchar_t **
540 __restrict __endptr,
541 int __base,
542 int __group) __THROW;
543 # define __wcstoull_internal_defined 1
544 #endif
547 #if defined __OPTIMIZE__ && __GNUC__ >= 2
548 /* Define inline functions which call the internal entry points. */
549 __BEGIN_NAMESPACE_C99
551 extern __inline double
552 __NTH (wcstod (__const wchar_t *__restrict __nptr,
553 wchar_t **__restrict __endptr))
554 { return __wcstod_internal (__nptr, __endptr, 0); }
555 extern __inline long int
556 __NTH (wcstol (__const wchar_t *__restrict __nptr,
557 wchar_t **__restrict __endptr, int __base))
558 { return __wcstol_internal (__nptr, __endptr, __base, 0); }
559 extern __inline unsigned long int
560 __NTH (wcstoul (__const wchar_t *__restrict __nptr,
561 wchar_t **__restrict __endptr, int __base))
562 { return __wcstoul_internal (__nptr, __endptr, __base, 0); }
563 __END_NAMESPACE_C99
565 # ifdef __USE_GNU
566 extern __inline float
567 __NTH (wcstof (__const wchar_t *__restrict __nptr,
568 wchar_t **__restrict __endptr))
569 { return __wcstof_internal (__nptr, __endptr, 0); }
570 # ifndef __LDBL_COMPAT
571 extern __inline long double
572 __NTH (wcstold (__const wchar_t *__restrict __nptr,
573 wchar_t **__restrict __endptr))
574 { return __wcstold_internal (__nptr, __endptr, 0); }
575 # endif
576 __extension__
577 extern __inline long long int
578 __NTH (wcstoq (__const wchar_t *__restrict __nptr,
579 wchar_t **__restrict __endptr, int __base))
580 { return __wcstoll_internal (__nptr, __endptr, __base, 0); }
581 __extension__
582 extern __inline unsigned long long int
583 __NTH (wcstouq (__const wchar_t *__restrict __nptr,
584 wchar_t **__restrict __endptr, int __base))
585 { return __wcstoull_internal (__nptr, __endptr, __base, 0); }
586 # endif /* Use GNU. */
587 #endif /* Optimizing GCC >=2. */
590 #ifdef __USE_GNU
591 /* Copy SRC to DEST, returning the address of the terminating L'\0' in
592 DEST. */
593 extern wchar_t *wcpcpy (wchar_t *__dest, __const wchar_t *__src) __THROW;
595 /* Copy no more than N characters of SRC to DEST, returning the address of
596 the last character written into DEST. */
597 extern wchar_t *wcpncpy (wchar_t *__dest, __const wchar_t *__src, size_t __n)
598 __THROW;
599 #endif /* use GNU */
602 /* Wide character I/O functions. */
604 #ifdef __USE_GNU
605 /* Like OPEN_MEMSTREAM, but the stream is wide oriented and produces
606 a wide character string. */
607 extern __FILE *open_wmemstream (wchar_t **__bufloc, size_t *__sizeloc) __THROW;
608 #endif
610 #if defined __USE_ISOC99 || defined __USE_UNIX98
611 __BEGIN_NAMESPACE_C99
613 /* Select orientation for stream. */
614 extern int fwide (__FILE *__fp, int __mode) __THROW;
617 /* Write formatted output to STREAM.
619 This function is a possible cancellation point and therefore not
620 marked with __THROW. */
621 extern int fwprintf (__FILE *__restrict __stream,
622 __const wchar_t *__restrict __format, ...)
623 /* __attribute__ ((__format__ (__wprintf__, 2, 3))) */;
624 /* Write formatted output to stdout.
626 This function is a possible cancellation point and therefore not
627 marked with __THROW. */
628 extern int wprintf (__const wchar_t *__restrict __format, ...)
629 /* __attribute__ ((__format__ (__wprintf__, 1, 2))) */;
630 /* Write formatted output of at most N characters to S. */
631 extern int swprintf (wchar_t *__restrict __s, size_t __n,
632 __const wchar_t *__restrict __format, ...)
633 __THROW /* __attribute__ ((__format__ (__wprintf__, 3, 4))) */;
635 /* Write formatted output to S from argument list ARG.
637 This function is a possible cancellation point and therefore not
638 marked with __THROW. */
639 extern int vfwprintf (__FILE *__restrict __s,
640 __const wchar_t *__restrict __format,
641 __gnuc_va_list __arg)
642 /* __attribute__ ((__format__ (__wprintf__, 2, 0))) */;
643 /* Write formatted output to stdout from argument list ARG.
645 This function is a possible cancellation point and therefore not
646 marked with __THROW. */
647 extern int vwprintf (__const wchar_t *__restrict __format,
648 __gnuc_va_list __arg)
649 /* __attribute__ ((__format__ (__wprintf__, 1, 0))) */;
650 /* Write formatted output of at most N character to S from argument
651 list ARG. */
652 extern int vswprintf (wchar_t *__restrict __s, size_t __n,
653 __const wchar_t *__restrict __format,
654 __gnuc_va_list __arg)
655 __THROW /* __attribute__ ((__format__ (__wprintf__, 3, 0))) */;
658 /* Read formatted input from STREAM.
660 This function is a possible cancellation point and therefore not
661 marked with __THROW. */
662 extern int fwscanf (__FILE *__restrict __stream,
663 __const wchar_t *__restrict __format, ...)
664 /* __attribute__ ((__format__ (__wscanf__, 2, 3))) */;
665 /* Read formatted input from stdin.
667 This function is a possible cancellation point and therefore not
668 marked with __THROW. */
669 extern int wscanf (__const wchar_t *__restrict __format, ...)
670 /* __attribute__ ((__format__ (__wscanf__, 1, 2))) */;
671 /* Read formatted input from S. */
672 extern int swscanf (__const wchar_t *__restrict __s,
673 __const wchar_t *__restrict __format, ...)
674 __THROW /* __attribute__ ((__format__ (__wscanf__, 2, 3))) */;
676 __END_NAMESPACE_C99
677 #endif /* Use ISO C99 and Unix98. */
679 #ifdef __USE_ISOC99
680 __BEGIN_NAMESPACE_C99
682 /* Read formatted input from S into argument list ARG.
684 This function is a possible cancellation point and therefore not
685 marked with __THROW. */
686 extern int vfwscanf (__FILE *__restrict __s,
687 __const wchar_t *__restrict __format,
688 __gnuc_va_list __arg)
689 /* __attribute__ ((__format__ (__wscanf__, 2, 0))) */;
690 /* Read formatted input from stdin into argument list ARG.
692 This function is a possible cancellation point and therefore not
693 marked with __THROW. */
694 extern int vwscanf (__const wchar_t *__restrict __format,
695 __gnuc_va_list __arg)
696 /* __attribute__ ((__format__ (__wscanf__, 1, 0))) */;
697 /* Read formatted input from S into argument list ARG. */
698 extern int vswscanf (__const wchar_t *__restrict __s,
699 __const wchar_t *__restrict __format,
700 __gnuc_va_list __arg)
701 __THROW /* __attribute__ ((__format__ (__wscanf__, 2, 0))) */;
703 __END_NAMESPACE_C99
704 #endif /* Use ISO C99. */
707 __BEGIN_NAMESPACE_C99
708 /* Read a character from STREAM.
710 These functions are possible cancellation points and therefore not
711 marked with __THROW. */
712 extern wint_t fgetwc (__FILE *__stream);
713 extern wint_t getwc (__FILE *__stream);
715 /* Read a character from stdin.
717 This function is a possible cancellation point and therefore not
718 marked with __THROW. */
719 extern wint_t getwchar (void);
722 /* Write a character to STREAM.
724 These functions are possible cancellation points and therefore not
725 marked with __THROW. */
726 extern wint_t fputwc (wchar_t __wc, __FILE *__stream);
727 extern wint_t putwc (wchar_t __wc, __FILE *__stream);
729 /* Write a character to stdout.
731 This function is a possible cancellation points and therefore not
732 marked with __THROW. */
733 extern wint_t putwchar (wchar_t __wc);
736 /* Get a newline-terminated wide character string of finite length
737 from STREAM.
739 This function is a possible cancellation points and therefore not
740 marked with __THROW. */
741 extern wchar_t *fgetws (wchar_t *__restrict __ws, int __n,
742 __FILE *__restrict __stream);
744 /* Write a string to STREAM.
746 This function is a possible cancellation points and therefore not
747 marked with __THROW. */
748 extern int fputws (__const wchar_t *__restrict __ws,
749 __FILE *__restrict __stream);
752 /* Push a character back onto the input buffer of STREAM.
754 This function is a possible cancellation points and therefore not
755 marked with __THROW. */
756 extern wint_t ungetwc (wint_t __wc, __FILE *__stream);
757 __END_NAMESPACE_C99
760 #ifdef __USE_GNU
761 /* These are defined to be equivalent to the `char' functions defined
762 in POSIX.1:1996.
764 These functions are not part of POSIX and therefore no official
765 cancellation point. But due to similarity with an POSIX interface
766 or due to the implementation they are cancellation points and
767 therefore not marked with __THROW. */
768 extern wint_t getwc_unlocked (__FILE *__stream);
769 extern wint_t getwchar_unlocked (void);
771 /* This is the wide character version of a GNU extension.
773 This function is not part of POSIX and therefore no official
774 cancellation point. But due to similarity with an POSIX interface
775 or due to the implementation it is a cancellation point and
776 therefore not marked with __THROW. */
777 extern wint_t fgetwc_unlocked (__FILE *__stream);
779 /* Faster version when locking is not necessary.
781 This function is not part of POSIX and therefore no official
782 cancellation point. But due to similarity with an POSIX interface
783 or due to the implementation it is a cancellation point and
784 therefore not marked with __THROW. */
785 extern wint_t fputwc_unlocked (wchar_t __wc, __FILE *__stream);
787 /* These are defined to be equivalent to the `char' functions defined
788 in POSIX.1:1996.
790 These functions are not part of POSIX and therefore no official
791 cancellation point. But due to similarity with an POSIX interface
792 or due to the implementation they are cancellation points and
793 therefore not marked with __THROW. */
794 extern wint_t putwc_unlocked (wchar_t __wc, __FILE *__stream);
795 extern wint_t putwchar_unlocked (wchar_t __wc);
798 /* This function does the same as `fgetws' but does not lock the stream.
800 This function is not part of POSIX and therefore no official
801 cancellation point. But due to similarity with an POSIX interface
802 or due to the implementation it is a cancellation point and
803 therefore not marked with __THROW. */
804 extern wchar_t *fgetws_unlocked (wchar_t *__restrict __ws, int __n,
805 __FILE *__restrict __stream);
807 /* This function does the same as `fputws' but does not lock the stream.
809 This function is not part of POSIX and therefore no official
810 cancellation point. But due to similarity with an POSIX interface
811 or due to the implementation it is a cancellation point and
812 therefore not marked with __THROW. */
813 extern int fputws_unlocked (__const wchar_t *__restrict __ws,
814 __FILE *__restrict __stream);
815 #endif
818 __BEGIN_NAMESPACE_C99
819 /* Format TP into S according to FORMAT.
820 Write no more than MAXSIZE wide characters and return the number
821 of wide characters written, or 0 if it would exceed MAXSIZE. */
822 extern size_t wcsftime (wchar_t *__restrict __s, size_t __maxsize,
823 __const wchar_t *__restrict __format,
824 __const struct tm *__restrict __tp) __THROW;
825 __END_NAMESPACE_C99
827 # ifdef __USE_GNU
828 # include <xlocale.h>
830 /* Similar to `wcsftime' but takes the information from
831 the provided locale and not the global locale. */
832 extern size_t wcsftime_l (wchar_t *__restrict __s, size_t __maxsize,
833 __const wchar_t *__restrict __format,
834 __const struct tm *__restrict __tp,
835 __locale_t __loc) __THROW;
836 # endif
838 /* The X/Open standard demands that most of the functions defined in
839 the <wctype.h> header must also appear here. This is probably
840 because some X/Open members wrote their implementation before the
841 ISO C standard was published and introduced the better solution.
842 We have to provide these definitions for compliance reasons but we
843 do this nonsense only if really necessary. */
844 #if defined __USE_UNIX98 && !defined __USE_GNU
845 # define __need_iswxxx
846 # include <wctype.h>
847 #endif
849 /* Define some macros helping to catch buffer overflows. */
850 #if __USE_FORTIFY_LEVEL > 0 && !defined __cplusplus
851 # include <bits/wchar2.h>
852 #endif
854 #ifdef __LDBL_COMPAT
855 # include <bits/wchar-ldbl.h>
856 #endif
858 __END_DECLS
860 #endif /* _WCHAR_H defined */
862 #endif /* wchar.h */