xref: /freebsd/include/stdio.h (revision a220d00e74dd245b4fca59c5eca0c53963686325)
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$
38  */
39 
40 #ifndef	_STDIO_H_
41 #define	_STDIO_H_
42 
43 #include <sys/cdefs.h>
44 #include <machine/ansi.h>
45 
46 #ifdef	_BSD_SIZE_T_
47 typedef	_BSD_SIZE_T_	size_t;
48 #undef	_BSD_SIZE_T_
49 #endif
50 
51 #ifndef NULL
52 #define	NULL	0
53 #endif
54 
55 typedef	_BSD_OFF_T_	fpos_t;
56 
57 #define	_FSTDIO			/* Define for new stdio with functions. */
58 
59 /*
60  * NB: to fit things in six character monocase externals, the stdio
61  * code uses the prefix `__s' for stdio objects, typically followed
62  * by a three-character attempt at a mnemonic.
63  */
64 
65 /* stdio buffers */
66 struct __sbuf {
67 	unsigned char *_base;
68 	int	_size;
69 };
70 
71 /* hold a buncha junk that would grow the ABI */
72 struct __sFILEX;
73 
74 /*
75  * stdio state variables.
76  *
77  * The following always hold:
78  *
79  *	if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
80  *		_lbfsize is -_bf._size, else _lbfsize is 0
81  *	if _flags&__SRD, _w is 0
82  *	if _flags&__SWR, _r is 0
83  *
84  * This ensures that the getc and putc macros (or inline functions) never
85  * try to write or read from a file that is in `read' or `write' mode.
86  * (Moreover, they can, and do, automatically switch from read mode to
87  * write mode, and back, on "r+" and "w+" files.)
88  *
89  * _lbfsize is used only to make the inline line-buffered output stream
90  * code as compact as possible.
91  *
92  * _ub, _up, and _ur are used when ungetc() pushes back more characters
93  * than fit in the current _bf, or when ungetc() pushes back a character
94  * that does not match the previous one in _bf.  When this happens,
95  * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
96  * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
97  *
98  * NB: see WARNING above before changing the layout of this structure!
99  */
100 typedef	struct __sFILE {
101 	unsigned char *_p;	/* current position in (some) buffer */
102 	int	_r;		/* read space left for getc() */
103 	int	_w;		/* write space left for putc() */
104 	short	_flags;		/* flags, below; this FILE is free if 0 */
105 	short	_file;		/* fileno, if Unix descriptor, else -1 */
106 	struct	__sbuf _bf;	/* the buffer (at least 1 byte, if !NULL) */
107 	int	_lbfsize;	/* 0 or -_bf._size, for inline putc */
108 
109 	/* operations */
110 	void	*_cookie;	/* cookie passed to io functions */
111 	int	(*_close) __P((void *));
112 	int	(*_read)  __P((void *, char *, int));
113 	fpos_t	(*_seek)  __P((void *, fpos_t, int));
114 	int	(*_write) __P((void *, const char *, int));
115 
116 	/* separate buffer for long sequences of ungetc() */
117 	struct	__sbuf _ub;	/* ungetc buffer */
118 	struct __sFILEX *_extra; /* additions to FILE to not break ABI */
119 	int	_ur;		/* saved _r when _r is counting ungetc data */
120 
121 	/* tricks to meet minimum requirements even when malloc() fails */
122 	unsigned char _ubuf[3];	/* guarantee an ungetc() buffer */
123 	unsigned char _nbuf[1];	/* guarantee a getc() buffer */
124 
125 	/* separate buffer for fgetln() when line crosses buffer boundary */
126 	struct	__sbuf _lb;	/* buffer for fgetln() */
127 
128 	/* Unix stdio files get aligned to block boundaries on fseek() */
129 	int	_blksize;	/* stat.st_blksize (may be != _bf._size) */
130 	fpos_t	_offset;	/* current lseek offset (see WARNING) */
131 } FILE;
132 
133 __BEGIN_DECLS
134 extern FILE __sF[];
135 extern FILE *__stdinp;
136 extern FILE *__stdoutp;
137 extern FILE *__stderrp;
138 __END_DECLS
139 
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 */
156 #define	__SIGN	0x8000		/* ignore this file in _fwalk */
157 
158 /*
159  * The following three definitions are for ANSI C, which took them
160  * from System V, which brilliantly took internal interface macros and
161  * made them official arguments to setvbuf(), without renaming them.
162  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
163  *
164  * Although numbered as their counterparts above, the implementation
165  * does not rely on this.
166  */
167 #define	_IOFBF	0		/* setvbuf should set fully buffered */
168 #define	_IOLBF	1		/* setvbuf should set line buffered */
169 #define	_IONBF	2		/* setvbuf should set unbuffered */
170 
171 #define	BUFSIZ	1024		/* size of buffer used by setbuf */
172 #define	EOF	(-1)
173 
174 /*
175  * FOPEN_MAX is a minimum maximum, and is the number of streams that
176  * stdio can provide without attempting to allocate further resources
177  * (which could fail).  Do not use this for anything.
178  */
179 				/* must be == _POSIX_STREAM_MAX <limits.h> */
180 #define	FOPEN_MAX	20	/* must be <= OPEN_MAX <sys/syslimits.h> */
181 #define	FILENAME_MAX	1024	/* must be <= PATH_MAX <sys/syslimits.h> */
182 
183 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
184 #ifndef _ANSI_SOURCE
185 #define	P_tmpdir	"/var/tmp/"
186 #endif
187 #define	L_tmpnam	1024	/* XXX must be == PATH_MAX */
188 #define	TMP_MAX		308915776
189 
190 #ifndef SEEK_SET
191 #define	SEEK_SET	0	/* set file offset to offset */
192 #endif
193 #ifndef SEEK_CUR
194 #define	SEEK_CUR	1	/* set file offset to current plus offset */
195 #endif
196 #ifndef SEEK_END
197 #define	SEEK_END	2	/* set file offset to EOF plus offset */
198 #endif
199 
200 /* To be removed by 5.0-RELEASE */
201 #if (defined(__i386__) || defined(__alpha__)) && defined(_OLD_STDIO)
202 #define	stdin	(&__sF[0])
203 #define	stdout	(&__sF[1])
204 #define	stderr	(&__sF[2])
205 #else
206 #define	stdin	__stdinp
207 #define	stdout	__stdoutp
208 #define	stderr	__stderrp
209 #endif
210 
211 /*
212  * Functions defined in ANSI C standard.
213  */
214 __BEGIN_DECLS
215 void	 clearerr __P((FILE *));
216 int	 fclose __P((FILE *));
217 int	 feof __P((FILE *));
218 int	 ferror __P((FILE *));
219 int	 fflush __P((FILE *));
220 int	 fgetc __P((FILE *));
221 int	 fgetpos __P((FILE *, fpos_t *));
222 char	*fgets __P((char *, int, FILE *));
223 FILE	*fopen __P((const char *, const char *));
224 int	 fprintf __P((FILE *, const char *, ...));
225 int	 fputc __P((int, FILE *));
226 int	 fputs __P((const char *, FILE *));
227 size_t	 fread __P((void *, size_t, size_t, FILE *));
228 FILE	*freopen __P((const char *, const char *, FILE *));
229 int	 fscanf __P((FILE *, const char *, ...));
230 int	 fseek __P((FILE *, long, int));
231 int	 fsetpos __P((FILE *, const fpos_t *));
232 long	 ftell __P((FILE *));
233 size_t	 fwrite __P((const void *, size_t, size_t, FILE *));
234 int	 getc __P((FILE *));
235 int	 getchar __P((void));
236 char	*gets __P((char *));
237 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
238 extern __const int sys_nerr;		/* perror(3) external variables */
239 extern __const char *__const sys_errlist[];
240 #endif
241 void	 perror __P((const char *));
242 int	 printf __P((const char *, ...));
243 int	 putc __P((int, FILE *));
244 int	 putchar __P((int));
245 int	 puts __P((const char *));
246 int	 remove __P((const char *));
247 int	 rename  __P((const char *, const char *));
248 void	 rewind __P((FILE *));
249 int	 scanf __P((const char *, ...));
250 void	 setbuf __P((FILE *, char *));
251 int	 setvbuf __P((FILE *, char *, int, size_t));
252 int	 sprintf __P((char *, const char *, ...));
253 int	 sscanf __P((const char *, const char *, ...));
254 FILE	*tmpfile __P((void));
255 char	*tmpnam __P((char *));
256 int	 ungetc __P((int, FILE *));
257 int	 vfprintf __P((FILE *, const char *, _BSD_VA_LIST_));
258 int	 vprintf __P((const char *, _BSD_VA_LIST_));
259 int	 vsprintf __P((char *, const char *, _BSD_VA_LIST_));
260 __END_DECLS
261 
262 /*
263  * Functions defined in POSIX 1003.1.
264  */
265 #ifndef _ANSI_SOURCE
266 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
267 #define	L_cuserid	17
268 
269 #define	L_ctermid	1024	/* size for ctermid(3); PATH_MAX */
270 
271 __BEGIN_DECLS
272 char	*ctermid __P((char *));
273 FILE	*fdopen __P((int, const char *));
274 int	 fileno __P((FILE *));
275 int	 ftrylockfile __P((FILE *));
276 void	 flockfile __P((FILE *));
277 void	 funlockfile __P((FILE *));
278 __END_DECLS
279 #endif /* not ANSI */
280 
281 /*
282  * Portability hacks.  See <sys/types.h>.
283  */
284 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
285 __BEGIN_DECLS
286 #ifndef _FTRUNCATE_DECLARED
287 #define	_FTRUNCATE_DECLARED
288 int	 ftruncate __P((int, _BSD_OFF_T_));
289 #endif
290 #ifndef _LSEEK_DECLARED
291 #define	_LSEEK_DECLARED
292 _BSD_OFF_T_ lseek __P((int, _BSD_OFF_T_, int));
293 #endif
294 #ifndef _MMAP_DECLARED
295 #define	_MMAP_DECLARED
296 void	*mmap __P((void *, size_t, int, int, int, _BSD_OFF_T_));
297 #endif
298 #ifndef _TRUNCATE_DECLARED
299 #define	_TRUNCATE_DECLARED
300 int	 truncate __P((const char *, _BSD_OFF_T_));
301 #endif
302 __END_DECLS
303 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
304 
305 /*
306  * Routines that are purely local.
307  */
308 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
309 __BEGIN_DECLS
310 int	 asprintf __P((char **, const char *, ...)) __printflike(2, 3);
311 char	*ctermid_r __P((char *));
312 __const char *fmtcheck __P((const char *, const char *))
313 	__attribute__((__format_arg__(2)));
314 char	*fgetln __P((FILE *, size_t *));
315 int	 fpurge __P((FILE *));
316 int	 fseeko __P((FILE *, _BSD_OFF_T_, int));
317 _BSD_OFF_T_ ftello __P((FILE *));
318 int	 getw __P((FILE *));
319 int	 pclose __P((FILE *));
320 FILE	*popen __P((const char *, const char *));
321 int	 putw __P((int, FILE *));
322 void	 setbuffer __P((FILE *, char *, int));
323 int	 setlinebuf __P((FILE *));
324 char	*tempnam __P((const char *, const char *));
325 int	 snprintf __P((char *, size_t, const char *, ...)) __printflike(3, 4);
326 int	 vasprintf __P((char **, const char *, _BSD_VA_LIST_))
327 	    __printflike(2, 0);
328 int	 vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_))
329 	    __printflike(3, 0);
330 int	 vscanf __P((const char *, _BSD_VA_LIST_)) __scanflike(1, 0);
331 int	 vsscanf __P((const char *, const char *, _BSD_VA_LIST_))
332 	    __scanflike(2, 0);
333 __END_DECLS
334 
335 /*
336  * This is a #define because the function is used internally and
337  * (unlike vfscanf) the name __vfscanf is guaranteed not to collide
338  * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
339  */
340 #define	 vfscanf	__vfscanf
341 
342 /*
343  * Stdio function-access interface.
344  */
345 __BEGIN_DECLS
346 FILE	*funopen __P((const void *,
347 	    int (*)(void *, char *, int),
348 	    int (*)(void *, const char *, int),
349 	    fpos_t (*)(void *, fpos_t, int),
350 	    int (*)(void *)));
351 __END_DECLS
352 #define	fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
353 #define	fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
354 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
355 
356 /*
357  * Functions internal to the implementation.
358  */
359 __BEGIN_DECLS
360 int	__srget __P((FILE *));
361 int	__vfscanf __P((FILE *, const char *, _BSD_VA_LIST_));
362 int	__svfscanf __P((FILE *, const char *, _BSD_VA_LIST_));
363 int	__swbuf __P((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__) && defined(__STDC__)
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 /*
398  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
399  * B.8.2.7 for the rationale behind the *_unlocked() macros.
400  */
401 #define	feof_unlocked(p)	__sfeof(p)
402 #define	ferror_unlocked(p)	__sferror(p)
403 #define	clearerr_unlocked(p)	__sclearerr(p)
404 
405 #ifndef _ANSI_SOURCE
406 #define	fileno_unlocked(p)	__sfileno(p)
407 #endif
408 
409 #define	getc_unlocked(fp)	__sgetc(fp)
410 #define	putc_unlocked(x, fp)	__sputc(x, fp)
411 
412 #define	getchar_unlocked()	getc_unlocked(stdin)
413 #define	putchar_unlocked(x)	putc_unlocked(x, stdout)
414 
415 #endif /* !_STDIO_H_ */
416