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/_types.h>
  45
  46 #ifndef _SIZE_T_DECLARED
  47 typedef __size_t        size_t;
  48 #define _SIZE_T_DECLARED
  49 #endif
  50
  51 #ifndef NULL
  52 #define NULL    0
  53 #endif
  54
  55 typedef __off_t         fpos_t;
  56
  57 #define _FSTDIO                 /* Define for new stdio with functions. */
  58
  59 /*
  60  * NB: to fit things in six character monocase externals, the stdio
  61  * code uses the prefix `__s' for stdio objects, typically followed
  62  * by a three-character attempt at a mnemonic.
  63  */
  64
  65 /* stdio buffers */
  66 struct __sbuf {
  67         unsigned char *_base;
  68         int     _size;
  69 };
  70
  71 /* hold a buncha junk that would grow the ABI */
  72 struct __sFILEX;
  73
  74 /*
  75  * stdio state variables.
  76  *
  77  * The following always hold:
  78  *
  79  *      if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  80  *              _lbfsize is -_bf._size, else _lbfsize is 0
  81  *      if _flags&__SRD, _w is 0
  82  *      if _flags&__SWR, _r is 0
  83  *
  84  * This ensures that the getc and putc macros (or inline functions) never
  85  * try to write or read from a file that is in `read' or `write' mode.
  86  * (Moreover, they can, and do, automatically switch from read mode to
  87  * write mode, and back, on "r+" and "w+" files.)
  88  *
  89  * _lbfsize is used only to make the inline line-buffered output stream
  90  * code as compact as possible.
  91  *
  92  * _ub, _up, and _ur are used when ungetc() pushes back more characters
  93  * than fit in the current _bf, or when ungetc() pushes back a character
  94  * that does not match the previous one in _bf.  When this happens,
  95  * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
  96  * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
  97  *
  98  * NB: see WARNING above before changing the layout of this structure!
  99  */
 100 typedef struct __sFILE {
 101         unsigned char *_p;      /* current position in (some) buffer */
 102         int     _r;             /* read space left for getc() */
 103         int     _w;             /* write space left for putc() */
 104         short   _flags;         /* flags, below; this FILE is free if 0 */
 105         short   _file;          /* fileno, if Unix descriptor, else -1 */
 106         struct  __sbuf _bf;     /* the buffer (at least 1 byte, if !NULL) */
 107         int     _lbfsize;       /* 0 or -_bf._size, for inline putc */
 108
 109         /* operations */
 110         void    *_cookie;       /* cookie passed to io functions */
 111         int     (*_close)(void *);
 112         int     (*_read)(void *, char *, int);
 113         fpos_t  (*_seek)(void *, fpos_t, int);
 114         int     (*_write)(void *, const char *, int);
 115
 116         /* separate buffer for long sequences of ungetc() */
 117         struct  __sbuf _ub;     /* ungetc buffer */
 118         struct __sFILEX *_extra; /* additions to FILE to not break ABI */
 119         int     _ur;            /* saved _r when _r is counting ungetc data */
 120
 121         /* tricks to meet minimum requirements even when malloc() fails */
 122         unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
 123         unsigned char _nbuf[1]; /* guarantee a getc() buffer */
 124
 125         /* separate buffer for fgetln() when line crosses buffer boundary */
 126         struct  __sbuf _lb;     /* buffer for fgetln() */
 127
 128         /* Unix stdio files get aligned to block boundaries on fseek() */
 129         int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
 130         fpos_t  _offset;        /* current lseek offset (see WARNING) */
 131 } FILE;
 132
 133 __BEGIN_DECLS
 134 extern FILE __sF[];
 135 extern FILE *__stdinp;
 136 extern FILE *__stdoutp;
 137 extern FILE *__stderrp;
 138 __END_DECLS
 139
 140 #define __SLBF  0x0001          /* line buffered */
 141 #define __SNBF  0x0002          /* unbuffered */
 142 #define __SRD   0x0004          /* OK to read */
 143 #define __SWR   0x0008          /* OK to write */
 144         /* RD and WR are never simultaneously asserted */
 145 #define __SRW   0x0010          /* open for reading & writing */
 146 #define __SEOF  0x0020          /* found EOF */
 147 #define __SERR  0x0040          /* found error */
 148 #define __SMBF  0x0080          /* _buf is from malloc */
 149 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 150 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 151 #define __SOPT  0x0400          /* do fseek() optimization */
 152 #define __SNPT  0x0800          /* do not do fseek() optimization */
 153 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 154 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 155 #define __SALC  0x4000          /* allocate string space dynamically */
 156 #define __SIGN  0x8000          /* ignore this file in _fwalk */
 157
 158 /*
 159  * The following three definitions are for ANSI C, which took them
 160  * from System V, which brilliantly took internal interface macros and
 161  * made them official arguments to setvbuf(), without renaming them.
 162  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 163  *
 164  * Although numbered as their counterparts above, the implementation
 165  * does not rely on this.
 166  */
 167 #define _IOFBF  0               /* setvbuf should set fully buffered */
 168 #define _IOLBF  1               /* setvbuf should set line buffered */
 169 #define _IONBF  2               /* setvbuf should set unbuffered */
 170
 171 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 172 #define EOF     (-1)
 173
 174 /*
 175  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 176  * stdio can provide without attempting to allocate further resources
 177  * (which could fail).  Do not use this for anything.
 178  */
 179                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 180 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 181 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 182
 183 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 184 #if __XSI_VISIBLE
 185 #define P_tmpdir        "/var/tmp/"
 186 #endif
 187 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 188 #define TMP_MAX         308915776
 189
 190 #ifndef SEEK_SET
 191 #define SEEK_SET        0       /* set file offset to offset */
 192 #endif
 193 #ifndef SEEK_CUR
 194 #define SEEK_CUR        1       /* set file offset to current plus offset */
 195 #endif
 196 #ifndef SEEK_END
 197 #define SEEK_END        2       /* set file offset to EOF plus offset */
 198 #endif
 199
 200 /* To be removed by 5.0-RELEASE */
 201 #if (defined(__i386__) || defined(__alpha__)) && defined(_OLD_STDIO)
 202 #define stdin   (&__sF[0])
 203 #define stdout  (&__sF[1])
 204 #define stderr  (&__sF[2])
 205 #else
 206 #define stdin   __stdinp
 207 #define stdout  __stdoutp
 208 #define stderr  __stderrp
 209 #endif
 210
 211 __BEGIN_DECLS
 212 /*
 213  * Functions defined in ANSI C standard.
 214  */
 215 void     clearerr(FILE *);
 216 int      fclose(FILE *);
 217 int      feof(FILE *);
 218 int      ferror(FILE *);
 219 int      fflush(FILE *);
 220 int      fgetc(FILE *);
 221 int      fgetpos(FILE *, fpos_t *);
 222 char    *fgets(char *, int, FILE *);
 223 FILE    *fopen(const char *, const char *);
 224 int      fprintf(FILE * __restrict, const char * __restrict, ...);
 225 int      fputc(int, FILE *);
 226 int      fputs(const char *, FILE *);
 227 size_t   fread(void *, size_t, size_t, FILE *);
 228 FILE    *freopen(const char *, const char *, FILE *);
 229 int      fscanf(FILE *, const char *, ...);
 230 int      fseek(FILE *, long, int);
 231 int      fsetpos(FILE *, const fpos_t *);
 232 long     ftell(FILE *);
 233 size_t   fwrite(const void *, size_t, size_t, FILE *);
 234 int      getc(FILE *);
 235 int      getchar(void);
 236 char    *gets(char *);
 237 void     perror(const char *);
 238 int      printf(const char * __restrict, ...);
 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 *, ...);
 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 int      sscanf(const char *, const char *, ...);
 250 FILE    *tmpfile(void);
 251 char    *tmpnam(char *);
 252 int      ungetc(int, FILE *);
 253 int      vfprintf(FILE * __restrict, const char * __restrict,
 254             __va_list);
 255 int      vprintf(const char * __restrict, __va_list);
 256 int      vsprintf(char * __restrict, const char * __restrict,
 257             __va_list);
 258
 259 #if __ISO_C_VISIBLE >= 1999
 260 int      snprintf(char * __restrict, size_t, const char * __restrict,
 261             ...) __printflike(3, 4);
 262 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 263             __va_list) __printflike(3, 0);
 264 #endif
 265
 266 /*
 267  * Functions defined in all versions of POSIX 1003.1.
 268  */
 269 #if __POSIX_VISIBLE
 270 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
 271 #define L_cuserid       17
 272
 273 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 274
 275 char    *ctermid(char *);
 276 FILE    *fdopen(int, const char *);
 277 int      fileno(FILE *);
 278 #endif /* __POSIX_VISIBLE */
 279
 280 #if __POSIX_VISIBLE >= 199209
 281 int      pclose(FILE *);
 282 FILE    *popen(const char *, const char *);
 283 #endif
 284
 285 #if __POSIX_VISIBLE >= 199506
 286 int      ftrylockfile(FILE *);
 287 void     flockfile(FILE *);
 288 void     funlockfile(FILE *);
 289
 290 /*
 291  * These are normally used through macros as defined below, but POSIX
 292  * requires functions as well.
 293  */
 294 int      getc_unlocked(FILE *);
 295 int      getchar_unlocked(void);
 296 int      putc_unlocked(int, FILE *);
 297 int      putchar_unlocked(int);
 298 #endif
 299
 300 #if __POSIX_VISIBLE >= 200112
 301 int      fseeko(FILE *, __off_t, int);
 302 __off_t  ftello(FILE *);
 303 #endif
 304
 305 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
 306 int      getw(FILE *);
 307 int      putw(int, FILE *);
 308 #endif /* BSD or X/Open before issue 6 */
 309
 310 #if __XSI_VISIBLE
 311 char    *tempnam(const char *, const char *);
 312 #endif
 313
 314 /*
 315  * Routines that are purely local.
 316  */
 317 #if __BSD_VISIBLE
 318 int      asprintf(char **, const char *, ...) __printflike(2, 3);
 319 char    *ctermid_r(char *);
 320 char    *fgetln(FILE *, size_t *);
 321 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3
 322 #define __ATTR_FORMAT_ARG       __attribute__((__format_arg__(2)))
 323 #else
 324 #define __ATTR_FORMAT_ARG
 325 #endif
 326 __const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG;
 327 int      fpurge(FILE *);
 328 void     setbuffer(FILE *, char *, int);
 329 int      setlinebuf(FILE *);
 330 int      vasprintf(char **, const char *, __va_list)
 331             __printflike(2, 0);
 332 int      vscanf(const char *, __va_list) __scanflike(1, 0);
 333 int      vsscanf(const char *, const char *, __va_list)
 334             __scanflike(2, 0);
 335
 336 /*
 337  * The system error table contains messages for the first sys_nerr
 338  * positive errno values.  Use strerror() or strerror_r() from <string.h>
 339  * instead.
 340  */
 341 extern __const int sys_nerr;
 342 extern __const char *__const sys_errlist[];
 343
 344 /*
 345  * This is a #define because the function is used internally and
 346  * (unlike vfscanf) the name __vfscanf is guaranteed not to collide
 347  * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
 348  */
 349 #define  vfscanf        __vfscanf
 350
 351 /*
 352  * Stdio function-access interface.
 353  */
 354 FILE    *funopen(const void *,
 355             int (*)(void *, char *, int),
 356             int (*)(void *, const char *, int),
 357             fpos_t (*)(void *, fpos_t, int),
 358             int (*)(void *));
 359 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 360 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 361
 362 /*
 363  * Portability hacks.  See <sys/types.h>.
 364  */
 365 #ifndef _FTRUNCATE_DECLARED
 366 #define _FTRUNCATE_DECLARED
 367 int      ftruncate(int, __off_t);
 368 #endif
 369 #ifndef _LSEEK_DECLARED
 370 #define _LSEEK_DECLARED
 371 __off_t  lseek(int, __off_t, int);
 372 #endif
 373 #ifndef _MMAP_DECLARED
 374 #define _MMAP_DECLARED
 375 void    *mmap(void *, size_t, int, int, int, __off_t);
 376 #endif
 377 #ifndef _TRUNCATE_DECLARED
 378 #define _TRUNCATE_DECLARED
 379 int      truncate(const char *, __off_t);
 380 #endif
 381 #endif /* __BSD_VISIBLE */
 382
 383 /*
 384  * Functions internal to the implementation.
 385  */
 386 int     __srget(FILE *);
 387 int     __vfscanf(FILE *, const char *, __va_list);
 388 int     __svfscanf(FILE *, const char *, __va_list);
 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 /*
 423  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
 424  * B.8.2.7 for the rationale behind the *_unlocked() macros.
 425  */
 426 #define feof_unlocked(p)        __sfeof(p)
 427 #define ferror_unlocked(p)      __sferror(p)
 428 #define clearerr_unlocked(p)    __sclearerr(p)
 429 #define fileno_unlocked(p)      __sfileno(p)
 430 #define getc_unlocked(fp)       __sgetc(fp)
 431 #define putc_unlocked(x, fp)    __sputc(x, fp)
 432
 433 #define getchar_unlocked()      getc_unlocked(stdin)
 434 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 435
 436 __END_DECLS
 437 #endif /* !_STDIO_H_ */