stdio.h revision 1.51
1 /* $NetBSD: stdio.h,v 1.51 2003/04/28 23:16:14 bjh21 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 #include <sys/ansi.h> 45 46 #include <sys/cdefs.h> 47 #include <sys/featuretest.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 #include <sys/null.h> 56 57 /* 58 * This is fairly grotesque, but pure ANSI code must not inspect the 59 * innards of an fpos_t anyway. The library internally uses off_t, 60 * which we assume is exactly as big as eight chars. 61 */ 62 #if (!defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)) || defined(_LIBC) 63 typedef __off_t fpos_t; 64 #else 65 typedef struct __sfpos { 66 __off_t _pos; 67 } fpos_t; 68 #endif 69 70 #define _FSTDIO /* Define for new stdio with functions. */ 71 72 /* 73 * NB: to fit things in six character monocase externals, the stdio 74 * code uses the prefix `__s' for stdio objects, typically followed 75 * by a three-character attempt at a mnemonic. 76 */ 77 78 /* stdio buffers */ 79 struct __sbuf { 80 unsigned char *_base; 81 int _size; 82 }; 83 84 /* 85 * stdio state variables. 86 * 87 * The following always hold: 88 * 89 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 90 * _lbfsize is -_bf._size, else _lbfsize is 0 91 * if _flags&__SRD, _w is 0 92 * if _flags&__SWR, _r is 0 93 * 94 * This ensures that the getc and putc macros (or inline functions) never 95 * try to write or read from a file that is in `read' or `write' mode. 96 * (Moreover, they can, and do, automatically switch from read mode to 97 * write mode, and back, on "r+" and "w+" files.) 98 * 99 * _lbfsize is used only to make the inline line-buffered output stream 100 * code as compact as possible. 101 * 102 * _ub, _up, and _ur are used when ungetc() pushes back more characters 103 * than fit in the current _bf, or when ungetc() pushes back a character 104 * that does not match the previous one in _bf. When this happens, 105 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 106 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 107 * 108 * NB: see WARNING above before changing the layout of this structure! 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 /* file extension */ 127 struct __sbuf _ext; 128 129 /* separate buffer for long sequences of ungetc() */ 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() optimization */ 161 #define __SNPT 0x0800 /* do not do fseek() optimization */ 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 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 193 defined(_NETBSD_SOURCE) 194 #define P_tmpdir "/var/tmp/" 195 #endif 196 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 197 /* Always ensure that this is consistent with <limits.h> */ 198 #ifndef TMP_MAX 199 #define TMP_MAX 308915776 /* Legacy */ 200 #endif 201 202 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 203 #ifndef SEEK_SET 204 #define SEEK_SET 0 /* set file offset to offset */ 205 #endif 206 #ifndef SEEK_CUR 207 #define SEEK_CUR 1 /* set file offset to current plus offset */ 208 #endif 209 #ifndef SEEK_END 210 #define SEEK_END 2 /* set file offset to EOF plus offset */ 211 #endif 212 213 #define stdin (&__sF[0]) 214 #define stdout (&__sF[1]) 215 #define stderr (&__sF[2]) 216 217 /* 218 * Functions defined in ANSI C standard. 219 */ 220 __BEGIN_DECLS 221 void clearerr __P((FILE *)); 222 int fclose __P((FILE *)); 223 int feof __P((FILE *)); 224 int ferror __P((FILE *)); 225 int fflush __P((FILE *)); 226 int fgetc __P((FILE *)); 227 int fgetpos __P((FILE * __restrict, fpos_t * __restrict)); 228 char *fgets __P((char * __restrict, int, FILE * __restrict)); 229 FILE *fopen __P((const char *, const char *)); 230 int fprintf __P((FILE * __restrict , const char * __restrict, ...)); 231 int fputc __P((int, FILE *)); 232 int fputs __P((const char * __restrict, FILE * __restrict)); 233 size_t fread __P((void * __restrict, size_t, size_t, FILE * __restrict)); 234 FILE *freopen __P((const char *, const char *, FILE * __restrict)); 235 int fscanf __P((FILE * __restrict, const char * __restrict, ...)); 236 int fseek __P((FILE *, long, int)); 237 int fsetpos __P((FILE *, const fpos_t *)); 238 long ftell __P((FILE *)); 239 size_t fwrite __P((const void * __restrict, size_t, size_t, 240 FILE * __restrict)); 241 int getc __P((FILE *)); 242 int getchar __P((void)); 243 void perror __P((const char *)); 244 int printf __P((const char * __restrict, ...)); 245 int putc __P((int, FILE *)); 246 int putchar __P((int)); 247 int puts __P((const char *)); 248 int remove __P((const char *)); 249 void rewind __P((FILE *)); 250 int scanf __P((const char * __restrict, ...)); 251 void setbuf __P((FILE * __restrict, char * __restrict)); 252 int setvbuf __P((FILE * __restrict, char * __restrict, int, size_t)); 253 int sscanf __P((const char * __restrict, const char * __restrict, ...)); 254 FILE *tmpfile __P((void)); 255 int ungetc __P((int, FILE *)); 256 int vfprintf __P((FILE * __restrict, const char * __restrict, 257 _BSD_VA_LIST_)); 258 int vfprintf_unlocked __P((FILE * __restrict, const char * __restrict, 259 _BSD_VA_LIST_)); 260 int vprintf __P((const char * __restrict, _BSD_VA_LIST_)); 261 262 #ifndef __AUDIT__ 263 char *gets __P((char *)); 264 int sprintf __P((char * __restrict, const char * __restrict, ...)); 265 char *tmpnam __P((char *)); 266 int vsprintf __P((char * __restrict, const char * __restrict, 267 _BSD_VA_LIST_)); 268 #endif 269 270 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 271 int rename __P((const char *, const char *)) __RENAME(__posix_rename); 272 #else 273 int rename __P((const char *, const char *)); 274 #endif 275 __END_DECLS 276 277 /* 278 * IEEE Std 1003.1-90 279 */ 280 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 281 defined(_NETBSD_SOURCE) 282 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 283 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 284 285 __BEGIN_DECLS 286 char *ctermid __P((char *)); 287 #ifndef __CUSERID_DECLARED 288 #define __CUSERID_DECLARED 289 /* also declared in unistd.h */ 290 char *cuserid __P((char *)); 291 #endif /* __CUSERID_DECLARED */ 292 FILE *fdopen __P((int, const char *)); 293 int fileno __P((FILE *)); 294 __END_DECLS 295 #endif /* not ANSI */ 296 297 /* 298 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 299 */ 300 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 301 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 302 __BEGIN_DECLS 303 void flockfile __P((FILE *)); 304 int ftrylockfile __P((FILE *)); 305 void funlockfile __P((FILE *)); 306 int getc_unlocked __P((FILE *)); 307 int getchar_unlocked __P((void)); 308 int putc_unlocked __P((int, FILE *)); 309 int putchar_unlocked __P((int)); 310 __END_DECLS 311 #endif /* _POSIX_C_SOURCE >= 1995056 || _XOPEN_SOURCE >= 500 || ... */ 312 313 /* 314 * Functions defined in POSIX 1003.2 and XPG2 or later. 315 */ 316 #if (_POSIX_C_SOURCE - 0) >= 2 || (_XOPEN_SOURCE - 0) >= 2 || \ 317 defined(_NETBSD_SOURCE) 318 __BEGIN_DECLS 319 int pclose __P((FILE *)); 320 FILE *popen __P((const char *, const char *)); 321 __END_DECLS 322 #endif 323 324 /* 325 * Functions defined in XPG4.2. 326 */ 327 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 328 __BEGIN_DECLS 329 int getw __P((FILE *)); 330 int putw __P((int, FILE *)); 331 int snprintf __P((char * __restrict, size_t, const char * __restrict, ...)) 332 __attribute__((__format__(__printf__, 3, 4))); 333 int vsnprintf __P((char * __restrict, size_t, const char * __restrict, 334 _BSD_VA_LIST_)) 335 __attribute__((__format__(__printf__, 3, 0))); 336 337 #ifndef __AUDIT__ 338 char *tempnam __P((const char *, const char *)); 339 #endif 340 __END_DECLS 341 #endif 342 343 /* 344 * X/Open CAE Specification Issue 5 Version 2 345 */ 346 #if (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) || \ 347 defined(_NETBSD_SOURCE) 348 #ifndef off_t 349 typedef __off_t off_t; 350 #define off_t __off_t 351 #endif /* off_t */ 352 353 __BEGIN_DECLS 354 int fseeko __P((FILE *, off_t, int)); 355 off_t ftello __P((FILE *)); 356 __END_DECLS 357 #endif /* _XOPEN_SOURCE >= 500 || _LARGEFILE_SOURCE || _NETBSD_SOURCE */ 358 359 /* 360 * Routines that are purely local. 361 */ 362 #if defined(_NETBSD_SOURCE) 363 364 #define FPARSELN_UNESCESC 0x01 365 #define FPARSELN_UNESCCONT 0x02 366 #define FPARSELN_UNESCCOMM 0x04 367 #define FPARSELN_UNESCREST 0x08 368 #define FPARSELN_UNESCALL 0x0f 369 370 __BEGIN_DECLS 371 int asprintf __P((char ** __restrict, const char * __restrict, ...)) 372 __attribute__((__format__(__printf__, 2, 3))); 373 char *fgetln __P((FILE * __restrict, size_t * __restrict)); 374 char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 375 int fpurge __P((FILE *)); 376 void setbuffer __P((FILE *, char *, int)); 377 int setlinebuf __P((FILE *)); 378 int vasprintf __P((char ** __restrict, const char * __restrict, 379 _BSD_VA_LIST_)) 380 __attribute__((__format__(__printf__, 2, 0))); 381 int vscanf __P((const char * __restrict, _BSD_VA_LIST_)) 382 __attribute__((__format__(__scanf__, 1, 0))); 383 int vfscanf __P((FILE * __restrict, const char * __restrict, 384 _BSD_VA_LIST_)) 385 __attribute__((__format__(__scanf__, 2, 0))); 386 int vsscanf __P((const char * __restrict, const char * __restrict, 387 _BSD_VA_LIST_)) 388 __attribute__((__format__(__scanf__, 2, 0))); 389 __const char *fmtcheck __P((const char *, const char *)) 390 __attribute__((__format_arg__(2))); 391 __END_DECLS 392 393 /* 394 * Stdio function-access interface. 395 */ 396 __BEGIN_DECLS 397 FILE *funopen __P((const void *, 398 int (*)(void *, char *, int), 399 int (*)(void *, const char *, int), 400 fpos_t (*)(void *, fpos_t, int), 401 int (*)(void *))); 402 __END_DECLS 403 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 404 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 405 #endif /* _NETBSD_SOURCE */ 406 407 /* 408 * Functions internal to the implementation. 409 */ 410 __BEGIN_DECLS 411 int __srget __P((FILE *)); 412 int __swbuf __P((int, FILE *)); 413 __END_DECLS 414 415 /* 416 * The __sfoo macros are here so that we can 417 * define function versions in the C library. 418 */ 419 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 420 #if defined(__GNUC__) && defined(__STDC__) 421 static __inline int __sputc(int _c, FILE *_p) { 422 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 423 return (*_p->_p++ = _c); 424 else 425 return (__swbuf(_c, _p)); 426 } 427 #else 428 /* 429 * This has been tuned to generate reasonable code on the vax using pcc. 430 */ 431 #define __sputc(c, p) \ 432 (--(p)->_w < 0 ? \ 433 (p)->_w >= (p)->_lbfsize ? \ 434 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 435 (int)*(p)->_p++ : \ 436 __swbuf('\n', p) : \ 437 __swbuf((int)(c), p) : \ 438 (*(p)->_p = (c), (int)*(p)->_p++)) 439 #endif 440 441 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 442 #define __sferror(p) (((p)->_flags & __SERR) != 0) 443 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 444 #define __sfileno(p) ((p)->_file) 445 446 #ifndef lint 447 #if !defined(_REENTRANT) && !defined(_PTHREADS) 448 #define feof(p) __sfeof(p) 449 #define ferror(p) __sferror(p) 450 #define clearerr(p) __sclearerr(p) 451 452 #define getc(fp) __sgetc(fp) 453 #define putc(x, fp) __sputc(x, fp) 454 #endif /* !_REENTRANT && !_PTHREADS */ 455 #endif /* lint */ 456 457 #define getchar() getc(stdin) 458 #define putchar(x) putc(x, stdout) 459 460 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 461 defined(_NETBSD_SOURCE) 462 #if !defined(_REENTRANT) && !defined(_PTHREADS) 463 #define fileno(p) __sfileno(p) 464 #endif /* !_REENTRANT && !_PTHREADS */ 465 #endif /* !_ANSI_SOURCE */ 466 467 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 468 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 469 #define getc_unlocked(fp) __sgetc(fp) 470 #define putc_unlocked(x, fp) __sputc(x, fp) 471 472 #define getchar_unlocked() getc_unlocked(stdin) 473 #define putchar_unlocked(x) putc_unlocked(x, stdout) 474 #endif /* _POSIX_C_SOURCE >= 199506 || _XOPEN_SOURCE >= 500 || _REENTRANT... */ 475 476 #endif /* _STDIO_H_ */ 477
Indexes created Sun Sep 21 18:09:52 GMT 2025