stdio.h revision 35163
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.15 1998/04/11 07:33:46 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 55/* 56 * This is fairly grotesque, but pure ANSI code must not inspect the 57 * innards of an fpos_t anyway. The library internally uses off_t, 58 * which we assume is exactly as big as eight chars. (When we switch 59 * to gcc 2.4 we will use __attribute__ here.) 60 * 61 * WARNING: the alignment constraints on an off_t and the struct below 62 * differ on (e.g.) the SPARC. Hence, the placement of an fpos_t object 63 * in a structure will change if fpos_t's are not aligned on 8-byte 64 * boundaries. THIS IS A CROCK, but for now there is no way around it. 65 */ 66#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 67typedef _BSD_OFF_T_ fpos_t; 68#else 69typedef struct __sfpos { 70 char _pos[8]; 71} fpos_t; 72#endif 73 74#define _FSTDIO /* Define for new stdio with functions. */ 75 76/* 77 * NB: to fit things in six character monocase externals, the stdio 78 * code uses the prefix `__s' for stdio objects, typically followed 79 * by a three-character attempt at a mnemonic. 80 */ 81 82/* stdio buffers */ 83struct __sbuf { 84 unsigned char *_base; 85 int _size; 86}; 87 88/* 89 * stdio state variables. 90 * 91 * The following always hold: 92 * 93 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 94 * _lbfsize is -_bf._size, else _lbfsize is 0 95 * if _flags&__SRD, _w is 0 96 * if _flags&__SWR, _r is 0 97 * 98 * This ensures that the getc and putc macros (or inline functions) never 99 * try to write or read from a file that is in `read' or `write' mode. 100 * (Moreover, they can, and do, automatically switch from read mode to 101 * write mode, and back, on "r+" and "w+" files.) 102 * 103 * _lbfsize is used only to make the inline line-buffered output stream 104 * code as compact as possible. 105 * 106 * _ub, _up, and _ur are used when ungetc() pushes back more characters 107 * than fit in the current _bf, or when ungetc() pushes back a character 108 * that does not match the previous one in _bf. When this happens, 109 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 110 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 111 * 112 * NB: see WARNING above before changing the layout of this structure! 113 */ 114typedef struct __sFILE { 115 unsigned char *_p; /* current position in (some) buffer */ 116 int _r; /* read space left for getc() */ 117 int _w; /* write space left for putc() */ 118 short _flags; /* flags, below; this FILE is free if 0 */ 119 short _file; /* fileno, if Unix descriptor, else -1 */ 120 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 121 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 122 123 /* operations */ 124 void *_cookie; /* cookie passed to io functions */ 125 int (*_close) __P((void *)); 126 int (*_read) __P((void *, char *, int)); 127 fpos_t (*_seek) __P((void *, fpos_t, int)); 128 int (*_write) __P((void *, const char *, int)); 129 130 /* separate buffer for long sequences of ungetc() */ 131 struct __sbuf _ub; /* ungetc buffer */ 132 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 133 int _ur; /* saved _r when _r is counting ungetc data */ 134 135 /* tricks to meet minimum requirements even when malloc() fails */ 136 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 137 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 138 139 /* separate buffer for fgetln() when line crosses buffer boundary */ 140 struct __sbuf _lb; /* buffer for fgetln() */ 141 142 /* Unix stdio files get aligned to block boundaries on fseek() */ 143 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 144 fpos_t _offset; /* current lseek offset (see WARNING) */ 145} FILE; 146 147__BEGIN_DECLS 148extern FILE __sF[]; 149__END_DECLS 150 151#define __SLBF 0x0001 /* line buffered */ 152#define __SNBF 0x0002 /* unbuffered */ 153#define __SRD 0x0004 /* OK to read */ 154#define __SWR 0x0008 /* OK to write */ 155 /* RD and WR are never simultaneously asserted */ 156#define __SRW 0x0010 /* open for reading & writing */ 157#define __SEOF 0x0020 /* found EOF */ 158#define __SERR 0x0040 /* found error */ 159#define __SMBF 0x0080 /* _buf is from malloc */ 160#define __SAPP 0x0100 /* fdopen()ed in append mode */ 161#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 162#define __SOPT 0x0400 /* do fseek() optimization */ 163#define __SNPT 0x0800 /* do not do fseek() optimization */ 164#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 165#define __SMOD 0x2000 /* true => fgetln modified _p text */ 166 167/* 168 * The following three definitions are for ANSI C, which took them 169 * from System V, which brilliantly took internal interface macros and 170 * made them official arguments to setvbuf(), without renaming them. 171 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 172 * 173 * Although numbered as their counterparts above, the implementation 174 * does not rely on this. 175 */ 176#define _IOFBF 0 /* setvbuf should set fully buffered */ 177#define _IOLBF 1 /* setvbuf should set line buffered */ 178#define _IONBF 2 /* setvbuf should set unbuffered */ 179 180#define BUFSIZ 1024 /* size of buffer used by setbuf */ 181#define EOF (-1) 182 183/* 184 * FOPEN_MAX is a minimum maximum, and is the number of streams that 185 * stdio can provide without attempting to allocate further resources 186 * (which could fail). Do not use this for anything. 187 */ 188 /* must be == _POSIX_STREAM_MAX <limits.h> */ 189#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 190#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 191 192/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 193#ifndef _ANSI_SOURCE 194#define P_tmpdir "/var/tmp/" 195#endif 196#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 197#define TMP_MAX 308915776 198 199#ifndef SEEK_SET 200#define SEEK_SET 0 /* set file offset to offset */ 201#endif 202#ifndef SEEK_CUR 203#define SEEK_CUR 1 /* set file offset to current plus offset */ 204#endif 205#ifndef SEEK_END 206#define SEEK_END 2 /* set file offset to EOF plus offset */ 207#endif 208 209#define stdin (&__sF[0]) 210#define stdout (&__sF[1]) 211#define stderr (&__sF[2]) 212 213/* 214 * Functions defined in ANSI C standard. 215 */ 216__BEGIN_DECLS 217void clearerr __P((FILE *)); 218int fclose __P((FILE *)); 219int feof __P((FILE *)); 220int ferror __P((FILE *)); 221int fflush __P((FILE *)); 222int fgetc __P((FILE *)); 223int fgetpos __P((FILE *, fpos_t *)); 224char *fgets __P((char *, int, FILE *)); 225FILE *fopen __P((const char *, const char *)); 226int fprintf __P((FILE *, const char *, ...)); 227int fputc __P((int, FILE *)); 228int fputs __P((const char *, FILE *)); 229size_t fread __P((void *, size_t, size_t, FILE *)); 230FILE *freopen __P((const char *, const char *, FILE *)); 231int fscanf __P((FILE *, const char *, ...)); 232int fseek __P((FILE *, long, int)); 233int fsetpos __P((FILE *, const fpos_t *)); 234long ftell __P((FILE *)); 235size_t fwrite __P((const void *, size_t, size_t, FILE *)); 236int getc __P((FILE *)); 237int getchar __P((void)); 238char *gets __P((char *)); 239#if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 240extern __const int sys_nerr; /* perror(3) external variables */ 241extern __const char *__const sys_errlist[]; 242#endif 243void perror __P((const char *)); 244int printf __P((const char *, ...)); 245int putc __P((int, FILE *)); 246int putchar __P((int)); 247int puts __P((const char *)); 248int remove __P((const char *)); 249int rename __P((const char *, const char *)); 250void rewind __P((FILE *)); 251int scanf __P((const char *, ...)); 252void setbuf __P((FILE *, char *)); 253int setvbuf __P((FILE *, char *, int, size_t)); 254int sprintf __P((char *, const char *, ...)); 255int sscanf __P((const char *, const char *, ...)); 256FILE *tmpfile __P((void)); 257char *tmpnam __P((char *)); 258int ungetc __P((int, FILE *)); 259int vfprintf __P((FILE *, const char *, _BSD_VA_LIST_)); 260int vprintf __P((const char *, _BSD_VA_LIST_)); 261int vsprintf __P((char *, const char *, _BSD_VA_LIST_)); 262__END_DECLS 263 264/* 265 * Functions defined in POSIX 1003.1. 266 */ 267#ifndef _ANSI_SOURCE 268/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 269#define L_cuserid 17 270 271#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 272 273__BEGIN_DECLS 274char *ctermid __P((char *)); 275FILE *fdopen __P((int, const char *)); 276int fileno __P((FILE *)); 277int ftrylockfile __P((FILE *)); 278void flockfile __P((FILE *)); 279void funlockfile __P((FILE *)); 280__END_DECLS 281#endif /* not ANSI */ 282 283/* 284 * Portability hacks. See <sys/types.h>. 285 */ 286#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 287__BEGIN_DECLS 288#ifndef _FTRUNCATE_DECLARED 289#define _FTRUNCATE_DECLARED 290int ftruncate __P((int, _BSD_OFF_T_)); 291#endif 292#ifndef _LSEEK_DECLARED 293#define _LSEEK_DECLARED 294_BSD_OFF_T_ lseek __P((int, _BSD_OFF_T_, int)); 295#endif 296#ifndef _MMAP_DECLARED 297#define _MMAP_DECLARED 298char *mmap __P((void *, size_t, int, int, int, _BSD_OFF_T_)); 299#endif 300#ifndef _TRUNCATE_DECLARED 301#define _TRUNCATE_DECLARED 302int truncate __P((const char *, _BSD_OFF_T_)); 303#endif 304__END_DECLS 305#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 306 307/* 308 * Routines that are purely local. 309 */ 310#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 311__BEGIN_DECLS 312int asprintf __P((char **, const char *, ...)); 313char *fgetln __P((FILE *, size_t *)); 314int fpurge __P((FILE *)); 315int getw __P((FILE *)); 316int pclose __P((FILE *)); 317FILE *popen __P((const char *, const char *)); 318int putw __P((int, FILE *)); 319void setbuffer __P((FILE *, char *, int)); 320int setlinebuf __P((FILE *)); 321char *tempnam __P((const char *, const char *)); 322int snprintf __P((char *, size_t, const char *, ...)); 323int vasprintf __P((char **, const char *, _BSD_VA_LIST_)); 324int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)); 325int vscanf __P((const char *, _BSD_VA_LIST_)); 326int vsscanf __P((const char *, const char *, _BSD_VA_LIST_)); 327__END_DECLS 328 329/* 330 * This is a #define because the function is used internally and 331 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 332 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 333 */ 334#define vfscanf __svfscanf 335 336/* 337 * Stdio function-access interface. 338 */ 339__BEGIN_DECLS 340FILE *funopen __P((const void *, 341 int (*)(void *, char *, int), 342 int (*)(void *, const char *, int), 343 fpos_t (*)(void *, fpos_t, int), 344 int (*)(void *))); 345__END_DECLS 346#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 347#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 348#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 349 350/* 351 * Functions internal to the implementation. 352 */ 353__BEGIN_DECLS 354int __srget __P((FILE *)); 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#ifndef _THREAD_SAFE 403#define feof(p) feof_unlocked(p) 404#define ferror(p) ferror_unlocked(p) 405#define clearerr(p) clearerr_unlocked(p) 406 407#ifndef _ANSI_SOURCE 408#define fileno(p) fileno_unlocked(p) 409#endif 410#endif 411 412#ifndef lint 413#define getc_unlocked(fp) __sgetc(fp) 414#define putc_unlocked(x, fp) __sputc(x, fp) 415#ifdef _THREAD_SAFE 416void _flockfile __P((FILE *)); 417void _flockfile_debug __P((FILE *, char *, int)); 418void _funlockfile __P((FILE *)); 419#ifdef _FLOCK_DEBUG 420#define _FLOCKFILE(x) _flockfile_debug(x, __FILE__, __LINE__) 421#else 422#define _FLOCKFILE(x) _flockfile(x) 423#endif 424static __inline int \ 425__getc_locked(FILE *_fp) \ 426{ \ 427 extern int __isthreaded; \ 428 int _ret; \ 429 if (__isthreaded) \ 430 _FLOCKFILE(_fp); \ 431 _ret = getc_unlocked(_fp); \ 432 if (__isthreaded) \ 433 _funlockfile(_fp); \ 434 return (_ret); \ 435} 436static __inline int \ 437__putc_locked(int _x, FILE *_fp) \ 438{ \ 439 extern int __isthreaded; \ 440 int _ret; \ 441 if (__isthreaded) \ 442 _FLOCKFILE(_fp); \ 443 _ret = putc_unlocked(_x, _fp); \ 444 if (__isthreaded) \ 445 _funlockfile(_fp); \ 446 return (_ret); \ 447} 448#define getc(fp) __getc_locked(fp) 449#define putc(x, fp) __putc_locked(x, fp) 450#else 451#define getc(fp) getc_unlocked(fp) 452#define putc(x, fp) putc_unlocked(x, fp) 453#endif 454#endif /* lint */ 455 456#define getchar() getc(stdin) 457#define getchar_unlocked() getc_unlocked(stdin) 458#define putchar(x) putc(x, stdout) 459#define putchar_unlocked(x) putc_unlocked(x, stdout) 460 461#endif /* !_STDIO_H_ */ 462