include/ruby/io.h File Reference

do {\
    if (RFILE(obj)->fptr) {\
        rb_io_close(obj);\
        rb_io_fptr_finalize(RFILE(obj)->fptr);\
        RFILE(obj)->fptr = 0;\
    }\
    (fp) = 0;\
    RB_IO_FPTR_NEW(fp);\
    RFILE(obj)->fptr = (fp);\
} while (0)

Definition at line 127 of file io.h.

Referenced by pipe_open(), prep_io(), pty_getpty(), pty_open(), rb_file_open_generic(), rb_io_init_copy(), rb_io_initialize(), and rsock_init_sock().

#define RB_IO_BUFFER_INIT ( buf )

Value:

do {\
    (buf).ptr = NULL;\
    (buf).off = 0;\
    (buf).len = 0;\
    (buf).capa = 0;\
} while (0)

Definition at line 120 of file io.h.

#define RB_IO_FPTR_NEW ( fp )

Value:

do {\
    (fp) = ALLOC(rb_io_t);\
    (fp)->fd = -1;\
    (fp)->stdio_file = NULL;\
    (fp)->mode = 0;\
    (fp)->pid = 0;\
    (fp)->lineno = 0;\
    (fp)->pathv = Qnil;\
    (fp)->finalize = 0;\
    RB_IO_BUFFER_INIT((fp)->wbuf);\
    RB_IO_BUFFER_INIT((fp)->rbuf);\
    RB_IO_BUFFER_INIT((fp)->cbuf);\
    (fp)->readconv = NULL;\
    (fp)->writeconv = NULL;\
    (fp)->writeconv_asciicompat = Qnil;\
    (fp)->writeconv_pre_ecflags = 0;\
    (fp)->writeconv_pre_ecopts = Qnil;\
    (fp)->writeconv_initialized = 0;\
    (fp)->tied_io_for_writing = 0;\
    (fp)->encs.enc = NULL;\
    (fp)->encs.enc2 = NULL;\
    (fp)->encs.ecflags = 0;\
    (fp)->encs.ecopts = Qnil;\
    (fp)->write_lock = 0;\
} while (0)

Definition at line 138 of file io.h.

#define rb_io_mode_flags ( modestr ) rb_io_modestr_fmode(modestr)

Definition at line 190 of file io.h.

Referenced by pty_getpty(), and strio_init().

#define rb_io_modenum_flags ( oflags ) rb_io_oflags_fmode(oflags)

Definition at line 191 of file io.h.

Referenced by strio_init().

#define RB_WAITFD_IN 0x001

Definition at line 47 of file io.h.

Referenced by io_wait_readable(), rb_thread_wait_fd_rw(), rb_wait_for_single_fd(), select_single(), and wait_connectable().

#define RB_WAITFD_OUT 0x004

Definition at line 49 of file io.h.

Referenced by io_wait_writable(), rb_thread_wait_fd_rw(), rb_wait_for_single_fd(), select_single(), and wait_connectable().

#define RB_WAITFD_PRI 0x002

Definition at line 48 of file io.h.

Referenced by rb_wait_for_single_fd(), and select_single().

#define RUBY_IO_H 1

Definition at line 13 of file io.h.

Function Documentation

DEPRECATED ( void rb_read_check(FILE *) )

NORETURN ( void rb_eof_error(void) )

FILE* rb_fdopen	(	int	,
		const char *
	)

Definition at line 5373 of file io.c.

References errno, NULL, rb_gc(), rb_sys_fail(), and rb_warn().

Referenced by rb_io_stdio_file().

ssize_t rb_io_bufwrite	(	VALUE	io,
		const void *	buf,
		size_t	size
	)

Definition at line 1365 of file io.c.

References binwrite_arg::fptr, GetOpenFile, io_binwrite(), and rb_io_check_writable().

void rb_io_check_byte_readable ( rb_io_t * fptr )

Definition at line 785 of file io.c.

References rb_eIOError, rb_io_check_char_readable(), rb_raise(), and READ_CHAR_PENDING.

