1 /* $OpenBSD: stdio.h,v 1.29 2003/08/01 17:38:33 avsm 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 #if !defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__) 42 #include <sys/types.h> 43 #endif 44 45 #include <sys/cdefs.h> 46 #include <machine/ansi.h> 47 48 #ifdef _BSD_SIZE_T_ 49 typedef _BSD_SIZE_T_ size_t; 50 #undef _BSD_SIZE_T_ 51 #endif 52 53 #ifdef _BSD_OFF_T_ 54 typedef _BSD_OFF_T_ off_t; 55 #undef _BSD_OFF_T_ 56 #endif 57 58 #ifndef NULL 59 #ifdef __GNUG__ 60 #define NULL __null 61 #else 62 #define NULL 0L 63 #endif 64 #endif 65 66 #define _FSTDIO /* Define for new stdio with functions. */ 67 68 typedef off_t fpos_t; /* stdio file position type */ 69 70 /* 71 * NB: to fit things in six character monocase externals, the stdio 72 * code uses the prefix `__s' for stdio objects, typically followed 73 * by a three-character attempt at a mnemonic. 74 */ 75 76 /* stdio buffers */ 77 struct __sbuf { 78 unsigned char *_base; 79 int _size; 80 }; 81 82 /* 83 * stdio state variables. 84 * 85 * The following always hold: 86 * 87 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 88 * _lbfsize is -_bf._size, else _lbfsize is 0 89 * if _flags&__SRD, _w is 0 90 * if _flags&__SWR, _r is 0 91 * 92 * This ensures that the getc and putc macros (or inline functions) never 93 * try to write or read from a file that is in `read' or `write' mode. 94 * (Moreover, they can, and do, automatically switch from read mode to 95 * write mode, and back, on "r+" and "w+" files.) 96 * 97 * _lbfsize is used only to make the inline line-buffered output stream 98 * code as compact as possible. 99 * 100 * _ub, _up, and _ur are used when ungetc() pushes back more characters 101 * than fit in the current _bf, or when ungetc() pushes back a character 102 * that does not match the previous one in _bf. When this happens, 103 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 104 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 105 */ 106 typedef 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 /* separate buffer for long sequences of ungetc() */ 123 struct __sbuf _ub; /* ungetc buffer */ 124 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 125 int _ur; /* saved _r when _r is counting ungetc data */ 126 127 /* tricks to meet minimum requirements even when malloc() fails */ 128 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 129 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 130 131 /* separate buffer for fgetln() when line crosses buffer boundary */ 132 struct __sbuf _lb; /* buffer for fgetln() */ 133 134 /* Unix stdio files get aligned to block boundaries on fseek() */ 135 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 136 fpos_t _offset; /* current lseek offset */ 137 } FILE; 138 139 __BEGIN_DECLS 140 extern FILE __sF[]; 141 __END_DECLS 142 143 #define __SLBF 0x0001 /* line buffered */ 144 #define __SNBF 0x0002 /* unbuffered */ 145 #define __SRD 0x0004 /* OK to read */ 146 #define __SWR 0x0008 /* OK to write */ 147 /* RD and WR are never simultaneously asserted */ 148 #define __SRW 0x0010 /* open for reading & writing */ 149 #define __SEOF 0x0020 /* found EOF */ 150 #define __SERR 0x0040 /* found error */ 151 #define __SMBF 0x0080 /* _buf is from malloc */ 152 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 153 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 154 #define __SOPT 0x0400 /* do fseek() optimisation */ 155 #define __SNPT 0x0800 /* do not do fseek() optimisation */ 156 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 157 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 158 #define __SALC 0x4000 /* allocate string space dynamically */ 159 160 /* 161 * The following three definitions are for ANSI C, which took them 162 * from System V, which brilliantly took internal interface macros and 163 * made them official arguments to setvbuf(), without renaming them. 164 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 165 * 166 * Although numbered as their counterparts above, the implementation 167 * does not rely on this. 168 */ 169 #define _IOFBF 0 /* setvbuf should set fully buffered */ 170 #define _IOLBF 1 /* setvbuf should set line buffered */ 171 #define _IONBF 2 /* setvbuf should set unbuffered */ 172 173 #define BUFSIZ 1024 /* size of buffer used by setbuf */ 174 175 #define EOF (-1) 176 177 /* 178 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors 179 * that the kernel can provide without allocation of a resource that can 180 * fail without the process sleeping. Do not use this for anything. 181 */ 182 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 183 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 184 185 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 186 #ifndef _ANSI_SOURCE 187 #define P_tmpdir "/tmp/" 188 #endif 189 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 190 #define TMP_MAX 308915776 191 192 #ifndef SEEK_SET 193 #define SEEK_SET 0 /* set file offset to offset */ 194 #endif 195 #ifndef SEEK_CUR 196 #define SEEK_CUR 1 /* set file offset to current plus offset */ 197 #endif 198 #ifndef SEEK_END 199 #define SEEK_END 2 /* set file offset to EOF plus offset */ 200 #endif 201 202 #define stdin (&__sF[0]) 203 #define stdout (&__sF[1]) 204 #define stderr (&__sF[2]) 205 206 /* 207 * Functions defined in ANSI C standard. 208 */ 209 __BEGIN_DECLS 210 void clearerr(FILE *); 211 int fclose(FILE *); 212 int feof(FILE *); 213 int ferror(FILE *); 214 int fflush(FILE *); 215 int fgetc(FILE *); 216 int fgetpos(FILE *, fpos_t *); 217 char *fgets(char *, int, FILE *) 218 __attribute__((__bounded__ (__string__,1,2))); 219 FILE *fopen(const char *, const char *); 220 int fprintf(FILE *, const char *, ...); 221 int fputc(int, FILE *); 222 int fputs(const char *, FILE *); 223 size_t fread(void *, size_t, size_t, FILE *) 224 __attribute__((__bounded__ (__size__,1,3,2))); 225 FILE *freopen(const char *, const char *, FILE *); 226 int fscanf(FILE *, const char *, ...); 227 int fseek(FILE *, long, int); 228 int fseeko(FILE *, off_t, int); 229 int fsetpos(FILE *, const fpos_t *); 230 long ftell(FILE *); 231 off_t ftello(FILE *); 232 size_t fwrite(const void *, size_t, size_t, FILE *) 233 __attribute__((__bounded__ (__size__,1,3,2))); 234 int getc(FILE *); 235 int getchar(void); 236 char *gets(char *); 237 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) && !defined(__SYS_ERRLIST) 238 #define __SYS_ERRLIST 239 240 extern int sys_nerr; /* perror(3) external variables */ 241 extern char *sys_errlist[]; 242 #endif 243 void perror(const char *); 244 int printf(const char *, ...); 245 int putc(int, FILE *); 246 int putchar(int); 247 int puts(const char *); 248 int remove(const char *); 249 int rename(const char *, const char *); 250 void rewind(FILE *); 251 int scanf(const char *, ...); 252 void setbuf(FILE *, char *); 253 int setvbuf(FILE *, char *, int, size_t); 254 int sprintf(char *, const char *, ...); 255 int sscanf(const char *, const char *, ...); 256 FILE *tmpfile(void); 257 char *tmpnam(char *); 258 int ungetc(int, FILE *); 259 int vfprintf(FILE *, const char *, _BSD_VA_LIST_); 260 int vprintf(const char *, _BSD_VA_LIST_); 261 int vsprintf(char *, const char *, _BSD_VA_LIST_); 262 __END_DECLS 263 264 /* 265 * Functions defined in POSIX 1003.1. 266 */ 267 #ifndef _ANSI_SOURCE 268 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 269 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 270 271 __BEGIN_DECLS 272 char *ctermid(char *); 273 char *ctermid_r(char *); 274 char *cuserid(char *); 275 FILE *fdopen(int, const char *); 276 int fileno(FILE *); 277 void flockfile(FILE *); 278 int ftrylockfile(FILE *); 279 void funlockfile(FILE *); 280 void _flockfile_debug(FILE *, char *, int); 281 int getc_unlocked(FILE *); 282 int putc_unlocked(int, FILE *); 283 int getchar_unlocked(void); 284 int putchar_unlocked(int); 285 __END_DECLS 286 287 #ifndef _POSIX_THREADS 288 # define flockfile(fp) /* nothing */ 289 # define ftrylockfile(fp) (0) 290 # define funlockfile(fp) /* nothing */ 291 # define _flockfile_debug(fp,f,l) /* nothing */ 292 #endif 293 294 #if 0 /* defined(DEBUG_FLOCKFILE) && defined(_POSIX_THREADS) */ 295 # define flockfile(fp) _flockfile_debug(fp, __FILE__, __LINE__) 296 #endif 297 298 #endif /* not ANSI */ 299 300 /* 301 * Routines that are purely local. 302 */ 303 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE) 304 __BEGIN_DECLS 305 int asprintf(char **, const char *, ...) 306 __attribute__((__format__ (printf, 2, 3))) 307 __attribute__((__nonnull__ (2))); 308 char *fgetln(FILE *, size_t *); 309 int fpurge(FILE *); 310 int getw(FILE *); 311 int pclose(FILE *); 312 FILE *popen(const char *, const char *); 313 int putw(int, FILE *); 314 void setbuffer(FILE *, char *, int); 315 int setlinebuf(FILE *); 316 char *tempnam(const char *, const char *); 317 int snprintf(char *, size_t, const char *, ...) 318 __attribute__((__format__ (printf, 3, 4))) 319 __attribute__((__nonnull__ (3))) 320 __attribute__((__bounded__ (__string__,1,2))); 321 int vasprintf(char **, const char *, _BSD_VA_LIST_) 322 __attribute__((__format__ (printf, 2, 0))) 323 __attribute__((__nonnull__ (2))); 324 int vsnprintf(char *, size_t, const char *, _BSD_VA_LIST_) 325 __attribute__((__format__ (printf, 3, 0))) 326 __attribute__((__nonnull__ (3))) 327 __attribute__((__bounded__(__string__,1,2))); 328 int vscanf(const char *, _BSD_VA_LIST_) 329 __attribute__((__format__ (scanf, 1, 0))) 330 __attribute__((__nonnull__ (1))); 331 int vsscanf(const char *, const char *, _BSD_VA_LIST_) 332 __attribute__((__format__ (scanf, 2, 0))) 333 __attribute__((__nonnull__ (2))); 334 __END_DECLS 335 336 /* 337 * This is a #define because the function is used internally and 338 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide 339 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined. 340 */ 341 #define vfscanf __svfscanf 342 343 /* 344 * Stdio function-access interface. 345 */ 346 __BEGIN_DECLS 347 FILE *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 /* !_ANSI_SOURCE && !_POSIX_SOURCE */ 356 357 /* 358 * Functions internal to the implementation. 359 */ 360 __BEGIN_DECLS 361 int __srget(FILE *); 362 int __svfscanf(FILE *, const char *, _BSD_VA_LIST_); 363 int __swbuf(int, FILE *); 364 __END_DECLS 365 366 /* 367 * The __sfoo macros are here so that we can 368 * define function versions in the C library. 369 */ 370 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 371 #if defined(__GNUC__) 372 static __inline int __sputc(int _c, FILE *_p) { 373 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 374 return (*_p->_p++ = _c); 375 else 376 return (__swbuf(_c, _p)); 377 } 378 #else 379 /* 380 * This has been tuned to generate reasonable code on the vax using pcc. 381 */ 382 #define __sputc(c, p) \ 383 (--(p)->_w < 0 ? \ 384 (p)->_w >= (p)->_lbfsize ? \ 385 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 386 (int)*(p)->_p++ : \ 387 __swbuf('\n', p) : \ 388 __swbuf((int)(c), p) : \ 389 (*(p)->_p = (c), (int)*(p)->_p++)) 390 #endif 391 392 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 393 #define __sferror(p) (((p)->_flags & __SERR) != 0) 394 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 395 #define __sfileno(p) ((p)->_file) 396 397 #define feof(p) __sfeof(p) 398 #define ferror(p) __sferror(p) 399 400 #ifndef _POSIX_THREADS 401 #define clearerr(p) __sclearerr(p) 402 #endif 403 404 #ifndef _ANSI_SOURCE 405 #define fileno(p) __sfileno(p) 406 #endif 407 408 #ifndef lint 409 #ifndef _POSIX_THREADS 410 #define getc(fp) __sgetc(fp) 411 #endif /* _POSIX_THREADS */ 412 #define getc_unlocked(fp) __sgetc(fp) 413 /* 414 * The macro implementations of putc and putc_unlocked are not 415 * fully POSIX compliant; they do not set errno on failure 416 */ 417 #ifndef _POSIX_SOURCE 418 #ifndef _POSIX_THREADS 419 #define putc(x, fp) __sputc(x, fp) 420 #endif /* _POSIX_THREADS */ 421 #define putc_unlocked(x, fp) __sputc(x, fp) 422 #endif /* _POSIX_SOURCE */ 423 #endif /* lint */ 424 425 #define getchar() getc(stdin) 426 #define putchar(x) putc(x, stdout) 427 #define getchar_unlocked() getc_unlocked(stdin) 428 #define putchar_unlocked(c) putc_unlocked(c, stdout) 429 430 #endif /* _STDIO_H_ */ 431