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