1 /* $NetBSD: stdio.h,v 1.46 2002/11/30 03:04:44 lukem 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 #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 * __restrict, fpos_t * __restrict)); 224 char *fgets __P((char * __restrict, int, FILE * __restrict)); 225 FILE *fopen __P((const char *, const char *)); 226 int fprintf __P((FILE * __restrict , const char * __restrict, ...)); 227 int fputc __P((int, FILE *)); 228 int fputs __P((const char * __restrict, FILE * __restrict)); 229 size_t fread __P((void * __restrict, size_t, size_t, FILE * __restrict)); 230 FILE *freopen __P((const char *, const char *, FILE * __restrict)); 231 int fscanf __P((FILE * __restrict, const char * __restrict, ...)); 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 * __restrict, size_t, size_t, 236 FILE * __restrict)); 237 int getc __P((FILE *)); 238 int getchar __P((void)); 239 void perror __P((const char *)); 240 int printf __P((const char * __restrict, ...)); 241 int putc __P((int, FILE *)); 242 int putchar __P((int)); 243 int puts __P((const char *)); 244 int remove __P((const char *)); 245 void rewind __P((FILE *)); 246 int scanf __P((const char * __restrict, ...)); 247 void setbuf __P((FILE * __restrict, char * __restrict)); 248 int setvbuf __P((FILE * __restrict, char * __restrict, int, size_t)); 249 int sscanf __P((const char * __restrict, const char * __restrict, ...)); 250 FILE *tmpfile __P((void)); 251 int ungetc __P((int, FILE *)); 252 int vfprintf __P((FILE * __restrict, const char * __restrict, 253 _BSD_VA_LIST_)); 254 int vprintf __P((const char * __restrict, _BSD_VA_LIST_)); 255 256 #ifndef __AUDIT__ 257 char *gets __P((char *)); 258 int sprintf __P((char * __restrict, const char * __restrict, ...)); 259 char *tmpnam __P((char *)); 260 int vsprintf __P((char * __resitrct, const char * __restrict, 261 _BSD_VA_LIST_)); 262 #endif 263 264 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 265 int rename __P((const char *, const char *)) __RENAME(__posix_rename); 266 #else 267 int rename __P((const char *, const char *)); 268 #endif 269 __END_DECLS 270 271 /* 272 * IEEE Std 1003.1-90 273 */ 274 #ifndef _ANSI_SOURCE 275 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 276 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 277 278 __BEGIN_DECLS 279 char *ctermid __P((char *)); 280 #ifndef __CUSERID_DECLARED 281 #define __CUSERID_DECLARED 282 /* also declared in unistd.h */ 283 char *cuserid __P((char *)); 284 #endif /* __CUSERID_DECLARED */ 285 FILE *fdopen __P((int, const char *)); 286 int fileno __P((FILE *)); 287 __END_DECLS 288 #endif /* not ANSI */ 289 290 /* 291 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 292 */ 293 #if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 294 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 199506L || \ 295 (_XOPEN_SOURCE - 0) >= 500 || defined(_REENTRANT) 296 __BEGIN_DECLS 297 #if 0 /* not yet */ 298 void flockfile __P((FILE *)); 299 int ftrylockfile __P((FILE *)); 300 void funlockfile __P((FILE *)); 301 #endif /* 0 */ 302 int getc_unlocked __P((FILE *)); 303 int getchar_unlocked __P((void)); 304 int putc_unlocked __P((int, FILE *)); 305 int putchar_unlocked __P((int)); 306 __END_DECLS 307 #endif /* (!_ANSI_SOURCE && !_POSIX_C_SOURCE && !_XOPEN_SOURCE) || ... */ 308 309 /* 310 * Functions defined in POSIX 1003.2 and XPG2 or later. 311 */ 312 #if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 313 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 2 || \ 314 (_XOPEN_SOURCE - 0) >= 2 315 __BEGIN_DECLS 316 int pclose __P((FILE *)); 317 FILE *popen __P((const char *, const char *)); 318 __END_DECLS 319 #endif 320 321 /* 322 * Functions defined in XPG4.2. 323 */ 324 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) || \ 325 defined(_XOPEN_SOURCE) 326 __BEGIN_DECLS 327 int getw __P((FILE *)); 328 int putw __P((int, FILE *)); 329 int snprintf __P((char * __restrict, size_t, const char * __restrict, ...)) 330 __attribute__((__format__(__printf__, 3, 4))); 331 int vsnprintf __P((char * __restrict, size_t, const char * __restrict, 332 _BSD_VA_LIST_)) 333 __attribute__((__format__(__printf__, 3, 0))); 334 335 #ifndef __AUDIT__ 336 char *tempnam __P((const char *, const char *)); 337 #endif 338 __END_DECLS 339 #endif 340 341 /* 342 * X/Open CAE Specification Issue 5 Version 2 343 */ 344 #if (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)) || \ 345 (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) 346 #ifndef off_t 347 typedef __off_t off_t; 348 #define off_t __off_t 349 #endif /* off_t */ 350 351 __BEGIN_DECLS 352 int fseeko __P((FILE *, off_t, int)); 353 off_t ftello __P((FILE *)); 354 __END_DECLS 355 #endif /* (!_POSIX_SOURCE && !_XOPEN_SOURCE) || ... */ 356 357 /* 358 * Routines that are purely local. 359 */ 360 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 361 !defined(_XOPEN_SOURCE) 362 363 #define FPARSELN_UNESCESC 0x01 364 #define FPARSELN_UNESCCONT 0x02 365 #define FPARSELN_UNESCCOMM 0x04 366 #define FPARSELN_UNESCREST 0x08 367 #define FPARSELN_UNESCALL 0x0f 368 369 __BEGIN_DECLS 370 int asprintf __P((char ** __restrict, const char * __restrict, ...)) 371 __attribute__((__format__(__printf__, 2, 3))); 372 char *fgetln __P((FILE * __restrict, size_t * __restrict)); 373 char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 374 int fpurge __P((FILE *)); 375 void setbuffer __P((FILE *, char *, int)); 376 int setlinebuf __P((FILE *)); 377 int vasprintf __P((char ** __restrict, const char * __restrict, 378 _BSD_VA_LIST_)) 379 __attribute__((__format__(__printf__, 2, 0))); 380 int vscanf __P((const char * __restrict, _BSD_VA_LIST_)) 381 __attribute__((__format__(__scanf__, 1, 0))); 382 int vfscanf __P((FILE * __restrict, const char * __restrict, 383 _BSD_VA_LIST_)) 384 __attribute__((__format__(__scanf__, 2, 0))); 385 int vsscanf __P((const char * __restrict, const char * __restrict, 386 _BSD_VA_LIST_)) 387 __attribute__((__format__(__scanf__, 2, 0))); 388 __const char *fmtcheck __P((const char *, const char *)) 389 __attribute__((__format_arg__(2))); 390 __END_DECLS 391 392 /* 393 * Stdio function-access interface. 394 */ 395 __BEGIN_DECLS 396 FILE *funopen __P((const void *, 397 int (*)(void *, char *, int), 398 int (*)(void *, const char *, int), 399 fpos_t (*)(void *, fpos_t, int), 400 int (*)(void *))); 401 __END_DECLS 402 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 403 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 404 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 405 406 /* 407 * Functions internal to the implementation. 408 */ 409 __BEGIN_DECLS 410 int __srget __P((FILE *)); 411 int __swbuf __P((int, FILE *)); 412 __END_DECLS 413 414 /* 415 * The __sfoo macros are here so that we can 416 * define function versions in the C library. 417 */ 418 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 419 #if defined(__GNUC__) && defined(__STDC__) 420 static __inline int __sputc(int _c, FILE *_p) { 421 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 422 return (*_p->_p++ = _c); 423 else 424 return (__swbuf(_c, _p)); 425 } 426 #else 427 /* 428 * This has been tuned to generate reasonable code on the vax using pcc. 429 */ 430 #define __sputc(c, p) \ 431 (--(p)->_w < 0 ? \ 432 (p)->_w >= (p)->_lbfsize ? \ 433 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 434 (int)*(p)->_p++ : \ 435 __swbuf('\n', p) : \ 436 __swbuf((int)(c), p) : \ 437 (*(p)->_p = (c), (int)*(p)->_p++)) 438 #endif 439 440 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 441 #define __sferror(p) (((p)->_flags & __SERR) != 0) 442 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 443 #define __sfileno(p) ((p)->_file) 444 445 #ifndef lint 446 #ifndef _REENTRANT 447 #define feof(p) __sfeof(p) 448 #define ferror(p) __sferror(p) 449 #define clearerr(p) __sclearerr(p) 450 451 #define getc(fp) __sgetc(fp) 452 #define putc(x, fp) __sputc(x, fp) 453 #endif /* !_REENTRANT */ 454 #endif /* lint */ 455 456 #define getchar() getc(stdin) 457 #define putchar(x) putc(x, stdout) 458 459 #ifndef _ANSI_SOURCE 460 #ifndef _REENTRANT 461 #define fileno(p) __sfileno(p) 462 #endif /* !_REENTRANT */ 463 #endif /* !_ANSI_SOURCE */ 464 465 #if (!defined(_ANSI_SOURCE) && !defined(_POSIX_C_SOURCE) && \ 466 !defined(_XOPEN_SOURCE)) || (_POSIX_C_SOURCE - 0) >= 199506L || \ 467 (_XOPEN_SOURCE - 0) >= 500 || defined(_REENTRANT) 468 #define getc_unlocked(fp) __sgetc(fp) 469 #define putc_unlocked(x, fp) __sputc(x, fp) 470 471 #define getchar_unlocked() getc_unlocked(stdin) 472 #define putchar_unlocked(x) putc_unlocked(x, stdout) 473 #endif /* (!_ANSI_SOURCE && !_POSIX_C_SOURCE && !_XOPEN_SOURCE) || ... */ 474 475 #endif /* _STDIO_H_ */ 476