terminal_rb 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 357e535e9317609160d54c93a2a106a2a39d86a4c6740e93bbbccc01a2fcd42f
-  data.tar.gz: 746ddada0e50edf61c7220d144d75de46530056138e8a9d1bc1793098fe8a824
+  metadata.gz: 834587f3bf9e66077d0ad33b8391100863ec8932e4eafd31077684c8a982d03c
+  data.tar.gz: fd95fac927978b7bdbc39d71797d165b42a787a6a35139418c6a445192258e83
 SHA512:
-  metadata.gz: 90b2db6aa0cd6d3351ae8b7ec0f8df30a37e7bdad87050def22c47cbf48c94246efe927b15a612adbc713ff8b34971adc973721172da4702a1c7a433446db5e9
-  data.tar.gz: f35bafc5ecc52b59360ecec503e32ed173486fa81b42eec99912ef545d64be888ff01f9d584c3a6f34dd45505d449ece87ae033e61f0bb0e9637d481ddb7f310
+  metadata.gz: 7f5284ff90de5ee142d3e11414df40148eef0dca7bb216e000f4f7a3474c416bba644cdb2a44656612eae33bb7e0933424ef34161a7cd247b89054ab99538bbe
+  data.tar.gz: 979db236870e067f58d25e18ca4bc5ce088c1558b8db8c59e95017656c28cf6e762593849fa4e9d44a2d716654b81e02d643ca43d2ba83528410070c8a8e70c7

data/lib/terminal/input/as_key_event.rb

@@ -11,28 +11,21 @@ module Terminal
         when "\e" # ESC ESC ...
           return esc_esc(raw)
         when 'O'
-          if raw.size == 3
-            # ESC O ?
-            return KeyEvent.new(raw, *@ss3[raw[2].ord])
-          end
-        when '[' # ESC [ ...
-          if raw.size == 3
-            # ESC [ ?
-            return KeyEvent.new(raw, *@ss3[raw[2].ord])
-          end
-          if raw.size == 6 && raw[2] == 'M'
-            # ESC [ M b c r
+          return KeyEvent.new(raw, *@ss3[raw[2].ord]) if raw.size == 3 # ESC O ?
+        when '['
+          return KeyEvent.new(raw, *@ss3[raw[2].ord]) if raw.size == 3 # ESC [ ?
+          if raw.size == 6 && raw[2] == 'M' # ESC [ M b c r
             return mouse_vt200(raw)
           end
           return csi1(raw) if raw.start_with?("\e[1;") # ESC [ 1 ; ...
           case raw[-1]
-          when '~'
+          when '~' # ESC [ ... ~
             return legacy(raw)
-          when 'u'
+          when 'u' # ESC [ ... u
             return csi_u(raw)
-          when 'M'
+          when 'M' # ESC [ ... M
             return raw[2] == '<' ? mouse_sgr(raw) : mouse_urxvt(raw)
-          when 'm'
+          when 'm' # ESC [ ... m
             return mouse_sgr(raw) if raw[2] == '<'
           end
         end
@@ -41,37 +34,6 @@ module Terminal
 
       private
 
-      def mouse_vt200(raw)
-        # ESC [ M b c r
-        mouse_event(raw, *raw[3..].chars.map! { _1.ord - 32 })
-      end
-
-      def mouse_sgr(raw)
-        # ESC [ < <code> ; <col> ; <row> M
-        # ESC [ < <code> ; <col> ; <row> m
-        return KeyEvent.unknown(raw) if raw.size < 8
-        bcr = raw[3..-2].split(';', 3).map!(&:to_i)
-        bcr.size == 3 ? mouse_event(raw, *bcr) : KeyEvent.unknown(raw)
-      end
-
-      def mouse_urxvt(raw)
-        # ESC [ <code> ; <col> ; <row> M
-        return KeyEvent.unknown(raw) if raw.size < 8
-        bcr = raw[2..-2].split(';', 3).map!(&:to_i)
-        bcr.size == 3 ? mouse_event(raw, *bcr) : KeyEvent.unknown(raw)
-      end
-
-      def mouse_event(raw, btn, col, row)
-        return KeyEvent.unknown(raw) if btn < 0 || col < 1 || row < 1
-        kind = btn & 3
-        ka = btn >= 64 ? @mouse_wheel_kind : @mouse_kind
-        btn -= kind
-        modifier = btn.allbits?(4) ? 1 : 0
-        modifier += 2 if btn.allbits?(8)
-        modifier += 4 if btn.allbits?(16)
-        KeyEvent.new(raw, ka[kind], modifier, [col, row])
-      end
-
       def csi_u(raw)
         # ESC [ <code> u
         # ESC [ <code> ; <modifier> u
