stdio.h revision 1.27
1/* $NetBSD: stdio.h,v 1.27 1998/08/28 21:37:12 perry Exp $ */ 2 3/*- 4 * Copyright (c) 1990, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Chris Torek. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the University of 21 * California, Berkeley and its contributors. 22 * 4. Neither the name of the University nor the names of its contributors 23 * may be used to endorse or promote products derived from this software 24 * without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 * 38 * @(#)stdio.h 8.5 (Berkeley) 4/29/95 39 */ 40 41#ifndef _STDIO_H_ 42#define _STDIO_H_ 43 44#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 45#include <sys/types.h> 46#endif 47 48#include <sys/cdefs.h> 49#include <sys/featuretest.h> 50 51#include <machine/ansi.h> 52#ifdef _BSD_SIZE_T_ 53typedef _BSD_SIZE_T_ size_t; 54#undef _BSD_SIZE_T_ 55#endif 56 57#ifndef NULL 58#define NULL 0 59#endif 60 61/* 62 * This is fairly grotesque, but pure ANSI code must not inspect the 63 * innards of an fpos_t anyway. The library internally uses off_t, 64 * which we assume is exactly as big as eight chars. 65 */ 66#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 67typedef off_t fpos_t; 68#else 69typedef struct __sfpos { 70 long long _pos; /* XXX must be the same as off_t */ 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 */ 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() optimisation */ 163#define __SNPT 0x0800 /* do not do fseek() optimisation */ 164#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 165#define __SMOD 0x2000 /* true => fgetln modified _p text */ 166#define __SALC 0x4000 /* allocate string space dynamically */ 167 168/* 169 * The following three definitions are for ANSI C, which took them 170 * from System V, which brilliantly took internal interface macros and 171 * made them official arguments to setvbuf(), without renaming them. 172 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 173 * 174 * Although numbered as their counterparts above, the implementation 175 * does not rely on this. 176 */ 177#define _IOFBF 0 /* setvbuf should set fully buffered */ 178#define _IOLBF 1 /* setvbuf should set line buffered */ 179#define _IONBF 2 /* setvbuf should set unbuffered */ 180 181#define BUFSIZ 1024 /* size of buffer used by setbuf */ 182#define EOF (-1) 183 184/* 185 * FOPEN_MAX is a minimum maximum, and is the number of streams that 186 * stdio can provide without attempting to allocate further resources 187 * (which could fail). Do not use this for anything. 188 */ 189 /* must be == _POSIX_STREAM_MAX <limits.h> */ 190#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 191#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 192 193/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 194#ifndef _ANSI_SOURCE 195#define P_tmpdir "/var/tmp/" 196#endif 197#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 198#define TMP_MAX 308915776 199 200/* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 201#ifndef SEEK_SET 202#define SEEK_SET 0 /* set file offset to offset */ 203#endif 204#ifndef SEEK_CUR 205#define SEEK_CUR 1 /* set file offset to current plus offset */ 206#endif 207#ifndef SEEK_END 208#define SEEK_END 2 /* set file offset to EOF plus offset */ 209#endif 210 211#define stdin (&__sF[0]) 212#define stdout (&__sF[1]) 213#define stderr (&__sF[2]) 214 215/* 216 * Functions defined in ANSI C standard. 217 */ 218__BEGIN_DECLS 219void clearerr __P((FILE *)); 220int fclose __P((FILE *)); 221int feof __P((FILE *)); 222int ferror __P((FILE *)); 223int fflush __P((FILE *)); 224int fgetc __P((FILE *)); 225int fgetpos __P((FILE *, fpos_t *)); 226char *fgets __P((char *, int, FILE *)); 227FILE *fopen __P((const char *, const char *)); 228int fprintf __P((FILE *, const char *, ...)); 229int fputc __P((int, FILE *)); 230int fputs __P((const char *, FILE *)); 231size_t fread __P((void *, size_t, size_t, FILE *)); 232FILE *freopen __P((const char *, const char *, FILE *)); 233int fscanf __P((FILE *, const char *, ...)); 234int fseek __P((FILE *, long, int)); 235int fsetpos __P((FILE *, const fpos_t *)); 236long ftell __P((FILE *)); 237size_t fwrite __P((const void *, size_t, size_t, FILE *)); 238int getc __P((FILE *)); 239int getchar __P((void)); 240void perror __P((const char *)); 241int printf __P((const char *, ...)); 242int putc __P((int, FILE *)); 243int putchar __P((int)); 244int puts __P((const char *)); 245int remove __P((const char *)); 246void rewind __P((FILE *)); 247int scanf __P((const char *, ...)); 248void setbuf __P((FILE *, char *)); 249int setvbuf __P((FILE *, char *, int, size_t)); 250int sscanf __P((const char *, const char *, ...)); 251FILE *tmpfile __P((void)); 252int ungetc __P((int, FILE *)); 253int vfprintf __P((FILE *, const char *, _BSD_VA_LIST_)); 254int vprintf __P((const char *, _BSD_VA_LIST_)); 255 256#ifndef __AUDIT__ 257char *gets __P((char *)); 258int sprintf __P((char *, const char *, ...)); 259char *tmpnam __P((char *)); 260int vsprintf __P((char *, const char *, _BSD_VA_LIST_)); 261#endif 262 263#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 264int rename __P((const char *, const char *)) __RENAME(__posix_rename); 265#else 266int rename __P((const char *, const char *)); 267#endif 268__END_DECLS 269 270/* 271 * Functions defined in POSIX 1003.1. 272 */ 273#ifndef _ANSI_SOURCE 274#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 275#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 276 277__BEGIN_DECLS 278char *ctermid __P((char *)); 279char *cuserid __P((char *)); 280FILE *fdopen __P((int, const char *)); 281int fileno __P((FILE *)); 282__END_DECLS 283#endif /* not ANSI */ 284 285#if 1 /* _POSIX_C_SOURCE >= 199506L */ 286extern void flockfile __P((FILE *)); 287extern int ftrylockfile __P((FILE *)); 288extern void funlockfile __P((FILE *)); 289extern int getc_unlocked __P((FILE *)); 290extern int getchar_unlocked __P((void)); 291extern int putc_unlocked __P((int, FILE *)); 292extern int putchar_unlocked __P((int)); 293#endif 294 295/* 296 * Functions defined in POSIX 1003.2 and XPGn or later. 297 */ 298#if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) || \ 299 (_POSIX_C_SOURCE - 0) >= 2 || defined(_XOPEN_SOURCE) 300__BEGIN_DECLS 301int pclose __P((FILE *)); 302FILE *popen __P((const char *, const char *)); 303__END_DECLS 304#endif 305 306/* 307 * Functions defined in XPG4.2. 308 */ 309#if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) || \ 310 defined(_XOPEN_SOURCE) 311__BEGIN_DECLS 312int getw __P((FILE *)); 313int putw __P((int, FILE *)); 314int snprintf __P((char *, size_t, const char *, ...)) 315 __attribute__((__format__(__printf__, 3, 4))); 316int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)) 317 __attribute__((__format__(__printf__, 3, 0))); 318 319#ifndef __AUDIT__ 320char *tempnam __P((const char *, const char *)); 321#endif 322__END_DECLS 323#endif 324 325/* 326 * Routines that are purely local. 327 */ 328#if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 329 !defined(_XOPEN_SOURCE) 330__BEGIN_DECLS 331int asprintf __P((char **, const char *, ...)) 332 __attribute__((format (printf, 2, 3))); 333char *fgetln __P((FILE *, size_t *)); 334int fpurge __P((FILE *)); 335void setbuffer __P((FILE *, char *, int)); 336int setlinebuf __P((FILE *)); 337int vasprintf __P((char **, const char *, _BSD_VA_LIST_)) 338 __attribute__((format (printf, 2, 0))); 339int vscanf __P((const char *, _BSD_VA_LIST_)) 340 __attribute__((__format__(__scanf__, 1, 0))); 341int vsscanf __P((const char *, const char *, _BSD_VA_LIST_)) 342 __attribute__((__format__(__scanf__, 2, 0))); 343__END_DECLS 344 345/* 346 * This is a #define because the function is used internally and 347 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 348 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 349 */ 350#define vfscanf __svfscanf 351 352/* 353 * Stdio function-access interface. 354 */ 355__BEGIN_DECLS 356FILE *funopen __P((const void *, 357 int (*)(void *, char *, int), 358 int (*)(void *, const char *, int), 359 fpos_t (*)(void *, fpos_t, int), 360 int (*)(void *))); 361__END_DECLS 362#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 363#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 364#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 365 366/* 367 * Functions internal to the implementation. 368 */ 369__BEGIN_DECLS 370int __srget __P((FILE *)); 371int __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_)); 372int __swbuf __P((int, FILE *)); 373__END_DECLS 374 375/* 376 * The __sfoo macros are here so that we can 377 * define function versions in the C library. 378 */ 379#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 380#if defined(__GNUC__) && defined(__STDC__) 381static __inline int __sputc(int _c, FILE *_p) { 382 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 383 return (*_p->_p++ = _c); 384 else 385 return (__swbuf(_c, _p)); 386} 387#else 388/* 389 * This has been tuned to generate reasonable code on the vax using pcc. 390 */ 391#define __sputc(c, p) \ 392 (--(p)->_w < 0 ? \ 393 (p)->_w >= (p)->_lbfsize ? \ 394 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 395 (int)*(p)->_p++ : \ 396 __swbuf('\n', p) : \ 397 __swbuf((int)(c), p) : \ 398 (*(p)->_p = (c), (int)*(p)->_p++)) 399#endif 400 401#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 402#define __sferror(p) (((p)->_flags & __SERR) != 0) 403#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 404#define __sfileno(p) ((p)->_file) 405 406#ifndef lint 407#ifndef _REENTRANT 408#define feof(p) __sfeof(p) 409#define ferror(p) __sferror(p) 410#define clearerr(p) __sclearerr(p) 411 412#define getc(fp) __sgetc(fp) 413#define putc(x, fp) __sputc(x, fp) 414#endif /* _REENTRANT */ 415#endif /* lint */ 416 417#define getchar() getc(stdin) 418#define putchar(x) putc(x, stdout) 419 420#ifndef _ANSI_SOURCE 421#define fileno(p) __sfileno(p) 422 423#define getc_unlocked(fp) __sgetc(fp) 424#define putc_unlocked(x, fp) __sputc(x, fp) 425 426#define getchar_unlocked() getc_unlocked(stdin) 427#define putchar_unlocked(x) putc_unlocked(x, stdout) 428#endif /* _ANSI_SOURCE */ 429 430#endif /* _STDIO_H_ */ 431