Ruby  1.9.3p551(2014-11-13revision48407)
Data Structures | Macros | Typedefs | Functions
io.h File Reference
#include <stdio.h>
#include <errno.h>
#include "ruby/encoding.h"
#include "ruby/config.h"

Go to the source code of this file.

Data Structures

struct  rb_io_buffer_t
 
struct  rb_io_t
 
struct  rb_io_t::rb_io_enc_t
 

Macros

#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)
 

Typedefs

typedef struct rb_io_t rb_io_t
 

Functions

FILErb_io_stdio_file (rb_io_t *fptr)
 
FILErb_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_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 *))
 

Macro Definition Documentation

#define FMODE_APPEND   0x00000040
#define FMODE_BINMODE   0x00000004
#define FMODE_CREATE   0x00000080
#define FMODE_DUPLEX   0x00000020
#define FMODE_READABLE   0x00000001
#define FMODE_READWRITE   (FMODE_READABLE|FMODE_WRITABLE)
#define FMODE_SETENC_BY_BOM   0x00100000

Definition at line 108 of file io.h.

Referenced by parse_mode_enc(), rb_file_open_generic(), rb_io_initialize(), and rb_io_modestr_fmode().

#define FMODE_SYNC   0x00000008
#define FMODE_TEXTMODE   0x00001000
#define FMODE_TRUNC   0x00000800

Definition at line 105 of file io.h.

Referenced by rb_io_fmode_oflags(), rb_io_modestr_fmode(), and rb_io_oflags_fmode().

#define FMODE_TTY   0x00000010

Definition at line 98 of file io.h.

Referenced by io_binwrite(), io_check_tty(), io_fwrite(), pty_open(), and rb_io_getbyte().

#define FMODE_WRITABLE   0x00000002
#define FMODE_WSPLIT   0x00000200

Definition at line 103 of file io.h.

Referenced by wsplit_p().

#define FMODE_WSPLIT_INITIALIZED   0x00000400

Definition at line 104 of file io.h.

Referenced by wsplit_p().

#define GetOpenFile (   obj,
  fp 
)    rb_io_check_closed((fp) = RFILE(rb_io_taint_check(obj))->fptr)

Definition at line 110 of file io.h.

Referenced by argf_next_argv(), argf_set_encoding(), bsock_close_read(), bsock_close_write(), bsock_do_not_reverse_lookup(), bsock_do_not_reverse_lookup_set(), bsock_getpeername(), bsock_getsockname(), bsock_getsockopt(), bsock_local_address(), bsock_remote_address(), bsock_s_for_fd(), bsock_setsockopt(), bsock_shutdown(), check_exec_redirect_fd(), console_dev(), console_echo_p(), console_iflush(), console_ioflush(), console_oflush(), console_set_cooked(), console_set_echo(), console_set_raw(), copy_stream_body(), get_write_fd(), io_getpartial(), io_nread(), io_read(), io_ready_p(), io_reopen(), io_set_encoding_by_bom(), io_wait(), io_write(), ip_addr(), ip_peeraddr(), ossl_obj2bio(), ossl_ssl_read_internal(), ossl_ssl_setup(), ossl_ssl_write_internal(), ossl_start_ssl(), prep_stdio(), prepare_getline_args(), rb_dlptr_s_to_ptr(), rb_f_backquote(), rb_file_atime(), rb_file_chmod(), rb_file_chown(), rb_file_ctime(), rb_file_flock(), rb_file_lstat(), rb_file_mtime(), rb_file_size(), rb_io_advise(), rb_io_ascii8bit_binmode(), rb_io_autoclose_p(), rb_io_binmode(), rb_io_binmode_p(), rb_io_bufread(), rb_io_bufwrite(), rb_io_check_char_readable(), rb_io_close_read(), rb_io_close_write(), rb_io_each_byte(), rb_io_each_char(), rb_io_each_codepoint(), rb_io_eof(), rb_io_external_encoding(), rb_io_fileno(), rb_io_flush(), rb_io_getbyte(), rb_io_getc(), rb_io_getline_1(), rb_io_init_copy(), rb_io_internal_encoding(), rb_io_isatty(), rb_io_lineno(), rb_io_pid(), rb_io_rewind(), rb_io_s_pipe(), rb_io_seek(), rb_io_set_autoclose(), rb_io_set_encoding(), rb_io_set_lineno(), rb_io_set_pos(), rb_io_set_sync(), rb_io_stat(), rb_io_sync(), rb_io_sysread(), rb_io_sysseek(), rb_io_syswrite(), rb_io_tell(), rb_io_ungetbyte(), rb_io_ungetc(), rb_io_write_nonblock(), rb_ioctl(), rb_stat(), readline_s_set_input(), readline_s_set_output(), rsock_bsock_send(), rsock_io_socket_addrinfo(), rsock_s_recvfrom(), rsock_s_recvfrom_nonblock(), rsock_sock_listen(), select_internal(), sock_accept(), sock_accept_nonblock(), sock_bind(), sock_connect(), sock_connect_nonblock(), sock_sysaccept(), tcp_accept(), tcp_accept_nonblock(), tcp_sysaccept(), ttymode(), udp_bind(), udp_connect(), and udp_send().

