]> git.ipfire.org Git - thirdparty/glibc.git/blame - wcsmbs/wchar.h
Use locale_t, not __locale_t, throughout glibc
[thirdparty/glibc.git] / wcsmbs / wchar.h
CommitLineData
bfff8b1b 1/* Copyright (C) 1995-2017 Free Software Foundation, Inc.
b5791037 2 This file is part of the GNU C Library.
30de3b18 3
b5791037 4 The GNU C Library is free software; you can redistribute it and/or
41bdb6e2
AJ
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.
30de3b18 8
b5791037
UD
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
41bdb6e2 12 Lesser General Public License for more details.
30de3b18 13
41bdb6e2 14 You should have received a copy of the GNU Lesser General Public
59ba27a6
PE
15 License along with the GNU C Library; if not, see
16 <http://www.gnu.org/licenses/>. */
30de3b18
RM
17
18/*
d1646309
UD
19 * ISO C99 Standard: 7.24
20 * Extended multibyte and wide character utilities <wchar.h>
30de3b18
RM
21 */
22
23#ifndef _WCHAR_H
199fc19d 24#define _WCHAR_H 1
5107cf1d 25
199fc19d
ZW
26#define __GLIBC_INTERNAL_STARTING_HEADER_IMPLEMENTATION
27#include <bits/libc-header-start.h>
30de3b18 28
45f39d45
PM
29/* Gather machine dependent type support. */
30#include <bits/floatn.h>
31
199fc19d
ZW
32#define __need_size_t
33#define __need_wchar_t
34#define __need_NULL
35#include <stddef.h>
30de3b18 36
199fc19d
ZW
37#define __need___va_list
38#include <stdarg.h>
7b503bcc 39
199fc19d
ZW
40#include <bits/wchar.h>
41#include <bits/types/wint_t.h>
42#include <bits/types/mbstate_t.h>
43#include <bits/types/__FILE.h>
9ac9129d 44
199fc19d
ZW
45#if defined __USE_UNIX98 || defined __USE_XOPEN2K
46# include <bits/types/FILE.h>
71a40c74 47#endif
f0be25b6
ZW
48#ifdef __USE_XOPEN2K8
49# include <bits/types/locale_t.h>
50#endif
71a40c74 51
199fc19d
ZW
52/* Tell the caller that we provide correct C++ prototypes. */
53#if defined __cplusplus && __GNUC_PREREQ (4, 4)
54# define __CORRECT_ISO_CPP_WCHAR_H_PROTO
d64b6ad0 55#endif
db6af3eb 56
cc3fa755
UD
57#ifndef WCHAR_MIN
58/* These constants might also be defined in <inttypes.h>. */
417bafec
UD
59# define WCHAR_MIN __WCHAR_MIN
60# define WCHAR_MAX __WCHAR_MAX
cc3fa755 61#endif
30de3b18
RM
62
63#ifndef WEOF
64# define WEOF (0xffffffffu)
65#endif
66
199fc19d
ZW
67/* All versions of XPG prior to the publication of ISO C99 required
68 the bulk of <wctype.h>'s declarations to appear in this header
69 (because <wctype.h> did not exist prior to C99). In POSIX.1-2001
70 those declarations were marked as XSI extensions; in -2008 they
71 were additionally marked as obsolescent. _GNU_SOURCE mode
72 anticipates the removal of these declarations in the next revision
73 of POSIX. */
74#if (defined __USE_XOPEN && !defined __USE_GNU \
75 && !(defined __USE_XOPEN2K && !defined __USE_XOPEN2KXSI))
76# include <bits/wctype-wchar.h>
e918a7fe
UD
77#endif
78
7a5affeb
UD
79__BEGIN_DECLS
80
9756dfe1
UD
81/* This incomplete type is defined in <time.h> but needed here because
82 of `wcsftime'. */
83struct tm;
84
85
30de3b18 86/* Copy SRC to DEST. */
c1422e5b 87extern wchar_t *wcscpy (wchar_t *__restrict __dest,
a6ab6ccd
DM
88 const wchar_t *__restrict __src)
89 __THROW __nonnull ((1, 2));
90
30de3b18 91/* Copy no more than N wide-characters of SRC to DEST. */
c1422e5b 92extern wchar_t *wcsncpy (wchar_t *__restrict __dest,
a784e502 93 const wchar_t *__restrict __src, size_t __n)
a6ab6ccd 94 __THROW __nonnull ((1, 2));
30de3b18
RM
95
96/* Append SRC onto DEST. */
c1422e5b 97extern wchar_t *wcscat (wchar_t *__restrict __dest,
aeb47bbc
DM
98 const wchar_t *__restrict __src)
99 __THROW __nonnull ((1, 2));
30de3b18 100/* Append no more than N wide-characters of SRC onto DEST. */
c1422e5b 101extern wchar_t *wcsncat (wchar_t *__restrict __dest,
a784e502 102 const wchar_t *__restrict __src, size_t __n)
aeb47bbc 103 __THROW __nonnull ((1, 2));
30de3b18
RM
104
105/* Compare S1 and S2. */
a784e502 106extern int wcscmp (const wchar_t *__s1, const wchar_t *__s2)
aeb47bbc 107 __THROW __attribute_pure__ __nonnull ((1, 2));
30de3b18 108/* Compare N wide-characters of S1 and S2. */
a784e502 109extern int wcsncmp (const wchar_t *__s1, const wchar_t *__s2, size_t __n)
aeb47bbc 110 __THROW __attribute_pure__ __nonnull ((1, 2));
30de3b18 111
6cbe890a 112#ifdef __USE_XOPEN2K8
2f6d1f1b 113/* Compare S1 and S2, ignoring case. */
a784e502 114extern int wcscasecmp (const wchar_t *__s1, const wchar_t *__s2) __THROW;
2f6d1f1b
UD
115
116/* Compare no more than N chars of S1 and S2, ignoring case. */
a784e502 117extern int wcsncasecmp (const wchar_t *__s1, const wchar_t *__s2,
c1422e5b 118 size_t __n) __THROW;
0501d603
UD
119
120/* Similar to the two functions above but take the information from
121 the provided locale and not the global locale. */
a784e502 122extern int wcscasecmp_l (const wchar_t *__s1, const wchar_t *__s2,
af85385f 123 locale_t __loc) __THROW;
0501d603 124
a784e502 125extern int wcsncasecmp_l (const wchar_t *__s1, const wchar_t *__s2,
af85385f 126 size_t __n, locale_t __loc) __THROW;
2f6d1f1b
UD
127#endif
128
75cd5204
RM
129/* Compare S1 and S2, both interpreted as appropriate to the
130 LC_COLLATE category of the current locale. */
a784e502 131extern int wcscoll (const wchar_t *__s1, const wchar_t *__s2) __THROW;
75cd5204
RM
132/* Transform S2 into array pointed to by S1 such that if wcscmp is
133 applied to two transformed strings the result is the as applying
134 `wcscoll' to the original strings. */
c1422e5b 135extern size_t wcsxfrm (wchar_t *__restrict __s1,
a784e502 136 const wchar_t *__restrict __s2, size_t __n) __THROW;
75cd5204 137
6cbe890a 138#ifdef __USE_XOPEN2K8
c84142e8
UD
139/* Similar to the two functions above but take the information from
140 the provided locale and not the global locale. */
c84142e8
UD
141
142/* Compare S1 and S2, both interpreted as appropriate to the
143 LC_COLLATE category of the given locale. */
a784e502 144extern int wcscoll_l (const wchar_t *__s1, const wchar_t *__s2,
af85385f 145 locale_t __loc) __THROW;
1ab62b32 146
c84142e8
UD
147/* Transform S2 into array pointed to by S1 such that if wcscmp is
148 applied to two transformed strings the result is the as applying
149 `wcscoll' to the original strings. */
a784e502 150extern size_t wcsxfrm_l (wchar_t *__s1, const wchar_t *__s2,
af85385f 151 size_t __n, locale_t __loc) __THROW;
c84142e8 152
30de3b18 153/* Duplicate S, returning an identical malloc'd string. */
a784e502 154extern wchar_t *wcsdup (const wchar_t *__s) __THROW __attribute_malloc__;
1618c590 155#endif
30de3b18 156
6d52618b 157/* Find the first occurrence of WC in WCS. */
d8387c7b
UD
158#ifdef __CORRECT_ISO_CPP_WCHAR_H_PROTO
159extern "C++" wchar_t *wcschr (wchar_t *__wcs, wchar_t __wc)
160 __THROW __asm ("wcschr") __attribute_pure__;
a784e502 161extern "C++" const wchar_t *wcschr (const wchar_t *__wcs, wchar_t __wc)
9ac9129d 162 __THROW __asm ("wcschr") __attribute_pure__;
d8387c7b 163#else
a784e502 164extern wchar_t *wcschr (const wchar_t *__wcs, wchar_t __wc)
fb4dfa0c 165 __THROW __attribute_pure__;
d8387c7b 166#endif
6d52618b 167/* Find the last occurrence of WC in WCS. */
d8387c7b
UD
168#ifdef __CORRECT_ISO_CPP_WCHAR_H_PROTO
169extern "C++" wchar_t *wcsrchr (wchar_t *__wcs, wchar_t __wc)
170 __THROW __asm ("wcsrchr") __attribute_pure__;
a784e502 171extern "C++" const wchar_t *wcsrchr (const wchar_t *__wcs, wchar_t __wc)
d8387c7b
UD
172 __THROW __asm ("wcsrchr") __attribute_pure__;
173#else
a784e502 174extern wchar_t *wcsrchr (const wchar_t *__wcs, wchar_t __wc)
fb4dfa0c 175 __THROW __attribute_pure__;
d8387c7b 176#endif
30de3b18 177
d64b6ad0 178#ifdef __USE_GNU
557a9213 179/* This function is similar to `wcschr'. But it returns a pointer to
d64b6ad0 180 the closing NUL wide character in case C is not found in S. */
a784e502 181extern wchar_t *wcschrnul (const wchar_t *__s, wchar_t __wc)
fb4dfa0c 182 __THROW __attribute_pure__;
d64b6ad0
UD
183#endif
184
30de3b18 185/* Return the length of the initial segmet of WCS which
1618c590 186 consists entirely of wide characters not in REJECT. */
a784e502 187extern size_t wcscspn (const wchar_t *__wcs, const wchar_t *__reject)
fb4dfa0c 188 __THROW __attribute_pure__;
30de3b18 189/* Return the length of the initial segmet of WCS which
1618c590 190 consists entirely of wide characters in ACCEPT. */
a784e502 191extern size_t wcsspn (const wchar_t *__wcs, const wchar_t *__accept)
fb4dfa0c 192 __THROW __attribute_pure__;
6d52618b 193/* Find the first occurrence in WCS of any character in ACCEPT. */
d8387c7b 194#ifdef __CORRECT_ISO_CPP_WCHAR_H_PROTO
a784e502 195extern "C++" wchar_t *wcspbrk (wchar_t *__wcs, const wchar_t *__accept)
d8387c7b 196 __THROW __asm ("wcspbrk") __attribute_pure__;
a784e502
UD
197extern "C++" const wchar_t *wcspbrk (const wchar_t *__wcs,
198 const wchar_t *__accept)
d8387c7b
UD
199 __THROW __asm ("wcspbrk") __attribute_pure__;
200#else
a784e502 201extern wchar_t *wcspbrk (const wchar_t *__wcs, const wchar_t *__accept)
fb4dfa0c 202 __THROW __attribute_pure__;
d8387c7b 203#endif
6d52618b 204/* Find the first occurrence of NEEDLE in HAYSTACK. */
d8387c7b 205#ifdef __CORRECT_ISO_CPP_WCHAR_H_PROTO
a784e502 206extern "C++" wchar_t *wcsstr (wchar_t *__haystack, const wchar_t *__needle)
d8387c7b 207 __THROW __asm ("wcsstr") __attribute_pure__;
a784e502
UD
208extern "C++" const wchar_t *wcsstr (const wchar_t *__haystack,
209 const wchar_t *__needle)
d8387c7b
UD
210 __THROW __asm ("wcsstr") __attribute_pure__;
211#else
a784e502 212extern wchar_t *wcsstr (const wchar_t *__haystack, const wchar_t *__needle)
fb4dfa0c 213 __THROW __attribute_pure__;
d8387c7b 214#endif
e918a7fe 215
30de3b18 216/* Divide WCS into tokens separated by characters in DELIM. */
c1422e5b 217extern wchar_t *wcstok (wchar_t *__restrict __s,
a784e502 218 const wchar_t *__restrict __delim,
c1422e5b 219 wchar_t **__restrict __ptr) __THROW;
30de3b18 220
1618c590 221/* Return the number of wide characters in S. */
a784e502 222extern size_t wcslen (const wchar_t *__s) __THROW __attribute_pure__;
7a5affeb
UD
223
224#ifdef __USE_XOPEN
225/* Another name for `wcsstr' from XPG4. */
d8387c7b 226# ifdef __CORRECT_ISO_CPP_WCHAR_H_PROTO
a784e502 227extern "C++" wchar_t *wcswcs (wchar_t *__haystack, const wchar_t *__needle)
d8387c7b 228 __THROW __asm ("wcswcs") __attribute_pure__;
a784e502
UD
229extern "C++" const wchar_t *wcswcs (const wchar_t *__haystack,
230 const wchar_t *__needle)
d8387c7b
UD
231 __THROW __asm ("wcswcs") __attribute_pure__;
232# else
a784e502 233extern wchar_t *wcswcs (const wchar_t *__haystack, const wchar_t *__needle)
7a5affeb 234 __THROW __attribute_pure__;
d8387c7b 235# endif
7a5affeb 236#endif
30de3b18 237
6cbe890a 238#ifdef __USE_XOPEN2K8
4bca4c17 239/* Return the number of wide characters in S, but at most MAXLEN. */
a784e502 240extern size_t wcsnlen (const wchar_t *__s, size_t __maxlen)
fb4dfa0c 241 __THROW __attribute_pure__;
4bca4c17
UD
242#endif
243
30de3b18 244
1618c590 245/* Search N wide characters of S for C. */
d8387c7b
UD
246#ifdef __CORRECT_ISO_CPP_WCHAR_H_PROTO
247extern "C++" wchar_t *wmemchr (wchar_t *__s, wchar_t __c, size_t __n)
248 __THROW __asm ("wmemchr") __attribute_pure__;
a784e502
UD
249extern "C++" const wchar_t *wmemchr (const wchar_t *__s, wchar_t __c,
250 size_t __n)
d8387c7b
UD
251 __THROW __asm ("wmemchr") __attribute_pure__;
252#else
a784e502 253extern wchar_t *wmemchr (const wchar_t *__s, wchar_t __c, size_t __n)
fb4dfa0c 254 __THROW __attribute_pure__;
d8387c7b 255#endif
30de3b18 256
1618c590 257/* Compare N wide characters of S1 and S2. */
a784e502 258extern int wmemcmp (const wchar_t *__s1, const wchar_t *__s2, size_t __n)
fb4dfa0c 259 __THROW __attribute_pure__;
30de3b18 260
1618c590 261/* Copy N wide characters of SRC to DEST. */
c1422e5b 262extern wchar_t *wmemcpy (wchar_t *__restrict __s1,
a784e502 263 const wchar_t *__restrict __s2, size_t __n) __THROW;
30de3b18 264
1618c590 265/* Copy N wide characters of SRC to DEST, guaranteeing
30de3b18 266 correct behavior for overlapping strings. */
a784e502 267extern wchar_t *wmemmove (wchar_t *__s1, const wchar_t *__s2, size_t __n)
c1422e5b 268 __THROW;
30de3b18 269
1618c590 270/* Set N wide characters of S to C. */
c1422e5b 271extern wchar_t *wmemset (wchar_t *__s, wchar_t __c, size_t __n) __THROW;
30de3b18 272
d64b6ad0
UD
273#ifdef __USE_GNU
274/* Copy N wide characters of SRC to DEST and return pointer to following
275 wide character. */
c1422e5b 276extern wchar_t *wmempcpy (wchar_t *__restrict __s1,
a784e502 277 const wchar_t *__restrict __s2, size_t __n)
c1422e5b 278 __THROW;
d64b6ad0
UD
279#endif
280
30de3b18
RM
281
282/* Determine whether C constitutes a valid (one-byte) multibyte
283 character. */
c1422e5b 284extern wint_t btowc (int __c) __THROW;
30de3b18
RM
285
286/* Determine whether C corresponds to a member of the extended
287 character set whose multibyte representation is a single byte. */
c1422e5b 288extern int wctob (wint_t __c) __THROW;
30de3b18
RM
289
290/* Determine whether PS points to an object representing the initial
291 state. */
a784e502 292extern int mbsinit (const mbstate_t *__ps) __THROW __attribute_pure__;
30de3b18 293
30de3b18
RM
294/* Write wide character representation of multibyte character pointed
295 to by S to PWC. */
c1422e5b 296extern size_t mbrtowc (wchar_t *__restrict __pwc,
a784e502 297 const char *__restrict __s, size_t __n,
dadebdae 298 mbstate_t *__restrict __p) __THROW;
30de3b18
RM
299
300/* Write multibyte representation of wide character WC to S. */
c1422e5b
UD
301extern size_t wcrtomb (char *__restrict __s, wchar_t __wc,
302 mbstate_t *__restrict __ps) __THROW;
30de3b18 303
07a4742f 304/* Return number of bytes in multibyte character pointed to by S. */
a784e502 305extern size_t __mbrlen (const char *__restrict __s, size_t __n,
c1422e5b 306 mbstate_t *__restrict __ps) __THROW;
a784e502 307extern size_t mbrlen (const char *__restrict __s, size_t __n,
c1422e5b 308 mbstate_t *__restrict __ps) __THROW;
07a4742f 309
07c416ed 310#ifdef __USE_EXTERN_INLINES
07a4742f 311/* Define inline function as optimization. */
91682d70
UD
312
313/* We can use the BTOWC and WCTOB optimizations since we know that all
314 locales must use ASCII encoding for the values in the ASCII range
315 and because the wchar_t encoding is always ISO 10646. */
316extern wint_t __btowc_alias (int __c) __asm ("btowc");
b037a293 317__extern_inline wint_t
91682d70
UD
318__NTH (btowc (int __c))
319{ return (__builtin_constant_p (__c) && __c >= '\0' && __c <= '\x7f'
320 ? (wint_t) __c : __btowc_alias (__c)); }
321
322extern int __wctob_alias (wint_t __c) __asm ("wctob");
b037a293 323__extern_inline int
91682d70
UD
324__NTH (wctob (wint_t __wc))
325{ return (__builtin_constant_p (__wc) && __wc >= L'\0' && __wc <= L'\x7f'
326 ? (int) __wc : __wctob_alias (__wc)); }
327
b037a293 328__extern_inline size_t
a784e502 329__NTH (mbrlen (const char *__restrict __s, size_t __n,
f377d022 330 mbstate_t *__restrict __ps))
2f6d1f1b 331{ return (__ps != NULL
bdbf022d 332 ? mbrtowc (NULL, __s, __n, __ps) : __mbrlen (__s, __n, NULL)); }
07a4742f
RM
333#endif
334
036cc82f
RM
335/* Write wide character representation of multibyte character string
336 SRC to DST. */
c1422e5b 337extern size_t mbsrtowcs (wchar_t *__restrict __dst,
a784e502 338 const char **__restrict __src, size_t __len,
c1422e5b 339 mbstate_t *__restrict __ps) __THROW;
30de3b18
RM
340
341/* Write multibyte character representation of wide character string
342 SRC to DST. */
c1422e5b 343extern size_t wcsrtombs (char *__restrict __dst,
a784e502 344 const wchar_t **__restrict __src, size_t __len,
c1422e5b 345 mbstate_t *__restrict __ps) __THROW;
30de3b18 346
75cd5204 347
6cbe890a 348#ifdef __USE_XOPEN2K8
036cc82f
RM
349/* Write wide character representation of at most NMC bytes of the
350 multibyte character string SRC to DST. */
c1422e5b 351extern size_t mbsnrtowcs (wchar_t *__restrict __dst,
a784e502 352 const char **__restrict __src, size_t __nmc,
c1422e5b 353 size_t __len, mbstate_t *__restrict __ps) __THROW;
036cc82f
RM
354
355/* Write multibyte character representation of at most NWC characters
356 from the wide character string SRC to DST. */
c1422e5b 357extern size_t wcsnrtombs (char *__restrict __dst,
a784e502 358 const wchar_t **__restrict __src,
c1422e5b
UD
359 size_t __nwc, size_t __len,
360 mbstate_t *__restrict __ps) __THROW;
6cbe890a 361#endif /* use POSIX 2008 */
e34b0f29 362
036cc82f 363
75cd5204 364/* The following functions are extensions found in X/Open CAE. */
9756dfe1 365#ifdef __USE_XOPEN
75cd5204 366/* Determine number of column positions required for C. */
b6d64fb0 367extern int wcwidth (wchar_t __c) __THROW;
75cd5204
RM
368
369/* Determine number of column positions required for first N wide
370 characters (or fewer if S ends before this) in S. */
a784e502 371extern int wcswidth (const wchar_t *__s, size_t __n) __THROW;
9756dfe1 372#endif /* Use X/Open. */
75cd5204
RM
373
374
375/* Convert initial portion of the wide string NPTR to `double'
376 representation. */
a784e502 377extern double wcstod (const wchar_t *__restrict __nptr,
c1422e5b 378 wchar_t **__restrict __endptr) __THROW;
75cd5204 379
ec751a23 380#ifdef __USE_ISOC99
75cd5204 381/* Likewise for `float' and `long double' sizes of floating-point numbers. */
a784e502 382extern float wcstof (const wchar_t *__restrict __nptr,
c1422e5b 383 wchar_t **__restrict __endptr) __THROW;
a784e502 384extern long double wcstold (const wchar_t *__restrict __nptr,
c1422e5b 385 wchar_t **__restrict __endptr) __THROW;
91bc38d0 386#endif /* C99 */
75cd5204 387
45f39d45
PM
388/* Likewise for `_Float128' when support is enabled. */
389#if __HAVE_FLOAT128 && defined __USE_GNU
390extern _Float128 wcstof128 (const wchar_t *__restrict __nptr,
391 wchar_t **__restrict __endptr) __THROW;
392#endif
393
75cd5204
RM
394
395/* Convert initial portion of wide string NPTR to `long int'
396 representation. */
a784e502 397extern long int wcstol (const wchar_t *__restrict __nptr,
c1422e5b 398 wchar_t **__restrict __endptr, int __base) __THROW;
75cd5204
RM
399
400/* Convert initial portion of wide string NPTR to `unsigned long int'
401 representation. */
a784e502 402extern unsigned long int wcstoul (const wchar_t *__restrict __nptr,
c1422e5b
UD
403 wchar_t **__restrict __endptr, int __base)
404 __THROW;
75cd5204 405
fed0faa1 406#ifdef __USE_ISOC99
9e6e344e 407/* Convert initial portion of wide string NPTR to `long long int'
75cd5204 408 representation. */
7782d0bf 409__extension__
a784e502 410extern long long int wcstoll (const wchar_t *__restrict __nptr,
7a5affeb 411 wchar_t **__restrict __endptr, int __base)
c1422e5b 412 __THROW;
75cd5204
RM
413
414/* Convert initial portion of wide string NPTR to `unsigned long long int'
415 representation. */
7782d0bf 416__extension__
a784e502 417extern unsigned long long int wcstoull (const wchar_t *__restrict __nptr,
7a5affeb
UD
418 wchar_t **__restrict __endptr,
419 int __base) __THROW;
fed0faa1 420#endif /* ISO C99. */
75cd5204 421
fed0faa1 422#ifdef __USE_GNU
9e6e344e 423/* Convert initial portion of wide string NPTR to `long long int'
2f6d1f1b 424 representation. */
7782d0bf 425__extension__
a784e502 426extern long long int wcstoq (const wchar_t *__restrict __nptr,
7a5affeb 427 wchar_t **__restrict __endptr, int __base)
c1422e5b 428 __THROW;
2f6d1f1b
UD
429
430/* Convert initial portion of wide string NPTR to `unsigned long long int'
431 representation. */
7782d0bf 432__extension__
a784e502 433extern unsigned long long int wcstouq (const wchar_t *__restrict __nptr,
7a5affeb
UD
434 wchar_t **__restrict __endptr,
435 int __base) __THROW;
fed0faa1 436#endif /* Use GNU. */
2f6d1f1b 437
0501d603 438#ifdef __USE_GNU
f0be25b6
ZW
439/* Parallel versions of the functions above which take the locale to
440 use as an additional parameter. These are GNU extensions inspired
441 by the POSIX.1-2008 extended locale API. */
a784e502 442extern long int wcstol_l (const wchar_t *__restrict __nptr,
1ab62b32 443 wchar_t **__restrict __endptr, int __base,
af85385f 444 locale_t __loc) __THROW;
0501d603 445
a784e502 446extern unsigned long int wcstoul_l (const wchar_t *__restrict __nptr,
1ab62b32 447 wchar_t **__restrict __endptr,
af85385f 448 int __base, locale_t __loc) __THROW;
0501d603 449
7782d0bf 450__extension__
a784e502 451extern long long int wcstoll_l (const wchar_t *__restrict __nptr,
1ab62b32 452 wchar_t **__restrict __endptr,
af85385f 453 int __base, locale_t __loc) __THROW;
0501d603 454
7782d0bf 455__extension__
a784e502 456extern unsigned long long int wcstoull_l (const wchar_t *__restrict __nptr,
1ab62b32 457 wchar_t **__restrict __endptr,
af85385f 458 int __base, locale_t __loc)
1ab62b32 459 __THROW;
0501d603 460
a784e502 461extern double wcstod_l (const wchar_t *__restrict __nptr,
af85385f 462 wchar_t **__restrict __endptr, locale_t __loc)
1ab62b32 463 __THROW;
0501d603 464
a784e502 465extern float wcstof_l (const wchar_t *__restrict __nptr,
af85385f 466 wchar_t **__restrict __endptr, locale_t __loc)
1ab62b32 467 __THROW;
0501d603 468
a784e502 469extern long double wcstold_l (const wchar_t *__restrict __nptr,
1ab62b32 470 wchar_t **__restrict __endptr,
af85385f 471 locale_t __loc) __THROW;
45f39d45
PM
472
473# if __HAVE_FLOAT128
474extern _Float128 wcstof128_l (const wchar_t *__restrict __nptr,
475 wchar_t **__restrict __endptr,
af85385f 476 locale_t __loc) __THROW;
45f39d45 477# endif
8593482f 478#endif /* use GNU */
0501d603 479
75cd5204 480
8593482f 481#ifdef __USE_XOPEN2K8
75cd5204
RM
482/* Copy SRC to DEST, returning the address of the terminating L'\0' in
483 DEST. */
4f197237 484extern wchar_t *wcpcpy (wchar_t *__restrict __dest,
a784e502 485 const wchar_t *__restrict __src) __THROW;
75cd5204
RM
486
487/* Copy no more than N characters of SRC to DEST, returning the address of
488 the last character written into DEST. */
4f197237 489extern wchar_t *wcpncpy (wchar_t *__restrict __dest,
a784e502 490 const wchar_t *__restrict __src, size_t __n)
c1422e5b 491 __THROW;
48789000 492#endif
75cd5204
RM
493
494
d64b6ad0 495/* Wide character I/O functions. */
1c31aa79 496
48789000 497#if defined __USE_XOPEN2K8 || __GLIBC_USE (LIB_EXT2)
1c31aa79
UD
498/* Like OPEN_MEMSTREAM, but the stream is wide oriented and produces
499 a wide character string. */
500extern __FILE *open_wmemstream (wchar_t **__bufloc, size_t *__sizeloc) __THROW;
501#endif
502
087722b8 503#if defined __USE_ISOC95 || defined __USE_UNIX98
d64b6ad0
UD
504
505/* Select orientation for stream. */
d1646309 506extern int fwide (__FILE *__fp, int __mode) __THROW;
d64b6ad0
UD
507
508
2c008571
UD
509/* Write formatted output to STREAM.
510
511 This function is a possible cancellation point and therefore not
512 marked with __THROW. */
d1646309 513extern int fwprintf (__FILE *__restrict __stream,
a784e502 514 const wchar_t *__restrict __format, ...)
2c008571
UD
515 /* __attribute__ ((__format__ (__wprintf__, 2, 3))) */;
516/* Write formatted output to stdout.
517
518 This function is a possible cancellation point and therefore not
519 marked with __THROW. */
a784e502 520extern int wprintf (const wchar_t *__restrict __format, ...)
2c008571 521 /* __attribute__ ((__format__ (__wprintf__, 1, 2))) */;
d64b6ad0 522/* Write formatted output of at most N characters to S. */
c1422e5b 523extern int swprintf (wchar_t *__restrict __s, size_t __n,
a784e502 524 const wchar_t *__restrict __format, ...)
c1422e5b 525 __THROW /* __attribute__ ((__format__ (__wprintf__, 3, 4))) */;
d64b6ad0 526
2c008571
UD
527/* Write formatted output to S from argument list ARG.
528
529 This function is a possible cancellation point and therefore not
530 marked with __THROW. */
d1646309 531extern int vfwprintf (__FILE *__restrict __s,
a784e502 532 const wchar_t *__restrict __format,
c1422e5b 533 __gnuc_va_list __arg)
2c008571
UD
534 /* __attribute__ ((__format__ (__wprintf__, 2, 0))) */;
535/* Write formatted output to stdout from argument list ARG.
536
537 This function is a possible cancellation point and therefore not
538 marked with __THROW. */
a784e502 539extern int vwprintf (const wchar_t *__restrict __format,
c1422e5b 540 __gnuc_va_list __arg)
2c008571 541 /* __attribute__ ((__format__ (__wprintf__, 1, 0))) */;
d64b6ad0
UD
542/* Write formatted output of at most N character to S from argument
543 list ARG. */
c1422e5b 544extern int vswprintf (wchar_t *__restrict __s, size_t __n,
a784e502 545 const wchar_t *__restrict __format,
c1422e5b
UD
546 __gnuc_va_list __arg)
547 __THROW /* __attribute__ ((__format__ (__wprintf__, 3, 0))) */;
d64b6ad0
UD
548
549
2c008571
UD
550/* Read formatted input from STREAM.
551
552 This function is a possible cancellation point and therefore not
553 marked with __THROW. */
d1646309 554extern int fwscanf (__FILE *__restrict __stream,
a784e502 555 const wchar_t *__restrict __format, ...)
2c008571
UD
556 /* __attribute__ ((__format__ (__wscanf__, 2, 3))) */;
557/* Read formatted input from stdin.
558
559 This function is a possible cancellation point and therefore not
560 marked with __THROW. */
a784e502 561extern int wscanf (const wchar_t *__restrict __format, ...)
2c008571 562 /* __attribute__ ((__format__ (__wscanf__, 1, 2))) */;
d64b6ad0 563/* Read formatted input from S. */
a784e502
UD
564extern int swscanf (const wchar_t *__restrict __s,
565 const wchar_t *__restrict __format, ...)
c1422e5b 566 __THROW /* __attribute__ ((__format__ (__wscanf__, 2, 3))) */;
7a5affeb 567
874aa523
UD
568# if defined __USE_ISOC99 && !defined __USE_GNU \
569 && (!defined __LDBL_COMPAT || !defined __REDIRECT) \
570 && (defined __STRICT_ANSI__ || defined __USE_XOPEN2K)
571# ifdef __REDIRECT
572/* For strict ISO C99 or POSIX compliance disallow %as, %aS and %a[
573 GNU extension which conflicts with valid %a followed by letter
574 s, S or [. */
575extern int __REDIRECT (fwscanf, (__FILE *__restrict __stream,
a784e502 576 const wchar_t *__restrict __format, ...),
874aa523
UD
577 __isoc99_fwscanf)
578 /* __attribute__ ((__format__ (__wscanf__, 2, 3))) */;
a784e502 579extern int __REDIRECT (wscanf, (const wchar_t *__restrict __format, ...),
874aa523
UD
580 __isoc99_wscanf)
581 /* __attribute__ ((__format__ (__wscanf__, 1, 2))) */;
a784e502
UD
582extern int __REDIRECT_NTH (swscanf, (const wchar_t *__restrict __s,
583 const wchar_t *__restrict __format,
f32f2869
JJ
584 ...), __isoc99_swscanf)
585 /* __attribute__ ((__format__ (__wscanf__, 2, 3))) */;
874aa523
UD
586# else
587extern int __isoc99_fwscanf (__FILE *__restrict __stream,
a784e502
UD
588 const wchar_t *__restrict __format, ...);
589extern int __isoc99_wscanf (const wchar_t *__restrict __format, ...);
590extern int __isoc99_swscanf (const wchar_t *__restrict __s,
591 const wchar_t *__restrict __format, ...)
874aa523
UD
592 __THROW;
593# define fwscanf __isoc99_fwscanf
594# define wscanf __isoc99_wscanf
595# define swscanf __isoc99_swscanf
596# endif
597# endif
598
087722b8 599#endif /* Use ISO C95, C99 and Unix98. */
d64b6ad0 600
91bc38d0 601#ifdef __USE_ISOC99
2c008571
UD
602/* Read formatted input from S into argument list ARG.
603
604 This function is a possible cancellation point and therefore not
605 marked with __THROW. */
d1646309 606extern int vfwscanf (__FILE *__restrict __s,
a784e502 607 const wchar_t *__restrict __format,
c1422e5b 608 __gnuc_va_list __arg)
2c008571
UD
609 /* __attribute__ ((__format__ (__wscanf__, 2, 0))) */;
610/* Read formatted input from stdin into argument list ARG.
611
612 This function is a possible cancellation point and therefore not
613 marked with __THROW. */
a784e502 614extern int vwscanf (const wchar_t *__restrict __format,
c1422e5b 615 __gnuc_va_list __arg)
2c008571 616 /* __attribute__ ((__format__ (__wscanf__, 1, 0))) */;
d64b6ad0 617/* Read formatted input from S into argument list ARG. */
a784e502
UD
618extern int vswscanf (const wchar_t *__restrict __s,
619 const wchar_t *__restrict __format,
c1422e5b
UD
620 __gnuc_va_list __arg)
621 __THROW /* __attribute__ ((__format__ (__wscanf__, 2, 0))) */;
7a5affeb 622
874aa523
UD
623# if !defined __USE_GNU \
624 && (!defined __LDBL_COMPAT || !defined __REDIRECT) \
625 && (defined __STRICT_ANSI__ || defined __USE_XOPEN2K)
626# ifdef __REDIRECT
627extern int __REDIRECT (vfwscanf, (__FILE *__restrict __s,
a784e502 628 const wchar_t *__restrict __format,
874aa523
UD
629 __gnuc_va_list __arg), __isoc99_vfwscanf)
630 /* __attribute__ ((__format__ (__wscanf__, 2, 0))) */;
a784e502 631extern int __REDIRECT (vwscanf, (const wchar_t *__restrict __format,
874aa523
UD
632 __gnuc_va_list __arg), __isoc99_vwscanf)
633 /* __attribute__ ((__format__ (__wscanf__, 1, 0))) */;
a784e502
UD
634extern int __REDIRECT_NTH (vswscanf, (const wchar_t *__restrict __s,
635 const wchar_t *__restrict __format,
f32f2869
JJ
636 __gnuc_va_list __arg), __isoc99_vswscanf)
637 /* __attribute__ ((__format__ (__wscanf__, 2, 0))) */;
874aa523
UD
638# else
639extern int __isoc99_vfwscanf (__FILE *__restrict __s,
a784e502 640 const wchar_t *__restrict __format,
874aa523 641 __gnuc_va_list __arg);
a784e502 642extern int __isoc99_vwscanf (const wchar_t *__restrict __format,
874aa523 643 __gnuc_va_list __arg);
a784e502
UD
644extern int __isoc99_vswscanf (const wchar_t *__restrict __s,
645 const wchar_t *__restrict __format,
874aa523
UD
646 __gnuc_va_list __arg) __THROW;
647# define vfwscanf __isoc99_vfwscanf
648# define vwscanf __isoc99_vwscanf
649# define vswscanf __isoc99_vswscanf
650# endif
651# endif
652
91bc38d0 653#endif /* Use ISO C99. */
d64b6ad0
UD
654
655
2c008571
UD
656/* Read a character from STREAM.
657
658 These functions are possible cancellation points and therefore not
659 marked with __THROW. */
660extern wint_t fgetwc (__FILE *__stream);
661extern wint_t getwc (__FILE *__stream);
d64b6ad0 662
2c008571 663/* Read a character from stdin.
d64b6ad0 664
2c008571
UD
665 This function is a possible cancellation point and therefore not
666 marked with __THROW. */
667extern wint_t getwchar (void);
d64b6ad0 668
d64b6ad0 669
2c008571
UD
670/* Write a character to STREAM.
671
672 These functions are possible cancellation points and therefore not
673 marked with __THROW. */
674extern wint_t fputwc (wchar_t __wc, __FILE *__stream);
675extern wint_t putwc (wchar_t __wc, __FILE *__stream);
676
677/* Write a character to stdout.
678
4c1423ed 679 This function is a possible cancellation point and therefore not
2c008571
UD
680 marked with __THROW. */
681extern wint_t putwchar (wchar_t __wc);
d64b6ad0 682
91bc38d0
UD
683
684/* Get a newline-terminated wide character string of finite length
2c008571
UD
685 from STREAM.
686
4c1423ed 687 This function is a possible cancellation point and therefore not
2c008571 688 marked with __THROW. */
91bc38d0 689extern wchar_t *fgetws (wchar_t *__restrict __ws, int __n,
2c008571
UD
690 __FILE *__restrict __stream);
691
692/* Write a string to STREAM.
91bc38d0 693
4c1423ed 694 This function is a possible cancellation point and therefore not
2c008571 695 marked with __THROW. */
a784e502 696extern int fputws (const wchar_t *__restrict __ws,
2c008571
UD
697 __FILE *__restrict __stream);
698
91bc38d0 699
2c008571 700/* Push a character back onto the input buffer of STREAM.
91bc38d0 701
4c1423ed 702 This function is a possible cancellation point and therefore not
2c008571
UD
703 marked with __THROW. */
704extern wint_t ungetwc (wint_t __wc, __FILE *__stream);
91bc38d0
UD
705
706
d64b6ad0 707#ifdef __USE_GNU
91bc38d0 708/* These are defined to be equivalent to the `char' functions defined
2c008571 709 in POSIX.1:1996.
91bc38d0 710
2c008571
UD
711 These functions are not part of POSIX and therefore no official
712 cancellation point. But due to similarity with an POSIX interface
713 or due to the implementation they are cancellation points and
714 therefore not marked with __THROW. */
715extern wint_t getwc_unlocked (__FILE *__stream);
716extern wint_t getwchar_unlocked (void);
91bc38d0 717
2c008571
UD
718/* This is the wide character version of a GNU extension.
719
720 This function is not part of POSIX and therefore no official
721 cancellation point. But due to similarity with an POSIX interface
722 or due to the implementation it is a cancellation point and
723 therefore not marked with __THROW. */
724extern wint_t fgetwc_unlocked (__FILE *__stream);
725
726/* Faster version when locking is not necessary.
727
728 This function is not part of POSIX and therefore no official
729 cancellation point. But due to similarity with an POSIX interface
730 or due to the implementation it is a cancellation point and
731 therefore not marked with __THROW. */
732extern wint_t fputwc_unlocked (wchar_t __wc, __FILE *__stream);
d64b6ad0
UD
733
734/* These are defined to be equivalent to the `char' functions defined
2c008571 735 in POSIX.1:1996.
d64b6ad0 736
2c008571
UD
737 These functions are not part of POSIX and therefore no official
738 cancellation point. But due to similarity with an POSIX interface
739 or due to the implementation they are cancellation points and
740 therefore not marked with __THROW. */
741extern wint_t putwc_unlocked (wchar_t __wc, __FILE *__stream);
742extern wint_t putwchar_unlocked (wchar_t __wc);
d64b6ad0 743
2c008571
UD
744
745/* This function does the same as `fgetws' but does not lock the stream.
746
747 This function is not part of POSIX and therefore no official
748 cancellation point. But due to similarity with an POSIX interface
749 or due to the implementation it is a cancellation point and
750 therefore not marked with __THROW. */
c1422e5b 751extern wchar_t *fgetws_unlocked (wchar_t *__restrict __ws, int __n,
2c008571
UD
752 __FILE *__restrict __stream);
753
754/* This function does the same as `fputws' but does not lock the stream.
d64b6ad0 755
2c008571
UD
756 This function is not part of POSIX and therefore no official
757 cancellation point. But due to similarity with an POSIX interface
758 or due to the implementation it is a cancellation point and
759 therefore not marked with __THROW. */
a784e502 760extern int fputws_unlocked (const wchar_t *__restrict __ws,
2c008571 761 __FILE *__restrict __stream);
d64b6ad0
UD
762#endif
763
764
d64b6ad0
UD
765/* Format TP into S according to FORMAT.
766 Write no more than MAXSIZE wide characters and return the number
767 of wide characters written, or 0 if it would exceed MAXSIZE. */
c1422e5b 768extern size_t wcsftime (wchar_t *__restrict __s, size_t __maxsize,
a784e502
UD
769 const wchar_t *__restrict __format,
770 const struct tm *__restrict __tp) __THROW;
d64b6ad0 771
c4d6f155 772# ifdef __USE_GNU
c4d6f155
RM
773/* Similar to `wcsftime' but takes the information from
774 the provided locale and not the global locale. */
c4d6f155 775extern size_t wcsftime_l (wchar_t *__restrict __s, size_t __maxsize,
a784e502
UD
776 const wchar_t *__restrict __format,
777 const struct tm *__restrict __tp,
af85385f 778 locale_t __loc) __THROW;
c4d6f155
RM
779# endif
780
8215c9ec 781/* Define some macros helping to catch buffer overflows. */
5ac3ea17 782#if __USE_FORTIFY_LEVEL > 0 && defined __fortify_function
8215c9ec
UD
783# include <bits/wchar2.h>
784#endif
785
54e98f69
RM
786#ifdef __LDBL_COMPAT
787# include <bits/wchar-ldbl.h>
788#endif
789
30de3b18
RM
790__END_DECLS
791
0f2ae55c 792#endif /* wchar.h */