stdio.h revision 127100
1198090Srdivacky/*- 2198090Srdivacky * Copyright (c) 1990, 1993 3198090Srdivacky * The Regents of the University of California. All rights reserved. 4198090Srdivacky * 5198090Srdivacky * This code is derived from software contributed to Berkeley by 6198090Srdivacky * Chris Torek. 7198090Srdivacky * 8198090Srdivacky * Redistribution and use in source and binary forms, with or without 9198090Srdivacky * modification, are permitted provided that the following conditions 10198090Srdivacky * are met: 11198090Srdivacky * 1. Redistributions of source code must retain the above copyright 12198090Srdivacky * notice, this list of conditions and the following disclaimer. 13198090Srdivacky * 2. Redistributions in binary form must reproduce the above copyright 14198090Srdivacky * notice, this list of conditions and the following disclaimer in the 15198090Srdivacky * documentation and/or other materials provided with the distribution. 16198090Srdivacky * 3. All advertising materials mentioning features or use of this software 17234353Sdim * must display the following acknowledgement: 18249423Sdim * This product includes software developed by the University of 19234353Sdim * California, Berkeley and its contributors. 20198090Srdivacky * 4. Neither the name of the University nor the names of its contributors 21198090Srdivacky * may be used to endorse or promote products derived from this software 22234353Sdim * without specific prior written permission. 23234353Sdim * 24208599Srdivacky * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25208599Srdivacky * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26234353Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27234353Sdim * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28234353Sdim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29234353Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30198396Srdivacky * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31263508Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32263508Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33263508Sdim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34263508Sdim * SUCH DAMAGE. 35198090Srdivacky * 36198090Srdivacky * @(#)stdio.h 8.5 (Berkeley) 4/29/95 37198090Srdivacky * $FreeBSD: head/include/stdio.h 127100 2004-03-17 01:43:08Z tjr $ 38208599Srdivacky */ 39207618Srdivacky 40207618Srdivacky#ifndef _STDIO_H_ 41263508Sdim#define _STDIO_H_ 42263508Sdim 43207618Srdivacky#include <sys/cdefs.h> 44198090Srdivacky#include <sys/_null.h> 45198396Srdivacky#include <sys/_types.h> 46212904Sdim 47226633Sdimtypedef __off_t fpos_t; 48198396Srdivacky 49263508Sdim#ifndef _SIZE_T_DECLARED 50212904Sdimtypedef __size_t size_t; 51212904Sdim#define _SIZE_T_DECLARED 52263508Sdim#endif 53263508Sdim 54198090Srdivacky#if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE 55208599Srdivacky#ifndef _VA_LIST_DECLARED 56198090Srdivackytypedef __va_list va_list; 57263508Sdim#define _VA_LIST_DECLARED 58198090Srdivacky#endif 59198892Srdivacky#endif 60198090Srdivacky 61198396Srdivacky#define _FSTDIO /* Define for new stdio with functions. */ 62263508Sdim 63263508Sdim/* 64263508Sdim * NB: to fit things in six character monocase externals, the stdio 65263508Sdim * code uses the prefix `__s' for stdio objects, typically followed 66226633Sdim * by a three-character attempt at a mnemonic. 67198396Srdivacky */ 68263508Sdim 69263508Sdim/* stdio buffers */ 70198090Srdivackystruct __sbuf { 71198090Srdivacky unsigned char *_base; 72263508Sdim int _size; 73263508Sdim}; 74198090Srdivacky 75198396Srdivacky/* hold a buncha junk that would grow the ABI */ 76263508Sdimstruct __sFILEX; 77263508Sdim 78198090Srdivacky/* 79198396Srdivacky * stdio state variables. 80263508Sdim * 81263508Sdim * The following always hold: 82198090Srdivacky * 83263508Sdim * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 84263508Sdim * _lbfsize is -_bf._size, else _lbfsize is 0 85263508Sdim * if _flags&__SRD, _w is 0 86198090Srdivacky * if _flags&__SWR, _r is 0 87263508Sdim * 88198090Srdivacky * This ensures that the getc and putc macros (or inline functions) never 89198090Srdivacky * try to write or read from a file that is in `read' or `write' mode. 90198090Srdivacky * (Moreover, they can, and do, automatically switch from read mode to 91198090Srdivacky * write mode, and back, on "r+" and "w+" files.) 92198090Srdivacky * 93263508Sdim * _lbfsize is used only to make the inline line-buffered output stream 94198090Srdivacky * code as compact as possible. 95198090Srdivacky * 96198090Srdivacky * _ub, _up, and _ur are used when ungetc() pushes back more characters 97198090Srdivacky * than fit in the current _bf, or when ungetc() pushes back a character 98198090Srdivacky * that does not match the previous one in _bf. When this happens, 99198090Srdivacky * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 100198090Srdivacky * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 101198396Srdivacky * 102263508Sdim * NB: see WARNING above before changing the layout of this structure! 103263508Sdim */ 104263508Sdimtypedef struct __sFILE { 105263508Sdim unsigned char *_p; /* current position in (some) buffer */ 106263508Sdim int _r; /* read space left for getc() */ 107263508Sdim int _w; /* write space left for putc() */ 108263508Sdim short _flags; /* flags, below; this FILE is free if 0 */ 109198090Srdivacky short _file; /* fileno, if Unix descriptor, else -1 */ 110198396Srdivacky struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 111263508Sdim int _lbfsize; /* 0 or -_bf._size, for inline putc */ 112263508Sdim 113263508Sdim /* operations */ 114263508Sdim void *_cookie; /* cookie passed to io functions */ 115212904Sdim int (*_close)(void *); 116212904Sdim int (*_read)(void *, char *, int); 117212904Sdim fpos_t (*_seek)(void *, fpos_t, int); 118198090Srdivacky int (*_write)(void *, const char *, int); 119198090Srdivacky 120207618Srdivacky /* separate buffer for long sequences of ungetc() */ 121243830Sdim struct __sbuf _ub; /* ungetc buffer */ 122243830Sdim struct __sFILEX *_extra; /* additions to FILE to not break ABI */ 123198090Srdivacky int _ur; /* saved _r when _r is counting ungetc data */ 124263508Sdim 125263508Sdim /* tricks to meet minimum requirements even when malloc() fails */ 126263508Sdim unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 127263508Sdim unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 128218893Sdim 129218893Sdim /* separate buffer for fgetln() when line crosses buffer boundary */ 130218893Sdim struct __sbuf _lb; /* buffer for fgetln() */ 131218893Sdim 132218893Sdim /* Unix stdio files get aligned to block boundaries on fseek() */ 133218893Sdim int _blksize; /* stat.st_blksize (may be != _bf._size) */ 134218893Sdim fpos_t _offset; /* current lseek offset (see WARNING) */ 135218893Sdim} FILE; 136218893Sdim 137218893Sdim__BEGIN_DECLS 138224145Sdimextern FILE *__stdinp; 139218893Sdimextern FILE *__stdoutp; 140218893Sdimextern FILE *__stderrp; 141263508Sdim__END_DECLS 142263508Sdim 143263508Sdim#define __SLBF 0x0001 /* line buffered */ 144263508Sdim#define __SNBF 0x0002 /* unbuffered */ 145263508Sdim#define __SRD 0x0004 /* OK to read */ 146218893Sdim#define __SWR 0x0008 /* OK to write */ 147218893Sdim /* RD and WR are never simultaneously asserted */ 148218893Sdim#define __SRW 0x0010 /* open for reading & writing */ 149263508Sdim#define __SEOF 0x0020 /* found EOF */ 150263508Sdim#define __SERR 0x0040 /* found error */ 151263508Sdim#define __SMBF 0x0080 /* _buf is from malloc */ 152263508Sdim#define __SAPP 0x0100 /* fdopen()ed in append mode */ 153218893Sdim#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 154234353Sdim#define __SOPT 0x0400 /* do fseek() optimization */ 155218893Sdim#define __SNPT 0x0800 /* do not do fseek() optimization */ 156263508Sdim#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 157263508Sdim#define __SMOD 0x2000 /* true => fgetln modified _p text */ 158218893Sdim#define __SALC 0x4000 /* allocate string space dynamically */ 159218893Sdim#define __SIGN 0x8000 /* ignore this file in _fwalk */ 160218893Sdim 161263508Sdim/* 162263508Sdim * The following three definitions are for ANSI C, which took them 163218893Sdim * from System V, which brilliantly took internal interface macros and 164218893Sdim * made them official arguments to setvbuf(), without renaming them. 165198090Srdivacky * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 166263508Sdim * 167218893Sdim * Although numbered as their counterparts above, the implementation 168218893Sdim * does not rely on this. 169218893Sdim */ 170263508Sdim#define _IOFBF 0 /* setvbuf should set fully buffered */ 171224145Sdim#define _IOLBF 1 /* setvbuf should set line buffered */ 172224145Sdim#define _IONBF 2 /* setvbuf should set unbuffered */ 173218893Sdim 174218893Sdim#define BUFSIZ 1024 /* size of buffer used by setbuf */ 175198090Srdivacky#define EOF (-1) 176198090Srdivacky 177198090Srdivacky/* 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 __XSI_VISIBLE 188#define P_tmpdir "/var/tmp/" 189#endif 190#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 191#define TMP_MAX 308915776 192 193#ifndef SEEK_SET 194#define SEEK_SET 0 /* set file offset to offset */ 195#endif 196#ifndef SEEK_CUR 197#define SEEK_CUR 1 /* set file offset to current plus offset */ 198#endif 199#ifndef SEEK_END 200#define SEEK_END 2 /* set file offset to EOF plus offset */ 201#endif 202 203#define stdin __stdinp 204#define stdout __stdoutp 205#define stderr __stderrp 206 207__BEGIN_DECLS 208/* 209 * Functions defined in ANSI C standard. 210 */ 211void clearerr(FILE *); 212int fclose(FILE *); 213int feof(FILE *); 214int ferror(FILE *); 215int fflush(FILE *); 216int fgetc(FILE *); 217int fgetpos(FILE * __restrict, fpos_t * __restrict); 218char *fgets(char * __restrict, int, FILE * __restrict); 219FILE *fopen(const char * __restrict, const char * __restrict); 220int fprintf(FILE * __restrict, const char * __restrict, ...); 221int fputc(int, FILE *); 222int fputs(const char * __restrict, FILE * __restrict); 223size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 224FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict); 225int fscanf(FILE * __restrict, const char * __restrict, ...); 226int fseek(FILE *, long, int); 227int fsetpos(FILE *, const fpos_t *); 228long ftell(FILE *); 229size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 230int getc(FILE *); 231int getchar(void); 232char *gets(char *); 233void perror(const char *); 234int printf(const char * __restrict, ...); 235int putc(int, FILE *); 236int putchar(int); 237int puts(const char *); 238int remove(const char *); 239int rename(const char *, const char *); 240void rewind(FILE *); 241int scanf(const char * __restrict, ...); 242void setbuf(FILE * __restrict, char * __restrict); 243int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 244int sprintf(char * __restrict, const char * __restrict, ...); 245int sscanf(const char * __restrict, const char * __restrict, ...); 246FILE *tmpfile(void); 247char *tmpnam(char *); 248int ungetc(int, FILE *); 249int vfprintf(FILE * __restrict, const char * __restrict, 250 __va_list); 251int vprintf(const char * __restrict, __va_list); 252int vsprintf(char * __restrict, const char * __restrict, 253 __va_list); 254 255#if __ISO_C_VISIBLE >= 1999 256int snprintf(char * __restrict, size_t, const char * __restrict, 257 ...) __printflike(3, 4); 258int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 259 __scanflike(2, 0); 260int vscanf(const char * __restrict, __va_list) __scanflike(1, 0); 261int vsnprintf(char * __restrict, size_t, const char * __restrict, 262 __va_list) __printflike(3, 0); 263int vsscanf(const char * __restrict, const char * __restrict, __va_list) 264 __scanflike(2, 0); 265#endif 266 267/* 268 * Functions defined in all versions of POSIX 1003.1. 269 */ 270#if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 271/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 272#define L_cuserid 17 /* legacy */ 273#endif 274 275#if __POSIX_VISIBLE 276#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 277 278char *ctermid(char *); 279FILE *fdopen(int, const char *); 280int fileno(FILE *); 281#endif /* __POSIX_VISIBLE */ 282 283#if __POSIX_VISIBLE >= 199209 284int pclose(FILE *); 285FILE *popen(const char *, const char *); 286#endif 287 288#if __POSIX_VISIBLE >= 199506 289int ftrylockfile(FILE *); 290void flockfile(FILE *); 291void funlockfile(FILE *); 292 293/* 294 * These are normally used through macros as defined below, but POSIX 295 * requires functions as well. 296 */ 297int getc_unlocked(FILE *); 298int getchar_unlocked(void); 299int putc_unlocked(int, FILE *); 300int putchar_unlocked(int); 301#endif 302#if __BSD_VISIBLE 303void clearerr_unlocked(FILE *); 304int feof_unlocked(FILE *); 305int ferror_unlocked(FILE *); 306int fileno_unlocked(FILE *); 307#endif 308 309#if __POSIX_VISIBLE >= 200112 310int fseeko(FILE *, __off_t, int); 311__off_t ftello(FILE *); 312#endif 313 314#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 315int getw(FILE *); 316int putw(int, FILE *); 317#endif /* BSD or X/Open before issue 6 */ 318 319#if __XSI_VISIBLE 320char *tempnam(const char *, const char *); 321#endif 322 323/* 324 * Routines that are purely local. 325 */ 326#if __BSD_VISIBLE 327int asprintf(char **, const char *, ...) __printflike(2, 3); 328char *ctermid_r(char *); 329char *fgetln(FILE *, size_t *); 330#if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3 331#define __ATTR_FORMAT_ARG __attribute__((__format_arg__(2))) 332#else 333#define __ATTR_FORMAT_ARG 334#endif 335__const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG; 336int fpurge(FILE *); 337void setbuffer(FILE *, char *, int); 338int setlinebuf(FILE *); 339int vasprintf(char **, const char *, __va_list) 340 __printflike(2, 0); 341 342/* 343 * The system error table contains messages for the first sys_nerr 344 * positive errno values. Use strerror() or strerror_r() from <string.h> 345 * instead. 346 */ 347extern __const int sys_nerr; 348extern __const char *__const sys_errlist[]; 349 350/* 351 * Stdio function-access interface. 352 */ 353FILE *funopen(const void *, 354 int (*)(void *, char *, int), 355 int (*)(void *, const char *, int), 356 fpos_t (*)(void *, fpos_t, int), 357 int (*)(void *)); 358#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 359#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 360 361/* 362 * Portability hacks. See <sys/types.h>. 363 */ 364#ifndef _FTRUNCATE_DECLARED 365#define _FTRUNCATE_DECLARED 366int ftruncate(int, __off_t); 367#endif 368#ifndef _LSEEK_DECLARED 369#define _LSEEK_DECLARED 370__off_t lseek(int, __off_t, int); 371#endif 372#ifndef _MMAP_DECLARED 373#define _MMAP_DECLARED 374void *mmap(void *, size_t, int, int, int, __off_t); 375#endif 376#ifndef _TRUNCATE_DECLARED 377#define _TRUNCATE_DECLARED 378int truncate(const char *, __off_t); 379#endif 380#endif /* __BSD_VISIBLE */ 381 382/* 383 * Functions internal to the implementation. 384 */ 385int __srget(FILE *); 386int __swbuf(int, FILE *); 387 388/* 389 * The __sfoo macros are here so that we can 390 * define function versions in the C library. 391 */ 392#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 393#if defined(__GNUC__) && defined(__STDC__) 394static __inline int __sputc(int _c, FILE *_p) { 395 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 396 return (*_p->_p++ = _c); 397 else 398 return (__swbuf(_c, _p)); 399} 400#else 401/* 402 * This has been tuned to generate reasonable code on the vax using pcc. 403 */ 404#define __sputc(c, p) \ 405 (--(p)->_w < 0 ? \ 406 (p)->_w >= (p)->_lbfsize ? \ 407 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 408 (int)*(p)->_p++ : \ 409 __swbuf('\n', p) : \ 410 __swbuf((int)(c), p) : \ 411 (*(p)->_p = (c), (int)*(p)->_p++)) 412#endif 413 414#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 415#define __sferror(p) (((p)->_flags & __SERR) != 0) 416#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 417#define __sfileno(p) ((p)->_file) 418 419extern int __isthreaded; 420 421#define feof(p) (!__isthreaded ? __sfeof(p) : feof(p)) 422#define ferror(p) (!__isthreaded ? __sferror(p) : ferror(p)) 423#define clearerr(p) (!__isthreaded ? __sclearerr(p) : clearerr(p)) 424 425#if __POSIX_VISIBLE 426#define fileno(p) (!__isthreaded ? __sfileno(p) : fileno(p)) 427#endif 428 429#define getc(fp) (!__isthreaded ? __sgetc(fp) : getc(fp)) 430#define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : putc(x, fp)) 431 432#define getchar() getc(stdin) 433#define putchar(x) putc(x, stdout) 434 435#if __BSD_VISIBLE 436/* 437 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 438 * B.8.2.7 for the rationale behind the *_unlocked() macros. 439 */ 440#define feof_unlocked(p) __sfeof(p) 441#define ferror_unlocked(p) __sferror(p) 442#define clearerr_unlocked(p) __sclearerr(p) 443#define fileno_unlocked(p) __sfileno(p) 444#endif 445#if __POSIX_VISIBLE >= 199506 446#define getc_unlocked(fp) __sgetc(fp) 447#define putc_unlocked(x, fp) __sputc(x, fp) 448 449#define getchar_unlocked() getc_unlocked(stdin) 450#define putchar_unlocked(x) putc_unlocked(x, stdout) 451#endif 452 453__END_DECLS 454#endif /* !_STDIO_H_ */ 455