Add the source code for /usr/src/usr.bin from the Net/2 tape
[unix-history] / usr / src / include / stdio.h
index 90dd4a8..5489652 100644 (file)
-/*     stdio.h 1.8     84/11/12        */
-#define        BUFSIZ  1024
-#define        _NFILE  20
-# ifndef FILE
-extern struct  _iobuf {
-       int     _cnt;
-       char    *_ptr;
-       char    *_base;
-       int     _bufsiz;
-       short   _flag;
-       char    _file;
-} _iob[_NFILE];
-# endif
-
-#define        _IOREAD 01
-#define        _IOWRT  02
-#define        _IONBF  04
-#define        _IOMYBUF        010
-#define        _IOEOF  020
-#define        _IOERR  040
-#define        _IOSTRG 0100
-#define        _IOLBF  0200
-#define        _IORW   0400
+/*-
+ * Copyright (c) 1990 The Regents of the University of California.
+ * All rights reserved.
+ *
+ * This code is derived from software contributed to Berkeley by
+ * Chris Torek.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *     This product includes software developed by the University of
+ *     California, Berkeley and its contributors.
+ * 4. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ *     @(#)stdio.h     5.17 (Berkeley) 6/3/91
+ */
+
+#ifndef        _STDIO_H_
+#define        _STDIO_H_
+
+#include <sys/cdefs.h>
+
+#include <machine/ansi.h>
+#ifdef _SIZE_T_
+typedef        _SIZE_T_        size_t;
+#undef _SIZE_T_
+#endif
+
+#ifndef NULL
 #define        NULL    0
 #define        NULL    0
-#define        FILE    struct _iobuf
+#endif
+
+typedef long fpos_t;           /* Must match off_t <sys/types.h> */
+
+#define        _FSTDIO                 /* Define for new stdio with functions. */
+
+/*
+ * NB: to fit things in six character monocase externals, the stdio
+ * code uses the prefix `__s' for stdio objects, typically followed
+ * by a three-character attempt at a mnemonic.
+ */
+
+/* stdio buffers */
+struct __sbuf {
+       unsigned char *_base;
+       int     _size;
+};
+
+/*
+ * stdio state variables.
+ *
+ * The following always hold:
+ *
+ *     if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
+ *             _lbfsize is -_bf._size, else _lbfsize is 0
+ *     if _flags&__SRD, _w is 0
+ *     if _flags&__SWR, _r is 0
+ *
+ * This ensures that the getc and putc macros (or inline functions) never
+ * try to write or read from a file that is in `read' or `write' mode.
+ * (Moreover, they can, and do, automatically switch from read mode to
+ * write mode, and back, on "r+" and "w+" files.)
+ *
+ * _lbfsize is used only to make the inline line-buffered output stream
+ * code as compact as possible.
+ *
+ * _ub, _up, and _ur are used when ungetc() pushes back more characters
+ * than fit in the current _bf, or when ungetc() pushes back a character
+ * that does not match the previous one in _bf.  When this happens,
+ * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
+ * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
+ */
+typedef        struct __sFILE {
+       unsigned char *_p;      /* current position in (some) buffer */
+       int     _r;             /* read space left for getc() */
+       int     _w;             /* write space left for putc() */
+       short   _flags;         /* flags, below; this FILE is free if 0 */
+       short   _file;          /* fileno, if Unix descriptor, else -1 */
+       struct  __sbuf _bf;     /* the buffer (at least 1 byte, if !NULL) */
+       int     _lbfsize;       /* 0 or -_bf._size, for inline putc */
+
+       /* operations */
+       void    *_cookie;       /* cookie passed to io functions */
+       int     (*_close) __P((void *));
+       int     (*_read)  __P((void *, char *, int));
+       fpos_t  (*_seek)  __P((void *, fpos_t, int));
+       int     (*_write) __P((void *, const char *, int));
+
+       /* separate buffer for long sequences of ungetc() */
+       struct  __sbuf _ub;     /* ungetc buffer */
+       unsigned char *_up;     /* saved _p when _p is doing ungetc data */
+       int     _ur;            /* saved _r when _r is counting ungetc data */
+
+       /* tricks to meet minimum requirements even when malloc() fails */
+       unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
+       unsigned char _nbuf[1]; /* guarantee a getc() buffer */
+
+       /* separate buffer for fgetline() when line crosses buffer boundary */
+       struct  __sbuf _lb;     /* buffer for fgetline() */
+
+       /* Unix stdio files get aligned to block boundaries on fseek() */
+       int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
+       int     _offset;        /* current lseek offset */
+} FILE;
+
+__BEGIN_DECLS
+extern FILE __sF[];
+__END_DECLS
+
+#define        __SLBF  0x0001          /* line buffered */
+#define        __SNBF  0x0002          /* unbuffered */
+#define        __SRD   0x0004          /* OK to read */
+#define        __SWR   0x0008          /* OK to write */
+       /* RD and WR are never simultaneously asserted */
+#define        __SRW   0x0010          /* open for reading & writing */
+#define        __SEOF  0x0020          /* found EOF */
+#define        __SERR  0x0040          /* found error */
+#define        __SMBF  0x0080          /* _buf is from malloc */
+#define        __SAPP  0x0100          /* fdopen()ed in append mode */
+#define        __SSTR  0x0200          /* this is an sprintf/snprintf string */
+#define        __SOPT  0x0400          /* do fseek() optimisation */
+#define        __SNPT  0x0800          /* do not do fseek() optimisation */
+#define        __SOFF  0x1000          /* set iff _offset is in fact correct */
+#define        __SMOD  0x2000          /* true => fgetline modified _p text */
+
+/*
+ * The following three definitions are for ANSI C, which took them
+ * from System V, which brilliantly took internal interface macros and
+ * made them official arguments to setvbuf(), without renaming them.
+ * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
+ *
+ * Although numbered as their counterparts above, the implementation
+ * does not rely on this.
+ */
+#define        _IOFBF  0               /* setvbuf should set fully buffered */
+#define        _IOLBF  1               /* setvbuf should set line buffered */
+#define        _IONBF  2               /* setvbuf should set unbuffered */
+
+#define        BUFSIZ  1024            /* size of buffer used by setbuf */
 #define        EOF     (-1)
 
 #define        EOF     (-1)
 
