Annotation of src/include/stdio.h, Revision 1.51
1.51 ! millert 1: /* $OpenBSD: stdio.h,v 1.50 2015/01/20 22:09:50 tedu 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
1.40 jsg 61: #elif defined(__cplusplus)
62: #define NULL 0L
1.11 espie 63: #else
1.39 miod 64: #define NULL ((void *)0)
1.11 espie 65: #endif
1.1 deraadt 66: #endif
67:
1.13 millert 68: #define _FSTDIO /* Define for new stdio with functions. */
1.1 deraadt 69:
1.13 millert 70: typedef off_t fpos_t; /* stdio file position type */
1.1 deraadt 71:
72: /*
73: * NB: to fit things in six character monocase externals, the stdio
74: * code uses the prefix `__s' for stdio objects, typically followed
75: * by a three-character attempt at a mnemonic.
76: */
77:
78: /* stdio buffers */
79: struct __sbuf {
80: unsigned char *_base;
81: int _size;
82: };
83:
84: /*
85: * stdio state variables.
86: *
87: * The following always hold:
88: *
89: * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
90: * _lbfsize is -_bf._size, else _lbfsize is 0
91: * if _flags&__SRD, _w is 0
92: * if _flags&__SWR, _r is 0
93: *
94: * This ensures that the getc and putc macros (or inline functions) never
95: * try to write or read from a file that is in `read' or `write' mode.
96: * (Moreover, they can, and do, automatically switch from read mode to
97: * write mode, and back, on "r+" and "w+" files.)
98: *
99: * _lbfsize is used only to make the inline line-buffered output stream
100: * code as compact as possible.
101: *
102: * _ub, _up, and _ur are used when ungetc() pushes back more characters
103: * than fit in the current _bf, or when ungetc() pushes back a character
104: * that does not match the previous one in _bf. When this happens,
105: * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
106: * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
107: */
108: typedef struct __sFILE {
109: unsigned char *_p; /* current position in (some) buffer */
110: int _r; /* read space left for getc() */
111: int _w; /* write space left for putc() */
112: short _flags; /* flags, below; this FILE is free if 0 */
113: short _file; /* fileno, if Unix descriptor, else -1 */
114: struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
115: int _lbfsize; /* 0 or -_bf._size, for inline putc */
116:
117: /* operations */
118: void *_cookie; /* cookie passed to io functions */
1.20 millert 119: int (*_close)(void *);
120: int (*_read)(void *, char *, int);
121: fpos_t (*_seek)(void *, fpos_t, int);
122: int (*_write)(void *, const char *, int);
1.1 deraadt 123:
1.31 espie 124: /* extension data, to avoid further ABI breakage */
125: struct __sbuf _ext;
126: /* data for long sequences of ungetc() */
1.1 deraadt 127: unsigned char *_up; /* saved _p when _p is doing ungetc data */
128: int _ur; /* saved _r when _r is counting ungetc data */
129:
130: /* tricks to meet minimum requirements even when malloc() fails */
131: unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
132: unsigned char _nbuf[1]; /* guarantee a getc() buffer */
133:
134: /* separate buffer for fgetln() when line crosses buffer boundary */
135: struct __sbuf _lb; /* buffer for fgetln() */
136:
137: /* Unix stdio files get aligned to block boundaries on fseek() */
138: int _blksize; /* stat.st_blksize (may be != _bf._size) */
139: fpos_t _offset; /* current lseek offset */
140: } FILE;
141:
142: __BEGIN_DECLS
143: extern FILE __sF[];
144: __END_DECLS
145:
146: #define __SLBF 0x0001 /* line buffered */
147: #define __SNBF 0x0002 /* unbuffered */
148: #define __SRD 0x0004 /* OK to read */
149: #define __SWR 0x0008 /* OK to write */
150: /* RD and WR are never simultaneously asserted */
151: #define __SRW 0x0010 /* open for reading & writing */
152: #define __SEOF 0x0020 /* found EOF */
153: #define __SERR 0x0040 /* found error */
154: #define __SMBF 0x0080 /* _buf is from malloc */
155: #define __SAPP 0x0100 /* fdopen()ed in append mode */
156: #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
157: #define __SOPT 0x0400 /* do fseek() optimisation */
158: #define __SNPT 0x0800 /* do not do fseek() optimisation */
159: #define __SOFF 0x1000 /* set iff _offset is in fact correct */
160: #define __SMOD 0x2000 /* true => fgetln modified _p text */
1.8 millert 161: #define __SALC 0x4000 /* allocate string space dynamically */
1.38 kurt 162: #define __SIGN 0x8000 /* ignore this file in _fwalk */
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:
1.25 millert 179: #define EOF (-1)
1.1 deraadt 180:
181: /*
182: * FOPEN_MAX is a minimum maximum, and should be the number of descriptors
183: * that the kernel can provide without allocation of a resource that can
184: * fail without the process sleeping. Do not use this for anything.
185: */
186: #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
187: #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
188:
189: /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
1.33 millert 190: #if __BSD_VISIBLE || __XPG_VISIBLE
1.14 millert 191: #define P_tmpdir "/tmp/"
1.1 deraadt 192: #endif
193: #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
1.50 tedu 194: #define TMP_MAX 0x7fffffff /* more, but don't overflow int */
1.1 deraadt 195:
196: #ifndef SEEK_SET
197: #define SEEK_SET 0 /* set file offset to offset */
198: #endif
199: #ifndef SEEK_CUR
200: #define SEEK_CUR 1 /* set file offset to current plus offset */
201: #endif
202: #ifndef SEEK_END
203: #define SEEK_END 2 /* set file offset to EOF plus offset */
204: #endif
205:
206: #define stdin (&__sF[0])
207: #define stdout (&__sF[1])
208: #define stderr (&__sF[2])
209:
210: /*
211: * Functions defined in ANSI C standard.
212: */
213: __BEGIN_DECLS
1.20 millert 214: void clearerr(FILE *);
1.43 brad 215: #if __POSIX_VISIBLE >= 200809
216: int dprintf(int, const char * __restrict, ...);
217: #endif
1.20 millert 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 *);
1.29 avsm 224: char *fgets(char *, int, FILE *)
225: __attribute__((__bounded__ (__string__,1,2)));
1.20 millert 226: FILE *fopen(const char *, const char *);
227: int fprintf(FILE *, const char *, ...);
228: int fputc(int, FILE *);
229: int fputs(const char *, FILE *);
1.29 avsm 230: size_t fread(void *, size_t, size_t, FILE *)
231: __attribute__((__bounded__ (__size__,1,3,2)));
1.20 millert 232: FILE *freopen(const char *, const char *, FILE *);
233: int fscanf(FILE *, const char *, ...);
234: int fseek(FILE *, long, int);
235: int fseeko(FILE *, off_t, int);
236: int fsetpos(FILE *, const fpos_t *);
237: long ftell(FILE *);
238: off_t ftello(FILE *);
1.29 avsm 239: size_t fwrite(const void *, size_t, size_t, FILE *)
240: __attribute__((__bounded__ (__size__,1,3,2)));
1.20 millert 241: int getc(FILE *);
242: int getchar(void);
1.42 fgsch 243: #if __POSIX_VISIBLE >= 200809
244: ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
245: FILE * __restrict);
246: ssize_t getline(char ** __restrict, size_t * __restrict,
247: FILE * __restrict);
248: #endif
1.33 millert 249: #if __BSD_VISIBLE && !defined(__SYS_ERRLIST)
1.5 downsj 250: #define __SYS_ERRLIST
251:
252: extern int sys_nerr; /* perror(3) external variables */
1.6 deraadt 253: extern char *sys_errlist[];
1.5 downsj 254: #endif
1.20 millert 255: void perror(const char *);
256: int printf(const char *, ...);
257: int putc(int, FILE *);
258: int putchar(int);
259: int puts(const char *);
260: int remove(const char *);
261: int rename(const char *, const char *);
1.41 matthew 262: #if __POSIX_VISIBLE >= 200809
263: int renameat(int, const char *, int, const char *);
264: #endif
1.20 millert 265: void rewind(FILE *);
266: int scanf(const char *, ...);
267: void setbuf(FILE *, char *);
268: int setvbuf(FILE *, char *, int, size_t);
269: int sprintf(char *, const char *, ...);
270: int sscanf(const char *, const char *, ...);
271: FILE *tmpfile(void);
272: char *tmpnam(char *);
273: int ungetc(int, FILE *);
1.34 millert 274: int vfprintf(FILE *, const char *, __va_list);
275: int vprintf(const char *, __va_list);
276: int vsprintf(char *, const char *, __va_list);
1.43 brad 277: #if __POSIX_VISIBLE >= 200809
278: int vdprintf(int, const char * __restrict, __va_list);
279: #endif
1.33 millert 280:
1.51 ! millert 281: #if __ISO_C_VISIBLE >= 1999 || __XPG_VISIBLE >= 500 || __BSD_VISIBLE
1.33 millert 282: int snprintf(char *, size_t, const char *, ...)
283: __attribute__((__format__ (printf, 3, 4)))
284: __attribute__((__nonnull__ (3)))
285: __attribute__((__bounded__ (__string__,1,2)));
1.51 ! millert 286: int vsnprintf(char *, size_t, const char *, __va_list)
! 287: __attribute__((__format__ (printf, 3, 0)))
! 288: __attribute__((__nonnull__ (3)))
! 289: __attribute__((__bounded__(__string__,1,2)));
! 290: #endif /* __ISO_C_VISIBLE >= 1999 || __XPG_VISIBLE >= 500 || __BSD_VISIBLE */
! 291:
! 292: #if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE
1.34 millert 293: int vfscanf(FILE *, const char *, __va_list)
1.33 millert 294: __attribute__((__format__ (scanf, 2, 0)))
295: __attribute__((__nonnull__ (2)));
1.34 millert 296: int vscanf(const char *, __va_list)
1.33 millert 297: __attribute__((__format__ (scanf, 1, 0)))
298: __attribute__((__nonnull__ (1)));
1.34 millert 299: int vsscanf(const char *, const char *, __va_list)
1.33 millert 300: __attribute__((__format__ (scanf, 2, 0)))
301: __attribute__((__nonnull__ (2)));
302: #endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */
303:
1.1 deraadt 304: __END_DECLS
305:
1.33 millert 306:
1.1 deraadt 307: /*
308: * Functions defined in POSIX 1003.1.
309: */
1.33 millert 310: #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE
1.1 deraadt 311: #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
312:
313: __BEGIN_DECLS
1.20 millert 314: char *ctermid(char *);
315: FILE *fdopen(int, const char *);
316: int fileno(FILE *);
1.33 millert 317:
318: #if __POSIX_VISIBLE >= 199209
319: int pclose(FILE *);
320: FILE *popen(const char *, const char *);
321: #endif
322:
323: #if __POSIX_VISIBLE >= 199506
1.20 millert 324: void flockfile(FILE *);
325: int ftrylockfile(FILE *);
326: void funlockfile(FILE *);
1.33 millert 327:
328: /*
329: * These are normally used through macros as defined below, but POSIX
330: * requires functions as well.
331: */
1.20 millert 332: int getc_unlocked(FILE *);
1.33 millert 333: int getchar_unlocked(void);
1.20 millert 334: int putc_unlocked(int, FILE *);
335: int putchar_unlocked(int);
1.33 millert 336: #endif /* __POSIX_VISIBLE >= 199506 */
1.44 eric 337:
338: #if __POSIX_VISIBLE >= 200809
339: FILE *fmemopen(void *, size_t, const char *);
340: FILE *open_memstream(char **, size_t *);
341: #endif /* __POSIX_VISIBLE >= 200809 */
1.33 millert 342:
343: #if __XPG_VISIBLE
344: char *tempnam(const char *, const char *);
345: #endif
1.1 deraadt 346: __END_DECLS
1.10 d 347:
1.33 millert 348: #endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */
1.1 deraadt 349:
350: /*
351: * Routines that are purely local.
352: */
1.33 millert 353: #if __BSD_VISIBLE
1.1 deraadt 354: __BEGIN_DECLS
1.20 millert 355: int asprintf(char **, const char *, ...)
1.19 espie 356: __attribute__((__format__ (printf, 2, 3)))
357: __attribute__((__nonnull__ (2)));
1.20 millert 358: char *fgetln(FILE *, size_t *);
359: int fpurge(FILE *);
360: int getw(FILE *);
361: int putw(int, FILE *);
362: void setbuffer(FILE *, char *, int);
363: int setlinebuf(FILE *);
1.34 millert 364: int vasprintf(char **, const char *, __va_list)
1.19 espie 365: __attribute__((__format__ (printf, 2, 0)))
366: __attribute__((__nonnull__ (2)));
1.1 deraadt 367: __END_DECLS
368:
369: /*
370: * Stdio function-access interface.
371: */
372: __BEGIN_DECLS
1.21 millert 373: FILE *funopen(const void *,
1.1 deraadt 374: int (*)(void *, char *, int),
375: int (*)(void *, const char *, int),
376: fpos_t (*)(void *, fpos_t, int),
1.21 millert 377: int (*)(void *));
1.1 deraadt 378: __END_DECLS
379: #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
380: #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
1.33 millert 381: #endif /* __BSD_VISIBLE */
1.1 deraadt 382:
383: /*
384: * Functions internal to the implementation.
385: */
386: __BEGIN_DECLS
1.20 millert 387: int __srget(FILE *);
388: int __swbuf(int, FILE *);
1.1 deraadt 389: __END_DECLS
390:
391: /*
392: * The __sfoo macros are here so that we can
393: * define function versions in the C library.
394: */
395: #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
1.22 millert 396: #if defined(__GNUC__)
1.1 deraadt 397: static __inline int __sputc(int _c, FILE *_p) {
398: if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
399: return (*_p->_p++ = _c);
400: else
401: return (__swbuf(_c, _p));
402: }
403: #else
404: /*
405: * This has been tuned to generate reasonable code on the vax using pcc.
406: */
407: #define __sputc(c, p) \
408: (--(p)->_w < 0 ? \
409: (p)->_w >= (p)->_lbfsize ? \
410: (*(p)->_p = (c)), *(p)->_p != '\n' ? \
411: (int)*(p)->_p++ : \
412: __swbuf('\n', p) : \
413: __swbuf((int)(c), p) : \
414: (*(p)->_p = (c), (int)*(p)->_p++))
415: #endif
416:
417: #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
418: #define __sferror(p) (((p)->_flags & __SERR) != 0)
419: #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
420: #define __sfileno(p) ((p)->_file)
421:
1.38 kurt 422: extern int __isthreaded;
1.10 d 423:
1.38 kurt 424: #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
425: #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
426: #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
1.1 deraadt 427:
1.33 millert 428: #if __POSIX_VISIBLE
1.38 kurt 429: #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
1.1 deraadt 430: #endif
431:
1.38 kurt 432: #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
433:
434: #if __BSD_VISIBLE
435: /*
436: * The macro implementations of putc and putc_unlocked are not
437: * fully POSIX compliant; they do not set errno on failure
438: */
439: #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
440: #endif /* __BSD_VISIBLE */
441:
442: #if __POSIX_VISIBLE >= 199506
1.10 d 443: #define getc_unlocked(fp) __sgetc(fp)
1.7 tholo 444: /*
1.10 d 445: * The macro implementations of putc and putc_unlocked are not
446: * fully POSIX compliant; they do not set errno on failure
1.7 tholo 447: */
1.33 millert 448: #if __BSD_VISIBLE
1.10 d 449: #define putc_unlocked(x, fp) __sputc(x, fp)
1.33 millert 450: #endif /* __BSD_VISIBLE */
1.38 kurt 451: #endif /* __POSIX_VISIBLE >= 199506 */
1.1 deraadt 452:
453: #define getchar() getc(stdin)
454: #define putchar(x) putc(x, stdout)
1.10 d 455: #define getchar_unlocked() getc_unlocked(stdin)
456: #define putchar_unlocked(c) putc_unlocked(c, stdout)
457:
1.1 deraadt 458: #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