stdio.h revision 1.45
1/* $NetBSD: stdio.h,v 1.45 2002/05/24 22:17:20 thorpej 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#include <sys/ansi.h> 45 46#include <sys/cdefs.h> 47#include <sys/featuretest.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#include <sys/null.h> 56 57/* 58 * This is fairly grotesque, but pure ANSI code must not inspect the 59 * innards of an fpos_t anyway. The library internally uses off_t, 60 * which we assume is exactly as big as eight chars. 61 */ 62#if (!defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)) || defined(_LIBC) 63typedef __off_t fpos_t; 64#else 65typedef struct __sfpos { 66 __off_t _pos; 67} fpos_t; 68#endif 69 70#define _FSTDIO /* Define for new stdio with functions. */ 71 72/* 73 * NB: to fit things in six character monocase externals, the stdio 74 * code uses the prefix `__s' for stdio objects, typically followed 75 * by a three-character attempt at a mnemonic. 76 */ 77 78/* stdio buffers */ 79struct __sbuf { 80 unsigned char *_base; 81 int _size; 82}; 83 84/* 85 * stdio state variables. 86 * 87 * The following always hold: 88 * 89 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 90 * _lbfsize is -_bf._size, else _lbfsize is 0 91 * if _flags&__SRD, _w is 0 92 * if _flags&__SWR, _r is 0 93 * 94 * This ensures that the getc and putc macros (or inline functions) never 95 * try to write or read from a file that is in `read' or `write' mode. 96 * (Moreover, they can, and do, automatically switch from read mode to 97 * write mode, and back, on "r+" and "w+" files.) 98 * 99 * _lbfsize is used only to make the inline line-buffered output stream 100 * code as compact as possible. 101 * 102 * _ub, _up, and _ur are used when ungetc() pushes back more characters 103 * than fit in the current _bf, or when ungetc() pushes back a character 104 * that does not match the previous one in _bf. When this happens, 105 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 106 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 107 * 108 * NB: see WARNING above before changing the layout of this structure! 109 */ 110typedef struct __sFILE { 111 unsigned char *_p; /* current position in (some) buffer */ 112 int _r; /* read space left for getc() */ 113 int _w; /* write space left for putc() */ 114 short _flags; /* flags, below; this FILE is free if 0 */ 115 short _file; /* fileno, if Unix descriptor, else -1 */ 116 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 117 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 118 119 /* operations */ 120 void *_cookie; /* cookie passed to io functions */ 121 int (*_close) __P((void *)); 122 int (*_read) __P((void *, char *, int)); 123 fpos_t (*_seek) __P((void *, fpos_t, int)); 124 int (*_write) __P((void *, const char *, int)); 125 126 /* file extension */ 127 struct __sbuf _ext; 128 129 /* separate buffer for long sequences of ungetc() */ 130 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 131 int _ur; /* saved _r when _r is counting ungetc data */ 132 133 /* tricks to meet minimum requirements even when malloc() fails */ 134 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 135 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 136 137 /* separate buffer for fgetln() when line crosses buffer boundary */ 138 struct __sbuf _lb; /* buffer for fgetln() */ 139 140 /* Unix stdio files get aligned to block boundaries on fseek() */ 141 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 142 fpos_t _offset; /* current lseek offset */ 143} FILE; 144 145__BEGIN_DECLS 146extern FILE __sF[]; 147__END_DECLS 148 149#define __SLBF 0x0001 /* line buffered */ 150#define __SNBF 0x0002 /* unbuffered */ 151#define __SRD 0x0004 /* OK to read */ 152#define __SWR 0x0008 /* OK to write */ 153 /* RD and WR are never simultaneously asserted */ 154#define __SRW 0x0010 /* open for reading & writing */ 155#define __SEOF 0x0020 /* found EOF */ 156#define __SERR 0x0040 /* found error */ 157#define __SMBF 0x0080 /* _buf is from malloc */ 158#define __SAPP 0x0100 /* fdopen()ed in append mode */ 159#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 160#define __SOPT 0x0400 /* do fseek() optimization */ 161#define __SNPT 0x0800 /* do not do fseek() optimization */ 162#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 163#define __SMOD 0x2000 /* true => fgetln modified _p text */ 164#define __SALC 0x4000 /* allocate string space dynamically */ 165 166/* 167 * The following three definitions are for ANSI C, which took them 168 * from System V, which brilliantly took internal interface macros and 169 * made them official arguments to setvbuf(), without renaming them. 170 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 171 * 172 * Although numbered as their counterparts above, the implementation 173 * does not rely on this. 174 */ 175#define _IOFBF 0 /* setvbuf should set fully buffered */ 176#define _IOLBF 1 /* setvbuf should set line buffered */ 177#define _IONBF 2 /* setvbuf should set unbuffered */ 178 179#define BUFSIZ 1024 /* size of buffer used by setbuf */ 180#define EOF (-1) 181 182/* 183 * FOPEN_MAX is a minimum maximum, and is the number of streams that 184 * stdio can provide without attempting to allocate further resources 185 * (which could fail). Do not use this for anything. 186 */ 187 /* must be == _POSIX_STREAM_MAX <limits.h> */ 188#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 189#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 190 191/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 192#ifndef _ANSI_SOURCE 193#define P_tmpdir "/var/tmp/" 194#endif 195#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 196#define TMP_MAX 308915776 197 198/* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 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 * __restrict, fpos_t * __restrict)); 224char *fgets __P((char * __restrict, int, FILE * __restrict)); 225FILE *fopen __P((const char *, const char *)); 226int fprintf __P((FILE * __restrict , const char * __restrict, ...)); 227int fputc __P((int, FILE *)); 228int fputs __P((const char * __restrict, FILE * __restrict)); 229size_t fread __P((void * __restrict, size_t, size_t, FILE * __restrict)); 230FILE *freopen __P((const char *, const char *, FILE * __restrict)); 231int fscanf __P((FILE * __restrict, const char * __restrict, ...)); 232int fseek __P((FILE *, long, int)); 233int fsetpos __P((FILE *, const fpos_t *)); 234long ftell __P((FILE *)); 235size_t fwrite __P((const void * __restrict, size_t, size_t, 236 FILE * __restrict)); 237int getc __P((FILE *)); 238int getchar __P((void)); 239void perror __P((const char *)); 240int printf __P((const char * __restrict, ...)); 241int putc __P((int, FILE *)); 242int putchar __P((int)); 243int puts __P((const char *)); 244int remove __P((const char *)); 245void rewind __P((FILE *)); 246int scanf __P((const char * __restrict, ...)); 247void setbuf __P((FILE * __restrict, char * __restrict)); 248int setvbuf __P((FILE * __restrict, char * __restrict, int, size_t)); 249int sscanf __P((const char * __restrict, const char * __restrict, ...)); 250FILE *tmpfile __P((void)); 251int ungetc __P((int, FILE *)); 252int vfprintf __P((FILE * __restrict, const char * __restrict, 253 _BSD_VA_LIST_)); 254int vprintf __P((const char * __restrict, _BSD_VA_LIST_)); 255 256#ifndef __AUDIT__ 257char *gets __P((char *)); 258int sprintf __P((char * __restrict, const char * __restrict, ...)); 259char *tmpnam __P((char *)); 260int vsprintf __P((char * __resitrct, const char * __restrict, 261 _BSD_VA_LIST_)); 262#endif 263 264#if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 265int rename __P((const char *, const char *)) __RENAME(__posix_rename); 266#else 267int rename __P((const char *, const char *)); 268#endif 269__END_DECLS 270 271/* 272 * IEEE Std 1003.1-90 273 */ 274#ifndef _ANSI_SOURCE 275#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 276#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 277 278__BEGIN_DECLS 279char *ctermid __P((char *)); 280#ifndef __CUSERID_DECLARED 281#define __CUSERID_DECLARED 282/* also declared in unistd.h */ 283char *cuserid __P((char *)); 284#endif /* __CUSERID_DECLARED */ 285FILE *fdopen __P((int, const char *)); 286int fileno __P((FILE *)); 287__END_DECLS 288#endif /* not ANSI */ 289 290/* 291 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 292 */ 293#if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 294 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 199506L || \ 295 (_XOPEN_SOURCE - 0) >= 500 || defined(_REENTRANT) 296__BEGIN_DECLS 297#if 0 /* not yet */ 298void flockfile __P((FILE *)); 299int ftrylockfile __P((FILE *)); 300void funlockfile __P((FILE *)); 301#endif /* 0 */ 302int getc_unlocked __P((FILE *)); 303int getchar_unlocked __P((void)); 304int putc_unlocked __P((int, FILE *)); 305int putchar_unlocked __P((int)); 306__END_DECLS 307#endif /* (!_ANSI_SOURCE && !_POSIX_C_SOURCE && !_XOPEN_SOURCE) || ... */ 308 309/* 310 * Functions defined in POSIX 1003.2 and XPG2 or later. 311 */ 312#if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 313 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 2 || \ 314 (_XOPEN_SOURCE - 0) >= 2 315__BEGIN_DECLS 316int pclose __P((FILE *)); 317FILE *popen __P((const char *, const char *)); 318__END_DECLS 319#endif 320 321/* 322 * Functions defined in XPG4.2. 323 */ 324#if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) || \ 325 defined(_XOPEN_SOURCE) 326__BEGIN_DECLS 327int getw __P((FILE *)); 328int putw __P((int, FILE *)); 329int snprintf __P((char * __restrict, size_t, const char * __restrict, ...)) 330 __attribute__((__format__(__printf__, 3, 4))); 331int vsnprintf __P((char * __restrict, size_t, const char * __restrict, 332 _BSD_VA_LIST_)) 333 __attribute__((__format__(__printf__, 3, 0))); 334 335#ifndef __AUDIT__ 336char *tempnam __P((const char *, const char *)); 337#endif 338__END_DECLS 339#endif 340 341/* 342 * X/Open CAE Specification Issue 5 Version 2 343 */ 344#if (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)) || \ 345 (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) 346#ifndef off_t 347typedef __off_t off_t; 348#define off_t __off_t 349#endif /* off_t */ 350 351__BEGIN_DECLS 352int fseeko __P((FILE *, off_t, int)); 353off_t ftello __P((FILE *)); 354__END_DECLS 355#endif /* (!_POSIX_SOURCE && !_XOPEN_SOURCE) || ... */ 356 357/* 358 * Routines that are purely local. 359 */ 360#if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 361 !defined(_XOPEN_SOURCE) 362__BEGIN_DECLS 363int asprintf __P((char ** __restrict, const char * __restrict, ...)) 364 __attribute__((__format__(__printf__, 2, 3))); 365char *fgetln __P((FILE * __restrict, size_t * __restrict)); 366int fpurge __P((FILE *)); 367void setbuffer __P((FILE *, char *, int)); 368int setlinebuf __P((FILE *)); 369int vasprintf __P((char ** __restrict, const char * __restrict, 370 _BSD_VA_LIST_)) 371 __attribute__((__format__(__printf__, 2, 0))); 372int vscanf __P((const char * __restrict, _BSD_VA_LIST_)) 373 __attribute__((__format__(__scanf__, 1, 0))); 374int vfscanf __P((FILE * __restrict, const char * __restrict, 375 _BSD_VA_LIST_)) 376 __attribute__((__format__(__scanf__, 2, 0))); 377int vsscanf __P((const char * __restrict, const char * __restrict, 378 _BSD_VA_LIST_)) 379 __attribute__((__format__(__scanf__, 2, 0))); 380__const char *fmtcheck __P((const char *, const char *)) 381 __attribute__((__format_arg__(2))); 382__END_DECLS 383 384/* 385 * Stdio function-access interface. 386 */ 387__BEGIN_DECLS 388FILE *funopen __P((const void *, 389 int (*)(void *, char *, int), 390 int (*)(void *, const char *, int), 391 fpos_t (*)(void *, fpos_t, int), 392 int (*)(void *))); 393__END_DECLS 394#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 395#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 396#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 397 398/* 399 * Functions internal to the implementation. 400 */ 401__BEGIN_DECLS 402int __srget __P((FILE *)); 403int __swbuf __P((int, FILE *)); 404__END_DECLS 405 406/* 407 * The __sfoo macros are here so that we can 408 * define function versions in the C library. 409 */ 410#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 411#if defined(__GNUC__) && defined(__STDC__) 412static __inline int __sputc(int _c, FILE *_p) { 413 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 414 return (*_p->_p++ = _c); 415 else 416 return (__swbuf(_c, _p)); 417} 418#else 419/* 420 * This has been tuned to generate reasonable code on the vax using pcc. 421 */ 422#define __sputc(c, p) \ 423 (--(p)->_w < 0 ? \ 424 (p)->_w >= (p)->_lbfsize ? \ 425 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 426 (int)*(p)->_p++ : \ 427 __swbuf('\n', p) : \ 428 __swbuf((int)(c), p) : \ 429 (*(p)->_p = (c), (int)*(p)->_p++)) 430#endif 431 432#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 433#define __sferror(p) (((p)->_flags & __SERR) != 0) 434#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 435#define __sfileno(p) ((p)->_file) 436 437#ifndef lint 438#ifndef _REENTRANT 439#define feof(p) __sfeof(p) 440#define ferror(p) __sferror(p) 441#define clearerr(p) __sclearerr(p) 442 443#define getc(fp) __sgetc(fp) 444#define putc(x, fp) __sputc(x, fp) 445#endif /* !_REENTRANT */ 446#endif /* lint */ 447 448#define getchar() getc(stdin) 449#define putchar(x) putc(x, stdout) 450 451#ifndef _ANSI_SOURCE 452#ifndef _REENTRANT 453#define fileno(p) __sfileno(p) 454#endif /* !_REENTRANT */ 455#endif /* !_ANSI_SOURCE */ 456 457#if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 458 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 199506L || \ 459 (_XOPEN_SOURCE - 0) >= 500 || defined(_REENTRANT) 460#define getc_unlocked(fp) __sgetc(fp) 461#define putc_unlocked(x, fp) __sputc(x, fp) 462 463#define getchar_unlocked() getc_unlocked(stdin) 464#define putchar_unlocked(x) putc_unlocked(x, stdout) 465#endif /* (!_ANSI_SOURCE && !_POSIX_C_SOURCE && !_XOPEN_SOURCE) || ... */ 466 467#endif /* _STDIO_H_ */ 468