stdio.h revision 1.32
1 /* $NetBSD: stdio.h,v 1.32 2000/01/10 16:58:38 kleink 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_ 53 typedef _BSD_SIZE_T_ size_t; 54 #undef _BSD_SIZE_T_ 55 #endif 56 57 #include <sys/null.h> 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 * NB: see WARNING above before changing the layout of this structure! 111 */ 112 typedef struct __sFILE { 113 unsigned char *_p; /* current position in (some) buffer */ 114 int _r; /* read space left for getc() */ 115 int _w; /* write space left for putc() */ 116 short _flags; /* flags, below; this FILE is free if 0 */ 117 short _file; /* fileno, if Unix descriptor, else -1 */ 118 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 119 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 120 121 /* operations */ 122 void *_cookie; /* cookie passed to io functions */ 123 int (*_close) __P((void *)); 124 int (*_read) __P((void *, char *, int)); 125 fpos_t (*_seek) __P((void *, fpos_t, int)); 126 int (*_write) __P((void *, const char *, int)); 127 128 /* separate buffer for long sequences of ungetc() */ 129 struct __sbuf _ub; /* ungetc buffer */ 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 146 extern 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() optimisation */ 161 #define __SNPT 0x0800 /* do not do fseek() optimisation */ 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 217 void clearerr __P((FILE *)); 218 int fclose __P((FILE *)); 219 int feof __P((FILE *)); 220 int ferror __P((FILE *)); 221 int fflush __P((FILE *)); 222 int fgetc __P((FILE *)); 223 int fgetpos __P((FILE *, fpos_t *)); 224 char *fgets __P((char *, int, FILE *)); 225 FILE *fopen __P((const char *, const char *)); 226 int fprintf __P((FILE *, const char *, ...)); 227 int fputc __P((int, FILE *)); 228 int fputs __P((const char *, FILE *)); 229 size_t fread __P((void *, size_t, size_t, FILE *)); 230 FILE *freopen __P((const char *, const char *, FILE *)); 231 int fscanf __P((FILE *, const char *, ...)); 232 int fseek __P((FILE *, long, int)); 233 int fsetpos __P((FILE *, const fpos_t *)); 234 long ftell __P((FILE *)); 235 size_t fwrite __P((const void *, size_t, size_t, FILE *)); 236 int getc __P((FILE *)); 237 int getchar __P((void)); 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 void rewind __P((FILE *)); 245 int scanf __P((const char *, ...)); 246 void setbuf __P((FILE *, char *)); 247 int setvbuf __P((FILE *, char *, int, size_t)); 248 int sscanf __P((const char *, const char *, ...)); 249 FILE *tmpfile __P((void)); 250 int ungetc __P((int, FILE *)); 251 int vfprintf __P((FILE *, const char *, _BSD_VA_LIST_)); 252 int vprintf __P((const char *, _BSD_VA_LIST_)); 253 254 #ifndef __AUDIT__ 255 char *gets __P((char *)); 256 int sprintf __P((char *, const char *, ...)); 257 char *tmpnam __P((char *)); 258 int vsprintf __P((char *, const char *, _BSD_VA_LIST_)); 259 #endif 260 261 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 262 int rename __P((const char *, const char *)) __RENAME(__posix_rename); 263 #else 264 int rename __P((const char *, const char *)); 265 #endif 266 __END_DECLS 267 268 /* 269 * IEEE Std 1003.1-90 270 */ 271 #ifndef _ANSI_SOURCE 272 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 273 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 274 275 __BEGIN_DECLS 276 char *ctermid __P((char *)); 277 char *cuserid __P((char *)); 278 FILE *fdopen __P((int, const char *)); 279 int fileno __P((FILE *)); 280 __END_DECLS 281 #endif /* not ANSI */ 282 283 /* 284 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 285 */ 286 #if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 287 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 199506L || \ 288 (_XOPEN_SOURCE - 0) >= 500 || defined(_REENTRANT) 289 __BEGIN_DECLS 290 #if 0 /* not yet */ 291 void flockfile __P((FILE *)); 292 int ftrylockfile __P((FILE *)); 293 void funlockfile __P((FILE *)); 294 #endif /* 0 */ 295 int getc_unlocked __P((FILE *)); 296 int getchar_unlocked __P((void)); 297 int putc_unlocked __P((int, FILE *)); 298 int putchar_unlocked __P((int)); 299 __END_DECLS 300 #endif /* (!_ANSI_SOURCE && !_POSIX_C_SOURCE && !_XOPEN_SOURCE) || ... */ 301 302 /* 303 * Functions defined in POSIX 1003.2 and XPG2 or later. 304 */ 305 #if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 306 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 2 || \ 307 (_XOPEN_SOURCE - 0) >= 2 308 __BEGIN_DECLS 309 int pclose __P((FILE *)); 310 FILE *popen __P((const char *, const char *)); 311 __END_DECLS 312 #endif 313 314 /* 315 * Functions defined in XPG4.2. 316 */ 317 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) || \ 318 defined(_XOPEN_SOURCE) 319 __BEGIN_DECLS 320 int getw __P((FILE *)); 321 int putw __P((int, FILE *)); 322 int snprintf __P((char *, size_t, const char *, ...)) 323 __attribute__((__format__(__printf__, 3, 4))); 324 int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)) 325 __attribute__((__format__(__printf__, 3, 0))); 326 327 #ifndef __AUDIT__ 328 char *tempnam __P((const char *, const char *)); 329 #endif 330 __END_DECLS 331 #endif 332 333 /* 334 * Routines that are purely local. 335 */ 336 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 337 !defined(_XOPEN_SOURCE) 338 __BEGIN_DECLS 339 int asprintf __P((char **, const char *, ...)) 340 __attribute__((__format__(__printf__, 2, 3))); 341 char *fgetln __P((FILE *, size_t *)); 342 int fpurge __P((FILE *)); 343 void setbuffer __P((FILE *, char *, int)); 344 int setlinebuf __P((FILE *)); 345 int vasprintf __P((char **, const char *, _BSD_VA_LIST_)) 346 __attribute__((__format__(__printf__, 2, 0))); 347 int vscanf __P((const char *, _BSD_VA_LIST_)) 348 __attribute__((__format__(__scanf__, 1, 0))); 349 int vsscanf __P((const char *, const char *, _BSD_VA_LIST_)) 350 __attribute__((__format__(__scanf__, 2, 0))); 351 __END_DECLS 352 353 /* 354 * This is a #define because the function is used internally and 355 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 356 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 357 */ 358 #define vfscanf __svfscanf 359 360 /* 361 * Stdio function-access interface. 362 */ 363 __BEGIN_DECLS 364 FILE *funopen __P((const void *, 365 int (*)(void *, char *, int), 366 int (*)(void *, const char *, int), 367 fpos_t (*)(void *, fpos_t, int), 368 int (*)(void *))); 369 __END_DECLS 370 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 371 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 372 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 373 374 /* 375 * Functions internal to the implementation. 376 */ 377 __BEGIN_DECLS 378 int __srget __P((FILE *)); 379 int __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_)); 380 int __swbuf __P((int, FILE *)); 381 __END_DECLS 382 383 /* 384 * The __sfoo macros are here so that we can 385 * define function versions in the C library. 386 */ 387 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 388 #if defined(__GNUC__) && defined(__STDC__) 389 static __inline int __sputc(int _c, FILE *_p) { 390 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 391 return (*_p->_p++ = _c); 392 else 393 return (__swbuf(_c, _p)); 394 } 395 #else 396 /* 397 * This has been tuned to generate reasonable code on the vax using pcc. 398 */ 399 #define __sputc(c, p) \ 400 (--(p)->_w < 0 ? \ 401 (p)->_w >= (p)->_lbfsize ? \ 402 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 403 (int)*(p)->_p++ : \ 404 __swbuf('\n', p) : \ 405 __swbuf((int)(c), p) : \ 406 (*(p)->_p = (c), (int)*(p)->_p++)) 407 #endif 408 409 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 410 #define __sferror(p) (((p)->_flags & __SERR) != 0) 411 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 412 #define __sfileno(p) ((p)->_file) 413 414 #ifndef lint 415 #ifndef _REENTRANT 416 #define feof(p) __sfeof(p) 417 #define ferror(p) __sferror(p) 418 #define clearerr(p) __sclearerr(p) 419 420 #define getc(fp) __sgetc(fp) 421 #define putc(x, fp) __sputc(x, fp) 422 #endif /* !_REENTRANT */ 423 #endif /* lint */ 424 425 #define getchar() getc(stdin) 426 #define putchar(x) putc(x, stdout) 427 428 #ifndef _ANSI_SOURCE 429 #ifndef _REENTRANT 430 #define fileno(p) __sfileno(p) 431 #endif /* !_REENTRANT */ 432 #endif /* !_ANSI_SOURCE */ 433 434 #if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 435 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 199506L || \ 436 (_XOPEN_SOURCE - 0) >= 500 || defined(_REENTRANT) 437 #define getc_unlocked(fp) __sgetc(fp) 438 #define putc_unlocked(x, fp) __sputc(x, fp) 439 440 #define getchar_unlocked() getc_unlocked(stdin) 441 #define putchar_unlocked(x) putc_unlocked(x, stdout) 442 #endif /* (!_ANSI_SOURCE && !_POSIX_C_SOURCE && !_XOPEN_SOURCE) || ... */ 443 444 #endif /* _STDIO_H_ */ 445
Indexes created Thu Oct 02 10:09:58 GMT 2025