xref: /haiku/headers/posix/libio.h (revision a127b88ecbfab58f64944c98aa47722a18e363b2)
1 /* Copyright (C) 1991,92,93,94,95,97,98,99,2000,2001 Free Software Foundation, Inc.
2    This file is part of the GNU IO Library.
3    Written by Per Bothner <bothner@cygnus.com>.
4 
5    This library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2, or (at
8    your option) any later version.
9 
10    This library is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14 
15    You should have received a copy of the GNU General Public License
16    along with this library; see the file COPYING.  If not, write to
17    the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
18    MA 02111-1307, USA.
19 
20    As a special exception, if you link this library with files
21    compiled with a GNU compiler to produce an executable, this does
22    not cause the resulting executable to be covered by the GNU General
23    Public License.  This exception does not however invalidate any
24    other reasons why the executable file might be covered by the GNU
25    General Public License.
26 */
27 #ifndef _IO_STDIO_H_
28 #define _IO_STDIO_H_
29 
30 #include <sys/types.h>
31 #include <stdarg.h>
32 
33 #ifndef EOF
34 #	define EOF (-1)
35 #endif
36 
37 #define _IO_pos_t		off_t /* obsolete */
38 #define _IO_fpos_t		off_t
39 #define _IO_fpos64_t	off_t
40 #define _IO_size_t		size_t
41 #define _IO_ssize_t		ssize_t
42 #define _IO_off_t		off_t
43 #define _IO_off64_t 	off_t
44 #define _IO_pid_t		pid_t
45 #define _IO_uid_t		uid_t
46 #define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
47 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
48 #define _IO_BUFSIZ		BUFSIZ
49 #define _IO_va_list		va_list
50 
51 #define _IOS_INPUT		1
52 #define _IOS_OUTPUT		2
53 #define _IOS_ATEND		4
54 #define _IOS_APPEND		8
55 #define _IOS_TRUNC		16
56 #define _IOS_NOCREATE	32
57 #define _IOS_NOREPLACE	64
58 #define _IOS_BIN		128
59 
60 /* Magic numbers and bits for the _flags field.
61    The magic numbers use the high-order bits of _flags;
62    the remaining bits are available for variable flags.
63    Note: The magic numbers must all be negative if stdio
64    emulation is desired. */
65 
66 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
67 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
68 #define _IO_MAGIC_MASK 0xFFFF0000
69 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
70 #define _IO_UNBUFFERED 2
71 #define _IO_NO_READS 4 /* Reading not allowed */
72 #define _IO_NO_WRITES 8 /* Writing not allowd */
73 #define _IO_EOF_SEEN 0x10
74 #define _IO_ERR_SEEN 0x20
75 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
76 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
77 #define _IO_IN_BACKUP 0x100
78 #define _IO_LINE_BUF 0x200
79 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
80 #define _IO_CURRENTLY_PUTTING 0x800
81 #define _IO_IS_APPENDING 0x1000
82 #define _IO_IS_FILEBUF 0x2000
83 #define _IO_BAD_SEEN 0x4000
84 
85 /* These are "formatting flags" matching the iostream fmtflags enum values. */
86 #define _IO_SKIPWS 01
87 #define _IO_LEFT 02
88 #define _IO_RIGHT 04
89 #define _IO_INTERNAL 010
90 #define _IO_DEC 020
91 #define _IO_OCT 040
92 #define _IO_HEX 0100
93 #define _IO_SHOWBASE 0200
94 #define _IO_SHOWPOINT 0400
95 #define _IO_UPPERCASE 01000
96 #define _IO_SHOWPOS 02000
97 #define _IO_SCIENTIFIC 04000
98 #define _IO_FIXED 010000
99 #define _IO_UNITBUF 020000
100 #define _IO_STDIO 040000
101 #define _IO_DONT_CLOSE 0100000
102 #define _IO_BOOLALPHA 0200000
103 
104 
105 struct _IO_marker;
106 struct _IO_codecvt;
107 struct _IO_wide_data;
108 typedef void _IO_lock_t;
109 
110 
111 struct _IO_marker {
112 	struct _IO_marker	*_next;
113 	struct _IO_FILE		*_sbuf;
114 	int					_pos;
115 };
116 
117 typedef struct _IO_FILE {
118 	int		_flags;		/* High-order word is _IO_MAGIC; rest is flags. */
119 #	define _IO_file_flags _flags
120 
121 	/* The following pointers correspond to the C++ streambuf protocol. */
122 	/* Note:  Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
123 	char	*_IO_read_ptr;	/* Current read pointer */
124 	char	*_IO_read_end;	/* End of get area. */
125 	char	*_IO_read_base;	/* Start of putback+get area. */
126 	char	*_IO_write_base;	/* Start of put area. */
127 	char	*_IO_write_ptr;	/* Current put pointer. */
128 	char	*_IO_write_end;	/* End of put area. */
129 	char	*_IO_buf_base;	/* Start of reserve area. */
130 	char	*_IO_buf_end;	/* End of reserve area. */
131 	/* The following fields are used to support backing up and undo. */
132 	char	*_IO_save_base; /* Pointer to start of non-current get area. */
133 	char	*_IO_backup_base;  /* Pointer to first valid character of backup area */
134 	char	*_IO_save_end; /* Pointer to end of non-current get area. */
135 
136 	struct _IO_marker *_markers;
137 
138 	struct _IO_FILE *_chain;
139 
140 	int		_fileno;
141 /*	int		_blksize; */
142 	int		_flags2;
143 	off_t	_old_offset; /* This used to be _offset but it's too small. */
144 		/* -> not true on BeOS, but who cares */
145 
146 	/* 1+column number of pbase(); 0 is unknown. */
147 	unsigned short _cur_column;
148 	signed char _vtable_offset;
149 	char	_shortbuf[1];
150 
151 	_IO_lock_t *_lock;
152 
153 	off_t	_offset;
154 /* #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T */
155 	/* Wide character stream stuff.  */
156 	struct _IO_codecvt *_codecvt;
157 	struct _IO_wide_data *_wide_data;
158 /* #else
159  *	void	*__pad1;
160  *	void	*__pad2;
161  * #endif */
162 	int _mode;
163 	/* Make sure we don't get into trouble again.  */
164 	char _unused2[15 * sizeof (int) - 2 * sizeof (void *)];
165 } _IO_FILE;
166 
167 
168 #ifdef __cplusplus
169 extern "C" {
170 #endif
171 
172 extern int _IO_feof(_IO_FILE *stream);
173 #define    _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
174 extern int _IO_ferror(_IO_FILE *stream);
175 #define    _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
176 extern int _IO_putc(int c, _IO_FILE *stream);
177 extern int _IO_getc(_IO_FILE *stream);
178 
179 extern int __underflow(_IO_FILE *stream);
180 extern int __uflow(_IO_FILE *stream);
181 extern int __overflow(_IO_FILE *stream, int c);
182 
183 extern int _IO_peekc_locked(_IO_FILE *stream);
184 
185 /* This one is for Emacs. */
186 #define _IO_PENDING_OUTPUT_COUNT(_fp)	\
187 	((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
188 
189 extern void _IO_flockfile(_IO_FILE *);
190 extern void _IO_funlockfile(_IO_FILE *);
191 extern int _IO_ftrylockfile(_IO_FILE *);
192 
193 #ifdef _IO_MTSAFE_IO
194 #	define _IO_peekc(_fp) _IO_peekc_locked (_fp)
195 #else
196 #	define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
197 #	define _IO_flockfile(_fp) /**/
198 #	define _IO_funlockfile(_fp) /**/
199 #	define _IO_ftrylockfile(_fp) /**/
200 #	define _IO_cleanup_region_start(_fct, _fp) /**/
201 #	define _IO_cleanup_region_end(_Doit) /**/
202 #endif /* !_IO_MTSAFE_IO */
203 
204 extern int _IO_vfscanf(_IO_FILE *, const char *, va_list, int *);
205 extern int _IO_vfprintf(_IO_FILE *, const char *, va_list);
206 extern _IO_ssize_t _IO_padn(_IO_FILE *, int, _IO_ssize_t);
207 extern _IO_size_t _IO_sgetn(_IO_FILE *, void *, _IO_size_t);
208 
209 extern _IO_fpos64_t _IO_seekoff(_IO_FILE *, _IO_off64_t, int, int);
210 extern _IO_fpos64_t _IO_seekpos(_IO_FILE *, _IO_fpos64_t, int);
211 
212 extern void _IO_free_backup_area(_IO_FILE *);
213 
214 #if  __GNUC__ >= 3
215 # define _IO_BE(expr, res) __builtin_expect (expr, res)
216 #else
217 # define _IO_BE(expr, res) (expr)
218 #endif
219 
220 #define _IO_getc_unlocked(_fp) \
221        (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
222         ? __uflow (_fp) : *(unsigned char *) (_fp)->_IO_read_ptr++)
223 #define _IO_peekc_unlocked(_fp) \
224        (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
225           && __underflow (_fp) == EOF ? EOF \
226         : *(unsigned char *) (_fp)->_IO_read_ptr)
227 #define _IO_putc_unlocked(_ch, _fp) \
228    (_IO_BE ((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end, 0) \
229     ? __overflow (_fp, (unsigned char) (_ch)) \
230     : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
231 
232 
233 
234 #ifdef __cplusplus
235 }
236 #endif
237 
238 #endif	/* _IO_STDIO_H_ */
239