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. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)stdio.h 8.5 (Berkeley) 4/29/95 33 * $FreeBSD: src/include/stdio.h,v 1.78 2009/03/25 08:07:52 das Exp $ 34 */ 35 36 #ifndef _STDIO_H_ 37 #define _STDIO_H_ 38 39 #include <sys/cdefs.h> 40 #include <sys/_null.h> 41 #include <sys/types.h> 42 #include <machine/stdarg.h> /* for __va_list */ 43 44 typedef __off_t fpos_t; 45 46 #ifndef _SIZE_T_DECLARED 47 typedef __size_t size_t; 48 #define _SIZE_T_DECLARED 49 #endif 50 51 #if __POSIX_VISIBLE >= 200809 52 #ifndef _OFF_T_DECLARED 53 #define _OFF_T_DECLARED 54 typedef __off_t off_t; 55 #endif 56 #ifndef _SSIZE_T_DECLARED 57 #define _SSIZE_T_DECLARED 58 typedef __ssize_t ssize_t; 59 #endif 60 #endif 61 62 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE 63 #ifdef __GNUC__ 64 #ifndef _VA_LIST_DECLARED 65 #define _VA_LIST_DECLARED 66 typedef __va_list va_list; 67 /* __gnuc_va_list is not needed, provided by <machine/stdarg.h> */ 68 #endif 69 #else 70 #include <stdarg.h> 71 #endif 72 #endif 73 74 #define _FSTDIO /* Define for new stdio with functions. */ 75 76 /* 77 * stdio state variables. 78 * 79 * The following always hold: 80 * 81 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 82 * _lbfsize is -_bf._size, else _lbfsize is 0 83 * if _flags&__SRD, _w is 0 84 * if _flags&__SWR, _r is 0 85 * 86 * This ensures that the getc and putc macros (or inline functions) never 87 * try to write or read from a file that is in `read' or `write' mode. 88 * (Moreover, they can, and do, automatically switch from read mode to 89 * write mode, and back, on "r+" and "w+" files.) 90 * 91 * _lbfsize is used only to make the inline line-buffered output stream 92 * code as compact as possible. 93 * 94 * WARNING: Do not change the order of the fields in __FILE_public! 95 */ 96 #ifndef _STDFILE_DECLARED 97 #define _STDFILE_DECLARED 98 typedef struct __FILE FILE; 99 #endif 100 101 struct __FILE_public { 102 unsigned char *_p; /* current position in (some) buffer */ 103 int _flags; /* flags, below; this FILE is free if 0 */ 104 int _fileno; /* fileno, if Unix descriptor, else -1 */ 105 __ssize_t _r; /* read space left for getc() */ 106 __ssize_t _w; /* write space left for putc() */ 107 __ssize_t _lbfsize; /* 0 or -_bf._size, for inline putc */ 108 }; 109 110 #ifndef _STDSTREAM_DECLARED 111 __BEGIN_DECLS 112 extern FILE *__stdinp; 113 extern FILE *__stdoutp; 114 extern FILE *__stderrp; 115 __END_DECLS 116 #define _STDSTREAM_DECLARED 117 #endif 118 119 #define __SLBF 0x0001 /* line buffered */ 120 #define __SNBF 0x0002 /* unbuffered */ 121 #define __SRD 0x0004 /* OK to read */ 122 #define __SWR 0x0008 /* OK to write */ 123 /* RD and WR are never simultaneously asserted */ 124 #define __SRW 0x0010 /* open for reading & writing */ 125 #define __SEOF 0x0020 /* found EOF */ 126 #define __SERR 0x0040 /* found error */ 127 #define __SMBF 0x0080 /* _buf is from malloc */ 128 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 129 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 130 #define __SOPT 0x0400 /* do fseek() optimization */ 131 #define __SNPT 0x0800 /* do not do fseek() optimization */ 132 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 133 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 134 #define __SALC 0x4000 /* allocate string space dynamically */ 135 #define __SIGN 0x8000 /* ignore this file in _fwalk */ 136 137 /* 138 * The following three definitions are for ANSI C, which took them 139 * from System V, which brilliantly took internal interface macros and 140 * made them official arguments to setvbuf(), without renaming them. 141 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 142 * 143 * Although numbered as their counterparts above, the implementation 144 * does not rely on this. 145 */ 146 #define _IOFBF 0 /* setvbuf should set fully buffered */ 147 #define _IOLBF 1 /* setvbuf should set line buffered */ 148 #define _IONBF 2 /* setvbuf should set unbuffered */ 149 150 #define BUFSIZ 1024 /* size of buffer used by setbuf */ 151 #define EOF (-1) 152 153 /* 154 * FOPEN_MAX is a minimum maximum, and is the number of streams that 155 * stdio can provide without attempting to allocate further resources 156 * (which could fail). Do not use this for anything. 157 */ 158 /* must be == _POSIX_STREAM_MAX <limits.h> */ 159 #ifndef FOPEN_MAX 160 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 161 #endif 162 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 163 164 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 165 #if __XSI_VISIBLE 166 #define P_tmpdir "/tmp/" 167 #endif 168 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 169 #define TMP_MAX 308915776 170 171 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 172 #ifndef SEEK_SET 173 #define SEEK_SET 0 /* set file offset to offset */ 174 #endif 175 #ifndef SEEK_CUR 176 #define SEEK_CUR 1 /* set file offset to current plus offset */ 177 #endif 178 #ifndef SEEK_END 179 #define SEEK_END 2 /* set file offset to EOF plus offset */ 180 #endif 181 182 #define stdin __stdinp 183 #define stdout __stdoutp 184 #define stderr __stderrp 185 186 __BEGIN_DECLS 187 /* 188 * Functions defined in ANSI C standard. 189 */ 190 void clearerr(FILE *); 191 int fclose(FILE *); 192 int feof(FILE *); 193 int ferror(FILE *); 194 int fflush(FILE *); 195 int fgetc(FILE *); 196 int fgetpos(FILE * __restrict, fpos_t * __restrict); 197 char *fgets(char * __restrict, int, FILE * __restrict); 198 FILE *fopen(const char * __restrict, const char * __restrict); 199 int fprintf(FILE * __restrict, const char * __restrict, ...); 200 int fputc(int, FILE *); 201 int fputs(const char * __restrict, FILE * __restrict); 202 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 203 FILE *freopen(const char * __restrict, const char * __restrict, 204 FILE * __restrict); 205 int fscanf(FILE * __restrict, const char * __restrict, ...); 206 int fseek(FILE *, long, int); 207 int fsetpos(FILE *, const fpos_t *); 208 long ftell(FILE *); 209 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 210 int getc(FILE *); 211 int getchar(void); 212 char *gets(char *); 213 void perror(const char *); 214 int printf(const char * __restrict, ...); 215 int putc(int, FILE *); 216 int putchar(int); 217 int puts(const char *); 218 int remove(const char *); 219 int rename(const char *, const char *); 220 void rewind(FILE *); 221 int scanf(const char * __restrict, ...); 222 void setbuf(FILE * __restrict, char * __restrict); 223 int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 224 int sprintf(char * __restrict, const char * __restrict, ...); 225 int sscanf(const char * __restrict, const char * __restrict, ...); 226 FILE *tmpfile(void); 227 char *tmpnam(char *); 228 int ungetc(int, FILE *); 229 int vfprintf(FILE * __restrict, const char * __restrict, __va_list); 230 int vprintf(const char * __restrict, __va_list); 231 int vsprintf(char * __restrict, const char * __restrict, __va_list); 232 233 #if __ISO_C_VISIBLE >= 1999 || __XSI_VISIBLE >= 500 234 int snprintf(char * __restrict, size_t, const char * __restrict, ...) 235 __printflike(3, 4); 236 int vsnprintf(char * __restrict, size_t, const char * __restrict, 237 __va_list) __printflike(3, 0); 238 #endif 239 #if __ISO_C_VISIBLE >= 1999 240 int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 241 __scanflike(2, 0); 242 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0); 243 int vsscanf(const char * __restrict, const char * __restrict, __va_list) 244 __scanflike(2, 0); 245 #endif 246 247 /* 248 * Functions defined in all versions of POSIX 1003.1. 249 */ 250 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 251 #define L_cuserid 17 /* size for cuserid(3); MAXLOGNAME, legacy */ 252 #endif 253 254 #if __POSIX_VISIBLE 255 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 256 257 char *ctermid(char *); 258 FILE *fdopen(int, const char *); 259 int fileno(FILE *); 260 #endif /* __POSIX_VISIBLE */ 261 262 #if __POSIX_VISIBLE >= 199209 263 int pclose(FILE *); 264 FILE *popen(const char *, const char *); 265 #endif 266 267 #if __POSIX_VISIBLE >= 199506 268 int ftrylockfile(FILE *); 269 void flockfile(FILE *); 270 void funlockfile(FILE *); 271 272 /* 273 * These are normally used through macros as defined below, but POSIX 274 * requires functions as well. 275 */ 276 int getc_unlocked(FILE *); 277 int getchar_unlocked(void); 278 int putc_unlocked(int, FILE *); 279 int putchar_unlocked(int); 280 #endif 281 #if __BSD_VISIBLE 282 void clearerr_unlocked(FILE *); 283 int feof_unlocked(FILE *); 284 int ferror_unlocked(FILE *); 285 int fileno_unlocked(FILE *); 286 #endif 287 288 #if __XSI_VISIBLE >= 500 || __POSIX_VISIBLE >= 200112 289 int fseeko(FILE *, __off_t, int); 290 __off_t ftello(FILE *); 291 #endif 292 293 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 294 int getw(FILE *); 295 int putw(int, FILE *); 296 #endif /* BSD or X/Open before issue 6 */ 297 298 #if __XSI_VISIBLE 299 char *tempnam(const char *, const char *); 300 #endif 301 302 #if __POSIX_VISIBLE >= 200809 303 FILE *fmemopen(void *__restrict, size_t, const char *__restrict); 304 ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 305 FILE * __restrict); 306 FILE *open_memstream(char **, size_t *); 307 int renameat(int, const char *, int, const char *); 308 int vdprintf(int, const char * __restrict, __va_list) __printflike(2, 0); 309 int dprintf(int, const char * __restrict, ...) __printflike(2, 3); 310 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict); 311 #endif /* __POSIX_VISIBLE >= 200809 */ 312 313 /* 314 * Routines that are purely local. 315 */ 316 #if __BSD_VISIBLE 317 int asprintf(char **, const char *, ...) __printflike(2, 3); 318 char *ctermid_r(char *); 319 void fcloseall(void); 320 void *fcookie(FILE *); 321 char *fgetln(FILE *, size_t *); 322 const char *fmtcheck(const char *, const char *) __format_arg(2); 323 __ssize_t __fpending(const FILE *); 324 int fpurge(FILE *); 325 void setbuffer(FILE *, char *, int); 326 int setlinebuf(FILE *); 327 int vasprintf(char **, const char *, __va_list) __printflike(2, 0); 328 329 /* 330 * The system error table contains messages for the first sys_nerr 331 * positive errno values. Use strerror() or strerror_r() from <string.h> 332 * instead. 333 */ 334 extern const int sys_nerr; 335 extern const char *const sys_errlist[]; 336 337 /* 338 * Stdio function-access interface. 339 */ 340 FILE *funopen(const void *, int (*)(void *, char *, int), 341 int (*)(void *, const char *, int), 342 fpos_t (*)(void *, fpos_t, int), int (*)(void *)); 343 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 344 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 345 346 /* 347 * Portability hacks. See <sys/types.h>. 348 */ 349 #ifndef _FTRUNCATE_DECLARED 350 #define _FTRUNCATE_DECLARED 351 int ftruncate(int, __off_t); 352 #endif 353 #ifndef _LSEEK_DECLARED 354 #define _LSEEK_DECLARED 355 __off_t lseek(int, __off_t, int); 356 #endif 357 #ifndef _MMAP_DECLARED 358 #define _MMAP_DECLARED 359 void *mmap(void *, size_t, int, int, int, __off_t); 360 #endif 361 #ifndef _TRUNCATE_DECLARED 362 #define _TRUNCATE_DECLARED 363 int truncate(const char *, __off_t); 364 #endif 365 #endif /* __BSD_VISIBLE */ 366 367 /* 368 * Functions internal to the implementation. 369 */ 370 int __srget(FILE *); 371 int __swbuf(int, FILE *); 372 373 /* 374 * The __sfoo functions are here so that we can 375 * define real function versions in the C library. 376 */ 377 static __inline __always_inline int 378 __sgetc(FILE *_fp) 379 { 380 struct __FILE_public *_p = (struct __FILE_public *)_fp; 381 382 if (--_p->_r < 0) 383 return (__srget(_fp)); 384 else 385 return (*_p->_p++); 386 } 387 388 static __inline __always_inline int 389 __sputc(int _c, FILE *_fp) 390 { 391 struct __FILE_public *_p = (struct __FILE_public *)_fp; 392 393 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && _c != '\n')) 394 return (*_p->_p++ = _c); 395 else 396 return (__swbuf(_c, _fp)); 397 } 398 399 static __inline __always_inline int 400 __sfeof(FILE *_fp) 401 { 402 struct __FILE_public *_p = (struct __FILE_public *)_fp; 403 404 return ((_p->_flags & __SEOF) != 0); 405 } 406 407 static __inline __always_inline int 408 __sferror(FILE *_fp) 409 { 410 struct __FILE_public *_p = (struct __FILE_public *)_fp; 411 412 return ((_p->_flags & __SERR) != 0); 413 } 414 415 static __inline __always_inline void 416 __sclearerr(FILE *_fp) 417 { 418 struct __FILE_public *_p = (struct __FILE_public *)_fp; 419 420 _p->_flags &= ~(__SERR|__SEOF); 421 } 422 423 static __inline __always_inline int 424 __sfileno(FILE *_fp) 425 { 426 struct __FILE_public *_p = (struct __FILE_public *)_fp; 427 428 return (_p->_fileno); 429 } 430 431 extern int __isthreaded; 432 433 #ifndef __cplusplus 434 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 435 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 436 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 437 438 #if __POSIX_VISIBLE 439 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 440 #endif 441 442 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 443 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 444 445 #define getchar() getc(stdin) 446 #define putchar(x) putc(x, stdout) 447 448 #if __BSD_VISIBLE 449 /* 450 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 451 * B.8.2.7 for the rationale behind the *_unlocked() macros. 452 */ 453 #define feof_unlocked(p) __sfeof(p) 454 #define ferror_unlocked(p) __sferror(p) 455 #define clearerr_unlocked(p) __sclearerr(p) 456 #define fileno_unlocked(p) __sfileno(p) 457 #endif 458 #if __POSIX_VISIBLE >= 199506 459 #define getc_unlocked(fp) __sgetc(fp) 460 #define putc_unlocked(x, fp) __sputc(x, fp) 461 462 #define getchar_unlocked() getc_unlocked(stdin) 463 #define putchar_unlocked(x) putc_unlocked(x, stdout) 464 #endif 465 #endif /* __cplusplus */ 466 467 __END_DECLS 468 #endif /* !_STDIO_H_ */ 469