1 /* $OpenBSD: stdio.h,v 1.42 2012/03/21 23:44:35 fgsch 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 int fclose(FILE *); 216 int feof(FILE *); 217 int ferror(FILE *); 218 int fflush(FILE *); 219 int fgetc(FILE *); 220 int fgetpos(FILE *, fpos_t *); 221 char *fgets(char *, int, FILE *) 222 __attribute__((__bounded__ (__string__,1,2))); 223 FILE *fopen(const char *, const char *); 224 int fprintf(FILE *, const char *, ...); 225 int fputc(int, FILE *); 226 int fputs(const char *, FILE *); 227 size_t fread(void *, size_t, size_t, FILE *) 228 __attribute__((__bounded__ (__size__,1,3,2))); 229 FILE *freopen(const char *, const char *, FILE *); 230 int fscanf(FILE *, const char *, ...); 231 int fseek(FILE *, long, int); 232 int fseeko(FILE *, off_t, int); 233 int fsetpos(FILE *, const fpos_t *); 234 long ftell(FILE *); 235 off_t ftello(FILE *); 236 size_t fwrite(const void *, size_t, size_t, FILE *) 237 __attribute__((__bounded__ (__size__,1,3,2))); 238 int getc(FILE *); 239 int getchar(void); 240 #if __POSIX_VISIBLE >= 200809 241 ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 242 FILE * __restrict); 243 ssize_t getline(char ** __restrict, size_t * __restrict, 244 FILE * __restrict); 245 #endif 246 char *gets(char *); 247 #if __BSD_VISIBLE && !defined(__SYS_ERRLIST) 248 #define __SYS_ERRLIST 249 250 extern int sys_nerr; /* perror(3) external variables */ 251 extern char *sys_errlist[]; 252 #endif 253 void perror(const char *); 254 int printf(const char *, ...); 255 int putc(int, FILE *); 256 int putchar(int); 257 int puts(const char *); 258 int remove(const char *); 259 int rename(const char *, const char *); 260 #if __POSIX_VISIBLE >= 200809 261 int renameat(int, const char *, int, const char *); 262 #endif 263 void rewind(FILE *); 264 int scanf(const char *, ...); 265 void setbuf(FILE *, char *); 266 int setvbuf(FILE *, char *, int, size_t); 267 int sprintf(char *, const char *, ...); 268 int sscanf(const char *, const char *, ...); 269 FILE *tmpfile(void); 270 char *tmpnam(char *); 271 int ungetc(int, FILE *); 272 int vfprintf(FILE *, const char *, __va_list); 273 int vprintf(const char *, __va_list); 274 int vsprintf(char *, const char *, __va_list); 275 276 #if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE 277 int snprintf(char *, size_t, const char *, ...) 278 __attribute__((__format__ (printf, 3, 4))) 279 __attribute__((__nonnull__ (3))) 280 __attribute__((__bounded__ (__string__,1,2))); 281 int vfscanf(FILE *, const char *, __va_list) 282 __attribute__((__format__ (scanf, 2, 0))) 283 __attribute__((__nonnull__ (2))); 284 int vscanf(const char *, __va_list) 285 __attribute__((__format__ (scanf, 1, 0))) 286 __attribute__((__nonnull__ (1))); 287 int vsnprintf(char *, size_t, const char *, __va_list) 288 __attribute__((__format__ (printf, 3, 0))) 289 __attribute__((__nonnull__ (3))) 290 __attribute__((__bounded__(__string__,1,2))); 291 int vsscanf(const char *, const char *, __va_list) 292 __attribute__((__format__ (scanf, 2, 0))) 293 __attribute__((__nonnull__ (2))); 294 #endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */ 295 296 __END_DECLS 297 298 299 /* 300 * Functions defined in POSIX 1003.1. 301 */ 302 #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE 303 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 304 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 305 306 __BEGIN_DECLS 307 char *ctermid(char *); 308 char *cuserid(char *); 309 FILE *fdopen(int, const char *); 310 int fileno(FILE *); 311 312 #if __POSIX_VISIBLE >= 199209 313 int pclose(FILE *); 314 FILE *popen(const char *, const char *); 315 #endif 316 317 #if __POSIX_VISIBLE >= 199506 318 void flockfile(FILE *); 319 int ftrylockfile(FILE *); 320 void funlockfile(FILE *); 321 322 /* 323 * These are normally used through macros as defined below, but POSIX 324 * requires functions as well. 325 */ 326 int getc_unlocked(FILE *); 327 int getchar_unlocked(void); 328 int putc_unlocked(int, FILE *); 329 int putchar_unlocked(int); 330 #endif /* __POSIX_VISIBLE >= 199506 */ 331 332 #if __XPG_VISIBLE 333 char *tempnam(const char *, const char *); 334 #endif 335 __END_DECLS 336 337 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */ 338 339 /* 340 * Routines that are purely local. 341 */ 342 #if __BSD_VISIBLE 343 __BEGIN_DECLS 344 int asprintf(char **, const char *, ...) 345 __attribute__((__format__ (printf, 2, 3))) 346 __attribute__((__nonnull__ (2))); 347 char *fgetln(FILE *, size_t *); 348 int fpurge(FILE *); 349 int getw(FILE *); 350 int putw(int, FILE *); 351 void setbuffer(FILE *, char *, int); 352 int setlinebuf(FILE *); 353 int vasprintf(char **, const char *, __va_list) 354 __attribute__((__format__ (printf, 2, 0))) 355 __attribute__((__nonnull__ (2))); 356 __END_DECLS 357 358 /* 359 * Stdio function-access interface. 360 */ 361 __BEGIN_DECLS 362 FILE *funopen(const void *, 363 int (*)(void *, char *, int), 364 int (*)(void *, const char *, int), 365 fpos_t (*)(void *, fpos_t, int), 366 int (*)(void *)); 367 __END_DECLS 368 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 369 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 370 #endif /* __BSD_VISIBLE */ 371 372 /* 373 * Functions internal to the implementation. 374 */ 375 __BEGIN_DECLS 376 int __srget(FILE *); 377 int __swbuf(int, FILE *); 378 __END_DECLS 379 380 /* 381 * The __sfoo macros are here so that we can 382 * define function versions in the C library. 383 */ 384 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 385 #if defined(__GNUC__) 386 static __inline int __sputc(int _c, FILE *_p) { 387 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 388 return (*_p->_p++ = _c); 389 else 390 return (__swbuf(_c, _p)); 391 } 392 #else 393 /* 394 * This has been tuned to generate reasonable code on the vax using pcc. 395 */ 396 #define __sputc(c, p) \ 397 (--(p)->_w < 0 ? \ 398 (p)->_w >= (p)->_lbfsize ? \ 399 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 400 (int)*(p)->_p++ : \ 401 __swbuf('\n', p) : \ 402 __swbuf((int)(c), p) : \ 403 (*(p)->_p = (c), (int)*(p)->_p++)) 404 #endif 405 406 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 407 #define __sferror(p) (((p)->_flags & __SERR) != 0) 408 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 409 #define __sfileno(p) ((p)->_file) 410 411 extern int __isthreaded; 412 413 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 414 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 415 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 416 417 #if __POSIX_VISIBLE 418 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 419 #endif 420 421 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 422 423 #if __BSD_VISIBLE 424 /* 425 * The macro implementations of putc and putc_unlocked are not 426 * fully POSIX compliant; they do not set errno on failure 427 */ 428 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 429 #endif /* __BSD_VISIBLE */ 430 431 #ifndef lint 432 #if __POSIX_VISIBLE >= 199506 433 #define getc_unlocked(fp) __sgetc(fp) 434 /* 435 * The macro implementations of putc and putc_unlocked are not 436 * fully POSIX compliant; they do not set errno on failure 437 */ 438 #if __BSD_VISIBLE 439 #define putc_unlocked(x, fp) __sputc(x, fp) 440 #endif /* __BSD_VISIBLE */ 441 #endif /* __POSIX_VISIBLE >= 199506 */ 442 #endif /* lint */ 443 444 #define getchar() getc(stdin) 445 #define putchar(x) putc(x, stdout) 446 #define getchar_unlocked() getc_unlocked(stdin) 447 #define putchar_unlocked(c) putc_unlocked(c, stdout) 448 449 #endif /* _STDIO_H_ */ 450