stdio.h revision 1.81
1/* $NetBSD: stdio.h,v 1.81 2012/03/27 15:06:01 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#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 ssize_t (*_read) (void *, void *, size_t); 125 __off_t (*_seek) (void *, __off_t, int); 126 ssize_t (*_write)(void *, const void *, size_t); 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 int (*_flush)(void *); 140 /* Formerly used by fgetln/fgetwln; kept for binary compatibility */ 141 char _lb_unused[sizeof(struct __sbuf) - sizeof(int (*)(void *))]; 142 143 /* Unix stdio files get aligned to block boundaries on fseek() */ 144 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 145 __off_t _offset; /* current lseek offset */ 146} FILE; 147 148__BEGIN_DECLS 149extern FILE __sF[]; 150__END_DECLS 151 152#define __SLBF 0x0001 /* line buffered */ 153#define __SNBF 0x0002 /* unbuffered */ 154#define __SRD 0x0004 /* OK to read */ 155#define __SWR 0x0008 /* OK to write */ 156 /* RD and WR are never simultaneously asserted */ 157#define __SRW 0x0010 /* open for reading & writing */ 158#define __SEOF 0x0020 /* found EOF */ 159#define __SERR 0x0040 /* found error */ 160#define __SMBF 0x0080 /* _buf is from malloc */ 161#define __SAPP 0x0100 /* fdopen()ed in append mode */ 162#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 163#define __SOPT 0x0400 /* do fseek() optimization */ 164#define __SNPT 0x0800 /* do not do fseek() optimization */ 165#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 166#define __SMOD 0x2000 /* true => fgetln modified _p text */ 167#define __SALC 0x4000 /* allocate string space dynamically */ 168 169/* 170 * The following three definitions are for ANSI C, which took them 171 * from System V, which brilliantly took internal interface macros and 172 * made them official arguments to setvbuf(), without renaming them. 173 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 174 * 175 * Although numbered as their counterparts above, the implementation 176 * does not rely on this. 177 */ 178#define _IOFBF 0 /* setvbuf should set fully buffered */ 179#define _IOLBF 1 /* setvbuf should set line buffered */ 180#define _IONBF 2 /* setvbuf should set unbuffered */ 181 182#define BUFSIZ 1024 /* size of buffer used by setbuf */ 183#define EOF (-1) 184 185/* 186 * FOPEN_MAX is a minimum maximum, and is the number of streams that 187 * stdio can provide without attempting to allocate further resources 188 * (which could fail). Do not use this for anything. 189 */ 190 /* must be == _POSIX_STREAM_MAX <limits.h> */ 191#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 192#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 193 194/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 195#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 196#define P_tmpdir "/var/tmp/" 197#endif 198#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 199/* Always ensure that this is consistent with <limits.h> */ 200#ifndef TMP_MAX 201#define TMP_MAX 308915776 /* Legacy */ 202#endif 203 204/* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 205#ifndef SEEK_SET 206#define SEEK_SET 0 /* set file offset to offset */ 207#endif 208#ifndef SEEK_CUR 209#define SEEK_CUR 1 /* set file offset to current plus offset */ 210#endif 211#ifndef SEEK_END 212#define SEEK_END 2 /* set file offset to EOF plus offset */ 213#endif 214 215#define stdin (&__sF[0]) 216#define stdout (&__sF[1]) 217#define stderr (&__sF[2]) 218 219/* 220 * Functions defined in ANSI C standard. 221 */ 222__BEGIN_DECLS 223void clearerr(FILE *); 224int fclose(FILE *); 225int feof(FILE *); 226int ferror(FILE *); 227int fflush(FILE *); 228int fgetc(FILE *); 229char *fgets(char * __restrict, int, FILE * __restrict); 230FILE *fopen(const char * __restrict , const char * __restrict); 231int fprintf(FILE * __restrict , const char * __restrict, ...) 232 __printflike(2, 3); 233int fputc(int, FILE *); 234int fputs(const char * __restrict, FILE * __restrict); 235size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 236FILE *freopen(const char * __restrict, const char * __restrict, 237 FILE * __restrict); 238int fscanf(FILE * __restrict, const char * __restrict, ...) 239 __scanflike(2, 3); 240int fseek(FILE *, long, int); 241long ftell(FILE *); 242size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 243int getc(FILE *); 244int getchar(void); 245ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 246 FILE * __restrict); 247ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict); 248void perror(const char *); 249int printf(const char * __restrict, ...) 250 __printflike(1, 2); 251int putc(int, FILE *); 252int putchar(int); 253int puts(const char *); 254int remove(const char *); 255void rewind(FILE *); 256int scanf(const char * __restrict, ...) 257 __scanflike(1, 2); 258void setbuf(FILE * __restrict, char * __restrict); 259int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 260int sscanf(const char * __restrict, const char * __restrict, ...) 261 __scanflike(2, 3); 262FILE *tmpfile(void); 263int ungetc(int, FILE *); 264int vfprintf(FILE * __restrict, const char * __restrict, __va_list) 265 __printflike(2, 0); 266int vprintf(const char * __restrict, __va_list) 267 __printflike(1, 0); 268 269#ifndef __AUDIT__ 270char *gets(char *); 271int sprintf(char * __restrict, const char * __restrict, ...) 272 __printflike(2, 3); 273char *tmpnam(char *); 274int vsprintf(char * __restrict, const char * __restrict, 275 __va_list) 276 __printflike(2, 0); 277#endif 278 279#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 280int rename (const char *, const char *) __RENAME(__posix_rename); 281#else 282int rename (const char *, const char *); 283#endif 284__END_DECLS 285 286#ifndef __LIBC12_SOURCE__ 287int fgetpos(FILE * __restrict, fpos_t * __restrict) __RENAME(__fgetpos50); 288int fsetpos(FILE *, const fpos_t *) __RENAME(__fsetpos50); 289#endif 290/* 291 * IEEE Std 1003.1-90 292 */ 293#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 294 defined(_NETBSD_SOURCE) 295#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 296#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 297 298__BEGIN_DECLS 299char *ctermid(char *); 300#ifndef __CUSERID_DECLARED 301#define __CUSERID_DECLARED 302/* also declared in unistd.h */ 303char *cuserid(char *); 304#endif /* __CUSERID_DECLARED */ 305FILE *fdopen(int, const char *); 306int fileno(FILE *); 307__END_DECLS 308#endif /* not ANSI */ 309 310/* 311 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 312 */ 313#if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 314 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 315__BEGIN_DECLS 316void flockfile(FILE *); 317int ftrylockfile(FILE *); 318void funlockfile(FILE *); 319int getc_unlocked(FILE *); 320int getchar_unlocked(void); 321int putc_unlocked(int, FILE *); 322int putchar_unlocked(int); 323__END_DECLS 324#endif /* _POSIX_C_SOURCE >= 1995056 || _XOPEN_SOURCE >= 500 || ... */ 325 326/* 327 * Functions defined in POSIX 1003.2 and XPG2 or later. 328 */ 329#if (_POSIX_C_SOURCE - 0) >= 2 || (_XOPEN_SOURCE - 0) >= 2 || \ 330 defined(_NETBSD_SOURCE) 331__BEGIN_DECLS 332int pclose(FILE *); 333FILE *popen(const char *, const char *); 334__END_DECLS 335#endif 336 337/* 338 * Functions defined in ISO XPG4.2, ISO C99, POSIX 1003.1-2001 or later. 339 */ 340#if ((__STDC_VERSION__ - 0) >= 199901L) || \ 341 ((_POSIX_C_SOURCE - 0) >= 200112L) || \ 342 (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \ 343 ((_XOPEN_SOURCE - 0) >= 500) || \ 344 defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE) 345__BEGIN_DECLS 346int snprintf(char * __restrict, size_t, const char * __restrict, ...) 347 __printflike(3, 4); 348int vsnprintf(char * __restrict, size_t, const char * __restrict, 349 __va_list) 350 __printflike(3, 0); 351__END_DECLS 352#endif 353 354/* 355 * Functions defined in XPG4.2. 356 */ 357#if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 358__BEGIN_DECLS 359int getw(FILE *); 360int putw(int, FILE *); 361 362#ifndef __AUDIT__ 363char *tempnam(const char *, const char *); 364#endif 365__END_DECLS 366#endif 367 368/* 369 * X/Open CAE Specification Issue 5 Version 2 370 */ 371#if (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) || \ 372 defined(_NETBSD_SOURCE) 373#ifndef off_t 374typedef __off_t off_t; 375#define off_t __off_t 376#endif /* off_t */ 377 378__BEGIN_DECLS 379int fseeko(FILE *, off_t, int); 380off_t ftello(FILE *); 381__END_DECLS 382#endif /* _XOPEN_SOURCE >= 500 || _LARGEFILE_SOURCE || _NETBSD_SOURCE */ 383 384/* 385 * Functions defined in ISO C99. Still put under _NETBSD_SOURCE due to 386 * backward compatible. 387 */ 388#if defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE) 389__BEGIN_DECLS 390int vscanf(const char * __restrict, __va_list) 391 __scanflike(1, 0); 392int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 393 __scanflike(2, 0); 394int vsscanf(const char * __restrict, const char * __restrict, 395 __va_list) 396 __scanflike(2, 0); 397__END_DECLS 398#endif /* _ISOC99_SOURCE || _NETBSD_SOURCE */ 399 400/* 401 * Routines that are purely local. 402 */ 403#if defined(_NETBSD_SOURCE) 404 405#define FPARSELN_UNESCESC 0x01 406#define FPARSELN_UNESCCONT 0x02 407#define FPARSELN_UNESCCOMM 0x04 408#define FPARSELN_UNESCREST 0x08 409#define FPARSELN_UNESCALL 0x0f 410 411__BEGIN_DECLS 412int asprintf(char ** __restrict, const char * __restrict, ...) 413 __printflike(2, 3); 414char *fgetln(FILE * __restrict, size_t * __restrict); 415char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 416int fpurge(FILE *); 417void setbuffer(FILE *, char *, int); 418int setlinebuf(FILE *); 419int vasprintf(char ** __restrict, const char * __restrict, 420 __va_list) 421 __printflike(2, 0); 422const char *fmtcheck(const char *, const char *) 423 __format_arg(2); 424__END_DECLS 425 426/* 427 * Stdio function-access interface. 428 */ 429__BEGIN_DECLS 430FILE *funopen(const void *, 431 int (*)(void *, char *, int), 432 int (*)(void *, const char *, int), 433 off_t (*)(void *, off_t, int), 434 int (*)(void *)); 435FILE *funopen2(const void *, 436 ssize_t (*)(void *, void *, size_t), 437 ssize_t (*)(void *, const void *, size_t), 438 off_t (*)(void *, off_t, int), 439 int (*)(void *), 440 int (*)(void *)); 441__END_DECLS 442#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 443#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 444#define fropen2(cookie, fn) funopen2(cookie, fn, 0, 0, 0, 0) 445#define fwopen2(cookie, fn) funopen2(cookie, 0, fn, 0, 0, 0) 446#endif /* _NETBSD_SOURCE */ 447 448/* 449 * Functions internal to the implementation. 450 */ 451__BEGIN_DECLS 452int __srget(FILE *); 453int __swbuf(int, FILE *); 454__END_DECLS 455 456/* 457 * The __sfoo macros are here so that we can 458 * define function versions in the C library. 459 */ 460#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 461#if defined(__GNUC__) && defined(__STDC__) 462static __inline int __sputc(int _c, FILE *_p) { 463 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 464 return (*_p->_p++ = _c); 465 else 466 return (__swbuf(_c, _p)); 467} 468#else 469/* 470 * This has been tuned to generate reasonable code on the vax using pcc. 471 */ 472#define __sputc(c, p) \ 473 (--(p)->_w < 0 ? \ 474 (p)->_w >= (p)->_lbfsize ? \ 475 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 476 (int)*(p)->_p++ : \ 477 __swbuf('\n', p) : \ 478 __swbuf((int)(c), p) : \ 479 (*(p)->_p = (c), (int)*(p)->_p++)) 480#endif 481 482#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 483#define __sferror(p) (((p)->_flags & __SERR) != 0) 484#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 485#define __sfileno(p) \ 486 ((p)->_file == -1 ? -1 : (int)(unsigned short)(p)->_file) 487 488#ifndef __lint__ 489#if !defined(_REENTRANT) && !defined(_PTHREADS) 490#define feof(p) __sfeof(p) 491#define ferror(p) __sferror(p) 492#define clearerr(p) __sclearerr(p) 493 494#define getc(fp) __sgetc(fp) 495#define putc(x, fp) __sputc(x, fp) 496#endif /* !_REENTRANT && !_PTHREADS */ 497#endif /* __lint__ */ 498 499#define getchar() getc(stdin) 500#define putchar(x) putc(x, stdout) 501 502#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 503 defined(_NETBSD_SOURCE) 504#if !defined(_REENTRANT) && !defined(_PTHREADS) 505#define fileno(p) __sfileno(p) 506#endif /* !_REENTRANT && !_PTHREADS */ 507#endif /* !_ANSI_SOURCE */ 508 509#if (_POSIX_C_SOURCE - 0) >= 200809L || defined(_NETBSD_SOURCE) 510int vdprintf(int, const char * __restrict, __va_list) 511 __printflike(2, 0); 512int dprintf(int, const char * __restrict, ...) 513 __printflike(2, 3); 514#endif /* (_POSIX_C_SOURCE - 0) >= 200809L || defined(_NETBSD_SOURCE) */ 515 516#if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 517 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 518#define getc_unlocked(fp) __sgetc(fp) 519#define putc_unlocked(x, fp) __sputc(x, fp) 520 521#define getchar_unlocked() getc_unlocked(stdin) 522#define putchar_unlocked(x) putc_unlocked(x, stdout) 523#endif /* _POSIX_C_SOURCE >= 199506 || _XOPEN_SOURCE >= 500 || _REENTRANT... */ 524 525#if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0) >= 700 || \ 526 defined(_NETBSD_SOURCE) 527FILE *fmemopen(void * __restrict, size_t, const char * __restrict); 528#endif 529 530#if _FORTIFY_SOURCE > 0 531#include <ssp/stdio.h> 532#endif 533 534#endif /* _STDIO_H_ */ 535