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