io-console 0.5.4 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31d79d8c0729bc693338a79041f2a32b412b556ee9c53b27a8f64187f1d47202
-  data.tar.gz: b0a73452d3fb90e791ce1b5fa8e3ad3f7656b3826bc39a0260632c4ff8db150c
+  metadata.gz: d4124dc490e2ac47dda9ad9283023351e95d781ac40af9a22f012a25c3b3eb15
+  data.tar.gz: 9ff304d0831ef2d5486f02c5da57fbe91ae960c4d3f1f28057e8e55a7fc7507a
 SHA512:
-  metadata.gz: b4b97beb4cb0b4f3692a26d0ca06eb78f21672426a01848a3a73182d01ea037d7d7ff2bb9b792eacc2e436620a18ce9b7d4c87709b4449cd5293ae96ffdb8281
-  data.tar.gz: 26330a319d0b643d991bbcbacbef03456000133bcf4adb1ad74500b792dbd84aa512f78e273876bcface1114884b2decaf9ecafbb5e24dbb739cab54b5b36209
+  metadata.gz: c8f277a43454e22b0c43beee7eba4069eac9db3b369a4ce0799259d482606a212fbb1d3deae07031703840add83fd5561dfe7170bc62f60675aabf695613e493
+  data.tar.gz: dfe52d8ca7becd7cf2aa8a27a56702380c1723bfd12393583cff7ad04c2996671b669476d8fd506c3e703d30b75c4084467ffcb8b0fcd7fe6e2be424f9d57c11

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,9 +77,18 @@ 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
 static ID id___send__;
 
@@ -111,6 +120,9 @@ rawmode_opt(int *argcp, VALUE *argv, int min_argc, int max_argc, rawmode_arg_t *
     int argc = *argcp;
     rawmode_arg_t *optp = NULL;
     VALUE vopts = Qnil;
+#ifdef RB_SCAN_ARGS_PASS_CALLED_KEYWORDS
+    argc = rb_scan_args(argc, argv, "*:", NULL, &vopts);
+#else
     if (argc > min_argc)  {
 	vopts = rb_check_hash_type(argv[argc-1]);
 	if (!NIL_P(vopts)) {
@@ -120,6 +132,7 @@ rawmode_opt(int *argcp, VALUE *argv, int min_argc, int max_argc, rawmode_arg_t *
 	    if (!vopts) vopts = Qnil;
 	}
     }
+#endif
     rb_check_arity(argc, min_argc, max_argc);
     if (!NIL_P(vopts)) {
 	VALUE vmin = rb_hash_aref(vopts, ID2SYM(id_min));
@@ -190,6 +203,7 @@ set_rawmode(conmode *t, void *arg)
 	if (r->intr) {
 	    t->c_iflag |= BRKINT;
 	    t->c_lflag |= ISIG;
+	    t->c_oflag |= OPOST;
 	}
 #endif
 	(void)r;
@@ -355,9 +369,9 @@ ttymode_with_io(VALUE io, VALUE (*func)(VALUE, VALUE), VALUE farg, void (*setter
 
 /*
  * call-seq:
- *   io.raw(min: nil, time: nil) {|io| }
+ *   io.raw(min: nil, time: nil, intr: nil) {|io| }
  *
- * Yields +self+ within raw mode.
+ * Yields +self+ within raw mode, and returns the result of the block.
  *
  *   STDIN.raw(&:gets)
  *
@@ -369,6 +383,9 @@ ttymode_with_io(VALUE io, VALUE (*func)(VALUE, VALUE), VALUE farg, void (*setter
  * The parameter +time+ specifies the timeout in _seconds_ with a
  * precision of 1/10 of a second. (default: 0)
  *
+ * If the parameter +intr+ is +true+, enables break, interrupt, quit,
+ * and suspend special characters.
+ *
  * Refer to the manual page of termios for further details.
  *
  * You must require 'io/console' to use this method.
@@ -382,11 +399,11 @@ console_raw(int argc, VALUE *argv, VALUE io)
 
 /*
  * call-seq:
- *   io.raw!(min: nil, time: nil)
+ *   io.raw!(min: nil, time: nil, intr: nil) -> io
  *
- * Enables raw mode.
+ * Enables raw mode, and returns +io+.
  *
- * If the terminal mode needs to be back, use io.raw { ... }.
+ * If the terminal mode needs to be back, use <code>io.raw { ... }</code>.
  *
  * See IO#raw for details on the parameters.
  *
@@ -402,9 +419,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;
 }
 
@@ -445,9 +462,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;
 }
 
@@ -482,7 +499,7 @@ nogvl_getch(void *p)
 
 /*
  * call-seq:
- *   io.getch(min: nil, time: nil)       -> char
+ *   io.getch(min: nil, time: nil, intr: nil) -> char
  *
  * Reads and returns a character in raw mode.
  *
@@ -500,28 +517,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, RUBY_IO_READABLE, timeout);
+	    if (result == Qfalse) 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);
@@ -582,12 +621,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;
 }
 
@@ -608,7 +647,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;
 }
 
@@ -692,7 +731,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);
 }
@@ -716,7 +755,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;
 }
@@ -758,7 +797,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)));
 }
 
@@ -805,7 +844,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)
@@ -880,7 +919,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;
@@ -903,7 +942,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;
@@ -930,11 +969,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;
@@ -953,7 +992,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;
 }
@@ -1187,8 +1226,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
@@ -1489,7 +1528,7 @@ console_dev(int argc, VALUE *argv, VALUE klass)
 
 /*
  * call-seq:
- *   io.getch(min: nil, time: nil)       -> char
+ *   io.getch(min: nil, time: nil, intr: nil) -> char
  *
  * See IO#getch.
  */
@@ -1526,7 +1565,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;
 }
@@ -1538,6 +1577,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
@@ -1582,6 +1625,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
+ok = true if RUBY_ENGINE == "ruby" || RUBY_ENGINE == "truffleruby"
 hdr = nil
 case
 when macro_defined?("_WIN32", "")
@@ -14,8 +14,9 @@ when have_header(hdr = "sgtty.h")
   %w"stty gtty".each {|f| have_func(f, hdr)}
 else
   ok = false
-end
-if ok
+end if ok
+case ok
+when true
   have_header("sys/ioctl.h") if hdr
   # rb_check_hash_type: 1.9.3
   # rb_io_get_write_io: 1.9.1
@@ -23,8 +24,15 @@ if ok
   # 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"
   }
+when nil
+  File.write("Makefile", dummy_makefile($srcdir).join(""))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io-console
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.9
 platform: ruby
 authors:
 - Nobu Nakada
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2021-03-10 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.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Console interface
 test_files: []