io-console 0.5.6 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 823fa2d6014a030a75d08f381bfad31a713e5df4202b627312214b3f0c1d7885
-  data.tar.gz: 557347a5cbf21d2a5f8ca52c06c53d774f88905642b2dcd43b176809a1e16d06
+  metadata.gz: a402e8ba6c8522b3b423e828a4575da34a084c97a5e6d27cbed65e35695a9c9e
+  data.tar.gz: 50fa0e88472bcdd8f3242c3957c8ed7c39d5f6c6f41f3d7db48a0eaf73cc64f2
 SHA512:
-  metadata.gz: cd2b8410bc0c0310e6961ff6883c794d672bf6ed1a2898e21ab44383ca863bc54a859931623a33548c120b7830d6309f5bc971f4d5e52777857958893687abcc
-  data.tar.gz: fb798eaa2a77a7efa26c433b7481a706f27b020259dc64caa01a87185d755a8078ac63a7987c6b37caf916836d1b8342f7e5bd520cdee5ae921b7e864c08cfed
+  metadata.gz: 6b190b4fb0d1dedaccc0613754d8c656f65dfa3766ac04624d0a0fd1943339a61aee118beed8be1274de764bfc8404697a303da30300377381d521fbc2d77acf
+  data.tar.gz: 70a62bd336c53ccd8ae25bacc7bb5a8d7a26d0d5eabcd26ee9541137f8d86345159f134d5f04bde13be0486d057ab7bdbbf2a3667d88b92b6350b6543de12c11

data/README.md

