diff options
Diffstat (limited to 'io.c')
| -rw-r--r-- | io.c | 10277 |
1 files changed, 6082 insertions, 4195 deletions
@@ -14,11 +14,7 @@ #include "ruby/internal/config.h" #include "ruby/fiber/scheduler.h" - -#ifdef _WIN32 -# include "ruby/ruby.h" -# include "ruby/io.h" -#endif +#include "ruby/io/buffer.h" #include <ctype.h> #include <errno.h> @@ -74,10 +70,6 @@ #include <sys/fcntl.h> #endif -#if !HAVE_OFF_T && !defined(off_t) -# define off_t long -#endif - #ifdef HAVE_SYS_TIME_H # include <sys/time.h> #endif @@ -120,6 +112,7 @@ #include "encindex.h" #include "id.h" #include "internal.h" +#include "internal/class.h" #include "internal/encoding.h" #include "internal/error.h" #include "internal/inits.h" @@ -131,6 +124,8 @@ #include "internal/transcode.h" #include "internal/variable.h" #include "ruby/io.h" +#include "ruby/io/buffer.h" +#include "ruby/missing.h" #include "ruby/thread.h" #include "ruby/util.h" #include "ruby_atomic.h" @@ -146,10 +141,6 @@ #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR) #endif -#if SIZEOF_OFF_T > SIZEOF_LONG && !defined(HAVE_LONG_LONG) -# error off_t is bigger than long, but you have no long long... -#endif - #ifndef PIPE_BUF # ifdef _POSIX_PIPE_BUF # define PIPE_BUF _POSIX_PIPE_BUF @@ -172,17 +163,21 @@ off_t __syscall(quad_t number, ...); #define IO_RBUF_CAPA_FOR(fptr) (NEED_READCONV(fptr) ? IO_CBUF_CAPA_MIN : IO_RBUF_CAPA_MIN) #define IO_WBUF_CAPA_MIN 8192 +#define IO_MAX_BUFFER_GROWTH 8 * 1024 * 1024 // 8MB + /* define system APIs */ #ifdef _WIN32 #undef open #define open rb_w32_uopen #undef rename #define rename(f, t) rb_w32_urename((f), (t)) +#include "win32/file.h" #endif VALUE rb_cIO; VALUE rb_eEOFError; VALUE rb_eIOError; +VALUE rb_eIOTimeoutError; VALUE rb_mWaitReadable; VALUE rb_mWaitWritable; @@ -203,7 +198,7 @@ VALUE rb_default_rs; static VALUE argf; -static ID id_write, id_read, id_getc, id_flush, id_readpartial, id_set_encoding; +static ID id_write, id_read, id_getc, id_flush, id_readpartial, id_set_encoding, id_fileno; static VALUE sym_mode, sym_perm, sym_flags, sym_extenc, sym_intenc, sym_encoding, sym_open_args; static VALUE sym_textmode, sym_binmode, sym_autoclose; static VALUE sym_SET, sym_CUR, sym_END; @@ -223,7 +218,7 @@ struct argf { long lineno; VALUE argv; VALUE inplace; - struct rb_io_enc_t encs; + struct rb_io_encoding encs; int8_t init_p, next_p, binmode; }; @@ -251,7 +246,7 @@ rb_update_max_fd(int fd) } while (max_fd < afd) { - max_fd = ATOMIC_CAS(max_file_descriptor, max_fd, afd); + max_fd = ATOMIC_CAS(max_file_descriptor, max_fd, afd); } } @@ -296,12 +291,18 @@ rb_fix_detect_o_cloexec(int fd) rb_bug("rb_fix_detect_o_cloexec: fcntl(%d, F_GETFD) failed: %s", fd, strerror(errno)); if (flags & FD_CLOEXEC) - return 1; + return 1; #endif /* fall through if O_CLOEXEC does not work: */ rb_maygvl_fd_fix_cloexec(fd); return 0; } +static inline bool +io_again_p(int e) +{ + return (e == EWOULDBLOCK) || (e == EAGAIN); +} + int rb_cloexec_open(const char *pathname, int flags, mode_t mode) { @@ -322,7 +323,7 @@ rb_cloexec_open(const char *pathname, int flags, mode_t mode) while ((ret = open(pathname, flags, mode)) == -1) { int e = errno; - if (e != EAGAIN && e != EWOULDBLOCK) break; + if (!io_again_p(e)) break; if (retry_count++ >= retry_max_count) break; sleep(retry_interval); @@ -330,13 +331,13 @@ rb_cloexec_open(const char *pathname, int flags, mode_t mode) if (ret < 0) return ret; if (ret <= 2 || o_cloexec_state == 0) { - rb_maygvl_fd_fix_cloexec(ret); + rb_maygvl_fd_fix_cloexec(ret); } else if (o_cloexec_state > 0) { - return ret; + return ret; } else { - o_cloexec_state = rb_fix_detect_o_cloexec(ret); + o_cloexec_state = rb_fix_detect_o_cloexec(ret); } return ret; } @@ -492,15 +493,15 @@ rb_cloexec_fcntl_dupfd(int fd, int minfd) #if defined(_WIN32) #define WAIT_FD_IN_WIN32(fptr) \ - (rb_w32_io_cancelable_p((fptr)->fd) ? 0 : RB_NUM2INT(rb_io_wait(fptr->self, RB_INT2NUM(RUBY_IO_READABLE), Qnil))) + (rb_w32_io_cancelable_p((fptr)->fd) ? Qnil : rb_io_wait(fptr->self, RB_INT2NUM(RUBY_IO_READABLE), RUBY_IO_TIMEOUT_DEFAULT)) #else #define WAIT_FD_IN_WIN32(fptr) #endif #define READ_CHECK(fptr) do {\ if (!READ_DATA_PENDING(fptr)) {\ - WAIT_FD_IN_WIN32(fptr);\ - rb_io_check_closed(fptr);\ + WAIT_FD_IN_WIN32(fptr);\ + rb_io_check_closed(fptr);\ }\ } while(0) @@ -521,7 +522,6 @@ rb_cloexec_fcntl_dupfd(int fd, int minfd) static int io_fflush(rb_io_t *); static rb_io_t *flush_before_seek(rb_io_t *fptr); -#define FMODE_PREP (1<<16) #define FMODE_SIGNAL_ON_EPIPE (1<<17) #define fptr_signal_on_epipe(fptr) \ @@ -534,10 +534,12 @@ static rb_io_t *flush_before_seek(rb_io_t *fptr); extern ID ruby_static_id_signo; -NORETURN(static void raise_on_write(rb_io_t *fptr, int e, VALUE errinfo)); +NORETURN(static void rb_sys_fail_on_write(rb_io_t *fptr)); static void -raise_on_write(rb_io_t *fptr, int e, VALUE errinfo) +rb_sys_fail_on_write(rb_io_t *fptr) { + int e = errno; + VALUE errinfo = rb_syserr_new_path(e, (fptr)->pathv); #if defined EPIPE if (fptr_signal_on_epipe(fptr) && (e == EPIPE)) { const VALUE sig = @@ -551,12 +553,6 @@ raise_on_write(rb_io_t *fptr, int e, VALUE errinfo) rb_exc_raise(errinfo); } -#define rb_sys_fail_on_write(fptr) \ - do { \ - int e = errno; \ - raise_on_write(fptr, e, rb_syserr_new_path(e, (fptr)->pathv)); \ - } while (0) - #define NEED_NEWLINE_DECORATOR_ON_READ(fptr) ((fptr)->mode & FMODE_TEXTMODE) #define NEED_NEWLINE_DECORATOR_ON_WRITE(fptr) ((fptr)->mode & FMODE_TEXTMODE) #if defined(RUBY_TEST_CRLF_ENVIRONMENT) || defined(_WIN32) @@ -589,19 +585,19 @@ raise_on_write(rb_io_t *fptr, int e, VALUE errinfo) #define NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr) do {\ if (NEED_NEWLINE_DECORATOR_ON_READ(fptr)) {\ - if (((fptr)->mode & FMODE_READABLE) &&\ - !((fptr)->encs.ecflags & ECONV_NEWLINE_DECORATOR_MASK)) {\ - setmode((fptr)->fd, O_BINARY);\ - }\ - else {\ - setmode((fptr)->fd, O_TEXT);\ - }\ + if (((fptr)->mode & FMODE_READABLE) &&\ + !((fptr)->encs.ecflags & ECONV_NEWLINE_DECORATOR_MASK)) {\ + setmode((fptr)->fd, O_BINARY);\ + }\ + else {\ + setmode((fptr)->fd, O_TEXT);\ + }\ }\ } while(0) #define SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags) do {\ if ((enc2) && ((ecflags) & ECONV_DEFAULT_NEWLINE_DECORATOR)) {\ - (ecflags) |= ECONV_UNIVERSAL_NEWLINE_DECORATOR;\ + (ecflags) |= ECONV_UNIVERSAL_NEWLINE_DECORATOR;\ }\ } while(0) @@ -611,7 +607,7 @@ raise_on_write(rb_io_t *fptr, int e, VALUE errinfo) static void io_unread(rb_io_t *fptr) { - off_t r, pos; + rb_off_t r, pos; ssize_t read_size; long i; long newlines = 0; @@ -621,28 +617,28 @@ io_unread(rb_io_t *fptr) rb_io_check_closed(fptr); if (fptr->rbuf.len == 0 || fptr->mode & FMODE_DUPLEX) { - return; + return; } errno = 0; if (!rb_w32_fd_is_text(fptr->fd)) { - r = lseek(fptr->fd, -fptr->rbuf.len, SEEK_CUR); - if (r < 0 && errno) { - if (errno == ESPIPE) - fptr->mode |= FMODE_DUPLEX; - return; - } + r = lseek(fptr->fd, -fptr->rbuf.len, SEEK_CUR); + if (r < 0 && errno) { + if (errno == ESPIPE) + fptr->mode |= FMODE_DUPLEX; + return; + } - fptr->rbuf.off = 0; - fptr->rbuf.len = 0; - return; + fptr->rbuf.off = 0; + fptr->rbuf.len = 0; + return; } pos = lseek(fptr->fd, 0, SEEK_CUR); if (pos < 0 && errno) { - if (errno == ESPIPE) - fptr->mode |= FMODE_DUPLEX; - return; + if (errno == ESPIPE) + fptr->mode |= FMODE_DUPLEX; + return; } /* add extra offset for removed '\r' in rbuf */ @@ -651,36 +647,36 @@ io_unread(rb_io_t *fptr) /* if the end of rbuf is '\r', rbuf doesn't have '\r' within rbuf.len */ if (*(fptr->rbuf.ptr + fptr->rbuf.capa - 1) == '\r') { - newlines++; + newlines++; } for (i = 0; i < fptr->rbuf.len; i++) { - if (*p == '\n') newlines++; - if (extra_max == newlines) break; - p++; + if (*p == '\n') newlines++; + if (extra_max == newlines) break; + p++; } buf = ALLOC_N(char, fptr->rbuf.len + newlines); while (newlines >= 0) { - r = lseek(fptr->fd, pos - fptr->rbuf.len - newlines, SEEK_SET); - if (newlines == 0) break; - if (r < 0) { - newlines--; - continue; - } - read_size = _read(fptr->fd, buf, fptr->rbuf.len + newlines); - if (read_size < 0) { - int e = errno; - free(buf); - rb_syserr_fail_path(e, fptr->pathv); - } - if (read_size == fptr->rbuf.len) { - lseek(fptr->fd, r, SEEK_SET); - break; - } - else { - newlines--; - } + r = lseek(fptr->fd, pos - fptr->rbuf.len - newlines, SEEK_SET); + if (newlines == 0) break; + if (r < 0) { + newlines--; + continue; + } + read_size = _read(fptr->fd, buf, fptr->rbuf.len + newlines); + if (read_size < 0) { + int e = errno; + free(buf); + rb_syserr_fail_path(e, fptr->pathv); + } + if (read_size == fptr->rbuf.len) { + lseek(fptr->fd, r, SEEK_SET); + break; + } + else { + newlines--; + } } free(buf); fptr->rbuf.off = 0; @@ -701,7 +697,7 @@ set_binary_mode_with_seek_cur(rb_io_t *fptr) if (!rb_w32_fd_is_text(fptr->fd)) return O_BINARY; if (fptr->rbuf.len == 0 || fptr->mode & FMODE_DUPLEX) { - return setmode(fptr->fd, O_BINARY); + return setmode(fptr->fd, O_BINARY); } flush_before_seek(fptr); return setmode(fptr->fd, O_BINARY); @@ -770,7 +766,7 @@ void rb_io_check_initialized(rb_io_t *fptr) { if (!fptr) { - rb_raise(rb_eIOError, "uninitialized stream"); + rb_raise(rb_eIOError, "uninitialized stream"); } } @@ -818,10 +814,10 @@ rb_io_set_write_io(VALUE io, VALUE w) VALUE write_io; rb_io_t *fptr = rb_io_get_fptr(io); if (!RTEST(w)) { - w = 0; + w = 0; } else { - GetWriteIO(w); + GetWriteIO(w); } write_io = fptr->tied_io_for_writing; fptr->tied_io_for_writing = w; @@ -830,19 +826,65 @@ rb_io_set_write_io(VALUE io, VALUE w) /* * call-seq: - * IO.try_convert(obj) -> io or nil + * timeout -> duration or nil * - * Try to convert <i>obj</i> into an IO, using to_io method. - * Returns converted IO or +nil+ if <i>obj</i> cannot be converted - * for any reason. + * Get the internal timeout duration or nil if it was not set. * - * IO.try_convert(STDOUT) #=> STDOUT - * IO.try_convert("STDOUT") #=> nil + */ +VALUE +rb_io_timeout(VALUE self) +{ + rb_io_t *fptr = rb_io_get_fptr(self); + + return fptr->timeout; +} + +/* + * call-seq: + * timeout = duration -> duration + * timeout = nil -> nil + * + * Sets the internal timeout to the specified duration or nil. The timeout + * applies to all blocking operations where possible. + * + * When the operation performs longer than the timeout set, IO::TimeoutError + * is raised. * - * require 'zlib' - * f = open("/tmp/zz.gz") #=> #<File:/tmp/zz.gz> - * z = Zlib::GzipReader.open(f) #=> #<Zlib::GzipReader:0x81d8744> - * IO.try_convert(z) #=> #<File:/tmp/zz.gz> + * This affects the following methods (but is not limited to): #gets, #puts, + * #read, #write, #wait_readable and #wait_writable. This also affects + * blocking socket operations like Socket#accept and Socket#connect. + * + * Some operations like File#open and IO#close are not affected by the + * timeout. A timeout during a write operation may leave the IO in an + * inconsistent state, e.g. data was partially written. Generally speaking, a + * timeout is a last ditch effort to prevent an application from hanging on + * slow I/O operations, such as those that occur during a slowloris attack. + */ +VALUE +rb_io_set_timeout(VALUE self, VALUE timeout) +{ + // Validate it: + if (RTEST(timeout)) { + rb_time_interval(timeout); + } + + rb_io_t *fptr = rb_io_get_fptr(self); + + fptr->timeout = timeout; + + return self; +} + +/* + * call-seq: + * IO.try_convert(object) -> new_io or nil + * + * Attempts to convert +object+ into an \IO object via method +to_io+; + * returns the new \IO object if successful, or +nil+ otherwise: + * + * IO.try_convert(STDOUT) # => #<IO:<STDOUT>> + * IO.try_convert(ARGF) # => #<IO:<STDIN>> + * IO.try_convert('STDOUT') # => nil * */ static VALUE @@ -855,7 +897,7 @@ rb_io_s_try_convert(VALUE dummy, VALUE io) static void io_unread(rb_io_t *fptr) { - off_t r; + rb_off_t r; rb_io_check_closed(fptr); if (fptr->rbuf.len == 0 || fptr->mode & FMODE_DUPLEX) return; @@ -885,17 +927,17 @@ io_ungetbyte(VALUE str, rb_io_t *fptr) fptr->rbuf.off = 0; fptr->rbuf.len = 0; #if SIZEOF_LONG > SIZEOF_INT - if (len > INT_MAX) - rb_raise(rb_eIOError, "ungetbyte failed"); + if (len > INT_MAX) + rb_raise(rb_eIOError, "ungetbyte failed"); #endif - if (len > min_capa) - fptr->rbuf.capa = (int)len; - else - fptr->rbuf.capa = min_capa; + if (len > min_capa) + fptr->rbuf.capa = (int)len; + else + fptr->rbuf.capa = min_capa; fptr->rbuf.ptr = ALLOC_N(char, fptr->rbuf.capa); } if (fptr->rbuf.capa < len + fptr->rbuf.len) { - rb_raise(rb_eIOError, "ungetbyte failed"); + rb_raise(rb_eIOError, "ungetbyte failed"); } if (fptr->rbuf.off < len) { MEMMOVE(fptr->rbuf.ptr+fptr->rbuf.capa-fptr->rbuf.len, @@ -932,15 +974,15 @@ rb_io_check_char_readable(rb_io_t *fptr) { rb_io_check_closed(fptr); if (!(fptr->mode & FMODE_READABLE)) { - rb_raise(rb_eIOError, "not opened for reading"); + rb_raise(rb_eIOError, "not opened for reading"); } if (fptr->wbuf.len) { if (io_fflush(fptr) < 0) rb_sys_fail_on_write(fptr); } if (fptr->tied_io_for_writing) { - rb_io_t *wfptr; - GetOpenFile(fptr->tied_io_for_writing, wfptr); + rb_io_t *wfptr; + GetOpenFile(fptr->tied_io_for_writing, wfptr); if (io_fflush(wfptr) < 0) rb_sys_fail_on_write(wfptr); } @@ -951,7 +993,7 @@ rb_io_check_byte_readable(rb_io_t *fptr) { rb_io_check_char_readable(fptr); if (READ_CHAR_PENDING(fptr)) { - rb_raise(rb_eIOError, "byte oriented read for character buffered IO"); + rb_raise(rb_eIOError, "byte oriented read for character buffered IO"); } } @@ -965,7 +1007,7 @@ static rb_encoding* io_read_encoding(rb_io_t *fptr) { if (fptr->encs.enc) { - return fptr->encs.enc; + return fptr->encs.enc; } return rb_default_external_encoding(); } @@ -974,7 +1016,7 @@ static rb_encoding* io_input_encoding(rb_io_t *fptr) { if (fptr->encs.enc2) { - return fptr->encs.enc2; + return fptr->encs.enc2; } return io_read_encoding(fptr); } @@ -984,7 +1026,7 @@ rb_io_check_writable(rb_io_t *fptr) { rb_io_check_closed(fptr); if (!(fptr->mode & FMODE_WRITABLE)) { - rb_raise(rb_eIOError, "not opened for writing"); + rb_raise(rb_eIOError, "not opened for writing"); } if (fptr->rbuf.len) { io_unread(fptr); @@ -1004,7 +1046,7 @@ void rb_io_read_check(rb_io_t *fptr) { if (!READ_DATA_PENDING(fptr)) { - rb_io_wait(fptr->self, RB_INT2NUM(RUBY_IO_READABLE), Qnil); + rb_io_wait(fptr->self, RB_INT2NUM(RUBY_IO_READABLE), RUBY_IO_TIMEOUT_DEFAULT); } return; } @@ -1013,26 +1055,30 @@ int rb_gc_for_fd(int err) { if (err == EMFILE || err == ENFILE || err == ENOMEM) { - rb_gc(); - return 1; + rb_gc(); + return 1; } return 0; } +/* try `expr` upto twice while it returns false and `errno` + * is to GC. Each `errno`s are available as `first_errno` and + * `retried_errno` respectively */ +#define TRY_WITH_GC(expr) \ + for (int first_errno, retried_errno = 0, retried = 0; \ + (!retried && \ + !(expr) && \ + (!rb_gc_for_fd(first_errno = errno) || !(expr)) && \ + (retried_errno = errno, 1)); \ + (void)retried_errno, retried = 1) + static int ruby_dup(int orig) { - int fd; + int fd = -1; - fd = rb_cloexec_dup(orig); - if (fd < 0) { - int e = errno; - if (rb_gc_for_fd(e)) { - fd = rb_cloexec_dup(orig); - } - if (fd < 0) { - rb_syserr_fail(e, 0); - } + TRY_WITH_GC((fd = rb_cloexec_dup(orig)) >= 0) { + rb_syserr_fail(first_errno, 0); } rb_update_max_fd(fd); return fd; @@ -1041,7 +1087,7 @@ ruby_dup(int orig) static VALUE io_alloc(VALUE klass) { - NEWOBJ_OF(io, struct RFile, klass, T_FILE); + NEWOBJ_OF(io, struct RFile, klass, T_FILE, sizeof(struct RFile), 0); io->fptr = 0; @@ -1054,64 +1100,131 @@ io_alloc(VALUE klass) struct io_internal_read_struct { VALUE th; - int fd; + rb_io_t *fptr; int nonblock; + int fd; + void *buf; size_t capa; + struct timeval *timeout; }; struct io_internal_write_struct { + VALUE th; + rb_io_t *fptr; + int nonblock; int fd; + const void *buf; size_t capa; + struct timeval *timeout; }; #ifdef HAVE_WRITEV struct io_internal_writev_struct { + VALUE th; + rb_io_t *fptr; + int nonblock; int fd; + int iovcnt; const struct iovec *iov; + struct timeval *timeout; }; #endif -static int nogvl_wait_for_single_fd(VALUE th, int fd, short events); +static int nogvl_wait_for(VALUE th, rb_io_t *fptr, short events, struct timeval *timeout); + +/** + * Wait for the given events on the given file descriptor. + * Returns -1 if an error or timeout occurred. +errno+ will be set. + * Returns the event mask if an event occurred. + */ +static inline int +io_internal_wait(VALUE thread, rb_io_t *fptr, int error, int events, struct timeval *timeout) +{ + if (!timeout && rb_thread_mn_schedulable(thread)) { + RUBY_ASSERT(errno == EWOULDBLOCK || errno == EAGAIN); + return -1; + } + + int ready = nogvl_wait_for(thread, fptr, events, timeout); + + if (ready > 0) { + return ready; + } + else if (ready == 0) { + errno = ETIMEDOUT; + return -1; + } + + errno = error; + return -1; +} + static VALUE internal_read_func(void *ptr) { struct io_internal_read_struct *iis = ptr; - ssize_t r; -retry: - r = read(iis->fd, iis->buf, iis->capa); - if (r < 0 && !iis->nonblock) { - int e = errno; - if (e == EAGAIN || e == EWOULDBLOCK) { - if (nogvl_wait_for_single_fd(iis->th, iis->fd, RB_WAITFD_IN) != -1) { + ssize_t result; + + if (iis->timeout && !iis->nonblock) { + if (io_internal_wait(iis->th, iis->fptr, 0, RB_WAITFD_IN, iis->timeout) == -1) { + return -1; + } + } + + retry: + result = read(iis->fd, iis->buf, iis->capa); + + if (result < 0 && !iis->nonblock) { + if (io_again_p(errno)) { + if (io_internal_wait(iis->th, iis->fptr, errno, RB_WAITFD_IN, iis->timeout) == -1) { + return -1; + } + else { goto retry; } - errno = e; } } - return r; + + return result; } #if defined __APPLE__ -# define do_write_retry(code) do {ret = code;} while (ret == -1 && errno == EPROTOTYPE) +# define do_write_retry(code) do {result = code;} while (result == -1 && errno == EPROTOTYPE) #else -# define do_write_retry(code) ret = code +# define do_write_retry(code) result = code #endif + static VALUE internal_write_func(void *ptr) { struct io_internal_write_struct *iis = ptr; - ssize_t ret; + ssize_t result; + + if (iis->timeout && !iis->nonblock) { + if (io_internal_wait(iis->th, iis->fptr, 0, RB_WAITFD_OUT, iis->timeout) == -1) { + return -1; + } + } + + retry: do_write_retry(write(iis->fd, iis->buf, iis->capa)); - return (VALUE)ret; -} -static void* -internal_write_func2(void *ptr) -{ - return (void*)internal_write_func(ptr); + if (result < 0 && !iis->nonblock) { + int e = errno; + if (io_again_p(e)) { + if (io_internal_wait(iis->th, iis->fptr, errno, RB_WAITFD_OUT, iis->timeout) == -1) { + return -1; + } + else { + goto retry; + } + } + } + + return result; } #ifdef HAVE_WRITEV @@ -1119,62 +1232,133 @@ static VALUE internal_writev_func(void *ptr) { struct io_internal_writev_struct *iis = ptr; - ssize_t ret; + ssize_t result; + + if (iis->timeout && !iis->nonblock) { + if (io_internal_wait(iis->th, iis->fptr, 0, RB_WAITFD_OUT, iis->timeout) == -1) { + return -1; + } + } + + retry: do_write_retry(writev(iis->fd, iis->iov, iis->iovcnt)); - return (VALUE)ret; + + if (result < 0 && !iis->nonblock) { + if (io_again_p(errno)) { + if (io_internal_wait(iis->th, iis->fptr, errno, RB_WAITFD_OUT, iis->timeout) == -1) { + return -1; + } + else { + goto retry; + } + } + } + + return result; } #endif static ssize_t -rb_read_internal(int fd, void *buf, size_t count) +rb_io_read_memory(rb_io_t *fptr, void *buf, size_t count) { + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + VALUE result = rb_fiber_scheduler_io_read_memory(scheduler, fptr->self, buf, count, 0); + + if (!UNDEF_P(result)) { + return rb_fiber_scheduler_io_result_apply(result); + } + } + struct io_internal_read_struct iis = { .th = rb_thread_current(), - .fd = fd, + .fptr = fptr, .nonblock = 0, + .fd = fptr->fd, + .buf = buf, - .capa = count + .capa = count, + .timeout = NULL, }; - return (ssize_t)rb_thread_io_blocking_region(internal_read_func, &iis, fd); -} + struct timeval timeout_storage; -static ssize_t -rb_write_internal(int fd, const void *buf, size_t count) -{ - struct io_internal_write_struct iis = { - .fd = fd, - .buf = buf, - .capa = count - }; + if (fptr->timeout != Qnil) { + timeout_storage = rb_time_interval(fptr->timeout); + iis.timeout = &timeout_storage; + } - return (ssize_t)rb_thread_io_blocking_region(internal_write_func, &iis, fd); + return (ssize_t)rb_thread_io_blocking_call(internal_read_func, &iis, fptr->fd, RB_WAITFD_IN); } static ssize_t -rb_write_internal2(int fd, const void *buf, size_t count) +rb_io_write_memory(rb_io_t *fptr, const void *buf, size_t count) { + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + VALUE result = rb_fiber_scheduler_io_write_memory(scheduler, fptr->self, buf, count, 0); + + if (!UNDEF_P(result)) { + return rb_fiber_scheduler_io_result_apply(result); + } + } + struct io_internal_write_struct iis = { - .fd = fd, + .th = rb_thread_current(), + .fptr = fptr, + .nonblock = 0, + .fd = fptr->fd, + .buf = buf, - .capa = count + .capa = count, + .timeout = NULL }; - return (ssize_t)rb_thread_call_without_gvl2(internal_write_func2, &iis, - RUBY_UBF_IO, NULL); + struct timeval timeout_storage; + + if (fptr->timeout != Qnil) { + timeout_storage = rb_time_interval(fptr->timeout); + iis.timeout = &timeout_storage; + } + + return (ssize_t)rb_thread_io_blocking_call(internal_write_func, &iis, fptr->fd, RB_WAITFD_OUT); } #ifdef HAVE_WRITEV static ssize_t -rb_writev_internal(int fd, const struct iovec *iov, int iovcnt) +rb_writev_internal(rb_io_t *fptr, const struct iovec *iov, int iovcnt) { + if (!iovcnt) return 0; + + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + // This path assumes at least one `iov`: + VALUE result = rb_fiber_scheduler_io_write_memory(scheduler, fptr->self, iov[0].iov_base, iov[0].iov_len, 0); + + if (!UNDEF_P(result)) { + return rb_fiber_scheduler_io_result_apply(result); + } + } + struct io_internal_writev_struct iis = { - .fd = fd, + .th = rb_thread_current(), + .fptr = fptr, + .nonblock = 0, + .fd = fptr->fd, + .iov = iov, .iovcnt = iovcnt, + .timeout = NULL }; - return (ssize_t)rb_thread_io_blocking_region(internal_writev_func, &iis, fd); + struct timeval timeout_storage; + + if (fptr->timeout != Qnil) { + timeout_storage = rb_time_interval(fptr->timeout); + iis.timeout = &timeout_storage; + } + + return (ssize_t)rb_thread_io_blocking_call(internal_writev_func, &iis, fptr->fd, RB_WAITFD_OUT); } #endif @@ -1186,67 +1370,35 @@ io_flush_buffer_sync(void *arg) ssize_t r = write(fptr->fd, fptr->wbuf.ptr+fptr->wbuf.off, (size_t)l); if (fptr->wbuf.len <= r) { - fptr->wbuf.off = 0; - fptr->wbuf.len = 0; - return 0; + fptr->wbuf.off = 0; + fptr->wbuf.len = 0; + return 0; } + if (0 <= r) { - fptr->wbuf.off += (int)r; - fptr->wbuf.len -= (int)r; - errno = EAGAIN; + fptr->wbuf.off += (int)r; + fptr->wbuf.len -= (int)r; + errno = EAGAIN; } - return (VALUE)-1; -} -static void* -io_flush_buffer_sync2(void *arg) -{ - VALUE result = io_flush_buffer_sync(arg); - - /* - * rb_thread_call_without_gvl2 uses 0 as interrupted. - * So, we need to avoid to use 0. - */ - return !result ? (void*)1 : (void*)result; + return (VALUE)-1; } static VALUE io_flush_buffer_async(VALUE arg) { rb_io_t *fptr = (rb_io_t *)arg; - return rb_thread_io_blocking_region(io_flush_buffer_sync, fptr, fptr->fd); -} - -static VALUE -io_flush_buffer_async2(VALUE arg) -{ - rb_io_t *fptr = (rb_io_t *)arg; - VALUE ret; - - ret = (VALUE)rb_thread_call_without_gvl2(io_flush_buffer_sync2, fptr, RUBY_UBF_IO, NULL); - - if (!ret) { - /* pending async interrupt is there. */ - errno = EAGAIN; - return -1; - } - else if (ret == 1) { - return 0; - } - return ret; + return rb_thread_io_blocking_call(io_flush_buffer_sync, fptr, fptr->fd, RB_WAITFD_OUT); } static inline int io_flush_buffer(rb_io_t *fptr) { - if (fptr->write_lock) { - if (rb_mutex_owned_p(fptr->write_lock)) - return (int)io_flush_buffer_async2((VALUE)fptr); - else - return (int)rb_mutex_synchronize(fptr->write_lock, io_flush_buffer_async2, (VALUE)fptr); + if (!NIL_P(fptr->write_lock) && rb_mutex_owned_p(fptr->write_lock)) { + return (int)io_flush_buffer_async((VALUE)fptr); } else { - return (int)io_flush_buffer_async((VALUE)fptr); + return (int)rb_mutex_synchronize(fptr->write_lock, io_flush_buffer_async, (VALUE)fptr); } } @@ -1259,7 +1411,7 @@ io_fflush(rb_io_t *fptr) return 0; while (fptr->wbuf.len > 0 && io_flush_buffer(fptr) != 0) { - if (!rb_io_maybe_wait_writable(errno, fptr->self, Qnil)) + if (!rb_io_maybe_wait_writable(errno, fptr->self, RUBY_IO_TIMEOUT_DEFAULT)) return -1; rb_io_check_closed(fptr); @@ -1283,6 +1435,10 @@ rb_io_wait(VALUE io, VALUE events, VALUE timeout) struct timeval tv_storage; struct timeval *tv = NULL; + if (NIL_OR_UNDEF_P(timeout)) { + timeout = fptr->timeout; + } + if (timeout != Qnil) { tv_storage = rb_time_interval(timeout); tv = &tv_storage; @@ -1297,7 +1453,7 @@ rb_io_wait(VALUE io, VALUE events, VALUE timeout) // Not sure if this is necessary: rb_io_check_closed(fptr); - if (ready > 0) { + if (ready) { return RB_INT2NUM(ready); } else { @@ -1308,11 +1464,11 @@ rb_io_wait(VALUE io, VALUE events, VALUE timeout) static VALUE io_from_fd(int fd) { - return prep_io(fd, FMODE_PREP, rb_cIO, NULL); + return prep_io(fd, FMODE_EXTERNAL, rb_cIO, NULL); } -static -int io_wait_for_single_fd(int fd, int events, struct timeval *timeout) +static int +io_wait_for_single_fd(int fd, int events, struct timeval *timeout) { VALUE scheduler = rb_fiber_scheduler_current(); @@ -1341,7 +1497,7 @@ rb_io_wait_readable(int f) return TRUE; case EAGAIN: -#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN +#if EWOULDBLOCK != EAGAIN case EWOULDBLOCK: #endif if (scheduler != Qnil) { @@ -1375,8 +1531,8 @@ rb_io_wait_writable(int f) * In old Linux, several special files under /proc and /sys don't handle * select properly. Thus we need avoid to call if don't use O_NONBLOCK. * Otherwise, we face nasty hang up. Sigh. - * e.g. http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=31b07093c44a7a442394d44423e21d783f5523b8 - * http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=31b07093c44a7a442394d44423e21d783f5523b8 + * e.g. https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=31b07093c44a7a442394d44423e21d783f5523b8 + * https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=31b07093c44a7a442394d44423e21d783f5523b8 * In EINTR case, we only need to call RUBY_VM_CHECK_INTS_BLOCKING(). * Then rb_thread_check_ints() is enough. */ @@ -1384,7 +1540,7 @@ rb_io_wait_writable(int f) return TRUE; case EAGAIN: -#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN +#if EWOULDBLOCK != EAGAIN case EWOULDBLOCK: #endif if (scheduler != Qnil) { @@ -1420,7 +1576,8 @@ rb_thread_fd_writable(int fd) return rb_wait_for_single_fd(fd, RUBY_IO_WRITABLE, NULL); } -VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout) +VALUE +rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout) { // fptr->fd can be set to -1 at any time by another thread when the GVL is // released. Many code, e.g. `io_bufread` didn't check this correctly and @@ -1433,8 +1590,8 @@ VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout) // In old Linux, several special files under /proc and /sys don't handle // select properly. Thus we need avoid to call if don't use O_NONBLOCK. // Otherwise, we face nasty hang up. Sigh. - // e.g. http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=31b07093c44a7a442394d44423e21d783f5523b8 - // http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=31b07093c44a7a442394d44423e21d783f5523b8 + // e.g. https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=31b07093c44a7a442394d44423e21d783f5523b8 + // https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=31b07093c44a7a442394d44423e21d783f5523b8 // In EINTR case, we only need to call RUBY_VM_CHECK_INTS_BLOCKING(). // Then rb_thread_check_ints() is enough. case EINTR: @@ -1448,7 +1605,7 @@ VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout) return events; case EAGAIN: -#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN +#if EWOULDBLOCK != EAGAIN case EWOULDBLOCK: #endif // The operation would block, so wait for the specified events: @@ -1456,18 +1613,34 @@ VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout) default: // Non-specific error, no event is ready: - return RB_INT2NUM(0); + return Qfalse; } } -int rb_io_maybe_wait_readable(int error, VALUE io, VALUE timeout) +int +rb_io_maybe_wait_readable(int error, VALUE io, VALUE timeout) { - return RB_NUM2INT(rb_io_maybe_wait(error, io, RB_INT2NUM(RUBY_IO_READABLE), timeout)); + VALUE result = rb_io_maybe_wait(error, io, RB_INT2NUM(RUBY_IO_READABLE), timeout); + + if (RTEST(result)) { + return RB_NUM2INT(result); + } + else { + return 0; + } } -int rb_io_maybe_wait_writable(int error, VALUE io, VALUE timeout) +int +rb_io_maybe_wait_writable(int error, VALUE io, VALUE timeout) { - return RB_NUM2INT(rb_io_maybe_wait(error, io, RB_INT2NUM(RUBY_IO_WRITABLE), timeout)); + VALUE result = rb_io_maybe_wait(error, io, RB_INT2NUM(RUBY_IO_WRITABLE), timeout); + + if (RTEST(result)) { + return RB_NUM2INT(result); + } + else { + return 0; + } } static void @@ -1484,7 +1657,7 @@ make_writeconv(rb_io_t *fptr) ecflags = fptr->encs.ecflags & ~ECONV_NEWLINE_DECORATOR_READ_MASK; ecopts = fptr->encs.ecopts; - if (!fptr->encs.enc || (fptr->encs.enc == rb_ascii8bit_encoding() && !fptr->encs.enc2)) { + if (!fptr->encs.enc || (rb_is_ascii8bit_enc(fptr->encs.enc) && !fptr->encs.enc2)) { /* no encoding conversion */ fptr->writeconv_pre_ecflags = 0; fptr->writeconv_pre_ecopts = Qnil; @@ -1528,7 +1701,6 @@ make_writeconv(rb_io_t *fptr) /* writing functions */ struct binwrite_arg { rb_io_t *fptr; - VALUE str; const char *ptr; long length; }; @@ -1540,144 +1712,179 @@ struct write_arg { }; #ifdef HAVE_WRITEV -static VALUE -io_binwrite_string(VALUE arg) +static ssize_t +io_binwrite_string_internal(rb_io_t *fptr, const char *ptr, long length) { - struct binwrite_arg *p = (struct binwrite_arg *)arg; - rb_io_t *fptr = p->fptr; - long r; - if (fptr->wbuf.len) { - struct iovec iov[2]; + struct iovec iov[2]; + + iov[0].iov_base = fptr->wbuf.ptr+fptr->wbuf.off; + iov[0].iov_len = fptr->wbuf.len; + iov[1].iov_base = (void*)ptr; + iov[1].iov_len = length; - iov[0].iov_base = fptr->wbuf.ptr+fptr->wbuf.off; - iov[0].iov_len = fptr->wbuf.len; - iov[1].iov_base = (char *)p->ptr; - iov[1].iov_len = p->length; + ssize_t result = rb_writev_internal(fptr, iov, 2); - r = rb_writev_internal(fptr->fd, iov, 2); + if (result < 0) + return result; - if (r < 0) - return r; + if (result >= fptr->wbuf.len) { + // We wrote more than the internal buffer: + result -= fptr->wbuf.len; + fptr->wbuf.off = 0; + fptr->wbuf.len = 0; + } + else { + // We only wrote less data than the internal buffer: + fptr->wbuf.off += (int)result; + fptr->wbuf.len -= (int)result; - if (fptr->wbuf.len <= r) { - r -= fptr->wbuf.len; - fptr->wbuf.off = 0; - fptr->wbuf.len = 0; - } - else { - fptr->wbuf.off += (int)r; - fptr->wbuf.len -= (int)r; - r = 0L; - } + result = 0; + } + + return result; } else { - r = rb_write_internal(fptr->fd, p->ptr, p->length); + return rb_io_write_memory(fptr, ptr, length); } - - return r; } #else -static VALUE -io_binwrite_string(VALUE arg) +static ssize_t +io_binwrite_string_internal(rb_io_t *fptr, const char *ptr, long length) { - struct binwrite_arg *p = (struct binwrite_arg *)arg; - rb_io_t *fptr = p->fptr; - long l, len; - - l = len = p->length; + long remaining = length; if (fptr->wbuf.len) { - if (fptr->wbuf.len+len <= fptr->wbuf.capa) { - if (fptr->wbuf.capa < fptr->wbuf.off+fptr->wbuf.len+len) { - MEMMOVE(fptr->wbuf.ptr, fptr->wbuf.ptr+fptr->wbuf.off, char, fptr->wbuf.len); - fptr->wbuf.off = 0; - } - MEMMOVE(fptr->wbuf.ptr+fptr->wbuf.off+fptr->wbuf.len, p->ptr, char, len); - fptr->wbuf.len += (int)len; - l = 0; - } - if (io_fflush(fptr) < 0) - return -2L; /* fail in fflush */ - if (l == 0) - return len; + if (fptr->wbuf.len+length <= fptr->wbuf.capa) { + if (fptr->wbuf.capa < fptr->wbuf.off+fptr->wbuf.len+length) { + MEMMOVE(fptr->wbuf.ptr, fptr->wbuf.ptr+fptr->wbuf.off, char, fptr->wbuf.len); + fptr->wbuf.off = 0; + } + + MEMMOVE(fptr->wbuf.ptr+fptr->wbuf.off+fptr->wbuf.len, ptr, char, length); + fptr->wbuf.len += (int)length; + + // We copied the entire incoming data to the internal buffer: + remaining = 0; + } + + // Flush the internal buffer: + if (io_fflush(fptr) < 0) { + return -1; + } + + // If all the data was buffered, we are done: + if (remaining == 0) { + return length; + } } - return rb_write_internal(p->fptr->fd, p->ptr, p->length); + // Otherwise, we should write the data directly: + return rb_io_write_memory(fptr, ptr, length); } #endif -static long -io_binwrite(VALUE str, const char *ptr, long len, rb_io_t *fptr, int nosync) +static VALUE +io_binwrite_string(VALUE arg) { - long n, r, offset = 0; - - /* don't write anything if current thread has a pending interrupt. */ - rb_thread_check_ints(); - - if ((n = len) <= 0) return n; - - VALUE scheduler = rb_fiber_scheduler_current(); - if (scheduler != Qnil) { - VALUE result = rb_fiber_scheduler_io_write(scheduler, fptr->self, str, offset, len); + struct binwrite_arg *p = (struct binwrite_arg *)arg; - if (result != Qundef) { - ssize_t length = RB_NUM2SSIZE(result); + const char *ptr = p->ptr; + size_t remaining = p->length; - if (length < 0) rb_sys_fail_path(fptr->pathv); + while (remaining) { + // Write as much as possible: + ssize_t result = io_binwrite_string_internal(p->fptr, ptr, remaining); - return length; + if (result == 0) { + // If only the internal buffer is written, result will be zero [bytes of given data written]. This means we + // should try again immediately. + } + else if (result > 0) { + if ((size_t)result == remaining) break; + ptr += result; + remaining -= result; + } + // Wait for it to become writable: + else if (rb_io_maybe_wait_writable(errno, p->fptr->self, RUBY_IO_TIMEOUT_DEFAULT)) { + rb_io_check_closed(p->fptr); + } + else { + // The error was unrelated to waiting for it to become writable, so we fail: + return -1; } } - if (fptr->wbuf.ptr == NULL && !(!nosync && (fptr->mode & FMODE_SYNC))) { + return p->length; +} + +inline static void +io_allocate_write_buffer(rb_io_t *fptr, int sync) +{ + if (fptr->wbuf.ptr == NULL && !(sync && (fptr->mode & FMODE_SYNC))) { fptr->wbuf.off = 0; fptr->wbuf.len = 0; fptr->wbuf.capa = IO_WBUF_CAPA_MIN; fptr->wbuf.ptr = ALLOC_N(char, fptr->wbuf.capa); + } + + if (NIL_P(fptr->write_lock)) { fptr->write_lock = rb_mutex_new(); - rb_mutex_allow_trap(fptr->write_lock, 1); + rb_mutex_allow_trap(fptr->write_lock, 1); } - if ((!nosync && (fptr->mode & (FMODE_SYNC|FMODE_TTY))) || - (fptr->wbuf.ptr && fptr->wbuf.capa <= fptr->wbuf.len + len)) { - struct binwrite_arg arg; +} - arg.fptr = fptr; - arg.str = str; - retry: - arg.ptr = ptr + offset; - arg.length = n; - if (fptr->write_lock) { - r = rb_mutex_synchronize(fptr->write_lock, io_binwrite_string, (VALUE)&arg); - } - else { - r = io_binwrite_string((VALUE)&arg); - } - /* xxx: other threads may modify given string. */ - if (r == n) return len; - if (0 <= r) { - offset += r; - n -= r; - errno = EAGAIN; - } - if (r == -2L) - return -1L; - if (rb_io_maybe_wait_writable(errno, fptr->self, Qnil)) { - rb_io_check_closed(fptr); - if (offset < len) - goto retry; +static inline int +io_binwrite_requires_flush_write(rb_io_t *fptr, long len, int nosync) +{ + // If the requested operation was synchronous and the output mode is synchronous or a TTY: + if (!nosync && (fptr->mode & (FMODE_SYNC|FMODE_TTY))) + return 1; + + // If the amount of data we want to write exceeds the internal buffer: + if (fptr->wbuf.ptr && fptr->wbuf.capa <= fptr->wbuf.len + len) + return 1; + + // Otherwise, we can append to the internal buffer: + return 0; +} + +static long +io_binwrite(const char *ptr, long len, rb_io_t *fptr, int nosync) +{ + if (len <= 0) return len; + + // Don't write anything if current thread has a pending interrupt: + rb_thread_check_ints(); + + io_allocate_write_buffer(fptr, !nosync); + + if (io_binwrite_requires_flush_write(fptr, len, nosync)) { + struct binwrite_arg arg; + + arg.fptr = fptr; + arg.ptr = ptr; + arg.length = len; + + if (!NIL_P(fptr->write_lock)) { + return rb_mutex_synchronize(fptr->write_lock, io_binwrite_string, (VALUE)&arg); + } + else { + return io_binwrite_string((VALUE)&arg); } - return -1L; } + else { + if (fptr->wbuf.off) { + if (fptr->wbuf.len) + MEMMOVE(fptr->wbuf.ptr, fptr->wbuf.ptr+fptr->wbuf.off, char, fptr->wbuf.len); + fptr->wbuf.off = 0; + } - if (fptr->wbuf.off) { - if (fptr->wbuf.len) - MEMMOVE(fptr->wbuf.ptr, fptr->wbuf.ptr+fptr->wbuf.off, char, fptr->wbuf.len); - fptr->wbuf.off = 0; + MEMMOVE(fptr->wbuf.ptr+fptr->wbuf.off+fptr->wbuf.len, ptr, char, len); + fptr->wbuf.len += (int)len; + + return len; } - MEMMOVE(fptr->wbuf.ptr+fptr->wbuf.off+fptr->wbuf.len, ptr+offset, char, len); - fptr->wbuf.len += (int)len; - return len; } # define MODE_BTMODE(a,b,c) ((fmode & FMODE_BINMODE) ? (b) : \ @@ -1692,7 +1899,7 @@ do_writeconv(VALUE str, rb_io_t *fptr, int *converted) { if (NEED_WRITECONV(fptr)) { VALUE common_encoding = Qnil; - SET_BINARY_MODE(fptr); + SET_BINARY_MODE(fptr); make_writeconv(fptr); @@ -1716,27 +1923,27 @@ do_writeconv(VALUE str, rb_io_t *fptr, int *converted) if (!NIL_P(common_encoding)) { str = rb_str_encode(str, common_encoding, fptr->writeconv_pre_ecflags, fptr->writeconv_pre_ecopts); - *converted = 1; + *converted = 1; } if (fptr->writeconv) { str = rb_econv_str_convert(fptr->writeconv, str, ECONV_PARTIAL_INPUT); - *converted = 1; + *converted = 1; } } #if RUBY_CRLF_ENVIRONMENT #define fmode (fptr->mode) else if (MODE_BTMODE(DEFAULT_TEXTMODE,0,1)) { - if ((fptr->mode & FMODE_READABLE) && - !(fptr->encs.ecflags & ECONV_NEWLINE_DECORATOR_MASK)) { - setmode(fptr->fd, O_BINARY); - } - else { - setmode(fptr->fd, O_TEXT); - } - if (!rb_enc_asciicompat(rb_enc_get(str))) { - rb_raise(rb_eArgError, "ASCII incompatible string written for text mode IO without encoding conversion: %s", - rb_enc_name(rb_enc_get(str))); + if ((fptr->mode & FMODE_READABLE) && + !(fptr->encs.ecflags & ECONV_NEWLINE_DECORATOR_MASK)) { + setmode(fptr->fd, O_BINARY); + } + else { + setmode(fptr->fd, O_TEXT); + } + if (!rb_enc_asciicompat(rb_enc_get(str))) { + rb_raise(rb_eArgError, "ASCII incompatible string written for text mode IO without encoding conversion: %s", + rb_enc_name(rb_enc_get(str))); } } #undef fmode @@ -1751,19 +1958,21 @@ io_fwrite(VALUE str, rb_io_t *fptr, int nosync) VALUE tmp; long n, len; const char *ptr; + #ifdef _WIN32 if (fptr->mode & FMODE_TTY) { - long len = rb_w32_write_console(str, fptr->fd); - if (len > 0) return len; + long len = rb_w32_write_console(str, fptr->fd); + if (len > 0) return len; } #endif + str = do_writeconv(str, fptr, &converted); if (converted) - OBJ_FREEZE(str); + OBJ_FREEZE(str); - tmp = rb_str_tmp_frozen_acquire(str); + tmp = rb_str_tmp_frozen_no_embed_acquire(str); RSTRING_GETMEM(tmp, ptr, len); - n = io_binwrite(tmp, ptr, len, fptr, nosync); + n = io_binwrite(ptr, len, fptr, nosync); rb_str_tmp_frozen_release(str, tmp); return n; @@ -1776,7 +1985,7 @@ rb_io_bufwrite(VALUE io, const void *buf, size_t size) GetOpenFile(io, fptr); rb_io_check_writable(fptr); - return (ssize_t)io_binwrite(0, buf, (long)size, fptr, 0); + return (ssize_t)io_binwrite(buf, (long)size, fptr, 0); } static VALUE @@ -1789,10 +1998,12 @@ io_write(VALUE io, VALUE str, int nosync) io = GetWriteIO(io); str = rb_obj_as_string(str); tmp = rb_io_check_io(io); + if (NIL_P(tmp)) { - /* port is not IO, call write method for it. */ - return rb_funcall(io, id_write, 1, str); + /* port is not IO, call write method for it. */ + return rb_funcall(io, id_write, 1, str); } + io = tmp; if (RSTRING_LEN(str) == 0) return INT2FIX(0); @@ -1808,104 +2019,124 @@ io_write(VALUE io, VALUE str, int nosync) #ifdef HAVE_WRITEV struct binwritev_arg { rb_io_t *fptr; - const struct iovec *iov; + struct iovec *iov; int iovcnt; + size_t total; }; static VALUE -call_writev_internal(VALUE arg) +io_binwritev_internal(VALUE arg) { struct binwritev_arg *p = (struct binwritev_arg *)arg; - return rb_writev_internal(p->fptr->fd, p->iov, p->iovcnt); + + size_t remaining = p->total; + size_t offset = 0; + + rb_io_t *fptr = p->fptr; + struct iovec *iov = p->iov; + int iovcnt = p->iovcnt; + + while (remaining) { + long result = rb_writev_internal(fptr, iov, iovcnt); + + if (result >= 0) { + offset += result; + if (fptr->wbuf.ptr && fptr->wbuf.len) { + if (offset < (size_t)fptr->wbuf.len) { + fptr->wbuf.off += result; + fptr->wbuf.len -= result; + } + else { + offset -= (size_t)fptr->wbuf.len; + fptr->wbuf.off = 0; + fptr->wbuf.len = 0; + } + } + + if (offset == p->total) { + return p->total; + } + + while (result >= (ssize_t)iov->iov_len) { + /* iovcnt > 0 */ + result -= iov->iov_len; + iov->iov_len = 0; + iov++; + + if (!--iovcnt) { + // I don't believe this code path can ever occur. + return offset; + } + } + + iov->iov_base = (char *)iov->iov_base + result; + iov->iov_len -= result; + } + else if (rb_io_maybe_wait_writable(errno, fptr->self, RUBY_IO_TIMEOUT_DEFAULT)) { + rb_io_check_closed(fptr); + } + else { + return -1; + } + } + + return offset; } static long io_binwritev(struct iovec *iov, int iovcnt, rb_io_t *fptr) { - int i; - long r, total = 0, written_len = 0; - - /* don't write anything if current thread has a pending interrupt. */ + // Don't write anything if current thread has a pending interrupt: rb_thread_check_ints(); if (iovcnt == 0) return 0; - for (i = 1; i < iovcnt; i++) total += iov[i].iov_len; - if (fptr->wbuf.ptr == NULL && !(fptr->mode & FMODE_SYNC)) { - fptr->wbuf.off = 0; - fptr->wbuf.len = 0; - fptr->wbuf.capa = IO_WBUF_CAPA_MIN; - fptr->wbuf.ptr = ALLOC_N(char, fptr->wbuf.capa); - fptr->write_lock = rb_mutex_new(); - rb_mutex_allow_trap(fptr->write_lock, 1); - } + size_t total = 0; + for (int i = 1; i < iovcnt; i++) total += iov[i].iov_len; + + io_allocate_write_buffer(fptr, 1); if (fptr->wbuf.ptr && fptr->wbuf.len) { - long offset = fptr->wbuf.off + fptr->wbuf.len; - if (offset + total <= fptr->wbuf.capa) { - for (i = 1; i < iovcnt; i++) { - memcpy(fptr->wbuf.ptr+offset, iov[i].iov_base, iov[i].iov_len); - offset += iov[i].iov_len; - } - fptr->wbuf.len += total; - return total; - } - else { - iov[0].iov_base = fptr->wbuf.ptr + fptr->wbuf.off; - iov[0].iov_len = fptr->wbuf.len; - } - } - else { - iov++; - if (!--iovcnt) return 0; - } + // The end of the buffered data: + size_t offset = fptr->wbuf.off + fptr->wbuf.len; - retry: - if (fptr->write_lock) { - struct binwritev_arg arg; - arg.fptr = fptr; - arg.iov = iov; - arg.iovcnt = iovcnt; - r = rb_mutex_synchronize(fptr->write_lock, call_writev_internal, (VALUE)&arg); + if (offset + total <= (size_t)fptr->wbuf.capa) { + for (int i = 1; i < iovcnt; i++) { + memcpy(fptr->wbuf.ptr+offset, iov[i].iov_base, iov[i].iov_len); + offset += iov[i].iov_len; + } + + fptr->wbuf.len += total; + + return total; + } + else { + iov[0].iov_base = fptr->wbuf.ptr + fptr->wbuf.off; + iov[0].iov_len = fptr->wbuf.len; + } } else { - r = rb_writev_internal(fptr->fd, iov, iovcnt); - } + // The first iov is reserved for the internal buffer, and it's empty. + iov++; - if (r >= 0) { - written_len += r; - if (fptr->wbuf.ptr && fptr->wbuf.len) { - if (written_len < fptr->wbuf.len) { - fptr->wbuf.off += r; - fptr->wbuf.len -= r; - } - else { - written_len -= fptr->wbuf.len; - fptr->wbuf.off = 0; - fptr->wbuf.len = 0; - } - } - if (written_len == total) return total; + if (!--iovcnt) { + // If there are no other io vectors we are done. + return 0; + } + } - while (r >= (ssize_t)iov->iov_len) { - /* iovcnt > 0 */ - r -= iov->iov_len; - iov->iov_len = 0; - iov++; - if (!--iovcnt) return total; - /* defensive check: written_len should == total */ - } - iov->iov_base = (char *)iov->iov_base + r; - iov->iov_len -= r; + struct binwritev_arg arg; + arg.fptr = fptr; + arg.iov = iov; + arg.iovcnt = iovcnt; + arg.total = total; - errno = EAGAIN; + if (!NIL_P(fptr->write_lock)) { + return rb_mutex_synchronize(fptr->write_lock, io_binwritev_internal, (VALUE)&arg); } - if (rb_io_maybe_wait_writable(errno, fptr->self, Qnil)) { - rb_io_check_closed(fptr); - goto retry; + else { + return io_binwritev_internal((VALUE)&arg); } - - return -1L; } static long @@ -1920,24 +2151,26 @@ io_fwritev(int argc, const VALUE *argv, rb_io_t *fptr) tmp_array = ALLOCV_N(VALUE, v2, argc); for (i = 0; i < argc; i++) { - str = rb_obj_as_string(argv[i]); - converted = 0; - str = do_writeconv(str, fptr, &converted); - if (converted) - OBJ_FREEZE(str); + str = rb_obj_as_string(argv[i]); + converted = 0; + str = do_writeconv(str, fptr, &converted); + + if (converted) + OBJ_FREEZE(str); - tmp = rb_str_tmp_frozen_acquire(str); - tmp_array[i] = tmp; - /* iov[0] is reserved for buffer of fptr */ - iov[i+1].iov_base = RSTRING_PTR(tmp); - iov[i+1].iov_len = RSTRING_LEN(tmp); + tmp = rb_str_tmp_frozen_acquire(str); + tmp_array[i] = tmp; + + /* iov[0] is reserved for buffer of fptr */ + iov[i+1].iov_base = RSTRING_PTR(tmp); + iov[i+1].iov_len = RSTRING_LEN(tmp); } n = io_binwritev(iov, iovcnt, fptr); if (v1) ALLOCV_END(v1); for (i = 0; i < argc; i++) { - rb_str_tmp_frozen_release(argv[i], tmp_array[i]); + rb_str_tmp_frozen_release(argv[i], tmp_array[i]); } if (v2) ALLOCV_END(v2); @@ -1966,10 +2199,12 @@ io_writev(int argc, const VALUE *argv, VALUE io) io = GetWriteIO(io); tmp = rb_io_check_io(io); + if (NIL_P(tmp)) { - /* port is not IO, call write method for it. */ - return rb_funcallv(io, id_write, argc, argv); + /* port is not IO, call write method for it. */ + return rb_funcallv(io, id_write, argc, argv); } + io = tmp; GetOpenFile(io, fptr); @@ -1977,18 +2212,21 @@ io_writev(int argc, const VALUE *argv, VALUE io) for (i = 0; i < argc; i += cnt) { #ifdef HAVE_WRITEV - if ((fptr->mode & (FMODE_SYNC|FMODE_TTY)) && iovcnt_ok(cnt = argc - i)) { - n = io_fwritev(cnt, &argv[i], fptr); - } - else + if ((fptr->mode & (FMODE_SYNC|FMODE_TTY)) && iovcnt_ok(cnt = argc - i)) { + n = io_fwritev(cnt, &argv[i], fptr); + } + else #endif - { - cnt = 1; - /* sync at last item */ - n = io_fwrite(rb_obj_as_string(argv[i]), fptr, (i < argc-1)); - } - if (n < 0L) rb_sys_fail_on_write(fptr); - total = rb_fix_plus(LONG2FIX(n), total); + { + cnt = 1; + /* sync at last item */ + n = io_fwrite(rb_obj_as_string(argv[i]), fptr, (i < argc-1)); + } + + if (n < 0L) + rb_sys_fail_on_write(fptr); + + total = rb_fix_plus(LONG2FIX(n), total); } return total; @@ -1996,31 +2234,34 @@ io_writev(int argc, const VALUE *argv, VALUE io) /* * call-seq: - * ios.write(string, ...) -> integer + * write(*objects) -> integer * - * Writes the given strings to <em>ios</em>. The stream must be opened - * for writing. Arguments that are not a string will be converted - * to a string using <code>to_s</code>. Returns the number of bytes - * written in total. + * Writes each of the given +objects+ to +self+, + * which must be opened for writing + * (see {Access Modes}[rdoc-ref:File@Access+Modes]); + * returns the total number bytes written; + * each of +objects+ that is not a string is converted via method +to_s+: * - * count = $stdout.write("This is", " a test\n") - * puts "That was #{count} bytes of data" + * $stdout.write('Hello', ', ', 'World!', "\n") # => 14 + * $stdout.write('foo', :bar, 2, "\n") # => 8 * - * <em>produces:</em> + * Output: + * + * Hello, World! + * foobar2 * - * This is a test - * That was 15 bytes of data + * Related: IO#read. */ static VALUE io_write_m(int argc, VALUE *argv, VALUE io) { if (argc != 1) { - return io_writev(argc, argv, io); + return io_writev(argc, argv, io); } else { - VALUE str = argv[0]; - return io_write(io, str, 0); + VALUE str = argv[0]; + return io_write(io, str, 0); } } @@ -2034,32 +2275,41 @@ static VALUE rb_io_writev(VALUE io, int argc, const VALUE *argv) { if (argc > 1 && rb_obj_method_arity(io, id_write) == 1) { - if (io != rb_ractor_stderr() && RTEST(ruby_verbose)) { - VALUE klass = CLASS_OF(io); - char sep = FL_TEST(klass, FL_SINGLETON) ? (klass = io, '.') : '#'; - rb_category_warning(RB_WARN_CATEGORY_DEPRECATED, "%+"PRIsVALUE"%c""write is outdated interface" - " which accepts just one argument", - klass, sep); - } - do rb_io_write(io, *argv++); while (--argc); - return argv[0]; /* unused right now */ + if (io != rb_ractor_stderr() && RTEST(ruby_verbose)) { + VALUE klass = CLASS_OF(io); + char sep = RCLASS_SINGLETON_P(klass) ? (klass = io, '.') : '#'; + rb_category_warning( + RB_WARN_CATEGORY_DEPRECATED, "%+"PRIsVALUE"%c""write is outdated interface" + " which accepts just one argument", + klass, sep + ); + } + + do rb_io_write(io, *argv++); while (--argc); + + return Qnil; } + return rb_funcallv(io, id_write, argc, argv); } /* * call-seq: - * ios << obj -> ios + * self << object -> self * - * String Output---Writes <i>obj</i> to <em>ios</em>. - * <i>obj</i> will be converted to a string using - * <code>to_s</code>. + * Writes the given +object+ to +self+, + * which must be opened for writing (see {Access Modes}[rdoc-ref:File@Access+Modes]); + * returns +self+; + * if +object+ is not a string, it is converted via method +to_s+: * - * $stdout << "Hello " << "world!\n" + * $stdout << 'Hello' << ', ' << 'World!' << "\n" + * $stdout << 'foo' << :bar << 2 << "\n" * - * <em>produces:</em> + * Output: + * + * Hello, World! + * foobar2 * - * Hello world! */ @@ -2078,7 +2328,7 @@ nogvl_fsync(void *ptr) #ifdef _WIN32 if (GetFileType((HANDLE)rb_w32_get_osfhandle(fptr->fd)) != FILE_TYPE_DISK) - return 0; + return 0; #endif return (VALUE)fsync(fptr->fd); } @@ -2109,18 +2359,14 @@ rb_io_flush_raw(VALUE io, int sync) /* * call-seq: - * ios.flush -> ios + * flush -> self * - * Flushes any buffered data within <em>ios</em> to the underlying - * operating system (note that this is Ruby internal buffering only; - * the OS may buffer the data as well). + * Flushes data buffered in +self+ to the operating system + * (but does not necessarily flush data buffered in the operating system): * - * $stdout.print "no newline" - * $stdout.flush + * $stdout.print 'no newline' # Not necessarily flushed. + * $stdout.flush # Flushed. * - * <em>produces:</em> - * - * no newline */ VALUE @@ -2131,22 +2377,25 @@ rb_io_flush(VALUE io) /* * call-seq: - * ios.pos -> integer - * ios.tell -> integer + * tell -> integer + * + * Returns the current position (in bytes) in +self+ + * (see {Position}[rdoc-ref:IO@Position]): * - * Returns the current offset (in bytes) of <em>ios</em>. + * f = File.open('t.txt') + * f.tell # => 0 + * f.gets # => "First line\n" + * f.tell # => 12 + * f.close * - * f = File.new("testfile") - * f.pos #=> 0 - * f.gets #=> "This is line one\n" - * f.pos #=> 17 + * Related: IO#pos=, IO#seek. */ static VALUE rb_io_tell(VALUE io) { rb_io_t *fptr; - off_t pos; + rb_off_t pos; GetOpenFile(io, fptr); pos = io_tell(fptr); @@ -2159,7 +2408,7 @@ static VALUE rb_io_seek(VALUE io, VALUE offset, int whence) { rb_io_t *fptr; - off_t pos; + rb_off_t pos; pos = NUM2OFFT(offset); GetOpenFile(io, fptr); @@ -2191,23 +2440,49 @@ interpret_seek_whence(VALUE vwhence) /* * call-seq: - * ios.seek(amount, whence=IO::SEEK_SET) -> 0 + * seek(offset, whence = IO::SEEK_SET) -> 0 * - * Seeks to a given offset <i>anInteger</i> in the stream according to - * the value of <i>whence</i>: + * Seeks to the position given by integer +offset+ + * (see {Position}[rdoc-ref:IO@Position]) + * and constant +whence+, which is one of: * - * :CUR or IO::SEEK_CUR | Seeks to _amount_ plus current position - * ----------------------+-------------------------------------------------- - * :END or IO::SEEK_END | Seeks to _amount_ plus end of stream (you - * | probably want a negative value for _amount_) - * ----------------------+-------------------------------------------------- - * :SET or IO::SEEK_SET | Seeks to the absolute location given by _amount_ + * - +:CUR+ or <tt>IO::SEEK_CUR</tt>: + * Repositions the stream to its current position plus the given +offset+: * - * Example: + * f = File.open('t.txt') + * f.tell # => 0 + * f.seek(20, :CUR) # => 0 + * f.tell # => 20 + * f.seek(-10, :CUR) # => 0 + * f.tell # => 10 + * f.close + * + * - +:END+ or <tt>IO::SEEK_END</tt>: + * Repositions the stream to its end plus the given +offset+: + * + * f = File.open('t.txt') + * f.tell # => 0 + * f.seek(0, :END) # => 0 # Repositions to stream end. + * f.tell # => 52 + * f.seek(-20, :END) # => 0 + * f.tell # => 32 + * f.seek(-40, :END) # => 0 + * f.tell # => 12 + * f.close + * + * - +:SET+ or <tt>IO:SEEK_SET</tt>: + * Repositions the stream to the given +offset+: + * + * f = File.open('t.txt') + * f.tell # => 0 + * f.seek(20, :SET) # => 0 + * f.tell # => 20 + * f.seek(40, :SET) # => 0 + * f.tell # => 40 + * f.close + * + * Related: IO#pos=, IO#tell. * - * f = File.new("testfile") - * f.seek(-13, IO::SEEK_END) #=> 0 - * f.readline #=> "And so on...\n" */ static VALUE @@ -2217,7 +2492,7 @@ rb_io_seek_m(int argc, VALUE *argv, VALUE io) int whence = SEEK_SET; if (rb_scan_args(argc, argv, "11", &offset, &ptrname) == 2) { - whence = interpret_seek_whence(ptrname); + whence = interpret_seek_whence(ptrname); } return rb_io_seek(io, offset, whence); @@ -2225,22 +2500,26 @@ rb_io_seek_m(int argc, VALUE *argv, VALUE io) /* * call-seq: - * ios.pos = integer -> integer + * pos = new_position -> new_position + * + * Seeks to the given +new_position+ (in bytes); + * see {Position}[rdoc-ref:IO@Position]: * - * Seeks to the given position (in bytes) in <em>ios</em>. - * It is not guaranteed that seeking to the right position when <em>ios</em> - * is textmode. + * f = File.open('t.txt') + * f.tell # => 0 + * f.pos = 20 # => 20 + * f.tell # => 20 + * f.close + * + * Related: IO#seek, IO#tell. * - * f = File.new("testfile") - * f.pos = 17 - * f.gets #=> "This is line two\n" */ static VALUE rb_io_set_pos(VALUE io, VALUE offset) { rb_io_t *fptr; - off_t pos; + rb_off_t pos; pos = NUM2OFFT(offset); GetOpenFile(io, fptr); @@ -2254,18 +2533,26 @@ static void clear_readconv(rb_io_t *fptr); /* * call-seq: - * ios.rewind -> 0 + * rewind -> 0 + * + * Repositions the stream to its beginning, + * setting both the position and the line number to zero; + * see {Position}[rdoc-ref:IO@Position] + * and {Line Number}[rdoc-ref:IO@Line+Number]: * - * Positions <em>ios</em> to the beginning of input, resetting - * #lineno to zero. + * f = File.open('t.txt') + * f.tell # => 0 + * f.lineno # => 0 + * f.gets # => "First line\n" + * f.tell # => 12 + * f.lineno # => 1 + * f.rewind # => 0 + * f.tell # => 0 + * f.lineno # => 0 + * f.close * - * f = File.new("testfile") - * f.readline #=> "This is line one\n" - * f.rewind #=> 0 - * f.lineno #=> 0 - * f.readline #=> "This is line one\n" + * Note that this method cannot be used with streams such as pipes, ttys, and sockets. * - * Note that it cannot be used with streams such as pipes, ttys, and sockets. */ static VALUE @@ -2276,11 +2563,11 @@ rb_io_rewind(VALUE io) GetOpenFile(io, fptr); if (io_seek(fptr, 0L, 0) < 0 && errno) rb_sys_fail_path(fptr->pathv); if (io == ARGF.current_file) { - ARGF.lineno -= fptr->lineno; + ARGF.lineno -= fptr->lineno; } fptr->lineno = 0; if (fptr->readconv) { - clear_readconv(fptr); + clear_readconv(fptr); } return INT2FIX(0); @@ -2289,11 +2576,12 @@ rb_io_rewind(VALUE io) static int fptr_wait_readable(rb_io_t *fptr) { - int ret = rb_io_maybe_wait_readable(errno, fptr->self, Qnil); + int result = rb_io_maybe_wait_readable(errno, fptr->self, RUBY_IO_TIMEOUT_DEFAULT); - if (ret) + if (result) rb_io_check_closed(fptr); - return ret; + + return result; } static int @@ -2307,27 +2595,26 @@ io_fillbuf(rb_io_t *fptr) fptr->rbuf.capa = IO_RBUF_CAPA_FOR(fptr); fptr->rbuf.ptr = ALLOC_N(char, fptr->rbuf.capa); #ifdef _WIN32 - fptr->rbuf.capa--; + fptr->rbuf.capa--; #endif } if (fptr->rbuf.len == 0) { retry: - { - r = rb_read_internal(fptr->fd, fptr->rbuf.ptr, fptr->rbuf.capa); - } + r = rb_io_read_memory(fptr, fptr->rbuf.ptr, fptr->rbuf.capa); + if (r < 0) { if (fptr_wait_readable(fptr)) goto retry; - { - int e = errno; - VALUE path = rb_sprintf("fd:%d ", fptr->fd); - if (!NIL_P(fptr->pathv)) { - rb_str_append(path, fptr->pathv); - } - rb_syserr_fail_path(e, path); - } - } - if (r > 0) rb_io_check_closed(fptr); + + int e = errno; + VALUE path = rb_sprintf("fd:%d ", fptr->fd); + if (!NIL_P(fptr->pathv)) { + rb_str_append(path, fptr->pathv); + } + + rb_syserr_fail_path(e, path); + } + if (r > 0) rb_io_check_closed(fptr); fptr->rbuf.off = 0; fptr->rbuf.len = (int)r; /* r should be <= rbuf_capa */ if (r == 0) @@ -2338,33 +2625,35 @@ io_fillbuf(rb_io_t *fptr) /* * call-seq: - * ios.eof -> true or false - * ios.eof? -> true or false + * eof -> true or false + * + * Returns +true+ if the stream is positioned at its end, +false+ otherwise; + * see {Position}[rdoc-ref:IO@Position]: * - * Returns true if <em>ios</em> is at end of file that means - * there are no more data to read. - * The stream must be opened for reading or an IOError will be - * raised. + * f = File.open('t.txt') + * f.eof # => false + * f.seek(0, :END) # => 0 + * f.eof # => true + * f.close * - * f = File.new("testfile") - * dummy = f.readlines - * f.eof #=> true + * Raises an exception unless the stream is opened for reading; + * see {Mode}[rdoc-ref:File@Access+Modes]. * - * If <em>ios</em> is a stream such as pipe or socket, IO#eof? - * blocks until the other end sends some data or closes it. + * If +self+ is a stream such as pipe or socket, this method + * blocks until the other end sends some data or closes it: * - * r, w = IO.pipe - * Thread.new { sleep 1; w.close } - * r.eof? #=> true after 1 second blocking + * r, w = IO.pipe + * Thread.new { sleep 1; w.close } + * r.eof? # => true # After 1-second wait. * - * r, w = IO.pipe - * Thread.new { sleep 1; w.puts "a" } - * r.eof? #=> false after 1 second blocking + * r, w = IO.pipe + * Thread.new { sleep 1; w.puts "a" } + * r.eof? # => false # After 1-second wait. * - * r, w = IO.pipe - * r.eof? # blocks forever + * r, w = IO.pipe + * r.eof? # blocks forever * - * Note that IO#eof? reads data to the input byte buffer. So + * Note that this method reads data to the input byte buffer. So * IO#sysread may not behave as you intend with IO#eof?, unless you * call IO#rewind first (which is not available for some streams). */ @@ -2382,7 +2671,7 @@ rb_io_eof(VALUE io) READ_CHECK(fptr); #if RUBY_CRLF_ENVIRONMENT if (!NEED_READCONV(fptr) && NEED_NEWLINE_DECORATOR_ON_READ(fptr)) { - return RBOOL(eof(fptr->fd));; + return RBOOL(eof(fptr->fd)); } #endif return RBOOL(io_fillbuf(fptr) < 0); @@ -2390,15 +2679,18 @@ rb_io_eof(VALUE io) /* * call-seq: - * ios.sync -> true or false + * sync -> true or false * - * Returns the current ``sync mode'' of <em>ios</em>. When sync mode is - * true, all output is immediately flushed to the underlying operating - * system and is not buffered by Ruby internally. See also - * IO#fsync. + * Returns the current sync mode of the stream. + * When sync mode is true, all output is immediately flushed to the underlying + * operating system and is not buffered by Ruby internally. See also #fsync. + * + * f = File.open('t.tmp', 'w') + * f.sync # => false + * f.sync = true + * f.sync # => true + * f.close * - * f = File.new("testfile") - * f.sync #=> false */ static VALUE @@ -2415,15 +2707,27 @@ rb_io_sync(VALUE io) /* * call-seq: - * ios.sync = boolean -> boolean + * sync = boolean -> boolean + * + * Sets the _sync_ _mode_ for the stream to the given value; + * returns the given value. + * + * Values for the sync mode: * - * Sets the ``sync mode'' to <code>true</code> or <code>false</code>. - * When sync mode is true, all output is immediately flushed to the - * underlying operating system and is not buffered internally. Returns - * the new state. See also IO#fsync. + * - +true+: All output is immediately flushed to the + * underlying operating system and is not buffered internally. + * - +false+: Output may be buffered internally. + * + * Example; + * + * f = File.open('t.tmp', 'w') + * f.sync # => false + * f.sync = true + * f.sync # => true + * f.close + * + * Related: IO#fsync. * - * f = File.new("testfile") - * f.sync = true */ static VALUE @@ -2434,25 +2738,30 @@ rb_io_set_sync(VALUE io, VALUE sync) io = GetWriteIO(io); GetOpenFile(io, fptr); if (RTEST(sync)) { - fptr->mode |= FMODE_SYNC; + fptr->mode |= FMODE_SYNC; } else { - fptr->mode &= ~FMODE_SYNC; + fptr->mode &= ~FMODE_SYNC; } return sync; } /* * call-seq: - * ios.fsync -> 0 or nil + * fsync -> 0 * - * Immediately writes all buffered data in <em>ios</em> to disk. - * Note that #fsync differs from using IO#sync=. The latter ensures - * that data is flushed from Ruby's buffers, but does not guarantee - * that the underlying operating system actually writes it to disk. + * Immediately writes to disk all data buffered in the stream, + * via the operating system's <tt>fsync(2)</tt>. + + * Note this difference: + * + * - IO#sync=: Ensures that data is flushed from the stream's internal buffers, + * but does not guarantee that the operating system actually writes the data to disk. + * - IO#fsync: Ensures both that data is flushed from internal buffers, + * and that data is written to disk. + * + * Raises an exception if the operating system does not support <tt>fsync(2)</tt>. * - * NotImplementedError is raised - * if the underlying operating system does not support <em>fsync(2)</em>. */ static VALUE @@ -2466,7 +2775,7 @@ rb_io_fsync(VALUE io) if (io_fflush(fptr) < 0) rb_sys_fail_on_write(fptr); if ((int)rb_thread_io_blocking_region(nogvl_fsync, fptr, fptr->fd) < 0) - rb_sys_fail_path(fptr->pathv); + rb_sys_fail_path(fptr->pathv); return INT2FIX(0); } #else @@ -2488,20 +2797,20 @@ nogvl_fdatasync(void *ptr) #ifdef _WIN32 if (GetFileType((HANDLE)rb_w32_get_osfhandle(fptr->fd)) != FILE_TYPE_DISK) - return 0; + return 0; #endif return (VALUE)fdatasync(fptr->fd); } /* * call-seq: - * ios.fdatasync -> 0 or nil + * fdatasync -> 0 * - * Immediately writes all buffered data in <em>ios</em> to disk. + * Immediately writes to disk all data buffered in the stream, + * via the operating system's: <tt>fdatasync(2)</tt>, if supported, + * otherwise via <tt>fsync(2)</tt>, if supported; + * otherwise raises an exception. * - * If the underlying operating system does not support <em>fdatasync(2)</em>, - * IO#fsync is called instead (which might raise a - * NotImplementedError). */ static VALUE @@ -2516,7 +2825,7 @@ rb_io_fdatasync(VALUE io) rb_sys_fail_on_write(fptr); if ((int)rb_thread_io_blocking_region(nogvl_fdatasync, fptr, fptr->fd) == 0) - return INT2FIX(0); + return INT2FIX(0); /* fall back */ return rb_io_fsync(io); @@ -2527,14 +2836,16 @@ rb_io_fdatasync(VALUE io) /* * call-seq: - * ios.fileno -> integer - * ios.to_i -> integer + * fileno -> integer * - * Returns an integer representing the numeric file descriptor for - * <em>ios</em>. + * Returns the integer file descriptor for the stream: + * + * $stdin.fileno # => 0 + * $stdout.fileno # => 1 + * $stderr.fileno # => 2 + * File.open('t.txt').fileno # => 10 + * f.close * - * $stdin.fileno #=> 0 - * $stdout.fileno #=> 1 */ static VALUE @@ -2548,25 +2859,54 @@ rb_io_fileno(VALUE io) return INT2FIX(fd); } +int +rb_io_descriptor(VALUE io) +{ + if (RB_TYPE_P(io, T_FILE)) { + rb_io_t *fptr = RFILE(io)->fptr; + rb_io_check_closed(fptr); + return fptr->fd; + } + else { + VALUE fileno = rb_check_funcall(io, id_fileno, 0, NULL); + if (!UNDEF_P(fileno)) { + return RB_NUM2INT(fileno); + } + } + + rb_raise(rb_eTypeError, "expected IO or #fileno, %"PRIsVALUE" given", rb_obj_class(io)); + + UNREACHABLE_RETURN(-1); +} + +int +rb_io_mode(VALUE io) +{ + rb_io_t *fptr; + GetOpenFile(io, fptr); + return fptr->mode; +} /* * call-seq: - * ios.pid -> integer + * pid -> integer or nil * - * Returns the process ID of a child process associated with - * <em>ios</em>. This will be set by IO.popen. + * Returns the process ID of a child process associated with the stream, + * which will have been set by IO#popen, or +nil+ if the stream was not + * created by IO#popen: * - * pipe = IO.popen("-") - * if pipe - * $stderr.puts "In parent, child pid is #{pipe.pid}" - * else - * $stderr.puts "In child, pid is #{$$}" - * end + * pipe = IO.popen("-") + * if pipe + * $stderr.puts "In parent, child pid is #{pipe.pid}" + * else + * $stderr.puts "In child, pid is #{$$}" + * end * - * <em>produces:</em> + * Output: + * + * In child, pid is 26209 + * In parent, child pid is 26209 * - * In child, pid is 26209 - * In parent, child pid is 26209 */ static VALUE @@ -2576,16 +2916,44 @@ rb_io_pid(VALUE io) GetOpenFile(io, fptr); if (!fptr->pid) - return Qnil; + return Qnil; return PIDT2NUM(fptr->pid); } +/* + * call-seq: + * path -> string or nil + * + * Returns the path associated with the IO, or +nil+ if there is no path + * associated with the IO. It is not guaranteed that the path exists on + * the filesystem. + * + * $stdin.path # => "<STDIN>" + * + * File.open("testfile") {|f| f.path} # => "testfile" + */ + +VALUE +rb_io_path(VALUE io) +{ + rb_io_t *fptr = RFILE(io)->fptr; + + if (!fptr) + return Qnil; + + return rb_obj_dup(fptr->pathv); +} /* - * call-seq: - * ios.inspect -> string + * call-seq: + * inspect -> string + * + * Returns a string representation of +self+: + * + * f = File.open('t.txt') + * f.inspect # => "#<File:t.txt>" + * f.close * - * Return a string describing this IO object. */ static VALUE @@ -2602,16 +2970,16 @@ rb_io_inspect(VALUE obj) rb_str_cat2(result, ":"); if (NIL_P(fptr->pathv)) { if (fptr->fd < 0) { - rb_str_cat(result, closed+1, strlen(closed)-1); + rb_str_cat(result, closed+1, strlen(closed)-1); } else { - rb_str_catf(result, "fd %d", fptr->fd); + rb_str_catf(result, "fd %d", fptr->fd); } } else { - rb_str_append(result, fptr->pathv); + rb_str_append(result, fptr->pathv); if (fptr->fd < 0) { - rb_str_cat(result, closed, strlen(closed)); + rb_str_cat(result, closed, strlen(closed)); } } return rb_str_cat2(result, ">"); @@ -2619,9 +2987,10 @@ rb_io_inspect(VALUE obj) /* * call-seq: - * ios.to_io -> ios + * to_io -> self + * + * Returns +self+. * - * Returns <em>ios</em>. */ static VALUE @@ -2656,7 +3025,7 @@ io_bufread(char *ptr, long len, rb_io_t *fptr) while (n > 0) { again: rb_io_check_closed(fptr); - c = rb_read_internal(fptr->fd, ptr+offset, n); + c = rb_io_read_memory(fptr, ptr+offset, n); if (c == 0) break; if (c < 0) { if (fptr_wait_readable(fptr)) @@ -2702,19 +3071,6 @@ bufread_call(VALUE arg) static long io_fread(VALUE str, long offset, long size, rb_io_t *fptr) { - VALUE scheduler = rb_fiber_scheduler_current(); - if (scheduler != Qnil) { - VALUE result = rb_fiber_scheduler_io_read(scheduler, fptr->self, str, offset, size); - - if (result != Qundef) { - ssize_t length = RB_NUM2SSIZE(result); - - if (length < 0) rb_sys_fail_path(fptr->pathv); - - return length; - } - } - long len; struct bufread_arg arg; @@ -2732,27 +3088,27 @@ static long remain_size(rb_io_t *fptr) { struct stat st; - off_t siz = READ_DATA_PENDING_COUNT(fptr); - off_t pos; + rb_off_t siz = READ_DATA_PENDING_COUNT(fptr); + rb_off_t pos; if (fstat(fptr->fd, &st) == 0 && S_ISREG(st.st_mode) #if defined(__HAIKU__) - && (st.st_dev > 3) + && (st.st_dev > 3) #endif - ) + ) { if (io_fflush(fptr) < 0) rb_sys_fail_on_write(fptr); - pos = lseek(fptr->fd, 0, SEEK_CUR); - if (st.st_size >= pos && pos >= 0) { - siz += st.st_size - pos; - if (siz > LONG_MAX) { - rb_raise(rb_eIOError, "file too big for single read"); - } - } + pos = lseek(fptr->fd, 0, SEEK_CUR); + if (st.st_size >= pos && pos >= 0) { + siz += st.st_size - pos; + if (siz > LONG_MAX) { + rb_raise(rb_eIOError, "file too big for single read"); + } + } } else { - siz += BUFSIZ; + siz += BUFSIZ; } return (long)siz; } @@ -2764,6 +3120,8 @@ io_enc_str(VALUE str, rb_io_t *fptr) return str; } +static rb_encoding *io_read_encoding(rb_io_t *fptr); + static void make_readconv(rb_io_t *fptr, int size) { @@ -2775,7 +3133,7 @@ make_readconv(rb_io_t *fptr, int size) ecopts = fptr->encs.ecopts; if (fptr->encs.enc2) { sname = rb_enc_name(fptr->encs.enc2); - dname = rb_enc_name(fptr->encs.enc); + dname = rb_enc_name(io_read_encoding(fptr)); } else { sname = dname = ""; @@ -2785,7 +3143,7 @@ make_readconv(rb_io_t *fptr, int size) rb_exc_raise(rb_econv_open_exc(sname, dname, ecflags)); fptr->cbuf.off = 0; fptr->cbuf.len = 0; - if (size < IO_CBUF_CAPA_MIN) size = IO_CBUF_CAPA_MIN; + if (size < IO_CBUF_CAPA_MIN) size = IO_CBUF_CAPA_MIN; fptr->cbuf.capa = size; fptr->cbuf.ptr = ALLOC_N(char, fptr->cbuf.capa); } @@ -2842,27 +3200,27 @@ fill_cbuf(rb_io_t *fptr, int ec_flags) if (res == econv_finished) { return MORE_CHAR_FINISHED; - } + } if (res == econv_source_buffer_empty) { if (fptr->rbuf.len == 0) { - READ_CHECK(fptr); + READ_CHECK(fptr); if (io_fillbuf(fptr) < 0) { - if (!fptr->readconv) { - return MORE_CHAR_FINISHED; - } + if (!fptr->readconv) { + return MORE_CHAR_FINISHED; + } ds = dp = (unsigned char *)fptr->cbuf.ptr + fptr->cbuf.off + fptr->cbuf.len; de = (unsigned char *)fptr->cbuf.ptr + fptr->cbuf.capa; res = rb_econv_convert(fptr->readconv, NULL, NULL, &dp, de, 0); fptr->cbuf.len += (int)(dp - ds); rb_econv_check_error(fptr->readconv); - break; + break; } } } } if (cbuf_len0 != fptr->cbuf.len) - return MORE_CHAR_SUSPENDED; + return MORE_CHAR_SUSPENDED; return MORE_CHAR_FINISHED; } @@ -2882,14 +3240,14 @@ io_shift_cbuf(rb_io_t *fptr, int len, VALUE *strp) { VALUE str = Qnil; if (strp) { - str = *strp; - if (NIL_P(str)) { - *strp = str = rb_str_new(fptr->cbuf.ptr+fptr->cbuf.off, len); - } - else { - rb_str_cat(str, fptr->cbuf.ptr+fptr->cbuf.off, len); - } - rb_enc_associate(str, fptr->encs.enc); + str = *strp; + if (NIL_P(str)) { + *strp = str = rb_str_new(fptr->cbuf.ptr+fptr->cbuf.off, len); + } + else { + rb_str_cat(str, fptr->cbuf.ptr+fptr->cbuf.off, len); + } + rb_enc_associate(str, fptr->encs.enc); } fptr->cbuf.off += len; fptr->cbuf.len -= len; @@ -2907,22 +3265,26 @@ static int io_setstrbuf(VALUE *str, long len) { #ifdef _WIN32 - len = (len + 1) & ~1L; /* round up for wide char */ + if (len > 0) + len = (len + 1) & ~1L; /* round up for wide char */ #endif if (NIL_P(*str)) { - *str = rb_str_new(0, len); - return TRUE; + *str = rb_str_new(0, len); + return TRUE; } else { - VALUE s = StringValue(*str); - long clen = RSTRING_LEN(s); - if (clen >= len) { - rb_str_modify(s); - return FALSE; - } - len -= clen; - } - rb_str_modify_expand(*str, len); + VALUE s = StringValue(*str); + rb_str_modify(s); + + long clen = RSTRING_LEN(s); + if (clen >= len) { + return FALSE; + } + len -= clen; + } + if ((rb_str_capacity(*str) - (size_t)RSTRING_LEN(*str)) < (size_t)len) { + rb_str_modify_expand(*str, len); + } return FALSE; } @@ -2931,7 +3293,7 @@ static void io_shrink_read_string(VALUE str, long n) { if (rb_str_capacity(str) - n > MAX_REALLOC_GAP) { - rb_str_resize(str, n); + rb_str_resize(str, n); } } @@ -2939,9 +3301,9 @@ static void io_set_read_length(VALUE str, long n, int shrinkable) { if (RSTRING_LEN(str) != n) { - rb_str_modify(str); - rb_str_set_len(str, n); - if (shrinkable) io_shrink_read_string(str, n); + rb_str_modify(str); + rb_str_set_len(str, n); + if (shrinkable) io_shrink_read_string(str, n); } } @@ -2956,28 +3318,28 @@ read_all(rb_io_t *fptr, long siz, VALUE str) int shrinkable; if (NEED_READCONV(fptr)) { - int first = !NIL_P(str); - SET_BINARY_MODE(fptr); - shrinkable = io_setstrbuf(&str,0); + int first = !NIL_P(str); + SET_BINARY_MODE(fptr); + shrinkable = io_setstrbuf(&str,0); make_readconv(fptr, 0); while (1) { VALUE v; if (fptr->cbuf.len) { - if (first) rb_str_set_len(str, first = 0); + if (first) rb_str_set_len(str, first = 0); io_shift_cbuf(fptr, fptr->cbuf.len, &str); } v = fill_cbuf(fptr, 0); if (v != MORE_CHAR_SUSPENDED && v != MORE_CHAR_FINISHED) { if (fptr->cbuf.len) { - if (first) rb_str_set_len(str, first = 0); + if (first) rb_str_set_len(str, first = 0); io_shift_cbuf(fptr, fptr->cbuf.len, &str); } rb_exc_raise(v); } if (v == MORE_CHAR_FINISHED) { clear_readconv(fptr); - if (first) rb_str_set_len(str, first = 0); - if (shrinkable) io_shrink_read_string(str, RSTRING_LEN(str)); + if (first) rb_str_set_len(str, first = 0); + if (shrinkable) io_shrink_read_string(str, RSTRING_LEN(str)); return io_enc_str(str, fptr); } } @@ -2993,19 +3355,29 @@ read_all(rb_io_t *fptr, long siz, VALUE str) if (siz == 0) siz = BUFSIZ; shrinkable = io_setstrbuf(&str, siz); for (;;) { - READ_CHECK(fptr); - n = io_fread(str, bytes, siz - bytes, fptr); - if (n == 0 && bytes == 0) { - rb_str_set_len(str, 0); - break; - } - bytes += n; - rb_str_set_len(str, bytes); - if (cr != ENC_CODERANGE_BROKEN) - pos += rb_str_coderange_scan_restartable(RSTRING_PTR(str) + pos, RSTRING_PTR(str) + bytes, enc, &cr); - if (bytes < siz) break; - siz += BUFSIZ; - rb_str_modify_expand(str, BUFSIZ); + READ_CHECK(fptr); + n = io_fread(str, bytes, siz - bytes, fptr); + if (n == 0 && bytes == 0) { + rb_str_set_len(str, 0); + break; + } + bytes += n; + rb_str_set_len(str, bytes); + if (cr != ENC_CODERANGE_BROKEN) + pos += rb_str_coderange_scan_restartable(RSTRING_PTR(str) + pos, RSTRING_PTR(str) + bytes, enc, &cr); + if (bytes < siz) break; + siz += BUFSIZ; + + size_t capa = rb_str_capacity(str); + if (capa < (size_t)RSTRING_LEN(str) + BUFSIZ) { + if (capa < BUFSIZ) { + capa = BUFSIZ; + } + else if (capa > IO_MAX_BUFFER_GROWTH) { + capa = IO_MAX_BUFFER_GROWTH; + } + rb_str_modify_expand(str, capa); + } } if (shrinkable) io_shrink_read_string(str, RSTRING_LEN(str)); str = io_enc_str(str, fptr); @@ -3017,22 +3389,37 @@ void rb_io_set_nonblock(rb_io_t *fptr) { if (rb_fd_set_nonblock(fptr->fd) != 0) { - rb_sys_fail_path(fptr->pathv); + rb_sys_fail_path(fptr->pathv); } } static VALUE -read_internal_call(VALUE arg) +io_read_memory_call(VALUE arg) { struct io_internal_read_struct *iis = (struct io_internal_read_struct *)arg; - return rb_thread_io_blocking_region(internal_read_func, iis, iis->fd); + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + VALUE result = rb_fiber_scheduler_io_read_memory(scheduler, iis->fptr->self, iis->buf, iis->capa, 0); + + if (!UNDEF_P(result)) { + // This is actually returned as a pseudo-VALUE and later cast to a long: + return (VALUE)rb_fiber_scheduler_io_result_apply(result); + } + } + + if (iis->nonblock) { + return rb_thread_io_blocking_call(internal_read_func, iis, iis->fptr->fd, 0); + } + else { + return rb_thread_io_blocking_call(internal_read_func, iis, iis->fptr->fd, RB_WAITFD_IN); + } } static long -read_internal_locktmp(VALUE str, struct io_internal_read_struct *iis) +io_read_memory_locktmp(VALUE str, struct io_internal_read_struct *iis) { - return (long)rb_str_locktmp_ensure(str, read_internal_call, (VALUE)iis); + return (long)rb_str_locktmp_ensure(str, io_read_memory_call, (VALUE)iis); } #define no_exception_p(opts) !rb_opts_exception_p((opts), TRUE) @@ -3049,7 +3436,7 @@ io_getpartial(int argc, VALUE *argv, VALUE io, int no_exception, int nonblock) rb_scan_args(argc, argv, "11", &length, &str); if ((len = NUM2LONG(length)) < 0) { - rb_raise(rb_eArgError, "negative length %ld given", len); + rb_raise(rb_eArgError, "negative length %ld given", len); } shrinkable = io_setstrbuf(&str, len); @@ -3057,8 +3444,10 @@ io_getpartial(int argc, VALUE *argv, VALUE io, int no_exception, int nonblock) GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); - if (len == 0) - return str; + if (len == 0) { + io_set_read_length(str, 0, shrinkable); + return str; + } if (!nonblock) READ_CHECK(fptr); @@ -3068,23 +3457,25 @@ io_getpartial(int argc, VALUE *argv, VALUE io, int no_exception, int nonblock) if (nonblock) { rb_io_set_nonblock(fptr); } - io_setstrbuf(&str, len); + io_setstrbuf(&str, len); iis.th = rb_thread_current(); - iis.fd = fptr->fd; + iis.fptr = fptr; iis.nonblock = nonblock; + iis.fd = fptr->fd; iis.buf = RSTRING_PTR(str); iis.capa = len; - n = read_internal_locktmp(str, &iis); + iis.timeout = NULL; + n = io_read_memory_locktmp(str, &iis); if (n < 0) { - int e = errno; + int e = errno; if (!nonblock && fptr_wait_readable(fptr)) goto again; - if (nonblock && (e == EWOULDBLOCK || e == EAGAIN)) { + if (nonblock && (io_again_p(e))) { if (no_exception) return sym_wait_readable; else - rb_readwrite_syserr_fail(RB_IO_WAIT_READABLE, - e, "read would block"); + rb_readwrite_syserr_fail(RB_IO_WAIT_READABLE, + e, "read would block"); } rb_syserr_fail_path(e, fptr->pathv); } @@ -3099,67 +3490,94 @@ io_getpartial(int argc, VALUE *argv, VALUE io, int no_exception, int nonblock) /* * call-seq: - * ios.readpartial(maxlen) -> string - * ios.readpartial(maxlen, outbuf) -> outbuf + * readpartial(maxlen) -> string + * readpartial(maxlen, out_string) -> out_string * - * Reads at most <i>maxlen</i> bytes from the I/O stream. - * It blocks only if <em>ios</em> has no data immediately available. - * It doesn't block if some data available. + * Reads up to +maxlen+ bytes from the stream; + * returns a string (either a new string or the given +out_string+). + * Its encoding is: * - * If the optional _outbuf_ argument is present, - * it must reference a String, which will receive the data. - * The _outbuf_ will contain only the received data after the method call - * even if it is not empty at the beginning. + * - The unchanged encoding of +out_string+, if +out_string+ is given. + * - ASCII-8BIT, otherwise. * - * It raises EOFError on end of file. - * - * readpartial is designed for streams such as pipe, socket, tty, etc. - * It blocks only when no data immediately available. - * This means that it blocks only when following all conditions hold. - * * the byte buffer in the IO object is empty. - * * the content of the stream is empty. - * * the stream is not reached to EOF. - * - * When readpartial blocks, it waits data or EOF on the stream. - * If some data is reached, readpartial returns with the data. - * If EOF is reached, readpartial raises EOFError. - * - * When readpartial doesn't blocks, it returns or raises immediately. - * If the byte buffer is not empty, it returns the data in the buffer. - * Otherwise if the stream has some content, - * it returns the data in the stream. - * Otherwise if the stream is reached to EOF, it raises EOFError. - * - * r, w = IO.pipe # buffer pipe content - * w << "abc" # "" "abc". - * r.readpartial(4096) #=> "abc" "" "" - * r.readpartial(4096) # blocks because buffer and pipe is empty. - * - * r, w = IO.pipe # buffer pipe content - * w << "abc" # "" "abc" - * w.close # "" "abc" EOF - * r.readpartial(4096) #=> "abc" "" EOF - * r.readpartial(4096) # raises EOFError + * - Contains +maxlen+ bytes from the stream, if available. + * - Otherwise contains all available bytes, if any available. + * - Otherwise is an empty string. + * + * With the single non-negative integer argument +maxlen+ given, + * returns a new string: + * + * f = File.new('t.txt') + * f.readpartial(20) # => "First line\nSecond l" + * f.readpartial(20) # => "ine\n\nFourth line\n" + * f.readpartial(20) # => "Fifth line\n" + * f.readpartial(20) # Raises EOFError. + * f.close + * + * With both argument +maxlen+ and string argument +out_string+ given, + * returns modified +out_string+: + * + * f = File.new('t.txt') + * s = 'foo' + * f.readpartial(20, s) # => "First line\nSecond l" + * s = 'bar' + * f.readpartial(0, s) # => "" + * f.close * - * r, w = IO.pipe # buffer pipe content - * w << "abc\ndef\n" # "" "abc\ndef\n" - * r.gets #=> "abc\n" "def\n" "" - * w << "ghi\n" # "def\n" "ghi\n" - * r.readpartial(4096) #=> "def\n" "" "ghi\n" - * r.readpartial(4096) #=> "ghi\n" "" "" + * This method is useful for a stream such as a pipe, a socket, or a tty. + * It blocks only when no data is immediately available. + * This means that it blocks only when _all_ of the following are true: * - * Note that readpartial behaves similar to sysread. - * The differences are: - * * If the byte buffer is not empty, read from the byte buffer + * - The byte buffer in the stream is empty. + * - The content of the stream is empty. + * - The stream is not at EOF. + * + * When blocked, the method waits for either more data or EOF on the stream: + * + * - If more data is read, the method returns the data. + * - If EOF is reached, the method raises EOFError. + * + * When not blocked, the method responds immediately: + * + * - Returns data from the buffer if there is any. + * - Otherwise returns data from the stream if there is any. + * - Otherwise raises EOFError if the stream has reached EOF. + * + * Note that this method is similar to sysread. The differences are: + * + * - If the byte buffer is not empty, read from the byte buffer * instead of "sysread for buffered IO (IOError)". - * * It doesn't cause Errno::EWOULDBLOCK and Errno::EINTR. When + * - It doesn't cause Errno::EWOULDBLOCK and Errno::EINTR. When * readpartial meets EWOULDBLOCK and EINTR by read system call, - * readpartial retry the system call. + * readpartial retries the system call. * - * The latter means that readpartial is nonblocking-flag insensitive. + * The latter means that readpartial is non-blocking-flag insensitive. * It blocks on the situation IO#sysread causes Errno::EWOULDBLOCK as * if the fd is blocking mode. * + * Examples: + * + * # # Returned Buffer Content Pipe Content + * r, w = IO.pipe # + * w << 'abc' # "" "abc". + * r.readpartial(4096) # => "abc" "" "" + * r.readpartial(4096) # (Blocks because buffer and pipe are empty.) + * + * # # Returned Buffer Content Pipe Content + * r, w = IO.pipe # + * w << 'abc' # "" "abc" + * w.close # "" "abc" EOF + * r.readpartial(4096) # => "abc" "" EOF + * r.readpartial(4096) # raises EOFError + * + * # # Returned Buffer Content Pipe Content + * r, w = IO.pipe # + * w << "abc\ndef\n" # "" "abc\ndef\n" + * r.gets # => "abc\n" "def\n" "" + * w << "ghi\n" # "def\n" "ghi\n" + * r.readpartial(4096) # => "def\n" "" "ghi\n" + * r.readpartial(4096) # => "ghi\n" "" "" + * */ static VALUE @@ -3192,33 +3610,37 @@ io_read_nonblock(rb_execution_context_t *ec, VALUE io, VALUE length, VALUE str, int shrinkable; if ((len = NUM2LONG(length)) < 0) { - rb_raise(rb_eArgError, "negative length %ld given", len); + rb_raise(rb_eArgError, "negative length %ld given", len); } shrinkable = io_setstrbuf(&str, len); - rb_bool_expected(ex, "exception"); + rb_bool_expected(ex, "exception", TRUE); GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); - if (len == 0) - return str; + if (len == 0) { + io_set_read_length(str, 0, shrinkable); + return str; + } n = read_buffered_data(RSTRING_PTR(str), len, fptr); if (n <= 0) { - rb_io_set_nonblock(fptr); - shrinkable |= io_setstrbuf(&str, len); - iis.fd = fptr->fd; + rb_fd_set_nonblock(fptr->fd); + shrinkable |= io_setstrbuf(&str, len); + iis.fptr = fptr; iis.nonblock = 1; + iis.fd = fptr->fd; iis.buf = RSTRING_PTR(str); iis.capa = len; - n = read_internal_locktmp(str, &iis); + iis.timeout = NULL; + n = io_read_memory_locktmp(str, &iis); if (n < 0) { - int e = errno; - if ((e == EWOULDBLOCK || e == EAGAIN)) { + int e = errno; + if (io_again_p(e)) { if (!ex) return sym_wait_readable; - rb_readwrite_syserr_fail(RB_IO_WAIT_READABLE, - e, "read would block"); + rb_readwrite_syserr_fail(RB_IO_WAIT_READABLE, + e, "read would block"); } rb_syserr_fail_path(e, fptr->pathv); } @@ -3227,7 +3649,7 @@ io_read_nonblock(rb_execution_context_t *ec, VALUE io, VALUE length, VALUE str, if (n == 0) { if (!ex) return Qnil; - rb_eof_error(); + rb_eof_error(); } return str; @@ -3241,8 +3663,8 @@ io_write_nonblock(rb_execution_context_t *ec, VALUE io, VALUE str, VALUE ex) long n; if (!RB_TYPE_P(str, T_STRING)) - str = rb_obj_as_string(str); - rb_bool_expected(ex, "exception"); + str = rb_obj_as_string(str); + rb_bool_expected(ex, "exception", TRUE); io = GetWriteIO(io); GetOpenFile(io, fptr); @@ -3251,21 +3673,21 @@ io_write_nonblock(rb_execution_context_t *ec, VALUE io, VALUE str, VALUE ex) if (io_fflush(fptr) < 0) rb_sys_fail_on_write(fptr); - rb_io_set_nonblock(fptr); + rb_fd_set_nonblock(fptr->fd); n = write(fptr->fd, RSTRING_PTR(str), RSTRING_LEN(str)); RB_GC_GUARD(str); if (n < 0) { - int e = errno; - if (e == EWOULDBLOCK || e == EAGAIN) { + int e = errno; + if (io_again_p(e)) { if (!ex) { - return sym_wait_writable; - } - else { - rb_readwrite_syserr_fail(RB_IO_WAIT_WRITABLE, e, "write would block"); - } - } - rb_syserr_fail_path(e, fptr->pathv); + return sym_wait_writable; + } + else { + rb_readwrite_syserr_fail(RB_IO_WAIT_WRITABLE, e, "write would block"); + } + } + rb_syserr_fail_path(e, fptr->pathv); } return LONG2FIX(n); @@ -3273,69 +3695,73 @@ io_write_nonblock(rb_execution_context_t *ec, VALUE io, VALUE str, VALUE ex) /* * call-seq: - * ios.read([length [, outbuf]]) -> string, outbuf, or nil + * read(maxlen = nil, out_string = nil) -> new_string, out_string, or nil * - * Reads _length_ bytes from the I/O stream. + * Reads bytes from the stream; the stream must be opened for reading + * (see {Access Modes}[rdoc-ref:File@Access+Modes]): * - * _length_ must be a non-negative integer or +nil+. + * - If +maxlen+ is +nil+, reads all bytes using the stream's data mode. + * - Otherwise reads up to +maxlen+ bytes in binary mode. * - * If _length_ is a positive integer, +read+ tries to read - * _length_ bytes without any conversion (binary mode). - * It returns +nil+ if an EOF is encountered before anything can be read. - * Fewer than _length_ bytes are returned if an EOF is encountered during - * the read. - * In the case of an integer _length_, the resulting string is always - * in ASCII-8BIT encoding. + * Returns a string (either a new string or the given +out_string+) + * containing the bytes read. + * The encoding of the string depends on both +maxLen+ and +out_string+: * - * If _length_ is omitted or is +nil+, it reads until EOF - * and the encoding conversion is applied, if applicable. - * A string is returned even if EOF is encountered before any data is read. + * - +maxlen+ is +nil+: uses internal encoding of +self+ + * (regardless of whether +out_string+ was given). + * - +maxlen+ not +nil+: * - * If _length_ is zero, it returns an empty string (<code>""</code>). + * - +out_string+ given: encoding of +out_string+ not modified. + * - +out_string+ not given: ASCII-8BIT is used. * - * If the optional _outbuf_ argument is present, - * it must reference a String, which will receive the data. - * The _outbuf_ will contain only the received data after the method call - * even if it is not empty at the beginning. + * <b>Without Argument +out_string+</b> * - * When this method is called at end of file, it returns +nil+ - * or <code>""</code>, depending on _length_: - * +read+, <code>read(nil)</code>, and <code>read(0)</code> return - * <code>""</code>, - * <code>read(<i>positive_integer</i>)</code> returns +nil+. + * When argument +out_string+ is omitted, + * the returned value is a new string: * - * f = File.new("testfile") - * f.read(16) #=> "This is line one" + * f = File.new('t.txt') + * f.read + * # => "First line\nSecond line\n\nFourth line\nFifth line\n" + * f.rewind + * f.read(30) # => "First line\r\nSecond line\r\n\r\nFou" + * f.read(30) # => "rth line\r\nFifth line\r\n" + * f.read(30) # => nil + * f.close * - * # read whole file - * open("file") do |f| - * data = f.read # This returns a string even if the file is empty. - * # ... - * end + * If +maxlen+ is zero, returns an empty string. * - * # iterate over fixed length records - * open("fixed-record-file") do |f| - * while record = f.read(256) - * # ... - * end - * end + * <b> With Argument +out_string+</b> * - * # iterate over variable length records, - * # each record is prefixed by its 32-bit length - * open("variable-record-file") do |f| - * while len = f.read(4) - * len = len.unpack1("N") # 32-bit length - * record = f.read(len) # This returns a string even if len is 0. - * end - * end + * When argument +out_string+ is given, + * the returned value is +out_string+, whose content is replaced: + * + * f = File.new('t.txt') + * s = 'foo' # => "foo" + * f.read(nil, s) # => "First line\nSecond line\n\nFourth line\nFifth line\n" + * s # => "First line\nSecond line\n\nFourth line\nFifth line\n" + * f.rewind + * s = 'bar' + * f.read(30, s) # => "First line\r\nSecond line\r\n\r\nFou" + * s # => "First line\r\nSecond line\r\n\r\nFou" + * s = 'baz' + * f.read(30, s) # => "rth line\r\nFifth line\r\n" + * s # => "rth line\r\nFifth line\r\n" + * s = 'bat' + * f.read(30, s) # => nil + * s # => "" + * f.close * * Note that this method behaves like the fread() function in C. * This means it retries to invoke read(2) system calls to read data - * with the specified length (or until EOF). - * This behavior is preserved even if <i>ios</i> is in non-blocking mode. - * (This method is non-blocking flag insensitive as other methods.) + * with the specified maxlen (or until EOF). + * + * This behavior is preserved even if the stream is in non-blocking mode. + * (This method is non-blocking-flag insensitive as other methods.) + * * If you need the behavior like a single read(2) system call, * consider #readpartial, #read_nonblock, and #sysread. + * + * Related: IO#write. */ static VALUE @@ -3352,13 +3778,13 @@ io_read(int argc, VALUE *argv, VALUE io) rb_scan_args(argc, argv, "02", &length, &str); if (NIL_P(length)) { - GetOpenFile(io, fptr); - rb_io_check_char_readable(fptr); - return read_all(fptr, remain_size(fptr), str); + GetOpenFile(io, fptr); + rb_io_check_char_readable(fptr); + return read_all(fptr, remain_size(fptr), str); } len = NUM2LONG(length); if (len < 0) { - rb_raise(rb_eArgError, "negative length %ld given", len); + rb_raise(rb_eArgError, "negative length %ld given", len); } shrinkable = io_setstrbuf(&str,len); @@ -3366,8 +3792,8 @@ io_read(int argc, VALUE *argv, VALUE io) GetOpenFile(io, fptr); rb_io_check_byte_readable(fptr); if (len == 0) { - io_set_read_length(str, 0, shrinkable); - return str; + io_set_read_length(str, 0, shrinkable); + return str; } READ_CHECK(fptr); @@ -3378,7 +3804,7 @@ io_read(int argc, VALUE *argv, VALUE io) io_set_read_length(str, n, shrinkable); #if RUBY_CRLF_ENVIRONMENT if (previous_mode == O_TEXT) { - setmode(fptr->fd, O_TEXT); + setmode(fptr->fd, O_TEXT); } #endif if (n == 0) return Qnil; @@ -3391,7 +3817,7 @@ rscheck(const char *rsptr, long rslen, VALUE rs) { if (!rs) return; if (RSTRING_PTR(rs) != rsptr && RSTRING_LEN(rs) != rslen) - rb_raise(rb_eRuntimeError, "rs modified"); + rb_raise(rb_eRuntimeError, "rs modified"); } static int @@ -3401,7 +3827,7 @@ appendline(rb_io_t *fptr, int delim, VALUE *strp, long *lp) long limit = *lp; if (NEED_READCONV(fptr)) { - SET_BINARY_MODE(fptr); + SET_BINARY_MODE(fptr); make_readconv(fptr, 0); do { const char *p, *e; @@ -3412,7 +3838,7 @@ appendline(rb_io_t *fptr, int delim, VALUE *strp, long *lp) searchlen = (int)limit; e = memchr(p, delim, searchlen); if (e) { - int len = (int)(e-p+1); + int len = (int)(e-p+1); if (NIL_P(str)) *strp = str = rb_str_new(p, len); else @@ -3445,32 +3871,32 @@ appendline(rb_io_t *fptr, int delim, VALUE *strp, long *lp) NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); do { - long pending = READ_DATA_PENDING_COUNT(fptr); - if (pending > 0) { - const char *p = READ_DATA_PENDING_PTR(fptr); - const char *e; - long last; - - if (limit > 0 && pending > limit) pending = limit; - e = memchr(p, delim, pending); - if (e) pending = e - p + 1; - if (!NIL_P(str)) { - last = RSTRING_LEN(str); - rb_str_resize(str, last + pending); - } - else { + long pending = READ_DATA_PENDING_COUNT(fptr); + if (pending > 0) { + const char *p = READ_DATA_PENDING_PTR(fptr); + const char *e; + long last; + + if (limit > 0 && pending > limit) pending = limit; + e = memchr(p, delim, pending); + if (e) pending = e - p + 1; + if (!NIL_P(str)) { + last = RSTRING_LEN(str); + rb_str_resize(str, last + pending); + } + else { last = 0; - *strp = str = rb_str_buf_new(pending); - rb_str_set_len(str, pending); - } - read_buffered_data(RSTRING_PTR(str) + last, pending, fptr); /* must not fail */ - limit -= pending; - *lp = limit; - if (e) return delim; - if (limit == 0) - return (unsigned char)RSTRING_PTR(str)[RSTRING_LEN(str)-1]; - } - READ_CHECK(fptr); + *strp = str = rb_str_buf_new(pending); + rb_str_set_len(str, pending); + } + read_buffered_data(RSTRING_PTR(str) + last, pending, fptr); /* must not fail */ + limit -= pending; + *lp = limit; + if (e) return delim; + if (limit == 0) + return (unsigned char)RSTRING_PTR(str)[RSTRING_LEN(str)-1]; + } + READ_CHECK(fptr); } while (io_fillbuf(fptr) >= 0); *lp = limit; return EOF; @@ -3480,47 +3906,47 @@ static inline int swallow(rb_io_t *fptr, int term) { if (NEED_READCONV(fptr)) { - rb_encoding *enc = io_read_encoding(fptr); - int needconv = rb_enc_mbminlen(enc) != 1; - SET_BINARY_MODE(fptr); - make_readconv(fptr, 0); - do { - size_t cnt; - while ((cnt = READ_CHAR_PENDING_COUNT(fptr)) > 0) { - const char *p = READ_CHAR_PENDING_PTR(fptr); - int i; - if (!needconv) { - if (*p != term) return TRUE; - i = (int)cnt; - while (--i && *++p == term); - } - else { - const char *e = p + cnt; - if (rb_enc_ascget(p, e, &i, enc) != term) return TRUE; - while ((p += i) < e && rb_enc_ascget(p, e, &i, enc) == term); - i = (int)(e - p); - } - io_shift_cbuf(fptr, (int)cnt - i, NULL); - } - } while (more_char(fptr) != MORE_CHAR_FINISHED); - return FALSE; + rb_encoding *enc = io_read_encoding(fptr); + int needconv = rb_enc_mbminlen(enc) != 1; + SET_BINARY_MODE(fptr); + make_readconv(fptr, 0); + do { + size_t cnt; + while ((cnt = READ_CHAR_PENDING_COUNT(fptr)) > 0) { + const char *p = READ_CHAR_PENDING_PTR(fptr); + int i; + if (!needconv) { + if (*p != term) return TRUE; + i = (int)cnt; + while (--i && *++p == term); + } + else { + const char *e = p + cnt; + if (rb_enc_ascget(p, e, &i, enc) != term) return TRUE; + while ((p += i) < e && rb_enc_ascget(p, e, &i, enc) == term); + i = (int)(e - p); + } + io_shift_cbuf(fptr, (int)cnt - i, NULL); + } + } while (more_char(fptr) != MORE_CHAR_FINISHED); + return FALSE; } NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); do { - size_t cnt; - while ((cnt = READ_DATA_PENDING_COUNT(fptr)) > 0) { - char buf[1024]; - const char *p = READ_DATA_PENDING_PTR(fptr); - int i; - if (cnt > sizeof buf) cnt = sizeof buf; - if (*p != term) return TRUE; - i = (int)cnt; - while (--i && *++p == term); - if (!read_buffered_data(buf, cnt - i, fptr)) /* must not fail */ - rb_sys_fail_path(fptr->pathv); - } - READ_CHECK(fptr); + size_t cnt; + while ((cnt = READ_DATA_PENDING_COUNT(fptr)) > 0) { + char buf[1024]; + const char *p = READ_DATA_PENDING_PTR(fptr); + int i; + if (cnt > sizeof buf) cnt = sizeof buf; + if (*p != term) return TRUE; + i = (int)cnt; + while (--i && *++p == term); + if (!read_buffered_data(buf, cnt - i, fptr)) /* must not fail */ + rb_sys_fail_path(fptr->pathv); + } + READ_CHECK(fptr); } while (io_fillbuf(fptr) == 0); return FALSE; } @@ -3534,43 +3960,43 @@ rb_io_getline_fast(rb_io_t *fptr, rb_encoding *enc, int chomp) int cr = 0; do { - int pending = READ_DATA_PENDING_COUNT(fptr); + int pending = READ_DATA_PENDING_COUNT(fptr); - if (pending > 0) { - const char *p = READ_DATA_PENDING_PTR(fptr); - const char *e; - int chomplen = 0; + if (pending > 0) { + const char *p = READ_DATA_PENDING_PTR(fptr); + const char *e; + int chomplen = 0; - e = memchr(p, '\n', pending); - if (e) { + e = memchr(p, '\n', pending); + if (e) { pending = (int)(e - p + 1); - if (chomp) { - chomplen = (pending > 1 && *(e-1) == '\r') + 1; - } - } - if (NIL_P(str)) { - str = rb_str_new(p, pending - chomplen); - fptr->rbuf.off += pending; - fptr->rbuf.len -= pending; - } - else { - rb_str_resize(str, len + pending - chomplen); - read_buffered_data(RSTRING_PTR(str)+len, pending - chomplen, fptr); - fptr->rbuf.off += chomplen; - fptr->rbuf.len -= chomplen; + if (chomp) { + chomplen = (pending > 1 && *(e-1) == '\r') + 1; + } + } + if (NIL_P(str)) { + str = rb_str_new(p, pending - chomplen); + fptr->rbuf.off += pending; + fptr->rbuf.len -= pending; + } + else { + rb_str_resize(str, len + pending - chomplen); + read_buffered_data(RSTRING_PTR(str)+len, pending - chomplen, fptr); + fptr->rbuf.off += chomplen; + fptr->rbuf.len -= chomplen; if (pending == 1 && chomplen == 1 && len > 0) { if (RSTRING_PTR(str)[len-1] == '\r') { rb_str_resize(str, --len); break; } } - } - len += pending - chomplen; - if (cr != ENC_CODERANGE_BROKEN) - pos += rb_str_coderange_scan_restartable(RSTRING_PTR(str) + pos, RSTRING_PTR(str) + len, enc, &cr); - if (e) break; - } - READ_CHECK(fptr); + } + len += pending - chomplen; + if (cr != ENC_CODERANGE_BROKEN) + pos += rb_str_coderange_scan_restartable(RSTRING_PTR(str) + pos, RSTRING_PTR(str) + len, enc, &cr); + if (e) break; + } + READ_CHECK(fptr); } while (io_fillbuf(fptr) >= 0); if (NIL_P(str)) return Qnil; @@ -3593,13 +4019,13 @@ extract_getline_opts(VALUE opts, struct getline_arg *args) { int chomp = FALSE; if (!NIL_P(opts)) { - static ID kwds[1]; - VALUE vchomp; - if (!kwds[0]) { - kwds[0] = rb_intern_const("chomp"); - } - rb_get_kwargs(opts, kwds, 0, -2, &vchomp); - chomp = (vchomp != Qundef) && RTEST(vchomp); + static ID kwds[1]; + VALUE vchomp; + if (!kwds[0]) { + kwds[0] = rb_intern_const("chomp"); + } + rb_get_kwargs(opts, kwds, 0, -2, &vchomp); + chomp = (!UNDEF_P(vchomp)) && RTEST(vchomp); } args->chomp = chomp; } @@ -3620,7 +4046,7 @@ extract_getline_args(int argc, VALUE *argv, struct getline_arg *args) } } else if (2 <= argc) { - rs = argv[0], lim = argv[1]; + rs = argv[0], lim = argv[1]; if (!NIL_P(rs)) StringValue(rs); } @@ -3635,25 +4061,25 @@ check_getline_args(VALUE *rsp, long *limit, VALUE io) VALUE rs = *rsp; if (!NIL_P(rs)) { - rb_encoding *enc_rs, *enc_io; - - GetOpenFile(io, fptr); - enc_rs = rb_enc_get(rs); - enc_io = io_read_encoding(fptr); - if (enc_io != enc_rs && - (rb_enc_str_coderange(rs) != ENC_CODERANGE_7BIT || - (RSTRING_LEN(rs) > 0 && !rb_enc_asciicompat(enc_io)))) { + rb_encoding *enc_rs, *enc_io; + + GetOpenFile(io, fptr); + enc_rs = rb_enc_get(rs); + enc_io = io_read_encoding(fptr); + if (enc_io != enc_rs && + (!is_ascii_string(rs) || + (RSTRING_LEN(rs) > 0 && !rb_enc_asciicompat(enc_io)))) { if (rs == rb_default_rs) { rs = rb_enc_str_new(0, 0, enc_io); rb_str_buf_cat_ascii(rs, "\n"); - *rsp = rs; + *rsp = rs; } else { rb_raise(rb_eArgError, "encoding mismatch: %s IO with %s RS", rb_enc_name(enc_io), rb_enc_name(enc_rs)); } - } + } } } @@ -3676,76 +4102,74 @@ rb_io_getline_0(VALUE rs, long limit, int chomp, rb_io_t *fptr) rb_io_check_char_readable(fptr); if (NIL_P(rs) && limit < 0) { - str = read_all(fptr, 0, Qnil); - if (RSTRING_LEN(str) == 0) return Qnil; - if (chomp) rb_str_chomp_string(str, rb_default_rs); + str = read_all(fptr, 0, Qnil); + if (RSTRING_LEN(str) == 0) return Qnil; } else if (limit == 0) { - return rb_enc_str_new(0, 0, io_read_encoding(fptr)); + return rb_enc_str_new(0, 0, io_read_encoding(fptr)); } else if (rs == rb_default_rs && limit < 0 && !NEED_READCONV(fptr) && rb_enc_asciicompat(enc = io_read_encoding(fptr))) { - NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); - return rb_io_getline_fast(fptr, enc, chomp); + NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); + return rb_io_getline_fast(fptr, enc, chomp); } else { - int c, newline = -1; - const char *rsptr = 0; - long rslen = 0; - int rspara = 0; + int c, newline = -1; + const char *rsptr = 0; + long rslen = 0; + int rspara = 0; int extra_limit = 16; - int chomp_cr = chomp; + int chomp_cr = chomp; - SET_BINARY_MODE(fptr); + SET_BINARY_MODE(fptr); enc = io_read_encoding(fptr); - if (!NIL_P(rs)) { - rslen = RSTRING_LEN(rs); - if (rslen == 0) { - rsptr = "\n\n"; - rslen = 2; - rspara = 1; - swallow(fptr, '\n'); - rs = 0; - if (!rb_enc_asciicompat(enc)) { - rs = rb_usascii_str_new(rsptr, rslen); - rs = rb_str_encode(rs, rb_enc_from_encoding(enc), 0, Qnil); - OBJ_FREEZE(rs); - rsptr = RSTRING_PTR(rs); - rslen = RSTRING_LEN(rs); - } - } - else { - rsptr = RSTRING_PTR(rs); - } - newline = (unsigned char)rsptr[rslen - 1]; - chomp_cr = chomp && rslen == 1 && newline == '\n'; - } - - /* MS - Optimization */ - while ((c = appendline(fptr, newline, &str, &limit)) != EOF) { + if (!NIL_P(rs)) { + rslen = RSTRING_LEN(rs); + if (rslen == 0) { + rsptr = "\n\n"; + rslen = 2; + rspara = 1; + swallow(fptr, '\n'); + rs = 0; + if (!rb_enc_asciicompat(enc)) { + rs = rb_usascii_str_new(rsptr, rslen); + rs = rb_str_encode(rs, rb_enc_from_encoding(enc), 0, Qnil); + OBJ_FREEZE(rs); + rsptr = RSTRING_PTR(rs); + rslen = RSTRING_LEN(rs); + } + } + else { + rsptr = RSTRING_PTR(rs); + } + newline = (unsigned char)rsptr[rslen - 1]; + chomp_cr = chomp && rslen == 1 && newline == '\n'; + } + + /* MS - Optimization */ + while ((c = appendline(fptr, newline, &str, &limit)) != EOF) { const char *s, *p, *pp, *e; - if (c == newline) { - if (RSTRING_LEN(str) < rslen) continue; - s = RSTRING_PTR(str); + if (c == newline) { + if (RSTRING_LEN(str) < rslen) continue; + s = RSTRING_PTR(str); e = RSTRING_END(str); - p = e - rslen; - pp = rb_enc_left_char_head(s, p, e, enc); - if (pp != p) continue; - if (!rspara) rscheck(rsptr, rslen, rs); - if (memcmp(p, rsptr, rslen) == 0) { - if (chomp) { - if (chomp_cr && p > s && *(p-1) == '\r') --p; - rb_str_set_len(str, p - s); - } - break; - } - } - if (limit == 0) { - s = RSTRING_PTR(str); - p = RSTRING_END(str); - pp = rb_enc_left_char_head(s, p-1, p, enc); + p = e - rslen; + if (!at_char_boundary(s, p, e, enc)) continue; + if (!rspara) rscheck(rsptr, rslen, rs); + if (memcmp(p, rsptr, rslen) == 0) { + if (chomp) { + if (chomp_cr && p > s && *(p-1) == '\r') --p; + rb_str_set_len(str, p - s); + } + break; + } + } + if (limit == 0) { + s = RSTRING_PTR(str); + p = RSTRING_END(str); + pp = rb_enc_left_char_head(s, p-1, p, enc); if (extra_limit && MBCLEN_NEEDMORE_P(rb_enc_precise_mbclen(pp, p, enc))) { /* relax the limit while incomplete character. @@ -3757,17 +4181,17 @@ rb_io_getline_0(VALUE rs, long limit, int chomp, rb_io_t *fptr) nolimit = 1; break; } - } - } + } + } - if (rspara && c != EOF) - swallow(fptr, '\n'); - if (!NIL_P(str)) + if (rspara && c != EOF) + swallow(fptr, '\n'); + if (!NIL_P(str)) str = io_enc_str(str, fptr); } if (!NIL_P(str) && !nolimit) { - fptr->lineno++; + fptr->lineno++; } return str; @@ -3784,13 +4208,13 @@ rb_io_getline_1(VALUE rs, long limit, int chomp, VALUE io) old_lineno = fptr->lineno; str = rb_io_getline_0(rs, limit, chomp, fptr); if (!NIL_P(str) && (new_lineno = fptr->lineno) != old_lineno) { - if (io == ARGF.current_file) { - ARGF.lineno += new_lineno - old_lineno; - ARGF.last_lineno = ARGF.lineno; - } - else { - ARGF.last_lineno = new_lineno; - } + if (io == ARGF.current_file) { + ARGF.lineno += new_lineno - old_lineno; + ARGF.last_lineno = ARGF.lineno; + } + else { + ARGF.last_lineno = new_lineno; + } } return str; @@ -3821,35 +4245,74 @@ rb_io_gets_internal(VALUE io) /* * call-seq: - * ios.gets(sep=$/ [, getline_args]) -> string or nil - * ios.gets(limit [, getline_args]) -> string or nil - * ios.gets(sep, limit [, getline_args]) -> string or nil + * gets(sep = $/, chomp: false) -> string or nil + * gets(limit, chomp: false) -> string or nil + * gets(sep, limit, chomp: false) -> string or nil + * + * Reads and returns a line from the stream; + * assigns the return value to <tt>$_</tt>. + * See {Line IO}[rdoc-ref:IO@Line+IO]. + * + * With no arguments given, returns the next line + * as determined by line separator <tt>$/</tt>, or +nil+ if none: * - * Reads the next ``line'' from the I/O stream; lines are separated by - * <i>sep</i>. A separator of +nil+ reads the entire - * contents, and a zero-length separator reads the input a paragraph at - * a time (two successive newlines in the input separate paragraphs). - * The stream must be opened for reading or an IOError will be raised. - * The line read in will be returned and also assigned to - * <code>$_</code>. Returns +nil+ if called at end of file. If the - * first argument is an integer, or optional second argument is given, - * the returning string would not be longer than the given value in - * bytes. + * f = File.open('t.txt') + * f.gets # => "First line\n" + * $_ # => "First line\n" + * f.gets # => "\n" + * f.gets # => "Fourth line\n" + * f.gets # => "Fifth line\n" + * f.gets # => nil + * f.close * - * File.new("testfile").gets #=> "This is line one\n" - * $_ #=> "This is line one\n" + * With only string argument +sep+ given, + * returns the next line as determined by line separator +sep+, + * or +nil+ if none; + * see {Line Separator}[rdoc-ref:IO@Line+Separator]: * - * File.new("testfile").gets(4)#=> "This" + * f = File.new('t.txt') + * f.gets('l') # => "First l" + * f.gets('li') # => "ine\nSecond li" + * f.gets('lin') # => "ne\n\nFourth lin" + * f.gets # => "e\n" + * f.close * - * If IO contains multibyte characters byte then <code>gets(1)</code> - * returns character entirely: + * The two special values for +sep+ are honored: + * + * f = File.new('t.txt') + * # Get all. + * f.gets(nil) # => "First line\nSecond line\n\nFourth line\nFifth line\n" + * f.rewind + * # Get paragraph (up to two line separators). + * f.gets('') # => "First line\nSecond line\n\n" + * f.close + * + * With only integer argument +limit+ given, + * limits the number of bytes in the line; + * see {Line Limit}[rdoc-ref:IO@Line+Limit]: + * + * # No more than one line. + * File.open('t.txt') {|f| f.gets(10) } # => "First line" + * File.open('t.txt') {|f| f.gets(11) } # => "First line\n" + * File.open('t.txt') {|f| f.gets(12) } # => "First line\n" + * + * With arguments +sep+ and +limit+ given, + * combines the two behaviors + * (see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit]). + * + * Optional keyword argument +chomp+ specifies whether line separators + * are to be omitted: + * + * f = File.open('t.txt') + * # Chomp the lines. + * f.gets(chomp: true) # => "First line" + * f.gets(chomp: true) # => "Second line" + * f.gets(chomp: true) # => "" + * f.gets(chomp: true) # => "Fourth line" + * f.gets(chomp: true) # => "Fifth line" + * f.gets(chomp: true) # => nil + * f.close * - * # Russian characters take 2 bytes - * File.write("testfile", "\u{442 435 441 442}") - * File.open("testfile") {|f|f.gets(1)} #=> "\u0442" - * File.open("testfile") {|f|f.gets(2)} #=> "\u0442" - * File.open("testfile") {|f|f.gets(3)} #=> "\u0442\u0435" - * File.open("testfile") {|f|f.gets(4)} #=> "\u0442\u0435" */ static VALUE @@ -3865,24 +4328,11 @@ rb_io_gets_m(int argc, VALUE *argv, VALUE io) /* * call-seq: - * ios.lineno -> integer - * - * Returns the current line number in <em>ios</em>. The stream must be - * opened for reading. #lineno counts the number of times #gets is called - * rather than the number of newlines encountered. The two values will - * differ if #gets is called with a separator other than newline. - * - * Methods that use <code>$/</code> like #each, #lines and #readline will - * also increment #lineno. + * lineno -> integer * - * See also the <code>$.</code> variable. + * Returns the current line number for the stream; + * see {Line Number}[rdoc-ref:IO@Line+Number]. * - * f = File.new("testfile") - * f.lineno #=> 0 - * f.gets #=> "This is line one\n" - * f.lineno #=> 1 - * f.gets #=> "This is line two\n" - * f.lineno #=> 2 */ static VALUE @@ -3897,19 +4347,11 @@ rb_io_lineno(VALUE io) /* * call-seq: - * ios.lineno = integer -> integer + * lineno = integer -> integer * - * Manually sets the current line number to the given value. - * <code>$.</code> is updated only on the next read. + * Sets and returns the line number for the stream; + * see {Line Number}[rdoc-ref:IO@Line+Number]. * - * f = File.new("testfile") - * f.gets #=> "This is line one\n" - * $. #=> 1 - * f.lineno = 1000 - * f.lineno #=> 1000 - * $. #=> 1 # lineno of last read - * f.gets #=> "This is line two\n" - * $. #=> 1001 # lineno of last read */ static VALUE @@ -3923,22 +4365,31 @@ rb_io_set_lineno(VALUE io, VALUE lineno) return lineno; } -/* - * call-seq: - * ios.readline(sep=$/ [, getline_args]) -> string - * ios.readline(limit [, getline_args]) -> string - * ios.readline(sep, limit [, getline_args]) -> string - * - * Reads a line as with IO#gets, but raises an EOFError on end of file. - */ - +/* :nodoc: */ static VALUE -rb_io_readline(int argc, VALUE *argv, VALUE io) -{ - VALUE line = rb_io_gets_m(argc, argv, io); +io_readline(rb_execution_context_t *ec, VALUE io, VALUE sep, VALUE lim, VALUE chomp) +{ + if (NIL_P(lim)) { + // If sep is specified, but it's not a string and not nil, then assume + // it's the limit (it should be an integer) + if (!NIL_P(sep) && NIL_P(rb_check_string_type(sep))) { + // If the user has specified a non-nil / non-string value + // for the separator, we assume it's the limit and set the + // separator to default: rb_rs. + lim = sep; + sep = rb_rs; + } + } + + if (!NIL_P(sep)) { + StringValue(sep); + } + + VALUE line = rb_io_getline_1(sep, NIL_P(lim) ? -1L : NUM2LONG(lim), RTEST(chomp), io); + rb_lastline_set_up(line, 1); if (NIL_P(line)) { - rb_eof_error(); + rb_eof_error(); } return line; } @@ -3947,26 +4398,66 @@ static VALUE io_readlines(const struct getline_arg *arg, VALUE io); /* * call-seq: - * ios.readlines(sep=$/ [, getline_args]) -> array - * ios.readlines(limit [, getline_args]) -> array - * ios.readlines(sep, limit [, getline_args]) -> array + * readlines(sep = $/, chomp: false) -> array + * readlines(limit, chomp: false) -> array + * readlines(sep, limit, chomp: false) -> array * - * Reads all of the lines in <em>ios</em>, and returns them in - * an array. Lines are separated by the optional <i>sep</i>. If - * <i>sep</i> is +nil+, the rest of the stream is returned - * as a single record. - * If the first argument is an integer, or an - * optional second argument is given, the returning string would not be - * longer than the given value in bytes. The stream must be opened for - * reading or an IOError will be raised. + * Reads and returns all remaining line from the stream; + * does not modify <tt>$_</tt>. + * See {Line IO}[rdoc-ref:IO@Line+IO]. * - * f = File.new("testfile") - * f.readlines[0] #=> "This is line one\n" + * With no arguments given, returns lines + * as determined by line separator <tt>$/</tt>, or +nil+ if none: * - * f = File.new("testfile", chomp: true) - * f.readlines[0] #=> "This is line one" + * f = File.new('t.txt') + * f.readlines + * # => ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"] + * f.readlines # => [] + * f.close + * + * With only string argument +sep+ given, + * returns lines as determined by line separator +sep+, + * or +nil+ if none; + * see {Line Separator}[rdoc-ref:IO@Line+Separator]: + * + * f = File.new('t.txt') + * f.readlines('li') + * # => ["First li", "ne\nSecond li", "ne\n\nFourth li", "ne\nFifth li", "ne\n"] + * f.close + * + * The two special values for +sep+ are honored: + * + * f = File.new('t.txt') + * # Get all into one string. + * f.readlines(nil) + * # => ["First line\nSecond line\n\nFourth line\nFifth line\n"] + * # Get paragraphs (up to two line separators). + * f.rewind + * f.readlines('') + * # => ["First line\nSecond line\n\n", "Fourth line\nFifth line\n"] + * f.close + * + * With only integer argument +limit+ given, + * limits the number of bytes in each line; + * see {Line Limit}[rdoc-ref:IO@Line+Limit]: + * + * f = File.new('t.txt') + * f.readlines(8) + * # => ["First li", "ne\n", "Second l", "ine\n", "\n", "Fourth l", "ine\n", "Fifth li", "ne\n"] + * f.close + * + * With arguments +sep+ and +limit+ given, + * combines the two behaviors + * (see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit]). + * + * Optional keyword argument +chomp+ specifies whether line separators + * are to be omitted: + * + * f = File.new('t.txt') + * f.readlines(chomp: true) + * # => ["First line", "Second line", "", "Fourth line", "Fifth line"] + * f.close * - * See IO.readlines for details about getline_args. */ static VALUE @@ -3984,43 +4475,118 @@ io_readlines(const struct getline_arg *arg, VALUE io) VALUE line, ary; if (arg->limit == 0) - rb_raise(rb_eArgError, "invalid limit: 0 for readlines"); + rb_raise(rb_eArgError, "invalid limit: 0 for readlines"); ary = rb_ary_new(); while (!NIL_P(line = rb_io_getline_1(arg->rs, arg->limit, arg->chomp, io))) { - rb_ary_push(ary, line); + rb_ary_push(ary, line); } return ary; } /* * call-seq: - * ios.each(sep=$/ [, getline_args]) {|line| block } -> ios - * ios.each(limit [, getline_args]) {|line| block } -> ios - * ios.each(sep, limit [, getline_args]) {|line| block } -> ios - * ios.each(...) -> an_enumerator + * each_line(sep = $/, chomp: false) {|line| ... } -> self + * each_line(limit, chomp: false) {|line| ... } -> self + * each_line(sep, limit, chomp: false) {|line| ... } -> self + * each_line -> enumerator * - * ios.each_line(sep=$/ [, getline_args]) {|line| block } -> ios - * ios.each_line(limit [, getline_args]) {|line| block } -> ios - * ios.each_line(sep, limit [, getline_args]) {|line| block } -> ios - * ios.each_line(...) -> an_enumerator + * Calls the block with each remaining line read from the stream; + * returns +self+. + * Does nothing if already at end-of-stream; + * See {Line IO}[rdoc-ref:IO@Line+IO]. * - * Executes the block for every line in <em>ios</em>, where lines are - * separated by <i>sep</i>. <em>ios</em> must be opened for - * reading or an IOError will be raised. + * With no arguments given, reads lines + * as determined by line separator <tt>$/</tt>: * - * If no block is given, an enumerator is returned instead. + * f = File.new('t.txt') + * f.each_line {|line| p line } + * f.each_line {|line| fail 'Cannot happen' } + * f.close * - * f = File.new("testfile") - * f.each {|line| puts "#{f.lineno}: #{line}" } + * Output: * - * <em>produces:</em> + * "First line\n" + * "Second line\n" + * "\n" + * "Fourth line\n" + * "Fifth line\n" * - * 1: This is line one - * 2: This is line two - * 3: This is line three - * 4: And so on... + * With only string argument +sep+ given, + * reads lines as determined by line separator +sep+; + * see {Line Separator}[rdoc-ref:IO@Line+Separator]: * - * See IO.readlines for details about getline_args. + * f = File.new('t.txt') + * f.each_line('li') {|line| p line } + * f.close + * + * Output: + * + * "First li" + * "ne\nSecond li" + * "ne\n\nFourth li" + * "ne\nFifth li" + * "ne\n" + * + * The two special values for +sep+ are honored: + * + * f = File.new('t.txt') + * # Get all into one string. + * f.each_line(nil) {|line| p line } + * f.close + * + * Output: + * + * "First line\nSecond line\n\nFourth line\nFifth line\n" + * + * f.rewind + * # Get paragraphs (up to two line separators). + * f.each_line('') {|line| p line } + * + * Output: + * + * "First line\nSecond line\n\n" + * "Fourth line\nFifth line\n" + * + * With only integer argument +limit+ given, + * limits the number of bytes in each line; + * see {Line Limit}[rdoc-ref:IO@Line+Limit]: + * + * f = File.new('t.txt') + * f.each_line(8) {|line| p line } + * f.close + * + * Output: + * + * "First li" + * "ne\n" + * "Second l" + * "ine\n" + * "\n" + * "Fourth l" + * "ine\n" + * "Fifth li" + * "ne\n" + * + * With arguments +sep+ and +limit+ given, + * combines the two behaviors + * (see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit]). + * + * Optional keyword argument +chomp+ specifies whether line separators + * are to be omitted: + * + * f = File.new('t.txt') + * f.each_line(chomp: true) {|line| p line } + * f.close + * + * Output: + * + * "First line" + * "Second line" + * "" + * "Fourth line" + * "Fifth line" + * + * Returns an Enumerator if no block is given. */ static VALUE @@ -4032,28 +4598,31 @@ rb_io_each_line(int argc, VALUE *argv, VALUE io) RETURN_ENUMERATOR(io, argc, argv); prepare_getline_args(argc, argv, &args, io); if (args.limit == 0) - rb_raise(rb_eArgError, "invalid limit: 0 for each_line"); + rb_raise(rb_eArgError, "invalid limit: 0 for each_line"); while (!NIL_P(str = rb_io_getline_1(args.rs, args.limit, args.chomp, io))) { - rb_yield(str); + rb_yield(str); } return io; } /* * call-seq: - * ios.each_byte {|byte| block } -> ios - * ios.each_byte -> an_enumerator + * each_byte {|byte| ... } -> self + * each_byte -> enumerator * - * Calls the given block once for each byte (0..255) in <em>ios</em>, - * passing the byte as an argument. The stream must be opened for - * reading or an IOError will be raised. + * Calls the given block with each byte (0..255) in the stream; returns +self+. + * See {Byte IO}[rdoc-ref:IO@Byte+IO]. * - * If no block is given, an enumerator is returned instead. + * f = File.new('t.rus') + * a = [] + * f.each_byte {|b| a << b } + * a # => [209, 130, 208, 181, 209, 129, 209, 130] + * f.close + * + * Returns an Enumerator if no block is given. + * + * Related: IO#each_char, IO#each_codepoint. * - * f = File.new("testfile") - * checksum = 0 - * f.each_byte {|x| checksum ^= x } #=> #<File:testfile> - * checksum #=> 12 */ static VALUE @@ -4065,14 +4634,14 @@ rb_io_each_byte(VALUE io) GetOpenFile(io, fptr); do { - while (fptr->rbuf.len > 0) { - char *p = fptr->rbuf.ptr + fptr->rbuf.off++; - fptr->rbuf.len--; - rb_yield(INT2FIX(*p & 0xff)); - rb_io_check_byte_readable(fptr); - errno = 0; - } - READ_CHECK(fptr); + while (fptr->rbuf.len > 0) { + char *p = fptr->rbuf.ptr + fptr->rbuf.off++; + fptr->rbuf.len--; + rb_yield(INT2FIX(*p & 0xff)); + rb_io_check_byte_readable(fptr); + errno = 0; + } + READ_CHECK(fptr); } while (io_fillbuf(fptr) >= 0); return io; } @@ -4084,17 +4653,17 @@ io_getc(rb_io_t *fptr, rb_encoding *enc) VALUE str; if (NEED_READCONV(fptr)) { - rb_encoding *read_enc = io_read_encoding(fptr); + rb_encoding *read_enc = io_read_encoding(fptr); - str = Qnil; - SET_BINARY_MODE(fptr); + str = Qnil; + SET_BINARY_MODE(fptr); make_readconv(fptr, 0); while (1) { if (fptr->cbuf.len) { - r = rb_enc_precise_mbclen(fptr->cbuf.ptr+fptr->cbuf.off, - fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, - read_enc); + r = rb_enc_precise_mbclen(fptr->cbuf.ptr+fptr->cbuf.off, + fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, + read_enc); if (!MBCLEN_NEEDMORE_P(r)) break; if (fptr->cbuf.len == fptr->cbuf.capa) { @@ -4104,16 +4673,16 @@ io_getc(rb_io_t *fptr, rb_encoding *enc) if (more_char(fptr) == MORE_CHAR_FINISHED) { if (fptr->cbuf.len == 0) { - clear_readconv(fptr); - return Qnil; - } + clear_readconv(fptr); + return Qnil; + } /* return an unit of an incomplete character just before EOF */ - str = rb_enc_str_new(fptr->cbuf.ptr+fptr->cbuf.off, 1, read_enc); - fptr->cbuf.off += 1; - fptr->cbuf.len -= 1; + str = rb_enc_str_new(fptr->cbuf.ptr+fptr->cbuf.off, 1, read_enc); + fptr->cbuf.off += 1; + fptr->cbuf.len -= 1; if (fptr->cbuf.len == 0) clear_readconv(fptr); - ENC_CODERANGE_SET(str, ENC_CODERANGE_BROKEN); - return str; + ENC_CODERANGE_SET(str, ENC_CODERANGE_BROKEN); + return str; } } if (MBCLEN_INVALID_P(r)) { @@ -4121,62 +4690,62 @@ io_getc(rb_io_t *fptr, rb_encoding *enc) fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, read_enc); io_shift_cbuf(fptr, r, &str); - cr = ENC_CODERANGE_BROKEN; - } - else { - io_shift_cbuf(fptr, MBCLEN_CHARFOUND_LEN(r), &str); - cr = ENC_CODERANGE_VALID; - if (MBCLEN_CHARFOUND_LEN(r) == 1 && rb_enc_asciicompat(read_enc) && - ISASCII(RSTRING_PTR(str)[0])) { - cr = ENC_CODERANGE_7BIT; - } - } - str = io_enc_str(str, fptr); - ENC_CODERANGE_SET(str, cr); - return str; + cr = ENC_CODERANGE_BROKEN; + } + else { + io_shift_cbuf(fptr, MBCLEN_CHARFOUND_LEN(r), &str); + cr = ENC_CODERANGE_VALID; + if (MBCLEN_CHARFOUND_LEN(r) == 1 && rb_enc_asciicompat(read_enc) && + ISASCII(RSTRING_PTR(str)[0])) { + cr = ENC_CODERANGE_7BIT; + } + } + str = io_enc_str(str, fptr); + ENC_CODERANGE_SET(str, cr); + return str; } NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); if (io_fillbuf(fptr) < 0) { - return Qnil; + return Qnil; } if (rb_enc_asciicompat(enc) && ISASCII(fptr->rbuf.ptr[fptr->rbuf.off])) { - str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, 1); - fptr->rbuf.off += 1; - fptr->rbuf.len -= 1; - cr = ENC_CODERANGE_7BIT; + str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, 1); + fptr->rbuf.off += 1; + fptr->rbuf.len -= 1; + cr = ENC_CODERANGE_7BIT; } else { - r = rb_enc_precise_mbclen(fptr->rbuf.ptr+fptr->rbuf.off, fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); - if (MBCLEN_CHARFOUND_P(r) && - (n = MBCLEN_CHARFOUND_LEN(r)) <= fptr->rbuf.len) { - str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, n); - fptr->rbuf.off += n; - fptr->rbuf.len -= n; - cr = ENC_CODERANGE_VALID; - } - else if (MBCLEN_NEEDMORE_P(r)) { - str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, fptr->rbuf.len); - fptr->rbuf.len = 0; - getc_needmore: - if (io_fillbuf(fptr) != -1) { - rb_str_cat(str, fptr->rbuf.ptr+fptr->rbuf.off, 1); - fptr->rbuf.off++; - fptr->rbuf.len--; - r = rb_enc_precise_mbclen(RSTRING_PTR(str), RSTRING_PTR(str)+RSTRING_LEN(str), enc); - if (MBCLEN_NEEDMORE_P(r)) { - goto getc_needmore; - } - else if (MBCLEN_CHARFOUND_P(r)) { - cr = ENC_CODERANGE_VALID; - } - } - } - else { - str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, 1); - fptr->rbuf.off++; - fptr->rbuf.len--; - } + r = rb_enc_precise_mbclen(fptr->rbuf.ptr+fptr->rbuf.off, fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); + if (MBCLEN_CHARFOUND_P(r) && + (n = MBCLEN_CHARFOUND_LEN(r)) <= fptr->rbuf.len) { + str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, n); + fptr->rbuf.off += n; + fptr->rbuf.len -= n; + cr = ENC_CODERANGE_VALID; + } + else if (MBCLEN_NEEDMORE_P(r)) { + str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, fptr->rbuf.len); + fptr->rbuf.len = 0; + getc_needmore: + if (io_fillbuf(fptr) != -1) { + rb_str_cat(str, fptr->rbuf.ptr+fptr->rbuf.off, 1); + fptr->rbuf.off++; + fptr->rbuf.len--; + r = rb_enc_precise_mbclen(RSTRING_PTR(str), RSTRING_PTR(str)+RSTRING_LEN(str), enc); + if (MBCLEN_NEEDMORE_P(r)) { + goto getc_needmore; + } + else if (MBCLEN_CHARFOUND_P(r)) { + cr = ENC_CODERANGE_VALID; + } + } + } + else { + str = rb_str_new(fptr->rbuf.ptr+fptr->rbuf.off, 1); + fptr->rbuf.off++; + fptr->rbuf.len--; + } } if (!cr) cr = ENC_CODERANGE_BROKEN; str = io_enc_str(str, fptr); @@ -4186,17 +4755,22 @@ io_getc(rb_io_t *fptr, rb_encoding *enc) /* * call-seq: - * ios.each_char {|c| block } -> ios - * ios.each_char -> an_enumerator + * each_char {|c| ... } -> self + * each_char -> enumerator * - * Calls the given block once for each character in <em>ios</em>, - * passing the character as an argument. The stream must be opened for - * reading or an IOError will be raised. + * Calls the given block with each character in the stream; returns +self+. + * See {Character IO}[rdoc-ref:IO@Character+IO]. * - * If no block is given, an enumerator is returned instead. + * f = File.new('t.rus') + * a = [] + * f.each_char {|c| a << c.ord } + * a # => [1090, 1077, 1089, 1090] + * f.close + * + * Returns an Enumerator if no block is given. + * + * Related: IO#each_byte, IO#each_codepoint. * - * f = File.new("testfile") - * f.each_char {|c| print c, ' ' } #=> #<File:testfile> */ static VALUE @@ -4220,14 +4794,20 @@ rb_io_each_char(VALUE io) /* * call-seq: - * ios.each_codepoint {|c| block } -> ios - * ios.each_codepoint -> an_enumerator + * each_codepoint {|c| ... } -> self + * each_codepoint -> enumerator * - * Passes the Integer ordinal of each character in <i>ios</i>, - * passing the codepoint as an argument. The stream must be opened for - * reading or an IOError will be raised. + * Calls the given block with each codepoint in the stream; returns +self+: * - * If no block is given, an enumerator is returned instead. + * f = File.new('t.rus') + * a = [] + * f.each_codepoint {|c| a << c } + * a # => [1090, 1077, 1089, 1090] + * f.close + * + * Returns an Enumerator if no block is given. + * + * Related: IO#each_byte, IO#each_char. * */ @@ -4245,87 +4825,87 @@ rb_io_each_codepoint(VALUE io) READ_CHECK(fptr); if (NEED_READCONV(fptr)) { - SET_BINARY_MODE(fptr); - r = 1; /* no invalid char yet */ - for (;;) { - make_readconv(fptr, 0); - for (;;) { - if (fptr->cbuf.len) { - if (fptr->encs.enc) - r = rb_enc_precise_mbclen(fptr->cbuf.ptr+fptr->cbuf.off, - fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, - fptr->encs.enc); - else - r = ONIGENC_CONSTRUCT_MBCLEN_CHARFOUND(1); - if (!MBCLEN_NEEDMORE_P(r)) - break; - if (fptr->cbuf.len == fptr->cbuf.capa) { - rb_raise(rb_eIOError, "too long character"); - } - } - if (more_char(fptr) == MORE_CHAR_FINISHED) { + SET_BINARY_MODE(fptr); + r = 1; /* no invalid char yet */ + for (;;) { + make_readconv(fptr, 0); + for (;;) { + if (fptr->cbuf.len) { + if (fptr->encs.enc) + r = rb_enc_precise_mbclen(fptr->cbuf.ptr+fptr->cbuf.off, + fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, + fptr->encs.enc); + else + r = ONIGENC_CONSTRUCT_MBCLEN_CHARFOUND(1); + if (!MBCLEN_NEEDMORE_P(r)) + break; + if (fptr->cbuf.len == fptr->cbuf.capa) { + rb_raise(rb_eIOError, "too long character"); + } + } + if (more_char(fptr) == MORE_CHAR_FINISHED) { clear_readconv(fptr); - if (!MBCLEN_CHARFOUND_P(r)) { - enc = fptr->encs.enc; - goto invalid; - } - return io; - } - } - if (MBCLEN_INVALID_P(r)) { - enc = fptr->encs.enc; - goto invalid; - } - n = MBCLEN_CHARFOUND_LEN(r); - if (fptr->encs.enc) { - c = rb_enc_codepoint(fptr->cbuf.ptr+fptr->cbuf.off, - fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, - fptr->encs.enc); - } - else { - c = (unsigned char)fptr->cbuf.ptr[fptr->cbuf.off]; - } - fptr->cbuf.off += n; - fptr->cbuf.len -= n; - rb_yield(UINT2NUM(c)); + if (!MBCLEN_CHARFOUND_P(r)) { + enc = fptr->encs.enc; + goto invalid; + } + return io; + } + } + if (MBCLEN_INVALID_P(r)) { + enc = fptr->encs.enc; + goto invalid; + } + n = MBCLEN_CHARFOUND_LEN(r); + if (fptr->encs.enc) { + c = rb_enc_codepoint(fptr->cbuf.ptr+fptr->cbuf.off, + fptr->cbuf.ptr+fptr->cbuf.off+fptr->cbuf.len, + fptr->encs.enc); + } + else { + c = (unsigned char)fptr->cbuf.ptr[fptr->cbuf.off]; + } + fptr->cbuf.off += n; + fptr->cbuf.len -= n; + rb_yield(UINT2NUM(c)); rb_io_check_byte_readable(fptr); - } + } } NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); enc = io_input_encoding(fptr); while (io_fillbuf(fptr) >= 0) { - r = rb_enc_precise_mbclen(fptr->rbuf.ptr+fptr->rbuf.off, - fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); - if (MBCLEN_CHARFOUND_P(r) && - (n = MBCLEN_CHARFOUND_LEN(r)) <= fptr->rbuf.len) { - c = rb_enc_codepoint(fptr->rbuf.ptr+fptr->rbuf.off, - fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); - fptr->rbuf.off += n; - fptr->rbuf.len -= n; - rb_yield(UINT2NUM(c)); - } - else if (MBCLEN_INVALID_P(r)) { + r = rb_enc_precise_mbclen(fptr->rbuf.ptr+fptr->rbuf.off, + fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); + if (MBCLEN_CHARFOUND_P(r) && + (n = MBCLEN_CHARFOUND_LEN(r)) <= fptr->rbuf.len) { + c = rb_enc_codepoint(fptr->rbuf.ptr+fptr->rbuf.off, + fptr->rbuf.ptr+fptr->rbuf.off+fptr->rbuf.len, enc); + fptr->rbuf.off += n; + fptr->rbuf.len -= n; + rb_yield(UINT2NUM(c)); + } + else if (MBCLEN_INVALID_P(r)) { goto invalid; - } - else if (MBCLEN_NEEDMORE_P(r)) { - char cbuf[8], *p = cbuf; - int more = MBCLEN_NEEDMORE_LEN(r); - if (more > numberof(cbuf)) goto invalid; - more += n = fptr->rbuf.len; - if (more > numberof(cbuf)) goto invalid; - while ((n = (int)read_buffered_data(p, more, fptr)) > 0 && - (p += n, (more -= n) > 0)) { - if (io_fillbuf(fptr) < 0) goto invalid; - if ((n = fptr->rbuf.len) > more) n = more; - } - r = rb_enc_precise_mbclen(cbuf, p, enc); - if (!MBCLEN_CHARFOUND_P(r)) goto invalid; - c = rb_enc_codepoint(cbuf, p, enc); - rb_yield(UINT2NUM(c)); - } - else { - continue; - } + } + else if (MBCLEN_NEEDMORE_P(r)) { + char cbuf[8], *p = cbuf; + int more = MBCLEN_NEEDMORE_LEN(r); + if (more > numberof(cbuf)) goto invalid; + more += n = fptr->rbuf.len; + if (more > numberof(cbuf)) goto invalid; + while ((n = (int)read_buffered_data(p, more, fptr)) > 0 && + (p += n, (more -= n) > 0)) { + if (io_fillbuf(fptr) < 0) goto invalid; + if ((n = fptr->rbuf.len) > more) n = more; + } + r = rb_enc_precise_mbclen(cbuf, p, enc); + if (!MBCLEN_CHARFOUND_P(r)) goto invalid; + c = rb_enc_codepoint(cbuf, p, enc); + rb_yield(UINT2NUM(c)); + } + else { + continue; + } rb_io_check_byte_readable(fptr); } return io; @@ -4337,14 +4917,21 @@ rb_io_each_codepoint(VALUE io) /* * call-seq: - * ios.getc -> string or nil + * getc -> character or nil + * + * Reads and returns the next 1-character string from the stream; + * returns +nil+ if already at end-of-stream. + * See {Character IO}[rdoc-ref:IO@Character+IO]. + * + * f = File.open('t.txt') + * f.getc # => "F" + * f.close + * f = File.open('t.rus') + * f.getc.ord # => 1090 + * f.close * - * Reads a one-character string from <em>ios</em>. Returns - * +nil+ if called at end of file. + * Related: IO#readchar (may raise EOFError). * - * f = File.new("testfile") - * f.getc #=> "h" - * f.getc #=> "e" */ static VALUE @@ -4363,14 +4950,21 @@ rb_io_getc(VALUE io) /* * call-seq: - * ios.readchar -> string + * readchar -> string * - * Reads a one-character string from <em>ios</em>. Raises an - * EOFError on end of file. + * Reads and returns the next 1-character string from the stream; + * raises EOFError if already at end-of-stream. + * See {Character IO}[rdoc-ref:IO@Character+IO]. + * + * f = File.open('t.txt') + * f.readchar # => "F" + * f.close + * f = File.open('t.rus') + * f.readchar.ord # => 1090 + * f.close + * + * Related: IO#getc (will not raise EOFError). * - * f = File.new("testfile") - * f.readchar #=> "h" - * f.readchar #=> "e" */ static VALUE @@ -4379,21 +4973,27 @@ rb_io_readchar(VALUE io) VALUE c = rb_io_getc(io); if (NIL_P(c)) { - rb_eof_error(); + rb_eof_error(); } return c; } /* * call-seq: - * ios.getbyte -> integer or nil + * getbyte -> integer or nil + * + * Reads and returns the next byte (in range 0..255) from the stream; + * returns +nil+ if already at end-of-stream. + * See {Byte IO}[rdoc-ref:IO@Byte+IO]. * - * Gets the next 8-bit byte (0..255) from <em>ios</em>. Returns - * +nil+ if called at end of file. + * f = File.open('t.txt') + * f.getbyte # => 70 + * f.close + * f = File.open('t.rus') + * f.getbyte # => 209 + * f.close * - * f = File.new("testfile") - * f.getbyte #=> 84 - * f.getbyte #=> 104 + * Related: IO#readbyte (may raise EOFError). */ VALUE @@ -4414,7 +5014,7 @@ rb_io_getbyte(VALUE io) } } if (io_fillbuf(fptr) < 0) { - return Qnil; + return Qnil; } fptr->rbuf.off++; fptr->rbuf.len--; @@ -4424,10 +5024,21 @@ rb_io_getbyte(VALUE io) /* * call-seq: - * ios.readbyte -> integer + * readbyte -> integer + * + * Reads and returns the next byte (in range 0..255) from the stream; + * raises EOFError if already at end-of-stream. + * See {Byte IO}[rdoc-ref:IO@Byte+IO]. + * + * f = File.open('t.txt') + * f.readbyte # => 70 + * f.close + * f = File.open('t.rus') + * f.readbyte # => 209 + * f.close + * + * Related: IO#getbyte (will not raise EOFError). * - * Reads a byte as with IO#getbyte, but raises an EOFError on end of - * file. */ static VALUE @@ -4436,45 +5047,47 @@ rb_io_readbyte(VALUE io) VALUE c = rb_io_getbyte(io); if (NIL_P(c)) { - rb_eof_error(); + rb_eof_error(); } return c; } /* * call-seq: - * ios.ungetbyte(string) -> nil - * ios.ungetbyte(integer) -> nil + * ungetbyte(integer) -> nil + * ungetbyte(string) -> nil * - * Pushes back bytes (passed as a parameter) onto <em>ios</em>, - * such that a subsequent buffered read will return it. - * It is only guaranteed to support a single byte, and only if ungetbyte - * or ungetc has not already been called on <em>ios</em> since the previous - * read of at least a single byte from <em>ios</em>. - * However, it can support additional bytes if there is space in the - * internal buffer to allow for it. + * Pushes back ("unshifts") the given data onto the stream's buffer, + * placing the data so that it is next to be read; returns +nil+. + * See {Byte IO}[rdoc-ref:IO@Byte+IO]. * - * f = File.new("testfile") #=> #<File:testfile> - * b = f.getbyte #=> 0x38 - * f.ungetbyte(b) #=> nil - * f.getbyte #=> 0x38 + * Note that: * - * If given an integer, only uses the lower 8 bits of the integer as the byte - * to push. + * - Calling the method has no effect with unbuffered reads (such as IO#sysread). + * - Calling #rewind on the stream discards the pushed-back data. * - * f = File.new("testfile") #=> #<File:testfile> - * f.ungetbyte(0x102) #=> nil - * f.getbyte #=> 0x2 + * When argument +integer+ is given, uses only its low-order byte: * - * Calling this method prepends to the existing buffer, even if the method - * has already been called previously: + * File.write('t.tmp', '012') + * f = File.open('t.tmp') + * f.ungetbyte(0x41) # => nil + * f.read # => "A012" + * f.rewind + * f.ungetbyte(0x4243) # => nil + * f.read # => "C012" + * f.close * - * f = File.new("testfile") #=> #<File:testfile> - * f.ungetbyte("ab") #=> nil - * f.ungetbyte("cd") #=> nil - * f.read(5) #=> "cdab8" + * When argument +string+ is given, uses all bytes: + * + * File.write('t.tmp', '012') + * f = File.open('t.tmp') + * f.ungetbyte('A') # => nil + * f.read # => "A012" + * f.rewind + * f.ungetbyte('BCDE') # => nil + * f.read # => "BCDE012" + * f.close * - * Has no effect with unbuffered reads (such as IO#sysread). */ VALUE @@ -4494,7 +5107,7 @@ rb_io_ungetbyte(VALUE io, VALUE b) b = rb_str_new((const char *)&c, 1); break; default: - SafeStringValue(b); + StringValue(b); } io_ungetbyte(b, fptr); return Qnil; @@ -4502,34 +5115,43 @@ rb_io_ungetbyte(VALUE io, VALUE b) /* * call-seq: - * ios.ungetc(integer) -> nil - * ios.ungetc(string) -> nil + * ungetc(integer) -> nil + * ungetc(string) -> nil + * + * Pushes back ("unshifts") the given data onto the stream's buffer, + * placing the data so that it is next to be read; returns +nil+. + * See {Character IO}[rdoc-ref:IO@Character+IO]. * - * Pushes back characters (passed as a parameter) onto <em>ios</em>, - * such that a subsequent buffered read will return it. - * It is only guaranteed to support a single byte, and only if ungetbyte - * or ungetc has not already been called on <em>ios</em> since the previous - * read of at least a single byte from <em>ios</em>. - * However, it can support additional bytes if there is space in the - * internal buffer to allow for it. + * Note that: * - * f = File.new("testfile") #=> #<File:testfile> - * c = f.getc #=> "8" - * f.ungetc(c) #=> nil - * f.getc #=> "8" + * - Calling the method has no effect with unbuffered reads (such as IO#sysread). + * - Calling #rewind on the stream discards the pushed-back data. * - * If given an integer, the integer must represent a valid codepoint in the - * external encoding of <em>ios</em>. + * When argument +integer+ is given, interprets the integer as a character: * - * Calling this method prepends to the existing buffer, even if the method - * has already been called previously: + * File.write('t.tmp', '012') + * f = File.open('t.tmp') + * f.ungetc(0x41) # => nil + * f.read # => "A012" + * f.rewind + * f.ungetc(0x0442) # => nil + * f.getc.ord # => 1090 + * f.close * - * f = File.new("testfile") #=> #<File:testfile> - * f.ungetc("ab") #=> nil - * f.ungetc("cd") #=> nil - * f.read(5) #=> "cdab8" + * When argument +string+ is given, uses all characters: + * + * File.write('t.tmp', '012') + * f = File.open('t.tmp') + * f.ungetc('A') # => nil + * f.read # => "A012" + * f.rewind + * f.ungetc("\u0442\u0435\u0441\u0442") # => nil + * f.getc.ord # => 1090 + * f.getc.ord # => 1077 + * f.getc.ord # => 1089 + * f.getc.ord # => 1090 + * f.close * - * Has no effect with unbuffered reads (such as IO#sysread). */ VALUE @@ -4541,20 +5163,20 @@ rb_io_ungetc(VALUE io, VALUE c) GetOpenFile(io, fptr); rb_io_check_char_readable(fptr); if (FIXNUM_P(c)) { - c = rb_enc_uint_chr(FIX2UINT(c), io_read_encoding(fptr)); + c = rb_enc_uint_chr(FIX2UINT(c), io_read_encoding(fptr)); } else if (RB_BIGNUM_TYPE_P(c)) { - c = rb_enc_uint_chr(NUM2UINT(c), io_read_encoding(fptr)); + c = rb_enc_uint_chr(NUM2UINT(c), io_read_encoding(fptr)); } else { - SafeStringValue(c); + StringValue(c); } if (NEED_READCONV(fptr)) { - SET_BINARY_MODE(fptr); + SET_BINARY_MODE(fptr); len = RSTRING_LEN(c); #if SIZEOF_LONG > SIZEOF_INT - if (len > INT_MAX) - rb_raise(rb_eIOError, "ungetc failed"); + if (len > INT_MAX) + rb_raise(rb_eIOError, "ungetc failed"); #endif make_readconv(fptr, (int)len); if (fptr->cbuf.capa - fptr->cbuf.len < len) @@ -4570,7 +5192,7 @@ rb_io_ungetc(VALUE io, VALUE c) MEMMOVE(fptr->cbuf.ptr+fptr->cbuf.off, RSTRING_PTR(c), char, len); } else { - NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); + NEED_NEWLINE_DECORATOR_ON_READ_CHECK(fptr); io_ungetbyte(c, fptr); } return Qnil; @@ -4578,14 +5200,16 @@ rb_io_ungetc(VALUE io, VALUE c) /* * call-seq: - * ios.isatty -> true or false - * ios.tty? -> true or false + * isatty -> true or false + * + * Returns +true+ if the stream is associated with a terminal device (tty), + * +false+ otherwise: * - * Returns <code>true</code> if <em>ios</em> is associated with a - * terminal device (tty), <code>false</code> otherwise. + * f = File.new('t.txt').isatty #=> false + * f.close + * f = File.new('/dev/tty').isatty #=> true + * f.close * - * File.new("testfile").isatty #=> false - * File.new("/dev/tty").isatty #=> true */ static VALUE @@ -4600,16 +5224,16 @@ rb_io_isatty(VALUE io) #if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC) /* * call-seq: - * ios.close_on_exec? -> true or false + * close_on_exec? -> true or false * - * Returns <code>true</code> if <em>ios</em> will be closed on exec. + * Returns +true+ if the stream will be closed on exec, +false+ otherwise: + * + * f = File.open('t.txt') + * f.close_on_exec? # => true + * f.close_on_exec = false + * f.close_on_exec? # => false + * f.close * - * f = open("/dev/null") - * f.close_on_exec? #=> false - * f.close_on_exec = true - * f.close_on_exec? #=> true - * f.close_on_exec = false - * f.close_on_exec? #=> false */ static VALUE @@ -4642,11 +5266,11 @@ rb_io_close_on_exec_p(VALUE io) #if defined(HAVE_FCNTL) && defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC) /* * call-seq: - * ios.close_on_exec = bool -> true or false + * self.close_on_exec = bool -> true or false * * Sets a close-on-exec flag. * - * f = open("/dev/null") + * f = File.open(File::NULL) * f.close_on_exec = true * system("cat", "/proc/self/fd/#{f.fileno}") # cat: /proc/self/fd/3: No such file or directory * f.closed? #=> false @@ -4697,7 +5321,7 @@ rb_io_set_close_on_exec(VALUE io, VALUE arg) #define rb_io_set_close_on_exec rb_f_notimplement #endif -#define IS_PREP_STDIO(f) ((f)->mode & FMODE_PREP) +#define RUBY_IO_EXTERNAL_P(f) ((f)->mode & FMODE_EXTERNAL) #define PREP_STDIO_NAME(f) (RSTRING_PTR((f)->pathv)) static VALUE @@ -4708,7 +5332,6 @@ finish_writeconv(rb_io_t *fptr, int noalloc) if (!fptr->wbuf.ptr) { unsigned char buf[1024]; - long r; res = econv_destination_buffer_full; while (res == econv_destination_buffer_full) { @@ -4716,22 +5339,20 @@ finish_writeconv(rb_io_t *fptr, int noalloc) de = buf + sizeof(buf); res = rb_econv_convert(fptr->writeconv, NULL, NULL, &dp, de, 0); while (dp-ds) { - retry: - if (fptr->write_lock && rb_mutex_owned_p(fptr->write_lock)) - r = rb_write_internal2(fptr->fd, ds, dp-ds); - else - r = rb_write_internal(fptr->fd, ds, dp-ds); - if (r == dp-ds) - break; - if (0 <= r) { - ds += r; + size_t remaining = dp-ds; + long result = rb_io_write_memory(fptr, ds, remaining); + + if (result > 0) { + ds += result; + if ((size_t)result == remaining) break; } - if (rb_io_maybe_wait_writable(errno, fptr->self, Qnil)) { + else if (rb_io_maybe_wait_writable(errno, fptr->self, RUBY_IO_TIMEOUT_DEFAULT)) { if (fptr->fd < 0) return noalloc ? Qtrue : rb_exc_new3(rb_eIOError, rb_str_new_cstr(closed_stream)); - goto retry; } - return noalloc ? Qtrue : INT2NUM(errno); + else { + return noalloc ? Qtrue : INT2NUM(errno); + } } if (res == econv_invalid_byte_sequence || res == econv_incomplete_input || @@ -4746,8 +5367,9 @@ finish_writeconv(rb_io_t *fptr, int noalloc) res = econv_destination_buffer_full; while (res == econv_destination_buffer_full) { if (fptr->wbuf.len == fptr->wbuf.capa) { - if (io_fflush(fptr) < 0) + if (io_fflush(fptr) < 0) { return noalloc ? Qtrue : INT2NUM(errno); + } } ds = dp = (unsigned char *)fptr->wbuf.ptr + fptr->wbuf.off + fptr->wbuf.len; @@ -4787,13 +5409,13 @@ static int maygvl_close(int fd, int keepgvl) { if (keepgvl) - return close(fd); + return close(fd); /* * close() may block for certain file types (NFS, SO_LINGER sockets, * inotify), so let other threads run. */ - return (int)(intptr_t)rb_thread_call_without_gvl(nogvl_close, &fd, RUBY_UBF_IO, 0); + return IO_WITHOUT_GVL_INT(nogvl_close, &fd); } static void* @@ -4808,9 +5430,9 @@ static int maygvl_fclose(FILE *file, int keepgvl) { if (keepgvl) - return fclose(file); + return fclose(file); - return (int)(intptr_t)rb_thread_call_without_gvl(nogvl_fclose, file, RUBY_UBF_IO, 0); + return IO_WITHOUT_GVL_INT(nogvl_fclose, file); } static void free_io_buffer(rb_io_buffer_t *buf); @@ -4818,72 +5440,92 @@ static void clear_codeconv(rb_io_t *fptr); static void fptr_finalize_flush(rb_io_t *fptr, int noraise, int keepgvl, - struct list_head *busy) + struct rb_io_close_wait_list *busy) { - VALUE err = Qnil; + VALUE error = Qnil; int fd = fptr->fd; FILE *stdio_file = fptr->stdio_file; int mode = fptr->mode; if (fptr->writeconv) { - if (fptr->write_lock && !noraise) { + if (!NIL_P(fptr->write_lock) && !noraise) { struct finish_writeconv_arg arg; arg.fptr = fptr; arg.noalloc = noraise; - err = rb_mutex_synchronize(fptr->write_lock, finish_writeconv_sync, (VALUE)&arg); - } - else { - err = finish_writeconv(fptr, noraise); - } + error = rb_mutex_synchronize(fptr->write_lock, finish_writeconv_sync, (VALUE)&arg); + } + else { + error = finish_writeconv(fptr, noraise); + } } if (fptr->wbuf.len) { - if (noraise) { - io_flush_buffer_sync(fptr); - } - else { - if (io_fflush(fptr) < 0 && NIL_P(err)) - err = INT2NUM(errno); - } + if (noraise) { + io_flush_buffer_sync(fptr); + } + else { + if (io_fflush(fptr) < 0 && NIL_P(error)) { + error = INT2NUM(errno); + } + } + } + + int done = 0; + + if (RUBY_IO_EXTERNAL_P(fptr) || fd <= 2) { + // Need to keep FILE objects of stdin, stdout and stderr, so we are done: + done = 1; } fptr->fd = -1; fptr->stdio_file = 0; fptr->mode &= ~(FMODE_READABLE|FMODE_WRITABLE); - /* - * ensure waiting_fd users do not hit EBADF, wait for them - * to exit before we call close(). - */ + // Ensure waiting_fd users do not hit EBADF. if (busy) { - do rb_thread_schedule(); while (!list_empty(busy)); - } + // Wait for them to exit before we call close(). + rb_notify_fd_close_wait(busy); + } + + // Disable for now. + // if (!done && fd >= 0) { + // VALUE scheduler = rb_fiber_scheduler_current(); + // if (scheduler != Qnil) { + // VALUE result = rb_fiber_scheduler_io_close(scheduler, fptr->self); + // if (!UNDEF_P(result)) done = 1; + // } + // } + + if (!done && stdio_file) { + // stdio_file is deallocated anyway even if fclose failed. + if ((maygvl_fclose(stdio_file, noraise) < 0) && NIL_P(error)) { + if (!noraise) { + error = INT2NUM(errno); + } + } - if (IS_PREP_STDIO(fptr) || fd <= 2) { - /* need to keep FILE objects of stdin, stdout and stderr */ - } - else if (stdio_file) { - /* stdio_file is deallocated anyway - * even if fclose failed. */ - if ((maygvl_fclose(stdio_file, noraise) < 0) && NIL_P(err)) - if (!noraise) err = INT2NUM(errno); + done = 1; } - else if (0 <= fd) { - /* fptr->fd may be closed even if close fails. - * POSIX doesn't specify it. - * We assumes it is closed. */ - /**/ - keepgvl |= !(mode & FMODE_WRITABLE); - keepgvl |= noraise; - if ((maygvl_close(fd, keepgvl) < 0) && NIL_P(err)) - if (!noraise) err = INT2NUM(errno); + if (!done && fd >= 0) { + // fptr->fd may be closed even if close fails. POSIX doesn't specify it. + // We assumes it is closed. + + keepgvl |= !(mode & FMODE_WRITABLE); + keepgvl |= noraise; + if ((maygvl_close(fd, keepgvl) < 0) && NIL_P(error)) { + if (!noraise) { + error = INT2NUM(errno); + } + } + + done = 1; } - if (!NIL_P(err) && !noraise) { - if (RB_INTEGER_TYPE_P(err)) - rb_syserr_fail_path(NUM2INT(err), fptr->pathv); - else - rb_exc_raise(err); + if (!NIL_P(error) && !noraise) { + if (RB_INTEGER_TYPE_P(error)) + rb_syserr_fail_path(NUM2INT(error), fptr->pathv); + else + rb_exc_raise(error); } } @@ -4900,10 +5542,10 @@ static void rb_io_fptr_cleanup(rb_io_t *fptr, int noraise) { if (fptr->finalize) { - (*fptr->finalize)(fptr, noraise); + (*fptr->finalize)(fptr, noraise); } else { - fptr_finalize(fptr, noraise); + fptr_finalize(fptr, noraise); } } @@ -4943,20 +5585,24 @@ clear_codeconv(rb_io_t *fptr) clear_writeconv(fptr); } -void -rb_io_fptr_finalize_internal(void *ptr) +static void +rb_io_fptr_cleanup_all(rb_io_t *fptr) { - rb_io_t *fptr = ptr; - - if (!ptr) return; fptr->pathv = Qnil; if (0 <= fptr->fd) rb_io_fptr_cleanup(fptr, TRUE); - fptr->write_lock = 0; + fptr->write_lock = Qnil; free_io_buffer(&fptr->rbuf); free_io_buffer(&fptr->wbuf); clear_codeconv(fptr); - free(fptr); +} + +void +rb_io_fptr_finalize_internal(void *ptr) +{ + if (!ptr) return; + rb_io_fptr_cleanup_all(ptr); + free(ptr); } #undef rb_io_fptr_finalize @@ -4973,7 +5619,7 @@ rb_io_fptr_finalize(rb_io_t *fptr) } #define rb_io_fptr_finalize(fptr) rb_io_fptr_finalize_internal(fptr) -RUBY_FUNC_EXPORTED size_t +size_t rb_io_memsize(const rb_io_t *fptr) { size_t size = sizeof(rb_io_t); @@ -4992,16 +5638,14 @@ rb_io_memsize(const rb_io_t *fptr) # define KEEPGVL FALSE #endif -int rb_notify_fd_close(int fd, struct list_head *); static rb_io_t * io_close_fptr(VALUE io) { rb_io_t *fptr; VALUE write_io; rb_io_t *write_fptr; - struct list_head busy; + struct rb_io_close_wait_list busy; - list_head_init(&busy); write_io = GetWriteIO(io); if (io != write_io) { write_fptr = RFILE(write_io)->fptr; @@ -5043,17 +5687,34 @@ rb_io_close(VALUE io) /* * call-seq: - * ios.close -> nil + * close -> nil + * + * Closes the stream for both reading and writing + * if open for either or both; returns +nil+. + * See {Open and Closed Streams}[rdoc-ref:IO@Open+and+Closed+Streams]. * - * Closes <em>ios</em> and flushes any pending writes to the operating - * system. The stream is unavailable for any further data operations; - * an IOError is raised if such an attempt is made. I/O streams are - * automatically closed when they are claimed by the garbage collector. + * If the stream is open for writing, flushes any buffered writes + * to the operating system before closing. * - * If <em>ios</em> is opened by IO.popen, #close sets - * <code>$?</code>. + * If the stream was opened by IO.popen, sets global variable <tt>$?</tt> + * (child exit status). * - * Calling this method on closed IO object is just ignored since Ruby 2.3. + * Example: + * + * IO.popen('ruby', 'r+') do |pipe| + * puts pipe.closed? + * pipe.close + * puts $? + * puts pipe.closed? + * end + * + * Output: + * + * false + * pid 13760 exit 0 + * true + * + * Related: IO#close_read, IO#close_write, IO#closed?. */ static VALUE @@ -5080,9 +5741,9 @@ ignore_closed_stream(VALUE io, VALUE exc) enum {mesg_len = sizeof(closed_stream)-1}; VALUE mesg = rb_attr_get(exc, idMesg); if (!RB_TYPE_P(mesg, T_STRING) || - RSTRING_LEN(mesg) != mesg_len || - memcmp(RSTRING_PTR(mesg), closed_stream, mesg_len)) { - rb_exc_raise(exc); + RSTRING_LEN(mesg) != mesg_len || + memcmp(RSTRING_PTR(mesg), closed_stream, mesg_len)) { + rb_exc_raise(exc); } return io; } @@ -5091,33 +5752,38 @@ static VALUE io_close(VALUE io) { VALUE closed = rb_check_funcall(io, rb_intern("closed?"), 0, 0); - if (closed != Qundef && RTEST(closed)) return io; + if (!UNDEF_P(closed) && RTEST(closed)) return io; rb_rescue2(io_call_close, io, ignore_closed_stream, io, - rb_eIOError, (VALUE)0); + rb_eIOError, (VALUE)0); return io; } /* * call-seq: - * ios.closed? -> true or false + * closed? -> true or false + * + * Returns +true+ if the stream is closed for both reading and writing, + * +false+ otherwise. + * See {Open and Closed Streams}[rdoc-ref:IO@Open+and+Closed+Streams]. + * + * IO.popen('ruby', 'r+') do |pipe| + * puts pipe.closed? + * pipe.close_read + * puts pipe.closed? + * pipe.close_write + * puts pipe.closed? + * end + * + * Output: * - * Returns <code>true</code> if <em>ios</em> is completely closed (for - * duplex streams, both reader and writer), <code>false</code> - * otherwise. + * false + * false + * true * - * f = File.new("testfile") - * f.close #=> nil - * f.closed? #=> true - * f = IO.popen("/bin/sh","r+") - * f.close_write #=> nil - * f.closed? #=> false - * f.close_read #=> nil - * f.closed? #=> true + * Related: IO#close_read, IO#close_write, IO#close. */ - - -static VALUE -rb_io_closed(VALUE io) +VALUE +rb_io_closed_p(VALUE io) { rb_io_t *fptr; VALUE write_io; @@ -5137,22 +5803,34 @@ rb_io_closed(VALUE io) /* * call-seq: - * ios.close_read -> nil + * close_read -> nil * - * Closes the read end of a duplex I/O stream (i.e., one that contains - * both a read and a write stream, such as a pipe). Will raise an - * IOError if the stream is not duplexed. + * Closes the stream for reading if open for reading; + * returns +nil+. + * See {Open and Closed Streams}[rdoc-ref:IO@Open+and+Closed+Streams]. * - * f = IO.popen("/bin/sh","r+") - * f.close_read - * f.readlines + * If the stream was opened by IO.popen and is also closed for writing, + * sets global variable <tt>$?</tt> (child exit status). * - * <em>produces:</em> + * Example: * - * prog.rb:3:in `readlines': not opened for reading (IOError) - * from prog.rb:3 + * IO.popen('ruby', 'r+') do |pipe| + * puts pipe.closed? + * pipe.close_write + * puts pipe.closed? + * pipe.close_read + * puts $? + * puts pipe.closed? + * end * - * Calling this method on closed IO object is just ignored since Ruby 2.3. + * Output: + * + * false + * false + * pid 14748 exit 0 + * true + * + * Related: IO#close, IO#close_write, IO#closed?. */ static VALUE @@ -5177,44 +5855,55 @@ rb_io_close_read(VALUE io) write_io = GetWriteIO(io); if (io != write_io) { - rb_io_t *wfptr; - wfptr = rb_io_get_fptr(rb_io_taint_check(write_io)); - wfptr->pid = fptr->pid; - fptr->pid = 0; + rb_io_t *wfptr; + wfptr = rb_io_get_fptr(rb_io_taint_check(write_io)); + wfptr->pid = fptr->pid; + fptr->pid = 0; RFILE(io)->fptr = wfptr; - /* bind to write_io temporarily to get rid of memory/fd leak */ - fptr->tied_io_for_writing = 0; - RFILE(write_io)->fptr = fptr; - rb_io_fptr_cleanup(fptr, FALSE); - /* should not finalize fptr because another thread may be reading it */ + /* bind to write_io temporarily to get rid of memory/fd leak */ + fptr->tied_io_for_writing = 0; + RFILE(write_io)->fptr = fptr; + rb_io_fptr_cleanup(fptr, FALSE); + /* should not finalize fptr because another thread may be reading it */ return Qnil; } if ((fptr->mode & (FMODE_DUPLEX|FMODE_WRITABLE)) == FMODE_WRITABLE) { - rb_raise(rb_eIOError, "closing non-duplex IO for reading"); + rb_raise(rb_eIOError, "closing non-duplex IO for reading"); } return rb_io_close(io); } /* * call-seq: - * ios.close_write -> nil + * close_write -> nil * - * Closes the write end of a duplex I/O stream (i.e., one that contains - * both a read and a write stream, such as a pipe). Will raise an - * IOError if the stream is not duplexed. + * Closes the stream for writing if open for writing; + * returns +nil+. + * See {Open and Closed Streams}[rdoc-ref:IO@Open+and+Closed+Streams]. * - * f = IO.popen("/bin/sh","r+") - * f.close_write - * f.print "nowhere" + * Flushes any buffered writes to the operating system before closing. * - * <em>produces:</em> + * If the stream was opened by IO.popen and is also closed for reading, + * sets global variable <tt>$?</tt> (child exit status). * - * prog.rb:3:in `write': not opened for writing (IOError) - * from prog.rb:3:in `print' - * from prog.rb:3 + * IO.popen('ruby', 'r+') do |pipe| + * puts pipe.closed? + * pipe.close_read + * puts pipe.closed? + * pipe.close_write + * puts $? + * puts pipe.closed? + * end + * + * Output: * - * Calling this method on closed IO object is just ignored since Ruby 2.3. + * false + * false + * pid 15044 exit 0 + * true + * + * Related: IO#close, IO#close_read, IO#closed?. */ static VALUE @@ -5234,17 +5923,17 @@ rb_io_close_write(VALUE io) rb_sys_fail_path(fptr->pathv); fptr->mode &= ~FMODE_WRITABLE; if (!(fptr->mode & FMODE_READABLE)) - return rb_io_close(write_io); + return rb_io_close(write_io); return Qnil; } if ((fptr->mode & (FMODE_DUPLEX|FMODE_READABLE)) == FMODE_READABLE) { - rb_raise(rb_eIOError, "closing non-duplex IO for writing"); + rb_raise(rb_eIOError, "closing non-duplex IO for writing"); } if (io != write_io) { - fptr = rb_io_get_fptr(rb_io_taint_check(io)); - fptr->tied_io_for_writing = 0; + fptr = rb_io_get_fptr(rb_io_taint_check(io)); + fptr->tied_io_for_writing = 0; } rb_io_close(write_io); return Qnil; @@ -5252,15 +5941,13 @@ rb_io_close_write(VALUE io) /* * call-seq: - * ios.sysseek(offset, whence=IO::SEEK_SET) -> integer + * sysseek(offset, whence = IO::SEEK_SET) -> integer + * + * Behaves like IO#seek, except that it: * - * Seeks to a given <i>offset</i> in the stream according to the value - * of <i>whence</i> (see IO#seek for values of <i>whence</i>). Returns - * the new offset into the file. + * - Uses low-level system functions. + * - Returns the new position. * - * f = File.new("testfile") - * f.sysseek(-13, IO::SEEK_END) #=> 53 - * f.sysread(10) #=> "And so on." */ static VALUE @@ -5269,19 +5956,19 @@ rb_io_sysseek(int argc, VALUE *argv, VALUE io) VALUE offset, ptrname; int whence = SEEK_SET; rb_io_t *fptr; - off_t pos; + rb_off_t pos; if (rb_scan_args(argc, argv, "11", &offset, &ptrname) == 2) { - whence = interpret_seek_whence(ptrname); + whence = interpret_seek_whence(ptrname); } pos = NUM2OFFT(offset); GetOpenFile(io, fptr); if ((fptr->mode & FMODE_READABLE) && (READ_DATA_BUFFERED(fptr) || READ_CHAR_PENDING(fptr))) { - rb_raise(rb_eIOError, "sysseek for buffered IO"); + rb_raise(rb_eIOError, "sysseek for buffered IO"); } if ((fptr->mode & FMODE_WRITABLE) && fptr->wbuf.len) { - rb_warn("sysseek for buffered IO"); + rb_warn("sysseek for buffered IO"); } errno = 0; pos = lseek(fptr->fd, pos, whence); @@ -5292,15 +5979,20 @@ rb_io_sysseek(int argc, VALUE *argv, VALUE io) /* * call-seq: - * ios.syswrite(string) -> integer + * syswrite(object) -> integer * - * Writes the given string to <em>ios</em> using a low-level write. - * Returns the number of bytes written. Do not mix with other methods - * that write to <em>ios</em> or you may get unpredictable results. - * Raises SystemCallError on error. + * Writes the given +object+ to self, which must be opened for writing (see Modes); + * returns the number bytes written. + * If +object+ is not a string is converted via method to_s: + * + * f = File.new('t.tmp', 'w') + * f.syswrite('foo') # => 3 + * f.syswrite(30) # => 2 + * f.syswrite(:foo) # => 3 + * f.close + * + * This methods should not be used with other stream-writer methods. * - * f = File.new("out", "w") - * f.syswrite("ABCDEF") #=> 6 */ static VALUE @@ -5312,19 +6004,19 @@ rb_io_syswrite(VALUE io, VALUE str) const char *ptr; if (!RB_TYPE_P(str, T_STRING)) - str = rb_obj_as_string(str); + str = rb_obj_as_string(str); io = GetWriteIO(io); GetOpenFile(io, fptr); rb_io_check_writable(fptr); if (fptr->wbuf.len) { - rb_warn("syswrite for buffered IO"); + rb_warn("syswrite for buffered IO"); } tmp = rb_str_tmp_frozen_acquire(str); RSTRING_GETMEM(tmp, ptr, len); - n = rb_write_internal(fptr->fd, ptr, len); + n = rb_io_write_memory(fptr, ptr, len); if (n < 0) rb_sys_fail_path(fptr->pathv); rb_str_tmp_frozen_release(str, tmp); @@ -5333,21 +6025,13 @@ rb_io_syswrite(VALUE io, VALUE str) /* * call-seq: - * ios.sysread(maxlen[, outbuf]) -> string + * sysread(maxlen) -> string + * sysread(maxlen, out_string) -> string * - * Reads <i>maxlen</i> bytes from <em>ios</em> using a low-level - * read and returns them as a string. Do not mix with other methods - * that read from <em>ios</em> or you may get unpredictable results. - * - * If the optional _outbuf_ argument is present, - * it must reference a String, which will receive the data. - * The _outbuf_ will contain only the received data after the method call - * even if it is not empty at the beginning. + * Behaves like IO#readpartial, except that it uses low-level system functions. * - * Raises SystemCallError on error and EOFError at end of file. + * This method should not be used with other stream-reader methods. * - * f = File.new("testfile") - * f.sysread(16) #=> "This is line one" */ static VALUE @@ -5376,11 +6060,13 @@ rb_io_sysread(int argc, VALUE *argv, VALUE io) io_setstrbuf(&str, ilen); iis.th = rb_thread_current(); - iis.fd = fptr->fd; + iis.fptr = fptr; iis.nonblock = 0; + iis.fd = fptr->fd; iis.buf = RSTRING_PTR(str); iis.capa = ilen; - n = read_internal_locktmp(str, &iis); + iis.timeout = NULL; + n = io_read_memory_locktmp(str, &iis); if (n < 0) { rb_sys_fail_path(fptr->pathv); @@ -5395,51 +6081,66 @@ rb_io_sysread(int argc, VALUE *argv, VALUE io) return str; } -#if defined(HAVE_PREAD) || defined(HAVE_PWRITE) struct prdwr_internal_arg { + VALUE io; int fd; void *buf; size_t count; - off_t offset; + rb_off_t offset; }; -#endif /* HAVE_PREAD || HAVE_PWRITE */ -#if defined(HAVE_PREAD) static VALUE -internal_pread_func(void *arg) +internal_pread_func(void *_arg) { - struct prdwr_internal_arg *p = arg; - return (VALUE)pread(p->fd, p->buf, p->count, p->offset); + struct prdwr_internal_arg *arg = _arg; + + return (VALUE)pread(arg->fd, arg->buf, arg->count, arg->offset); } static VALUE -pread_internal_call(VALUE arg) +pread_internal_call(VALUE _arg) { - struct prdwr_internal_arg *p = (struct prdwr_internal_arg *)arg; - return rb_thread_io_blocking_region(internal_pread_func, p, p->fd); + struct prdwr_internal_arg *arg = (struct prdwr_internal_arg *)_arg; + + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + VALUE result = rb_fiber_scheduler_io_pread_memory(scheduler, arg->io, arg->offset, arg->buf, arg->count, 0); + + if (!UNDEF_P(result)) { + return rb_fiber_scheduler_io_result_apply(result); + } + } + + return rb_thread_io_blocking_call(internal_pread_func, arg, arg->fd, RB_WAITFD_IN); } /* * call-seq: - * ios.pread(maxlen, offset[, outbuf]) -> string + * pread(maxlen, offset) -> string + * pread(maxlen, offset, out_string) -> string * - * Reads <i>maxlen</i> bytes from <em>ios</em> using the pread system call - * and returns them as a string without modifying the underlying - * descriptor offset. This is advantageous compared to combining IO#seek - * and IO#read in that it is atomic, allowing multiple threads/process to - * share the same IO object for reading the file at various locations. - * This bypasses any userspace buffering of the IO layer. - * If the optional <i>outbuf</i> argument is present, it must - * reference a String, which will receive the data. - * Raises SystemCallError on error, EOFError at end of file and - * NotImplementedError if platform does not implement the system call. + * Behaves like IO#readpartial, except that it: + * + * - Reads at the given +offset+ (in bytes). + * - Disregards, and does not modify, the stream's position + * (see {Position}[rdoc-ref:IO@Position]). + * - Bypasses any user space buffering in the stream. + * + * Because this method does not disturb the stream's state + * (its position, in particular), +pread+ allows multiple threads and processes + * to use the same \IO object for reading at various offsets. + * + * f = File.open('t.txt') + * f.read # => "First line\nSecond line\n\nFourth line\nFifth line\n" + * f.pos # => 52 + * # Read 12 bytes at offset 0. + * f.pread(12, 0) # => "First line\n" + * # Read 9 bytes at offset 8. + * f.pread(9, 8) # => "ne\nSecon" + * f.close + * + * Not available on some platforms. * - * File.write("testfile", "This is line one\nThis is line two\n") - * File.open("testfile") do |f| - * p f.read # => "This is line one\nThis is line two\n" - * p f.pread(12, 0) # => "This is line" - * p f.pread(9, 8) # => "line one\n" - * end */ static VALUE rb_io_pread(int argc, VALUE *argv, VALUE io) @@ -5447,7 +6148,7 @@ rb_io_pread(int argc, VALUE *argv, VALUE io) VALUE len, offset, str; rb_io_t *fptr; ssize_t n; - struct prdwr_internal_arg arg; + struct prdwr_internal_arg arg = {.io = io}; int shrinkable; rb_scan_args(argc, argv, "21", &len, &offset, &str); @@ -5468,57 +6169,69 @@ rb_io_pread(int argc, VALUE *argv, VALUE io) n = (ssize_t)rb_ensure(pread_internal_call, (VALUE)&arg, rb_str_unlocktmp, str); if (n < 0) { - rb_sys_fail_path(fptr->pathv); + rb_sys_fail_path(fptr->pathv); } io_set_read_length(str, n, shrinkable); if (n == 0 && arg.count > 0) { - rb_eof_error(); + rb_eof_error(); } return str; } -#else -# define rb_io_pread rb_f_notimplement -#endif /* HAVE_PREAD */ -#if defined(HAVE_PWRITE) static VALUE -internal_pwrite_func(void *ptr) +internal_pwrite_func(void *_arg) { - struct prdwr_internal_arg *arg = ptr; + struct prdwr_internal_arg *arg = _arg; + + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + VALUE result = rb_fiber_scheduler_io_pwrite_memory(scheduler, arg->io, arg->offset, arg->buf, arg->count, 0); + + if (!UNDEF_P(result)) { + return rb_fiber_scheduler_io_result_apply(result); + } + } + return (VALUE)pwrite(arg->fd, arg->buf, arg->count, arg->offset); } /* * call-seq: - * ios.pwrite(string, offset) -> integer + * pwrite(object, offset) -> integer * - * Writes the given string to <em>ios</em> at <i>offset</i> using pwrite() - * system call. This is advantageous to combining IO#seek and IO#write - * in that it is atomic, allowing multiple threads/process to share the - * same IO object for reading the file at various locations. - * This bypasses any userspace buffering of the IO layer. - * Returns the number of bytes written. - * Raises SystemCallError on error and NotImplementedError - * if platform does not implement the system call. + * Behaves like IO#write, except that it: * - * File.open("out", "w") do |f| - * f.pwrite("ABCDEF", 3) #=> 6 - * end + * - Writes at the given +offset+ (in bytes). + * - Disregards, and does not modify, the stream's position + * (see {Position}[rdoc-ref:IO@Position]). + * - Bypasses any user space buffering in the stream. + * + * Because this method does not disturb the stream's state + * (its position, in particular), +pwrite+ allows multiple threads and processes + * to use the same \IO object for writing at various offsets. + * + * f = File.open('t.tmp', 'w+') + * # Write 6 bytes at offset 3. + * f.pwrite('ABCDEF', 3) # => 6 + * f.rewind + * f.read # => "\u0000\u0000\u0000ABCDEF" + * f.close + * + * Not available on some platforms. * - * File.read("out") #=> "\u0000\u0000\u0000ABCDEF" */ static VALUE rb_io_pwrite(VALUE io, VALUE str, VALUE offset) { rb_io_t *fptr; ssize_t n; - struct prdwr_internal_arg arg; + struct prdwr_internal_arg arg = {.io = io}; VALUE tmp; if (!RB_TYPE_P(str, T_STRING)) - str = rb_obj_as_string(str); + str = rb_obj_as_string(str); arg.offset = NUM2OFFT(offset); @@ -5531,15 +6244,12 @@ rb_io_pwrite(VALUE io, VALUE str, VALUE offset) arg.buf = RSTRING_PTR(tmp); arg.count = (size_t)RSTRING_LEN(tmp); - n = (ssize_t)rb_thread_io_blocking_region(internal_pwrite_func, &arg, fptr->fd); + n = (ssize_t)rb_thread_io_blocking_call(internal_pwrite_func, &arg, fptr->fd, RB_WAITFD_OUT); if (n < 0) rb_sys_fail_path(fptr->pathv); rb_str_tmp_frozen_release(str, tmp); return SSIZET2NUM(n); } -#else -# define rb_io_pwrite rb_f_notimplement -#endif /* HAVE_PWRITE */ VALUE rb_io_binmode(VALUE io) @@ -5556,10 +6266,10 @@ rb_io_binmode(VALUE io) fptr->writeconv_pre_ecflags &= ~ECONV_NEWLINE_DECORATOR_MASK; #ifdef O_BINARY if (!fptr->readconv) { - SET_BINARY_MODE_WITH_SEEK_CUR(fptr); + SET_BINARY_MODE_WITH_SEEK_CUR(fptr); } else { - setmode(fptr->fd, O_BINARY); + setmode(fptr->fd, O_BINARY); } #endif return io; @@ -5600,14 +6310,13 @@ rb_io_ascii8bit_binmode(VALUE io) /* * call-seq: - * ios.binmode -> ios + * binmode -> self * - * Puts <em>ios</em> into binary mode. - * Once a stream is in binary mode, it cannot be reset to nonbinary mode. + * Sets the stream's data mode as binary + * (see {Data Mode}[rdoc-ref:File@Data+Mode]). + * + * A stream's data mode may not be changed from binary to text. * - * - newline conversion disabled - * - encoding conversion disabled - * - content is treated as ASCII-8BIT */ static VALUE @@ -5625,9 +6334,11 @@ rb_io_binmode_m(VALUE io) /* * call-seq: - * ios.binmode? -> true or false + * binmode? -> true or false + * + * Returns +true+ if the stream is on binary mode, +false+ otherwise. + * See {Data Mode}[rdoc-ref:File@Data+Mode]. * - * Returns <code>true</code> if <em>ios</em> is binmode. */ static VALUE rb_io_binmode_p(VALUE io) @@ -5641,23 +6352,23 @@ static const char* rb_io_fmode_modestr(int fmode) { if (fmode & FMODE_APPEND) { - if ((fmode & FMODE_READWRITE) == FMODE_READWRITE) { - return MODE_BTMODE("a+", "ab+", "at+"); - } - return MODE_BTMODE("a", "ab", "at"); + if ((fmode & FMODE_READWRITE) == FMODE_READWRITE) { + return MODE_BTMODE("a+", "ab+", "at+"); + } + return MODE_BTMODE("a", "ab", "at"); } switch (fmode & FMODE_READWRITE) { default: - rb_raise(rb_eArgError, "invalid access fmode 0x%x", fmode); + rb_raise(rb_eArgError, "invalid access fmode 0x%x", fmode); case FMODE_READABLE: - return MODE_BTMODE("r", "rb", "rt"); + return MODE_BTMODE("r", "rb", "rt"); case FMODE_WRITABLE: - return MODE_BTXMODE("w", "wb", "wt", "wx", "wbx", "wtx"); + return MODE_BTXMODE("w", "wb", "wt", "wx", "wbx", "wtx"); case FMODE_READWRITE: - if (fmode & FMODE_CREATE) { + if (fmode & FMODE_CREATE) { return MODE_BTXMODE("w+", "wb+", "wt+", "w+x", "wb+x", "wt+x"); - } - return MODE_BTMODE("r+", "rb+", "rt+"); + } + return MODE_BTMODE("r+", "rb+", "rt+"); } } @@ -5680,27 +6391,27 @@ rb_io_modestr_fmode(const char *modestr) switch (*m++) { case 'r': - fmode |= FMODE_READABLE; - break; + fmode |= FMODE_READABLE; + break; case 'w': - fmode |= FMODE_WRITABLE | FMODE_TRUNC | FMODE_CREATE; - break; + fmode |= FMODE_WRITABLE | FMODE_TRUNC | FMODE_CREATE; + break; case 'a': - fmode |= FMODE_WRITABLE | FMODE_APPEND | FMODE_CREATE; - break; + fmode |= FMODE_WRITABLE | FMODE_APPEND | FMODE_CREATE; + break; default: goto error; } while (*m) { switch (*m++) { - case 'b': + case 'b': fmode |= FMODE_BINMODE; break; - case 't': + case 't': fmode |= FMODE_TEXTMODE; break; - case '+': + case '+': fmode |= FMODE_READWRITE; break; case 'x': @@ -5708,12 +6419,12 @@ rb_io_modestr_fmode(const char *modestr) goto error; fmode |= FMODE_EXCL; break; - default: + default: goto error; - case ':': - p = strchr(m, ':'); - if (io_encname_bom_p(m, p ? (long)(p - m) : (long)strlen(m))) - fmode |= FMODE_SETENC_BY_BOM; + case ':': + p = strchr(m, ':'); + if (io_encname_bom_p(m, p ? (long)(p - m) : (long)strlen(m))) + fmode |= FMODE_SETENC_BY_BOM; goto finished; } } @@ -5736,31 +6447,31 @@ rb_io_oflags_fmode(int oflags) switch (oflags & O_ACCMODE) { case O_RDONLY: - fmode = FMODE_READABLE; - break; + fmode = FMODE_READABLE; + break; case O_WRONLY: - fmode = FMODE_WRITABLE; - break; + fmode = FMODE_WRITABLE; + break; case O_RDWR: - fmode = FMODE_READWRITE; - break; + fmode = FMODE_READWRITE; + break; } if (oflags & O_APPEND) { - fmode |= FMODE_APPEND; + fmode |= FMODE_APPEND; } if (oflags & O_TRUNC) { - fmode |= FMODE_TRUNC; + fmode |= FMODE_TRUNC; } if (oflags & O_CREAT) { - fmode |= FMODE_CREATE; + fmode |= FMODE_CREATE; } if (oflags & O_EXCL) { fmode |= FMODE_EXCL; } #ifdef O_BINARY if (oflags & O_BINARY) { - fmode |= FMODE_BINMODE; + fmode |= FMODE_BINMODE; } #endif @@ -5825,25 +6536,25 @@ rb_io_oflags_modestr(int oflags) } accmode = oflags & (O_RDONLY|O_WRONLY|O_RDWR); if (oflags & O_APPEND) { - if (accmode == O_WRONLY) { - return MODE_BINARY("a", "ab"); - } - if (accmode == O_RDWR) { - return MODE_BINARY("a+", "ab+"); - } + if (accmode == O_WRONLY) { + return MODE_BINARY("a", "ab"); + } + if (accmode == O_RDWR) { + return MODE_BINARY("a+", "ab+"); + } } switch (accmode) { default: - rb_raise(rb_eArgError, "invalid access oflags 0x%x", oflags); + rb_raise(rb_eArgError, "invalid access oflags 0x%x", oflags); case O_RDONLY: - return MODE_BINARY("r", "rb"); + return MODE_BINARY("r", "rb"); case O_WRONLY: - return MODE_BINARY("w", "wb"); + return MODE_BINARY("w", "wb"); case O_RDWR: - if (oflags & O_TRUNC) { - return MODE_BINARY("w+", "wb+"); - } - return MODE_BINARY("r+", "rb+"); + if (oflags & O_TRUNC) { + return MODE_BINARY("w+", "wb+"); + } + return MODE_BINARY("r+", "rb+"); } } @@ -5858,25 +6569,25 @@ rb_io_ext_int_to_encs(rb_encoding *ext, rb_encoding *intern, rb_encoding **enc, int default_ext = 0; if (ext == NULL) { - ext = rb_default_external_encoding(); - default_ext = 1; + ext = rb_default_external_encoding(); + default_ext = 1; } - if (ext == rb_ascii8bit_encoding()) { - /* If external is ASCII-8BIT, no transcoding */ - intern = NULL; + if (rb_is_ascii8bit_enc(ext)) { + /* If external is ASCII-8BIT, no transcoding */ + intern = NULL; } else if (intern == NULL) { - intern = rb_default_internal_encoding(); + intern = rb_default_internal_encoding(); } if (intern == NULL || intern == (rb_encoding *)Qnil || - (!(fmode & FMODE_SETENC_BY_BOM) && (intern == ext))) { - /* No internal encoding => use external + no transcoding */ - *enc = (default_ext && intern != ext) ? NULL : ext; - *enc2 = NULL; + (!(fmode & FMODE_SETENC_BY_BOM) && (intern == ext))) { + /* No internal encoding => use external + no transcoding */ + *enc = (default_ext && intern != ext) ? NULL : ext; + *enc2 = NULL; } else { - *enc = intern; - *enc2 = ext; + *enc = intern; + *enc2 = ext; } } @@ -5888,7 +6599,7 @@ unsupported_encoding(const char *name, rb_encoding *enc) static void parse_mode_enc(const char *estr, rb_encoding *estr_enc, - rb_encoding **enc_p, rb_encoding **enc2_p, int *fmode_p) + rb_encoding **enc_p, rb_encoding **enc2_p, int *fmode_p) { const char *p; char encname[ENCODING_MAXNAMELEN+1]; @@ -5902,53 +6613,53 @@ parse_mode_enc(const char *estr, rb_encoding *estr_enc, p = strrchr(estr, ':'); len = p ? (p++ - estr) : (long)strlen(estr); if ((fmode & FMODE_SETENC_BY_BOM) || io_encname_bom_p(estr, len)) { - estr += bom_prefix_len; - len -= bom_prefix_len; - if (!STRNCASECMP(estr, utf_prefix, utf_prefix_len)) { - fmode |= FMODE_SETENC_BY_BOM; - } - else { - rb_enc_warn(estr_enc, "BOM with non-UTF encoding %s is nonsense", estr); - fmode &= ~FMODE_SETENC_BY_BOM; - } + estr += bom_prefix_len; + len -= bom_prefix_len; + if (!STRNCASECMP(estr, utf_prefix, utf_prefix_len)) { + fmode |= FMODE_SETENC_BY_BOM; + } + else { + rb_enc_warn(estr_enc, "BOM with non-UTF encoding %s is nonsense", estr); + fmode &= ~FMODE_SETENC_BY_BOM; + } } if (len == 0 || len > ENCODING_MAXNAMELEN) { - idx = -1; + idx = -1; } else { - if (p) { - memcpy(encname, estr, len); - encname[len] = '\0'; - estr = encname; - } - idx = rb_enc_find_index(estr); + if (p) { + memcpy(encname, estr, len); + encname[len] = '\0'; + estr = encname; + } + idx = rb_enc_find_index(estr); } if (fmode_p) *fmode_p = fmode; if (idx >= 0) - ext_enc = rb_enc_from_index(idx); + ext_enc = rb_enc_from_index(idx); else { - if (idx != -2) - unsupported_encoding(estr, estr_enc); - ext_enc = NULL; + if (idx != -2) + unsupported_encoding(estr, estr_enc); + ext_enc = NULL; } int_enc = NULL; if (p) { - if (*p == '-' && *(p+1) == '\0') { - /* Special case - "-" => no transcoding */ - int_enc = (rb_encoding *)Qnil; - } - else { - idx2 = rb_enc_find_index(p); - if (idx2 < 0) - unsupported_encoding(p, estr_enc); - else if (!(fmode & FMODE_SETENC_BY_BOM) && (idx2 == idx)) { - int_enc = (rb_encoding *)Qnil; - } - else - int_enc = rb_enc_from_index(idx2); - } + if (*p == '-' && *(p+1) == '\0') { + /* Special case - "-" => no transcoding */ + int_enc = (rb_encoding *)Qnil; + } + else { + idx2 = rb_enc_find_index(p); + if (idx2 < 0) + unsupported_encoding(p, estr_enc); + else if (!(fmode & FMODE_SETENC_BY_BOM) && (idx2 == idx)) { + int_enc = (rb_encoding *)Qnil; + } + else + int_enc = rb_enc_from_index(idx2); + } } rb_io_ext_int_to_encs(ext_enc, int_enc, enc_p, enc2_p, fmode); @@ -5963,68 +6674,66 @@ rb_io_extract_encoding_option(VALUE opt, rb_encoding **enc_p, rb_encoding **enc2 rb_encoding *intencoding = NULL; if (!NIL_P(opt)) { - VALUE v; - v = rb_hash_lookup2(opt, sym_encoding, Qnil); - if (v != Qnil) encoding = v; - v = rb_hash_lookup2(opt, sym_extenc, Qundef); - if (v != Qnil) extenc = v; - v = rb_hash_lookup2(opt, sym_intenc, Qundef); - if (v != Qundef) intenc = v; - } - if ((extenc != Qundef || intenc != Qundef) && !NIL_P(encoding)) { - if (!NIL_P(ruby_verbose)) { - int idx = rb_to_encoding_index(encoding); - if (idx >= 0) encoding = rb_enc_from_encoding(rb_enc_from_index(idx)); - rb_warn("Ignoring encoding parameter '%"PRIsVALUE"': %s_encoding is used", - encoding, extenc == Qundef ? "internal" : "external"); - } - encoding = Qnil; - } - if (extenc != Qundef && !NIL_P(extenc)) { - extencoding = rb_to_encoding(extenc); - } - if (intenc != Qundef) { - if (NIL_P(intenc)) { - /* internal_encoding: nil => no transcoding */ - intencoding = (rb_encoding *)Qnil; - } - else if (!NIL_P(tmp = rb_check_string_type(intenc))) { - char *p = StringValueCStr(tmp); - - if (*p == '-' && *(p+1) == '\0') { - /* Special case - "-" => no transcoding */ - intencoding = (rb_encoding *)Qnil; - } - else { - intencoding = rb_to_encoding(intenc); - } - } - else { - intencoding = rb_to_encoding(intenc); - } - if (extencoding == intencoding) { - intencoding = (rb_encoding *)Qnil; - } + VALUE v; + v = rb_hash_lookup2(opt, sym_encoding, Qnil); + if (v != Qnil) encoding = v; + v = rb_hash_lookup2(opt, sym_extenc, Qundef); + if (v != Qnil) extenc = v; + v = rb_hash_lookup2(opt, sym_intenc, Qundef); + if (!UNDEF_P(v)) intenc = v; + } + if ((!UNDEF_P(extenc) || !UNDEF_P(intenc)) && !NIL_P(encoding)) { + if (!NIL_P(ruby_verbose)) { + int idx = rb_to_encoding_index(encoding); + if (idx >= 0) encoding = rb_enc_from_encoding(rb_enc_from_index(idx)); + rb_warn("Ignoring encoding parameter '%"PRIsVALUE"': %s_encoding is used", + encoding, UNDEF_P(extenc) ? "internal" : "external"); + } + encoding = Qnil; + } + if (!UNDEF_P(extenc) && !NIL_P(extenc)) { + extencoding = rb_to_encoding(extenc); + } + if (!UNDEF_P(intenc)) { + if (NIL_P(intenc)) { + /* internal_encoding: nil => no transcoding */ + intencoding = (rb_encoding *)Qnil; + } + else if (!NIL_P(tmp = rb_check_string_type(intenc))) { + char *p = StringValueCStr(tmp); + + if (*p == '-' && *(p+1) == '\0') { + /* Special case - "-" => no transcoding */ + intencoding = (rb_encoding *)Qnil; + } + else { + intencoding = rb_to_encoding(intenc); + } + } + else { + intencoding = rb_to_encoding(intenc); + } + if (extencoding == intencoding) { + intencoding = (rb_encoding *)Qnil; + } } if (!NIL_P(encoding)) { - extracted = 1; - if (!NIL_P(tmp = rb_check_string_type(encoding))) { - parse_mode_enc(StringValueCStr(tmp), rb_enc_get(tmp), - enc_p, enc2_p, fmode_p); - } - else { - rb_io_ext_int_to_encs(rb_to_encoding(encoding), NULL, enc_p, enc2_p, 0); - } - } - else if (extenc != Qundef || intenc != Qundef) { extracted = 1; - rb_io_ext_int_to_encs(extencoding, intencoding, enc_p, enc2_p, 0); + if (!NIL_P(tmp = rb_check_string_type(encoding))) { + parse_mode_enc(StringValueCStr(tmp), rb_enc_get(tmp), + enc_p, enc2_p, fmode_p); + } + else { + rb_io_ext_int_to_encs(rb_to_encoding(encoding), NULL, enc_p, enc2_p, 0); + } + } + else if (!UNDEF_P(extenc) || !UNDEF_P(intenc)) { + extracted = 1; + rb_io_ext_int_to_encs(extencoding, intencoding, enc_p, enc2_p, 0); } return extracted; } -typedef struct rb_io_enc_t convconfig_t; - static void validate_enc_binmode(int *fmode_p, int ecflags, rb_encoding *enc, rb_encoding *enc2) { @@ -6037,17 +6746,17 @@ validate_enc_binmode(int *fmode_p, int ecflags, rb_encoding *enc, rb_encoding *e rb_raise(rb_eArgError, "ASCII incompatible encoding needs binmode"); if ((fmode & FMODE_BINMODE) && (ecflags & ECONV_NEWLINE_DECORATOR_MASK)) { - rb_raise(rb_eArgError, "newline decorator with binary mode"); + rb_raise(rb_eArgError, "newline decorator with binary mode"); } if (!(fmode & FMODE_BINMODE) && - (DEFAULT_TEXTMODE || (ecflags & ECONV_NEWLINE_DECORATOR_MASK))) { - fmode |= FMODE_TEXTMODE; - *fmode_p = fmode; + (DEFAULT_TEXTMODE || (ecflags & ECONV_NEWLINE_DECORATOR_MASK))) { + fmode |= FMODE_TEXTMODE; + *fmode_p = fmode; } #if !DEFAULT_TEXTMODE else if (!(ecflags & ECONV_NEWLINE_DECORATOR_MASK)) { - fmode &= ~FMODE_TEXTMODE; - *fmode_p = fmode; + fmode &= ~FMODE_TEXTMODE; + *fmode_p = fmode; } #endif } @@ -6056,34 +6765,34 @@ static void extract_binmode(VALUE opthash, int *fmode) { if (!NIL_P(opthash)) { - VALUE v; - v = rb_hash_aref(opthash, sym_textmode); - if (!NIL_P(v)) { - if (*fmode & FMODE_TEXTMODE) - rb_raise(rb_eArgError, "textmode specified twice"); - if (*fmode & FMODE_BINMODE) - rb_raise(rb_eArgError, "both textmode and binmode specified"); - if (RTEST(v)) - *fmode |= FMODE_TEXTMODE; - } - v = rb_hash_aref(opthash, sym_binmode); - if (!NIL_P(v)) { - if (*fmode & FMODE_BINMODE) - rb_raise(rb_eArgError, "binmode specified twice"); - if (*fmode & FMODE_TEXTMODE) - rb_raise(rb_eArgError, "both textmode and binmode specified"); - if (RTEST(v)) - *fmode |= FMODE_BINMODE; - } - - if ((*fmode & FMODE_BINMODE) && (*fmode & FMODE_TEXTMODE)) - rb_raise(rb_eArgError, "both textmode and binmode specified"); + VALUE v; + v = rb_hash_aref(opthash, sym_textmode); + if (!NIL_P(v)) { + if (*fmode & FMODE_TEXTMODE) + rb_raise(rb_eArgError, "textmode specified twice"); + if (*fmode & FMODE_BINMODE) + rb_raise(rb_eArgError, "both textmode and binmode specified"); + if (RTEST(v)) + *fmode |= FMODE_TEXTMODE; + } + v = rb_hash_aref(opthash, sym_binmode); + if (!NIL_P(v)) { + if (*fmode & FMODE_BINMODE) + rb_raise(rb_eArgError, "binmode specified twice"); + if (*fmode & FMODE_TEXTMODE) + rb_raise(rb_eArgError, "both textmode and binmode specified"); + if (RTEST(v)) + *fmode |= FMODE_BINMODE; + } + + if ((*fmode & FMODE_BINMODE) && (*fmode & FMODE_TEXTMODE)) + rb_raise(rb_eArgError, "both textmode and binmode specified"); } } void rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, - int *oflags_p, int *fmode_p, convconfig_t *convconfig_p) + int *oflags_p, int *fmode_p, struct rb_io_encoding *convconfig_p) { VALUE vmode; int oflags, fmode; @@ -6111,7 +6820,7 @@ rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, else { const char *p; - SafeStringValue(vmode); + StringValue(vmode); p = StringValueCStr(vmode); fmode = rb_io_modestr_fmode(p); oflags = rb_io_fmode_oflags(fmode); @@ -6120,24 +6829,24 @@ rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, has_enc = 1; parse_mode_enc(p+1, rb_enc_get(vmode), &enc, &enc2, &fmode); } - else { - rb_encoding *e; + else { + rb_encoding *e; - e = (fmode & FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL; - rb_io_ext_int_to_encs(e, NULL, &enc, &enc2, fmode); - } + e = (fmode & FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL; + rb_io_ext_int_to_encs(e, NULL, &enc, &enc2, fmode); + } } if (NIL_P(opthash)) { - ecflags = (fmode & FMODE_READABLE) ? - MODE_BTMODE(ECONV_DEFAULT_NEWLINE_DECORATOR, - 0, ECONV_UNIVERSAL_NEWLINE_DECORATOR) : 0; + ecflags = (fmode & FMODE_READABLE) ? + MODE_BTMODE(ECONV_DEFAULT_NEWLINE_DECORATOR, + 0, ECONV_UNIVERSAL_NEWLINE_DECORATOR) : 0; #ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE - ecflags |= (fmode & FMODE_WRITABLE) ? - MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE, - 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0; + ecflags |= (fmode & FMODE_WRITABLE) ? + MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE, + 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0; #endif - SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); ecopts = Qnil; if (fmode & FMODE_BINMODE) { #ifdef O_BINARY @@ -6153,57 +6862,57 @@ rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, #endif } else { - VALUE v; - if (!has_vmode) { - v = rb_hash_aref(opthash, sym_mode); - if (!NIL_P(v)) { - if (!NIL_P(vmode)) { - rb_raise(rb_eArgError, "mode specified twice"); - } - has_vmode = 1; - vmode = v; - goto vmode_handle; - } - } - v = rb_hash_aref(opthash, sym_flags); - if (!NIL_P(v)) { - v = rb_to_int(v); - oflags |= NUM2INT(v); - vmode = INT2NUM(oflags); - fmode = rb_io_oflags_fmode(oflags); - } - extract_binmode(opthash, &fmode); - if (fmode & FMODE_BINMODE) { + VALUE v; + if (!has_vmode) { + v = rb_hash_aref(opthash, sym_mode); + if (!NIL_P(v)) { + if (!NIL_P(vmode)) { + rb_raise(rb_eArgError, "mode specified twice"); + } + has_vmode = 1; + vmode = v; + goto vmode_handle; + } + } + v = rb_hash_aref(opthash, sym_flags); + if (!NIL_P(v)) { + v = rb_to_int(v); + oflags |= NUM2INT(v); + vmode = INT2NUM(oflags); + fmode = rb_io_oflags_fmode(oflags); + } + extract_binmode(opthash, &fmode); + if (fmode & FMODE_BINMODE) { #ifdef O_BINARY oflags |= O_BINARY; #endif - if (!has_enc) - rb_io_ext_int_to_encs(rb_ascii8bit_encoding(), NULL, &enc, &enc2, fmode); - } + if (!has_enc) + rb_io_ext_int_to_encs(rb_ascii8bit_encoding(), NULL, &enc, &enc2, fmode); + } #if DEFAULT_TEXTMODE - else if (NIL_P(vmode)) { - fmode |= DEFAULT_TEXTMODE; - } -#endif - v = rb_hash_aref(opthash, sym_perm); - if (!NIL_P(v)) { - if (vperm_p) { - if (!NIL_P(*vperm_p)) { - rb_raise(rb_eArgError, "perm specified twice"); - } - *vperm_p = v; - } - else { - /* perm no use, just ignore */ - } - } - ecflags = (fmode & FMODE_READABLE) ? - MODE_BTMODE(ECONV_DEFAULT_NEWLINE_DECORATOR, - 0, ECONV_UNIVERSAL_NEWLINE_DECORATOR) : 0; + else if (NIL_P(vmode)) { + fmode |= DEFAULT_TEXTMODE; + } +#endif + v = rb_hash_aref(opthash, sym_perm); + if (!NIL_P(v)) { + if (vperm_p) { + if (!NIL_P(*vperm_p)) { + rb_raise(rb_eArgError, "perm specified twice"); + } + *vperm_p = v; + } + else { + /* perm no use, just ignore */ + } + } + ecflags = (fmode & FMODE_READABLE) ? + MODE_BTMODE(ECONV_DEFAULT_NEWLINE_DECORATOR, + 0, ECONV_UNIVERSAL_NEWLINE_DECORATOR) : 0; #ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE - ecflags |= (fmode & FMODE_WRITABLE) ? - MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE, - 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0; + ecflags |= (fmode & FMODE_WRITABLE) ? + MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE, + 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0; #endif if (rb_io_extract_encoding_option(opthash, &enc, &enc2, &fmode)) { @@ -6211,8 +6920,8 @@ rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, rb_raise(rb_eArgError, "encoding specified twice"); } } - SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); - ecflags = rb_econv_prepare_options(opthash, &ecopts, ecflags); + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); + ecflags = rb_econv_prepare_options(opthash, &ecopts, ecflags); } validate_enc_binmode(&fmode, ecflags, enc, enc2); @@ -6244,8 +6953,7 @@ sysopen_func(void *ptr) static inline int rb_sysopen_internal(struct sysopen_struct *data) { - int fd; - fd = (int)(VALUE)rb_thread_call_without_gvl(sysopen_func, data, RUBY_UBF_IO, 0); + int fd = IO_WITHOUT_GVL_INT(sysopen_func, data); if (0 <= fd) rb_update_max_fd(fd); return fd; @@ -6254,7 +6962,7 @@ rb_sysopen_internal(struct sysopen_struct *data) static int rb_sysopen(VALUE fname, int oflags, mode_t perm) { - int fd; + int fd = -1; struct sysopen_struct data; data.fname = rb_str_encode_ospath(fname); @@ -6262,21 +6970,14 @@ rb_sysopen(VALUE fname, int oflags, mode_t perm) data.oflags = oflags; data.perm = perm; - fd = rb_sysopen_internal(&data); - if (fd < 0) { - int e = errno; - if (rb_gc_for_fd(e)) { - fd = rb_sysopen_internal(&data); - } - if (fd < 0) { - rb_syserr_fail_path(e, fname); - } + TRY_WITH_GC((fd = rb_sysopen_internal(&data)) >= 0) { + rb_syserr_fail_path(first_errno, fname); } return fd; } -FILE * -rb_fdopen(int fd, const char *modestr) +static inline FILE * +fdopen_internal(int fd, const char *modestr) { FILE *file; @@ -6285,32 +6986,28 @@ rb_fdopen(int fd, const char *modestr) #endif file = fdopen(fd, modestr); if (!file) { - int e = errno; -#if defined(__sun) - if (e == 0) { - rb_gc(); - errno = 0; - file = fdopen(fd, modestr); - } - else -#endif - if (rb_gc_for_fd(e)) { - file = fdopen(fd, modestr); - } - if (!file) { #ifdef _WIN32 - if (e == 0) e = EINVAL; + if (errno == 0) errno = EINVAL; #elif defined(__sun) - if (e == 0) e = EMFILE; + if (errno == 0) errno = EMFILE; #endif - rb_syserr_fail(e, 0); - } + } + return file; +} + +FILE * +rb_fdopen(int fd, const char *modestr) +{ + FILE *file = 0; + + TRY_WITH_GC((file = fdopen_internal(fd, modestr)) != 0) { + rb_syserr_fail(first_errno, 0); } /* xxx: should be _IONBF? A buffer in FILE may have trouble. */ #ifdef USE_SETVBUF if (setvbuf(file, NULL, _IOFBF, 0) != 0) - rb_warn("setvbuf() can't be honoured (fd=%d)", fd); + rb_warn("setvbuf() can't be honoured (fd=%d)", fd); #endif return file; } @@ -6338,53 +7035,53 @@ io_strip_bom(VALUE io) if (NIL_P(b1 = rb_io_getbyte(io))) return 0; switch (b1) { case INT2FIX(0xEF): - if (NIL_P(b2 = rb_io_getbyte(io))) break; - if (b2 == INT2FIX(0xBB) && !NIL_P(b3 = rb_io_getbyte(io))) { - if (b3 == INT2FIX(0xBF)) { - return rb_utf8_encindex(); - } - rb_io_ungetbyte(io, b3); - } - rb_io_ungetbyte(io, b2); - break; + if (NIL_P(b2 = rb_io_getbyte(io))) break; + if (b2 == INT2FIX(0xBB) && !NIL_P(b3 = rb_io_getbyte(io))) { + if (b3 == INT2FIX(0xBF)) { + return rb_utf8_encindex(); + } + rb_io_ungetbyte(io, b3); + } + rb_io_ungetbyte(io, b2); + break; case INT2FIX(0xFE): - if (NIL_P(b2 = rb_io_getbyte(io))) break; - if (b2 == INT2FIX(0xFF)) { - return ENCINDEX_UTF_16BE; - } - rb_io_ungetbyte(io, b2); - break; + if (NIL_P(b2 = rb_io_getbyte(io))) break; + if (b2 == INT2FIX(0xFF)) { + return ENCINDEX_UTF_16BE; + } + rb_io_ungetbyte(io, b2); + break; case INT2FIX(0xFF): - if (NIL_P(b2 = rb_io_getbyte(io))) break; - if (b2 == INT2FIX(0xFE)) { - b3 = rb_io_getbyte(io); - if (b3 == INT2FIX(0) && !NIL_P(b4 = rb_io_getbyte(io))) { - if (b4 == INT2FIX(0)) { - return ENCINDEX_UTF_32LE; - } - rb_io_ungetbyte(io, b4); - } + if (NIL_P(b2 = rb_io_getbyte(io))) break; + if (b2 == INT2FIX(0xFE)) { + b3 = rb_io_getbyte(io); + if (b3 == INT2FIX(0) && !NIL_P(b4 = rb_io_getbyte(io))) { + if (b4 == INT2FIX(0)) { + return ENCINDEX_UTF_32LE; + } + rb_io_ungetbyte(io, b4); + } rb_io_ungetbyte(io, b3); return ENCINDEX_UTF_16LE; - } - rb_io_ungetbyte(io, b2); - break; + } + rb_io_ungetbyte(io, b2); + break; case INT2FIX(0): - if (NIL_P(b2 = rb_io_getbyte(io))) break; - if (b2 == INT2FIX(0) && !NIL_P(b3 = rb_io_getbyte(io))) { - if (b3 == INT2FIX(0xFE) && !NIL_P(b4 = rb_io_getbyte(io))) { - if (b4 == INT2FIX(0xFF)) { - return ENCINDEX_UTF_32BE; - } - rb_io_ungetbyte(io, b4); - } - rb_io_ungetbyte(io, b3); - } - rb_io_ungetbyte(io, b2); - break; + if (NIL_P(b2 = rb_io_getbyte(io))) break; + if (b2 == INT2FIX(0) && !NIL_P(b3 = rb_io_getbyte(io))) { + if (b3 == INT2FIX(0xFE) && !NIL_P(b4 = rb_io_getbyte(io))) { + if (b4 == INT2FIX(0xFF)) { + return ENCINDEX_UTF_32BE; + } + rb_io_ungetbyte(io, b4); + } + rb_io_ungetbyte(io, b3); + } + rb_io_ungetbyte(io, b2); + break; } rb_io_ungetbyte(io, b1); return 0; @@ -6404,27 +7101,27 @@ io_set_encoding_by_bom(VALUE io) rb_io_internal_encoding(io), Qnil); } else { - fptr->encs.enc2 = NULL; + fptr->encs.enc2 = NULL; } return extenc; } static VALUE rb_file_open_generic(VALUE io, VALUE filename, int oflags, int fmode, - const convconfig_t *convconfig, mode_t perm) + const struct rb_io_encoding *convconfig, mode_t perm) { VALUE pathv; rb_io_t *fptr; - convconfig_t cc; + struct rb_io_encoding cc; if (!convconfig) { - /* Set to default encodings */ - rb_io_ext_int_to_encs(NULL, NULL, &cc.enc, &cc.enc2, fmode); + /* Set to default encodings */ + rb_io_ext_int_to_encs(NULL, NULL, &cc.enc, &cc.enc2, fmode); cc.ecflags = 0; cc.ecopts = Qnil; convconfig = &cc; } validate_enc_binmode(&fmode, convconfig->ecflags, - convconfig->enc, convconfig->enc2); + convconfig->enc, convconfig->enc2); MakeOpenFile(io, fptr); fptr->mode = fmode; @@ -6449,24 +7146,31 @@ rb_file_open_internal(VALUE io, VALUE filename, const char *modestr) { int fmode = rb_io_modestr_fmode(modestr); const char *p = strchr(modestr, ':'); - convconfig_t convconfig; + struct rb_io_encoding convconfig; if (p) { parse_mode_enc(p+1, rb_usascii_encoding(), - &convconfig.enc, &convconfig.enc2, &fmode); - convconfig.ecflags = 0; - convconfig.ecopts = Qnil; + &convconfig.enc, &convconfig.enc2, &fmode); } else { - rb_encoding *e; - /* Set to default encodings */ + rb_encoding *e; + /* Set to default encodings */ - e = (fmode & FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL; - rb_io_ext_int_to_encs(e, NULL, &convconfig.enc, &convconfig.enc2, fmode); - convconfig.ecflags = 0; - convconfig.ecopts = Qnil; + e = (fmode & FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL; + rb_io_ext_int_to_encs(e, NULL, &convconfig.enc, &convconfig.enc2, fmode); } + convconfig.ecflags = (fmode & FMODE_READABLE) ? + MODE_BTMODE(ECONV_DEFAULT_NEWLINE_DECORATOR, + 0, ECONV_UNIVERSAL_NEWLINE_DECORATOR) : 0; +#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE + convconfig.ecflags |= (fmode & FMODE_WRITABLE) ? + MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE, + 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0; +#endif + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(convconfig.enc2, convconfig.ecflags); + convconfig.ecopts = Qnil; + return rb_file_open_generic(io, filename, rb_io_fmode_oflags(fmode), fmode, @@ -6511,12 +7215,12 @@ pipe_del_fptr(rb_io_t *fptr) struct pipe_list *tmp; while ((tmp = *prev) != 0) { - if (tmp->fptr == fptr) { - *prev = tmp->next; - free(tmp); - return; - } - prev = &tmp->next; + if (tmp->fptr == fptr) { + *prev = tmp->next; + free(tmp); + return; + } + prev = &tmp->next; } } @@ -6528,9 +7232,9 @@ pipe_atexit(void) struct pipe_list *tmp; while (list) { - tmp = list->next; - rb_io_fptr_finalize(list->fptr); - list = tmp; + tmp = list->next; + rb_io_fptr_finalize(list->fptr); + list = tmp; } } #endif @@ -6557,7 +7261,7 @@ static void fptr_copy_finalizer(rb_io_t *fptr, const rb_io_t *orig) { #if defined(__CYGWIN__) || !defined(HAVE_WORKING_FORK) - void (*const old_finalize)(struct rb_io_t*,int) = fptr->finalize; + void (*const old_finalize)(struct rb_io*,int) = fptr->finalize; if (old_finalize == orig->finalize) return; #endif @@ -6566,14 +7270,14 @@ fptr_copy_finalizer(rb_io_t *fptr, const rb_io_t *orig) #if defined(__CYGWIN__) || !defined(HAVE_WORKING_FORK) if (old_finalize != pipe_finalize) { - struct pipe_list *list; - for (list = pipe_list; list; list = list->next) { - if (list->fptr == fptr) break; - } - if (!list) pipe_add_fptr(fptr); + struct pipe_list *list; + for (list = pipe_list; list; list = list->next) { + if (list->fptr == fptr) break; + } + if (!list) pipe_add_fptr(fptr); } else { - pipe_del_fptr(fptr); + pipe_del_fptr(fptr); } #endif } @@ -6595,12 +7299,7 @@ int rb_pipe(int *pipes) { int ret; - ret = rb_cloexec_pipe(pipes); - if (ret < 0) { - if (rb_gc_for_fd(errno)) { - ret = rb_cloexec_pipe(pipes); - } - } + TRY_WITH_GC((ret = rb_cloexec_pipe(pipes)) >= 0); if (ret == 0) { rb_update_max_fd(pipes[0]); rb_update_max_fd(pipes[1]); @@ -6724,15 +7423,15 @@ rb_close_before_exec(int lowfd, int maxhint, VALUE noclose_fds) if (!NIL_P(noclose_fds) && RTEST(rb_hash_lookup(noclose_fds, INT2FIX(fd)))) /* async-signal-safe */ continue; - ret = fcntl(fd, F_GETFD); /* async-signal-safe */ - if (ret != -1 && !(ret & FD_CLOEXEC)) { + ret = fcntl(fd, F_GETFD); /* async-signal-safe */ + if (ret != -1 && !(ret & FD_CLOEXEC)) { fcntl(fd, F_SETFD, ret|FD_CLOEXEC); /* async-signal-safe */ } # define CONTIGUOUS_CLOSED_FDS 20 if (ret != -1) { - if (max < fd + CONTIGUOUS_CLOSED_FDS) - max = fd + CONTIGUOUS_CLOSED_FDS; - } + if (max < fd + CONTIGUOUS_CLOSED_FDS) + max = fd + CONTIGUOUS_CLOSED_FDS; + } } #endif } @@ -6762,7 +7461,7 @@ char *rb_execarg_commandline(const struct rb_execarg *eargp, VALUE *prog); #ifndef __EMSCRIPTEN__ static VALUE pipe_open(VALUE execarg_obj, const char *modestr, int fmode, - const convconfig_t *convconfig) + const struct rb_io_encoding *convconfig) { struct rb_execarg *eargp = NIL_P(execarg_obj) ? NULL : rb_execarg_get(execarg_obj); VALUE prog = eargp ? (eargp->use_shell ? eargp->invoke.sh.shell_script : eargp->invoke.cmd.command_name) : Qfalse ; @@ -6783,12 +7482,12 @@ pipe_open(VALUE execarg_obj, const char *modestr, int fmode, #if defined(HAVE_SPAWNV) # if defined(HAVE_SPAWNVE) # define DO_SPAWN(cmd, args, envp) ((args) ? \ - spawnve(P_NOWAIT, (cmd), (args), (envp)) : \ - spawne(P_NOWAIT, (cmd), (envp))) + spawnve(P_NOWAIT, (cmd), (args), (envp)) : \ + spawne(P_NOWAIT, (cmd), (envp))) # else # define DO_SPAWN(cmd, args, envp) ((args) ? \ - spawnv(P_NOWAIT, (cmd), (args)) : \ - spawn(P_NOWAIT, (cmd))) + spawnv(P_NOWAIT, (cmd), (args)) : \ + spawn(P_NOWAIT, (cmd))) # endif # if !defined(HAVE_WORKING_FORK) char **args = NULL; @@ -6835,19 +7534,19 @@ pipe_open(VALUE execarg_obj, const char *modestr, int fmode, rb_execarg_addopt(execarg_obj, INT2FIX(0), INT2FIX(arg.write_pair[0])); rb_execarg_addopt(execarg_obj, INT2FIX(1), INT2FIX(arg.pair[1])); } - break; + break; case FMODE_READABLE: if (rb_pipe(arg.pair) < 0) rb_sys_fail_str(prog); if (eargp) rb_execarg_addopt(execarg_obj, INT2FIX(1), INT2FIX(arg.pair[1])); - break; + break; case FMODE_WRITABLE: if (rb_pipe(arg.pair) < 0) rb_sys_fail_str(prog); if (eargp) rb_execarg_addopt(execarg_obj, INT2FIX(0), INT2FIX(arg.pair[0])); - break; + break; default: rb_sys_fail_str(prog); } @@ -6863,59 +7562,59 @@ pipe_open(VALUE execarg_obj, const char *modestr, int fmode, } # if defined(HAVE_WORKING_FORK) - pid = rb_fork_async_signal_safe(&status, popen_exec, &arg, arg.eargp->redirect_fds, errmsg, sizeof(errmsg)); + pid = rb_fork_async_signal_safe(&status, popen_exec, &arg, arg.eargp->redirect_fds, errmsg, sizeof(errmsg)); # else - rb_execarg_run_options(eargp, sargp, NULL, 0); + rb_execarg_run_options(eargp, sargp, NULL, 0); # if defined(HAVE_SPAWNVE) - if (eargp->envp_str) envp = (char **)RSTRING_PTR(eargp->envp_str); + if (eargp->envp_str) envp = (char **)RSTRING_PTR(eargp->envp_str); # endif while ((pid = DO_SPAWN(cmd, args, envp)) < 0) { - /* exec failed */ - switch (e = errno) { - case EAGAIN: -# if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN - case EWOULDBLOCK: + /* exec failed */ + switch (e = errno) { + case EAGAIN: +# if EWOULDBLOCK != EAGAIN + case EWOULDBLOCK: # endif - rb_thread_sleep(1); - continue; - } - break; - } - if (eargp) - rb_execarg_run_options(sargp, NULL, NULL, 0); + rb_thread_sleep(1); + continue; + } + break; + } + if (eargp) + rb_execarg_run_options(sargp, NULL, NULL, 0); # endif rb_execarg_parent_end(execarg_obj); } else { # if defined(HAVE_WORKING_FORK) - pid = rb_fork_ruby(&status); - if (pid == 0) { /* child */ - popen_redirect(&arg); - rb_io_synchronized(RFILE(orig_stdout)->fptr); - rb_io_synchronized(RFILE(orig_stderr)->fptr); - return Qnil; - } + pid = rb_call_proc__fork(); + if (pid == 0) { /* child */ + popen_redirect(&arg); + rb_io_synchronized(RFILE(orig_stdout)->fptr); + rb_io_synchronized(RFILE(orig_stderr)->fptr); + return Qnil; + } # else - rb_notimplement(); + rb_notimplement(); # endif } /* parent */ if (pid < 0) { # if defined(HAVE_WORKING_FORK) - e = errno; + e = errno; # endif - close(arg.pair[0]); - close(arg.pair[1]); + close(arg.pair[0]); + close(arg.pair[1]); if ((fmode & (FMODE_READABLE|FMODE_WRITABLE)) == (FMODE_READABLE|FMODE_WRITABLE)) { close(arg.write_pair[0]); close(arg.write_pair[1]); } # if defined(HAVE_WORKING_FORK) if (errmsg[0]) - rb_syserr_fail(e, errmsg); + rb_syserr_fail(e, errmsg); # endif - rb_syserr_fail_str(e, prog); + rb_syserr_fail_str(e, prog); } if ((fmode & FMODE_READABLE) && (fmode & FMODE_WRITABLE)) { close(arg.pair[1]); @@ -6934,14 +7633,14 @@ pipe_open(VALUE execarg_obj, const char *modestr, int fmode, #else cmd = rb_execarg_commandline(eargp, &prog); if (!NIL_P(execarg_obj)) { - rb_execarg_parent_start(execarg_obj); - rb_execarg_run_options(eargp, sargp, NULL, 0); + rb_execarg_parent_start(execarg_obj); + rb_execarg_run_options(eargp, sargp, NULL, 0); } fp = popen(cmd, modestr); e = errno; if (eargp) { rb_execarg_parent_end(execarg_obj); - rb_execarg_run_options(sargp, NULL, NULL, 0); + rb_execarg_run_options(sargp, NULL, NULL, 0); } if (!fp) rb_syserr_fail_path(e, prog); fd = fileno(fp); @@ -6955,19 +7654,19 @@ pipe_open(VALUE execarg_obj, const char *modestr, int fmode, if (convconfig) { fptr->encs = *convconfig; #if RUBY_CRLF_ENVIRONMENT - if (fptr->encs.ecflags & ECONV_DEFAULT_NEWLINE_DECORATOR) { - fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; - } + if (fptr->encs.ecflags & ECONV_DEFAULT_NEWLINE_DECORATOR) { + fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; + } #endif } else { - if (NEED_NEWLINE_DECORATOR_ON_READ(fptr)) { - fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; - } + if (NEED_NEWLINE_DECORATOR_ON_READ(fptr)) { + fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; + } #ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE - if (NEED_NEWLINE_DECORATOR_ON_WRITE(fptr)) { - fptr->encs.ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE; - } + if (NEED_NEWLINE_DECORATOR_ON_WRITE(fptr)) { + fptr->encs.ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE; + } #endif } fptr->pid = pid; @@ -6991,7 +7690,7 @@ pipe_open(VALUE execarg_obj, const char *modestr, int fmode, #else static VALUE pipe_open(VALUE execarg_obj, const char *modestr, int fmode, - const convconfig_t *convconfig) + const struct rb_io_encoding *convconfig) { rb_raise(rb_eNotImpError, "popen() is not available"); } @@ -7002,10 +7701,10 @@ is_popen_fork(VALUE prog) { if (RSTRING_LEN(prog) == 1 && RSTRING_PTR(prog)[0] == '-') { #if !defined(HAVE_WORKING_FORK) - rb_raise(rb_eNotImpError, - "fork() function is unimplemented on this machine"); + rb_raise(rb_eNotImpError, + "fork() function is unimplemented on this machine"); #else - return TRUE; + return TRUE; #endif } return FALSE; @@ -7013,7 +7712,7 @@ is_popen_fork(VALUE prog) static VALUE pipe_open_s(VALUE prog, const char *modestr, int fmode, - const convconfig_t *convconfig) + const struct rb_io_encoding *convconfig) { int argc = 1; VALUE *argv = &prog; @@ -7029,7 +7728,7 @@ pipe_close(VALUE io) { rb_io_t *fptr = io_close_fptr(io); if (fptr) { - fptr_waitpid(fptr, rb_thread_to_be_killed(rb_thread_current())); + fptr_waitpid(fptr, rb_thread_to_be_killed(rb_thread_current())); } return Qnil; } @@ -7038,67 +7737,136 @@ static VALUE popen_finish(VALUE port, VALUE klass); /* * call-seq: - * IO.popen([env,] cmd, mode="r" [, opt]) -> io - * IO.popen([env,] cmd, mode="r" [, opt]) {|io| block } -> obj + * IO.popen(env = {}, cmd, mode = 'r', **opts) -> io + * IO.popen(env = {}, cmd, mode = 'r', **opts) {|io| ... } -> object * - * Runs the specified command as a subprocess; the subprocess's - * standard input and output will be connected to the returned - * IO object. + * Executes the given command +cmd+ as a subprocess + * whose $stdin and $stdout are connected to a new stream +io+. * - * The PID of the started process can be obtained by IO#pid method. + * This method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. * - * _cmd_ is a string or an array as follows. + * If no block is given, returns the new stream, + * which depending on given +mode+ may be open for reading, writing, or both. + * The stream should be explicitly closed (eventually) to avoid resource leaks. * - * cmd: - * "-" : fork - * commandline : command line string which is passed to a shell - * [env, cmdname, arg1, ..., opts] : command name and zero or more arguments (no shell) - * [env, [cmdname, argv0], arg1, ..., opts] : command name, argv[0] and zero or more arguments (no shell) - * (env and opts are optional.) + * If a block is given, the stream is passed to the block + * (again, open for reading, writing, or both); + * when the block exits, the stream is closed, + * and the block's value is assigned to global variable <tt>$?</tt> and returned. * - * If _cmd_ is a +String+ ``<code>-</code>'', - * then a new instance of Ruby is started as the subprocess. + * Optional argument +mode+ may be any valid \IO mode. + * See {Access Modes}[rdoc-ref:File@Access+Modes]. * - * If <i>cmd</i> is an +Array+ of +String+, - * then it will be used as the subprocess's +argv+ bypassing a shell. - * The array can contain a hash at first for environments and - * a hash at last for options similar to #spawn. + * Required argument +cmd+ determines which of the following occurs: * - * The default mode for the new file object is ``r'', - * but <i>mode</i> may be set to any of the modes listed in the description for class IO. - * The last argument <i>opt</i> qualifies <i>mode</i>. + * - The process forks. + * - A specified program runs in a shell. + * - A specified program runs with specified arguments. + * - A specified program runs with specified arguments and a specified +argv0+. * - * # set IO encoding - * IO.popen("nkf -e filename", :external_encoding=>"EUC-JP") {|nkf_io| - * euc_jp_string = nkf_io.read - * } + * Each of these is detailed below. * - * # merge standard output and standard error using - * # spawn option. See the document of Kernel.spawn. - * IO.popen(["ls", "/", :err=>[:child, :out]]) {|ls_io| - * ls_result_with_error = ls_io.read - * } + * The optional hash argument +env+ specifies name/value pairs that are to be added + * to the environment variables for the subprocess: * - * # spawn options can be mixed with IO options - * IO.popen(["ls", "/"], :err=>[:child, :out]) {|ls_io| - * ls_result_with_error = ls_io.read - * } + * IO.popen({'FOO' => 'bar'}, 'ruby', 'r+') do |pipe| + * pipe.puts 'puts ENV["FOO"]' + * pipe.close_write + * pipe.gets + * end => "bar\n" * - * Raises exceptions which IO.pipe and Kernel.spawn raise. + * Optional keyword arguments +opts+ specify: * - * If a block is given, Ruby will run the command as a child connected - * to Ruby with a pipe. Ruby's end of the pipe will be passed as a - * parameter to the block. - * At the end of block, Ruby closes the pipe and sets <code>$?</code>. - * In this case IO.popen returns the value of the block. + * - {Open options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. + * - Options for Kernel#spawn. * - * If a block is given with a _cmd_ of ``<code>-</code>'', - * the block will be run in two separate processes: once in the parent, - * and once in a child. The parent process will be passed the pipe - * object as a parameter to the block, the child version of the block - * will be passed +nil+, and the child's standard in and - * standard out will be connected to the parent through the pipe. Not - * available on all platforms. + * <b>Forked \Process</b> + * + * When argument +cmd+ is the 1-character string <tt>'-'</tt>, causes the process to fork: + * IO.popen('-') do |pipe| + * if pipe + * $stderr.puts "In parent, child pid is #{pipe.pid}\n" + * else + * $stderr.puts "In child, pid is #{$$}\n" + * end + * end + * + * Output: + * + * In parent, child pid is 26253 + * In child, pid is 26253 + * + * Note that this is not supported on all platforms. + * + * <b>Shell Subprocess</b> + * + * When argument +cmd+ is a single string (but not <tt>'-'</tt>), + * the program named +cmd+ is run as a shell command: + * + * IO.popen('uname') do |pipe| + * pipe.readlines + * end + * + * Output: + * + * ["Linux\n"] + * + * Another example: + * + * IO.popen('/bin/sh', 'r+') do |pipe| + * pipe.puts('ls') + * pipe.close_write + * $stderr.puts pipe.readlines.size + * end + * + * Output: + * + * 213 + * + * <b>Program Subprocess</b> + * + * When argument +cmd+ is an array of strings, + * the program named <tt>cmd[0]</tt> is run with all elements of +cmd+ as its arguments: + * + * IO.popen(['du', '..', '.']) do |pipe| + * $stderr.puts pipe.readlines.size + * end + * + * Output: + * + * 1111 + * + * <b>Program Subprocess with <tt>argv0</tt></b> + * + * When argument +cmd+ is an array whose first element is a 2-element string array + * and whose remaining elements (if any) are strings: + * + * - <tt>cmd[0][0]</tt> (the first string in the nested array) is the name of a program that is run. + * - <tt>cmd[0][1]</tt> (the second string in the nested array) is set as the program's <tt>argv[0]</tt>. + * - <tt>cmd[1..-1]</tt> (the strings in the outer array) are the program's arguments. + * + * Example (sets <tt>$0</tt> to 'foo'): + * + * IO.popen([['/bin/sh', 'foo'], '-c', 'echo $0']).read # => "foo\n" + * + * <b>Some Special Examples</b> + * + * # Set IO encoding. + * IO.popen("nkf -e filename", :external_encoding=>"EUC-JP") {|nkf_io| + * euc_jp_string = nkf_io.read + * } + * + * # Merge standard output and standard error using Kernel#spawn option. See Kernel#spawn. + * IO.popen(["ls", "/", :err=>[:child, :out]]) do |io| + * ls_result_with_error = io.read + * end + * + * # Use mixture of spawn options and IO options. + * IO.popen(["ls", "/"], :err=>[:child, :out]) do |io| + * ls_result_with_error = io.read + * end * * f = IO.popen("uname") * p f.readlines @@ -7111,7 +7879,7 @@ static VALUE popen_finish(VALUE port, VALUE klass); * f.puts "bar"; f.close_write; puts f.gets * } * - * <em>produces:</em> + * Output (from last section): * * ["Linux\n"] * Parent is 21346 @@ -7120,6 +7888,9 @@ static VALUE popen_finish(VALUE port, VALUE klass); * 21352 is here, f is nil * #<Process::Status: pid 21352 exit 0> * <foo>bar;zot; + * + * Raises exceptions that IO.pipe and Kernel.spawn raise. + * */ static VALUE @@ -7131,15 +7902,15 @@ rb_io_s_popen(int argc, VALUE *argv, VALUE klass) if (argc > 1 && !NIL_P(env = rb_check_hash_type(argv[0]))) --argc, ++argv; switch (argc) { case 2: - pmode = argv[1]; + pmode = argv[1]; case 1: - pname = argv[0]; - break; + pname = argv[0]; + break; default: - { - int ex = !NIL_P(opt); - rb_error_arity(argc + ex, 1 + ex, 2 + ex); - } + { + int ex = !NIL_P(opt); + rb_error_arity(argc + ex, 1 + ex, 2 + ex); + } } return popen_finish(rb_io_popen(pname, pmode, env, opt), klass); } @@ -7150,30 +7921,30 @@ rb_io_popen(VALUE pname, VALUE pmode, VALUE env, VALUE opt) const char *modestr; VALUE tmp, execarg_obj = Qnil; int oflags, fmode; - convconfig_t convconfig; + struct rb_io_encoding convconfig; tmp = rb_check_array_type(pname); if (!NIL_P(tmp)) { - long len = RARRAY_LEN(tmp); + long len = RARRAY_LEN(tmp); #if SIZEOF_LONG > SIZEOF_INT - if (len > INT_MAX) { - rb_raise(rb_eArgError, "too many arguments"); - } + if (len > INT_MAX) { + rb_raise(rb_eArgError, "too many arguments"); + } #endif execarg_obj = rb_execarg_new((int)len, RARRAY_CONST_PTR(tmp), FALSE, FALSE); - RB_GC_GUARD(tmp); + RB_GC_GUARD(tmp); } else { - SafeStringValue(pname); - execarg_obj = Qnil; - if (!is_popen_fork(pname)) + StringValue(pname); + execarg_obj = Qnil; + if (!is_popen_fork(pname)) execarg_obj = rb_execarg_new(1, &pname, TRUE, FALSE); } if (!NIL_P(execarg_obj)) { - if (!NIL_P(opt)) - opt = rb_execarg_extract_options(execarg_obj, opt); - if (!NIL_P(env)) - rb_execarg_setenv(execarg_obj, env); + if (!NIL_P(opt)) + opt = rb_execarg_extract_options(execarg_obj, opt); + if (!NIL_P(env)) + rb_execarg_setenv(execarg_obj, env); } rb_io_extract_modeenc(&pmode, 0, opt, &oflags, &fmode, &convconfig); modestr = rb_io_oflags_modestr(oflags); @@ -7185,26 +7956,80 @@ static VALUE popen_finish(VALUE port, VALUE klass) { if (NIL_P(port)) { - /* child */ - if (rb_block_given_p()) { - rb_yield(Qnil); + /* child */ + if (rb_block_given_p()) { + rb_yield(Qnil); rb_io_flush(rb_ractor_stdout()); rb_io_flush(rb_ractor_stderr()); - _exit(0); - } - return Qnil; + _exit(0); + } + return Qnil; } RBASIC_SET_CLASS(port, klass); if (rb_block_given_p()) { - return rb_ensure(rb_yield, port, pipe_close, port); + return rb_ensure(rb_yield, port, pipe_close, port); } return port; } +#if defined(HAVE_WORKING_FORK) && !defined(__EMSCRIPTEN__) +struct popen_writer_arg { + char *const *argv; + struct popen_arg popen; +}; + +static int +exec_popen_writer(void *arg, char *errmsg, size_t buflen) +{ + struct popen_writer_arg *pw = arg; + pw->popen.modef = FMODE_WRITABLE; + popen_redirect(&pw->popen); + execv(pw->argv[0], pw->argv); + strlcpy(errmsg, strerror(errno), buflen); + return -1; +} +#endif + +FILE * +ruby_popen_writer(char *const *argv, rb_pid_t *pid) +{ +#if (defined(HAVE_WORKING_FORK) && !defined(__EMSCRIPTEN__)) || defined(_WIN32) +# ifdef HAVE_WORKING_FORK + struct popen_writer_arg pw; + int *const write_pair = pw.popen.pair; +# else + int write_pair[2]; +# endif + + int result = rb_cloexec_pipe(write_pair); + *pid = -1; + if (result == 0) { +# ifdef HAVE_WORKING_FORK + pw.argv = argv; + int status; + char errmsg[80] = {'\0'}; + *pid = rb_fork_async_signal_safe(&status, exec_popen_writer, &pw, Qnil, errmsg, sizeof(errmsg)); +# else + *pid = rb_w32_uspawn_process(P_NOWAIT, argv[0], argv, write_pair[0], -1, -1, 0); + const char *errmsg = (*pid < 0) ? strerror(errno) : NULL; +# endif + close(write_pair[0]); + if (*pid < 0) { + close(write_pair[1]); + fprintf(stderr, "ruby_popen_writer(%s): %s\n", argv[0], errmsg); + } + else { + return fdopen(write_pair[1], "w"); + } + } +#endif + return NULL; +} + static void rb_scan_open_args(int argc, const VALUE *argv, VALUE *fname_p, int *oflags_p, int *fmode_p, - convconfig_t *convconfig_p, mode_t *perm_p) + struct rb_io_encoding *convconfig_p, mode_t *perm_p) { VALUE opt, fname, vmode, vperm; int oflags, fmode; @@ -7228,7 +8053,7 @@ rb_open_file(int argc, const VALUE *argv, VALUE io) { VALUE fname; int oflags, fmode; - convconfig_t convconfig; + struct rb_io_encoding convconfig; mode_t perm; rb_scan_open_args(argc, argv, &fname, &oflags, &fmode, &convconfig, &perm); @@ -7237,41 +8062,36 @@ rb_open_file(int argc, const VALUE *argv, VALUE io) return io; } - /* * Document-method: File::open * * call-seq: - * File.open(filename, mode="r" [, opt]) -> file - * File.open(filename [, mode [, perm]] [, opt]) -> file - * File.open(filename, mode="r" [, opt]) {|file| block } -> obj - * File.open(filename [, mode [, perm]] [, opt]) {|file| block } -> obj + * File.open(path, mode = 'r', perm = 0666, **opts) -> file + * File.open(path, mode = 'r', perm = 0666, **opts) {|f| ... } -> object + * + * Creates a new File object, via File.new with the given arguments. * - * With no associated block, File.open is a synonym for - * File.new. If the optional code block is given, it will - * be passed the opened +file+ as an argument and the File object will - * automatically be closed when the block terminates. The value of the block - * will be returned from File.open. + * With no block given, returns the File object. * - * If a file is being created, its initial permissions may be set using the - * +perm+ parameter. See File.new for further discussion. + * With a block given, calls the block with the File object + * and returns the block's value. * - * See IO.new for a description of the +mode+ and +opt+ parameters. */ /* * Document-method: IO::open * * call-seq: - * IO.open(fd, mode="r" [, opt]) -> io - * IO.open(fd, mode="r" [, opt]) {|io| block } -> obj + * IO.open(fd, mode = 'r', **opts) -> io + * IO.open(fd, mode = 'r', **opts) {|io| ... } -> object * - * With no associated block, IO.open is a synonym for IO.new. If - * the optional code block is given, it will be passed +io+ as an argument, - * and the IO object will automatically be closed when the block terminates. - * In this instance, IO.open returns the value of the block. + * Creates a new \IO object, via IO.new with the given arguments. + * + * With no block given, returns the \IO object. + * + * With a block given, calls the block with the \IO object + * and returns the block's value. * - * See IO.new for a description of the +fd+, +mode+ and +opt+ parameters. */ static VALUE @@ -7280,7 +8100,7 @@ rb_io_s_open(int argc, VALUE *argv, VALUE klass) VALUE io = rb_class_new_instance_kw(argc, argv, klass, RB_PASS_CALLED_KEYWORDS); if (rb_block_given_p()) { - return rb_ensure(rb_yield, io, io_close, io); + return rb_ensure(rb_yield, io, io_close, io); } return io; @@ -7288,12 +8108,20 @@ rb_io_s_open(int argc, VALUE *argv, VALUE klass) /* * call-seq: - * IO.sysopen(path, [mode, [perm]]) -> integer + * IO.sysopen(path, mode = 'r', perm = 0666) -> integer + * + * Opens the file at the given path with the given mode and permissions; + * returns the integer file descriptor. + * + * If the file is to be readable, it must exist; + * if the file is to be writable and does not exist, + * it is created with the given permissions: + * + * File.write('t.tmp', '') # => 0 + * IO.sysopen('t.tmp') # => 8 + * IO.sysopen('t.tmp', 'w') # => 9 * - * Opens the given path, returning the underlying file descriptor as a - * Integer. * - * IO.sysopen("testfile") #=> 3 */ static VALUE @@ -7312,8 +8140,8 @@ rb_io_s_sysopen(int argc, VALUE *argv, VALUE _) else if (!NIL_P(intmode = rb_check_to_integer(vmode, "to_int"))) oflags = NUM2INT(intmode); else { - SafeStringValue(vmode); - oflags = rb_io_modestr_oflags(StringValueCStr(vmode)); + StringValue(vmode); + oflags = rb_io_modestr_oflags(StringValueCStr(vmode)); } if (NIL_P(vperm)) perm = 0666; else perm = NUM2MODET(vperm); @@ -7340,101 +8168,29 @@ check_pipe_command(VALUE filename_or_command) /* * call-seq: - * open(path [, mode [, perm]] [, opt]) -> io or nil - * open(path [, mode [, perm]] [, opt]) {|io| block } -> obj - * - * Creates an IO object connected to the given stream, file, or subprocess. - * - * If +path+ does not start with a pipe character (<code>|</code>), treat it - * as the name of a file to open using the specified mode (defaulting to - * "r"). - * - * The +mode+ is either a string or an integer. If it is an integer, it - * must be bitwise-or of open(2) flags, such as File::RDWR or File::EXCL. If - * it is a string, it is either "fmode", "fmode:ext_enc", or - * "fmode:ext_enc:int_enc". - * - * See the documentation of IO.new for full documentation of the +mode+ string - * directives. - * - * If a file is being created, its initial permissions may be set using the - * +perm+ parameter. See File.new and the open(2) and chmod(2) man pages for - * a description of permissions. - * - * If a block is specified, it will be invoked with the IO object as a - * parameter, and the IO will be automatically closed when the block - * terminates. The call returns the value of the block. - * - * If +path+ starts with a pipe character (<code>"|"</code>), a subprocess is - * created, connected to the caller by a pair of pipes. The returned IO - * object may be used to write to the standard input and read from the - * standard output of this subprocess. - * - * If the command following the pipe is a single minus sign - * (<code>"|-"</code>), Ruby forks, and this subprocess is connected to the - * parent. If the command is not <code>"-"</code>, the subprocess runs the - * command. Note that the command may be processed by shell if it contains - * shell metacharacters. - * - * When the subprocess is Ruby (opened via <code>"|-"</code>), the +open+ - * call returns +nil+. If a block is associated with the open call, that - * block will run twice --- once in the parent and once in the child. - * - * The block parameter will be an IO object in the parent and +nil+ in the - * child. The parent's +IO+ object will be connected to the child's $stdin - * and $stdout. The subprocess will be terminated at the end of the block. - * - * === Examples - * - * Reading from "testfile": - * - * open("testfile") do |f| - * print f.gets - * end - * - * Produces: - * - * This is line one - * - * Open a subprocess and read its output: + * open(path, mode = 'r', perm = 0666, **opts) -> io or nil + * open(path, mode = 'r', perm = 0666, **opts) {|io| ... } -> obj * - * cmd = open("|date") - * print cmd.gets - * cmd.close + * Creates an IO object connected to the given file. * - * Produces: + * This method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. * - * Wed Apr 9 08:56:31 CDT 2003 + * With no block given, file stream is returned: * - * Open a subprocess running the same Ruby program: - * - * f = open("|-", "w+") - * if f.nil? - * puts "in Child" - * exit - * else - * puts "Got: #{f.gets}" - * end + * open('t.txt') # => #<File:t.txt> * - * Produces: + * With a block given, calls the block with the open file stream, + * then closes the stream: * - * Got: in Child + * open('t.txt') {|f| p f } # => #<File:t.txt (closed)> * - * Open a subprocess using a block to receive the IO object: + * Output: * - * open "|-" do |f| - * if f then - * # parent process - * puts "Got: #{f.gets}" - * else - * # child process - * puts "in Child" - * end - * end + * #<File:t.txt> * - * Produces: + * See File.open for details. * - * Got: in Child */ static VALUE @@ -7444,43 +8200,45 @@ rb_f_open(int argc, VALUE *argv, VALUE _) int redirect = FALSE; if (argc >= 1) { - CONST_ID(to_open, "to_open"); - if (rb_respond_to(argv[0], to_open)) { - redirect = TRUE; - } - else { - VALUE tmp = argv[0]; - FilePathValue(tmp); - if (NIL_P(tmp)) { - redirect = TRUE; - } - else { + CONST_ID(to_open, "to_open"); + if (rb_respond_to(argv[0], to_open)) { + redirect = TRUE; + } + else { + VALUE tmp = argv[0]; + FilePathValue(tmp); + if (NIL_P(tmp)) { + redirect = TRUE; + } + else { VALUE cmd = check_pipe_command(tmp); if (!NIL_P(cmd)) { - argv[0] = cmd; - return rb_io_s_popen(argc, argv, rb_cIO); - } - } - } + // TODO: when removed in 4.0, update command_injection.rdoc + rb_warn_deprecated_to_remove_at(4.0, "Calling Kernel#open with a leading '|'", "IO.popen"); + argv[0] = cmd; + return rb_io_s_popen(argc, argv, rb_cIO); + } + } + } } if (redirect) { VALUE io = rb_funcallv_kw(argv[0], to_open, argc-1, argv+1, RB_PASS_CALLED_KEYWORDS); - if (rb_block_given_p()) { - return rb_ensure(rb_yield, io, io_close, io); - } - return io; + if (rb_block_given_p()) { + return rb_ensure(rb_yield, io, io_close, io); + } + return io; } return rb_io_s_open(argc, argv, rb_cFile); } -static VALUE rb_io_open_generic(VALUE, VALUE, int, int, const convconfig_t *, mode_t); +static VALUE rb_io_open_generic(VALUE, VALUE, int, int, const struct rb_io_encoding *, mode_t); static VALUE rb_io_open(VALUE io, VALUE filename, VALUE vmode, VALUE vperm, VALUE opt) { int oflags, fmode; - convconfig_t convconfig; + struct rb_io_encoding convconfig; mode_t perm; rb_io_extract_modeenc(&vmode, &vperm, opt, &oflags, &fmode, &convconfig); @@ -7490,15 +8248,17 @@ rb_io_open(VALUE io, VALUE filename, VALUE vmode, VALUE vperm, VALUE opt) static VALUE rb_io_open_generic(VALUE klass, VALUE filename, int oflags, int fmode, - const convconfig_t *convconfig, mode_t perm) + const struct rb_io_encoding *convconfig, mode_t perm) { VALUE cmd; if (klass == rb_cIO && !NIL_P(cmd = check_pipe_command(filename))) { - return pipe_open_s(cmd, rb_io_oflags_modestr(oflags), fmode, convconfig); + // TODO: when removed in 4.0, update command_injection.rdoc + rb_warn_deprecated_to_remove_at(4.0, "IO process creation with a leading '|'", "IO.popen"); + return pipe_open_s(cmd, rb_io_oflags_modestr(oflags), fmode, convconfig); } else { - return rb_file_open_generic(io_alloc(klass), filename, - oflags, fmode, convconfig, perm); + return rb_file_open_generic(io_alloc(klass), filename, + oflags, fmode, convconfig, perm); } } @@ -7507,22 +8267,22 @@ io_reopen(VALUE io, VALUE nfile) { rb_io_t *fptr, *orig; int fd, fd2; - off_t pos = 0; + rb_off_t pos = 0; nfile = rb_io_get_io(nfile); GetOpenFile(io, fptr); GetOpenFile(nfile, orig); if (fptr == orig) return io; - if (IS_PREP_STDIO(fptr)) { + if (RUBY_IO_EXTERNAL_P(fptr)) { if ((fptr->stdio_file == stdin && !(orig->mode & FMODE_READABLE)) || (fptr->stdio_file == stdout && !(orig->mode & FMODE_WRITABLE)) || (fptr->stdio_file == stderr && !(orig->mode & FMODE_WRITABLE))) { - rb_raise(rb_eArgError, - "%s can't change access mode from \"%s\" to \"%s\"", - PREP_STDIO_NAME(fptr), rb_io_fmode_modestr(fptr->mode), - rb_io_fmode_modestr(orig->mode)); - } + rb_raise(rb_eArgError, + "%s can't change access mode from \"%s\" to \"%s\"", + PREP_STDIO_NAME(fptr), rb_io_fmode_modestr(fptr->mode), + rb_io_fmode_modestr(orig->mode)); + } } if (fptr->mode & FMODE_WRITABLE) { if (io_fflush(fptr) < 0) @@ -7532,7 +8292,7 @@ io_reopen(VALUE io, VALUE nfile) flush_before_seek(fptr); } if (orig->mode & FMODE_READABLE) { - pos = io_tell(orig); + pos = io_tell(orig); } if (orig->mode & FMODE_WRITABLE) { if (io_fflush(orig) < 0) @@ -7540,23 +8300,23 @@ io_reopen(VALUE io, VALUE nfile) } /* copy rb_io_t structure */ - fptr->mode = orig->mode | (fptr->mode & FMODE_PREP); + fptr->mode = orig->mode | (fptr->mode & FMODE_EXTERNAL); fptr->pid = orig->pid; fptr->lineno = orig->lineno; if (RTEST(orig->pathv)) fptr->pathv = orig->pathv; - else if (!IS_PREP_STDIO(fptr)) fptr->pathv = Qnil; + else if (!RUBY_IO_EXTERNAL_P(fptr)) fptr->pathv = Qnil; fptr_copy_finalizer(fptr, orig); fd = fptr->fd; fd2 = orig->fd; if (fd != fd2) { - if (IS_PREP_STDIO(fptr) || fd <= 2 || !fptr->stdio_file) { - /* need to keep FILE objects of stdin, stdout and stderr */ - if (rb_cloexec_dup2(fd2, fd) < 0) - rb_sys_fail_path(orig->pathv); + if (RUBY_IO_EXTERNAL_P(fptr) || fd <= 2 || !fptr->stdio_file) { + /* need to keep FILE objects of stdin, stdout and stderr */ + if (rb_cloexec_dup2(fd2, fd) < 0) + rb_sys_fail_path(orig->pathv); rb_update_max_fd(fd); - } - else { + } + else { fclose(fptr->stdio_file); fptr->stdio_file = 0; fptr->fd = -1; @@ -7564,20 +8324,20 @@ io_reopen(VALUE io, VALUE nfile) rb_sys_fail_path(orig->pathv); rb_update_max_fd(fd); fptr->fd = fd; - } - rb_thread_fd_close(fd); - if ((orig->mode & FMODE_READABLE) && pos >= 0) { - if (io_seek(fptr, pos, SEEK_SET) < 0 && errno) { - rb_sys_fail_path(fptr->pathv); - } - if (io_seek(orig, pos, SEEK_SET) < 0 && errno) { - rb_sys_fail_path(orig->pathv); - } - } + } + rb_thread_fd_close(fd); + if ((orig->mode & FMODE_READABLE) && pos >= 0) { + if (io_seek(fptr, pos, SEEK_SET) < 0 && errno) { + rb_sys_fail_path(fptr->pathv); + } + if (io_seek(orig, pos, SEEK_SET) < 0 && errno) { + rb_sys_fail_path(orig->pathv); + } + } } if (fptr->mode & FMODE_BINMODE) { - rb_io_binmode(io); + rb_io_binmode(io); } RBASIC_SET_CLASS(io, rb_obj_class(nfile)); @@ -7591,8 +8351,8 @@ static int rb_freopen(VALUE fname, const char *mode, FILE *fp) { if (!freopen(RSTRING_PTR(fname), mode, fp)) { - RB_GC_GUARD(fname); - return errno; + RB_GC_GUARD(fname); + return errno; } return 0; } @@ -7600,19 +8360,36 @@ rb_freopen(VALUE fname, const char *mode, FILE *fp) /* * call-seq: - * ios.reopen(other_IO) -> ios - * ios.reopen(path, mode [, opt]) -> ios + * reopen(other_io) -> self + * reopen(path, mode = 'r', **opts) -> self + * + * Reassociates the stream with another stream, + * which may be of a different class. + * This method may be used to redirect an existing stream + * to a new destination. + * + * With argument +other_io+ given, reassociates with that stream: + * + * # Redirect $stdin from a file. + * f = File.open('t.txt') + * $stdin.reopen(f) + * f.close + * + * # Redirect $stdout to a file. + * f = File.open('t.tmp', 'w') + * $stdout.reopen(f) + * f.close + * + * With argument +path+ given, reassociates with a new stream to that file path: + * + * $stdin.reopen('t.txt') + * $stdout.reopen('t.tmp', 'w') * - * Reassociates <em>ios</em> with the I/O stream given in - * <i>other_IO</i> or to a new stream opened on <i>path</i>. This may - * dynamically change the actual class of this stream. - * The +mode+ and +opt+ parameters accept the same values as IO.open. + * Optional keyword arguments +opts+ specify: + * + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. * - * f1 = File.new("testfile") - * f2 = File.new("testfile") - * f2.readlines[0] #=> "This is line one\n" - * f2.reopen(f1) #=> #<File:testfile> - * f2.readlines[0] #=> "This is line one\n" */ static VALUE @@ -7623,44 +8400,44 @@ rb_io_reopen(int argc, VALUE *argv, VALUE file) rb_io_t *fptr; if (rb_scan_args(argc, argv, "11:", &fname, &nmode, &opt) == 1) { - VALUE tmp = rb_io_check_io(fname); - if (!NIL_P(tmp)) { - return io_reopen(file, tmp); - } + VALUE tmp = rb_io_check_io(fname); + if (!NIL_P(tmp)) { + return io_reopen(file, tmp); + } } FilePathValue(fname); rb_io_taint_check(file); fptr = RFILE(file)->fptr; if (!fptr) { - fptr = RFILE(file)->fptr = ZALLOC(rb_io_t); + fptr = RFILE(file)->fptr = ZALLOC(rb_io_t); } if (!NIL_P(nmode) || !NIL_P(opt)) { - int fmode; - convconfig_t convconfig; + int fmode; + struct rb_io_encoding convconfig; - rb_io_extract_modeenc(&nmode, 0, opt, &oflags, &fmode, &convconfig); - if (IS_PREP_STDIO(fptr) && + rb_io_extract_modeenc(&nmode, 0, opt, &oflags, &fmode, &convconfig); + if (RUBY_IO_EXTERNAL_P(fptr) && ((fptr->mode & FMODE_READWRITE) & (fmode & FMODE_READWRITE)) != (fptr->mode & FMODE_READWRITE)) { - rb_raise(rb_eArgError, - "%s can't change access mode from \"%s\" to \"%s\"", - PREP_STDIO_NAME(fptr), rb_io_fmode_modestr(fptr->mode), - rb_io_fmode_modestr(fmode)); - } - fptr->mode = fmode; - fptr->encs = convconfig; + rb_raise(rb_eArgError, + "%s can't change access mode from \"%s\" to \"%s\"", + PREP_STDIO_NAME(fptr), rb_io_fmode_modestr(fptr->mode), + rb_io_fmode_modestr(fmode)); + } + fptr->mode = fmode; + fptr->encs = convconfig; } else { - oflags = rb_io_fmode_oflags(fptr->mode); + oflags = rb_io_fmode_oflags(fptr->mode); } fptr->pathv = fname; if (fptr->fd < 0) { fptr->fd = rb_sysopen(fptr->pathv, oflags, 0666); - fptr->stdio_file = 0; - return file; + fptr->stdio_file = 0; + return file; } if (fptr->mode & FMODE_WRITABLE) { @@ -7670,9 +8447,9 @@ rb_io_reopen(int argc, VALUE *argv, VALUE file) fptr->rbuf.off = fptr->rbuf.len = 0; if (fptr->stdio_file) { - int e = rb_freopen(rb_str_encode_ospath(fptr->pathv), - rb_io_oflags_modestr(oflags), - fptr->stdio_file); + int e = rb_freopen(rb_str_encode_ospath(fptr->pathv), + rb_io_oflags_modestr(oflags), + fptr->stdio_file); if (e) rb_syserr_fail_path(e, fptr->pathv); fptr->fd = fileno(fptr->stdio_file); rb_fd_fix_cloexec(fptr->fd); @@ -7690,14 +8467,14 @@ rb_io_reopen(int argc, VALUE *argv, VALUE file) } } else { - int tmpfd = rb_sysopen(fptr->pathv, oflags, 0666); - int err = 0; - if (rb_cloexec_dup2(tmpfd, fptr->fd) < 0) - err = errno; - (void)close(tmpfd); - if (err) { - rb_syserr_fail_path(err, fptr->pathv); - } + int tmpfd = rb_sysopen(fptr->pathv, oflags, 0666); + int err = 0; + if (rb_cloexec_dup2(tmpfd, fptr->fd) < 0) + err = errno; + (void)close(tmpfd); + if (err) { + rb_syserr_fail_path(err, fptr->pathv); + } } return file; @@ -7710,7 +8487,7 @@ rb_io_init_copy(VALUE dest, VALUE io) rb_io_t *fptr, *orig; int fd; VALUE write_io; - off_t pos; + rb_off_t pos; io = rb_io_get_io(io); if (!OBJ_INIT_COPY(dest, io)) return dest; @@ -7720,10 +8497,11 @@ rb_io_init_copy(VALUE dest, VALUE io) rb_io_flush(io); /* copy rb_io_t structure */ - fptr->mode = orig->mode & ~FMODE_PREP; + fptr->mode = orig->mode & ~FMODE_EXTERNAL; fptr->encs = orig->encs; fptr->pid = orig->pid; fptr->lineno = orig->lineno; + fptr->timeout = orig->timeout; if (!NIL_P(orig->pathv)) fptr->pathv = orig->pathv; fptr_copy_finalizer(fptr, orig); @@ -7733,7 +8511,7 @@ rb_io_init_copy(VALUE dest, VALUE io) if (0 <= pos) io_seek(fptr, pos, SEEK_SET); if (fptr->mode & FMODE_BINMODE) { - rb_io_binmode(dest); + rb_io_binmode(dest); } write_io = GetWriteIO(io); @@ -7748,10 +8526,13 @@ rb_io_init_copy(VALUE dest, VALUE io) /* * call-seq: - * ios.printf(format_string [, obj, ...]) -> nil + * printf(format_string, *objects) -> nil + * + * Formats and writes +objects+ to the stream. + * + * For details on +format_string+, see + * {Format Specifications}[rdoc-ref:format_specifications.rdoc]. * - * Formats and writes to <em>ios</em>, converting parameters under - * control of the format string. See Kernel#sprintf for details. */ VALUE @@ -7763,13 +8544,36 @@ rb_io_printf(int argc, const VALUE *argv, VALUE out) /* * call-seq: - * printf(io, string [, obj ... ]) -> nil - * printf(string [, obj ... ]) -> nil + * printf(format_string, *objects) -> nil + * printf(io, format_string, *objects) -> nil * * Equivalent to: - * io.write(sprintf(string, obj, ...)) - * or - * $stdout.write(sprintf(string, obj, ...)) + * + * io.write(sprintf(format_string, *objects)) + * + * For details on +format_string+, see + * {Format Specifications}[rdoc-ref:format_specifications.rdoc]. + * + * With the single argument +format_string+, formats +objects+ into the string, + * then writes the formatted string to $stdout: + * + * printf('%4.4d %10s %2.2f', 24, 24, 24.0) + * + * Output (on $stdout): + * + * 0024 24 24.00# + * + * With arguments +io+ and +format_string+, formats +objects+ into the string, + * then writes the formatted string to +io+: + * + * printf($stderr, '%4.4d %10s %2.2f', 24, 24, 24.0) + * + * Output (on $stderr): + * + * 0024 24 24.00# => nil + * + * With no arguments, does nothing. + * */ static VALUE @@ -7779,12 +8583,12 @@ rb_f_printf(int argc, VALUE *argv, VALUE _) if (argc == 0) return Qnil; if (RB_TYPE_P(argv[0], T_STRING)) { - out = rb_ractor_stdout(); + out = rb_ractor_stdout(); } else { - out = argv[0]; - argv++; - argc--; + out = argv[0]; + argv++; + argc--; } rb_io_write(out, rb_f_sprintf(argc, argv)); @@ -7796,33 +8600,65 @@ deprecated_str_setter(VALUE val, ID id, VALUE *var) { rb_str_setter(val, id, &val); if (!NIL_P(val)) { - rb_warn_deprecated("`%s'", NULL, rb_id2name(id)); + rb_warn_deprecated("'%s'", NULL, rb_id2name(id)); } *var = val; } /* * call-seq: - * ios.print -> nil - * ios.print(obj, ...) -> nil + * print(*objects) -> nil * - * Writes the given object(s) to <em>ios</em>. Returns +nil+. + * Writes the given objects to the stream; returns +nil+. + * Appends the output record separator <tt>$OUTPUT_RECORD_SEPARATOR</tt> + * (<tt>$\\</tt>), if it is not +nil+. + * See {Line IO}[rdoc-ref:IO@Line+IO]. * - * The stream must be opened for writing. - * Each given object that isn't a string will be converted by calling - * its <code>to_s</code> method. - * When called without arguments, prints the contents of <code>$_</code>. + * With argument +objects+ given, for each object: * - * If the output field separator (<code>$,</code>) is not +nil+, - * it is inserted between objects. - * If the output record separator (<code>$\\</code>) is not +nil+, - * it is appended to the output. + * - Converts via its method +to_s+ if not a string. + * - Writes to the stream. + * - If not the last object, writes the output field separator + * <tt>$OUTPUT_FIELD_SEPARATOR</tt> (<tt>$,</tt>) if it is not +nil+. * - * $stdout.print("This is ", 100, " percent.\n") + * With default separators: * - * <em>produces:</em> + * f = File.open('t.tmp', 'w+') + * objects = [0, 0.0, Rational(0, 1), Complex(0, 0), :zero, 'zero'] + * p $OUTPUT_RECORD_SEPARATOR + * p $OUTPUT_FIELD_SEPARATOR + * f.print(*objects) + * f.rewind + * p f.read + * f.close + * + * Output: + * + * nil + * nil + * "00.00/10+0izerozero" + * + * With specified separators: + * + * $\ = "\n" + * $, = ',' + * f.rewind + * f.print(*objects) + * f.rewind + * p f.read + * + * Output: + * + * "0,0.0,0/1,0+0i,zero,zero\n" + * + * With no argument given, writes the content of <tt>$_</tt> + * (which is usually the most recent user input): + * + * f = File.open('t.tmp', 'w+') + * gets # Sets $_ to the most recent user input. + * f.print + * f.close * - * This is 100 percent. */ VALUE @@ -7833,21 +8669,21 @@ rb_io_print(int argc, const VALUE *argv, VALUE out) /* if no argument given, print `$_' */ if (argc == 0) { - argc = 1; - line = rb_lastline_get(); - argv = &line; + argc = 1; + line = rb_lastline_get(); + argv = &line; } if (argc > 1 && !NIL_P(rb_output_fs)) { rb_category_warn(RB_WARN_CATEGORY_DEPRECATED, "$, is set to non-nil value"); } for (i=0; i<argc; i++) { - if (!NIL_P(rb_output_fs) && i>0) { - rb_io_write(out, rb_output_fs); - } - rb_io_write(out, argv[i]); + if (!NIL_P(rb_output_fs) && i>0) { + rb_io_write(out, rb_output_fs); + } + rb_io_write(out, argv[i]); } if (argc > 0 && !NIL_P(rb_output_rs)) { - rb_io_write(out, rb_output_rs); + rb_io_write(out, rb_output_rs); } return Qnil; @@ -7855,25 +8691,51 @@ rb_io_print(int argc, const VALUE *argv, VALUE out) /* * call-seq: - * print(obj, ...) -> nil + * print(*objects) -> nil * - * Prints each object in turn to <code>$stdout</code>. If the output - * field separator (<code>$,</code>) is not +nil+, its - * contents will appear between each field. If the output record - * separator (<code>$\\</code>) is not +nil+, it will be - * appended to the output. If no arguments are given, prints - * <code>$_</code>. Objects that aren't strings will be converted by - * calling their <code>to_s</code> method. + * Equivalent to <tt>$stdout.print(*objects)</tt>, + * this method is the straightforward way to write to <tt>$stdout</tt>. * - * print "cat", [1,2,3], 99, "\n" - * $, = ", " - * $\ = "\n" - * print "cat", [1,2,3], 99 + * Writes the given objects to <tt>$stdout</tt>; returns +nil+. + * Appends the output record separator <tt>$OUTPUT_RECORD_SEPARATOR</tt> + * <tt>$\\</tt>), if it is not +nil+. * - * <em>produces:</em> + * With argument +objects+ given, for each object: + * + * - Converts via its method +to_s+ if not a string. + * - Writes to <tt>stdout</tt>. + * - If not the last object, writes the output field separator + * <tt>$OUTPUT_FIELD_SEPARATOR</tt> (<tt>$,</tt> if it is not +nil+. + * + * With default separators: + * + * objects = [0, 0.0, Rational(0, 1), Complex(0, 0), :zero, 'zero'] + * $OUTPUT_RECORD_SEPARATOR + * $OUTPUT_FIELD_SEPARATOR + * print(*objects) + * + * Output: + * + * nil + * nil + * 00.00/10+0izerozero + * + * With specified separators: + * + * $OUTPUT_RECORD_SEPARATOR = "\n" + * $OUTPUT_FIELD_SEPARATOR = ',' + * print(*objects) + * + * Output: + * + * 0,0.0,0/1,0+0i,zero,zero + * + * With no argument given, writes the content of <tt>$_</tt> + * (which is usually the most recent user input): + * + * gets # Sets $_ to the most recent user input. + * print # Prints $_. * - * cat12399 - * cat, 1, 2, 3, 99 */ static VALUE @@ -7885,19 +8747,23 @@ rb_f_print(int argc, const VALUE *argv, VALUE _) /* * call-seq: - * ios.putc(obj) -> obj + * putc(object) -> object * - * If <i>obj</i> is Numeric, write the character whose code is the - * least-significant byte of <i>obj</i>. If <i>obj</i> is String, - * write the first character of <i>obj</i> to <em>ios</em>. Otherwise, - * raise TypeError. + * Writes a character to the stream. + * See {Character IO}[rdoc-ref:IO@Character+IO]. * - * $stdout.putc "A" - * $stdout.putc 65 + * If +object+ is numeric, converts to integer if necessary, + * then writes the character whose code is the + * least significant byte; + * if +object+ is a string, writes the first character: * - * <em>produces:</em> + * $stdout.putc "A" + * $stdout.putc 65 + * + * Output: * * AA + * */ static VALUE @@ -7905,11 +8771,11 @@ rb_io_putc(VALUE io, VALUE ch) { VALUE str; if (RB_TYPE_P(ch, T_STRING)) { - str = rb_str_substr(ch, 0, 1); + str = rb_str_substr(ch, 0, 1); } else { - char c = NUM2CHR(ch); - str = rb_str_new(&c, 1); + char c = NUM2CHR(ch); + str = rb_str_new(&c, 1); } rb_io_write(io, str); return ch; @@ -7924,14 +8790,14 @@ rb_io_putc(VALUE io, VALUE ch) /* * call-seq: - * putc(int) -> int + * putc(int) -> int * * Equivalent to: * * $stdout.putc(int) * - * Refer to the documentation for IO#putc for important information regarding - * multi-byte characters. + * See IO#putc for important information regarding multi-byte characters. + * */ static VALUE @@ -7939,7 +8805,7 @@ rb_f_putc(VALUE recv, VALUE ch) { VALUE r_stdout = rb_ractor_stdout(); if (recv == r_stdout) { - return rb_io_putc(recv, ch); + return rb_io_putc(recv, ch); } return forward(r_stdout, rb_intern("putc"), 1, &ch); } @@ -7955,7 +8821,7 @@ rb_str_end_with_asciichar(VALUE str, int c) if (len == 0) return 0; if ((n = rb_enc_mbminlen(enc)) == 1) { - return ptr[len - 1] == c; + return ptr[len - 1] == c; } return rb_enc_ascget(ptr + ((len - 1) / n) * n, ptr + len, &n, enc) == c; } @@ -7967,74 +8833,101 @@ io_puts_ary(VALUE ary, VALUE out, int recur) long i; if (recur) { - tmp = rb_str_new2("[...]"); - rb_io_puts(1, &tmp, out); - return Qtrue; + tmp = rb_str_new2("[...]"); + rb_io_puts(1, &tmp, out); + return Qtrue; } ary = rb_check_array_type(ary); if (NIL_P(ary)) return Qfalse; for (i=0; i<RARRAY_LEN(ary); i++) { - tmp = RARRAY_AREF(ary, i); - rb_io_puts(1, &tmp, out); + tmp = RARRAY_AREF(ary, i); + rb_io_puts(1, &tmp, out); } return Qtrue; } /* * call-seq: - * ios.puts(obj, ...) -> nil + * puts(*objects) -> nil * - * Writes the given object(s) to <em>ios</em>. - * Writes a newline after any that do not already end - * with a newline sequence. Returns +nil+. + * Writes the given +objects+ to the stream, which must be open for writing; + * returns +nil+.\ + * Writes a newline after each that does not already end with a newline sequence. + * If called without arguments, writes a newline. + * See {Line IO}[rdoc-ref:IO@Line+IO]. * - * The stream must be opened for writing. - * If called with an array argument, writes each element on a new line. - * Each given object that isn't a string or array will be converted - * by calling its +to_s+ method. - * If called without arguments, outputs a single newline. + * Note that each added newline is the character <tt>"\n"<//tt>, + * not the output record separator (<tt>$\\</tt>). * - * $stdout.puts("this", "is", ["a", "test"]) + * Treatment for each object: * - * <em>produces:</em> + * - String: writes the string. + * - Neither string nor array: writes <tt>object.to_s</tt>. + * - Array: writes each element of the array; arrays may be nested. + * + * To keep these examples brief, we define this helper method: + * + * def show(*objects) + * # Puts objects to file. + * f = File.new('t.tmp', 'w+') + * f.puts(objects) + * # Return file content. + * f.rewind + * p f.read + * f.close + * end * - * this - * is - * a - * test + * # Strings without newlines. + * show('foo', 'bar', 'baz') # => "foo\nbar\nbaz\n" + * # Strings, some with newlines. + * show("foo\n", 'bar', "baz\n") # => "foo\nbar\nbaz\n" + * + * # Neither strings nor arrays: + * show(0, 0.0, Rational(0, 1), Complex(9, 0), :zero) + * # => "0\n0.0\n0/1\n9+0i\nzero\n" + * + * # Array of strings. + * show(['foo', "bar\n", 'baz']) # => "foo\nbar\nbaz\n" + * # Nested arrays. + * show([[[0, 1], 2, 3], 4, 5]) # => "0\n1\n2\n3\n4\n5\n" * - * Note that +puts+ always uses newlines and is not affected - * by the output record separator (<code>$\\</code>). */ VALUE rb_io_puts(int argc, const VALUE *argv, VALUE out) { - int i, n; VALUE line, args[2]; /* if no argument given, print newline. */ if (argc == 0) { - rb_io_write(out, rb_default_rs); - return Qnil; + rb_io_write(out, rb_default_rs); + return Qnil; } - for (i=0; i<argc; i++) { - if (RB_TYPE_P(argv[i], T_STRING)) { - line = argv[i]; - goto string; - } - if (rb_exec_recursive(io_puts_ary, argv[i], out)) { - continue; - } - line = rb_obj_as_string(argv[i]); - string: - n = 0; - args[n++] = line; - if (RSTRING_LEN(line) == 0 || - !rb_str_end_with_asciichar(line, '\n')) { - args[n++] = rb_default_rs; - } - rb_io_writev(out, n, args); + for (int i = 0; i < argc; i++) { + // Convert the argument to a string: + if (RB_TYPE_P(argv[i], T_STRING)) { + line = argv[i]; + } + else if (rb_exec_recursive(io_puts_ary, argv[i], out)) { + continue; + } + else { + line = rb_obj_as_string(argv[i]); + } + + // Write the line: + int n = 0; + if (RSTRING_LEN(line) == 0) { + args[n++] = rb_default_rs; + } + else { + args[n++] = line; + if (!rb_str_end_with_asciichar(line, '\n')) { + args[n++] = rb_default_rs; + } + } + + rb_io_writev(out, n, args); } return Qnil; @@ -8042,11 +8935,11 @@ rb_io_puts(int argc, const VALUE *argv, VALUE out) /* * call-seq: - * puts(obj, ...) -> nil + * puts(*objects) -> nil * * Equivalent to * - * $stdout.puts(obj, ...) + * $stdout.puts(objects) */ static VALUE @@ -8054,7 +8947,7 @@ rb_f_puts(int argc, VALUE *argv, VALUE recv) { VALUE r_stdout = rb_ractor_stdout(); if (recv == r_stdout) { - return rb_io_puts(argc, argv, recv); + return rb_io_puts(argc, argv, recv); } return forward(r_stdout, rb_intern("puts"), argc, argv); } @@ -8068,10 +8961,10 @@ rb_p_write(VALUE str) VALUE r_stdout = rb_ractor_stdout(); if (RB_TYPE_P(r_stdout, T_FILE) && rb_method_basic_definition_p(CLASS_OF(r_stdout), id_write)) { - io_writev(2, args, r_stdout); + io_writev(2, args, r_stdout); } else { - rb_io_writev(r_stdout, 2, args); + rb_io_writev(r_stdout, 2, args); } return Qnil; } @@ -8088,34 +8981,48 @@ rb_p_result(int argc, const VALUE *argv) VALUE ret = Qnil; if (argc == 1) { - ret = argv[0]; + ret = argv[0]; } else if (argc > 1) { - ret = rb_ary_new4(argc, argv); + ret = rb_ary_new4(argc, argv); } VALUE r_stdout = rb_ractor_stdout(); if (RB_TYPE_P(r_stdout, T_FILE)) { - rb_io_flush(r_stdout); + rb_uninterruptible(rb_io_flush, r_stdout); } return ret; } /* * call-seq: - * p(obj) -> obj - * p(obj1, obj2, ...) -> [obj, ...] - * p() -> nil + * p(object) -> obj + * p(*objects) -> array of objects + * p -> nil * - * For each object, directly writes _obj_.+inspect+ followed by a - * newline to the program's standard output. + * For each object +obj+, executes: * - * S = Struct.new(:name, :state) - * s = S['dave', 'TX'] - * p s + * $stdout.write(obj.inspect, "\n") * - * <em>produces:</em> + * With one object given, returns the object; + * with multiple objects given, returns an array containing the objects; + * with no object given, returns +nil+. + * + * Examples: * - * #<S name="dave", state="TX"> + * r = Range.new(0, 4) + * p r # => 0..4 + * p [r, r, r] # => [0..4, 0..4, 0..4] + * p # => nil + * + * Output: + * + * 0..4 + * [0..4, 0..4, 0..4] + * + * Kernel#p is designed for debugging purposes. + * Ruby implementations may define Kernel#p to be uninterruptible + * in whole or in part. + * On CRuby, Kernel#p's writing of data is uninterruptible. */ static VALUE @@ -8131,26 +9038,19 @@ rb_f_p(int argc, VALUE *argv, VALUE self) /* * call-seq: - * obj.display(port=$>) -> nil + * display(port = $>) -> nil * - * Prints <i>obj</i> on the given port (default <code>$></code>). - * Equivalent to: - * - * def display(port=$>) - * port.write self - * nil - * end - * - * For example: + * Writes +self+ on the given port: * * 1.display * "cat".display * [ 4, 5, 6 ].display * puts * - * <em>produces:</em> + * Output: * * 1cat[4, 5, 6] + * */ static VALUE @@ -8165,27 +9065,28 @@ rb_obj_display(int argc, VALUE *argv, VALUE self) } static int -rb_stderr_to_original_p(void) +rb_stderr_to_original_p(VALUE err) { - return (rb_ractor_stderr() == orig_stderr || RFILE(orig_stderr)->fptr->fd < 0); + return (err == orig_stderr || RFILE(orig_stderr)->fptr->fd < 0); } void rb_write_error2(const char *mesg, long len) { - if (rb_stderr_to_original_p()) { + VALUE out = rb_ractor_stderr(); + if (rb_stderr_to_original_p(out)) { #ifdef _WIN32 - if (isatty(fileno(stderr))) { - if (rb_w32_write_console(rb_str_new(mesg, len), fileno(stderr)) > 0) return; - } + if (isatty(fileno(stderr))) { + if (rb_w32_write_console(rb_str_new(mesg, len), fileno(stderr)) > 0) return; + } #endif - if (fwrite(mesg, sizeof(char), (size_t)len, stderr) < (size_t)len) { - /* failed to write to stderr, what can we do? */ - return; - } + if (fwrite(mesg, sizeof(char), (size_t)len, stderr) < (size_t)len) { + /* failed to write to stderr, what can we do? */ + return; + } } else { - rb_io_write(rb_ractor_stderr(), rb_str_new(mesg, len)); + rb_io_write(out, rb_str_new(mesg, len)); } } @@ -8198,30 +9099,31 @@ rb_write_error(const char *mesg) void rb_write_error_str(VALUE mesg) { + VALUE out = rb_ractor_stderr(); /* a stopgap measure for the time being */ - if (rb_stderr_to_original_p()) { - size_t len = (size_t)RSTRING_LEN(mesg); + if (rb_stderr_to_original_p(out)) { + size_t len = (size_t)RSTRING_LEN(mesg); #ifdef _WIN32 - if (isatty(fileno(stderr))) { - if (rb_w32_write_console(mesg, fileno(stderr)) > 0) return; - } + if (isatty(fileno(stderr))) { + if (rb_w32_write_console(mesg, fileno(stderr)) > 0) return; + } #endif - if (fwrite(RSTRING_PTR(mesg), sizeof(char), len, stderr) < len) { - RB_GC_GUARD(mesg); - return; - } + if (fwrite(RSTRING_PTR(mesg), sizeof(char), len, stderr) < len) { + RB_GC_GUARD(mesg); + return; + } } else { - /* may unlock GVL, and */ - rb_io_write(rb_ractor_stderr(), mesg); + /* may unlock GVL, and */ + rb_io_write(out, mesg); } } int rb_stderr_tty_p(void) { - if (rb_stderr_to_original_p()) - return isatty(fileno(stderr)); + if (rb_stderr_to_original_p(rb_ractor_stderr())) + return isatty(fileno(stderr)); return 0; } @@ -8229,9 +9131,9 @@ static void must_respond_to(ID mid, VALUE val, ID id) { if (!rb_respond_to(val, mid)) { - rb_raise(rb_eTypeError, "%"PRIsVALUE" must have %"PRIsVALUE" method, %"PRIsVALUE" given", - rb_id2str(id), rb_id2str(mid), - rb_obj_class(val)); + rb_raise(rb_eTypeError, "%"PRIsVALUE" must have %"PRIsVALUE" method, %"PRIsVALUE" given", + rb_id2str(id), rb_id2str(mid), + rb_obj_class(val)); } } @@ -8274,25 +9176,94 @@ stderr_getter(ID id, VALUE *ptr) } static VALUE +allocate_and_open_new_file(VALUE klass) +{ + VALUE self = io_alloc(klass); + rb_io_make_open_file(self); + return self; +} + +VALUE +rb_io_open_descriptor(VALUE klass, int descriptor, int mode, VALUE path, VALUE timeout, struct rb_io_encoding *encoding) +{ + int state; + VALUE self = rb_protect(allocate_and_open_new_file, klass, &state); + if (state) { + /* if we raised an exception allocating an IO object, but the caller + intended to transfer ownership of this FD to us, close the fd before + raising the exception. Otherwise, we would leak a FD - the caller + expects GC to close the file, but we never got around to assigning + it to a rb_io. */ + if (!(mode & FMODE_EXTERNAL)) { + maygvl_close(descriptor, 0); + } + rb_jump_tag(state); + } + + + rb_io_t *io = RFILE(self)->fptr; + io->self = self; + io->fd = descriptor; + io->mode = mode; + + /* At this point, Ruby fully owns the descriptor, and will close it when + the IO gets GC'd (unless FMODE_EXTERNAL was set), no matter what happens + in the rest of this method. */ + + if (NIL_P(path)) { + io->pathv = Qnil; + } + else { + StringValue(path); + io->pathv = rb_str_new_frozen(path); + } + + io->timeout = timeout; + + if (encoding) { + io->encs = *encoding; + } + + rb_update_max_fd(descriptor); + + return self; +} + +static VALUE prep_io(int fd, int fmode, VALUE klass, const char *path) { - rb_io_t *fp; - VALUE io = io_alloc(klass); + VALUE path_value = Qnil; + rb_encoding *e; + struct rb_io_encoding convconfig; - MakeOpenFile(io, fp); - fp->self = io; - fp->fd = fd; - fp->mode = fmode; - if (!io_check_tty(fp)) { + if (path) { + path_value = rb_obj_freeze(rb_str_new_cstr(path)); + } + + e = (fmode & FMODE_BINMODE) ? rb_ascii8bit_encoding() : NULL; + rb_io_ext_int_to_encs(e, NULL, &convconfig.enc, &convconfig.enc2, fmode); + convconfig.ecflags = (fmode & FMODE_READABLE) ? + MODE_BTMODE(ECONV_DEFAULT_NEWLINE_DECORATOR, + 0, ECONV_UNIVERSAL_NEWLINE_DECORATOR) : 0; +#ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE + convconfig.ecflags |= (fmode & FMODE_WRITABLE) ? + MODE_BTMODE(TEXTMODE_NEWLINE_DECORATOR_ON_WRITE, + 0, TEXTMODE_NEWLINE_DECORATOR_ON_WRITE) : 0; +#endif + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(convconfig.enc2, convconfig.ecflags); + convconfig.ecopts = Qnil; + + VALUE self = rb_io_open_descriptor(klass, fd, fmode, path_value, Qnil, &convconfig); + rb_io_t*io = RFILE(self)->fptr; + + if (!io_check_tty(io)) { #ifdef __CYGWIN__ - fp->mode |= FMODE_BINMODE; - setmode(fd, O_BINARY); + io->mode |= FMODE_BINMODE; + setmode(fd, O_BINARY); #endif } - if (path) fp->pathv = rb_obj_freeze(rb_str_new_cstr(path)); - rb_update_max_fd(fd); - return io; + return self; } VALUE @@ -8308,14 +9279,14 @@ static VALUE prep_stdio(FILE *f, int fmode, VALUE klass, const char *path) { rb_io_t *fptr; - VALUE io = prep_io(fileno(f), fmode|FMODE_PREP|DEFAULT_TEXTMODE, klass, path); + VALUE io = prep_io(fileno(f), fmode|FMODE_EXTERNAL|DEFAULT_TEXTMODE, klass, path); GetOpenFile(io, fptr); fptr->encs.ecflags |= ECONV_DEFAULT_NEWLINE_DECORATOR; #ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE fptr->encs.ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE; if (fmode & FMODE_READABLE) { - fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; + fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; } #endif fptr->stdio_file = f; @@ -8352,7 +9323,7 @@ rb_io_stdio_file(rb_io_t *fptr) } static inline void -rb_io_buffer_init(rb_io_buffer_t *buf) +rb_io_buffer_init(struct rb_io_internal_buffer *buf) { buf->ptr = NULL; buf->off = 0; @@ -8386,7 +9357,8 @@ rb_io_fptr_new(void) fp->encs.enc2 = NULL; fp->encs.ecflags = 0; fp->encs.ecopts = Qnil; - fp->write_lock = 0; + fp->write_lock = Qnil; + fp->timeout = Qnil; return fp; } @@ -8409,155 +9381,43 @@ rb_io_make_open_file(VALUE obj) /* * call-seq: - * IO.new(fd [, mode] [, opt]) -> io - * - * Returns a new IO object (a stream) for the given integer file descriptor - * +fd+ and +mode+ string. +opt+ may be used to specify parts of +mode+ in a - * more readable fashion. See also IO.sysopen and IO.for_fd. - * - * IO.new is called by various File and IO opening methods such as IO::open, - * Kernel#open, and File::open. - * - * === Open Mode - * - * When +mode+ is an integer it must be combination of the modes defined in - * File::Constants (+File::RDONLY+, <code>File::WRONLY|File::CREAT</code>). - * See the open(2) man page for more information. - * - * When +mode+ is a string it must be in one of the following forms: - * - * fmode - * fmode ":" ext_enc - * fmode ":" ext_enc ":" int_enc - * fmode ":" "BOM|UTF-*" - * - * +fmode+ is an IO open mode string, +ext_enc+ is the external encoding for - * the IO and +int_enc+ is the internal encoding. - * - * ==== IO Open Mode - * - * Ruby allows the following open modes: - * - * "r" Read-only, starts at beginning of file (default mode). - * - * "r+" Read-write, starts at beginning of file. - * - * "w" Write-only, truncates existing file - * to zero length or creates a new file for writing. + * IO.new(fd, mode = 'r', **opts) -> io * - * "w+" Read-write, truncates existing file to zero length - * or creates a new file for reading and writing. + * Creates and returns a new \IO object (file stream) from a file descriptor. * - * "a" Write-only, each write call appends data at end of file. - * Creates a new file for writing if file does not exist. + * \IO.new may be useful for interaction with low-level libraries. + * For higher-level interactions, it may be simpler to create + * the file stream using File.open. * - * "a+" Read-write, each write call appends data at end of file. - * Creates a new file for reading and writing if file does - * not exist. + * Argument +fd+ must be a valid file descriptor (integer): * - * The following modes must be used separately, and along with one or more of - * the modes seen above. + * path = 't.tmp' + * fd = IO.sysopen(path) # => 3 + * IO.new(fd) # => #<IO:fd 3> * - * "b" Binary file mode - * Suppresses EOL <-> CRLF conversion on Windows. And - * sets external encoding to ASCII-8BIT unless explicitly - * specified. + * The new \IO object does not inherit encoding + * (because the integer file descriptor does not have an encoding): * - * "t" Text file mode - * - * The exclusive access mode ("x") can be used together with "w" to ensure - * the file is created. Errno::EEXIST is raised when it already exists. - * It may not be supported with all kinds of streams (e.g. pipes). - * - * When the open mode of original IO is read only, the mode cannot be - * changed to be writable. Similarly, the open mode cannot be changed from - * write only to readable. - * - * When such a change is attempted the error is raised in different locations - * according to the platform. - * - * === IO Encoding - * - * When +ext_enc+ is specified, strings read will be tagged by the encoding - * when reading, and strings output will be converted to the specified - * encoding when writing. - * - * When +ext_enc+ and +int_enc+ are specified read strings will be converted - * from +ext_enc+ to +int_enc+ upon input, and written strings will be - * converted from +int_enc+ to +ext_enc+ upon output. See Encoding for - * further details of transcoding on input and output. - * - * If "BOM|UTF-8", "BOM|UTF-16LE" or "BOM|UTF16-BE" are used, Ruby checks for - * a Unicode BOM in the input document to help determine the encoding. For - * UTF-16 encodings the file open mode must be binary. When present, the BOM - * is stripped and the external encoding from the BOM is used. When the BOM - * is missing the given Unicode encoding is used as +ext_enc+. (The BOM-set - * encoding option is case insensitive, so "bom|utf-8" is also valid.) - * - * === Options - * - * +opt+ can be used instead of +mode+ for improved readability. The - * following keys are supported: - * - * :mode :: - * Same as +mode+ parameter - * - * :flags :: - * Specifies file open flags as integer. - * If +mode+ parameter is given, this parameter will be bitwise-ORed. - * - * :\external_encoding :: - * External encoding for the IO. - * - * :\internal_encoding :: - * Internal encoding for the IO. "-" is a synonym for the default internal - * encoding. - * - * If the value is +nil+ no conversion occurs. + * fd = IO.sysopen('t.rus', 'rb') + * io = IO.new(fd) + * io.external_encoding # => #<Encoding:UTF-8> # Not ASCII-8BIT. * - * :encoding :: - * Specifies external and internal encodings as "extern:intern". + * Optional argument +mode+ (defaults to 'r') must specify a valid mode; + * see {Access Modes}[rdoc-ref:File@Access+Modes]: * - * :textmode :: - * If the value is truth value, same as "t" in argument +mode+. + * IO.new(fd, 'w') # => #<IO:fd 3> + * IO.new(fd, File::WRONLY) # => #<IO:fd 3> * - * :binmode :: - * If the value is truth value, same as "b" in argument +mode+. + * Optional keyword arguments +opts+ specify: * - * :autoclose :: - * If the value is +false+, the +fd+ will be kept open after this IO - * instance gets finalized. + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. * - * Also, +opt+ can have same keys in String#encode for controlling conversion - * between the external encoding and the internal encoding. - * - * === Example 1 - * - * fd = IO.sysopen("/dev/tty", "w") - * a = IO.new(fd,"w") - * $stderr.puts "Hello" - * a.puts "World" - * - * Produces: - * - * Hello - * World - * - * === Example 2 - * - * require 'fcntl' - * - * fd = STDERR.fcntl(Fcntl::F_DUPFD) - * io = IO.new(fd, mode: 'w:UTF-16LE', cr_newline: true) - * io.puts "Hello, World!" + * Examples: * - * fd = STDERR.fcntl(Fcntl::F_DUPFD) - * io = IO.new(fd, mode: 'w', cr_newline: true, - * external_encoding: Encoding::UTF_16LE) - * io.puts "Hello, World!" + * IO.new(fd, internal_encoding: nil) # => #<IO:fd 3> + * IO.new(fd, autoclose: true) # => #<IO:fd 3> * - * Both of above print "Hello, World!" in UTF-16LE to standard error output - * with converting EOL generated by #puts to CR. */ static VALUE @@ -8566,7 +9426,7 @@ rb_io_initialize(int argc, VALUE *argv, VALUE io) VALUE fnum, vmode; rb_io_t *fp; int fd, fmode, oflags = O_RDONLY; - convconfig_t convconfig; + struct rb_io_encoding convconfig; VALUE opt; #if defined(HAVE_FCNTL) && defined(F_GETFL) int ofmode; @@ -8580,7 +9440,7 @@ rb_io_initialize(int argc, VALUE *argv, VALUE io) fd = NUM2INT(fnum); if (rb_reserved_fd_p(fd)) { - rb_raise(rb_eArgError, "The given fd is not accessible because RubyVM reserves it"); + rb_raise(rb_eArgError, "The given fd is not accessible because RubyVM reserves it"); } #if defined(HAVE_FCNTL) && defined(F_GETFL) oflags = fcntl(fd, F_GETFL); @@ -8592,29 +9452,42 @@ rb_io_initialize(int argc, VALUE *argv, VALUE io) #if defined(HAVE_FCNTL) && defined(F_GETFL) ofmode = rb_io_oflags_fmode(oflags); if (NIL_P(vmode)) { - fmode = ofmode; + fmode = ofmode; } else if ((~ofmode & fmode) & FMODE_READWRITE) { - VALUE error = INT2FIX(EINVAL); - rb_exc_raise(rb_class_new_instance(1, &error, rb_eSystemCallError)); + VALUE error = INT2FIX(EINVAL); + rb_exc_raise(rb_class_new_instance(1, &error, rb_eSystemCallError)); } #endif - if (!NIL_P(opt) && rb_hash_aref(opt, sym_autoclose) == Qfalse) { - fmode |= FMODE_PREP; + VALUE path = Qnil; + + if (!NIL_P(opt)) { + if (rb_hash_aref(opt, sym_autoclose) == Qfalse) { + fmode |= FMODE_EXTERNAL; + } + + path = rb_hash_aref(opt, RB_ID2SYM(idPath)); + if (!NIL_P(path)) { + StringValue(path); + path = rb_str_new_frozen(path); + } } + MakeOpenFile(io, fp); fp->self = io; fp->fd = fd; fp->mode = fmode; fp->encs = convconfig; + fp->pathv = path; + fp->timeout = Qnil; clear_codeconv(fp); io_check_tty(fp); if (fileno(stdin) == fd) - fp->stdio_file = stdin; + fp->stdio_file = stdin; else if (fileno(stdout) == fd) - fp->stdio_file = stdout; + fp->stdio_file = stdout; else if (fileno(stderr) == fd) - fp->stdio_file = stderr; + fp->stdio_file = stderr; if (fmode & FMODE_SETENC_BY_BOM) io_set_encoding_by_bom(io); return io; @@ -8622,20 +9495,26 @@ rb_io_initialize(int argc, VALUE *argv, VALUE io) /* * call-seq: - * ios.set_encoding_by_bom -> encoding or nil + * set_encoding_by_bom -> encoding or nil + * + * If the stream begins with a BOM + * ({byte order marker}[https://en.wikipedia.org/wiki/Byte_order_mark]), + * consumes the BOM and sets the external encoding accordingly; + * returns the result encoding if found, or +nil+ otherwise: * - * Checks if +ios+ starts with a BOM, and then consumes it and sets - * the external encoding. Returns the result encoding if found, or - * nil. If +ios+ is not binmode or its encoding has been set - * already, an exception will be raised. + * File.write('t.tmp', "\u{FEFF}abc") + * io = File.open('t.tmp', 'rb') + * io.set_encoding_by_bom # => #<Encoding:UTF-8> + * io.close * - * File.write("bom.txt", "\u{FEFF}abc") - * ios = File.open("bom.txt", "rb") - * ios.set_encoding_by_bom #=> #<Encoding:UTF-8> + * File.write('t.tmp', 'abc') + * io = File.open('t.tmp', 'rb') + * io.set_encoding_by_bom # => nil + * io.close + * + * Raises an exception if the stream is not binmode + * or its encoding has already been set. * - * File.write("nobom.txt", "abc") - * ios = File.open("nobom.txt", "rb") - * ios.set_encoding_by_bom #=> nil */ static VALUE @@ -8660,42 +9539,58 @@ rb_io_set_encoding_by_bom(VALUE io) /* * call-seq: - * File.new(filename, mode="r" [, opt]) -> file - * File.new(filename [, mode [, perm]] [, opt]) -> file - * - * Opens the file named by +filename+ according to the given +mode+ and - * returns a new File object. + * File.new(path, mode = 'r', perm = 0666, **opts) -> file * - * See IO.new for a description of +mode+ and +opt+. - * - * If a file is being created, permission bits may be given in +perm+. These - * mode and permission bits are platform dependent; on Unix systems, see - * open(2) and chmod(2) man pages for details. + * Opens the file at the given +path+ according to the given +mode+; + * creates and returns a new File object for that file. * * The new File object is buffered mode (or non-sync mode), unless * +filename+ is a tty. - * See IO#flush, IO#fsync, IO#fdatasync, and IO#sync= about sync mode. + * See IO#flush, IO#fsync, IO#fdatasync, and IO#sync=. + * + * Argument +path+ must be a valid file path: + * + * f = File.new('/etc/fstab') + * f.close + * f = File.new('t.txt') + * f.close + * + * Optional argument +mode+ (defaults to 'r') must specify a valid mode; + * see {Access Modes}[rdoc-ref:File@Access+Modes]: + * + * f = File.new('t.tmp', 'w') + * f.close + * f = File.new('t.tmp', File::RDONLY) + * f.close * - * === Examples + * Optional argument +perm+ (defaults to 0666) must specify valid permissions + * see {File Permissions}[rdoc-ref:File@File+Permissions]: + * + * f = File.new('t.tmp', File::CREAT, 0644) + * f.close + * f = File.new('t.tmp', File::CREAT, 0444) + * f.close + * + * Optional keyword arguments +opts+ specify: + * + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. * - * f = File.new("testfile", "r") - * f = File.new("newfile", "w+") - * f = File.new("newfile", File::CREAT|File::TRUNC|File::RDWR, 0644) */ static VALUE rb_file_initialize(int argc, VALUE *argv, VALUE io) { if (RFILE(io)->fptr) { - rb_raise(rb_eRuntimeError, "reinitializing File"); + rb_raise(rb_eRuntimeError, "reinitializing File"); } if (0 < argc && argc < 3) { - VALUE fd = rb_check_to_int(argv[0]); + VALUE fd = rb_check_to_int(argv[0]); - if (!NIL_P(fd)) { - argv[0] = fd; - return rb_io_initialize(argc, argv, io); - } + if (!NIL_P(fd)) { + argv[0] = fd; + return rb_io_initialize(argc, argv, io); + } } rb_open_file(argc, argv, io); @@ -8707,10 +9602,10 @@ static VALUE rb_io_s_new(int argc, VALUE *argv, VALUE klass) { if (rb_block_given_p()) { - VALUE cname = rb_obj_as_string(klass); + VALUE cname = rb_obj_as_string(klass); - rb_warn("%"PRIsVALUE"::new() does not take block; use %"PRIsVALUE"::open() instead", - cname, cname); + rb_warn("%"PRIsVALUE"::new() does not take block; use %"PRIsVALUE"::open() instead", + cname, cname); } return rb_class_new_instance_kw(argc, argv, klass, RB_PASS_CALLED_KEYWORDS); } @@ -8718,7 +9613,7 @@ rb_io_s_new(int argc, VALUE *argv, VALUE klass) /* * call-seq: - * IO.for_fd(fd, mode [, opt]) -> io + * IO.for_fd(fd, mode = 'r', **opts) -> io * * Synonym for IO.new. * @@ -8737,7 +9632,7 @@ rb_io_s_for_fd(int argc, VALUE *argv, VALUE klass) * ios.autoclose? -> true or false * * Returns +true+ if the underlying file descriptor of _ios_ will be - * closed automatically at its finalization, otherwise +false+. + * closed at its finalization or at calling #close, otherwise +false+. */ static VALUE @@ -8745,7 +9640,7 @@ rb_io_autoclose_p(VALUE io) { rb_io_t *fptr = RFILE(io)->fptr; rb_io_check_closed(fptr); - return (fptr->mode & FMODE_PREP) ? Qfalse : Qtrue; + return RBOOL(!(fptr->mode & FMODE_EXTERNAL)); } /* @@ -8754,14 +9649,14 @@ rb_io_autoclose_p(VALUE io) * * Sets auto-close flag. * - * f = open("/dev/null") - * IO.for_fd(f.fileno) - * # ... - * f.gets # may cause Errno::EBADF + * f = File.open(File::NULL) + * IO.for_fd(f.fileno).close + * f.gets # raises Errno::EBADF * - * f = open("/dev/null") - * IO.for_fd(f.fileno).autoclose = false - * # ... + * f = File.open(File::NULL) + * g = IO.for_fd(f.fileno) + * g.autoclose = false + * g.close * f.gets # won't cause Errno::EBADF */ @@ -8771,12 +9666,223 @@ rb_io_set_autoclose(VALUE io, VALUE autoclose) rb_io_t *fptr; GetOpenFile(io, fptr); if (!RTEST(autoclose)) - fptr->mode |= FMODE_PREP; + fptr->mode |= FMODE_EXTERNAL; else - fptr->mode &= ~FMODE_PREP; + fptr->mode &= ~FMODE_EXTERNAL; return autoclose; } +static VALUE +io_wait_event(VALUE io, int event, VALUE timeout, int return_io) +{ + VALUE result = rb_io_wait(io, RB_INT2NUM(event), timeout); + + if (!RB_TEST(result)) { + return Qnil; + } + + int mask = RB_NUM2INT(result); + + if (mask & event) { + if (return_io) + return io; + else + return result; + } + else { + return Qfalse; + } +} + +/* + * call-seq: + * io.wait_readable -> truthy or falsy + * io.wait_readable(timeout) -> truthy or falsy + * + * Waits until IO is readable and returns a truthy value, or a falsy + * value when times out. Returns a truthy value immediately when + * buffered data is available. + */ + +static VALUE +io_wait_readable(int argc, VALUE *argv, VALUE io) +{ + rb_io_t *fptr; + + RB_IO_POINTER(io, fptr); + rb_io_check_readable(fptr); + + if (rb_io_read_pending(fptr)) return Qtrue; + + rb_check_arity(argc, 0, 1); + VALUE timeout = (argc == 1 ? argv[0] : Qnil); + + return io_wait_event(io, RUBY_IO_READABLE, timeout, 1); +} + +/* + * call-seq: + * io.wait_writable -> truthy or falsy + * io.wait_writable(timeout) -> truthy or falsy + * + * Waits until IO is writable and returns a truthy value or a falsy + * value when times out. + */ +static VALUE +io_wait_writable(int argc, VALUE *argv, VALUE io) +{ + rb_io_t *fptr; + + RB_IO_POINTER(io, fptr); + rb_io_check_writable(fptr); + + rb_check_arity(argc, 0, 1); + VALUE timeout = (argc == 1 ? argv[0] : Qnil); + + return io_wait_event(io, RUBY_IO_WRITABLE, timeout, 1); +} + +/* + * call-seq: + * io.wait_priority -> truthy or falsy + * io.wait_priority(timeout) -> truthy or falsy + * + * Waits until IO is priority and returns a truthy value or a falsy + * value when times out. Priority data is sent and received using + * the Socket::MSG_OOB flag and is typically limited to streams. + */ +static VALUE +io_wait_priority(int argc, VALUE *argv, VALUE io) +{ + rb_io_t *fptr = NULL; + + RB_IO_POINTER(io, fptr); + rb_io_check_readable(fptr); + + if (rb_io_read_pending(fptr)) return Qtrue; + + rb_check_arity(argc, 0, 1); + VALUE timeout = argc == 1 ? argv[0] : Qnil; + + return io_wait_event(io, RUBY_IO_PRIORITY, timeout, 1); +} + +static int +wait_mode_sym(VALUE mode) +{ + if (mode == ID2SYM(rb_intern("r"))) { + return RB_WAITFD_IN; + } + if (mode == ID2SYM(rb_intern("read"))) { + return RB_WAITFD_IN; + } + if (mode == ID2SYM(rb_intern("readable"))) { + return RB_WAITFD_IN; + } + if (mode == ID2SYM(rb_intern("w"))) { + return RB_WAITFD_OUT; + } + if (mode == ID2SYM(rb_intern("write"))) { + return RB_WAITFD_OUT; + } + if (mode == ID2SYM(rb_intern("writable"))) { + return RB_WAITFD_OUT; + } + if (mode == ID2SYM(rb_intern("rw"))) { + return RB_WAITFD_IN|RB_WAITFD_OUT; + } + if (mode == ID2SYM(rb_intern("read_write"))) { + return RB_WAITFD_IN|RB_WAITFD_OUT; + } + if (mode == ID2SYM(rb_intern("readable_writable"))) { + return RB_WAITFD_IN|RB_WAITFD_OUT; + } + + rb_raise(rb_eArgError, "unsupported mode: %"PRIsVALUE, mode); +} + +static inline enum rb_io_event +io_event_from_value(VALUE value) +{ + int events = RB_NUM2INT(value); + + if (events <= 0) rb_raise(rb_eArgError, "Events must be positive integer!"); + + return events; +} + +/* + * call-seq: + * io.wait(events, timeout) -> event mask, false or nil + * io.wait(timeout = nil, mode = :read) -> self, true, or false + * + * Waits until the IO becomes ready for the specified events and returns the + * subset of events that become ready, or a falsy value when times out. + * + * The events can be a bit mask of +IO::READABLE+, +IO::WRITABLE+ or + * +IO::PRIORITY+. + * + * Returns an event mask (truthy value) immediately when buffered data is available. + * + * Optional parameter +mode+ is one of +:read+, +:write+, or + * +:read_write+. + */ + +static VALUE +io_wait(int argc, VALUE *argv, VALUE io) +{ + VALUE timeout = Qundef; + enum rb_io_event events = 0; + int return_io = 0; + + // The documented signature for this method is actually incorrect. + // A single timeout is allowed in any position, and multiple symbols can be given. + // Whether this is intentional or not, I don't know, and as such I consider this to + // be a legacy/slow path. + if (argc != 2 || (RB_SYMBOL_P(argv[0]) || RB_SYMBOL_P(argv[1]))) { + // We'd prefer to return the actual mask, but this form would return the io itself: + return_io = 1; + + // Slow/messy path: + for (int i = 0; i < argc; i += 1) { + if (RB_SYMBOL_P(argv[i])) { + events |= wait_mode_sym(argv[i]); + } + else if (UNDEF_P(timeout)) { + rb_time_interval(timeout = argv[i]); + } + else { + rb_raise(rb_eArgError, "timeout given more than once"); + } + } + + if (UNDEF_P(timeout)) timeout = Qnil; + + if (events == 0) { + events = RUBY_IO_READABLE; + } + } + else /* argc == 2 and neither are symbols */ { + // This is the fast path: + events = io_event_from_value(argv[0]); + timeout = argv[1]; + } + + if (events & RUBY_IO_READABLE) { + rb_io_t *fptr = NULL; + RB_IO_POINTER(io, fptr); + + if (rb_io_read_pending(fptr)) { + // This was the original behaviour: + if (return_io) return Qtrue; + // New behaviour always returns an event mask: + else return RB_INT2NUM(RUBY_IO_READABLE); + } + } + + return io_wait_event(io, events, timeout, return_io); +} + static void argf_mark(void *ptr) { @@ -8847,11 +9953,11 @@ argf_initialize_copy(VALUE argf, VALUE orig) * call-seq: * ARGF.lineno = integer -> integer * - * Sets the line number of +ARGF+ as a whole to the given +Integer+. + * Sets the line number of ARGF as a whole to the given Integer. * - * +ARGF+ sets the line number automatically as you read data, so normally + * ARGF sets the line number automatically as you read data, so normally * you will not need to set it explicitly. To access the current line number - * use +ARGF.lineno+. + * use ARGF.lineno. * * For example: * @@ -8866,7 +9972,7 @@ argf_set_lineno(VALUE argf, VALUE val) { ARGF.lineno = NUM2INT(val); ARGF.last_lineno = ARGF.lineno; - return Qnil; + return val; } /* @@ -8874,7 +9980,7 @@ argf_set_lineno(VALUE argf, VALUE val) * ARGF.lineno -> integer * * Returns the current line number of ARGF as a whole. This value - * can be set manually with +ARGF.lineno=+. + * can be set manually with ARGF.lineno=. * * For example: * @@ -8899,7 +10005,7 @@ argf_forward(int argc, VALUE *argv, VALUE argf) (ARGF.current_file == rb_stdin && !RB_TYPE_P(ARGF.current_file, T_FILE)) #define ARGF_FORWARD(argc, argv) do {\ if (ARGF_GENERIC_INPUT_P())\ - return argf_forward((argc), (argv), argf);\ + return argf_forward((argc), (argv), argf);\ } while (0) #define NEXT_ARGF_FORWARD(argc, argv) do {\ if (!next_argv()) return Qnil;\ @@ -8912,7 +10018,7 @@ argf_close(VALUE argf) VALUE file = ARGF.current_file; if (file == rb_stdin) return; if (RB_TYPE_P(file, T_FILE)) { - rb_io_set_write_io(file, Qnil); + rb_io_set_write_io(file, Qnil); } io_close(file); ARGF.init_p = -1; @@ -8935,163 +10041,163 @@ argf_next_argv(VALUE argf) } if (ARGF.init_p == 0) { - if (!NIL_P(ARGF.argv) && RARRAY_LEN(ARGF.argv) > 0) { - ARGF.next_p = 1; - } - else { - ARGF.next_p = -1; - } - ARGF.init_p = 1; + if (!NIL_P(ARGF.argv) && RARRAY_LEN(ARGF.argv) > 0) { + ARGF.next_p = 1; + } + else { + ARGF.next_p = -1; + } + ARGF.init_p = 1; } else { - if (NIL_P(ARGF.argv)) { - ARGF.next_p = -1; - } - else if (ARGF.next_p == -1 && RARRAY_LEN(ARGF.argv) > 0) { - ARGF.next_p = 1; - } + if (NIL_P(ARGF.argv)) { + ARGF.next_p = -1; + } + else if (ARGF.next_p == -1 && RARRAY_LEN(ARGF.argv) > 0) { + ARGF.next_p = 1; + } } if (ARGF.next_p == 1) { - if (ARGF.init_p == 1) argf_close(argf); + if (ARGF.init_p == 1) argf_close(argf); retry: - if (RARRAY_LEN(ARGF.argv) > 0) { - VALUE filename = rb_ary_shift(ARGF.argv); - FilePathValue(filename); - ARGF.filename = filename; - filename = rb_str_encode_ospath(filename); - fn = StringValueCStr(filename); - if (RSTRING_LEN(filename) == 1 && fn[0] == '-') { - ARGF.current_file = rb_stdin; - if (ARGF.inplace) { - rb_warn("Can't do inplace edit for stdio; skipping"); - goto retry; - } - } - else { - VALUE write_io = Qnil; - int fr = rb_sysopen(filename, O_RDONLY, 0); - - if (ARGF.inplace) { - struct stat st; + if (RARRAY_LEN(ARGF.argv) > 0) { + VALUE filename = rb_ary_shift(ARGF.argv); + FilePathValue(filename); + ARGF.filename = filename; + filename = rb_str_encode_ospath(filename); + fn = StringValueCStr(filename); + if (RSTRING_LEN(filename) == 1 && fn[0] == '-') { + ARGF.current_file = rb_stdin; + if (ARGF.inplace) { + rb_warn("Can't do inplace edit for stdio; skipping"); + goto retry; + } + } + else { + VALUE write_io = Qnil; + int fr = rb_sysopen(filename, O_RDONLY, 0); + + if (ARGF.inplace) { + struct stat st; #ifndef NO_SAFE_RENAME - struct stat st2; -#endif - VALUE str; - int fw; - - if (RB_TYPE_P(r_stdout, T_FILE) && r_stdout != orig_stdout) { - rb_io_close(r_stdout); - } - fstat(fr, &st); - str = filename; - if (!NIL_P(ARGF.inplace)) { - VALUE suffix = ARGF.inplace; - str = rb_str_dup(str); - if (NIL_P(rb_str_cat_conv_enc_opts(str, RSTRING_LEN(str), - RSTRING_PTR(suffix), RSTRING_LEN(suffix), - rb_enc_get(suffix), 0, Qnil))) { - rb_str_append(str, suffix); - } + struct stat st2; +#endif + VALUE str; + int fw; + + if (RB_TYPE_P(r_stdout, T_FILE) && r_stdout != orig_stdout) { + rb_io_close(r_stdout); + } + fstat(fr, &st); + str = filename; + if (!NIL_P(ARGF.inplace)) { + VALUE suffix = ARGF.inplace; + str = rb_str_dup(str); + if (NIL_P(rb_str_cat_conv_enc_opts(str, RSTRING_LEN(str), + RSTRING_PTR(suffix), RSTRING_LEN(suffix), + rb_enc_get(suffix), 0, Qnil))) { + rb_str_append(str, suffix); + } #ifdef NO_SAFE_RENAME - (void)close(fr); - (void)unlink(RSTRING_PTR(str)); - if (rename(fn, RSTRING_PTR(str)) < 0) { - rb_warn("Can't rename %"PRIsVALUE" to %"PRIsVALUE": %s, skipping file", - filename, str, strerror(errno)); - goto retry; - } - fr = rb_sysopen(str, O_RDONLY, 0); + (void)close(fr); + (void)unlink(RSTRING_PTR(str)); + if (rename(fn, RSTRING_PTR(str)) < 0) { + rb_warn("Can't rename %"PRIsVALUE" to %"PRIsVALUE": %s, skipping file", + filename, str, strerror(errno)); + goto retry; + } + fr = rb_sysopen(str, O_RDONLY, 0); #else - if (rename(fn, RSTRING_PTR(str)) < 0) { - rb_warn("Can't rename %"PRIsVALUE" to %"PRIsVALUE": %s, skipping file", - filename, str, strerror(errno)); - close(fr); - goto retry; - } -#endif - } - else { + if (rename(fn, RSTRING_PTR(str)) < 0) { + rb_warn("Can't rename %"PRIsVALUE" to %"PRIsVALUE": %s, skipping file", + filename, str, strerror(errno)); + close(fr); + goto retry; + } +#endif + } + else { #ifdef NO_SAFE_RENAME - rb_fatal("Can't do inplace edit without backup"); + rb_fatal("Can't do inplace edit without backup"); #else - if (unlink(fn) < 0) { - rb_warn("Can't remove %"PRIsVALUE": %s, skipping file", - filename, strerror(errno)); - close(fr); - goto retry; - } -#endif - } - fw = rb_sysopen(filename, O_WRONLY|O_CREAT|O_TRUNC, 0666); + if (unlink(fn) < 0) { + rb_warn("Can't remove %"PRIsVALUE": %s, skipping file", + filename, strerror(errno)); + close(fr); + goto retry; + } +#endif + } + fw = rb_sysopen(filename, O_WRONLY|O_CREAT|O_TRUNC, 0666); #ifndef NO_SAFE_RENAME - fstat(fw, &st2); + fstat(fw, &st2); #ifdef HAVE_FCHMOD - fchmod(fw, st.st_mode); + fchmod(fw, st.st_mode); #else - chmod(fn, st.st_mode); + chmod(fn, st.st_mode); #endif - if (st.st_uid!=st2.st_uid || st.st_gid!=st2.st_gid) { - int err; + if (st.st_uid!=st2.st_uid || st.st_gid!=st2.st_gid) { + int err; #ifdef HAVE_FCHOWN - err = fchown(fw, st.st_uid, st.st_gid); + err = fchown(fw, st.st_uid, st.st_gid); #else - err = chown(fn, st.st_uid, st.st_gid); -#endif - if (err && getuid() == 0 && st2.st_uid == 0) { - const char *wkfn = RSTRING_PTR(filename); - rb_warn("Can't set owner/group of %"PRIsVALUE" to same as %"PRIsVALUE": %s, skipping file", - filename, str, strerror(errno)); - (void)close(fr); - (void)close(fw); - (void)unlink(wkfn); - goto retry; - } - } -#endif - write_io = prep_io(fw, FMODE_WRITABLE, rb_cFile, fn); - rb_ractor_stdout_set(write_io); - if (stdout_binmode) rb_io_binmode(rb_stdout); - } - fmode = FMODE_READABLE; - if (!ARGF.binmode) { - fmode |= DEFAULT_TEXTMODE; - } - ARGF.current_file = prep_io(fr, fmode, rb_cFile, fn); - if (!NIL_P(write_io)) { - rb_io_set_write_io(ARGF.current_file, write_io); - } - RB_GC_GUARD(filename); - } - if (ARGF.binmode) rb_io_ascii8bit_binmode(ARGF.current_file); - GetOpenFile(ARGF.current_file, fptr); - if (ARGF.encs.enc) { - fptr->encs = ARGF.encs; + err = chown(fn, st.st_uid, st.st_gid); +#endif + if (err && getuid() == 0 && st2.st_uid == 0) { + const char *wkfn = RSTRING_PTR(filename); + rb_warn("Can't set owner/group of %"PRIsVALUE" to same as %"PRIsVALUE": %s, skipping file", + filename, str, strerror(errno)); + (void)close(fr); + (void)close(fw); + (void)unlink(wkfn); + goto retry; + } + } +#endif + write_io = prep_io(fw, FMODE_WRITABLE, rb_cFile, fn); + rb_ractor_stdout_set(write_io); + if (stdout_binmode) rb_io_binmode(rb_stdout); + } + fmode = FMODE_READABLE; + if (!ARGF.binmode) { + fmode |= DEFAULT_TEXTMODE; + } + ARGF.current_file = prep_io(fr, fmode, rb_cFile, fn); + if (!NIL_P(write_io)) { + rb_io_set_write_io(ARGF.current_file, write_io); + } + RB_GC_GUARD(filename); + } + if (ARGF.binmode) rb_io_ascii8bit_binmode(ARGF.current_file); + GetOpenFile(ARGF.current_file, fptr); + if (ARGF.encs.enc) { + fptr->encs = ARGF.encs; clear_codeconv(fptr); - } - else { - fptr->encs.ecflags &= ~ECONV_NEWLINE_DECORATOR_MASK; - if (!ARGF.binmode) { - fptr->encs.ecflags |= ECONV_DEFAULT_NEWLINE_DECORATOR; + } + else { + fptr->encs.ecflags &= ~ECONV_NEWLINE_DECORATOR_MASK; + if (!ARGF.binmode) { + fptr->encs.ecflags |= ECONV_DEFAULT_NEWLINE_DECORATOR; #ifdef TEXTMODE_NEWLINE_DECORATOR_ON_WRITE - fptr->encs.ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE; + fptr->encs.ecflags |= TEXTMODE_NEWLINE_DECORATOR_ON_WRITE; #endif - } - } - ARGF.next_p = 0; - } - else { - ARGF.next_p = 1; - return FALSE; - } + } + } + ARGF.next_p = 0; + } + else { + ARGF.next_p = 1; + return FALSE; + } } else if (ARGF.next_p == -1) { - ARGF.current_file = rb_stdin; - ARGF.filename = rb_str_new2("-"); - if (ARGF.inplace) { - rb_warn("Can't do inplace edit for stdio"); - rb_ractor_stdout_set(orig_stdout); - } + ARGF.current_file = rb_stdin; + ARGF.filename = rb_str_new2("-"); + if (ARGF.inplace) { + rb_warn("Can't do inplace edit for stdio"); + rb_ractor_stdout_set(orig_stdout); + } } if (ARGF.init_p == -1) ARGF.init_p = 1; return TRUE; @@ -9106,24 +10212,24 @@ argf_getline(int argc, VALUE *argv, VALUE argf) retry: if (!next_argv()) return Qnil; if (ARGF_GENERIC_INPUT_P()) { - line = forward_current(idGets, argc, argv); + line = forward_current(idGets, argc, argv); } else { - if (argc == 0 && rb_rs == rb_default_rs) { - line = rb_io_gets(ARGF.current_file); - } - else { - line = rb_io_getline(argc, argv, ARGF.current_file); - } - if (NIL_P(line) && ARGF.next_p != -1) { - argf_close(argf); - ARGF.next_p = 1; - goto retry; - } + if (argc == 0 && rb_rs == rb_default_rs) { + line = rb_io_gets(ARGF.current_file); + } + else { + line = rb_io_getline(argc, argv, ARGF.current_file); + } + if (NIL_P(line) && ARGF.next_p != -1) { + argf_close(argf); + ARGF.next_p = 1; + goto retry; + } } if (!NIL_P(line)) { - ARGF.lineno = ++lineno; - ARGF.last_lineno = ARGF.lineno; + ARGF.lineno = ++lineno; + ARGF.last_lineno = ARGF.lineno; } return line; } @@ -9143,6 +10249,12 @@ argf_lineno_setter(VALUE val, ID id, VALUE *var) ARGF.last_lineno = ARGF.lineno = n; } +void +rb_reset_argf_lineno(long n) +{ + ARGF.last_lineno = ARGF.lineno = n; +} + static VALUE argf_gets(int, VALUE *, VALUE); /* @@ -9182,7 +10294,7 @@ static VALUE rb_f_gets(int argc, VALUE *argv, VALUE recv) { if (recv == argf) { - return argf_gets(argc, argv, argf); + return argf_gets(argc, argv, argf); } return forward(argf, idGets, argc, argv); } @@ -9193,10 +10305,10 @@ rb_f_gets(int argc, VALUE *argv, VALUE recv) * ARGF.gets(limit [, getline_args]) -> string or nil * ARGF.gets(sep, limit [, getline_args]) -> string or nil * - * Returns the next line from the current file in +ARGF+. + * Returns the next line from the current file in ARGF. * * By default lines are assumed to be separated by <code>$/</code>; - * to use a different character as a separator, supply it as a +String+ + * to use a different character as a separator, supply it as a String * for the _sep_ argument. * * The optional _limit_ argument specifies how many characters of each line @@ -9222,21 +10334,21 @@ rb_gets(void) VALUE line; if (rb_rs != rb_default_rs) { - return rb_f_gets(0, 0, argf); + return rb_f_gets(0, 0, argf); } retry: if (!next_argv()) return Qnil; line = rb_io_gets(ARGF.current_file); if (NIL_P(line) && ARGF.next_p != -1) { - rb_io_close(ARGF.current_file); - ARGF.next_p = 1; - goto retry; + rb_io_close(ARGF.current_file); + ARGF.next_p = 1; + goto retry; } rb_lastline_set(line); if (!NIL_P(line)) { - ARGF.lineno++; - ARGF.last_lineno = ARGF.lineno; + ARGF.lineno++; + ARGF.last_lineno = ARGF.lineno; } return line; @@ -9246,19 +10358,26 @@ static VALUE argf_readline(int, VALUE *, VALUE); /* * call-seq: - * readline(sep=$/) -> string - * readline(limit) -> string - * readline(sep, limit) -> string + * readline(sep = $/, chomp: false) -> string + * readline(limit, chomp: false) -> string + * readline(sep, limit, chomp: false) -> string * - * Equivalent to Kernel::gets, except - * +readline+ raises +EOFError+ at end of file. + * Equivalent to method Kernel#gets, except that it raises an exception + * if called at end-of-stream: + * + * $ cat t.txt | ruby -e "p readlines; readline" + * ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"] + * in `readline': end of file reached (EOFError) + * + * Optional keyword argument +chomp+ specifies whether line separators + * are to be omitted. */ static VALUE rb_f_readline(int argc, VALUE *argv, VALUE recv) { if (recv == argf) { - return argf_readline(argc, argv, argf); + return argf_readline(argc, argv, argf); } return forward(argf, rb_intern("readline"), argc, argv); } @@ -9270,16 +10389,16 @@ rb_f_readline(int argc, VALUE *argv, VALUE recv) * ARGF.readline(limit) -> string * ARGF.readline(sep, limit) -> string * - * Returns the next line from the current file in +ARGF+. + * Returns the next line from the current file in ARGF. * * By default lines are assumed to be separated by <code>$/</code>; - * to use a different character as a separator, supply it as a +String+ + * to use a different character as a separator, supply it as a String * for the _sep_ argument. * * The optional _limit_ argument specifies how many characters of each line * to return. By default all characters are returned. * - * An +EOFError+ is raised at the end of the file. + * An EOFError is raised at the end of the file. */ static VALUE argf_readline(int argc, VALUE *argv, VALUE argf) @@ -9290,7 +10409,7 @@ argf_readline(int argc, VALUE *argv, VALUE argf) ARGF_FORWARD(argc, argv); line = argf_gets(argc, argv, argf); if (NIL_P(line)) { - rb_eof_error(); + rb_eof_error(); } return line; @@ -9300,38 +10419,89 @@ static VALUE argf_readlines(int, VALUE *, VALUE); /* * call-seq: - * readlines(sep=$/) -> array - * readlines(limit) -> array - * readlines(sep, limit) -> array + * readlines(sep = $/, chomp: false, **enc_opts) -> array + * readlines(limit, chomp: false, **enc_opts) -> array + * readlines(sep, limit, chomp: false, **enc_opts) -> array * * Returns an array containing the lines returned by calling - * <code>Kernel.gets(<i>sep</i>)</code> until the end of file. + * Kernel#gets until the end-of-stream is reached; + * (see {Line IO}[rdoc-ref:IO@Line+IO]). + * + * With only string argument +sep+ given, + * returns the remaining lines as determined by line separator +sep+, + * or +nil+ if none; + * see {Line Separator}[rdoc-ref:IO@Line+Separator]: + * + * # Default separator. + * $ cat t.txt | ruby -e "p readlines" + * ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"] + * + * # Specified separator. + * $ cat t.txt | ruby -e "p readlines 'li'" + * ["First li", "ne\nSecond li", "ne\n\nFourth li", "ne\nFifth li", "ne\n"] + * + * # Get-all separator. + * $ cat t.txt | ruby -e "p readlines nil" + * ["First line\nSecond line\n\nFourth line\nFifth line\n"] + * + * # Get-paragraph separator. + * $ cat t.txt | ruby -e "p readlines ''" + * ["First line\nSecond line\n\n", "Fourth line\nFifth line\n"] + * + * With only integer argument +limit+ given, + * limits the number of bytes in the line; + * see {Line Limit}[rdoc-ref:IO@Line+Limit]: + * + * $cat t.txt | ruby -e "p readlines 10" + * ["First line", "\n", "Second lin", "e\n", "\n", "Fourth lin", "e\n", "Fifth line", "\n"] + * + * $cat t.txt | ruby -e "p readlines 11" + * ["First line\n", "Second line", "\n", "\n", "Fourth line", "\n", "Fifth line\n"] + * + * $cat t.txt | ruby -e "p readlines 12" + * ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"] + * + * With arguments +sep+ and +limit+ given, + * combines the two behaviors + * (see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit]). + * + * Optional keyword argument +chomp+ specifies whether line separators + * are to be omitted: + * + * $ cat t.txt | ruby -e "p readlines(chomp: true)" + * ["First line", "Second line", "", "Fourth line", "Fifth line"] + * + * Optional keyword arguments +enc_opts+ specify encoding options; + * see {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. + * */ static VALUE rb_f_readlines(int argc, VALUE *argv, VALUE recv) { if (recv == argf) { - return argf_readlines(argc, argv, argf); + return argf_readlines(argc, argv, argf); } return forward(argf, rb_intern("readlines"), argc, argv); } /* * call-seq: - * ARGF.readlines(sep=$/) -> array - * ARGF.readlines(limit) -> array - * ARGF.readlines(sep, limit) -> array + * ARGF.readlines(sep = $/, chomp: false) -> array + * ARGF.readlines(limit, chomp: false) -> array + * ARGF.readlines(sep, limit, chomp: false) -> array * - * ARGF.to_a(sep=$/) -> array - * ARGF.to_a(limit) -> array - * ARGF.to_a(sep, limit) -> array + * ARGF.to_a(sep = $/, chomp: false) -> array + * ARGF.to_a(limit, chomp: false) -> array + * ARGF.to_a(sep, limit, chomp: false) -> array * - * Reads +ARGF+'s current file in its entirety, returning an +Array+ of its - * lines, one line per element. Lines are assumed to be separated by _sep_. + * Reads each file in ARGF in its entirety, returning an Array containing + * lines from the files. Lines are assumed to be separated by _sep_. * * lines = ARGF.readlines * lines[0] #=> "This is line one\n" + * + * See +IO.readlines+ for a full description of all options. */ static VALUE argf_readlines(int argc, VALUE *argv, VALUE argf) @@ -9341,17 +10511,17 @@ argf_readlines(int argc, VALUE *argv, VALUE argf) ary = rb_ary_new(); while (next_argv()) { - if (ARGF_GENERIC_INPUT_P()) { - lines = forward_current(rb_intern("readlines"), argc, argv); - } - else { - lines = rb_io_readlines(argc, argv, ARGF.current_file); - argf_close(argf); - } - ARGF.next_p = 1; - rb_ary_concat(ary, lines); - ARGF.lineno = lineno + RARRAY_LEN(ary); - ARGF.last_lineno = ARGF.lineno; + if (ARGF_GENERIC_INPUT_P()) { + lines = forward_current(rb_intern("readlines"), argc, argv); + } + else { + lines = rb_io_readlines(argc, argv, ARGF.current_file); + argf_close(argf); + } + ARGF.next_p = 1; + rb_ary_concat(ary, lines); + ARGF.lineno = lineno + RARRAY_LEN(ary); + ARGF.last_lineno = ARGF.lineno; } ARGF.init_p = 0; return ary; @@ -9359,16 +10529,23 @@ argf_readlines(int argc, VALUE *argv, VALUE argf) /* * call-seq: - * `cmd` -> string + * `command` -> string + * + * Returns the <tt>$stdout</tt> output from running +command+ in a subshell; + * sets global variable <tt>$?</tt> to the process status. + * + * This method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. + * + * Examples: + * + * $ `date` # => "Wed Apr 9 08:56:30 CDT 2003\n" + * $ `echo oops && exit 99` # => "oops\n" + * $ $? # => #<Process::Status: pid 17088 exit 99> + * $ $?.status # => 99> * - * Returns the standard output of running _cmd_ in a subshell. - * The built-in syntax <code>%x{...}</code> uses - * this method. Sets <code>$?</code> to the process status. + * The built-in syntax <tt>%x{...}</tt> uses this method. * - * `date` #=> "Wed Apr 9 08:56:30 CDT 2003\n" - * `ls testdir`.split[1] #=> "main.rb" - * `echo oops && exit 99` #=> "oops\n" - * $?.exitstatus #=> 99 */ static VALUE @@ -9378,7 +10555,7 @@ rb_f_backquote(VALUE obj, VALUE str) VALUE result; rb_io_t *fptr; - SafeStringValue(str); + StringValue(str); rb_last_status_clear(); port = pipe_open_s(str, "r", FMODE_READABLE|DEFAULT_TEXTMODE, NULL); if (NIL_P(port)) return rb_str_new(0,0); @@ -9386,9 +10563,8 @@ rb_f_backquote(VALUE obj, VALUE str) GetOpenFile(port, fptr); result = read_all(fptr, remain_size(fptr), Qnil); rb_io_close(port); - RFILE(port)->fptr = NULL; - rb_io_fptr_finalize(fptr); - rb_gc_force_recycle(port); /* also guards from premature GC */ + rb_io_fptr_cleanup_all(fptr); + RB_GC_GUARD(port); return result; } @@ -9409,63 +10585,63 @@ select_internal(VALUE read, VALUE write, VALUE except, struct timeval *tp, rb_fd struct timeval timerec; if (!NIL_P(read)) { - Check_Type(read, T_ARRAY); - for (i=0; i<RARRAY_LEN(read); i++) { - GetOpenFile(rb_io_get_io(RARRAY_AREF(read, i)), fptr); - rb_fd_set(fptr->fd, &fds[0]); - if (READ_DATA_PENDING(fptr) || READ_CHAR_PENDING(fptr)) { /* check for buffered data */ - pending++; - rb_fd_set(fptr->fd, &fds[3]); - } - if (max < fptr->fd) max = fptr->fd; - } - if (pending) { /* no blocking if there's buffered data */ - timerec.tv_sec = timerec.tv_usec = 0; - tp = &timerec; - } - rp = &fds[0]; + Check_Type(read, T_ARRAY); + for (i=0; i<RARRAY_LEN(read); i++) { + GetOpenFile(rb_io_get_io(RARRAY_AREF(read, i)), fptr); + rb_fd_set(fptr->fd, &fds[0]); + if (READ_DATA_PENDING(fptr) || READ_CHAR_PENDING(fptr)) { /* check for buffered data */ + pending++; + rb_fd_set(fptr->fd, &fds[3]); + } + if (max < fptr->fd) max = fptr->fd; + } + if (pending) { /* no blocking if there's buffered data */ + timerec.tv_sec = timerec.tv_usec = 0; + tp = &timerec; + } + rp = &fds[0]; } else - rp = 0; + rp = 0; if (!NIL_P(write)) { - Check_Type(write, T_ARRAY); - for (i=0; i<RARRAY_LEN(write); i++) { + Check_Type(write, T_ARRAY); + for (i=0; i<RARRAY_LEN(write); i++) { VALUE write_io = GetWriteIO(rb_io_get_io(RARRAY_AREF(write, i))); - GetOpenFile(write_io, fptr); - rb_fd_set(fptr->fd, &fds[1]); - if (max < fptr->fd) max = fptr->fd; - } - wp = &fds[1]; + GetOpenFile(write_io, fptr); + rb_fd_set(fptr->fd, &fds[1]); + if (max < fptr->fd) max = fptr->fd; + } + wp = &fds[1]; } else - wp = 0; + wp = 0; if (!NIL_P(except)) { - Check_Type(except, T_ARRAY); - for (i=0; i<RARRAY_LEN(except); i++) { + Check_Type(except, T_ARRAY); + for (i=0; i<RARRAY_LEN(except); i++) { VALUE io = rb_io_get_io(RARRAY_AREF(except, i)); VALUE write_io = GetWriteIO(io); - GetOpenFile(io, fptr); - rb_fd_set(fptr->fd, &fds[2]); - if (max < fptr->fd) max = fptr->fd; + GetOpenFile(io, fptr); + rb_fd_set(fptr->fd, &fds[2]); + if (max < fptr->fd) max = fptr->fd; if (io != write_io) { GetOpenFile(write_io, fptr); rb_fd_set(fptr->fd, &fds[2]); if (max < fptr->fd) max = fptr->fd; } - } - ep = &fds[2]; + } + ep = &fds[2]; } else { - ep = 0; + ep = 0; } max++; n = rb_thread_fd_select(max, rp, wp, ep, tp); if (n < 0) { - rb_sys_fail(0); + rb_sys_fail(0); } if (!pending && n == 0) return Qnil; /* returns nil on timeout */ @@ -9475,48 +10651,48 @@ select_internal(VALUE read, VALUE write, VALUE except, struct timeval *tp, rb_fd rb_ary_push(res, ep?rb_ary_new():rb_ary_new2(0)); if (rp) { - list = RARRAY_AREF(res, 0); - for (i=0; i< RARRAY_LEN(read); i++) { - VALUE obj = rb_ary_entry(read, i); - VALUE io = rb_io_get_io(obj); - GetOpenFile(io, fptr); - if (rb_fd_isset(fptr->fd, &fds[0]) || - rb_fd_isset(fptr->fd, &fds[3])) { - rb_ary_push(list, obj); - } - } + list = RARRAY_AREF(res, 0); + for (i=0; i< RARRAY_LEN(read); i++) { + VALUE obj = rb_ary_entry(read, i); + VALUE io = rb_io_get_io(obj); + GetOpenFile(io, fptr); + if (rb_fd_isset(fptr->fd, &fds[0]) || + rb_fd_isset(fptr->fd, &fds[3])) { + rb_ary_push(list, obj); + } + } } if (wp) { - list = RARRAY_AREF(res, 1); - for (i=0; i< RARRAY_LEN(write); i++) { - VALUE obj = rb_ary_entry(write, i); - VALUE io = rb_io_get_io(obj); - VALUE write_io = GetWriteIO(io); - GetOpenFile(write_io, fptr); - if (rb_fd_isset(fptr->fd, &fds[1])) { - rb_ary_push(list, obj); - } - } + list = RARRAY_AREF(res, 1); + for (i=0; i< RARRAY_LEN(write); i++) { + VALUE obj = rb_ary_entry(write, i); + VALUE io = rb_io_get_io(obj); + VALUE write_io = GetWriteIO(io); + GetOpenFile(write_io, fptr); + if (rb_fd_isset(fptr->fd, &fds[1])) { + rb_ary_push(list, obj); + } + } } if (ep) { - list = RARRAY_AREF(res, 2); - for (i=0; i< RARRAY_LEN(except); i++) { - VALUE obj = rb_ary_entry(except, i); - VALUE io = rb_io_get_io(obj); - VALUE write_io = GetWriteIO(io); - GetOpenFile(io, fptr); - if (rb_fd_isset(fptr->fd, &fds[2])) { - rb_ary_push(list, obj); - } - else if (io != write_io) { - GetOpenFile(write_io, fptr); - if (rb_fd_isset(fptr->fd, &fds[2])) { - rb_ary_push(list, obj); - } - } - } + list = RARRAY_AREF(res, 2); + for (i=0; i< RARRAY_LEN(except); i++) { + VALUE obj = rb_ary_entry(except, i); + VALUE io = rb_io_get_io(obj); + VALUE write_io = GetWriteIO(io); + GetOpenFile(io, fptr); + if (rb_fd_isset(fptr->fd, &fds[2])) { + rb_ary_push(list, obj); + } + else if (io != write_io) { + GetOpenFile(write_io, fptr); + if (rb_fd_isset(fptr->fd, &fds[2])) { + rb_ary_push(list, obj); + } + } + } } return res; /* returns an empty array on interrupt */ @@ -9543,7 +10719,7 @@ select_end(VALUE arg) int i; for (i = 0; i < numberof(p->fdsets); ++i) - rb_fd_term(&p->fdsets[i]); + rb_fd_term(&p->fdsets[i]); return Qnil; } @@ -9554,8 +10730,8 @@ static VALUE sym_normal, sym_sequential, sym_random, struct io_advise_struct { int fd; int advice; - off_t offset; - off_t len; + rb_off_t offset; + rb_off_t len; }; static VALUE @@ -9570,39 +10746,39 @@ io_advise_sym_to_const(VALUE sym) { #ifdef POSIX_FADV_NORMAL if (sym == sym_normal) - return INT2NUM(POSIX_FADV_NORMAL); + return INT2NUM(POSIX_FADV_NORMAL); #endif #ifdef POSIX_FADV_RANDOM if (sym == sym_random) - return INT2NUM(POSIX_FADV_RANDOM); + return INT2NUM(POSIX_FADV_RANDOM); #endif #ifdef POSIX_FADV_SEQUENTIAL if (sym == sym_sequential) - return INT2NUM(POSIX_FADV_SEQUENTIAL); + return INT2NUM(POSIX_FADV_SEQUENTIAL); #endif #ifdef POSIX_FADV_WILLNEED if (sym == sym_willneed) - return INT2NUM(POSIX_FADV_WILLNEED); + return INT2NUM(POSIX_FADV_WILLNEED); #endif #ifdef POSIX_FADV_DONTNEED if (sym == sym_dontneed) - return INT2NUM(POSIX_FADV_DONTNEED); + return INT2NUM(POSIX_FADV_DONTNEED); #endif #ifdef POSIX_FADV_NOREUSE if (sym == sym_noreuse) - return INT2NUM(POSIX_FADV_NOREUSE); + return INT2NUM(POSIX_FADV_NOREUSE); #endif return Qnil; } static VALUE -do_io_advise(rb_io_t *fptr, VALUE advice, off_t offset, off_t len) +do_io_advise(rb_io_t *fptr, VALUE advice, rb_off_t offset, rb_off_t len) { int rv; struct io_advise_struct ias; @@ -9615,7 +10791,7 @@ do_io_advise(rb_io_t *fptr, VALUE advice, off_t offset, off_t len) * silently ignore it. Because IO::advise is only hint. */ if (NIL_P(num_adv)) - return Qnil; + return Qnil; ias.fd = fptr->fd; ias.advice = NUM2INT(num_adv); @@ -9624,14 +10800,14 @@ do_io_advise(rb_io_t *fptr, VALUE advice, off_t offset, off_t len) rv = (int)rb_thread_io_blocking_region(io_advise_internal, &ias, fptr->fd); if (rv && rv != ENOSYS) { - /* posix_fadvise(2) doesn't set errno. On success it returns 0; otherwise - it returns the error code. */ - VALUE message = rb_sprintf("%"PRIsVALUE" " - "(%"PRI_OFFT_PREFIX"d, " - "%"PRI_OFFT_PREFIX"d, " - "%"PRIsVALUE")", - fptr->pathv, offset, len, advice); - rb_syserr_fail_str(rv, message); + /* posix_fadvise(2) doesn't set errno. On success it returns 0; otherwise + it returns the error code. */ + VALUE message = rb_sprintf("%"PRIsVALUE" " + "(%"PRI_OFFT_PREFIX"d, " + "%"PRI_OFFT_PREFIX"d, " + "%"PRIsVALUE")", + fptr->pathv, offset, len, advice); + rb_syserr_fail_str(rv, message); } return Qnil; @@ -9643,65 +10819,56 @@ static void advice_arg_check(VALUE advice) { if (!SYMBOL_P(advice)) - rb_raise(rb_eTypeError, "advice must be a Symbol"); + rb_raise(rb_eTypeError, "advice must be a Symbol"); if (advice != sym_normal && - advice != sym_sequential && - advice != sym_random && - advice != sym_willneed && - advice != sym_dontneed && - advice != sym_noreuse) { - rb_raise(rb_eNotImpError, "Unsupported advice: %+"PRIsVALUE, advice); + advice != sym_sequential && + advice != sym_random && + advice != sym_willneed && + advice != sym_dontneed && + advice != sym_noreuse) { + rb_raise(rb_eNotImpError, "Unsupported advice: %+"PRIsVALUE, advice); } } /* * call-seq: - * ios.advise(advice, offset=0, len=0) -> nil + * advise(advice, offset = 0, len = 0) -> nil * - * Announce an intention to access data from the current file in a - * specific pattern. On platforms that do not support the - * <em>posix_fadvise(2)</em> system call, this method is a no-op. + * Invokes Posix system call + * {posix_fadvise(2)}[https://linux.die.net/man/2/posix_fadvise], + * which announces an intention to access data from the current file + * in a particular manner. * - * _advice_ is one of the following symbols: + * The arguments and results are platform-dependent. * - * :normal:: No advice to give; the default assumption for an open file. - * :sequential:: The data will be accessed sequentially - * with lower offsets read before higher ones. - * :random:: The data will be accessed in random order. - * :willneed:: The data will be accessed in the near future. - * :dontneed:: The data will not be accessed in the near future. - * :noreuse:: The data will only be accessed once. + * The relevant data is specified by: * - * The semantics of a piece of advice are platform-dependent. See - * <em>man 2 posix_fadvise</em> for details. + * - +offset+: The offset of the first byte of data. + * - +len+: The number of bytes to be accessed; + * if +len+ is zero, or is larger than the number of bytes remaining, + * all remaining bytes will be accessed. * - * "data" means the region of the current file that begins at - * _offset_ and extends for _len_ bytes. If _len_ is 0, the region - * ends at the last byte of the file. By default, both _offset_ and - * _len_ are 0, meaning that the advice applies to the entire file. + * Argument +advice+ is one of the following symbols: * - * If an error occurs, one of the following exceptions will be raised: + * - +:normal+: The application has no advice to give + * about its access pattern for the specified data. + * If no advice is given for an open file, this is the default assumption. + * - +:sequential+: The application expects to access the specified data sequentially + * (with lower offsets read before higher ones). + * - +:random+: The specified data will be accessed in random order. + * - +:noreuse+: The specified data will be accessed only once. + * - +:willneed+: The specified data will be accessed in the near future. + * - +:dontneed+: The specified data will not be accessed in the near future. * - * IOError:: The IO stream is closed. - * Errno::EBADF:: - * The file descriptor of the current file is invalid. - * Errno::EINVAL:: An invalid value for _advice_ was given. - * Errno::ESPIPE:: - * The file descriptor of the current file refers to a FIFO or - * pipe. (Linux raises Errno::EINVAL in this case). - * TypeError:: - * Either _advice_ was not a Symbol, or one of the - * other arguments was not an Integer. - * RangeError:: One of the arguments given was too big/small. + * Not implemented on all platforms. * - * This list is not exhaustive; other Errno:: exceptions are also possible. */ static VALUE rb_io_advise(int argc, VALUE *argv, VALUE io) { VALUE advice, offset, len; - off_t off, l; + rb_off_t off, l; rb_io_t *fptr; rb_scan_args(argc, argv, "12", &advice, &offset, &len); @@ -9723,31 +10890,45 @@ rb_io_advise(int argc, VALUE *argv, VALUE io) /* * call-seq: - * IO.select(read_array [, write_array [, error_array [, timeout]]]) -> array or nil + * IO.select(read_ios, write_ios = [], error_ios = [], timeout = nil) -> array or nil + * + * Invokes system call {select(2)}[https://linux.die.net/man/2/select], + * which monitors multiple file descriptors, + * waiting until one or more of the file descriptors + * becomes ready for some class of I/O operation. + * + * Not implemented on all platforms. * - * Calls select(2) system call. - * It monitors given arrays of IO objects, waits until one or more of - * IO objects are ready for reading, are ready for writing, and have - * pending exceptions respectively, and returns an array that contains - * arrays of those IO objects. It will return +nil+ if optional - * <i>timeout</i> value is given and no IO object is ready in - * <i>timeout</i> seconds. + * Each of the arguments +read_ios+, +write_ios+, and +error_ios+ + * is an array of IO objects. * - * IO.select peeks the buffer of IO objects for testing readability. - * If the IO buffer is not empty, IO.select immediately notifies - * readability. This "peek" only happens for IO objects. It does not + * Argument +timeout+ is an integer timeout interval in seconds. + * + * The method monitors the \IO objects given in all three arrays, + * waiting for some to be ready; + * returns a 3-element array whose elements are: + * + * - An array of the objects in +read_ios+ that are ready for reading. + * - An array of the objects in +write_ios+ that are ready for writing. + * - An array of the objects in +error_ios+ have pending exceptions. + * + * If no object becomes ready within the given +timeout+, +nil+ is returned. + * + * \IO.select peeks the buffer of \IO objects for testing readability. + * If the \IO buffer is not empty, \IO.select immediately notifies + * readability. This "peek" only happens for \IO objects. It does not * happen for IO-like objects such as OpenSSL::SSL::SSLSocket. * - * The best way to use IO.select is invoking it after nonblocking + * The best way to use \IO.select is invoking it after non-blocking * methods such as #read_nonblock, #write_nonblock, etc. The methods * raise an exception which is extended by IO::WaitReadable or * IO::WaitWritable. The modules notify how the caller should wait - * with IO.select. If IO::WaitReadable is raised, the caller should + * with \IO.select. If IO::WaitReadable is raised, the caller should * wait for reading. If IO::WaitWritable is raised, the caller should * wait for writing. * * So, blocking read (#readpartial) can be emulated using - * #read_nonblock and IO.select as follows: + * #read_nonblock and \IO.select as follows: * * begin * result = io_like.read_nonblock(maxlen) @@ -9759,16 +10940,16 @@ rb_io_advise(int argc, VALUE *argv, VALUE io) * retry * end * - * Especially, the combination of nonblocking methods and IO.select is + * Especially, the combination of non-blocking methods and \IO.select is * preferred for IO like objects such as OpenSSL::SSL::SSLSocket. It * has #to_io method to return underlying IO object. IO.select calls * #to_io to obtain the file descriptor to wait. * - * This means that readability notified by IO.select doesn't mean + * This means that readability notified by \IO.select doesn't mean * readability from OpenSSL::SSL::SSLSocket object. * * The most likely situation is that OpenSSL::SSL::SSLSocket buffers - * some data. IO.select doesn't see the buffer. So IO.select can + * some data. \IO.select doesn't see the buffer. So \IO.select can * block when OpenSSL::SSL::SSLSocket#readpartial doesn't block. * * However, several more complicated situations exist. @@ -9788,23 +10969,23 @@ rb_io_advise(int argc, VALUE *argv, VALUE io) * So, the caller should wait for ready for writability as above * example. * - * The combination of nonblocking methods and IO.select is also useful + * The combination of non-blocking methods and \IO.select is also useful * for streams such as tty, pipe socket socket when multiple processes * read from a stream. * * Finally, Linux kernel developers don't guarantee that * readability of select(2) means readability of following read(2) even - * for a single process. - * See select(2) manual on GNU/Linux system. + * for a single process; + * see {select(2)}[https://linux.die.net/man/2/select] * - * Invoking IO.select before IO#readpartial works well as usual. - * However it is not the best way to use IO.select. + * Invoking \IO.select before IO#readpartial works well as usual. + * However it is not the best way to use \IO.select. * * The writability notified by select(2) doesn't show * how many bytes are writable. * IO#write method blocks until given whole string is written. - * So, <code>IO#write(two or more bytes)</code> can block after - * writability is notified by IO.select. IO#write_nonblock is required + * So, <tt>IO#write(two or more bytes)</tt> can block after + * writability is notified by \IO.select. IO#write_nonblock is required * to avoid the blocking. * * Blocking write (#write) can be emulated using #write_nonblock and @@ -9824,13 +11005,7 @@ rb_io_advise(int argc, VALUE *argv, VALUE io) * string = string.byteslice(written..-1) * end * - * === Parameters - * read_array:: an array of IO objects that wait until ready for read - * write_array:: an array of IO objects that wait until ready for write - * error_array:: an array of IO objects that wait for exceptions - * timeout:: a numeric value in second - * - * === Example + * Example: * * rp, wp = IO.pipe * mesg = "ping " @@ -9852,18 +11027,26 @@ rb_io_advise(int argc, VALUE *argv, VALUE io) * end * } * - * <em>produces:</em> + * Output: * * ping pong * ping pong * ping pong * (snipped) * ping + * */ static VALUE rb_f_select(int argc, VALUE *argv, VALUE obj) { + VALUE scheduler = rb_fiber_scheduler_current(); + if (scheduler != Qnil) { + // It's optionally supported. + VALUE result = rb_fiber_scheduler_io_selectv(scheduler, argc, argv); + if (!UNDEF_P(result)) return result; + } + VALUE timeout; struct select_args args; struct timeval timerec; @@ -9871,15 +11054,15 @@ rb_f_select(int argc, VALUE *argv, VALUE obj) rb_scan_args(argc, argv, "13", &args.read, &args.write, &args.except, &timeout); if (NIL_P(timeout)) { - args.timeout = 0; + args.timeout = 0; } else { - timerec = rb_time_interval(timeout); - args.timeout = &timerec; + timerec = rb_time_interval(timeout); + args.timeout = &timerec; } for (i = 0; i < numberof(args.fdsets); ++i) - rb_fd_init(&args.fdsets[i]); + rb_fd_init(&args.fdsets[i]); return rb_ensure(select_call, (VALUE)&args, select_end, (VALUE)&args); } @@ -9922,7 +11105,7 @@ do_ioctl(int fd, ioctl_req_t cmd, long narg) } #endif -#define DEFULT_IOCTL_NARG_LEN (256) +#define DEFAULT_IOCTL_NARG_LEN (256) #if defined(__linux__) && defined(_IOC_SIZE) static long @@ -9931,20 +11114,21 @@ linux_iocparm_len(ioctl_req_t cmd) long len; if ((cmd & 0xFFFF0000) == 0) { - /* legacy and unstructured ioctl number. */ - return DEFULT_IOCTL_NARG_LEN; + /* legacy and unstructured ioctl number. */ + return DEFAULT_IOCTL_NARG_LEN; } len = _IOC_SIZE(cmd); /* paranoia check for silly drivers which don't keep ioctl convention */ - if (len < DEFULT_IOCTL_NARG_LEN) - len = DEFULT_IOCTL_NARG_LEN; + if (len < DEFAULT_IOCTL_NARG_LEN) + len = DEFAULT_IOCTL_NARG_LEN; return len; } #endif +#ifdef HAVE_IOCTL static long ioctl_narg_len(ioctl_req_t cmd) { @@ -9961,11 +11145,12 @@ ioctl_narg_len(ioctl_req_t cmd) len = linux_iocparm_len(cmd); #else /* otherwise guess at what's safe */ - len = DEFULT_IOCTL_NARG_LEN; + len = DEFAULT_IOCTL_NARG_LEN; #endif return len; } +#endif #ifdef HAVE_FCNTL #ifdef __linux__ @@ -9976,181 +11161,196 @@ typedef int fcntl_arg_t; #endif static long -fcntl_narg_len(int cmd) +fcntl_narg_len(ioctl_req_t cmd) { long len; switch (cmd) { #ifdef F_DUPFD case F_DUPFD: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif #ifdef F_DUP2FD /* bsd specific */ case F_DUP2FD: - len = sizeof(int); - break; + len = sizeof(int); + break; #endif #ifdef F_DUPFD_CLOEXEC /* linux specific */ case F_DUPFD_CLOEXEC: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif #ifdef F_GETFD case F_GETFD: - len = 1; - break; + len = 1; + break; #endif #ifdef F_SETFD case F_SETFD: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif #ifdef F_GETFL case F_GETFL: - len = 1; - break; + len = 1; + break; #endif #ifdef F_SETFL case F_SETFL: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif #ifdef F_GETOWN case F_GETOWN: - len = 1; - break; + len = 1; + break; #endif #ifdef F_SETOWN case F_SETOWN: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif #ifdef F_GETOWN_EX /* linux specific */ case F_GETOWN_EX: - len = sizeof(struct f_owner_ex); - break; + len = sizeof(struct f_owner_ex); + break; #endif #ifdef F_SETOWN_EX /* linux specific */ case F_SETOWN_EX: - len = sizeof(struct f_owner_ex); - break; + len = sizeof(struct f_owner_ex); + break; #endif #ifdef F_GETLK case F_GETLK: - len = sizeof(struct flock); - break; + len = sizeof(struct flock); + break; #endif #ifdef F_SETLK case F_SETLK: - len = sizeof(struct flock); - break; + len = sizeof(struct flock); + break; #endif #ifdef F_SETLKW case F_SETLKW: - len = sizeof(struct flock); - break; + len = sizeof(struct flock); + break; #endif #ifdef F_READAHEAD /* bsd specific */ case F_READAHEAD: - len = sizeof(int); - break; + len = sizeof(int); + break; #endif #ifdef F_RDAHEAD /* Darwin specific */ case F_RDAHEAD: - len = sizeof(int); - break; + len = sizeof(int); + break; #endif #ifdef F_GETSIG /* linux specific */ case F_GETSIG: - len = 1; - break; + len = 1; + break; #endif #ifdef F_SETSIG /* linux specific */ case F_SETSIG: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif #ifdef F_GETLEASE /* linux specific */ case F_GETLEASE: - len = 1; - break; + len = 1; + break; #endif #ifdef F_SETLEASE /* linux specific */ case F_SETLEASE: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif #ifdef F_NOTIFY /* linux specific */ case F_NOTIFY: - len = sizeof(fcntl_arg_t); - break; + len = sizeof(fcntl_arg_t); + break; #endif default: - len = 256; - break; + len = 256; + break; } return len; } #else /* HAVE_FCNTL */ static long -fcntl_narg_len(int cmd) +fcntl_narg_len(ioctl_req_t cmd) { return 0; } #endif /* HAVE_FCNTL */ +#define NARG_SENTINEL 17 + static long -setup_narg(ioctl_req_t cmd, VALUE *argp, int io_p) +setup_narg(ioctl_req_t cmd, VALUE *argp, long (*narg_len)(ioctl_req_t)) { long narg = 0; VALUE arg = *argp; - if (NIL_P(arg) || arg == Qfalse) { - narg = 0; + if (!RTEST(arg)) { + narg = 0; } else if (FIXNUM_P(arg)) { - narg = FIX2LONG(arg); + narg = FIX2LONG(arg); } else if (arg == Qtrue) { - narg = 1; + narg = 1; } else { - VALUE tmp = rb_check_string_type(arg); - - if (NIL_P(tmp)) { - narg = NUM2LONG(arg); - } - else { - char *ptr; - long len, slen; - - *argp = arg = tmp; - if (io_p) - len = ioctl_narg_len(cmd); - else - len = fcntl_narg_len((int)cmd); - rb_str_modify(arg); - - slen = RSTRING_LEN(arg); - /* expand for data + sentinel. */ - if (slen < len+1) { - rb_str_resize(arg, len+1); - MEMZERO(RSTRING_PTR(arg)+slen, char, len-slen); - slen = len+1; - } - /* a little sanity check here */ - ptr = RSTRING_PTR(arg); - ptr[slen - 1] = 17; - narg = (long)(SIGNED_VALUE)ptr; - } + VALUE tmp = rb_check_string_type(arg); + + if (NIL_P(tmp)) { + narg = NUM2LONG(arg); + } + else { + char *ptr; + long len, slen; + + *argp = arg = tmp; + len = narg_len(cmd); + rb_str_modify(arg); + + slen = RSTRING_LEN(arg); + /* expand for data + sentinel. */ + if (slen < len+1) { + rb_str_resize(arg, len+1); + MEMZERO(RSTRING_PTR(arg)+slen, char, len-slen); + slen = len+1; + } + /* a little sanity check here */ + ptr = RSTRING_PTR(arg); + ptr[slen - 1] = NARG_SENTINEL; + narg = (long)(SIGNED_VALUE)ptr; + } } return narg; } +static VALUE +finish_narg(int retval, VALUE arg, const rb_io_t *fptr) +{ + if (retval < 0) rb_sys_fail_path(fptr->pathv); + if (RB_TYPE_P(arg, T_STRING)) { + char *ptr; + long slen; + RSTRING_GETMEM(arg, ptr, slen); + if (ptr[slen-1] != NARG_SENTINEL) + rb_raise(rb_eArgError, "return value overflowed string"); + ptr[slen-1] = '\0'; + } + + return INT2NUM(retval); +} + #ifdef HAVE_IOCTL static VALUE rb_ioctl(VALUE io, VALUE req, VALUE arg) @@ -10160,32 +11360,28 @@ rb_ioctl(VALUE io, VALUE req, VALUE arg) long narg; int retval; - narg = setup_narg(cmd, &arg, 1); + narg = setup_narg(cmd, &arg, ioctl_narg_len); GetOpenFile(io, fptr); retval = do_ioctl(fptr->fd, cmd, narg); - if (retval < 0) rb_sys_fail_path(fptr->pathv); - if (RB_TYPE_P(arg, T_STRING)) { - char *ptr; - long slen; - RSTRING_GETMEM(arg, ptr, slen); - if (ptr[slen-1] != 17) - rb_raise(rb_eArgError, "return value overflowed string"); - ptr[slen-1] = '\0'; - } - - return INT2NUM(retval); + return finish_narg(retval, arg, fptr); } /* * call-seq: - * ios.ioctl(integer_cmd, arg) -> integer + * ioctl(integer_cmd, argument) -> integer + * + * Invokes Posix system call {ioctl(2)}[https://linux.die.net/man/2/ioctl], + * which issues a low-level command to an I/O device. + * + * Issues a low-level command to an I/O device. + * The arguments and returned value are platform-dependent. + * The effect of the call is platform-dependent. + * + * If argument +argument+ is an integer, it is passed directly; + * if it is a string, it is interpreted as a binary sequence of bytes. + * + * Not implemented on all platforms. * - * Provides a mechanism for issuing low-level commands to control or - * query I/O devices. Arguments and results are platform dependent. If - * <i>arg</i> is a number, its value is passed directly. If it is a - * string, it is interpreted as a binary sequence of bytes. On Unix - * platforms, see <code>ioctl(2)</code> for details. Not implemented on - * all platforms. */ static VALUE @@ -10214,7 +11410,7 @@ nogvl_fcntl(void *ptr) #if defined(F_DUPFD) if (arg->cmd == F_DUPFD) - return (VALUE)rb_cloexec_fcntl_dupfd(arg->fd, (int)arg->narg); + return (VALUE)rb_cloexec_fcntl_dupfd(arg->fd, (int)arg->narg); #endif return (VALUE)fcntl(arg->fd, arg->cmd, arg->narg); } @@ -10231,15 +11427,15 @@ do_fcntl(int fd, int cmd, long narg) retval = (int)rb_thread_io_blocking_region(nogvl_fcntl, &arg, fd); if (retval != -1) { - switch (cmd) { + switch (cmd) { #if defined(F_DUPFD) - case F_DUPFD: + case F_DUPFD: #endif #if defined(F_DUPFD_CLOEXEC) - case F_DUPFD_CLOEXEC: + case F_DUPFD_CLOEXEC: #endif - rb_update_max_fd(retval); - } + rb_update_max_fd(retval); + } } return retval; @@ -10253,33 +11449,27 @@ rb_fcntl(VALUE io, VALUE req, VALUE arg) long narg; int retval; - narg = setup_narg(cmd, &arg, 0); + narg = setup_narg(cmd, &arg, fcntl_narg_len); GetOpenFile(io, fptr); retval = do_fcntl(fptr->fd, cmd, narg); - if (retval < 0) rb_sys_fail_path(fptr->pathv); - if (RB_TYPE_P(arg, T_STRING)) { - char *ptr; - long slen; - RSTRING_GETMEM(arg, ptr, slen); - if (ptr[slen-1] != 17) - rb_raise(rb_eArgError, "return value overflowed string"); - ptr[slen-1] = '\0'; - } - - return INT2NUM(retval); + return finish_narg(retval, arg, fptr); } /* * call-seq: - * ios.fcntl(integer_cmd, arg) -> integer + * fcntl(integer_cmd, argument) -> integer + * + * Invokes Posix system call {fcntl(2)}[https://linux.die.net/man/2/fcntl], + * which provides a mechanism for issuing low-level commands to control or query + * a file-oriented I/O stream. Arguments and results are platform + * dependent. + * + * If +argument+ is a number, its value is passed directly; + * if it is a string, it is interpreted as a binary sequence of bytes. + * (Array#pack might be a useful way to build this string.) + * + * Not implemented on all platforms. * - * Provides a mechanism for issuing low-level commands to control or - * query file-oriented I/O streams. Arguments and results are platform - * dependent. If <i>arg</i> is a number, its value is passed - * directly. If it is a string, it is interpreted as a binary sequence - * of bytes (Array#pack might be a useful way to build this string). On - * Unix platforms, see <code>fcntl(2)</code> for details. Not - * implemented on all platforms. */ static VALUE @@ -10297,36 +11487,29 @@ rb_io_fcntl(int argc, VALUE *argv, VALUE io) #if defined(HAVE_SYSCALL) || defined(HAVE___SYSCALL) /* * call-seq: - * syscall(num [, args...]) -> integer - * - * Calls the operating system function identified by _num_ and - * returns the result of the function or raises SystemCallError if - * it failed. + * syscall(integer_callno, *arguments) -> integer * - * Arguments for the function can follow _num_. They must be either - * +String+ objects or +Integer+ objects. A +String+ object is passed - * as a pointer to the byte sequence. An +Integer+ object is passed - * as an integer whose bit size is the same as a pointer. - * Up to nine parameters may be passed. + * Invokes Posix system call {syscall(2)}[https://linux.die.net/man/2/syscall], + * which calls a specified function. * - * The function identified by _num_ is system - * dependent. On some Unix systems, the numbers may be obtained from a - * header file called <code>syscall.h</code>. - * - * syscall 4, 1, "hello\n", 6 # '4' is write(2) on our box - * - * <em>produces:</em> + * Calls the operating system function identified by +integer_callno+; + * returns the result of the function or raises SystemCallError if it failed. + * The effect of the call is platform-dependent. + * The arguments and returned value are platform-dependent. * - * hello + * For each of +arguments+: if it is an integer, it is passed directly; + * if it is a string, it is interpreted as a binary sequence of bytes. + * There may be as many as nine such arguments. * - * Calling +syscall+ on a platform which does not have any way to - * an arbitrary system function just fails with NotImplementedError. + * Arguments +integer_callno+ and +argument+, as well as the returned value, + * are platform-dependent. * - * *Note:* - * +syscall+ is essentially unsafe and unportable. - * Feel free to shoot your foot. + * Note: Method +syscall+ is essentially unsafe and unportable. * The DL (Fiddle) library is preferred for safer and a bit * more portable programming. + * + * Not implemented on all platforms. + * */ static VALUE @@ -10370,52 +11553,52 @@ rb_f_syscall(int argc, VALUE *argv, VALUE _) } if (argc == 0) - rb_raise(rb_eArgError, "too few arguments for syscall"); + rb_raise(rb_eArgError, "too few arguments for syscall"); if (argc > numberof(arg)) - rb_raise(rb_eArgError, "too many arguments for syscall"); + rb_raise(rb_eArgError, "too many arguments for syscall"); num = NUM2SYSCALLID(argv[0]); ++argv; for (i = argc - 1; i--; ) { - VALUE v = rb_check_string_type(argv[i]); + VALUE v = rb_check_string_type(argv[i]); - if (!NIL_P(v)) { - SafeStringValue(v); - rb_str_modify(v); - arg[i] = (VALUE)StringValueCStr(v); - } - else { - arg[i] = (VALUE)NUM2LONG(argv[i]); - } + if (!NIL_P(v)) { + StringValue(v); + rb_str_modify(v); + arg[i] = (VALUE)StringValueCStr(v); + } + else { + arg[i] = (VALUE)NUM2LONG(argv[i]); + } } switch (argc) { case 1: - retval = SYSCALL(num); - break; + retval = SYSCALL(num); + break; case 2: - retval = SYSCALL(num, arg[0]); - break; + retval = SYSCALL(num, arg[0]); + break; case 3: - retval = SYSCALL(num, arg[0],arg[1]); - break; + retval = SYSCALL(num, arg[0],arg[1]); + break; case 4: - retval = SYSCALL(num, arg[0],arg[1],arg[2]); - break; + retval = SYSCALL(num, arg[0],arg[1],arg[2]); + break; case 5: - retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3]); - break; + retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3]); + break; case 6: - retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4]); - break; + retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4]); + break; case 7: - retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5]); - break; + retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5]); + break; case 8: - retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6]); - break; + retval = SYSCALL(num, arg[0],arg[1],arg[2],arg[3],arg[4],arg[5],arg[6]); + break; } if (retval == -1) - rb_sys_fail(0); + rb_sys_fail(0); return RETVAL2NUM(retval); #undef SYSCALL #undef NUM2SYSCALLID @@ -10447,51 +11630,56 @@ io_encoding_set(rb_io_t *fptr, VALUE v1, VALUE v2, VALUE opt) VALUE ecopts, tmp; if (!NIL_P(v2)) { - enc2 = find_encoding(v1); - tmp = rb_check_string_type(v2); - if (!NIL_P(tmp)) { - if (RSTRING_LEN(tmp) == 1 && RSTRING_PTR(tmp)[0] == '-') { - /* Special case - "-" => no transcoding */ - enc = enc2; - enc2 = NULL; - } - else - enc = find_encoding(v2); - if (enc == enc2) { - /* Special case - "-" => no transcoding */ - enc2 = NULL; - } - } - else { - enc = find_encoding(v2); - if (enc == enc2) { - /* Special case - "-" => no transcoding */ - enc2 = NULL; - } - } - SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); - ecflags = rb_econv_prepare_options(opt, &ecopts, ecflags); + enc2 = find_encoding(v1); + tmp = rb_check_string_type(v2); + if (!NIL_P(tmp)) { + if (RSTRING_LEN(tmp) == 1 && RSTRING_PTR(tmp)[0] == '-') { + /* Special case - "-" => no transcoding */ + enc = enc2; + enc2 = NULL; + } + else + enc = find_encoding(v2); + if (enc == enc2) { + /* Special case - "-" => no transcoding */ + enc2 = NULL; + } + } + else { + enc = find_encoding(v2); + if (enc == enc2) { + /* Special case - "-" => no transcoding */ + enc2 = NULL; + } + } + if (enc2 == rb_ascii8bit_encoding()) { + /* If external is ASCII-8BIT, no transcoding */ + enc = enc2; + enc2 = NULL; + } + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); + ecflags = rb_econv_prepare_options(opt, &ecopts, ecflags); } else { - if (NIL_P(v1)) { - /* Set to default encodings */ - rb_io_ext_int_to_encs(NULL, NULL, &enc, &enc2, 0); - SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); + if (NIL_P(v1)) { + /* Set to default encodings */ + rb_io_ext_int_to_encs(NULL, NULL, &enc, &enc2, 0); + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); ecopts = Qnil; - } - else { - tmp = rb_check_string_type(v1); - if (!NIL_P(tmp) && rb_enc_asciicompat(enc = rb_enc_get(tmp))) { + } + else { + tmp = rb_check_string_type(v1); + if (!NIL_P(tmp) && rb_enc_asciicompat(enc = rb_enc_get(tmp))) { parse_mode_enc(RSTRING_PTR(tmp), enc, &enc, &enc2, NULL); - SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); ecflags = rb_econv_prepare_options(opt, &ecopts, ecflags); - } - else { - rb_io_ext_int_to_encs(find_encoding(v1), NULL, &enc, &enc2, 0); - SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); + } + else { + rb_io_ext_int_to_encs(find_encoding(v1), NULL, &enc, &enc2, 0); + SET_UNIVERSAL_NEWLINE_DECORATOR_IF_ENC2(enc2, ecflags); ecopts = Qnil; - } - } + } + } } validate_enc_binmode(&fptr->mode, ecflags, enc, enc2); fptr->encs.enc = enc; @@ -10526,62 +11714,81 @@ pipe_pair_close(VALUE rw) /* * call-seq: - * IO.pipe -> [read_io, write_io] - * IO.pipe(ext_enc) -> [read_io, write_io] - * IO.pipe("ext_enc:int_enc" [, opt]) -> [read_io, write_io] - * IO.pipe(ext_enc, int_enc [, opt]) -> [read_io, write_io] + * IO.pipe(**opts) -> [read_io, write_io] + * IO.pipe(enc, **opts) -> [read_io, write_io] + * IO.pipe(ext_enc, int_enc, **opts) -> [read_io, write_io] + * IO.pipe(**opts) {|read_io, write_io| ...} -> object + * IO.pipe(enc, **opts) {|read_io, write_io| ...} -> object + * IO.pipe(ext_enc, int_enc, **opts) {|read_io, write_io| ...} -> object * - * IO.pipe(...) {|read_io, write_io| ... } + * Creates a pair of pipe endpoints, +read_io+ and +write_io+, + * connected to each other. * - * Creates a pair of pipe endpoints (connected to each other) and - * returns them as a two-element array of IO objects: - * <code>[</code> <i>read_io</i>, <i>write_io</i> <code>]</code>. + * If argument +enc_string+ is given, it must be a string containing one of: * - * If a block is given, the block is called and - * returns the value of the block. - * <i>read_io</i> and <i>write_io</i> are sent to the block as arguments. - * If read_io and write_io are not closed when the block exits, they are closed. - * i.e. closing read_io and/or write_io doesn't cause an error. + * - The name of the encoding to be used as the external encoding. + * - The colon-separated names of two encodings to be used as the external + * and internal encodings. * - * Not available on all platforms. + * If argument +int_enc+ is given, it must be an Encoding object + * or encoding name string that specifies the internal encoding to be used; + * if argument +ext_enc+ is also given, it must be an Encoding object + * or encoding name string that specifies the external encoding to be used. * - * If an encoding (encoding name or encoding object) is specified as an optional argument, - * read string from pipe is tagged with the encoding specified. - * If the argument is a colon separated two encoding names "A:B", - * the read string is converted from encoding A (external encoding) - * to encoding B (internal encoding), then tagged with B. - * If two optional arguments are specified, those must be - * encoding objects or encoding names, - * and the first one is the external encoding, - * and the second one is the internal encoding. - * If the external encoding and the internal encoding is specified, - * optional hash argument specify the conversion option. + * The string read from +read_io+ is tagged with the external encoding; + * if an internal encoding is also specified, the string is converted + * to, and tagged with, that encoding. + * + * If any encoding is specified, + * optional hash arguments specify the conversion option. + * + * Optional keyword arguments +opts+ specify: + * + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding Options}[rdoc-ref:encodings.rdoc@Encoding+Options]. + * + * With no block given, returns the two endpoints in an array: + * + * IO.pipe # => [#<IO:fd 4>, #<IO:fd 5>] + * + * With a block given, calls the block with the two endpoints; + * closes both endpoints and returns the value of the block: + * + * IO.pipe {|read_io, write_io| p read_io; p write_io } + * + * Output: + * + * #<IO:fd 6> + * #<IO:fd 7> + * + * Not available on all platforms. * * In the example below, the two processes close the ends of the pipe * that they are not using. This is not just a cosmetic nicety. The * read end of a pipe will not generate an end of file condition if * there are any writers with the pipe still open. In the case of the - * parent process, the <code>rd.read</code> will never return if it - * does not first issue a <code>wr.close</code>. - * - * rd, wr = IO.pipe - * - * if fork - * wr.close - * puts "Parent got: <#{rd.read}>" - * rd.close - * Process.wait - * else - * rd.close - * puts "Sending message to parent" - * wr.write "Hi Dad" - * wr.close - * end + * parent process, the <tt>rd.read</tt> will never return if it + * does not first issue a <tt>wr.close</tt>: + * + * rd, wr = IO.pipe + * + * if fork + * wr.close + * puts "Parent got: <#{rd.read}>" + * rd.close + * Process.wait + * else + * rd.close + * puts 'Sending message to parent' + * wr.write "Hi Dad" + * wr.close + * end * * <em>produces:</em> * * Sending message to parent * Parent got: <Hi Dad> + * */ static VALUE @@ -10604,9 +11811,9 @@ rb_io_s_pipe(int argc, VALUE *argv, VALUE klass) args[2] = INT2FIX(O_RDONLY); r = rb_protect(io_new_instance, (VALUE)args, &state); if (state) { - close(pipes[0]); - close(pipes[1]); - rb_jump_tag(state); + close(pipes[0]); + close(pipes[1]); + rb_jump_tag(state); } GetOpenFile(r, fptr); @@ -10616,55 +11823,55 @@ rb_io_s_pipe(int argc, VALUE *argv, VALUE klass) ies_args.opt = opt; rb_protect(io_encoding_set_v, (VALUE)&ies_args, &state); if (state) { - close(pipes[1]); + close(pipes[1]); io_close(r); - rb_jump_tag(state); + rb_jump_tag(state); } args[1] = INT2NUM(pipes[1]); args[2] = INT2FIX(O_WRONLY); w = rb_protect(io_new_instance, (VALUE)args, &state); if (state) { - close(pipes[1]); - if (!NIL_P(r)) rb_io_close(r); - rb_jump_tag(state); + close(pipes[1]); + if (!NIL_P(r)) rb_io_close(r); + rb_jump_tag(state); } GetOpenFile(w, fptr2); rb_io_synchronized(fptr2); extract_binmode(opt, &fmode); - if ((fmode & FMODE_BINMODE) && v1 == Qnil) { + if ((fmode & FMODE_BINMODE) && NIL_P(v1)) { rb_io_ascii8bit_binmode(r); rb_io_ascii8bit_binmode(w); } #if DEFAULT_TEXTMODE if ((fptr->mode & FMODE_TEXTMODE) && (fmode & FMODE_BINMODE)) { - fptr->mode &= ~FMODE_TEXTMODE; - setmode(fptr->fd, O_BINARY); + fptr->mode &= ~FMODE_TEXTMODE; + setmode(fptr->fd, O_BINARY); } #if RUBY_CRLF_ENVIRONMENT if (fptr->encs.ecflags & ECONV_DEFAULT_NEWLINE_DECORATOR) { - fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; + fptr->encs.ecflags |= ECONV_UNIVERSAL_NEWLINE_DECORATOR; } #endif #endif fptr->mode |= fmode; #if DEFAULT_TEXTMODE if ((fptr2->mode & FMODE_TEXTMODE) && (fmode & FMODE_BINMODE)) { - fptr2->mode &= ~FMODE_TEXTMODE; - setmode(fptr2->fd, O_BINARY); + fptr2->mode &= ~FMODE_TEXTMODE; + setmode(fptr2->fd, O_BINARY); } #endif fptr2->mode |= fmode; ret = rb_assoc_new(r, w); if (rb_block_given_p()) { - VALUE rw[2]; - rw[0] = r; - rw[1] = w; - return rb_ensure(rb_yield, ret, pipe_pair_close, (VALUE)rw); + VALUE rw[2]; + rw[0] = r; + rw[1] = w; + return rb_ensure(rb_yield, ret, pipe_pair_close, (VALUE)rw); } return ret; } @@ -10688,15 +11895,15 @@ open_key_args(VALUE klass, int argc, VALUE *argv, VALUE opt, struct foreach_arg arg->argc = argc; arg->argv = argv; if (NIL_P(opt)) { - vmode = INT2NUM(O_RDONLY); - vperm = INT2FIX(0666); + vmode = INT2NUM(O_RDONLY); + vperm = INT2FIX(0666); } else if (!NIL_P(v = rb_hash_aref(opt, sym_open_args))) { - int n; + int n; - v = rb_to_array_type(v); - n = RARRAY_LENINT(v); - rb_check_arity(n, 0, 3); /* rb_io_open */ + v = rb_to_array_type(v); + n = RARRAY_LENINT(v); + rb_check_arity(n, 0, 3); /* rb_io_open */ rb_scan_args_kw(RB_SCAN_ARGS_LAST_HASH_KEYWORDS, n, RARRAY_CONST_PTR(v), "02:", &vmode, &vperm, &opt); } arg->io = rb_io_open(klass, path, vmode, vperm, opt); @@ -10708,9 +11915,11 @@ io_s_foreach(VALUE v) struct getline_arg *arg = (void *)v; VALUE str; + if (arg->limit == 0) + rb_raise(rb_eArgError, "invalid limit: 0 for foreach"); while (!NIL_P(str = rb_io_getline_1(arg->rs, arg->limit, arg->chomp, arg->io))) { - rb_lastline_set(str); - rb_yield(str); + rb_lastline_set(str); + rb_yield(str); } rb_lastline_set(Qnil); return Qnil; @@ -10718,38 +11927,80 @@ io_s_foreach(VALUE v) /* * call-seq: - * IO.foreach(name, sep=$/ [, getline_args, open_args]) {|line| block } -> nil - * IO.foreach(name, limit [, getline_args, open_args]) {|line| block } -> nil - * IO.foreach(name, sep, limit [, getline_args, open_args]) {|line| block } -> nil - * IO.foreach(...) -> an_enumerator - * File.foreach(name, sep=$/ [, getline_args, open_args]) {|line| block } -> nil - * File.foreach(name, limit [, getline_args, open_args]) {|line| block } -> nil - * File.foreach(name, sep, limit [, getline_args, open_args]) {|line| block } -> nil - * File.foreach(...) -> an_enumerator + * IO.foreach(path, sep = $/, **opts) {|line| block } -> nil + * IO.foreach(path, limit, **opts) {|line| block } -> nil + * IO.foreach(path, sep, limit, **opts) {|line| block } -> nil + * IO.foreach(...) -> an_enumerator * - * Executes the block for every line in the named I/O port, where lines - * are separated by <em>sep</em>. + * Calls the block with each successive line read from the stream. * - * If no block is given, an enumerator is returned instead. + * When called from class \IO (but not subclasses of \IO), + * this method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. * - * If +name+ starts with a pipe character (<code>"|"</code>) and the receiver - * is the IO class, a subprocess is created in the same way as Kernel#open, - * and its output is returned. - * Consider to use File.foreach to disable the behavior of subprocess invocation. + * The first argument must be a string that is the path to a file. * - * File.foreach("testfile") {|x| print "GOT ", x } - * IO.foreach("| cat testfile") {|x| print "GOT ", x } + * With only argument +path+ given, parses lines from the file at the given +path+, + * as determined by the default line separator, + * and calls the block with each successive line: * - * <em>produces:</em> + * File.foreach('t.txt') {|line| p line } * - * GOT This is line one - * GOT This is line two - * GOT This is line three - * GOT And so on... + * Output: the same as above. * - * If the last argument is a hash, it's the keyword argument to open. - * See IO.readlines for details about getline_args. - * And see also IO.read for details about open_args. + * For both forms, command and path, the remaining arguments are the same. + * + * With argument +sep+ given, parses lines as determined by that line separator + * (see {Line Separator}[rdoc-ref:IO@Line+Separator]): + * + * File.foreach('t.txt', 'li') {|line| p line } + * + * Output: + * + * "First li" + * "ne\nSecond li" + * "ne\n\nThird li" + * "ne\nFourth li" + * "ne\n" + * + * Each paragraph: + * + * File.foreach('t.txt', '') {|paragraph| p paragraph } + * + * Output: + * + * "First line\nSecond line\n\n" + * "Third line\nFourth line\n" + * + * With argument +limit+ given, parses lines as determined by the default + * line separator and the given line-length limit + * (see {Line Separator}[rdoc-ref:IO@Line+Separator] and {Line Limit}[rdoc-ref:IO@Line+Limit]): + * + * File.foreach('t.txt', 7) {|line| p line } + * + * Output: + * + * "First l" + * "ine\n" + * "Second " + * "line\n" + * "\n" + * "Third l" + * "ine\n" + * "Fourth l" + * "line\n" + * + * With arguments +sep+ and +limit+ given, + * combines the two behaviors + * (see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit]). + * + * Optional keyword arguments +opts+ specify: + * + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. + * - {Line Options}[rdoc-ref:IO@Line+IO]. + * + * Returns an Enumerator if no block is given. * */ @@ -10761,7 +12012,7 @@ rb_io_s_foreach(int argc, VALUE *argv, VALUE self) struct foreach_arg arg; struct getline_arg garg; - argc = rb_scan_args(argc, argv, "13:", NULL, NULL, NULL, NULL, &opt); + argc = rb_scan_args(argc, argv, "12:", NULL, NULL, NULL, &opt); RETURN_ENUMERATOR(self, orig_argc, argv); extract_getline_args(argc-1, argv+1, &garg); open_key_args(self, argc, argv, opt, &arg); @@ -10780,42 +12031,55 @@ io_s_readlines(VALUE v) /* * call-seq: - * IO.readlines(name, sep=$/ [, getline_args, open_args]) -> array - * IO.readlines(name, limit [, getline_args, open_args]) -> array - * IO.readlines(name, sep, limit [, getline_args, open_args]) -> array - * File.readlines(name, sep=$/ [, getline_args, open_args]) -> array - * File.readlines(name, limit [, getline_args, open_args]) -> array - * File.readlines(name, sep, limit [, getline_args, open_args]) -> array + * IO.readlines(path, sep = $/, **opts) -> array + * IO.readlines(path, limit, **opts) -> array + * IO.readlines(path, sep, limit, **opts) -> array + * + * Returns an array of all lines read from the stream. + * + * When called from class \IO (but not subclasses of \IO), + * this method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. + * + * The first argument must be a string that is the path to a file. * - * Reads the entire file specified by <i>name</i> as individual - * lines, and returns those lines in an array. Lines are separated by - * <i>sep</i>. + * With only argument +path+ given, parses lines from the file at the given +path+, + * as determined by the default line separator, + * and returns those lines in an array: * - * If +name+ starts with a pipe character (<code>"|"</code>) and the receiver - * is the IO class, a subprocess is created in the same way as Kernel#open, - * and its output is returned. - * Consider to use File.readlines to disable the behavior of subprocess invocation. + * IO.readlines('t.txt') + * # => ["First line\n", "Second line\n", "\n", "Third line\n", "Fourth line\n"] * - * a = File.readlines("testfile") - * a[0] #=> "This is line one\n" + * With argument +sep+ given, parses lines as determined by that line separator + * (see {Line Separator}[rdoc-ref:IO@Line+Separator]): * - * b = File.readlines("testfile", chomp: true) - * b[0] #=> "This is line one" + * # Ordinary separator. + * IO.readlines('t.txt', 'li') + * # =>["First li", "ne\nSecond li", "ne\n\nThird li", "ne\nFourth li", "ne\n"] + * # Get-paragraphs separator. + * IO.readlines('t.txt', '') + * # => ["First line\nSecond line\n\n", "Third line\nFourth line\n"] + * # Get-all separator. + * IO.readlines('t.txt', nil) + * # => ["First line\nSecond line\n\nThird line\nFourth line\n"] * - * IO.readlines("|ls -a") #=> [".\n", "..\n", ...] + * With argument +limit+ given, parses lines as determined by the default + * line separator and the given line-length limit + * (see {Line Separator}[rdoc-ref:IO@Line+Separator] and {Line Limit}[rdoc-ref:IO@Line+Limit]: * - * If the last argument is a hash, it's the keyword argument to open. + * IO.readlines('t.txt', 7) + * # => ["First l", "ine\n", "Second ", "line\n", "\n", "Third l", "ine\n", "Fourth ", "line\n"] * - * === Options for getline + * With arguments +sep+ and +limit+ given, + * combines the two behaviors + * (see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit]). * - * The options hash accepts the following keys: + * Optional keyword arguments +opts+ specify: * - * :chomp:: - * When the optional +chomp+ keyword argument has a true value, - * <code>\n</code>, <code>\r</code>, and <code>\r\n</code> - * will be removed from the end of each line. + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. + * - {Line Options}[rdoc-ref:IO@Line+IO]. * - * See also IO.read for details about +name+ and open_args. */ static VALUE @@ -10825,7 +12089,7 @@ rb_io_s_readlines(int argc, VALUE *argv, VALUE io) struct foreach_arg arg; struct getline_arg garg; - argc = rb_scan_args(argc, argv, "13:", NULL, NULL, NULL, NULL, &opt); + argc = rb_scan_args(argc, argv, "12:", NULL, NULL, NULL, &opt); extract_getline_args(argc-1, argv+1, &garg); open_key_args(io, argc, argv, opt, &arg); if (NIL_P(arg.io)) return Qnil; @@ -10857,96 +12121,86 @@ seek_before_access(VALUE argp) /* * call-seq: - * IO.read(name, [length [, offset]] [, opt]) -> string - * File.read(name, [length [, offset]] [, opt]) -> string + * IO.read(path, length = nil, offset = 0, **opts) -> string or nil * - * Opens the file, optionally seeks to the given +offset+, then returns - * +length+ bytes (defaulting to the rest of the file). #read ensures - * the file is closed before returning. + * Opens the stream, reads and returns some or all of its content, + * and closes the stream; returns +nil+ if no bytes were read. * - * If +name+ starts with a pipe character (<code>"|"</code>) and the receiver - * is the IO class, a subprocess is created in the same way as Kernel#open, - * and its output is returned. - * Consider to use File.read to disable the behavior of subprocess invocation. + * When called from class \IO (but not subclasses of \IO), + * this method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. * - * === Options + * The first argument must be a string that is the path to a file. * - * The options hash accepts the following keys: + * With only argument +path+ given, reads in text mode and returns the entire content + * of the file at the given path: * - * :encoding:: - * string or encoding + * IO.read('t.txt') + * # => "First line\nSecond line\n\nThird line\nFourth line\n" * - * Specifies the encoding of the read string. +:encoding+ will be ignored - * if +length+ is specified. See Encoding.aliases for possible encodings. + * On Windows, text mode can terminate reading and leave bytes in the file + * unread when encountering certain special bytes. Consider using + * IO.binread if all bytes in the file should be read. * - * :mode:: - * string or integer + * With argument +length+, returns +length+ bytes if available: * - * Specifies the <i>mode</i> argument for open(). It must start - * with an "r", otherwise it will cause an error. - * See IO.new for the list of possible modes. + * IO.read('t.txt', 7) # => "First l" + * IO.read('t.txt', 700) + * # => "First line\r\nSecond line\r\n\r\nFourth line\r\nFifth line\r\n" * - * :open_args:: - * array + * With arguments +length+ and +offset+, returns +length+ bytes + * if available, beginning at the given +offset+: * - * Specifies arguments for open() as an array. This key can not be used - * in combination with either +:encoding+ or +:mode+. + * IO.read('t.txt', 10, 2) # => "rst line\nS" + * IO.read('t.txt', 10, 200) # => nil * - * Examples: + * Optional keyword arguments +opts+ specify: + * + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. * - * File.read("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n" - * File.read("testfile", 20) #=> "This is line one\nThi" - * File.read("testfile", 20, 10) #=> "ne one\nThis is line " - * File.read("binfile", mode: "rb") #=> "\xF7\x00\x00\x0E\x12" - * IO.read("|ls -a") #=> ".\n..\n"... */ static VALUE rb_io_s_read(int argc, VALUE *argv, VALUE io) { VALUE opt, offset; + long off; struct foreach_arg arg; argc = rb_scan_args(argc, argv, "13:", NULL, NULL, &offset, NULL, &opt); + if (!NIL_P(offset) && (off = NUM2LONG(offset)) < 0) { + rb_raise(rb_eArgError, "negative offset %ld given", off); + } open_key_args(io, argc, argv, opt, &arg); if (NIL_P(arg.io)) return Qnil; if (!NIL_P(offset)) { - struct seek_arg sarg; - int state = 0; - sarg.io = arg.io; - sarg.offset = offset; - sarg.mode = SEEK_SET; - rb_protect(seek_before_access, (VALUE)&sarg, &state); - if (state) { - rb_io_close(arg.io); - rb_jump_tag(state); - } - if (arg.argc == 2) arg.argc = 1; + struct seek_arg sarg; + int state = 0; + sarg.io = arg.io; + sarg.offset = offset; + sarg.mode = SEEK_SET; + rb_protect(seek_before_access, (VALUE)&sarg, &state); + if (state) { + rb_io_close(arg.io); + rb_jump_tag(state); + } + if (arg.argc == 2) arg.argc = 1; } return rb_ensure(io_s_read, (VALUE)&arg, rb_io_close, arg.io); } /* * call-seq: - * IO.binread(name, [length [, offset]]) -> string - * File.binread(name, [length [, offset]]) -> string - * - * Opens the file, optionally seeks to the given <i>offset</i>, then - * returns <i>length</i> bytes (defaulting to the rest of the file). - * #binread ensures the file is closed before returning. The open mode - * would be <code>"rb:ASCII-8BIT"</code>. + * IO.binread(path, length = nil, offset = 0) -> string or nil * - * If +name+ starts with a pipe character (<code>"|"</code>) and the receiver - * is the IO class, a subprocess is created in the same way as Kernel#open, - * and its output is returned. - * Consider to use File.binread to disable the behavior of subprocess invocation. + * Behaves like IO.read, except that the stream is opened in binary mode + * with ASCII-8BIT encoding. * - * File.binread("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n" - * File.binread("testfile", 20) #=> "This is line one\nThi" - * File.binread("testfile", 20, 10) #=> "ne one\nThis is line " - * IO.binread("| cat testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n" + * When called from class \IO (but not subclasses of \IO), + * this method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. * - * See also IO.read for details about +name+ and open_args. */ static VALUE @@ -10955,13 +12209,13 @@ rb_io_s_binread(int argc, VALUE *argv, VALUE io) VALUE offset; struct foreach_arg arg; enum { - fmode = FMODE_READABLE|FMODE_BINMODE, - oflags = O_RDONLY + fmode = FMODE_READABLE|FMODE_BINMODE, + oflags = O_RDONLY #ifdef O_BINARY - |O_BINARY + |O_BINARY #endif }; - convconfig_t convconfig = {NULL, NULL, 0, Qnil}; + struct rb_io_encoding convconfig = {NULL, NULL, 0, Qnil}; rb_scan_args(argc, argv, "12", NULL, NULL, &offset); FilePathValue(argv[0]); @@ -10971,16 +12225,16 @@ rb_io_s_binread(int argc, VALUE *argv, VALUE io) arg.argv = argv+1; arg.argc = (argc > 1) ? 1 : 0; if (!NIL_P(offset)) { - struct seek_arg sarg; - int state = 0; - sarg.io = arg.io; - sarg.offset = offset; - sarg.mode = SEEK_SET; - rb_protect(seek_before_access, (VALUE)&sarg, &state); - if (state) { - rb_io_close(arg.io); - rb_jump_tag(state); - } + struct seek_arg sarg; + int state = 0; + sarg.io = arg.io; + sarg.offset = offset; + sarg.mode = SEEK_SET; + rb_protect(seek_before_access, (VALUE)&sarg, &state); + if (state) { + rb_io_close(arg.io); + rb_jump_tag(state); + } } return rb_ensure(io_s_read, (VALUE)&arg, rb_io_close, arg.io); } @@ -11042,56 +12296,46 @@ io_s_write(int argc, VALUE *argv, VALUE klass, int binary) /* * call-seq: - * IO.write(name, string [, offset]) -> integer - * IO.write(name, string [, offset] [, opt]) -> integer - * File.write(name, string [, offset]) -> integer - * File.write(name, string [, offset] [, opt]) -> integer + * IO.write(path, data, offset = 0, **opts) -> integer + * + * Opens the stream, writes the given +data+ to it, + * and closes the stream; returns the number of bytes written. * - * Opens the file, optionally seeks to the given <i>offset</i>, writes - * <i>string</i>, then returns the length written. #write ensures the - * file is closed before returning. If <i>offset</i> is not given in - * write mode, the file is truncated. Otherwise, it is not truncated. + * When called from class \IO (but not subclasses of \IO), + * this method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. * - * If +name+ starts with a pipe character (<code>"|"</code>) and the receiver - * is the IO class, a subprocess is created in the same way as Kernel#open, - * and its output is returned. - * Consider to use File.write to disable the behavior of subprocess invocation. + * The first argument must be a string that is the path to a file. * - * File.write("testfile", "0123456789", 20) #=> 10 - * # File could contain: "This is line one\nThi0123456789two\nThis is line three\nAnd so on...\n" - * File.write("testfile", "0123456789") #=> 10 - * # File would now read: "0123456789" - * IO.write("|tr a-z A-Z", "abc") #=> 3 - * # Prints "ABC" to the standard output + * With only argument +path+ given, writes the given +data+ to the file at that path: * - * If the last argument is a hash, it specifies options for the internal - * open(). It accepts the following keys: + * IO.write('t.tmp', 'abc') # => 3 + * File.read('t.tmp') # => "abc" * - * :encoding:: - * string or encoding + * If +offset+ is zero (the default), the file is overwritten: * - * Specifies the encoding of the read string. - * See Encoding.aliases for possible encodings. + * IO.write('t.tmp', 'A') # => 1 + * File.read('t.tmp') # => "A" * - * :mode:: - * string or integer + * If +offset+ in within the file content, the file is partly overwritten: * - * Specifies the <i>mode</i> argument for open(). It must start - * with "w", "a", or "r+", otherwise it will cause an error. - * See IO.new for the list of possible modes. + * IO.write('t.tmp', 'abcdef') # => 3 + * File.read('t.tmp') # => "abcdef" + * # Offset within content. + * IO.write('t.tmp', '012', 2) # => 3 + * File.read('t.tmp') # => "ab012f" * - * :perm:: - * integer + * If +offset+ is outside the file content, + * the file is padded with null characters <tt>"\u0000"</tt>: * - * Specifies the <i>perm</i> argument for open(). + * IO.write('t.tmp', 'xyz', 10) # => 3 + * File.read('t.tmp') # => "ab012f\u0000\u0000\u0000\u0000xyz" * - * :open_args:: - * array + * Optional keyword arguments +opts+ specify: * - * Specifies arguments for open() as an array. - * This key can not be used in combination with other keys. + * - {Open Options}[rdoc-ref:IO@Open+Options]. + * - {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. * - * See also IO.read for details about +name+ and open_args. */ static VALUE @@ -11102,20 +12346,15 @@ rb_io_s_write(int argc, VALUE *argv, VALUE io) /* * call-seq: - * IO.binwrite(name, string, [offset]) -> integer - * IO.binwrite(name, string, [offset], open_args) -> integer - * File.binwrite(name, string, [offset]) -> integer - * File.binwrite(name, string, [offset], open_args) -> integer + * IO.binwrite(path, string, offset = 0) -> integer * - * Same as IO.write except opening the file in binary mode and - * ASCII-8BIT encoding (<code>"wb:ASCII-8BIT"</code>). + * Behaves like IO.write, except that the stream is opened in binary mode + * with ASCII-8BIT encoding. * - * If +name+ starts with a pipe character (<code>"|"</code>) and the receiver - * is the IO class, a subprocess is created in the same way as Kernel#open, - * and its output is returned. - * Consider to use File.binwrite to disable the behavior of subprocess invocation. + * When called from class \IO (but not subclasses of \IO), + * this method has potential security vulnerabilities if called with untrusted input; + * see {Command Injection}[rdoc-ref:command_injection.rdoc]. * - * See also IO.read for details about +name+ and open_args. */ static VALUE @@ -11127,15 +12366,15 @@ rb_io_s_binwrite(int argc, VALUE *argv, VALUE io) struct copy_stream_struct { VALUE src; VALUE dst; - off_t copy_length; /* (off_t)-1 if not specified */ - off_t src_offset; /* (off_t)-1 if not specified */ + rb_off_t copy_length; /* (rb_off_t)-1 if not specified */ + rb_off_t src_offset; /* (rb_off_t)-1 if not specified */ - int src_fd; - int dst_fd; + rb_io_t *src_fptr; + rb_io_t *dst_fptr; unsigned close_src : 1; unsigned close_dst : 1; int error_no; - off_t total; + rb_off_t total; const char *syserr; const char *notimp; VALUE th; @@ -11167,32 +12406,32 @@ maygvl_copy_stream_continue_p(int has_gvl, struct copy_stream_struct *stp) #if defined(ERESTART) case ERESTART: #endif - if (rb_thread_interrupted(stp->th)) { + if (rb_thread_interrupted(stp->th)) { if (has_gvl) rb_thread_execute_interrupts(stp->th); else rb_thread_call_with_gvl(exec_interrupts, (void *)stp->th); } - return TRUE; + return TRUE; } return FALSE; } -struct wait_for_single_fd { +struct fiber_scheduler_wait_for_arguments { VALUE scheduler; - int fd; + rb_io_t *fptr; short events; VALUE result; }; static void * -rb_thread_fiber_scheduler_wait_for_single_fd(void * _args) +fiber_scheduler_wait_for(void * _arguments) { - struct wait_for_single_fd *args = (struct wait_for_single_fd *)_args; + struct fiber_scheduler_wait_for_arguments *arguments = (struct fiber_scheduler_wait_for_arguments *)_arguments; - args->result = rb_fiber_scheduler_io_wait(args->scheduler, io_from_fd(args->fd), INT2NUM(args->events), Qnil); + arguments->result = rb_fiber_scheduler_io_wait(arguments->scheduler, arguments->fptr->self, INT2NUM(arguments->events), RUBY_IO_TIMEOUT_DEFAULT); return NULL; } @@ -11202,34 +12441,50 @@ rb_thread_fiber_scheduler_wait_for_single_fd(void * _args) STATIC_ASSERT(pollin_expected, POLLIN == RB_WAITFD_IN); STATIC_ASSERT(pollout_expected, POLLOUT == RB_WAITFD_OUT); static int -nogvl_wait_for_single_fd(VALUE th, int fd, short events) +nogvl_wait_for(VALUE th, rb_io_t *fptr, short events, struct timeval *timeout) { VALUE scheduler = rb_fiber_scheduler_current_for_thread(th); if (scheduler != Qnil) { - struct wait_for_single_fd args = {.scheduler = scheduler, .fd = fd, .events = events}; - rb_thread_call_with_gvl(rb_thread_fiber_scheduler_wait_for_single_fd, &args); + struct fiber_scheduler_wait_for_arguments args = {.scheduler = scheduler, .fptr = fptr, .events = events}; + rb_thread_call_with_gvl(fiber_scheduler_wait_for, &args); return RTEST(args.result); } + int fd = fptr->fd; + if (fd == -1) return 0; + struct pollfd fds; fds.fd = fd; fds.events = events; - return poll(&fds, 1, -1); + int timeout_milliseconds = -1; + + if (timeout) { + timeout_milliseconds = (int)(timeout->tv_sec * 1000) + (int)(timeout->tv_usec / 1000); + } + + return poll(&fds, 1, timeout_milliseconds); } #else /* !USE_POLL */ # define IOWAIT_SYSCALL "select" static int -nogvl_wait_for_single_fd(VALUE th, int fd, short events) +nogvl_wait_for(VALUE th, rb_io_t *fptr, short events, struct timeval *timeout) { VALUE scheduler = rb_fiber_scheduler_current_for_thread(th); if (scheduler != Qnil) { - struct wait_for_single_fd args = {.scheduler = scheduler, .fd = fd, .events = events}; - rb_thread_call_with_gvl(rb_thread_fiber_scheduler_wait_for_single_fd, &args); + struct fiber_scheduler_wait_for_arguments args = {.scheduler = scheduler, .fptr = fptr, .events = events}; + rb_thread_call_with_gvl(fiber_scheduler_wait_for, &args); return RTEST(args.result); } + int fd = fptr->fd; + + if (fd == -1) { + errno = EBADF; + return -1; + } + rb_fdset_t fds; int ret; @@ -11238,16 +12493,18 @@ nogvl_wait_for_single_fd(VALUE th, int fd, short events) switch (events) { case RB_WAITFD_IN: - ret = rb_fd_select(fd + 1, &fds, 0, 0, 0); + ret = rb_fd_select(fd + 1, &fds, 0, 0, timeout); break; case RB_WAITFD_OUT: - ret = rb_fd_select(fd + 1, 0, &fds, 0, 0); + ret = rb_fd_select(fd + 1, 0, &fds, 0, timeout); break; default: - VM_UNREACHABLE(nogvl_wait_for_single_fd); + VM_UNREACHABLE(nogvl_wait_for); } rb_fd_term(&fds); + + // On timeout, this returns 0. return ret; } #endif /* !USE_POLL */ @@ -11262,7 +12519,7 @@ maygvl_copy_stream_wait_read(int has_gvl, struct copy_stream_struct *stp) ret = RB_NUM2INT(rb_io_wait(stp->src, RB_INT2NUM(RUBY_IO_READABLE), Qnil)); } else { - ret = nogvl_wait_for_single_fd(stp->th, stp->src_fd, RB_WAITFD_IN); + ret = nogvl_wait_for(stp->th, stp->src_fptr, RB_WAITFD_IN, NULL); } } while (ret < 0 && maygvl_copy_stream_continue_p(has_gvl, stp)); @@ -11280,7 +12537,7 @@ nogvl_copy_stream_wait_write(struct copy_stream_struct *stp) int ret; do { - ret = nogvl_wait_for_single_fd(stp->th, stp->dst_fd, RB_WAITFD_OUT); + ret = nogvl_wait_for(stp->th, stp->dst_fptr, RB_WAITFD_OUT, NULL); } while (ret < 0 && maygvl_copy_stream_continue_p(0, stp)); if (ret < 0) { @@ -11294,7 +12551,7 @@ nogvl_copy_stream_wait_write(struct copy_stream_struct *stp) #ifdef USE_COPY_FILE_RANGE static ssize_t -simple_copy_file_range(int in_fd, off_t *in_offset, int out_fd, off_t *out_offset, size_t count, unsigned int flags) +simple_copy_file_range(int in_fd, rb_off_t *in_offset, int out_fd, rb_off_t *out_offset, size_t count, unsigned int flags) { #ifdef HAVE_COPY_FILE_RANGE return copy_file_range(in_fd, in_offset, out_fd, out_offset, count, flags); @@ -11307,47 +12564,47 @@ static int nogvl_copy_file_range(struct copy_stream_struct *stp) { ssize_t ss; - off_t src_size; - off_t copy_length, src_offset, *src_offset_ptr; + rb_off_t src_size; + rb_off_t copy_length, src_offset, *src_offset_ptr; if (!S_ISREG(stp->src_stat.st_mode)) return 0; src_size = stp->src_stat.st_size; src_offset = stp->src_offset; - if (src_offset >= (off_t)0) { - src_offset_ptr = &src_offset; + if (src_offset >= (rb_off_t)0) { + src_offset_ptr = &src_offset; } else { - src_offset_ptr = NULL; /* if src_offset_ptr is NULL, then bytes are read from in_fd starting from the file offset */ + src_offset_ptr = NULL; /* if src_offset_ptr is NULL, then bytes are read from in_fd starting from the file offset */ } copy_length = stp->copy_length; - if (copy_length < (off_t)0) { - if (src_offset < (off_t)0) { - off_t current_offset; + if (copy_length < (rb_off_t)0) { + if (src_offset < (rb_off_t)0) { + rb_off_t current_offset; errno = 0; - current_offset = lseek(stp->src_fd, 0, SEEK_CUR); - if (current_offset < (off_t)0 && errno) { + current_offset = lseek(stp->src_fptr->fd, 0, SEEK_CUR); + if (current_offset < (rb_off_t)0 && errno) { stp->syserr = "lseek"; stp->error_no = errno; return (int)current_offset; } copy_length = src_size - current_offset; - } - else { + } + else { copy_length = src_size - src_offset; - } + } } retry_copy_file_range: # if SIZEOF_OFF_T > SIZEOF_SIZE_T /* we are limited by the 32-bit ssize_t return value on 32-bit */ - ss = (copy_length > (off_t)SSIZE_MAX) ? SSIZE_MAX : (ssize_t)copy_length; + ss = (copy_length > (rb_off_t)SSIZE_MAX) ? SSIZE_MAX : (ssize_t)copy_length; # else ss = (ssize_t)copy_length; # endif - ss = simple_copy_file_range(stp->src_fd, src_offset_ptr, stp->dst_fd, NULL, ss, 0); + ss = simple_copy_file_range(stp->src_fptr->fd, src_offset_ptr, stp->dst_fptr->fd, NULL, ss, 0); if (0 < ss) { stp->total += ss; copy_length -= ss; @@ -11356,39 +12613,39 @@ nogvl_copy_file_range(struct copy_stream_struct *stp) } } if (ss < 0) { - if (maygvl_copy_stream_continue_p(0, stp)) { + if (maygvl_copy_stream_continue_p(0, stp)) { goto retry_copy_file_range; - } + } switch (errno) { - case EINVAL: - case EPERM: /* copy_file_range(2) doesn't exist (may happen in - docker container) */ + case EINVAL: + case EPERM: /* copy_file_range(2) doesn't exist (may happen in + docker container) */ #ifdef ENOSYS - case ENOSYS: + case ENOSYS: #endif #ifdef EXDEV - case EXDEV: /* in_fd and out_fd are not on the same filesystem */ + case EXDEV: /* in_fd and out_fd are not on the same filesystem */ #endif return 0; - case EAGAIN: -#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN - case EWOULDBLOCK: + case EAGAIN: +#if EWOULDBLOCK != EAGAIN + case EWOULDBLOCK: #endif { int ret = nogvl_copy_stream_wait_write(stp); if (ret < 0) return ret; } goto retry_copy_file_range; - case EBADF: - { - int e = errno; - int flags = fcntl(stp->dst_fd, F_GETFL); + case EBADF: + { + int e = errno; + int flags = fcntl(stp->dst_fptr->fd, F_GETFL); - if (flags != -1 && flags & O_APPEND) { - return 0; - } - errno = e; - } + if (flags != -1 && flags & O_APPEND) { + return 0; + } + errno = e; + } } stp->syserr = "copy_file_range"; stp->error_no = errno; @@ -11402,11 +12659,11 @@ nogvl_copy_file_range(struct copy_stream_struct *stp) static int nogvl_fcopyfile(struct copy_stream_struct *stp) { - off_t cur, ss = 0; - const off_t src_offset = stp->src_offset; + rb_off_t cur, ss = 0; + const rb_off_t src_offset = stp->src_offset; int ret; - if (stp->copy_length >= (off_t)0) { + if (stp->copy_length >= (rb_off_t)0) { /* copy_length can't be specified in fcopyfile(3) */ return 0; } @@ -11416,40 +12673,47 @@ nogvl_fcopyfile(struct copy_stream_struct *stp) if (!S_ISREG(stp->dst_stat.st_mode)) return 0; - if (lseek(stp->dst_fd, 0, SEEK_CUR) > (off_t)0) /* if dst IO was already written */ + if (lseek(stp->dst_fptr->fd, 0, SEEK_CUR) > (rb_off_t)0) /* if dst IO was already written */ return 0; + if (fcntl(stp->dst_fptr->fd, F_GETFL) & O_APPEND) { + /* fcopyfile(3) appends src IO to dst IO and then truncates + * dst IO to src IO's original size. */ + rb_off_t end = lseek(stp->dst_fptr->fd, 0, SEEK_END); + lseek(stp->dst_fptr->fd, 0, SEEK_SET); + if (end > (rb_off_t)0) return 0; + } - if (src_offset > (off_t)0) { - off_t r; + if (src_offset > (rb_off_t)0) { + rb_off_t r; /* get current offset */ errno = 0; - cur = lseek(stp->src_fd, 0, SEEK_CUR); - if (cur < (off_t)0 && errno) { + cur = lseek(stp->src_fptr->fd, 0, SEEK_CUR); + if (cur < (rb_off_t)0 && errno) { stp->error_no = errno; return 1; } errno = 0; - r = lseek(stp->src_fd, src_offset, SEEK_SET); - if (r < (off_t)0 && errno) { + r = lseek(stp->src_fptr->fd, src_offset, SEEK_SET); + if (r < (rb_off_t)0 && errno) { stp->error_no = errno; return 1; } } stp->copyfile_state = copyfile_state_alloc(); /* this will be freed by copy_stream_finalize() */ - ret = fcopyfile(stp->src_fd, stp->dst_fd, stp->copyfile_state, COPYFILE_DATA); + ret = fcopyfile(stp->src_fptr->fd, stp->dst_fptr->fd, stp->copyfile_state, COPYFILE_DATA); copyfile_state_get(stp->copyfile_state, COPYFILE_STATE_COPIED, &ss); /* get copied bytes */ if (ret == 0) { /* success */ stp->total = ss; - if (src_offset > (off_t)0) { - off_t r; + if (src_offset > (rb_off_t)0) { + rb_off_t r; errno = 0; /* reset offset */ - r = lseek(stp->src_fd, cur, SEEK_SET); - if (r < (off_t)0 && errno) { + r = lseek(stp->src_fptr->fd, cur, SEEK_SET); + if (r < (rb_off_t)0 && errno) { stp->error_no = errno; return 1; } @@ -11480,7 +12744,7 @@ nogvl_fcopyfile(struct copy_stream_struct *stp) # endif static ssize_t -simple_sendfile(int out_fd, int in_fd, off_t *offset, off_t count) +simple_sendfile(int out_fd, int in_fd, rb_off_t *offset, rb_off_t count) { return sendfile(out_fd, in_fd, offset, (size_t)count); } @@ -11492,11 +12756,11 @@ simple_sendfile(int out_fd, int in_fd, off_t *offset, off_t count) # define USE_SENDFILE static ssize_t -simple_sendfile(int out_fd, int in_fd, off_t *offset, off_t count) +simple_sendfile(int out_fd, int in_fd, rb_off_t *offset, rb_off_t count) { int r; - off_t pos = offset ? *offset : lseek(in_fd, 0, SEEK_CUR); - off_t sbytes; + rb_off_t pos = offset ? *offset : lseek(in_fd, 0, SEEK_CUR); + rb_off_t sbytes; # ifdef __APPLE__ r = sendfile(in_fd, out_fd, pos, &count, NULL, 0); sbytes = count; @@ -11505,10 +12769,10 @@ simple_sendfile(int out_fd, int in_fd, off_t *offset, off_t count) # endif if (r != 0 && sbytes == 0) return r; if (offset) { - *offset += sbytes; + *offset += sbytes; } else { - lseek(in_fd, sbytes, SEEK_CUR); + lseek(in_fd, sbytes, SEEK_CUR); } return (ssize_t)sbytes; } @@ -11522,9 +12786,9 @@ static int nogvl_copy_stream_sendfile(struct copy_stream_struct *stp) { ssize_t ss; - off_t src_size; - off_t copy_length; - off_t src_offset; + rb_off_t src_size; + rb_off_t copy_length; + rb_off_t src_offset; int use_pread; if (!S_ISREG(stp->src_stat.st_mode)) @@ -11533,21 +12797,21 @@ nogvl_copy_stream_sendfile(struct copy_stream_struct *stp) src_size = stp->src_stat.st_size; #ifndef __linux__ if ((stp->dst_stat.st_mode & S_IFMT) != S_IFSOCK) - return 0; + return 0; #endif src_offset = stp->src_offset; - use_pread = src_offset >= (off_t)0; + use_pread = src_offset >= (rb_off_t)0; copy_length = stp->copy_length; - if (copy_length < (off_t)0) { + if (copy_length < (rb_off_t)0) { if (use_pread) copy_length = src_size - src_offset; else { - off_t cur; + rb_off_t cur; errno = 0; - cur = lseek(stp->src_fd, 0, SEEK_CUR); - if (cur < (off_t)0 && errno) { + cur = lseek(stp->src_fptr->fd, 0, SEEK_CUR); + if (cur < (rb_off_t)0 && errno) { stp->syserr = "lseek"; stp->error_no = errno; return (int)cur; @@ -11559,15 +12823,15 @@ nogvl_copy_stream_sendfile(struct copy_stream_struct *stp) retry_sendfile: # if SIZEOF_OFF_T > SIZEOF_SIZE_T /* we are limited by the 32-bit ssize_t return value on 32-bit */ - ss = (copy_length > (off_t)SSIZE_MAX) ? SSIZE_MAX : (ssize_t)copy_length; + ss = (copy_length > (rb_off_t)SSIZE_MAX) ? SSIZE_MAX : (ssize_t)copy_length; # else ss = (ssize_t)copy_length; # endif if (use_pread) { - ss = simple_sendfile(stp->dst_fd, stp->src_fd, &src_offset, ss); + ss = simple_sendfile(stp->dst_fptr->fd, stp->src_fptr->fd, &src_offset, ss); } else { - ss = simple_sendfile(stp->dst_fd, stp->src_fd, NULL, ss); + ss = simple_sendfile(stp->dst_fptr->fd, stp->src_fptr->fd, NULL, ss); } if (0 < ss) { stp->total += ss; @@ -11577,28 +12841,28 @@ nogvl_copy_stream_sendfile(struct copy_stream_struct *stp) } } if (ss < 0) { - if (maygvl_copy_stream_continue_p(0, stp)) - goto retry_sendfile; + if (maygvl_copy_stream_continue_p(0, stp)) + goto retry_sendfile; switch (errno) { - case EINVAL: + case EINVAL: #ifdef ENOSYS - case ENOSYS: + case ENOSYS: #endif #ifdef EOPNOTSUP - /* some RedHat kernels may return EOPNOTSUP on an NFS mount. - see also: [Feature #16965] */ - case EOPNOTSUP: + /* some RedHat kernels may return EOPNOTSUP on an NFS mount. + see also: [Feature #16965] */ + case EOPNOTSUP: #endif return 0; - case EAGAIN: -#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN - case EWOULDBLOCK: + case EAGAIN: +#if EWOULDBLOCK != EAGAIN + case EWOULDBLOCK: #endif { int ret; #ifndef __linux__ /* - * Linux requires stp->src_fd to be a mmap-able (regular) file, + * Linux requires stp->src_fptr->fd to be a mmap-able (regular) file, * select() reports regular files to always be "ready", so * there is no need to select() on it. * Other OSes may have the same limitation for sendfile() which @@ -11621,40 +12885,35 @@ nogvl_copy_stream_sendfile(struct copy_stream_struct *stp) #endif static ssize_t -maygvl_read(int has_gvl, int fd, void *buf, size_t count) +maygvl_read(int has_gvl, rb_io_t *fptr, void *buf, size_t count) { if (has_gvl) - return rb_read_internal(fd, buf, count); + return rb_io_read_memory(fptr, buf, count); else - return read(fd, buf, count); + return read(fptr->fd, buf, count); } static ssize_t -maygvl_copy_stream_read(int has_gvl, struct copy_stream_struct *stp, char *buf, size_t len, off_t offset) +maygvl_copy_stream_read(int has_gvl, struct copy_stream_struct *stp, char *buf, size_t len, rb_off_t offset) { ssize_t ss; retry_read: - if (offset < (off_t)0) { - ss = maygvl_read(has_gvl, stp->src_fd, buf, len); + if (offset < (rb_off_t)0) { + ss = maygvl_read(has_gvl, stp->src_fptr, buf, len); } else { -#ifdef HAVE_PREAD - ss = pread(stp->src_fd, buf, len, offset); -#else - stp->notimp = "pread"; - return -1; -#endif + ss = pread(stp->src_fptr->fd, buf, len, offset); } if (ss == 0) { return 0; } if (ss < 0) { - if (maygvl_copy_stream_continue_p(has_gvl, stp)) - goto retry_read; + if (maygvl_copy_stream_continue_p(has_gvl, stp)) + goto retry_read; switch (errno) { - case EAGAIN: -#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN - case EWOULDBLOCK: + case EAGAIN: +#if EWOULDBLOCK != EAGAIN + case EWOULDBLOCK: #endif { int ret = maygvl_copy_stream_wait_read(has_gvl, stp); @@ -11662,12 +12921,12 @@ maygvl_copy_stream_read(int has_gvl, struct copy_stream_struct *stp, char *buf, } goto retry_read; #ifdef ENOSYS - case ENOSYS: + case ENOSYS: stp->notimp = "pread"; return ss; #endif } - stp->syserr = offset < (off_t)0 ? "read" : "pread"; + stp->syserr = offset < (rb_off_t)0 ? "read" : "pread"; stp->error_no = errno; } return ss; @@ -11679,11 +12938,11 @@ nogvl_copy_stream_write(struct copy_stream_struct *stp, char *buf, size_t len) ssize_t ss; int off = 0; while (len) { - ss = write(stp->dst_fd, buf+off, len); + ss = write(stp->dst_fptr->fd, buf+off, len); if (ss < 0) { if (maygvl_copy_stream_continue_p(0, stp)) continue; - if (errno == EAGAIN || errno == EWOULDBLOCK) { + if (io_again_p(errno)) { int ret = nogvl_copy_stream_wait_write(stp); if (ret < 0) return ret; continue; @@ -11706,31 +12965,31 @@ nogvl_copy_stream_read_write(struct copy_stream_struct *stp) size_t len; ssize_t ss; int ret; - off_t copy_length; + rb_off_t copy_length; + rb_off_t src_offset; int use_eof; - off_t src_offset; int use_pread; copy_length = stp->copy_length; - use_eof = copy_length < (off_t)0; + use_eof = copy_length < (rb_off_t)0; src_offset = stp->src_offset; - use_pread = src_offset >= (off_t)0; + use_pread = src_offset >= (rb_off_t)0; if (use_pread && stp->close_src) { - off_t r; - errno = 0; - r = lseek(stp->src_fd, src_offset, SEEK_SET); - if (r < (off_t)0 && errno) { + rb_off_t r; + errno = 0; + r = lseek(stp->src_fptr->fd, src_offset, SEEK_SET); + if (r < (rb_off_t)0 && errno) { stp->syserr = "lseek"; stp->error_no = errno; return; } - src_offset = (off_t)-1; + src_offset = (rb_off_t)-1; use_pread = 0; } while (use_eof || 0 < copy_length) { - if (!use_eof && copy_length < (off_t)sizeof(buf)) { + if (!use_eof && copy_length < (rb_off_t)sizeof(buf)) { len = (size_t)copy_length; } else { @@ -11742,7 +13001,7 @@ nogvl_copy_stream_read_write(struct copy_stream_struct *stp) src_offset += ss; } else { - ss = maygvl_copy_stream_read(0, stp, buf, len, (off_t)-1); + ss = maygvl_copy_stream_read(0, stp, buf, len, (rb_off_t)-1); } if (ss <= 0) /* EOF or error */ return; @@ -11767,7 +13026,7 @@ nogvl_copy_stream_func(void *arg) #ifdef USE_COPY_FILE_RANGE ret = nogvl_copy_file_range(stp); if (ret != 0) - goto finish; /* error or success */ + goto finish; /* error or success */ #endif #ifdef HAVE_FCOPYFILE @@ -11797,30 +13056,30 @@ copy_stream_fallback_body(VALUE arg) const int buflen = 16*1024; VALUE n; VALUE buf = rb_str_buf_new(buflen); - off_t rest = stp->copy_length; - off_t off = stp->src_offset; + rb_off_t rest = stp->copy_length; + rb_off_t off = stp->src_offset; ID read_method = id_readpartial; - if (stp->src_fd < 0) { - if (!rb_respond_to(stp->src, read_method)) { - read_method = id_read; - } + if (!stp->src_fptr) { + if (!rb_respond_to(stp->src, read_method)) { + read_method = id_read; + } } while (1) { long numwrote; long l; - if (stp->copy_length < (off_t)0) { + if (stp->copy_length < (rb_off_t)0) { l = buflen; } else { - if (rest == 0) { - rb_str_resize(buf, 0); - break; - } + if (rest == 0) { + rb_str_resize(buf, 0); + break; + } l = buflen < rest ? buflen : (long)rest; } - if (stp->src_fd < 0) { + if (!stp->src_fptr) { VALUE rc = rb_funcall(stp->src, read_method, 2, INT2FIX(l), buf); if (read_method == id_read && NIL_P(rc)) @@ -11835,16 +13094,16 @@ copy_stream_fallback_body(VALUE arg) return Qnil; if (ss == 0) rb_eof_error(); - if (off >= (off_t)0) + if (off >= (rb_off_t)0) off += ss; } n = rb_io_write(stp->dst, buf); numwrote = NUM2LONG(n); stp->total += numwrote; rest -= numwrote; - if (read_method == id_read && RSTRING_LEN(buf) == 0) { - break; - } + if (read_method == id_read && RSTRING_LEN(buf) == 0) { + break; + } } return Qnil; @@ -11853,8 +13112,8 @@ copy_stream_fallback_body(VALUE arg) static VALUE copy_stream_fallback(struct copy_stream_struct *stp) { - if (stp->src_fd < 0 && stp->src_offset >= (off_t)0) { - rb_raise(rb_eArgError, "cannot specify src_offset for non-IO"); + if (!stp->src_fptr && stp->src_offset >= (rb_off_t)0) { + rb_raise(rb_eArgError, "cannot specify src_offset for non-IO"); } rb_rescue2(copy_stream_fallback_body, (VALUE)stp, (VALUE (*) (VALUE, VALUE))0, (VALUE)0, @@ -11867,131 +13126,125 @@ copy_stream_body(VALUE arg) { struct copy_stream_struct *stp = (struct copy_stream_struct *)arg; VALUE src_io = stp->src, dst_io = stp->dst; - rb_io_t *src_fptr = 0, *dst_fptr = 0; - int src_fd, dst_fd; const int common_oflags = 0 #ifdef O_NOCTTY - | O_NOCTTY + | O_NOCTTY #endif - ; + ; stp->th = rb_thread_current(); stp->total = 0; if (src_io == argf || - !(RB_TYPE_P(src_io, T_FILE) || - RB_TYPE_P(src_io, T_STRING) || - rb_respond_to(src_io, rb_intern("to_path")))) { - src_fd = -1; + !(RB_TYPE_P(src_io, T_FILE) || + RB_TYPE_P(src_io, T_STRING) || + rb_respond_to(src_io, rb_intern("to_path")))) { + stp->src_fptr = NULL; } else { int stat_ret; - VALUE tmp_io = rb_io_check_io(src_io); - if (!NIL_P(tmp_io)) { - src_io = tmp_io; - } - else if (!RB_TYPE_P(src_io, T_FILE)) { - VALUE args[2]; - FilePathValue(src_io); - args[0] = src_io; - args[1] = INT2NUM(O_RDONLY|common_oflags); - src_io = rb_class_new_instance(2, args, rb_cFile); - stp->src = src_io; - stp->close_src = 1; - } - GetOpenFile(src_io, src_fptr); - rb_io_check_byte_readable(src_fptr); - src_fd = src_fptr->fd; - - stat_ret = fstat(src_fd, &stp->src_stat); + VALUE tmp_io = rb_io_check_io(src_io); + if (!NIL_P(tmp_io)) { + src_io = tmp_io; + } + else if (!RB_TYPE_P(src_io, T_FILE)) { + VALUE args[2]; + FilePathValue(src_io); + args[0] = src_io; + args[1] = INT2NUM(O_RDONLY|common_oflags); + src_io = rb_class_new_instance(2, args, rb_cFile); + stp->src = src_io; + stp->close_src = 1; + } + RB_IO_POINTER(src_io, stp->src_fptr); + rb_io_check_byte_readable(stp->src_fptr); + + stat_ret = fstat(stp->src_fptr->fd, &stp->src_stat); if (stat_ret < 0) { stp->syserr = "fstat"; stp->error_no = errno; return Qnil; } } - stp->src_fd = src_fd; if (dst_io == argf || - !(RB_TYPE_P(dst_io, T_FILE) || - RB_TYPE_P(dst_io, T_STRING) || - rb_respond_to(dst_io, rb_intern("to_path")))) { - dst_fd = -1; + !(RB_TYPE_P(dst_io, T_FILE) || + RB_TYPE_P(dst_io, T_STRING) || + rb_respond_to(dst_io, rb_intern("to_path")))) { + stp->dst_fptr = NULL; } else { int stat_ret; VALUE tmp_io = rb_io_check_io(dst_io); - if (!NIL_P(tmp_io)) { - dst_io = GetWriteIO(tmp_io); - } - else if (!RB_TYPE_P(dst_io, T_FILE)) { - VALUE args[3]; - FilePathValue(dst_io); - args[0] = dst_io; - args[1] = INT2NUM(O_WRONLY|O_CREAT|O_TRUNC|common_oflags); - args[2] = INT2FIX(0666); - dst_io = rb_class_new_instance(3, args, rb_cFile); - stp->dst = dst_io; - stp->close_dst = 1; - } - else { - dst_io = GetWriteIO(dst_io); - stp->dst = dst_io; - } - GetOpenFile(dst_io, dst_fptr); - rb_io_check_writable(dst_fptr); - dst_fd = dst_fptr->fd; - - stat_ret = fstat(dst_fd, &stp->dst_stat); + if (!NIL_P(tmp_io)) { + dst_io = GetWriteIO(tmp_io); + } + else if (!RB_TYPE_P(dst_io, T_FILE)) { + VALUE args[3]; + FilePathValue(dst_io); + args[0] = dst_io; + args[1] = INT2NUM(O_WRONLY|O_CREAT|O_TRUNC|common_oflags); + args[2] = INT2FIX(0666); + dst_io = rb_class_new_instance(3, args, rb_cFile); + stp->dst = dst_io; + stp->close_dst = 1; + } + else { + dst_io = GetWriteIO(dst_io); + stp->dst = dst_io; + } + RB_IO_POINTER(dst_io, stp->dst_fptr); + rb_io_check_writable(stp->dst_fptr); + + stat_ret = fstat(stp->dst_fptr->fd, &stp->dst_stat); if (stat_ret < 0) { stp->syserr = "fstat"; stp->error_no = errno; return Qnil; } } - stp->dst_fd = dst_fd; #ifdef O_BINARY - if (src_fptr) - SET_BINARY_MODE_WITH_SEEK_CUR(src_fptr); + if (stp->src_fptr) + SET_BINARY_MODE_WITH_SEEK_CUR(stp->src_fptr); #endif - if (dst_fptr) - io_ascii8bit_binmode(dst_fptr); + if (stp->dst_fptr) + io_ascii8bit_binmode(stp->dst_fptr); - if (stp->src_offset < (off_t)0 && src_fptr && src_fptr->rbuf.len) { - size_t len = src_fptr->rbuf.len; + if (stp->src_offset < (rb_off_t)0 && stp->src_fptr && stp->src_fptr->rbuf.len) { + size_t len = stp->src_fptr->rbuf.len; VALUE str; - if (stp->copy_length >= (off_t)0 && stp->copy_length < (off_t)len) { + if (stp->copy_length >= (rb_off_t)0 && stp->copy_length < (rb_off_t)len) { len = (size_t)stp->copy_length; } str = rb_str_buf_new(len); rb_str_resize(str,len); - read_buffered_data(RSTRING_PTR(str), len, src_fptr); - if (dst_fptr) { /* IO or filename */ - if (io_binwrite(str, RSTRING_PTR(str), RSTRING_LEN(str), dst_fptr, 0) < 0) - rb_sys_fail_on_write(dst_fptr); + read_buffered_data(RSTRING_PTR(str), len, stp->src_fptr); + if (stp->dst_fptr) { /* IO or filename */ + if (io_binwrite(RSTRING_PTR(str), RSTRING_LEN(str), stp->dst_fptr, 0) < 0) + rb_sys_fail_on_write(stp->dst_fptr); } else /* others such as StringIO */ - rb_io_write(dst_io, str); + rb_io_write(dst_io, str); rb_str_resize(str, 0); stp->total += len; - if (stp->copy_length >= (off_t)0) + if (stp->copy_length >= (rb_off_t)0) stp->copy_length -= len; } - if (dst_fptr && io_fflush(dst_fptr) < 0) { - rb_raise(rb_eIOError, "flush failed"); + if (stp->dst_fptr && io_fflush(stp->dst_fptr) < 0) { + rb_raise(rb_eIOError, "flush failed"); } if (stp->copy_length == 0) return Qnil; - if (src_fd < 0 || dst_fd < 0) { + if (stp->src_fptr == NULL || stp->dst_fptr == NULL) { return copy_stream_fallback(stp); } - rb_thread_call_without_gvl(nogvl_copy_stream_func, (void*)stp, RUBY_UBF_IO, 0); + IO_WITHOUT_GVL(nogvl_copy_stream_func, stp); return Qnil; } @@ -12016,41 +13269,60 @@ copy_stream_finalize(VALUE arg) rb_syserr_fail(stp->error_no, stp->syserr); } if (stp->notimp) { - rb_raise(rb_eNotImpError, "%s() not implemented", stp->notimp); + rb_raise(rb_eNotImpError, "%s() not implemented", stp->notimp); } return Qnil; } /* * call-seq: - * IO.copy_stream(src, dst) - * IO.copy_stream(src, dst, copy_length) - * IO.copy_stream(src, dst, copy_length, src_offset) + * IO.copy_stream(src, dst, src_length = nil, src_offset = 0) -> integer + * + * Copies from the given +src+ to the given +dst+, + * returning the number of bytes copied. + * + * - The given +src+ must be one of the following: * - * IO.copy_stream copies <i>src</i> to <i>dst</i>. - * <i>src</i> and <i>dst</i> is either a filename or an IO-like object. - * IO-like object for <i>src</i> should have #readpartial or #read - * method. IO-like object for <i>dst</i> should have #write method. - * (Specialized mechanisms, such as sendfile system call, may be used - * on appropriate situation.) + * - The path to a readable file, from which source data is to be read. + * - An \IO-like object, opened for reading and capable of responding + * to method +:readpartial+ or method +:read+. * - * This method returns the number of bytes copied. + * - The given +dst+ must be one of the following: * - * If optional arguments are not given, - * the start position of the copy is - * the beginning of the filename or - * the current file offset of the IO. - * The end position of the copy is the end of file. + * - The path to a writable file, to which data is to be written. + * - An \IO-like object, opened for writing and capable of responding + * to method +:write+. * - * If <i>copy_length</i> is given, - * No more than <i>copy_length</i> bytes are copied. + * The examples here use file <tt>t.txt</tt> as source: * - * If <i>src_offset</i> is given, - * it specifies the start position of the copy. + * File.read('t.txt') + * # => "First line\nSecond line\n\nThird line\nFourth line\n" + * File.read('t.txt').size # => 47 * - * When <i>src_offset</i> is specified and - * <i>src</i> is an IO, - * IO.copy_stream doesn't move the current file offset. + * If only arguments +src+ and +dst+ are given, + * the entire source stream is copied: + * + * # Paths. + * IO.copy_stream('t.txt', 't.tmp') # => 47 + * + * # IOs (recall that a File is also an IO). + * src_io = File.open('t.txt', 'r') # => #<File:t.txt> + * dst_io = File.open('t.tmp', 'w') # => #<File:t.tmp> + * IO.copy_stream(src_io, dst_io) # => 47 + * src_io.close + * dst_io.close + * + * With argument +src_length+ a non-negative integer, + * no more than that many bytes are copied: + * + * IO.copy_stream('t.txt', 't.tmp', 10) # => 10 + * File.read('t.tmp') # => "First line" + * + * With argument +src_offset+ also given, + * the source stream is read beginning at that offset: + * + * IO.copy_stream('t.txt', 't.tmp', 11, 11) # => 11 + * IO.read('t.tmp') # => "Second line" * */ static VALUE @@ -12066,13 +13338,16 @@ rb_io_s_copy_stream(int argc, VALUE *argv, VALUE io) st.src = src; st.dst = dst; + st.src_fptr = NULL; + st.dst_fptr = NULL; + if (NIL_P(length)) - st.copy_length = (off_t)-1; + st.copy_length = (rb_off_t)-1; else st.copy_length = NUM2OFFT(length); if (NIL_P(src_offset)) - st.src_offset = (off_t)-1; + st.src_offset = (rb_off_t)-1; else st.src_offset = NUM2OFFT(src_offset); @@ -12083,10 +13358,13 @@ rb_io_s_copy_stream(int argc, VALUE *argv, VALUE io) /* * call-seq: - * io.external_encoding -> encoding + * external_encoding -> encoding or nil + * + * Returns the Encoding object that represents the encoding of the stream, + * or +nil+ if the stream is in write mode and no encoding is specified. + * + * See {Encodings}[rdoc-ref:File@Encodings]. * - * Returns the Encoding object that represents the encoding of the file. - * If _io_ is in write mode and no encoding is specified, returns +nil+. */ static VALUE @@ -12095,22 +13373,26 @@ rb_io_external_encoding(VALUE io) rb_io_t *fptr = RFILE(rb_io_taint_check(io))->fptr; if (fptr->encs.enc2) { - return rb_enc_from_encoding(fptr->encs.enc2); + return rb_enc_from_encoding(fptr->encs.enc2); } if (fptr->mode & FMODE_WRITABLE) { - if (fptr->encs.enc) - return rb_enc_from_encoding(fptr->encs.enc); - return Qnil; + if (fptr->encs.enc) + return rb_enc_from_encoding(fptr->encs.enc); + return Qnil; } return rb_enc_from_encoding(io_read_encoding(fptr)); } /* * call-seq: - * io.internal_encoding -> encoding + * internal_encoding -> encoding or nil + * + * Returns the Encoding object that represents the encoding of the internal string, + * if conversion is specified, + * or +nil+ otherwise. + * + * See {Encodings}[rdoc-ref:File@Encodings]. * - * Returns the Encoding of the internal string if conversion is - * specified. Otherwise returns +nil+. */ static VALUE @@ -12124,21 +13406,32 @@ rb_io_internal_encoding(VALUE io) /* * call-seq: - * io.set_encoding(ext_enc) -> io - * io.set_encoding("ext_enc:int_enc") -> io - * io.set_encoding(ext_enc, int_enc) -> io - * io.set_encoding("ext_enc:int_enc", opt) -> io - * io.set_encoding(ext_enc, int_enc, opt) -> io + * set_encoding(ext_enc) -> self + * set_encoding(ext_enc, int_enc, **enc_opts) -> self + * set_encoding('ext_enc:int_enc', **enc_opts) -> self + * + * See {Encodings}[rdoc-ref:File@Encodings]. + * + * Argument +ext_enc+, if given, must be an Encoding object + * or a String with the encoding name; + * it is assigned as the encoding for the stream. + * + * Argument +int_enc+, if given, must be an Encoding object + * or a String with the encoding name; + * it is assigned as the encoding for the internal string. + * + * Argument <tt>'ext_enc:int_enc'</tt>, if given, is a string + * containing two colon-separated encoding names; + * corresponding Encoding objects are assigned as the external + * and internal encodings for the stream. + * + * If the external encoding of a string is binary/ASCII-8BIT, + * the internal encoding of the string is set to nil, since no + * transcoding is needed. + * + * Optional keyword arguments +enc_opts+ specify + * {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. * - * If single argument is specified, read string from io is tagged - * with the encoding specified. If encoding is a colon separated two - * encoding names "A:B", the read string is converted from encoding A - * (external encoding) to encoding B (internal encoding), then tagged - * with B. If two arguments are specified, those must be encoding - * objects or encoding names, and the first one is the external encoding, and the - * second one is the internal encoding. - * If the external encoding and the internal encoding is specified, - * optional hash argument specify the conversion option. */ static VALUE @@ -12162,6 +13455,18 @@ rb_stdio_set_default_encoding(void) { VALUE val = Qnil; +#ifdef _WIN32 + if (isatty(fileno(stdin))) { + rb_encoding *external = rb_locale_encoding(); + rb_encoding *internal = rb_default_internal_encoding(); + if (!internal) internal = rb_default_external_encoding(); + io_encoding_set(RFILE(rb_stdin)->fptr, + rb_enc_from_encoding(external), + rb_enc_from_encoding(internal), + Qnil); + } + else +#endif rb_io_set_encoding(1, &val, rb_stdin); rb_io_set_encoding(1, &val, rb_stdout); rb_io_set_encoding(1, &val, rb_stderr); @@ -12173,16 +13478,27 @@ global_argf_p(VALUE arg) return arg == argf; } +typedef VALUE (*argf_encoding_func)(VALUE io); + +static VALUE +argf_encoding(VALUE argf, argf_encoding_func func) +{ + if (!RTEST(ARGF.current_file)) { + return rb_enc_default_external(); + } + return func(rb_io_check_io(ARGF.current_file)); +} + /* * call-seq: * ARGF.external_encoding -> encoding * - * Returns the external encoding for files read from +ARGF+ as an +Encoding+ + * Returns the external encoding for files read from ARGF as an Encoding * object. The external encoding is the encoding of the text as stored in a - * file. Contrast with +ARGF.internal_encoding+, which is the encoding used - * to represent this text within Ruby. + * file. Contrast with ARGF.internal_encoding, which is the encoding used to + * represent this text within Ruby. * - * To set the external encoding use +ARGF.set_encoding+. + * To set the external encoding use ARGF.set_encoding. * * For example: * @@ -12192,20 +13508,17 @@ global_argf_p(VALUE arg) static VALUE argf_external_encoding(VALUE argf) { - if (!RTEST(ARGF.current_file)) { - return rb_enc_from_encoding(rb_default_external_encoding()); - } - return rb_io_external_encoding(rb_io_check_io(ARGF.current_file)); + return argf_encoding(argf, rb_io_external_encoding); } /* * call-seq: * ARGF.internal_encoding -> encoding * - * Returns the internal encoding for strings read from +ARGF+ as an - * +Encoding+ object. + * Returns the internal encoding for strings read from ARGF as an + * Encoding object. * - * If +ARGF.set_encoding+ has been called with two encoding names, the second + * If ARGF.set_encoding has been called with two encoding names, the second * is returned. Otherwise, if +Encoding.default_external+ has been set, that * value is returned. Failing that, if a default external encoding was * specified on the command-line, that value is used. If the encoding is @@ -12214,10 +13527,7 @@ argf_external_encoding(VALUE argf) static VALUE argf_internal_encoding(VALUE argf) { - if (!RTEST(ARGF.current_file)) { - return rb_enc_from_encoding(rb_default_external_encoding()); - } - return rb_io_internal_encoding(rb_io_check_io(ARGF.current_file)); + return argf_encoding(argf, rb_io_internal_encoding); } /* @@ -12241,7 +13551,7 @@ argf_internal_encoding(VALUE argf) * specifies the internal encoding. * * If the external encoding and the internal encoding are specified, the - * optional +Hash+ argument can be used to adjust the conversion process. The + * optional Hash argument can be used to adjust the conversion process. The * structure of this hash is explained in the String#encode documentation. * * For example: @@ -12257,7 +13567,7 @@ argf_set_encoding(int argc, VALUE *argv, VALUE argf) rb_io_t *fptr; if (!next_argv()) { - rb_raise(rb_eArgError, "no stream to set encoding"); + rb_raise(rb_eArgError, "no stream to set encoding"); } rb_io_set_encoding(argc, argv, ARGF.current_file); GetOpenFile(ARGF.current_file, fptr); @@ -12270,7 +13580,7 @@ argf_set_encoding(int argc, VALUE *argv, VALUE argf) * ARGF.tell -> Integer * ARGF.pos -> Integer * - * Returns the current offset (in bytes) of the current file in +ARGF+. + * Returns the current offset (in bytes) of the current file in ARGF. * * ARGF.pos #=> 0 * ARGF.gets #=> "This is line one\n" @@ -12281,7 +13591,7 @@ static VALUE argf_tell(VALUE argf) { if (!next_argv()) { - rb_raise(rb_eArgError, "no stream to tell"); + rb_raise(rb_eArgError, "no stream to tell"); } ARGF_FORWARD(0, 0); return rb_io_tell(ARGF.current_file); @@ -12291,14 +13601,14 @@ argf_tell(VALUE argf) * call-seq: * ARGF.seek(amount, whence=IO::SEEK_SET) -> 0 * - * Seeks to offset _amount_ (an +Integer+) in the +ARGF+ stream according to + * Seeks to offset _amount_ (an Integer) in the ARGF stream according to * the value of _whence_. See IO#seek for further details. */ static VALUE argf_seek_m(int argc, VALUE *argv, VALUE argf) { if (!next_argv()) { - rb_raise(rb_eArgError, "no stream to seek"); + rb_raise(rb_eArgError, "no stream to seek"); } ARGF_FORWARD(argc, argv); return rb_io_seek_m(argc, argv, ARGF.current_file); @@ -12308,7 +13618,7 @@ argf_seek_m(int argc, VALUE *argv, VALUE argf) * call-seq: * ARGF.pos = position -> Integer * - * Seeks to the position given by _position_ (in bytes) in +ARGF+. + * Seeks to the position given by _position_ (in bytes) in ARGF. * * For example: * @@ -12319,7 +13629,7 @@ static VALUE argf_set_pos(VALUE argf, VALUE offset) { if (!next_argv()) { - rb_raise(rb_eArgError, "no stream to set position"); + rb_raise(rb_eArgError, "no stream to set position"); } ARGF_FORWARD(1, &offset); return rb_io_set_pos(ARGF.current_file, offset); @@ -12330,7 +13640,7 @@ argf_set_pos(VALUE argf, VALUE offset) * ARGF.rewind -> 0 * * Positions the current file to the beginning of input, resetting - * +ARGF.lineno+ to zero. + * ARGF.lineno to zero. * * ARGF.readline #=> "This is line one\n" * ARGF.rewind #=> 0 @@ -12344,13 +13654,13 @@ argf_rewind(VALUE argf) int old_lineno; if (!next_argv()) { - rb_raise(rb_eArgError, "no stream to rewind"); + rb_raise(rb_eArgError, "no stream to rewind"); } ARGF_FORWARD(0, 0); old_lineno = RFILE(ARGF.current_file)->fptr->lineno; ret = rb_io_rewind(ARGF.current_file); if (!global_argf_p(argf)) { - ARGF.last_lineno = ARGF.lineno -= old_lineno; + ARGF.last_lineno = ARGF.lineno -= old_lineno; } return ret; } @@ -12361,7 +13671,7 @@ argf_rewind(VALUE argf) * ARGF.to_i -> integer * * Returns an integer representing the numeric file descriptor for - * the current file. Raises an +ArgumentError+ if there isn't a current file. + * the current file. Raises an ArgumentError if there isn't a current file. * * ARGF.fileno #=> 3 */ @@ -12369,7 +13679,7 @@ static VALUE argf_fileno(VALUE argf) { if (!next_argv()) { - rb_raise(rb_eArgError, "no stream"); + rb_raise(rb_eArgError, "no stream"); } ARGF_FORWARD(0, 0); return rb_io_fileno(ARGF.current_file); @@ -12379,8 +13689,8 @@ argf_fileno(VALUE argf) * call-seq: * ARGF.to_io -> IO * - * Returns an +IO+ object representing the current file. This will be a - * +File+ object unless the current file is a stream such as STDIN. + * Returns an IO object representing the current file. This will be a + * File object unless the current file is a stream such as STDIN. * * For example: * @@ -12400,8 +13710,8 @@ argf_to_io(VALUE argf) * ARGF.eof? -> true or false * ARGF.eof -> true or false * - * Returns true if the current file in +ARGF+ is at end of file, i.e. it has - * no data to read. The stream must be opened for reading or an +IOError+ + * Returns true if the current file in ARGF is at end of file, i.e. it has + * no data to read. The stream must be opened for reading or an IOError * will be raised. * * $ echo "eof" | ruby argf.rb @@ -12418,12 +13728,12 @@ argf_eof(VALUE argf) { next_argv(); if (RTEST(ARGF.current_file)) { - if (ARGF.init_p == 0) return Qtrue; - next_argv(); - ARGF_FORWARD(0, 0); - if (rb_io_eof(ARGF.current_file)) { - return Qtrue; - } + if (ARGF.init_p == 0) return Qtrue; + next_argv(); + ARGF_FORWARD(0, 0); + if (rb_io_eof(ARGF.current_file)) { + return Qtrue; + } } return Qfalse; } @@ -12484,39 +13794,39 @@ argf_read(int argc, VALUE *argv, VALUE argf) rb_scan_args(argc, argv, "02", &length, &str); if (!NIL_P(length)) { - len = NUM2LONG(argv[0]); + len = NUM2LONG(argv[0]); } if (!NIL_P(str)) { - StringValue(str); - rb_str_resize(str,0); - argv[1] = Qnil; + StringValue(str); + rb_str_resize(str,0); + argv[1] = Qnil; } retry: if (!next_argv()) { - return str; + return str; } if (ARGF_GENERIC_INPUT_P()) { - tmp = argf_forward(argc, argv, argf); + tmp = argf_forward(argc, argv, argf); } else { - tmp = io_read(argc, argv, ARGF.current_file); + tmp = io_read(argc, argv, ARGF.current_file); } if (NIL_P(str)) str = tmp; else if (!NIL_P(tmp)) rb_str_append(str, tmp); if (NIL_P(tmp) || NIL_P(length)) { - if (ARGF.next_p != -1) { - argf_close(argf); - ARGF.next_p = 1; - goto retry; - } + if (ARGF.next_p != -1) { + argf_close(argf); + ARGF.next_p = 1; + goto retry; + } } else if (argc >= 1) { - long slen = RSTRING_LEN(str); - if (slen < len) { + long slen = RSTRING_LEN(str); + if (slen < len) { argv[0] = LONG2NUM(len - slen); - goto retry; - } + goto retry; + } } return str; } @@ -12599,18 +13909,18 @@ argf_getpartial(int argc, VALUE *argv, VALUE argf, VALUE opts, int nonblock) no_exception = no_exception_p(opts); if (!next_argv()) { - if (!NIL_P(str)) { - rb_str_resize(str, 0); - } + if (!NIL_P(str)) { + rb_str_resize(str, 0); + } rb_eof_error(); } if (ARGF_GENERIC_INPUT_P()) { VALUE (*const rescue_does_nothing)(VALUE, VALUE) = 0; - struct argf_call_arg arg; - arg.argc = argc; - arg.argv = argv; - arg.argf = argf; - tmp = rb_rescue2(argf_forward_call, (VALUE)&arg, + struct argf_call_arg arg; + arg.argc = argc; + arg.argv = argv; + arg.argf = argf; + tmp = rb_rescue2(argf_forward_call, (VALUE)&arg, rescue_does_nothing, Qnil, rb_eEOFError, (VALUE)0); } else { @@ -12624,7 +13934,7 @@ argf_getpartial(int argc, VALUE *argv, VALUE argf, VALUE opts, int nonblock) ARGF.next_p = 1; if (RARRAY_LEN(ARGF.argv) == 0) { return io_nonblock_eof(no_exception); - } + } if (NIL_P(str)) str = rb_str_new(NULL, 0); return str; @@ -12636,10 +13946,10 @@ argf_getpartial(int argc, VALUE *argv, VALUE argf, VALUE opts, int nonblock) * call-seq: * ARGF.getc -> String or nil * - * Reads the next character from +ARGF+ and returns it as a +String+. Returns + * Reads the next character from ARGF and returns it as a String. Returns * +nil+ at the end of the stream. * - * +ARGF+ treats the files named on the command line as a single file created + * ARGF treats the files named on the command line as a single file created * by concatenating their contents. After returning the last character of the * first file, it returns the first character of the second file, and so on. * @@ -12663,15 +13973,15 @@ argf_getc(VALUE argf) retry: if (!next_argv()) return Qnil; if (ARGF_GENERIC_INPUT_P()) { - ch = forward_current(rb_intern("getc"), 0, 0); + ch = forward_current(rb_intern("getc"), 0, 0); } else { - ch = rb_io_getc(ARGF.current_file); + ch = rb_io_getc(ARGF.current_file); } if (NIL_P(ch) && ARGF.next_p != -1) { - argf_close(argf); - ARGF.next_p = 1; - goto retry; + argf_close(argf); + ARGF.next_p = 1; + goto retry; } return ch; @@ -12681,7 +13991,7 @@ argf_getc(VALUE argf) * call-seq: * ARGF.getbyte -> Integer or nil * - * Gets the next 8-bit byte (0..255) from +ARGF+. Returns +nil+ if called at + * Gets the next 8-bit byte (0..255) from ARGF. Returns +nil+ if called at * the end of the stream. * * For example: @@ -12703,15 +14013,15 @@ argf_getbyte(VALUE argf) retry: if (!next_argv()) return Qnil; if (!RB_TYPE_P(ARGF.current_file, T_FILE)) { - ch = forward_current(rb_intern("getbyte"), 0, 0); + ch = forward_current(rb_intern("getbyte"), 0, 0); } else { - ch = rb_io_getbyte(ARGF.current_file); + ch = rb_io_getbyte(ARGF.current_file); } if (NIL_P(ch) && ARGF.next_p != -1) { - argf_close(argf); - ARGF.next_p = 1; - goto retry; + argf_close(argf); + ARGF.next_p = 1; + goto retry; } return ch; @@ -12721,8 +14031,8 @@ argf_getbyte(VALUE argf) * call-seq: * ARGF.readchar -> String or nil * - * Reads the next character from +ARGF+ and returns it as a +String+. Raises - * an +EOFError+ after the last character of the last file has been read. + * Reads the next character from ARGF and returns it as a String. Raises + * an EOFError after the last character of the last file has been read. * * For example: * @@ -12743,15 +14053,15 @@ argf_readchar(VALUE argf) retry: if (!next_argv()) rb_eof_error(); if (!RB_TYPE_P(ARGF.current_file, T_FILE)) { - ch = forward_current(rb_intern("getc"), 0, 0); + ch = forward_current(rb_intern("getc"), 0, 0); } else { - ch = rb_io_getc(ARGF.current_file); + ch = rb_io_getc(ARGF.current_file); } if (NIL_P(ch) && ARGF.next_p != -1) { - argf_close(argf); - ARGF.next_p = 1; - goto retry; + argf_close(argf); + ARGF.next_p = 1; + goto retry; } return ch; @@ -12761,8 +14071,8 @@ argf_readchar(VALUE argf) * call-seq: * ARGF.readbyte -> Integer * - * Reads the next 8-bit byte from ARGF and returns it as an +Integer+. Raises - * an +EOFError+ after the last byte of the last file has been read. + * Reads the next 8-bit byte from ARGF and returns it as an Integer. Raises + * an EOFError after the last byte of the last file has been read. * * For example: * @@ -12783,7 +14093,7 @@ argf_readbyte(VALUE argf) NEXT_ARGF_FORWARD(0, 0); c = argf_getbyte(argf); if (NIL_P(c)) { - rb_eof_error(); + rb_eof_error(); } return c; } @@ -12796,7 +14106,7 @@ argf_block_call_i(RB_BLOCK_CALL_FUNC_ARGLIST(i, argf)) const VALUE current = ARGF.current_file; rb_yield_values2(argc, argv); if (ARGF.init_p == -1 || current != ARGF.current_file) { - rb_iter_break_value(Qundef); + rb_iter_break_value(Qundef); } return Qnil; } @@ -12809,14 +14119,14 @@ static void argf_block_call(ID mid, int argc, VALUE *argv, VALUE argf) { VALUE ret = ARGF_block_call(mid, argc, argv, argf_block_call_i, argf); - if (ret != Qundef) ARGF.next_p = 1; + if (!UNDEF_P(ret)) ARGF.next_p = 1; } static VALUE argf_block_call_line_i(RB_BLOCK_CALL_FUNC_ARGLIST(i, argf)) { if (!global_argf_p(argf)) { - ARGF.last_lineno = ++ARGF.lineno; + ARGF.last_lineno = ++ARGF.lineno; } return argf_block_call_i(i, argf, argc, argv, blockarg); } @@ -12825,7 +14135,7 @@ static void argf_block_call_line(ID mid, int argc, VALUE *argv, VALUE argf) { VALUE ret = ARGF_block_call(mid, argc, argv, argf_block_call_line_i, argf); - if (ret != Qundef) ARGF.next_p = 1; + if (!UNDEF_P(ret)) ARGF.next_p = 1; } /* @@ -12842,15 +14152,15 @@ argf_block_call_line(ID mid, int argc, VALUE *argv, VALUE argf) * which defaults to your platform's newline character) of each file in * +ARGV+. If a block is supplied, each line in turn will be yielded to the * block, otherwise an enumerator is returned. - * The optional _limit_ argument is an +Integer+ specifying the maximum + * The optional _limit_ argument is an Integer specifying the maximum * length of each line; longer lines will be split according to this limit. * * This method allows you to treat the files supplied on the command line as * a single file consisting of the concatenation of each named file. After * the last line of the first file has been returned, the first line of the - * second file is returned. The +ARGF.filename+ and +ARGF.lineno+ methods can - * be used to determine the filename of the current line and line number of - * the whole input, respectively. + * second file is returned. The ARGF.filename and ARGF.lineno methods can be + * used to determine the filename of the current line and line number of the + * whole input, respectively. * * For example, the following code prints out each line of each named file * prefixed with its line number, displaying the filename once per file: @@ -12873,7 +14183,7 @@ argf_each_line(int argc, VALUE *argv, VALUE argf) { RETURN_ENUMERATOR(argf, argc, argv); FOREACH_ARGF() { - argf_block_call_line(rb_intern("each_line"), argc, argv, argf); + argf_block_call_line(rb_intern("each_line"), argc, argv, argf); } return argf; } @@ -12884,12 +14194,12 @@ argf_each_line(int argc, VALUE *argv, VALUE argf) * ARGF.each_byte -> an_enumerator * * Iterates over each byte of each file in +ARGV+. - * A byte is returned as an +Integer+ in the range 0..255. + * A byte is returned as an Integer in the range 0..255. * * This method allows you to treat the files supplied on the command line as * a single file consisting of the concatenation of each named file. After * the last byte of the first file has been returned, the first byte of the - * second file is returned. The +ARGF.filename+ method can be used to + * second file is returned. The ARGF.filename method can be used to * determine the filename of the current byte. * * If no block is given, an enumerator is returned instead. @@ -12904,7 +14214,7 @@ argf_each_byte(VALUE argf) { RETURN_ENUMERATOR(argf, 0, 0); FOREACH_ARGF() { - argf_block_call(rb_intern("each_byte"), 0, 0, argf); + argf_block_call(rb_intern("each_byte"), 0, 0, argf); } return argf; } @@ -12914,12 +14224,12 @@ argf_each_byte(VALUE argf) * ARGF.each_char {|char| block } -> ARGF * ARGF.each_char -> an_enumerator * - * Iterates over each character of each file in +ARGF+. + * Iterates over each character of each file in ARGF. * * This method allows you to treat the files supplied on the command line as * a single file consisting of the concatenation of each named file. After * the last character of the first file has been returned, the first - * character of the second file is returned. The +ARGF.filename+ method can + * character of the second file is returned. The ARGF.filename method can * be used to determine the name of the file in which the current character * appears. * @@ -12930,7 +14240,7 @@ argf_each_char(VALUE argf) { RETURN_ENUMERATOR(argf, 0, 0); FOREACH_ARGF() { - argf_block_call(rb_intern("each_char"), 0, 0, argf); + argf_block_call(rb_intern("each_char"), 0, 0, argf); } return argf; } @@ -12940,12 +14250,12 @@ argf_each_char(VALUE argf) * ARGF.each_codepoint {|codepoint| block } -> ARGF * ARGF.each_codepoint -> an_enumerator * - * Iterates over each codepoint of each file in +ARGF+. + * Iterates over each codepoint of each file in ARGF. * * This method allows you to treat the files supplied on the command line as * a single file consisting of the concatenation of each named file. After * the last codepoint of the first file has been returned, the first - * codepoint of the second file is returned. The +ARGF.filename+ method can + * codepoint of the second file is returned. The ARGF.filename method can * be used to determine the name of the file in which the current codepoint * appears. * @@ -12956,7 +14266,7 @@ argf_each_codepoint(VALUE argf) { RETURN_ENUMERATOR(argf, 0, 0); FOREACH_ARGF() { - argf_block_call(rb_intern("each_codepoint"), 0, 0, argf); + argf_block_call(rb_intern("each_codepoint"), 0, 0, argf); } return argf; } @@ -13000,7 +14310,7 @@ argf_filename_getter(ID id, VALUE *var) * call-seq: * ARGF.file -> IO or File object * - * Returns the current file as an +IO+ or +File+ object. + * Returns the current file as an IO or File object. * <code>$stdin</code> is returned when the current file is STDIN. * * For example: @@ -13025,7 +14335,7 @@ argf_file(VALUE argf) * call-seq: * ARGF.binmode -> ARGF * - * Puts +ARGF+ into binary mode. Once a stream is in binary mode, it cannot + * Puts ARGF into binary mode. Once a stream is in binary mode, it cannot * be reset to non-binary mode. This option has the following effects: * * * Newline conversion is disabled. @@ -13046,8 +14356,8 @@ argf_binmode_m(VALUE argf) * call-seq: * ARGF.binmode? -> true or false * - * Returns true if +ARGF+ is being read in binary mode; false otherwise. - * To enable binary mode use +ARGF.binmode+. + * Returns true if ARGF is being read in binary mode; false otherwise. + * To enable binary mode use ARGF.binmode. * * For example: * @@ -13079,8 +14389,8 @@ static VALUE argf_skip(VALUE argf) { if (ARGF.init_p && ARGF.next_p == 0) { - argf_close(argf); - ARGF.next_p = 1; + argf_close(argf); + ARGF.next_p = 1; } return argf; } @@ -13090,7 +14400,7 @@ argf_skip(VALUE argf) * ARGF.close -> ARGF * * Closes the current file and skips to the next file in ARGV. If there are - * no more files to open, just closes the current file. +STDIN+ will not be + * no more files to open, just closes the current file. STDIN will not be * closed. * * For example: @@ -13108,7 +14418,7 @@ argf_close_m(VALUE argf) next_argv(); argf_close(argf); if (ARGF.next_p != -1) { - ARGF.next_p = 1; + ARGF.next_p = 1; } ARGF.lineno = 0; return argf; @@ -13119,14 +14429,14 @@ argf_close_m(VALUE argf) * ARGF.closed? -> true or false * * Returns _true_ if the current file has been closed; _false_ otherwise. Use - * +ARGF.close+ to actually close the current file. + * ARGF.close to actually close the current file. */ static VALUE argf_closed(VALUE argf) { next_argv(); ARGF_FORWARD(0, 0); - return rb_io_closed(ARGF.current_file); + return rb_io_closed_p(ARGF.current_file); } /* @@ -13145,9 +14455,9 @@ argf_to_s(VALUE argf) * call-seq: * ARGF.inplace_mode -> String * - * Returns the file extension appended to the names of modified files under - * in-place edit mode. This value can be set using +ARGF.inplace_mode=+ or - * passing the +-i+ switch to the Ruby binary. + * Returns the file extension appended to the names of backup copies of + * modified files under in-place edit mode. This value can be set using + * ARGF.inplace_mode= or passing the +-i+ switch to the Ruby binary. */ static VALUE argf_inplace_mode_get(VALUE argf) @@ -13168,8 +14478,8 @@ opt_i_get(ID id, VALUE *var) * ARGF.inplace_mode = ext -> ARGF * * Sets the filename extension for in-place editing mode to the given String. - * Each file being edited has this value appended to its filename. The - * modified file is saved under this new name. + * The backup copy of each file being edited has this value appended to its + * filename. * * For example: * @@ -13180,20 +14490,21 @@ opt_i_get(ID id, VALUE *var) * print line.sub("foo","bar") * end * - * Each line of _file.txt_ has the first occurrence of "foo" replaced with - * "bar", then the new line is written out to _file.txt.bak_. + * First, _file.txt.bak_ is created as a backup copy of _file.txt_. + * Then, each line of _file.txt_ has the first occurrence of "foo" replaced with + * "bar". */ static VALUE argf_inplace_mode_set(VALUE argf, VALUE val) { if (!RTEST(val)) { - ARGF.inplace = Qfalse; + ARGF.inplace = Qfalse; } else if (StringValueCStr(val), !RSTRING_LEN(val)) { - ARGF.inplace = Qnil; + ARGF.inplace = Qnil; } else { - ARGF.inplace = rb_str_new_frozen(val); + ARGF.inplace = rb_str_new_frozen(val); } return argf; } @@ -13253,21 +14564,21 @@ static VALUE argf_write_io(VALUE argf) { if (!RTEST(ARGF.current_file)) { - rb_raise(rb_eIOError, "not opened for writing"); + rb_raise(rb_eIOError, "not opened for writing"); } return GetWriteIO(ARGF.current_file); } /* * call-seq: - * ARGF.write(string) -> integer + * ARGF.write(*objects) -> integer * - * Writes _string_ if inplace mode. + * Writes each of the given +objects+ if inplace mode. */ static VALUE -argf_write(VALUE argf, VALUE str) +argf_write(int argc, VALUE *argv, VALUE argf) { - return rb_io_write(argf_write_io(argf), str); + return rb_io_writev(argf_write_io(argf), argc, argv); } void @@ -13283,41 +14594,41 @@ rb_readwrite_syserr_fail(enum rb_io_wait_readwrite waiting, int n, const char *m arg = mesg ? rb_str_new2(mesg) : Qnil; switch (waiting) { case RB_IO_WAIT_WRITABLE: - switch (n) { - case EAGAIN: + switch (n) { + case EAGAIN: c = rb_eEAGAINWaitWritable; - break; + break; #if EAGAIN != EWOULDBLOCK - case EWOULDBLOCK: + case EWOULDBLOCK: c = rb_eEWOULDBLOCKWaitWritable; - break; + break; #endif - case EINPROGRESS: + case EINPROGRESS: c = rb_eEINPROGRESSWaitWritable; - break; - default: + break; + default: rb_mod_syserr_fail_str(rb_mWaitWritable, n, arg); - } + } break; case RB_IO_WAIT_READABLE: - switch (n) { - case EAGAIN: + switch (n) { + case EAGAIN: c = rb_eEAGAINWaitReadable; - break; + break; #if EAGAIN != EWOULDBLOCK - case EWOULDBLOCK: + case EWOULDBLOCK: c = rb_eEWOULDBLOCKWaitReadable; - break; + break; #endif - case EINPROGRESS: + case EINPROGRESS: c = rb_eEINPROGRESSWaitReadable; - break; - default: + break; + default: rb_mod_syserr_fail_str(rb_mWaitReadable, n, arg); - } + } break; default: - rb_bug("invalid read/write type passed to rb_readwrite_sys_fail: %d", waiting); + rb_bug("invalid read/write type passed to rb_readwrite_sys_fail: %d", waiting); } rb_exc_raise(rb_class_new_instance(1, &arg, c)); } @@ -13359,285 +14670,843 @@ set_LAST_READ_LINE(VALUE val, ID _x, VALUE *_y) * methods exist in two forms, * * one that returns +nil+ when the end of file is reached, the other - * raises +EOFError+. + * raises EOFError. * - * +EOFError+ is a subclass of +IOError+. + * EOFError is a subclass of IOError. * * file = File.open("/etc/hosts") * file.read * file.gets #=> nil * file.readline #=> EOFError: end of file reached + * file.close */ /* * Document-class: ARGF * - * +ARGF+ is a stream designed for use in scripts that process files given as - * command-line arguments or passed in via STDIN. + * == \ARGF and +ARGV+ + * + * The \ARGF object works with the array at global variable +ARGV+ + * to make <tt>$stdin</tt> and file streams available in the Ruby program: + * + * - **ARGV** may be thought of as the <b>argument vector</b> array. + * + * Initially, it contains the command-line arguments and options + * that are passed to the Ruby program; + * the program can modify that array as it likes. + * + * - **ARGF** may be thought of as the <b>argument files</b> object. + * + * It can access file streams and/or the <tt>$stdin</tt> stream, + * based on what it finds in +ARGV+. + * This provides a convenient way for the command line + * to specify streams for a Ruby program to read. + * + * == Reading + * + * \ARGF may read from _source_ streams, + * which at any particular time are determined by the content of +ARGV+. + * + * === Simplest Case + * + * When the <i>very first</i> \ARGF read occurs with an empty +ARGV+ (<tt>[]</tt>), + * the source is <tt>$stdin</tt>: + * + * - \File +t.rb+: + * + * p ['ARGV', ARGV] + * p ['ARGF.read', ARGF.read] + * + * - Commands and outputs + * (see below for the content of files +foo.txt+ and +bar.txt+): + * + * $ echo "Open the pod bay doors, Hal." | ruby t.rb + * ["ARGV", []] + * ["ARGF.read", "Open the pod bay doors, Hal.\n"] + * + * $ cat foo.txt bar.txt | ruby t.rb + * ["ARGV", []] + * ["ARGF.read", "Foo 0\nFoo 1\nBar 0\nBar 1\nBar 2\nBar 3\n"] + * + * === About the Examples + * + * Many examples here assume the existence of files +foo.txt+ and +bar.txt+: + * + * $ cat foo.txt + * Foo 0 + * Foo 1 + * $ cat bar.txt + * Bar 0 + * Bar 1 + * Bar 2 + * Bar 3 + * + * === Sources in +ARGV+ + * + * For any \ARGF read _except_ the {simplest case}[rdoc-ref:ARGF@Simplest+Case] + * (that is, _except_ for the <i>very first</i> \ARGF read with an empty +ARGV+), + * the sources are found in +ARGV+. + * + * \ARGF assumes that each element in array +ARGV+ is a potential source, + * and is one of: + * + * - The string path to a file that may be opened as a stream. + * - The character <tt>'-'</tt>, meaning stream <tt>$stdin</tt>. + * + * Each element that is _not_ one of these + * should be removed from +ARGV+ before \ARGF accesses that source. * - * The arguments passed to your script are stored in the +ARGV+ Array, one - * argument per element. +ARGF+ assumes that any arguments that aren't - * filenames have been removed from +ARGV+. For example: + * In the following example: * - * $ ruby argf.rb --verbose file1 file2 + * - Filepaths +foo.txt+ and +bar.txt+ may be retained as potential sources. + * - Options <tt>--xyzzy</tt> and <tt>--mojo</tt> should be removed. * - * ARGV #=> ["--verbose", "file1", "file2"] - * option = ARGV.shift #=> "--verbose" - * ARGV #=> ["file1", "file2"] + * Example: * - * You can now use +ARGF+ to work with a concatenation of each of these named - * files. For instance, +ARGF.read+ will return the contents of _file1_ - * followed by the contents of _file2_. + * - \File +t.rb+: * - * After a file in +ARGV+ has been read +ARGF+ removes it from the Array. - * Thus, after all files have been read +ARGV+ will be empty. + * # Print arguments (and options, if any) found on command line. + * p ['ARGV', ARGV] * - * You can manipulate +ARGV+ yourself to control what +ARGF+ operates on. If - * you remove a file from +ARGV+, it is ignored by +ARGF+; if you add files to - * +ARGV+, they are treated as if they were named on the command line. For - * example: + * - Command and output: * - * ARGV.replace ["file1"] - * ARGF.readlines # Returns the contents of file1 as an Array - * ARGV #=> [] - * ARGV.replace ["file2", "file3"] - * ARGF.read # Returns the contents of file2 and file3 + * $ ruby t.rb --xyzzy --mojo foo.txt bar.txt + * ["ARGV", ["--xyzzy", "--mojo", "foo.txt", "bar.txt"]] * - * If +ARGV+ is empty, +ARGF+ acts as if it contained STDIN, i.e. the data - * piped to your script. For example: + * \ARGF's stream access considers the elements of +ARGV+, left to right: + * + * - \File +t.rb+: + * + * p "ARGV: #{ARGV}" + * p "Line: #{ARGF.read}" # Read everything from all specified streams. + * + * - Command and output: + * + * $ ruby t.rb foo.txt bar.txt + * "ARGV: [\"foo.txt\", \"bar.txt\"]" + * "Read: Foo 0\nFoo 1\nBar 0\nBar 1\nBar 2\nBar 3\n" + * + * Because the value at +ARGV+ is an ordinary array, + * you can manipulate it to control which sources \ARGF considers: + * + * - If you remove an element from +ARGV+, \ARGF will not consider the corresponding source. + * - If you add an element to +ARGV+, \ARGF will consider the corresponding source. + * + * Each element in +ARGV+ is removed when its corresponding source is accessed; + * when all sources have been accessed, the array is empty: + * + * - \File +t.rb+: + * + * until ARGV.empty? && ARGF.eof? + * p "ARGV: #{ARGV}" + * p "Line: #{ARGF.readline}" # Read each line from each specified stream. + * end + * + * - Command and output: + * + * $ ruby t.rb foo.txt bar.txt + * "ARGV: [\"foo.txt\", \"bar.txt\"]" + * "Line: Foo 0\n" + * "ARGV: [\"bar.txt\"]" + * "Line: Foo 1\n" + * "ARGV: [\"bar.txt\"]" + * "Line: Bar 0\n" + * "ARGV: []" + * "Line: Bar 1\n" + * "ARGV: []" + * "Line: Bar 2\n" + * "ARGV: []" + * "Line: Bar 3\n" + * + * ==== Filepaths in +ARGV+ + * + * The +ARGV+ array may contain filepaths the specify sources for \ARGF reading. + * + * This program prints what it reads from files at the paths specified + * on the command line: + * + * - \File +t.rb+: + * + * p ['ARGV', ARGV] + * # Read and print all content from the specified sources. + * p ['ARGF.read', ARGF.read] + * + * - Command and output: + * + * $ ruby t.rb foo.txt bar.txt + * ["ARGV", [foo.txt, bar.txt] + * ["ARGF.read", "Foo 0\nFoo 1\nBar 0\nBar 1\nBar 2\nBar 3\n"] + * + * ==== Specifying <tt>$stdin</tt> in +ARGV+ + * + * To specify stream <tt>$stdin</tt> in +ARGV+, us the character <tt>'-'</tt>: + * + * - \File +t.rb+: + * + * p ['ARGV', ARGV] + * p ['ARGF.read', ARGF.read] + * + * - Command and output: + * + * $ echo "Open the pod bay doors, Hal." | ruby t.rb - + * ["ARGV", ["-"]] + * ["ARGF.read", "Open the pod bay doors, Hal.\n"] + * + * When no character <tt>'-'</tt> is given, stream <tt>$stdin</tt> is ignored + * (exception: + * see {Specifying $stdin in ARGV}[rdoc-ref:ARGF@Specifying+-24stdin+in+ARGV]): + * + * - Command and output: + * + * $ echo "Open the pod bay doors, Hal." | ruby t.rb foo.txt bar.txt + * "ARGV: [\"foo.txt\", \"bar.txt\"]" + * "Read: Foo 0\nFoo 1\nBar 0\nBar 1\nBar 2\nBar 3\n" + * + * ==== Mixtures and Repetitions in +ARGV+ + * + * For an \ARGF reader, +ARGV+ may contain any mixture of filepaths + * and character <tt>'-'</tt>, including repetitions. + * + * ==== Modifications to +ARGV+ + * + * The running Ruby program may make any modifications to the +ARGV+ array; + * the current value of +ARGV+ affects \ARGF reading. + * + * ==== Empty +ARGV+ + * + * For an empty +ARGV+, an \ARGF read method either returns +nil+ + * or raises an exception, depending on the specific method. + * + * === More Read Methods + * + * As seen above, method ARGF#read reads the content of all sources + * into a single string. + * Other \ARGF methods provide other ways to access that content; + * these include: + * + * - Byte access: #each_byte, #getbyte, #readbyte. + * - Character access: #each_char, #getc, #readchar. + * - Codepoint access: #each_codepoint. + * - Line access: #each_line, #gets, #readline, #readlines. + * - Source access: #read, #read_nonblock, #readpartial. + * + * === About \Enumerable + * + * \ARGF includes module Enumerable. + * Virtually all methods in \Enumerable call method <tt>#each</tt> in the including class. + * + * <b>Note well</b>: In \ARGF, method #each returns data from the _sources_, + * _not_ from +ARGV+; + * therefore, for example, <tt>ARGF#entries</tt> returns an array of lines from the sources, + * not an array of the strings from +ARGV+: + * + * - \File +t.rb+: + * + * p ['ARGV', ARGV] + * p ['ARGF.entries', ARGF.entries] + * + * - Command and output: + * + * $ ruby t.rb foo.txt bar.txt + * ["ARGV", ["foo.txt", "bar.txt"]] + * ["ARGF.entries", ["Foo 0\n", "Foo 1\n", "Bar 0\n", "Bar 1\n", "Bar 2\n", "Bar 3\n"]] + * + * == Writing + * + * If <i>inplace mode</i> is in effect, + * \ARGF may write to target streams, + * which at any particular time are determined by the content of ARGV. + * + * Methods about inplace mode: + * + * - #inplace_mode + * - #inplace_mode= + * - #to_write_io + * + * Methods for writing: + * + * - #print + * - #printf + * - #putc + * - #puts + * - #write * - * $ echo "glark" | ruby -e 'p ARGF.read' - * "glark\n" */ /* - * The IO class is the basis for all input and output in Ruby. - * An I/O stream may be <em>duplexed</em> (that is, bidirectional), and - * so may use more than one native operating system stream. + * An instance of class \IO (commonly called a _stream_) + * represents an input/output stream in the underlying operating system. + * \Class \IO is the basis for input and output in Ruby. * - * Many of the examples in this section use the File class, the only standard - * subclass of IO. The two classes are closely associated. Like the File - * class, the Socket library subclasses from IO (such as TCPSocket or - * UDPSocket). + * \Class File is the only class in the Ruby core that is a subclass of \IO. + * Some classes in the Ruby standard library are also subclasses of \IO; + * these include TCPSocket and UDPSocket. * - * The Kernel#open method can create an IO (or File) object for these types - * of arguments: + * The global constant ARGF (also accessible as <tt>$<</tt>) + * provides an IO-like stream that allows access to all file paths + * found in ARGV (or found in STDIN if ARGV is empty). + * ARGF is not itself a subclass of \IO. * - * * A plain string represents a filename suitable for the underlying - * operating system. + * \Class StringIO provides an IO-like stream that handles a String. + * StringIO is not itself a subclass of \IO. + * + * Important objects based on \IO include: + * + * - $stdin. + * - $stdout. + * - $stderr. + * - Instances of class File. + * + * An instance of \IO may be created using: + * + * - IO.new: returns a new \IO object for the given integer file descriptor. + * - IO.open: passes a new \IO object to the given block. + * - IO.popen: returns a new \IO object that is connected to the $stdin and $stdout + * of a newly-launched subprocess. + * - Kernel#open: Returns a new \IO object connected to a given source: + * stream, file, or subprocess. + * + * Like a File stream, an \IO stream has: + * + * - A read/write mode, which may be read-only, write-only, or read/write; + * see {Read/Write Mode}[rdoc-ref:File@Read-2FWrite+Mode]. + * - A data mode, which may be text-only or binary; + * see {Data Mode}[rdoc-ref:File@Data+Mode]. + * - Internal and external encodings; + * see {Encodings}[rdoc-ref:File@Encodings]. + * + * And like other \IO streams, it has: * - * * A string starting with <code>"|"</code> indicates a subprocess. - * The remainder of the string following the <code>"|"</code> is - * invoked as a process with appropriate input/output channels - * connected to it. - * - * * A string equal to <code>"|-"</code> will create another Ruby - * instance as a subprocess. - * - * The IO may be opened with different file modes (read-only, write-only) and - * encodings for proper conversion. See IO.new for these options. See - * Kernel#open for details of the various command formats described above. - * - * IO.popen, the Open3 library, or Process#spawn may also be used to - * communicate with subprocesses through an IO. - * - * Ruby will convert pathnames between different operating system - * conventions if possible. For instance, on a Windows system the - * filename <code>"/gumby/ruby/test.rb"</code> will be opened as - * <code>"\gumby\ruby\test.rb"</code>. When specifying a Windows-style - * filename in a Ruby string, remember to escape the backslashes: - * - * "C:\\gumby\\ruby\\test.rb" - * - * Our examples here will use the Unix-style forward slashes; - * File::ALT_SEPARATOR can be used to get the platform-specific separator - * character. - * - * The global constant ARGF (also accessible as <code>$<</code>) provides an - * IO-like stream which allows access to all files mentioned on the - * command line (or STDIN if no files are mentioned). ARGF#path and its alias - * ARGF#filename are provided to access the name of the file currently being - * read. - * - * == io/console - * - * The io/console extension provides methods for interacting with the - * console. The console can be accessed from IO.console or the standard - * input/output/error IO objects. - * - * Requiring io/console adds the following methods: - * - * * IO::console - * * IO#raw - * * IO#raw! - * * IO#cooked - * * IO#cooked! - * * IO#getch - * * IO#echo= - * * IO#echo? - * * IO#noecho - * * IO#winsize - * * IO#winsize= - * * IO#iflush - * * IO#ioflush - * * IO#oflush + * - A position, which determines where in the stream the next + * read or write is to occur; + * see {Position}[rdoc-ref:IO@Position]. + * - A line number, which is a special, line-oriented, "position" + * (different from the position mentioned above); + * see {Line Number}[rdoc-ref:IO@Line+Number]. + * + * == Extension <tt>io/console</tt> + * + * Extension <tt>io/console</tt> provides numerous methods + * for interacting with the console; + * requiring it adds numerous methods to class \IO. + * + * == Example Files + * + * Many examples here use these variables: + * + * :include: doc/examples/files.rdoc + * + * == Open Options + * + * A number of \IO methods accept optional keyword arguments + * that determine how a new stream is to be opened: + * + * - +:mode+: Stream mode. + * - +:flags+: Integer file open flags; + * If +mode+ is also given, the two are bitwise-ORed. + * - +:external_encoding+: External encoding for the stream. + * - +:internal_encoding+: Internal encoding for the stream. + * <tt>'-'</tt> is a synonym for the default internal encoding. + * If the value is +nil+ no conversion occurs. + * - +:encoding+: Specifies external and internal encodings as <tt>'extern:intern'</tt>. + * - +:textmode+: If a truthy value, specifies the mode as text-only, binary otherwise. + * - +:binmode+: If a truthy value, specifies the mode as binary, text-only otherwise. + * - +:autoclose+: If a truthy value, specifies that the +fd+ will close + * when the stream closes; otherwise it remains open. + * - +:path:+ If a string value is provided, it is used in #inspect and is available as + * #path method. + * + * Also available are the options offered in String#encode, + * which may control conversion between external and internal encoding. + * + * == Basic \IO + * + * You can perform basic stream \IO with these methods, + * which typically operate on multi-byte strings: + * + * - IO#read: Reads and returns some or all of the remaining bytes from the stream. + * - IO#write: Writes zero or more strings to the stream; + * each given object that is not already a string is converted via +to_s+. + * + * === Position + * + * An \IO stream has a nonnegative integer _position_, + * which is the byte offset at which the next read or write is to occur. + * A new stream has position zero (and line number zero); + * method +rewind+ resets the position (and line number) to zero. + * + * The relevant methods: + * + * - IO#tell (aliased as +#pos+): Returns the current position (in bytes) in the stream. + * - IO#pos=: Sets the position of the stream to a given integer +new_position+ (in bytes). + * - IO#seek: Sets the position of the stream to a given integer +offset+ (in bytes), + * relative to a given position +whence+ + * (indicating the beginning, end, or current position). + * - IO#rewind: Positions the stream at the beginning (also resetting the line number). + * + * === Open and Closed Streams + * + * A new \IO stream may be open for reading, open for writing, or both. + * + * A stream is automatically closed when claimed by the garbage collector. + * + * Attempted reading or writing on a closed stream raises an exception. + * + * The relevant methods: + * + * - IO#close: Closes the stream for both reading and writing. + * - IO#close_read: Closes the stream for reading. + * - IO#close_write: Closes the stream for writing. + * - IO#closed?: Returns whether the stream is closed. + * + * === End-of-Stream + * + * You can query whether a stream is positioned at its end: + * + * - IO#eof? (also aliased as +#eof+): Returns whether the stream is at end-of-stream. + * + * You can reposition to end-of-stream by using method IO#seek: + * + * f = File.new('t.txt') + * f.eof? # => false + * f.seek(0, :END) + * f.eof? # => true + * f.close + * + * Or by reading all stream content (which is slower than using IO#seek): + * + * f.rewind + * f.eof? # => false + * f.read # => "First line\nSecond line\n\nFourth line\nFifth line\n" + * f.eof? # => true + * + * == Line \IO + * + * \Class \IO supports line-oriented + * {input}[rdoc-ref:IO@Line+Input] and {output}[rdoc-ref:IO@Line+Output] + * + * === Line Input + * + * \Class \IO supports line-oriented input for + * {files}[rdoc-ref:IO@File+Line+Input] and {IO streams}[rdoc-ref:IO@Stream+Line+Input] + * + * ==== \File Line Input + * + * You can read lines from a file using these methods: + * + * - IO.foreach: Reads each line and passes it to the given block. + * - IO.readlines: Reads and returns all lines in an array. + * + * For each of these methods: + * + * - You can specify {open options}[rdoc-ref:IO@Open+Options]. + * - Line parsing depends on the effective <i>line separator</i>; + * see {Line Separator}[rdoc-ref:IO@Line+Separator]. + * - The length of each returned line depends on the effective <i>line limit</i>; + * see {Line Limit}[rdoc-ref:IO@Line+Limit]. + * + * ==== Stream Line Input + * + * You can read lines from an \IO stream using these methods: + * + * - IO#each_line: Reads each remaining line, passing it to the given block. + * - IO#gets: Returns the next line. + * - IO#readline: Like #gets, but raises an exception at end-of-stream. + * - IO#readlines: Returns all remaining lines in an array. + * + * For each of these methods: + * + * - Reading may begin mid-line, + * depending on the stream's _position_; + * see {Position}[rdoc-ref:IO@Position]. + * - Line parsing depends on the effective <i>line separator</i>; + * see {Line Separator}[rdoc-ref:IO@Line+Separator]. + * - The length of each returned line depends on the effective <i>line limit</i>; + * see {Line Limit}[rdoc-ref:IO@Line+Limit]. + * + * ===== Line Separator + * + * Each of the {line input methods}[rdoc-ref:IO@Line+Input] uses a <i>line separator</i>: + * the string that determines what is considered a line; + * it is sometimes called the <i>input record separator</i>. + * + * The default line separator is taken from global variable <tt>$/</tt>, + * whose initial value is <tt>"\n"</tt>. + * + * Generally, the line to be read next is all data + * from the current {position}[rdoc-ref:IO@Position] + * to the next line separator + * (but see {Special Line Separator Values}[rdoc-ref:IO@Special+Line+Separator+Values]): + * + * f = File.new('t.txt') + * # Method gets with no sep argument returns the next line, according to $/. + * f.gets # => "First line\n" + * f.gets # => "Second line\n" + * f.gets # => "\n" + * f.gets # => "Fourth line\n" + * f.gets # => "Fifth line\n" + * f.close + * + * You can use a different line separator by passing argument +sep+: + * + * f = File.new('t.txt') + * f.gets('l') # => "First l" + * f.gets('li') # => "ine\nSecond li" + * f.gets('lin') # => "ne\n\nFourth lin" + * f.gets # => "e\n" + * f.close + * + * Or by setting global variable <tt>$/</tt>: + * + * f = File.new('t.txt') + * $/ = 'l' + * f.gets # => "First l" + * f.gets # => "ine\nSecond l" + * f.gets # => "ine\n\nFourth l" + * f.close + * + * ===== Special Line Separator Values + * + * Each of the {line input methods}[rdoc-ref:IO@Line+Input] + * accepts two special values for parameter +sep+: + * + * - +nil+: The entire stream is to be read ("slurped") into a single string: + * + * f = File.new('t.txt') + * f.gets(nil) # => "First line\nSecond line\n\nFourth line\nFifth line\n" + * f.close + * + * - <tt>''</tt> (the empty string): The next "paragraph" is to be read + * (paragraphs being separated by two consecutive line separators): + * + * f = File.new('t.txt') + * f.gets('') # => "First line\nSecond line\n\n" + * f.gets('') # => "Fourth line\nFifth line\n" + * f.close + * + * ===== Line Limit + * + * Each of the {line input methods}[rdoc-ref:IO@Line+Input] + * uses an integer <i>line limit</i>, + * which restricts the number of bytes that may be returned. + * (A multi-byte character will not be split, and so a returned line may be slightly longer + * than the limit). + * + * The default limit value is <tt>-1</tt>; + * any negative limit value means that there is no limit. + * + * If there is no limit, the line is determined only by +sep+. + * + * # Text with 1-byte characters. + * File.open('t.txt') {|f| f.gets(1) } # => "F" + * File.open('t.txt') {|f| f.gets(2) } # => "Fi" + * File.open('t.txt') {|f| f.gets(3) } # => "Fir" + * File.open('t.txt') {|f| f.gets(4) } # => "Firs" + * # No more than one line. + * File.open('t.txt') {|f| f.gets(10) } # => "First line" + * File.open('t.txt') {|f| f.gets(11) } # => "First line\n" + * File.open('t.txt') {|f| f.gets(12) } # => "First line\n" + * + * # Text with 2-byte characters, which will not be split. + * File.open('t.rus') {|f| f.gets(1).size } # => 1 + * File.open('t.rus') {|f| f.gets(2).size } # => 1 + * File.open('t.rus') {|f| f.gets(3).size } # => 2 + * File.open('t.rus') {|f| f.gets(4).size } # => 2 + * + * ===== Line Separator and Line Limit + * + * With arguments +sep+ and +limit+ given, combines the two behaviors: + * + * - Returns the next line as determined by line separator +sep+. + * - But returns no more bytes than are allowed by the limit +limit+. * * Example: * - * require 'io/console' - * rows, columns = $stdout.winsize - * puts "Your screen is #{columns} wide and #{rows} tall" + * File.open('t.txt') {|f| f.gets('li', 20) } # => "First li" + * File.open('t.txt') {|f| f.gets('li', 2) } # => "Fi" + * + * ===== Line Number + * + * A readable \IO stream has a non-negative integer <i>line number</i>: + * + * - IO#lineno: Returns the line number. + * - IO#lineno=: Resets and returns the line number. + * + * Unless modified by a call to method IO#lineno=, + * the line number is the number of lines read + * by certain line-oriented methods, + * according to the effective {line separator}[rdoc-ref:IO@Line+Separator]: + * + * - IO.foreach: Increments the line number on each call to the block. + * - IO#each_line: Increments the line number on each call to the block. + * - IO#gets: Increments the line number. + * - IO#readline: Increments the line number. + * - IO#readlines: Increments the line number for each line read. + * + * A new stream is initially has line number zero (and position zero); + * method +rewind+ resets the line number (and position) to zero: + * + * f = File.new('t.txt') + * f.lineno # => 0 + * f.gets # => "First line\n" + * f.lineno # => 1 + * f.rewind + * f.lineno # => 0 + * f.close + * + * Reading lines from a stream usually changes its line number: + * + * f = File.new('t.txt', 'r') + * f.lineno # => 0 + * f.readline # => "This is line one.\n" + * f.lineno # => 1 + * f.readline # => "This is the second line.\n" + * f.lineno # => 2 + * f.readline # => "Here's the third line.\n" + * f.lineno # => 3 + * f.eof? # => true + * f.close + * + * Iterating over lines in a stream usually changes its line number: + * + * File.open('t.txt') do |f| + * f.each_line do |line| + * p "position=#{f.pos} eof?=#{f.eof?} lineno=#{f.lineno}" + * end + * end + * + * Output: + * + * "position=11 eof?=false lineno=1" + * "position=23 eof?=false lineno=2" + * "position=24 eof?=false lineno=3" + * "position=36 eof?=false lineno=4" + * "position=47 eof?=true lineno=5" + * + * Unlike the stream's {position}[rdoc-ref:IO@Position], + * the line number does not affect where the next read or write will occur: + * + * f = File.new('t.txt') + * f.lineno = 1000 + * f.lineno # => 1000 + * f.gets # => "First line\n" + * f.lineno # => 1001 + * f.close + * + * Associated with the line number is the global variable <tt>$.</tt>: + * + * - When a stream is opened, <tt>$.</tt> is not set; + * its value is left over from previous activity in the process: + * + * $. = 41 + * f = File.new('t.txt') + * $. = 41 + * # => 41 + * f.close + * + * - When a stream is read, <tt>$.</tt> is set to the line number for that stream: + * + * f0 = File.new('t.txt') + * f1 = File.new('t.dat') + * f0.readlines # => ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"] + * $. # => 5 + * f1.readlines # => ["\xFE\xFF\x99\x90\x99\x91\x99\x92\x99\x93\x99\x94"] + * $. # => 1 + * f0.close + * f1.close + * + * - Methods IO#rewind and IO#seek do not affect <tt>$.</tt>: + * + * f = File.new('t.txt') + * f.readlines # => ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"] + * $. # => 5 + * f.rewind + * f.seek(0, :SET) + * $. # => 5 + * f.close + * + * === Line Output + * + * You can write to an \IO stream line-by-line using this method: + * + * - IO#puts: Writes objects to the stream. + * + * == Character \IO + * + * You can process an \IO stream character-by-character using these methods: + * + * - IO#getc: Reads and returns the next character from the stream. + * - IO#readchar: Like #getc, but raises an exception at end-of-stream. + * - IO#ungetc: Pushes back ("unshifts") a character or integer onto the stream. + * - IO#putc: Writes a character to the stream. + * - IO#each_char: Reads each remaining character in the stream, + * passing the character to the given block. + * == Byte \IO + * + * You can process an \IO stream byte-by-byte using these methods: + * + * - IO#getbyte: Returns the next 8-bit byte as an integer in range 0..255. + * - IO#readbyte: Like #getbyte, but raises an exception if at end-of-stream. + * - IO#ungetbyte: Pushes back ("unshifts") a byte back onto the stream. + * - IO#each_byte: Reads each remaining byte in the stream, + * passing the byte to the given block. + * + * == Codepoint \IO + * + * You can process an \IO stream codepoint-by-codepoint: + * + * - IO#each_codepoint: Reads each remaining codepoint, passing it to the given block. * * == What's Here * * First, what's elsewhere. \Class \IO: * - * - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here]. - * - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here], + * - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here]. + * - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here], * which provides dozens of additional methods. * * Here, class \IO provides methods that are useful for: * - * - {Creating}[#class-IO-label-Creating] - * - {Reading}[#class-IO-label-Reading] - * - {Writing}[#class-IO-label-Writing] - * - {Positioning}[#class-IO-label-Positioning] - * - {Iterating}[#class-IO-label-Iterating] - * - {Settings}[#class-IO-label-Settings] - * - {Querying}[#class-IO-label-Querying] - * - {Buffering}[#class-IO-label-Buffering] - * - {Low-Level Access}[#class-IO-label-Low-Level+Access] - * - {Other}[#class-IO-label-Other] + * - {Creating}[rdoc-ref:IO@Creating] + * - {Reading}[rdoc-ref:IO@Reading] + * - {Writing}[rdoc-ref:IO@Writing] + * - {Positioning}[rdoc-ref:IO@Positioning] + * - {Iterating}[rdoc-ref:IO@Iterating] + * - {Settings}[rdoc-ref:IO@Settings] + * - {Querying}[rdoc-ref:IO@Querying] + * - {Buffering}[rdoc-ref:IO@Buffering] + * - {Low-Level Access}[rdoc-ref:IO@Low-Level+Access] + * - {Other}[rdoc-ref:IO@Other] * * === Creating * - * - ::new (aliased as ::for_fd):: Creates and returns a new \IO object for the given - * integer file descriptor. - * - ::open:: Creates a new \IO object. - * - ::pipe:: Creates a connected pair of reader and writer \IO objects. - * - ::popen:: Creates an \IO object to interact with a subprocess. - * - ::select:: Selects which given \IO instances are ready for reading, + * - ::new (aliased as ::for_fd): Creates and returns a new \IO object for the given + * integer file descriptor. + * - ::open: Creates a new \IO object. + * - ::pipe: Creates a connected pair of reader and writer \IO objects. + * - ::popen: Creates an \IO object to interact with a subprocess. + * - ::select: Selects which given \IO instances are ready for reading, * writing, or have pending exceptions. * * === Reading * - * - ::binread:: Returns a binary string with all or a subset of bytes - * from the given file. - * - ::read:: Returns a string with all or a subset of bytes from the given file. - * - ::readlines:: Returns an array of strings, which are the lines from the given file. - * - #getbyte:: Returns the next 8-bit byte read from +self+ as an integer. - * - #getc:: Returns the next character read from +self+ as a string. - * - #gets:: Returns the line read from +self+. - * - #pread:: Returns all or the next _n_ bytes read from +self+, - * not updating the receiver's offset. - * - #read:: Returns all remaining or the next _n_ bytes read from +self+ - * for a given _n_. - * - #read_nonblock:: the next _n_ bytes read from +self+ for a given _n_, - * in non-block mode. - * - #readbyte:: Returns the next byte read from +self+; - * same as #getbyte, but raises an exception on end-of-file. - * - #readchar:: Returns the next character read from +self+; - * same as #getc, but raises an exception on end-of-file. - * - #readline:: Returns the next line read from +self+; - * same as #getline, but raises an exception of end-of-file. - * - #readlines:: Returns an array of all lines read read from +self+. - * - #readpartial:: Returns up to the given number of bytes from +self+. + * - ::binread: Returns a binary string with all or a subset of bytes + * from the given file. + * - ::read: Returns a string with all or a subset of bytes from the given file. + * - ::readlines: Returns an array of strings, which are the lines from the given file. + * - #getbyte: Returns the next 8-bit byte read from +self+ as an integer. + * - #getc: Returns the next character read from +self+ as a string. + * - #gets: Returns the line read from +self+. + * - #pread: Returns all or the next _n_ bytes read from +self+, + * not updating the receiver's offset. + * - #read: Returns all remaining or the next _n_ bytes read from +self+ + * for a given _n_. + * - #read_nonblock: the next _n_ bytes read from +self+ for a given _n_, + * in non-block mode. + * - #readbyte: Returns the next byte read from +self+; + * same as #getbyte, but raises an exception on end-of-stream. + * - #readchar: Returns the next character read from +self+; + * same as #getc, but raises an exception on end-of-stream. + * - #readline: Returns the next line read from +self+; + * same as #getline, but raises an exception of end-of-stream. + * - #readlines: Returns an array of all lines read read from +self+. + * - #readpartial: Returns up to the given number of bytes from +self+. * * === Writing * - * - ::binwrite:: Writes the given string to the file at the given filepath, - in binary mode. - * - ::write:: Writes the given string to +self+. - * - {::<<}[#method-i-3C-3C]:: Appends the given string to +self+. - * - #print:: Prints last read line or given objects to +self+. - * - #printf:: Writes to +self+ based on the given format string and objects. - * - #putc:: Writes a character to +self+. - * - #puts:: Writes lines to +self+, making sure line ends with a newline. - * - #pwrite:: Writes the given string at the given offset, - * not updating the receiver's offset. - * - #write:: Writes one or more given strings to +self+. - * - #write_nonblock:: Writes one or more given strings to +self+ in non-blocking mode. + * - ::binwrite: Writes the given string to the file at the given filepath, + * in binary mode. + * - ::write: Writes the given string to +self+. + * - #<<: Appends the given string to +self+. + * - #print: Prints last read line or given objects to +self+. + * - #printf: Writes to +self+ based on the given format string and objects. + * - #putc: Writes a character to +self+. + * - #puts: Writes lines to +self+, making sure line ends with a newline. + * - #pwrite: Writes the given string at the given offset, + * not updating the receiver's offset. + * - #write: Writes one or more given strings to +self+. + * - #write_nonblock: Writes one or more given strings to +self+ in non-blocking mode. * * === Positioning * - * - #lineno:: Returns the current line number in +self+. - * - #lineno=:: Sets the line number is +self+. - * - #pos (aliased as #tell):: Returns the current byte offset in +self+. - * - #pos=:: Sets the byte offset in +self+. - * - #reopen:: Reassociates +self+ with a new or existing \IO stream. - * - #rewind:: Positions +self+ to the beginning of input. - * - #seek:: Sets the offset for +self+ relative to given position. + * - #lineno: Returns the current line number in +self+. + * - #lineno=: Sets the line number is +self+. + * - #pos (aliased as #tell): Returns the current byte offset in +self+. + * - #pos=: Sets the byte offset in +self+. + * - #reopen: Reassociates +self+ with a new or existing \IO stream. + * - #rewind: Positions +self+ to the beginning of input. + * - #seek: Sets the offset for +self+ relative to given position. * * === Iterating * - * - ::foreach:: Yields each line of given file to the block. - * - #each (aliased as #each_line):: Calls the given block - * with each successive line in +self+. - * - #each_byte:: Calls the given block with each successive byte in +self+ - * as an integer. - * - #each_char:: Calls the given block with each successive character in +self+ - * as a string. - * - #each_codepoint:: Calls the given block with each successive codepoint in +self+ - * as an integer. + * - ::foreach: Yields each line of given file to the block. + * - #each (aliased as #each_line): Calls the given block + * with each successive line in +self+. + * - #each_byte: Calls the given block with each successive byte in +self+ + * as an integer. + * - #each_char: Calls the given block with each successive character in +self+ + * as a string. + * - #each_codepoint: Calls the given block with each successive codepoint in +self+ + * as an integer. * * === Settings * - * - #autoclose=:: Sets whether +self+ auto-closes. - * - #binmode:: Sets +self+ to binary mode. - * - #close:: Closes +self+. - * - #close_on_exec=:: Sets the close-on-exec flag. - * - #close_read:: Closes +self+ for reading. - * - #close_write:: Closes +self+ for writing. - * - #set_encoding:: Sets the encoding for +self+. - * - #set_encoding_by_bom:: Sets the encoding for +self+, based on its - * Unicode byte-order-mark. - * - #sync=:: Sets the sync-mode to the given value. + * - #autoclose=: Sets whether +self+ auto-closes. + * - #binmode: Sets +self+ to binary mode. + * - #close: Closes +self+. + * - #close_on_exec=: Sets the close-on-exec flag. + * - #close_read: Closes +self+ for reading. + * - #close_write: Closes +self+ for writing. + * - #set_encoding: Sets the encoding for +self+. + * - #set_encoding_by_bom: Sets the encoding for +self+, based on its + * Unicode byte-order-mark. + * - #sync=: Sets the sync-mode to the given value. * * === Querying * - * - #autoclose?:: Returns whether +self+ auto-closes. - * - #binmode?:: Returns whether +self+ is in binary mode. - * - #close_on_exec?:: Returns the close-on-exec flag for +self+. - * - #closed?:: Returns whether +self+ is closed. - * - #eof? (aliased as #eof):: Returns whether +self+ is at end-of-file. - * - #external_encoding:: Returns the external encoding object for +self+. - * - #fileno (aliased as #to_i):: Returns the integer file descriptor for +self+ - * - #internal_encoding:: Returns the internal encoding object for +self+. - * - #pid:: Returns the process ID of a child process associated with +self+, - * if +self+ was created by ::popen. - * - #stat:: Returns the File::Stat object containing status information for +self+. - * - #sync:: Returns whether +self+ is in sync-mode. - * - #tty (aliased as #isatty):: Returns whether +self+ is a terminal. + * - #autoclose?: Returns whether +self+ auto-closes. + * - #binmode?: Returns whether +self+ is in binary mode. + * - #close_on_exec?: Returns the close-on-exec flag for +self+. + * - #closed?: Returns whether +self+ is closed. + * - #eof? (aliased as #eof): Returns whether +self+ is at end-of-stream. + * - #external_encoding: Returns the external encoding object for +self+. + * - #fileno (aliased as #to_i): Returns the integer file descriptor for +self+ + * - #internal_encoding: Returns the internal encoding object for +self+. + * - #pid: Returns the process ID of a child process associated with +self+, + * if +self+ was created by ::popen. + * - #stat: Returns the File::Stat object containing status information for +self+. + * - #sync: Returns whether +self+ is in sync-mode. + * - #tty? (aliased as #isatty): Returns whether +self+ is a terminal. * * === Buffering * - * - #fdatasync:: Immediately writes all buffered data in +self+ to disk. - * - #flush:: Flushes any buffered data within +self+ to the underlying - * operating system. - * - #fsync:: Immediately writes all buffered data and attributes in +self+ to disk. - * - #ungetbyte:: Prepends buffer for +self+ with given integer byte or string. - * - #ungetc:: Prepends buffer for +self+ with given string. + * - #fdatasync: Immediately writes all buffered data in +self+ to disk. + * - #flush: Flushes any buffered data within +self+ to the underlying + * operating system. + * - #fsync: Immediately writes all buffered data and attributes in +self+ to disk. + * - #ungetbyte: Prepends buffer for +self+ with given integer byte or string. + * - #ungetc: Prepends buffer for +self+ with given string. * * === Low-Level Access * - * - ::sysopen:: Opens the file given by its path, - * returning the integer file descriptor. - * - #advise:: Announces the intention to access data from +self+ in a specific way. - * - #fcntl:: Passes a low-level command to the file specified - * by the given file descriptor. - * - #ioctl:: Passes a low-level command to the device specified - * by the given file descriptor. - * - #sysread:: Returns up to the next _n_ bytes read from self using a low-level read. - * - #sysseek:: Sets the offset for +self+. - * - #syswrite:: Writes the given string to +self+ using a low-level write. + * - ::sysopen: Opens the file given by its path, + * returning the integer file descriptor. + * - #advise: Announces the intention to access data from +self+ in a specific way. + * - #fcntl: Passes a low-level command to the file specified + * by the given file descriptor. + * - #ioctl: Passes a low-level command to the device specified + * by the given file descriptor. + * - #sysread: Returns up to the next _n_ bytes read from self using a low-level read. + * - #sysseek: Sets the offset for +self+. + * - #syswrite: Writes the given string to +self+ using a low-level write. * * === Other * - * - ::copy_stream:: Copies data from a source to a destination, - * each of which is a filepath or an \IO-like object. - * - ::try_convert:: Returns a new \IO object resulting from converting - * the given object. - * - #inspect:: Returns the string representation of +self+. + * - ::copy_stream: Copies data from a source to a destination, + * each of which is a filepath or an \IO-like object. + * - ::try_convert: Returns a new \IO object resulting from converting + * the given object. + * - #inspect: Returns the string representation of +self+. * */ @@ -13649,11 +15518,11 @@ Init_IO(void) #include <sys/cygwin.h> static struct __cygwin_perfile pf[] = { - {"", O_RDONLY | O_BINARY}, - {"", O_WRONLY | O_BINARY}, - {"", O_RDWR | O_BINARY}, - {"", O_APPEND | O_BINARY}, - {NULL, 0} + {"", O_RDONLY | O_BINARY}, + {"", O_WRONLY | O_BINARY}, + {"", O_RDWR | O_BINARY}, + {"", O_APPEND | O_BINARY}, + {NULL, 0} }; cygwin_internal(CW_PERFILE, pf); #endif @@ -13667,6 +15536,7 @@ Init_IO(void) id_flush = rb_intern_const("flush"); id_readpartial = rb_intern_const("readpartial"); id_set_encoding = rb_intern_const("set_encoding"); + id_fileno = rb_intern_const("fileno"); rb_define_global_function("syscall", rb_f_syscall, -1); @@ -13689,8 +15559,14 @@ Init_IO(void) rb_cIO = rb_define_class("IO", rb_cObject); rb_include_module(rb_cIO, rb_mEnumerable); + /* Can be raised by IO operations when IO#timeout= is set. */ + rb_eIOTimeoutError = rb_define_class_under(rb_cIO, "TimeoutError", rb_eIOError); + + /* Readable event mask for IO#wait. */ rb_define_const(rb_cIO, "READABLE", INT2NUM(RUBY_IO_READABLE)); + /* Writable event mask for IO#wait. */ rb_define_const(rb_cIO, "WRITABLE", INT2NUM(RUBY_IO_WRITABLE)); + /* Priority event mask for IO#wait. */ rb_define_const(rb_cIO, "PRIORITY", INT2NUM(RUBY_IO_PRIORITY)); /* exception to wait for reading. see IO.select. */ @@ -13753,7 +15629,7 @@ Init_IO(void) rb_define_hooked_variable("$,", &rb_output_fs, 0, deprecated_str_setter); rb_default_rs = rb_fstring_lit("\n"); /* avoid modifying RS_default */ - rb_gc_register_mark_object(rb_default_rs); + rb_vm_register_global_object(rb_default_rs); rb_rs = rb_default_rs; rb_output_rs = Qnil; rb_define_hooked_variable("$/", &rb_rs, 0, deprecated_str_setter); @@ -13787,23 +15663,25 @@ Init_IO(void) rb_define_alias(rb_cIO, "to_i", "fileno"); rb_define_method(rb_cIO, "to_io", rb_io_to_io, 0); - rb_define_method(rb_cIO, "fsync", rb_io_fsync, 0); - rb_define_method(rb_cIO, "fdatasync", rb_io_fdatasync, 0); - rb_define_method(rb_cIO, "sync", rb_io_sync, 0); - rb_define_method(rb_cIO, "sync=", rb_io_set_sync, 1); + rb_define_method(rb_cIO, "timeout", rb_io_timeout, 0); + rb_define_method(rb_cIO, "timeout=", rb_io_set_timeout, 1); - rb_define_method(rb_cIO, "lineno", rb_io_lineno, 0); - rb_define_method(rb_cIO, "lineno=", rb_io_set_lineno, 1); + rb_define_method(rb_cIO, "fsync", rb_io_fsync, 0); + rb_define_method(rb_cIO, "fdatasync", rb_io_fdatasync, 0); + rb_define_method(rb_cIO, "sync", rb_io_sync, 0); + rb_define_method(rb_cIO, "sync=", rb_io_set_sync, 1); - rb_define_method(rb_cIO, "readlines", rb_io_readlines, -1); + rb_define_method(rb_cIO, "lineno", rb_io_lineno, 0); + rb_define_method(rb_cIO, "lineno=", rb_io_set_lineno, 1); - rb_define_method(rb_cIO, "readpartial", io_readpartial, -1); - rb_define_method(rb_cIO, "read", io_read, -1); + rb_define_method(rb_cIO, "readlines", rb_io_readlines, -1); + + rb_define_method(rb_cIO, "readpartial", io_readpartial, -1); + rb_define_method(rb_cIO, "read", io_read, -1); rb_define_method(rb_cIO, "write", io_write_m, -1); - rb_define_method(rb_cIO, "gets", rb_io_gets_m, -1); - rb_define_method(rb_cIO, "readline", rb_io_readline, -1); - rb_define_method(rb_cIO, "getc", rb_io_getc, 0); - rb_define_method(rb_cIO, "getbyte", rb_io_getbyte, 0); + rb_define_method(rb_cIO, "gets", rb_io_gets_m, -1); + rb_define_method(rb_cIO, "getc", rb_io_getc, 0); + rb_define_method(rb_cIO, "getbyte", rb_io_getbyte, 0); rb_define_method(rb_cIO, "readchar", rb_io_readchar, 0); rb_define_method(rb_cIO, "readbyte", rb_io_readbyte, 0); rb_define_method(rb_cIO, "ungetbyte",rb_io_ungetbyte, 1); @@ -13836,7 +15714,7 @@ Init_IO(void) rb_define_method(rb_cIO, "close_on_exec=", rb_io_set_close_on_exec, 1); rb_define_method(rb_cIO, "close", rb_io_close_m, 0); - rb_define_method(rb_cIO, "closed?", rb_io_closed, 0); + rb_define_method(rb_cIO, "closed?", rb_io_closed_p, 0); rb_define_method(rb_cIO, "close_read", rb_io_close_read, 0); rb_define_method(rb_cIO, "close_write", rb_io_close_write, 0); @@ -13850,6 +15728,10 @@ Init_IO(void) rb_define_method(rb_cIO, "ioctl", rb_io_ioctl, -1); rb_define_method(rb_cIO, "fcntl", rb_io_fcntl, -1); rb_define_method(rb_cIO, "pid", rb_io_pid, 0); + + rb_define_method(rb_cIO, "path", rb_io_path, 0); + rb_define_method(rb_cIO, "to_path", rb_io_path, 0); + rb_define_method(rb_cIO, "inspect", rb_io_inspect, 0); rb_define_method(rb_cIO, "external_encoding", rb_io_external_encoding, 0); @@ -13860,6 +15742,12 @@ Init_IO(void) rb_define_method(rb_cIO, "autoclose?", rb_io_autoclose_p, 0); rb_define_method(rb_cIO, "autoclose=", rb_io_set_autoclose, 1); + rb_define_method(rb_cIO, "wait", io_wait, -1); + + rb_define_method(rb_cIO, "wait_readable", io_wait_readable, -1); + rb_define_method(rb_cIO, "wait_writable", io_wait_writable, -1); + rb_define_method(rb_cIO, "wait_priority", io_wait_priority, -1); + rb_define_virtual_variable("$stdin", stdin_getter, stdin_setter); rb_define_virtual_variable("$stdout", stdout_getter, stdout_setter); rb_define_virtual_variable("$>", stdout_getter, stdout_setter); @@ -13870,13 +15758,12 @@ Init_IO(void) rb_gvar_ractor_local("$>"); rb_gvar_ractor_local("$stderr"); - rb_stdin = rb_io_prep_stdin(); - rb_stdout = rb_io_prep_stdout(); - rb_stderr = rb_io_prep_stderr(); - rb_global_variable(&rb_stdin); + rb_stdin = rb_io_prep_stdin(); rb_global_variable(&rb_stdout); + rb_stdout = rb_io_prep_stdout(); rb_global_variable(&rb_stderr); + rb_stderr = rb_io_prep_stderr(); orig_stdout = rb_stdout; orig_stderr = rb_stderr; @@ -13936,7 +15823,7 @@ Init_IO(void) rb_define_method(rb_cARGF, "binmode", argf_binmode_m, 0); rb_define_method(rb_cARGF, "binmode?", argf_binmode_p, 0); - rb_define_method(rb_cARGF, "write", argf_write, 1); + rb_define_method(rb_cARGF, "write", argf_write, -1); rb_define_method(rb_cARGF, "print", rb_io_print, -1); rb_define_method(rb_cARGF, "putc", rb_io_putc, 1); rb_define_method(rb_cARGF, "puts", rb_io_puts, -1); |