#define HAVE_RB_IO_T   1

Definition at line 91 of file io.h.

#define MakeOpenFile (   obj,
  fp 
)
Value:
do {\
if (RFILE(obj)->fptr) {\
RFILE(obj)->fptr = 0;\
}\
(fp) = 0;\
RFILE(obj)->fptr = (fp);\
} while (0)
if(len<=MAX_WORD_LENGTH &&len >=MIN_WORD_LENGTH)
Definition: name2ctype.h:23841
int rb_io_fptr_finalize(rb_io_t *)
Definition: io.c:3876
#define RFILE(obj)
Definition: ruby.h:917
static VALUE VALUE obj
Definition: tcltklib.c:3147
#define RB_IO_FPTR_NEW(fp)
Definition: io.h:130
VALUE rb_io_close(VALUE)
Definition: io.c:3911

Definition at line 119 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)
n NULL
Definition: yaml2byte.c:134
unsigned char buf[MIME_BUF_SIZE]
Definition: nkf.c:3913
register unsigned int len
Definition: name2ctype.h:22210
return ptr
Definition: tcltklib.c:780

Definition at line 112 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);\
(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: io.h:53
gz lineno
Definition: zlib.c:2031
#define Qnil
Definition: ruby.h:367
n NULL
Definition: yaml2byte.c:134
#define ALLOC(type)
Definition: ruby.h:1035
VALUE mode
Definition: tcltklib.c:1655
#define RB_IO_BUFFER_INIT(buf)
Definition: io.h:112
gz cbuf
Definition: zlib.c:2039

Definition at line 130 of file io.h.

#define rb_io_mode_flags (   modestr)    rb_io_modestr_fmode(modestr)

Definition at line 181 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 182 of file io.h.

Referenced by strio_init().

#define RB_WAITFD_IN   0x001
#define RB_WAITFD_OUT   0x004
#define RB_WAITFD_PRI   0x002

Definition at line 38 of file io.h.

Referenced by Init_wait_for_single_fd(), rb_wait_for_single_fd(), and select_single().

Typedef Documentation

typedef struct rb_io_t rb_io_t

Function Documentation

DEPRECATED ( void   rb_read_checkFILE *)
NORETURN ( void   rb_eof_errorvoid)
FILE* rb_fdopen ( int  ,
const char *   
)

Definition at line 4964 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 1163 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)
void rb_io_check_char_readable ( rb_io_t fptr)
void rb_io_check_closed ( rb_io_t )
void rb_io_check_initialized ( rb_io_t )
void rb_io_check_readable ( rb_io_t )

Definition at line 657 of file io.c.

References rb_io_check_byte_readable().

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

void rb_io_check_writable ( rb_io_t )
int rb_io_extract_encoding_option ( VALUE  opt,
rb_encoding **  enc_p,
rb_encoding **  enc2_p,
int fmode_p 
)
int rb_io_fptr_finalize ( rb_io_t )
VALUE rb_io_get_io ( VALUE  io)

Definition at line 488 of file io.c.

References rb_convert_type(), and T_FILE.

VALUE rb_io_get_write_io ( VALUE  io)

Definition at line 500 of file io.c.

References io, rb_io_check_initialized(), and RFILE.

int rb_io_modestr_fmode ( const char *  modestr)
int rb_io_modestr_oflags ( const char *  modestr)

Definition at line 4531 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)
void rb_io_read_check ( rb_io_t )

Definition at line 710 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 693 of file io.c.

References READ_CHAR_PENDING, and READ_DATA_PENDING.

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

void rb_io_set_nonblock ( rb_io_t fptr)
VALUE rb_io_set_write_io ( VALUE  io,
VALUE  w 
)

Definition at line 512 of file io.c.

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

Referenced by argf_close(), and argf_next_argv().

FILE* rb_io_stdio_file ( rb_io_t fptr)
void rb_io_synchronized ( rb_io_t )

Definition at line 5226 of file io.c.

References FMODE_SYNC, 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  )
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 
)