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