include/stdio.h

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