@@ -118,6 +80,42 @@ module Terminal
         key, modifier = @esc1[char.ord]
         KeyEvent.new(raw, key || char, modifier || 2)
       end
+
+      def mouse_vt200(raw)
+        # ESC [ M b c r
+        mouse_event(raw, *raw[3..].chars.map! { _1.ord - 32 })
+      end
+
+      def mouse_sgr(raw)
+        # ESC [ < <code> ; <col> ; <row> M
+        # ESC [ < <code> ; <col> ; <row> m
+        return KeyEvent.unknown(raw) if raw.size < 8
+        bcr = raw[3..-2].split(';', 3).map!(&:to_i)
+        bcr.size == 3 ? mouse_event(raw, *bcr) : KeyEvent.unknown(raw)
+      end
+
+      def mouse_urxvt(raw)
+        # ESC [ <code> ; <col> ; <row> M
+        return KeyEvent.unknown(raw) if raw.size < 8
+        bcr = raw[2..-2].split(';', 3).map!(&:to_i)
+        bcr.size == 3 ? mouse_event(raw, *bcr) : KeyEvent.unknown(raw)
+      end
+
+      def mouse_event(raw, btn, col, row)
+        return KeyEvent.unknown(raw) if btn < 0 || col < 1 || row < 1
+        key, btn = kind_of_mouse_event(btn)
+        modifier = btn.allbits?(4) ? 1 : 0
+        modifier += 2 if btn.allbits?(8)
+        modifier += 4 if btn.allbits?(16)
+        KeyEvent.new(raw, key, modifier, [col, row])
+      end
+
+      def mouse_event_key(btn)
+        kind = btn & 3
+        key = (btn >= 64 ? @mouse_wheel_kind : @mouse_kind)[kind]
+        # TODO: what about btn >= 128 for more mouse wheel events?
+        [btn - kind, key]
+      end
     end
 
     @mouse_kind = %i[

data/lib/terminal/input.rb

@@ -9,7 +9,8 @@ module Terminal
     # @attribute [r] input_mode
     #
     # @return [:csi_u]
-    #   when CSIu protocol support
+    #   when [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol)
+    #   supported
     # @return [:legacy]
     #   for standard terminal
     # @return [:dumb]
@@ -51,8 +52,7 @@ module Terminal
         KeyEvent.new(raw, *opts)
       when :csi_u, :legacy
         # raw = with_mouse ? read_tty_with_mouse : read_tty
-        raw = read_tty
-        AsKeyEvent[raw] if raw
+        AsKeyEvent[raw] if (raw = read_tty)
       end
     end
 
@@ -69,7 +69,7 @@ module Terminal
       else
         :legacy
       end
-    rescue SignalException
+    rescue Interrupt
       :legacy
     rescue IOError, SystemCallError
       :error
@@ -90,7 +90,7 @@ module Terminal
       nil
     end
 
-    def read_tty_with_mouse(any_move: false)
+    def read_tty_with_mouse(each_move: false)
       # highlight: '1001'
       # drag: '1002'
       # move: '1003'
@@ -98,7 +98,7 @@ module Terminal
       # sgr: '1006'
       # urxvt: '1015'
       # pixel: '1016'
-      opts = any_move ? '1000;1003;1006;1015' : '1000;1006;1015'
+      opts = each_move ? '1000;1003;1006;1015' : '1000;1006;1015'
       opts = _write("\e[?#{opts}h") ? "\e[?#{opts}l" : nil
       read_tty
     ensure
@@ -106,13 +106,13 @@ module Terminal
     end
 
     def read_tty
-      key = STDIN.getch
-      return key if key != "\e"
-      while (nc = STDIN.read_nonblock(1, exception: false))
-        String === nc ? key << nc : break
+      if (key = STDIN.getch) == "\e"
+        while (nc = STDIN.read_nonblock(1, exception: false))
+          String === nc ? key << nc : break
+        end
       end
       key
-    rescue SignalException
+    rescue Interrupt
       nil
     rescue IOError, SystemCallError
       @input_mode = :error
@@ -148,10 +148,12 @@ module Terminal
         end
       end
 
+      # @!visibility private
       def new(raw, key = raw, modifier = 0, extra = nil)
-        @cache ? super.freeze : @cache[raw] || (@cache[raw] = super.freeze)
+        @cache ? (@cache[raw] ||= super.freeze) : super.freeze
       end
 
+      # @!visibility private
       def unknown(raw) = new(raw, nil)
     end
 
@@ -172,7 +174,9 @@ module Terminal
     # @return [Integer] modifier key code
     attr_reader :modifier
 
-    # @comment for mouse events? attr_reader :extra
+    # @comment for mouse events
+    # @!visibility private
+    attr_reader :extra
 
     # Name of the key event.
     # This can be a simple name like `"a"` or `"Shift+Ctrl+F12"` for combined

data/lib/terminal/text.rb

@@ -30,7 +30,7 @@ module Terminal
       def width(str, bbcode: true)
         str = bbcode ? Ansi.unbbcode(str) : str.to_s
         return 0 if str.empty?
-        str = str.encode(ENC) if str.encoding != ENC
+        str = str.encode(@encoding) if str.encoding != @encoding
         width = 0
         str.scan(WIDTH_SCANNER) do |sp, gc|
           next width += char_width(gc) if gc
@@ -113,7 +113,7 @@ module Terminal
 
       def char_width(char)
         ord = char.ord
-        return CONTROL_CHAR_WIDTH[ord] || 2 if ord < 0x20
+        return @ctrlchar_width[ord] || 2 if ord < 0x20
         return 1 if char.size < 2 && ord < 0xa1
         width = CharWidth[ord]
         return @ambiguous_char_width if width == -1
@@ -124,7 +124,7 @@ module Terminal
       end
 
       def lim_pairs(snippeds, limit)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -144,7 +144,7 @@ module Terminal
 
           if snipped == :hard_nl
             line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -190,7 +190,7 @@ module Terminal
       end
 
       def pairs(snippeds)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -208,7 +208,7 @@ module Terminal
 
           if snipped == :hard_nl
             line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -229,7 +229,7 @@ module Terminal
       end
 
       def lim_lines(snippeds, limit)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -249,7 +249,7 @@ module Terminal
 
           if snipped == :hard_nl
             yield(line[-1] == ' ' ? line.chop : line)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -295,7 +295,7 @@ module Terminal
       end
 
       def lines(snippeds)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -313,7 +313,7 @@ module Terminal
 
           if snipped == :hard_nl
             yield(line[-1] == ' ' ? line.chop : line)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -342,7 +342,7 @@ module Terminal
             next ret << (last = :hard_nl)
           end
 
-          txt = txt.encode(ENC) if txt.encoding != ENC
+          txt = txt.encode(@encoding) if txt.encoding != @encoding
 
           txt.scan(SCAN_EXPR) do |nl, csi, osc, space, gc|
             if gc
@@ -445,10 +445,8 @@ module Terminal
     private_constant :Osc, :CsiEnd, :Csi, :Word, :WordEx
 
     @ambiguous_char_width = 1
-
-    ENC = Encoding::UTF_8
-    EMPTY = String.new(encoding: ENC).freeze
-    private_constant :ENC, :EMPTY
+    @encoding = Encoding::UTF_8
+    @empty = String.new(encoding: @encoding).freeze
 
     SCAN_EXPR =
       /\G(?:
@@ -468,7 +466,7 @@ module Terminal
       )/x
     private_constant :SCAN_EXPR, :WIDTH_SCANNER
 
-    CONTROL_CHAR_WIDTH = {
+    @ctrlchar_width = {
       0x00 => 0,
       0x01 => 1,
       0x02 => 1,
@@ -502,7 +500,6 @@ module Terminal
       0x1e => 1,
       0x1f => 1
     }.compare_by_identity.freeze
-    private_constant :CONTROL_CHAR_WIDTH
 
     autoload :CharWidth, "#{__dir__}/text/char_width.rb"
     private_constant :CharWidth

data/lib/terminal/version.rb

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

data/lib/terminal.rb

@@ -11,16 +11,16 @@ require_relative 'terminal/input'
 # It automagically detects whether your terminal supports ANSI features, like
 # coloring (see {colors}) or the
 # [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol) support
-# (see {read_key} and {input_mode}). It calculates the display width for Unicode
-# chars (see {Text.width}) and help you to display text with line formatting
-# (see {Text.each_line}).
+# (see {read_key_event} and {input_mode}).
+# It calculates the display width for Unicode chars (see {Text.width}) and help
+# you to display text with line formatting (see {Text.each_line}).
 #
 module Terminal
   class << self
-    # Return true when the current terminal supports ANSI control codes.
-    # When the terminal does not support it, {colors} will return `2` as color
-    # count and all output methods ({<<}, {print}, {puts}) will not forward
-    # ANSI control codes to the terminal, {read_key} will not support CSIu.
+    # Return true if the current terminal supports ANSI control codes.
+    # When the terminal does not support it, {colors} will return `2` and all
+    # output methods ({<<}, {print}, {puts}) will not forward ANSI control
+    # codes to the terminal, {read_key_event} will not support CSIu.
     #
     # @attribute [r] ansi?
     # @return [Boolean] whether ANSI control codes are supported
@@ -123,8 +123,9 @@ module Terminal
 
     # Screen size as a tuple of {rows} and {columns}.
     #
-    # If the terminal does not support the report for it's dimension or ANSI
-    # is not supported in general then environment variables will be used.
+    # If the terminal does not support the report of it's dimension or ANSI
+    # is not supported in general then environment variables `COLUMNS` and
+    # `LINES` will be used.
     # If this failed `[25, 80]` will be returned as default.
     #
     # Setting the terminal size is not widely supported.
@@ -156,7 +157,8 @@ module Terminal
     # Hide the cursor.
     # Will not send the control code if the cursor is already hidden.
     #
-    # To show the cursor again call {show_cursor}.
+    # When you called {hide_cursor} n-times you need to call {show_cursor}
+    # n-times to show the cursor again.
     #
     # @return [Terminal] itself
     def hide_cursor

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -44,11 +44,11 @@ homepage: https://codeberg.org/mblumtritt/Terminal.rb
 licenses:
 - MIT
 metadata:
-  rubygems_mfa_required: 'true'
-  yard.run: yard
   source_code_uri: https://codeberg.org/mblumtritt/Terminal.rb
   bug_tracker_uri: https://codeberg.org/mblumtritt/Terminal.rb/issues
-  documentation_uri: https://rubydoc.info/gems/terminal_rb/Terminal
+  documentation_uri: https://rubydoc.info/gems/terminal_rb
+  rubygems_mfa_required: 'true'
+  yard.run: yard
 rdoc_options: []
 require_paths:
 - lib