io-console 0.7.1-java → 0.7.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e485bcd84c07daad2c3ae9bdf997be3e55739fc63e35ed39b9d796046f688043
-  data.tar.gz: 44e692abbe7b3695c78035209b92a1442b2ea16bd83d516df02445efa30ccdd0
+  metadata.gz: a2f353bc5f4bdde430dd0c5166013af6b6601a2c2b25c60de3ec1b1a432934a5
+  data.tar.gz: 7b5a900fc2f6b2c5ba507b01dc89cc394a45b05fbf02d70d3cfff0312ee25b5c
 SHA512:
-  metadata.gz: aace9d8a02be800edda06d3ad4df4b2d9b2f1c929b7fac248c3d9b59bacaf59bd531013c45bce33f927f6dec8566fc90b17e28015b0fdc7b693ae40a03a0f38e
-  data.tar.gz: 95cb6adaadec911579285db4986e6ad592c1d219104ceb56f074351e3657c0a0eea3c3e5a7dc356879fa5d8f7cf709a85e9f3a1152494ff3cbfe4f7012ec977d
+  metadata.gz: 83d234297209f93e79b5c879e90575aadbbd6782a7b69d198426c427d6cf1feef7f3266aa401cb85cdd0480e4756dc037ef0701b0c0c3776b65e5eacfea96071
+  data.tar.gz: fc04c9b4870c50005897f0478e1294624ac0b2fc5ae63d9b4a5bf4e1bc11f48af9b58c12d75ed7b54caf8af8ba8966cb50ed1ed322d31f90fbe1c60136d03aae

data/.document

@@ -1,4 +1,5 @@
 LICENSE.txt
 README.md
+docs/
 ext/
 lib/io/console/size.rb

data/lib/ffi/io/console/bsd_console.rb

@@ -1,5 +1,11 @@
 require 'ffi'
 
+tested_platforms = %w[i386 x86_64]
+
+if RbConfig::CONFIG['host_os'].downcase =~ /darwin/ && FFI::Platform::ARCH !~ /#{tested_platforms.join('|')}/
+  raise LoadError.new("native console on MacOS only supported on #{tested_platforms.join(', ')}")
+end
+
 module IO::LibC
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/lib/ffi/io/console/common.rb

@@ -1,5 +1,47 @@
 # Methods common to all backend impls
 class IO
+  # TODO: Windows version uses "conin$" and "conout$" instead of /dev/tty
+  def self.console(sym = nil, *args)
+    raise TypeError, "expected Symbol, got #{sym.class}" unless sym.nil? || sym.kind_of?(Symbol)
+
+    # klass = self == IO ? File : self
+    if defined?(@console) # using ivar instead of hidden const as in MRI
+      con = @console
+      # MRI checks IO internals : (!RB_TYPE_P(con, T_FILE) || (!(fptr = RFILE(con)->fptr) || GetReadFD(fptr) == -1))
+      if !con.kind_of?(File) || (con.kind_of?(IO) && (con.closed? || !FileTest.readable?(con)))
+        remove_instance_variable :@console
+        con = nil
+      end
+    end
+
+    if sym
+      if sym == :close
+        if con
+          con.close
+          remove_instance_variable :@console if defined?(@console)
+        end
+        return nil
+      end
+    end
+
+    if !con
+      if $stdin.isatty && $stdout.isatty
+        begin
+          con = File.open('/dev/tty', 'r+')
+        rescue
+          return nil
+        end
+
+        con.sync = true
+      end
+
+      @console = con
+    end
+
+    return con.send(sym, *args) if sym
+    return con
+  end
+
   def getch(*, **opts)
     raw(**opts) do
       getc
@@ -20,6 +62,80 @@ class IO
     str.chomp
   end
 
