Annotation of src/include/stdio.h, Revision 1.34
1.34 ! millert 1: /* $OpenBSD: stdio.h,v 1.33 2005/12/13 00:35:22 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.33 millert 41: #include <sys/cdefs.h>
1.34 ! millert 42: #include <sys/_types.h>
1.33 millert 43:
44: #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE
1.34 ! millert 45: #include <sys/types.h> /* XXX should be removed */
1.1 deraadt 46: #endif
47:
1.34 ! millert 48: #ifndef _SIZE_T_DEFINED_
! 49: #define _SIZE_T_DEFINED_
! 50: typedef __size_t size_t;
1.1 deraadt 51: #endif
52:
1.34 ! millert 53: #ifndef _OFF_T_DEFINED_
! 54: #define _OFF_T_DEFINED_
! 55: typedef __off_t off_t;
1.13 millert 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:
1.31 espie 122: /* extension data, to avoid further ABI breakage */
123: struct __sbuf _ext;
124: /* data for long sequences of ungetc() */
1.1 deraadt 125: unsigned char *_up; /* saved _p when _p is doing ungetc data */
126: int _ur; /* saved _r when _r is counting ungetc data */
127:
128: /* tricks to meet minimum requirements even when malloc() fails */
129: unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
130: unsigned char _nbuf[1]; /* guarantee a getc() buffer */
131:
132: /* separate buffer for fgetln() when line crosses buffer boundary */
133: struct __sbuf _lb; /* buffer for fgetln() */
134:
135: /* Unix stdio files get aligned to block boundaries on fseek() */
136: int _blksize; /* stat.st_blksize (may be != _bf._size) */
137: fpos_t _offset; /* current lseek offset */
138: } FILE;
139:
140: __BEGIN_DECLS
141: extern FILE __sF[];
142: __END_DECLS
143:
144: #define __SLBF 0x0001 /* line buffered */
145: #define __SNBF 0x0002 /* unbuffered */
146: #define __SRD 0x0004 /* OK to read */
147: #define __SWR 0x0008 /* OK to write */
148: /* RD and WR are never simultaneously asserted */
149: #define __SRW 0x0010 /* open for reading & writing */
150: #define __SEOF 0x0020 /* found EOF */
151: #define __SERR 0x0040 /* found error */
152: #define __SMBF 0x0080 /* _buf is from malloc */
153: #define __SAPP 0x0100 /* fdopen()ed in append mode */
154: #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
155: #define __SOPT 0x0400 /* do fseek() optimisation */
156: #define __SNPT 0x0800 /* do not do fseek() optimisation */
157: #define __SOFF 0x1000 /* set iff _offset is in fact correct */
158: #define __SMOD 0x2000 /* true => fgetln modified _p text */
1.8 millert 159: #define __SALC 0x4000 /* allocate string space dynamically */
1.1 deraadt 160:
161: /*
162: * The following three definitions are for ANSI C, which took them
163: * from System V, which brilliantly took internal interface macros and
164: * made them official arguments to setvbuf(), without renaming them.
165: * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
166: *
167: * Although numbered as their counterparts above, the implementation
168: * does not rely on this.
169: */
170: #define _IOFBF 0 /* setvbuf should set fully buffered */
171: #define _IOLBF 1 /* setvbuf should set line buffered */
172: #define _IONBF 2 /* setvbuf should set unbuffered */
173:
174: #define BUFSIZ 1024 /* size of buffer used by setbuf */
1.24 millert 175:
1.25 millert 176: #define EOF (-1)
1.1 deraadt 177:
178: /*
179: * FOPEN_MAX is a minimum maximum, and should be the number of descriptors
180: * that the kernel can provide without allocation of a resource that can
181: * fail without the process sleeping. Do not use this for anything.
182: */
183: #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
184: #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
185:
186: /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
1.33 millert 187: #if __BSD_VISIBLE || __XPG_VISIBLE
1.14 millert 188: #define P_tmpdir "/tmp/"
1.1 deraadt 189: #endif
190: #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
191: #define TMP_MAX 308915776
192:
193: #ifndef SEEK_SET
194: #define SEEK_SET 0 /* set file offset to offset */
195: #endif
196: #ifndef SEEK_CUR
197: #define SEEK_CUR 1 /* set file offset to current plus offset */
198: #endif
199: #ifndef SEEK_END
200: #define SEEK_END 2 /* set file offset to EOF plus offset */
201: #endif
202:
203: #define stdin (&__sF[0])
204: #define stdout (&__sF[1])
205: #define stderr (&__sF[2])
206:
207: /*
208: * Functions defined in ANSI C standard.
209: */
210: __BEGIN_DECLS
1.20 millert 211: void clearerr(FILE *);
212: int fclose(FILE *);
213: int feof(FILE *);
214: int ferror(FILE *);
215: int fflush(FILE *);
216: int fgetc(FILE *);
217: int fgetpos(FILE *, fpos_t *);
1.29 avsm 218: char *fgets(char *, int, FILE *)
219: __attribute__((__bounded__ (__string__,1,2)));
1.20 millert 220: FILE *fopen(const char *, const char *);
221: int fprintf(FILE *, const char *, ...);
222: int fputc(int, FILE *);
223: int fputs(const char *, FILE *);
1.29 avsm 224: size_t fread(void *, size_t, size_t, FILE *)
225: __attribute__((__bounded__ (__size__,1,3,2)));
1.20 millert 226: FILE *freopen(const char *, const char *, FILE *);
227: int fscanf(FILE *, const char *, ...);
228: int fseek(FILE *, long, int);
229: int fseeko(FILE *, off_t, int);
230: int fsetpos(FILE *, const fpos_t *);
231: long ftell(FILE *);
232: off_t ftello(FILE *);
1.29 avsm 233: size_t fwrite(const void *, size_t, size_t, FILE *)
234: __attribute__((__bounded__ (__size__,1,3,2)));
1.20 millert 235: int getc(FILE *);
236: int getchar(void);
237: char *gets(char *);
1.33 millert 238: #if __BSD_VISIBLE && !defined(__SYS_ERRLIST)
1.5 downsj 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.20 millert 244: void perror(const char *);
245: int printf(const char *, ...);
246: int putc(int, FILE *);
247: int putchar(int);
248: int puts(const char *);
249: int remove(const char *);
250: int rename(const char *, const char *);
251: void rewind(FILE *);
252: int scanf(const char *, ...);
253: void setbuf(FILE *, char *);
254: int setvbuf(FILE *, char *, int, size_t);
255: int sprintf(char *, const char *, ...);
256: int sscanf(const char *, const char *, ...);
257: FILE *tmpfile(void);
258: char *tmpnam(char *);
259: int ungetc(int, FILE *);
1.34 ! millert 260: int vfprintf(FILE *, const char *, __va_list);
! 261: int vprintf(const char *, __va_list);
! 262: int vsprintf(char *, const char *, __va_list);
1.33 millert 263:
264: #if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE
265: int snprintf(char *, size_t, const char *, ...)
266: __attribute__((__format__ (printf, 3, 4)))
267: __attribute__((__nonnull__ (3)))
268: __attribute__((__bounded__ (__string__,1,2)));
1.34 ! millert 269: int vfscanf(FILE *, const char *, __va_list)
1.33 millert 270: __attribute__((__format__ (scanf, 2, 0)))
271: __attribute__((__nonnull__ (2)));
1.34 ! millert 272: int vscanf(const char *, __va_list)
1.33 millert 273: __attribute__((__format__ (scanf, 1, 0)))
274: __attribute__((__nonnull__ (1)));
1.34 ! millert 275: int vsnprintf(char *, size_t, const char *, __va_list)
1.33 millert 276: __attribute__((__format__ (printf, 3, 0)))
277: __attribute__((__nonnull__ (3)))
278: __attribute__((__bounded__(__string__,1,2)));
1.34 ! millert 279: int vsscanf(const char *, const char *, __va_list)
1.33 millert 280: __attribute__((__format__ (scanf, 2, 0)))
281: __attribute__((__nonnull__ (2)));
282: #endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */
283:
1.1 deraadt 284: __END_DECLS
285:
1.33 millert 286:
1.1 deraadt 287: /*
288: * Functions defined in POSIX 1003.1.
289: */
1.33 millert 290: #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE
1.1 deraadt 291: #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
292: #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */
293:
294: __BEGIN_DECLS
1.20 millert 295: char *ctermid(char *);
296: char *ctermid_r(char *);
297: char *cuserid(char *);
298: FILE *fdopen(int, const char *);
299: int fileno(FILE *);
1.33 millert 300:
301: #if __POSIX_VISIBLE >= 199209
302: int pclose(FILE *);
303: FILE *popen(const char *, const char *);
304: #endif
305:
306: #if __POSIX_VISIBLE >= 199506
1.20 millert 307: void flockfile(FILE *);
308: int ftrylockfile(FILE *);
309: void funlockfile(FILE *);
1.33 millert 310:
311: /*
312: * These are normally used through macros as defined below, but POSIX
313: * requires functions as well.
314: */
1.20 millert 315: int getc_unlocked(FILE *);
1.33 millert 316: int getchar_unlocked(void);
1.20 millert 317: int putc_unlocked(int, FILE *);
318: int putchar_unlocked(int);
1.33 millert 319: #endif /* __POSIX_VISIBLE >= 199506 */
320:
321: #if __XPG_VISIBLE
322: char *tempnam(const char *, const char *);
323: #endif
1.1 deraadt 324: __END_DECLS
1.10 d 325:
326: #ifndef _POSIX_THREADS
327: # define flockfile(fp) /* nothing */
328: # define ftrylockfile(fp) (0)
329: # define funlockfile(fp) /* nothing */
330: #endif
331:
1.33 millert 332: #endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */
1.1 deraadt 333:
334: /*
335: * Routines that are purely local.
336: */
1.33 millert 337: #if __BSD_VISIBLE
1.1 deraadt 338: __BEGIN_DECLS
1.20 millert 339: int asprintf(char **, const char *, ...)
1.19 espie 340: __attribute__((__format__ (printf, 2, 3)))
341: __attribute__((__nonnull__ (2)));
1.20 millert 342: char *fgetln(FILE *, size_t *);
343: int fpurge(FILE *);
344: int getw(FILE *);
345: int putw(int, FILE *);
346: void setbuffer(FILE *, char *, int);
347: int setlinebuf(FILE *);
1.34 ! millert 348: int vasprintf(char **, const char *, __va_list)
1.19 espie 349: __attribute__((__format__ (printf, 2, 0)))
350: __attribute__((__nonnull__ (2)));
1.1 deraadt 351: __END_DECLS
352:
353: /*
354: * Stdio function-access interface.
355: */
356: __BEGIN_DECLS
1.21 millert 357: FILE *funopen(const void *,
1.1 deraadt 358: int (*)(void *, char *, int),
359: int (*)(void *, const char *, int),
360: fpos_t (*)(void *, fpos_t, int),
1.21 millert 361: int (*)(void *));
1.1 deraadt 362: __END_DECLS
363: #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
364: #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
1.33 millert 365: #endif /* __BSD_VISIBLE */
1.1 deraadt 366:
367: /*
368: * Functions internal to the implementation.
369: */
370: __BEGIN_DECLS
1.20 millert 371: int __srget(FILE *);
372: int __swbuf(int, FILE *);
1.1 deraadt 373: __END_DECLS
374:
375: /*
376: * The __sfoo macros are here so that we can
377: * define function versions in the C library.
378: */
379: #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
1.22 millert 380: #if defined(__GNUC__)
1.1 deraadt 381: static __inline int __sputc(int _c, FILE *_p) {
382: if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
383: return (*_p->_p++ = _c);
384: else
385: return (__swbuf(_c, _p));
386: }
387: #else
388: /*
389: * This has been tuned to generate reasonable code on the vax using pcc.
390: */
391: #define __sputc(c, p) \
392: (--(p)->_w < 0 ? \
393: (p)->_w >= (p)->_lbfsize ? \
394: (*(p)->_p = (c)), *(p)->_p != '\n' ? \
395: (int)*(p)->_p++ : \
396: __swbuf('\n', p) : \
397: __swbuf((int)(c), p) : \
398: (*(p)->_p = (c), (int)*(p)->_p++))
399: #endif
400:
401: #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
402: #define __sferror(p) (((p)->_flags & __SERR) != 0)
403: #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
404: #define __sfileno(p) ((p)->_file)
405:
406: #define feof(p) __sfeof(p)
407: #define ferror(p) __sferror(p)
1.10 d 408:
409: #ifndef _POSIX_THREADS
1.1 deraadt 410: #define clearerr(p) __sclearerr(p)
1.10 d 411: #endif
1.1 deraadt 412:
1.33 millert 413: #if __POSIX_VISIBLE
1.1 deraadt 414: #define fileno(p) __sfileno(p)
415: #endif
416:
417: #ifndef lint
1.10 d 418: #ifndef _POSIX_THREADS
1.1 deraadt 419: #define getc(fp) __sgetc(fp)
1.10 d 420: #endif /* _POSIX_THREADS */
421: #define getc_unlocked(fp) __sgetc(fp)
1.7 tholo 422: /*
1.10 d 423: * The macro implementations of putc and putc_unlocked are not
424: * fully POSIX compliant; they do not set errno on failure
1.7 tholo 425: */
1.33 millert 426: #if __BSD_VISIBLE
1.10 d 427: #ifndef _POSIX_THREADS
1.1 deraadt 428: #define putc(x, fp) __sputc(x, fp)
1.10 d 429: #endif /* _POSIX_THREADS */
430: #define putc_unlocked(x, fp) __sputc(x, fp)
1.33 millert 431: #endif /* __BSD_VISIBLE */
1.1 deraadt 432: #endif /* lint */
433:
434: #define getchar() getc(stdin)
435: #define putchar(x) putc(x, stdout)
1.10 d 436: #define getchar_unlocked() getc_unlocked(stdin)
437: #define putchar_unlocked(c) putc_unlocked(c, stdout)
438:
1.1 deraadt 439: #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