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 __POSIX_VISIBLE >= 200809
  52 #ifndef _OFF_T_DECLARED
  53 #define _OFF_T_DECLARED
  54 typedef __off_t         off_t;
  55 #endif
  56 #ifndef _SSIZE_T_DECLARED
  57 #define _SSIZE_T_DECLARED
  58 typedef __ssize_t       ssize_t;
  59 #endif
  60 #endif
  61
  62 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
  63 #ifdef __GNUC__
  64 #ifndef _VA_LIST_DECLARED
  65 #define _VA_LIST_DECLARED
  66 typedef __va_list       va_list;
  67 /* __gnuc_va_list is not needed, provided by <machine/stdarg.h> */
  68 #endif
  69 #else
  70 #include <stdarg.h>
  71 #endif
  72 #endif
  73
  74 #define _FSTDIO                 /* Define for new stdio with functions. */
  75
  76 /*
  77  * stdio state variables.
  78  *
  79  * The following always hold:
  80  *
  81  *      if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  82  *              _lbfsize is -_bf._size, else _lbfsize is 0
  83  *      if _flags&__SRD, _w is 0
  84  *      if _flags&__SWR, _r is 0
  85  *
  86  * This ensures that the getc and putc macros (or inline functions) never
  87  * try to write or read from a file that is in `read' or `write' mode.
  88  * (Moreover, they can, and do, automatically switch from read mode to
  89  * write mode, and back, on "r+" and "w+" files.)
  90  *
  91  * _lbfsize is used only to make the inline line-buffered output stream
  92  * code as compact as possible.
  93  *
  94  * WARNING: Do not change the order of the fields in __FILE_public!
  95  */
  96 #ifndef _STDFILE_DECLARED
  97 #define _STDFILE_DECLARED
  98 typedef struct __FILE FILE;
  99 #endif
 100
 101 struct __FILE_public {
 102         unsigned char   *_p;            /* current position in (some) buffer */
 103         int             _flags;         /* flags, below; this FILE is free if 0 */
 104         int             _fileno;        /* fileno, if Unix descriptor, else -1 */
 105         __ssize_t       _r;             /* read space left for getc() */
 106         __ssize_t       _w;             /* write space left for putc() */
 107         __ssize_t       _lbfsize;       /* 0 or -_bf._size, for inline putc */
 108 };
 109
 110 #ifndef _STDSTREAM_DECLARED
 111 __BEGIN_DECLS
 112 extern FILE *__stdinp;
 113 extern FILE *__stdoutp;
 114 extern FILE *__stderrp;
 115 __END_DECLS
 116 #define _STDSTREAM_DECLARED
 117 #endif
 118
 119 #define __SLBF  0x0001          /* line buffered */
 120 #define __SNBF  0x0002          /* unbuffered */
 121 #define __SRD   0x0004          /* OK to read */
 122 #define __SWR   0x0008          /* OK to write */
 123         /* RD and WR are never simultaneously asserted */
 124 #define __SRW   0x0010          /* open for reading & writing */
 125 #define __SEOF  0x0020          /* found EOF */
 126 #define __SERR  0x0040          /* found error */
 127 #define __SMBF  0x0080          /* _buf is from malloc */
 128 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 129 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 130 #define __SOPT  0x0400          /* do fseek() optimization */
 131 #define __SNPT  0x0800          /* do not do fseek() optimization */
 132 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 133 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 134 #define __SALC  0x4000          /* allocate string space dynamically */
 135 #define __SIGN  0x8000          /* ignore this file in _fwalk */
 136
 137 /*
 138  * The following three definitions are for ANSI C, which took them
 139  * from System V, which brilliantly took internal interface macros and
 140  * made them official arguments to setvbuf(), without renaming them.
 141  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 142  *
 143  * Although numbered as their counterparts above, the implementation
 144  * does not rely on this.
 145  */
 146 #define _IOFBF  0               /* setvbuf should set fully buffered */
 147 #define _IOLBF  1               /* setvbuf should set line buffered */
 148 #define _IONBF  2               /* setvbuf should set unbuffered */
 149
 150 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 151 #define EOF     (-1)
 152
 153 /*
 154  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 155  * stdio can provide without attempting to allocate further resources
 156  * (which could fail).  Do not use this for anything.
 157  */
 158                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 159 #ifndef FOPEN_MAX
 160 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 161 #endif
 162 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 163
 164 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 165 #if __XSI_VISIBLE
 166 #define P_tmpdir        "/tmp/"
 167 #endif
 168 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 169 #define TMP_MAX         308915776
 170
 171 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */
 172 #ifndef SEEK_SET
 173 #define SEEK_SET        0       /* set file offset to offset */
 174 #endif
 175 #ifndef SEEK_CUR
 176 #define SEEK_CUR        1       /* set file offset to current plus offset */
 177 #endif
 178 #ifndef SEEK_END
 179 #define SEEK_END        2       /* set file offset to EOF plus offset */
 180 #endif
 181
 182 #define stdin   __stdinp
 183 #define stdout  __stdoutp
 184 #define stderr  __stderrp
 185
 186 __BEGIN_DECLS
 187 /*
 188  * Functions defined in ANSI C standard.
 189  */
 190 void     clearerr(FILE *);
 191 int      fclose(FILE *);
 192 int      feof(FILE *);
 193 int      ferror(FILE *);
 194 int      fflush(FILE *);
 195 int      fgetc(FILE *);
 196 int      fgetpos(FILE * __restrict, fpos_t * __restrict);
 197 char    *fgets(char * __restrict, int, FILE * __restrict);
 198 FILE    *fopen(const char * __restrict, const char * __restrict);
 199 int      fprintf(FILE * __restrict, const char * __restrict, ...)
 200              __printflike(2, 3);
 201 int      fputc(int, FILE *);
 202 int      fputs(const char * __restrict, FILE * __restrict);
 203 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
 204 FILE    *freopen(const char * __restrict, const char * __restrict,
 205                  FILE * __restrict);
 206 int      fscanf(FILE * __restrict, const char * __restrict, ...)
 207              __scanflike(2, 3);
 208 int      fseek(FILE *, long, int);
 209 int      fsetpos(FILE *, const fpos_t *);
 210 long     ftell(FILE *);
 211 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
 212 int      getc(FILE *);
 213 int      getchar(void);
 214 char    *gets(char *);
 215 void     perror(const char *);
 216 int      printf(const char * __restrict, ...) __printflike(1, 2);
 217 int      putc(int, FILE *);
 218 int      putchar(int);
 219 int      puts(const char *);
 220 int      remove(const char *);
 221 int      rename(const char *, const char *);
 222 void     rewind(FILE *);
 223 int      scanf(const char * __restrict, ...) __scanflike(1, 2);
 224 void     setbuf(FILE * __restrict, char * __restrict);
 225 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
 226 int      sprintf(char * __restrict, const char * __restrict, ...)
 227              __printflike(2, 3);
 228 int      sscanf(const char * __restrict, const char * __restrict, ...)
 229              __scanflike(2, 3);
 230 FILE    *tmpfile(void);
 231 char    *tmpnam(char *);
 232 int      ungetc(int, FILE *);
 233 int      vfprintf(FILE * __restrict, const char * __restrict, __va_list)
 234              __printflike(2, 0);
 235 int      vprintf(const char * __restrict, __va_list) __printflike(1, 0);
 236 int      vsprintf(char * __restrict, const char * __restrict, __va_list)
 237              __printflike(2, 0);
 238
 239 #if __ISO_C_VISIBLE >= 1999 || __XSI_VISIBLE >= 500
 240 int      snprintf(char * __restrict, size_t, const char * __restrict, ...)
 241             __printflike(3, 4);
 242 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 243                    __va_list) __printflike(3, 0);
 244 #endif
 245 #if __ISO_C_VISIBLE >= 1999
 246 int      vfscanf(FILE * __restrict, const char * __restrict, __va_list)
 247             __scanflike(2, 0);
 248 int      vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
 249 int      vsscanf(const char * __restrict, const char * __restrict, __va_list)
 250             __scanflike(2, 0);
 251 #endif
 252
 253 /*
 254  * Functions defined in all versions of POSIX 1003.1.
 255  */
 256 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
 257 #define L_cuserid       17      /* size for cuserid(3); MAXLOGNAME, legacy */
 258 #endif
 259
 260 #if __POSIX_VISIBLE
 261 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 262
 263 char    *ctermid(char *);
 264 FILE    *fdopen(int, const char *);
 265 int      fileno(FILE *);
 266 #endif /* __POSIX_VISIBLE */
 267
 268 #if __POSIX_VISIBLE >= 199209
 269 int      pclose(FILE *);
 270 FILE    *popen(const char *, const char *);
 271 #endif
 272
 273 #if __POSIX_VISIBLE >= 199506
 274 int      ftrylockfile(FILE *);
 275 void     flockfile(FILE *);
 276 void     funlockfile(FILE *);
 277
 278 /*
 279  * These are normally used through macros as defined below, but POSIX
 280  * requires functions as well.
 281  */
 282 int      getc_unlocked(FILE *);
 283 int      getchar_unlocked(void);
 284 int      putc_unlocked(int, FILE *);
 285 int      putchar_unlocked(int);
 286 #endif
 287 #if __BSD_VISIBLE
 288 void     clearerr_unlocked(FILE *);
 289 int      feof_unlocked(FILE *);
 290 int      ferror_unlocked(FILE *);
 291 int      fileno_unlocked(FILE *);
 292 #endif
 293
 294 #if __XSI_VISIBLE >= 500 || __POSIX_VISIBLE >= 200112
 295 int      fseeko(FILE *, __off_t, int);
 296 __off_t  ftello(FILE *);
 297 #endif
 298
 299 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
 300 int      getw(FILE *);
 301 int      putw(int, FILE *);
 302 #endif /* BSD or X/Open before issue 6 */
 303
 304 #if __XSI_VISIBLE
 305 char    *tempnam(const char *, const char *);
 306 #endif
 307
 308 #if __POSIX_VISIBLE >= 200809
 309 FILE    *fmemopen(void *__restrict, size_t, const char *__restrict);
 310 ssize_t  getdelim(char ** __restrict, size_t * __restrict, int,
 311                   FILE * __restrict);
 312 FILE    *open_memstream(char **, size_t *);
 313 int      renameat(int, const char *, int, const char *);
 314 int      vdprintf(int, const char * __restrict, __va_list) __printflike(2, 0);
 315 int      dprintf(int, const char * __restrict, ...) __printflike(2, 3);
 316 ssize_t  getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
 317 #endif /* __POSIX_VISIBLE >= 200809 */
 318
 319 /*
 320  * Routines that are purely local.
 321  */
 322 #if __BSD_VISIBLE
 323 int      asprintf(char **, const char *, ...) __printflike(2, 3);
 324 char    *ctermid_r(char *);
 325 void     fcloseall(void);
 326 void    *fcookie(FILE *);
 327 char    *fgetln(FILE *, size_t *);
 328 const char *fmtcheck(const char *, const char *) __format_arg(2);
 329 __ssize_t __fpending(const FILE *);
 330 int      fpurge(FILE *);
 331 void     setbuffer(FILE *, char *, int);
 332 int      setlinebuf(FILE *);
 333 int      vasprintf(char **, const char *, __va_list) __printflike(2, 0);
 334
 335 /*
 336  * The system error table contains messages for the first sys_nerr
 337  * positive errno values.  Use strerror() or strerror_r() from <string.h>
 338  * instead.
 339  */
 340 extern const int sys_nerr;
 341 extern const char *const sys_errlist[];
 342
 343 /*
 344  * Stdio function-access interface.
 345  */
 346 FILE    *funopen(const void *, int (*)(void *, char *, int),
 347                  int (*)(void *, const char *, int),
 348                  fpos_t (*)(void *, fpos_t, int), int (*)(void *));
 349 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 350 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 351 #endif /* __BSD_VISIBLE */
 352
 353 /*
 354  * Functions internal to the implementation.
 355  */
 356 int     __srget(FILE *);
 357 int     __swbuf(int, FILE *);
 358
 359 /*
 360  * The __sfoo functions are here so that we can
 361  * define real function versions in the C library.
 362  */
 363 static __inline __always_inline int
 364 __sgetc(FILE *_fp)
 365 {
 366         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 367
 368         if (--_p->_r < 0)
 369                 return (__srget(_fp));
 370         else
 371                 return (*_p->_p++);
 372 }
 373
 374 static __inline __always_inline int
 375 __sputc(int _c, FILE *_fp)
 376 {
 377         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 378
 379         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && _c != '\n'))
 380                 return (*_p->_p++ = _c);
 381         else
 382                 return (__swbuf(_c, _fp));
 383 }
 384
 385 static __inline __always_inline int
 386 __sfeof(FILE *_fp)
 387 {
 388         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 389
 390         return ((_p->_flags & __SEOF) != 0);
 391 }
 392
 393 static __inline __always_inline int
 394 __sferror(FILE *_fp)
 395 {
 396         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 397
 398         return ((_p->_flags & __SERR) != 0);
 399 }
 400
 401 static __inline __always_inline void
 402 __sclearerr(FILE *_fp)
 403 {
 404         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 405
 406         _p->_flags &= ~(__SERR|__SEOF);
 407 }
 408
 409 static __inline __always_inline int
 410 __sfileno(FILE *_fp)
 411 {
 412         struct __FILE_public *_p = (struct __FILE_public *)_fp;
 413
 414         return (_p->_fileno);
 415 }
 416
 417 extern int __isthreaded;
 418
 419 #ifndef __cplusplus
 420 #define feof(p)         (!__isthreaded ? __sfeof(p) : (feof)(p))
 421 #define ferror(p)       (!__isthreaded ? __sferror(p) : (ferror)(p))
 422 #define clearerr(p)     (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
 423
 424 #if __POSIX_VISIBLE
 425 #define fileno(p)       (!__isthreaded ? __sfileno(p) : (fileno)(p))
 426 #endif
 427
 428 #define getc(fp)        (!__isthreaded ? __sgetc(fp) : (getc)(fp))
 429 #define putc(x, fp)     (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
 430
 431 #define getchar()       getc(stdin)
 432 #define putchar(x)      putc(x, stdout)
 433
 434 #if __BSD_VISIBLE
 435 /*
 436  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
 437  * B.8.2.7 for the rationale behind the *_unlocked() macros.
 438  */
 439 #define feof_unlocked(p)        __sfeof(p)
 440 #define ferror_unlocked(p)      __sferror(p)
 441 #define clearerr_unlocked(p)    __sclearerr(p)
 442 #define fileno_unlocked(p)      __sfileno(p)
 443 #endif
 444 #if __POSIX_VISIBLE >= 199506
 445 #define getc_unlocked(fp)       __sgetc(fp)
 446 #define putc_unlocked(x, fp)    __sputc(x, fp)
 447
 448 #define getchar_unlocked()      getc_unlocked(stdin)
 449 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 450 #endif
 451 #endif /* __cplusplus */
 452
 453 __END_DECLS
 454 #endif /* !_STDIO_H_ */