-#define        stdin   (&_iob[0])
-#define        stdout  (&_iob[1])
-#define        stderr  (&_iob[2])
-#define        getc(p)         (--(p)->_cnt>=0? *(p)->_ptr++&0377:_filbuf(p))
-#define        getchar()       getc(stdin)
-#define putc(x, p)     (--(p)->_cnt >= 0 || ((p)->_flag & _IOLBF) &&\
-               -(p)->_cnt <= (p)->_bufsiz && (x) != '\n' ?\
-               (int)(*(p)->_ptr++ = (unsigned)(x)) : _flsbuf((unsigned)(x), p))
-#define        putchar(x)      putc(x,stdout)
-#define        feof(p)         (((p)->_flag&_IOEOF)!=0)
-#define        ferror(p)       (((p)->_flag&_IOERR)!=0)
-#define        fileno(p)       ((p)->_file)
-
-FILE   *fopen();
-FILE   *fdopen();
-FILE   *freopen();
-long   ftell();
-char   *fgets();
-char   *gets();
-#ifdef vax
-char   *sprintf();             /* too painful to do right */
+/*
+ * FOPEN_MAX is a minimum maximum, and should be the number of descriptors
+ * that the kernel can provide without allocation of a resource that can
+ * fail without the process sleeping.  Do not use this for anything.
+ */
+#define        FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
+#define        FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
+
+/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
+#ifndef _ANSI_SOURCE
+#define        P_tmpdir        "/var/tmp/"
 #endif
 #endif
