1 /* $NetBSD: stdio.h,v 1.58 2005/02/09 21:35:46 kleink Exp $ */ 2 3 /*- 4 * Copyright (c) 1990, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This code is derived from software contributed to Berkeley by 8 * Chris Torek. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)stdio.h 8.5 (Berkeley) 4/29/95 35 */ 36 37 #ifndef _STDIO_H_ 38 #define _STDIO_H_ 39 40 #include <sys/ansi.h> 41 42 #include <sys/cdefs.h> 43 #include <sys/featuretest.h> 44 45 #include <machine/ansi.h> 46 #ifdef _BSD_SIZE_T_ 47 typedef _BSD_SIZE_T_ size_t; 48 #undef _BSD_SIZE_T_ 49 #endif 50 51 #include <sys/null.h> 52 53 /* 54 * This is fairly grotesque, but pure ANSI code must not inspect the 55 * innards of an fpos_t anyway. The library internally uses off_t, 56 * which we assume is exactly as big as eight chars. 57 */ 58 #if (!defined(_ANSI_SOURCE) && !defined(__STRICT_ANSI__)) || defined(_LIBC) 59 typedef __off_t fpos_t; 60 #else 61 typedef struct __sfpos { 62 __off_t _pos; 63 } fpos_t; 64 #endif 65 66 #define _FSTDIO /* Define for new stdio with functions. */ 67 68 /* 69 * NB: to fit things in six character monocase externals, the stdio 70 * code uses the prefix `__s' for stdio objects, typically followed 71 * by a three-character attempt at a mnemonic. 72 */ 73 74 /* stdio buffers */ 75 struct __sbuf { 76 unsigned char *_base; 77 int _size; 78 }; 79 80 /* 81 * stdio state variables. 82 * 83 * The following always hold: 84 * 85 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR), 86 * _lbfsize is -_bf._size, else _lbfsize is 0 87 * if _flags&__SRD, _w is 0 88 * if _flags&__SWR, _r is 0 89 * 90 * This ensures that the getc and putc macros (or inline functions) never 91 * try to write or read from a file that is in `read' or `write' mode. 92 * (Moreover, they can, and do, automatically switch from read mode to 93 * write mode, and back, on "r+" and "w+" files.) 94 * 95 * _lbfsize is used only to make the inline line-buffered output stream 96 * code as compact as possible. 97 * 98 * _ub, _up, and _ur are used when ungetc() pushes back more characters 99 * than fit in the current _bf, or when ungetc() pushes back a character 100 * that does not match the previous one in _bf. When this happens, 101 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff 102 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r. 103 * 104 * NB: see WARNING above before changing the layout of this structure! 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 /* file extension */ 123 struct __sbuf _ext; 124 125 /* separate buffer for long sequences of ungetc() */ 126 unsigned char *_up; /* saved _p when _p is doing ungetc data */ 127 int _ur; /* saved _r when _r is counting ungetc data */ 128 129 /* tricks to meet minimum requirements even when malloc() fails */ 130 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */ 131 unsigned char _nbuf[1]; /* guarantee a getc() buffer */ 132 133 /* separate buffer for fgetln() when line crosses buffer boundary */ 134 struct __sbuf _lb; /* buffer for fgetln() */ 135 136 /* Unix stdio files get aligned to block boundaries on fseek() */ 137 int _blksize; /* stat.st_blksize (may be != _bf._size) */ 138 fpos_t _offset; /* current lseek offset */ 139 } FILE; 140 141 __BEGIN_DECLS 142 extern FILE __sF[]; 143 __END_DECLS 144 145 #define __SLBF 0x0001 /* line buffered */ 146 #define __SNBF 0x0002 /* unbuffered */ 147 #define __SRD 0x0004 /* OK to read */ 148 #define __SWR 0x0008 /* OK to write */ 149 /* RD and WR are never simultaneously asserted */ 150 #define __SRW 0x0010 /* open for reading & writing */ 151 #define __SEOF 0x0020 /* found EOF */ 152 #define __SERR 0x0040 /* found error */ 153 #define __SMBF 0x0080 /* _buf is from malloc */ 154 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 155 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 156 #define __SOPT 0x0400 /* do fseek() optimization */ 157 #define __SNPT 0x0800 /* do not do fseek() optimization */ 158 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 159 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 160 #define __SALC 0x4000 /* allocate string space dynamically */ 161 162 /* 163 * The following three definitions are for ANSI C, which took them 164 * from System V, which brilliantly took internal interface macros and 165 * made them official arguments to setvbuf(), without renaming them. 166 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 167 * 168 * Although numbered as their counterparts above, the implementation 169 * does not rely on this. 170 */ 171 #define _IOFBF 0 /* setvbuf should set fully buffered */ 172 #define _IOLBF 1 /* setvbuf should set line buffered */ 173 #define _IONBF 2 /* setvbuf should set unbuffered */ 174 175 #define BUFSIZ 1024 /* size of buffer used by setbuf */ 176 #define EOF (-1) 177 178 /* 179 * FOPEN_MAX is a minimum maximum, and is the number of streams that 180 * stdio can provide without attempting to allocate further resources 181 * (which could fail). Do not use this for anything. 182 */ 183 /* must be == _POSIX_STREAM_MAX <limits.h> */ 184 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 185 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 186 187 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 188 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 189 #define P_tmpdir "/var/tmp/" 190 #endif 191 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 192 /* Always ensure that this is consistent with <limits.h> */ 193 #ifndef TMP_MAX 194 #define TMP_MAX 308915776 /* Legacy */ 195 #endif 196 197 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */ 198 #ifndef SEEK_SET 199 #define SEEK_SET 0 /* set file offset to offset */ 200 #endif 201 #ifndef SEEK_CUR 202 #define SEEK_CUR 1 /* set file offset to current plus offset */ 203 #endif 204 #ifndef SEEK_END 205 #define SEEK_END 2 /* set file offset to EOF plus offset */ 206 #endif 207 208 #define stdin (&__sF[0]) 209 #define stdout (&__sF[1]) 210 #define stderr (&__sF[2]) 211 212 /* 213 * Functions defined in ANSI C standard. 214 */ 215 __BEGIN_DECLS 216 void clearerr(FILE *); 217 int fclose(FILE *); 218 int feof(FILE *); 219 int ferror(FILE *); 220 int fflush(FILE *); 221 int fgetc(FILE *); 222 int fgetpos(FILE * __restrict, fpos_t * __restrict); 223 char *fgets(char * __restrict, int, FILE * __restrict); 224 FILE *fopen(const char *, const char *); 225 int fprintf(FILE * __restrict , const char * __restrict, ...); 226 int fputc(int, FILE *); 227 int fputs(const char * __restrict, FILE * __restrict); 228 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 229 FILE *freopen(const char *, const char *, FILE * __restrict); 230 int fscanf(FILE * __restrict, const char * __restrict, ...); 231 int fseek(FILE *, long, int); 232 int fsetpos(FILE *, const fpos_t *); 233 long ftell(FILE *); 234 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 235 int getc(FILE *); 236 int getchar(void); 237 void perror(const char *); 238 int printf(const char * __restrict, ...); 239 int putc(int, FILE *); 240 int putchar(int); 241 int puts(const char *); 242 int remove(const char *); 243 void rewind(FILE *); 244 int scanf(const char * __restrict, ...); 245 void setbuf(FILE * __restrict, char * __restrict); 246 int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 247 int sscanf(const char * __restrict, const char * __restrict, ...); 248 FILE *tmpfile(void); 249 int ungetc(int, FILE *); 250 int vfprintf(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_); 251 int vprintf(const char * __restrict, _BSD_VA_LIST_); 252 253 #ifndef __AUDIT__ 254 char *gets(char *); 255 int sprintf(char * __restrict, const char * __restrict, ...); 256 char *tmpnam(char *); 257 int vsprintf(char * __restrict, const char * __restrict, 258 _BSD_VA_LIST_); 259 #endif 260 261 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) 262 int rename (const char *, const char *) __RENAME(__posix_rename); 263 #else 264 int rename (const char *, const char *); 265 #endif 266 __END_DECLS 267 268 /* 269 * IEEE Std 1003.1-90 270 */ 271 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 272 defined(_NETBSD_SOURCE) 273 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 274 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 275 276 __BEGIN_DECLS 277 char *ctermid(char *); 278 #ifndef __CUSERID_DECLARED 279 #define __CUSERID_DECLARED 280 /* also declared in unistd.h */ 281 char *cuserid(char *); 282 #endif /* __CUSERID_DECLARED */ 283 FILE *fdopen(int, const char *); 284 int fileno(FILE *); 285 __END_DECLS 286 #endif /* not ANSI */ 287 288 /* 289 * IEEE Std 1003.1c-95, also adopted by X/Open CAE Spec Issue 5 Version 2 290 */ 291 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 292 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 293 __BEGIN_DECLS 294 void flockfile(FILE *); 295 int ftrylockfile(FILE *); 296 void funlockfile(FILE *); 297 int getc_unlocked(FILE *); 298 int getchar_unlocked(void); 299 int putc_unlocked(int, FILE *); 300 int putchar_unlocked(int); 301 __END_DECLS 302 #endif /* _POSIX_C_SOURCE >= 1995056 || _XOPEN_SOURCE >= 500 || ... */ 303 304 /* 305 * Functions defined in POSIX 1003.2 and XPG2 or later. 306 */ 307 #if (_POSIX_C_SOURCE - 0) >= 2 || (_XOPEN_SOURCE - 0) >= 2 || \ 308 defined(_NETBSD_SOURCE) 309 __BEGIN_DECLS 310 int pclose(FILE *); 311 FILE *popen(const char *, const char *); 312 __END_DECLS 313 #endif 314 315 /* 316 * Functions defined in XPG4.2. 317 */ 318 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) 319 __BEGIN_DECLS 320 int getw(FILE *); 321 int putw(int, FILE *); 322 int snprintf(char * __restrict, size_t, const char * __restrict, ...) 323 __attribute__((__format__(__printf__, 3, 4))); 324 int vsnprintf(char * __restrict, size_t, const char * __restrict, 325 _BSD_VA_LIST_) 326 __attribute__((__format__(__printf__, 3, 0))); 327 328 #ifndef __AUDIT__ 329 char *tempnam(const char *, const char *); 330 #endif 331 __END_DECLS 332 #endif 333 334 /* 335 * X/Open CAE Specification Issue 5 Version 2 336 */ 337 #if (_XOPEN_SOURCE - 0) >= 500 || defined(_LARGEFILE_SOURCE) || \ 338 defined(_NETBSD_SOURCE) 339 #ifndef off_t 340 typedef __off_t off_t; 341 #define off_t __off_t 342 #endif /* off_t */ 343 344 __BEGIN_DECLS 345 int fseeko(FILE *, off_t, int); 346 off_t ftello(FILE *); 347 __END_DECLS 348 #endif /* _XOPEN_SOURCE >= 500 || _LARGEFILE_SOURCE || _NETBSD_SOURCE */ 349 350 /* 351 * Routines that are purely local. 352 */ 353 #if defined(_NETBSD_SOURCE) 354 355 #define FPARSELN_UNESCESC 0x01 356 #define FPARSELN_UNESCCONT 0x02 357 #define FPARSELN_UNESCCOMM 0x04 358 #define FPARSELN_UNESCREST 0x08 359 #define FPARSELN_UNESCALL 0x0f 360 361 __BEGIN_DECLS 362 int asprintf(char ** __restrict, const char * __restrict, ...) 363 __attribute__((__format__(__printf__, 2, 3))); 364 char *fgetln(FILE * __restrict, size_t * __restrict); 365 char *fparseln(FILE *, size_t *, size_t *, const char[3], int); 366 int fpurge(FILE *); 367 void setbuffer(FILE *, char *, int); 368 int setlinebuf(FILE *); 369 int vasprintf(char ** __restrict, const char * __restrict, 370 _BSD_VA_LIST_) 371 __attribute__((__format__(__printf__, 2, 0))); 372 int vscanf(const char * __restrict, _BSD_VA_LIST_) 373 __attribute__((__format__(__scanf__, 1, 0))); 374 int vfscanf(FILE * __restrict, const char * __restrict, 375 _BSD_VA_LIST_) 376 __attribute__((__format__(__scanf__, 2, 0))); 377 int vsscanf(const char * __restrict, const char * __restrict, 378 _BSD_VA_LIST_) 379 __attribute__((__format__(__scanf__, 2, 0))); 380 __const char *fmtcheck(const char *, const char *) 381 __attribute__((__format_arg__(2))); 382 __END_DECLS 383 384 /* 385 * Stdio function-access interface. 386 */ 387 __BEGIN_DECLS 388 FILE *funopen(const void *, 389 int (*)(void *, char *, int), 390 int (*)(void *, const char *, int), 391 fpos_t (*)(void *, fpos_t, int), 392 int (*)(void *)); 393 __END_DECLS 394 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 395 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 396 #endif /* _NETBSD_SOURCE */ 397 398 /* 399 * Functions internal to the implementation. 400 */ 401 __BEGIN_DECLS 402 int __srget(FILE *); 403 int __swbuf(int, FILE *); 404 __END_DECLS 405 406 /* 407 * The __sfoo macros are here so that we can 408 * define function versions in the C library. 409 */ 410 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 411 #if defined(__GNUC__) && defined(__STDC__) 412 static __inline int __sputc(int _c, FILE *_p) { 413 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 414 return (*_p->_p++ = _c); 415 else 416 return (__swbuf(_c, _p)); 417 } 418 #else 419 /* 420 * This has been tuned to generate reasonable code on the vax using pcc. 421 */ 422 #define __sputc(c, p) \ 423 (--(p)->_w < 0 ? \ 424 (p)->_w >= (p)->_lbfsize ? \ 425 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 426 (int)*(p)->_p++ : \ 427 __swbuf('\n', p) : \ 428 __swbuf((int)(c), p) : \ 429 (*(p)->_p = (c), (int)*(p)->_p++)) 430 #endif 431 432 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 433 #define __sferror(p) (((p)->_flags & __SERR) != 0) 434 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 435 #define __sfileno(p) ((p)->_file) 436 437 #ifndef __lint__ 438 #if !defined(_REENTRANT) && !defined(_PTHREADS) 439 #define feof(p) __sfeof(p) 440 #define ferror(p) __sferror(p) 441 #define clearerr(p) __sclearerr(p) 442 443 #define getc(fp) __sgetc(fp) 444 #define putc(x, fp) __sputc(x, fp) 445 #endif /* !_REENTRANT && !_PTHREADS */ 446 #endif /* __lint__ */ 447 448 #define getchar() getc(stdin) 449 #define putchar(x) putc(x, stdout) 450 451 #if defined(_POSIX_C_SOURCE) || defined(_XOPEN_SOURCE) || \ 452 defined(_NETBSD_SOURCE) 453 #if !defined(_REENTRANT) && !defined(_PTHREADS) 454 #define fileno(p) __sfileno(p) 455 #endif /* !_REENTRANT && !_PTHREADS */ 456 #endif /* !_ANSI_SOURCE */ 457 458 #if (_POSIX_C_SOURCE - 0) >= 199506L || (_XOPEN_SOURCE - 0) >= 500 || \ 459 defined(_REENTRANT) || defined(_NETBSD_SOURCE) 460 #define getc_unlocked(fp) __sgetc(fp) 461 #define putc_unlocked(x, fp) __sputc(x, fp) 462 463 #define getchar_unlocked() getc_unlocked(stdin) 464 #define putchar_unlocked(x) putc_unlocked(x, stdout) 465 #endif /* _POSIX_C_SOURCE >= 199506 || _XOPEN_SOURCE >= 500 || _REENTRANT... */ 466 467 #endif /* _STDIO_H_ */ 468