stdio.h revision 104585
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 104585 2002-10-06 22:16:12Z mike $ 38 */ 39 40#ifndef _STDIO_H_ 41#define _STDIO_H_ 42 43#include <sys/cdefs.h> 44#include <sys/_types.h> 45 46typedef __off_t fpos_t; 47 48#ifndef _SIZE_T_DECLARED 49typedef __size_t size_t; 50#define _SIZE_T_DECLARED 51#endif 52 53#if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE 54#ifndef _VA_LIST_DECLARED 55typedef __va_list va_list; 56#define _VA_LIST_DECLARED 57#endif 58#endif 59 60#ifndef NULL 61#define NULL 0 62#endif 63 64#define _FSTDIO /* Define for new stdio with functions. */ 65 66/* 67 * NB: to fit things in six character monocase externals, the stdio 68 * code uses the prefix `__s' for stdio objects, typically followed 69 * by a three-character attempt at a mnemonic. 70 */ 71 72/* stdio buffers */ 73struct __sbuf { 74 unsigned char *_base; 75 int _size; 76}; 77 78/* hold a buncha junk that would grow the ABI */ 79struct __sFILEX; 80 81/* 82 * stdio state variables. 83 * 84 * The following always hold: 85 * 86 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 87 * _lbfsize is -_bf._size, else _lbfsize is 0 88 * if _flags&__SRD, _w is 0 89 * if _flags&__SWR, _r is 0 90 * 91 * This ensures that the getc and putc macros (or inline functions) never 92 * try to write or read from a file that is in `read' or `write' mode. 93 * (Moreover, they can, and do, automatically switch from read mode to 94 * write mode, and back, on "r+" and "w+" files.) 95 * 96 * _lbfsize is used only to make the inline line-buffered output stream 97 * code as compact as possible. 98 * 99 * _ub, _up, and _ur are used when ungetc() pushes back more characters 100 * than fit in the current _bf, or when ungetc() pushes back a character 101 * that does not match the previous one in _bf. When this happens, 102 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 103 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 104 * 105 * NB: see WARNING above before changing the layout of this structure! 106 */ 107typedef struct __sFILE { 108 unsigned char *_p; /* current position in (some) buffer */ 109 int _r; /* read space left for getc() */ 110 int _w; /* write space left for putc() */ 111 short _flags; /* flags, below; this FILE is free if 0 */ 112 short _file; /* fileno, if Unix descriptor, else -1 */ 113 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 114 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 115 116 /* operations */ 117 void *_cookie; /* cookie passed to io functions */ 118 int (*_close)(void *); 119 int (*_read)(void *, char *, int); 120 fpos_t (*_seek)(void *, fpos_t, int); 121 int (*_write)(void *, const char *, int); 122 123 /* separate buffer for long sequences of ungetc() */ 124 struct __sbuf _ub; /* ungetc buffer */ 125 struct __sFILEX *_extra; /* additions to FILE to not break ABI */ 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 (see WARNING) */ 138} FILE; 139 140__BEGIN_DECLS 141extern FILE __sF[]; 142extern FILE *__stdinp; 143extern FILE *__stdoutp; 144extern FILE *__stderrp; 145__END_DECLS 146 147#define __SLBF 0x0001 /* line buffered */ 148#define __SNBF 0x0002 /* unbuffered */ 149#define __SRD 0x0004 /* OK to read */ 150#define __SWR 0x0008 /* OK to write */ 151 /* RD and WR are never simultaneously asserted */ 152#define __SRW 0x0010 /* open for reading & writing */ 153#define __SEOF 0x0020 /* found EOF */ 154#define __SERR 0x0040 /* found error */ 155#define __SMBF 0x0080 /* _buf is from malloc */ 156#define __SAPP 0x0100 /* fdopen()ed in append mode */ 157#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 158#define __SOPT 0x0400 /* do fseek() optimization */ 159#define __SNPT 0x0800 /* do not do fseek() optimization */ 160#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 161#define __SMOD 0x2000 /* true => fgetln modified _p text */ 162#define __SALC 0x4000 /* allocate string space dynamically */ 163#define __SIGN 0x8000 /* ignore this file in _fwalk */ 164 165/* 166 * The following three definitions are for ANSI C, which took them 167 * from System V, which brilliantly took internal interface macros and 168 * made them official arguments to setvbuf(), without renaming them. 169 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 170 * 171 * Although numbered as their counterparts above, the implementation 172 * does not rely on this. 173 */ 174#define _IOFBF 0 /* setvbuf should set fully buffered */ 175#define _IOLBF 1 /* setvbuf should set line buffered */ 176#define _IONBF 2 /* setvbuf should set unbuffered */ 177 178#define BUFSIZ 1024 /* size of buffer used by setbuf */ 179#define EOF (-1) 180 181/* 182 * FOPEN_MAX is a minimum maximum, and is the number of streams that 183 * stdio can provide without attempting to allocate further resources 184 * (which could fail). Do not use this for anything. 185 */ 186 /* must be == _POSIX_STREAM_MAX <limits.h> */ 187#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 188#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 189 190/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 191#if __XSI_VISIBLE 192#define P_tmpdir "/var/tmp/" 193#endif 194#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 195#define TMP_MAX 308915776 196 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/* To be removed by 5.0-RELEASE */ 208#if (defined(__i386__) || defined(__alpha__)) && defined(_OLD_STDIO) 209#define stdin (&__sF[0]) 210#define stdout (&__sF[1]) 211#define stderr (&__sF[2]) 212#else 213#define stdin __stdinp 214#define stdout __stdoutp 215#define stderr __stderrp 216#endif 217 218__BEGIN_DECLS 219/* 220 * Functions defined in ANSI C standard. 221 * 222 * XXX fgetpos(), fgets(), fopen(), fputs(), fread(), freopen(), fscanf(), 223 * fwrite(), scanf(), sscanf(), vscanf(), and vsscanf() are missing the 224 * restrict type-qualifier. 225 */ 226void clearerr(FILE *); 227int fclose(FILE *); 228int feof(FILE *); 229int ferror(FILE *); 230int fflush(FILE *); 231int fgetc(FILE *); 232int fgetpos(FILE *, fpos_t *); 233char *fgets(char *, int, FILE *); 234FILE *fopen(const char *, const char *); 235int fprintf(FILE * __restrict, const char * __restrict, ...); 236int fputc(int, FILE *); 237int fputs(const char *, FILE *); 238size_t fread(void *, size_t, size_t, FILE *); 239FILE *freopen(const char *, const char *, FILE *); 240int fscanf(FILE *, const char *, ...); 241int fseek(FILE *, long, int); 242int fsetpos(FILE *, const fpos_t *); 243long ftell(FILE *); 244size_t fwrite(const void *, size_t, size_t, FILE *); 245int getc(FILE *); 246int getchar(void); 247char *gets(char *); 248void perror(const char *); 249int printf(const char * __restrict, ...); 250int putc(int, FILE *); 251int putchar(int); 252int puts(const char *); 253int remove(const char *); 254int rename(const char *, const char *); 255void rewind(FILE *); 256int scanf(const char *, ...); 257void setbuf(FILE * __restrict, char * __restrict); 258int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 259int sprintf(char * __restrict, const char * __restrict, ...); 260int sscanf(const char *, const char *, ...); 261FILE *tmpfile(void); 262char *tmpnam(char *); 263int ungetc(int, FILE *); 264int vfprintf(FILE * __restrict, const char * __restrict, 265 __va_list); 266int vprintf(const char * __restrict, __va_list); 267int vsprintf(char * __restrict, const char * __restrict, 268 __va_list); 269 270#if __ISO_C_VISIBLE >= 1999 271int snprintf(char * __restrict, size_t, const char * __restrict, 272 ...) __printflike(3, 4); 273int vscanf(const char *, __va_list) __scanflike(1, 0); 274int vsnprintf(char * __restrict, size_t, const char * __restrict, 275 __va_list) __printflike(3, 0); 276int vsscanf(const char *, const char *, __va_list) 277 __scanflike(2, 0); 278 279/* 280 * This is a #define because the function is used internally and 281 * (unlike vfscanf) the name __vfscanf is guaranteed not to collide 282 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 283 * 284 * XXX missing a backing function (weak alias?) for this. 285 */ 286#define vfscanf __vfscanf 287#endif 288 289/* 290 * Functions defined in all versions of POSIX 1003.1. 291 */ 292#if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 293/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 294#define L_cuserid 17 /* legacy */ 295#endif 296 297#if __POSIX_VISIBLE 298#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 299 300char *ctermid(char *); 301FILE *fdopen(int, const char *); 302int fileno(FILE *); 303#endif /* __POSIX_VISIBLE */ 304 305#if __POSIX_VISIBLE >= 199209 306int pclose(FILE *); 307FILE *popen(const char *, const char *); 308#endif 309 310#if __POSIX_VISIBLE >= 199506 311int ftrylockfile(FILE *); 312void flockfile(FILE *); 313void funlockfile(FILE *); 314 315/* 316 * These are normally used through macros as defined below, but POSIX 317 * requires functions as well. 318 */ 319int getc_unlocked(FILE *); 320int getchar_unlocked(void); 321int putc_unlocked(int, FILE *); 322int putchar_unlocked(int); 323#endif 324 325#if __POSIX_VISIBLE >= 200112 326int fseeko(FILE *, __off_t, int); 327__off_t ftello(FILE *); 328#endif 329 330#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 331int getw(FILE *); 332int putw(int, FILE *); 333#endif /* BSD or X/Open before issue 6 */ 334 335#if __XSI_VISIBLE 336char *tempnam(const char *, const char *); 337#endif 338 339/* 340 * Routines that are purely local. 341 */ 342#if __BSD_VISIBLE 343int asprintf(char **, const char *, ...) __printflike(2, 3); 344char *ctermid_r(char *); 345char *fgetln(FILE *, size_t *); 346#if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3 347#define __ATTR_FORMAT_ARG __attribute__((__format_arg__(2))) 348#else 349#define __ATTR_FORMAT_ARG 350#endif 351__const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG; 352int fpurge(FILE *); 353void setbuffer(FILE *, char *, int); 354int setlinebuf(FILE *); 355int vasprintf(char **, const char *, __va_list) 356 __printflike(2, 0); 357 358/* 359 * The system error table contains messages for the first sys_nerr 360 * positive errno values. Use strerror() or strerror_r() from <string.h> 361 * instead. 362 */ 363extern __const int sys_nerr; 364extern __const char *__const sys_errlist[]; 365 366/* 367 * Stdio function-access interface. 368 */ 369FILE *funopen(const void *, 370 int (*)(void *, char *, int), 371 int (*)(void *, const char *, int), 372 fpos_t (*)(void *, fpos_t, int), 373 int (*)(void *)); 374#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 375#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 376 377/* 378 * Portability hacks. See <sys/types.h>. 379 */ 380#ifndef _FTRUNCATE_DECLARED 381#define _FTRUNCATE_DECLARED 382int ftruncate(int, __off_t); 383#endif 384#ifndef _LSEEK_DECLARED 385#define _LSEEK_DECLARED 386__off_t lseek(int, __off_t, int); 387#endif 388#ifndef _MMAP_DECLARED 389#define _MMAP_DECLARED 390void *mmap(void *, size_t, int, int, int, __off_t); 391#endif 392#ifndef _TRUNCATE_DECLARED 393#define _TRUNCATE_DECLARED 394int truncate(const char *, __off_t); 395#endif 396#endif /* __BSD_VISIBLE */ 397 398/* 399 * Functions internal to the implementation. 400 */ 401int __srget(FILE *); 402int __vfscanf(FILE *, const char *, __va_list); 403int __svfscanf(FILE *, const char *, __va_list); 404int __swbuf(int, FILE *); 405 406/* 407 * The __sfoo macros are here so that we can 408 * define function versions in the C library. 409 */ 410#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 411#if defined(__GNUC__) && defined(__STDC__) 412static __inline int __sputc(int _c, FILE *_p) { 413 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 414 return (*_p->_p++ = _c); 415 else 416 return (__swbuf(_c, _p)); 417} 418#else 419/* 420 * This has been tuned to generate reasonable code on the vax using pcc. 421 */ 422#define __sputc(c, p) \ 423 (--(p)->_w < 0 ? \ 424 (p)->_w >= (p)->_lbfsize ? \ 425 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 426 (int)*(p)->_p++ : \ 427 __swbuf('\n', p) : \ 428 __swbuf((int)(c), p) : \ 429 (*(p)->_p = (c), (int)*(p)->_p++)) 430#endif 431 432#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 433#define __sferror(p) (((p)->_flags & __SERR) != 0) 434#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 435#define __sfileno(p) ((p)->_file) 436 437#if __BSD_VISIBLE 438/* 439 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 440 * B.8.2.7 for the rationale behind the *_unlocked() macros. 441 */ 442#define feof_unlocked(p) __sfeof(p) 443#define ferror_unlocked(p) __sferror(p) 444#define clearerr_unlocked(p) __sclearerr(p) 445#define fileno_unlocked(p) __sfileno(p) 446#endif 447#if __POSIX_VISIBLE >= 199506 448#define getc_unlocked(fp) __sgetc(fp) 449#define putc_unlocked(x, fp) __sputc(x, fp) 450 451#define getchar_unlocked() getc_unlocked(stdin) 452#define putchar_unlocked(x) putc_unlocked(x, stdout) 453#endif 454 455__END_DECLS 456#endif /* !_STDIO_H_ */ 457