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