stdio.h revision 1.60
1 /* $NetBSD: stdio.h,v 1.60 2005/05/25 19:35:07 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. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)stdio.h 8.5 (Berkeley) 4/29/95 35 */ 36 37 #ifndef _STDIO_H_ 38 #define _STDIO_H_ 39 40 #include <sys/ansi.h> 41 42 #include <sys/cdefs.h> 43 #include <sys/featuretest.h> 44 45 #include <machine/ansi.h> 46 #ifdef _BSD_SIZE_T_ 47 typedef _BSD_SIZE_T_ size_t; 48 #undef _BSD_SIZE_T_ 49 #endif 50 51 #include <sys/null.h> 52 53 /* 54 * This is fairly grotesque, but pure ANSI code must not inspect the 55 * innards of an fpos_t anyway. The library internally uses off_t, 56 * which we assume is exactly as big as eight chars. 57 */ 58 #if (!defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)) || defined(_LIBC) 59 typedef __off_t fpos_t; 60 #else 61 typedef struct __sfpos { 62 __off_t _pos; 63 } fpos_t; 64 #endif 65 66 #define _FSTDIO /* Define for new stdio with functions. */ 67 68 /* 69 * NB: to fit things in six character monocase externals, the stdio 70 * code uses the prefix `__s' for stdio objects, typically followed 71 * by a three-character attempt at a mnemonic. 72 */ 73 74 /* stdio buffers */ 75 struct __sbuf { 76 unsigned char *_base; 77 int _size; 78 }; 79 80 /* 81 * stdio state variables. 82 * 83 * The following always hold: 84 * 85 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 86 * _lbfsize is -_bf._size, else _lbfsize is 0 87 * if _flags&__SRD, _w is 0 88 * if _flags&__SWR, _r is 0 89 * 90 * This ensures that the getc and putc macros (or inline functions) never 91 * try to write or read from a file that is in `read' or `write' mode. 92 * (Moreover, they can, and do, automatically switch from read mode to 93 * write mode, and back, on "r+" and "w+" files.) 94 * 95 * _lbfsize is used only to make the inline line-buffered output stream 96 * code as compact as possible. 97 * 98 * _ub, _up, and _ur are used when ungetc() pushes back more characters 99 * than fit in the current _bf, or when ungetc() pushes back a character 100 * that does not match the previous one in _bf. When this happens, 101 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 102 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 103 * 104 * NB: see WARNING above before changing the layout of this structure! 105 */ 106 typedef struct __sFILE { 107 unsigned char *_p; /* current position in (some) buffer */ 108 int _r; /* read space left for getc() */ 109 int _w; /* write space left for putc() */ 110 short _flags; /* flags, below; this FILE is free if 0 */ 111 short _file; /* fileno, if Unix descriptor, else -1 */ 112 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 113 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 114 115 /* operations */ 116 void *_cookie; /* cookie passed to io functions */ 117 int (*_close)(void *); 118 int (*_read) (void *, char *, int); 119 fpos_t (*_seek) (void *, fpos_t, int); 120 int (*_write)(void *, const char *, int); 121 122 /* file extension */ 123 struct __sbuf _ext; 124 125 /* separate buffer for long sequences of ungetc() */ 126 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 127 int _ur; /* saved _r when _r is counting ungetc data */ 128 129 /* tricks to meet minimum requirements even when malloc() fails */ 130 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 131 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 132 133 /* separate buffer for fgetln() when line crosses buffer boundary */ 134 struct __sbuf _lb; /* buffer for fgetln() */ 135 136 /* Unix stdio files get aligned to block boundaries on fseek() */ 137 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 138 fpos_t _offset; /* current lseek offset */ 139 } FILE; 140 141 __BEGIN_DECLS 142 extern FILE __sF[]; 143 __END_DECLS 144 145 #define __SLBF 0x0001 /* line buffered */ 146 #define __SNBF 0x0002 /* unbuffered */ 147 #define __SRD 0x0004 /* OK to read */ 148 #define __SWR 0x0008 /* OK to write */ 149 /* RD and WR are never simultaneously asserted */ 150 #define __SRW 0x0010 /* open for reading & writing */ 151 #define __SEOF 0x0020 /* found EOF */ 152 #define __SERR 0x0040 /* found error */ 153 #define __SMBF 0x0080 /* _buf is from malloc */ 154 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 155 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 156 #define __SOPT 0x0400 /* do fseek() optimization */ 157 #define __SNPT 0x0800 /* do not do fseek() optimization */ 158 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 159 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 160 #define __SALC 0x4000 /* allocate string space dynamically */ 161 162 /* 163 * The following three definitions are for ANSI C, which took them 164 * from System V, which brilliantly took internal interface macros and 165 * made them official arguments to setvbuf(), without renaming them. 166 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 167 * 168 * Although numbered as their counterparts above, the implementation 169 * does not rely on this. 170 */ 171 #define _IOFBF 0 /* setvbuf should set fully buffered */ 172 #define _IOLBF 1 /* setvbuf should set line buffered */ 173 #define _IONBF 2 /* setvbuf should set unbuffered */ 174 175 #define BUFSIZ 1024 /* size of buffer used by setbuf */ 176 #define EOF (-1) 177 178 /* 179 * FOPEN_MAX is a minimum maximum, and is the number of streams that 180 * stdio can provide without attempting to allocate further resources 181 * (which could fail). Do not use this for anything. 182 */ 183 /* must be == _POSIX_STREAM_MAX <limits.h> */ 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 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 189 #define P_tmpdir "/var/tmp/" 190 #endif 191 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 192 /* Always ensure that this is consistent with <limits.h> */ 193 #ifndef TMP_MAX 194 #define TMP_MAX 308915776 /* Legacy */ 195 #endif 196 197 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 198 #ifndef SEEK_SET 199 #define SEEK_SET 0 /* set file offset to offset */ 200 #endif 201 #ifndef SEEK_CUR 202 #define SEEK_CUR 1 /* set file offset to current plus offset */ 203 #endif 204 #ifndef SEEK_END 205 #define SEEK_END 2 /* set file offset to EOF plus offset */ 206 #endif 207 208 #define stdin (&__sF[0]) 209 #define stdout (&__sF[1]) 210 #define stderr (&__sF[2]) 211 212 /* 213 * Functions defined in ANSI C standard. 214 */ 215 __BEGIN_DECLS 216 void clearerr(FILE *); 217 int fclose(FILE *); 218 int feof(FILE *); 219 int ferror(FILE *); 220 int fflush(FILE *); 221 int fgetc(FILE *); 222 int fgetpos(FILE * __restrict, fpos_t * __restrict); 223 char *fgets(char * __restrict, int, FILE * __restrict); 224 FILE *fopen(const char * __restrict , const char * __restrict); 225 int fprintf(FILE * __restrict , const char * __restrict, ...); 226 int fputc(int, FILE *); 227 int fputs(const char * __restrict, FILE * __restrict); 228 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 229 FILE *freopen(const char * __restrict, const char * __restrict, 230 FILE * __restrict); 231 int fscanf(FILE * __restrict, const char * __restrict, ...); 232 int fseek(FILE *, long, int); 233 int fsetpos(FILE *, const fpos_t *); 234 long ftell(FILE *); 235 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 236 int getc(FILE *); 237 int getchar(void); 238 void perror(const char *); 239 int printf(const char * __restrict, ...); 240 int putc(int, FILE *); 241 int putchar(int); 242 int puts(const char *); 243 int remove(const char *); 244 void rewind(FILE *); 245 int scanf(const char * __restrict, ...); 246 void setbuf(FILE * __restrict, char * __restrict); 247 int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 248 int sscanf(const char * __restrict, const char * __restrict, ...); 249 FILE *tmpfile(void); 250 int ungetc(int, FILE *); 251 int vfprintf(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_); 252 int vprintf(const char * __restrict, _BSD_VA_LIST_); 253 254 #ifndef __AUDIT__ 255 char *gets(char *); 256 int sprintf(char * __restrict, const char * __restrict, ...); 257 char *tmpnam(char *); 258 int vsprintf(char * __restrict, const char * __restrict, 259 _BSD_VA_LIST_); 260 #endif 261 262 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 263 int rename (const char *, const char *) __RENAME(__posix_rename); 264 #else 265 int rename (const char *, const char *); 266 #endif 267 __END_DECLS 268 269 /* 270 * IEEE Std 1003.1-90 271 */ 272 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 273 defined(_NETBSD_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(char *); 279 #ifndef __CUSERID_DECLARED 280 #define __CUSERID_DECLARED 281 /* also declared in unistd.h */ 282 char *cuserid(char *); 283 #endif /* __CUSERID_DECLARED */ 284 FILE *fdopen(int, const char *); 285 int fileno(FILE *); 286 __END_DECLS 287 #endif /* not ANSI */ 288 289 /* 290 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 291 */ 292 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 293 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 294 __BEGIN_DECLS 295 void flockfile(FILE *); 296 int ftrylockfile(FILE *); 297 void funlockfile(FILE *); 298 int getc_unlocked(FILE *); 299 int getchar_unlocked(void); 300 int putc_unlocked(int, FILE *); 301 int putchar_unlocked(int); 302 __END_DECLS 303 #endif /* _POSIX_C_SOURCE >= 1995056 || _XOPEN_SOURCE >= 500 || ... */ 304 305 /* 306 * Functions defined in POSIX 1003.2 and XPG2 or later. 307 */ 308 #if (_POSIX_C_SOURCE - 0) >= 2 || (_XOPEN_SOURCE - 0) >= 2 || \ 309 defined(_NETBSD_SOURCE) 310 __BEGIN_DECLS 311 int pclose(FILE *); 312 FILE *popen(const char *, const char *); 313 __END_DECLS 314 #endif 315 316 /* 317 * Functions defined in ISO XPG4.2, ISO C99, POSIX 1003.1-2001 or later. 318 */ 319 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 320 !defined(_XOPEN_SOURCE) || \ 321 ((__STDC_VERSION__ - 0) >= 199901L) || \ 322 ((_POSIX_C_SOURCE - 0) >= 200112L) || \ 323 (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \ 324 ((_XOPEN_SOURCE - 0) >= 500) || \ 325 defined(_ISOC99_SOURCE) || defined(_NETBSD_SOURCE) 326 int snprintf(char * __restrict, size_t, const char * __restrict, ...) 327 __attribute__((__format__(__printf__, 3, 4))); 328 int vsnprintf(char * __restrict, size_t, const char * __restrict, 329 _BSD_VA_LIST_) 330 __attribute__((__format__(__printf__, 3, 0))); 331 #endif 332 333 /* 334 * Functions defined in XPG4.2. 335 */ 336 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 337 __BEGIN_DECLS 338 int getw(FILE *); 339 int putw(int, FILE *); 340 341 #ifndef __AUDIT__ 342 char *tempnam(const char *, const char *); 343 #endif 344 __END_DECLS 345 #endif 346 347 /* 348 * X/Open CAE Specification Issue 5 Version 2 349 */ 350 #if (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) || \ 351 defined(_NETBSD_SOURCE) 352 #ifndef off_t 353 typedef __off_t off_t; 354 #define off_t __off_t 355 #endif /* off_t */ 356 357 __BEGIN_DECLS 358 int fseeko(FILE *, off_t, int); 359 off_t ftello(FILE *); 360 __END_DECLS 361 #endif /* _XOPEN_SOURCE >= 500 || _LARGEFILE_SOURCE || _NETBSD_SOURCE */ 362 363 /* 364 * Routines that are purely local. 365 */ 366 #if defined(_NETBSD_SOURCE) 367 368 #define FPARSELN_UNESCESC 0x01 369 #define FPARSELN_UNESCCONT 0x02 370 #define FPARSELN_UNESCCOMM 0x04 371 #define FPARSELN_UNESCREST 0x08 372 #define FPARSELN_UNESCALL 0x0f 373 374 __BEGIN_DECLS 375 int asprintf(char ** __restrict, const char * __restrict, ...) 376 __attribute__((__format__(__printf__, 2, 3))); 377 char *fgetln(FILE * __restrict, size_t * __restrict); 378 char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 379 int fpurge(FILE *); 380 void setbuffer(FILE *, char *, int); 381 int setlinebuf(FILE *); 382 int vasprintf(char ** __restrict, const char * __restrict, 383 _BSD_VA_LIST_) 384 __attribute__((__format__(__printf__, 2, 0))); 385 int vscanf(const char * __restrict, _BSD_VA_LIST_) 386 __attribute__((__format__(__scanf__, 1, 0))); 387 int vfscanf(FILE * __restrict, const char * __restrict, 388 _BSD_VA_LIST_) 389 __attribute__((__format__(__scanf__, 2, 0))); 390 int vsscanf(const char * __restrict, const char * __restrict, 391 _BSD_VA_LIST_) 392 __attribute__((__format__(__scanf__, 2, 0))); 393 __const char *fmtcheck(const char *, const char *) 394 __attribute__((__format_arg__(2))); 395 __END_DECLS 396 397 /* 398 * Stdio function-access interface. 399 */ 400 __BEGIN_DECLS 401 FILE *funopen(const void *, 402 int (*)(void *, char *, int), 403 int (*)(void *, const char *, int), 404 fpos_t (*)(void *, fpos_t, int), 405 int (*)(void *)); 406 __END_DECLS 407 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 408 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 409 #endif /* _NETBSD_SOURCE */ 410 411 /* 412 * Functions internal to the implementation. 413 */ 414 __BEGIN_DECLS 415 int __srget(FILE *); 416 int __swbuf(int, FILE *); 417 __END_DECLS 418 419 /* 420 * The __sfoo macros are here so that we can 421 * define function versions in the C library. 422 */ 423 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 424 #if defined(__GNUC__) && defined(__STDC__) 425 static __inline int __sputc(int _c, FILE *_p) { 426 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 427 return (*_p->_p++ = _c); 428 else 429 return (__swbuf(_c, _p)); 430 } 431 #else 432 /* 433 * This has been tuned to generate reasonable code on the vax using pcc. 434 */ 435 #define __sputc(c, p) \ 436 (--(p)->_w < 0 ? \ 437 (p)->_w >= (p)->_lbfsize ? \ 438 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 439 (int)*(p)->_p++ : \ 440 __swbuf('\n', p) : \ 441 __swbuf((int)(c), p) : \ 442 (*(p)->_p = (c), (int)*(p)->_p++)) 443 #endif 444 445 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 446 #define __sferror(p) (((p)->_flags & __SERR) != 0) 447 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 448 #define __sfileno(p) ((p)->_file) 449 450 #ifndef __lint__ 451 #if !defined(_REENTRANT) && !defined(_PTHREADS) 452 #define feof(p) __sfeof(p) 453 #define ferror(p) __sferror(p) 454 #define clearerr(p) __sclearerr(p) 455 456 #define getc(fp) __sgetc(fp) 457 #define putc(x, fp) __sputc(x, fp) 458 #endif /* !_REENTRANT && !_PTHREADS */ 459 #endif /* __lint__ */ 460 461 #define getchar() getc(stdin) 462 #define putchar(x) putc(x, stdout) 463 464 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 465 defined(_NETBSD_SOURCE) 466 #if !defined(_REENTRANT) && !defined(_PTHREADS) 467 #define fileno(p) __sfileno(p) 468 #endif /* !_REENTRANT && !_PTHREADS */ 469 #endif /* !_ANSI_SOURCE */ 470 471 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 472 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 473 #define getc_unlocked(fp) __sgetc(fp) 474 #define putc_unlocked(x, fp) __sputc(x, fp) 475 476 #define getchar_unlocked() getc_unlocked(stdin) 477 #define putchar_unlocked(x) putc_unlocked(x, stdout) 478 #endif /* _POSIX_C_SOURCE >= 199506 || _XOPEN_SOURCE >= 500 || _REENTRANT... */ 479 480 #endif /* _STDIO_H_ */ 481
Indexes created Thu Oct 02 10:09:58 GMT 2025