stdio.h revision 1.7
1/* $OpenBSD: stdio.h,v 1.7 1996/10/28 06:51:05 tholo Exp $ */ 2/* $NetBSD: stdio.h,v 1.18 1996/04/25 18:29:21 jtc Exp $ */ 3 4/*- 5 * Copyright (c) 1990 The Regents of the University of California. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * Chris Torek. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the University of 22 * California, Berkeley and its contributors. 23 * 4. Neither the name of the University nor the names of its contributors 24 * may be used to endorse or promote products derived from this software 25 * without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 37 * SUCH DAMAGE. 38 * 39 * @(#)stdio.h 5.17 (Berkeley) 6/3/91 40 */ 41 42#ifndef _STDIO_H_ 43#define _STDIO_H_ 44 45#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 46#include <sys/types.h> 47#endif 48 49#include <sys/cdefs.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 /* LONGLONG */ 71 long long _pos; /* XXX must be the same as off_t */ 72} fpos_t; 73#endif 74 75#define _FSTDIO /* Define for new stdio with functions. */ 76 77/* 78 * NB: to fit things in six character monocase externals, the stdio 79 * code uses the prefix `__s' for stdio objects, typically followed 80 * by a three-character attempt at a mnemonic. 81 */ 82 83/* stdio buffers */ 84struct __sbuf { 85 unsigned char *_base; 86 int _size; 87}; 88 89/* 90 * stdio state variables. 91 * 92 * The following always hold: 93 * 94 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 95 * _lbfsize is -_bf._size, else _lbfsize is 0 96 * if _flags&__SRD, _w is 0 97 * if _flags&__SWR, _r is 0 98 * 99 * This ensures that the getc and putc macros (or inline functions) never 100 * try to write or read from a file that is in `read' or `write' mode. 101 * (Moreover, they can, and do, automatically switch from read mode to 102 * write mode, and back, on "r+" and "w+" files.) 103 * 104 * _lbfsize is used only to make the inline line-buffered output stream 105 * code as compact as possible. 106 * 107 * _ub, _up, and _ur are used when ungetc() pushes back more characters 108 * than fit in the current _bf, or when ungetc() pushes back a character 109 * that does not match the previous one in _bf. When this happens, 110 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 111 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 112 */ 113typedef struct __sFILE { 114 unsigned char *_p; /* current position in (some) buffer */ 115 int _r; /* read space left for getc() */ 116 int _w; /* write space left for putc() */ 117 short _flags; /* flags, below; this FILE is free if 0 */ 118 short _file; /* fileno, if Unix descriptor, else -1 */ 119 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 120 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 121 122 /* operations */ 123 void *_cookie; /* cookie passed to io functions */ 124 int (*_close) __P((void *)); 125 int (*_read) __P((void *, char *, int)); 126 fpos_t (*_seek) __P((void *, fpos_t, int)); 127 int (*_write) __P((void *, const char *, int)); 128 129 /* separate buffer for long sequences of ungetc() */ 130 struct __sbuf _ub; /* ungetc buffer */ 131 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 132 int _ur; /* saved _r when _r is counting ungetc data */ 133 134 /* tricks to meet minimum requirements even when malloc() fails */ 135 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 136 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 137 138 /* separate buffer for fgetln() when line crosses buffer boundary */ 139 struct __sbuf _lb; /* buffer for fgetln() */ 140 141 /* Unix stdio files get aligned to block boundaries on fseek() */ 142 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 143 fpos_t _offset; /* current lseek offset */ 144} FILE; 145 146__BEGIN_DECLS 147extern FILE __sF[]; 148__END_DECLS 149 150#define __SLBF 0x0001 /* line buffered */ 151#define __SNBF 0x0002 /* unbuffered */ 152#define __SRD 0x0004 /* OK to read */ 153#define __SWR 0x0008 /* OK to write */ 154 /* RD and WR are never simultaneously asserted */ 155#define __SRW 0x0010 /* open for reading & writing */ 156#define __SEOF 0x0020 /* found EOF */ 157#define __SERR 0x0040 /* found error */ 158#define __SMBF 0x0080 /* _buf is from malloc */ 159#define __SAPP 0x0100 /* fdopen()ed in append mode */ 160#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 161#define __SOPT 0x0400 /* do fseek() optimisation */ 162#define __SNPT 0x0800 /* do not do fseek() optimisation */ 163#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 164#define __SMOD 0x2000 /* true => fgetln modified _p text */ 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 should be the number of descriptors 184 * that the kernel can provide without allocation of a resource that can 185 * fail without the process sleeping. Do not use this for anything. 186 */ 187#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 188#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 189 190/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 191#ifndef _ANSI_SOURCE 192#define P_tmpdir "/var/tmp/" 193#endif 194#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 195#define TMP_MAX 308915776 196 197#ifndef SEEK_SET 198#define SEEK_SET 0 /* set file offset to offset */ 199#endif 200#ifndef SEEK_CUR 201#define SEEK_CUR 1 /* set file offset to current plus offset */ 202#endif 203#ifndef SEEK_END 204#define SEEK_END 2 /* set file offset to EOF plus offset */ 205#endif 206 207#define stdin (&__sF[0]) 208#define stdout (&__sF[1]) 209#define stderr (&__sF[2]) 210 211/* 212 * Functions defined in ANSI C standard. 213 */ 214__BEGIN_DECLS 215void clearerr __P((FILE *)); 216int fclose __P((FILE *)); 217int feof __P((FILE *)); 218int ferror __P((FILE *)); 219int fflush __P((FILE *)); 220int fgetc __P((FILE *)); 221int fgetpos __P((FILE *, fpos_t *)); 222char *fgets __P((char *, int, FILE *)); 223FILE *fopen __P((const char *, const char *)); 224int fprintf __P((FILE *, const char *, ...)); 225int fputc __P((int, FILE *)); 226int fputs __P((const char *, FILE *)); 227size_t fread __P((void *, size_t, size_t, FILE *)); 228FILE *freopen __P((const char *, const char *, FILE *)); 229int fscanf __P((FILE *, const char *, ...)); 230int fseek __P((FILE *, long, int)); 231int fsetpos __P((FILE *, const fpos_t *)); 232long ftell __P((FILE *)); 233size_t fwrite __P((const void *, size_t, size_t, FILE *)); 234int getc __P((FILE *)); 235int getchar __P((void)); 236char *gets __P((char *)); 237#if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) && !defined(__SYS_ERRLIST) 238#define __SYS_ERRLIST 239 240extern int sys_nerr; /* perror(3) external variables */ 241extern char *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#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 269#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 270 271__BEGIN_DECLS 272char *ctermid __P((char *)); 273char *cuserid __P((char *)); 274FILE *fdopen __P((int, const char *)); 275int fileno __P((FILE *)); 276__END_DECLS 277#endif /* not ANSI */ 278 279/* 280 * Routines that are purely local. 281 */ 282#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 283__BEGIN_DECLS 284char *fgetln __P((FILE *, size_t *)); 285int fpurge __P((FILE *)); 286int getw __P((FILE *)); 287int pclose __P((FILE *)); 288FILE *popen __P((const char *, const char *)); 289int putw __P((int, FILE *)); 290void setbuffer __P((FILE *, char *, int)); 291int setlinebuf __P((FILE *)); 292char *tempnam __P((const char *, const char *)); 293int snprintf __P((char *, size_t, const char *, ...)) 294 __attribute__((format (printf, 3, 4))); 295int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)) 296 __attribute__((format (printf, 3, 0))); 297int vscanf __P((const char *, _BSD_VA_LIST_)) 298 __attribute__((format (scanf, 1, 0))); 299int vsscanf __P((const char *, const char *, _BSD_VA_LIST_)) 300 __attribute__((format (scanf, 2, 0))); 301__END_DECLS 302 303/* 304 * This is a #define because the function is used internally and 305 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 306 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 307 */ 308#define vfscanf __svfscanf 309 310/* 311 * Stdio function-access interface. 312 */ 313__BEGIN_DECLS 314FILE *funopen __P((const void *, 315 int (*)(void *, char *, int), 316 int (*)(void *, const char *, int), 317 fpos_t (*)(void *, fpos_t, int), 318 int (*)(void *))); 319__END_DECLS 320#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 321#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 322#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 323 324/* 325 * Functions internal to the implementation. 326 */ 327__BEGIN_DECLS 328int __srget __P((FILE *)); 329int __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_)); 330int __swbuf __P((int, FILE *)); 331__END_DECLS 332 333/* 334 * The __sfoo macros are here so that we can 335 * define function versions in the C library. 336 */ 337#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 338#if defined(__GNUC__) && defined(__STDC__) 339static __inline int __sputc(int _c, FILE *_p) { 340 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 341 return (*_p->_p++ = _c); 342 else 343 return (__swbuf(_c, _p)); 344} 345#else 346/* 347 * This has been tuned to generate reasonable code on the vax using pcc. 348 */ 349#define __sputc(c, p) \ 350 (--(p)->_w < 0 ? \ 351 (p)->_w >= (p)->_lbfsize ? \ 352 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 353 (int)*(p)->_p++ : \ 354 __swbuf('\n', p) : \ 355 __swbuf((int)(c), p) : \ 356 (*(p)->_p = (c), (int)*(p)->_p++)) 357#endif 358 359#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 360#define __sferror(p) (((p)->_flags & __SERR) != 0) 361#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 362#define __sfileno(p) ((p)->_file) 363 364#define feof(p) __sfeof(p) 365#define ferror(p) __sferror(p) 366#define clearerr(p) __sclearerr(p) 367 368#ifndef _ANSI_SOURCE 369#define fileno(p) __sfileno(p) 370#endif 371 372#ifndef lint 373#define getc(fp) __sgetc(fp) 374/* 375 * The macro implementation of putc is not fully POSIX 376 * compliant; it does not set errno on failure 377 */ 378#ifndef _POSIX_SOURCE 379#define putc(x, fp) __sputc(x, fp) 380#endif /* _POSIX_SOURCE */ 381#endif /* lint */ 382 383#define getchar() getc(stdin) 384#define putchar(x) putc(x, stdout) 385#endif /* _STDIO_H_ */ 386