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