stdio.h revision 130773
1/*- 2 * Copyright (c) 1990, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Chris Torek. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)stdio.h 8.5 (Berkeley) 4/29/95 37 * $FreeBSD: head/include/stdio.h 130773 2004-06-20 10:01:30Z tjr $ 38 */ 39 40#ifndef _STDIO_H_ 41#define _STDIO_H_ 42 43#include <sys/cdefs.h> 44#include <sys/_null.h> 45#include <sys/_types.h> 46 47typedef __off_t fpos_t; 48 49#ifndef _SIZE_T_DECLARED 50typedef __size_t size_t; 51#define _SIZE_T_DECLARED 52#endif 53 54#if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE 55#ifndef _VA_LIST_DECLARED 56typedef __va_list va_list; 57#define _VA_LIST_DECLARED 58#endif 59#endif 60 61#define _FSTDIO /* Define for new stdio with functions. */ 62 63/* 64 * NB: to fit things in six character monocase externals, the stdio 65 * code uses the prefix `__s' for stdio objects, typically followed 66 * by a three-character attempt at a mnemonic. 67 */ 68 69/* stdio buffers */ 70struct __sbuf { 71 unsigned char *_base; 72 int _size; 73}; 74 75/* hold a buncha junk that would grow the ABI */ 76struct __sFILEX; 77 78/* 79 * stdio state variables. 80 * 81 * The following always hold: 82 * 83 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 84 * _lbfsize is -_bf._size, else _lbfsize is 0 85 * if _flags&__SRD, _w is 0 86 * if _flags&__SWR, _r is 0 87 * 88 * This ensures that the getc and putc macros (or inline functions) never 89 * try to write or read from a file that is in `read' or `write' mode. 90 * (Moreover, they can, and do, automatically switch from read mode to 91 * write mode, and back, on "r+" and "w+" files.) 92 * 93 * _lbfsize is used only to make the inline line-buffered output stream 94 * code as compact as possible. 95 * 96 * _ub, _up, and _ur are used when ungetc() pushes back more characters 97 * than fit in the current _bf, or when ungetc() pushes back a character 98 * that does not match the previous one in _bf. When this happens, 99 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 100 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 101 */ 102typedef struct __sFILE { 103 unsigned char *_p; /* current position in (some) buffer */ 104 int _r; /* read space left for getc() */ 105 int _w; /* write space left for putc() */ 106 short _flags; /* flags, below; this FILE is free if 0 */ 107 short _file; /* fileno, if Unix descriptor, else -1 */ 108 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 109 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 110 111 /* operations */ 112 void *_cookie; /* cookie passed to io functions */ 113 int (*_close)(void *); 114 int (*_read)(void *, char *, int); 115 fpos_t (*_seek)(void *, fpos_t, int); 116 int (*_write)(void *, const char *, int); 117 118 /* separate buffer for long sequences of ungetc() */ 119 struct __sbuf _ub; /* ungetc buffer */ 120 struct __sFILEX *_extra; /* additions to FILE to not break ABI */ 121 int _ur; /* saved _r when _r is counting ungetc data */ 122 123 /* tricks to meet minimum requirements even when malloc() fails */ 124 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 125 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 126 127 /* separate buffer for fgetln() when line crosses buffer boundary */ 128 struct __sbuf _lb; /* buffer for fgetln() */ 129 130 /* Unix stdio files get aligned to block boundaries on fseek() */ 131 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 132 fpos_t _offset; /* current lseek offset */ 133} FILE; 134 135#ifndef _STDSTREAM_DECLARED 136__BEGIN_DECLS 137extern FILE *__stdinp; 138extern FILE *__stdoutp; 139extern FILE *__stderrp; 140__END_DECLS 141#define _STDSTREAM_DECLARED 142#endif 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#define __SIGN 0x8000 /* ignore this file in _fwalk */ 161 162/* 163 * The following three definitions are for ANSI C, which took them 164 * from System V, which brilliantly took internal interface macros and 165 * made them official arguments to setvbuf(), without renaming them. 166 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 167 * 168 * Although numbered as their counterparts above, the implementation 169 * does not rely on this. 170 */ 171#define _IOFBF 0 /* setvbuf should set fully buffered */ 172#define _IOLBF 1 /* setvbuf should set line buffered */ 173#define _IONBF 2 /* setvbuf should set unbuffered */ 174 175#define BUFSIZ 1024 /* size of buffer used by setbuf */ 176#define EOF (-1) 177 178/* 179 * FOPEN_MAX is a minimum maximum, and is the number of streams that 180 * stdio can provide without attempting to allocate further resources 181 * (which could fail). Do not use this for anything. 182 */ 183 /* must be == _POSIX_STREAM_MAX <limits.h> */ 184#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 185#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 186 187/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 188#if __XSI_VISIBLE 189#define P_tmpdir "/var/tmp/" 190#endif 191#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 192#define TMP_MAX 308915776 193 194#ifndef SEEK_SET 195#define SEEK_SET 0 /* set file offset to offset */ 196#endif 197#ifndef SEEK_CUR 198#define SEEK_CUR 1 /* set file offset to current plus offset */ 199#endif 200#ifndef SEEK_END 201#define SEEK_END 2 /* set file offset to EOF plus offset */ 202#endif 203 204#define stdin __stdinp 205#define stdout __stdoutp 206#define stderr __stderrp 207 208__BEGIN_DECLS 209/* 210 * Functions defined in ANSI C standard. 211 */ 212void clearerr(FILE *); 213int fclose(FILE *); 214int feof(FILE *); 215int ferror(FILE *); 216int fflush(FILE *); 217int fgetc(FILE *); 218int fgetpos(FILE * __restrict, fpos_t * __restrict); 219char *fgets(char * __restrict, int, FILE * __restrict); 220FILE *fopen(const char * __restrict, const char * __restrict); 221int fprintf(FILE * __restrict, const char * __restrict, ...); 222int fputc(int, FILE *); 223int fputs(const char * __restrict, FILE * __restrict); 224size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 225FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict); 226int fscanf(FILE * __restrict, const char * __restrict, ...); 227int fseek(FILE *, long, int); 228int fsetpos(FILE *, const fpos_t *); 229long ftell(FILE *); 230size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 231int getc(FILE *); 232int getchar(void); 233char *gets(char *); 234void perror(const char *); 235int printf(const char * __restrict, ...); 236int putc(int, FILE *); 237int putchar(int); 238int puts(const char *); 239int remove(const char *); 240int rename(const char *, const char *); 241void rewind(FILE *); 242int scanf(const char * __restrict, ...); 243void setbuf(FILE * __restrict, char * __restrict); 244int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 245int sprintf(char * __restrict, const char * __restrict, ...); 246int sscanf(const char * __restrict, const char * __restrict, ...); 247FILE *tmpfile(void); 248char *tmpnam(char *); 249int ungetc(int, FILE *); 250int vfprintf(FILE * __restrict, const char * __restrict, 251 __va_list); 252int vprintf(const char * __restrict, __va_list); 253int vsprintf(char * __restrict, const char * __restrict, 254 __va_list); 255 256#if __ISO_C_VISIBLE >= 1999 257int snprintf(char * __restrict, size_t, const char * __restrict, 258 ...) __printflike(3, 4); 259int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 260 __scanflike(2, 0); 261int vscanf(const char * __restrict, __va_list) __scanflike(1, 0); 262int vsnprintf(char * __restrict, size_t, const char * __restrict, 263 __va_list) __printflike(3, 0); 264int vsscanf(const char * __restrict, const char * __restrict, __va_list) 265 __scanflike(2, 0); 266#endif 267 268/* 269 * Functions defined in all versions of POSIX 1003.1. 270 */ 271#if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 272/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 273#define L_cuserid 17 /* legacy */ 274#endif 275 276#if __POSIX_VISIBLE 277#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 278 279char *ctermid(char *); 280FILE *fdopen(int, const char *); 281int fileno(FILE *); 282#endif /* __POSIX_VISIBLE */ 283 284#if __POSIX_VISIBLE >= 199209 285int pclose(FILE *); 286FILE *popen(const char *, const char *); 287#endif 288 289#if __POSIX_VISIBLE >= 199506 290int ftrylockfile(FILE *); 291void flockfile(FILE *); 292void funlockfile(FILE *); 293 294/* 295 * These are normally used through macros as defined below, but POSIX 296 * requires functions as well. 297 */ 298int getc_unlocked(FILE *); 299int getchar_unlocked(void); 300int putc_unlocked(int, FILE *); 301int putchar_unlocked(int); 302#endif 303#if __BSD_VISIBLE 304void clearerr_unlocked(FILE *); 305int feof_unlocked(FILE *); 306int ferror_unlocked(FILE *); 307int fileno_unlocked(FILE *); 308#endif 309 310#if __POSIX_VISIBLE >= 200112 311int fseeko(FILE *, __off_t, int); 312__off_t ftello(FILE *); 313#endif 314 315#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 316int getw(FILE *); 317int putw(int, FILE *); 318#endif /* BSD or X/Open before issue 6 */ 319 320#if __XSI_VISIBLE 321char *tempnam(const char *, const char *); 322#endif 323 324/* 325 * Routines that are purely local. 326 */ 327#if __BSD_VISIBLE 328int asprintf(char **, const char *, ...) __printflike(2, 3); 329char *ctermid_r(char *); 330char *fgetln(FILE *, size_t *); 331#if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3 332#define __ATTR_FORMAT_ARG __attribute__((__format_arg__(2))) 333#else 334#define __ATTR_FORMAT_ARG 335#endif 336__const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG; 337int fpurge(FILE *); 338void setbuffer(FILE *, char *, int); 339int setlinebuf(FILE *); 340int vasprintf(char **, const char *, __va_list) 341 __printflike(2, 0); 342 343/* 344 * The system error table contains messages for the first sys_nerr 345 * positive errno values. Use strerror() or strerror_r() from <string.h> 346 * instead. 347 */ 348extern __const int sys_nerr; 349extern __const char *__const sys_errlist[]; 350 351/* 352 * Stdio function-access interface. 353 */ 354FILE *funopen(const void *, 355 int (*)(void *, char *, int), 356 int (*)(void *, const char *, int), 357 fpos_t (*)(void *, fpos_t, int), 358 int (*)(void *)); 359#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 360#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 361 362/* 363 * Portability hacks. See <sys/types.h>. 364 */ 365#ifndef _FTRUNCATE_DECLARED 366#define _FTRUNCATE_DECLARED 367int ftruncate(int, __off_t); 368#endif 369#ifndef _LSEEK_DECLARED 370#define _LSEEK_DECLARED 371__off_t lseek(int, __off_t, int); 372#endif 373#ifndef _MMAP_DECLARED 374#define _MMAP_DECLARED 375void *mmap(void *, size_t, int, int, int, __off_t); 376#endif 377#ifndef _TRUNCATE_DECLARED 378#define _TRUNCATE_DECLARED 379int truncate(const char *, __off_t); 380#endif 381#endif /* __BSD_VISIBLE */ 382 383/* 384 * Functions internal to the implementation. 385 */ 386int __srget(FILE *); 387int __swbuf(int, FILE *); 388 389/* 390 * The __sfoo macros are here so that we can 391 * define function versions in the C library. 392 */ 393#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 394#if defined(__GNUC__) && defined(__STDC__) 395static __inline int __sputc(int _c, FILE *_p) { 396 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 397 return (*_p->_p++ = _c); 398 else 399 return (__swbuf(_c, _p)); 400} 401#else 402/* 403 * This has been tuned to generate reasonable code on the vax using pcc. 404 */ 405#define __sputc(c, p) \ 406 (--(p)->_w < 0 ? \ 407 (p)->_w >= (p)->_lbfsize ? \ 408 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 409 (int)*(p)->_p++ : \ 410 __swbuf('\n', p) : \ 411 __swbuf((int)(c), p) : \ 412 (*(p)->_p = (c), (int)*(p)->_p++)) 413#endif 414 415#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 416#define __sferror(p) (((p)->_flags & __SERR) != 0) 417#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 418#define __sfileno(p) ((p)->_file) 419 420extern int __isthreaded; 421 422#define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 423#define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 424#define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 425 426#if __POSIX_VISIBLE 427#define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 428#endif 429 430#define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 431#define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 432 433#define getchar() getc(stdin) 434#define putchar(x) putc(x, stdout) 435 436#if __BSD_VISIBLE 437/* 438 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 439 * B.8.2.7 for the rationale behind the *_unlocked() macros. 440 */ 441#define feof_unlocked(p) __sfeof(p) 442#define ferror_unlocked(p) __sferror(p) 443#define clearerr_unlocked(p) __sclearerr(p) 444#define fileno_unlocked(p) __sfileno(p) 445#endif 446#if __POSIX_VISIBLE >= 199506 447#define getc_unlocked(fp) __sgetc(fp) 448#define putc_unlocked(x, fp) __sputc(x, fp) 449 450#define getchar_unlocked() getc_unlocked(stdin) 451#define putchar_unlocked(x) putc_unlocked(x, stdout) 452#endif 453 454__END_DECLS 455#endif /* !_STDIO_H_ */ 456