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