libio/libio.h

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