terminal_rb 0.16.0 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05eda4c596ad7060b576cb01f6fe7dafd38e114274b44c14c4c90e1b3a2b322a
-  data.tar.gz: '0479860569041d6fb874d38de0d183a2cc778a6803d3eed302425cd795133e06'
+  metadata.gz: c1c85e6d14f19a36f2efd995aa90b962ef24deaedeacd6ba5ba0392ae7d87f54
+  data.tar.gz: 99a8c94cbb3b79386fb1725378f4f7cfc6e97e1e4b93978cf6e67d0a1d0720a0
 SHA512:
-  metadata.gz: ab038b9b4cc9ed41ba09673be9a2e2d25aa2edc2ffbf1fa0cad826ca7f55c8fef3aab734648f13f63750ea7799bce638479839e5f609e597eeb0bf4508b0f0e7
-  data.tar.gz: b501721dfd7d6d79ceb8821fa5dd9d877e764e235435f3e6441e9b02b424a5873aba1318365a4b064a9430c135882be39470361d0042b56726be3dd2505e9db5
+  metadata.gz: 4d257376892920c46bd96c60a475953d169409552db6fc75a3e0f5f0613b34fe5bc3a2e18d77c53d05cf2670f0b81a02ba4ce237d83fb4c3299826d1c3e7cce8
+  data.tar.gz: 353f4ed0f0da7ad39ce7413335e31d89264e0587e12c450d6028c8fbfc5c30c986136e0babac12a146176d44c810aabdb403b52a13389a3900256f53cd5b96d8

data/README.md

@@ -16,7 +16,7 @@ Terminal.rb supports you with input and output on your terminal. Simple [BBCode]
 - calculation for correct display width of strings containing Unicdode chars inclusive emojis
 - word-wise line break generator
 - supports [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol)
-- mouse events support
+- mouse events
 
 ## Examples
 

data/lib/terminal/ansi.rb

@@ -571,7 +571,7 @@ module Terminal
 
     @re_test =
       /
-      (?:\e\[[\d;:?]*[ABCDEFGHJKSTfminsuhl])
+      (?:\e\[[\x30-\x3f]*[\x20-\x2f]*[a-zA-Z])
       |
       (?:\e\]\d+(?:;[^\a\e]+)*(?:\a|\e\\))
     /x

data/lib/terminal/input/key_event.rb

@@ -5,13 +5,6 @@ module Terminal
   # Key event reported from {read_key_event} and {on_key_event}.
   #
   class KeyEvent
-    # ANSI code sequence received from standard input.
-    # This can be a simple value like `"a"`or more complex input like
-    # `"\e[24;6~"` (for Shift+Ctrl+F12).
-    #
-    # @return [String] received ANSI code sequence
-    attr_reader :raw
-
     # Pressed key without any modifiers.
     # This can be a string for simple keys like `"a"` or a Symbol like `:F12`
     # (see {.key_names}).
@@ -24,11 +17,9 @@ module Terminal
     # @return [Integer] modifier key code
     attr_reader :modifier
 
-    # Mouse event position.
-    #
-    # @return [[Integer,Integer]] row and column
-    # @return nil when no coordinates are assigned
-    attr_reader :position
+    # @attribute [r] modifier?
+    # @return [true, false] whether a key modifier was pressed
+    def modifier? = @modifier != 0
 
     # Name of the key event.
     # This can be a simple name like `"a"` or `"Shift+Ctrl+F12"` for combined
@@ -37,9 +28,18 @@ module Terminal
     # @return [String] key name
     attr_reader :name
 
-    # @attribute [r] modifier?
-    # @return [true, false] whether a key modifier was pressed
-    def modifier? = @modifier != 0
+    # Mouse event position.
+    #
+    # @return [[Integer,Integer]] row and column
+    # @return nil when no coordinates are assigned
+    attr_reader :position
+
+    # ANSI code sequence received from standard input.
+    # This can be a simple value like `"a"`or more complex input like
+    # `"\e[24;6~"` (for Shift+Ctrl+F12).
+    #
+    # @return [String] received ANSI code sequence
+    attr_reader :raw
 
     # @attribute [r] simple?
     # @return [true, false] whether a simple key was pressed
@@ -48,6 +48,14 @@ module Terminal
     # All pressed keys.
     # This is composed by all {modifier} and the {key}.
     #
+    # @example
+    #   Terminal::KeyEvent["\e\r"].to_a
+    #   => [:Alt, :Enter]
+    #   Terminal::KeyEvent['a'].to_a
+    #   => ['a']
+    #   Terminal::KeyEvent["\e[<12;45;30m"].to_a
+    #   => [:Shift, :Alt, :MBLeftUp]
+    #
     # @return [Array<Symbol, String>] all pressed keys
     def to_a = @ary.dup
 
@@ -76,9 +84,9 @@ module Terminal
       @key = key
       @modifier = modifier
       @position = position
-      @ary = MODIFIERS.filter_map { |b, n| n if modifier.allbits?(b) }
+      @ary = MODIFIERS.filter_map { |b, n| n if (modifier & b) == b }
       @ary << key if key
-      @name = @ary.join('+') # .encode(Encoding::UTF_8)
+      @name = @ary.join('+')
     end
 
     class << self
@@ -103,9 +111,9 @@ module Terminal
         ).dup
       end
 
