stdio.h revision 21673
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.4 (Berkeley) 1/4/94 37 * $FreeBSD: head/include/stdio.h 21673 1997-01-14 07:20:47Z jkh $ 38 */ 39 40#ifndef _STDIO_H_ 41#define _STDIO_H_ 42 43#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 44#include <sys/types.h> 45#endif 46 47#include <sys/cdefs.h> 48 49#include <machine/ansi.h> 50#ifdef _BSD_SIZE_T_ 51typedef _BSD_SIZE_T_ size_t; 52#undef _BSD_SIZE_T_ 53#endif 54 55#ifndef NULL 56#define NULL 0 57#endif 58 59/* 60 * This is fairly grotesque, but pure ANSI code must not inspect the 61 * innards of an fpos_t anyway. The library internally uses off_t, 62 * which we assume is exactly as big as eight chars. (When we switch 63 * to gcc 2.4 we will use __attribute__ here.) 64 * 65 * WARNING: the alignment constraints on an off_t and the struct below 66 * differ on (e.g.) the SPARC. Hence, the placement of an fpos_t object 67 * in a structure will change if fpos_t's are not aligned on 8-byte 68 * boundaries. THIS IS A CROCK, but for now there is no way around it. 69 */ 70#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 71typedef off_t fpos_t; 72#else 73typedef struct __sfpos { 74 char _pos[8]; 75} fpos_t; 76#endif 77 78#define _FSTDIO /* Define for new stdio with functions. */ 79 80/* 81 * NB: to fit things in six character monocase externals, the stdio 82 * code uses the prefix `__s' for stdio objects, typically followed 83 * by a three-character attempt at a mnemonic. 84 */ 85 86/* stdio buffers */ 87struct __sbuf { 88 unsigned char *_base; 89 int _size; 90}; 91 92/* 93 * stdio state variables. 94 * 95 * The following always hold: 96 * 97 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 98 * _lbfsize is -_bf._size, else _lbfsize is 0 99 * if _flags&__SRD, _w is 0 100 * if _flags&__SWR, _r is 0 101 * 102 * This ensures that the getc and putc macros (or inline functions) never 103 * try to write or read from a file that is in `read' or `write' mode. 104 * (Moreover, they can, and do, automatically switch from read mode to 105 * write mode, and back, on "r+" and "w+" files.) 106 * 107 * _lbfsize is used only to make the inline line-buffered output stream 108 * code as compact as possible. 109 * 110 * _ub, _up, and _ur are used when ungetc() pushes back more characters 111 * than fit in the current _bf, or when ungetc() pushes back a character 112 * that does not match the previous one in _bf. When this happens, 113 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 114 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 115 * 116 * NB: see WARNING above before changing the layout of this structure! 117 */ 118typedef struct __sFILE { 119 unsigned char *_p; /* current position in (some) buffer */ 120 int _r; /* read space left for getc() */ 121 int _w; /* write space left for putc() */ 122 short _flags; /* flags, below; this FILE is free if 0 */ 123 short _file; /* fileno, if Unix descriptor, else -1 */ 124 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 125 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 126 127 /* operations */ 128 void *_cookie; /* cookie passed to io functions */ 129 int (*_close) __P((void *)); 130 int (*_read) __P((void *, char *, int)); 131 fpos_t (*_seek) __P((void *, fpos_t, int)); 132 int (*_write) __P((void *, const char *, int)); 133 134 /* separate buffer for long sequences of ungetc() */ 135 struct __sbuf _ub; /* ungetc buffer */ 136 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 137 int _ur; /* saved _r when _r is counting ungetc data */ 138 139 /* tricks to meet minimum requirements even when malloc() fails */ 140 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 141 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 142 143 /* separate buffer for fgetln() when line crosses buffer boundary */ 144 struct __sbuf _lb; /* buffer for fgetln() */ 145 146 /* Unix stdio files get aligned to block boundaries on fseek() */ 147 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 148 fpos_t _offset; /* current lseek offset (see WARNING) */ 149} FILE; 150 151__BEGIN_DECLS 152extern FILE __sF[]; 153__END_DECLS 154 155#define __SLBF 0x0001 /* line buffered */ 156#define __SNBF 0x0002 /* unbuffered */ 157#define __SRD 0x0004 /* OK to read */ 158#define __SWR 0x0008 /* OK to write */ 159 /* RD and WR are never simultaneously asserted */ 160#define __SRW 0x0010 /* open for reading & writing */ 161#define __SEOF 0x0020 /* found EOF */ 162#define __SERR 0x0040 /* found error */ 163#define __SMBF 0x0080 /* _buf is from malloc */ 164#define __SAPP 0x0100 /* fdopen()ed in append mode */ 165#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 166#define __SOPT 0x0400 /* do fseek() optimization */ 167#define __SNPT 0x0800 /* do not do fseek() optimization */ 168#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 169#define __SMOD 0x2000 /* true => fgetln modified _p text */ 170 171/* 172 * The following three definitions are for ANSI C, which took them 173 * from System V, which brilliantly took internal interface macros and 174 * made them official arguments to setvbuf(), without renaming them. 175 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 176 * 177 * Although numbered as their counterparts above, the implementation 178 * does not rely on this. 179 */ 180#define _IOFBF 0 /* setvbuf should set fully buffered */ 181#define _IOLBF 1 /* setvbuf should set line buffered */ 182#define _IONBF 2 /* setvbuf should set unbuffered */ 183 184#define BUFSIZ 1024 /* size of buffer used by setbuf */ 185#define EOF (-1) 186 187/* 188 * FOPEN_MAX is a minimum maximum, and is the number of streams that 189 * stdio can provide without attempting to allocate further resources 190 * (which could fail). Do not use this for anything. 191 */ 192 /* must be == _POSIX_STREAM_MAX <limits.h> */ 193#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 194#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 195 196/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 197#ifndef _ANSI_SOURCE 198#define P_tmpdir "/var/tmp/" 199#endif 200#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 201#define TMP_MAX 308915776 202 203#ifndef SEEK_SET 204#define SEEK_SET 0 /* set file offset to offset */ 205#endif 206#ifndef SEEK_CUR 207#define SEEK_CUR 1 /* set file offset to current plus offset */ 208#endif 209#ifndef SEEK_END 210#define SEEK_END 2 /* set file offset to EOF plus offset */ 211#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 9 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