stdio.h revision 36981
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 * $Id: stdio.h,v 1.17 1998/05/05 21:59:19 jb Exp $ 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 150/* 151 * The following three definitions are for ANSI C, which took them 152 * from System V, which brilliantly took internal interface macros and 153 * made them official arguments to setvbuf(), without renaming them. 154 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 155 * 156 * Although numbered as their counterparts above, the implementation 157 * does not rely on this. 158 */ 159#define _IOFBF 0 /* setvbuf should set fully buffered */ 160#define _IOLBF 1 /* setvbuf should set line buffered */ 161#define _IONBF 2 /* setvbuf should set unbuffered */ 162 163#define BUFSIZ 1024 /* size of buffer used by setbuf */ 164#define EOF (-1) 165 166/* 167 * FOPEN_MAX is a minimum maximum, and is the number of streams that 168 * stdio can provide without attempting to allocate further resources 169 * (which could fail). Do not use this for anything. 170 */ 171 /* must be == _POSIX_STREAM_MAX <limits.h> */ 172#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 173#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 174 175/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 176#ifndef _ANSI_SOURCE 177#define P_tmpdir "/var/tmp/" 178#endif 179#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 180#define TMP_MAX 308915776 181 182#ifndef SEEK_SET 183#define SEEK_SET 0 /* set file offset to offset */ 184#endif 185#ifndef SEEK_CUR 186#define SEEK_CUR 1 /* set file offset to current plus offset */ 187#endif 188#ifndef SEEK_END 189#define SEEK_END 2 /* set file offset to EOF plus offset */ 190#endif 191 192#define stdin (&__sF[0]) 193#define stdout (&__sF[1]) 194#define stderr (&__sF[2]) 195 196/* 197 * Functions defined in ANSI C standard. 198 */ 199__BEGIN_DECLS 200void clearerr __P((FILE *)); 201int fclose __P((FILE *)); 202int feof __P((FILE *)); 203int ferror __P((FILE *)); 204int fflush __P((FILE *)); 205int fgetc __P((FILE *)); 206int fgetpos __P((FILE *, fpos_t *)); 207char *fgets __P((char *, int, FILE *)); 208FILE *fopen __P((const char *, const char *)); 209int fprintf __P((FILE *, const char *, ...)); 210int fputc __P((int, FILE *)); 211int fputs __P((const char *, FILE *)); 212size_t fread __P((void *, size_t, size_t, FILE *)); 213FILE *freopen __P((const char *, const char *, FILE *)); 214int fscanf __P((FILE *, const char *, ...)); 215int fseek __P((FILE *, long, int)); 216int fsetpos __P((FILE *, const fpos_t *)); 217long ftell __P((FILE *)); 218size_t fwrite __P((const void *, size_t, size_t, FILE *)); 219int getc __P((FILE *)); 220int getchar __P((void)); 221char *gets __P((char *)); 222#if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 223extern __const int sys_nerr; /* perror(3) external variables */ 224extern __const char *__const sys_errlist[]; 225#endif 226void perror __P((const char *)); 227int printf __P((const char *, ...)); 228int putc __P((int, FILE *)); 229int putchar __P((int)); 230int puts __P((const char *)); 231int remove __P((const char *)); 232int rename __P((const char *, const char *)); 233void rewind __P((FILE *)); 234int scanf __P((const char *, ...)); 235void setbuf __P((FILE *, char *)); 236int setvbuf __P((FILE *, char *, int, size_t)); 237int sprintf __P((char *, const char *, ...)); 238int sscanf __P((const char *, const char *, ...)); 239FILE *tmpfile __P((void)); 240char *tmpnam __P((char *)); 241int ungetc __P((int, FILE *)); 242int vfprintf __P((FILE *, const char *, _BSD_VA_LIST_)); 243int vprintf __P((const char *, _BSD_VA_LIST_)); 244int vsprintf __P((char *, const char *, _BSD_VA_LIST_)); 245__END_DECLS 246 247/* 248 * Functions defined in POSIX 1003.1. 249 */ 250#ifndef _ANSI_SOURCE 251/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 252#define L_cuserid 17 253 254#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 255 256__BEGIN_DECLS 257char *ctermid __P((char *)); 258FILE *fdopen __P((int, const char *)); 259int fileno __P((FILE *)); 260int ftrylockfile __P((FILE *)); 261void flockfile __P((FILE *)); 262void funlockfile __P((FILE *)); 263__END_DECLS 264#endif /* not ANSI */ 265 266/* 267 * Portability hacks. See <sys/types.h>. 268 */ 269#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 270__BEGIN_DECLS 271#ifndef _FTRUNCATE_DECLARED 272#define _FTRUNCATE_DECLARED 273int ftruncate __P((int, _BSD_OFF_T_)); 274#endif 275#ifndef _LSEEK_DECLARED 276#define _LSEEK_DECLARED 277_BSD_OFF_T_ lseek __P((int, _BSD_OFF_T_, int)); 278#endif 279#ifndef _MMAP_DECLARED 280#define _MMAP_DECLARED 281char *mmap __P((void *, size_t, int, int, int, _BSD_OFF_T_)); 282#endif 283#ifndef _TRUNCATE_DECLARED 284#define _TRUNCATE_DECLARED 285int truncate __P((const char *, _BSD_OFF_T_)); 286#endif 287__END_DECLS 288#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 289 290/* 291 * Routines that are purely local. 292 */ 293#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 294__BEGIN_DECLS 295int asprintf __P((char **, const char *, ...)); 296char *fgetln __P((FILE *, size_t *)); 297int fpurge __P((FILE *)); 298int getw __P((FILE *)); 299int pclose __P((FILE *)); 300FILE *popen __P((const char *, const char *)); 301int putw __P((int, FILE *)); 302void setbuffer __P((FILE *, char *, int)); 303int setlinebuf __P((FILE *)); 304char *tempnam __P((const char *, const char *)); 305int snprintf __P((char *, size_t, const char *, ...)); 306int vasprintf __P((char **, const char *, _BSD_VA_LIST_)); 307int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)); 308int vscanf __P((const char *, _BSD_VA_LIST_)); 309int vsscanf __P((const char *, const char *, _BSD_VA_LIST_)); 310__END_DECLS 311 312/* 313 * This is a #define because the function is used internally and 314 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 315 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 316 */ 317#define vfscanf __svfscanf 318 319/* 320 * Stdio function-access interface. 321 */ 322__BEGIN_DECLS 323FILE *funopen __P((const void *, 324 int (*)(void *, char *, int), 325 int (*)(void *, const char *, int), 326 fpos_t (*)(void *, fpos_t, int), 327 int (*)(void *))); 328__END_DECLS 329#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 330#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 331#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 332 333/* 334 * Functions internal to the implementation. 335 */ 336__BEGIN_DECLS 337int __srget __P((FILE *)); 338int __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_)); 339int __swbuf __P((int, FILE *)); 340__END_DECLS 341 342/* 343 * The __sfoo macros are here so that we can 344 * define function versions in the C library. 345 */ 346#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 347#if defined(__GNUC__) && defined(__STDC__) 348static __inline int __sputc(int _c, FILE *_p) { 349 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 350 return (*_p->_p++ = _c); 351 else 352 return (__swbuf(_c, _p)); 353} 354#else 355/* 356 * This has been tuned to generate reasonable code on the vax using pcc. 357 */ 358#define __sputc(c, p) \ 359 (--(p)->_w < 0 ? \ 360 (p)->_w >= (p)->_lbfsize ? \ 361 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 362 (int)*(p)->_p++ : \ 363 __swbuf('\n', p) : \ 364 __swbuf((int)(c), p) : \ 365 (*(p)->_p = (c), (int)*(p)->_p++)) 366#endif 367 368#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 369#define __sferror(p) (((p)->_flags & __SERR) != 0) 370#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 371#define __sfileno(p) ((p)->_file) 372 373/* 374 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 375 * B.8.2.7 for the rationale behind the *_unlocked() macros. 376 */ 377#define feof_unlocked(p) __sfeof(p) 378#define ferror_unlocked(p) __sferror(p) 379#define clearerr_unlocked(p) __sclearerr(p) 380 381#ifndef _ANSI_SOURCE 382#define fileno_unlocked(p) __sfileno(p) 383#endif 384 385#ifndef _THREAD_SAFE 386#define feof(p) feof_unlocked(p) 387#define ferror(p) ferror_unlocked(p) 388#define clearerr(p) clearerr_unlocked(p) 389 390#ifndef _ANSI_SOURCE 391#define fileno(p) fileno_unlocked(p) 392#endif 393#endif 394 395#ifndef lint 396#define getc_unlocked(fp) __sgetc(fp) 397#define putc_unlocked(x, fp) __sputc(x, fp) 398#ifdef _THREAD_SAFE 399void _flockfile_debug __P((FILE *, char *, int)); 400#ifdef _FLOCK_DEBUG 401#define _FLOCKFILE(x) _flockfile_debug(x, __FILE__, __LINE__) 402#else 403#define _FLOCKFILE(x) flockfile(x) 404#endif 405static __inline int \ 406__getc_locked(FILE *_fp) \ 407{ \ 408 extern int __isthreaded; \ 409 int _ret; \ 410 if (__isthreaded) \ 411 _FLOCKFILE(_fp); \ 412 _ret = getc_unlocked(_fp); \ 413 if (__isthreaded) \ 414 funlockfile(_fp); \ 415 return (_ret); \ 416} 417static __inline int \ 418__putc_locked(int _x, FILE *_fp) \ 419{ \ 420 extern int __isthreaded; \ 421 int _ret; \ 422 if (__isthreaded) \ 423 _FLOCKFILE(_fp); \ 424 _ret = putc_unlocked(_x, _fp); \ 425 if (__isthreaded) \ 426 funlockfile(_fp); \ 427 return (_ret); \ 428} 429#define getc(fp) __getc_locked(fp) 430#define putc(x, fp) __putc_locked(x, fp) 431#else 432#define getc(fp) getc_unlocked(fp) 433#define putc(x, fp) putc_unlocked(x, fp) 434#endif 435#endif /* lint */ 436 437#define getchar() getc(stdin) 438#define getchar_unlocked() getc_unlocked(stdin) 439#define putchar(x) putc(x, stdout) 440#define putchar_unlocked(x) putc_unlocked(x, stdout) 441 442#endif /* !_STDIO_H_ */ 443