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