stdio.h revision 1.12
1 /*- 2 * Copyright (c) 1990 The Regents of the University of California. 3 * 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 * from: @(#)stdio.h 5.17 (Berkeley) 6/3/91 37 * $Id: stdio.h,v 1.12 1994/05/21 09:42:20 cgd Exp $ 38 */ 39 40 #ifndef _STDIO_H_ 41 #define _STDIO_H_ 42 43 #if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI_) 44 #include <sys/types.h> 45 #endif 46 47 #include <sys/cdefs.h> 48 49 #include <machine/ansi.h> 50 #ifdef _BSD_SIZE_T_ 51 typedef _BSD_SIZE_T_ size_t; 52 #undef _BSD_SIZE_T_ 53 #endif 54 55 #ifndef NULL 56 #define NULL 0 57 #endif 58 59 /* 60 * This is fairly grotesque, but pure ANSI code must not inspect the 61 * innards of an fpos_t anyway. The library internally uses off_t, 62 * which we assume is exactly as big as eight chars. 63 */ 64 #if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 65 typedef off_t fpos_t; 66 #else 67 typedef struct __sfpos { 68 long long _pos; /* XXX must be the same as off_t */ 69 } fpos_t; 70 #endif 71 72 #define _FSTDIO /* Define for new stdio with functions. */ 73 74 /* 75 * NB: to fit things in six character monocase externals, the stdio 76 * code uses the prefix `__s' for stdio objects, typically followed 77 * by a three-character attempt at a mnemonic. 78 */ 79 80 /* stdio buffers */ 81 struct __sbuf { 82 unsigned char *_base; 83 int _size; 84 }; 85 86 /* 87 * stdio state variables. 88 * 89 * The following always hold: 90 * 91 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 92 * _lbfsize is -_bf._size, else _lbfsize is 0 93 * if _flags&__SRD, _w is 0 94 * if _flags&__SWR, _r is 0 95 * 96 * This ensures that the getc and putc macros (or inline functions) never 97 * try to write or read from a file that is in `read' or `write' mode. 98 * (Moreover, they can, and do, automatically switch from read mode to 99 * write mode, and back, on "r+" and "w+" files.) 100 * 101 * _lbfsize is used only to make the inline line-buffered output stream 102 * code as compact as possible. 103 * 104 * _ub, _up, and _ur are used when ungetc() pushes back more characters 105 * than fit in the current _bf, or when ungetc() pushes back a character 106 * that does not match the previous one in _bf. When this happens, 107 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 108 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 109 */ 110 typedef 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 /* separate buffer for long sequences of ungetc() */ 127 struct __sbuf _ub; /* ungetc buffer */ 128 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 129 int _ur; /* saved _r when _r is counting ungetc data */ 130 131 /* tricks to meet minimum requirements even when malloc() fails */ 132 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 133 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 134 135 /* separate buffer for fgetln() when line crosses buffer boundary */ 136 struct __sbuf _lb; /* buffer for fgetln() */ 137 138 /* Unix stdio files get aligned to block boundaries on fseek() */ 139 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 140 fpos_t _offset; /* current lseek offset */ 141 } FILE; 142 143 __BEGIN_DECLS 144 extern FILE __sF[]; 145 __END_DECLS 146 147 #define __SLBF 0x0001 /* line buffered */ 148 #define __SNBF 0x0002 /* unbuffered */ 149 #define __SRD 0x0004 /* OK to read */ 150 #define __SWR 0x0008 /* OK to write */ 151 /* RD and WR are never simultaneously asserted */ 152 #define __SRW 0x0010 /* open for reading & writing */ 153 #define __SEOF 0x0020 /* found EOF */ 154 #define __SERR 0x0040 /* found error */ 155 #define __SMBF 0x0080 /* _buf is from malloc */ 156 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 157 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 158 #define __SOPT 0x0400 /* do fseek() optimisation */ 159 #define __SNPT 0x0800 /* do not do fseek() optimisation */ 160 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 161 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 162 163 /* 164 * The following three definitions are for ANSI C, which took them 165 * from System V, which brilliantly took internal interface macros and 166 * made them official arguments to setvbuf(), without renaming them. 167 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 168 * 169 * Although numbered as their counterparts above, the implementation 170 * does not rely on this. 171 */ 172 #define _IOFBF 0 /* setvbuf should set fully buffered */ 173 #define _IOLBF 1 /* setvbuf should set line buffered */ 174 #define _IONBF 2 /* setvbuf should set unbuffered */ 175 176 #define BUFSIZ 1024 /* size of buffer used by setbuf */ 177 #define EOF (-1) 178 179 /* 180 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors 181 * that the kernel can provide without allocation of a resource that can 182 * fail without the process sleeping. Do not use this for anything. 183 */ 184 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 185 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 186 187 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 188 #ifndef _ANSI_SOURCE 189 #define P_tmpdir "/var/tmp/" 190 #endif 191 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 192 #define TMP_MAX 308915776 193 194 #ifndef SEEK_SET 195 #define SEEK_SET 0 /* set file offset to offset */ 196 #endif 197 #ifndef SEEK_CUR 198 #define SEEK_CUR 1 /* set file offset to current plus offset */ 199 #endif 200 #ifndef SEEK_END 201 #define SEEK_END 2 /* set file offset to EOF plus offset */ 202 #endif 203 204 #define stdin (&__sF[0]) 205 #define stdout (&__sF[1]) 206 #define stderr (&__sF[2]) 207 208 /* 209 * Functions defined in ANSI C standard. 210 */ 211 __BEGIN_DECLS 212 void clearerr __P((FILE *)); 213 int fclose __P((FILE *)); 214 int feof __P((FILE *)); 215 int ferror __P((FILE *)); 216 int fflush __P((FILE *)); 217 int fgetc __P((FILE *)); 218 int fgetpos __P((FILE *, fpos_t *)); 219 char *fgets __P((char *, size_t, FILE *)); 220 FILE *fopen __P((const char *, const char *)); 221 int fprintf __P((FILE *, const char *, ...)); 222 int fputc __P((int, FILE *)); 223 int fputs __P((const char *, FILE *)); 224 size_t fread __P((void *, size_t, size_t, FILE *)); 225 FILE *freopen __P((const char *, const char *, FILE *)); 226 int fscanf __P((FILE *, const char *, ...)); 227 int fseek __P((FILE *, long, int)); 228 int fsetpos __P((FILE *, const fpos_t *)); 229 long ftell __P((const FILE *)); 230 size_t fwrite __P((const void *, size_t, size_t, FILE *)); 231 int getc __P((FILE *)); 232 int getchar __P((void)); 233 char *gets __P((char *)); 234 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 235 extern int sys_nerr; /* perror(3) external variables */ 236 extern const char *const sys_errlist[]; 237 #endif 238 void perror __P((const char *)); 239 int printf __P((const char *, ...)); 240 int putc __P((int, FILE *)); 241 int putchar __P((int)); 242 int puts __P((const char *)); 243 int remove __P((const char *)); 244 int rename __P((const char *, const char *)); 245 void rewind __P((FILE *)); 246 int scanf __P((const char *, ...)); 247 void setbuf __P((FILE *, char *)); 248 int setvbuf __P((FILE *, char *, int, size_t)); 249 int sprintf __P((char *, const char *, ...)); 250 int sscanf __P((const char *, const char *, ...)); 251 FILE *tmpfile __P((void)); 252 char *tmpnam __P((char *)); 253 int ungetc __P((int, FILE *)); 254 int vfprintf __P((FILE *, const char *, _VA_LIST_)); 255 int vprintf __P((const char *, _VA_LIST_)); 256 int vsprintf __P((char *, const char *, _VA_LIST_)); 257 __END_DECLS 258 259 /* 260 * Functions defined in POSIX 1003.1. 261 */ 262 #ifndef _ANSI_SOURCE 263 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 264 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 265 266 __BEGIN_DECLS 267 char *ctermid __P((char *)); 268 char *cuserid __P((char *)); 269 FILE *fdopen __P((int, const char *)); 270 int fileno __P((FILE *)); 271 __END_DECLS 272 #endif /* not ANSI */ 273 274 /* 275 * Routines that are purely local. 276 */ 277 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 278 __BEGIN_DECLS 279 char *fgetln __P((FILE *, size_t *)); 280 int fpurge __P((FILE *)); 281 int getw __P((FILE *)); 282 int pclose __P((FILE *)); 283 FILE *popen __P((const char *, const char *)); 284 int putw __P((int, FILE *)); 285 void setbuffer __P((FILE *, char *, int)); 286 int setlinebuf __P((FILE *)); 287 char *tempnam __P((const char *, const char *)); 288 int snprintf __P((char *, size_t, const char *, ...)) 289 __attribute__((format (printf, 3, 4))); 290 int vsnprintf __P((char *, size_t, const char *, _VA_LIST_)) 291 __attribute__((format (printf, 3, 0))); 292 int vscanf __P((const char *, _VA_LIST_)) 293 __attribute__((format (scanf, 1, 0))); 294 int vsscanf __P((const char *, const char *, _VA_LIST_)) 295 __attribute__((format (scanf, 2, 0))); 296 __END_DECLS 297 298 /* 299 * This is a #define because the function is used internally and 300 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 301 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 302 */ 303 #define vfscanf __svfscanf 304 305 /* 306 * Stdio function-access interface. 307 */ 308 __BEGIN_DECLS 309 FILE *funopen __P((const void *, 310 int (*)(void *, char *, int), 311 int (*)(void *, const char *, int), 312 fpos_t (*)(void *, fpos_t, int), 313 int (*)(void *))); 314 __END_DECLS 315 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 316 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 317 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 318 319 /* 320 * Functions internal to the implementation. 321 */ 322 __BEGIN_DECLS 323 int __srget __P((FILE *)); 324 int __svfscanf __P((FILE *, const char *, _VA_LIST_)); 325 int __swbuf __P((int, FILE *)); 326 __END_DECLS 327 328 /* 329 * The __sfoo macros are here so that we can 330 * define function versions in the C library. 331 */ 332 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 333 #if defined(__GNUC__) && defined(__STDC__) 334 static __inline int __sputc(int _c, FILE *_p) { 335 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 336 return (*_p->_p++ = _c); 337 else 338 return (__swbuf(_c, _p)); 339 } 340 #else 341 /* 342 * This has been tuned to generate reasonable code on the vax using pcc. 343 */ 344 #define __sputc(c, p) \ 345 (--(p)->_w < 0 ? \ 346 (p)->_w >= (p)->_lbfsize ? \ 347 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 348 (int)*(p)->_p++ : \ 349 __swbuf('\n', p) : \ 350 __swbuf((int)(c), p) : \ 351 (*(p)->_p = (c), (int)*(p)->_p++)) 352 #endif 353 354 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 355 #define __sferror(p) (((p)->_flags & __SERR) != 0) 356 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 357 #define __sfileno(p) ((p)->_file) 358 359 #define feof(p) __sfeof(p) 360 #define ferror(p) __sferror(p) 361 #define clearerr(p) __sclearerr(p) 362 363 #ifndef _ANSI_SOURCE 364 #define fileno(p) __sfileno(p) 365 #endif 366 367 #ifndef lint 368 #define getc(fp) __sgetc(fp) 369 #define putc(x, fp) __sputc(x, fp) 370 #endif /* lint */ 371 372 #define getchar() getc(stdin) 373 #define putchar(x) putc(x, stdout) 374 #endif /* _STDIO_H_ */ 375
Indexes created Sun Sep 21 20:09:37 GMT 2025