1/* $NetBSD: stdio.h,v 1.79 2011/07/17 20:54:34 joerg 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#ifdef _BSD_SIZE_T_ 45typedef _BSD_SIZE_T_ size_t; 46#undef _BSD_SIZE_T_ 47#endif 48#ifdef _BSD_SSIZE_T_ 49typedef _BSD_SSIZE_T_ ssize_t; 50#undef _BSD_SSIZE_T_ 51#endif 52 53#if defined(_POSIX_C_SOURCE) 54#ifndef __VA_LIST_DECLARED 55typedef __va_list va_list; 56#define __VA_LIST_DECLARED 57#endif 58#endif 59 60#include <sys/null.h> 61 62/* 63 * This is fairly grotesque, but pure ANSI code must not inspect the 64 * innards of an fpos_t anyway. The library internally uses off_t, 65 * which we assume is exactly as big as eight chars. 66 */ 67typedef struct __sfpos { 68 __off_t _pos; 69 __mbstate_t _mbstate_in, _mbstate_out; 70} fpos_t; 71 72#define _FSTDIO /* Define for new stdio with functions. */ 73 74/* 75 * NB: to fit things in six character monocase externals, the stdio 76 * code uses the prefix `__s' for stdio objects, typically followed 77 * by a three-character attempt at a mnemonic. 78 */ 79 80/* stdio buffers */ 81struct __sbuf { 82 unsigned char *_base; 83 int _size; 84}; 85 86/* 87 * stdio state variables. 88 * 89 * The following always hold: 90 * 91 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 92 * _lbfsize is -_bf._size, else _lbfsize is 0 93 * if _flags&__SRD, _w is 0 94 * if _flags&__SWR, _r is 0 95 * 96 * This ensures that the getc and putc macros (or inline functions) never 97 * try to write or read from a file that is in `read' or `write' mode. 98 * (Moreover, they can, and do, automatically switch from read mode to 99 * write mode, and back, on "r+" and "w+" files.) 100 * 101 * _lbfsize is used only to make the inline line-buffered output stream 102 * code as compact as possible. 103 * 104 * _ub, _up, and _ur are used when ungetc() pushes back more characters 105 * than fit in the current _bf, or when ungetc() pushes back a character 106 * that does not match the previous one in _bf. When this happens, 107 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 108 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 109 * 110 * NB: see WARNING above before changing the layout of this structure! 111 */ 112typedef struct __sFILE { 113 unsigned char *_p; /* current position in (some) buffer */ 114 int _r; /* read space left for getc() */ 115 int _w; /* write space left for putc() */ 116 unsigned short _flags; /* flags, below; this FILE is free if 0 */ 117 short _file; /* fileno, if Unix descriptor, else -1 */ 118 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 119 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 120 121 /* operations */ 122 void *_cookie; /* cookie passed to io functions */ 123 int (*_close)(void *); 124 int (*_read) (void *, char *, int); 125 __off_t (*_seek) (void *, __off_t, int); 126 int (*_write)(void *, const char *, int); 127 128 /* file extension */ 129 struct __sbuf _ext; 130 131 /* separate buffer for long sequences of ungetc() */ 132 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 133 int _ur; /* saved _r when _r is counting ungetc data */ 134 135 /* tricks to meet minimum requirements even when malloc() fails */ 136 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 137 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 138 139 /* Formerly used by fgetln/fgetwln; kept for binary compatibility */ 140 struct __sbuf _lb__unused; 141 142 /* Unix stdio files get aligned to block boundaries on fseek() */ 143 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 144 __off_t _offset; /* current lseek offset */ 145} FILE; 146 147__BEGIN_DECLS 148extern FILE __sF[]; 149__END_DECLS 150 151#define __SLBF 0x0001 /* line buffered */ 152#define __SNBF 0x0002 /* unbuffered */ 153#define __SRD 0x0004 /* OK to read */ 154#define __SWR 0x0008 /* OK to write */ 155 /* RD and WR are never simultaneously asserted */ 156#define __SRW 0x0010 /* open for reading & writing */ 157#define __SEOF 0x0020 /* found EOF */ 158#define __SERR 0x0040 /* found error */ 159#define __SMBF 0x0080 /* _buf is from malloc */ 160#define __SAPP 0x0100 /* fdopen()ed in append mode */ 161#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 162#define __SOPT 0x0400 /* do fseek() optimization */ 163#define __SNPT 0x0800 /* do not do fseek() optimization */ 164#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 165#define __SMOD 0x2000 /* true => fgetln modified _p text */ 166#define __SALC 0x4000 /* allocate string space dynamically */ 167 168/* 169 * The following three definitions are for ANSI C, which took them 170 * from System V, which brilliantly took internal interface macros and 171 * made them official arguments to setvbuf(), without renaming them. 172 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 173 * 174 * Although numbered as their counterparts above, the implementation 175 * does not rely on this. 176 */ 177#define _IOFBF 0 /* setvbuf should set fully buffered */ 178#define _IOLBF 1 /* setvbuf should set line buffered */ 179#define _IONBF 2 /* setvbuf should set unbuffered */ 180 181#define BUFSIZ 1024 /* size of buffer used by setbuf */ 182#define EOF (-1) 183 184/* 185 * FOPEN_MAX is a minimum maximum, and is the number of streams that 186 * stdio can provide without attempting to allocate further resources 187 * (which could fail). Do not use this for anything. 188 */ 189 /* must be == _POSIX_STREAM_MAX <limits.h> */ 190#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 191#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 192 193/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 194#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 195#define P_tmpdir "/var/tmp/" 196#endif 197#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 198/* Always ensure that this is consistent with <limits.h> */ 199#ifndef TMP_MAX 200#define TMP_MAX 308915776 /* Legacy */ 201#endif 202 203/* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 204#ifndef SEEK_SET 205#define SEEK_SET 0 /* set file offset to offset */ 206#endif 207#ifndef SEEK_CUR 208#define SEEK_CUR 1 /* set file offset to current plus offset */ 209#endif 210#ifndef SEEK_END 211#define SEEK_END 2 /* set file offset to EOF plus offset */ 212#endif 213 214#define stdin (&__sF[0]) 215#define stdout (&__sF[1]) 216#define stderr (&__sF[2]) 217 218/* 219 * Functions defined in ANSI C standard. 220 */ 221__BEGIN_DECLS 222void clearerr(FILE *); 223int fclose(FILE *); 224int feof(FILE *); 225int ferror(FILE *); 226int fflush(FILE *); 227int fgetc(FILE *); 228char *fgets(char * __restrict, int, FILE * __restrict); 229FILE *fopen(const char * __restrict , const char * __restrict); 230int fprintf(FILE * __restrict , const char * __restrict, ...) 231 __printflike(2, 3); 232int fputc(int, FILE *); 233int fputs(const char * __restrict, FILE * __restrict); 234size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 235FILE *freopen(const char * __restrict, const char * __restrict, 236 FILE * __restrict); 237int fscanf(FILE * __restrict, const char * __restrict, ...) 238 __scanflike(2, 3); 239int fseek(FILE *, long, int); 240long ftell(FILE *); 241size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 242int getc(FILE *); 243int getchar(void); 244ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 245 FILE * __restrict); 246ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict); 247void perror(const char *); 248int printf(const char * __restrict, ...) 249 __printflike(1, 2); 250int putc(int, FILE *); 251int putchar(int); 252int puts(const char *); 253int remove(const char *); 254void rewind(FILE *); 255int scanf(const char * __restrict, ...) 256 __scanflike(1, 2); 257void setbuf(FILE * __restrict, char * __restrict); 258int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 259int sscanf(const char * __restrict, const char * __restrict, ...) 260 __scanflike(2, 3); 261FILE *tmpfile(void); 262int ungetc(int, FILE *); 263int vfprintf(FILE * __restrict, const char * __restrict, __va_list) 264 __printflike(2, 0); 265int vprintf(const char * __restrict, __va_list) 266 __printflike(1, 0); 267 268#ifndef __AUDIT__ 269char *gets(char *); 270int sprintf(char * __restrict, const char * __restrict, ...) 271 __printflike(2, 3); 272char *tmpnam(char *); 273int vsprintf(char * __restrict, const char * __restrict, 274 __va_list) 275 __printflike(2, 0); 276#endif 277 278#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 279int rename (const char *, const char *) __RENAME(__posix_rename); 280#else 281int rename (const char *, const char *); 282#endif 283__END_DECLS 284 285#ifndef __LIBC12_SOURCE__ 286int fgetpos(FILE * __restrict, fpos_t * __restrict) __RENAME(__fgetpos50); 287int fsetpos(FILE *, const fpos_t *) __RENAME(__fsetpos50); 288#endif 289/* 290 * IEEE Std 1003.1-90 291 */ 292#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 293 defined(_NETBSD_SOURCE) 294#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 295#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 296 297__BEGIN_DECLS 298char *ctermid(char *); 299#ifndef __CUSERID_DECLARED 300#define __CUSERID_DECLARED 301/* also declared in unistd.h */ 302char *cuserid(char *); 303#endif /* __CUSERID_DECLARED */ 304FILE *fdopen(int, const char *); 305int fileno(FILE *); 306__END_DECLS 307#endif /* not ANSI */ 308 309/* 310 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 311 */ 312#if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 313 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 314__BEGIN_DECLS 315void flockfile(FILE *); 316int ftrylockfile(FILE *); 317void funlockfile(FILE *); 318int getc_unlocked(FILE *); 319int getchar_unlocked(void); 320int putc_unlocked(int, FILE *); 321int putchar_unlocked(int); 322__END_DECLS 323#endif /* _POSIX_C_SOURCE >= 1995056 || _XOPEN_SOURCE >= 500 || ... */ 324 325/* 326 * Functions defined in POSIX 1003.2 and XPG2 or later. 327 */ 328#if (_POSIX_C_SOURCE - 0) >= 2 || (_XOPEN_SOURCE - 0) >= 2 || \ 329 defined(_NETBSD_SOURCE) 330__BEGIN_DECLS 331int pclose(FILE *); 332FILE *popen(const char *, const char *); 333__END_DECLS 334#endif 335 336/* 337 * Functions defined in ISO XPG4.2, ISO C99, POSIX 1003.1-2001 or later. 338 */ 339#if ((__STDC_VERSION__ - 0) >= 199901L) || \ 340 ((_POSIX_C_SOURCE - 0) >= 200112L) || \ 341 (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \ 342 ((_XOPEN_SOURCE - 0) >= 500) || \ 343 defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE) 344__BEGIN_DECLS 345int snprintf(char * __restrict, size_t, const char * __restrict, ...) 346 __printflike(3, 4); 347int vsnprintf(char * __restrict, size_t, const char * __restrict, 348 __va_list) 349 __printflike(3, 0); 350__END_DECLS 351#endif 352 353/* 354 * Functions defined in XPG4.2. 355 */ 356#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 357__BEGIN_DECLS 358int getw(FILE *); 359int putw(int, FILE *); 360 361#ifndef __AUDIT__ 362char *tempnam(const char *, const char *); 363#endif 364__END_DECLS 365#endif 366 367/* 368 * X/Open CAE Specification Issue 5 Version 2 369 */ 370#if (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) || \ 371 defined(_NETBSD_SOURCE) 372#ifndef off_t 373typedef __off_t off_t; 374#define off_t __off_t 375#endif /* off_t */ 376 377__BEGIN_DECLS 378int fseeko(FILE *, off_t, int); 379off_t ftello(FILE *); 380__END_DECLS 381#endif /* _XOPEN_SOURCE >= 500 || _LARGEFILE_SOURCE || _NETBSD_SOURCE */ 382 383/* 384 * Functions defined in ISO C99. Still put under _NETBSD_SOURCE due to 385 * backward compatible. 386 */ 387#if defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE) 388__BEGIN_DECLS 389int vscanf(const char * __restrict, __va_list) 390 __scanflike(1, 0); 391int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 392 __scanflike(2, 0); 393int vsscanf(const char * __restrict, const char * __restrict, 394 __va_list) 395 __scanflike(2, 0); 396__END_DECLS 397#endif /* _ISOC99_SOURCE || _NETBSD_SOURCE */ 398 399/* 400 * Routines that are purely local. 401 */ 402#if defined(_NETBSD_SOURCE) 403 404#define FPARSELN_UNESCESC 0x01 405#define FPARSELN_UNESCCONT 0x02 406#define FPARSELN_UNESCCOMM 0x04 407#define FPARSELN_UNESCREST 0x08 408#define FPARSELN_UNESCALL 0x0f 409 410__BEGIN_DECLS 411int asprintf(char ** __restrict, const char * __restrict, ...) 412 __printflike(2, 3); 413char *fgetln(FILE * __restrict, size_t * __restrict); 414char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 415int fpurge(FILE *); 416void setbuffer(FILE *, char *, int); 417int setlinebuf(FILE *); 418int vasprintf(char ** __restrict, const char * __restrict, 419 __va_list) 420 __printflike(2, 0); 421const char *fmtcheck(const char *, const char *) 422 __format_arg(2); 423__END_DECLS 424 425/* 426 * Stdio function-access interface. 427 */ 428__BEGIN_DECLS 429FILE *funopen(const void *, 430 int (*)(void *, char *, int), 431 int (*)(void *, const char *, int), 432 off_t (*)(void *, off_t, int), 433 int (*)(void *)); 434__END_DECLS 435#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 436#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 437#endif /* _NETBSD_SOURCE */ 438 439/* 440 * Functions internal to the implementation. 441 */ 442__BEGIN_DECLS 443int __srget(FILE *); 444int __swbuf(int, FILE *); 445__END_DECLS 446 447/* 448 * The __sfoo macros are here so that we can 449 * define function versions in the C library. 450 */ 451#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 452#if defined(__GNUC__) && defined(__STDC__) 453static __inline int __sputc(int _c, FILE *_p) { 454 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 455 return (*_p->_p++ = _c); 456 else 457 return (__swbuf(_c, _p)); 458} 459#else 460/* 461 * This has been tuned to generate reasonable code on the vax using pcc. 462 */ 463#define __sputc(c, p) \ 464 (--(p)->_w < 0 ? \ 465 (p)->_w >= (p)->_lbfsize ? \ 466 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 467 (int)*(p)->_p++ : \ 468 __swbuf('\n', p) : \ 469 __swbuf((int)(c), p) : \ 470 (*(p)->_p = (c), (int)*(p)->_p++)) 471#endif 472 473#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 474#define __sferror(p) (((p)->_flags & __SERR) != 0) 475#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 476#define __sfileno(p) \ 477 ((p)->_file == -1 ? -1 : (int)(unsigned short)(p)->_file) 478 479#ifndef __lint__ 480#if !defined(_REENTRANT) && !defined(_PTHREADS) 481#define feof(p) __sfeof(p) 482#define ferror(p) __sferror(p) 483#define clearerr(p) __sclearerr(p) 484 485#define getc(fp) __sgetc(fp) 486#define putc(x, fp) __sputc(x, fp) 487#endif /* !_REENTRANT && !_PTHREADS */ 488#endif /* __lint__ */ 489 490#define getchar() getc(stdin) 491#define putchar(x) putc(x, stdout) 492 493#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 494 defined(_NETBSD_SOURCE) 495#if !defined(_REENTRANT) && !defined(_PTHREADS) 496#define fileno(p) __sfileno(p) 497#endif /* !_REENTRANT && !_PTHREADS */ 498#endif /* !_ANSI_SOURCE */ 499 500#if (_POSIX_C_SOURCE - 0) >= 200809L || defined(_NETBSD_SOURCE) 501int vdprintf(int, const char * __restrict, __va_list) 502 __printflike(2, 0); 503int dprintf(int, const char * __restrict, ...) 504 __printflike(2, 3); 505#endif /* (_POSIX_C_SOURCE - 0) >= 200809L || defined(_NETBSD_SOURCE) */ 506 507#if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 508 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 509#define getc_unlocked(fp) __sgetc(fp) 510#define putc_unlocked(x, fp) __sputc(x, fp) 511 512#define getchar_unlocked() getc_unlocked(stdin) 513#define putchar_unlocked(x) putc_unlocked(x, stdout) 514#endif /* _POSIX_C_SOURCE >= 199506 || _XOPEN_SOURCE >= 500 || _REENTRANT... */ 515 516#if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0) >= 700 || \ 517 defined(_NETBSD_SOURCE) 518FILE *fmemopen(void * __restrict, size_t, const char * __restrict); 519#endif 520 521#if _FORTIFY_SOURCE > 0 522#include <ssp/stdio.h> 523#endif 524 525#endif /* _STDIO_H_ */ 526