wcsmbs/wchar.h

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