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