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