libio/libio.h

   1 /* Copyright (C) 1991, 92, 93, 94, 95, 97 Free Software Foundation, Inc.
   2    This file is part of the GNU IO Library.
   3    Written by Per Bothner <bothner@cygnus.com>.
   4
   5    This library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2, or (at
   8    your option) any later version.
   9
  10    This library is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this library; see the file COPYING.  If not, write to
  17    the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  18    MA 02111-1307, USA.
  19
  20    As a special exception, if you link this library with files
  21    compiled with a GNU compiler to produce an executable, this does
  22    not cause the resulting executable to be covered by the GNU General
  23    Public License.  This exception does not however invalidate any
  24    other reasons why the executable file might be covered by the GNU
  25    General Public License.  */
  26
  27 #ifndef _IO_STDIO_H
  28 #define _IO_STDIO_H
  29
  30 #include <_G_config.h>
  31 #define _IO_pos_t _G_fpos_t /* obsolete */
  32 #define _IO_fpos_t _G_fpos_t
  33 #define _IO_fpos64_t _G_fpos64_t
  34 #define _IO_size_t _G_size_t
  35 #define _IO_ssize_t _G_ssize_t
  36 #define _IO_off_t _G_off_t
  37 #define _IO_off64_t _G_off64_t
  38 #define _IO_pid_t _G_pid_t
  39 #define _IO_uid_t _G_uid_t
  40 #define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
  41 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
  42 #define _IO_BUFSIZ _G_BUFSIZ
  43 #define _IO_va_list _G_va_list
  44
  45 #ifdef _G_NEED_STDARG_H
  46 /* This define avoids name pollution if we're using GNU stdarg.h */
  47 # define __need___va_list
  48 # include <stdarg.h>
  49 # ifdef __GNUC_VA_LIST
  50 #  undef _IO_va_list
  51 #  define _IO_va_list __gnuc_va_list
  52 # endif /* __GNUC_VA_LIST */
  53 #endif
  54
  55 #ifndef __P
  56 # if _G_HAVE_SYS_CDEFS
  57 #  include <sys/cdefs.h>
  58 # else
  59 #  ifdef __STDC__
  60 #   define __P(protos) protos
  61 #  else
  62 #   define __P(protos) ()
  63 #  endif
  64 # endif
  65 #endif /*!__P*/
  66
  67 /* For backward compatibility */
  68 #ifndef _PARAMS
  69 # define _PARAMS(protos) __P(protos)
  70 #endif /*!_PARAMS*/
  71
  72 #ifndef __STDC__
  73 # define const
  74 #endif
  75 #define _IO_UNIFIED_JUMPTABLES 1
  76 #ifndef _G_HAVE_PRINTF_FP
  77 # define _IO_USE_DTOA 1
  78 #endif
  79
  80 #ifndef EOF
  81 # define EOF (-1)
  82 #endif
  83 #ifndef NULL
  84 # if defined __GNUG__ && \
  85     (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
  86 #  define NULL (__null)
  87 # else
  88 #  if !defined(__cplusplus)
  89 #   define NULL ((void*)0)
  90 #  else
  91 #   define NULL (0)
  92 #  endif
  93 # endif
  94 #endif
  95
  96 #define _IOS_INPUT      1
  97 #define _IOS_OUTPUT     2
  98 #define _IOS_ATEND      4
  99 #define _IOS_APPEND     8
 100 #define _IOS_TRUNC      16
 101 #define _IOS_NOCREATE   32
 102 #define _IOS_NOREPLACE  64
 103 #define _IOS_BIN        128
 104
 105 /* Magic numbers and bits for the _flags field.
 106    The magic numbers use the high-order bits of _flags;
 107    the remaining bits are available for variable flags.
 108    Note: The magic numbers must all be negative if stdio
 109    emulation is desired. */
 110
 111 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
 112 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
 113 #define _IO_MAGIC_MASK 0xFFFF0000
 114 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
 115 #define _IO_UNBUFFERED 2
 116 #define _IO_NO_READS 4 /* Reading not allowed */
 117 #define _IO_NO_WRITES 8 /* Writing not allowd */
 118 #define _IO_EOF_SEEN 0x10
 119 #define _IO_ERR_SEEN 0x20
 120 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
 121 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
 122 #define _IO_IN_BACKUP 0x100
 123 #define _IO_LINE_BUF 0x200
 124 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
 125 #define _IO_CURRENTLY_PUTTING 0x800
 126 #define _IO_IS_APPENDING 0x1000
 127 #define _IO_IS_FILEBUF 0x2000
 128 #define _IO_BAD_SEEN 0x4000
 129
 130 /* These are "formatting flags" matching the iostream fmtflags enum values. */
 131 #define _IO_SKIPWS 01
 132 #define _IO_LEFT 02
 133 #define _IO_RIGHT 04
 134 #define _IO_INTERNAL 010
 135 #define _IO_DEC 020
 136 #define _IO_OCT 040
 137 #define _IO_HEX 0100
 138 #define _IO_SHOWBASE 0200
 139 #define _IO_SHOWPOINT 0400
 140 #define _IO_UPPERCASE 01000
 141 #define _IO_SHOWPOS 02000
 142 #define _IO_SCIENTIFIC 04000
 143 #define _IO_FIXED 010000
 144 #define _IO_UNITBUF 020000
 145 #define _IO_STDIO 040000
 146 #define _IO_DONT_CLOSE 0100000
 147 #define _IO_BOOLALPHA 0200000
 148
 149
 150 struct _IO_jump_t;  struct _IO_FILE;
 151
 152 /* Handle lock.  */
 153 #ifdef _IO_MTSAFE_IO
 154 # if defined __GLIBC__ && __GLIBC__ >= 2
 155 #  include <bits/stdio-lock.h>
 156 # else
 157 /*# include <comthread.h>*/
 158 # endif
 159 #else
 160 typedef void _IO_lock_t;
 161 #endif
 162
 163
 164 /* A streammarker remembers a position in a buffer. */
 165
 166 struct _IO_marker {
 167   struct _IO_marker *_next;
 168   struct _IO_FILE *_sbuf;
 169   /* If _pos >= 0
 170  it points to _buf->Gbase()+_pos. FIXME comment */
 171   /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
 172   int _pos;
 173 #if 0
 174     void set_streampos(streampos sp) { _spos = sp; }
 175     void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
 176   public:
 177     streammarker(streambuf *sb);
 178     ~streammarker();
 179     int saving() { return  _spos == -2; }
 180     int delta(streammarker&);
 181     int delta();
 182 #endif
 183 };
 184
 185 struct _IO_FILE {
 186   int _flags;           /* High-order word is _IO_MAGIC; rest is flags. */
 187 #define _IO_file_flags _flags
 188
 189   /* The following pointers correspond to the C++ streambuf protocol. */
 190   /* Note:  Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
 191   char* _IO_read_ptr;   /* Current read pointer */
 192   char* _IO_read_end;   /* End of get area. */
 193   char* _IO_read_base;  /* Start of putback+get area. */
 194   char* _IO_write_base; /* Start of put area. */
 195   char* _IO_write_ptr;  /* Current put pointer. */
 196   char* _IO_write_end;  /* End of put area. */
 197   char* _IO_buf_base;   /* Start of reserve area. */
 198   char* _IO_buf_end;    /* End of reserve area. */
 199   /* The following fields are used to support backing up and undo. */
 200   char *_IO_save_base; /* Pointer to start of non-current get area. */
 201   char *_IO_backup_base;  /* Pointer to first valid character of backup area */
 202   char *_IO_save_end; /* Pointer to end of non-current get area. */
 203
 204   struct _IO_marker *_markers;
 205
 206   struct _IO_FILE *_chain;
 207
 208   int _fileno;
 209   int _blksize;
 210   _IO_off_t _unused2;   /* This used to be _offset but it's too small.  */
 211
 212 #define __HAVE_COLUMN /* temporary */
 213   /* 1+column number of pbase(); 0 is unknown. */
 214   unsigned short _cur_column;
 215   char _unused;
 216   char _shortbuf[1];
 217
 218   /*  char* _save_gptr;  char* _save_egptr; */
 219
 220   _IO_lock_t *_lock;
 221
 222   _IO_off64_t _offset;
 223 };
 224
 225 #ifndef __cplusplus
 226 typedef struct _IO_FILE _IO_FILE;
 227 #endif
 228
 229 struct _IO_FILE_plus;
 230 extern struct _IO_FILE_plus _IO_stdin_, _IO_stdout_, _IO_stderr_;
 231 #define _IO_stdin ((_IO_FILE*)(&_IO_stdin_))
 232 #define _IO_stdout ((_IO_FILE*)(&_IO_stdout_))
 233 #define _IO_stderr ((_IO_FILE*)(&_IO_stderr_))
 234
 235
 236 /* Define the user-visible type, with user-friendly member names.  */
 237 typedef struct
 238 {
 239   _IO_ssize_t (*read) __P ((struct _IO_FILE *, void *, _IO_ssize_t));
 240   _IO_ssize_t (*write) __P ((struct _IO_FILE *, const void *, _IO_ssize_t));
 241   _IO_fpos_t (*seek) __P ((struct _IO_FILE *, _IO_off_t, int));
 242   int (*close) __P ((struct _IO_FILE *));
 243 } _IO_cookie_io_functions_t;
 244
 245 /* Special file type for fopencookie function.  */
 246 struct _IO_cookie_file
 247 {
 248   struct _IO_FILE file;
 249   const void *vtable;
 250   void *cookie;
 251   _IO_cookie_io_functions_t io_functions;
 252 };
 253
 254
 255 #ifdef __cplusplus
 256 extern "C" {
 257 #endif
 258
 259 extern int __underflow __P ((_IO_FILE *));
 260 extern int __uflow __P ((_IO_FILE *));
 261 extern int __overflow __P ((_IO_FILE *, int));
 262
 263 #define _IO_getc_unlocked(_fp) \
 264        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow (_fp) \
 265         : *(unsigned char *) (_fp)->_IO_read_ptr++)
 266 #define _IO_peekc_unlocked(_fp) \
 267        ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
 268           && __underflow (_fp) == EOF ? EOF \
 269         : *(unsigned char *) (_fp)->_IO_read_ptr)
 270
 271 #define _IO_putc_unlocked(_ch, _fp) \
 272    (((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
 273     ? __overflow (_fp, (unsigned char) (_ch)) \
 274     : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
 275
 276 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
 277 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
 278
 279 extern int _IO_getc __P ((_IO_FILE *__fp));
 280 extern int _IO_putc __P ((int __c, _IO_FILE *__fp));
 281 extern int _IO_feof __P ((_IO_FILE *__fp));
 282 extern int _IO_ferror __P ((_IO_FILE *__fp));
 283
 284 extern int _IO_peekc_locked __P ((_IO_FILE *__fp));
 285
 286 /* This one is for Emacs. */
 287 #define _IO_PENDING_OUTPUT_COUNT(_fp)   \
 288         ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
 289
 290 extern void _IO_flockfile __P ((_IO_FILE *));
 291 extern void _IO_funlockfile __P ((_IO_FILE *));
 292 extern int _IO_ftrylockfile __P ((_IO_FILE *));
 293
 294 #ifdef _IO_MTSAFE_IO
 295 # define _IO_peekc(_fp) _IO_peekc_locked (_fp)
 296 #else
 297 # define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
 298 # define _IO_flockfile(_fp) /**/
 299 # define _IO_funlockfile(_fp) /**/
 300 # define _IO_ftrylockfile(_fp) /**/
 301 # define _IO_cleanup_region_start(_fct, _fp) /**/
 302 # define _IO_cleanup_region_end(_Doit) /**/
 303 #endif /* !_IO_MTSAFE_IO */
 304
 305 extern int _IO_vfscanf __P ((_IO_FILE *, const char *, _IO_va_list, int *));
 306 extern int _IO_vfprintf __P ((_IO_FILE *, const char *, _IO_va_list));
 307 extern _IO_ssize_t _IO_padn __P ((_IO_FILE *, int, _IO_ssize_t));
 308 extern _IO_size_t _IO_sgetn __P ((_IO_FILE *, void *, _IO_size_t));
 309
 310 extern _IO_fpos64_t _IO_seekoff __P ((_IO_FILE *, _IO_off64_t, int, int));
 311 extern _IO_fpos64_t _IO_seekpos __P ((_IO_FILE *, _IO_fpos64_t, int));
 312
 313 extern void _IO_free_backup_area __P ((_IO_FILE *));
 314
 315 #ifdef __cplusplus
 316 }
 317 #endif
 318
 319 #endif /* _IO_STDIO_H */