ANSI
[unix-history] / usr / src / include / stdio.h
CommitLineData
238b8fe5
KB
1/*-
2 * Copyright (c) 1990 The Regents of the University of California.
3 * All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Chris Torek.
7 *
8 * %sccs.include.redist.c%
586c39b1 9 *
6124b236 10 * @(#)stdio.h 5.15 (Berkeley) %G%
586c39b1
DF
11 */
12
238b8fe5
KB
13#ifndef _STDIO_H_
14#define _STDIO_H_
15
5038e9e5 16#include <sys/cdefs.h>
238b8fe5 17
6124b236 18#include <machine/ansi.h>
238b8fe5
KB
19#ifdef _SIZE_T_
20typedef _SIZE_T_ size_t;
21#undef _SIZE_T_
22#endif
23
97b8a2b7
KB
24#ifndef NULL
25#define NULL 0
26#endif
27
238b8fe5
KB
28typedef long fpos_t; /* Must match off_t <sys/types.h> */
29
30#define _FSTDIO /* Define for new stdio with functions. */
31
5038e9e5
KB
32/*
33 * NB: to fit things in six character monocase externals, the stdio
34 * code uses the prefix `__s' for stdio objects, typically followed
35 * by a three-character attempt at a mnemonic.
36 */
37
238b8fe5
KB
38/* stdio buffers */
39struct __sbuf {
40 unsigned char *_base;
41 int _size;
42};
43
44/*
45 * stdio state variables.
46 *
47 * The following always hold:
48 *
49 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
50 * _lbfsize is -_bf._size, else _lbfsize is 0
51 * if _flags&__SRD, _w is 0
52 * if _flags&__SWR, _r is 0
53 *
54 * This ensures that the getc and putc macros (or inline functions) never
55 * try to write or read from a file that is in `read' or `write' mode.
56 * (Moreover, they can, and do, automatically switch from read mode to
57 * write mode, and back, on "r+" and "w+" files.)
58 *
59 * _lbfsize is used only to make the inline line-buffered output stream
60 * code as compact as possible.
61 *
62 * _ub, _up, and _ur are used when ungetc() pushes back more characters
63 * than fit in the current _bf, or when ungetc() pushes back a character
64 * that does not match the previous one in _bf. When this happens,
65 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
66 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
67 */
68typedef struct __sFILE {
69 unsigned char *_p; /* current position in (some) buffer */
70 int _r; /* read space left for getc() */
71 int _w; /* write space left for putc() */
72 short _flags; /* flags, below; this FILE is free if 0 */
73 short _file; /* fileno, if Unix descriptor, else -1 */
74 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
75 int _lbfsize; /* 0 or -_bf._size, for inline putc */
76
77 /* operations */
78 void *_cookie; /* cookie passed to io functions */
4b22ff03
DS
79 int (*_close) __P((void *));
80 int (*_read) __P((void *, char *, int));
81 fpos_t (*_seek) __P((void *, fpos_t, int));
82 int (*_write) __P((void *, const char *, int));
238b8fe5
KB
83
84 /* separate buffer for long sequences of ungetc() */
85 struct __sbuf _ub; /* ungetc buffer */
86 unsigned char *_up; /* saved _p when _p is doing ungetc data */
87 int _ur; /* saved _r when _r is counting ungetc data */
88
89 /* tricks to meet minimum requirements even when malloc() fails */
90 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
91 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
92
93 /* separate buffer for fgetline() when line crosses buffer boundary */
94 struct __sbuf _lb; /* buffer for fgetline() */
95
96 /* Unix stdio files get aligned to block boundaries on fseek() */
97 int _blksize; /* stat.st_blksize (may be != _bf._size) */
98 int _offset; /* current lseek offset */
99} FILE;
100
d9f57e12 101__BEGIN_DECLS
238b8fe5 102extern FILE __sF[];
d9f57e12 103__END_DECLS
238b8fe5
KB
104
105#define __SLBF 0x0001 /* line buffered */
106#define __SNBF 0x0002 /* unbuffered */
107#define __SRD 0x0004 /* OK to read */
108#define __SWR 0x0008 /* OK to write */
109 /* RD and WR are never simultaneously asserted */
110#define __SRW 0x0010 /* open for reading & writing */
111#define __SEOF 0x0020 /* found EOF */
112#define __SERR 0x0040 /* found error */
113#define __SMBF 0x0080 /* _buf is from malloc */
114#define __SAPP 0x0100 /* fdopen()ed in append mode */
115#define __SSTR 0x0200 /* this is an sprintf/snprintf string */
116#define __SOPT 0x0400 /* do fseek() optimisation */
117#define __SNPT 0x0800 /* do not do fseek() optimisation */
118#define __SOFF 0x1000 /* set iff _offset is in fact correct */
119#define __SMOD 0x2000 /* true => fgetline modified _p text */
120
121/*
122 * The following three definitions are for ANSI C, which took them
123 * from System V, which brilliantly took internal interface macros and
124 * made them official arguments to setvbuf(), without renaming them.
125 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
126 *
127 * Although numbered as their counterparts above, the implementation
128 * does not rely on this.
129 */
130#define _IOFBF 0 /* setvbuf should set fully buffered */
131#define _IOLBF 1 /* setvbuf should set line buffered */
132#define _IONBF 2 /* setvbuf should set unbuffered */
133
134#define BUFSIZ 1024 /* size of buffer used by setbuf */
7002c7bd
MT
135#define EOF (-1)
136
238b8fe5
KB
137/*
138 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors
139 * that the kernel can provide without allocation of a resource that can
140 * fail without the process sleeping. Do not use this for anything.
141 */
142#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
143#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
7002c7bd 144
238b8fe5
KB
145/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
146#ifndef _ANSI_SOURCE
45c3183f 147#define P_tmpdir "/var/tmp/"
238b8fe5
KB
148#endif
149#define L_tmpnam 1024 /* XXX must be == PATH_MAX */
150#define TMP_MAX 308915776
151
152#ifndef SEEK_SET
153#define SEEK_SET 0 /* set file offset to offset */
154#endif
155#ifndef SEEK_CUR
156#define SEEK_CUR 1 /* set file offset to current plus offset */
157#endif
158#ifndef SEEK_END
159#define SEEK_END 2 /* set file offset to EOF plus offset */
160#endif
161
162#define stdin (&__sF[0])
163#define stdout (&__sF[1])
164#define stderr (&__sF[2])
165
166/*
167 * Functions defined in ANSI C standard.
168 */
5038e9e5
KB
169__BEGIN_DECLS
170void clearerr __P((FILE *));
171int fclose __P((FILE *));
172int feof __P((FILE *));
173int ferror __P((FILE *));
174int fflush __P((FILE *));
175int fgetc __P((FILE *));
176int fgetpos __P((FILE *, fpos_t *));
177char *fgets __P((char *, size_t, FILE *));
4b22ff03 178FILE *fopen __P((const char *, const char *));
5038e9e5
KB
179int fprintf __P((FILE *, const char *, ...));
180int fputc __P((int, FILE *));
181int fputs __P((const char *, FILE *));
4b22ff03
DS
182int fread __P((void *, size_t, size_t, FILE *));
183FILE *freopen __P((const char *, const char *, FILE *));
5038e9e5
KB
184int fscanf __P((FILE *, const char *, ...));
185int fseek __P((FILE *, long, int));
186int fsetpos __P((FILE *, const fpos_t *));
187long ftell __P((const FILE *));
4b22ff03 188int fwrite __P((const void *, size_t, size_t, FILE *));
5038e9e5
KB
189int getc __P((FILE *));
190int getchar __P((void));
191char *gets __P((char *));
192void perror __P((const char *));
193int printf __P((const char *, ...));
194int putc __P((int, FILE *));
195int putchar __P((int));
196int puts __P((const char *));
197int remove __P((const char *));
4b22ff03 198int rename __P((const char *, const char *));
5038e9e5
KB
199void rewind __P((FILE *));
200int scanf __P((const char *, ...));
201void setbuf __P((FILE *, char *));
202int setvbuf __P((FILE *, char *, int, size_t));
203int sprintf __P((char *, const char *, ...));
204int sscanf __P((char *, const char *, ...));
205FILE *tmpfile __P((void));
206char *tmpnam __P((char *));
207int ungetc __P((int, FILE *));
208int vfprintf __P((FILE *, const char *, _VA_LIST_));
209int vprintf __P((const char *, _VA_LIST_));
210int vsprintf __P((char *, const char *, _VA_LIST_));
211__END_DECLS
238b8fe5
KB
212
213/*
214 * Functions defined in POSIX 1003.1.
215 */
216#ifndef _ANSI_SOURCE
217#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */
218#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
219
5038e9e5 220__BEGIN_DECLS
41dd63a8 221char *ctermid __P((char *));
5038e9e5
KB
222FILE *fdopen __P((int, const char *));
223int fileno __P((FILE *));
224__END_DECLS
4b22ff03 225#endif /* not ANSI */
238b8fe5
KB
226
227/*
228 * Routines that are purely local.
229 */
4b22ff03 230#if !defined (_ANSI_SOURCE) && !defined(_POSIX_SOURCE)
5038e9e5
KB
231__BEGIN_DECLS
232char *fgetline __P((FILE *, size_t *));
233int fpurge __P((FILE *));
234int getw __P((FILE *));
235int pclose __P((FILE *));
4b22ff03 236FILE *popen __P((const char *, const char *));
5038e9e5
KB
237int putw __P((int, FILE *));
238void setbuffer __P((FILE *, char *, int));
239int setlinebuf __P((FILE *));
45c3183f 240char *tempnam __P((const char *, const char *));
5038e9e5
KB
241int snprintf __P((char *, size_t, const char *, ...));
242int vsnprintf __P((char *, size_t, const char *, _VA_LIST_));
243__END_DECLS
cede253f 244
6b5bab0e
DS
245/*
246 * This is a #define because the function is used internally and
247 * (unlike vfscanf) the name __svfscanf is guaranteed not to collide
248 * with a user function when _ANSI_SOURCE or _POSIX_SOURCE is defined.
249 */
250#define vfscanf __svfscanf
251
238b8fe5
KB
252/*
253 * Stdio function-access interface.
254 */
5038e9e5 255__BEGIN_DECLS
4b22ff03
DS
256FILE *funopen __P((const void *,
257 int (*)(void *, char *, int),
258 int (*)(void *, const char *, int),
259 fpos_t (*)(void *, fpos_t, int),
260 int (*)(void *)));
5038e9e5 261__END_DECLS
238b8fe5
KB
262#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
263#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
d9f57e12 264#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
238b8fe5
KB
265
266/*
267 * Functions internal to the implementation.
268 */
d9f57e12 269__BEGIN_DECLS
5038e9e5 270int __srget __P((FILE *));
6b5bab0e 271int __svfscanf __P((FILE *, const char *, _VA_LIST_));
5038e9e5 272int __swbuf __P((int, FILE *));
d9f57e12 273__END_DECLS
238b8fe5
KB
274
275/*
276 * The __sfoo macros are here so that we can
277 * define function versions in the C library.
278 */
279#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
6b5bab0e
DS
280#if defined(__GNUC__) && defined(__STDC__)
281static inline int __sputc(int _c, FILE *_p) {
238b8fe5
KB
282 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
283 return (*_p->_p++ = _c);
284 else
285 return (__swbuf(_c, _p));
286}
287#else
288/*
289 * This has been tuned to generate reasonable code on the vax using pcc.
290 */
291#define __sputc(c, p) \
292 (--(p)->_w < 0 ? \
293 (p)->_w >= (p)->_lbfsize ? \
294 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
295 (int)*(p)->_p++ : \
296 __swbuf('\n', p) : \
297 __swbuf((int)(c), p) : \
298 (*(p)->_p = (c), (int)*(p)->_p++))
299#endif
300
301#define __sfeof(p) (((p)->_flags & __SEOF) != 0)
302#define __sferror(p) (((p)->_flags & __SERR) != 0)
303#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
304#define __sfileno(p) ((p)->_file)
305
306#define feof(p) __sfeof(p)
307#define ferror(p) __sferror(p)
308#define clearerr(p) __sclearerr(p)
309
310#ifndef _ANSI_SOURCE
311#define fileno(p) __sfileno(p)
312#endif
313
314#ifndef lint
315#define getc(fp) __sgetc(fp)
316#define putc(x, fp) __sputc(x, fp)
317#endif /* lint */
318
319#define getchar() getc(stdin)
320#define putchar(x) putc(x, stdout)
321#endif /* _STDIO_H_ */