1/* $OpenBSD: stdio.h,v 1.35 2006/01/13 18:10:09 miod 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/* 42 * This file must contain a reference to __gnuc_va_list so that GCC's 43 * fixincludes knows that that's what's being used for va_list, and so 44 * to leave our <stdio.h> alone. (fixincludes gets in the way of pointing 45 * one toolchain at various different sets of platform headers.) 46 * If you alter this comment, be sure to keep "__gnuc_va_list" in it! 47 */ 48 49#include <sys/cdefs.h> 50#include <sys/types.h> 51 52/* va_list and size_t must be defined by stdio.h according to Posix */ 53#define __need___va_list 54#include <stdarg.h> 55 56/* note that this forces stddef.h to *only* define size_t */ 57#define __need_size_t 58#include <stddef.h> 59 60#define __need_NULL 61#include <stddef.h> 62 63#define _FSTDIO /* Define for new stdio with functions. */ 64 65typedef off_t fpos_t; /* stdio file position type */ 66 67/* 68 * NB: to fit things in six character monocase externals, the stdio 69 * code uses the prefix `__s' for stdio objects, typically followed 70 * by a three-character attempt at a mnemonic. 71 */ 72 73/* stdio buffers */ 74struct __sbuf { 75 unsigned char *_base; 76 int _size; 77}; 78 79/* 80 * stdio state variables. 81 * 82 * The following always hold: 83 * 84 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 85 * _lbfsize is -_bf._size, else _lbfsize is 0 86 * if _flags&__SRD, _w is 0 87 * if _flags&__SWR, _r is 0 88 * 89 * This ensures that the getc and putc macros (or inline functions) never 90 * try to write or read from a file that is in `read' or `write' mode. 91 * (Moreover, they can, and do, automatically switch from read mode to 92 * write mode, and back, on "r+" and "w+" files.) 93 * 94 * _lbfsize is used only to make the inline line-buffered output stream 95 * code as compact as possible. 96 * 97 * _ub, _up, and _ur are used when ungetc() pushes back more characters 98 * than fit in the current _bf, or when ungetc() pushes back a character 99 * that does not match the previous one in _bf. When this happens, 100 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 101 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 102 * 103 * NOTE: if you change this structure, you also need to update the 104 * std() initializer in findfp.c. 105 */ 106typedef struct __sFILE { 107 unsigned char *_p; /* current position in (some) buffer */ 108 int _r; /* read space left for getc() */ 109 int _w; /* write space left for putc() */ 110 short _flags; /* flags, below; this FILE is free if 0 */ 111 short _file; /* fileno, if Unix descriptor, else -1 */ 112 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */ 113 int _lbfsize; /* 0 or -_bf._size, for inline putc */ 114 115 /* operations */ 116 void *_cookie; /* cookie passed to io functions */ 117 int (*_close)(void *); 118 int (*_read)(void *, char *, int); 119 fpos_t (*_seek)(void *, fpos_t, int); 120 int (*_write)(void *, const char *, int); 121 122 /* extension data, to avoid further ABI breakage */ 123 struct __sbuf _ext; 124 /* data for long sequences of ungetc() */ 125 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 126 int _ur; /* saved _r when _r is counting ungetc data */ 127 128 /* tricks to meet minimum requirements even when malloc() fails */ 129 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 130 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 131 132 /* separate buffer for fgetln() when line crosses buffer boundary */ 133 struct __sbuf _lb; /* buffer for fgetln() */ 134 135 /* Unix stdio files get aligned to block boundaries on fseek() */ 136 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 137 fpos_t _offset; /* current lseek offset */ 138} FILE; 139 140__BEGIN_DECLS 141extern FILE __sF[]; 142__END_DECLS 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() optimisation */ 156#define __SNPT 0x0800 /* do not do fseek() optimisation */ 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 161/* 162 * The following three definitions are for ANSI C, which took them 163 * from System V, which brilliantly took internal interface macros and 164 * made them official arguments to setvbuf(), without renaming them. 165 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 166 * 167 * Although numbered as their counterparts above, the implementation 168 * does not rely on this. 169 */ 170#define _IOFBF 0 /* setvbuf should set fully buffered */ 171#define _IOLBF 1 /* setvbuf should set line buffered */ 172#define _IONBF 2 /* setvbuf should set unbuffered */ 173 174#define BUFSIZ 1024 /* size of buffer used by setbuf */ 175 176#define EOF (-1) 177 178/* 179 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors 180 * that the kernel can provide without allocation of a resource that can 181 * fail without the process sleeping. Do not use this for anything. 182 */ 183#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 184#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 185 186/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 187#if __BSD_VISIBLE || __XPG_VISIBLE 188#define P_tmpdir "/tmp/" 189#endif 190#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 191#define TMP_MAX 308915776 192 193#ifndef SEEK_SET 194#define SEEK_SET 0 /* set file offset to offset */ 195#endif 196#ifndef SEEK_CUR 197#define SEEK_CUR 1 /* set file offset to current plus offset */ 198#endif 199#ifndef SEEK_END 200#define SEEK_END 2 /* set file offset to EOF plus offset */ 201#endif 202 203#define stdin (&__sF[0]) 204#define stdout (&__sF[1]) 205#define stderr (&__sF[2]) 206 207/* 208 * Functions defined in ANSI C standard. 209 */ 210__BEGIN_DECLS 211void clearerr(FILE *); 212int fclose(FILE *); 213int feof(FILE *); 214int ferror(FILE *); 215int fflush(FILE *); 216int fgetc(FILE *); 217int fgetpos(FILE *, fpos_t *); 218char *fgets(char *, int, FILE *); 219FILE *fopen(const char *, const char *); 220int fprintf(FILE *, const char *, ...); 221int fputc(int, FILE *); 222int fputs(const char *, FILE *); 223size_t fread(void *, size_t, size_t, FILE *); 224FILE *freopen(const char *, const char *, FILE *); 225int fscanf(FILE *, const char *, ...); 226int fseek(FILE *, long, int); 227int fseeko(FILE *, off_t, int); 228int fsetpos(FILE *, const fpos_t *); 229long ftell(FILE *); 230off_t ftello(FILE *); 231size_t fwrite(const void *, size_t, size_t, FILE *); 232int getc(FILE *); 233int getchar(void); 234char *gets(char *); 235#if __BSD_VISIBLE && !defined(__SYS_ERRLIST) 236#define __SYS_ERRLIST 237 238extern int sys_nerr; /* perror(3) external variables */ 239extern char *sys_errlist[]; 240#endif 241void perror(const char *); 242int printf(const char *, ...); 243int putc(int, FILE *); 244int putchar(int); 245int puts(const char *); 246int remove(const char *); 247int rename(const char *, const char *); 248void rewind(FILE *); 249int scanf(const char *, ...); 250void setbuf(FILE *, char *); 251int setvbuf(FILE *, char *, int, size_t); 252int sprintf(char *, const char *, ...); 253int sscanf(const char *, const char *, ...); 254FILE *tmpfile(void); 255char *tmpnam(char *); 256int ungetc(int, FILE *); 257int vfprintf(FILE *, const char *, __va_list); 258int vprintf(const char *, __va_list); 259int vsprintf(char *, const char *, __va_list); 260 261#if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE 262int snprintf(char *, size_t, const char *, ...) 263 __attribute__((__format__ (printf, 3, 4))) 264 __attribute__((__nonnull__ (3))); 265int vfscanf(FILE *, const char *, __va_list) 266 __attribute__((__format__ (scanf, 2, 0))) 267 __attribute__((__nonnull__ (2))); 268int vscanf(const char *, __va_list) 269 __attribute__((__format__ (scanf, 1, 0))) 270 __attribute__((__nonnull__ (1))); 271int vsnprintf(char *, size_t, const char *, __va_list) 272 __attribute__((__format__ (printf, 3, 0))) 273 __attribute__((__nonnull__ (3))); 274int vsscanf(const char *, const char *, __va_list) 275 __attribute__((__format__ (scanf, 2, 0))) 276 __attribute__((__nonnull__ (2))); 277#endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */ 278 279__END_DECLS 280 281 282/* 283 * Functions defined in POSIX 1003.1. 284 */ 285#if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE 286#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 287#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 288 289__BEGIN_DECLS 290#if 0 /* MISSING FROM BIONIC */ 291char *ctermid(char *); 292char *cuserid(char *); 293#endif /* MISSING */ 294FILE *fdopen(int, const char *); 295int fileno(FILE *); 296 297#if (__POSIX_VISIBLE >= 199209) 298int pclose(FILE *); 299FILE *popen(const char *, const char *); 300#endif 301 302#if __POSIX_VISIBLE >= 199506 303void flockfile(FILE *); 304int ftrylockfile(FILE *); 305void funlockfile(FILE *); 306 307/* 308 * These are normally used through macros as defined below, but POSIX 309 * requires functions as well. 310 */ 311int getc_unlocked(FILE *); 312int getchar_unlocked(void); 313int putc_unlocked(int, FILE *); 314int putchar_unlocked(int); 315#endif /* __POSIX_VISIBLE >= 199506 */ 316 317#if __XPG_VISIBLE 318char *tempnam(const char *, const char *); 319#endif 320__END_DECLS 321 322#endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */ 323 324/* 325 * Routines that are purely local. 326 */ 327#if __BSD_VISIBLE 328__BEGIN_DECLS 329int asprintf(char **, const char *, ...) 330 __attribute__((__format__ (printf, 2, 3))) 331 __attribute__((__nonnull__ (2))); 332char *fgetln(FILE *, size_t *); 333int fpurge(FILE *); 334int getw(FILE *); 335int putw(int, FILE *); 336void setbuffer(FILE *, char *, int); 337int setlinebuf(FILE *); 338int vasprintf(char **, const char *, __va_list) 339 __attribute__((__format__ (printf, 2, 0))) 340 __attribute__((__nonnull__ (2))); 341__END_DECLS 342 343/* 344 * Stdio function-access interface. 345 */ 346__BEGIN_DECLS 347FILE *funopen(const void *, 348 int (*)(void *, char *, int), 349 int (*)(void *, const char *, int), 350 fpos_t (*)(void *, fpos_t, int), 351 int (*)(void *)); 352__END_DECLS 353#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 354#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 355#endif /* __BSD_VISIBLE */ 356 357/* 358 * The __sfoo macros are here so that we can 359 * define function versions in the C library. 360 */ 361 362#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 363#define __sferror(p) (((p)->_flags & __SERR) != 0) 364#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 365#define __sfileno(p) ((p)->_file) 366 367#define feof(p) __sfeof(p) 368#define ferror(p) __sferror(p) 369 370#ifndef _POSIX_THREADS 371#define clearerr(p) __sclearerr(p) 372#endif 373 374#if __POSIX_VISIBLE 375#define fileno(p) __sfileno(p) 376#endif 377 378#define getchar() getc(stdin) 379#define putchar(x) putc(x, stdout) 380#define getchar_unlocked() getc_unlocked(stdin) 381#define putchar_unlocked(c) putc_unlocked(c, stdout) 382 383#ifdef _GNU_SOURCE 384/* 385 * glibc defines dprintf(int, const char*, ...), which is poorly named 386 * and likely to conflict with locally defined debugging printfs 387 * fdprintf is a better name, and some programs that use fdprintf use a 388 * #define fdprintf dprintf for compatibility 389 */ 390int fdprintf(int, const char*, ...); 391int vfdprintf(int, const char*, __va_list); 392#endif /* _GNU_SOURCE */ 393 394#endif /* _STDIO_H_ */ 395