1 /* Copyright (C) 1991-2018 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Written by Per Bothner <bothner@cygnus.com>.
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.
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.
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/>.
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. */
32 # error "libio.h should only be included when building glibc itself"
35 # error "libio.h should not be included under _ISOMAC"
40 #if defined _IO_MTSAFE_IO && !defined _IO_lock_t_defined
41 # error "Someone forgot to include stdio-lock.h"
44 #define __need_wchar_t
47 #include <bits/types/__mbstate_t.h>
48 #include <bits/types/wint_t.h>
53 struct __gconv_info __cd
;
56 struct __gconv_info __cd
;
57 struct __gconv_step_data __data
;
61 #include <shlib-compat.h>
63 /* _IO_seekoff modes */
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. */
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
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
98 /* _IO_pos_BAD is an off64_t value indicating error, unknown, or EOF. */
99 #define _IO_pos_BAD ((off64_t) -1)
101 /* _IO_pos_adjust adjusts an off64_t by some number of bytes. */
102 #define _IO_pos_adjust(pos, delta) ((pos) += (delta))
104 /* _IO_pos_0 is an off64_t value indicating beginning of file. */
105 #define _IO_pos_0 ((off64_t) 0)
109 /* A streammarker remembers a position in a buffer. */
111 struct _IO_marker
*_next
;
114 it points to _buf->Gbase()+_pos. FIXME comment */
115 /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
119 /* This is the structure from the libstdc++ codecvt class. */
120 enum __codecvt_result
128 /* The order of the elements in the following struct must match the order
129 of the virtual functions in the libstdc++ codecvt class. */
132 void (*__codecvt_destr
) (struct _IO_codecvt
*);
133 enum __codecvt_result (*__codecvt_do_out
) (struct _IO_codecvt
*,
137 const wchar_t **, char *,
139 enum __codecvt_result (*__codecvt_do_unshift
) (struct _IO_codecvt
*,
140 __mbstate_t
*, char *,
142 enum __codecvt_result (*__codecvt_do_in
) (struct _IO_codecvt
*,
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
*);
154 _IO_iconv_t __cd_out
;
157 /* Extra data for wide character streams. */
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
172 wchar_t *_IO_save_end
; /* Pointer to end of non-current get area. */
174 __mbstate_t _IO_state
;
175 __mbstate_t _IO_last_state
;
176 struct _IO_codecvt _codecvt
;
178 wchar_t _shortbuf
[1];
180 const struct _IO_jump_t
*_wide_vtable
;
183 struct _IO_FILE_plus
;
185 extern struct _IO_FILE_plus _IO_2_1_stdin_
;
186 extern struct _IO_FILE_plus _IO_2_1_stdout_
;
187 extern struct _IO_FILE_plus _IO_2_1_stderr_
;
188 extern FILE *_IO_stdin attribute_hidden
;
189 extern FILE *_IO_stdout attribute_hidden
;
190 extern FILE *_IO_stderr attribute_hidden
;
192 struct _IO_cookie_file
;
194 /* Initialize one of those. */
195 extern void _IO_cookie_init (struct _IO_cookie_file
*__cfile
, int __read_write
,
196 void *__cookie
, cookie_io_functions_t __fns
);
198 extern int __underflow (FILE *);
199 extern wint_t __wunderflow (FILE *);
200 extern wint_t __wuflow (FILE *);
201 extern wint_t __woverflow (FILE *, wint_t);
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 \
208 : *(unsigned char *) (_fp)->_IO_read_ptr)
209 #define _IO_putc_unlocked(_ch, _fp) __putc_unlocked_body (_ch, _fp)
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)))
223 #define _IO_feof_unlocked(_fp) __feof_unlocked_body (_fp)
224 #define _IO_ferror_unlocked(_fp) __ferror_unlocked_body (_fp)
226 extern int _IO_getc (FILE *__fp
);
227 extern int _IO_putc (int __c
, FILE *__fp
);
228 extern int _IO_feof (FILE *__fp
) __THROW
;
229 extern int _IO_ferror (FILE *__fp
) __THROW
;
231 extern int _IO_peekc_locked (FILE *__fp
);
233 /* This one is for Emacs. */
234 #define _IO_PENDING_OUTPUT_COUNT(_fp) \
235 ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
237 extern void _IO_flockfile (FILE *) __THROW
;
238 extern void _IO_funlockfile (FILE *) __THROW
;
239 extern int _IO_ftrylockfile (FILE *) __THROW
;
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) /**/
248 #ifndef _IO_cleanup_region_end
249 #define _IO_cleanup_region_end(_Doit) /**/
252 #define _IO_need_lock(_fp) \
253 (((_fp)->_flags2 & _IO_FLAGS2_NEED_LOCK) != 0)
255 extern int _IO_vfscanf (FILE * __restrict
, const char * __restrict
,
256 __gnuc_va_list
, int *__restrict
);
257 extern __ssize_t
_IO_padn (FILE *, int, __ssize_t
);
258 extern size_t _IO_sgetn (FILE *, void *, size_t);
260 extern off64_t
_IO_seekoff (FILE *, off64_t
, int, int);
261 extern off64_t
_IO_seekpos (FILE *, off64_t
, int);
263 extern void _IO_free_backup_area (FILE *) __THROW
;
266 extern wint_t _IO_getwc (FILE *__fp
);
267 extern wint_t _IO_putwc (wchar_t __wc
, FILE *__fp
);
268 extern int _IO_fwide (FILE *__fp
, int __mode
) __THROW
;
270 #if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
271 # define _IO_fwide_maybe_incompatible \
272 (__glibc_unlikely (&_IO_stdin_used == NULL))
273 extern const int _IO_stdin_used
;
274 weak_extern (_IO_stdin_used
);
276 # define _IO_fwide_maybe_incompatible (0)
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) \
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; \
290 else if (__builtin_constant_p (__mode) && (__mode) == 0) \
291 __result = _IO_fwide_maybe_incompatible ? -1 : (__fp)->_mode; \
293 __result = _IO_fwide (__fp, __result); \
296 extern int _IO_vfwscanf (FILE * __restrict
, const wchar_t * __restrict
,
297 __gnuc_va_list
, int *__restrict
);
298 extern __ssize_t
_IO_wpadn (FILE *, wint_t, __ssize_t
);
299 extern void _IO_free_wbackup_area (FILE *) __THROW
;
302 __LDBL_REDIR_DECL (_IO_vfscanf
)
305 libc_hidden_proto (__overflow
)
306 libc_hidden_proto (__underflow
)
307 libc_hidden_proto (__uflow
)
308 libc_hidden_proto (__woverflow
)
309 libc_hidden_proto (__wunderflow
)
310 libc_hidden_proto (__wuflow
)
311 libc_hidden_proto (_IO_free_backup_area
)
312 libc_hidden_proto (_IO_free_wbackup_area
)
313 libc_hidden_proto (_IO_padn
)
314 libc_hidden_proto (_IO_putc
)
315 libc_hidden_proto (_IO_sgetn
)
319 # undef _IO_flockfile
320 # undef _IO_funlockfile
321 # undef _IO_ftrylockfile
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)
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)
335 #endif /* _IO_MTSAFE_IO */
337 #endif /* _LIBIO_H */