stdio.h revision 178282
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 178282 2008-04-17 19:06:00Z jhb $ 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 * 102 * Certain members of __sFILE are accessed directly via macros or 103 * inline functions. To preserve ABI compat, these members must not 104 * be disturbed. These members are marked below with (*). 105 */ 106typedef struct __sFILE { 107 unsigned char *_p; /* (*) current position in (some) buffer */ 108 int _r; /* (*) read space left for getc() */ 109 int _w; /* (*) write space left for putc() */ 110 short _flags; /* (*) flags, below; this FILE is free if 0 */ 111 short _file; /* (*) fileno, if Unix descriptor, else -1 */ 112 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 113 int _lbfsize; /* (*) 0 or -_bf._size, for inline putc */ 114 115 /* operations */ 116 void *_cookie; /* cookie passed to io functions */ 117 int (*_close)(void *); 118 int (*_read)(void *, char *, int); 119 fpos_t (*_seek)(void *, fpos_t, int); 120 int (*_write)(void *, const char *, int); 121 122 /* separate buffer for long sequences of ungetc() */ 123 struct __sbuf _ub; /* ungetc buffer */ 124 struct __sFILEX *_extra; /* additions to FILE to not break ABI */ 125 int _ur; /* saved _r when _r is counting ungetc data */ 126 127 /* tricks to meet minimum requirements even when malloc() fails */ 128 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 129 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 130 131 /* separate buffer for fgetln() when line crosses buffer boundary */ 132 struct __sbuf _lb; /* buffer for fgetln() */ 133 134 /* Unix stdio files get aligned to block boundaries on fseek() */ 135 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 136 fpos_t _offset; /* current lseek offset */ 137} FILE; 138 139#ifndef _STDSTREAM_DECLARED 140__BEGIN_DECLS 141extern FILE *__stdinp; 142extern FILE *__stdoutp; 143extern FILE *__stderrp; 144__END_DECLS 145#define _STDSTREAM_DECLARED 146#endif 147 148#define __SLBF 0x0001 /* line buffered */ 149#define __SNBF 0x0002 /* unbuffered */ 150#define __SRD 0x0004 /* OK to read */ 151#define __SWR 0x0008 /* OK to write */ 152 /* RD and WR are never simultaneously asserted */ 153#define __SRW 0x0010 /* open for reading & writing */ 154#define __SEOF 0x0020 /* found EOF */ 155#define __SERR 0x0040 /* found error */ 156#define __SMBF 0x0080 /* _buf is from malloc */ 157#define __SAPP 0x0100 /* fdopen()ed in append mode */ 158#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 159#define __SOPT 0x0400 /* do fseek() optimization */ 160#define __SNPT 0x0800 /* do not do fseek() optimization */ 161#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 162#define __SMOD 0x2000 /* true => fgetln modified _p text */ 163#define __SALC 0x4000 /* allocate string space dynamically */ 164#define __SIGN 0x8000 /* ignore this file in _fwalk */ 165 166/* 167 * The following three definitions are for ANSI C, which took them 168 * from System V, which brilliantly took internal interface macros and 169 * made them official arguments to setvbuf(), without renaming them. 170 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 171 * 172 * Although numbered as their counterparts above, the implementation 173 * does not rely on this. 174 */ 175#define _IOFBF 0 /* setvbuf should set fully buffered */ 176#define _IOLBF 1 /* setvbuf should set line buffered */ 177#define _IONBF 2 /* setvbuf should set unbuffered */ 178 179#define BUFSIZ 1024 /* size of buffer used by setbuf */ 180#define EOF (-1) 181 182/* 183 * FOPEN_MAX is a minimum maximum, and is the number of streams that 184 * stdio can provide without attempting to allocate further resources 185 * (which could fail). Do not use this for anything. 186 */ 187 /* must be == _POSIX_STREAM_MAX <limits.h> */ 188#ifndef FOPEN_MAX 189#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 190#endif 191#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 192 193/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 194#if __XSI_VISIBLE 195#define P_tmpdir "/var/tmp/" 196#endif 197#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 198#define TMP_MAX 308915776 199 200#ifndef SEEK_SET 201#define SEEK_SET 0 /* set file offset to offset */ 202#endif 203#ifndef SEEK_CUR 204#define SEEK_CUR 1 /* set file offset to current plus offset */ 205#endif 206#ifndef SEEK_END 207#define SEEK_END 2 /* set file offset to EOF plus offset */ 208#endif 209 210#define stdin __stdinp 211#define stdout __stdoutp 212#define stderr __stderrp 213 214__BEGIN_DECLS 215/* 216 * Functions defined in ANSI C standard. 217 */ 218void clearerr(FILE *); 219int fclose(FILE *); 220int feof(FILE *); 221int ferror(FILE *); 222int fflush(FILE *); 223int fgetc(FILE *); 224int fgetpos(FILE * __restrict, fpos_t * __restrict); 225char *fgets(char * __restrict, int, FILE * __restrict); 226FILE *fopen(const char * __restrict, const char * __restrict); 227int fprintf(FILE * __restrict, const char * __restrict, ...); 228int fputc(int, FILE *); 229int fputs(const char * __restrict, FILE * __restrict); 230size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 231FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict); 232int fscanf(FILE * __restrict, const char * __restrict, ...); 233int fseek(FILE *, long, int); 234int fsetpos(FILE *, const fpos_t *); 235long ftell(FILE *); 236size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 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 * __restrict, ...); 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 * __restrict, const char * __restrict, ...); 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 vfscanf(FILE * __restrict, const char * __restrict, __va_list) 266 __scanflike(2, 0); 267int vscanf(const char * __restrict, __va_list) __scanflike(1, 0); 268int vsnprintf(char * __restrict, size_t, const char * __restrict, 269 __va_list) __printflike(3, 0); 270int vsscanf(const char * __restrict, const char * __restrict, __va_list) 271 __scanflike(2, 0); 272#endif 273 274/* 275 * Functions defined in all versions of POSIX 1003.1. 276 */ 277#if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 278/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 279#define L_cuserid 17 /* legacy */ 280#endif 281 282#if __POSIX_VISIBLE 283#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 284 285char *ctermid(char *); 286FILE *fdopen(int, const char *); 287int fileno(FILE *); 288#endif /* __POSIX_VISIBLE */ 289 290#if __POSIX_VISIBLE >= 199209 291int pclose(FILE *); 292FILE *popen(const char *, const char *); 293#endif 294 295#if __POSIX_VISIBLE >= 199506 296int ftrylockfile(FILE *); 297void flockfile(FILE *); 298void funlockfile(FILE *); 299 300/* 301 * These are normally used through macros as defined below, but POSIX 302 * requires functions as well. 303 */ 304int getc_unlocked(FILE *); 305int getchar_unlocked(void); 306int putc_unlocked(int, FILE *); 307int putchar_unlocked(int); 308#endif 309#if __BSD_VISIBLE 310void clearerr_unlocked(FILE *); 311int feof_unlocked(FILE *); 312int ferror_unlocked(FILE *); 313int fileno_unlocked(FILE *); 314#endif 315 316#if __POSIX_VISIBLE >= 200112 317int fseeko(FILE *, __off_t, int); 318__off_t ftello(FILE *); 319#endif 320 321#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 322int getw(FILE *); 323int putw(int, FILE *); 324#endif /* BSD or X/Open before issue 6 */ 325 326#if __XSI_VISIBLE 327char *tempnam(const char *, const char *); 328#endif 329 330/* 331 * Routines that are purely local. 332 */ 333#if __BSD_VISIBLE 334int asprintf(char **, const char *, ...) __printflike(2, 3); 335char *ctermid_r(char *); 336void fcloseall(void); 337char *fgetln(FILE *, size_t *); 338__const char *fmtcheck(const char *, const char *) __format_arg(2); 339int fpurge(FILE *); 340void setbuffer(FILE *, char *, int); 341int setlinebuf(FILE *); 342int vasprintf(char **, const char *, __va_list) 343 __printflike(2, 0); 344 345/* 346 * The system error table contains messages for the first sys_nerr 347 * positive errno values. Use strerror() or strerror_r() from <string.h> 348 * instead. 349 */ 350extern __const int sys_nerr; 351extern __const char *__const sys_errlist[]; 352 353/* 354 * Stdio function-access interface. 355 */ 356FILE *funopen(const void *, 357 int (*)(void *, char *, int), 358 int (*)(void *, const char *, int), 359 fpos_t (*)(void *, fpos_t, int), 360 int (*)(void *)); 361#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 362#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 363 364/* 365 * Portability hacks. See <sys/types.h>. 366 */ 367#ifndef _FTRUNCATE_DECLARED 368#define _FTRUNCATE_DECLARED 369int ftruncate(int, __off_t); 370#endif 371#ifndef _LSEEK_DECLARED 372#define _LSEEK_DECLARED 373__off_t lseek(int, __off_t, int); 374#endif 375#ifndef _MMAP_DECLARED 376#define _MMAP_DECLARED 377void *mmap(void *, size_t, int, int, int, __off_t); 378#endif 379#ifndef _TRUNCATE_DECLARED 380#define _TRUNCATE_DECLARED 381int truncate(const char *, __off_t); 382#endif 383#endif /* __BSD_VISIBLE */ 384 385/* 386 * Functions internal to the implementation. 387 */ 388int __srget(FILE *); 389int __swbuf(int, FILE *); 390 391/* 392 * The __sfoo macros are here so that we can 393 * define function versions in the C library. 394 */ 395#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 396#if defined(__GNUC__) && defined(__STDC__) 397static __inline int __sputc(int _c, FILE *_p) { 398 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 399 return (*_p->_p++ = _c); 400 else 401 return (__swbuf(_c, _p)); 402} 403#else 404/* 405 * This has been tuned to generate reasonable code on the vax using pcc. 406 */ 407#define __sputc(c, p) \ 408 (--(p)->_w < 0 ? \ 409 (p)->_w >= (p)->_lbfsize ? \ 410 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 411 (int)*(p)->_p++ : \ 412 __swbuf('\n', p) : \ 413 __swbuf((int)(c), p) : \ 414 (*(p)->_p = (c), (int)*(p)->_p++)) 415#endif 416 417#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 418#define __sferror(p) (((p)->_flags & __SERR) != 0) 419#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 420#define __sfileno(p) ((p)->_file) 421 422extern int __isthreaded; 423 424#define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 425#define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 426#define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 427 428#if __POSIX_VISIBLE 429#define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 430#endif 431 432#define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 433#define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 434 435#define getchar() getc(stdin) 436#define putchar(x) putc(x, stdout) 437 438#if __BSD_VISIBLE 439/* 440 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 441 * B.8.2.7 for the rationale behind the *_unlocked() macros. 442 */ 443#define feof_unlocked(p) __sfeof(p) 444#define ferror_unlocked(p) __sferror(p) 445#define clearerr_unlocked(p) __sclearerr(p) 446#define fileno_unlocked(p) __sfileno(p) 447#endif 448#if __POSIX_VISIBLE >= 199506 449#define getc_unlocked(fp) __sgetc(fp) 450#define putc_unlocked(x, fp) __sputc(x, fp) 451 452#define getchar_unlocked() getc_unlocked(stdin) 453#define putchar_unlocked(x) putc_unlocked(x, stdout) 454#endif 455 456#if __BSD_VISIBLE 457int renameat(int, const char *, int, const char *); 458#endif 459__END_DECLS 460#endif /* !_STDIO_H_ */ 461