Return to stdio.h CVS log

Up to [Apple Darwin 0.x] / kernel / bsd / include

Annotation of kernel/bsd/include/stdio.h, revision 1.1

1.1     ! root        1: /*
        !             2:  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
        !             3:  *
        !             4:  * @APPLE_LICENSE_HEADER_START@
        !             5:  * 
        !             6:  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
        !             7:  * Reserved.  This file contains Original Code and/or Modifications of
        !             8:  * Original Code as defined in and that are subject to the Apple Public
        !             9:  * Source License Version 1.1 (the "License").  You may not use this file
        !            10:  * except in compliance with the License.  Please obtain a copy of the
        !            11:  * License at http://www.apple.com/publicsource and read it before using
        !            12:  * this file.
        !            13:  * 
        !            14:  * The Original Code and all software distributed under the License are
        !            15:  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
        !            16:  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
        !            17:  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
        !            18:  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
        !            19:  * License for the specific language governing rights and limitations
        !            20:  * under the License.
        !            21:  * 
        !            22:  * @APPLE_LICENSE_HEADER_END@
        !            23:  */
        !            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: 
        !           194: /*
        !           195:  * The following three definitions are for ANSI C, which took them
        !           196:  * from System V, which brilliantly took internal interface macros and
        !           197:  * made them official arguments to setvbuf(), without renaming them.
        !           198:  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
        !           199:  *
        !           200:  * Although numbered as their counterparts above, the implementation
        !           201:  * does not rely on this.
        !           202:  */
        !           203: #define        _IOFBF  0               /* setvbuf should set fully buffered */
        !           204: #define        _IOLBF  1               /* setvbuf should set line buffered */
        !           205: #define        _IONBF  2               /* setvbuf should set unbuffered */
        !           206: 
        !           207: #define        BUFSIZ  1024            /* size of buffer used by setbuf */
        !           208: #define        EOF     (-1)
        !           209: 
        !           210: /*
        !           211:  * FOPEN_MAX is a minimum maximum, and is the number of streams that
        !           212:  * stdio can provide without attempting to allocate further resources
        !           213:  * (which could fail).  Do not use this for anything.
        !           214:  */
        !           215:                                /* must be == _POSIX_STREAM_MAX <limits.h> */
        !           216: #define        FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
        !           217: #define        FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
        !           218: 
        !           219: /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
        !           220: #ifndef _ANSI_SOURCE
        !           221: #define        P_tmpdir        "/var/tmp/"
        !           222: #endif
        !           223: #define        L_tmpnam        1024    /* XXX must be == PATH_MAX */
        !           224: #define        TMP_MAX         308915776
        !           225: 
        !           226: #ifndef SEEK_SET
        !           227: #define        SEEK_SET        0       /* set file offset to offset */
        !           228: #endif
        !           229: #ifndef SEEK_CUR
        !           230: #define        SEEK_CUR        1       /* set file offset to current plus offset */
        !           231: #endif
        !           232: #ifndef SEEK_END
        !           233: #define        SEEK_END        2       /* set file offset to EOF plus offset */
        !           234: #endif
        !           235: 
        !           236: #define        stdin   (&__sF[0])
        !           237: #define        stdout  (&__sF[1])
        !           238: #define        stderr  (&__sF[2])
        !           239: 
        !           240: /*
        !           241:  * Functions defined in ANSI C standard.
        !           242:  */
        !           243: __BEGIN_DECLS
        !           244: void    clearerr __P((FILE *));
        !           245: int     fclose __P((FILE *));
        !           246: int     feof __P((FILE *));
        !           247: int     ferror __P((FILE *));
        !           248: int     fflush __P((FILE *));
        !           249: int     fgetc __P((FILE *));
        !           250: int     fgetpos __P((FILE *, fpos_t *));
        !           251: char   *fgets __P((char *, size_t, FILE *));
        !           252: FILE   *fopen __P((const char *, const char *));
        !           253: int     fprintf __P((FILE *, const char *, ...));
        !           254: int     fputc __P((int, FILE *));
        !           255: int     fputs __P((const char *, FILE *));
        !           256: size_t  fread __P((void *, size_t, size_t, FILE *));
        !           257: FILE   *freopen __P((const char *, const char *, FILE *));
        !           258: int     fscanf __P((FILE *, const char *, ...));
        !           259: int     fseek __P((FILE *, long, int));
        !           260: int     fsetpos __P((FILE *, const fpos_t *));
        !           261: long    ftell __P((const FILE *));
        !           262: size_t  fwrite __P((const void *, size_t, size_t, FILE *));
        !           263: int     getc __P((FILE *));
        !           264: int     getchar __P((void));
        !           265: char   *gets __P((char *));
        !           266: #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
        !           267: extern int sys_nerr;                   /* perror(3) external variables */
        !           268: extern __const char *__const sys_errlist[];
        !           269: #endif
        !           270: void    perror __P((const char *));
        !           271: int     printf __P((const char *, ...));
        !           272: int     putc __P((int, FILE *));
        !           273: int     putchar __P((int));
        !           274: int     puts __P((const char *));
        !           275: int     remove __P((const char *));
        !           276: int     rename  __P((const char *, const char *));
        !           277: void    rewind __P((FILE *));
        !           278: int     scanf __P((const char *, ...));
        !           279: void    setbuf __P((FILE *, char *));
        !           280: int     setvbuf __P((FILE *, char *, int, size_t));
        !           281: int     sprintf __P((char *, const char *, ...));
        !           282: int     sscanf __P((const char *, const char *, ...));
        !           283: FILE   *tmpfile __P((void));
        !           284: char   *tmpnam __P((char *));
        !           285: int     ungetc __P((int, FILE *));
        !           286: int     vfprintf __P((FILE *, const char *, _BSD_VA_LIST_));
        !           287: int     vprintf __P((const char *, _BSD_VA_LIST_));
        !           288: int     vsprintf __P((char *, const char *, _BSD_VA_LIST_));
        !           289: __END_DECLS
        !           290: 
        !           291: /*
        !           292:  * Functions defined in POSIX 1003.1.
        !           293:  */
        !           294: #ifndef _ANSI_SOURCE
        !           295: #define        L_cuserid       9       /* size for cuserid(); UT_NAMESIZE + 1 */
        !           296: #define        L_ctermid       1024    /* size for ctermid(); PATH_MAX */
        !           297: 
        !           298: __BEGIN_DECLS
        !           299: char   *ctermid __P((char *));
        !           300: FILE   *fdopen __P((int, const char *));
        !           301: int     fileno __P((FILE *));
        !           302: __END_DECLS
        !           303: #endif /* not ANSI */
        !           304: 
        !           305: /*
        !           306:  * Routines that are purely local.
        !           307:  */
        !           308: #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
        !           309: __BEGIN_DECLS
        !           310: char   *fgetln __P((FILE *, size_t *));
        !           311: int     fpurge __P((FILE *));
        !           312: int     getw __P((FILE *));
        !           313: int     pclose __P((FILE *));
        !           314: FILE   *popen __P((const char *, const char *));
        !           315: int     putw __P((int, FILE *));
        !           316: void    setbuffer __P((FILE *, char *, int));
        !           317: int     setlinebuf __P((FILE *));
        !           318: char   *tempnam __P((const char *, const char *));
        !           319: int     snprintf __P((char *, size_t, const char *, ...));
        !           320: int     vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_));
        !           321: int     vscanf __P((const char *, _BSD_VA_LIST_));
        !           322: int     vsscanf __P((const char *, const char *, _BSD_VA_LIST_));
        !           323: FILE   *zopen __P((const char *, const char *, int));
        !           324: __END_DECLS
        !           325: 
        !           326: /*
        !           327:  * This is a #define because the function is used internally and
        !           328:  * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
        !           329:  * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
        !           330:  */
        !           331: #define         vfscanf        __svfscanf
        !           332: 
        !           333: /*
        !           334:  * Stdio function-access interface.
        !           335:  */
        !           336: __BEGIN_DECLS
        !           337: FILE   *funopen __P((const void *,
        !           338:                int (*)(void *, char *, int),
        !           339:                int (*)(void *, const char *, int),
        !           340:                fpos_t (*)(void *, fpos_t, int),
        !           341:                int (*)(void *)));
        !           342: __END_DECLS
        !           343: #define        fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
        !           344: #define        fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
        !           345: #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
        !           346: 
        !           347: /*
        !           348:  * Functions internal to the implementation.
        !           349:  */
        !           350: __BEGIN_DECLS
        !           351: int    __srget __P((FILE *));
        !           352: int    __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_));
        !           353: int    __swbuf __P((int, FILE *));
        !           354: __END_DECLS
        !           355: 
        !           356: /*
        !           357:  * The __sfoo macros are here so that we can 
        !           358:  * define function versions in the C library.
        !           359:  */
        !           360: #define        __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
        !           361: #if defined(__GNUC__) && defined(__STDC__)
        !           362: static __inline int __sputc(int _c, FILE *_p) {
        !           363:        if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
        !           364:                return (*_p->_p++ = _c);
        !           365:        else
        !           366:                return (__swbuf(_c, _p));
        !           367: }
        !           368: #else
        !           369: /*
        !           370:  * This has been tuned to generate reasonable code on the vax using pcc.
        !           371:  */
        !           372: #define        __sputc(c, p) \
        !           373:        (--(p)->_w < 0 ? \
        !           374:                (p)->_w >= (p)->_lbfsize ? \
        !           375:                        (*(p)->_p = (c)), *(p)->_p != '\n' ? \
        !           376:                                (int)*(p)->_p++ : \
        !           377:                                __swbuf('\n', p) : \
        !           378:                        __swbuf((int)(c), p) : \
        !           379:                (*(p)->_p = (c), (int)*(p)->_p++))
        !           380: #endif
        !           381: 
        !           382: #define        __sfeof(p)      (((p)->_flags & __SEOF) != 0)
        !           383: #define        __sferror(p)    (((p)->_flags & __SERR) != 0)
        !           384: #define        __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
        !           385: #define        __sfileno(p)    ((p)->_file)
        !           386: 
        !           387: #define        feof(p)         __sfeof(p)
        !           388: #define        ferror(p)       __sferror(p)
        !           389: #define        clearerr(p)     __sclearerr(p)
        !           390: 
        !           391: #ifndef _ANSI_SOURCE
        !           392: #define        fileno(p)       __sfileno(p)
        !           393: #endif
        !           394: 
        !           395: #ifndef lint
        !           396: #define        getc(fp)        __sgetc(fp)
        !           397: #define putc(x, fp)    __sputc(x, fp)
        !           398: #endif /* lint */
        !           399: 
        !           400: #define        getchar()       getc(stdin)
        !           401: #define        putchar(x)      putc(x, stdout)
        !           402: #endif /* _STDIO_H_ */

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.