1 /* $OpenBSD: stdio.h,v 1.46 2014/03/16 18:38:30 guenther Exp $ */ 2 /* $NetBSD: stdio.h,v 1.18 1996/04/25 18:29:21 jtc Exp $ */ 3 4 /*- 5 * Copyright (c) 1990 The Regents of the University of California. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * Chris Torek. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * @(#)stdio.h 5.17 (Berkeley) 6/3/91 36 */ 37 38 #ifndef _STDIO_H_ 39 #define _STDIO_H_ 40 41 #include <sys/cdefs.h> 42 #include <sys/_types.h> 43 44 #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE 45 #include <sys/types.h> /* XXX should be removed */ 46 #endif 47 48 #ifndef _SIZE_T_DEFINED_ 49 #define _SIZE_T_DEFINED_ 50 typedef __size_t size_t; 51 #endif 52 53 #ifndef _OFF_T_DEFINED_ 54 #define _OFF_T_DEFINED_ 55 typedef __off_t off_t; 56 #endif 57 58 #ifndef NULL 59 #ifdef __GNUG__ 60 #define NULL __null 61 #elif defined(__cplusplus) 62 #define NULL 0L 63 #else 64 #define NULL ((void *)0) 65 #endif 66 #endif 67 68 #define _FSTDIO /* Define for new stdio with functions. */ 69 70 typedef off_t fpos_t; /* stdio file position type */ 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 typedef struct __sFILE { 109 unsigned char *_p; /* current position in (some) buffer */ 110 int _r; /* read space left for getc() */ 111 int _w; /* write space left for putc() */ 112 short _flags; /* flags, below; this FILE is free if 0 */ 113 short _file; /* fileno, if Unix descriptor, else -1 */ 114 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 115 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 116 117 /* operations */ 118 void *_cookie; /* cookie passed to io functions */ 119 int (*_close)(void *); 120 int (*_read)(void *, char *, int); 121 fpos_t (*_seek)(void *, fpos_t, int); 122 int (*_write)(void *, const char *, int); 123 124 /* extension data, to avoid further ABI breakage */ 125 struct __sbuf _ext; 126 /* data for long sequences of ungetc() */ 127 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 128 int _ur; /* saved _r when _r is counting ungetc data */ 129 130 /* tricks to meet minimum requirements even when malloc() fails */ 131 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 132 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 133 134 /* separate buffer for fgetln() when line crosses buffer boundary */ 135 struct __sbuf _lb; /* buffer for fgetln() */ 136 137 /* Unix stdio files get aligned to block boundaries on fseek() */ 138 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 139 fpos_t _offset; /* current lseek offset */ 140 } FILE; 141 142 __BEGIN_DECLS 143 extern FILE __sF[]; 144 __END_DECLS 145 146 #define __SLBF 0x0001 /* line buffered */ 147 #define __SNBF 0x0002 /* unbuffered */ 148 #define __SRD 0x0004 /* OK to read */ 149 #define __SWR 0x0008 /* OK to write */ 150 /* RD and WR are never simultaneously asserted */ 151 #define __SRW 0x0010 /* open for reading & writing */ 152 #define __SEOF 0x0020 /* found EOF */ 153 #define __SERR 0x0040 /* found error */ 154 #define __SMBF 0x0080 /* _buf is from malloc */ 155 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 156 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 157 #define __SOPT 0x0400 /* do fseek() optimisation */ 158 #define __SNPT 0x0800 /* do not do fseek() optimisation */ 159 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 160 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 161 #define __SALC 0x4000 /* allocate string space dynamically */ 162 #define __SIGN 0x8000 /* ignore this file in _fwalk */ 163 164 /* 165 * The following three definitions are for ANSI C, which took them 166 * from System V, which brilliantly took internal interface macros and 167 * made them official arguments to setvbuf(), without renaming them. 168 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 169 * 170 * Although numbered as their counterparts above, the implementation 171 * does not rely on this. 172 */ 173 #define _IOFBF 0 /* setvbuf should set fully buffered */ 174 #define _IOLBF 1 /* setvbuf should set line buffered */ 175 #define _IONBF 2 /* setvbuf should set unbuffered */ 176 177 #define BUFSIZ 1024 /* size of buffer used by setbuf */ 178 179 #define EOF (-1) 180 181 /* 182 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors 183 * that the kernel can provide without allocation of a resource that can 184 * fail without the process sleeping. Do not use this for anything. 185 */ 186 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 187 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 188 189 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 190 #if __BSD_VISIBLE || __XPG_VISIBLE 191 #define P_tmpdir "/tmp/" 192 #endif 193 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 194 #define TMP_MAX 308915776 195 196 #ifndef SEEK_SET 197 #define SEEK_SET 0 /* set file offset to offset */ 198 #endif 199 #ifndef SEEK_CUR 200 #define SEEK_CUR 1 /* set file offset to current plus offset */ 201 #endif 202 #ifndef SEEK_END 203 #define SEEK_END 2 /* set file offset to EOF plus offset */ 204 #endif 205 206 #define stdin (&__sF[0]) 207 #define stdout (&__sF[1]) 208 #define stderr (&__sF[2]) 209 210 /* 211 * Functions defined in ANSI C standard. 212 */ 213 __BEGIN_DECLS 214 void clearerr(FILE *); 215 #if __POSIX_VISIBLE >= 200809 216 int dprintf(int, const char * __restrict, ...); 217 #endif 218 int fclose(FILE *); 219 int feof(FILE *); 220 int ferror(FILE *); 221 int fflush(FILE *); 222 int fgetc(FILE *); 223 int fgetpos(FILE *, fpos_t *); 224 char *fgets(char *, int, FILE *) 225 __attribute__((__bounded__ (__string__,1,2))); 226 FILE *fopen(const char *, const char *); 227 int fprintf(FILE *, const char *, ...); 228 int fputc(int, FILE *); 229 int fputs(const char *, FILE *); 230 size_t fread(void *, size_t, size_t, FILE *) 231 __attribute__((__bounded__ (__size__,1,3,2))); 232 FILE *freopen(const char *, const char *, FILE *); 233 int fscanf(FILE *, const char *, ...); 234 int fseek(FILE *, long, int); 235 int fseeko(FILE *, off_t, int); 236 int fsetpos(FILE *, const fpos_t *); 237 long ftell(FILE *); 238 off_t ftello(FILE *); 239 size_t fwrite(const void *, size_t, size_t, FILE *) 240 __attribute__((__bounded__ (__size__,1,3,2))); 241 int getc(FILE *); 242 int getchar(void); 243 #if __POSIX_VISIBLE >= 200809 244 ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 245 FILE * __restrict); 246 ssize_t getline(char ** __restrict, size_t * __restrict, 247 FILE * __restrict); 248 #endif 249 char *gets(char *); 250 #if __BSD_VISIBLE && !defined(__SYS_ERRLIST) 251 #define __SYS_ERRLIST 252 253 extern int sys_nerr; /* perror(3) external variables */ 254 extern char *sys_errlist[]; 255 #endif 256 void perror(const char *); 257 int printf(const char *, ...); 258 int putc(int, FILE *); 259 int putchar(int); 260 int puts(const char *); 261 int remove(const char *); 262 int rename(const char *, const char *); 263 #if __POSIX_VISIBLE >= 200809 264 int renameat(int, const char *, int, const char *); 265 #endif 266 void rewind(FILE *); 267 int scanf(const char *, ...); 268 void setbuf(FILE *, char *); 269 int setvbuf(FILE *, char *, int, size_t); 270 int sprintf(char *, const char *, ...); 271 int sscanf(const char *, const char *, ...); 272 FILE *tmpfile(void); 273 char *tmpnam(char *); 274 int ungetc(int, FILE *); 275 int vfprintf(FILE *, const char *, __va_list); 276 int vprintf(const char *, __va_list); 277 int vsprintf(char *, const char *, __va_list); 278 #if __POSIX_VISIBLE >= 200809 279 int vdprintf(int, const char * __restrict, __va_list); 280 #endif 281 282 #if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE 283 int snprintf(char *, size_t, const char *, ...) 284 __attribute__((__format__ (printf, 3, 4))) 285 __attribute__((__nonnull__ (3))) 286 __attribute__((__bounded__ (__string__,1,2))); 287 int vfscanf(FILE *, const char *, __va_list) 288 __attribute__((__format__ (scanf, 2, 0))) 289 __attribute__((__nonnull__ (2))); 290 int vscanf(const char *, __va_list) 291 __attribute__((__format__ (scanf, 1, 0))) 292 __attribute__((__nonnull__ (1))); 293 int vsnprintf(char *, size_t, const char *, __va_list) 294 __attribute__((__format__ (printf, 3, 0))) 295 __attribute__((__nonnull__ (3))) 296 __attribute__((__bounded__(__string__,1,2))); 297 int vsscanf(const char *, const char *, __va_list) 298 __attribute__((__format__ (scanf, 2, 0))) 299 __attribute__((__nonnull__ (2))); 300 #endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */ 301 302 __END_DECLS 303 304 305 /* 306 * Functions defined in POSIX 1003.1. 307 */ 308 #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE 309 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 310 311 __BEGIN_DECLS 312 char *ctermid(char *); 313 FILE *fdopen(int, const char *); 314 int fileno(FILE *); 315 316 #if __POSIX_VISIBLE >= 199209 317 int pclose(FILE *); 318 FILE *popen(const char *, const char *); 319 #endif 320 321 #if __POSIX_VISIBLE >= 199506 322 void flockfile(FILE *); 323 int ftrylockfile(FILE *); 324 void funlockfile(FILE *); 325 326 /* 327 * These are normally used through macros as defined below, but POSIX 328 * requires functions as well. 329 */ 330 int getc_unlocked(FILE *); 331 int getchar_unlocked(void); 332 int putc_unlocked(int, FILE *); 333 int putchar_unlocked(int); 334 #endif /* __POSIX_VISIBLE >= 199506 */ 335 336 #if __POSIX_VISIBLE >= 200809 337 FILE *fmemopen(void *, size_t, const char *); 338 FILE *open_memstream(char **, size_t *); 339 #endif /* __POSIX_VISIBLE >= 200809 */ 340 341 #if __XPG_VISIBLE 342 char *tempnam(const char *, const char *); 343 #endif 344 __END_DECLS 345 346 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */ 347 348 /* 349 * Routines that are purely local. 350 */ 351 #if __BSD_VISIBLE 352 __BEGIN_DECLS 353 int asprintf(char **, const char *, ...) 354 __attribute__((__format__ (printf, 2, 3))) 355 __attribute__((__nonnull__ (2))); 356 char *fgetln(FILE *, size_t *); 357 int fpurge(FILE *); 358 int getw(FILE *); 359 int putw(int, FILE *); 360 void setbuffer(FILE *, char *, int); 361 int setlinebuf(FILE *); 362 int vasprintf(char **, const char *, __va_list) 363 __attribute__((__format__ (printf, 2, 0))) 364 __attribute__((__nonnull__ (2))); 365 __END_DECLS 366 367 /* 368 * Stdio function-access interface. 369 */ 370 __BEGIN_DECLS 371 FILE *funopen(const void *, 372 int (*)(void *, char *, int), 373 int (*)(void *, const char *, int), 374 fpos_t (*)(void *, fpos_t, int), 375 int (*)(void *)); 376 __END_DECLS 377 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 378 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 379 #endif /* __BSD_VISIBLE */ 380 381 /* 382 * Functions internal to the implementation. 383 */ 384 __BEGIN_DECLS 385 int __srget(FILE *); 386 int __swbuf(int, FILE *); 387 __END_DECLS 388 389 /* 390 * The __sfoo macros are here so that we can 391 * define function versions in the C library. 392 */ 393 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 394 #if defined(__GNUC__) 395 static __inline int __sputc(int _c, FILE *_p) { 396 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 397 return (*_p->_p++ = _c); 398 else 399 return (__swbuf(_c, _p)); 400 } 401 #else 402 /* 403 * This has been tuned to generate reasonable code on the vax using pcc. 404 */ 405 #define __sputc(c, p) \ 406 (--(p)->_w < 0 ? \ 407 (p)->_w >= (p)->_lbfsize ? \ 408 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 409 (int)*(p)->_p++ : \ 410 __swbuf('\n', p) : \ 411 __swbuf((int)(c), p) : \ 412 (*(p)->_p = (c), (int)*(p)->_p++)) 413 #endif 414 415 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 416 #define __sferror(p) (((p)->_flags & __SERR) != 0) 417 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 418 #define __sfileno(p) ((p)->_file) 419 420 extern int __isthreaded; 421 422 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 423 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 424 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 425 426 #if __POSIX_VISIBLE 427 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 428 #endif 429 430 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 431 432 #if __BSD_VISIBLE 433 /* 434 * The macro implementations of putc and putc_unlocked are not 435 * fully POSIX compliant; they do not set errno on failure 436 */ 437 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 438 #endif /* __BSD_VISIBLE */ 439 440 #if __POSIX_VISIBLE >= 199506 441 #define getc_unlocked(fp) __sgetc(fp) 442 /* 443 * The macro implementations of putc and putc_unlocked are not 444 * fully POSIX compliant; they do not set errno on failure 445 */ 446 #if __BSD_VISIBLE 447 #define putc_unlocked(x, fp) __sputc(x, fp) 448 #endif /* __BSD_VISIBLE */ 449 #endif /* __POSIX_VISIBLE >= 199506 */ 450 451 #define getchar() getc(stdin) 452 #define putchar(x) putc(x, stdout) 453 #define getchar_unlocked() getc_unlocked(stdin) 454 #define putchar_unlocked(c) putc_unlocked(c, stdout) 455 456 #endif /* _STDIO_H_ */ 457