stdio.h revision 23260
1779Sjoehw/*- 2968Sfyuan * Copyright (c) 1990, 1993 3779Sjoehw * The Regents of the University of California. All rights reserved. 4779Sjoehw * 5779Sjoehw * This code is derived from software contributed to Berkeley by 6779Sjoehw * Chris Torek. 7779Sjoehw * 8779Sjoehw * Redistribution and use in source and binary forms, with or without 9779Sjoehw * modification, are permitted provided that the following conditions 10779Sjoehw * are met: 11779Sjoehw * 1. Redistributions of source code must retain the above copyright 12779Sjoehw * notice, this list of conditions and the following disclaimer. 13779Sjoehw * 2. Redistributions in binary form must reproduce the above copyright 14779Sjoehw * notice, this list of conditions and the following disclaimer in the 15779Sjoehw * documentation and/or other materials provided with the distribution. 16779Sjoehw * 3. All advertising materials mentioning features or use of this software 17779Sjoehw * must display the following acknowledgement: 18779Sjoehw * This product includes software developed by the University of 19779Sjoehw * California, Berkeley and its contributors. 20779Sjoehw * 4. Neither the name of the University nor the names of its contributors 21779Sjoehw * may be used to endorse or promote products derived from this software 22779Sjoehw * without specific prior written permission. 23779Sjoehw * 24779Sjoehw * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25779Sjoehw * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 261087Sfyuan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27968Sfyuan * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28968Sfyuan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29779Sjoehw * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30779Sjoehw * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31779Sjoehw * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32968Sfyuan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33779Sjoehw * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34779Sjoehw * SUCH DAMAGE. 35779Sjoehw * 36779Sjoehw * @(#)stdio.h 8.4 (Berkeley) 1/4/94 37779Sjoehw * $Id: stdio.h,v 1.10 1997/02/23 09:17:15 peter Exp $ 38779Sjoehw */ 39779Sjoehw 40779Sjoehw#ifndef _STDIO_H_ 41779Sjoehw#define _STDIO_H_ 42779Sjoehw 43779Sjoehw#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 44779Sjoehw#include <sys/types.h> 45779Sjoehw#endif 46968Sfyuan 47779Sjoehw#include <sys/cdefs.h> 48779Sjoehw 49779Sjoehw#include <machine/ansi.h> 50779Sjoehw#ifdef _BSD_SIZE_T_ 51968Sfyuantypedef _BSD_SIZE_T_ size_t; 52968Sfyuan#undef _BSD_SIZE_T_ 53968Sfyuan#endif 54968Sfyuan 55779Sjoehw#ifndef NULL 56779Sjoehw#define NULL 0 57968Sfyuan#endif 58779Sjoehw 59779Sjoehw/* 60779Sjoehw * This is fairly grotesque, but pure ANSI code must not inspect the 61779Sjoehw * innards of an fpos_t anyway. The library internally uses off_t, 62779Sjoehw * which we assume is exactly as big as eight chars. (When we switch 63779Sjoehw * to gcc 2.4 we will use __attribute__ here.) 64779Sjoehw * 651087Sfyuan * WARNING: the alignment constraints on an off_t and the struct below 66779Sjoehw * differ on (e.g.) the SPARC. Hence, the placement of an fpos_t object 67779Sjoehw * in a structure will change if fpos_t's are not aligned on 8-byte 68779Sjoehw * boundaries. THIS IS A CROCK, but for now there is no way around it. 69779Sjoehw */ 70779Sjoehw#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 71779Sjoehwtypedef off_t fpos_t; 72779Sjoehw#else 73779Sjoehwtypedef struct __sfpos { 74779Sjoehw char _pos[8]; 75779Sjoehw} fpos_t; 76779Sjoehw#endif 77779Sjoehw 78779Sjoehw#define _FSTDIO /* Define for new stdio with functions. */ 79779Sjoehw 80779Sjoehw/* 81779Sjoehw * NB: to fit things in six character monocase externals, the stdio 82779Sjoehw * code uses the prefix `__s' for stdio objects, typically followed 83779Sjoehw * by a three-character attempt at a mnemonic. 84779Sjoehw */ 85779Sjoehw 86779Sjoehw/* stdio buffers */ 87779Sjoehwstruct __sbuf { 88779Sjoehw unsigned char *_base; 89779Sjoehw int _size; 90779Sjoehw}; 91779Sjoehw 921087Sfyuan/* 93779Sjoehw * stdio state variables. 94779Sjoehw * 95779Sjoehw * The following always hold: 96779Sjoehw * 97779Sjoehw * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 98968Sfyuan * _lbfsize is -_bf._size, else _lbfsize is 0 99968Sfyuan * if _flags&__SRD, _w is 0 100968Sfyuan * if _flags&__SWR, _r is 0 101779Sjoehw * 102779Sjoehw * This ensures that the getc and putc macros (or inline functions) never 103779Sjoehw * try to write or read from a file that is in `read' or `write' mode. 104779Sjoehw * (Moreover, they can, and do, automatically switch from read mode to 105779Sjoehw * write mode, and back, on "r+" and "w+" files.) 106779Sjoehw * 107779Sjoehw * _lbfsize is used only to make the inline line-buffered output stream 108779Sjoehw * code as compact as possible. 109779Sjoehw * 110779Sjoehw * _ub, _up, and _ur are used when ungetc() pushes back more characters 111779Sjoehw * than fit in the current _bf, or when ungetc() pushes back a character 112779Sjoehw * that does not match the previous one in _bf. When this happens, 113779Sjoehw * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 114779Sjoehw * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 115779Sjoehw * 116779Sjoehw * NB: see WARNING above before changing the layout of this structure! 117779Sjoehw */ 118779Sjoehwtypedef struct __sFILE { 119779Sjoehw unsigned char *_p; /* current position in (some) buffer */ 120779Sjoehw int _r; /* read space left for getc() */ 1211087Sfyuan int _w; /* write space left for putc() */ 122779Sjoehw short _flags; /* flags, below; this FILE is free if 0 */ 123779Sjoehw short _file; /* fileno, if Unix descriptor, else -1 */ 124779Sjoehw struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 125779Sjoehw int _lbfsize; /* 0 or -_bf._size, for inline putc */ 126779Sjoehw 127779Sjoehw /* operations */ 128968Sfyuan void *_cookie; /* cookie passed to io functions */ 129968Sfyuan int (*_close) __P((void *)); 130968Sfyuan int (*_read) __P((void *, char *, int)); 131779Sjoehw fpos_t (*_seek) __P((void *, fpos_t, int)); 132779Sjoehw int (*_write) __P((void *, const char *, int)); 133779Sjoehw 134779Sjoehw /* separate buffer for long sequences of ungetc() */ 135779Sjoehw struct __sbuf _ub; /* ungetc buffer */ 136779Sjoehw unsigned char *_up; /* saved _p when _p is doing ungetc data */ 137779Sjoehw int _ur; /* saved _r when _r is counting ungetc data */ 138779Sjoehw 139779Sjoehw /* tricks to meet minimum requirements even when malloc() fails */ 140779Sjoehw unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 141779Sjoehw unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 142779Sjoehw 143779Sjoehw /* separate buffer for fgetln() when line crosses buffer boundary */ 144779Sjoehw struct __sbuf _lb; /* buffer for fgetln() */ 145779Sjoehw 146779Sjoehw /* Unix stdio files get aligned to block boundaries on fseek() */ 147779Sjoehw int _blksize; /* stat.st_blksize (may be != _bf._size) */ 1481087Sfyuan fpos_t _offset; /* current lseek offset (see WARNING) */ 149779Sjoehw} FILE; 150779Sjoehw 151779Sjoehw__BEGIN_DECLS 152779Sjoehwextern FILE __sF[]; 153779Sjoehw__END_DECLS 154779Sjoehw 155779Sjoehw#define __SLBF 0x0001 /* line buffered */ 156779Sjoehw#define __SNBF 0x0002 /* unbuffered */ 157779Sjoehw#define __SRD 0x0004 /* OK to read */ 158779Sjoehw#define __SWR 0x0008 /* OK to write */ 159779Sjoehw /* RD and WR are never simultaneously asserted */ 160779Sjoehw#define __SRW 0x0010 /* open for reading & writing */ 161779Sjoehw#define __SEOF 0x0020 /* found EOF */ 162779Sjoehw#define __SERR 0x0040 /* found error */ 163779Sjoehw#define __SMBF 0x0080 /* _buf is from malloc */ 164779Sjoehw#define __SAPP 0x0100 /* fdopen()ed in append mode */ 165779Sjoehw#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 166779Sjoehw#define __SOPT 0x0400 /* do fseek() optimization */ 167779Sjoehw#define __SNPT 0x0800 /* do not do fseek() optimization */ 168779Sjoehw#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 169779Sjoehw#define __SMOD 0x2000 /* true => fgetln modified _p text */ 170779Sjoehw 171779Sjoehw/* 172779Sjoehw * The following three definitions are for ANSI C, which took them 173779Sjoehw * from System V, which brilliantly took internal interface macros and 174779Sjoehw * made them official arguments to setvbuf(), without renaming them. 175779Sjoehw * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 176779Sjoehw * 177779Sjoehw * Although numbered as their counterparts above, the implementation 178779Sjoehw * does not rely on this. 179779Sjoehw */ 180779Sjoehw#define _IOFBF 0 /* setvbuf should set fully buffered */ 181779Sjoehw#define _IOLBF 1 /* setvbuf should set line buffered */ 182779Sjoehw#define _IONBF 2 /* setvbuf should set unbuffered */ 183779Sjoehw 184779Sjoehw#define BUFSIZ 1024 /* size of buffer used by setbuf */ 185779Sjoehw#define EOF (-1) 186779Sjoehw 187779Sjoehw/* 188779Sjoehw * FOPEN_MAX is a minimum maximum, and is the number of streams that 189779Sjoehw * stdio can provide without attempting to allocate further resources 190779Sjoehw * (which could fail). Do not use this for anything. 191779Sjoehw */ 192779Sjoehw /* must be == _POSIX_STREAM_MAX <limits.h> */ 193779Sjoehw#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 194779Sjoehw#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 195779Sjoehw 196779Sjoehw/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 197779Sjoehw#ifndef _ANSI_SOURCE 198779Sjoehw#define P_tmpdir "/var/tmp/" 199779Sjoehw#endif 200779Sjoehw#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 201779Sjoehw#define TMP_MAX 308915776 202779Sjoehw 203779Sjoehw#ifndef SEEK_SET 204779Sjoehw#define SEEK_SET 0 /* set file offset to offset */ 205779Sjoehw#endif 206779Sjoehw#ifndef SEEK_CUR 207779Sjoehw#define SEEK_CUR 1 /* set file offset to current plus offset */ 208779Sjoehw#endif 209779Sjoehw#ifndef SEEK_END 210779Sjoehw#define SEEK_END 2 /* set file offset to EOF plus offset */ 211779Sjoehw#endif 212 213#define stdin (&__sF[0]) 214#define stdout (&__sF[1]) 215#define stderr (&__sF[2]) 216 217/* 218 * Functions defined in ANSI C standard. 219 */ 220__BEGIN_DECLS 221void clearerr __P((FILE *)); 222int fclose __P((FILE *)); 223int feof __P((FILE *)); 224int ferror __P((FILE *)); 225int fflush __P((FILE *)); 226int fgetc __P((FILE *)); 227int fgetpos __P((FILE *, fpos_t *)); 228char *fgets __P((char *, int, FILE *)); 229FILE *fopen __P((const char *, const char *)); 230int fprintf __P((FILE *, const char *, ...)); 231int fputc __P((int, FILE *)); 232int fputs __P((const char *, FILE *)); 233size_t fread __P((void *, size_t, size_t, FILE *)); 234FILE *freopen __P((const char *, const char *, FILE *)); 235int fscanf __P((FILE *, const char *, ...)); 236int fseek __P((FILE *, long, int)); 237int fsetpos __P((FILE *, const fpos_t *)); 238long ftell __P((FILE *)); 239size_t fwrite __P((const void *, size_t, size_t, FILE *)); 240int getc __P((FILE *)); 241int getchar __P((void)); 242char *gets __P((char *)); 243#if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 244extern __const int sys_nerr; /* perror(3) external variables */ 245extern __const char *__const sys_errlist[]; 246#endif 247void perror __P((const char *)); 248int printf __P((const char *, ...)); 249int putc __P((int, FILE *)); 250int putchar __P((int)); 251int puts __P((const char *)); 252int remove __P((const char *)); 253int rename __P((const char *, const char *)); 254void rewind __P((FILE *)); 255int scanf __P((const char *, ...)); 256void setbuf __P((FILE *, char *)); 257int setvbuf __P((FILE *, char *, int, size_t)); 258int sprintf __P((char *, const char *, ...)); 259int sscanf __P((const char *, const char *, ...)); 260FILE *tmpfile __P((void)); 261char *tmpnam __P((char *)); 262int ungetc __P((int, FILE *)); 263int vfprintf __P((FILE *, const char *, _BSD_VA_LIST_)); 264int vprintf __P((const char *, _BSD_VA_LIST_)); 265int vsprintf __P((char *, const char *, _BSD_VA_LIST_)); 266__END_DECLS 267 268/* 269 * Functions defined in POSIX 1003.1. 270 */ 271#ifndef _ANSI_SOURCE 272/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 273#define L_cuserid 17 274 275#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 276 277__BEGIN_DECLS 278char *ctermid __P((char *)); 279FILE *fdopen __P((int, const char *)); 280int fileno __P((FILE *)); 281__END_DECLS 282#endif /* not ANSI */ 283 284/* 285 * Routines that are purely local. 286 */ 287#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 288__BEGIN_DECLS 289int asprintf __P((char **, const char *, ...)); 290char *fgetln __P((FILE *, size_t *)); 291int fpurge __P((FILE *)); 292int getw __P((FILE *)); 293int pclose __P((FILE *)); 294FILE *popen __P((const char *, const char *)); 295int putw __P((int, FILE *)); 296void setbuffer __P((FILE *, char *, int)); 297int setlinebuf __P((FILE *)); 298char *tempnam __P((const char *, const char *)); 299int snprintf __P((char *, size_t, const char *, ...)); 300int vasprintf __P((char **, const char *, _BSD_VA_LIST_)); 301int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)); 302int vscanf __P((const char *, _BSD_VA_LIST_)); 303int vsscanf __P((const char *, const char *, _BSD_VA_LIST_)); 304__END_DECLS 305 306/* 307 * This is a #define because the function is used internally and 308 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 309 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 310 */ 311#define vfscanf __svfscanf 312 313/* 314 * Stdio function-access interface. 315 */ 316__BEGIN_DECLS 317FILE *funopen __P((const void *, 318 int (*)(void *, char *, int), 319 int (*)(void *, const char *, int), 320 fpos_t (*)(void *, fpos_t, int), 321 int (*)(void *))); 322__END_DECLS 323#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 324#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 325#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 326 327/* 328 * Functions internal to the implementation. 329 */ 330__BEGIN_DECLS 331int __srget __P((FILE *)); 332int __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_)); 333int __swbuf __P((int, FILE *)); 334__END_DECLS 335 336/* 337 * The __sfoo macros are here so that we can 338 * define function versions in the C library. 339 */ 340#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 341#if defined(__GNUC__) && defined(__STDC__) 342static __inline int __sputc(int _c, FILE *_p) { 343 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 344 return (*_p->_p++ = _c); 345 else 346 return (__swbuf(_c, _p)); 347} 348#else 349/* 350 * This has been tuned to generate reasonable code on the vax using pcc. 351 */ 352#define __sputc(c, p) \ 353 (--(p)->_w < 0 ? \ 354 (p)->_w >= (p)->_lbfsize ? \ 355 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 356 (int)*(p)->_p++ : \ 357 __swbuf('\n', p) : \ 358 __swbuf((int)(c), p) : \ 359 (*(p)->_p = (c), (int)*(p)->_p++)) 360#endif 361 362#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 363#define __sferror(p) (((p)->_flags & __SERR) != 0) 364#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 365#define __sfileno(p) ((p)->_file) 366 367#define feof(p) __sfeof(p) 368#define ferror(p) __sferror(p) 369#define clearerr(p) __sclearerr(p) 370 371#ifndef _ANSI_SOURCE 372#define fileno(p) __sfileno(p) 373#endif 374 375#ifndef lint 376#define getc(fp) __sgetc(fp) 377#define putc(x, fp) __sputc(x, fp) 378#endif /* lint */ 379 380#define getchar() getc(stdin) 381#define putchar(x) putc(x, stdout) 382#endif /* _STDIO_H_ */ 383