Referenced by copy_stream_body(), io_getpartial(), io_read(), rb_io_check_readable(), rb_io_each_byte(), rb_io_getbyte(), rb_io_sysread(), and rb_io_ungetbyte().

void rb_io_check_char_readable ( rb_io_t * fptr )

Definition at line 766 of file io.c.

References FMODE_READABLE, GetOpenFile, io_fflush(), rb_io_buffer_t::len, rb_io_t::mode, rb_eIOError, rb_io_check_closed(), rb_raise(), rb_sys_fail(), rb_io_t::tied_io_for_writing, and rb_io_t::wbuf.

Referenced by io_read(), rb_io_check_byte_readable(), rb_io_each_char(), rb_io_each_codepoint(), rb_io_eof(), rb_io_getc(), rb_io_getline_1(), rb_io_lineno(), rb_io_set_lineno(), and rb_io_ungetc().

void rb_io_check_closed ( rb_io_t * )

Definition at line 617 of file io.c.

References rb_io_t::fd, rb_eIOError, rb_io_check_initialized(), and rb_raise().

Referenced by bsock_getsockopt(), bsock_setsockopt(), io_binwrite(), io_bufread(), io_fflush(), io_unread(), io_wait_readable(), io_wait_writable(), rb_file_flock(), rb_io_autoclose_p(), rb_io_check_char_readable(), rb_io_check_writable(), rb_io_close_m(), rb_io_fileno(), rb_io_sysread(), rsock_s_recvfrom(), and rsock_s_recvfrom_nonblock().

void rb_io_check_initialized ( rb_io_t * )

Definition at line 609 of file io.c.

References rb_eIOError, and rb_raise().

Referenced by rb_file_path(), rb_io_check_closed(), rb_io_closed(), rb_io_get_write_io(), rb_io_set_write_io(), rb_io_synchronized(), and readline_readline().

VALUE rb_io_check_io ( VALUE io )

Definition at line 633 of file io.c.

References rb_check_convert_type(), and T_FILE.

Referenced by argf_external_encoding(), argf_internal_encoding(), check_exec_redirect(), dump_output(), io_write(), rb_io_reopen(), and rb_io_s_try_convert().

void rb_io_check_readable ( rb_io_t * )

Definition at line 794 of file io.c.

References rb_io_check_byte_readable().

Referenced by io_nread(), io_ready_p(), io_wait_readable(), ossl_obj2bio(), ossl_ssl_setup(), and rb_io_bufread().

void rb_io_check_writable ( rb_io_t * )

Definition at line 818 of file io.c.

References FMODE_WRITABLE, io_unread(), rb_io_buffer_t::len, rb_io_t::mode, rb_eIOError, rb_io_check_closed(), rb_raise(), and rb_io_t::rbuf.

Referenced by copy_stream_body(), io_wait_writable(), io_write(), io_write_nonblock(), ossl_ssl_setup(), rb_io_bufwrite(), and rb_io_syswrite().

int rb_io_extract_encoding_option	(	VALUE	opt,
		rb_encoding **	enc_p,
		rb_encoding **	enc2_p,
		int *	fmode_p
	)

Definition at line 5076 of file io.c.

References NIL_P, NULL, parse_mode_enc(), Qnil, Qundef, rb_check_string_type(), rb_enc_from_index(), rb_enc_name, rb_hash_lookup2(), rb_io_ext_int_to_encs(), rb_to_encoding(), rb_to_encoding_index(), rb_warn(), ruby_verbose, StringValueCStr, sym_encoding, sym_extenc, sym_intenc, and VALUE.

Referenced by rb_gzfile_ecopts(), and rb_io_extract_modeenc().

int rb_io_fptr_finalize ( rb_io_t * )

Definition at line 4257 of file io.c.

References clear_codeconv(), rb_io_t::fd, finish_writeconv_arg::fptr, free, rb_io_t::pathv, rb_io_buffer_t::ptr, Qnil, rb_io_fptr_cleanup(), rb_io_t::rbuf, TRUE, rb_io_t::wbuf, and rb_io_t::write_lock.

