]> git.ipfire.org Git - thirdparty/glibc.git/blame - libio/libio.h
Remove _IO_file_flags define.
[thirdparty/glibc.git] / libio / libio.h
CommitLineData
688903eb 1/* Copyright (C) 1991-2018 Free Software Foundation, Inc.
48a8f832
ZW
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
6c6c962a
ZW
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
48a8f832 37
a4fea3f2 38#include <stdio.h>
48a8f832 39
6c6c962a
ZW
40#if defined _IO_MTSAFE_IO && !defined _IO_lock_t_defined
41# error "Someone forgot to include stdio-lock.h"
42#endif
43
63fb8f9a
ZW
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
6c6c962a
ZW
61#include <shlib-compat.h>
62
df6c012b 63/* _IO_seekoff modes */
48a8f832
ZW
64#define _IOS_INPUT 1
65#define _IOS_OUTPUT 2
48a8f832 66
df6c012b
ZW
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. */
48a8f832
ZW
91#define _IO_FLAGS2_MMAP 1
92#define _IO_FLAGS2_NOTCANCEL 2
34957904 93#define _IO_FLAGS2_FORTIFY 4
48a8f832 94#define _IO_FLAGS2_USER_WBUF 8
34957904
ZW
95#define _IO_FLAGS2_SCANF_STD 16
96#define _IO_FLAGS2_NOCLOSE 32
97#define _IO_FLAGS2_CLOEXEC 64
98#define _IO_FLAGS2_NEED_LOCK 128
48a8f832 99
48a8f832 100
a4fea3f2 101struct _IO_jump_t;
48a8f832
ZW
102
103/* A streammarker remembers a position in a buffer. */
48a8f832
ZW
104struct _IO_marker {
105 struct _IO_marker *_next;
9964a145 106 FILE *_sbuf;
48a8f832
ZW
107 /* If _pos >= 0
108 it points to _buf->Gbase()+_pos. FIXME comment */
109 /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
110 int _pos;
48a8f832
ZW
111};
112
113/* This is the structure from the libstdc++ codecvt class. */
114enum __codecvt_result
115{
116 __codecvt_ok,
117 __codecvt_partial,
118 __codecvt_error,
119 __codecvt_noconv
120};
121
48a8f832
ZW
122/* The order of the elements in the following struct must match the order
123 of the virtual functions in the libstdc++ codecvt class. */
124struct _IO_codecvt
125{
126 void (*__codecvt_destr) (struct _IO_codecvt *);
127 enum __codecvt_result (*__codecvt_do_out) (struct _IO_codecvt *,
128 __mbstate_t *,
129 const wchar_t *,
130 const wchar_t *,
131 const wchar_t **, char *,
132 char *, char **);
133 enum __codecvt_result (*__codecvt_do_unshift) (struct _IO_codecvt *,
134 __mbstate_t *, char *,
135 char *, char **);
136 enum __codecvt_result (*__codecvt_do_in) (struct _IO_codecvt *,
137 __mbstate_t *,
138 const char *, const char *,
139 const char **, wchar_t *,
140 wchar_t *, wchar_t **);
141 int (*__codecvt_do_encoding) (struct _IO_codecvt *);
142 int (*__codecvt_do_always_noconv) (struct _IO_codecvt *);
143 int (*__codecvt_do_length) (struct _IO_codecvt *, __mbstate_t *,
9964a145 144 const char *, const char *, size_t);
48a8f832
ZW
145 int (*__codecvt_do_max_length) (struct _IO_codecvt *);
146
147 _IO_iconv_t __cd_in;
148 _IO_iconv_t __cd_out;
149};
150
151/* Extra data for wide character streams. */
152struct _IO_wide_data
153{
154 wchar_t *_IO_read_ptr; /* Current read pointer */
155 wchar_t *_IO_read_end; /* End of get area. */
156 wchar_t *_IO_read_base; /* Start of putback+get area. */
157 wchar_t *_IO_write_base; /* Start of put area. */
158 wchar_t *_IO_write_ptr; /* Current put pointer. */
159 wchar_t *_IO_write_end; /* End of put area. */
160 wchar_t *_IO_buf_base; /* Start of reserve area. */
161 wchar_t *_IO_buf_end; /* End of reserve area. */
162 /* The following fields are used to support backing up and undo. */
163 wchar_t *_IO_save_base; /* Pointer to start of non-current get area. */
164 wchar_t *_IO_backup_base; /* Pointer to first valid character of
165 backup area */
166 wchar_t *_IO_save_end; /* Pointer to end of non-current get area. */
167
168 __mbstate_t _IO_state;
169 __mbstate_t _IO_last_state;
170 struct _IO_codecvt _codecvt;
171
172 wchar_t _shortbuf[1];
173
174 const struct _IO_jump_t *_wide_vtable;
175};
48a8f832 176
48a8f832
ZW
177struct _IO_FILE_plus;
178
179extern struct _IO_FILE_plus _IO_2_1_stdin_;
180extern struct _IO_FILE_plus _IO_2_1_stdout_;
181extern struct _IO_FILE_plus _IO_2_1_stderr_;
9964a145
ZW
182extern FILE *_IO_stdin attribute_hidden;
183extern FILE *_IO_stdout attribute_hidden;
184extern FILE *_IO_stderr attribute_hidden;
48a8f832
ZW
185
186struct _IO_cookie_file;
187
188/* Initialize one of those. */
189extern void _IO_cookie_init (struct _IO_cookie_file *__cfile, int __read_write,
9964a145 190 void *__cookie, cookie_io_functions_t __fns);
48a8f832 191
9964a145
ZW
192extern int __underflow (FILE *);
193extern wint_t __wunderflow (FILE *);
194extern wint_t __wuflow (FILE *);
195extern wint_t __woverflow (FILE *, wint_t);
48a8f832 196
a4fea3f2 197#define _IO_getc_unlocked(_fp) __getc_unlocked_body (_fp)
177aad3f
ZW
198#define _IO_peekc_unlocked(_fp) \
199 (__glibc_unlikely ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end) \
200 && __underflow (_fp) == EOF \
201 ? EOF \
202 : *(unsigned char *) (_fp)->_IO_read_ptr)
a4fea3f2 203#define _IO_putc_unlocked(_ch, _fp) __putc_unlocked_body (_ch, _fp)
48a8f832 204
177aad3f
ZW
205# define _IO_getwc_unlocked(_fp) \
206 (__glibc_unlikely ((_fp)->_wide_data == NULL \
207 || ((_fp)->_wide_data->_IO_read_ptr \
208 >= (_fp)->_wide_data->_IO_read_end)) \
9964a145 209 ? __wuflow (_fp) : (wint_t) *(_fp)->_wide_data->_IO_read_ptr++)
177aad3f
ZW
210# define _IO_putwc_unlocked(_wch, _fp) \
211 (__glibc_unlikely ((_fp)->_wide_data == NULL \
212 || ((_fp)->_wide_data->_IO_write_ptr \
213 >= (_fp)->_wide_data->_IO_write_end)) \
48a8f832 214 ? __woverflow (_fp, _wch) \
9964a145 215 : (wint_t) (*(_fp)->_wide_data->_IO_write_ptr++ = (_wch)))
48a8f832 216
a4fea3f2
ZW
217#define _IO_feof_unlocked(_fp) __feof_unlocked_body (_fp)
218#define _IO_ferror_unlocked(_fp) __ferror_unlocked_body (_fp)
48a8f832 219
9964a145
ZW
220extern int _IO_getc (FILE *__fp);
221extern int _IO_putc (int __c, FILE *__fp);
222extern int _IO_feof (FILE *__fp) __THROW;
223extern int _IO_ferror (FILE *__fp) __THROW;
48a8f832 224
9964a145 225extern int _IO_peekc_locked (FILE *__fp);
48a8f832
ZW
226
227/* This one is for Emacs. */
228#define _IO_PENDING_OUTPUT_COUNT(_fp) \
229 ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
230
9964a145
ZW
231extern void _IO_flockfile (FILE *) __THROW;
232extern void _IO_funlockfile (FILE *) __THROW;
233extern int _IO_ftrylockfile (FILE *) __THROW;
48a8f832
ZW
234
235#define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
236#define _IO_flockfile(_fp) /**/
237#define _IO_funlockfile(_fp) /**/
238#define _IO_ftrylockfile(_fp) /**/
239#ifndef _IO_cleanup_region_start
240#define _IO_cleanup_region_start(_fct, _fp) /**/
241#endif
242#ifndef _IO_cleanup_region_end
243#define _IO_cleanup_region_end(_Doit) /**/
244#endif
245
246#define _IO_need_lock(_fp) \
247 (((_fp)->_flags2 & _IO_FLAGS2_NEED_LOCK) != 0)
248
9964a145
ZW
249extern int _IO_vfscanf (FILE * __restrict, const char * __restrict,
250 __gnuc_va_list, int *__restrict);
251extern int _IO_vfprintf (FILE *__restrict, const char *__restrict,
252 __gnuc_va_list);
253extern __ssize_t _IO_padn (FILE *, int, __ssize_t);
254extern size_t _IO_sgetn (FILE *, void *, size_t);
48a8f832 255
9964a145
ZW
256extern off64_t _IO_seekoff (FILE *, off64_t, int, int);
257extern off64_t _IO_seekpos (FILE *, off64_t, int);
48a8f832 258
9964a145 259extern void _IO_free_backup_area (FILE *) __THROW;
48a8f832 260
6c6c962a 261
9964a145
ZW
262extern wint_t _IO_getwc (FILE *__fp);
263extern wint_t _IO_putwc (wchar_t __wc, FILE *__fp);
264extern int _IO_fwide (FILE *__fp, int __mode) __THROW;
6c6c962a 265
6c6c962a
ZW
266#if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
267# define _IO_fwide_maybe_incompatible \
177aad3f 268 (__glibc_unlikely (&_IO_stdin_used == NULL))
48a8f832
ZW
269extern const int _IO_stdin_used;
270weak_extern (_IO_stdin_used);
6c6c962a
ZW
271#else
272# define _IO_fwide_maybe_incompatible (0)
273#endif
274
48a8f832
ZW
275/* A special optimized version of the function above. It optimizes the
276 case of initializing an unoriented byte stream. */
6c6c962a 277#define _IO_fwide(__fp, __mode) \
48a8f832
ZW
278 ({ int __result = (__mode); \
279 if (__result < 0 && ! _IO_fwide_maybe_incompatible) \
280 { \
281 if ((__fp)->_mode == 0) \
282 /* We know that all we have to do is to set the flag. */ \
283 (__fp)->_mode = -1; \
284 __result = (__fp)->_mode; \
285 } \
286 else if (__builtin_constant_p (__mode) && (__mode) == 0) \
287 __result = _IO_fwide_maybe_incompatible ? -1 : (__fp)->_mode; \
288 else \
289 __result = _IO_fwide (__fp, __result); \
290 __result; })
48a8f832 291
9964a145
ZW
292extern int _IO_vfwscanf (FILE * __restrict, const wchar_t * __restrict,
293 __gnuc_va_list, int *__restrict);
294extern int _IO_vfwprintf (FILE *__restrict, const wchar_t *__restrict,
295 __gnuc_va_list);
296extern __ssize_t _IO_wpadn (FILE *, wint_t, __ssize_t);
297extern void _IO_free_wbackup_area (FILE *) __THROW;
48a8f832
ZW
298
299#ifdef __LDBL_COMPAT
6c6c962a
ZW
300__LDBL_REDIR_DECL (_IO_vfscanf)
301__LDBL_REDIR_DECL (_IO_vfprintf)
48a8f832
ZW
302#endif
303
6c6c962a
ZW
304libc_hidden_proto (__overflow)
305libc_hidden_proto (__underflow)
306libc_hidden_proto (__uflow)
307libc_hidden_proto (__woverflow)
308libc_hidden_proto (__wunderflow)
309libc_hidden_proto (__wuflow)
310libc_hidden_proto (_IO_free_backup_area)
311libc_hidden_proto (_IO_free_wbackup_area)
312libc_hidden_proto (_IO_padn)
313libc_hidden_proto (_IO_putc)
314libc_hidden_proto (_IO_sgetn)
315libc_hidden_proto (_IO_vfprintf)
316libc_hidden_proto (_IO_vfscanf)
317
318#ifdef _IO_MTSAFE_IO
319# undef _IO_peekc
320# undef _IO_flockfile
321# undef _IO_funlockfile
322# undef _IO_ftrylockfile
323
324# define _IO_peekc(_fp) _IO_peekc_locked (_fp)
325# if _IO_lock_inexpensive
326# define _IO_flockfile(_fp) \
327 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_lock_lock (*(_fp)->_lock)
328# define _IO_funlockfile(_fp) \
329 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_lock_unlock (*(_fp)->_lock)
330# else
331# define _IO_flockfile(_fp) \
332 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_flockfile (_fp)
333# define _IO_funlockfile(_fp) \
334 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_funlockfile (_fp)
335# endif
336#endif /* _IO_MTSAFE_IO */
337
6c6c962a 338#endif /* _LIBIO_H */