include/stdio.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Chris Torek.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)stdio.h     8.5 (Berkeley) 4/29/95
  33  * $FreeBSD: src/include/stdio.h,v 1.78 2009/03/25 08:07:52 das Exp $
  34  */
  35
  36 #ifndef _STDIO_H_
  37 #define _STDIO_H_
  38
  39 #include <sys/cdefs.h>
  40 #include <sys/_null.h>
  41 #include <sys/types.h>
  42 #include <machine/stdarg.h> /* for __va_list */
  43
  44 typedef __off_t         fpos_t;
  45
  46 #ifndef _SIZE_T_DECLARED
  47 typedef __size_t        size_t;
  48 #define _SIZE_T_DECLARED
  49 #endif
  50
  51 #if __EXT1_VISIBLE
  52 #ifndef _RSIZE_T_DECLARED
  53 #define _RSIZE_T_DECLARED
  54 typedef size_t          rsize_t;
  55 #endif
  56 #endif
  57
  58 #if __POSIX_VISIBLE >= 200809
  59 #ifndef _OFF_T_DECLARED
  60 #define _OFF_T_DECLARED
  61 typedef __off_t         off_t;
  62 #endif
  63 #ifndef _SSIZE_T_DECLARED
  64 #define _SSIZE_T_DECLARED
  65 typedef __ssize_t       ssize_t;
  66 #endif
  67 #endif
  68
  69 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
  70 #ifdef __GNUC__
  71 #ifndef _VA_LIST_DECLARED
  72 #define _VA_LIST_DECLARED
  73 typedef __va_list       va_list;
  74 /* __gnuc_va_list is not needed, provided by <machine/stdarg.h> */
  75 #endif
  76 #else
  77 #include <stdarg.h>
  78 #endif
  79 #endif
  80
  81 #define _FSTDIO                 /* Define for new stdio with functions. */
  82
  83 /*
  84  * stdio state variables.
  85  *
  86  * The following always hold:
  87  *
  88  *      if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  89  *              _lbfsize is -_bf._size, else _lbfsize is 0
  90  *      if _flags&__SRD, _w is 0
  91  *      if _flags&__SWR, _r is 0
  92  *
  93  * This ensures that the getc and putc macros (or inline functions) never
  94  * try to write or read from a file that is in `read' or `write' mode.
  95  * (Moreover, they can, and do, automatically switch from read mode to
  96  * write mode, and back, on "r+" and "w+" files.)
  97  *
  98  * _lbfsize is used only to make the inline line-buffered output stream
  99  * code as compact as possible.
 100  *
 101  * WARNING: Do not change the order of the fields in __FILE_public!
 102  */
 103 #ifndef _STDFILE_DECLARED
 104 #define _STDFILE_DECLARED
 105 typedef struct __FILE FILE;
 106 #endif
 107
 108 struct __FILE_public {
 109         unsigned char   *_p;            /* current position in (some) buffer */
 110         int             _flags;         /* flags, below; this FILE is free if 0 */
 111         int             _fileno;        /* fileno, if Unix descriptor, else -1 */
 112         __ssize_t       _r;             /* read space left for getc() */
 113         __ssize_t       _w;             /* write space left for putc() */
 114         __ssize_t       _lbfsize;       /* 0 or -_bf._size, for inline putc */
 115 };
 116
 117 #ifndef _STDSTREAM_DECLARED
 118 __BEGIN_DECLS
 119 extern FILE *__stdinp;
 120 extern FILE *__stdoutp;
 121 extern FILE *__stderrp;
 122 __END_DECLS
 123 #define _STDSTREAM_DECLARED
 124 #endif
 125
 126 #define __SLBF  0x0001          /* line buffered */
 127 #define __SNBF  0x0002          /* unbuffered */
 128 #define __SRD   0x0004          /* OK to read */
 129 #define __SWR   0x0008          /* OK to write */
 130         /* RD and WR are never simultaneously asserted */
 131 #define __SRW   0x0010          /* open for reading & writing */
 132 #define __SEOF  0x0020          /* found EOF */
 133 #define __SERR  0x0040          /* found error */
 134 #define __SMBF  0x0080          /* _buf is from malloc */
 135 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 136 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 137 #define __SOPT  0x0400          /* do fseek() optimization */
 138 #define __SNPT  0x0800          /* do not do fseek() optimization */
 139 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 140 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 141 #define __SALC  0x4000          /* allocate string space dynamically */
 142 #define __SIGN  0x8000          /* ignore this file in _fwalk */
 143
 144 /*
 145  * The following three definitions are for ANSI C, which took them
 146  * from System V, which brilliantly took internal interface macros and
 147  * made them official arguments to setvbuf(), without renaming them.
 148  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 149  *
 150  * Although numbered as their counterparts above, the implementation
 151  * does not rely on this.
 152  */
 153 #define _IOFBF  0               /* setvbuf should set fully buffered */
 154 #define _IOLBF  1               /* setvbuf should set line buffered */
 155 #define _IONBF  2               /* setvbuf should set unbuffered */
 156
 157 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 158 #define EOF     (-1)
 159
 160 /*
 161  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 162  * stdio can provide without attempting to allocate further resources
 163  * (which could fail).  Do not use this for anything.
 164  */
 165                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 166 #ifndef FOPEN_MAX
 167 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 168 #endif
 169 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 170
 171 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 172 #if __XSI_VISIBLE
 173 #define P_tmpdir        "/tmp/"
 174 #endif
 175 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 176 #define TMP_MAX         308915776
 177
 178 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */
 179 #ifndef SEEK_SET
 180 #define SEEK_SET        0       /* set file offset to offset */
 181 #endif
 182 #ifndef SEEK_CUR
 183 #define SEEK_CUR        1       /* set file offset to current plus offset */
 184 #endif
 185 #ifndef SEEK_END
 186 #define SEEK_END        2       /* set file offset to EOF plus offset */
 187 #endif
 188
 189 #define stdin   __stdinp
 190 #define stdout  __stdoutp
 191 #define stderr  __stderrp
 192
 193 #if __BSD_VISIBLE
 194 /* fparseln(3) */
 195 #define FPARSELN_UNESCESC       0x01
 196 #define FPARSELN_UNESCCONT      0x02
 197 #define FPARSELN_UNESCCOMM      0x04
 198 #define FPARSELN_UNESCREST      0x08
 199 #define FPARSELN_UNESCALL       0x0f
 200 #endif
 201
 202 __BEGIN_DECLS
 203 #ifdef _XLOCALE_H_
 204 #include <xlocale/_stdio.h>
 205 #endif
 206 /*
 207  * Functions defined in ANSI C standard.
 208  */
 209 void     clearerr(FILE *);
 210 int      fclose(FILE *);
 211 int      feof(FILE *);
 212 int      ferror(FILE *);
 213 int      fflush(FILE *);
 214 int      fgetc(FILE *);
 215 int      fgetpos(FILE * __restrict, fpos_t * __restrict);
 216 char    *fgets(char * __restrict, int, FILE * __restrict);
 217 FILE    *fopen(const char * __restrict, const char * __restrict);
 218 int      fprintf(FILE * __restrict, const char * __restrict, ...)
 219              __printflike(2, 3);
 220 int      fputc(int, FILE *);
 221 int      fputs(const char * __restrict, FILE * __restrict);
 222 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
 223 FILE    *freopen(const char * __restrict, const char * __restrict,
 224                  FILE * __restrict);
 225 int      fscanf(FILE * __restrict, const char * __restrict, ...)
 226              __scanflike(2, 3);
 227 int      fseek(FILE *, long, int);
 228 int      fsetpos(FILE *, const fpos_t *);
 229 long     ftell(FILE *);
 230 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
 231 int      getc(FILE *);
 232 int      getchar(void);
 233 char    *gets(char *);
 234 #if __EXT1_VISIBLE
 235 char    *gets_s(char *, rsize_t);
 236 #endif
 237 void     perror(const char *);
 238 int      printf(const char * __restrict, ...) __printflike(1, 2);
 239 int      putc(int, FILE *);
 240 int      putchar(int);
 241 int      puts(const char *);
 242 int      remove(const char *);
 243 int      rename(const char *, const char *);
 244 void     rewind(FILE *);
 245 int      scanf(const char * __restrict, ...) __scanflike(1, 2);
 246 void     setbuf(FILE * __restrict, char * __restrict);
 247 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
 248 int      sprintf(char * __restrict, const char * __restrict, ...)
 249              __printflike(2, 3);
 250 int      sscanf(const char * __restrict, const char * __restrict, ...)
 251              __scanflike(2, 3);
 252 FILE    *tmpfile(void);
 253 char    *tmpnam(char *);
 254 int      ungetc(int, FILE *);
 255 int      vfprintf(FILE * __restrict, const char * __restrict, __va_list)
 256              __printflike(2, 0);
 257 int      vprintf(const char * __restrict, __va_list) __printflike(1, 0);
 258 int      vsprintf(char * __restrict, const char * __restrict, __va_list)
 259              __printflike(2, 0);
 260
 261 #if __ISO_C_VISIBLE >= 1999 || __XSI_VISIBLE >= 500
 262 int      snprintf(char * __restrict, size_t, const char * __restrict, ...)
 263             __printflike(3, 4);
 264 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 265                    __va_list) __printflike(3, 0);
 266 #endif
 267 #if __ISO_C_VISIBLE >= 1999
 268 int      vfscanf(FILE * __restrict, const char * __restrict, __va_list)
 269             __scanflike(2, 0);
 270 int      vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
 271 int      vsscanf(const char * __restrict, const char * __restrict, __va_list)
 272             __scanflike(2, 0);
 273 #endif
 274
 275 /*
 276  * Functions defined in all versions of POSIX 1003.1.
 277  */
 278 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200112)
 279 #define L_cuserid       17      /* size for cuserid(3); MAXLOGNAME, legacy */
 280 #endif
 281
 282 #if __POSIX_VISIBLE
 283 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 284
 285 char    *ctermid(char *);
 286 FILE    *fdopen(int, const char *);
 287 int      fileno(FILE *);
 288 #endif /* __POSIX_VISIBLE */
 289
 290 #if __POSIX_VISIBLE >= 199209
 291 int      pclose(FILE *);
 292 FILE    *popen(const char *, const char *);
 293 #endif
 294
 295 #if __POSIX_VISIBLE >= 199506
 296 int      ftrylockfile(FILE *);
 297 void     flockfile(FILE *);
 298 void     funlockfile(FILE *);
 299
 300 /*
 301  * These are normally used through macros as defined below, but POSIX
 302  * requires functions as well.
 303  */
 304 int      getc_unlocked(FILE *);
 305 int      getchar_unlocked(void);
 306 int      putc_unlocked(int, FILE *);
 307 int      putchar_unlocked(int);
 308 #endif
 309 #if __BSD_VISIBLE
 310 void     clearerr_unlocked(FILE *);
 311 int      feof_unlocked(FILE *);
 312 int      ferror_unlocked(FILE *);
 313 int      fileno_unlocked(FILE *);
 314 #endif
 315
 316 #if __XSI_VISIBLE >= 500 || __POSIX_VISIBLE >= 200112
 317 int      fseeko(FILE *, __off_t, int);
 318 __off_t  ftello(FILE *);
 319 #endif
 320
 321 #if __BSD_VISIBLE || (__XSI_VISIBLE && __XSI_VISIBLE < 600)
 322 int      getw(FILE *);
 323 int      putw(int, FILE *);
 324 #endif /* BSD or X/Open before issue 6 */
 325
 326 #if __XSI_VISIBLE
 327 char    *tempnam(const char *, const char *);
 328 #endif
 329
 330 #if __POSIX_VISIBLE >= 200809
 331 FILE    *fmemopen(void *__restrict, size_t, const char *__restrict);
 332 ssize_t  getdelim(char ** __restrict, size_t * __restrict, int,
 333                   FILE * __restrict);
 334 FILE    *open_memstream(char **, size_t *);
 335 int      renameat(int, const char *, int, const char *);
 336 int      vdprintf(int, const char * __restrict, __va_list) __printflike(2, 0);
 337 int      dprintf(int, const char * __restrict, ...) __printflike(2, 3);
 338 ssize_t  getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
 339 #endif /* __POSIX_VISIBLE >= 200809 */
 340
 341 /*
 342  * Routines that are purely local.
 343  */
 344 #if __BSD_VISIBLE
 345 int      asprintf(char **, const char *, ...) __printflike(2, 3);
 346 char    *ctermid_r(char *);
 347 void     fcloseall(void);
 348 void    *fcookie(FILE *);
 349 char    *fgetln(FILE *, size_t *);
 350 const char *fmtcheck(const char *, const char *) __format_arg(2);
 351 char    *fparseln(FILE *, size_t *, size_t *, const char[3], int);
 352 __ssize_t __fpending(const FILE *);
 353 int      fpurge(FILE *);
 354 void     setbuffer(FILE *, char *, int);
 355 int      setlinebuf(FILE *);
 356 int      vasprintf(char **, const char *, __va_list) __printflike(2, 0);
 357
 358 /*
 359  * The system error table contains messages for the first sys_nerr
 360  * positive errno values.  Use strerror() or strerror_r() from <string.h>
 361  * instead.
 362  */
 363 extern const int sys_nerr;
 364 extern const char *const sys_errlist[];
 365
 366 /*
 367  * Stdio function-access interface.
 368  */
 369 FILE    *funopen(const void *, int (*)(void *, char *, int),
 370                  int (*)(void *, const char *, int),
 371                  fpos_t (*)(void *, fpos_t, int), int (*)(void *));
 372 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 373 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 374 #endif /* __BSD_VISIBLE */
 375
 376 /*
 377  * Functions internal to the implementation.
 378  */
 379 int     __srget(FILE *);
 380 int     __swbuf(int, FILE *);
 381
 382 /*
 383  * The __sfoo functions are here so that we can
 384  * define real function versions in the C library.
 385  */
 386 static __inline __always_inline int
 387 __sgetc(FILE *_fp)
 388 {
 389         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 390
 391         if (--_p->_r < 0)
 392                 return (__srget(_fp));
 393         else
 394                 return (*_p->_p++);
 395 }
 396
 397 static __inline __always_inline int
 398 __sputc(int _c, FILE *_fp)
 399 {
 400         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 401
 402         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && _c != '\n'))
 403                 return (*_p->_p++ = _c);
 404         else
 405                 return (__swbuf(_c, _fp));
 406 }
 407
 408 static __inline __always_inline int
 409 __sfeof(FILE *_fp)
 410 {
 411         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 412
 413         return ((_p->_flags & __SEOF) != 0);
 414 }
 415
 416 static __inline __always_inline int
 417 __sferror(FILE *_fp)
 418 {
 419         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 420
 421         return ((_p->_flags & __SERR) != 0);
 422 }
 423
 424 static __inline __always_inline void
 425 __sclearerr(FILE *_fp)
 426 {
 427         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 428
 429         _p->_flags &= ~(__SERR|__SEOF);
 430 }
 431
 432 static __inline __always_inline int
 433 __sfileno(FILE *_fp)
 434 {
 435         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 436
 437         return (_p->_fileno);
 438 }
 439
 440 #ifndef __LIBC_ISTHREADED_DECLARED
 441 #define __LIBC_ISTHREADED_DECLARED
 442 extern int __isthreaded;
 443 #endif
 444
 445 #ifndef __cplusplus
 446 #define feof(p)         (!__isthreaded ? __sfeof(p) : (feof)(p))
 447 #define ferror(p)       (!__isthreaded ? __sferror(p) : (ferror)(p))
 448 #define clearerr(p)     (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
 449
 450 #if __POSIX_VISIBLE
 451 #define fileno(p)       (!__isthreaded ? __sfileno(p) : (fileno)(p))
 452 #endif
 453
 454 #define getc(fp)        (!__isthreaded ? __sgetc(fp) : (getc)(fp))
 455 #define putc(x, fp)     (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
 456
 457 #define getchar()       getc(stdin)
 458 #define putchar(x)      putc(x, stdout)
 459
 460 #if __BSD_VISIBLE
 461 /*
 462  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
 463  * B.8.2.7 for the rationale behind the *_unlocked() macros.
 464  */
 465 #define feof_unlocked(p)        __sfeof(p)
 466 #define ferror_unlocked(p)      __sferror(p)
 467 #define clearerr_unlocked(p)    __sclearerr(p)
 468 #define fileno_unlocked(p)      __sfileno(p)
 469 #endif
 470 #if __POSIX_VISIBLE >= 199506
 471 #define getc_unlocked(fp)       __sgetc(fp)
 472 #define putc_unlocked(x, fp)    __sputc(x, fp)
 473
 474 #define getchar_unlocked()      getc_unlocked(stdin)
 475 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 476 #endif
 477 #endif /* __cplusplus */
 478
 479 __END_DECLS
 480 #endif /* !_STDIO_H_ */