libio/libio.h

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