-      # Translate a ANSI input code sequence into a related KeyEvent.
+      # Translate an ANSI input code sequence into a related KeyEvent.
       #
-      # @param raw [String] keyboard input
+      # @param raw [String] keyboard, mouse or focus event sequence
       # @return [KeyEvent] related key event
       def [](raw)
         cached = @cache[raw] and return cached if @cache

data/lib/terminal/input.rb

@@ -85,7 +85,7 @@ module Terminal
         on_bumb_key_event(&block)
         true
       when :csi_u, :legacy
-        on_tty_key_event(mouse, mouse_move, focus, &block)
+        on_tty_key_event(mouse_option(mouse, mouse_move, focus), &block)
         true
       else
         false
@@ -94,36 +94,30 @@ module Terminal
 
     private
 
-    def on_tty_key_event(mouse, mouse_move, focus)
+    def mouse_option(mouse, mouse_move, focus)
+      opts = +(mouse ? '1000' : '')
       # highlight: '1001'
       # drag: '1002'
-      # move: '1003'
-      # focus: '1004' - lost: "\e[O", get: "\e[I"
+      opts << ';1003' if mouse_move
+      opts << ';1004' if focus
       # ext: '1005'
       # sgr: '1006'
       # urxvt: '1015'
       # pixel: '1016'
-      opts =
-        if mouse || mouse_move || focus
-          opts = mouse ? +"\e[?1006;1000" : +"\e[?1006"
-          opts << ';1003' if mouse_move
-          opts << ';1004' if focus
-          raw_write("#{opts}h") ? "#{opts}l" : nil
-        end
+      "\e[?#{opts};1006" unless opts.empty?
+    end
+
+    def on_tty_key_event(opts)
       STDIN.noecho do |stdin|
+        opts = raw_write("#{opts}h") ? "#{opts}l" : nil
         while (raw = stdin.getch)
-          if raw != "\e"
-            yield(KeyEvent[raw]) ? next : break
-          end
+          (yield(KeyEvent[raw]) ? next : break) if raw != "\e"
           lesci = 0
-          while (nc = stdin.read_nonblock(1, exception: false))
-            break unless String === nc
+          while String === (nc = stdin.read_nonblock(1, exception: false))
             lesci = raw.size if nc == "\e"
             raw << nc
           end
-          if lesci < 2
-            yield(KeyEvent[raw]) ? next : break
-          end
+          (yield(KeyEvent[raw]) ? next : break) if lesci < 2
           break unless raw[1..].split("\e").all? { yield(KeyEvent["\e#{_1}"]) }
         end
       end
@@ -147,16 +141,13 @@ module Terminal
       return :legacy if im == 'legacy'
       return :dumb if im == 'dumb' || !STDIN.tty?
       STDIN.noecho do |stdin|
-        if raw_write("\e[>1u\e[?u\e[c")
-          inp = +''
-          inp << stdin.getch until inp.rindex('c')
-          if inp.include?("\e[?1u")
-            at_exit { raw_write("\e[<u") }
-            return :csi_u
-          end
-        end
+        return :legacy unless raw_write("\e[>1u\e[?u\e[c")
+        inp = +''
+        inp << stdin.getch until inp.rindex('c')
+        return :legacy unless inp.include?("\e[?1u")
+        at_exit { raw_write("\e[<u") }
+        :csi_u
       end
-      :legacy
     rescue Interrupt
       :legacy
     rescue IOError, SystemCallError

data/lib/terminal/rspec/helper.rb

@@ -61,5 +61,12 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
     allow(Terminal).to receive(:read_key_event) do
       Terminal::KeyEvent[stdin.shift || raise('stdin buffer is empty')]
     end