+  def cursor
+    raw do
+      syswrite "\e[6n"
+
+      return nil if getbyte != 0x1b
+      return nil if getbyte != ?[.ord
+
+      num = 0
+      result = []
+
+      while b = getbyte
+        c = b.to_i
+        if c == ?;.ord
+          result.push num
+          num = 0
+        elsif c >= ?0.ord && c <= ?9.ord
+          num = num * 10 + c - ?0.ord
+          #elsif opt && c == opt
+        else
+          last = c
+          result.push num
+          b = last.chr
+          return nil unless b == ?R
+          break
+        end
+      end
+
+      result.map(&:pred)
+    end
+  end
+
+  def cursor=(pos)
+    pos = pos.to_ary if !pos.kind_of?(Array)
+
+    raise "expected 2D coordinates" unless pos.size == 2
+
+    x, y = pos
+    syswrite(format("\x1b[%d;%dH", x + 1, y + 1))
+
+    self
+  end
+
+  def cursor_down(n)
+    raw do
+      syswrite "\x1b[#{n}B"
+    end
+
+    self
+  end
+
+  def cursor_right(n)
+    raw do
+      syswrite "\x1b[#{n}C"
+    end
+
+    self
+  end
+
+  def cursor_left(n)
+    raw do
+      syswrite "\x1b[#{n}D"
+    end
+
+    self
+  end
+
+  def cursor_up(n)
+    raw do
+      syswrite "\x1b[#{n}A"
+    end
+
+    self
+  end
+
   module GenericReadable
     def getch(*)
       getc

data/lib/ffi/io/console/linux_console.rb

@@ -1,7 +1,9 @@
 require 'ffi'
 
-unless FFI::Platform::ARCH =~ /i386|x86_64|powerpc64|aarch64|s390x/
-  raise LoadError.new("native console only supported on i386, x86_64, powerpc64, aarch64 and s390x")
+tested_platforms = %w[i386 x86_64 powerpc64 aarch64 s390x]
+
+unless FFI::Platform::ARCH =~ /#{tested_platforms.join('|')}/
+  warn "native console only tested on #{tested_platforms.join(', ')}"
 end
 
 module IO::LibC

data/lib/ffi/io/console/native_console.rb

@@ -52,8 +52,8 @@ class IO
     end
   end
 
-  def raw(*, **kwargs, &block)
-    ttymode_yield(block, **kwargs, &TTY_RAW)
+  def raw(*, min: 1, time: nil, intr: nil, &block)
+    ttymode_yield(block, min:, time:, intr:, &TTY_RAW)
   end
 
   def raw!(*)
@@ -137,117 +137,4 @@ class IO
   def ioflush
     raise SystemCallError.new("tcflush(TCIOFLUSH)", FFI.errno) unless LibC.tcflush(self.fileno, LibC::TCIOFLUSH) == 0
   end
-
-  def cursor
-    raw do
-      syswrite "\e[6n"
-
-      return nil if getbyte != 0x1b
-      return nil if getbyte != ?[.ord
-
-      num = 0
-      result = []
-
-      while b = getbyte
-        c = b.to_i
-        if c == ?;.ord
-          result.push num
-          num = 0
-        elsif c >= ?0.ord && c <= ?9.ord
-          num = num * 10 + c - ?0.ord
-          #elsif opt && c == opt
-        else
-          last = c
-          result.push num
-          b = last.chr
-          return nil unless b == ?R
-          break
-        end
-      end
-
-      result.map(&:pred)
-    end
-  end
-
-  def cursor=(pos)
-    pos = pos.to_ary if !pos.kind_of?(Array)
-
-    raise "expected 2D coordinates" unless pos.size == 2
-
-    x, y = pos
-    syswrite(format("\x1b[%d;%dH", x + 1, y + 1))
-
-    self
-  end
-
-  def cursor_down(n)
-    raw do
-      syswrite "\x1b[#{n}B"
-    end
-
-    self
-  end
-
-  def cursor_right(n)
-    raw do
-      syswrite "\x1b[#{n}C"
-    end
-
-    self
-  end
-
-  def cursor_left(n)
-    raw do
-      syswrite "\x1b[#{n}D"
-    end
-
-    self
-  end
-
-  def cursor_up(n)
-    raw do
-      syswrite "\x1b[#{n}A"
-    end
-
-    self
-  end
-
-  # TODO: Windows version uses "conin$" and "conout$" instead of /dev/tty
-  def self.console(sym = nil, *args)
-    raise TypeError, "expected Symbol, got #{sym.class}" unless sym.nil? || sym.kind_of?(Symbol)
-
-    # klass = self == IO ? File : self
-    if defined?(@console) # using ivar instead of hidden const as in MRI
-      con = @console
-      # MRI checks IO internals : (!RB_TYPE_P(con, T_FILE) || (!(fptr = RFILE(con)->fptr) || GetReadFD(fptr) == -1))
-      if !con.kind_of?(File) || (con.kind_of?(IO) && (con.closed? || !FileTest.readable?(con)))
-        remove_instance_variable :@console
-        con = nil
-      end
-    end
-
-    if sym
-      if sym == :close
-        if con
-          con.close
-          remove_instance_variable :@console if defined?(@console)
-        end
-        return nil
-      end
-    end
-
-    if !con
-      begin
-        con = File.open('/dev/tty', 'r+')
-      rescue
-        return nil
-      end
-
-      con.sync = true
-      @console = con
-    end
-
-    return con.send(sym, *args) if sym
-    return con
-  end
 end

data/lib/ffi/io/console/stty_console.rb

@@ -4,26 +4,39 @@ if $?.exitstatus != 0
   raise "stty command returned nonzero exit status"
 end
 
-warn "io/console on JRuby shells out to stty for most operations"
+warn "io/console on JRuby shells out to stty for most operations" if $VERBOSE
 
 # Non-Windows assumes stty command is available
 class IO
   if RbConfig::CONFIG['host_os'].downcase =~ /linux/ && File.exists?("/proc/#{Process.pid}/fd")
-    def stty(*args)
-      `stty #{args.join(' ')} < /proc/#{Process.pid}/fd/#{fileno}`
+    protected def _io_console_stty(*args)
+      _io_console_stty_error { `stty #{args.join(' ')} < /proc/#{Process.pid}/fd/#{fileno}` }
     end
   else
-    def stty(*args)
-      `stty #{args.join(' ')}`
+    protected def _io_console_stty(*args)
+      _io_console_stty_error { `stty #{args.join(' ')}` }
     end
   end
 
-  def raw(*)
-    saved = stty('-g')
-    stty('raw')
+  protected def _io_console_stty_error
+    # pre-check to catch non-tty filenos we can't stty against anyway
+    raise Errno::ENOTTY, inspect if !tty?
+
+    result = yield
+
+    case result
+    when /Inappropriate ioctl for device/
+      raise Errno.ENOTTY, inspect
+    end
+
+    result
+  end
+
+  def raw(*, min: 1, time: nil, intr: nil)
+    saved = _io_console_stty('-g raw')
     yield self
   ensure
-    stty(saved)
+    _io_console_stty(saved)
   end
 
   def raw!(*)
@@ -31,31 +44,29 @@ class IO
   end
 
   def cooked(*)
-    saved = stty('-g')
-    stty('-raw')
+    saved = _io_console_stty('-g', '-raw')
     yield self
   ensure
-    stty(saved)
+    _io_console_stty(saved)
   end
 
   def cooked!(*)
-    stty('-raw')
+    _io_console_stty('-raw')
   end
 
   def echo=(echo)
-    stty(echo ? 'echo' : '-echo')
+    _io_console_stty(echo ? 'echo' : '-echo')
   end
 
   def echo?
-    (stty('-a') =~ / -echo /) ? false : true
+    (_io_console_stty('-a') =~ / -echo /) ? false : true
   end
 
   def noecho
-    saved = stty('-g')
-    stty('-echo')
+    saved = _io_console_stty('-g', '-echo')
     yield self
   ensure
-    stty(saved)
+    _io_console_stty(saved)
   end
 
   # Not all systems return same format of stty -a output
@@ -63,7 +74,7 @@ class IO
   UBUNTU = 'rows (?<rows>\d+); columns (?<columns>\d+)'
 
   def winsize
-    match = stty('-a').match(/#{IEEE_STD_1003_2}|#{UBUNTU}/)
+    match = _io_console_stty('-a').match(/#{IEEE_STD_1003_2}|#{UBUNTU}/)
     [match[:rows].to_i, match[:columns].to_i]
   end
 
@@ -75,13 +86,13 @@ class IO
       raise ArgumentError.new("wrong number of arguments (given #{sizelen}, expected 2 or 4)")
     end
 
-    row, col, xpixel, ypixel = size
-
     if sizelen == 4
       warn "stty io/console does not support pixel winsize"
     end
 
-    stty("rows #{row} cols #{col}")
+    row, col, _, _ = size
+
+    _io_console_stty("rows #{row} cols #{col}")
   end
 
   def iflush

data/lib/ffi/io/console/stub_console.rb

@@ -2,7 +2,7 @@ warn "io/console not supported; tty will not be manipulated" if $VERBOSE
 
 # Windows version is always stubbed for now
 class IO
-  def raw(*)
+  def raw(*, min: 1, time: nil, intr: nil)
     yield self
   end
 

data/lib/ffi/io/console/version.rb

@@ -1,3 +1,3 @@
 class IO::ConsoleMode
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io-console
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: java
 authors:
 - Nobu Nakada
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies: []
 description: add console capabilities to IO instances.
 email: nobu@ruby-lang.org
@@ -34,6 +34,7 @@ licenses:
 - BSD-2-Clause
 metadata:
   source_code_url: https://github.com/ruby/io-console
+  changelog_uri: https://github.com/ruby/io-console/releases
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -50,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.6.0.dev
 signing_key:
 specification_version: 4
 summary: Console interface