include/stdio.h

   1 /*      $NetBSD: stdio.h,v 1.73 2008/09/21 16:59:46 christos Exp $      */
   2
   3 /*-
   4  * Copyright (c) 1990, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   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. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)stdio.h     8.5 (Berkeley) 4/29/95
  35  */
  36
  37 #ifndef _STDIO_H_
  38 #define _STDIO_H_
  39
  40 #include <sys/cdefs.h>
  41 #include <sys/featuretest.h>
  42 #include <sys/ansi.h>
  43
  44 #include <machine/ansi.h>
  45 #ifdef  _BSD_SIZE_T_
  46 typedef _BSD_SIZE_T_    size_t;
  47 #undef  _BSD_SIZE_T_
  48 #endif
  49 #ifdef  _BSD_SSIZE_T_
  50 typedef _BSD_SSIZE_T_   ssize_t;
  51 #undef  _BSD_SSIZE_T_
  52 #endif
  53
  54 #include <sys/null.h>
  55
  56 /*
  57  * This is fairly grotesque, but pure ANSI code must not inspect the
  58  * innards of an fpos_t anyway.  The library internally uses off_t,
  59  * which we assume is exactly as big as eight chars.
  60  */
  61 #if (!defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)) || defined(_LIBC)
  62 typedef __off_t fpos_t;
  63 #else
  64 typedef struct __sfpos {
  65         __off_t _pos;
  66 } fpos_t;
  67 #endif
  68
  69 #define _FSTDIO                 /* Define for new stdio with functions. */
  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  * NB: see WARNING above before changing the layout of this structure!
 108  */
 109 typedef struct __sFILE {
 110         unsigned char *_p;      /* current position in (some) buffer */
 111         int     _r;             /* read space left for getc() */
 112         int     _w;             /* write space left for putc() */
 113         unsigned short _flags;  /* flags, below; this FILE is free if 0 */
 114         short   _file;          /* fileno, if Unix descriptor, else -1 */
 115         struct  __sbuf _bf;     /* the buffer (at least 1 byte, if !NULL) */
 116         int     _lbfsize;       /* 0 or -_bf._size, for inline putc */
 117
 118         /* operations */
 119         void    *_cookie;       /* cookie passed to io functions */
 120         int     (*_close)(void *);
 121         int     (*_read) (void *, char *, int);
 122         fpos_t  (*_seek) (void *, fpos_t, int);
 123         int     (*_write)(void *, const char *, int);
 124
 125         /* file extension */
 126         struct  __sbuf _ext;
 127
 128         /* separate buffer for long sequences of ungetc() */
 129         unsigned char *_up;     /* saved _p when _p is doing ungetc data */
 130         int     _ur;            /* saved _r when _r is counting ungetc data */
 131
 132         /* tricks to meet minimum requirements even when malloc() fails */
 133         unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
 134         unsigned char _nbuf[1]; /* guarantee a getc() buffer */
 135
 136         /* separate buffer for fgetln() when line crosses buffer boundary */
 137         struct  __sbuf _lb;     /* buffer for fgetln() */
 138
 139         /* Unix stdio files get aligned to block boundaries on fseek() */
 140         int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
 141         fpos_t  _offset;        /* current lseek offset */
 142 } FILE;
 143
 144 __BEGIN_DECLS
 145 extern FILE __sF[];
 146 __END_DECLS
 147
 148 #define __SLBF  0x0001          /* line buffered */
 149 #define __SNBF  0x0002          /* unbuffered */
 150 #define __SRD   0x0004          /* OK to read */
 151 #define __SWR   0x0008          /* OK to write */
 152         /* RD and WR are never simultaneously asserted */
 153 #define __SRW   0x0010          /* open for reading & writing */
 154 #define __SEOF  0x0020          /* found EOF */
 155 #define __SERR  0x0040          /* found error */
 156 #define __SMBF  0x0080          /* _buf is from malloc */
 157 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 158 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 159 #define __SOPT  0x0400          /* do fseek() optimization */
 160 #define __SNPT  0x0800          /* do not do fseek() optimization */
 161 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 162 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 163 #define __SALC  0x4000          /* allocate string space dynamically */
 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 #define EOF     (-1)
 180
 181 /*
 182  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 183  * stdio can provide without attempting to allocate further resources
 184  * (which could fail).  Do not use this for anything.
 185  */
 186                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 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 defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
 192 #define P_tmpdir        "/var/tmp/"
 193 #endif
 194 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 195 /* Always ensure that this is consistent with <limits.h> */
 196 #ifndef TMP_MAX
 197 #define TMP_MAX                 308915776       /* Legacy */
 198 #endif
 199
 200 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */
 201 #ifndef SEEK_SET
 202 #define SEEK_SET        0       /* set file offset to offset */
 203 #endif
 204 #ifndef SEEK_CUR
 205 #define SEEK_CUR        1       /* set file offset to current plus offset */
 206 #endif
 207 #ifndef SEEK_END
 208 #define SEEK_END        2       /* set file offset to EOF plus offset */
 209 #endif
 210
 211 #define stdin   (&__sF[0])
 212 #define stdout  (&__sF[1])
 213 #define stderr  (&__sF[2])
 214
 215 /*
 216  * Functions defined in ANSI C standard.
 217  */
 218 __BEGIN_DECLS
 219 void     clearerr(FILE *);
 220 int      fclose(FILE *);
 221 int      feof(FILE *);
 222 int      ferror(FILE *);
 223 int      fflush(FILE *);
 224 int      fgetc(FILE *);
 225 int      fgetpos(FILE * __restrict, fpos_t * __restrict);
 226 char    *fgets(char * __restrict, int, FILE * __restrict);
 227 FILE    *fopen(const char * __restrict , const char * __restrict);
 228 int      fprintf(FILE * __restrict , const char * __restrict, ...)
 229     __attribute__((__format__(__printf__, 2, 3)));
 230 int      fputc(int, FILE *);
 231 int      fputs(const char * __restrict, FILE * __restrict);
 232 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
 233 FILE    *freopen(const char * __restrict, const char * __restrict,
 234             FILE * __restrict);
 235 int      fscanf(FILE * __restrict, const char * __restrict, ...)
 236     __attribute__((__format__(__scanf__, 2, 3)));
 237 int      fseek(FILE *, long, int);
 238 int      fsetpos(FILE *, const fpos_t *);
 239 long     ftell(FILE *);
 240 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
 241 int      getc(FILE *);
 242 int      getchar(void);
 243 ssize_t  getdelim(char ** __restrict, size_t * __restrict, int,
 244             FILE * __restrict);
 245 ssize_t  getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
 246 void     perror(const char *);
 247 int      printf(const char * __restrict, ...)
 248     __attribute__((__format__(__printf__, 1, 2)));
 249 int      putc(int, FILE *);
 250 int      putchar(int);
 251 int      puts(const char *);
 252 int      remove(const char *);
 253 void     rewind(FILE *);
 254 int      scanf(const char * __restrict, ...)
 255     __attribute__((__format__(__scanf__, 1, 2)));
 256 void     setbuf(FILE * __restrict, char * __restrict);
 257 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
 258 int      sscanf(const char * __restrict, const char * __restrict, ...)
 259     __attribute__((__format__(__scanf__, 2, 3)));
 260 FILE    *tmpfile(void);
 261 int      ungetc(int, FILE *);
 262 int      vfprintf(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_)
 263     __attribute__((__format__(__printf__, 2, 0)));
 264 int      vprintf(const char * __restrict, _BSD_VA_LIST_)
 265     __attribute__((__format__(__printf__, 1, 0)));
 266
 267 #ifndef __AUDIT__
 268 char    *gets(char *);
 269 int      sprintf(char * __restrict, const char * __restrict, ...)
 270     __attribute__((__format__(__printf__, 2, 3)));
 271 char    *tmpnam(char *);
 272 int      vsprintf(char * __restrict, const char * __restrict,
 273     _BSD_VA_LIST_)
 274     __attribute__((__format__(__printf__, 2, 0)));
 275 #endif
 276
 277 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE)
 278 int      rename (const char *, const char *) __RENAME(__posix_rename);
 279 #else
 280 int      rename (const char *, const char *);
 281 #endif
 282 __END_DECLS
 283
 284 /*
 285  * IEEE Std 1003.1-90
 286  */
 287 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \
 288     defined(_NETBSD_SOURCE)
 289 #define L_ctermid       1024    /* size for ctermid(); PATH_MAX */
 290 #define L_cuserid       9       /* size for cuserid(); UT_NAMESIZE + 1 */
 291
 292 __BEGIN_DECLS
 293 char    *ctermid(char *);
 294 #ifndef __CUSERID_DECLARED
 295 #define __CUSERID_DECLARED
 296 /* also declared in unistd.h */
 297 char    *cuserid(char *);
 298 #endif /* __CUSERID_DECLARED */
 299 FILE    *fdopen(int, const char *);
 300 int      fileno(FILE *);
 301 __END_DECLS
 302 #endif /* not ANSI */
 303
 304 /*
 305  * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2
 306  */
 307 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \
 308     defined(_REENTRANT) || defined(_NETBSD_SOURCE)
 309 __BEGIN_DECLS
 310 void    flockfile(FILE *);
 311 int     ftrylockfile(FILE *);
 312 void    funlockfile(FILE *);
 313 int     getc_unlocked(FILE *);
 314 int     getchar_unlocked(void);
 315 int     putc_unlocked(int, FILE *);
 316 int     putchar_unlocked(int);
 317 __END_DECLS
 318 #endif /* _POSIX_C_SOURCE >= 1995056 || _XOPEN_SOURCE >= 500 || ... */
 319
 320 /*
 321  * Functions defined in POSIX 1003.2 and XPG2 or later.
 322  */
 323 #if (_POSIX_C_SOURCE - 0) >= 2 || (_XOPEN_SOURCE - 0) >= 2 || \
 324     defined(_NETBSD_SOURCE)
 325 __BEGIN_DECLS
 326 int      pclose(FILE *);
 327 FILE    *popen(const char *, const char *);
 328 __END_DECLS
 329 #endif
 330
 331 /*
 332  * Functions defined in ISO XPG4.2, ISO C99, POSIX 1003.1-2001 or later.
 333  */
 334 #if ((__STDC_VERSION__ - 0) >= 199901L) || \
 335     ((_POSIX_C_SOURCE - 0) >= 200112L) || \
 336     (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \
 337     ((_XOPEN_SOURCE - 0) >= 500) || \
 338     defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE)
 339 __BEGIN_DECLS
 340 int      snprintf(char * __restrict, size_t, const char * __restrict, ...)
 341     __attribute__((__format__(__printf__, 3, 4)));
 342 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 343             _BSD_VA_LIST_)
 344     __attribute__((__format__(__printf__, 3, 0)));
 345 __END_DECLS
 346 #endif
 347
 348 /*
 349  * Functions defined in XPG4.2.
 350  */
 351 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
 352 __BEGIN_DECLS
 353 int      getw(FILE *);
 354 int      putw(int, FILE *);
 355
 356 #ifndef __AUDIT__
 357 char    *tempnam(const char *, const char *);
 358 #endif
 359 __END_DECLS
 360 #endif
 361
 362 /*
 363  * X/Open CAE Specification Issue 5 Version 2
 364  */
 365 #if (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) || \
 366     defined(_NETBSD_SOURCE)
 367 #ifndef off_t
 368 typedef __off_t         off_t;
 369 #define off_t           __off_t
 370 #endif /* off_t */
 371
 372 __BEGIN_DECLS
 373 int      fseeko(FILE *, off_t, int);
 374 off_t    ftello(FILE *);
 375 __END_DECLS
 376 #endif /* _XOPEN_SOURCE >= 500 || _LARGEFILE_SOURCE || _NETBSD_SOURCE */
 377
 378 /*
 379  * Functions defined in ISO C99.  Still put under _NETBSD_SOURCE due to
 380  * backward compatible.
 381  */
 382 #if defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE)
 383 __BEGIN_DECLS
 384 int      vscanf(const char * __restrict, _BSD_VA_LIST_)
 385     __attribute__((__format__(__scanf__, 1, 0)));
 386 int      vfscanf(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_)
 387     __attribute__((__format__(__scanf__, 2, 0)));
 388 int      vsscanf(const char * __restrict, const char * __restrict,
 389     _BSD_VA_LIST_)
 390     __attribute__((__format__(__scanf__, 2, 0)));
 391 __END_DECLS
 392 #endif /* _ISOC99_SOURCE || _NETBSD_SOURCE */
 393
 394 /*
 395  * Routines that are purely local.
 396  */
 397 #if defined(_NETBSD_SOURCE)
 398
 399 #define FPARSELN_UNESCESC       0x01
 400 #define FPARSELN_UNESCCONT      0x02
 401 #define FPARSELN_UNESCCOMM      0x04
 402 #define FPARSELN_UNESCREST      0x08
 403 #define FPARSELN_UNESCALL       0x0f
 404
 405 __BEGIN_DECLS
 406 int      asprintf(char ** __restrict, const char * __restrict, ...)
 407     __attribute__((__format__(__printf__, 2, 3)));
 408 char    *fgetln(FILE * __restrict, size_t * __restrict);
 409 char    *fparseln(FILE *, size_t *, size_t *, const char[3], int);
 410 int      fpurge(FILE *);
 411 void     setbuffer(FILE *, char *, int);
 412 int      setlinebuf(FILE *);
 413 int      vasprintf(char ** __restrict, const char * __restrict,
 414     _BSD_VA_LIST_)
 415     __attribute__((__format__(__printf__, 2, 0)));
 416 const char *fmtcheck(const char *, const char *)
 417     __attribute__((__format_arg__(2)));
 418 __END_DECLS
 419
 420 /*
 421  * Stdio function-access interface.
 422  */
 423 __BEGIN_DECLS
 424 FILE    *funopen(const void *,
 425                 int (*)(void *, char *, int),
 426                 int (*)(void *, const char *, int),
 427                 fpos_t (*)(void *, fpos_t, int),
 428                 int (*)(void *));
 429 __END_DECLS
 430 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 431 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 432 #endif /* _NETBSD_SOURCE */
 433
 434 /*
 435  * Functions internal to the implementation.
 436  */
 437 __BEGIN_DECLS
 438 int     __srget(FILE *);
 439 int     __swbuf(int, FILE *);
 440 __END_DECLS
 441
 442 /*
 443  * The __sfoo macros are here so that we can
 444  * define function versions in the C library.
 445  */
 446 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
 447 #if defined(__GNUC__) && defined(__STDC__)
 448 static __inline int __sputc(int _c, FILE *_p) {
 449         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
 450                 return (*_p->_p++ = _c);
 451         else
 452                 return (__swbuf(_c, _p));
 453 }
 454 #else
 455 /*
 456  * This has been tuned to generate reasonable code on the vax using pcc.
 457  */
 458 #define __sputc(c, p) \
 459         (--(p)->_w < 0 ? \
 460                 (p)->_w >= (p)->_lbfsize ? \
 461                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
 462                                 (int)*(p)->_p++ : \
 463                                 __swbuf('\n', p) : \
 464                         __swbuf((int)(c), p) : \
 465                 (*(p)->_p = (c), (int)*(p)->_p++))
 466 #endif
 467
 468 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
 469 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
 470 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
 471 #define __sfileno(p)    \
 472     ((p)->_file == -1 ? -1 : (int)(unsigned short)(p)->_file)
 473
 474 #ifndef __lint__
 475 #if !defined(_REENTRANT) && !defined(_PTHREADS)
 476 #define feof(p)         __sfeof(p)
 477 #define ferror(p)       __sferror(p)
 478 #define clearerr(p)     __sclearerr(p)
 479
 480 #define getc(fp)        __sgetc(fp)
 481 #define putc(x, fp)     __sputc(x, fp)
 482 #endif /* !_REENTRANT && !_PTHREADS */
 483 #endif /* __lint__ */
 484
 485 #define getchar()       getc(stdin)
 486 #define putchar(x)      putc(x, stdout)
 487
 488 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \
 489     defined(_NETBSD_SOURCE)
 490 #if !defined(_REENTRANT) && !defined(_PTHREADS)
 491 #define fileno(p)       __sfileno(p)
 492 #endif /* !_REENTRANT && !_PTHREADS */
 493 #endif /* !_ANSI_SOURCE */
 494
 495 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \
 496     defined(_REENTRANT) || defined(_NETBSD_SOURCE)
 497 #define getc_unlocked(fp)       __sgetc(fp)
 498 #define putc_unlocked(x, fp)    __sputc(x, fp)
 499
 500 #define getchar_unlocked()      getc_unlocked(stdin)
 501 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 502 #endif /* _POSIX_C_SOURCE >= 199506 || _XOPEN_SOURCE >= 500 || _REENTRANT... */
 503
 504 #if _FORTIFY_SOURCE > 0
 505 #include <ssp/stdio.h>
 506 #endif
 507
 508 #endif /* _STDIO_H_ */