1/*- 2 * Copyright (c) 1990, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Chris Torek. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)stdio.h 8.5 (Berkeley) 4/29/95
|
37 * $FreeBSD: head/include/stdio.h 178287 2008-04-17 22:17:54Z jhb $
|
37 * $FreeBSD: head/include/stdio.h 178721 2008-05-02 15:25:07Z jhb $ |
38 */ 39 40#ifndef _STDIO_H_ 41#define _STDIO_H_ 42 43#include <sys/cdefs.h> 44#include <sys/_null.h> 45#include <sys/_types.h> 46 47typedef __off_t fpos_t; 48 49#ifndef _SIZE_T_DECLARED 50typedef __size_t size_t; 51#define _SIZE_T_DECLARED 52#endif 53 54#if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE 55#ifndef _VA_LIST_DECLARED 56typedef __va_list va_list; 57#define _VA_LIST_DECLARED 58#endif 59#endif 60 61#define _FSTDIO /* Define for new stdio with functions. */ 62
|
63/*
64 * NB: to fit things in six character monocase externals, the stdio
65 * code uses the prefix `__s' for stdio objects, typically followed
66 * by a three-character attempt at a mnemonic.
67 */
|
63struct __sFILE; 64typedef struct __sFILE FILE; |
65
|
69/* stdio buffers */
70struct __sbuf {
71 unsigned char *_base;
72 int _size;
73};
74
75/*
76 * stdio state variables.
77 *
78 * The following always hold:
79 *
80 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
81 * _lbfsize is -_bf._size, else _lbfsize is 0
82 * if _flags&__SRD, _w is 0
83 * if _flags&__SWR, _r is 0
84 *
85 * This ensures that the getc and putc macros (or inline functions) never
86 * try to write or read from a file that is in `read' or `write' mode.
87 * (Moreover, they can, and do, automatically switch from read mode to
88 * write mode, and back, on "r+" and "w+" files.)
89 *
90 * _lbfsize is used only to make the inline line-buffered output stream
91 * code as compact as possible.
92 *
93 * _ub, _up, and _ur are used when ungetc() pushes back more characters
94 * than fit in the current _bf, or when ungetc() pushes back a character
95 * that does not match the previous one in _bf. When this happens,
96 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
97 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
98 *
99 * Certain members of __sFILE are accessed directly via macros or
100 * inline functions. To preserve ABI compat, these members must not
101 * be disturbed. These members are marked below with (*).
102 */
103typedef struct __sFILE {
104 unsigned char *_p; /* (*) current position in (some) buffer */
105 int _r; /* (*) read space left for getc() */
106 int _w; /* (*) write space left for putc() */
107 short _flags; /* (*) flags, below; this FILE is free if 0 */
108 short _file; /* (*) fileno, if Unix descriptor, else -1 */
109 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
110 int _lbfsize; /* (*) 0 or -_bf._size, for inline putc */
111
112 /* operations */
113 void *_cookie; /* cookie passed to io functions */
114 int (*_close)(void *);
115 int (*_read)(void *, char *, int);
116 fpos_t (*_seek)(void *, fpos_t, int);
117 int (*_write)(void *, const char *, int);
118
119 /* separate buffer for long sequences of ungetc() */
120 struct __sbuf _ub; /* ungetc buffer */
121 unsigned char *_up; /* saved _p when _p is doing ungetc data */
122 int _ur; /* saved _r when _r is counting ungetc data */
123
124 /* tricks to meet minimum requirements even when malloc() fails */
125 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
126 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
127
128 /* separate buffer for fgetln() when line crosses buffer boundary */
129 struct __sbuf _lb; /* buffer for fgetln() */
130
131 /* Unix stdio files get aligned to block boundaries on fseek() */
132 int _blksize; /* stat.st_blksize (may be != _bf._size) */
133 fpos_t _offset; /* current lseek offset */
134
135 struct pthread_mutex *_fl_mutex; /* used for MT-safety */
136 struct pthread *_fl_owner; /* current owner */
137 int _fl_count; /* recursive lock count */
138 int _orientation; /* orientation for fwide() */
139 __mbstate_t _mbstate; /* multibyte conversion state */
140} FILE;
141
|
66#ifndef _STDSTREAM_DECLARED 67__BEGIN_DECLS 68extern FILE *__stdinp; 69extern FILE *__stdoutp; 70extern FILE *__stderrp; 71__END_DECLS 72#define _STDSTREAM_DECLARED 73#endif 74
|
151#define __SLBF 0x0001 /* line buffered */
152#define __SNBF 0x0002 /* unbuffered */
153#define __SRD 0x0004 /* OK to read */
154#define __SWR 0x0008 /* OK to write */
155 /* RD and WR are never simultaneously asserted */
156#define __SRW 0x0010 /* open for reading & writing */
157#define __SEOF 0x0020 /* found EOF */
158#define __SERR 0x0040 /* found error */
159#define __SMBF 0x0080 /* _buf is from malloc */
160#define __SAPP 0x0100 /* fdopen()ed in append mode */
161#define __SSTR 0x0200 /* this is an sprintf/snprintf string */
162#define __SOPT 0x0400 /* do fseek() optimization */
163#define __SNPT 0x0800 /* do not do fseek() optimization */
164#define __SOFF 0x1000 /* set iff _offset is in fact correct */
165#define __SMOD 0x2000 /* true => fgetln modified _p text */
166#define __SALC 0x4000 /* allocate string space dynamically */
167#define __SIGN 0x8000 /* ignore this file in _fwalk */
168
|
75/* 76 * The following three definitions are for ANSI C, which took them 77 * from System V, which brilliantly took internal interface macros and 78 * made them official arguments to setvbuf(), without renaming them. 79 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
|
174 *
175 * Although numbered as their counterparts above, the implementation
176 * does not rely on this.
|
80 */ 81#define _IOFBF 0 /* setvbuf should set fully buffered */ 82#define _IOLBF 1 /* setvbuf should set line buffered */ 83#define _IONBF 2 /* setvbuf should set unbuffered */ 84 85#define BUFSIZ 1024 /* size of buffer used by setbuf */ 86#define EOF (-1) 87 88/* 89 * FOPEN_MAX is a minimum maximum, and is the number of streams that 90 * stdio can provide without attempting to allocate further resources 91 * (which could fail). Do not use this for anything. 92 */ 93 /* must be == _POSIX_STREAM_MAX <limits.h> */ 94#ifndef FOPEN_MAX 95#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 96#endif 97#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 98 99/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 100#if __XSI_VISIBLE 101#define P_tmpdir "/var/tmp/" 102#endif 103#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 104#define TMP_MAX 308915776 105 106#ifndef SEEK_SET 107#define SEEK_SET 0 /* set file offset to offset */ 108#endif 109#ifndef SEEK_CUR 110#define SEEK_CUR 1 /* set file offset to current plus offset */ 111#endif 112#ifndef SEEK_END 113#define SEEK_END 2 /* set file offset to EOF plus offset */ 114#endif 115 116#define stdin __stdinp 117#define stdout __stdoutp 118#define stderr __stderrp 119 120__BEGIN_DECLS 121/* 122 * Functions defined in ANSI C standard. 123 */ 124void clearerr(FILE *); 125int fclose(FILE *); 126int feof(FILE *); 127int ferror(FILE *); 128int fflush(FILE *); 129int fgetc(FILE *); 130int fgetpos(FILE * __restrict, fpos_t * __restrict); 131char *fgets(char * __restrict, int, FILE * __restrict); 132FILE *fopen(const char * __restrict, const char * __restrict); 133int fprintf(FILE * __restrict, const char * __restrict, ...); 134int fputc(int, FILE *); 135int fputs(const char * __restrict, FILE * __restrict); 136size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 137FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict); 138int fscanf(FILE * __restrict, const char * __restrict, ...); 139int fseek(FILE *, long, int); 140int fsetpos(FILE *, const fpos_t *); 141long ftell(FILE *); 142size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 143int getc(FILE *); 144int getchar(void); 145char *gets(char *); 146void perror(const char *); 147int printf(const char * __restrict, ...); 148int putc(int, FILE *); 149int putchar(int); 150int puts(const char *); 151int remove(const char *); 152int rename(const char *, const char *); 153void rewind(FILE *); 154int scanf(const char * __restrict, ...); 155void setbuf(FILE * __restrict, char * __restrict); 156int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 157int sprintf(char * __restrict, const char * __restrict, ...); 158int sscanf(const char * __restrict, const char * __restrict, ...); 159FILE *tmpfile(void); 160char *tmpnam(char *); 161int ungetc(int, FILE *); 162int vfprintf(FILE * __restrict, const char * __restrict, 163 __va_list); 164int vprintf(const char * __restrict, __va_list); 165int vsprintf(char * __restrict, const char * __restrict, 166 __va_list); 167 168#if __ISO_C_VISIBLE >= 1999 169int snprintf(char * __restrict, size_t, const char * __restrict, 170 ...) __printflike(3, 4); 171int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 172 __scanflike(2, 0); 173int vscanf(const char * __restrict, __va_list) __scanflike(1, 0); 174int vsnprintf(char * __restrict, size_t, const char * __restrict, 175 __va_list) __printflike(3, 0); 176int vsscanf(const char * __restrict, const char * __restrict, __va_list) 177 __scanflike(2, 0); 178#endif 179 180/* 181 * Functions defined in all versions of POSIX 1003.1. 182 */ 183#if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 184/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */ 185#define L_cuserid 17 /* legacy */ 186#endif 187 188#if __POSIX_VISIBLE 189#define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 190 191char *ctermid(char *); 192FILE *fdopen(int, const char *); 193int fileno(FILE *); 194#endif /* __POSIX_VISIBLE */ 195 196#if __POSIX_VISIBLE >= 199209 197int pclose(FILE *); 198FILE *popen(const char *, const char *); 199#endif 200 201#if __POSIX_VISIBLE >= 199506 202int ftrylockfile(FILE *); 203void flockfile(FILE *); 204void funlockfile(FILE *); 205 206/*
|
304 * These are normally used through macros as defined below, but POSIX
305 * requires functions as well.
|
207 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 208 * B.8.2.7 for the rationale behind the *_unlocked() functions. |
209 */ 210int getc_unlocked(FILE *); 211int getchar_unlocked(void); 212int putc_unlocked(int, FILE *); 213int putchar_unlocked(int); 214#endif 215#if __BSD_VISIBLE 216void clearerr_unlocked(FILE *); 217int feof_unlocked(FILE *); 218int ferror_unlocked(FILE *); 219int fileno_unlocked(FILE *); 220#endif 221 222#if __POSIX_VISIBLE >= 200112 223int fseeko(FILE *, __off_t, int); 224__off_t ftello(FILE *); 225#endif 226 227#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 228int getw(FILE *); 229int putw(int, FILE *); 230#endif /* BSD or X/Open before issue 6 */ 231 232#if __XSI_VISIBLE 233char *tempnam(const char *, const char *); 234#endif 235 236/* 237 * Routines that are purely local. 238 */ 239#if __BSD_VISIBLE 240int asprintf(char **, const char *, ...) __printflike(2, 3); 241char *ctermid_r(char *); 242void fcloseall(void); 243char *fgetln(FILE *, size_t *); 244__const char *fmtcheck(const char *, const char *) __format_arg(2); 245int fpurge(FILE *); 246void setbuffer(FILE *, char *, int); 247int setlinebuf(FILE *); 248int vasprintf(char **, const char *, __va_list) 249 __printflike(2, 0); 250 251/* 252 * The system error table contains messages for the first sys_nerr 253 * positive errno values. Use strerror() or strerror_r() from <string.h> 254 * instead. 255 */ 256extern __const int sys_nerr; 257extern __const char *__const sys_errlist[]; 258 259/* 260 * Stdio function-access interface. 261 */ 262FILE *funopen(const void *, 263 int (*)(void *, char *, int), 264 int (*)(void *, const char *, int), 265 fpos_t (*)(void *, fpos_t, int), 266 int (*)(void *)); 267#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 268#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 269 270/* 271 * Portability hacks. See <sys/types.h>. 272 */ 273#ifndef _FTRUNCATE_DECLARED 274#define _FTRUNCATE_DECLARED 275int ftruncate(int, __off_t); 276#endif 277#ifndef _LSEEK_DECLARED 278#define _LSEEK_DECLARED 279__off_t lseek(int, __off_t, int); 280#endif 281#ifndef _MMAP_DECLARED 282#define _MMAP_DECLARED 283void *mmap(void *, size_t, int, int, int, __off_t); 284#endif 285#ifndef _TRUNCATE_DECLARED 286#define _TRUNCATE_DECLARED 287int truncate(const char *, __off_t); 288#endif 289#endif /* __BSD_VISIBLE */ 290
|
388/*
389 * Functions internal to the implementation.
390 */
391int __srget(FILE *);
392int __swbuf(int, FILE *);
393
394/*
395 * The __sfoo macros are here so that we can
396 * define function versions in the C library.
397 */
398#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
399#if defined(__GNUC__) && defined(__STDC__)
400static __inline int __sputc(int _c, FILE *_p) {
401 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
402 return (*_p->_p++ = _c);
403 else
404 return (__swbuf(_c, _p));
405}
406#else
407/*
408 * This has been tuned to generate reasonable code on the vax using pcc.
409 */
410#define __sputc(c, p) \
411 (--(p)->_w < 0 ? \
412 (p)->_w >= (p)->_lbfsize ? \
413 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
414 (int)*(p)->_p++ : \
415 __swbuf('\n', p) : \
416 __swbuf((int)(c), p) : \
417 (*(p)->_p = (c), (int)*(p)->_p++))
418#endif
419
420#define __sfeof(p) (((p)->_flags & __SEOF) != 0)
421#define __sferror(p) (((p)->_flags & __SERR) != 0)
422#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
423#define __sfileno(p) ((p)->_file)
424
425extern int __isthreaded;
426
427#define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
428#define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
429#define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
430
431#if __POSIX_VISIBLE
432#define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
433#endif
434
435#define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
436#define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
437
438#define getchar() getc(stdin)
439#define putchar(x) putc(x, stdout)
440
|
291#if __BSD_VISIBLE
|
442/*
443 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
444 * B.8.2.7 for the rationale behind the *_unlocked() macros.
445 */
446#define feof_unlocked(p) __sfeof(p)
447#define ferror_unlocked(p) __sferror(p)
448#define clearerr_unlocked(p) __sclearerr(p)
449#define fileno_unlocked(p) __sfileno(p)
450#endif
451#if __POSIX_VISIBLE >= 199506
452#define getc_unlocked(fp) __sgetc(fp)
453#define putc_unlocked(x, fp) __sputc(x, fp)
454
455#define getchar_unlocked() getc_unlocked(stdin)
456#define putchar_unlocked(x) putc_unlocked(x, stdout)
457#endif
458
459#if __BSD_VISIBLE
|
292int renameat(int, const char *, int, const char *); 293#endif 294__END_DECLS 295#endif /* !_STDIO_H_ */
|