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