2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
36 * @(#)stdio.h 8.5 (Berkeley) 4/29/95
37 * $FreeBSD: src/include/stdio.h,v 1.24.2.5 2002/11/09 08:07:20 imp Exp $
38 * $DragonFly: src/include/stdio.h,v 1.2 2003/06/17 04:25:56 dillon Exp $
44 #include <sys/cdefs.h>
45 #include <machine/ansi.h>
48 typedef _BSD_SIZE_T_ size_t;
56 typedef _BSD_OFF_T_ fpos_t;
58 #define _FSTDIO /* Define for new stdio with functions. */
61 * NB: to fit things in six character monocase externals, the stdio
62 * code uses the prefix `__s' for stdio objects, typically followed
63 * by a three-character attempt at a mnemonic.
73 * stdio state variables.
75 * The following always hold:
77 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
78 * _lbfsize is -_bf._size, else _lbfsize is 0
79 * if _flags&__SRD, _w is 0
80 * if _flags&__SWR, _r is 0
82 * This ensures that the getc and putc macros (or inline functions) never
83 * try to write or read from a file that is in `read' or `write' mode.
84 * (Moreover, they can, and do, automatically switch from read mode to
85 * write mode, and back, on "r+" and "w+" files.)
87 * _lbfsize is used only to make the inline line-buffered output stream
88 * code as compact as possible.
90 * _ub, _up, and _ur are used when ungetc() pushes back more characters
91 * than fit in the current _bf, or when ungetc() pushes back a character
92 * that does not match the previous one in _bf. When this happens,
93 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
94 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
96 * NB: see WARNING above before changing the layout of this structure!
98 typedef struct __sFILE {
99 unsigned char *_p; /* current position in (some) buffer */
100 int _r; /* read space left for getc() */
101 int _w; /* write space left for putc() */
102 short _flags; /* flags, below; this FILE is free if 0 */
103 short _file; /* fileno, if Unix descriptor, else -1 */
104 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
105 int _lbfsize; /* 0 or -_bf._size, for inline putc */
108 void *_cookie; /* cookie passed to io functions */
109 int (*_close) __P((void *));
110 int (*_read) __P((void *, char *, int));
111 fpos_t (*_seek) __P((void *, fpos_t, int));
112 int (*_write) __P((void *, const char *, int));
114 /* separate buffer for long sequences of ungetc() */
115 struct __sbuf _ub; /* ungetc buffer */
116 unsigned char *_up; /* saved _p when _p is doing ungetc data */
117 int _ur; /* saved _r when _r is counting ungetc data */
119 /* tricks to meet minimum requirements even when malloc() fails */
120 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
121 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
123 /* separate buffer for fgetln() when line crosses buffer boundary */
124 struct __sbuf _lb; /* buffer for fgetln() */
126 /* Unix stdio files get aligned to block boundaries on fseek() */
127 int _blksize; /* stat.st_blksize (may be != _bf._size) */
128 fpos_t _offset; /* current lseek offset (see WARNING) */
132 extern FILE *__stdinp, *__stdoutp, *__stderrp;
135 #define __SLBF 0x0001 /* line buffered */
136 #define __SNBF 0x0002 /* unbuffered */
137 #define __SRD 0x0004 /* OK to read */
138 #define __SWR 0x0008 /* OK to write */
139 /* RD and WR are never simultaneously asserted */
140 #define __SRW 0x0010 /* open for reading & writing */
141 #define __SEOF 0x0020 /* found EOF */
142 #define __SERR 0x0040 /* found error */
143 #define __SMBF 0x0080 /* _buf is from malloc */
144 #define __SAPP 0x0100 /* fdopen()ed in append mode */
145 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
146 #define __SOPT 0x0400 /* do fseek() optimization */
147 #define __SNPT 0x0800 /* do not do fseek() optimization */
148 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
149 #define __SMOD 0x2000 /* true => fgetln modified _p text */
150 #define __SALC 0x4000 /* allocate string space dynamically */
153 * The following three definitions are for ANSI C, which took them
154 * from System V, which brilliantly took internal interface macros and
155 * made them official arguments to setvbuf(), without renaming them.
156 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
158 * Although numbered as their counterparts above, the implementation
159 * does not rely on this.
161 #define _IOFBF 0 /* setvbuf should set fully buffered */
162 #define _IOLBF 1 /* setvbuf should set line buffered */
163 #define _IONBF 2 /* setvbuf should set unbuffered */
165 #define BUFSIZ 1024 /* size of buffer used by setbuf */
169 * FOPEN_MAX is a minimum maximum, and is the number of streams that
170 * stdio can provide without attempting to allocate further resources
171 * (which could fail). Do not use this for anything.
173 /* must be == _POSIX_STREAM_MAX <limits.h> */
174 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
175 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
177 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
179 #define P_tmpdir "/var/tmp/"
181 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
182 #define TMP_MAX 308915776
185 #define SEEK_SET 0 /* set file offset to offset */
188 #define SEEK_CUR 1 /* set file offset to current plus offset */
191 #define SEEK_END 2 /* set file offset to EOF plus offset */
194 #define stdin (__stdinp)
195 #define stdout (__stdoutp)
196 #define stderr (__stderrp)
199 * Functions defined in ANSI C standard.
202 void clearerr __P((FILE *));
203 int fclose __P((FILE *));
204 int feof __P((FILE *));
205 int ferror __P((FILE *));
206 int fflush __P((FILE *));
207 int fgetc __P((FILE *));
208 int fgetpos __P((FILE *, fpos_t *));
209 char *fgets __P((char *, int, FILE *));
210 FILE *fopen __P((const char *, const char *));
211 int fprintf __P((FILE *, const char *, ...));
212 int fputc __P((int, FILE *));
213 int fputs __P((const char *, FILE *));
214 size_t fread __P((void *, size_t, size_t, FILE *));
215 FILE *freopen __P((const char *, const char *, FILE *));
216 int fscanf __P((FILE *, const char *, ...));
217 int fseek __P((FILE *, long, int));
218 int fsetpos __P((FILE *, const fpos_t *));
219 long ftell __P((FILE *));
220 size_t fwrite __P((const void *, size_t, size_t, FILE *));
221 int getc __P((FILE *));
222 int getchar __P((void));
223 char *gets __P((char *));
224 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
225 extern __const int sys_nerr; /* perror(3) external variables */
226 extern __const char *__const sys_errlist[];
228 void perror __P((const char *));
229 int printf __P((const char *, ...));
230 int putc __P((int, FILE *));
231 int putchar __P((int));
232 int puts __P((const char *));
233 int remove __P((const char *));
234 int rename __P((const char *, const char *));
235 void rewind __P((FILE *));
236 int scanf __P((const char *, ...));
237 void setbuf __P((FILE *, char *));
238 int setvbuf __P((FILE *, char *, int, size_t));
239 int sprintf __P((char *, const char *, ...));
240 int sscanf __P((const char *, const char *, ...));
241 FILE *tmpfile __P((void));
242 char *tmpnam __P((char *));
243 int ungetc __P((int, FILE *));
244 int vfprintf __P((FILE *, const char *, _BSD_VA_LIST_));
245 int vprintf __P((const char *, _BSD_VA_LIST_));
246 int vsprintf __P((char *, const char *, _BSD_VA_LIST_));
250 * Functions defined in POSIX 1003.1.
253 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
256 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
259 char *ctermid __P((char *));
260 FILE *fdopen __P((int, const char *));
261 int fileno __P((FILE *));
262 int ftrylockfile __P((FILE *));
263 void flockfile __P((FILE *));
264 void funlockfile __P((FILE *));
266 #endif /* not ANSI */
269 * Portability hacks. See <sys/types.h>.
271 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
273 #ifndef _FTRUNCATE_DECLARED
274 #define _FTRUNCATE_DECLARED
275 int ftruncate __P((int, _BSD_OFF_T_));
277 #ifndef _LSEEK_DECLARED
278 #define _LSEEK_DECLARED
279 _BSD_OFF_T_ lseek __P((int, _BSD_OFF_T_, int));
281 #ifndef _MMAP_DECLARED
282 #define _MMAP_DECLARED
283 void *mmap __P((void *, size_t, int, int, int, _BSD_OFF_T_));
285 #ifndef _TRUNCATE_DECLARED
286 #define _TRUNCATE_DECLARED
287 int truncate __P((const char *, _BSD_OFF_T_));
290 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
293 * Routines that are purely local.
295 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
297 int asprintf __P((char **, const char *, ...)) __printflike(2, 3);
298 char *ctermid_r __P((char *));
299 char *fgetln __P((FILE *, size_t *));
300 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3
301 #define __ATTR_FORMAT_ARG __attribute__((__format_arg__(2)))
303 #define __ATTR_FORMAT_ARG
305 __const char *fmtcheck __P((const char *, const char *)) __ATTR_FORMAT_ARG;
306 int fpurge __P((FILE *));
307 int fseeko __P((FILE *, _BSD_OFF_T_, int));
308 _BSD_OFF_T_ ftello __P((FILE *));
309 int getw __P((FILE *));
310 int pclose __P((FILE *));
311 FILE *popen __P((const char *, const char *));
312 int putw __P((int, FILE *));
313 void setbuffer __P((FILE *, char *, int));
314 int setlinebuf __P((FILE *));
315 char *tempnam __P((const char *, const char *));
316 int snprintf __P((char *, size_t, const char *, ...)) __printflike(3, 4);
317 int vasprintf __P((char **, const char *, _BSD_VA_LIST_))
319 int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_))
321 int vscanf __P((const char *, _BSD_VA_LIST_)) __scanflike(1, 0);
322 int vsscanf __P((const char *, const char *, _BSD_VA_LIST_))
327 * This is a #define because the function is used internally and
328 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
329 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
331 #define vfscanf __svfscanf
334 * Stdio function-access interface.
337 FILE *funopen __P((const void *,
338 int (*)(void *, char *, int),
339 int (*)(void *, const char *, int),
340 fpos_t (*)(void *, fpos_t, int),
343 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
344 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
345 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
348 * Functions internal to the implementation.
351 int __srget __P((FILE *));
352 int __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_));
353 int __swbuf __P((int, FILE *));
357 * The __sfoo macros are here so that we can
358 * define function versions in the C library.
360 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
361 #if defined(__GNUC__) && defined(__STDC__)
362 static __inline int __sputc(int _c, FILE *_p) {
363 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
364 return (*_p->_p++ = _c);
366 return (__swbuf(_c, _p));
370 * This has been tuned to generate reasonable code on the vax using pcc.
372 #define __sputc(c, p) \
374 (p)->_w >= (p)->_lbfsize ? \
375 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
378 __swbuf((int)(c), p) : \
379 (*(p)->_p = (c), (int)*(p)->_p++))
382 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
383 #define __sferror(p) (((p)->_flags & __SERR) != 0)
384 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
385 #define __sfileno(p) ((p)->_file)
388 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
389 * B.8.2.7 for the rationale behind the *_unlocked() macros.
391 #define feof_unlocked(p) __sfeof(p)
392 #define ferror_unlocked(p) __sferror(p)
393 #define clearerr_unlocked(p) __sclearerr(p)
396 #define fileno_unlocked(p) __sfileno(p)
400 #define feof(p) feof_unlocked(p)
401 #define ferror(p) ferror_unlocked(p)
402 #define clearerr(p) clearerr_unlocked(p)
405 #define fileno(p) fileno_unlocked(p)
410 #define getc_unlocked(fp) __sgetc(fp)
411 #define putc_unlocked(x, fp) __sputc(x, fp)
413 void _flockfile_debug __P((FILE *, char *, int));
415 #define _FLOCKFILE(x) _flockfile_debug(x, __FILE__, __LINE__)
417 #define _FLOCKFILE(x) flockfile(x)
419 extern int __isthreaded;
420 static __inline int \
421 __getc_locked(FILE *_fp) \
426 _ret = getc_unlocked(_fp); \
431 static __inline int \
432 __putc_locked(int _x, FILE *_fp) \
437 _ret = putc_unlocked(_x, _fp); \
442 #define getc(fp) __getc_locked(fp)
443 #define putc(x, fp) __putc_locked(x, fp)
445 #define getc(fp) getc_unlocked(fp)
446 #define putc(x, fp) putc_unlocked(x, fp)
450 #define getchar() getc(stdin)
451 #define getchar_unlocked() getc_unlocked(stdin)
452 #define putchar(x) putc(x, stdout)
453 #define putchar_unlocked(x) putc_unlocked(x, stdout)
455 #endif /* !_STDIO_H_ */