1/* Copyright (C) 1991-2019 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Written by Per Bothner <bothner@cygnus.com>.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>.
18
19 As a special exception, if you link the code in this file with
20 files compiled with a GNU compiler to produce an executable,
21 that does not cause the resulting executable to be covered by
22 the GNU Lesser General Public License. This exception does not
23 however invalidate any other reasons why the executable file
24 might be covered by the GNU Lesser General Public License.
25 This exception applies to code released by its copyright holders
26 in files containing the exception. */
27
28#ifndef _LIBIO_H
29#define _LIBIO_H 1
30
31#ifndef _LIBC
32# error "libio.h should only be included when building glibc itself"
33#endif
34#ifdef _ISOMAC
35# error "libio.h should not be included under _ISOMAC"
36#endif
37
38#include <stdio.h>
39
40#if defined _IO_MTSAFE_IO && !defined _IO_lock_t_defined
41# error "Someone forgot to include stdio-lock.h"
42#endif
43
44#define __need_wchar_t
45#include <stddef.h>
46
47#include <bits/types/__mbstate_t.h>
48#include <bits/types/wint_t.h>
49#include <gconv.h>
50
51typedef union
52{
53 struct __gconv_info __cd;
54 struct
55 {
56 struct __gconv_info __cd;
57 struct __gconv_step_data __data;
58 } __combined;
59} _IO_iconv_t;
60
61#include <shlib-compat.h>
62
63/* _IO_seekoff modes */
64#define _IOS_INPUT 1
65#define _IOS_OUTPUT 2
66
67/* Magic number and bits for the _flags field. The magic number is
68 mostly vestigial, but preserved for compatibility. It occupies the
69 high 16 bits of _flags; the low 16 bits are actual flag bits. */
70
71#define _IO_MAGIC 0xFBAD0000 /* Magic number */
72#define _IO_MAGIC_MASK 0xFFFF0000
73#define _IO_USER_BUF 0x0001 /* Don't deallocate buffer on close. */
74#define _IO_UNBUFFERED 0x0002
75#define _IO_NO_READS 0x0004 /* Reading not allowed. */
76#define _IO_NO_WRITES 0x0008 /* Writing not allowed. */
77#define _IO_EOF_SEEN 0x0010
78#define _IO_ERR_SEEN 0x0020
79#define _IO_DELETE_DONT_CLOSE 0x0040 /* Don't call close(_fileno) on close. */
80#define _IO_LINKED 0x0080 /* In the list of all open files. */
81#define _IO_IN_BACKUP 0x0100
82#define _IO_LINE_BUF 0x0200
83#define _IO_TIED_PUT_GET 0x0400 /* Put and get pointer move in unison. */
84#define _IO_CURRENTLY_PUTTING 0x0800
85#define _IO_IS_APPENDING 0x1000
86#define _IO_IS_FILEBUF 0x2000
87 /* 0x4000 No longer used, reserved for compat. */
88#define _IO_USER_LOCK 0x8000
89
90/* Bits for the _flags2 field. */
91#define _IO_FLAGS2_MMAP 1
92#define _IO_FLAGS2_NOTCANCEL 2
93#define _IO_FLAGS2_USER_WBUF 8
94#define _IO_FLAGS2_NOCLOSE 32
95#define _IO_FLAGS2_CLOEXEC 64
96#define _IO_FLAGS2_NEED_LOCK 128
97
98/* _IO_pos_BAD is an off64_t value indicating error, unknown, or EOF. */
99#define _IO_pos_BAD ((off64_t) -1)
100
101/* _IO_pos_adjust adjusts an off64_t by some number of bytes. */
102#define _IO_pos_adjust(pos, delta) ((pos) += (delta))
103
104/* _IO_pos_0 is an off64_t value indicating beginning of file. */
105#define _IO_pos_0 ((off64_t) 0)
106
107struct _IO_jump_t;
108
109/* A streammarker remembers a position in a buffer. */
110struct _IO_marker {
111 struct _IO_marker *_next;
112 FILE *_sbuf;
113 /* If _pos >= 0
114 it points to _buf->Gbase()+_pos. FIXME comment */
115 /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
116 int _pos;
117};
118
119/* This is the structure from the libstdc++ codecvt class. */
120enum __codecvt_result
121{
122 __codecvt_ok,
123 __codecvt_partial,
124 __codecvt_error,
125 __codecvt_noconv
126};
127
128/* The order of the elements in the following struct must match the order
129 of the virtual functions in the libstdc++ codecvt class. */
130struct _IO_codecvt
131{
132 void (*__codecvt_destr) (struct _IO_codecvt *);
133 enum __codecvt_result (*__codecvt_do_out) (struct _IO_codecvt *,
134 __mbstate_t *,
135 const wchar_t *,
136 const wchar_t *,
137 const wchar_t **, char *,
138 char *, char **);
139 enum __codecvt_result (*__codecvt_do_unshift) (struct _IO_codecvt *,
140 __mbstate_t *, char *,
141 char *, char **);
142 enum __codecvt_result (*__codecvt_do_in) (struct _IO_codecvt *,
143 __mbstate_t *,
144 const char *, const char *,
145 const char **, wchar_t *,
146 wchar_t *, wchar_t **);
147 int (*__codecvt_do_encoding) (struct _IO_codecvt *);
148 int (*__codecvt_do_always_noconv) (struct _IO_codecvt *);
149 int (*__codecvt_do_length) (struct _IO_codecvt *, __mbstate_t *,
150 const char *, const char *, size_t);
151 int (*__codecvt_do_max_length) (struct _IO_codecvt *);
152
153 _IO_iconv_t __cd_in;
154 _IO_iconv_t __cd_out;
155};
156
157/* Extra data for wide character streams. */
158struct _IO_wide_data
159{
160 wchar_t *_IO_read_ptr; /* Current read pointer */
161 wchar_t *_IO_read_end; /* End of get area. */
162 wchar_t *_IO_read_base; /* Start of putback+get area. */
163 wchar_t *_IO_write_base; /* Start of put area. */
164 wchar_t *_IO_write_ptr; /* Current put pointer. */
165 wchar_t *_IO_write_end; /* End of put area. */
166 wchar_t *_IO_buf_base; /* Start of reserve area. */
167 wchar_t *_IO_buf_end; /* End of reserve area. */
168 /* The following fields are used to support backing up and undo. */
169 wchar_t *_IO_save_base; /* Pointer to start of non-current get area. */
170 wchar_t *_IO_backup_base; /* Pointer to first valid character of
171 backup area */
172 wchar_t *_IO_save_end; /* Pointer to end of non-current get area. */
173
174 __mbstate_t _IO_state;
175 __mbstate_t _IO_last_state;
176 struct _IO_codecvt _codecvt;
177
178 wchar_t _shortbuf[1];
179
180 const struct _IO_jump_t *_wide_vtable;
181};
182
183struct _IO_FILE_plus;
184
185extern struct _IO_FILE_plus _IO_2_1_stdin_;
186extern struct _IO_FILE_plus _IO_2_1_stdout_;
187extern struct _IO_FILE_plus _IO_2_1_stderr_;
188extern FILE *_IO_stdin attribute_hidden;
189extern FILE *_IO_stdout attribute_hidden;
190extern FILE *_IO_stderr attribute_hidden;
191
192struct _IO_cookie_file;
193
194/* Initialize one of those. */
195extern void _IO_cookie_init (struct _IO_cookie_file *__cfile, int __read_write,
196 void *__cookie, cookie_io_functions_t __fns);
197
198extern int __underflow (FILE *);
199extern wint_t __wunderflow (FILE *);
200extern wint_t __wuflow (FILE *);
201extern wint_t __woverflow (FILE *, wint_t);
202
203#define _IO_getc_unlocked(_fp) __getc_unlocked_body (_fp)
204#define _IO_peekc_unlocked(_fp) \
205 (__glibc_unlikely ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end) \
206 && __underflow (_fp) == EOF \
207 ? EOF \
208 : *(unsigned char *) (_fp)->_IO_read_ptr)
209#define _IO_putc_unlocked(_ch, _fp) __putc_unlocked_body (_ch, _fp)
210
211# define _IO_getwc_unlocked(_fp) \
212 (__glibc_unlikely ((_fp)->_wide_data == NULL \
213 || ((_fp)->_wide_data->_IO_read_ptr \
214 >= (_fp)->_wide_data->_IO_read_end)) \
215 ? __wuflow (_fp) : (wint_t) *(_fp)->_wide_data->_IO_read_ptr++)
216# define _IO_putwc_unlocked(_wch, _fp) \
217 (__glibc_unlikely ((_fp)->_wide_data == NULL \
218 || ((_fp)->_wide_data->_IO_write_ptr \
219 >= (_fp)->_wide_data->_IO_write_end)) \
220 ? __woverflow (_fp, _wch) \
221 : (wint_t) (*(_fp)->_wide_data->_IO_write_ptr++ = (_wch)))
222
223#define _IO_feof_unlocked(_fp) __feof_unlocked_body (_fp)
224#define _IO_ferror_unlocked(_fp) __ferror_unlocked_body (_fp)
225
226extern int _IO_getc (FILE *__fp);
227extern int _IO_putc (int __c, FILE *__fp);
228extern int _IO_feof (FILE *__fp) __THROW;
229extern int _IO_ferror (FILE *__fp) __THROW;
230
231extern int _IO_peekc_locked (FILE *__fp);
232
233/* This one is for Emacs. */
234#define _IO_PENDING_OUTPUT_COUNT(_fp) \
235 ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
236
237extern void _IO_flockfile (FILE *) __THROW;
238extern void _IO_funlockfile (FILE *) __THROW;
239extern int _IO_ftrylockfile (FILE *) __THROW;
240
241#define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
242#define _IO_flockfile(_fp) /**/
243#define _IO_funlockfile(_fp) /**/
244#define _IO_ftrylockfile(_fp) /**/
245#ifndef _IO_cleanup_region_start
246#define _IO_cleanup_region_start(_fct, _fp) /**/
247#endif
248#ifndef _IO_cleanup_region_end
249#define _IO_cleanup_region_end(_Doit) /**/
250#endif
251
252#define _IO_need_lock(_fp) \
253 (((_fp)->_flags2 & _IO_FLAGS2_NEED_LOCK) != 0)
254
255extern int _IO_vfscanf (FILE * __restrict, const char * __restrict,
256 __gnuc_va_list, int *__restrict);
257extern __ssize_t _IO_padn (FILE *, int, __ssize_t);
258extern size_t _IO_sgetn (FILE *, void *, size_t);
259
260extern off64_t _IO_seekoff (FILE *, off64_t, int, int);
261extern off64_t _IO_seekpos (FILE *, off64_t, int);
262
263extern void _IO_free_backup_area (FILE *) __THROW;
264
265
266extern wint_t _IO_getwc (FILE *__fp);
267extern wint_t _IO_putwc (wchar_t __wc, FILE *__fp);
268extern int _IO_fwide (FILE *__fp, int __mode) __THROW;
269
270#if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
271# define _IO_fwide_maybe_incompatible \
272 (__glibc_unlikely (&_IO_stdin_used == NULL))
273extern const int _IO_stdin_used;
274weak_extern (_IO_stdin_used);
275#else
276# define _IO_fwide_maybe_incompatible (0)
277#endif
278
279/* A special optimized version of the function above. It optimizes the
280 case of initializing an unoriented byte stream. */
281#define _IO_fwide(__fp, __mode) \
282 ({ int __result = (__mode); \
283 if (__result < 0 && ! _IO_fwide_maybe_incompatible) \
284 { \
285 if ((__fp)->_mode == 0) \
286 /* We know that all we have to do is to set the flag. */ \
287 (__fp)->_mode = -1; \
288 __result = (__fp)->_mode; \
289 } \
290 else if (__builtin_constant_p (__mode) && (__mode) == 0) \
291 __result = _IO_fwide_maybe_incompatible ? -1 : (__fp)->_mode; \
292 else \
293 __result = _IO_fwide (__fp, __result); \
294 __result; })
295
296extern int _IO_vfwscanf (FILE * __restrict, const wchar_t * __restrict,
297 __gnuc_va_list, int *__restrict);
298extern __ssize_t _IO_wpadn (FILE *, wint_t, __ssize_t);
299extern void _IO_free_wbackup_area (FILE *) __THROW;
300
301#ifdef __LDBL_COMPAT
302__LDBL_REDIR_DECL (_IO_vfscanf)
303#endif
304
305libc_hidden_proto (__overflow)
306libc_hidden_proto (__underflow)
307libc_hidden_proto (__uflow)
308libc_hidden_proto (__woverflow)
309libc_hidden_proto (__wunderflow)
310libc_hidden_proto (__wuflow)
311libc_hidden_proto (_IO_free_backup_area)
312libc_hidden_proto (_IO_free_wbackup_area)
313libc_hidden_proto (_IO_padn)
314libc_hidden_proto (_IO_putc)
315libc_hidden_proto (_IO_sgetn)
316
317#ifdef _IO_MTSAFE_IO
318# undef _IO_peekc
319# undef _IO_flockfile
320# undef _IO_funlockfile
321# undef _IO_ftrylockfile
322
323# define _IO_peekc(_fp) _IO_peekc_locked (_fp)
324# if _IO_lock_inexpensive
325# define _IO_flockfile(_fp) \
326 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_lock_lock (*(_fp)->_lock)
327# define _IO_funlockfile(_fp) \
328 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_lock_unlock (*(_fp)->_lock)
329# else
330# define _IO_flockfile(_fp) \
331 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_flockfile (_fp)
332# define _IO_funlockfile(_fp) \
333 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_funlockfile (_fp)
334# endif
335#endif /* _IO_MTSAFE_IO */
336
337#endif /* _LIBIO_H */
338