[BACK]Return to stdio.h CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / include

Annotation of src/include/stdio.h, Revision 1.20

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

CVSweb <webmaster@jp.NetBSD.org>