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