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 #if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)
  67 #include <sys/types.h>
  68 #endif
  69
  70 #include <sys/cdefs.h>
  71
  72 #include <machine/ansi.h>
  73 #ifndef _BSD_SIZE_T_DEFINED_
  74 #define _BSD_SIZE_T_DEFINED_
  75 typedef _BSD_SIZE_T_    size_t;
  76 #endif
  77
  78 #ifndef NULL
  79 #define NULL    0
  80 #endif
  81
  82 /*
  83  * This is fairly grotesque, but pure ANSI code must not inspect the
  84  * innards of an fpos_t anyway.  The library internally uses off_t,
  85  * which we assume is exactly as big as eight chars.  (When we switch
  86  * to gcc 2.4 we will use __attribute__ here.)
  87  *
  88  * WARNING: the alignment constraints on an off_t and the struct below
  89  * differ on (e.g.) the SPARC.  Hence, the placement of an fpos_t object
  90  * in a structure will change if fpos_t's are not aligned on 8-byte
  91  * boundaries.  THIS IS A CROCK, but for now there is no way around it.
  92  */
  93 #if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)
  94 typedef off_t fpos_t;
  95 #else
  96 typedef struct __sfpos {
  97         char    _pos[8];
  98 } fpos_t;
  99 #endif
 100
 101 #define _FSTDIO                 /* Define for new stdio with functions. */
 102
 103 /*
 104  * NB: to fit things in six character monocase externals, the stdio
 105  * code uses the prefix `__s' for stdio objects, typically followed
 106  * by a three-character attempt at a mnemonic.
 107  */
 108
 109 /* stdio buffers */
 110 struct __sbuf {
 111         unsigned char *_base;
 112         int     _size;
 113 };
 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) __P((void *));
 153         int     (*_read)  __P((void *, char *, int));
 154         fpos_t  (*_seek)  __P((void *, fpos_t, int));
 155         int     (*_write) __P((void *, const char *, int));
 156
 157         /* separate buffer for long sequences of ungetc() */
 158         struct  __sbuf _ub;     /* ungetc buffer */
 159         unsigned char *_up;     /* saved _p when _p is doing ungetc data */
 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
 195 /*
 196  * The following three definitions are for ANSI C, which took them
 197  * from System V, which brilliantly took internal interface macros and
 198  * made them official arguments to setvbuf(), without renaming them.
 199  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 200  *
 201  * Although numbered as their counterparts above, the implementation
 202  * does not rely on this.
 203  */
 204 #define _IOFBF  0               /* setvbuf should set fully buffered */
 205 #define _IOLBF  1               /* setvbuf should set line buffered */
 206 #define _IONBF  2               /* setvbuf should set unbuffered */
 207
 208 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 209 #define EOF     (-1)
 210
 211 /*
 212  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 213  * stdio can provide without attempting to allocate further resources
 214  * (which could fail).  Do not use this for anything.
 215  */
 216                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 217 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 218 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 219
 220 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 221 #ifndef _ANSI_SOURCE
 222 #define P_tmpdir        "/var/tmp/"
 223 #endif
 224 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 225 #define TMP_MAX         308915776
 226
 227 #ifndef SEEK_SET
 228 #define SEEK_SET        0       /* set file offset to offset */
 229 #endif
 230 #ifndef SEEK_CUR
 231 #define SEEK_CUR        1       /* set file offset to current plus offset */
 232 #endif
 233 #ifndef SEEK_END
 234 #define SEEK_END        2       /* set file offset to EOF plus offset */
 235 #endif
 236
 237 #define stdin   (&__sF[0])
 238 #define stdout  (&__sF[1])
 239 #define stderr  (&__sF[2])
 240
 241 /*
 242  * Functions defined in ANSI C standard.
 243  */
 244 __BEGIN_DECLS
 245 void     clearerr __P((FILE *));
 246 int      fclose __P((FILE *));
 247 int      feof __P((FILE *));
 248 int      ferror __P((FILE *));
 249 int      fflush __P((FILE *));
 250 int      fgetc __P((FILE *));
 251 int      fgetpos __P((FILE *, fpos_t *));
 252 char    *fgets __P((char *, int, FILE *));
 253 FILE    *fopen __P((const char *, const char *));
 254 int      fprintf __P((FILE *, const char *, ...));
 255 int      fputc __P((int, FILE *));
 256 int      fputs __P((const char *, FILE *));
 257 size_t   fread __P((void *, size_t, size_t, FILE *));
 258 FILE    *freopen __P((const char *, const char *, FILE *));
 259 int      fscanf __P((FILE *, const char *, ...));
 260 int      fseek __P((FILE *, long, int));
 261 int      fsetpos __P((FILE *, const fpos_t *));
 262 long     ftell __P((FILE *));
 263 size_t   fwrite __P((const void *, size_t, size_t, FILE *));
 264 int      getc __P((FILE *));
 265 int      getchar __P((void));
 266 char    *gets __P((char *));
 267 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 268 extern __const int sys_nerr;            /* perror(3) external variables */
 269 extern __const char *__const sys_errlist[];
 270 #endif
 271 void     perror __P((const char *));
 272 int      printf __P((const char *, ...));
 273 int      putc __P((int, FILE *));
 274 int      putchar __P((int));
 275 int      puts __P((const char *));
 276 int      remove __P((const char *));
 277 int      rename  __P((const char *, const char *));
 278 void     rewind __P((FILE *));
 279 int      scanf __P((const char *, ...));
 280 void     setbuf __P((FILE *, char *));
 281 int      setvbuf __P((FILE *, char *, int, size_t));
 282 int      sprintf __P((char *, const char *, ...));
 283 int      sscanf __P((const char *, const char *, ...));
 284 FILE    *tmpfile __P((void));
 285 char    *tmpnam __P((char *));
 286 int      ungetc __P((int, FILE *));
 287 int      vfprintf __P((FILE *, const char *, _BSD_VA_LIST_));
 288 int      vprintf __P((const char *, _BSD_VA_LIST_));
 289 int      vsprintf __P((char *, const char *, _BSD_VA_LIST_));
 290 int      asprintf __P((char **, const char *, ...));
 291 int      vasprintf __P((char **, const char *, _BSD_VA_LIST_));
 292 __END_DECLS
 293
 294 /*
 295  * Functions defined in POSIX 1003.1.
 296  */
 297 #ifndef _ANSI_SOURCE
 298 #define L_cuserid       9       /* size for cuserid(); UT_NAMESIZE + 1 */
 299 #define L_ctermid       1024    /* size for ctermid(); PATH_MAX */
 300
 301 __BEGIN_DECLS
 302 char    *ctermid __P((char *));
 303 FILE    *fdopen __P((int, const char *));
 304 int      fileno __P((FILE *));
 305 __END_DECLS
 306 #endif /* not ANSI */
 307
 308 /*
 309  * Routines that are purely local.
 310  */
 311 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
 312 __BEGIN_DECLS
 313 char    *fgetln __P((FILE *, size_t *));
 314 int      fpurge __P((FILE *));
 315 int      fseeko __P((FILE *, fpos_t, int));
 316 fpos_t  ftello __P((FILE *));
 317 int      getw __P((FILE *));
 318 int      pclose __P((FILE *));
 319 FILE    *popen __P((const char *, const char *));
 320 int      putw __P((int, FILE *));
 321 void     setbuffer __P((FILE *, char *, int));
 322 int      setlinebuf __P((FILE *));
 323 char    *tempnam __P((const char *, const char *));
 324 int      snprintf __P((char *, size_t, const char *, ...));
 325 int      vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_));
 326 int      vscanf __P((const char *, _BSD_VA_LIST_));
 327 int      vsscanf __P((const char *, const char *, _BSD_VA_LIST_));
 328 FILE    *zopen __P((const char *, const char *, int));
 329 __END_DECLS
 330
 331 /*
 332  * This is a #define because the function is used internally and
 333  * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
 334  * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
 335  */
 336 #define  vfscanf        __svfscanf
 337
 338 /*
 339  * Stdio function-access interface.
 340  */
 341 __BEGIN_DECLS
 342 FILE    *funopen __P((const void *,
 343                 int (*)(void *, char *, int),
 344                 int (*)(void *, const char *, int),
 345                 fpos_t (*)(void *, fpos_t, int),
 346                 int (*)(void *)));
 347 __END_DECLS
 348 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 349 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 350 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
 351
 352 /*
 353  * Functions internal to the implementation.
 354  */
 355 __BEGIN_DECLS
 356 int     __srget __P((FILE *));
 357 int     __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_));
 358 int     __swbuf __P((int, FILE *));
 359 __END_DECLS
 360
 361 /*
 362  * The __sfoo macros are here so that we can
 363  * define function versions in the C library.
 364  */
 365 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
 366 #if defined(__GNUC__) && defined(__STDC__)
 367 static __inline int __sputc(int _c, FILE *_p) {
 368         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
 369                 return (*_p->_p++ = _c);
 370         else
 371                 return (__swbuf(_c, _p));
 372 }
 373 #else
 374 /*
 375  * This has been tuned to generate reasonable code on the vax using pcc.
 376  */
 377 #define __sputc(c, p) \
 378         (--(p)->_w < 0 ? \
 379                 (p)->_w >= (p)->_lbfsize ? \
 380                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
 381                                 (int)*(p)->_p++ : \
 382                                 __swbuf('\n', p) : \
 383                         __swbuf((int)(c), p) : \
 384                 (*(p)->_p = (c), (int)*(p)->_p++))
 385 #endif
 386
 387 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
 388 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
 389 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
 390 #define __sfileno(p)    ((p)->_file)
 391
 392 #define feof(p)         __sfeof(p)
 393 #define ferror(p)       __sferror(p)
 394 #define clearerr(p)     __sclearerr(p)
 395
 396 #ifndef _ANSI_SOURCE
 397 #define fileno(p)       __sfileno(p)
 398 #endif
 399
 400 #ifndef lint
 401 #define getc(fp)        __sgetc(fp)
 402 #define putc(x, fp)     __sputc(x, fp)
 403 #endif /* lint */
 404
 405 #define getchar()       getc(stdin)
 406 #define putchar(x)      putc(x, stdout)
 407 #endif /* _STDIO_H_ */