Referenced by make_io_deferred(), and pipe_atexit().

VALUE rb_io_get_io ( VALUE io )

Definition at line 627 of file io.c.

References rb_convert_type(), and T_FILE.

VALUE rb_io_get_write_io ( VALUE io )

Definition at line 639 of file io.c.

References rb_io_check_initialized(), RFILE, and VALUE.

Referenced by dump_output().

int rb_io_modestr_fmode ( const char * modestr )

Definition at line 4812 of file io.c.

References fmode, FMODE_APPEND, FMODE_BINMODE, FMODE_CREATE, FMODE_READABLE, FMODE_READWRITE, FMODE_SETENC_BY_BOM, FMODE_TEXTMODE, FMODE_TRUNC, FMODE_WRITABLE, io_encname_bom_p(), NULL, rb_eArgError, and rb_raise().

Referenced by rb_file_open_internal(), rb_io_extract_modeenc(), and rb_io_modestr_oflags().

int rb_io_modestr_oflags ( const char * modestr )

Definition at line 4931 of file io.c.

References rb_io_fmode_oflags(), and rb_io_modestr_fmode().

Referenced by check_exec_redirect(), and rb_io_s_sysopen().

int rb_io_oflags_fmode ( int oflags )

Definition at line 4861 of file io.c.

References fmode, FMODE_APPEND, FMODE_BINMODE, FMODE_CREATE, FMODE_READABLE, FMODE_READWRITE, FMODE_TRUNC, FMODE_WRITABLE, and O_BINARY.

Referenced by rb_io_extract_modeenc(), rb_io_fdopen(), and rb_io_initialize().

void rb_io_read_check ( rb_io_t * )

Definition at line 847 of file io.c.

References rb_io_t::fd, rb_thread_wait_fd(), and READ_DATA_PENDING.

int rb_io_read_pending ( rb_io_t * )

Definition at line 830 of file io.c.

References READ_CHAR_PENDING, and READ_DATA_PENDING.

Referenced by io_nread(), io_ready_p(), io_wait_readable(), rsock_s_recvfrom(), and rsock_s_recvfrom_nonblock().

void rb_io_set_nonblock ( rb_io_t * fptr )

Definition at line 2378 of file io.c.

References F_SETFL, fcntl(), rb_io_t::fd, O_NONBLOCK, rb_io_t::pathv, and rb_sys_fail_path.

Referenced by io_getpartial(), io_write_nonblock(), rsock_s_accept_nonblock(), rsock_s_recvfrom_nonblock(), and sock_connect_nonblock().

VALUE rb_io_set_write_io	(	VALUE	io,
		VALUE	w
	)

Definition at line 651 of file io.c.

References GetWriteIO, Qnil, rb_io_check_initialized(), RFILE, RTEST, and VALUE.

Referenced by argf_close(), and argf_next_argv().

FILE* rb_io_stdio_file ( rb_io_t * fptr )

Definition at line 7247 of file io.c.

References rb_io_t::fd, rb_io_t::mode, rb_fdopen(), rb_io_fmode_oflags(), rb_io_oflags_modestr(), and rb_io_t::stdio_file.

Referenced by dump_output(), rb_dlptr_s_to_ptr(), and rb_fiddle_ptr_s_to_ptr().

void rb_io_synchronized ( rb_io_t * )

Definition at line 5638 of file io.c.

References FMODE_SYNC, pipe_list::fptr, rb_io_t::mode, and rb_io_check_initialized().

Referenced by pipe_open(), rb_io_s_pipe(), rb_io_unbuffered(), and rsock_init_sock().

VALUE rb_io_taint_check ( VALUE )

Definition at line 602 of file io.c.

References rb_check_frozen.

Referenced by get_strio(), rb_file_path(), rb_io_reopen(), readline_readline(), strio_reopen(), and strio_set_string().

int rb_io_wait_readable ( int )

Definition at line 1077 of file io.c.

References errno, EWOULDBLOCK, FALSE, rb_eIOError, rb_raise(), rb_thread_check_ints(), rb_thread_wait_fd(), and TRUE.

