io-console 0.7.1-java → 0.8.0.beta1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e485bcd84c07daad2c3ae9bdf997be3e55739fc63e35ed39b9d796046f688043
-  data.tar.gz: 44e692abbe7b3695c78035209b92a1442b2ea16bd83d516df02445efa30ccdd0
+  metadata.gz: '070823def2bf48e4fd8e7c6e025b8c5eb5a43472ae505cf04d19eb1a9cb7ff58'
+  data.tar.gz: 0a93067f420e9cd95a267b9ea807d08f77b64ba2527f5d850fec23e810abca9b
 SHA512:
-  metadata.gz: aace9d8a02be800edda06d3ad4df4b2d9b2f1c929b7fac248c3d9b59bacaf59bd531013c45bce33f927f6dec8566fc90b17e28015b0fdc7b693ae40a03a0f38e
-  data.tar.gz: 95cb6adaadec911579285db4986e6ad592c1d219104ceb56f074351e3657c0a0eea3c3e5a7dc356879fa5d8f7cf709a85e9f3a1152494ff3cbfe4f7012ec977d
+  metadata.gz: 06e6dd0a561c6b3a3b058ffbd003f52bae1e953fc63c8fb79422dd03cbc30ef51074d2dbd4abc0c528db0135086bc2f965fb186ad2ebfc35f00a392f18d113f3
+  data.tar.gz: 929a7573f8397564ab77894c6c998498bee58b7dc9c90e9cdc0af1457a1723668a302f383c60b0f9dd806c65fe582afa9692201cd91d0db53f969c64681bfb89

data/.document

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

data/{LICENSE.txt → BSDL}

@@ -4,10 +4,10 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+   notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

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.8.0.beta1"
 end

data/lib/ffi/io/console.rb

@@ -52,9 +52,9 @@ else
       require_relative 'console/stty_console'
       ready = true
 
-    rescue Exception
+    rescue Exception => ex2
 
-      warn "failed to load stty console support: #{ex}" if $VERBOSE
+      warn "failed to load stty console support: #{ex2}" if $VERBOSE
       ready = false
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io-console
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0.beta1
 platform: java
 authors:
 - Nobu Nakada
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies: []
 description: add console capabilities to IO instances.
 email: nobu@ruby-lang.org
@@ -17,7 +17,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
-- LICENSE.txt
+- BSDL
+- COPYING
 - README.md
 - lib/ffi/io/console.rb
 - lib/ffi/io/console/bsd_console.rb
@@ -34,7 +35,8 @@ licenses:
 - BSD-2-Clause
 metadata:
   source_code_url: https://github.com/ruby/io-console
-post_install_message:
+  changelog_uri: https://github.com/ruby/io-console/releases
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib/ffi
@@ -50,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Console interface
 test_files: []