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