Referenced by io_bufread(), io_fillbuf(), io_getpartial(), ossl_ssl_read_internal(), ossl_ssl_write_internal(), ossl_start_ssl(), rsock_s_accept(), and rsock_s_recvfrom().

int rb_io_wait_writable ( int )

Definition at line 1103 of file io.c.

References errno, EWOULDBLOCK, FALSE, rb_eIOError, rb_raise(), rb_thread_check_ints(), rb_thread_fd_writable(), and TRUE.

Referenced by finish_writeconv(), io_binwrite(), io_fflush(), ossl_ssl_read_internal(), ossl_ssl_write_internal(), ossl_start_ssl(), rsock_bsock_send(), and udp_send().

VALUE rb_stat_new ( const struct stat * )

Definition at line 381 of file file.c.

References stat_new_0().

Referenced by rb_file_lstat(), rb_file_s_lstat(), rb_file_s_stat(), and rb_io_stat().

int rb_wait_for_single_fd	(	int	fd,
		int	events,
		struct timeval *	tv
	)

Definition at line 3775 of file thread.c.

References args, errno, init_set_fd(), NULL, rb_ensure(), RB_WAITFD_IN, RB_WAITFD_OUT, RB_WAITFD_PRI, select_single(), select_single_cleanup(), select_args::tv, and VALUE.

Referenced by io_wait_readable(), io_wait_writable(), rb_thread_wait_fd_rw(), and wait_connectable().

Generated on 19 Jul 2016 for Ruby by

1.4.7


Data Structures
struct	rb_io_buffer_t
struct	rb_io_t
struct	rb_io_t::rb_io_enc_t
Defines
#define	RUBY_IO_H 1
#define	RB_WAITFD_IN 0x001
#define	RB_WAITFD_PRI 0x002
#define	RB_WAITFD_OUT 0x004
#define	HAVE_RB_IO_T 1
#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_WSPLIT 0x00000200
#define	FMODE_WSPLIT_INITIALIZED 0x00000400
#define	FMODE_TRUNC 0x00000800
#define	FMODE_TEXTMODE 0x00001000
#define	FMODE_SETENC_BY_BOM 0x00100000
#define	GetOpenFile(obj, fp) rb_io_check_closed((fp) = RFILE(rb_io_taint_check(obj))->fptr)
#define	RB_IO_BUFFER_INIT(buf)
#define	MakeOpenFile(obj, fp)
#define	RB_IO_FPTR_NEW(fp)
#define	rb_io_mode_flags(modestr) rb_io_modestr_fmode(modestr)
#define	rb_io_modenum_flags(oflags) rb_io_oflags_fmode(oflags)
Functions
FILE *	rb_io_stdio_file (rb_io_t *fptr)
FILE *	rb_fdopen (int, const char *)
int	rb_io_modestr_fmode (const char *modestr)
int	rb_io_modestr_oflags (const char *modestr)
int	rb_io_oflags_fmode (int oflags)
void	rb_io_check_writable (rb_io_t *)
void	rb_io_check_readable (rb_io_t *)
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 *)
void	rb_io_synchronized (rb_io_t *)
void	rb_io_check_initialized (rb_io_t *)
void	rb_io_check_closed (rb_io_t *)
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)
int	rb_io_wait_readable (int)
int	rb_io_wait_writable (int)
int	rb_wait_for_single_fd (int fd, int events, struct timeval *tv)
void	rb_io_set_nonblock (rb_io_t *fptr)
int	rb_io_extract_encoding_option (VALUE opt, rb_encoding enc_p, rb_encoding enc2_p, int *fmode_p)
ssize_t	rb_io_bufwrite (VALUE io, const void *buf, size_t size)
VALUE	rb_io_taint_check (VALUE)
	NORETURN (void rb_eof_error(void))
void	rb_io_read_check (rb_io_t *)
int	rb_io_read_pending (rb_io_t *)
	DEPRECATED (void rb_read_check(FILE *))
VALUE	rb_stat_new (const struct stat *)