include/stdio.h

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