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