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  *      $Id: stdio.h,v 1.13 1997/04/13 15:50:07 bde Exp $
  38  */
  39
  40 #ifndef _STDIO_H_
  41 #define _STDIO_H_
  42
  43 #include <sys/cdefs.h>
  44 #include <machine/ansi.h>
  45
  46 #ifdef  _BSD_SIZE_T_
  47 typedef _BSD_SIZE_T_    size_t;
  48 #undef  _BSD_SIZE_T_
  49 #endif
  50
  51 #ifndef NULL
  52 #define NULL    0
  53 #endif
  54
  55 /*
  56  * This is fairly grotesque, but pure ANSI code must not inspect the
  57  * innards of an fpos_t anyway.  The library internally uses off_t,
  58  * which we assume is exactly as big as eight chars.  (When we switch
  59  * to gcc 2.4 we will use __attribute__ here.)
  60  *
  61  * WARNING: the alignment constraints on an off_t and the struct below
  62  * differ on (e.g.) the SPARC.  Hence, the placement of an fpos_t object
  63  * in a structure will change if fpos_t's are not aligned on 8-byte
  64  * boundaries.  THIS IS A CROCK, but for now there is no way around it.
  65  */
  66 #if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)
  67 typedef _BSD_OFF_T_     fpos_t;
  68 #else
  69 typedef struct __sfpos {
  70         char    _pos[8];
  71 } fpos_t;
  72 #endif
  73
  74 #define _FSTDIO                 /* Define for new stdio with functions. */
  75
  76 /*
  77  * NB: to fit things in six character monocase externals, the stdio
  78  * code uses the prefix `__s' for stdio objects, typically followed
  79  * by a three-character attempt at a mnemonic.
  80  */
  81
  82 /* stdio buffers */
  83 struct __sbuf {
  84         unsigned char *_base;
  85         int     _size;
  86 };
  87
  88 /*
  89  * stdio state variables.
  90  *
  91  * The following always hold:
  92  *
  93  *      if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  94  *              _lbfsize is -_bf._size, else _lbfsize is 0
  95  *      if _flags&__SRD, _w is 0
  96  *      if _flags&__SWR, _r is 0
  97  *
  98  * This ensures that the getc and putc macros (or inline functions) never
  99  * try to write or read from a file that is in `read' or `write' mode.
 100  * (Moreover, they can, and do, automatically switch from read mode to
 101  * write mode, and back, on "r+" and "w+" files.)
 102  *
 103  * _lbfsize is used only to make the inline line-buffered output stream
 104  * code as compact as possible.
 105  *
 106  * _ub, _up, and _ur are used when ungetc() pushes back more characters
 107  * than fit in the current _bf, or when ungetc() pushes back a character
 108  * that does not match the previous one in _bf.  When this happens,
 109  * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
 110  * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
 111  *
 112  * NB: see WARNING above before changing the layout of this structure!
 113  */
 114 typedef struct __sFILE {
 115         unsigned char *_p;      /* current position in (some) buffer */
 116         int     _r;             /* read space left for getc() */
 117         int     _w;             /* write space left for putc() */
 118         short   _flags;         /* flags, below; this FILE is free if 0 */
 119         short   _file;          /* fileno, if Unix descriptor, else -1 */
 120         struct  __sbuf _bf;     /* the buffer (at least 1 byte, if !NULL) */
 121         int     _lbfsize;       /* 0 or -_bf._size, for inline putc */
 122
 123         /* operations */
 124         void    *_cookie;       /* cookie passed to io functions */
 125         int     (*_close) __P((void *));
 126         int     (*_read)  __P((void *, char *, int));
 127         fpos_t  (*_seek)  __P((void *, fpos_t, int));
 128         int     (*_write) __P((void *, const char *, int));
 129
 130         /* separate buffer for long sequences of ungetc() */
 131         struct  __sbuf _ub;     /* ungetc buffer */
 132         unsigned char *_up;     /* saved _p when _p is doing ungetc data */
 133         int     _ur;            /* saved _r when _r is counting ungetc data */
 134
 135         /* tricks to meet minimum requirements even when malloc() fails */
 136         unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
 137         unsigned char _nbuf[1]; /* guarantee a getc() buffer */
 138
 139         /* separate buffer for fgetln() when line crosses buffer boundary */
 140         struct  __sbuf _lb;     /* buffer for fgetln() */
 141
 142         /* Unix stdio files get aligned to block boundaries on fseek() */
 143         int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
 144         fpos_t  _offset;        /* current lseek offset (see WARNING) */
 145 } FILE;
 146
 147 __BEGIN_DECLS
 148 extern FILE __sF[];
 149 __END_DECLS
 150
 151 #define __SLBF  0x0001          /* line buffered */
 152 #define __SNBF  0x0002          /* unbuffered */
 153 #define __SRD   0x0004          /* OK to read */
 154 #define __SWR   0x0008          /* OK to write */
 155         /* RD and WR are never simultaneously asserted */
 156 #define __SRW   0x0010          /* open for reading & writing */
 157 #define __SEOF  0x0020          /* found EOF */
 158 #define __SERR  0x0040          /* found error */
 159 #define __SMBF  0x0080          /* _buf is from malloc */
 160 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 161 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 162 #define __SOPT  0x0400          /* do fseek() optimization */
 163 #define __SNPT  0x0800          /* do not do fseek() optimization */
 164 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 165 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 166
 167 /*
 168  * The following three definitions are for ANSI C, which took them
 169  * from System V, which brilliantly took internal interface macros and
 170  * made them official arguments to setvbuf(), without renaming them.
 171  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 172  *
 173  * Although numbered as their counterparts above, the implementation
 174  * does not rely on this.
 175  */
 176 #define _IOFBF  0               /* setvbuf should set fully buffered */
 177 #define _IOLBF  1               /* setvbuf should set line buffered */
 178 #define _IONBF  2               /* setvbuf should set unbuffered */
 179
 180 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 181 #define EOF     (-1)
 182
 183 /*
 184  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 185  * stdio can provide without attempting to allocate further resources
 186  * (which could fail).  Do not use this for anything.
 187  */
 188                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 189 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 190 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 191
 192 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 193 #ifndef _ANSI_SOURCE
 194 #define P_tmpdir        "/var/tmp/"
 195 #endif
 196 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 197 #define TMP_MAX         308915776
 198
 199 #ifndef SEEK_SET
 200 #define SEEK_SET        0       /* set file offset to offset */
 201 #endif
 202 #ifndef SEEK_CUR
 203 #define SEEK_CUR        1       /* set file offset to current plus offset */
 204 #endif
 205 #ifndef SEEK_END
 206 #define SEEK_END        2       /* set file offset to EOF plus offset */
 207 #endif
 208
 209 #define stdin   (&__sF[0])
 210 #define stdout  (&__sF[1])
 211 #define stderr  (&__sF[2])
 212
 213 /*
 214  * Functions defined in ANSI C standard.
 215  */
 216 __BEGIN_DECLS
 217 void     clearerr __P((FILE *));
 218 int      fclose __P((FILE *));
 219 int      feof __P((FILE *));
 220 int      ferror __P((FILE *));
 221 int      fflush __P((FILE *));
 222 int      fgetc __P((FILE *));
 223 int      fgetpos __P((FILE *, fpos_t *));
 224 char    *fgets __P((char *, int, FILE *));
 225 FILE    *fopen __P((const char *, const char *));
 226 int      fprintf __P((FILE *, const char *, ...));
 227 int      fputc __P((int, FILE *));
 228 int      fputs __P((const char *, FILE *));
 229 size_t   fread __P((void *, size_t, size_t, FILE *));
 230 FILE    *freopen __P((const char *, const char *, FILE *));
 231 int      fscanf __P((FILE *, const char *, ...));
 232 int      fseek __P((FILE *, long, int));
 233 int      fsetpos __P((FILE *, const fpos_t *));
 234 long     ftell __P((FILE *));
 235 size_t   fwrite __P((const void *, size_t, size_t, FILE *));
 236 int      getc __P((FILE *));
 237 int      getchar __P((void));
 238 char    *gets __P((char *));
 239 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 240 extern __const int sys_nerr;            /* perror(3) external variables */
 241 extern __const char *__const sys_errlist[];
 242 #endif
 243 void     perror __P((const char *));
 244 int      printf __P((const char *, ...));
 245 int      putc __P((int, FILE *));
 246 int      putchar __P((int));
 247 int      puts __P((const char *));
 248 int      remove __P((const char *));
 249 int      rename  __P((const char *, const char *));
 250 void     rewind __P((FILE *));
 251 int      scanf __P((const char *, ...));
 252 void     setbuf __P((FILE *, char *));
 253 int      setvbuf __P((FILE *, char *, int, size_t));
 254 int      sprintf __P((char *, const char *, ...));
 255 int      sscanf __P((const char *, const char *, ...));
 256 FILE    *tmpfile __P((void));
 257 char    *tmpnam __P((char *));
 258 int      ungetc __P((int, FILE *));
 259 int      vfprintf __P((FILE *, const char *, _BSD_VA_LIST_));
 260 int      vprintf __P((const char *, _BSD_VA_LIST_));
 261 int      vsprintf __P((char *, const char *, _BSD_VA_LIST_));
 262 __END_DECLS
 263
 264 /*
 265  * Functions defined in POSIX 1003.1.
 266  */
 267 #ifndef _ANSI_SOURCE
 268 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
 269 #define L_cuserid       17
 270
 271 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 272
 273 __BEGIN_DECLS
 274 char    *ctermid __P((char *));
 275 FILE    *fdopen __P((int, const char *));
 276 int      fileno __P((FILE *));
 277 __END_DECLS
 278 #endif /* not ANSI */
 279
 280 /*
 281  * Portability hacks.  See <sys/types.h>.
 282  */
 283 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 284 __BEGIN_DECLS
 285 #ifndef _FTRUNCATE_DECLARED
 286 #define _FTRUNCATE_DECLARED
 287 int      ftruncate __P((int, _BSD_OFF_T_));
 288 #endif
 289 #ifndef _LSEEK_DECLARED
 290 #define _LSEEK_DECLARED
 291 _BSD_OFF_T_ lseek __P((int, _BSD_OFF_T_, int));
 292 #endif
 293 #ifndef _MMAP_DECLARED
 294 #define _MMAP_DECLARED
 295 char    *mmap __P((void *, size_t, int, int, int, _BSD_OFF_T_));
 296 #endif
 297 #ifndef _TRUNCATE_DECLARED
 298 #define _TRUNCATE_DECLARED
 299 int      truncate __P((const char *, _BSD_OFF_T_));
 300 #endif
 301 __END_DECLS
 302 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
 303
 304 /*
 305  * Routines that are purely local.
 306  */
 307 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 308 __BEGIN_DECLS
 309 int      asprintf __P((char **, const char *, ...));
 310 char    *fgetln __P((FILE *, size_t *));
 311 int      fpurge __P((FILE *));
 312 int      getw __P((FILE *));
 313 int      pclose __P((FILE *));
 314 FILE    *popen __P((const char *, const char *));
 315 int      putw __P((int, FILE *));
 316 void     setbuffer __P((FILE *, char *, int));
 317 int      setlinebuf __P((FILE *));
 318 char    *tempnam __P((const char *, const char *));
 319 int      snprintf __P((char *, size_t, const char *, ...));
 320 int      vasprintf __P((char **, const char *, _BSD_VA_LIST_));
 321 int      vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_));
 322 int      vscanf __P((const char *, _BSD_VA_LIST_));
 323 int      vsscanf __P((const char *, const char *, _BSD_VA_LIST_));
 324 __END_DECLS
 325
 326 /*
 327  * This is a #define because the function is used internally and
 328  * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
 329  * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
 330  */
 331 #define  vfscanf        __svfscanf
 332
 333 /*
 334  * Stdio function-access interface.
 335  */
 336 __BEGIN_DECLS
 337 FILE    *funopen __P((const void *,
 338                 int (*)(void *, char *, int),
 339                 int (*)(void *, const char *, int),
 340                 fpos_t (*)(void *, fpos_t, int),
 341                 int (*)(void *)));
 342 __END_DECLS
 343 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 344 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 345 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
 346
 347 /*
 348  * Functions internal to the implementation.
 349  */
 350 __BEGIN_DECLS
 351 int     __srget __P((FILE *));
 352 int     __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_));
 353 int     __swbuf __P((int, FILE *));
 354 __END_DECLS
 355
 356 /*
 357  * The __sfoo macros are here so that we can
 358  * define function versions in the C library.
 359  */
 360 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
 361 #if defined(__GNUC__) && defined(__STDC__)
 362 static __inline int __sputc(int _c, FILE *_p) {
 363         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
 364                 return (*_p->_p++ = _c);
 365         else
 366                 return (__swbuf(_c, _p));
 367 }
 368 #else
 369 /*
 370  * This has been tuned to generate reasonable code on the vax using pcc.
 371  */
 372 #define __sputc(c, p) \
 373         (--(p)->_w < 0 ? \
 374                 (p)->_w >= (p)->_lbfsize ? \
 375                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
 376                                 (int)*(p)->_p++ : \
 377                                 __swbuf('\n', p) : \
 378                         __swbuf((int)(c), p) : \
 379                 (*(p)->_p = (c), (int)*(p)->_p++))
 380 #endif
 381
 382 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
 383 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
 384 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
 385 #define __sfileno(p)    ((p)->_file)
 386
 387 #define feof(p)         __sfeof(p)
 388 #define ferror(p)       __sferror(p)
 389 #define clearerr(p)     __sclearerr(p)
 390
 391 #ifndef _ANSI_SOURCE
 392 #define fileno(p)       __sfileno(p)
 393 #endif
 394
 395 #ifndef lint
 396 #define getc(fp)        __sgetc(fp)
 397 #define putc(x, fp)     __sputc(x, fp)
 398 #endif /* lint */
 399
 400 #define getchar()       getc(stdin)
 401 #define putchar(x)      putc(x, stdout)
 402
 403 #endif /* !_STDIO_H_ */