@@ -27,7 +27,7 @@ IO.console      -> #<File:/dev/tty>
 IO.console(sym, *args)
 ```
 
-Returns an File instance opened console.
+Returns a File instance opened console.
 
 If `sym` is given, it will be sent to the opened console with `args` and the result will be returned instead of the console IO itself.
 

data/ext/io/console/console.c

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- c-file-style: "ruby"; indent-tabs-mode: t -*- */
 /*
  * console IO module
  */
@@ -77,10 +77,23 @@ getattr(int fd, conmode *t)
 
 static ID id_getc, id_console, id_close, id_min, id_time, id_intr;
 #if ENABLE_IO_GETPASS
-static ID id_gets;
+static ID id_gets, id_chomp_bang;
 #endif
 
+#if defined HAVE_RUBY_FIBER_SCHEDULER_H
+# include "ruby/fiber/scheduler.h"
+#elif defined HAVE_RB_SCHEDULER_TIMEOUT
+extern VALUE rb_scheduler_timeout(struct timeval *timeout);
+# define rb_fiber_scheduler_make_timeout rb_scheduler_timeout
+#endif
+
+#define sys_fail_fptr(fptr) rb_sys_fail_str((fptr)->pathv)
+
 #ifndef HAVE_RB_F_SEND
+#ifndef RB_PASS_CALLED_KEYWORDS
+# define rb_funcallv_kw(recv, mid, arg, argv, kw_splat) rb_funcallv(recv, mid, arg, argv)
+#endif
+
 static ID id___send__;
 
 static VALUE
@@ -95,7 +108,7 @@ rb_f_send(int argc, VALUE *argv, VALUE recv)
     else {
 	vid = id___send__;
     }
-    return rb_funcallv(recv, vid, argc, argv);
+    return rb_funcallv_kw(recv, vid, argc, argv, RB_PASS_CALLED_KEYWORDS);
 }
 #endif
 
@@ -410,9 +423,9 @@ console_set_raw(int argc, VALUE *argv, VALUE io)
 
     GetOpenFile(io, fptr);
     fd = GetReadFD(fptr);
-    if (!getattr(fd, &t)) rb_sys_fail(0);
+    if (!getattr(fd, &t)) sys_fail_fptr(fptr);
     set_rawmode(&t, optp);
-    if (!setattr(fd, &t)) rb_sys_fail(0);
+    if (!setattr(fd, &t)) sys_fail_fptr(fptr);
     return io;
 }
 
@@ -453,9 +466,9 @@ console_set_cooked(VALUE io)
 
     GetOpenFile(io, fptr);
     fd = GetReadFD(fptr);
-    if (!getattr(fd, &t)) rb_sys_fail(0);
+    if (!getattr(fd, &t)) sys_fail_fptr(fptr);
     set_cookedmode(&t, NULL);
-    if (!setattr(fd, &t)) rb_sys_fail(0);
+    if (!setattr(fd, &t)) sys_fail_fptr(fptr);
     return io;
 }
 
@@ -508,28 +521,50 @@ console_getch(int argc, VALUE *argv, VALUE io)
     rb_io_t *fptr;
     VALUE str;
     wint_t c;
-    int w, len;
+    int len;
     char buf[8];
     wint_t wbuf[2];
+# ifndef HAVE_RB_IO_WAIT
     struct timeval *to = NULL, tv;
+# else
+    VALUE timeout = Qnil;
+# endif
 
     GetOpenFile(io, fptr);
     if (optp) {
 	if (optp->vtime) {
+# ifndef HAVE_RB_IO_WAIT
 	    to = &tv;
+# else
+	    struct timeval tv;
+# endif
 	    tv.tv_sec = optp->vtime / 10;
 	    tv.tv_usec = (optp->vtime % 10) * 100000;
+# ifdef HAVE_RB_IO_WAIT
+	    timeout = rb_fiber_scheduler_make_timeout(&tv);
+# endif
 	}
-	if (optp->vmin != 1) {
-	    rb_warning("min option ignored");
+	switch (optp->vmin) {
+	  case 1: /* default */
+	    break;
+	  case 0: /* return nil when timed out */
+	    if (optp->vtime) break;
+	    /* fallthru */
+	  default:
+	    rb_warning("min option larger than 1 ignored");
 	}
 	if (optp->intr) {
-	    w = rb_wait_for_single_fd(fptr->fd, RB_WAITFD_IN, to);
+# ifndef HAVE_RB_IO_WAIT
+	    int w = rb_wait_for_single_fd(fptr->fd, RB_WAITFD_IN, to);
 	    if (w < 0) rb_eof_error();
 	    if (!(w & RB_WAITFD_IN)) return Qnil;
+# else
+	    VALUE result = rb_io_wait(io, RB_INT2NUM(RUBY_IO_READABLE), timeout);
+	    if (!RTEST(result)) return Qnil;
+# endif
 	}
-	else {
-	    rb_warning("vtime option ignored if intr flag is unset");
+	else if (optp->vtime) {
+	    rb_warning("Non-zero vtime option ignored if intr flag is unset");
 	}
     }
     len = (int)(VALUE)rb_thread_call_without_gvl(nogvl_getch, wbuf, RUBY_UBF_IO, 0);
@@ -590,12 +625,12 @@ console_set_echo(VALUE io, VALUE f)
 
     GetOpenFile(io, fptr);
     fd = GetReadFD(fptr);
-    if (!getattr(fd, &t)) rb_sys_fail(0);
+    if (!getattr(fd, &t)) sys_fail_fptr(fptr);
     if (RTEST(f))
 	set_echo(&t, NULL);
     else
 	set_noecho(&t, NULL);
-    if (!setattr(fd, &t)) rb_sys_fail(0);
+    if (!setattr(fd, &t)) sys_fail_fptr(fptr);
     return io;
 }
 
@@ -616,7 +651,7 @@ console_echo_p(VALUE io)
 
     GetOpenFile(io, fptr);
     fd = GetReadFD(fptr);
-    if (!getattr(fd, &t)) rb_sys_fail(0);
+    if (!getattr(fd, &t)) sys_fail_fptr(fptr);
     return echo_p(&t) ? Qtrue : Qfalse;
 }
 
@@ -700,7 +735,7 @@ console_conmode_get(VALUE io)
 
     GetOpenFile(io, fptr);
     fd = GetReadFD(fptr);
-    if (!getattr(fd, &t)) rb_sys_fail(0);
+    if (!getattr(fd, &t)) sys_fail_fptr(fptr);
 
     return conmode_new(cConmode, &t);
 }
@@ -724,7 +759,7 @@ console_conmode_set(VALUE io, VALUE mode)
     r = *t;
     GetOpenFile(io, fptr);
     fd = GetReadFD(fptr);
-    if (!setattr(fd, &r)) rb_sys_fail(0);
+    if (!setattr(fd, &r)) sys_fail_fptr(fptr);
 
     return mode;
 }
@@ -766,7 +801,7 @@ console_winsize(VALUE io)
 
     GetOpenFile(io, fptr);
     fd = GetWriteFD(fptr);
-    if (!getwinsize(fd, &ws)) rb_sys_fail(0);
+    if (!getwinsize(fd, &ws)) sys_fail_fptr(fptr);
     return rb_assoc_new(INT2NUM(winsize_row(&ws)), INT2NUM(winsize_col(&ws)));
 }
 
@@ -813,7 +848,7 @@ console_set_winsize(VALUE io, VALUE size)
     SET(xpixel);
     SET(ypixel);
 #undef SET
-    if (!setwinsize(fd, &ws)) rb_sys_fail(0);
+    if (!setwinsize(fd, &ws)) sys_fail_fptr(fptr);
 #elif defined _WIN32
     wh = (HANDLE)rb_w32_get_osfhandle(fd);
 #define SET(m) new##m = NIL_P(m) ? 0 : (unsigned short)NUM2UINT(m)
@@ -888,7 +923,7 @@ console_iflush(VALUE io)
     GetOpenFile(io, fptr);
     fd = GetReadFD(fptr);
 #if defined HAVE_TERMIOS_H || defined HAVE_TERMIO_H
-    if (tcflush(fd, TCIFLUSH)) rb_sys_fail(0);
+    if (tcflush(fd, TCIFLUSH)) sys_fail_fptr(fptr);
 #endif
     (void)fd;
     return io;
@@ -911,7 +946,7 @@ console_oflush(VALUE io)
     GetOpenFile(io, fptr);
     fd = GetWriteFD(fptr);
 #if defined HAVE_TERMIOS_H || defined HAVE_TERMIO_H
-    if (tcflush(fd, TCOFLUSH)) rb_sys_fail(0);
+    if (tcflush(fd, TCOFLUSH)) sys_fail_fptr(fptr);
 #endif
     (void)fd;
     return io;
@@ -938,11 +973,11 @@ console_ioflush(VALUE io)
     fd1 = GetReadFD(fptr);
     fd2 = GetWriteFD(fptr);
     if (fd2 != -1 && fd1 != fd2) {
-	if (tcflush(fd1, TCIFLUSH)) rb_sys_fail(0);
-	if (tcflush(fd2, TCOFLUSH)) rb_sys_fail(0);
+	if (tcflush(fd1, TCIFLUSH)) sys_fail_fptr(fptr);
+	if (tcflush(fd2, TCOFLUSH)) sys_fail_fptr(fptr);
     }
     else {
-	if (tcflush(fd1, TCIOFLUSH)) rb_sys_fail(0);
+	if (tcflush(fd1, TCIOFLUSH)) sys_fail_fptr(fptr);
     }
 #endif
     return io;
@@ -961,7 +996,7 @@ console_beep(VALUE io)
     MessageBeep(0);
 #else
     if (write(fd, "\a", 1) < 0)
-	rb_sys_fail(0);
+	sys_fail_fptr(fptr);
 #endif
     return io;
 }
@@ -1195,8 +1230,8 @@ console_key_pressed_p(VALUE io, VALUE k)
 }
 #else
 struct query_args {
-    const char *qstr;
-    int opt;
+    char qstr[6];
+    unsigned char opt;
 };
 
 static int
@@ -1534,7 +1569,7 @@ static VALUE
 str_chomp(VALUE str)
 {
     if (!NIL_P(str)) {
-	str = rb_funcallv(str, rb_intern("chomp!"), 0, 0);
+	rb_funcallv(str, id_chomp_bang, 0, 0);
     }
     return str;
 }
@@ -1546,6 +1581,10 @@ str_chomp(VALUE str)
  * Reads and returns a line without echo back.
  * Prints +prompt+ unless it is +nil+.
  *
+ * The newline character that terminates the
+ * read line is removed from the returned string,
+ * see String#chomp!.
+ *
  * You must require 'io/console' to use this method.
  */
 static VALUE
@@ -1590,6 +1629,7 @@ Init_console(void)
     id_getc = rb_intern("getc");
 #if ENABLE_IO_GETPASS
     id_gets = rb_intern("gets");
+    id_chomp_bang = rb_intern("chomp!");
 #endif
     id_console = rb_intern("console");
     id_close = rb_intern("close");

data/ext/io/console/extconf.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: false
 require 'mkmf'
 
-ok = true if RUBY_ENGINE == "ruby"
+ok = true if RUBY_ENGINE == "ruby" || RUBY_ENGINE == "truffleruby"
 hdr = nil
 case
 when macro_defined?("_WIN32", "")
@@ -24,6 +24,11 @@ when true
   # rb_funcallv: 2.1.0
   # RARRAY_CONST_PTR: 2.1.0
   # rb_sym2str: 2.2.0
+  if have_macro("HAVE_RUBY_FIBER_SCHEDULER_H")
+    $defs << "-D""HAVE_RB_IO_WAIT=1"
+  elsif have_func("rb_scheduler_timeout") # 3.0
+    have_func("rb_io_wait")
+  end
   $defs << "-D""ENABLE_IO_GETPASS=1"
   create_makefile("io/console") {|conf|
     conf << "\n""VK_HEADER = #{vk_header}\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io-console
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.11
 platform: ruby
 authors:
 - Nobu Nakada
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies: []
 description: add console capabilities to IO instances.
 email: nobu@ruby-lang.org
@@ -25,10 +25,11 @@ files:
 - lib/io/console/size.rb
 homepage: https://github.com/ruby/io-console
 licenses:
+- Ruby
 - BSD-2-Clause
 metadata:
   source_code_url: https://github.com/ruby/io-console
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -36,15 +37,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.pre1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Console interface
 test_files: []