2006-03-03 Steven Munroe <sjmunroe@us.ibm.com> Alan Modra <amodra@bigpond.net.au>
[glibc/history.git] / libio / libio.h
blob6f9c418c31d60912d8d9eaa48f41e8b90ad09e67
1 /* Copyright (C) 1991-1995,1997-2005,2006 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
141 #define _IO_FLAGS2_NOTCANCEL 2
142 #ifdef _LIBC
143 # define _IO_FLAGS2_FORTIFY 4
144 #endif
146 /* These are "formatting flags" matching the iostream fmtflags enum values. */
147 #define _IO_SKIPWS 01
148 #define _IO_LEFT 02
149 #define _IO_RIGHT 04
150 #define _IO_INTERNAL 010
151 #define _IO_DEC 020
152 #define _IO_OCT 040
153 #define _IO_HEX 0100
154 #define _IO_SHOWBASE 0200
155 #define _IO_SHOWPOINT 0400
156 #define _IO_UPPERCASE 01000
157 #define _IO_SHOWPOS 02000
158 #define _IO_SCIENTIFIC 04000
159 #define _IO_FIXED 010000
160 #define _IO_UNITBUF 020000
161 #define _IO_STDIO 040000
162 #define _IO_DONT_CLOSE 0100000
163 #define _IO_BOOLALPHA 0200000
166 struct _IO_jump_t; struct _IO_FILE;
168 /* Handle lock. */
169 #ifdef _IO_MTSAFE_IO
170 # if defined __GLIBC__ && __GLIBC__ >= 2
171 # include <bits/stdio-lock.h>
172 # else
173 /*# include <comthread.h>*/
174 # endif
175 #else
176 typedef void _IO_lock_t;
177 #endif
180 /* A streammarker remembers a position in a buffer. */
182 struct _IO_marker {
183 struct _IO_marker *_next;
184 struct _IO_FILE *_sbuf;
185 /* If _pos >= 0
186 it points to _buf->Gbase()+_pos. FIXME comment */
187 /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
188 int _pos;
189 #if 0
190 void set_streampos(streampos sp) { _spos = sp; }
191 void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
192 public:
193 streammarker(streambuf *sb);
194 ~streammarker();
195 int saving() { return _spos == -2; }
196 int delta(streammarker&);
197 int delta();
198 #endif
201 /* This is the structure from the libstdc++ codecvt class. */
202 enum __codecvt_result
204 __codecvt_ok,
205 __codecvt_partial,
206 __codecvt_error,
207 __codecvt_noconv
210 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
211 /* The order of the elements in the following struct must match the order
212 of the virtual functions in the libstdc++ codecvt class. */
213 struct _IO_codecvt
215 void (*__codecvt_destr) (struct _IO_codecvt *);
216 enum __codecvt_result (*__codecvt_do_out) (struct _IO_codecvt *,
217 __mbstate_t *,
218 const wchar_t *,
219 const wchar_t *,
220 const wchar_t **, char *,
221 char *, char **);
222 enum __codecvt_result (*__codecvt_do_unshift) (struct _IO_codecvt *,
223 __mbstate_t *, char *,
224 char *, char **);
225 enum __codecvt_result (*__codecvt_do_in) (struct _IO_codecvt *,
226 __mbstate_t *,
227 const char *, const char *,
228 const char **, wchar_t *,
229 wchar_t *, wchar_t **);
230 int (*__codecvt_do_encoding) (struct _IO_codecvt *);
231 int (*__codecvt_do_always_noconv) (struct _IO_codecvt *);
232 int (*__codecvt_do_length) (struct _IO_codecvt *, __mbstate_t *,
233 const char *, const char *, _IO_size_t);
234 int (*__codecvt_do_max_length) (struct _IO_codecvt *);
236 _IO_iconv_t __cd_in;
237 _IO_iconv_t __cd_out;
240 /* Extra data for wide character streams. */
241 struct _IO_wide_data
243 wchar_t *_IO_read_ptr; /* Current read pointer */
244 wchar_t *_IO_read_end; /* End of get area. */
245 wchar_t *_IO_read_base; /* Start of putback+get area. */
246 wchar_t *_IO_write_base; /* Start of put area. */
247 wchar_t *_IO_write_ptr; /* Current put pointer. */
248 wchar_t *_IO_write_end; /* End of put area. */
249 wchar_t *_IO_buf_base; /* Start of reserve area. */
250 wchar_t *_IO_buf_end; /* End of reserve area. */
251 /* The following fields are used to support backing up and undo. */
252 wchar_t *_IO_save_base; /* Pointer to start of non-current get area. */
253 wchar_t *_IO_backup_base; /* Pointer to first valid character of
254 backup area */
255 wchar_t *_IO_save_end; /* Pointer to end of non-current get area. */
257 __mbstate_t _IO_state;
258 __mbstate_t _IO_last_state;
259 struct _IO_codecvt _codecvt;
261 wchar_t _shortbuf[1];
263 const struct _IO_jump_t *_wide_vtable;
265 #endif
267 struct _IO_FILE {
268 int _flags; /* High-order word is _IO_MAGIC; rest is flags. */
269 #define _IO_file_flags _flags
271 /* The following pointers correspond to the C++ streambuf protocol. */
272 /* Note: Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
273 char* _IO_read_ptr; /* Current read pointer */
274 char* _IO_read_end; /* End of get area. */
275 char* _IO_read_base; /* Start of putback+get area. */
276 char* _IO_write_base; /* Start of put area. */
277 char* _IO_write_ptr; /* Current put pointer. */
278 char* _IO_write_end; /* End of put area. */
279 char* _IO_buf_base; /* Start of reserve area. */
280 char* _IO_buf_end; /* End of reserve area. */
281 /* The following fields are used to support backing up and undo. */
282 char *_IO_save_base; /* Pointer to start of non-current get area. */
283 char *_IO_backup_base; /* Pointer to first valid character of backup area */
284 char *_IO_save_end; /* Pointer to end of non-current get area. */
286 struct _IO_marker *_markers;
288 struct _IO_FILE *_chain;
290 int _fileno;
291 #if 0
292 int _blksize;
293 #else
294 int _flags2;
295 #endif
296 _IO_off_t _old_offset; /* This used to be _offset but it's too small. */
298 #define __HAVE_COLUMN /* temporary */
299 /* 1+column number of pbase(); 0 is unknown. */
300 unsigned short _cur_column;
301 signed char _vtable_offset;
302 char _shortbuf[1];
304 /* char* _save_gptr; char* _save_egptr; */
306 _IO_lock_t *_lock;
307 #ifdef _IO_USE_OLD_IO_FILE
310 struct _IO_FILE_complete
312 struct _IO_FILE _file;
313 #endif
314 #if defined _G_IO_IO_FILE_VERSION && _G_IO_IO_FILE_VERSION == 0x20001
315 _IO_off64_t _offset;
316 # if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
317 /* Wide character stream stuff. */
318 struct _IO_codecvt *_codecvt;
319 struct _IO_wide_data *_wide_data;
320 struct _IO_FILE *_freeres_list;
321 void *_freeres_buf;
322 size_t _freeres_size;
323 # else
324 void *__pad1;
325 void *__pad2;
326 void *__pad3;
327 void *__pad4;
328 size_t __pad5;
329 # endif
330 int _mode;
331 /* Make sure we don't get into trouble again. */
332 char _unused2[15 * sizeof (int) - 4 * sizeof (void *) - sizeof (size_t)];
333 #endif
336 #ifndef __cplusplus
337 typedef struct _IO_FILE _IO_FILE;
338 #endif
340 struct _IO_FILE_plus;
342 extern struct _IO_FILE_plus _IO_2_1_stdin_;
343 extern struct _IO_FILE_plus _IO_2_1_stdout_;
344 extern struct _IO_FILE_plus _IO_2_1_stderr_;
345 #ifndef _LIBC
346 #define _IO_stdin ((_IO_FILE*)(&_IO_2_1_stdin_))
347 #define _IO_stdout ((_IO_FILE*)(&_IO_2_1_stdout_))
348 #define _IO_stderr ((_IO_FILE*)(&_IO_2_1_stderr_))
349 #else
350 extern _IO_FILE *_IO_stdin attribute_hidden;
351 extern _IO_FILE *_IO_stdout attribute_hidden;
352 extern _IO_FILE *_IO_stderr attribute_hidden;
353 #endif
356 /* Functions to do I/O and file management for a stream. */
358 /* Read NBYTES bytes from COOKIE into a buffer pointed to by BUF.
359 Return number of bytes read. */
360 typedef __ssize_t __io_read_fn (void *__cookie, char *__buf, size_t __nbytes);
362 /* Write N bytes pointed to by BUF to COOKIE. Write all N bytes
363 unless there is an error. Return number of bytes written, or -1 if
364 there is an error without writing anything. If the file has been
365 opened for append (__mode.__append set), then set the file pointer
366 to the end of the file and then do the write; if not, just write at
367 the current file pointer. */
368 typedef __ssize_t __io_write_fn (void *__cookie, __const char *__buf,
369 size_t __n);
371 /* Move COOKIE's file position to *POS bytes from the
372 beginning of the file (if W is SEEK_SET),
373 the current position (if W is SEEK_CUR),
374 or the end of the file (if W is SEEK_END).
375 Set *POS to the new file position.
376 Returns zero if successful, nonzero if not. */
377 typedef int __io_seek_fn (void *__cookie, _IO_off64_t *__pos, int __w);
379 /* Close COOKIE. */
380 typedef int __io_close_fn (void *__cookie);
383 #ifdef _GNU_SOURCE
384 /* User-visible names for the above. */
385 typedef __io_read_fn cookie_read_function_t;
386 typedef __io_write_fn cookie_write_function_t;
387 typedef __io_seek_fn cookie_seek_function_t;
388 typedef __io_close_fn cookie_close_function_t;
390 /* The structure with the cookie function pointers. */
391 typedef struct
393 __io_read_fn *read; /* Read bytes. */
394 __io_write_fn *write; /* Write bytes. */
395 __io_seek_fn *seek; /* Seek/tell file position. */
396 __io_close_fn *close; /* Close file. */
397 } _IO_cookie_io_functions_t;
398 typedef _IO_cookie_io_functions_t cookie_io_functions_t;
400 struct _IO_cookie_file;
402 /* Initialize one of those. */
403 extern void _IO_cookie_init (struct _IO_cookie_file *__cfile, int __read_write,
404 void *__cookie, _IO_cookie_io_functions_t __fns);
405 #endif
408 #ifdef __cplusplus
409 extern "C" {
410 #endif
412 extern int __underflow (_IO_FILE *) __THROW;
413 extern int __uflow (_IO_FILE *) __THROW;
414 extern int __overflow (_IO_FILE *, int) __THROW;
415 extern _IO_wint_t __wunderflow (_IO_FILE *) __THROW;
416 extern _IO_wint_t __wuflow (_IO_FILE *) __THROW;
417 extern _IO_wint_t __woverflow (_IO_FILE *, _IO_wint_t) __THROW;
419 #if __GNUC__ >= 3
420 # define _IO_BE(expr, res) __builtin_expect ((expr), res)
421 #else
422 # define _IO_BE(expr, res) (expr)
423 #endif
425 #define _IO_getc_unlocked(_fp) \
426 (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
427 ? __uflow (_fp) : *(unsigned char *) (_fp)->_IO_read_ptr++)
428 #define _IO_peekc_unlocked(_fp) \
429 (_IO_BE ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end, 0) \
430 && __underflow (_fp) == EOF ? EOF \
431 : *(unsigned char *) (_fp)->_IO_read_ptr)
432 #define _IO_putc_unlocked(_ch, _fp) \
433 (_IO_BE ((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end, 0) \
434 ? __overflow (_fp, (unsigned char) (_ch)) \
435 : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
437 #define _IO_getwc_unlocked(_fp) \
438 (_IO_BE ((_fp)->_wide_data->_IO_read_ptr >= (_fp)->_wide_data->_IO_read_end,\
439 0) \
440 ? __wuflow (_fp) : (_IO_wint_t) *(_fp)->_wide_data->_IO_read_ptr++)
441 #define _IO_putwc_unlocked(_wch, _fp) \
442 (_IO_BE ((_fp)->_wide_data->_IO_write_ptr \
443 >= (_fp)->_wide_data->_IO_write_end, 0) \
444 ? __woverflow (_fp, _wch) \
445 : (_IO_wint_t) (*(_fp)->_wide_data->_IO_write_ptr++ = (_wch)))
447 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
448 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
450 extern int _IO_getc (_IO_FILE *__fp) __THROW;
451 extern int _IO_putc (int __c, _IO_FILE *__fp) __THROW;
452 extern int _IO_feof (_IO_FILE *__fp) __THROW;
453 extern int _IO_ferror (_IO_FILE *__fp) __THROW;
455 extern int _IO_peekc_locked (_IO_FILE *__fp) __THROW;
457 /* This one is for Emacs. */
458 #define _IO_PENDING_OUTPUT_COUNT(_fp) \
459 ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
461 extern void _IO_flockfile (_IO_FILE *) __THROW;
462 extern void _IO_funlockfile (_IO_FILE *) __THROW;
463 extern int _IO_ftrylockfile (_IO_FILE *) __THROW;
465 #ifdef _IO_MTSAFE_IO
466 # define _IO_peekc(_fp) _IO_peekc_locked (_fp)
467 # define _IO_flockfile(_fp) \
468 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_flockfile (_fp)
469 # define _IO_funlockfile(_fp) \
470 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_funlockfile (_fp)
471 #else
472 # define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
473 # define _IO_flockfile(_fp) /**/
474 # define _IO_funlockfile(_fp) /**/
475 # define _IO_ftrylockfile(_fp) /**/
476 # define _IO_cleanup_region_start(_fct, _fp) /**/
477 # define _IO_cleanup_region_end(_Doit) /**/
478 #endif /* !_IO_MTSAFE_IO */
480 extern int _IO_vfscanf (_IO_FILE * __restrict, const char * __restrict,
481 _IO_va_list, int *__restrict);
482 extern int _IO_vfprintf (_IO_FILE *__restrict, const char *__restrict,
483 _IO_va_list);
484 extern _IO_ssize_t _IO_padn (_IO_FILE *, int, _IO_ssize_t) __THROW;
485 extern _IO_size_t _IO_sgetn (_IO_FILE *, void *, _IO_size_t) __THROW;
487 extern _IO_off64_t _IO_seekoff (_IO_FILE *, _IO_off64_t, int, int) __THROW;
488 extern _IO_off64_t _IO_seekpos (_IO_FILE *, _IO_off64_t, int) __THROW;
490 extern void _IO_free_backup_area (_IO_FILE *) __THROW;
492 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
493 extern _IO_wint_t _IO_getwc (_IO_FILE *__fp) __THROW;
494 extern _IO_wint_t _IO_putwc (wchar_t __wc, _IO_FILE *__fp) __THROW;
495 extern int _IO_fwide (_IO_FILE *__fp, int __mode) __THROW;
496 # if __GNUC__ >= 2
497 /* While compiling glibc we have to handle compatibility with very old
498 versions. */
499 # if defined _LIBC && defined SHARED
500 # include <shlib-compat.h>
501 # if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
502 # define _IO_fwide_maybe_incompatible \
503 (__builtin_expect (&_IO_stdin_used == NULL, 0))
504 extern const int _IO_stdin_used;
505 weak_extern (_IO_stdin_used);
506 # endif
507 # endif
508 # ifndef _IO_fwide_maybe_incompatible
509 # define _IO_fwide_maybe_incompatible (0)
510 # endif
511 /* A special optimized version of the function above. It optimizes the
512 case of initializing an unoriented byte stream. */
513 # define _IO_fwide(__fp, __mode) \
514 ({ int __result = (__mode); \
515 if (__result < 0 && ! _IO_fwide_maybe_incompatible) \
517 if ((__fp)->_mode == 0) \
518 /* We know that all we have to do is to set the flag. */ \
519 (__fp)->_mode = -1; \
520 __result = (__fp)->_mode; \
522 else if (__builtin_constant_p (__mode) && (__mode) == 0) \
523 __result = _IO_fwide_maybe_incompatible ? -1 : (__fp)->_mode; \
524 else \
525 __result = _IO_fwide (__fp, __result); \
526 __result; })
527 # endif
529 extern int _IO_vfwscanf (_IO_FILE * __restrict, const wchar_t * __restrict,
530 _IO_va_list, int *__restrict);
531 extern int _IO_vfwprintf (_IO_FILE *__restrict, const wchar_t *__restrict,
532 _IO_va_list);
533 extern _IO_ssize_t _IO_wpadn (_IO_FILE *, wint_t, _IO_ssize_t) __THROW;
534 extern void _IO_free_wbackup_area (_IO_FILE *) __THROW;
535 #endif
537 #ifdef __LDBL_COMPAT
538 # include <bits/libio-ldbl.h>
539 #endif
541 #ifdef __cplusplus
543 #endif
545 #endif /* _IO_STDIO_H */