stdio.h revision 178755 
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: head/include/stdio.h 178755 2008-05-03 23:36:00Z marcel $
38 */
39
40#ifndef	_STDIO_H_
41#define	_STDIO_H_
42
43#include <sys/cdefs.h>
44#include <sys/_null.h>
45#include <sys/_types.h>
46
47typedef	__off_t		fpos_t;
48
49#ifndef _SIZE_T_DECLARED
50typedef	__size_t	size_t;
51#define	_SIZE_T_DECLARED
52#endif
53
54#if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
55#ifndef _VA_LIST_DECLARED
56typedef	__va_list	va_list;
57#define	_VA_LIST_DECLARED
58#endif
59#endif
60
61#define	_FSTDIO			/* Define for new stdio with functions. */
62
63struct __sFILE;
64typedef	struct __sFILE FILE;
65
66#ifndef _STDSTREAM_DECLARED
67__BEGIN_DECLS
68extern FILE *__stdinp;
69extern FILE *__stdoutp;
70extern FILE *__stderrp;
71__END_DECLS
72#define	_STDSTREAM_DECLARED
73#endif
74
75/*
76 * The following three definitions are for ANSI C, which took them
77 * from System V, which brilliantly took internal interface macros and
78 * made them official arguments to setvbuf(), without renaming them.
79 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
80 */
81#define	_IOFBF	0		/* setvbuf should set fully buffered */
82#define	_IOLBF	1		/* setvbuf should set line buffered */
83#define	_IONBF	2		/* setvbuf should set unbuffered */
84
85#define	BUFSIZ	1024		/* size of buffer used by setbuf */
86#define	EOF	(-1)
87
88/*
89 * FOPEN_MAX is a minimum maximum, and is the number of streams that
90 * stdio can provide without attempting to allocate further resources
91 * (which could fail).  Do not use this for anything.
92 */
93				/* must be == _POSIX_STREAM_MAX <limits.h> */
94#ifndef FOPEN_MAX
95#define	FOPEN_MAX	20	/* must be <= OPEN_MAX <sys/syslimits.h> */
96#endif
97#define	FILENAME_MAX	1024	/* must be <= PATH_MAX <sys/syslimits.h> */
98
99/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
100#if __XSI_VISIBLE
101#define	P_tmpdir	"/var/tmp/"
102#endif
103#define	L_tmpnam	1024	/* XXX must be == PATH_MAX */
104#define	TMP_MAX		308915776
105
106#ifndef SEEK_SET
107#define	SEEK_SET	0	/* set file offset to offset */
108#endif
109#ifndef SEEK_CUR
110#define	SEEK_CUR	1	/* set file offset to current plus offset */
111#endif
112#ifndef SEEK_END
113#define	SEEK_END	2	/* set file offset to EOF plus offset */
114#endif
115
116#define	stdin	__stdinp
117#define	stdout	__stdoutp
118#define	stderr	__stderrp
119
120__BEGIN_DECLS
121/*
122 * Functions defined in ANSI C standard.
123 */
124void	 clearerr(FILE *);
125int	 fclose(FILE *);
126int	 feof(FILE *);
127int	 ferror(FILE *);
128int	 fflush(FILE *);
129int	 fgetc(FILE *);
130int	 fgetpos(FILE * __restrict, fpos_t * __restrict);
131char	*fgets(char * __restrict, int, FILE * __restrict);
132FILE	*fopen(const char * __restrict, const char * __restrict);
133int	 fprintf(FILE * __restrict, const char * __restrict, ...);
134int	 fputc(int, FILE *);
135int	 fputs(const char * __restrict, FILE * __restrict);
136size_t	 fread(void * __restrict, size_t, size_t, FILE * __restrict);
137FILE	*freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
138int	 fscanf(FILE * __restrict, const char * __restrict, ...);
139int	 fseek(FILE *, long, int);
140int	 fsetpos(FILE *, const fpos_t *);
141long	 ftell(FILE *);
142size_t	 fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
143int	 getc(FILE *);
144int	 getchar(void);
145char	*gets(char *);
146void	 perror(const char *);
147int	 printf(const char * __restrict, ...);
148int	 putc(int, FILE *);
149int	 putchar(int);
150int	 puts(const char *);
151int	 remove(const char *);
152int	 rename(const char *, const char *);
153void	 rewind(FILE *);
154int	 scanf(const char * __restrict, ...);
155void	 setbuf(FILE * __restrict, char * __restrict);
156int	 setvbuf(FILE * __restrict, char * __restrict, int, size_t);
157int	 sprintf(char * __restrict, const char * __restrict, ...);
158int	 sscanf(const char * __restrict, const char * __restrict, ...);
159FILE	*tmpfile(void);
160char	*tmpnam(char *);
161int	 ungetc(int, FILE *);
162int	 vfprintf(FILE * __restrict, const char * __restrict,
163	    __va_list);
164int	 vprintf(const char * __restrict, __va_list);
165int	 vsprintf(char * __restrict, const char * __restrict,
166	    __va_list);
167
168#if __ISO_C_VISIBLE >= 1999
169int	 snprintf(char * __restrict, size_t, const char * __restrict,
170	    ...) __printflike(3, 4);
171int	 vfscanf(FILE * __restrict, const char * __restrict, __va_list)
172	    __scanflike(2, 0);
173int	 vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
174int	 vsnprintf(char * __restrict, size_t, const char * __restrict,
175	    __va_list) __printflike(3, 0);
176int	 vsscanf(const char * __restrict, const char * __restrict, __va_list)
177	    __scanflike(2, 0);
178#endif
179
180/*
181 * Functions defined in all versions of POSIX 1003.1.
182 */
183#if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
184/* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
185#define	L_cuserid	17	/* legacy */
186#endif
187
188#if __POSIX_VISIBLE
189#define	L_ctermid	1024	/* size for ctermid(3); PATH_MAX */
190
191char	*ctermid(char *);
192FILE	*fdopen(int, const char *);
193int	 fileno(FILE *);
194#endif /* __POSIX_VISIBLE */
195
196#if __POSIX_VISIBLE >= 199209
197int	 pclose(FILE *);
198FILE	*popen(const char *, const char *);
199#endif
200
201#if __POSIX_VISIBLE >= 199506
202int	 ftrylockfile(FILE *);
203void	 flockfile(FILE *);
204void	 funlockfile(FILE *);
205
206/*
207 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
208 * B.8.2.7 for the rationale behind the *_unlocked() functions.
209 */
210int	 getc_unlocked(FILE *);
211int	 getchar_unlocked(void);
212int	 putc_unlocked(int, FILE *);
213int	 putchar_unlocked(int);
214#endif
215#if __BSD_VISIBLE
216void	 clearerr_unlocked(FILE *);
217int	 feof_unlocked(FILE *);
218int	 ferror_unlocked(FILE *);
219int	 fileno_unlocked(FILE *);
220#endif
221
222#if __POSIX_VISIBLE >= 200112
223int	 fseeko(FILE *, __off_t, int);
224__off_t	 ftello(FILE *);
225#endif
226
227#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
228int	 getw(FILE *);
229int	 putw(int, FILE *);
230#endif /* BSD or X/Open before issue 6 */
231
232#if __XSI_VISIBLE
233char	*tempnam(const char *, const char *);
234#endif
235
236/*
237 * Routines that are purely local.
238 */
239#if __BSD_VISIBLE
240int	 asprintf(char **, const char *, ...) __printflike(2, 3);
241char	*ctermid_r(char *);
242void	 fcloseall(void);
243char	*fgetln(FILE *, size_t *);
244__const char *fmtcheck(const char *, const char *) __format_arg(2);
245int	 fpurge(FILE *);
246int	 renameat(int, const char *, int, const char *);
247void	 setbuffer(FILE *, char *, int);
248int	 setlinebuf(FILE *);
249int	 vasprintf(char **, const char *, __va_list)
250	    __printflike(2, 0);
251
252/* XXX used by libftpio */
253void	*__fgetcookie(FILE *);
254void	__fsetfileno(FILE *, int);
255/* XXX used by sort */
256size_t	__fgetpendout(FILE *);
257
258/*
259 * The system error table contains messages for the first sys_nerr
260 * positive errno values.  Use strerror() or strerror_r() from <string.h>
261 * instead.
262 */
263extern __const int sys_nerr;
264extern __const char *__const sys_errlist[];
265
266/*
267 * Stdio function-access interface.
268 */
269FILE	*funopen(const void *,
270	    int (*)(void *, char *, int),
271	    int (*)(void *, const char *, int),
272	    fpos_t (*)(void *, fpos_t, int),
273	    int (*)(void *));
274#define	fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
275#define	fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
276
277/*
278 * Portability hacks.  See <sys/types.h>.
279 */
280#ifndef _FTRUNCATE_DECLARED
281#define	_FTRUNCATE_DECLARED
282int	 ftruncate(int, __off_t);
283#endif
284#ifndef _LSEEK_DECLARED
285#define	_LSEEK_DECLARED
286__off_t	 lseek(int, __off_t, int);
287#endif
288#ifndef _MMAP_DECLARED
289#define	_MMAP_DECLARED
290void	*mmap(void *, size_t, int, int, int, __off_t);
291#endif
292#ifndef _TRUNCATE_DECLARED
293#define	_TRUNCATE_DECLARED
294int	 truncate(const char *, __off_t);
295#endif
296#endif /* __BSD_VISIBLE */
297
298__END_DECLS
299#endif /* !_STDIO_H_ */
300