include/stdio.h

   1 /* Define ISO C stdio on top of C++ iostreams.
   2    Copyright (C) 1991-2021 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <https://www.gnu.org/licenses/>.  */
  18
  19 /*
  20  *      ISO C99 Standard: 7.19 Input/output     <stdio.h>
  21  */
  22
  23 #ifndef _STDIO_H
  24 #define _STDIO_H        1
  25
  26 #define __GLIBC_INTERNAL_STARTING_HEADER_IMPLEMENTATION
  27 #include <bits/libc-header-start.h>
  28
  29 __BEGIN_DECLS
  30
  31 #define __need_size_t
  32 #define __need_NULL
  33 #include <stddef.h>
  34
  35 #define __need___va_list
  36 #include <stdarg.h>
  37
  38 #include <bits/types.h>
  39 #include <bits/types/__fpos_t.h>
  40 #include <bits/types/__fpos64_t.h>
  41 #include <bits/types/__FILE.h>
  42 #include <bits/types/FILE.h>
  43 #include <bits/types/struct_FILE.h>
  44
  45 #ifdef __USE_GNU
  46 # include <bits/types/cookie_io_functions_t.h>
  47 #endif
  48
  49 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
  50 # ifdef __GNUC__
  51 #  ifndef _VA_LIST_DEFINED
  52 typedef __gnuc_va_list va_list;
  53 #   define _VA_LIST_DEFINED
  54 #  endif
  55 # else
  56 #  include <stdarg.h>
  57 # endif
  58 #endif
  59
  60 #if defined __USE_UNIX98 || defined __USE_XOPEN2K
  61 # ifndef __off_t_defined
  62 # ifndef __USE_FILE_OFFSET64
  63 typedef __off_t off_t;
  64 # else
  65 typedef __off64_t off_t;
  66 # endif
  67 # define __off_t_defined
  68 # endif
  69 # if defined __USE_LARGEFILE64 && !defined __off64_t_defined
  70 typedef __off64_t off64_t;
  71 # define __off64_t_defined
  72 # endif
  73 #endif
  74
  75 #ifdef __USE_XOPEN2K8
  76 # ifndef __ssize_t_defined
  77 typedef __ssize_t ssize_t;
  78 # define __ssize_t_defined
  79 # endif
  80 #endif
  81
  82 /* The type of the second argument to `fgetpos' and `fsetpos'.  */
  83 #ifndef __USE_FILE_OFFSET64
  84 typedef __fpos_t fpos_t;
  85 #else
  86 typedef __fpos64_t fpos_t;
  87 #endif
  88 #ifdef __USE_LARGEFILE64
  89 typedef __fpos64_t fpos64_t;
  90 #endif
  91
  92 /* The possibilities for the third argument to `setvbuf'.  */
  93 #define _IOFBF 0                /* Fully buffered.  */
  94 #define _IOLBF 1                /* Line buffered.  */
  95 #define _IONBF 2                /* No buffering.  */
  96
  97
  98 /* Default buffer size.  */
  99 #define BUFSIZ 8192
 100
 101
 102 /* The value returned by fgetc and similar functions to indicate the
 103    end of the file.  */
 104 #define EOF (-1)
 105
 106
 107 /* The possibilities for the third argument to `fseek'.
 108    These values should not be changed.  */
 109 #define SEEK_SET        0       /* Seek from beginning of file.  */
 110 #define SEEK_CUR        1       /* Seek from current position.  */
 111 #define SEEK_END        2       /* Seek from end of file.  */
 112 #ifdef __USE_GNU
 113 # define SEEK_DATA      3       /* Seek to next data.  */
 114 # define SEEK_HOLE      4       /* Seek to next hole.  */
 115 #endif
 116
 117
 118 #if defined __USE_MISC || defined __USE_XOPEN
 119 /* Default path prefix for `tempnam' and `tmpnam'.  */
 120 # define P_tmpdir       "/tmp"
 121 #endif
 122
 123
 124 /* Get the values:
 125    L_tmpnam     How long an array of chars must be to be passed to `tmpnam'.
 126    TMP_MAX      The minimum number of unique filenames generated by tmpnam
 127                 (and tempnam when it uses tmpnam's name space),
 128                 or tempnam (the two are separate).
 129    L_ctermid    How long an array to pass to `ctermid'.
 130    L_cuserid    How long an array to pass to `cuserid'.
 131    FOPEN_MAX    Minimum number of files that can be open at once.
 132    FILENAME_MAX Maximum length of a filename.  */
 133 #include <bits/stdio_lim.h>
 134
 135
 136 /* Standard streams.  */
 137 extern FILE *stdin;             /* Standard input stream.  */
 138 extern FILE *stdout;            /* Standard output stream.  */
 139 extern FILE *stderr;            /* Standard error output stream.  */
 140 /* C89/C99 say they're macros.  Make them happy.  */
 141 #define stdin stdin
 142 #define stdout stdout
 143 #define stderr stderr
 144
 145 /* Remove file FILENAME.  */
 146 extern int remove (const char *__filename) __THROW;
 147 /* Rename file OLD to NEW.  */
 148 extern int rename (const char *__old, const char *__new) __THROW;
 149
 150 #ifdef __USE_ATFILE
 151 /* Rename file OLD relative to OLDFD to NEW relative to NEWFD.  */
 152 extern int renameat (int __oldfd, const char *__old, int __newfd,
 153                      const char *__new) __THROW;
 154 #endif
 155
 156 #ifdef __USE_GNU
 157 /* Flags for renameat2.  */
 158 # define RENAME_NOREPLACE (1 << 0)
 159 # define RENAME_EXCHANGE (1 << 1)
 160 # define RENAME_WHITEOUT (1 << 2)
 161
 162 /* Rename file OLD relative to OLDFD to NEW relative to NEWFD, with
 163    additional flags.  */
 164 extern int renameat2 (int __oldfd, const char *__old, int __newfd,
 165                       const char *__new, unsigned int __flags) __THROW;
 166 #endif
 167
 168 /* Create a temporary file and open it read/write.
 169
 170    This function is a possible cancellation point and therefore not
 171    marked with __THROW.  */
 172 #ifndef __USE_FILE_OFFSET64
 173 extern FILE *tmpfile (void) __wur;
 174 #else
 175 # ifdef __REDIRECT
 176 extern FILE *__REDIRECT (tmpfile, (void), tmpfile64) __wur;
 177 # else
 178 #  define tmpfile tmpfile64
 179 # endif
 180 #endif
 181
 182 #ifdef __USE_LARGEFILE64
 183 extern FILE *tmpfile64 (void) __wur;
 184 #endif
 185
 186 /* Generate a temporary filename.  */
 187 extern char *tmpnam (char *__s) __THROW __wur;
 188
 189 #ifdef __USE_MISC
 190 /* This is the reentrant variant of `tmpnam'.  The only difference is
 191    that it does not allow S to be NULL.  */
 192 extern char *tmpnam_r (char *__s) __THROW __wur;
 193 #endif
 194
 195
 196 #if defined __USE_MISC || defined __USE_XOPEN
 197 /* Generate a unique temporary filename using up to five characters of PFX
 198    if it is not NULL.  The directory to put this file in is searched for
 199    as follows: First the environment variable "TMPDIR" is checked.
 200    If it contains the name of a writable directory, that directory is used.
 201    If not and if DIR is not NULL, that value is checked.  If that fails,
 202    P_tmpdir is tried and finally "/tmp".  The storage for the filename
 203    is allocated by `malloc'.  */
 204 extern char *tempnam (const char *__dir, const char *__pfx)
 205      __THROW __attribute_malloc__ __wur;
 206 #endif
 207
 208
 209 /* Close STREAM.
 210
 211    This function is a possible cancellation point and therefore not
 212    marked with __THROW.  */
 213 extern int fclose (FILE *__stream);
 214 /* Flush STREAM, or all streams if STREAM is NULL.
 215
 216    This function is a possible cancellation point and therefore not
 217    marked with __THROW.  */
 218 extern int fflush (FILE *__stream);
 219
 220 #ifdef __USE_MISC
 221 /* Faster versions when locking is not required.
 222
 223    This function is not part of POSIX and therefore no official
 224    cancellation point.  But due to similarity with an POSIX interface
 225    or due to the implementation it is a cancellation point and
 226    therefore not marked with __THROW.  */
 227 extern int fflush_unlocked (FILE *__stream);
 228 #endif
 229
 230 #ifdef __USE_GNU
 231 /* Close all streams.
 232
 233    This function is not part of POSIX and therefore no official
 234    cancellation point.  But due to similarity with an POSIX interface
 235    or due to the implementation it is a cancellation point and
 236    therefore not marked with __THROW.  */
 237 extern int fcloseall (void);
 238 #endif
 239
 240
 241 #ifndef __USE_FILE_OFFSET64
 242 /* Open a file and create a new stream for it.
 243
 244    This function is a possible cancellation point and therefore not
 245    marked with __THROW.  */
 246 extern FILE *fopen (const char *__restrict __filename,
 247                     const char *__restrict __modes) __wur;
 248 /* Open a file, replacing an existing stream with it.
 249
 250    This function is a possible cancellation point and therefore not
 251    marked with __THROW.  */
 252 extern FILE *freopen (const char *__restrict __filename,
 253                       const char *__restrict __modes,
 254                       FILE *__restrict __stream) __wur;
 255 #else
 256 # ifdef __REDIRECT
 257 extern FILE *__REDIRECT (fopen, (const char *__restrict __filename,
 258                                  const char *__restrict __modes), fopen64)
 259   __wur;
 260 extern FILE *__REDIRECT (freopen, (const char *__restrict __filename,
 261                                    const char *__restrict __modes,
 262                                    FILE *__restrict __stream), freopen64)
 263   __wur;
 264 # else
 265 #  define fopen fopen64
 266 #  define freopen freopen64
 267 # endif
 268 #endif
 269 #ifdef __USE_LARGEFILE64
 270 extern FILE *fopen64 (const char *__restrict __filename,
 271                       const char *__restrict __modes) __wur;
 272 extern FILE *freopen64 (const char *__restrict __filename,
 273                         const char *__restrict __modes,
 274                         FILE *__restrict __stream) __wur;
 275 #endif
 276
 277 #ifdef  __USE_POSIX
 278 /* Create a new stream that refers to an existing system file descriptor.  */
 279 extern FILE *fdopen (int __fd, const char *__modes) __THROW __wur;
 280 #endif
 281
 282 #ifdef  __USE_GNU
 283 /* Create a new stream that refers to the given magic cookie,
 284    and uses the given functions for input and output.  */
 285 extern FILE *fopencookie (void *__restrict __magic_cookie,
 286                           const char *__restrict __modes,
 287                           cookie_io_functions_t __io_funcs) __THROW __wur;
 288 #endif
 289
 290 #if defined __USE_XOPEN2K8 || __GLIBC_USE (LIB_EXT2)
 291 /* Create a new stream that refers to a memory buffer.  */
 292 extern FILE *fmemopen (void *__s, size_t __len, const char *__modes)
 293   __THROW __wur;
 294
 295 /* Open a stream that writes into a malloc'd buffer that is expanded as
 296    necessary.  *BUFLOC and *SIZELOC are updated with the buffer's location
 297    and the number of characters written on fflush or fclose.  */
 298 extern FILE *open_memstream (char **__bufloc, size_t *__sizeloc) __THROW __wur;
 299 #endif
 300
 301
 302 /* If BUF is NULL, make STREAM unbuffered.
 303    Else make it use buffer BUF, of size BUFSIZ.  */
 304 extern void setbuf (FILE *__restrict __stream, char *__restrict __buf) __THROW;
 305 /* Make STREAM use buffering mode MODE.
 306    If BUF is not NULL, use N bytes of it for buffering;
 307    else allocate an internal buffer N bytes long.  */
 308 extern int setvbuf (FILE *__restrict __stream, char *__restrict __buf,
 309                     int __modes, size_t __n) __THROW;
 310
 311 #ifdef  __USE_MISC
 312 /* If BUF is NULL, make STREAM unbuffered.
 313    Else make it use SIZE bytes of BUF for buffering.  */
 314 extern void setbuffer (FILE *__restrict __stream, char *__restrict __buf,
 315                        size_t __size) __THROW;
 316
 317 /* Make STREAM line-buffered.  */
 318 extern void setlinebuf (FILE *__stream) __THROW;
 319 #endif
 320
 321
 322 /* Write formatted output to STREAM.
 323
 324    This function is a possible cancellation point and therefore not
 325    marked with __THROW.  */
 326 extern int fprintf (FILE *__restrict __stream,
 327                     const char *__restrict __format, ...);
 328 /* Write formatted output to stdout.
 329
 330    This function is a possible cancellation point and therefore not
 331    marked with __THROW.  */
 332 extern int printf (const char *__restrict __format, ...);
 333 /* Write formatted output to S.  */
 334 extern int sprintf (char *__restrict __s,
 335                     const char *__restrict __format, ...) __THROWNL;
 336
 337 /* Write formatted output to S from argument list ARG.
 338
 339    This function is a possible cancellation point and therefore not
 340    marked with __THROW.  */
 341 extern int vfprintf (FILE *__restrict __s, const char *__restrict __format,
 342                      __gnuc_va_list __arg);
 343 /* Write formatted output to stdout from argument list ARG.
 344
 345    This function is a possible cancellation point and therefore not
 346    marked with __THROW.  */
 347 extern int vprintf (const char *__restrict __format, __gnuc_va_list __arg);
 348 /* Write formatted output to S from argument list ARG.  */
 349 extern int vsprintf (char *__restrict __s, const char *__restrict __format,
 350                      __gnuc_va_list __arg) __THROWNL;
 351
 352 #if defined __USE_ISOC99 || defined __USE_UNIX98
 353 /* Maximum chars of output to write in MAXLEN.  */
 354 extern int snprintf (char *__restrict __s, size_t __maxlen,
 355                      const char *__restrict __format, ...)
 356      __THROWNL __attribute__ ((__format__ (__printf__, 3, 4)));
 357
 358 extern int vsnprintf (char *__restrict __s, size_t __maxlen,
 359                       const char *__restrict __format, __gnuc_va_list __arg)
 360      __THROWNL __attribute__ ((__format__ (__printf__, 3, 0)));
 361 #endif
 362
 363 #if __GLIBC_USE (LIB_EXT2)
 364 /* Write formatted output to a string dynamically allocated with `malloc'.
 365    Store the address of the string in *PTR.  */
 366 extern int vasprintf (char **__restrict __ptr, const char *__restrict __f,
 367                       __gnuc_va_list __arg)
 368      __THROWNL __attribute__ ((__format__ (__printf__, 2, 0))) __wur;
 369 extern int __asprintf (char **__restrict __ptr,
 370                        const char *__restrict __fmt, ...)
 371      __THROWNL __attribute__ ((__format__ (__printf__, 2, 3))) __wur;
 372 extern int asprintf (char **__restrict __ptr,
 373                      const char *__restrict __fmt, ...)
 374      __THROWNL __attribute__ ((__format__ (__printf__, 2, 3))) __wur;
 375 #endif
 376
 377 #ifdef __USE_XOPEN2K8
 378 /* Write formatted output to a file descriptor.  */
 379 extern int vdprintf (int __fd, const char *__restrict __fmt,
 380                      __gnuc_va_list __arg)
 381      __attribute__ ((__format__ (__printf__, 2, 0)));
 382 extern int dprintf (int __fd, const char *__restrict __fmt, ...)
 383      __attribute__ ((__format__ (__printf__, 2, 3)));
 384 #endif
 385
 386
 387 /* Read formatted input from STREAM.
 388
 389    This function is a possible cancellation point and therefore not
 390    marked with __THROW.  */
 391 extern int fscanf (FILE *__restrict __stream,
 392                    const char *__restrict __format, ...) __wur;
 393 /* Read formatted input from stdin.
 394
 395    This function is a possible cancellation point and therefore not
 396    marked with __THROW.  */
 397 extern int scanf (const char *__restrict __format, ...) __wur;
 398 /* Read formatted input from S.  */
 399 extern int sscanf (const char *__restrict __s,
 400                    const char *__restrict __format, ...) __THROW;
 401
 402 /* For historical reasons, the C99-compliant versions of the scanf
 403    functions are at alternative names.  When __LDBL_COMPAT or
 404    __LDOUBLE_REDIRECTS_TO_FLOAT128_ABI are in effect, this is handled in
 405    bits/stdio-ldbl.h.  */
 406 #include <bits/floatn.h>
 407 #if !__GLIBC_USE (DEPRECATED_SCANF) && !defined __LDBL_COMPAT \
 408     && __LDOUBLE_REDIRECTS_TO_FLOAT128_ABI == 0
 409 # ifdef __REDIRECT
 410 extern int __REDIRECT (fscanf, (FILE *__restrict __stream,
 411                                 const char *__restrict __format, ...),
 412                        __isoc99_fscanf) __wur;
 413 extern int __REDIRECT (scanf, (const char *__restrict __format, ...),
 414                        __isoc99_scanf) __wur;
 415 extern int __REDIRECT_NTH (sscanf, (const char *__restrict __s,
 416                                     const char *__restrict __format, ...),
 417                            __isoc99_sscanf);
 418 # else
 419 extern int __isoc99_fscanf (FILE *__restrict __stream,
 420                             const char *__restrict __format, ...) __wur;
 421 extern int __isoc99_scanf (const char *__restrict __format, ...) __wur;
 422 extern int __isoc99_sscanf (const char *__restrict __s,
 423                             const char *__restrict __format, ...) __THROW;
 424 #  define fscanf __isoc99_fscanf
 425 #  define scanf __isoc99_scanf
 426 #  define sscanf __isoc99_sscanf
 427 # endif
 428 #endif
 429
 430 #ifdef  __USE_ISOC99
 431 /* Read formatted input from S into argument list ARG.
 432
 433    This function is a possible cancellation point and therefore not
 434    marked with __THROW.  */
 435 extern int vfscanf (FILE *__restrict __s, const char *__restrict __format,
 436                     __gnuc_va_list __arg)
 437      __attribute__ ((__format__ (__scanf__, 2, 0))) __wur;
 438
 439 /* Read formatted input from stdin into argument list ARG.
 440
 441    This function is a possible cancellation point and therefore not
 442    marked with __THROW.  */
 443 extern int vscanf (const char *__restrict __format, __gnuc_va_list __arg)
 444      __attribute__ ((__format__ (__scanf__, 1, 0))) __wur;
 445
 446 /* Read formatted input from S into argument list ARG.  */
 447 extern int vsscanf (const char *__restrict __s,
 448                     const char *__restrict __format, __gnuc_va_list __arg)
 449      __THROW __attribute__ ((__format__ (__scanf__, 2, 0)));
 450
 451 /* Same redirection as above for the v*scanf family.  */
 452 # if !__GLIBC_USE (DEPRECATED_SCANF)
 453 #  if defined __REDIRECT && !defined __LDBL_COMPAT \
 454       && __LDOUBLE_REDIRECTS_TO_FLOAT128_ABI == 0
 455 extern int __REDIRECT (vfscanf,
 456                        (FILE *__restrict __s,
 457                         const char *__restrict __format, __gnuc_va_list __arg),
 458                        __isoc99_vfscanf)
 459      __attribute__ ((__format__ (__scanf__, 2, 0))) __wur;
 460 extern int __REDIRECT (vscanf, (const char *__restrict __format,
 461                                 __gnuc_va_list __arg), __isoc99_vscanf)
 462      __attribute__ ((__format__ (__scanf__, 1, 0))) __wur;
 463 extern int __REDIRECT_NTH (vsscanf,
 464                            (const char *__restrict __s,
 465                             const char *__restrict __format,
 466                             __gnuc_va_list __arg), __isoc99_vsscanf)
 467      __attribute__ ((__format__ (__scanf__, 2, 0)));
 468 #  elif !defined __REDIRECT
 469 extern int __isoc99_vfscanf (FILE *__restrict __s,
 470                              const char *__restrict __format,
 471                              __gnuc_va_list __arg) __wur;
 472 extern int __isoc99_vscanf (const char *__restrict __format,
 473                             __gnuc_va_list __arg) __wur;
 474 extern int __isoc99_vsscanf (const char *__restrict __s,
 475                              const char *__restrict __format,
 476                              __gnuc_va_list __arg) __THROW;
 477 #   define vfscanf __isoc99_vfscanf
 478 #   define vscanf __isoc99_vscanf
 479 #   define vsscanf __isoc99_vsscanf
 480 #  endif
 481 # endif
 482 #endif /* Use ISO C9x.  */
 483
 484
 485 /* Read a character from STREAM.
 486
 487    These functions are possible cancellation points and therefore not
 488    marked with __THROW.  */
 489 extern int fgetc (FILE *__stream);
 490 extern int getc (FILE *__stream);
 491
 492 /* Read a character from stdin.
 493
 494    This function is a possible cancellation point and therefore not
 495    marked with __THROW.  */
 496 extern int getchar (void);
 497
 498 #ifdef __USE_POSIX199506
 499 /* These are defined in POSIX.1:1996.
 500
 501    These functions are possible cancellation points and therefore not
 502    marked with __THROW.  */
 503 extern int getc_unlocked (FILE *__stream);
 504 extern int getchar_unlocked (void);
 505 #endif /* Use POSIX.  */
 506
 507 #ifdef __USE_MISC
 508 /* Faster version when locking is not necessary.
 509
 510    This function is not part of POSIX and therefore no official
 511    cancellation point.  But due to similarity with an POSIX interface
 512    or due to the implementation it is a cancellation point and
 513    therefore not marked with __THROW.  */
 514 extern int fgetc_unlocked (FILE *__stream);
 515 #endif /* Use MISC.  */
 516
 517
 518 /* Write a character to STREAM.
 519
 520    These functions are possible cancellation points and therefore not
 521    marked with __THROW.
 522
 523    These functions is a possible cancellation point and therefore not
 524    marked with __THROW.  */
 525 extern int fputc (int __c, FILE *__stream);
 526 extern int putc (int __c, FILE *__stream);
 527
 528 /* Write a character to stdout.
 529
 530    This function is a possible cancellation point and therefore not
 531    marked with __THROW.  */
 532 extern int putchar (int __c);
 533
 534 #ifdef __USE_MISC
 535 /* Faster version when locking is not necessary.
 536
 537    This function is not part of POSIX and therefore no official
 538    cancellation point.  But due to similarity with an POSIX interface
 539    or due to the implementation it is a cancellation point and
 540    therefore not marked with __THROW.  */
 541 extern int fputc_unlocked (int __c, FILE *__stream);
 542 #endif /* Use MISC.  */
 543
 544 #ifdef __USE_POSIX199506
 545 /* These are defined in POSIX.1:1996.
 546
 547    These functions are possible cancellation points and therefore not
 548    marked with __THROW.  */
 549 extern int putc_unlocked (int __c, FILE *__stream);
 550 extern int putchar_unlocked (int __c);
 551 #endif /* Use POSIX.  */
 552
 553
 554 #if defined __USE_MISC \
 555     || (defined __USE_XOPEN && !defined __USE_XOPEN2K)
 556 /* Get a word (int) from STREAM.  */
 557 extern int getw (FILE *__stream);
 558
 559 /* Write a word (int) to STREAM.  */
 560 extern int putw (int __w, FILE *__stream);
 561 #endif
 562
 563
 564 /* Get a newline-terminated string of finite length from STREAM.
 565
 566    This function is a possible cancellation point and therefore not
 567    marked with __THROW.  */
 568 extern char *fgets (char *__restrict __s, int __n, FILE *__restrict __stream)
 569      __wur __attr_access ((__write_only__, 1, 2));
 570
 571 #if __GLIBC_USE (DEPRECATED_GETS)
 572 /* Get a newline-terminated string from stdin, removing the newline.
 573
 574    This function is impossible to use safely.  It has been officially
 575    removed from ISO C11 and ISO C++14, and we have also removed it
 576    from the _GNU_SOURCE feature list.  It remains available when
 577    explicitly using an old ISO C, Unix, or POSIX standard.
 578
 579    This function is a possible cancellation point and therefore not
 580    marked with __THROW.  */
 581 extern char *gets (char *__s) __wur __attribute_deprecated__;
 582 #endif
 583
 584 #ifdef __USE_GNU
 585 /* This function does the same as `fgets' but does not lock the stream.
 586
 587    This function is not part of POSIX and therefore no official
 588    cancellation point.  But due to similarity with an POSIX interface
 589    or due to the implementation it is a cancellation point and
 590    therefore not marked with __THROW.  */
 591 extern char *fgets_unlocked (char *__restrict __s, int __n,
 592                              FILE *__restrict __stream) __wur
 593     __attr_access ((__write_only__, 1, 2));
 594 #endif
 595
 596
 597 #if defined __USE_XOPEN2K8 || __GLIBC_USE (LIB_EXT2)
 598 /* Read up to (and including) a DELIMITER from STREAM into *LINEPTR
 599    (and null-terminate it). *LINEPTR is a pointer returned from malloc (or
 600    NULL), pointing to *N characters of space.  It is realloc'd as
 601    necessary.  Returns the number of characters read (not including the
 602    null terminator), or -1 on error or EOF.
 603
 604    These functions are not part of POSIX and therefore no official
 605    cancellation point.  But due to similarity with an POSIX interface
 606    or due to the implementation they are cancellation points and
 607    therefore not marked with __THROW.  */
 608 extern __ssize_t __getdelim (char **__restrict __lineptr,
 609                              size_t *__restrict __n, int __delimiter,
 610                              FILE *__restrict __stream) __wur;
 611 extern __ssize_t getdelim (char **__restrict __lineptr,
 612                            size_t *__restrict __n, int __delimiter,
 613                            FILE *__restrict __stream) __wur;
 614
 615 /* Like `getdelim', but reads up to a newline.
 616
 617    This function is not part of POSIX and therefore no official
 618    cancellation point.  But due to similarity with an POSIX interface
 619    or due to the implementation it is a cancellation point and
 620    therefore not marked with __THROW.  */
 621 extern __ssize_t getline (char **__restrict __lineptr,
 622                           size_t *__restrict __n,
 623                           FILE *__restrict __stream) __wur;
 624 #endif
 625
 626
 627 /* Write a string to STREAM.
 628
 629    This function is a possible cancellation point and therefore not
 630    marked with __THROW.  */
 631 extern int fputs (const char *__restrict __s, FILE *__restrict __stream);
 632
 633 /* Write a string, followed by a newline, to stdout.
 634
 635    This function is a possible cancellation point and therefore not
 636    marked with __THROW.  */
 637 extern int puts (const char *__s);
 638
 639
 640 /* Push a character back onto the input buffer of STREAM.
 641
 642    This function is a possible cancellation point and therefore not
 643    marked with __THROW.  */
 644 extern int ungetc (int __c, FILE *__stream);
 645
 646
 647 /* Read chunks of generic data from STREAM.
 648
 649    This function is a possible cancellation point and therefore not
 650    marked with __THROW.  */
 651 extern size_t fread (void *__restrict __ptr, size_t __size,
 652                      size_t __n, FILE *__restrict __stream) __wur;
 653 /* Write chunks of generic data to STREAM.
 654
 655    This function is a possible cancellation point and therefore not
 656    marked with __THROW.  */
 657 extern size_t fwrite (const void *__restrict __ptr, size_t __size,
 658                       size_t __n, FILE *__restrict __s);
 659
 660 #ifdef __USE_GNU
 661 /* This function does the same as `fputs' but does not lock the stream.
 662
 663    This function is not part of POSIX and therefore no official
 664    cancellation point.  But due to similarity with an POSIX interface
 665    or due to the implementation it is a cancellation point and
 666    therefore not marked with __THROW.  */
 667 extern int fputs_unlocked (const char *__restrict __s,
 668                            FILE *__restrict __stream);
 669 #endif
 670
 671 #ifdef __USE_MISC
 672 /* Faster versions when locking is not necessary.
 673
 674    These functions are not part of POSIX and therefore no official
 675    cancellation point.  But due to similarity with an POSIX interface
 676    or due to the implementation they are cancellation points and
 677    therefore not marked with __THROW.  */
 678 extern size_t fread_unlocked (void *__restrict __ptr, size_t __size,
 679                               size_t __n, FILE *__restrict __stream) __wur;
 680 extern size_t fwrite_unlocked (const void *__restrict __ptr, size_t __size,
 681                                size_t __n, FILE *__restrict __stream);
 682 #endif
 683
 684
 685 /* Seek to a certain position on STREAM.
 686
 687    This function is a possible cancellation point and therefore not
 688    marked with __THROW.  */
 689 extern int fseek (FILE *__stream, long int __off, int __whence);
 690 /* Return the current position of STREAM.
 691
 692    This function is a possible cancellation point and therefore not
 693    marked with __THROW.  */
 694 extern long int ftell (FILE *__stream) __wur;
 695 /* Rewind to the beginning of STREAM.
 696
 697    This function is a possible cancellation point and therefore not
 698    marked with __THROW.  */
 699 extern void rewind (FILE *__stream);
 700
 701 /* The Single Unix Specification, Version 2, specifies an alternative,
 702    more adequate interface for the two functions above which deal with
 703    file offset.  `long int' is not the right type.  These definitions
 704    are originally defined in the Large File Support API.  */
 705
 706 #if defined __USE_LARGEFILE || defined __USE_XOPEN2K
 707 # ifndef __USE_FILE_OFFSET64
 708 /* Seek to a certain position on STREAM.
 709
 710    This function is a possible cancellation point and therefore not
 711    marked with __THROW.  */
 712 extern int fseeko (FILE *__stream, __off_t __off, int __whence);
 713 /* Return the current position of STREAM.
 714
 715    This function is a possible cancellation point and therefore not
 716    marked with __THROW.  */
 717 extern __off_t ftello (FILE *__stream) __wur;
 718 # else
 719 #  ifdef __REDIRECT
 720 extern int __REDIRECT (fseeko,
 721                        (FILE *__stream, __off64_t __off, int __whence),
 722                        fseeko64);
 723 extern __off64_t __REDIRECT (ftello, (FILE *__stream), ftello64);
 724 #  else
 725 #   define fseeko fseeko64
 726 #   define ftello ftello64
 727 #  endif
 728 # endif
 729 #endif
 730
 731 #ifndef __USE_FILE_OFFSET64
 732 /* Get STREAM's position.
 733
 734    This function is a possible cancellation point and therefore not
 735    marked with __THROW.  */
 736 extern int fgetpos (FILE *__restrict __stream, fpos_t *__restrict __pos);
 737 /* Set STREAM's position.
 738
 739    This function is a possible cancellation point and therefore not
 740    marked with __THROW.  */
 741 extern int fsetpos (FILE *__stream, const fpos_t *__pos);
 742 #else
 743 # ifdef __REDIRECT
 744 extern int __REDIRECT (fgetpos, (FILE *__restrict __stream,
 745                                  fpos_t *__restrict __pos), fgetpos64);
 746 extern int __REDIRECT (fsetpos,
 747                        (FILE *__stream, const fpos_t *__pos), fsetpos64);
 748 # else
 749 #  define fgetpos fgetpos64
 750 #  define fsetpos fsetpos64
 751 # endif
 752 #endif
 753
 754 #ifdef __USE_LARGEFILE64
 755 extern int fseeko64 (FILE *__stream, __off64_t __off, int __whence);
 756 extern __off64_t ftello64 (FILE *__stream) __wur;
 757 extern int fgetpos64 (FILE *__restrict __stream, fpos64_t *__restrict __pos);
 758 extern int fsetpos64 (FILE *__stream, const fpos64_t *__pos);
 759 #endif
 760
 761 /* Clear the error and EOF indicators for STREAM.  */
 762 extern void clearerr (FILE *__stream) __THROW;
 763 /* Return the EOF indicator for STREAM.  */
 764 extern int feof (FILE *__stream) __THROW __wur;
 765 /* Return the error indicator for STREAM.  */
 766 extern int ferror (FILE *__stream) __THROW __wur;
 767
 768 #ifdef __USE_MISC
 769 /* Faster versions when locking is not required.  */
 770 extern void clearerr_unlocked (FILE *__stream) __THROW;
 771 extern int feof_unlocked (FILE *__stream) __THROW __wur;
 772 extern int ferror_unlocked (FILE *__stream) __THROW __wur;
 773 #endif
 774
 775
 776 /* Print a message describing the meaning of the value of errno.
 777
 778    This function is a possible cancellation point and therefore not
 779    marked with __THROW.  */
 780 extern void perror (const char *__s);
 781
 782
 783 #ifdef  __USE_POSIX
 784 /* Return the system file descriptor for STREAM.  */
 785 extern int fileno (FILE *__stream) __THROW __wur;
 786 #endif /* Use POSIX.  */
 787
 788 #ifdef __USE_MISC
 789 /* Faster version when locking is not required.  */
 790 extern int fileno_unlocked (FILE *__stream) __THROW __wur;
 791 #endif
 792
 793
 794 #ifdef __USE_POSIX2
 795 /* Create a new stream connected to a pipe running the given command.
 796
 797    This function is a possible cancellation point and therefore not
 798    marked with __THROW.  */
 799 extern FILE *popen (const char *__command, const char *__modes) __wur;
 800
 801 /* Close a stream opened by popen and return the status of its child.
 802
 803    This function is a possible cancellation point and therefore not
 804    marked with __THROW.  */
 805 extern int pclose (FILE *__stream);
 806 #endif
 807
 808
 809 #ifdef  __USE_POSIX
 810 /* Return the name of the controlling terminal.  */
 811 extern char *ctermid (char *__s) __THROW;
 812 #endif /* Use POSIX.  */
 813
 814
 815 #if (defined __USE_XOPEN && !defined __USE_XOPEN2K) || defined __USE_GNU
 816 /* Return the name of the current user.  */
 817 extern char *cuserid (char *__s);
 818 #endif /* Use X/Open, but not issue 6.  */
 819
 820
 821 #ifdef  __USE_GNU
 822 struct obstack;                 /* See <obstack.h>.  */
 823
 824 /* Write formatted output to an obstack.  */
 825 extern int obstack_printf (struct obstack *__restrict __obstack,
 826                            const char *__restrict __format, ...)
 827      __THROWNL __attribute__ ((__format__ (__printf__, 2, 3)));
 828 extern int obstack_vprintf (struct obstack *__restrict __obstack,
 829                             const char *__restrict __format,
 830                             __gnuc_va_list __args)
 831      __THROWNL __attribute__ ((__format__ (__printf__, 2, 0)));
 832 #endif /* Use GNU.  */
 833
 834
 835 #ifdef __USE_POSIX199506
 836 /* These are defined in POSIX.1:1996.  */
 837
 838 /* Acquire ownership of STREAM.  */
 839 extern void flockfile (FILE *__stream) __THROW;
 840
 841 /* Try to acquire ownership of STREAM but do not block if it is not
 842    possible.  */
 843 extern int ftrylockfile (FILE *__stream) __THROW __wur;
 844
 845 /* Relinquish the ownership granted for STREAM.  */
 846 extern void funlockfile (FILE *__stream) __THROW;
 847 #endif /* POSIX */
 848
 849 #if defined __USE_XOPEN && !defined __USE_XOPEN2K && !defined __USE_GNU
 850 /*  X/Open Issues 1-5 required getopt to be declared in this
 851    header.  It was removed in Issue 6.  GNU follows Issue 6.  */
 852 # include <bits/getopt_posix.h>
 853 #endif
 854
 855 /* Slow-path routines used by the optimized inline functions in
 856    bits/stdio.h.  */
 857 extern int __uflow (FILE *);
 858 extern int __overflow (FILE *, int);
 859
 860 /* If we are compiling with optimizing read this file.  It contains
 861    several optimizing inline functions and macros.  */
 862 #ifdef __USE_EXTERN_INLINES
 863 # include <bits/stdio.h>
 864 #endif
 865 #if __USE_FORTIFY_LEVEL > 0 && defined __fortify_function
 866 # include <bits/stdio2.h>
 867 #endif
 868
 869 #include <bits/floatn.h>
 870 #if defined __LDBL_COMPAT || __LDOUBLE_REDIRECTS_TO_FLOAT128_ABI == 1
 871 # include <bits/stdio-ldbl.h>
 872 #endif
 873
 874 __END_DECLS
 875
 876 #endif /* <stdio.h> included.  */