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