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