libio/libio.h

   1 /* Copyright (C) 1991-2018 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 _LIBIO_H
  29 #define _LIBIO_H 1
  30
  31 #ifndef _LIBC
  32 # error "libio.h should only be included when building glibc itself"
  33 #endif
  34 #ifdef _ISOMAC
  35 # error "libio.h should not be included under _ISOMAC"
  36 #endif
  37
  38 #include <stdio.h>
  39
  40 #if defined _IO_MTSAFE_IO && !defined _IO_lock_t_defined
  41 # error "Someone forgot to include stdio-lock.h"
  42 #endif
  43
  44 #define __need_wchar_t
  45 #include <stddef.h>
  46
  47 #include <bits/types/__mbstate_t.h>
  48 #include <bits/types/wint_t.h>
  49 #include <gconv.h>
  50
  51 typedef union
  52 {
  53   struct __gconv_info __cd;
  54   struct
  55   {
  56     struct __gconv_info __cd;
  57     struct __gconv_step_data __data;
  58   } __combined;
  59 } _IO_iconv_t;
  60
  61 #include <shlib-compat.h>
  62
  63 /* _IO_seekoff modes */
  64 #define _IOS_INPUT      1
  65 #define _IOS_OUTPUT     2
  66
  67 /* Magic number and bits for the _flags field.  The magic number is
  68    mostly vestigial, but preserved for compatibility.  It occupies the
  69    high 16 bits of _flags; the low 16 bits are actual flag bits.  */
  70
  71 #define _IO_MAGIC         0xFBAD0000 /* Magic number */
  72 #define _IO_MAGIC_MASK    0xFFFF0000
  73 #define _IO_USER_BUF          0x0001 /* Don't deallocate buffer on close. */
  74 #define _IO_UNBUFFERED        0x0002
  75 #define _IO_NO_READS          0x0004 /* Reading not allowed.  */
  76 #define _IO_NO_WRITES         0x0008 /* Writing not allowed.  */
  77 #define _IO_EOF_SEEN          0x0010
  78 #define _IO_ERR_SEEN          0x0020
  79 #define _IO_DELETE_DONT_CLOSE 0x0040 /* Don't call close(_fileno) on close.  */
  80 #define _IO_LINKED            0x0080 /* In the list of all open files.  */
  81 #define _IO_IN_BACKUP         0x0100
  82 #define _IO_LINE_BUF          0x0200
  83 #define _IO_TIED_PUT_GET      0x0400 /* Put and get pointer move in unison.  */
  84 #define _IO_CURRENTLY_PUTTING 0x0800
  85 #define _IO_IS_APPENDING      0x1000
  86 #define _IO_IS_FILEBUF        0x2000
  87                            /* 0x4000  No longer used, reserved for compat.  */
  88 #define _IO_USER_LOCK         0x8000
  89
  90 /* Bits for the _flags2 field.  */
  91 #define _IO_FLAGS2_MMAP 1
  92 #define _IO_FLAGS2_NOTCANCEL 2
  93 #define _IO_FLAGS2_FORTIFY 4
  94 #define _IO_FLAGS2_USER_WBUF 8
  95 #define _IO_FLAGS2_NOCLOSE 32
  96 #define _IO_FLAGS2_CLOEXEC 64
  97 #define _IO_FLAGS2_NEED_LOCK 128
  98
  99 /* _IO_pos_BAD is an off64_t value indicating error, unknown, or EOF.  */
 100 #define _IO_pos_BAD ((off64_t) -1)
 101
 102 /* _IO_pos_adjust adjusts an off64_t by some number of bytes.  */
 103 #define _IO_pos_adjust(pos, delta) ((pos) += (delta))
 104
 105 /* _IO_pos_0 is an off64_t value indicating beginning of file.  */
 106 #define _IO_pos_0 ((off64_t) 0)
 107
 108 struct _IO_jump_t;
 109
 110 /* A streammarker remembers a position in a buffer. */
 111 struct _IO_marker {
 112   struct _IO_marker *_next;
 113   FILE *_sbuf;
 114   /* If _pos >= 0
 115  it points to _buf->Gbase()+_pos. FIXME comment */
 116   /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
 117   int _pos;
 118 };
 119
 120 /* This is the structure from the libstdc++ codecvt class.  */
 121 enum __codecvt_result
 122 {
 123   __codecvt_ok,
 124   __codecvt_partial,
 125   __codecvt_error,
 126   __codecvt_noconv
 127 };
 128
 129 /* The order of the elements in the following struct must match the order
 130    of the virtual functions in the libstdc++ codecvt class.  */
 131 struct _IO_codecvt
 132 {
 133   void (*__codecvt_destr) (struct _IO_codecvt *);
 134   enum __codecvt_result (*__codecvt_do_out) (struct _IO_codecvt *,
 135                                              __mbstate_t *,
 136                                              const wchar_t *,
 137                                              const wchar_t *,
 138                                              const wchar_t **, char *,
 139                                              char *, char **);
 140   enum __codecvt_result (*__codecvt_do_unshift) (struct _IO_codecvt *,
 141                                                  __mbstate_t *, char *,
 142                                                  char *, char **);
 143   enum __codecvt_result (*__codecvt_do_in) (struct _IO_codecvt *,
 144                                             __mbstate_t *,
 145                                             const char *, const char *,
 146                                             const char **, wchar_t *,
 147                                             wchar_t *, wchar_t **);
 148   int (*__codecvt_do_encoding) (struct _IO_codecvt *);
 149   int (*__codecvt_do_always_noconv) (struct _IO_codecvt *);
 150   int (*__codecvt_do_length) (struct _IO_codecvt *, __mbstate_t *,
 151                               const char *, const char *, size_t);
 152   int (*__codecvt_do_max_length) (struct _IO_codecvt *);
 153
 154   _IO_iconv_t __cd_in;
 155   _IO_iconv_t __cd_out;
 156 };
 157
 158 /* Extra data for wide character streams.  */
 159 struct _IO_wide_data
 160 {
 161   wchar_t *_IO_read_ptr;        /* Current read pointer */
 162   wchar_t *_IO_read_end;        /* End of get area. */
 163   wchar_t *_IO_read_base;       /* Start of putback+get area. */
 164   wchar_t *_IO_write_base;      /* Start of put area. */
 165   wchar_t *_IO_write_ptr;       /* Current put pointer. */
 166   wchar_t *_IO_write_end;       /* End of put area. */
 167   wchar_t *_IO_buf_base;        /* Start of reserve area. */
 168   wchar_t *_IO_buf_end;         /* End of reserve area. */
 169   /* The following fields are used to support backing up and undo. */
 170   wchar_t *_IO_save_base;       /* Pointer to start of non-current get area. */
 171   wchar_t *_IO_backup_base;     /* Pointer to first valid character of
 172                                    backup area */
 173   wchar_t *_IO_save_end;        /* Pointer to end of non-current get area. */
 174
 175   __mbstate_t _IO_state;
 176   __mbstate_t _IO_last_state;
 177   struct _IO_codecvt _codecvt;
 178
 179   wchar_t _shortbuf[1];
 180
 181   const struct _IO_jump_t *_wide_vtable;
 182 };
 183
 184 struct _IO_FILE_plus;
 185
 186 extern struct _IO_FILE_plus _IO_2_1_stdin_;
 187 extern struct _IO_FILE_plus _IO_2_1_stdout_;
 188 extern struct _IO_FILE_plus _IO_2_1_stderr_;
 189 extern FILE *_IO_stdin attribute_hidden;
 190 extern FILE *_IO_stdout attribute_hidden;
 191 extern FILE *_IO_stderr attribute_hidden;
 192
 193 struct _IO_cookie_file;
 194
 195 /* Initialize one of those.  */
 196 extern void _IO_cookie_init (struct _IO_cookie_file *__cfile, int __read_write,
 197                              void *__cookie, cookie_io_functions_t __fns);
 198
 199 extern int __underflow (FILE *);
 200 extern wint_t __wunderflow (FILE *);
 201 extern wint_t __wuflow (FILE *);
 202 extern wint_t __woverflow (FILE *, wint_t);
 203
 204 #define _IO_getc_unlocked(_fp) __getc_unlocked_body (_fp)
 205 #define _IO_peekc_unlocked(_fp)                                         \
 206   (__glibc_unlikely ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end)        \
 207    && __underflow (_fp) == EOF                                          \
 208    ? EOF                                                                \
 209    : *(unsigned char *) (_fp)->_IO_read_ptr)
 210 #define _IO_putc_unlocked(_ch, _fp) __putc_unlocked_body (_ch, _fp)
 211
 212 # define _IO_getwc_unlocked(_fp)                                        \
 213   (__glibc_unlikely ((_fp)->_wide_data == NULL                          \
 214                      || ((_fp)->_wide_data->_IO_read_ptr                \
 215                          >= (_fp)->_wide_data->_IO_read_end))           \
 216    ? __wuflow (_fp) : (wint_t) *(_fp)->_wide_data->_IO_read_ptr++)
 217 # define _IO_putwc_unlocked(_wch, _fp)                                  \
 218   (__glibc_unlikely ((_fp)->_wide_data == NULL                          \
 219                      || ((_fp)->_wide_data->_IO_write_ptr               \
 220                          >= (_fp)->_wide_data->_IO_write_end))          \
 221    ? __woverflow (_fp, _wch)                                            \
 222    : (wint_t) (*(_fp)->_wide_data->_IO_write_ptr++ = (_wch)))
 223
 224 #define _IO_feof_unlocked(_fp) __feof_unlocked_body (_fp)
 225 #define _IO_ferror_unlocked(_fp) __ferror_unlocked_body (_fp)
 226
 227 extern int _IO_getc (FILE *__fp);
 228 extern int _IO_putc (int __c, FILE *__fp);
 229 extern int _IO_feof (FILE *__fp) __THROW;
 230 extern int _IO_ferror (FILE *__fp) __THROW;
 231
 232 extern int _IO_peekc_locked (FILE *__fp);
 233
 234 /* This one is for Emacs. */
 235 #define _IO_PENDING_OUTPUT_COUNT(_fp)   \
 236         ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
 237
 238 extern void _IO_flockfile (FILE *) __THROW;
 239 extern void _IO_funlockfile (FILE *) __THROW;
 240 extern int _IO_ftrylockfile (FILE *) __THROW;
 241
 242 #define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
 243 #define _IO_flockfile(_fp) /**/
 244 #define _IO_funlockfile(_fp) /**/
 245 #define _IO_ftrylockfile(_fp) /**/
 246 #ifndef _IO_cleanup_region_start
 247 #define _IO_cleanup_region_start(_fct, _fp) /**/
 248 #endif
 249 #ifndef _IO_cleanup_region_end
 250 #define _IO_cleanup_region_end(_Doit) /**/
 251 #endif
 252
 253 #define _IO_need_lock(_fp) \
 254   (((_fp)->_flags2 & _IO_FLAGS2_NEED_LOCK) != 0)
 255
 256 extern int _IO_vfscanf (FILE * __restrict, const char * __restrict,
 257                         __gnuc_va_list, int *__restrict);
 258 extern int _IO_vfprintf (FILE *__restrict, const char *__restrict,
 259                          __gnuc_va_list);
 260 extern __ssize_t _IO_padn (FILE *, int, __ssize_t);
 261 extern size_t _IO_sgetn (FILE *, void *, size_t);
 262
 263 extern off64_t _IO_seekoff (FILE *, off64_t, int, int);
 264 extern off64_t _IO_seekpos (FILE *, off64_t, int);
 265
 266 extern void _IO_free_backup_area (FILE *) __THROW;
 267
 268
 269 extern wint_t _IO_getwc (FILE *__fp);
 270 extern wint_t _IO_putwc (wchar_t __wc, FILE *__fp);
 271 extern int _IO_fwide (FILE *__fp, int __mode) __THROW;
 272
 273 #if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
 274 #  define _IO_fwide_maybe_incompatible \
 275   (__glibc_unlikely (&_IO_stdin_used == NULL))
 276 extern const int _IO_stdin_used;
 277 weak_extern (_IO_stdin_used);
 278 #else
 279 # define _IO_fwide_maybe_incompatible (0)
 280 #endif
 281
 282 /* A special optimized version of the function above.  It optimizes the
 283    case of initializing an unoriented byte stream.  */
 284 #define _IO_fwide(__fp, __mode) \
 285   ({ int __result = (__mode);                                                 \
 286      if (__result < 0 && ! _IO_fwide_maybe_incompatible)                      \
 287        {                                                                      \
 288          if ((__fp)->_mode == 0)                                              \
 289            /* We know that all we have to do is to set the flag.  */          \
 290            (__fp)->_mode = -1;                                                \
 291          __result = (__fp)->_mode;                                            \
 292        }                                                                      \
 293      else if (__builtin_constant_p (__mode) && (__mode) == 0)                 \
 294        __result = _IO_fwide_maybe_incompatible ? -1 : (__fp)->_mode;          \
 295      else                                                                     \
 296        __result = _IO_fwide (__fp, __result);                                 \
 297      __result; })
 298
 299 extern int _IO_vfwscanf (FILE * __restrict, const wchar_t * __restrict,
 300                          __gnuc_va_list, int *__restrict);
 301 extern int _IO_vfwprintf (FILE *__restrict, const wchar_t *__restrict,
 302                           __gnuc_va_list);
 303 extern __ssize_t _IO_wpadn (FILE *, wint_t, __ssize_t);
 304 extern void _IO_free_wbackup_area (FILE *) __THROW;
 305
 306 #ifdef __LDBL_COMPAT
 307 __LDBL_REDIR_DECL (_IO_vfscanf)
 308 __LDBL_REDIR_DECL (_IO_vfprintf)
 309 #endif
 310
 311 libc_hidden_proto (__overflow)
 312 libc_hidden_proto (__underflow)
 313 libc_hidden_proto (__uflow)
 314 libc_hidden_proto (__woverflow)
 315 libc_hidden_proto (__wunderflow)
 316 libc_hidden_proto (__wuflow)
 317 libc_hidden_proto (_IO_free_backup_area)
 318 libc_hidden_proto (_IO_free_wbackup_area)
 319 libc_hidden_proto (_IO_padn)
 320 libc_hidden_proto (_IO_putc)
 321 libc_hidden_proto (_IO_sgetn)
 322 libc_hidden_proto (_IO_vfprintf)
 323
 324 #ifdef _IO_MTSAFE_IO
 325 # undef _IO_peekc
 326 # undef _IO_flockfile
 327 # undef _IO_funlockfile
 328 # undef _IO_ftrylockfile
 329
 330 # define _IO_peekc(_fp) _IO_peekc_locked (_fp)
 331 # if _IO_lock_inexpensive
 332 #  define _IO_flockfile(_fp) \
 333   if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_lock_lock (*(_fp)->_lock)
 334 #  define _IO_funlockfile(_fp) \
 335   if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_lock_unlock (*(_fp)->_lock)
 336 # else
 337 #  define _IO_flockfile(_fp) \
 338   if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_flockfile (_fp)
 339 #  define _IO_funlockfile(_fp) \
 340   if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_funlockfile (_fp)
 341 # endif
 342 #endif /* _IO_MTSAFE_IO */
 343
 344 #endif /* _LIBIO_H */