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. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)stdio.h     8.5 (Berkeley) 4/29/95
  37  * $FreeBSD$
  38  */
  39
  40 #ifndef _STDIO_H_
  41 #define _STDIO_H_
  42
  43 #include <sys/cdefs.h>
  44 #include <sys/_null.h>
  45 #include <sys/_types.h>
  46
  47 typedef __off_t         fpos_t;
  48
  49 #ifndef _SIZE_T_DECLARED
  50 typedef __size_t        size_t;
  51 #define _SIZE_T_DECLARED
  52 #endif
  53
  54 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
  55 #ifndef _VA_LIST_DECLARED
  56 typedef __va_list       va_list;
  57 #define _VA_LIST_DECLARED
  58 #endif
  59 #endif
  60
  61 #define _FSTDIO                 /* Define for new stdio with functions. */
  62
  63 /*
  64  * NB: to fit things in six character monocase externals, the stdio
  65  * code uses the prefix `__s' for stdio objects, typically followed
  66  * by a three-character attempt at a mnemonic.
  67  */
  68
  69 /* stdio buffers */
  70 struct __sbuf {
  71         unsigned char *_base;
  72         int     _size;
  73 };
  74
  75 /* hold a buncha junk that would grow the ABI */
  76 struct __sFILEX;
  77
  78 /*
  79  * stdio state variables.
  80  *
  81  * The following always hold:
  82  *
  83  *      if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  84  *              _lbfsize is -_bf._size, else _lbfsize is 0
  85  *      if _flags&__SRD, _w is 0
  86  *      if _flags&__SWR, _r is 0
  87  *
  88  * This ensures that the getc and putc macros (or inline functions) never
  89  * try to write or read from a file that is in `read' or `write' mode.
  90  * (Moreover, they can, and do, automatically switch from read mode to
  91  * write mode, and back, on "r+" and "w+" files.)
  92  *
  93  * _lbfsize is used only to make the inline line-buffered output stream
  94  * code as compact as possible.
  95  *
  96  * _ub, _up, and _ur are used when ungetc() pushes back more characters
  97  * than fit in the current _bf, or when ungetc() pushes back a character
  98  * that does not match the previous one in _bf.  When this happens,
  99  * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
 100  * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
 101  *
 102  * NB: see WARNING above before changing the layout of this structure!
 103  */
 104 typedef struct __sFILE {
 105         unsigned char *_p;      /* current position in (some) buffer */
 106         int     _r;             /* read space left for getc() */
 107         int     _w;             /* write space left for putc() */
 108         short   _flags;         /* flags, below; this FILE is free if 0 */
 109         short   _file;          /* fileno, if Unix descriptor, else -1 */
 110         struct  __sbuf _bf;     /* the buffer (at least 1 byte, if !NULL) */
 111         int     _lbfsize;       /* 0 or -_bf._size, for inline putc */
 112
 113         /* operations */
 114         void    *_cookie;       /* cookie passed to io functions */
 115         int     (*_close)(void *);
 116         int     (*_read)(void *, char *, int);
 117         fpos_t  (*_seek)(void *, fpos_t, int);
 118         int     (*_write)(void *, const char *, int);
 119
 120         /* separate buffer for long sequences of ungetc() */
 121         struct  __sbuf _ub;     /* ungetc buffer */
 122         struct __sFILEX *_extra; /* additions to FILE to not break ABI */
 123         int     _ur;            /* saved _r when _r is counting ungetc data */
 124
 125         /* tricks to meet minimum requirements even when malloc() fails */
 126         unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
 127         unsigned char _nbuf[1]; /* guarantee a getc() buffer */
 128
 129         /* separate buffer for fgetln() when line crosses buffer boundary */
 130         struct  __sbuf _lb;     /* buffer for fgetln() */
 131
 132         /* Unix stdio files get aligned to block boundaries on fseek() */
 133         int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
 134         fpos_t  _offset;        /* current lseek offset (see WARNING) */
 135 } FILE;
 136
 137 __BEGIN_DECLS
 138 extern FILE *__stdinp;
 139 extern FILE *__stdoutp;
 140 extern FILE *__stderrp;
 141 __END_DECLS
 142
 143 #define __SLBF  0x0001          /* line buffered */
 144 #define __SNBF  0x0002          /* unbuffered */
 145 #define __SRD   0x0004          /* OK to read */
 146 #define __SWR   0x0008          /* OK to write */
 147         /* RD and WR are never simultaneously asserted */
 148 #define __SRW   0x0010          /* open for reading & writing */
 149 #define __SEOF  0x0020          /* found EOF */
 150 #define __SERR  0x0040          /* found error */
 151 #define __SMBF  0x0080          /* _buf is from malloc */
 152 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 153 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 154 #define __SOPT  0x0400          /* do fseek() optimization */
 155 #define __SNPT  0x0800          /* do not do fseek() optimization */
 156 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 157 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 158 #define __SALC  0x4000          /* allocate string space dynamically */
 159 #define __SIGN  0x8000          /* ignore this file in _fwalk */
 160
 161 /*
 162  * The following three definitions are for ANSI C, which took them
 163  * from System V, which brilliantly took internal interface macros and
 164  * made them official arguments to setvbuf(), without renaming them.
 165  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 166  *
 167  * Although numbered as their counterparts above, the implementation
 168  * does not rely on this.
 169  */
 170 #define _IOFBF  0               /* setvbuf should set fully buffered */
 171 #define _IOLBF  1               /* setvbuf should set line buffered */
 172 #define _IONBF  2               /* setvbuf should set unbuffered */
 173
 174 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 175 #define EOF     (-1)
 176
 177 /*
 178  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 179  * stdio can provide without attempting to allocate further resources
 180  * (which could fail).  Do not use this for anything.
 181  */
 182                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 183 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 184 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 185
 186 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 187 #if __XSI_VISIBLE
 188 #define P_tmpdir        "/var/tmp/"
 189 #endif
 190 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 191 #define TMP_MAX         308915776
 192
 193 #ifndef SEEK_SET
 194 #define SEEK_SET        0       /* set file offset to offset */
 195 #endif
 196 #ifndef SEEK_CUR
 197 #define SEEK_CUR        1       /* set file offset to current plus offset */
 198 #endif
 199 #ifndef SEEK_END
 200 #define SEEK_END        2       /* set file offset to EOF plus offset */
 201 #endif
 202
 203 #define stdin   __stdinp
 204 #define stdout  __stdoutp
 205 #define stderr  __stderrp
 206
 207 __BEGIN_DECLS
 208 /*
 209  * Functions defined in ANSI C standard.
 210  */
 211 void     clearerr(FILE *);
 212 int      fclose(FILE *);
 213 int      feof(FILE *);
 214 int      ferror(FILE *);
 215 int      fflush(FILE *);
 216 int      fgetc(FILE *);
 217 int      fgetpos(FILE * __restrict, fpos_t * __restrict);
 218 char    *fgets(char * __restrict, int, FILE * __restrict);
 219 FILE    *fopen(const char * __restrict, const char * __restrict);
 220 int      fprintf(FILE * __restrict, const char * __restrict, ...);
 221 int      fputc(int, FILE *);
 222 int      fputs(const char * __restrict, FILE * __restrict);
 223 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
 224 FILE    *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
 225 int      fscanf(FILE * __restrict, const char * __restrict, ...);
 226 int      fseek(FILE *, long, int);
 227 int      fsetpos(FILE *, const fpos_t *);
 228 long     ftell(FILE *);
 229 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
 230 int      getc(FILE *);
 231 int      getchar(void);
 232 char    *gets(char *);
 233 void     perror(const char *);
 234 int      printf(const char * __restrict, ...);
 235 int      putc(int, FILE *);
 236 int      putchar(int);
 237 int      puts(const char *);
 238 int      remove(const char *);
 239 int      rename(const char *, const char *);
 240 void     rewind(FILE *);
 241 int      scanf(const char * __restrict, ...);
 242 void     setbuf(FILE * __restrict, char * __restrict);
 243 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
 244 int      sprintf(char * __restrict, const char * __restrict, ...);
 245 int      sscanf(const char * __restrict, const char * __restrict, ...);
 246 FILE    *tmpfile(void);
 247 char    *tmpnam(char *);
 248 int      ungetc(int, FILE *);
 249 int      vfprintf(FILE * __restrict, const char * __restrict,
 250             __va_list);
 251 int      vprintf(const char * __restrict, __va_list);
 252 int      vsprintf(char * __restrict, const char * __restrict,
 253             __va_list);
 254
 255 #if __ISO_C_VISIBLE >= 1999
 256 int      snprintf(char * __restrict, size_t, const char * __restrict,
 257             ...) __printflike(3, 4);
 258 int      vfscanf(FILE * __restrict, const char * __restrict, __va_list)
 259             __scanflike(2, 0);
 260 int      vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
 261 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 262             __va_list) __printflike(3, 0);
 263 int      vsscanf(const char * __restrict, const char * __restrict, __va_list)
 264             __scanflike(2, 0);
 265 #endif
 266
 267 /*
 268  * Functions defined in all versions of POSIX 1003.1.
 269  */
 270 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
 271 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
 272 #define L_cuserid       17      /* legacy */
 273 #endif
 274
 275 #if __POSIX_VISIBLE
 276 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 277
 278 char    *ctermid(char *);
 279 FILE    *fdopen(int, const char *);
 280 int      fileno(FILE *);
 281 #endif /* __POSIX_VISIBLE */
 282
 283 #if __POSIX_VISIBLE >= 199209
 284 int      pclose(FILE *);
 285 FILE    *popen(const char *, const char *);
 286 #endif
 287
 288 #if __POSIX_VISIBLE >= 199506
 289 int      ftrylockfile(FILE *);
 290 void     flockfile(FILE *);
 291 void     funlockfile(FILE *);
 292
 293 /*
 294  * These are normally used through macros as defined below, but POSIX
 295  * requires functions as well.
 296  */
 297 int      getc_unlocked(FILE *);
 298 int      getchar_unlocked(void);
 299 int      putc_unlocked(int, FILE *);
 300 int      putchar_unlocked(int);
 301 #endif
 302 #if __BSD_VISIBLE
 303 void    clearerr_unlocked(FILE *);
 304 int     feof_unlocked(FILE *);
 305 int     ferror_unlocked(FILE *);
 306 int     fileno_unlocked(FILE *);
 307 #endif
 308
 309 #if __POSIX_VISIBLE >= 200112
 310 int      fseeko(FILE *, __off_t, int);
 311 __off_t  ftello(FILE *);
 312 #endif
 313
 314 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
 315 int      getw(FILE *);
 316 int      putw(int, FILE *);
 317 #endif /* BSD or X/Open before issue 6 */
 318
 319 #if __XSI_VISIBLE
 320 char    *tempnam(const char *, const char *);
 321 #endif
 322
 323 /*
 324  * Routines that are purely local.
 325  */
 326 #if __BSD_VISIBLE
 327 int      asprintf(char **, const char *, ...) __printflike(2, 3);
 328 char    *ctermid_r(char *);
 329 char    *fgetln(FILE *, size_t *);
 330 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3
 331 #define __ATTR_FORMAT_ARG       __attribute__((__format_arg__(2)))
 332 #else
 333 #define __ATTR_FORMAT_ARG
 334 #endif
 335 __const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG;
 336 int      fpurge(FILE *);
 337 void     setbuffer(FILE *, char *, int);
 338 int      setlinebuf(FILE *);
 339 int      vasprintf(char **, const char *, __va_list)
 340             __printflike(2, 0);
 341
 342 /*
 343  * The system error table contains messages for the first sys_nerr
 344  * positive errno values.  Use strerror() or strerror_r() from <string.h>
 345  * instead.
 346  */
 347 extern __const int sys_nerr;
 348 extern __const char *__const sys_errlist[];
 349
 350 /*
 351  * Stdio function-access interface.
 352  */
 353 FILE    *funopen(const void *,
 354             int (*)(void *, char *, int),
 355             int (*)(void *, const char *, int),
 356             fpos_t (*)(void *, fpos_t, int),
 357             int (*)(void *));
 358 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 359 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 360
 361 /*
 362  * Portability hacks.  See <sys/types.h>.
 363  */
 364 #ifndef _FTRUNCATE_DECLARED
 365 #define _FTRUNCATE_DECLARED
 366 int      ftruncate(int, __off_t);
 367 #endif
 368 #ifndef _LSEEK_DECLARED
 369 #define _LSEEK_DECLARED
 370 __off_t  lseek(int, __off_t, int);
 371 #endif
 372 #ifndef _MMAP_DECLARED
 373 #define _MMAP_DECLARED
 374 void    *mmap(void *, size_t, int, int, int, __off_t);
 375 #endif
 376 #ifndef _TRUNCATE_DECLARED
 377 #define _TRUNCATE_DECLARED
 378 int      truncate(const char *, __off_t);
 379 #endif
 380 #endif /* __BSD_VISIBLE */
 381
 382 /*
 383  * Functions internal to the implementation.
 384  */
 385 int     __srget(FILE *);
 386 int     __swbuf(int, FILE *);
 387
 388 /*
 389  * The __sfoo macros are here so that we can
 390  * define function versions in the C library.
 391  */
 392 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
 393 #if defined(__GNUC__) && defined(__STDC__)
 394 static __inline int __sputc(int _c, FILE *_p) {
 395         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
 396                 return (*_p->_p++ = _c);
 397         else
 398                 return (__swbuf(_c, _p));
 399 }
 400 #else
 401 /*
 402  * This has been tuned to generate reasonable code on the vax using pcc.
 403  */
 404 #define __sputc(c, p) \
 405         (--(p)->_w < 0 ? \
 406                 (p)->_w >= (p)->_lbfsize ? \
 407                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
 408                                 (int)*(p)->_p++ : \
 409                                 __swbuf('\n', p) : \
 410                         __swbuf((int)(c), p) : \
 411                 (*(p)->_p = (c), (int)*(p)->_p++))
 412 #endif
 413
 414 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
 415 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
 416 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
 417 #define __sfileno(p)    ((p)->_file)
 418
 419 extern int __isthreaded;
 420
 421 #define feof(p)         (!__isthreaded ? __sfeof(p) : (feof)(p))
 422 #define ferror(p)       (!__isthreaded ? __sferror(p) : (ferror)(p))
 423 #define clearerr(p)     (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
 424
 425 #if __POSIX_VISIBLE
 426 #define fileno(p)       (!__isthreaded ? __sfileno(p) : (fileno)(p))
 427 #endif
 428
 429 #define getc(fp)        (!__isthreaded ? __sgetc(fp) : (getc)(fp))
 430 #define putc(x, fp)     (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
 431
 432 #define getchar()       getc(stdin)
 433 #define putchar(x)      putc(x, stdout)
 434
 435 #if __BSD_VISIBLE
 436 /*
 437  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
 438  * B.8.2.7 for the rationale behind the *_unlocked() macros.
 439  */
 440 #define feof_unlocked(p)        __sfeof(p)
 441 #define ferror_unlocked(p)      __sferror(p)
 442 #define clearerr_unlocked(p)    __sclearerr(p)
 443 #define fileno_unlocked(p)      __sfileno(p)
 444 #endif
 445 #if __POSIX_VISIBLE >= 199506
 446 #define getc_unlocked(fp)       __sgetc(fp)
 447 #define putc_unlocked(x, fp)    __sputc(x, fp)
 448
 449 #define getchar_unlocked()      getc_unlocked(stdin)
 450 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 451 #endif
 452
 453 __END_DECLS
 454 #endif /* !_STDIO_H_ */