stdio.h revision 104941
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 104941 2002-10-11 22:38:17Z peter $ 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 *__stdinp; 142extern FILE *__stdoutp; 143extern FILE *__stderrp; 144__END_DECLS 145 146#define __SLBF 0x0001 /* line buffered */ 147#define __SNBF 0x0002 /* unbuffered */ 148#define __SRD 0x0004 /* OK to read */ 149#define __SWR 0x0008 /* OK to write */ 150 /* RD and WR are never simultaneously asserted */ 151#define __SRW 0x0010 /* open for reading & writing */ 152#define __SEOF 0x0020 /* found EOF */ 153#define __SERR 0x0040 /* found error */ 154#define __SMBF 0x0080 /* _buf is from malloc */ 155#define __SAPP 0x0100 /* fdopen()ed in append mode */ 156#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 157#define __SOPT 0x0400 /* do fseek() optimization */ 158#define __SNPT 0x0800 /* do not do fseek() optimization */ 159#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 160#define __SMOD 0x2000 /* true => fgetln modified _p text */ 161#define __SALC 0x4000 /* allocate string space dynamically */ 162#define __SIGN 0x8000 /* ignore this file in _fwalk */ 163 164/* 165 * The following three definitions are for ANSI C, which took them 166 * from System V, which brilliantly took internal interface macros and 167 * made them official arguments to setvbuf(), without renaming them. 168 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 169 * 170 * Although numbered as their counterparts above, the implementation 171 * does not rely on this. 172 */ 173#define _IOFBF 0 /* setvbuf should set fully buffered */ 174#define _IOLBF 1 /* setvbuf should set line buffered */ 175#define _IONBF 2 /* setvbuf should set unbuffered */ 176 177#define BUFSIZ 1024 /* size of buffer used by setbuf */ 178#define EOF (-1) 179 180/* 181 * FOPEN_MAX is a minimum maximum, and is the number of streams that 182 * stdio can provide without attempting to allocate further resources 183 * (which could fail). Do not use this for anything. 184 */ 185 /* must be == _POSIX_STREAM_MAX <limits.h> */ 186#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 187#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 188 189/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 190#if __XSI_VISIBLE 191#define P_tmpdir "/var/tmp/" 192#endif 193#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 194#define TMP_MAX 308915776 195 196#ifndef SEEK_SET 197#define SEEK_SET 0 /* set file offset to offset */ 198#endif 199#ifndef SEEK_CUR 200#define SEEK_CUR 1 /* set file offset to current plus offset */ 201#endif 202#ifndef SEEK_END 203#define SEEK_END 2 /* set file offset to EOF plus offset */ 204#endif 205 206#define stdin __stdinp 207#define stdout __stdoutp 208#define stderr __stderrp 209 210__BEGIN_DECLS 211/* 212 * Functions defined in ANSI C standard. 213 * 214 * XXX fgetpos(), fgets(), fopen(), fputs(), fread(), freopen(), fscanf(), 215 * fwrite(), scanf(), sscanf(), vscanf(), and vsscanf() are missing the 216 * restrict type-qualifier. 217 */ 218void clearerr(FILE *); 219int fclose(FILE *); 220int feof(FILE *); 221int ferror(FILE *); 222int fflush(FILE *); 223int fgetc(FILE *); 224int fgetpos(FILE *, fpos_t *); 225char *fgets(char *, int, FILE *); 226FILE *fopen(const char *, const char *); 227int fprintf(FILE * __restrict, const char * __restrict, ...); 228int fputc(int, FILE *); 229int fputs(const char *, FILE *); 230size_t fread(void *, size_t, size_t, FILE *); 231FILE *freopen(const char *, const char *, FILE *); 232int fscanf(FILE *, const char *, ...); 233int fseek(FILE *, long, int); 234int fsetpos(FILE *, const fpos_t *); 235long ftell(FILE *); 236size_t fwrite(const void *, size_t, size_t, FILE *); 237int getc(FILE *); 238int getchar(void); 239char *gets(char *); 240void perror(const char *); 241int printf(const char * __restrict, ...); 242int putc(int, FILE *); 243int putchar(int); 244int puts(const char *); 245int remove(const char *); 246int rename(const char *, const char *); 247void rewind(FILE *); 248int scanf(const char *, ...); 249void setbuf(FILE * __restrict, char * __restrict); 250int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 251int sprintf(char * __restrict, const char * __restrict, ...); 252int sscanf(const char *, const char *, ...); 253FILE *tmpfile(void); 254char *tmpnam(char *); 255int ungetc(int, FILE *); 256int vfprintf(FILE * __restrict, const char * __restrict, 257 __va_list); 258int vprintf(const char * __restrict, __va_list); 259int vsprintf(char * __restrict, const char * __restrict, 260 __va_list); 261 262#if __ISO_C_VISIBLE >= 1999 263int snprintf(char * __restrict, size_t, const char * __restrict, 264 ...) __printflike(3, 4); 265int vscanf(const char *, __va_list) __scanflike(1, 0); 266int vsnprintf(char * __restrict, size_t, const char * __restrict, 267 __va_list) __printflike(3, 0); 268int vsscanf(const char *, const char *, __va_list) 269 __scanflike(2, 0); 270 271/* 272 * This is a #define because the function is used internally and 273 * (unlike vfscanf) the name __vfscanf is guaranteed not to collide 274 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 275 * 276 * XXX missing a backing function (weak alias?) for this. 277 */ 278#define vfscanf __vfscanf 279#endif 280 281/* 282 * Functions defined in all versions of POSIX 1003.1. 283 */ 284#if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 285/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 286#define L_cuserid 17 /* legacy */ 287#endif 288 289#if __POSIX_VISIBLE 290#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 291 292char *ctermid(char *); 293FILE *fdopen(int, const char *); 294int fileno(FILE *); 295#endif /* __POSIX_VISIBLE */ 296 297#if __POSIX_VISIBLE >= 199209 298int pclose(FILE *); 299FILE *popen(const char *, const char *); 300#endif 301 302#if __POSIX_VISIBLE >= 199506 303int ftrylockfile(FILE *); 304void flockfile(FILE *); 305void funlockfile(FILE *); 306 307/* 308 * These are normally used through macros as defined below, but POSIX 309 * requires functions as well. 310 */ 311int getc_unlocked(FILE *); 312int getchar_unlocked(void); 313int putc_unlocked(int, FILE *); 314int putchar_unlocked(int); 315#endif 316 317#if __POSIX_VISIBLE >= 200112 318int fseeko(FILE *, __off_t, int); 319__off_t ftello(FILE *); 320#endif 321 322#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 323int getw(FILE *); 324int putw(int, FILE *); 325#endif /* BSD or X/Open before issue 6 */ 326 327#if __XSI_VISIBLE 328char *tempnam(const char *, const char *); 329#endif 330 331/* 332 * Routines that are purely local. 333 */ 334#if __BSD_VISIBLE 335int asprintf(char **, const char *, ...) __printflike(2, 3); 336char *ctermid_r(char *); 337char *fgetln(FILE *, size_t *); 338#if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3 339#define __ATTR_FORMAT_ARG __attribute__((__format_arg__(2))) 340#else 341#define __ATTR_FORMAT_ARG 342#endif 343__const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG; 344int fpurge(FILE *); 345void setbuffer(FILE *, char *, int); 346int setlinebuf(FILE *); 347int vasprintf(char **, const char *, __va_list) 348 __printflike(2, 0); 349 350/* 351 * The system error table contains messages for the first sys_nerr 352 * positive errno values. Use strerror() or strerror_r() from <string.h> 353 * instead. 354 */ 355extern __const int sys_nerr; 356extern __const char *__const sys_errlist[]; 357 358/* 359 * Stdio function-access interface. 360 */ 361FILE *funopen(const void *, 362 int (*)(void *, char *, int), 363 int (*)(void *, const char *, int), 364 fpos_t (*)(void *, fpos_t, int), 365 int (*)(void *)); 366#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 367#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 368 369/* 370 * Portability hacks. See <sys/types.h>. 371 */ 372#ifndef _FTRUNCATE_DECLARED 373#define _FTRUNCATE_DECLARED 374int ftruncate(int, __off_t); 375#endif 376#ifndef _LSEEK_DECLARED 377#define _LSEEK_DECLARED 378__off_t lseek(int, __off_t, int); 379#endif 380#ifndef _MMAP_DECLARED 381#define _MMAP_DECLARED 382void *mmap(void *, size_t, int, int, int, __off_t); 383#endif 384#ifndef _TRUNCATE_DECLARED 385#define _TRUNCATE_DECLARED 386int truncate(const char *, __off_t); 387#endif 388#endif /* __BSD_VISIBLE */ 389 390/* 391 * Functions internal to the implementation. 392 */ 393int __srget(FILE *); 394int __vfscanf(FILE *, const char *, __va_list); 395int __svfscanf(FILE *, const char *, __va_list); 396int __swbuf(int, FILE *); 397 398/* 399 * The __sfoo macros are here so that we can 400 * define function versions in the C library. 401 */ 402#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 403#if defined(__GNUC__) && defined(__STDC__) 404static __inline int __sputc(int _c, FILE *_p) { 405 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 406 return (*_p->_p++ = _c); 407 else 408 return (__swbuf(_c, _p)); 409} 410#else 411/* 412 * This has been tuned to generate reasonable code on the vax using pcc. 413 */ 414#define __sputc(c, p) \ 415 (--(p)->_w < 0 ? \ 416 (p)->_w >= (p)->_lbfsize ? \ 417 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 418 (int)*(p)->_p++ : \ 419 __swbuf('\n', p) : \ 420 __swbuf((int)(c), p) : \ 421 (*(p)->_p = (c), (int)*(p)->_p++)) 422#endif 423 424#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 425#define __sferror(p) (((p)->_flags & __SERR) != 0) 426#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 427#define __sfileno(p) ((p)->_file) 428 429#if __BSD_VISIBLE 430/* 431 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 432 * B.8.2.7 for the rationale behind the *_unlocked() macros. 433 */ 434#define feof_unlocked(p) __sfeof(p) 435#define ferror_unlocked(p) __sferror(p) 436#define clearerr_unlocked(p) __sclearerr(p) 437#define fileno_unlocked(p) __sfileno(p) 438#endif 439#if __POSIX_VISIBLE >= 199506 440#define getc_unlocked(fp) __sgetc(fp) 441#define putc_unlocked(x, fp) __sputc(x, fp) 442 443#define getchar_unlocked() getc_unlocked(stdin) 444#define putchar_unlocked(x) putc_unlocked(x, stdout) 445#endif 446 447__END_DECLS 448#endif /* !_STDIO_H_ */ 449