Annotation of src/include/stdio.h, Revision 1.17
1.17 ! todd 1: /* $OpenBSD: stdio.h,v 1.16 2001/08/30 07:38:27 fgsch 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>
1.13 millert 50: #include <machine/ansi.h>
1.1 deraadt 51:
52: #ifdef _BSD_SIZE_T_
53: typedef _BSD_SIZE_T_ size_t;
54: #undef _BSD_SIZE_T_
55: #endif
56:
1.13 millert 57: #ifdef _BSD_OFF_T_
58: typedef _BSD_OFF_T_ off_t;
59: #undef _BSD_OFF_T_
60: #endif
61:
1.1 deraadt 62: #ifndef NULL
1.11 espie 63: #ifdef __GNUG__
64: #define NULL __null
65: #else
1.1 deraadt 66: #define NULL 0
1.11 espie 67: #endif
1.1 deraadt 68: #endif
69:
1.13 millert 70: #define _FSTDIO /* Define for new stdio with functions. */
1.1 deraadt 71:
1.13 millert 72: typedef off_t fpos_t; /* stdio file position type */
1.1 deraadt 73:
74: /*
75: * NB: to fit things in six character monocase externals, the stdio
76: * code uses the prefix `__s' for stdio objects, typically followed
77: * by a three-character attempt at a mnemonic.
78: */
79:
80: /* stdio buffers */
81: struct __sbuf {
82: unsigned char *_base;
83: int _size;
84: };
85:
86: /*
87: * stdio state variables.
88: *
89: * The following always hold:
90: *
91: * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
92: * _lbfsize is -_bf._size, else _lbfsize is 0
93: * if _flags&__SRD, _w is 0
94: * if _flags&__SWR, _r is 0
95: *
96: * This ensures that the getc and putc macros (or inline functions) never
97: * try to write or read from a file that is in `read' or `write' mode.
98: * (Moreover, they can, and do, automatically switch from read mode to
99: * write mode, and back, on "r+" and "w+" files.)
100: *
101: * _lbfsize is used only to make the inline line-buffered output stream
102: * code as compact as possible.
103: *
104: * _ub, _up, and _ur are used when ungetc() pushes back more characters
105: * than fit in the current _bf, or when ungetc() pushes back a character
106: * that does not match the previous one in _bf. When this happens,
107: * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
108: * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
109: */
110: typedef struct __sFILE {
111: unsigned char *_p; /* current position in (some) buffer */
112: int _r; /* read space left for getc() */
113: int _w; /* write space left for putc() */
114: short _flags; /* flags, below; this FILE is free if 0 */
115: short _file; /* fileno, if Unix descriptor, else -1 */
116: struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
117: int _lbfsize; /* 0 or -_bf._size, for inline putc */
118:
119: /* operations */
120: void *_cookie; /* cookie passed to io functions */
121: int (*_close) __P((void *));
122: int (*_read) __P((void *, char *, int));
123: fpos_t (*_seek) __P((void *, fpos_t, int));
124: int (*_write) __P((void *, const char *, int));
125:
126: /* separate buffer for long sequences of ungetc() */
127: struct __sbuf _ub; /* ungetc buffer */
128: unsigned char *_up; /* saved _p when _p is doing ungetc data */
129: int _ur; /* saved _r when _r is counting ungetc data */
130:
131: /* tricks to meet minimum requirements even when malloc() fails */
132: unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
133: unsigned char _nbuf[1]; /* guarantee a getc() buffer */
134:
135: /* separate buffer for fgetln() when line crosses buffer boundary */
136: struct __sbuf _lb; /* buffer for fgetln() */
137:
138: /* Unix stdio files get aligned to block boundaries on fseek() */
139: int _blksize; /* stat.st_blksize (may be != _bf._size) */
140: fpos_t _offset; /* current lseek offset */
141: } FILE;
142:
143: __BEGIN_DECLS
144: extern FILE __sF[];
145: __END_DECLS
146:
147: #define __SLBF 0x0001 /* line buffered */
148: #define __SNBF 0x0002 /* unbuffered */
149: #define __SRD 0x0004 /* OK to read */
150: #define __SWR 0x0008 /* OK to write */
151: /* RD and WR are never simultaneously asserted */
152: #define __SRW 0x0010 /* open for reading & writing */
153: #define __SEOF 0x0020 /* found EOF */
154: #define __SERR 0x0040 /* found error */
155: #define __SMBF 0x0080 /* _buf is from malloc */
156: #define __SAPP 0x0100 /* fdopen()ed in append mode */
157: #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
158: #define __SOPT 0x0400 /* do fseek() optimisation */
159: #define __SNPT 0x0800 /* do not do fseek() optimisation */
160: #define __SOFF 0x1000 /* set iff _offset is in fact correct */
161: #define __SMOD 0x2000 /* true => fgetln modified _p text */
1.8 millert 162: #define __SALC 0x4000 /* allocate string space dynamically */
1.1 deraadt 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
1.14 millert 190: #define P_tmpdir "/tmp/"
1.1 deraadt 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));
1.12 millert 229: int fseeko __P((FILE *, off_t, int));
1.1 deraadt 230: int fsetpos __P((FILE *, const fpos_t *));
231: long ftell __P((FILE *));
1.12 millert 232: off_t ftello __P((FILE *));
1.1 deraadt 233: size_t fwrite __P((const void *, size_t, size_t, FILE *));
234: int getc __P((FILE *));
235: int getchar __P((void));
236: char *gets __P((char *));
1.5 downsj 237: #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) && !defined(__SYS_ERRLIST)
238: #define __SYS_ERRLIST
239:
240: extern int sys_nerr; /* perror(3) external variables */
1.6 deraadt 241: extern char *sys_errlist[];
1.5 downsj 242: #endif
1.1 deraadt 243: void perror __P((const char *));
244: int printf __P((const char *, ...));
245: int putc __P((int, FILE *));
246: int putchar __P((int));
247: int puts __P((const char *));
248: int remove __P((const char *));
249: int rename __P((const char *, const char *));
250: void rewind __P((FILE *));
251: int scanf __P((const char *, ...));
252: void setbuf __P((FILE *, char *));
253: int setvbuf __P((FILE *, char *, int, size_t));
254: int sprintf __P((char *, const char *, ...));
255: int sscanf __P((const char *, const char *, ...));
256: FILE *tmpfile __P((void));
257: char *tmpnam __P((char *));
258: int ungetc __P((int, FILE *));
259: int vfprintf __P((FILE *, const char *, _BSD_VA_LIST_));
260: int vprintf __P((const char *, _BSD_VA_LIST_));
261: int vsprintf __P((char *, const char *, _BSD_VA_LIST_));
262: __END_DECLS
263:
264: /*
265: * Functions defined in POSIX 1003.1.
266: */
267: #ifndef _ANSI_SOURCE
268: #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
269: #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */
270:
271: __BEGIN_DECLS
272: char *ctermid __P((char *));
1.10 d 273: char *ctermid_r __P((char *));
1.1 deraadt 274: char *cuserid __P((char *));
275: FILE *fdopen __P((int, const char *));
276: int fileno __P((FILE *));
1.10 d 277: void flockfile __P((FILE *));
278: int ftrylockfile __P((FILE *));
279: void funlockfile __P((FILE *));
1.17 ! todd 280: void _flockfile_debug __P((FILE *, const char *, int));
1.10 d 281: int getc_unlocked __P((FILE *));
282: int putc_unlocked __P((int, FILE *));
283: int getchar_unlocked __P((void));
284: int putchar_unlocked __P((int));
1.1 deraadt 285: __END_DECLS
1.10 d 286:
287: #ifndef _POSIX_THREADS
288: # define flockfile(fp) /* nothing */
289: # define ftrylockfile(fp) (0)
290: # define funlockfile(fp) /* nothing */
291: # define _flockfile_debug(fp,f,l) /* nothing */
292: #endif
293:
294: #if 0 /* defined(DEBUG_FLOCKFILE) && defined(_POSIX_THREADS) */
295: # define flockfile(fp) _flockfile_debug(fp, __FILE__, __LINE__)
296: #endif
297:
1.1 deraadt 298: #endif /* not ANSI */
299:
300: /*
301: * Routines that are purely local.
302: */
303: #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
304: __BEGIN_DECLS
1.9 millert 305: int asprintf __P((char **, const char *, ...))
1.15 deraadt 306: __attribute__((__format__ (printf, 2, 3)));
1.1 deraadt 307: char *fgetln __P((FILE *, size_t *));
308: int fpurge __P((FILE *));
309: int getw __P((FILE *));
310: int pclose __P((FILE *));
311: FILE *popen __P((const char *, const char *));
312: int putw __P((int, FILE *));
313: void setbuffer __P((FILE *, char *, int));
314: int setlinebuf __P((FILE *));
315: char *tempnam __P((const char *, const char *));
316: int snprintf __P((char *, size_t, const char *, ...))
1.15 deraadt 317: __attribute__((__format__ (printf, 3, 4)));
1.8 millert 318: int vasprintf __P((char **, const char *, _BSD_VA_LIST_))
1.15 deraadt 319: __attribute__((__format__ (printf, 2, 0)));
1.1 deraadt 320: int vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_))
1.15 deraadt 321: __attribute__((__format__ (printf, 3, 0)));
1.1 deraadt 322: int vscanf __P((const char *, _BSD_VA_LIST_))
1.15 deraadt 323: __attribute__((__format__ (scanf, 1, 0)));
1.1 deraadt 324: int vsscanf __P((const char *, const char *, _BSD_VA_LIST_))
1.15 deraadt 325: __attribute__((__format__ (scanf, 2, 0)));
1.1 deraadt 326: __END_DECLS
327:
328: /*
329: * This is a #define because the function is used internally and
330: * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
331: * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
332: */
333: #define vfscanf __svfscanf
334:
335: /*
336: * Stdio function-access interface.
337: */
338: __BEGIN_DECLS
339: FILE *funopen __P((const void *,
340: int (*)(void *, char *, int),
341: int (*)(void *, const char *, int),
342: fpos_t (*)(void *, fpos_t, int),
343: int (*)(void *)));
344: __END_DECLS
345: #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
346: #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
347: #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
348:
349: /*
350: * Functions internal to the implementation.
351: */
352: __BEGIN_DECLS
353: int __srget __P((FILE *));
354: int __svfscanf __P((FILE *, const char *, _BSD_VA_LIST_));
355: int __swbuf __P((int, FILE *));
356: __END_DECLS
357:
358: /*
359: * The __sfoo macros are here so that we can
360: * define function versions in the C library.
361: */
362: #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
363: #if defined(__GNUC__) && defined(__STDC__)
364: static __inline int __sputc(int _c, FILE *_p) {
365: if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
366: return (*_p->_p++ = _c);
367: else
368: return (__swbuf(_c, _p));
369: }
370: #else
371: /*
372: * This has been tuned to generate reasonable code on the vax using pcc.
373: */
374: #define __sputc(c, p) \
375: (--(p)->_w < 0 ? \
376: (p)->_w >= (p)->_lbfsize ? \
377: (*(p)->_p = (c)), *(p)->_p != '\n' ? \
378: (int)*(p)->_p++ : \
379: __swbuf('\n', p) : \
380: __swbuf((int)(c), p) : \
381: (*(p)->_p = (c), (int)*(p)->_p++))
382: #endif
383:
384: #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
385: #define __sferror(p) (((p)->_flags & __SERR) != 0)
386: #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
387: #define __sfileno(p) ((p)->_file)
388:
389: #define feof(p) __sfeof(p)
390: #define ferror(p) __sferror(p)
1.10 d 391:
392: #ifndef _POSIX_THREADS
1.1 deraadt 393: #define clearerr(p) __sclearerr(p)
1.10 d 394: #endif
1.1 deraadt 395:
396: #ifndef _ANSI_SOURCE
397: #define fileno(p) __sfileno(p)
398: #endif
399:
400: #ifndef lint
1.10 d 401: #ifndef _POSIX_THREADS
1.1 deraadt 402: #define getc(fp) __sgetc(fp)
1.10 d 403: #endif /* _POSIX_THREADS */
404: #define getc_unlocked(fp) __sgetc(fp)
1.7 tholo 405: /*
1.10 d 406: * The macro implementations of putc and putc_unlocked are not
407: * fully POSIX compliant; they do not set errno on failure
1.7 tholo 408: */
409: #ifndef _POSIX_SOURCE
1.10 d 410: #ifndef _POSIX_THREADS
1.1 deraadt 411: #define putc(x, fp) __sputc(x, fp)
1.10 d 412: #endif /* _POSIX_THREADS */
413: #define putc_unlocked(x, fp) __sputc(x, fp)
1.7 tholo 414: #endif /* _POSIX_SOURCE */
1.1 deraadt 415: #endif /* lint */
416:
417: #define getchar() getc(stdin)
418: #define putchar(x) putc(x, stdout)
1.10 d 419: #define getchar_unlocked() getc_unlocked(stdin)
420: #define putchar_unlocked(c) putc_unlocked(c, stdout)
421:
1.1 deraadt 422: #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