1 /* $OpenBSD: stdio.h,v 1.35 2006/01/13 18:10:09 miod Exp $ */
2 /* $NetBSD: stdio.h,v 1.18 1996/04/25 18:29:21 jtc Exp $ */
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. Neither the name of the University nor the names of its contributors
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
41 #include <sys/cdefs.h>
42 #include <sys/types.h>
43
44 /* va_list and size_t must be defined by stdio.h according to Posix */
45 #define __need___va_list
46 #include <stdarg.h>
47
48 /* note that this forces stddef.h to *only* define size_t */
49 #define __need_size_t
50 #include <stddef.h>
51
52 #define __need_NULL
53 #include <stddef.h>
54
55 #define _FSTDIO /* Define for new stdio with functions. */
56
57 typedef off_t fpos_t; /* stdio file position type */
58
59 /*
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.
63 */
64
65 /* stdio buffers */
66 struct __sbuf {
67 unsigned char *_base;
68 int _size;
69 };
70
71 /*
72 * stdio state variables.
73 *
74 * The following always hold:
75 *
76 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
77 * _lbfsize is -_bf._size, else _lbfsize is 0
78 * if _flags&__SRD, _w is 0
79 * if _flags&__SWR, _r is 0
80 *
81 * This ensures that the getc and putc macros (or inline functions) never
82 * try to write or read from a file that is in `read' or `write' mode.
83 * (Moreover, they can, and do, automatically switch from read mode to
84 * write mode, and back, on "r+" and "w+" files.)
85 *
86 * _lbfsize is used only to make the inline line-buffered output stream
87 * code as compact as possible.
88 *
89 * _ub, _up, and _ur are used when ungetc() pushes back more characters
90 * than fit in the current _bf, or when ungetc() pushes back a character
91 * that does not match the previous one in _bf. When this happens,
92 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
93 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
94 *
95 * NOTE: if you change this structure, you also need to update the
96 * std() initializer in findfp.c.
97 */
98 typedef struct __sFILE {
99 unsigned char *_p; /* current position in (some) buffer */
100 int _r; /* read space left for getc() */
101 int _w; /* write space left for putc() */
102 short _flags; /* flags, below; this FILE is free if 0 */
103 short _file; /* fileno, if Unix descriptor, else -1 */
104 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
105 int _lbfsize; /* 0 or -_bf._size, for inline putc */
106
107 /* operations */
108 void *_cookie; /* cookie passed to io functions */
109 int (*_close)(void *);
110 int (*_read)(void *, char *, int);
111 fpos_t (*_seek)(void *, fpos_t, int);
112 int (*_write)(void *, const char *, int);
113
114 /* extension data, to avoid further ABI breakage */
115 struct __sbuf _ext;
116 /* data for long sequences of ungetc() */
117 unsigned char *_up; /* saved _p when _p is doing ungetc data */
118 int _ur; /* saved _r when _r is counting ungetc data */
119
120 /* tricks to meet minimum requirements even when malloc() fails */
121 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
122 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
123
124 /* separate buffer for fgetln() when line crosses buffer boundary */
125 struct __sbuf _lb; /* buffer for fgetln() */
126
127 /* Unix stdio files get aligned to block boundaries on fseek() */
128 int _blksize; /* stat.st_blksize (may be != _bf._size) */
129 fpos_t _offset; /* current lseek offset */
130 } FILE;
131
132 __BEGIN_DECLS
133 extern FILE __sF[];
134 __END_DECLS
135
136 #define __SLBF 0x0001 /* line buffered */
137 #define __SNBF 0x0002 /* unbuffered */
138 #define __SRD 0x0004 /* OK to read */
139 #define __SWR 0x0008 /* OK to write */
140 /* RD and WR are never simultaneously asserted */
141 #define __SRW 0x0010 /* open for reading & writing */
142 #define __SEOF 0x0020 /* found EOF */
143 #define __SERR 0x0040 /* found error */
144 #define __SMBF 0x0080 /* _buf is from malloc */
145 #define __SAPP 0x0100 /* fdopen()ed in append mode */
146 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
147 #define __SOPT 0x0400 /* do fseek() optimisation */
148 #define __SNPT 0x0800 /* do not do fseek() optimisation */
149 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
150 #define __SMOD 0x2000 /* true => fgetln modified _p text */
151 #define __SALC 0x4000 /* allocate string space dynamically */
152
153 /*
154 * The following three definitions are for ANSI C, which took them
155 * from System V, which brilliantly took internal interface macros and
156 * made them official arguments to setvbuf(), without renaming them.
157 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
158 *
159 * Although numbered as their counterparts above, the implementation
160 * does not rely on this.
161 */
162 #define _IOFBF 0 /* setvbuf should set fully buffered */
163 #define _IOLBF 1 /* setvbuf should set line buffered */
164 #define _IONBF 2 /* setvbuf should set unbuffered */
165
166 #define BUFSIZ 1024 /* size of buffer used by setbuf */
167
168 #define EOF (-1)
169
170 /*
171 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors
172 * that the kernel can provide without allocation of a resource that can
173 * fail without the process sleeping. Do not use this for anything.
174 */
175 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
176 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
177
178 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
179 #if __BSD_VISIBLE || __XPG_VISIBLE
180 #define P_tmpdir "/tmp/"
181 #endif
182 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
183 #define TMP_MAX 308915776
184
185 #ifndef SEEK_SET
186 #define SEEK_SET 0 /* set file offset to offset */
187 #endif
188 #ifndef SEEK_CUR
189 #define SEEK_CUR 1 /* set file offset to current plus offset */
190 #endif
191 #ifndef SEEK_END
192 #define SEEK_END 2 /* set file offset to EOF plus offset */
193 #endif
194
195 #define stdin (&__sF[0])
196 #define stdout (&__sF[1])
197 #define stderr (&__sF[2])
198
199 /*
200 * Functions defined in ANSI C standard.
201 */
202 __BEGIN_DECLS
203 void clearerr(FILE *);
204 int fclose(FILE *);
205 int feof(FILE *);
206 int ferror(FILE *);
207 int fflush(FILE *);
208 int fgetc(FILE *);
209 int fgetpos(FILE *, fpos_t *);
210 char *fgets(char *, int, FILE *);
211 FILE *fopen(const char *, const char *);
212 int fprintf(FILE *, const char *, ...);
213 int fputc(int, FILE *);
214 int fputs(const char *, FILE *);
215 size_t fread(void *, size_t, size_t, FILE *);
216 FILE *freopen(const char *, const char *, FILE *);
217 int fscanf(FILE *, const char *, ...);
218 int fseek(FILE *, long, int);
219 int fseeko(FILE *, off_t, int);
220 int fsetpos(FILE *, const fpos_t *);
221 long ftell(FILE *);
222 off_t ftello(FILE *);
223 size_t fwrite(const void *, size_t, size_t, FILE *);
224 int getc(FILE *);
225 int getchar(void);
226 char *gets(char *);
227 #if __BSD_VISIBLE && !defined(__SYS_ERRLIST)
228 #define __SYS_ERRLIST
229
230 extern int sys_nerr; /* perror(3) external variables */
231 extern char *sys_errlist[];
232 #endif
233 void perror(const char *);
234 int printf(const char *, ...);
235 int putc(int, FILE *);
236 int putchar(int);
237 int puts(const char *);
238 int remove(const char *);
239 int rename(const char *, const char *);
240 void rewind(FILE *);
241 int scanf(const char *, ...);
242 void setbuf(FILE *, char *);
243 int setvbuf(FILE *, char *, int, size_t);
244 int sprintf(char *, const char *, ...);
245 int sscanf(const char *, const char *, ...);
246 FILE *tmpfile(void);
247 char *tmpnam(char *);
248 int ungetc(int, FILE *);
249 int vfprintf(FILE *, const char *, __va_list);
250 int vprintf(const char *, __va_list);
251 int vsprintf(char *, const char *, __va_list);
252
253 #if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE
254 int snprintf(char *, size_t, const char *, ...)
255 __attribute__((__format__ (printf, 3, 4)))
256 __attribute__((__nonnull__ (3)));
257 int vfscanf(FILE *, const char *, __va_list)
258 __attribute__((__format__ (scanf, 2, 0)))
259 __attribute__((__nonnull__ (2)));
260 int vscanf(const char *, __va_list)
261 __attribute__((__format__ (scanf, 1, 0)))
262 __attribute__((__nonnull__ (1)));
263 int vsnprintf(char *, size_t, const char *, __va_list)
264 __attribute__((__format__ (printf, 3, 0)))
265 __attribute__((__nonnull__ (3)));
266 int vsscanf(const char *, const char *, __va_list)
267 __attribute__((__format__ (scanf, 2, 0)))
268 __attribute__((__nonnull__ (2)));
269 #endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */
270
271 __END_DECLS
272
273
274 /*
275 * Functions defined in POSIX 1003.1.
276 */
277 #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE
278 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
279 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */
280
281 __BEGIN_DECLS
282 #if 0 /* MISSING FROM BIONIC */
283 char *ctermid(char *);
284 char *cuserid(char *);
285 #endif /* MISSING */
286 FILE *fdopen(int, const char *);
287 int fileno(FILE *);
288
289 #if (__POSIX_VISIBLE >= 199209)
290 int pclose(FILE *);
291 FILE *popen(const char *, const char *);
292 #endif
293
294 #if __POSIX_VISIBLE >= 199506
295 void flockfile(FILE *);
296 int ftrylockfile(FILE *);
297 void funlockfile(FILE *);
298
299 /*
300 * These are normally used through macros as defined below, but POSIX
301 * requires functions as well.
302 */
303 int getc_unlocked(FILE *);
304 int getchar_unlocked(void);
305 int putc_unlocked(int, FILE *);
306 int putchar_unlocked(int);
307 #endif /* __POSIX_VISIBLE >= 199506 */
308
309 #if __XPG_VISIBLE
310 char *tempnam(const char *, const char *);
311 #endif
312 __END_DECLS
313
314 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */
315
316 /*
317 * Routines that are purely local.
318 */
319 #if __BSD_VISIBLE
320 __BEGIN_DECLS
321 int asprintf(char **, const char *, ...)
322 __attribute__((__format__ (printf, 2, 3)))
323 __attribute__((__nonnull__ (2)));
324 char *fgetln(FILE *, size_t *);
325 int fpurge(FILE *);
326 int getw(FILE *);
327 int putw(int, FILE *);
328 void setbuffer(FILE *, char *, int);
329 int setlinebuf(FILE *);
330 int vasprintf(char **, const char *, __va_list)
331 __attribute__((__format__ (printf, 2, 0)))
332 __attribute__((__nonnull__ (2)));
333 __END_DECLS
334
335 /*
336 * Stdio function-access interface.
337 */
338 __BEGIN_DECLS
339 FILE *funopen(const void *,
340 int (*)(void *, char *, int),
341 int (*)(void *, const char *, int),
342 fpos_t (*)(void *, fpos_t, int),
343 int (*)(void *));
344 __END_DECLS
345 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
346 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
347 #endif /* __BSD_VISIBLE */
348
349 /*
350 * Functions internal to the implementation.
351 */
352 __BEGIN_DECLS
353 int __srget(FILE *);
354 int __swbuf(int, FILE *);
355 __END_DECLS
356
357 /*
358 * The __sfoo macros are here so that we can
359 * define function versions in the C library.
360 */
361 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
362 #if defined(__GNUC__)
__sputc(int _c,FILE * _p)363 static __inline int __sputc(int _c, FILE *_p) {
364 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
365 return (*_p->_p++ = _c);
366 else
367 return (__swbuf(_c, _p));
368 }
369 #else
370 /*
371 * This has been tuned to generate reasonable code on the vax using pcc.
372 */
373 #define __sputc(c, p) \
374 (--(p)->_w < 0 ? \
375 (p)->_w >= (p)->_lbfsize ? \
376 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
377 (int)*(p)->_p++ : \
378 __swbuf('\n', p) : \
379 __swbuf((int)(c), p) : \
380 (*(p)->_p = (c), (int)*(p)->_p++))
381 #endif
382
383 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
384 #define __sferror(p) (((p)->_flags & __SERR) != 0)
385 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
386 #define __sfileno(p) ((p)->_file)
387
388 #define feof(p) __sfeof(p)
389 #define ferror(p) __sferror(p)
390
391 #ifndef _POSIX_THREADS
392 #define clearerr(p) __sclearerr(p)
393 #endif
394
395 #if __POSIX_VISIBLE
396 #define fileno(p) __sfileno(p)
397 #endif
398
399 #ifndef lint
400 #ifndef _POSIX_THREADS
401 #define getc(fp) __sgetc(fp)
402 #endif /* _POSIX_THREADS */
403 #define getc_unlocked(fp) __sgetc(fp)
404 /*
405 * The macro implementations of putc and putc_unlocked are not
406 * fully POSIX compliant; they do not set errno on failure
407 */
408 #if __BSD_VISIBLE
409 #ifndef _POSIX_THREADS
410 #define putc(x, fp) __sputc(x, fp)
411 #endif /* _POSIX_THREADS */
412 #define putc_unlocked(x, fp) __sputc(x, fp)
413 #endif /* __BSD_VISIBLE */
414 #endif /* lint */
415
416 #define getchar() getc(stdin)
417 #define putchar(x) putc(x, stdout)
418 #define getchar_unlocked() getc_unlocked(stdin)
419 #define putchar_unlocked(c) putc_unlocked(c, stdout)
420
421 #ifdef _GNU_SOURCE
422 /*
423 * glibc defines dprintf(int, const char*, ...), which is poorly named
424 * and likely to conflict with locally defined debugging printfs
425 * fdprintf is a better name, and some programs that use fdprintf use a
426 * #define fdprintf dprintf for compatibility
427 */
428 int fdprintf(int, const char*, ...);
429 int vfdprintf(int, const char*, __va_list);
430 #endif /* _GNU_SOURCE */
431
432 #endif /* _STDIO_H_ */
433