1 /* Copyright (C) 1991-2015 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 _IO_STDIO_H
29 #define _IO_STDIO_H
30
31 #include <_G_config.h>
32 /* ALL of these should be defined in _G_config.h */
33 #define _IO_fpos_t _G_fpos_t
34 #define _IO_fpos64_t _G_fpos64_t
35 #define _IO_size_t size_t
36 #define _IO_ssize_t __ssize_t
37 #define _IO_off_t __off_t
38 #define _IO_off64_t __off64_t
39 #define _IO_pid_t __pid_t
40 #define _IO_uid_t __uid_t
41 #define _IO_iconv_t _G_iconv_t
42 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
43 #define _IO_BUFSIZ _G_BUFSIZ
44 #define _IO_va_list _G_va_list
45 #define _IO_wint_t wint_t
46
47 /* This define avoids name pollution if we're using GNU stdarg.h */
48 #define __need___va_list
49 #include <stdarg.h>
50 #ifdef __GNUC_VA_LIST
51 # undef _IO_va_list
52 # define _IO_va_list __gnuc_va_list
53 #endif /* __GNUC_VA_LIST */
54
55 #ifndef __P
56 # include <sys/cdefs.h>
57 #endif /*!__P*/
58
59 #define _IO_UNIFIED_JUMPTABLES 1
60
61 #ifndef EOF
62 # define EOF (-1)
63 #endif
64 #ifndef NULL
65 # if defined __GNUG__ && \
66 (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
67 # define NULL (__null)
68 # else
69 # if !defined(__cplusplus)
70 # define NULL ((void*)0)
71 # else
72 # define NULL (0)
73 # endif
74 # endif
75 #endif
76
77 #define _IOS_INPUT 1
78 #define _IOS_OUTPUT 2
79 #define _IOS_ATEND 4
80 #define _IOS_APPEND 8
81 #define _IOS_TRUNC 16
82 #define _IOS_NOCREATE 32
83 #define _IOS_NOREPLACE 64
84 #define _IOS_BIN 128
85
86 /* Magic numbers and bits for the _flags field.
87 The magic numbers use the high-order bits of _flags;
88 the remaining bits are available for variable flags.
89 Note: The magic numbers must all be negative if stdio
90 emulation is desired. */
91
92 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
93 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
94 #define _IO_MAGIC_MASK 0xFFFF0000
95 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
96 #define _IO_UNBUFFERED 2
97 #define _IO_NO_READS 4 /* Reading not allowed */
98 #define _IO_NO_WRITES 8 /* Writing not allowd */
99 #define _IO_EOF_SEEN 0x10
100 #define _IO_ERR_SEEN 0x20
101 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
102 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
103 #define _IO_IN_BACKUP 0x100
104 #define _IO_LINE_BUF 0x200
105 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
106 #define _IO_CURRENTLY_PUTTING 0x800
107 #define _IO_IS_APPENDING 0x1000
108 #define _IO_IS_FILEBUF 0x2000
109 #define _IO_BAD_SEEN 0x4000
110 #define _IO_USER_LOCK 0x8000
111
112 #define _IO_FLAGS2_MMAP 1
113 #define _IO_FLAGS2_NOTCANCEL 2
114 #ifdef _LIBC
115 # define _IO_FLAGS2_FORTIFY 4
116 #endif
117 #define _IO_FLAGS2_USER_WBUF 8
118 #ifdef _LIBC
119 # define _IO_FLAGS2_SCANF_STD 16
120 # define _IO_FLAGS2_NOCLOSE 32
121 # define _IO_FLAGS2_CLOEXEC 64
122 #endif
123
124 /* These are "formatting flags" matching the iostream fmtflags enum values. */
125 #define _IO_SKIPWS 01
126 #define _IO_LEFT 02
127 #define _IO_RIGHT 04
128 #define _IO_INTERNAL 010
129 #define _IO_DEC 020
130 #define _IO_OCT 040
131 #define _IO_HEX 0100
132 #define _IO_SHOWBASE 0200
133 #define _IO_SHOWPOINT 0400
134 #define _IO_UPPERCASE 01000
135 #define _IO_SHOWPOS 02000
136 #define _IO_SCIENTIFIC 04000
137 #define _IO_FIXED 010000
138 #define _IO_UNITBUF 020000
139 #define _IO_STDIO 040000
140 #define _IO_DONT_CLOSE 0100000
141 #define _IO_BOOLALPHA 0200000
142
143
144 struct _IO_jump_t; struct _IO_FILE;
145
146 /* Handle lock. */
147 #ifdef _IO_MTSAFE_IO
148 # if defined __GLIBC__ && __GLIBC__ >= 2
149 # include <bits/stdio-lock.h>
150 # else
151 /*# include <comthread.h>*/
152 # endif
153 #else
154 typedef void _IO_lock_t;
155 #endif
156
157
158 /* A streammarker remembers a position in a buffer. */
159
160 struct _IO_marker {
161 struct _IO_marker *_next;
162 struct _IO_FILE *_sbuf;
163 /* If _pos >= 0
164 it points to _buf->Gbase()+_pos. FIXME comment */
165 /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
166 int _pos;
167 #if 0
168 void set_streampos(streampos sp) { _spos = sp; }
169 void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
170 public:
171 streammarker(streambuf *sb);
172 ~streammarker();
173 int saving() { return _spos == -2; }
174 int delta(streammarker&);
175 int delta();
176 #endif
177 };
178
179 /* This is the structure from the libstdc++ codecvt class. */
180 enum __codecvt_result
181 {
182 __codecvt_ok,
183 __codecvt_partial,
184 __codecvt_error,
185 __codecvt_noconv
186 };
187
188 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
189 /* The order of the elements in the following struct must match the order
190 of the virtual functions in the libstdc++ codecvt class. */
191 struct _IO_codecvt
192 {
193 void (*__codecvt_destr) (struct _IO_codecvt *);
194 enum __codecvt_result (*__codecvt_do_out) (struct _IO_codecvt *,
195 __mbstate_t *,
196 const wchar_t *,
197 const wchar_t *,
198 const wchar_t **, char *,
199 char *, char **);
200 enum __codecvt_result (*__codecvt_do_unshift) (struct _IO_codecvt *,
201 __mbstate_t *, char *,
202 char *, char **);
203 enum __codecvt_result (*__codecvt_do_in) (struct _IO_codecvt *,
204 __mbstate_t *,
205 const char *, const char *,
206 const char **, wchar_t *,
207 wchar_t *, wchar_t **);
208 int (*__codecvt_do_encoding) (struct _IO_codecvt *);
209 int (*__codecvt_do_always_noconv) (struct _IO_codecvt *);
210 int (*__codecvt_do_length) (struct _IO_codecvt *, __mbstate_t *,
211 const char *, const char *, _IO_size_t);
212 int (*__codecvt_do_max_length) (struct _IO_codecvt *);
213
214 _IO_iconv_t __cd_in;
215 _IO_iconv_t __cd_out;
216 };
217
218 /* Extra data for wide character streams. */
219 struct _IO_wide_data
220 {
221 wchar_t *_IO_read_ptr; /* Current read pointer */
222 wchar_t *_IO_read_end; /* End of get area. */
223 wchar_t *_IO_read_base; /* Start of putback+get area. */
224 wchar_t *_IO_write_base; /* Start of put area. */
225 wchar_t *_IO_write_ptr; /* Current put pointer. */
226 wchar_t *_IO_write_end; /* End of put area. */
227 wchar_t *_IO_buf_base; /* Start of reserve area. */
228 wchar_t *_IO_buf_end; /* End of reserve area. */
229 /* The following fields are used to support backing up and undo. */
230 wchar_t *_IO_save_base; /* Pointer to start of non-current get area. */
231 wchar_t *_IO_backup_base; /* Pointer to first valid character of
232 backup area */
233 wchar_t *_IO_save_end; /* Pointer to end of non-current get area. */
234
235 __mbstate_t _IO_state;
236 __mbstate_t _IO_last_state;
237 struct _IO_codecvt _codecvt;
238
239 wchar_t _shortbuf[1];
240
241 const struct _IO_jump_t *_wide_vtable;
242 };
243 #endif
244
245 struct _IO_FILE {
246 int _flags; /* High-order word is _IO_MAGIC; rest is flags. */
247 #define _IO_file_flags _flags
248
249 /* The following pointers correspond to the C++ streambuf protocol. */
250 /* Note: Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
251 char* _IO_read_ptr; /* Current read pointer */
252 char* _IO_read_end; /* End of get area. */
253 char* _IO_read_base; /* Start of putback+get area. */
254 char* _IO_write_base; /* Start of put area. */
255 char* _IO_write_ptr; /* Current put pointer. */
256 char* _IO_write_end; /* End of put area. */
257 char* _IO_buf_base; /* Start of reserve area. */
258 char* _IO_buf_end; /* End of reserve area. */
259 /* The following fields are used to support backing up and undo. */
260 char *_IO_save_base; /* Pointer to start of non-current get area. */
261 char *_IO_backup_base; /* Pointer to first valid character of backup area */
262 char *_IO_save_end; /* Pointer to end of non-current get area. */
263
264 struct _IO_marker *_markers;
265
266 struct _IO_FILE *_chain;
267
268 int _fileno;
269 #if 0
270 int _blksize;
271 #else
272 int _flags2;
273 #endif
274 _IO_off_t _old_offset; /* This used to be _offset but it's too small. */
275
276 #define __HAVE_COLUMN /* temporary */
277 /* 1+column number of pbase(); 0 is unknown. */
278 unsigned short _cur_column;
279 signed char _vtable_offset;
280 char _shortbuf[1];
281
282 /* char* _save_gptr; char* _save_egptr; */
283
284 _IO_lock_t *_lock;
285 #ifdef _IO_USE_OLD_IO_FILE
286 };
287
288 struct _IO_FILE_complete
289 {
290 struct _IO_FILE _file;
291 #endif
292 #if defined _G_IO_IO_FILE_VERSION && _G_IO_IO_FILE_VERSION == 0x20001
293 _IO_off64_t _offset;
294 # if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
295 /* Wide character stream stuff. */
296 struct _IO_codecvt *_codecvt;
297 struct _IO_wide_data *_wide_data;
298 struct _IO_FILE *_freeres_list;
299 void *_freeres_buf;
300 size_t _freeres_size;
301 # else
302 void *__pad1;
303 void *__pad2;
304 void *__pad3;
305 void *__pad4;
306 size_t __pad5;
307 # endif
308 int _mode;
309 /* Make sure we don't get into trouble again. */
310 char _unused2[15 * sizeof (int) - 4 * sizeof (void *) - sizeof (size_t)];
311 #endif
312 };
313
314 #ifndef __cplusplus
315 typedef struct _IO_FILE _IO_FILE;
316 #endif
317
318 struct _IO_FILE_plus;
319
320 extern struct _IO_FILE_plus _IO_2_1_stdin_;
321 extern struct _IO_FILE_plus _IO_2_1_stdout_;
322 extern struct _IO_FILE_plus _IO_2_1_stderr_;
323 #ifndef _LIBC
324 #define _IO_stdin ((_IO_FILE*)(&_IO_2_1_stdin_))
325 #define _IO_stdout ((_IO_FILE*)(&_IO_2_1_stdout_))
326 #define _IO_stderr ((_IO_FILE*)(&_IO_2_1_stderr_))
327 #else
328 extern _IO_FILE *_IO_stdin attribute_hidden;
329 extern _IO_FILE *_IO_stdout attribute_hidden;
330 extern _IO_FILE *_IO_stderr attribute_hidden;
331 #endif
332
333
334 /* Functions to do I/O and file management for a stream. */
335
336 /* Read NBYTES bytes from COOKIE into a buffer pointed to by BUF.
337 Return number of bytes read. */
338 typedef __ssize_t __io_read_fn (void *__cookie, char *__buf, size_t __nbytes);
339
340 /* Write N bytes pointed to by BUF to COOKIE. Write all N bytes
341 unless there is an error. Return number of bytes written. If
342 there is an error, return 0 and do not write anything. If the file
343 has been opened for append (__mode.__append set), then set the file
344 pointer to the end of the file and then do the write; if not, just
345 write at the current file pointer. */
346 typedef __ssize_t __io_write_fn (void *__cookie, const char *__buf,
347 size_t __n);
348
349 /* Move COOKIE's file position to *POS bytes from the
350 beginning of the file (if W is SEEK_SET),
351 the current position (if W is SEEK_CUR),
352 or the end of the file (if W is SEEK_END).
353 Set *POS to the new file position.
354 Returns zero if successful, nonzero if not. */
355 typedef int __io_seek_fn (void *__cookie, _IO_off64_t *__pos, int __w);
356
357 /* Close COOKIE. */
358 typedef int __io_close_fn (void *__cookie);
359
360
361 #ifdef _GNU_SOURCE
362 /* User-visible names for the above. */
363 typedef __io_read_fn cookie_read_function_t;
364 typedef __io_write_fn cookie_write_function_t;
365 typedef __io_seek_fn cookie_seek_function_t;
366 typedef __io_close_fn cookie_close_function_t;
367
368 /* The structure with the cookie function pointers. */
369 typedef struct
370 {
371 __io_read_fn *read; /* Read bytes. */
372 __io_write_fn *write; /* Write bytes. */
373 __io_seek_fn *seek; /* Seek/tell file position. */
374 __io_close_fn *close; /* Close file. */
375 } _IO_cookie_io_functions_t;
376 typedef _IO_cookie_io_functions_t cookie_io_functions_t;
377
378 struct _IO_cookie_file;
379
380 /* Initialize one of those. */
381 extern void _IO_cookie_init (struct _IO_cookie_file *__cfile, int __read_write,
382 void *__cookie, _IO_cookie_io_functions_t __fns);
383 #endif
384
385
386 #ifdef __cplusplus
387 extern "C" {
388 #endif
389
390 extern int __underflow (_IO_FILE *);
391 extern int __uflow (_IO_FILE *);
392 extern int __overflow (_IO_FILE *, int);
393 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
394 extern _IO_wint_t __wunderflow (_IO_FILE *);
395 extern _IO_wint_t __wuflow (_IO_FILE *);
396 extern _IO_wint_t __woverflow (_IO_FILE *, _IO_wint_t);
397 #endif
398
399 #if __GNUC__ >= 3
400 # define _IO_BE(expr, res) __builtin_expect ((expr), res)
401 #else
402 # define _IO_BE(expr, res) (expr)
403 #endif
404
405 #define _IO_getc_unlocked(_fp) \
406 (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
407 ? __uflow (_fp) : *(unsigned char *) (_fp)->_IO_read_ptr++)
408 #define _IO_peekc_unlocked(_fp) \
409 (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
410 && __underflow (_fp) == EOF ? EOF \
411 : *(unsigned char *) (_fp)->_IO_read_ptr)
412 #define _IO_putc_unlocked(_ch, _fp) \
413 (_IO_BE ((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end, 0) \
414 ? __overflow (_fp, (unsigned char) (_ch)) \
415 : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
416
417 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
418 # define _IO_getwc_unlocked(_fp) \
419 (_IO_BE ((_fp)->_wide_data == NULL \
420 || ((_fp)->_wide_data->_IO_read_ptr \
421 >= (_fp)->_wide_data->_IO_read_end), 0) \
422 ? __wuflow (_fp) : (_IO_wint_t) *(_fp)->_wide_data->_IO_read_ptr++)
423 # define _IO_putwc_unlocked(_wch, _fp) \
424 (_IO_BE ((_fp)->_wide_data == NULL \
425 || ((_fp)->_wide_data->_IO_write_ptr \
426 >= (_fp)->_wide_data->_IO_write_end), 0) \
427 ? __woverflow (_fp, _wch) \
428 : (_IO_wint_t) (*(_fp)->_wide_data->_IO_write_ptr++ = (_wch)))
429 #endif
430
431 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
432 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
433
434 extern int _IO_getc (_IO_FILE *__fp);
435 extern int _IO_putc (int __c, _IO_FILE *__fp);
436 extern int _IO_feof (_IO_FILE *__fp) __THROW;
437 extern int _IO_ferror (_IO_FILE *__fp) __THROW;
438
439 extern int _IO_peekc_locked (_IO_FILE *__fp);
440
441 /* This one is for Emacs. */
442 #define _IO_PENDING_OUTPUT_COUNT(_fp) \
443 ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
444
445 extern void _IO_flockfile (_IO_FILE *) __THROW;
446 extern void _IO_funlockfile (_IO_FILE *) __THROW;
447 extern int _IO_ftrylockfile (_IO_FILE *) __THROW;
448
449 #ifdef _IO_MTSAFE_IO
450 # define _IO_peekc(_fp) _IO_peekc_locked (_fp)
451 # define _IO_flockfile(_fp) \
452 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_flockfile (_fp)
453 # define _IO_funlockfile(_fp) \
454 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_funlockfile (_fp)
455 #else
456 # define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
457 # define _IO_flockfile(_fp) /**/
458 # define _IO_funlockfile(_fp) /**/
459 # define _IO_ftrylockfile(_fp) /**/
460 # define _IO_cleanup_region_start(_fct, _fp) /**/
461 # define _IO_cleanup_region_end(_Doit) /**/
462 #endif /* !_IO_MTSAFE_IO */
463
464 extern int _IO_vfscanf (_IO_FILE * __restrict, const char * __restrict,
465 _IO_va_list, int *__restrict);
466 extern int _IO_vfprintf (_IO_FILE *__restrict, const char *__restrict,
467 _IO_va_list);
468 extern _IO_ssize_t _IO_padn (_IO_FILE *, int, _IO_ssize_t);
469 extern _IO_size_t _IO_sgetn (_IO_FILE *, void *, _IO_size_t);
470
471 extern _IO_off64_t _IO_seekoff (_IO_FILE *, _IO_off64_t, int, int);
472 extern _IO_off64_t _IO_seekpos (_IO_FILE *, _IO_off64_t, int);
473
474 extern void _IO_free_backup_area (_IO_FILE *) __THROW;
475
476 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
477 extern _IO_wint_t _IO_getwc (_IO_FILE *__fp);
478 extern _IO_wint_t _IO_putwc (wchar_t __wc, _IO_FILE *__fp);
479 extern int _IO_fwide (_IO_FILE *__fp, int __mode) __THROW;
480 # if __GNUC__ >= 2
481 /* While compiling glibc we have to handle compatibility with very old
482 versions. */
483 # if defined _LIBC && defined SHARED
484 # include <shlib-compat.h>
485 # if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
486 # define _IO_fwide_maybe_incompatible \
487 (__builtin_expect (&_IO_stdin_used == NULL, 0))
488 extern const int _IO_stdin_used;
489 weak_extern (_IO_stdin_used);
490 # endif
491 # endif
492 # ifndef _IO_fwide_maybe_incompatible
493 # define _IO_fwide_maybe_incompatible (0)
494 # endif
495 /* A special optimized version of the function above. It optimizes the
496 case of initializing an unoriented byte stream. */
497 # define _IO_fwide(__fp, __mode) \
498 ({ int __result = (__mode); \
499 if (__result < 0 && ! _IO_fwide_maybe_incompatible) \
500 { \
501 if ((__fp)->_mode == 0) \
502 /* We know that all we have to do is to set the flag. */ \
503 (__fp)->_mode = -1; \
504 __result = (__fp)->_mode; \
505 } \
506 else if (__builtin_constant_p (__mode) && (__mode) == 0) \
507 __result = _IO_fwide_maybe_incompatible ? -1 : (__fp)->_mode; \
508 else \
509 __result = _IO_fwide (__fp, __result); \
510 __result; })
511 # endif
512
513 extern int _IO_vfwscanf (_IO_FILE * __restrict, const wchar_t * __restrict,
514 _IO_va_list, int *__restrict);
515 extern int _IO_vfwprintf (_IO_FILE *__restrict, const wchar_t *__restrict,
516 _IO_va_list);
517 extern _IO_ssize_t _IO_wpadn (_IO_FILE *, wint_t, _IO_ssize_t);
518 extern void _IO_free_wbackup_area (_IO_FILE *) __THROW;
519 #endif
520
521 #ifdef __LDBL_COMPAT
522 # include <bits/libio-ldbl.h>
523 #endif
524
525 #ifdef __cplusplus
526 }
527 #endif
528
529 #endif /* _IO_STDIO_H */
530