include/stdio.h

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