io.h

Go to the documentation of this file.

#ifndef RUBY_IO_H                                    /*-*-C++-*-vi:se ft=cpp:*/
#define RUBY_IO_H 1
#include "ruby/internal/config.h"
 
#include <stdio.h>
#include "ruby/encoding.h"
 
#if defined(HAVE_STDIO_EXT_H)
#include <stdio_ext.h>
#endif
 
#include <errno.h>
 
#if defined(HAVE_POLL)
#  ifdef _AIX
#    define reqevents events
#    define rtnevents revents
#  endif
#  include <poll.h>
#  ifdef _AIX
#    undef reqevents
#    undef rtnevents
#    undef events
#    undef revents
#  endif
#  define RB_WAITFD_IN  POLLIN
#  if defined(POLLPRI)
#    define RB_WAITFD_PRI POLLPRI
#  else
#    define RB_WAITFD_PRI 0
#  endif
#  define RB_WAITFD_OUT POLLOUT
#else
#  define RB_WAITFD_IN  0x001
#  define RB_WAITFD_PRI 0x002
#  define RB_WAITFD_OUT 0x004
#endif
#include "ruby/internal/attr/const.h"
#include "ruby/internal/attr/packed_struct.h"
#include "ruby/internal/attr/pure.h"
#include "ruby/internal/attr/noreturn.h"
#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"
 
// IO#wait, IO#wait_readable, IO#wait_writable, IO#wait_priority are defined by this implementation.
#define RUBY_IO_WAIT_METHODS
 
// Used as the default timeout argument to `rb_io_wait` to use the `IO#timeout` value.
#define RUBY_IO_TIMEOUT_DEFAULT Qnil
 
RBIMPL_SYMBOL_EXPORT_BEGIN()
 
struct stat;
struct timeval;
 
RUBY_EXTERN VALUE rb_eIOTimeoutError;
 
enum rb_io_event {
    RUBY_IO_READABLE = RB_WAITFD_IN,  
    RUBY_IO_WRITABLE = RB_WAITFD_OUT, 
    RUBY_IO_PRIORITY = RB_WAITFD_PRI, 
};
 
typedef enum rb_io_event rb_io_event_t;
 
RBIMPL_ATTR_PACKED_STRUCT_UNALIGNED_BEGIN()
struct rb_io_internal_buffer {
 
    char *ptr;                  /* off + len <= capa */
 
    int off;
 
    int len;
 
    int capa;
} RBIMPL_ATTR_PACKED_STRUCT_UNALIGNED_END();
 
typedef struct rb_io_internal_buffer rb_io_buffer_t;
 
/*
 * enc  enc2 read action                      write action
 * NULL NULL force_encoding(default_external) write the byte sequence of str
 * e1   NULL force_encoding(e1)               convert str.encoding to e1
 * e1   e2   convert from e2 to e1            convert str.encoding to e2
 */
struct rb_io_encoding {
    rb_encoding *enc;
    rb_encoding *enc2;
    int ecflags;
    VALUE ecopts;
};
 
#define FMODE_READABLE              0x00000001
 
#define FMODE_WRITABLE              0x00000002
 
#define FMODE_READWRITE             (FMODE_READABLE|FMODE_WRITABLE)
 
#define FMODE_BINMODE               0x00000004
 
#define FMODE_SYNC                  0x00000008
 
#define FMODE_TTY                   0x00000010
 
#define FMODE_DUPLEX                0x00000020
 
#define FMODE_APPEND                0x00000040
 
#define FMODE_CREATE                0x00000080
/* #define FMODE_NOREVLOOKUP        0x00000100 */
 
#define FMODE_EXCL                  0x00000400
 
#define FMODE_TRUNC                 0x00000800
 
#define FMODE_TEXTMODE              0x00001000
#define FMODE_EXTERNAL              0x00010000
 
/* #define FMODE_SIGNAL_ON_EPIPE    0x00020000 */
 
#define FMODE_SETENC_BY_BOM         0x00100000
/* #define FMODE_UNIX                  0x00200000 */
/* #define FMODE_INET                  0x00400000 */
/* #define FMODE_INET6                 0x00800000 */
 
enum rb_io_mode {
    RUBY_IO_MODE_EXTERNAL = FMODE_EXTERNAL,
 
    RUBY_IO_MODE_READABLE = FMODE_READABLE,
    RUBY_IO_MODE_WRITABLE = FMODE_WRITABLE,
    RUBY_IO_MODE_READABLE_WRITABLE = (RUBY_IO_MODE_READABLE|RUBY_IO_MODE_WRITABLE),
 
    RUBY_IO_MODE_BINARY = FMODE_BINMODE,
    RUBY_IO_MODE_TEXT = FMODE_TEXTMODE,
    RUBY_IO_MODE_TEXT_SET_ENCODING_FROM_BOM = FMODE_SETENC_BY_BOM,
 
    RUBY_IO_MODE_SYNCHRONISED = FMODE_SYNC,
 
    RUBY_IO_MODE_TTY = FMODE_TTY,
 
    RUBY_IO_MODE_DUPLEX = FMODE_DUPLEX,
 
    RUBY_IO_MODE_APPEND = FMODE_APPEND,
    RUBY_IO_MODE_CREATE = FMODE_CREATE,
    RUBY_IO_MODE_EXCLUSIVE = FMODE_EXCL,
    RUBY_IO_MODE_TRUNCATE = FMODE_TRUNC,
};
 
typedef enum rb_io_mode rb_io_mode_t;
 
#ifndef HAVE_RB_IO_T
#define HAVE_RB_IO_T 1
struct rb_io {
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    VALUE self;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    FILE *stdio_file;
 
