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