+
+    allow(Terminal).to receive(:on_key_event) do |&b|
+      while true
+        ev = Terminal::KeyEvent[stdin.shift || raise('stdin buffer is empty')]
+        b[ev] or break
+      end
+    end
   end
 end

data/lib/terminal/text.rb

@@ -447,7 +447,7 @@ module Terminal
     @scan_snippet =
       /\G(?:
         (\r?\n)
-        | (\e\[[\d;:?]*[ABCDEFGHJKSTfhilmnsu])
+        | (\e\[[\x30-\x3f]*[\x20-\x2f]*[a-zA-Z])
         | (\e\]\d+(?:;[^\a\e]+)*(?:\a|\e\\))
         | (\s+)
         | (\X)
@@ -455,7 +455,7 @@ module Terminal
 
     @scan_width =
       /\G(?:
-        (?:\e\[[\d;:?]*[ABCDEFGHJKSTfhilmnsu])
+        (?:\e\[[\x30-\x3f]*[\x20-\x2f]*[a-zA-Z])
         | (?:\e\]\d+(?:;[^\a\e]+)*(?:\a|\e\\))
         | (\s+)
         | (\X)

data/lib/terminal/version.rb

@@ -2,5 +2,5 @@
 
 module Terminal
   # The version number of the gem.
-  VERSION = '0.16.0'
+  VERSION = '0.16.2'
 end

data/lib/terminal.rb

@@ -16,16 +16,42 @@ require_relative 'terminal/input'
 #
 module Terminal
   class << self
-    # Return true if the current terminal supports ANSI control codes.
-    # When the terminal does not support it, {colors} will return 2 (two) and
-    # all output methods ({<<}, {print}, {puts}) will not forward ANSI control
-    # codes to the terminal, {read_key_event} and {on_key_event} will not
-    # support extended key codes and/or mouse events.
+    # Return `true` if the current terminal supports ANSI control codes for
+    # output.
+    # In this case all output methods ({<<}, {print}, {puts}) will forward ANSI
+    # control codes to the terminal and translate BBCode (see {Ansi.bbcode}).
+    #
+    # When `false` is returned (ANSI is not supported) the output methods will
+    # not forward ANSI control codes and BBCodes will be removed.
+    # The {colors} method will just return 2 (two).
+    #
+    # @see tui?
     #
     # @attribute [r] ansi?
-    # @return [Boolean] whether ANSI control codes are supported
+    # @return [true, false] whether ANSI control codes are supported for output
     def ansi? = @ansi
 
+    # Return `true` if the current terminal supports ANSI control codes for
+    # input _and_ output.
+    # In this case not only all output methods ({<<}, {print}, {puts}) will
+    # forward ANSI control codes to the terminal and translate BBCode
+    # (see {Ansi.bbcode}). But also the input methods {read_key_event} and
+    # {on_key_event} will support extended key codes, mouse  and focus events.
+    #
+    # @see ansi?
+    #
+    # @attribute [r] tui?
+    # @return [true, false]
+    #   whether ANSI control codes are supported for input and output
+    def tui?
+      case input_mode
+      when :csi_u, :legacy
+        @ansi
+      else
+        false
+      end
+    end
+
     # Terminal application identifier.
     #
     # The detection supports a wide range of terminal emulators but may return
@@ -127,7 +153,7 @@ module Terminal
 
     # @see colors
     # @attribute [r] true_color?
-    # @return [Boolean] whether true colors are supported
+    # @return [true, false] whether true colors are supported
     def true_color? = (colors == 16_777_216)
 
     # Hide the cursor.
@@ -365,5 +391,6 @@ module Terminal
   autoload :Text, "#{dir}/text.rb"
   autoload :Detect, "#{dir}/detect.rb"
   autoload :Shell, "#{dir}/shell.rb"
+  autoload :VERSION, "#{dir}/version.rb"
   private_constant :Detect, :Shell
 end

data/terminal_rb.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name = 'terminal_rb'
   spec.version = Terminal::VERSION
   spec.summary = <<~SUMMARY.tr("\n", ' ')
-    Fast terminal access with ANSI, CSIu, mouse eventing, BBCode, word-wise
+    Fast terminal access with ANSI, CSIu, mouse events, BBCode, word-wise
     line break support and much more.
   SUMMARY
   spec.description = <<~DESCRIPTION.tr("\n", ' ')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.2
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -69,6 +69,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.2
 specification_version: 4
-summary: Fast terminal access with ANSI, CSIu, mouse eventing, BBCode, word-wise line
+summary: Fast terminal access with ANSI, CSIu, mouse events, BBCode, word-wise line
   break support and much more.
 test_files: []