1 /*- 2 * Copyright (c) 1990, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Chris Torek. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)stdio.h 8.5 (Berkeley) 4/29/95 37 * $FreeBSD$ 38 */ 39 40 #ifndef _STDIO_H_ 41 #define _STDIO_H_ 42 43 #include <sys/cdefs.h> 44 #include <sys/_null.h> 45 #include <sys/_types.h> 46 47 typedef __off_t fpos_t; 48 49 #ifndef _SIZE_T_DECLARED 50 typedef __size_t size_t; 51 #define _SIZE_T_DECLARED 52 #endif 53 54 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE 55 #ifndef _VA_LIST_DECLARED 56 typedef __va_list va_list; 57 #define _VA_LIST_DECLARED 58 #endif 59 #endif 60 61 #define _FSTDIO /* Define for new stdio with functions. */ 62 63 /* 64 * NB: to fit things in six character monocase externals, the stdio 65 * code uses the prefix `__s' for stdio objects, typically followed 66 * by a three-character attempt at a mnemonic. 67 */ 68 69 /* stdio buffers */ 70 struct __sbuf { 71 unsigned char *_base; 72 int _size; 73 }; 74 75 /* hold a buncha junk that would grow the ABI */ 76 struct __sFILEX; 77 78 /* 79 * stdio state variables. 80 * 81 * The following always hold: 82 * 83 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 84 * _lbfsize is -_bf._size, else _lbfsize is 0 85 * if _flags&__SRD, _w is 0 86 * if _flags&__SWR, _r is 0 87 * 88 * This ensures that the getc and putc macros (or inline functions) never 89 * try to write or read from a file that is in `read' or `write' mode. 90 * (Moreover, they can, and do, automatically switch from read mode to 91 * write mode, and back, on "r+" and "w+" files.) 92 * 93 * _lbfsize is used only to make the inline line-buffered output stream 94 * code as compact as possible. 95 * 96 * _ub, _up, and _ur are used when ungetc() pushes back more characters 97 * than fit in the current _bf, or when ungetc() pushes back a character 98 * that does not match the previous one in _bf. When this happens, 99 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 100 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 101 */ 102 typedef struct __sFILE { 103 unsigned char *_p; /* current position in (some) buffer */ 104 int _r; /* read space left for getc() */ 105 int _w; /* write space left for putc() */ 106 short _flags; /* flags, below; this FILE is free if 0 */ 107 short _file; /* fileno, if Unix descriptor, else -1 */ 108 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 109 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 110 111 /* operations */ 112 void *_cookie; /* cookie passed to io functions */ 113 int (*_close)(void *); 114 int (*_read)(void *, char *, int); 115 fpos_t (*_seek)(void *, fpos_t, int); 116 int (*_write)(void *, const char *, int); 117 118 /* separate buffer for long sequences of ungetc() */ 119 struct __sbuf _ub; /* ungetc buffer */ 120 struct __sFILEX *_extra; /* additions to FILE to not break ABI */ 121 int _ur; /* saved _r when _r is counting ungetc data */ 122 123 /* tricks to meet minimum requirements even when malloc() fails */ 124 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 125 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 126 127 /* separate buffer for fgetln() when line crosses buffer boundary */ 128 struct __sbuf _lb; /* buffer for fgetln() */ 129 130 /* Unix stdio files get aligned to block boundaries on fseek() */ 131 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 132 fpos_t _offset; /* current lseek offset */ 133 } FILE; 134 135 #ifndef _STDSTREAM_DECLARED 136 __BEGIN_DECLS 137 extern FILE *__stdinp; 138 extern FILE *__stdoutp; 139 extern FILE *__stderrp; 140 __END_DECLS 141 #define _STDSTREAM_DECLARED 142 #endif 143 144 #define __SLBF 0x0001 /* line buffered */ 145 #define __SNBF 0x0002 /* unbuffered */ 146 #define __SRD 0x0004 /* OK to read */ 147 #define __SWR 0x0008 /* OK to write */ 148 /* RD and WR are never simultaneously asserted */ 149 #define __SRW 0x0010 /* open for reading & writing */ 150 #define __SEOF 0x0020 /* found EOF */ 151 #define __SERR 0x0040 /* found error */ 152 #define __SMBF 0x0080 /* _buf is from malloc */ 153 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 154 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 155 #define __SOPT 0x0400 /* do fseek() optimization */ 156 #define __SNPT 0x0800 /* do not do fseek() optimization */ 157 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 158 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 159 #define __SALC 0x4000 /* allocate string space dynamically */ 160 #define __SIGN 0x8000 /* ignore this file in _fwalk */ 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 __XSI_VISIBLE 189 #define P_tmpdir "/var/tmp/" 190 #endif 191 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 192 #define TMP_MAX 308915776 193 194 #ifndef SEEK_SET 195 #define SEEK_SET 0 /* set file offset to offset */ 196 #endif 197 #ifndef SEEK_CUR 198 #define SEEK_CUR 1 /* set file offset to current plus offset */ 199 #endif 200 #ifndef SEEK_END 201 #define SEEK_END 2 /* set file offset to EOF plus offset */ 202 #endif 203 204 #define stdin __stdinp 205 #define stdout __stdoutp 206 #define stderr __stderrp 207 208 __BEGIN_DECLS 209 /* 210 * Functions defined in ANSI C standard. 211 */ 212 void clearerr(FILE *); 213 int fclose(FILE *); 214 int feof(FILE *); 215 int ferror(FILE *); 216 int fflush(FILE *); 217 int fgetc(FILE *); 218 int fgetpos(FILE * __restrict, fpos_t * __restrict); 219 char *fgets(char * __restrict, int, FILE * __restrict); 220 FILE *fopen(const char * __restrict, const char * __restrict); 221 int fprintf(FILE * __restrict, const char * __restrict, ...); 222 int fputc(int, FILE *); 223 int fputs(const char * __restrict, FILE * __restrict); 224 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 225 FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict); 226 int fscanf(FILE * __restrict, const char * __restrict, ...); 227 int fseek(FILE *, long, int); 228 int fsetpos(FILE *, const fpos_t *); 229 long ftell(FILE *); 230 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 231 int getc(FILE *); 232 int getchar(void); 233 char *gets(char *); 234 void perror(const char *); 235 int printf(const char * __restrict, ...); 236 int putc(int, FILE *); 237 int putchar(int); 238 int puts(const char *); 239 int remove(const char *); 240 int rename(const char *, const char *); 241 void rewind(FILE *); 242 int scanf(const char * __restrict, ...); 243 void setbuf(FILE * __restrict, char * __restrict); 244 int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 245 int sprintf(char * __restrict, const char * __restrict, ...); 246 int sscanf(const char * __restrict, const char * __restrict, ...); 247 FILE *tmpfile(void); 248 char *tmpnam(char *); 249 int ungetc(int, FILE *); 250 int vfprintf(FILE * __restrict, const char * __restrict, 251 __va_list); 252 int vprintf(const char * __restrict, __va_list); 253 int vsprintf(char * __restrict, const char * __restrict, 254 __va_list); 255 256 #if __ISO_C_VISIBLE >= 1999 257 int snprintf(char * __restrict, size_t, const char * __restrict, 258 ...) __printflike(3, 4); 259 int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 260 __scanflike(2, 0); 261 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0); 262 int vsnprintf(char * __restrict, size_t, const char * __restrict, 263 __va_list) __printflike(3, 0); 264 int vsscanf(const char * __restrict, const char * __restrict, __va_list) 265 __scanflike(2, 0); 266 #endif 267 268 /* 269 * Functions defined in all versions of POSIX 1003.1. 270 */ 271 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 272 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 273 #define L_cuserid 17 /* legacy */ 274 #endif 275 276 #if __POSIX_VISIBLE 277 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 278 279 char *ctermid(char *); 280 FILE *fdopen(int, const char *); 281 int fileno(FILE *); 282 #endif /* __POSIX_VISIBLE */ 283 284 #if __POSIX_VISIBLE >= 199209 285 int pclose(FILE *); 286 FILE *popen(const char *, const char *); 287 #endif 288 289 #if __POSIX_VISIBLE >= 199506 290 int ftrylockfile(FILE *); 291 void flockfile(FILE *); 292 void funlockfile(FILE *); 293 294 /* 295 * These are normally used through macros as defined below, but POSIX 296 * requires functions as well. 297 */ 298 int getc_unlocked(FILE *); 299 int getchar_unlocked(void); 300 int putc_unlocked(int, FILE *); 301 int putchar_unlocked(int); 302 #endif 303 #if __BSD_VISIBLE 304 void clearerr_unlocked(FILE *); 305 int feof_unlocked(FILE *); 306 int ferror_unlocked(FILE *); 307 int fileno_unlocked(FILE *); 308 #endif 309 310 #if __POSIX_VISIBLE >= 200112 311 int fseeko(FILE *, __off_t, int); 312 __off_t ftello(FILE *); 313 #endif 314 315 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 316 int getw(FILE *); 317 int putw(int, FILE *); 318 #endif /* BSD or X/Open before issue 6 */ 319 320 #if __XSI_VISIBLE 321 char *tempnam(const char *, const char *); 322 #endif 323 324 /* 325 * Routines that are purely local. 326 */ 327 #if __BSD_VISIBLE 328 int asprintf(char **, const char *, ...) __printflike(2, 3); 329 char *ctermid_r(char *); 330 void fcloseall(void); 331 char *fgetln(FILE *, size_t *); 332 __const char *fmtcheck(const char *, const char *) __format_arg(2); 333 int fpurge(FILE *); 334 void setbuffer(FILE *, char *, int); 335 int setlinebuf(FILE *); 336 int vasprintf(char **, const char *, __va_list) 337 __printflike(2, 0); 338 339 /* 340 * The system error table contains messages for the first sys_nerr 341 * positive errno values. Use strerror() or strerror_r() from <string.h> 342 * instead. 343 */ 344 extern __const int sys_nerr; 345 extern __const char *__const sys_errlist[]; 346 347 /* 348 * Stdio function-access interface. 349 */ 350 FILE *funopen(const void *, 351 int (*)(void *, char *, int), 352 int (*)(void *, const char *, int), 353 fpos_t (*)(void *, fpos_t, int), 354 int (*)(void *)); 355 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 356 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 357 358 /* 359 * Portability hacks. See <sys/types.h>. 360 */ 361 #ifndef _FTRUNCATE_DECLARED 362 #define _FTRUNCATE_DECLARED 363 int ftruncate(int, __off_t); 364 #endif 365 #ifndef _LSEEK_DECLARED 366 #define _LSEEK_DECLARED 367 __off_t lseek(int, __off_t, int); 368 #endif 369 #ifndef _MMAP_DECLARED 370 #define _MMAP_DECLARED 371 void *mmap(void *, size_t, int, int, int, __off_t); 372 #endif 373 #ifndef _TRUNCATE_DECLARED 374 #define _TRUNCATE_DECLARED 375 int truncate(const char *, __off_t); 376 #endif 377 #endif /* __BSD_VISIBLE */ 378 379 /* 380 * Functions internal to the implementation. 381 */ 382 int __srget(FILE *); 383 int __swbuf(int, FILE *); 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 extern int __isthreaded; 417 418 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 419 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 420 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 421 422 #if __POSIX_VISIBLE 423 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 424 #endif 425 426 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 427 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 428 429 #define getchar() getc(stdin) 430 #define putchar(x) putc(x, stdout) 431 432 #if __BSD_VISIBLE 433 /* 434 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 435 * B.8.2.7 for the rationale behind the *_unlocked() macros. 436 */ 437 #define feof_unlocked(p) __sfeof(p) 438 #define ferror_unlocked(p) __sferror(p) 439 #define clearerr_unlocked(p) __sclearerr(p) 440 #define fileno_unlocked(p) __sfileno(p) 441 #endif 442 #if __POSIX_VISIBLE >= 199506 443 #define getc_unlocked(fp) __sgetc(fp) 444 #define putc_unlocked(x, fp) __sputc(x, fp) 445 446 #define getchar_unlocked() getc_unlocked(stdin) 447 #define putchar_unlocked(x) putc_unlocked(x, stdout) 448 #endif 449 450 __END_DECLS 451 #endif /* !_STDIO_H_ */ 452