include/stdio.h

   1 /*      $NetBSD: stdio.h,v 1.69 2007/05/30 21:14:37 tls 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
  50 #include <sys/null.h>
  51
  52 /*
  53  * This is fairly grotesque, but pure ANSI code must not inspect the
  54  * innards of an fpos_t anyway.  The library internally uses off_t,
  55  * which we assume is exactly as big as eight chars.
  56  */
  57 #if (!defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)) || defined(_LIBC)
  58 typedef __off_t fpos_t;
  59 #else
  60 typedef struct __sfpos {
  61         __off_t _pos;
  62 } fpos_t;
  63 #endif
  64
  65 #define _FSTDIO                 /* Define for new stdio with functions. */
  66
  67 /*
  68  * NB: to fit things in six character monocase externals, the stdio
  69  * code uses the prefix `__s' for stdio objects, typically followed
  70  * by a three-character attempt at a mnemonic.
  71  */
  72
  73 /* stdio buffers */
  74 struct __sbuf {
  75         unsigned char *_base;
  76         int     _size;
  77 };
  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         unsigned 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         /* file extension */
 122         struct  __sbuf _ext;
 123
 124         /* separate buffer for long sequences of ungetc() */
 125         unsigned char *_up;     /* saved _p when _p is doing ungetc data */
 126         int     _ur;            /* saved _r when _r is counting ungetc data */
 127
 128         /* tricks to meet minimum requirements even when malloc() fails */
 129         unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
 130         unsigned char _nbuf[1]; /* guarantee a getc() buffer */
 131
 132         /* separate buffer for fgetln() when line crosses buffer boundary */
 133         struct  __sbuf _lb;     /* buffer for fgetln() */
 134
 135         /* Unix stdio files get aligned to block boundaries on fseek() */
 136         int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
 137         fpos_t  _offset;        /* current lseek offset */
 138 } FILE;
 139
 140 __BEGIN_DECLS
 141 extern FILE __sF[];
 142 __END_DECLS
 143
 144 #define __SLBF  0x0001          /* line buffered */
 145 #define __SNBF  0x0002          /* unbuffered */
 146 #define __SRD   0x0004          /* OK to read */
 147 #define __SWR   0x0008          /* OK to write */
 148         /* RD and WR are never simultaneously asserted */
 149 #define __SRW   0x0010          /* open for reading & writing */
 150 #define __SEOF  0x0020          /* found EOF */
 151 #define __SERR  0x0040          /* found error */
 152 #define __SMBF  0x0080          /* _buf is from malloc */
 153 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 154 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 155 #define __SOPT  0x0400          /* do fseek() optimization */
 156 #define __SNPT  0x0800          /* do not do fseek() optimization */
 157 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 158 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 159 #define __SALC  0x4000          /* allocate string space dynamically */
 160
 161 /*
 162  * The following three definitions are for ANSI C, which took them
 163  * from System V, which brilliantly took internal interface macros and
 164  * made them official arguments to setvbuf(), without renaming them.
 165  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 166  *
 167  * Although numbered as their counterparts above, the implementation
 168  * does not rely on this.
 169  */
 170 #define _IOFBF  0               /* setvbuf should set fully buffered */
 171 #define _IOLBF  1               /* setvbuf should set line buffered */
 172 #define _IONBF  2               /* setvbuf should set unbuffered */
 173
 174 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 175 #define EOF     (-1)
 176
 177 /*
 178  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 179  * stdio can provide without attempting to allocate further resources
 180  * (which could fail).  Do not use this for anything.
 181  */
 182                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 183 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 184 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 185
 186 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 187 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
 188 #define P_tmpdir        "/var/tmp/"
 189 #endif
 190 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 191 /* Always ensure that this is consistent with <limits.h> */
 192 #ifndef TMP_MAX
 193 #define TMP_MAX                 308915776       /* Legacy */
 194 #endif
 195
 196 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */
 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      fgetpos(FILE * __restrict, fpos_t * __restrict);
 222 char    *fgets(char * __restrict, int, FILE * __restrict);
 223 FILE    *fopen(const char * __restrict , const char * __restrict);
 224 int      fprintf(FILE * __restrict , const char * __restrict, ...);
 225 int      fputc(int, FILE *);
 226 int      fputs(const char * __restrict, FILE * __restrict);
 227 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
 228 FILE    *freopen(const char * __restrict, const char * __restrict,
 229             FILE * __restrict);
 230 int      fscanf(FILE * __restrict, const char * __restrict, ...);
 231 int      fseek(FILE *, long, int);
 232 int      fsetpos(FILE *, const fpos_t *);
 233 long     ftell(FILE *);
 234 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
 235 int      getc(FILE *);
 236 int      getchar(void);
 237 void     perror(const char *);
 238 int      printf(const char * __restrict, ...);
 239 int      putc(int, FILE *);
 240 int      putchar(int);
 241 int      puts(const char *);
 242 int      remove(const char *);
 243 void     rewind(FILE *);
 244 int      scanf(const char * __restrict, ...);
 245 void     setbuf(FILE * __restrict, char * __restrict);
 246 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
 247 int      sscanf(const char * __restrict, const char * __restrict, ...);
 248 FILE    *tmpfile(void);
 249 int      ungetc(int, FILE *);
 250 int      vfprintf(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_);
 251 int      vprintf(const char * __restrict, _BSD_VA_LIST_);
 252
 253 #ifndef __AUDIT__
 254 char    *gets(char *);
 255 int      sprintf(char * __restrict, const char * __restrict, ...);
 256 char    *tmpnam(char *);
 257 int      vsprintf(char * __restrict, const char * __restrict,
 258             _BSD_VA_LIST_);
 259 #endif
 260
 261 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE)
 262 int      rename (const char *, const char *) __RENAME(__posix_rename);
 263 #else
 264 int      rename (const char *, const char *);
 265 #endif
 266 __END_DECLS
 267
 268 /*
 269  * IEEE Std 1003.1-90
 270  */
 271 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \
 272     defined(_NETBSD_SOURCE)
 273 #define L_ctermid       1024    /* size for ctermid(); PATH_MAX */
 274 #define L_cuserid       9       /* size for cuserid(); UT_NAMESIZE + 1 */
 275
 276 __BEGIN_DECLS
 277 char    *ctermid(char *);
 278 #ifndef __CUSERID_DECLARED
 279 #define __CUSERID_DECLARED
 280 /* also declared in unistd.h */
 281 char    *cuserid(char *);
 282 #endif /* __CUSERID_DECLARED */
 283 FILE    *fdopen(int, const char *);
 284 int      fileno(FILE *);
 285 __END_DECLS
 286 #endif /* not ANSI */
 287
 288 /*
 289  * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2
 290  */
 291 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \
 292     defined(_REENTRANT) || defined(_NETBSD_SOURCE)
 293 __BEGIN_DECLS
 294 void    flockfile(FILE *);
 295 int     ftrylockfile(FILE *);
 296 void    funlockfile(FILE *);
 297 int     getc_unlocked(FILE *);
 298 int     getchar_unlocked(void);
 299 int     putc_unlocked(int, FILE *);
 300 int     putchar_unlocked(int);
 301 __END_DECLS
 302 #endif /* _POSIX_C_SOURCE >= 1995056 || _XOPEN_SOURCE >= 500 || ... */
 303
 304 /*
 305  * Functions defined in POSIX 1003.2 and XPG2 or later.
 306  */
 307 #if (_POSIX_C_SOURCE - 0) >= 2 || (_XOPEN_SOURCE - 0) >= 2 || \
 308     defined(_NETBSD_SOURCE)
 309 __BEGIN_DECLS
 310 int      pclose(FILE *);
 311 FILE    *popen(const char *, const char *);
 312 __END_DECLS
 313 #endif
 314
 315 /*
 316  * Functions defined in ISO XPG4.2, ISO C99, POSIX 1003.1-2001 or later.
 317  */
 318 #if ((__STDC_VERSION__ - 0) >= 199901L) || \
 319     ((_POSIX_C_SOURCE - 0) >= 200112L) || \
 320     (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \
 321     ((_XOPEN_SOURCE - 0) >= 500) || \
 322     defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE)
 323 __BEGIN_DECLS
 324 int      snprintf(char * __restrict, size_t, const char * __restrict, ...)
 325             __attribute__((__format__(__printf__, 3, 4)));
 326 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 327             _BSD_VA_LIST_)
 328             __attribute__((__format__(__printf__, 3, 0)));
 329 __END_DECLS
 330 #endif
 331
 332 /*
 333  * Functions defined in XPG4.2.
 334  */
 335 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
 336 __BEGIN_DECLS
 337 int      getw(FILE *);
 338 int      putw(int, FILE *);
 339
 340 #ifndef __AUDIT__
 341 char    *tempnam(const char *, const char *);
 342 #endif
 343 __END_DECLS
 344 #endif
 345
 346 /*
 347  * X/Open CAE Specification Issue 5 Version 2
 348  */
 349 #if (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) || \
 350     defined(_NETBSD_SOURCE)
 351 #ifndef off_t
 352 typedef __off_t         off_t;
 353 #define off_t           __off_t
 354 #endif /* off_t */
 355
 356 __BEGIN_DECLS
 357 int      fseeko(FILE *, off_t, int);
 358 off_t    ftello(FILE *);
 359 __END_DECLS
 360 #endif /* _XOPEN_SOURCE >= 500 || _LARGEFILE_SOURCE || _NETBSD_SOURCE */
 361
 362 /*
 363  * Routines that are purely local.
 364  */
 365 #if defined(_NETBSD_SOURCE)
 366
 367 #define FPARSELN_UNESCESC       0x01
 368 #define FPARSELN_UNESCCONT      0x02
 369 #define FPARSELN_UNESCCOMM      0x04
 370 #define FPARSELN_UNESCREST      0x08
 371 #define FPARSELN_UNESCALL       0x0f
 372
 373 __BEGIN_DECLS
 374 int      asprintf(char ** __restrict, const char * __restrict, ...)
 375             __attribute__((__format__(__printf__, 2, 3)));
 376 char    *fgetln(FILE * __restrict, size_t * __restrict);
 377 char    *fparseln(FILE *, size_t *, size_t *, const char[3], int);
 378 int      fpurge(FILE *);
 379 void     setbuffer(FILE *, char *, int);
 380 int      setlinebuf(FILE *);
 381 int      vasprintf(char ** __restrict, const char * __restrict,
 382             _BSD_VA_LIST_)
 383             __attribute__((__format__(__printf__, 2, 0)));
 384 int      vscanf(const char * __restrict, _BSD_VA_LIST_)
 385             __attribute__((__format__(__scanf__, 1, 0)));
 386 int      vfscanf(FILE * __restrict, const char * __restrict,
 387             _BSD_VA_LIST_)
 388             __attribute__((__format__(__scanf__, 2, 0)));
 389 int      vsscanf(const char * __restrict, const char * __restrict,
 390             _BSD_VA_LIST_)
 391             __attribute__((__format__(__scanf__, 2, 0)));
 392 const char *fmtcheck(const char *, const char *)
 393             __attribute__((__format_arg__(2)));
 394 __END_DECLS
 395
 396 /*
 397  * Stdio function-access interface.
 398  */
 399 __BEGIN_DECLS
 400 FILE    *funopen(const void *,
 401                 int (*)(void *, char *, int),
 402                 int (*)(void *, const char *, int),
 403                 fpos_t (*)(void *, fpos_t, int),
 404                 int (*)(void *));
 405 __END_DECLS
 406 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 407 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 408 #endif /* _NETBSD_SOURCE */
 409
 410 /*
 411  * Functions internal to the implementation.
 412  */
 413 __BEGIN_DECLS
 414 int     __srget(FILE *);
 415 int     __swbuf(int, FILE *);
 416 __END_DECLS
 417
 418 /*
 419  * The __sfoo macros are here so that we can
 420  * define function versions in the C library.
 421  */
 422 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
 423 #if defined(__GNUC__) && defined(__STDC__)
 424 static __inline int __sputc(int _c, FILE *_p) {
 425         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
 426                 return (*_p->_p++ = _c);
 427         else
 428                 return (__swbuf(_c, _p));
 429 }
 430 #else
 431 /*
 432  * This has been tuned to generate reasonable code on the vax using pcc.
 433  */
 434 #define __sputc(c, p) \
 435         (--(p)->_w < 0 ? \
 436                 (p)->_w >= (p)->_lbfsize ? \
 437                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
 438                                 (int)*(p)->_p++ : \
 439                                 __swbuf('\n', p) : \
 440                         __swbuf((int)(c), p) : \
 441                 (*(p)->_p = (c), (int)*(p)->_p++))
 442 #endif
 443
 444 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
 445 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
 446 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
 447 #define __sfileno(p)    ((p)->_file)
 448
 449 #ifndef __lint__
 450 #if !defined(_REENTRANT) && !defined(_PTHREADS)
 451 #define feof(p)         __sfeof(p)
 452 #define ferror(p)       __sferror(p)
 453 #define clearerr(p)     __sclearerr(p)
 454
 455 #define getc(fp)        __sgetc(fp)
 456 #define putc(x, fp)     __sputc(x, fp)
 457 #endif /* !_REENTRANT && !_PTHREADS */
 458 #endif /* __lint__ */
 459
 460 #define getchar()       getc(stdin)
 461 #define putchar(x)      putc(x, stdout)
 462
 463 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \
 464     defined(_NETBSD_SOURCE)
 465 #if !defined(_REENTRANT) && !defined(_PTHREADS)
 466 #define fileno(p)       __sfileno(p)
 467 #endif /* !_REENTRANT && !_PTHREADS */
 468 #endif /* !_ANSI_SOURCE */
 469
 470 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \
 471     defined(_REENTRANT) || defined(_NETBSD_SOURCE)
 472 #define getc_unlocked(fp)       __sgetc(fp)
 473 #define putc_unlocked(x, fp)    __sputc(x, fp)
 474
 475 #define getchar_unlocked()      getc_unlocked(stdin)
 476 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 477 #endif /* _POSIX_C_SOURCE >= 199506 || _XOPEN_SOURCE >= 500 || _REENTRANT... */
 478
 479 #if _FORTIFY_SOURCE > 0
 480 #include <ssp/stdio.h>
 481 #endif
 482
 483 #endif /* _STDIO_H_ */