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