stdio.h revision 1.1 1 /*-
2 * Copyright (c) 1990 The Regents of the University of California.
3 * 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 5.17 (Berkeley) 6/3/91
37 */
38
39 #ifndef _STDIO_H_
40 #define _STDIO_H_
41
42 #include <sys/cdefs.h>
43
44 #include <machine/ansi.h>
45 #ifdef _SIZE_T_
46 typedef _SIZE_T_ size_t;
47 #undef _SIZE_T_
48 #endif
49
50 #ifndef NULL
51 #define NULL 0
52 #endif
53
54 typedef long fpos_t; /* Must match off_t <sys/types.h> */
55
56 #define _FSTDIO /* Define for new stdio with functions. */
57
58 /*
59 * NB: to fit things in six character monocase externals, the stdio
60 * code uses the prefix `__s' for stdio objects, typically followed
61 * by a three-character attempt at a mnemonic.
62 */
63
64 /* stdio buffers */
65 struct __sbuf {
66 unsigned char *_base;
67 int _size;
68 };
69
70 /*
71 * stdio state variables.
72 *
73 * The following always hold:
74 *
75 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
76 * _lbfsize is -_bf._size, else _lbfsize is 0
77 * if _flags&__SRD, _w is 0
78 * if _flags&__SWR, _r is 0
79 *
80 * This ensures that the getc and putc macros (or inline functions) never
81 * try to write or read from a file that is in `read' or `write' mode.
82 * (Moreover, they can, and do, automatically switch from read mode to
83 * write mode, and back, on "r+" and "w+" files.)
84 *
85 * _lbfsize is used only to make the inline line-buffered output stream
86 * code as compact as possible.
87 *
88 * _ub, _up, and _ur are used when ungetc() pushes back more characters
89 * than fit in the current _bf, or when ungetc() pushes back a character
90 * that does not match the previous one in _bf. When this happens,
91 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
92 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
93 */
94 typedef struct __sFILE {
95 unsigned char *_p; /* current position in (some) buffer */
96 int _r; /* read space left for getc() */
97 int _w; /* write space left for putc() */
98 short _flags; /* flags, below; this FILE is free if 0 */
99 short _file; /* fileno, if Unix descriptor, else -1 */
100 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
101 int _lbfsize; /* 0 or -_bf._size, for inline putc */
102
103 /* operations */
104 void *_cookie; /* cookie passed to io functions */
105 int (*_close) __P((void *));
106 int (*_read) __P((void *, char *, int));
107 fpos_t (*_seek) __P((void *, fpos_t, int));
108 int (*_write) __P((void *, const char *, int));
109
110 /* separate buffer for long sequences of ungetc() */
111 struct __sbuf _ub; /* ungetc buffer */
112 unsigned char *_up; /* saved _p when _p is doing ungetc data */
113 int _ur; /* saved _r when _r is counting ungetc data */
114
115 /* tricks to meet minimum requirements even when malloc() fails */
116 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
117 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
118
119 /* separate buffer for fgetline() when line crosses buffer boundary */
120 struct __sbuf _lb; /* buffer for fgetline() */
121
122 /* Unix stdio files get aligned to block boundaries on fseek() */
123 int _blksize; /* stat.st_blksize (may be != _bf._size) */
124 int _offset; /* current lseek offset */
125 } FILE;
126
127 __BEGIN_DECLS
128 extern FILE __sF[];
129 __END_DECLS
130
131 #define __SLBF 0x0001 /* line buffered */
132 #define __SNBF 0x0002 /* unbuffered */
133 #define __SRD 0x0004 /* OK to read */
134 #define __SWR 0x0008 /* OK to write */
135 /* RD and WR are never simultaneously asserted */
136 #define __SRW 0x0010 /* open for reading & writing */
137 #define __SEOF 0x0020 /* found EOF */
138 #define __SERR 0x0040 /* found error */
139 #define __SMBF 0x0080 /* _buf is from malloc */
140 #define __SAPP 0x0100 /* fdopen()ed in append mode */
141 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
142 #define __SOPT 0x0400 /* do fseek() optimisation */
143 #define __SNPT 0x0800 /* do not do fseek() optimisation */
144 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
145 #define __SMOD 0x2000 /* true => fgetline modified _p text */
146
147 /*
148 * The following three definitions are for ANSI C, which took them
149 * from System V, which brilliantly took internal interface macros and
150 * made them official arguments to setvbuf(), without renaming them.
151 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
152 *
153 * Although numbered as their counterparts above, the implementation
154 * does not rely on this.
155 */
156 #define _IOFBF 0 /* setvbuf should set fully buffered */
157 #define _IOLBF 1 /* setvbuf should set line buffered */
158 #define _IONBF 2 /* setvbuf should set unbuffered */
159
160 #define BUFSIZ 1024 /* size of buffer used by setbuf */
161 #define EOF (-1)
162
163 /*
164 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors
165 * that the kernel can provide without allocation of a resource that can
166 * fail without the process sleeping. Do not use this for anything.
167 */
168 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
169 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
170
171 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
172 #ifndef _ANSI_SOURCE
173 #define P_tmpdir "/var/tmp/"
174 #endif
175 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
176 #define TMP_MAX 308915776
177
178 #ifndef SEEK_SET
179 #define SEEK_SET 0 /* set file offset to offset */
180 #endif
181 #ifndef SEEK_CUR
182 #define SEEK_CUR 1 /* set file offset to current plus offset */
183 #endif
184 #ifndef SEEK_END
185 #define SEEK_END 2 /* set file offset to EOF plus offset */
186 #endif
187
188 #define stdin (&__sF[0])
189 #define stdout (&__sF[1])
190 #define stderr (&__sF[2])
191
192 /*
193 * Functions defined in ANSI C standard.
194 */
195 __BEGIN_DECLS
196 void clearerr __P((FILE *));
197 int fclose __P((FILE *));
198 int feof __P((FILE *));
199 int ferror __P((FILE *));
200 int fflush __P((FILE *));
201 int fgetc __P((FILE *));
202 int fgetpos __P((FILE *, fpos_t *));
203 char *fgets __P((char *, size_t, FILE *));
204 FILE *fopen __P((const char *, const char *));
205 int fprintf __P((FILE *, const char *, ...));
206 int fputc __P((int, FILE *));
207 int fputs __P((const char *, FILE *));
208 int fread __P((void *, size_t, size_t, FILE *));
209 FILE *freopen __P((const char *, const char *, FILE *));
210 int fscanf __P((FILE *, const char *, ...));
211 int fseek __P((FILE *, long, int));
212 int fsetpos __P((FILE *, const fpos_t *));
213 long ftell __P((const FILE *));
214 int fwrite __P((const void *, size_t, size_t, FILE *));
215 int getc __P((FILE *));
216 int getchar __P((void));
217 char *gets __P((char *));
218 #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
219 extern int sys_nerr; /* perror(3) external variables */
220 extern char *sys_errlist[];
221 #endif
222 void perror __P((const char *));
223 int printf __P((const char *, ...));
224 int putc __P((int, FILE *));
225 int putchar __P((int));
226 int puts __P((const char *));
227 int remove __P((const char *));
228 int rename __P((const char *, const char *));
229 void rewind __P((FILE *));
230 int scanf __P((const char *, ...));
231 void setbuf __P((FILE *, char *));
232 int setvbuf __P((FILE *, char *, int, size_t));
233 int sprintf __P((char *, const char *, ...));
234 int sscanf __P((char *, const char *, ...));
235 FILE *tmpfile __P((void));
236 char *tmpnam __P((char *));
237 int ungetc __P((int, FILE *));
238 int vfprintf __P((FILE *, const char *, _VA_LIST_));
239 int vprintf __P((const char *, _VA_LIST_));
240 int vsprintf __P((char *, const char *, _VA_LIST_));
241 __END_DECLS
242
243 /*
244 * Functions defined in POSIX 1003.1.
245 */
246 #ifndef _ANSI_SOURCE
247 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */
248 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
249
250 __BEGIN_DECLS
251 char *ctermid __P((char *));
252 FILE *fdopen __P((int, const char *));
253 int fileno __P((FILE *));
254 __END_DECLS
255 #endif /* not ANSI */
256
257 /*
258 * Routines that are purely local.
259 */
260 #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
261 __BEGIN_DECLS
262 char *fgetline __P((FILE *, size_t *));
263 int fpurge __P((FILE *));
264 int getw __P((FILE *));
265 int pclose __P((FILE *));
266 FILE *popen __P((const char *, const char *));
267 int putw __P((int, FILE *));
268 void setbuffer __P((FILE *, char *, int));
269 int setlinebuf __P((FILE *));
270 char *tempnam __P((const char *, const char *));
271 int snprintf __P((char *, size_t, const char *, ...));
272 int vsnprintf __P((char *, size_t, const char *, _VA_LIST_));
273 int vscanf __P((const char *, _VA_LIST_));
274 int vsscanf __P((const char *, const char *, _VA_LIST_));
275 __END_DECLS
276
277 /*
278 * This is a #define because the function is used internally and
279 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
280 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
281 */
282 #define vfscanf __svfscanf
283
284 /*
285 * Stdio function-access interface.
286 */
287 __BEGIN_DECLS
288 FILE *funopen __P((const void *,
289 int (*)(void *, char *, int),
290 int (*)(void *, const char *, int),
291 fpos_t (*)(void *, fpos_t, int),
292 int (*)(void *)));
293 __END_DECLS
294 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
295 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
296 #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
297
298 /*
299 * Functions internal to the implementation.
300 */
301 __BEGIN_DECLS
302 int __srget __P((FILE *));
303 int __svfscanf __P((FILE *, const char *, _VA_LIST_));
304 int __swbuf __P((int, FILE *));
305 __END_DECLS
306
307 /*
308 * The __sfoo macros are here so that we can
309 * define function versions in the C library.
310 */
311 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
312 #if defined(__GNUC__) && defined(__STDC__)
313 static inline int __sputc(int _c, FILE *_p) {
314 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
315 return (*_p->_p++ = _c);
316 else
317 return (__swbuf(_c, _p));
318 }
319 #else
320 /*
321 * This has been tuned to generate reasonable code on the vax using pcc.
322 */
323 #define __sputc(c, p) \
324 (--(p)->_w < 0 ? \
325 (p)->_w >= (p)->_lbfsize ? \
326 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
327 (int)*(p)->_p++ : \
328 __swbuf('\n', p) : \
329 __swbuf((int)(c), p) : \
330 (*(p)->_p = (c), (int)*(p)->_p++))
331 #endif
332
333 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
334 #define __sferror(p) (((p)->_flags & __SERR) != 0)
335 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
336 #define __sfileno(p) ((p)->_file)
337
338 #define feof(p) __sfeof(p)
339 #define ferror(p) __sferror(p)
340 #define clearerr(p) __sclearerr(p)
341
342 #ifndef _ANSI_SOURCE
343 #define fileno(p) __sfileno(p)
344 #endif
345
346 #ifndef lint
347 #define getc(fp) __sgetc(fp)
348 #define putc(x, fp) __sputc(x, fp)
349 #endif /* lint */
350
351 #define getchar() getc(stdin)
352 #define putchar(x) putc(x, stdout)
353 #endif /* _STDIO_H_ */
354