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

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

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