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.6 2005/01/31 22:28:58 dillon Exp $
44 #include <sys/cdefs.h>
45 #ifndef _SYS_STDINT_H_
46 #include <sys/stdint.h>
48 #ifndef _MACHINE_STDARG_H_
49 #include <machine/stdarg.h>
52 #ifndef _SIZE_T_DECLARED
53 #define _SIZE_T_DECLARED
54 typedef __size_t size_t;
61 typedef __off_t fpos_t;
63 #define _FSTDIO /* Define for new stdio with functions. */
66 * NB: to fit things in six character monocase externals, the stdio
67 * code uses the prefix `__s' for stdio objects, typically followed
68 * by a three-character attempt at a mnemonic.
78 * stdio state variables.
80 * The following always hold:
82 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
83 * _lbfsize is -_bf._size, else _lbfsize is 0
84 * if _flags&__SRD, _w is 0
85 * if _flags&__SWR, _r is 0
87 * This ensures that the getc and putc macros (or inline functions) never
88 * try to write or read from a file that is in `read' or `write' mode.
89 * (Moreover, they can, and do, automatically switch from read mode to
90 * write mode, and back, on "r+" and "w+" files.)
92 * _lbfsize is used only to make the inline line-buffered output stream
93 * code as compact as possible.
95 * _ub, _up, and _ur are used when ungetc() pushes back more characters
96 * than fit in the current _bf, or when ungetc() pushes back a character
97 * that does not match the previous one in _bf. When this happens,
98 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
99 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
101 * NB: see WARNING above before changing the layout of this structure!
103 typedef 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 */
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);
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 */
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 */
128 /* separate buffer for fgetln() when line crosses buffer boundary */
129 struct __sbuf _lb; /* buffer for fgetln() */
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 (see WARNING) */
137 extern FILE *__stdinp, *__stdoutp, *__stderrp;
140 #define __SLBF 0x0001 /* line buffered */
141 #define __SNBF 0x0002 /* unbuffered */
142 #define __SRD 0x0004 /* OK to read */
143 #define __SWR 0x0008 /* OK to write */
144 /* RD and WR are never simultaneously asserted */
145 #define __SRW 0x0010 /* open for reading & writing */
146 #define __SEOF 0x0020 /* found EOF */
147 #define __SERR 0x0040 /* found error */
148 #define __SMBF 0x0080 /* _buf is from malloc */
149 #define __SAPP 0x0100 /* fdopen()ed in append mode */
150 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
151 #define __SOPT 0x0400 /* do fseek() optimization */
152 #define __SNPT 0x0800 /* do not do fseek() optimization */
153 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
154 #define __SMOD 0x2000 /* true => fgetln modified _p text */
155 #define __SALC 0x4000 /* allocate string space dynamically */
158 * The following three definitions are for ANSI C, which took them
159 * from System V, which brilliantly took internal interface macros and
160 * made them official arguments to setvbuf(), without renaming them.
161 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
163 * Although numbered as their counterparts above, the implementation
164 * does not rely on this.
166 #define _IOFBF 0 /* setvbuf should set fully buffered */
167 #define _IOLBF 1 /* setvbuf should set line buffered */
168 #define _IONBF 2 /* setvbuf should set unbuffered */
170 #define BUFSIZ 1024 /* size of buffer used by setbuf */
174 * FOPEN_MAX is a minimum maximum, and is the number of streams that
175 * stdio can provide without attempting to allocate further resources
176 * (which could fail). Do not use this for anything.
178 /* must be == _POSIX_STREAM_MAX <limits.h> */
179 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
180 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
182 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
184 #define P_tmpdir "/var/tmp/"
186 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
187 #define TMP_MAX 308915776
190 #define SEEK_SET 0 /* set file offset to offset */
193 #define SEEK_CUR 1 /* set file offset to current plus offset */
196 #define SEEK_END 2 /* set file offset to EOF plus offset */
199 #define stdin (__stdinp)
200 #define stdout (__stdoutp)
201 #define stderr (__stderrp)
204 * Functions defined in ANSI C standard.
207 void clearerr (FILE *);
213 int fgetpos (FILE *, fpos_t *);
214 char *fgets (char *, int, FILE *);
215 FILE *fopen (const char *, const char *);
216 int fprintf (FILE *, const char *, ...);
217 int fputc (int, FILE *);
218 int fputs (const char *, FILE *);
219 size_t fread (void *, size_t, size_t, FILE *);
220 FILE *freopen (const char *, const char *, FILE *);
221 int fscanf (FILE *, const char *, ...);
222 int fseek (FILE *, long, int);
223 int fsetpos (FILE *, const fpos_t *);
225 size_t fwrite (const void *, size_t, size_t, FILE *);
229 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
230 extern __const int sys_nerr; /* perror(3) external variables */
231 extern __const char *__const sys_errlist[];
233 void perror (const char *);
234 int printf (const char *, ...);
235 int putc (int, FILE *);
237 int puts (const char *);
238 int remove (const char *);
239 int rename (const char *, const char *);
240 void rewind (FILE *);
241 int scanf (const char *, ...);
242 void setbuf (FILE *, char *);
243 int setvbuf (FILE *, char *, int, size_t);
244 int sprintf (char *, const char *, ...);
245 int sscanf (const char *, const char *, ...);
246 FILE *tmpfile (void);
247 char *tmpnam (char *);
248 int ungetc (int, FILE *);
249 int vfprintf (FILE *, const char *, __va_list);
250 int vprintf (const char *, __va_list);
251 int vsprintf (char *, const char *, __va_list);
255 * Functions defined in POSIX 1003.1.
258 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
261 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
264 char *ctermid (char *);
265 FILE *fdopen (int, const char *);
267 int ftrylockfile (FILE *);
268 void flockfile (FILE *);
269 void funlockfile (FILE *);
271 #endif /* not ANSI */
274 * Portability hacks. See <sys/types.h>.
276 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
278 #ifndef _FTRUNCATE_DECLARED
279 #define _FTRUNCATE_DECLARED
280 int ftruncate (int, __off_t);
282 #ifndef _LSEEK_DECLARED
283 #define _LSEEK_DECLARED
284 __off_t lseek (int, __off_t, int);
286 #ifndef _MMAP_DECLARED
287 #define _MMAP_DECLARED
288 void *mmap (void *, size_t, int, int, int, __off_t);
290 #ifndef _TRUNCATE_DECLARED
291 #define _TRUNCATE_DECLARED
292 int truncate (const char *, __off_t);
295 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
298 * Routines that are purely local.
300 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
302 int asprintf (char **, const char *, ...) __printflike(2, 3);
303 char *ctermid_r (char *);
304 char *fgetln (FILE *, size_t *);
305 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3
306 #define __ATTR_FORMAT_ARG __attribute__((__format_arg__(2)))
308 #define __ATTR_FORMAT_ARG
310 __const char *fmtcheck (const char *, const char *) __ATTR_FORMAT_ARG;
312 int fseeko (FILE *, __off_t, int);
313 __off_t ftello (FILE *);
316 FILE *popen (const char *, const char *);
317 int putw (int, FILE *);
318 void setbuffer (FILE *, char *, int);
319 int setlinebuf (FILE *);
320 char *tempnam (const char *, const char *);
321 int snprintf (char *, size_t, const char *, ...) __printflike(3, 4);
322 int vasprintf (char **, const char *, __va_list)
324 int vsnprintf (char *, size_t, const char *, __va_list)
326 int vscanf (const char *, __va_list) __scanflike(1, 0);
327 int vsscanf (const char *, const char *, __va_list)
332 * This is a #define because the function is used internally and
333 * (unlike vfscanf) the name __vfscanf is guaranteed not to collide
334 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
336 #define vfscanf __vfscanf
339 * Stdio function-access interface.
342 FILE *funopen (const void *,
343 int (*)(void *, char *, int),
344 int (*)(void *, const char *, int),
345 fpos_t (*)(void *, fpos_t, int),
348 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
349 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
350 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
353 * Functions internal to the implementation.
356 int __srget (FILE *);
357 int __vfscanf (FILE *, const char *, __va_list);
358 int __svfscanf (FILE *, const char *, __va_list);
359 int __swbuf (int, FILE *);
363 * The __sfoo macros are here so that we can
364 * define function versions in the C library.
366 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
367 #if defined(__GNUC__) && defined(__STDC__)
368 static __inline int __sputc(int _c, FILE *_p) {
369 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
370 return (*_p->_p++ = _c);
372 return (__swbuf(_c, _p));
376 * This has been tuned to generate reasonable code on the vax using pcc.
378 #define __sputc(c, p) \
380 (p)->_w >= (p)->_lbfsize ? \
381 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
384 __swbuf((int)(c), p) : \
385 (*(p)->_p = (c), (int)*(p)->_p++))
388 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
389 #define __sferror(p) (((p)->_flags & __SERR) != 0)
390 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
391 #define __sfileno(p) ((p)->_file)
394 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
395 * B.8.2.7 for the rationale behind the *_unlocked() macros.
397 #define feof_unlocked(p) __sfeof(p)
398 #define ferror_unlocked(p) __sferror(p)
399 #define clearerr_unlocked(p) __sclearerr(p)
402 #define fileno_unlocked(p) __sfileno(p)
405 #define getc_unlocked(fp) __sgetc(fp)
406 #define putc_unlocked(x, fp) __sputc(x, fp)
408 #define getchar_unlocked() getc_unlocked(stdin)
409 #define putchar_unlocked(x) putc_unlocked(x, stdout)
411 #endif /* !_STDIO_H_ */