Annotation of src/include/stdio.h, Revision 1.24
1.24 ! millert 1: /* $OpenBSD: stdio.h,v 1.23 2002/10/25 21:55:28 millert 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.23 millert 66: #define NULL 0L
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 */
1.20 millert 121: int (*_close)(void *);
122: int (*_read)(void *, char *, int);
123: fpos_t (*_seek)(void *, fpos_t, int);
124: int (*_write)(void *, const char *, int);
1.1 deraadt 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 */
1.24 ! millert 178:
! 179: #ifndef __EOF
! 180: #define __EOF (-1)
! 181: #endif
! 182: #define EOF __EOF
1.1 deraadt 183:
184: /*
185: * FOPEN_MAX is a minimum maximum, and should be the number of descriptors
186: * that the kernel can provide without allocation of a resource that can
187: * fail without the process sleeping. Do not use this for anything.
188: */
189: #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
190: #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
191:
192: /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
193: #ifndef _ANSI_SOURCE
1.14 millert 194: #define P_tmpdir "/tmp/"
1.1 deraadt 195: #endif
196: #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
197: #define TMP_MAX 308915776
198:
199: #ifndef SEEK_SET
200: #define SEEK_SET 0 /* set file offset to offset */
201: #endif
202: #ifndef SEEK_CUR
203: #define SEEK_CUR 1 /* set file offset to current plus offset */
204: #endif
205: #ifndef SEEK_END
206: #define SEEK_END 2 /* set file offset to EOF plus offset */
207: #endif
208:
209: #define stdin (&__sF[0])
210: #define stdout (&__sF[1])
211: #define stderr (&__sF[2])
212:
213: /*
214: * Functions defined in ANSI C standard.
215: */
216: __BEGIN_DECLS
1.20 millert 217: void clearerr(FILE *);
218: int fclose(FILE *);
219: int feof(FILE *);
220: int ferror(FILE *);
221: int fflush(FILE *);
222: int fgetc(FILE *);
223: int fgetpos(FILE *, fpos_t *);
224: char *fgets(char *, int, FILE *);
225: FILE *fopen(const char *, const char *);
226: int fprintf(FILE *, const char *, ...);
227: int fputc(int, FILE *);
228: int fputs(const char *, FILE *);
229: size_t fread(void *, size_t, size_t, FILE *);
230: FILE *freopen(const char *, const char *, FILE *);
231: int fscanf(FILE *, const char *, ...);
232: int fseek(FILE *, long, int);
233: int fseeko(FILE *, off_t, int);
234: int fsetpos(FILE *, const fpos_t *);
235: long ftell(FILE *);
236: off_t ftello(FILE *);
237: size_t fwrite(const void *, size_t, size_t, FILE *);
238: int getc(FILE *);
239: int getchar(void);
240: char *gets(char *);
1.5 downsj 241: #if !defined(_ANSI_SOURCE) && !defined(_POSIX_SOURCE) && !defined(__SYS_ERRLIST)
242: #define __SYS_ERRLIST
243:
244: extern int sys_nerr; /* perror(3) external variables */
1.6 deraadt 245: extern char *sys_errlist[];
1.5 downsj 246: #endif
1.20 millert 247: void perror(const char *);
248: int printf(const char *, ...);
249: int putc(int, FILE *);
250: int putchar(int);
251: int puts(const char *);
252: int remove(const char *);
253: int rename(const char *, const char *);
254: void rewind(FILE *);
255: int scanf(const char *, ...);
256: void setbuf(FILE *, char *);
257: int setvbuf(FILE *, char *, int, size_t);
258: int sprintf(char *, const char *, ...);
259: int sscanf(const char *, const char *, ...);
260: FILE *tmpfile(void);
261: char *tmpnam(char *);
262: int ungetc(int, FILE *);
263: int vfprintf(FILE *, const char *, _BSD_VA_LIST_);
264: int vprintf(const char *, _BSD_VA_LIST_);
265: int vsprintf(char *, const char *, _BSD_VA_LIST_);
1.1 deraadt 266: __END_DECLS
267:
268: /*
269: * Functions defined in POSIX 1003.1.
270: */
271: #ifndef _ANSI_SOURCE
272: #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
273: #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */
274:
275: __BEGIN_DECLS
1.20 millert 276: char *ctermid(char *);
277: char *ctermid_r(char *);
278: char *cuserid(char *);
279: FILE *fdopen(int, const char *);
280: int fileno(FILE *);
281: void flockfile(FILE *);
282: int ftrylockfile(FILE *);
283: void funlockfile(FILE *);
284: void _flockfile_debug(FILE *, char *, int);
285: int getc_unlocked(FILE *);
286: int putc_unlocked(int, FILE *);
287: int getchar_unlocked(void);
288: int putchar_unlocked(int);
1.1 deraadt 289: __END_DECLS
1.10 d 290:
291: #ifndef _POSIX_THREADS
292: # define flockfile(fp) /* nothing */
293: # define ftrylockfile(fp) (0)
294: # define funlockfile(fp) /* nothing */
295: # define _flockfile_debug(fp,f,l) /* nothing */
296: #endif
297:
298: #if 0 /* defined(DEBUG_FLOCKFILE) && defined(_POSIX_THREADS) */
299: # define flockfile(fp) _flockfile_debug(fp, __FILE__, __LINE__)
300: #endif
301:
1.1 deraadt 302: #endif /* not ANSI */
303:
304: /*
305: * Routines that are purely local.
306: */
307: #if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
308: __BEGIN_DECLS
1.20 millert 309: int asprintf(char **, const char *, ...)
1.19 espie 310: __attribute__((__format__ (printf, 2, 3)))
311: __attribute__((__nonnull__ (2)));
1.20 millert 312: char *fgetln(FILE *, size_t *);
313: int fpurge(FILE *);
314: int getw(FILE *);
315: int pclose(FILE *);
316: FILE *popen(const char *, const char *);
317: int putw(int, FILE *);
318: void setbuffer(FILE *, char *, int);
319: int setlinebuf(FILE *);
320: char *tempnam(const char *, const char *);
321: int snprintf(char *, size_t, const char *, ...)
1.19 espie 322: __attribute__((__format__ (printf, 3, 4)))
323: __attribute__((__nonnull__ (3)));
1.20 millert 324: int vasprintf(char **, const char *, _BSD_VA_LIST_)
1.19 espie 325: __attribute__((__format__ (printf, 2, 0)))
326: __attribute__((__nonnull__ (2)));
1.20 millert 327: int vsnprintf(char *, size_t, const char *, _BSD_VA_LIST_)
1.19 espie 328: __attribute__((__format__ (printf, 3, 0)))
329: __attribute__((__nonnull__ (3)));
1.20 millert 330: int vscanf(const char *, _BSD_VA_LIST_)
1.19 espie 331: __attribute__((__format__ (scanf, 1, 0)))
332: __attribute__((__nonnull__ (1)));
1.20 millert 333: int vsscanf(const char *, const char *, _BSD_VA_LIST_)
1.19 espie 334: __attribute__((__format__ (scanf, 2, 0)))
335: __attribute__((__nonnull__ (2)));
1.1 deraadt 336: __END_DECLS
337:
338: /*
339: * This is a #define because the function is used internally and
340: * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
341: * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
342: */
343: #define vfscanf __svfscanf
344:
345: /*
346: * Stdio function-access interface.
347: */
348: __BEGIN_DECLS
1.21 millert 349: FILE *funopen(const void *,
1.1 deraadt 350: int (*)(void *, char *, int),
351: int (*)(void *, const char *, int),
352: fpos_t (*)(void *, fpos_t, int),
1.21 millert 353: int (*)(void *));
1.1 deraadt 354: __END_DECLS
355: #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
356: #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
357: #endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
358:
359: /*
360: * Functions internal to the implementation.
361: */
362: __BEGIN_DECLS
1.20 millert 363: int __srget(FILE *);
364: int __svfscanf(FILE *, const char *, _BSD_VA_LIST_);
365: int __swbuf(int, FILE *);
1.1 deraadt 366: __END_DECLS
367:
368: /*
369: * The __sfoo macros are here so that we can
370: * define function versions in the C library.
371: */
372: #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
1.22 millert 373: #if defined(__GNUC__)
1.1 deraadt 374: static __inline int __sputc(int _c, FILE *_p) {
375: if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
376: return (*_p->_p++ = _c);
377: else
378: return (__swbuf(_c, _p));
379: }
380: #else
381: /*
382: * This has been tuned to generate reasonable code on the vax using pcc.
383: */
384: #define __sputc(c, p) \
385: (--(p)->_w < 0 ? \
386: (p)->_w >= (p)->_lbfsize ? \
387: (*(p)->_p = (c)), *(p)->_p != '\n' ? \
388: (int)*(p)->_p++ : \
389: __swbuf('\n', p) : \
390: __swbuf((int)(c), p) : \
391: (*(p)->_p = (c), (int)*(p)->_p++))
392: #endif
393:
394: #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
395: #define __sferror(p) (((p)->_flags & __SERR) != 0)
396: #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
397: #define __sfileno(p) ((p)->_file)
398:
399: #define feof(p) __sfeof(p)
400: #define ferror(p) __sferror(p)
1.10 d 401:
402: #ifndef _POSIX_THREADS
1.1 deraadt 403: #define clearerr(p) __sclearerr(p)
1.10 d 404: #endif
1.1 deraadt 405:
406: #ifndef _ANSI_SOURCE
407: #define fileno(p) __sfileno(p)
408: #endif
409:
410: #ifndef lint
1.10 d 411: #ifndef _POSIX_THREADS
1.1 deraadt 412: #define getc(fp) __sgetc(fp)
1.10 d 413: #endif /* _POSIX_THREADS */
414: #define getc_unlocked(fp) __sgetc(fp)
1.7 tholo 415: /*
1.10 d 416: * The macro implementations of putc and putc_unlocked are not
417: * fully POSIX compliant; they do not set errno on failure
1.7 tholo 418: */
419: #ifndef _POSIX_SOURCE
1.10 d 420: #ifndef _POSIX_THREADS
1.1 deraadt 421: #define putc(x, fp) __sputc(x, fp)
1.10 d 422: #endif /* _POSIX_THREADS */
423: #define putc_unlocked(x, fp) __sputc(x, fp)
1.7 tholo 424: #endif /* _POSIX_SOURCE */
1.1 deraadt 425: #endif /* lint */
426:
427: #define getchar() getc(stdin)
428: #define putchar(x) putc(x, stdout)
1.10 d 429: #define getchar_unlocked() getc_unlocked(stdin)
430: #define putchar_unlocked(c) putc_unlocked(c, stdout)
431:
1.1 deraadt 432: #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