stdio.h revision 24897
1169689Skan/*- 2169689Skan * Copyright (c) 1990, 1993 3169689Skan * The Regents of the University of California. All rights reserved. 4169689Skan * 5169689Skan * This code is derived from software contributed to Berkeley by 6169689Skan * Chris Torek. 7169689Skan * 8169689Skan * Redistribution and use in source and binary forms, with or without 9169689Skan * modification, are permitted provided that the following conditions 10169689Skan * are met: 11169689Skan * 1. Redistributions of source code must retain the above copyright 12169689Skan * notice, this list of conditions and the following disclaimer. 13169689Skan * 2. Redistributions in binary form must reproduce the above copyright 14169689Skan * notice, this list of conditions and the following disclaimer in the 15169689Skan * documentation and/or other materials provided with the distribution. 16169689Skan * 3. All advertising materials mentioning features or use of this software 17169689Skan * must display the following acknowledgement: 18169689Skan * This product includes software developed by the University of 19169689Skan * California, Berkeley and its contributors. 20169689Skan * 4. Neither the name of the University nor the names of its contributors 21169689Skan * may be used to endorse or promote products derived from this software 22169689Skan * without specific prior written permission. 23169689Skan * 24169689Skan * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25169689Skan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26169689Skan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27169689Skan * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28169689Skan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29169689Skan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30169689Skan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31169689Skan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32169689Skan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33169689Skan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34169689Skan * SUCH DAMAGE. 35169689Skan * 36169689Skan * @(#)stdio.h 8.5 (Berkeley) 4/29/95 37169689Skan * $Id: stdio.h,v 1.12 1997/03/11 11:16:27 peter Exp $ 38169689Skan */ 39169689Skan 40169689Skan#ifndef _STDIO_H_ 41169689Skan#define _STDIO_H_ 42169689Skan 43169689Skan#include <sys/cdefs.h> 44169689Skan#include <machine/ansi.h> 45169689Skan 46169689Skan#ifdef _BSD_SIZE_T_ 47169689Skantypedef _BSD_SIZE_T_ size_t; 48169689Skan#undef _BSD_SIZE_T_ 49169689Skan#endif 50169689Skan 51169689Skan#ifndef NULL 52169689Skan#define NULL 0 53169689Skan#endif 54169689Skan 55169689Skan/* 56169689Skan * This is fairly grotesque, but pure ANSI code must not inspect the 57169689Skan * innards of an fpos_t anyway. The library internally uses off_t, 58169689Skan * which we assume is exactly as big as eight chars. (When we switch 59169689Skan * to gcc 2.4 we will use __attribute__ here.) 60169689Skan * 61169689Skan * WARNING: the alignment constraints on an off_t and the struct below 62169689Skan * differ on (e.g.) the SPARC. Hence, the placement of an fpos_t object 63169689Skan * in a structure will change if fpos_t's are not aligned on 8-byte 64169689Skan * boundaries. THIS IS A CROCK, but for now there is no way around it. 65169689Skan */ 66169689Skan#if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 67169689Skantypedef _BSD_OFF_T_ fpos_t; 68169689Skan#else 69169689Skantypedef struct __sfpos { 70169689Skan char _pos[8]; 71169689Skan} fpos_t; 72169689Skan#endif 73169689Skan 74169689Skan#define _FSTDIO /* Define for new stdio with functions. */ 75169689Skan 76169689Skan/* 77169689Skan * NB: to fit things in six character monocase externals, the stdio 78169689Skan * code uses the prefix `__s' for stdio objects, typically followed 79169689Skan * by a three-character attempt at a mnemonic. 80169689Skan */ 81169689Skan 82169689Skan/* stdio buffers */ 83169689Skanstruct __sbuf { 84169689Skan unsigned char *_base; 85169689Skan int _size; 86169689Skan}; 87169689Skan 88169689Skan/* 89169689Skan * stdio state variables. 90169689Skan * 91169689Skan * The following always hold: 92169689Skan * 93169689Skan * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 94169689Skan * _lbfsize is -_bf._size, else _lbfsize is 0 95169689Skan * if _flags&__SRD, _w is 0 96169689Skan * if _flags&__SWR, _r is 0 97169689Skan * 98169689Skan * This ensures that the getc and putc macros (or inline functions) never 99169689Skan * try to write or read from a file that is in `read' or `write' mode. 100169689Skan * (Moreover, they can, and do, automatically switch from read mode to 101169689Skan * write mode, and back, on "r+" and "w+" files.) 102169689Skan * 103169689Skan * _lbfsize is used only to make the inline line-buffered output stream 104169689Skan * code as compact as possible. 105169689Skan * 106169689Skan * _ub, _up, and _ur are used when ungetc() pushes back more characters 107169689Skan * than fit in the current _bf, or when ungetc() pushes back a character 108169689Skan * that does not match the previous one in _bf. When this happens, 109169689Skan * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 110169689Skan * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 111169689Skan * 112169689Skan * NB: see WARNING above before changing the layout of this structure! 113169689Skan */ 114169689Skantypedef struct __sFILE { 115169689Skan unsigned char *_p; /* current position in (some) buffer */ 116169689Skan int _r; /* read space left for getc() */ 117169689Skan int _w; /* write space left for putc() */ 118169689Skan short _flags; /* flags, below; this FILE is free if 0 */ 119169689Skan short _file; /* fileno, if Unix descriptor, else -1 */ 120169689Skan struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 121169689Skan int _lbfsize; /* 0 or -_bf._size, for inline putc */ 122169689Skan 123169689Skan /* operations */ 124169689Skan void *_cookie; /* cookie passed to io functions */ 125169689Skan int (*_close) __P((void *)); 126169689Skan int (*_read) __P((void *, char *, int)); 127169689Skan fpos_t (*_seek) __P((void *, fpos_t, int)); 128169689Skan int (*_write) __P((void *, const char *, int)); 129169689Skan 130169689Skan /* separate buffer for long sequences of ungetc() */ 131169689Skan struct __sbuf _ub; /* ungetc buffer */ 132169689Skan unsigned char *_up; /* saved _p when _p is doing ungetc data */ 133169689Skan int _ur; /* saved _r when _r is counting ungetc data */ 134169689Skan 135169689Skan /* tricks to meet minimum requirements even when malloc() fails */ 136169689Skan unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 137169689Skan unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 138169689Skan 139169689Skan /* separate buffer for fgetln() when line crosses buffer boundary */ 140169689Skan struct __sbuf _lb; /* buffer for fgetln() */ 141169689Skan 142169689Skan /* Unix stdio files get aligned to block boundaries on fseek() */ 143169689Skan int _blksize; /* stat.st_blksize (may be != _bf._size) */ 144169689Skan fpos_t _offset; /* current lseek offset (see WARNING) */ 145169689Skan} FILE; 146169689Skan 147169689Skan__BEGIN_DECLS 148169689Skanextern FILE __sF[]; 149169689Skan__END_DECLS 150169689Skan 151169689Skan#define __SLBF 0x0001 /* line buffered */ 152169689Skan#define __SNBF 0x0002 /* unbuffered */ 153169689Skan#define __SRD 0x0004 /* OK to read */ 154169689Skan#define __SWR 0x0008 /* OK to write */ 155169689Skan /* RD and WR are never simultaneously asserted */ 156169689Skan#define __SRW 0x0010 /* open for reading & writing */ 157169689Skan#define __SEOF 0x0020 /* found EOF */ 158169689Skan#define __SERR 0x0040 /* found error */ 159169689Skan#define __SMBF 0x0080 /* _buf is from malloc */ 160169689Skan#define __SAPP 0x0100 /* fdopen()ed in append mode */ 161169689Skan#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 162169689Skan#define __SOPT 0x0400 /* do fseek() optimization */ 163169689Skan#define __SNPT 0x0800 /* do not do fseek() optimization */ 164169689Skan#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 165169689Skan#define __SMOD 0x2000 /* true => fgetln modified _p text */ 166169689Skan 167169689Skan/* 168169689Skan * The following three definitions are for ANSI C, which took them 169169689Skan * from System V, which brilliantly took internal interface macros and 170169689Skan * made them official arguments to setvbuf(), without renaming them. 171169689Skan * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 172169689Skan * 173169689Skan * Although numbered as their counterparts above, the implementation 174169689Skan * does not rely on this. 175169689Skan */ 176169689Skan#define _IOFBF 0 /* setvbuf should set fully buffered */ 177169689Skan#define _IOLBF 1 /* setvbuf should set line buffered */ 178169689Skan#define _IONBF 2 /* setvbuf should set unbuffered */ 179169689Skan 180169689Skan#define BUFSIZ 1024 /* size of buffer used by setbuf */ 181169689Skan#define EOF (-1) 182169689Skan 183169689Skan/* 184169689Skan * FOPEN_MAX is a minimum maximum, and is the number of streams that 185169689Skan * stdio can provide without attempting to allocate further resources 186169689Skan * (which could fail). Do not use this for anything. 187169689Skan */ 188169689Skan /* must be == _POSIX_STREAM_MAX <limits.h> */ 189169689Skan#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 190169689Skan#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 191169689Skan 192169689Skan/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 193169689Skan#ifndef _ANSI_SOURCE 194169689Skan#define P_tmpdir "/var/tmp/" 195169689Skan#endif 196169689Skan#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 197169689Skan#define TMP_MAX 308915776 198169689Skan 199169689Skan#ifndef SEEK_SET 200169689Skan#define SEEK_SET 0 /* set file offset to offset */ 201169689Skan#endif 202169689Skan#ifndef SEEK_CUR 203169689Skan#define SEEK_CUR 1 /* set file offset to current plus offset */ 204169689Skan#endif 205169689Skan#ifndef SEEK_END 206169689Skan#define SEEK_END 2 /* set file offset to EOF plus offset */ 207169689Skan#endif 208169689Skan 209169689Skan#define stdin (&__sF[0]) 210169689Skan#define stdout (&__sF[1]) 211169689Skan#define stderr (&__sF[2]) 212169689Skan 213169689Skan/* 214169689Skan * Functions defined in ANSI C standard. 215169689Skan */ 216169689Skan__BEGIN_DECLS 217169689Skanvoid clearerr __P((FILE *)); 218169689Skanint fclose __P((FILE *)); 219169689Skanint feof __P((FILE *)); 220169689Skanint ferror __P((FILE *)); 221169689Skanint fflush __P((FILE *)); 222169689Skanint fgetc __P((FILE *)); 223169689Skanint fgetpos __P((FILE *, fpos_t *)); 224169689Skanchar *fgets __P((char *, int, FILE *)); 225169689SkanFILE *fopen __P((const char *, const char *)); 226169689Skanint fprintf __P((FILE *, const char *, ...)); 227169689Skanint fputc __P((int, FILE *)); 228169689Skanint fputs __P((const char *, FILE *)); 229169689Skansize_t fread __P((void *, size_t, size_t, FILE *)); 230169689SkanFILE *freopen __P((const char *, const char *, FILE *)); 231169689Skanint fscanf __P((FILE *, const char *, ...)); 232169689Skanint fseek __P((FILE *, long, int)); 233169689Skanint fsetpos __P((FILE *, const fpos_t *)); 234169689Skanlong ftell __P((FILE *)); 235169689Skansize_t fwrite __P((const void *, size_t, size_t, FILE *)); 236169689Skanint getc __P((FILE *)); 237169689Skanint getchar __P((void)); 238169689Skanchar *gets __P((char *)); 239169689Skan#if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 240169689Skanextern __const int sys_nerr; /* perror(3) external variables */ 241169689Skanextern __const char *__const sys_errlist[]; 242169689Skan#endif 243169689Skanvoid perror __P((const char *)); 244169689Skanint printf __P((const char *, ...)); 245169689Skanint putc __P((int, FILE *)); 246169689Skanint putchar __P((int)); 247169689Skanint puts __P((const char *)); 248169689Skanint remove __P((const char *)); 249169689Skanint rename __P((const char *, const char *)); 250169689Skanvoid rewind __P((FILE *)); 251169689Skanint scanf __P((const char *, ...)); 252169689Skanvoid setbuf __P((FILE *, char *)); 253169689Skanint setvbuf __P((FILE *, char *, int, size_t)); 254169689Skanint sprintf __P((char *, const char *, ...)); 255169689Skanint sscanf __P((const char *, const char *, ...)); 256169689SkanFILE *tmpfile __P((void)); 257169689Skanchar *tmpnam __P((char *)); 258169689Skanint ungetc __P((int, FILE *)); 259169689Skanint vfprintf __P((FILE *, const char *, _BSD_VA_LIST_)); 260169689Skanint vprintf __P((const char *, _BSD_VA_LIST_)); 261169689Skanint vsprintf __P((char *, const char *, _BSD_VA_LIST_)); 262169689Skan__END_DECLS 263169689Skan 264169689Skan/* 265169689Skan * Functions defined in POSIX 1003.1. 266169689Skan */ 267169689Skan#ifndef _ANSI_SOURCE 268169689Skan/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 269169689Skan#define L_cuserid 17 270169689Skan 271169689Skan#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 272169689Skan 273169689Skan__BEGIN_DECLS 274169689Skanchar *ctermid __P((char *)); 275169689SkanFILE *fdopen __P((int, const char *)); 276169689Skanint fileno __P((FILE *)); 277169689Skan__END_DECLS 278169689Skan#endif /* not ANSI */ 279169689Skan 280169689Skan/* 281169689Skan * Portability hacks. See <sys/types.h>. 282169689Skan */ 283169689Skan#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 284169689Skan__BEGIN_DECLS 285169689Skan#ifndef _FTRUNCATE_DECLARED 286169689Skan#define _FTRUNCATE_DECLARED 287169689Skanint ftruncate __P((int, _BSD_OFF_T_)); 288169689Skan#endif 289169689Skan#ifndef _LSEEK_DECLARED 290169689Skan#define _LSEEK_DECLARED 291169689Skan_BSD_OFF_T_ lseek __P((int, _BSD_OFF_T_, int)); 292169689Skan#endif 293169689Skan#ifndef _MMAP_DECLARED 294169689Skan#define _MMAP_DECLARED 295169689Skanchar *mmap __P((char *, size_t, int, int, int, _BSD_OFF_T_)); 296169689Skan#endif 297169689Skan#ifndef _TRUNCATE_DECLARED 298169689Skan#define _TRUNCATE_DECLARED 299169689Skanint truncate __P((const char *, _BSD_OFF_T_)); 300169689Skan#endif 301169689Skan__END_DECLS 302169689Skan#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 303169689Skan 304169689Skan/* 305169689Skan * Routines that are purely local. 306169689Skan */ 307169689Skan#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 308169689Skan__BEGIN_DECLS 309169689Skanint asprintf __P((char **, const char *, ...)); 310169689Skanchar *fgetln __P((FILE *, size_t *)); 311169689Skanint fpurge __P((FILE *)); 312169689Skanint getw __P((FILE *)); 313169689Skanint pclose __P((FILE *)); 314169689SkanFILE *popen __P((const char *, const char *)); 315169689Skanint putw __P((int, FILE *)); 316169689Skanvoid setbuffer __P((FILE *, char *, int)); 317169689Skanint setlinebuf __P((FILE *)); 318169689Skanchar *tempnam __P((const char *, const char *)); 319169689Skanint snprintf __P((char *, size_t, const char *, ...)); 320169689Skanint vasprintf __P((char **, const char *, _BSD_VA_LIST_)); 321169689Skanint vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)); 322169689Skanint vscanf __P((const char *, _BSD_VA_LIST_)); 323169689Skanint vsscanf __P((const char *, const char *, _BSD_VA_LIST_)); 324169689Skan__END_DECLS 325169689Skan 326169689Skan/* 327169689Skan * This is a #define because the function is used internally and 328169689Skan * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 329169689Skan * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 330169689Skan */ 331169689Skan#define vfscanf __svfscanf 332169689Skan 333169689Skan/* 334169689Skan * Stdio function-access interface. 335169689Skan */ 336169689Skan__BEGIN_DECLS 337169689SkanFILE *funopen __P((const void *, 338169689Skan int (*)(void *, char *, int), 339169689Skan int (*)(void *, const char *, int), 340169689Skan fpos_t (*)(void *, fpos_t, int), 341169689Skan int (*)(void *))); 342169689Skan__END_DECLS 343169689Skan#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 344169689Skan#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 345169689Skan#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 346169689Skan 347169689Skan/* 348169689Skan * Functions internal to the implementation. 349169689Skan */ 350169689Skan__BEGIN_DECLS 351169689Skanint __srget __P((FILE *)); 352169689Skanint __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_)); 353169689Skanint __swbuf __P((int, FILE *)); 354169689Skan__END_DECLS 355169689Skan 356169689Skan/* 357169689Skan * The __sfoo macros are here so that we can 358169689Skan * define function versions in the C library. 359169689Skan */ 360169689Skan#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 361169689Skan#if defined(__GNUC__) && defined(__STDC__) 362169689Skanstatic __inline int __sputc(int _c, FILE *_p) { 363169689Skan if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 364169689Skan return (*_p->_p++ = _c); 365169689Skan else 366169689Skan return (__swbuf(_c, _p)); 367169689Skan} 368169689Skan#else 369169689Skan/* 370169689Skan * This has been tuned to generate reasonable code on the vax using pcc. 371169689Skan */ 372169689Skan#define __sputc(c, p) \ 373169689Skan (--(p)->_w < 0 ? \ 374169689Skan (p)->_w >= (p)->_lbfsize ? \ 375169689Skan (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 376169689Skan (int)*(p)->_p++ : \ 377169689Skan __swbuf('\n', p) : \ 378169689Skan __swbuf((int)(c), p) : \ 379169689Skan (*(p)->_p = (c), (int)*(p)->_p++)) 380169689Skan#endif 381169689Skan 382169689Skan#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 383169689Skan#define __sferror(p) (((p)->_flags & __SERR) != 0) 384169689Skan#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 385169689Skan#define __sfileno(p) ((p)->_file) 386169689Skan 387169689Skan#define feof(p) __sfeof(p) 388169689Skan#define ferror(p) __sferror(p) 389169689Skan#define clearerr(p) __sclearerr(p) 390169689Skan 391169689Skan#ifndef _ANSI_SOURCE 392169689Skan#define fileno(p) __sfileno(p) 393169689Skan#endif 394169689Skan 395169689Skan#ifndef lint 396169689Skan#define getc(fp) __sgetc(fp) 397169689Skan#define putc(x, fp) __sputc(x, fp) 398169689Skan#endif /* lint */ 399169689Skan 400169689Skan#define getchar() getc(stdin) 401169689Skan#define putchar(x) putc(x, stdout) 402169689Skan 403169689Skan#endif /* !_STDIO_H_ */ 404169689Skan