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