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 #ifndef _STDSTREAM_DECLARED
 138 __BEGIN_DECLS
 139 extern FILE *__stdinp;
 140 extern FILE *__stdoutp;
 141 extern FILE *__stderrp;
 142 __END_DECLS
 143 #define _STDSTREAM_DECLARED
 144 #endif
 145
 146 #define __SLBF  0x0001          /* line buffered */
 147 #define __SNBF  0x0002          /* unbuffered */
 148 #define __SRD   0x0004          /* OK to read */
 149 #define __SWR   0x0008          /* OK to write */
 150         /* RD and WR are never simultaneously asserted */
 151 #define __SRW   0x0010          /* open for reading & writing */
 152 #define __SEOF  0x0020          /* found EOF */
 153 #define __SERR  0x0040          /* found error */
 154 #define __SMBF  0x0080          /* _buf is from malloc */
 155 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 156 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 157 #define __SOPT  0x0400          /* do fseek() optimization */
 158 #define __SNPT  0x0800          /* do not do fseek() optimization */
 159 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 160 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 161 #define __SALC  0x4000          /* allocate string space dynamically */
 162 #define __SIGN  0x8000          /* ignore this file in _fwalk */
 163
 164 /*
 165  * The following three definitions are for ANSI C, which took them
 166  * from System V, which brilliantly took internal interface macros and
 167  * made them official arguments to setvbuf(), without renaming them.
 168  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 169  *
 170  * Although numbered as their counterparts above, the implementation
 171  * does not rely on this.
 172  */
 173 #define _IOFBF  0               /* setvbuf should set fully buffered */
 174 #define _IOLBF  1               /* setvbuf should set line buffered */
 175 #define _IONBF  2               /* setvbuf should set unbuffered */
 176
 177 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 178 #define EOF     (-1)
 179
 180 /*
 181  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 182  * stdio can provide without attempting to allocate further resources
 183  * (which could fail).  Do not use this for anything.
 184  */
 185                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 186 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 187 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 188
 189 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 190 #if __XSI_VISIBLE
 191 #define P_tmpdir        "/var/tmp/"
 192 #endif
 193 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 194 #define TMP_MAX         308915776
 195
 196 #ifndef SEEK_SET
 197 #define SEEK_SET        0       /* set file offset to offset */
 198 #endif
 199 #ifndef SEEK_CUR
 200 #define SEEK_CUR        1       /* set file offset to current plus offset */
 201 #endif
 202 #ifndef SEEK_END
 203 #define SEEK_END        2       /* set file offset to EOF plus offset */
 204 #endif
 205
 206 #define stdin   __stdinp
 207 #define stdout  __stdoutp
 208 #define stderr  __stderrp
 209
 210 __BEGIN_DECLS
 211 /*
 212  * Functions defined in ANSI C standard.
 213  */
 214 void     clearerr(FILE *);
 215 int      fclose(FILE *);
 216 int      feof(FILE *);
 217 int      ferror(FILE *);
 218 int      fflush(FILE *);
 219 int      fgetc(FILE *);
 220 int      fgetpos(FILE * __restrict, fpos_t * __restrict);
 221 char    *fgets(char * __restrict, int, FILE * __restrict);
 222 FILE    *fopen(const char * __restrict, const char * __restrict);
 223 int      fprintf(FILE * __restrict, const char * __restrict, ...);
 224 int      fputc(int, FILE *);
 225 int      fputs(const char * __restrict, FILE * __restrict);
 226 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
 227 FILE    *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
 228 int      fscanf(FILE * __restrict, const char * __restrict, ...);
 229 int      fseek(FILE *, long, int);
 230 int      fsetpos(FILE *, const fpos_t *);
 231 long     ftell(FILE *);
 232 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
 233 int      getc(FILE *);
 234 int      getchar(void);
 235 char    *gets(char *);
 236 void     perror(const char *);
 237 int      printf(const char * __restrict, ...);
 238 int      putc(int, FILE *);
 239 int      putchar(int);
 240 int      puts(const char *);
 241 int      remove(const char *);
 242 int      rename(const char *, const char *);
 243 void     rewind(FILE *);
 244 int      scanf(const char * __restrict, ...);
 245 void     setbuf(FILE * __restrict, char * __restrict);
 246 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
 247 int      sprintf(char * __restrict, const char * __restrict, ...);
 248 int      sscanf(const char * __restrict, const char * __restrict, ...);
 249 FILE    *tmpfile(void);
 250 char    *tmpnam(char *);
 251 int      ungetc(int, FILE *);
 252 int      vfprintf(FILE * __restrict, const char * __restrict,
 253             __va_list);
 254 int      vprintf(const char * __restrict, __va_list);
 255 int      vsprintf(char * __restrict, const char * __restrict,
 256             __va_list);
 257
 258 #if __ISO_C_VISIBLE >= 1999
 259 int      snprintf(char * __restrict, size_t, const char * __restrict,
 260             ...) __printflike(3, 4);
 261 int      vfscanf(FILE * __restrict, const char * __restrict, __va_list)
 262             __scanflike(2, 0);
 263 int      vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
 264 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 265             __va_list) __printflike(3, 0);
 266 int      vsscanf(const char * __restrict, const char * __restrict, __va_list)
 267             __scanflike(2, 0);
 268 #endif
 269
 270 /*
 271  * Functions defined in all versions of POSIX 1003.1.
 272  */
 273 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
 274 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
 275 #define L_cuserid       17      /* legacy */
 276 #endif
 277
 278 #if __POSIX_VISIBLE
 279 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 280
 281 char    *ctermid(char *);
 282 FILE    *fdopen(int, const char *);
 283 int      fileno(FILE *);
 284 #endif /* __POSIX_VISIBLE */
 285
 286 #if __POSIX_VISIBLE >= 199209
 287 int      pclose(FILE *);
 288 FILE    *popen(const char *, const char *);
 289 #endif
 290
 291 #if __POSIX_VISIBLE >= 199506
 292 int      ftrylockfile(FILE *);
 293 void     flockfile(FILE *);
 294 void     funlockfile(FILE *);
 295
 296 /*
 297  * These are normally used through macros as defined below, but POSIX
 298  * requires functions as well.
 299  */
 300 int      getc_unlocked(FILE *);
 301 int      getchar_unlocked(void);
 302 int      putc_unlocked(int, FILE *);
 303 int      putchar_unlocked(int);
 304 #endif
 305 #if __BSD_VISIBLE
 306 void    clearerr_unlocked(FILE *);
 307 int     feof_unlocked(FILE *);
 308 int     ferror_unlocked(FILE *);
 309 int     fileno_unlocked(FILE *);
 310 #endif
 311
 312 #if __POSIX_VISIBLE >= 200112
 313 int      fseeko(FILE *, __off_t, int);
 314 __off_t  ftello(FILE *);
 315 #endif
 316
 317 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
 318 int      getw(FILE *);
 319 int      putw(int, FILE *);
 320 #endif /* BSD or X/Open before issue 6 */
 321
 322 #if __XSI_VISIBLE
 323 char    *tempnam(const char *, const char *);
 324 #endif
 325
 326 /*
 327  * Routines that are purely local.
 328  */
 329 #if __BSD_VISIBLE
 330 int      asprintf(char **, const char *, ...) __printflike(2, 3);
 331 char    *ctermid_r(char *);
 332 char    *fgetln(FILE *, size_t *);
 333 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3
 334 #define __ATTR_FORMAT_ARG       __attribute__((__format_arg__(2)))
 335 #else
 336 #define __ATTR_FORMAT_ARG
 337 #endif
 338 __const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG;
 339 int      fpurge(FILE *);
 340 void     setbuffer(FILE *, char *, int);
 341 int      setlinebuf(FILE *);
 342 int      vasprintf(char **, const char *, __va_list)
 343             __printflike(2, 0);
 344
 345 /*
 346  * The system error table contains messages for the first sys_nerr
 347  * positive errno values.  Use strerror() or strerror_r() from <string.h>
 348  * instead.
 349  */
 350 extern __const int sys_nerr;
 351 extern __const char *__const sys_errlist[];
 352
 353 /*
 354  * Stdio function-access interface.
 355  */
 356 FILE    *funopen(const void *,
 357             int (*)(void *, char *, int),
 358             int (*)(void *, const char *, int),
 359             fpos_t (*)(void *, fpos_t, int),
 360             int (*)(void *));
 361 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 362 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 363
 364 /*
 365  * Portability hacks.  See <sys/types.h>.
 366  */
 367 #ifndef _FTRUNCATE_DECLARED
 368 #define _FTRUNCATE_DECLARED
 369 int      ftruncate(int, __off_t);
 370 #endif
 371 #ifndef _LSEEK_DECLARED
 372 #define _LSEEK_DECLARED
 373 __off_t  lseek(int, __off_t, int);
 374 #endif
 375 #ifndef _MMAP_DECLARED
 376 #define _MMAP_DECLARED
 377 void    *mmap(void *, size_t, int, int, int, __off_t);
 378 #endif
 379 #ifndef _TRUNCATE_DECLARED
 380 #define _TRUNCATE_DECLARED
 381 int      truncate(const char *, __off_t);
 382 #endif
 383 #endif /* __BSD_VISIBLE */
 384
 385 /*
 386  * Functions internal to the implementation.
 387  */
 388 int     __srget(FILE *);
 389 int     __swbuf(int, FILE *);
 390
 391 /*
 392  * The __sfoo macros are here so that we can
 393  * define function versions in the C library.
 394  */
 395 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
 396 #if defined(__GNUC__) && defined(__STDC__)
 397 static __inline int __sputc(int _c, FILE *_p) {
 398         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
 399                 return (*_p->_p++ = _c);
 400         else
 401                 return (__swbuf(_c, _p));
 402 }
 403 #else
 404 /*
 405  * This has been tuned to generate reasonable code on the vax using pcc.
 406  */
 407 #define __sputc(c, p) \
 408         (--(p)->_w < 0 ? \
 409                 (p)->_w >= (p)->_lbfsize ? \
 410                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
 411                                 (int)*(p)->_p++ : \
 412                                 __swbuf('\n', p) : \
 413                         __swbuf((int)(c), p) : \
 414                 (*(p)->_p = (c), (int)*(p)->_p++))
 415 #endif
 416
 417 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
 418 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
 419 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
 420 #define __sfileno(p)    ((p)->_file)
 421
 422 extern int __isthreaded;
 423
 424 #define feof(p)         (!__isthreaded ? __sfeof(p) : (feof)(p))
 425 #define ferror(p)       (!__isthreaded ? __sferror(p) : (ferror)(p))
 426 #define clearerr(p)     (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
 427
 428 #if __POSIX_VISIBLE
 429 #define fileno(p)       (!__isthreaded ? __sfileno(p) : (fileno)(p))
 430 #endif
 431
 432 #define getc(fp)        (!__isthreaded ? __sgetc(fp) : (getc)(fp))
 433 #define putc(x, fp)     (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
 434
 435 #define getchar()       getc(stdin)
 436 #define putchar(x)      putc(x, stdout)
 437
 438 #if __BSD_VISIBLE
 439 /*
 440  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
 441  * B.8.2.7 for the rationale behind the *_unlocked() macros.
 442  */
 443 #define feof_unlocked(p)        __sfeof(p)
 444 #define ferror_unlocked(p)      __sferror(p)
 445 #define clearerr_unlocked(p)    __sclearerr(p)
 446 #define fileno_unlocked(p)      __sfileno(p)
 447 #endif
 448 #if __POSIX_VISIBLE >= 199506
 449 #define getc_unlocked(fp)       __sgetc(fp)
 450 #define putc_unlocked(x, fp)    __sputc(x, fp)
 451
 452 #define getchar_unlocked()      getc_unlocked(stdin)
 453 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 454 #endif
 455
 456 __END_DECLS
 457 #endif /* !_STDIO_H_ */