2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)stdio.h 8.5 (Berkeley) 4/29/95
43 #include <sys/cdefs.h>
44 #include <sys/_types.h>
46 #ifndef _SIZE_T_DECLARED
47 typedef __size_t size_t;
48 #define _SIZE_T_DECLARED
55 typedef __off_t fpos_t;
57 #define _FSTDIO /* Define for new stdio with functions. */
60 * NB: to fit things in six character monocase externals, the stdio
61 * code uses the prefix `__s' for stdio objects, typically followed
62 * by a three-character attempt at a mnemonic.
71 /* hold a buncha junk that would grow the ABI */
75 * stdio state variables.
77 * The following always hold:
79 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
80 * _lbfsize is -_bf._size, else _lbfsize is 0
81 * if _flags&__SRD, _w is 0
82 * if _flags&__SWR, _r is 0
84 * This ensures that the getc and putc macros (or inline functions) never
85 * try to write or read from a file that is in `read' or `write' mode.
86 * (Moreover, they can, and do, automatically switch from read mode to
87 * write mode, and back, on "r+" and "w+" files.)
89 * _lbfsize is used only to make the inline line-buffered output stream
90 * code as compact as possible.
92 * _ub, _up, and _ur are used when ungetc() pushes back more characters
93 * than fit in the current _bf, or when ungetc() pushes back a character
94 * that does not match the previous one in _bf. When this happens,
95 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
96 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
98 * NB: see WARNING above before changing the layout of this structure!
100 typedef struct __sFILE {
101 unsigned char *_p; /* current position in (some) buffer */
102 int _r; /* read space left for getc() */
103 int _w; /* write space left for putc() */
104 short _flags; /* flags, below; this FILE is free if 0 */
105 short _file; /* fileno, if Unix descriptor, else -1 */
106 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
107 int _lbfsize; /* 0 or -_bf._size, for inline putc */
110 void *_cookie; /* cookie passed to io functions */
111 int (*_close)(void *);
112 int (*_read)(void *, char *, int);
113 fpos_t (*_seek)(void *, fpos_t, int);
114 int (*_write)(void *, const char *, int);
116 /* separate buffer for long sequences of ungetc() */
117 struct __sbuf _ub; /* ungetc buffer */
118 struct __sFILEX *_extra; /* additions to FILE to not break ABI */
119 int _ur; /* saved _r when _r is counting ungetc data */
121 /* tricks to meet minimum requirements even when malloc() fails */
122 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
123 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
125 /* separate buffer for fgetln() when line crosses buffer boundary */
126 struct __sbuf _lb; /* buffer for fgetln() */
128 /* Unix stdio files get aligned to block boundaries on fseek() */
129 int _blksize; /* stat.st_blksize (may be != _bf._size) */
130 fpos_t _offset; /* current lseek offset (see WARNING) */
135 extern FILE *__stdinp;
136 extern FILE *__stdoutp;
137 extern FILE *__stderrp;
140 #define __SLBF 0x0001 /* line buffered */
141 #define __SNBF 0x0002 /* unbuffered */
142 #define __SRD 0x0004 /* OK to read */
143 #define __SWR 0x0008 /* OK to write */
144 /* RD and WR are never simultaneously asserted */
145 #define __SRW 0x0010 /* open for reading & writing */
146 #define __SEOF 0x0020 /* found EOF */
147 #define __SERR 0x0040 /* found error */
148 #define __SMBF 0x0080 /* _buf is from malloc */
149 #define __SAPP 0x0100 /* fdopen()ed in append mode */
150 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
151 #define __SOPT 0x0400 /* do fseek() optimization */
152 #define __SNPT 0x0800 /* do not do fseek() optimization */
153 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
154 #define __SMOD 0x2000 /* true => fgetln modified _p text */
155 #define __SALC 0x4000 /* allocate string space dynamically */
156 #define __SIGN 0x8000 /* ignore this file in _fwalk */
159 * The following three definitions are for ANSI C, which took them
160 * from System V, which brilliantly took internal interface macros and
161 * made them official arguments to setvbuf(), without renaming them.
162 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
164 * Although numbered as their counterparts above, the implementation
165 * does not rely on this.
167 #define _IOFBF 0 /* setvbuf should set fully buffered */
168 #define _IOLBF 1 /* setvbuf should set line buffered */
169 #define _IONBF 2 /* setvbuf should set unbuffered */
171 #define BUFSIZ 1024 /* size of buffer used by setbuf */
175 * FOPEN_MAX is a minimum maximum, and is the number of streams that
176 * stdio can provide without attempting to allocate further resources
177 * (which could fail). Do not use this for anything.
179 /* must be == _POSIX_STREAM_MAX <limits.h> */
180 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
181 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
183 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
185 #define P_tmpdir "/var/tmp/"
187 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
188 #define TMP_MAX 308915776
191 #define SEEK_SET 0 /* set file offset to offset */
194 #define SEEK_CUR 1 /* set file offset to current plus offset */
197 #define SEEK_END 2 /* set file offset to EOF plus offset */
200 /* To be removed by 5.0-RELEASE */
201 #if (defined(__i386__) || defined(__alpha__)) && defined(_OLD_STDIO)
202 #define stdin (&__sF[0])
203 #define stdout (&__sF[1])
204 #define stderr (&__sF[2])
206 #define stdin __stdinp
207 #define stdout __stdoutp
208 #define stderr __stderrp
213 * Functions defined in ANSI C standard.
215 void clearerr(FILE *);
221 int fgetpos(FILE *, fpos_t *);
222 char *fgets(char *, int, FILE *);
223 FILE *fopen(const char *, const char *);
224 int fprintf(FILE * __restrict, const char * __restrict, ...);
225 int fputc(int, FILE *);
226 int fputs(const char *, FILE *);
227 size_t fread(void *, size_t, size_t, FILE *);
228 FILE *freopen(const char *, const char *, FILE *);
229 int fscanf(FILE *, const char *, ...);
230 int fseek(FILE *, long, int);
231 int fsetpos(FILE *, const fpos_t *);
233 size_t fwrite(const void *, size_t, size_t, FILE *);
237 void perror(const char *);
238 int printf(const char * __restrict, ...);
239 int putc(int, FILE *);
241 int puts(const char *);
242 int remove(const char *);
243 int rename(const char *, const char *);
245 int scanf(const char *, ...);
246 void setbuf(FILE * __restrict, char * __restrict);
247 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
248 int sprintf(char * __restrict, const char * __restrict, ...);
249 int sscanf(const char *, const char *, ...);
251 char *tmpnam(char *);
252 int ungetc(int, FILE *);
253 int vfprintf(FILE * __restrict, const char * __restrict,
255 int vprintf(const char * __restrict, __va_list);
256 int vsprintf(char * __restrict, const char * __restrict,
259 #if __ISO_C_VISIBLE >= 1999
260 int snprintf(char * __restrict, size_t, const char * __restrict,
261 ...) __printflike(3, 4);
262 int vsnprintf(char * __restrict, size_t, const char * __restrict,
263 __va_list) __printflike(3, 0);
267 * Functions defined in all versions of POSIX 1003.1.
270 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
273 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
275 char *ctermid(char *);
276 FILE *fdopen(int, const char *);
278 #endif /* __POSIX_VISIBLE */
280 #if __POSIX_VISIBLE >= 199209
282 FILE *popen(const char *, const char *);
285 #if __POSIX_VISIBLE >= 199506
286 int ftrylockfile(FILE *);
287 void flockfile(FILE *);
288 void funlockfile(FILE *);
291 * These are normally used through macros as defined below, but POSIX
292 * requires functions as well.
294 int getc_unlocked(FILE *);
295 int getchar_unlocked(void);
296 int putc_unlocked(int, FILE *);
297 int putchar_unlocked(int);
300 #if __POSIX_VISIBLE >= 200112
301 int fseeko(FILE *, __off_t, int);
302 __off_t ftello(FILE *);
305 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
307 int putw(int, FILE *);
308 #endif /* BSD or X/Open before issue 6 */
311 char *tempnam(const char *, const char *);
315 * Routines that are purely local.
318 int asprintf(char **, const char *, ...) __printflike(2, 3);
319 char *ctermid_r(char *);
320 char *fgetln(FILE *, size_t *);
321 #if __GNUC__ == 2 && __GNUC_MINOR__ >= 7 || __GNUC__ >= 3
322 #define __ATTR_FORMAT_ARG __attribute__((__format_arg__(2)))
324 #define __ATTR_FORMAT_ARG
326 __const char *fmtcheck(const char *, const char *) __ATTR_FORMAT_ARG;
328 void setbuffer(FILE *, char *, int);
329 int setlinebuf(FILE *);
330 int vasprintf(char **, const char *, __va_list)
332 int vscanf(const char *, __va_list) __scanflike(1, 0);
333 int vsscanf(const char *, const char *, __va_list)
337 * The system error table contains messages for the first sys_nerr
338 * positive errno values. Use strerror() or strerror_r() from <string.h>
341 extern __const int sys_nerr;
342 extern __const char *__const sys_errlist[];
345 * This is a #define because the function is used internally and
346 * (unlike vfscanf) the name __vfscanf is guaranteed not to collide
347 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
349 #define vfscanf __vfscanf
352 * Stdio function-access interface.
354 FILE *funopen(const void *,
355 int (*)(void *, char *, int),
356 int (*)(void *, const char *, int),
357 fpos_t (*)(void *, fpos_t, int),
359 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
360 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
363 * Portability hacks. See <sys/types.h>.
365 #ifndef _FTRUNCATE_DECLARED
366 #define _FTRUNCATE_DECLARED
367 int ftruncate(int, __off_t);
369 #ifndef _LSEEK_DECLARED
370 #define _LSEEK_DECLARED
371 __off_t lseek(int, __off_t, int);
373 #ifndef _MMAP_DECLARED
374 #define _MMAP_DECLARED
375 void *mmap(void *, size_t, int, int, int, __off_t);
377 #ifndef _TRUNCATE_DECLARED
378 #define _TRUNCATE_DECLARED
379 int truncate(const char *, __off_t);
381 #endif /* __BSD_VISIBLE */
384 * Functions internal to the implementation.
387 int __vfscanf(FILE *, const char *, __va_list);
388 int __svfscanf(FILE *, const char *, __va_list);
389 int __swbuf(int, FILE *);
392 * The __sfoo macros are here so that we can
393 * define function versions in the C library.
395 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
396 #if defined(__GNUC__) && defined(__STDC__)
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);
401 return (__swbuf(_c, _p));
405 * This has been tuned to generate reasonable code on the vax using pcc.
407 #define __sputc(c, p) \
409 (p)->_w >= (p)->_lbfsize ? \
410 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
413 __swbuf((int)(c), p) : \
414 (*(p)->_p = (c), (int)*(p)->_p++))
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)
423 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
424 * B.8.2.7 for the rationale behind the *_unlocked() macros.
426 #define feof_unlocked(p) __sfeof(p)
427 #define ferror_unlocked(p) __sferror(p)
428 #define clearerr_unlocked(p) __sclearerr(p)
429 #define fileno_unlocked(p) __sfileno(p)
430 #define getc_unlocked(fp) __sgetc(fp)
431 #define putc_unlocked(x, fp) __sputc(x, fp)
433 #define getchar_unlocked() getc_unlocked(stdin)
434 #define putchar_unlocked(x) putc_unlocked(x, stdout)
437 #endif /* !_STDIO_H_ */