gonzui

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