+#define        L_tmpnam        1024    /* XXX must be == PATH_MAX */
+#define        TMP_MAX         308915776
+
+#ifndef SEEK_SET
+#define        SEEK_SET        0       /* set file offset to offset */
+#endif
+#ifndef SEEK_CUR
+#define        SEEK_CUR        1       /* set file offset to current plus offset */
+#endif
+#ifndef SEEK_END
+#define        SEEK_END        2       /* set file offset to EOF plus offset */
+#endif
+
+#define        stdin   (&__sF[0])
+#define        stdout  (&__sF[1])
+#define        stderr  (&__sF[2])
+
+/*
+ * Functions defined in ANSI C standard.
+ */
+__BEGIN_DECLS
+void    clearerr __P((FILE *));
+int     fclose __P((FILE *));
+int     feof __P((FILE *));
+int     ferror __P((FILE *));
+int     fflush __P((FILE *));
+int     fgetc __P((FILE *));
+int     fgetpos __P((FILE *, fpos_t *));
+char   *fgets __P((char *, size_t, FILE *));
+FILE   *fopen __P((const char *, const char *));
+int     fprintf __P((FILE *, const char *, ...));
+int     fputc __P((int, FILE *));
+int     fputs __P((const char *, FILE *));
+int     fread __P((void *, size_t, size_t, FILE *));
+FILE   *freopen __P((const char *, const char *, FILE *));
+int     fscanf __P((FILE *, const char *, ...));
+int     fseek __P((FILE *, long, int));
+int     fsetpos __P((FILE *, const fpos_t *));
+long    ftell __P((const FILE *));
+int     fwrite __P((const void *, size_t, size_t, FILE *));
+int     getc __P((FILE *));
+int     getchar __P((void));
+char   *gets __P((char *));
+#if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
+extern int sys_nerr;                   /* perror(3) external variables */
+extern char *sys_errlist[];
+#endif
+void    perror __P((const char *));
+int     printf __P((const char *, ...));
+int     putc __P((int, FILE *));
+int     putchar __P((int));
+int     puts __P((const char *));
+int     remove __P((const char *));
+int     rename  __P((const char *, const char *));
+void    rewind __P((FILE *));
+int     scanf __P((const char *, ...));
+void    setbuf __P((FILE *, char *));
+int     setvbuf __P((FILE *, char *, int, size_t));
+int     sprintf __P((char *, const char *, ...));
+int     sscanf __P((char *, const char *, ...));
+FILE   *tmpfile __P((void));
+char   *tmpnam __P((char *));
+int     ungetc __P((int, FILE *));
+int     vfprintf __P((FILE *, const char *, _VA_LIST_));
+int     vprintf __P((const char *, _VA_LIST_));
+int     vsprintf __P((char *, const char *, _VA_LIST_));
+__END_DECLS
+
+/*
+ * Functions defined in POSIX 1003.1.
+ */
+#ifndef _ANSI_SOURCE
+#define        L_cuserid       9       /* size for cuserid(); UT_NAMESIZE + 1 */
+#define        L_ctermid       1024    /* size for ctermid(); PATH_MAX */
+
+__BEGIN_DECLS
+char   *ctermid __P((char *));
+FILE   *fdopen __P((int, const char *));
+int     fileno __P((FILE *));
+__END_DECLS
+#endif /* not ANSI */
+
+/*
+ * Routines that are purely local.
+ */
+#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
+__BEGIN_DECLS
+char   *fgetline __P((FILE *, size_t *));
+int     fpurge __P((FILE *));
+int     getw __P((FILE *));
+int     pclose __P((FILE *));
+FILE   *popen __P((const char *, const char *));
+int     putw __P((int, FILE *));
+void    setbuffer __P((FILE *, char *, int));
+int     setlinebuf __P((FILE *));
+char   *tempnam __P((const char *, const char *));
+int     snprintf __P((char *, size_t, const char *, ...));
+int     vsnprintf __P((char *, size_t, const char *, _VA_LIST_));
+int     vscanf __P((const char *, _VA_LIST_));
+int     vsscanf __P((const char *, const char *, _VA_LIST_));
+__END_DECLS
+
+/*
+ * This is a #define because the function is used internally and
+ * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
+ * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
+ */
+#define         vfscanf        __svfscanf
+
+/*
+ * Stdio function-access interface.
+ */
+__BEGIN_DECLS
+FILE   *funopen __P((const void *,
+               int (*)(void *, char *, int),
+               int (*)(void *, const char *, int),
+               fpos_t (*)(void *, fpos_t, int),
+               int (*)(void *)));
+__END_DECLS
+#define        fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
+#define        fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
+#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
+
+/*
+ * Functions internal to the implementation.
+ */
+__BEGIN_DECLS
+int    __srget __P((FILE *));
+int    __svfscanf __P((FILE *, const char *, _VA_LIST_));
+int    __swbuf __P((int, FILE *));
+__END_DECLS
+
+/*
+ * The __sfoo macros are here so that we can 
+ * define function versions in the C library.
+ */
+#define        __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
+#if defined(__GNUC__) && defined(__STDC__)
+static inline int __sputc(int _c, FILE *_p) {
+       if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
+               return (*_p->_p++ = _c);
+       else
+               return (__swbuf(_c, _p));
+}
+#else
+/*
+ * This has been tuned to generate reasonable code on the vax using pcc.
+ */
+#define        __sputc(c, p) \
+       (--(p)->_w < 0 ? \
+               (p)->_w >= (p)->_lbfsize ? \
+                       (*(p)->_p = (c)), *(p)->_p != '\n' ? \
+                               (int)*(p)->_p++ : \
+                               __swbuf('\n', p) : \
+                       __swbuf((int)(c), p) : \
+               (*(p)->_p = (c), (int)*(p)->_p++))
+#endif
+
+#define        __sfeof(p)      (((p)->_flags & __SEOF) != 0)
+#define        __sferror(p)    (((p)->_flags & __SERR) != 0)
+#define        __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
+#define        __sfileno(p)    ((p)->_file)
+
+#define        feof(p)         __sfeof(p)
+#define        ferror(p)       __sferror(p)
+#define        clearerr(p)     __sclearerr(p)
+
+#ifndef _ANSI_SOURCE
+#define        fileno(p)       __sfileno(p)
+#endif
+
+#ifndef lint
+#define        getc(fp)        __sgetc(fp)
+#define putc(x, fp)    __sputc(x, fp)
+#endif /* lint */
+
+#define        getchar()       getc(stdin)
+#define        putchar(x)      putc(x, stdout)
+#endif /* _STDIO_H_ */