    RBIMPL_ATTR_DEPRECATED(("rb_io_descriptor"))
    int fd;
 
    RBIMPL_ATTR_DEPRECATED(("rb_io_mode"))
    enum rb_io_mode mode;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    rb_pid_t pid;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    int lineno;
 
    RBIMPL_ATTR_DEPRECATED(("rb_io_path"))
    VALUE pathv;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    void (*finalize)(struct rb_io*,int);
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    rb_io_buffer_t wbuf;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    rb_io_buffer_t rbuf;
 
    RBIMPL_ATTR_DEPRECATED(("rb_io_get_write_io"))
    VALUE tied_io_for_writing;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    struct rb_io_encoding encs; 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    rb_econv_t *readconv;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    rb_io_buffer_t cbuf;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    rb_econv_t *writeconv;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    VALUE writeconv_asciicompat;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    int writeconv_initialized;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    int writeconv_pre_ecflags;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    VALUE writeconv_pre_ecopts;
 
    RBIMPL_ATTR_DEPRECATED(("with no replacement"))
    VALUE write_lock;
 
    RBIMPL_ATTR_DEPRECATED(("rb_io_timeout/rb_io_set_timeout"))
    VALUE timeout;
};
#endif
 
typedef struct rb_io rb_io_t;
 
typedef struct rb_io_encoding rb_io_enc_t;
 
VALUE rb_io_open_descriptor(VALUE klass, int descriptor, int mode, VALUE path, VALUE timeout, struct rb_io_encoding *encoding);
 
VALUE rb_io_closed_p(VALUE io);
 
#define RB_IO_POINTER(obj,fp) rb_io_check_closed((fp) = RFILE(rb_io_taint_check(obj))->fptr)
 
#define GetOpenFile RB_IO_POINTER
 
#define RB_IO_OPEN(obj, fp) do {\
    (fp) = rb_io_make_open_file(obj);\
} while (0)
 
#define MakeOpenFile RB_IO_OPEN
 
rb_io_t *rb_io_make_open_file(VALUE obj);
 
FILE *rb_io_stdio_file(rb_io_t *fptr);
 
FILE *rb_fdopen(int fd, const char *modestr);
 
enum rb_io_mode rb_io_modestr_fmode(const char *modestr);
 
int rb_io_modestr_oflags(const char *modestr);
 
RBIMPL_ATTR_CONST()
int rb_io_oflags_fmode(int oflags);
 
void rb_io_check_writable(rb_io_t *fptr);
 
void rb_io_check_readable(rb_io_t *fptr);
 
void rb_io_check_char_readable(rb_io_t *fptr);
 
void rb_io_check_byte_readable(rb_io_t *fptr);
 
int rb_io_fptr_finalize(rb_io_t *fptr);
 
void rb_io_synchronized(rb_io_t *fptr);
 
void rb_io_check_initialized(rb_io_t *fptr);
 
void rb_io_check_closed(rb_io_t *fptr);
 
VALUE rb_io_get_io(VALUE io);
 
VALUE rb_io_check_io(VALUE io);
 
VALUE rb_io_get_write_io(VALUE io);
 
VALUE rb_io_set_write_io(VALUE io, VALUE w);
 
void rb_io_set_nonblock(rb_io_t *fptr);
 
VALUE rb_io_path(VALUE io);
 
int rb_io_descriptor(VALUE io);
 
int rb_io_mode(VALUE io);
 
int rb_io_extract_encoding_option(VALUE opt, rb_encoding **enc_p, rb_encoding **enc2_p, enum rb_io_mode *fmode_p);
 
void rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, int *oflags_p, enum rb_io_mode *fmode_p, rb_io_enc_t *convconfig_p);
 
/* :TODO: can this function be __attribute__((warn_unused_result)) or not? */
ssize_t rb_io_bufwrite(VALUE io, const void *buf, size_t size);
 
//RBIMPL_ATTR_DEPRECATED(("use rb_io_maybe_wait_readable"))
int rb_io_wait_readable(int fd);
 
//RBIMPL_ATTR_DEPRECATED(("use rb_io_maybe_wait_writable"))
int rb_io_wait_writable(int fd);
 
//RBIMPL_ATTR_DEPRECATED(("use rb_io_wait"))
int rb_wait_for_single_fd(int fd, int events, struct timeval *tv);
 
VALUE rb_io_timeout(VALUE io);
 
VALUE rb_io_set_timeout(VALUE io, VALUE timeout);
 
VALUE rb_io_wait(VALUE io, VALUE events, VALUE timeout);
 
VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout);
 
int rb_io_maybe_wait_readable(int error, VALUE io, VALUE timeout);
 
int rb_io_maybe_wait_writable(int error, VALUE io, VALUE timeout);
 
/* compatibility for ruby 1.8 and older */
#define rb_io_mode_flags(modestr) [<"rb_io_mode_flags() is obsolete; use rb_io_modestr_fmode()">]
#define rb_io_modenum_flags(oflags) [<"rb_io_modenum_flags() is obsolete; use rb_io_oflags_fmode()">]
VALUE rb_io_taint_check(VALUE obj);
 
RBIMPL_ATTR_NORETURN()
void rb_eof_error(void);
 
void rb_io_read_check(rb_io_t *fptr);
 
RBIMPL_ATTR_PURE()
int rb_io_read_pending(rb_io_t *fptr);
 
VALUE rb_stat_new(const struct stat *st);
 
/* gc.c */
 
RBIMPL_SYMBOL_EXPORT_END()
 
#endif /* RUBY_IO_H */