terminal_rb 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fdd6ab56d007f6fa6e82bf8d557d0a27815ad789998da5583310dd62af2b551
-  data.tar.gz: ef83edfd6c82bc9a2a056d148cd4da2af7b1a28acaa0cab9863901d608d502b7
+  metadata.gz: 673e2c03057d8f9c6c73d8dbe3f464a70ab796e67b272dd6de58ec44ab82bde8
+  data.tar.gz: 3fa3b10c9370c7ab9113d8f7a961ebd74437fdba76dc34a64716f955df1fae6a
 SHA512:
-  metadata.gz: d53c04af3d74273cf3111b9b7078846e0c33f0caf8501e9f0182427ed784d96b94444c1f6238427dd248cf300fb362d95a3a0f5dea2ead5c571ff2fd7d52fdf9
-  data.tar.gz: 82d79cfab6b7d499bb5d6f9fb7d6ce9af14f69ed792f8f7eedf4485a4f26546576ecadd723cc67a48ffbb4bc00ab1cc83d04a15a1bceb37d8437ec825d0f38cc
+  metadata.gz: 91ba6fb64a85db7d30f5a390b8d3b5544ad5080428d832582a5a1ee655dac23e7bdebee185784dccdc5e2ac20eddfb33c64808a93893297769e994522dbdd696
+  data.tar.gz: 435c3f4369383850562d5b95f355bdb45fb4fb235ba9bba7eb451404657552c75e54b6b181c975903f4e6041a73206e08023c1e3fd77bedb3d28fb10f33e5612

data/README.md

@@ -4,7 +4,7 @@ Terminal access with support for ANSI control codes and [BBCode-like](https://en
 
 - Gem: [rubygems.org](https://rubygems.org/gems/terminal_rb)
 - Source: [codeberg.org](https://codeberg.org/mblumtritt/Terminal.rb)
-- Help: [rubydoc.info](https://rubydoc.info/gems/terminal_rb/0.9.0/Terminal)
+- Help: [rubydoc.info](https://rubydoc.info/gems/terminal_rb/Terminal)
 
 ## Features
 
@@ -15,7 +15,7 @@ Terminal access with support for ANSI control codes and [BBCode-like](https://en
 - markup of text attributes and colors using a [BBCode](https://en.wikipedia.org/wiki/BBCode)-like syntax
 - calculation for correct display width of strings containing Unicdode chars inclusive emojis
 - word-wise text wrapper
-- easy to use key codes
+- supports [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol)
 
 ## Examples
 

data/examples/info.rb

@@ -11,5 +11,6 @@ Terminal.puts <<~TEXT
   Supported Colors: [b]#{Terminal.colors}#{Terminal::Ansi.rainbow(' (truecolor)') if Terminal.true_color?}[/]
      Terminal Size: [b]#{Terminal.size.join(' x ')}[/]
    Cursor Position: [b]#{Terminal.pos&.join(', ')}[/]
+        Input Mode: [b]#{Terminal.input_mode}[/]
 
 TEXT

data/examples/key-codes.rb

@@ -6,7 +6,7 @@ Terminal.puts <<~TEXT
 
   ✅ [b bright_green]Terminal.rb[/b] — Key Codes:[/]
      Press any key to display it's control code and name.
-     [bright_black](Exit with Ctrl+C)[/]
+     [bright_black]([b]#{Terminal.input_mode}[/b] mode  - exit with ESC)[/fg]
 
 TEXT
 
@@ -18,5 +18,5 @@ while true
   Terminal.puts(
     "   [blue]: [yellow]#{raw.inspect}  [bold bright_green]#{name}[/]"
   )
-  break puts if name == 'Ctrl+C'
+  break puts if name == 'Esc'
 end

data/lib/terminal/ansi.rb

@@ -482,6 +482,63 @@ module Terminal
       # @return (see cursor_up)
       def link(url, text) = "\e]8;;#{url}\a#{text}\e]8;;\a"
 
+      # Create scaled text.
+      # It uses the
+      # [text sizing protocol](https://sw.kovidgoyal.net/kitty/text-sizing-protocol).
+      # This is not widely supported.
+      #
+      # @example Double-height Greeting
+      #   Terminal::Ansi.scale('Hello Ruby!', scale: 2)
+      #
+      # @example Half-height Greeting
+      #   Terminal::Ansi.scale('Hello Ruby!', fracn: 1, fracd: 2, vertical: :centered)
+      #
+      # @param [#to_s] text text to scale
+      # @param [Integer, nil] scale
+      #   overall scale size, range 1..7
+      # @param [Integer, nil] width
+      #   with on cells, range 0..7
+      # @param [Integer, nil] fracn
+      #   numerator for the fractional scale, range: 0..15
+      # @param [Integer, nil] fracd
+      #   denominator for the fractional scale, range: 0..15, > fracn
+      # @param [:top, :bottom, :centered, nil] vertical
+      #   vertical alignment to use for fractionally scaled text
+      # @return (see cursor_up)
+      def scale(
+        text,
+        scale: nil,
+        width: nil,
+        fracn: nil,
+        fracd: nil,
+        vertical: nil,
+        horizontal: nil
+      )
+        opts = scale ? ["s=#{scale.clamp(1, 7)}"] : []
+        opts << "w=#{width.clamp(0, 7)}" if width
+        if fracn
+          opts << "n=#{fracn = fracn.clamp(0, 15)}"
+          opts << "d=#{fracd.clamp(fracn + 1, 15)}" if fracd
+          case vertical
+          when 0, :top
+            opts << 'v=0'
+          when 1, :bottom
+            opts << 'v=1'
+          when 2, :centered, :center
+            opts << 'v=2'
+          end
+          case horizontal
+          when 0, :left
+            opts << 'h=0'
+          when 1, :right
+            opts << 'h=1'
+          when 2, :centered, :center
+            opts << 'h=2'
+          end
+        end
+        "\e]66;#{opts.join(':')};#{text}\a"
+      end
+
       #
       # @!endgroup
       #
@@ -559,13 +616,13 @@ module Terminal
     # @!visibility private
     CURSOR_HIDE = "\e[?25l"
 
-    # CURSOR_POS_SAVE_SCO = "\e[s"
-    # CURSOR_POS_SAVE_DEC = "\e7"
+    # @comment CURSOR_POS_SAVE_SCO = "\e[s"
+    # @comment CURSOR_POS_SAVE_DEC = "\e7"
     # @!visibility private
     CURSOR_POS_SAVE = "\e7"
 
-    # CURSOR_POS_RESTORE_SCO = "\e[u"
-    # CURSOR_POS_RESTORE_DEC = "\e8"
+    # @comment CURSOR_POS_RESTORE_SCO = "\e[u"
+    # @comment CURSOR_POS_RESTORE_DEC = "\e8"
     # @!visibility private
     CURSOR_POS_RESTORE = "\e8"
 
@@ -582,11 +639,18 @@ module Terminal
     SCREEN_SAVE = "\e[?47h"
     # @!visibility private
     SCREEN_RESTORE = "\e[?47l"
+
     # @!visibility private
-    SCREEN_ALTERNATE = "\e[?1049h"
+    # @comment at least Kitty requires CURSOR_HOME too
+    SCREEN_ALTERNATE = "\e[?1049h#{CURSOR_HOME}".freeze
     # @!visibility private
     SCREEN_ALTERNATE_OFF = "\e[?1049l"
 
+    # @!visibility private
+    SCREEN_REVERSE_MODE_ON = "\e[?5h"
+    # @!visibility private
+    SCREEN_REVERSE_MODE_OFF = "\e[?5l"
+
     # @!visibility private
     LINE_ERASE = line_erase.freeze
     # @!visibility private
@@ -597,14 +661,22 @@ module Terminal
     LINE_ERASE_PREV = "#{cursor_prev_line(nil)}#{LINE_ERASE}".freeze
 
     # @comment seems not widely supported:
-    # @comment  doubled!? def cursor_column(column = 1) = "\e[#{column}`"
-    # @comment  doubled!? def cursor_row(row = 1) = "\e[#{row}d"
-    # @comment  def cursor_column_rel(columns = 1) = "\e[#{columns}a"
-    # @comment  def cursor_row_rel(rows = 1) = "\e[#{rows}e"
-    # @comment  def cursor_tab(count = 1) = "\e[#{column}I"
-    # @comment  def cursor_reverse_tab(count = 1) = "\e[#{count}Z"
-    # @comment  def chars_delete(count = 1) = "\e[#{count}P"
-    # @comment  def chars_erase(count = 1) = "\e[#{count}X"
-    # @comment  def notify(title) = "\e]9;#{title}\a"
+    #   doubled!? def cursor_column(column = 1) = "\e[#{column}`"
+    #   doubled!? def cursor_row(row = 1) = "\e[#{row}d"
+    #   def cursor_column_rel(columns = 1) = "\e[#{columns}a"
+    #   def cursor_row_rel(rows = 1) = "\e[#{rows}e"
+    #   def cursor_tab(count = 1) = "\e[#{column}I"
+    #   def cursor_reverse_tab(count = 1) = "\e[#{count}Z"
+    #   def chars_delete(count = 1) = "\e[#{count}P"
+    #   def chars_erase(count = 1) = "\e[#{count}X"
+    #   def notify(title) = "\e]9;#{title}\a"
+
+    # @comment TODO:
+    #   https://sw.kovidgoyal.net/kitty/desktop-notifications
+    #   https://sw.kovidgoyal.net/kitty/pointer-shapes
+    #   https://sw.kovidgoyal.net/kitty/unscroll
+    #   https://sw.kovidgoyal.net/kitty/color-stack
+    #   https://sw.kovidgoyal.net/kitty/deccara
+    #   https://sw.kovidgoyal.net/kitty/clipboard
   end
 end

data/lib/terminal/input/csiu_mode.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Terminal
+  module CSIUMode
+    class << self
+      def type = :csi_u
+
+      def key_name(key)
+        return unless key
+        return ORD[key.ord] if key.size == 1
+        return if key[0] != "\e"
+        return C0_LEGACY[key[1].ord] if key.size == 2 # ESC ?
+        return csi(key) if key[1] == '['
+        SS3[key[2].ord] if key[1] == 'O' && key.size == 3 # ESC O ?
+      end
+
+      private
+
+      def csi(key)
+        type = key[-1]
+        return unicode(key) if type == 'u' # ESC [ ? u
+        return legacy(key) if type == '~' # ESC [ ? ; <modifier> ~
+        if key.size == 3 # ESC [ ?
+          ord = type.ord
+          return ord == 0x5a ? 'Shift+Tab' : SS3[ord]
+        end
+        return if key.size < 5
+        return unless key.start_with?("\e[1;")
+        # ESC [ 1 ; <modifier> ?
+        name = SS3[type.ord] or return
+        mod = key[4..-2]
+        mod.empty? ? name : modifier(name, mod.to_i - 1)
+      end
+
+      def unicode(key)
+        with_modifier(key) { ORD[_1] || _1.chr(Encoding::UTF_8) }
+      end
+
+      def legacy(key)
+        with_modifier(key) { _1 == 13 ? 'F3' : ORD[_1] }
+      end
+
+      def with_modifier(key)
+        code, mod = key[2..-2].split(';', 2)
+        code = yield(code.to_i) or return
+        mod ? modifier(code, mod.to_i - 1) : code
+      end
+
+      def modifier(name, mod)
+        (MODS.filter_map { |b, n| n if mod.allbits?(b) } << name).join('+')
+      end
+    end
+
+    ORD = {
+      0x02 => 'Ins',
+      0x03 => 'Del',
+      0x05 => 'PageUp',
+      0x06 => 'PageDown',
+      0x07 => 'Home',
+      0x08 => 'End',
+      0x09 => 'Tab',
+      0x0b => 'F1',
+      0x0c => 'F2',
+      0x0d => 'Enter',
+      0x0e => 'F4',
+      0x0f => 'F5',
+      0x11 => 'F6',
+      0x12 => 'F7',
+      0x13 => 'F8',
+      0x14 => 'F9',
+      0x15 => 'F10',
+      0x17 => 'F11',
+      0x18 => 'F12',
+      0x1b => 'Esc',
+      0x7f => 'Back'
+    }.compare_by_identity.freeze
+
+    # ESC ?
+    C0_LEGACY = {
+      0x00 => 'Ctrl+Space',
+      0x08 => 'Ctrl+Back',
+      0x09 => 'Alt+Tab',
+      0x0d => 'Alt+Enter',
+      0x1b => 'Alt+Esc',
+      0x20 => 'Alt+Space',
+      0x64 => 'Alt+Del',
+      0x7f => 'Alt+Back'
+    }.compare_by_identity.freeze
+
+    # ESC [ ?
+    # ESC [ O ?
+    SS3 = {
+      0x41 => 'Up', # A
+      0x42 => 'Down', # B
+      0x43 => 'Right', # C
+      0x44 => 'Left', # D
+      0x46 => 'End', # F
+      0x48 => 'Home', # H
+      0x50 => 'F1', # P
+      0x51 => 'F2', # Q
+      0x52 => 'F3', # R
+      0x53 => 'F4' # S
+    }.compare_by_identity.freeze
+
+    MODS = {
+      1 => 'Shift',
+      2 => 'Alt',
+      4 => 'Ctrl',
+      8 => 'Super',
+      16 => 'Hyper',
+      32 => 'Meta',
+      64 => 'Caps',
+      128 => 'Num'
+    }.freeze
+  end
+  private_constant :CSIUMode
+end

data/lib/terminal/input/legacy_mode.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Terminal
+  module LegacyMode
+    class << self
+      def type = :legacy
+
+      def key_name(key)
+        return unless key
+        return ORD[key.ord] if key.size == 1
+        return if key[0] != "\e"
+        return csi(key) if key[1] == '['
+        SS3[key[2].ord] if key[1] == 'O' && key.size == 3 # ESC O ?
+      end
+
+      private
+
+      def csi(key)
+        return legacy(key) if key[-1] == '~' # ESC [ ? ; <modifier> ~
+        if key.size == 3 # ESC [ ?
+          ord = key[2].ord
+          return ord == 0x5a ? 'Shift+Tab' : SS3[ord]
+        end
+        # ESC [ 1 ; <modifier> ?
+        return if key.size < 5
+        return unless key.start_with?("\e[1;")
+        # ESC [ ? {ABCDEFHPQRS}
+        name = SS3[key[-1].ord] or return
+        mod = key[4..-2]
+        mod.empty? ? name : modifier(name, mod.to_i - 1)
+      end
+
+      def legacy(key)
+        with_modifier(key) { LEGACY[_1] }
+      end
+
+      def with_modifier(key)
+        code, mod = key[2..-2].split(';', 2)
+        code = yield(code.to_i) or return
+        mod ? modifier(code, mod.to_i - 1) : code
+      end
+
+      def modifier(name, mod)
+        (MODS.filter_map { |b, n| n if mod.allbits?(b) } << name).join('+')
+      end
+    end
+
+    ORD = {
+      0x00 => 'Ctrl+2',
+      0x01 => 'Ctrl+a',
+      0x02 => 'Ctrl+b',
+      0x03 => 'Ctrl+c',
+      0x04 => 'Del',
+      0x05 => 'Ctrl+e',
+      0x06 => 'Ctrl+f',
+      0x07 => 'Ctrl+g',
+      0x08 => 'Ctrl+h',
+      0x09 => 'Tab',
+      0x0a => 'Ctrl+j',
+      0x0b => 'Ctrl+k',
+      0x0c => 'Ctrl+l',
+      0x0d => 'Enter',
+      0x0e => 'Ctrl+n',
+      0x0f => 'Ctrl+o',
+      0x10 => 'Ctrl+p',
+      0x11 => 'Ctrl+q',
+      0x12 => 'Ctrl+r',
+      0x13 => 'Ctrl+s',
+      0x14 => 'Ctrl+t',
+      0x15 => 'Ctrl+u',
+      0x16 => 'Ctrl+v',
+      0x17 => 'Ctrl+w',
+      0x18 => 'Ctrl+x',
+      0x19 => 'Ctrl+y',
+      0x1a => 'Ctrl+z',
+      0x1d => 'Ctrl+ü', # FIND AM
+      0x1e => 'Ctrl+^', # FIND AM
+      0x1f => 'Ctrl+-',
+      0x1b => 'Esc',
+      0x7f => 'Back'
+    }.compare_by_identity.freeze
+
+    # ESC [ ?
+    # ESC [ O ?
+    SS3 = {
+      0x41 => 'Up', # A
+      0x42 => 'Down', # B
+      0x43 => 'Right', # C
+      0x44 => 'Left', # D
+      0x46 => 'End', # F
+      0x48 => 'Home', # H
+      0x50 => 'F1', # P
+      0x51 => 'F2', # Q
+      0x52 => 'F3', # R
+      0x53 => 'F4' # S
+    }.compare_by_identity.freeze
+
+    LEGACY = {
+      0x03 => 'Del',
+      0x0f => 'F5',
+      0x11 => 'F6',
+      0x12 => 'F7',
+      0x13 => 'F8',
+      0x14 => 'F9',
+      0x15 => 'F10',
+      0x17 => 'F11',
+      0x18 => 'F12'
+    }.compare_by_identity.freeze
+
+    MODS = {
+      1 => 'Shift',
+      2 => 'Alt',
+      4 => 'Ctrl',
+      8 => 'Super',
+      16 => 'Hyper',
+      32 => 'Meta',
+      64 => 'Caps',
+      128 => 'Num'
+    }.freeze
+  end
+  private_constant :LegacyMode
+end

data/lib/terminal/input.rb

@@ -4,9 +4,22 @@ require 'io/console'
 
 module Terminal
   class << self
+    # Supported input mode.
+    #
+    # @attribute [r] input_mode
+    # @return [:csi_u] when CSIu protocol support
+    # @return [:legacy] for standard terminal
+    # @return [:dumb] for non-interactive input (pipes etc.)
+    # @return [:error] when input device is closed
+    def input_mode
+      return @inp_mode.type if (@inp ||= find_inp) == READ_TTY_INP
+      return :dumb if @inp == READ_DUMB_INP
+      :error
+    end
+
     # Read next keyboard input.
     #
-    # The input will be returned as named key codes like "Ctrl+C" by default.
+    # The input will be returned as named key codes like "Ctrl+c" by default.
     # This can be changed by `mode`.
     #
     # @param [:named, :raw, :both] mode modifies the result
@@ -14,175 +27,58 @@ module Terminal
     # @return [String] key name in `:named` mode
     # @return [[String, String]] key code and key name in `:both` mode
     def read_key(mode: :named)
-      key = _raw_read_key or return
+      key = (@inp ||= find_inp).call or return
       return key if mode == :raw
-      mode == :both ? [key, _key_name(key)] : _key_name(key) || key
+      return key, @inp_mode.key_name(key) if mode == :both
+      @inp_mode.key_name(key) || key
     end
 
     private
 
-    def _raw_read_key
-      return unless @in
-      return @in.getc unless @in.tty?
-      key = @in.getch
-      while (nc = @in.read_nonblock(1, exception: false))
-        String === nc ? key += nc : break
+    def find_inp
+      return READ_DUMB_INP unless STDIN.tty?
+      return READ_TTY_INP if !ansi? || _write("\e[>1u\e[?u\e[c").nil?
+      while true
+        result = READ_TTY_INP.call
+        if result.include?("\e[?1u")
+          @inp_mode = CSIUMode
+          at_exit { _write("\e[<u") } if ENV['ENV'] != 'test'
+        end
+        return READ_TTY_INP if result[-1] == 'c'
       end
-      key
-    rescue Interrupt
-      key
     rescue IOError, SystemCallError
-      @in = nil
-    end
-
-    def _key_name(key)
-      return unless key
-      return KEY_MAP[key]&.dup if key.size != 1
-      KEY_MAP[key]&.dup if (ord = key.ord) == 127 || (ord > 0 && ord < 28)
+      -> {}
+    ensure
+      @inp_mode ||= LegacyMode
     end
   end
 
-  @in = STDIN
-
-  KEY_MAP =
-    Module
-      .new do
-        def self.add_modifiers(keys)
-          @mods.each_pair do |mod, pref|
-            keys.each_pair do |name, code|
-              @map["\e[1;#{mod}#{code}"] = "#{pref}+#{name}"
-            end
-          end
-        end
-
-        def self.add_keys(keys)
-          keys.each_pair { |name, code| @map["\e[#{code}"] = name }
-          add_modifiers(keys)
-        end
-
-        def self.add_fkeys(keys)
-          keys.each_pair { |name, code| @map["\e[#{code}~"] = name }
-          @mods.each_pair do |mod, prefix|
-            keys.each_pair do |name, code|
-              @map["\e[#{code};#{mod}~"] = "#{prefix}+#{name}"
-            end
-          end
-        end
-
-        def self.to_hash
-          num = 0
-          @map = ('A'..'Z').to_h { [(num += 1).chr, "Ctrl+#{_1}"] }
-
-          add_keys(
-            'F1' => 'P',
-            'F2' => 'Q',
-            'F3' => 'R',
-            'F4' => 'S',
-            'Up' => 'A',
-            'Down' => 'B',
-            'Right' => 'C',
-            'Left' => 'D',
-            'End' => 'F',
-            'Home' => 'H'
-          )
-
-          add_fkeys(
-            'Del' => '3',
-            'PgUp' => '5',
-            'PgDown' => '6',
-            # -
-            'F1' => 'F1',
-            'F2' => 'F2',
-            'F3' => 'F3',
-            'F4' => 'F4',
-            # -
-            'F5' => '15',
-            'F6' => '17',
-            'F7' => '18',
-            'F8' => '19',
-            'F9' => '20',
-            'F10' => '21',
-            'F11' => '23',
-            'F12' => '24',
-            'F13' => '25',
-            'F14' => '26',
-            'F15' => '28',
-            'F16' => '29',
-            'F17' => '31',
-            'F18' => '32',
-            'F19' => '33',
-            'F20' => '34'
-          )
-
-          add_fkeys('F3' => '13') # Kitty
-
-          # Kitty:
-          @mods.each_pair do |mod, pref|
-            ('a'..'z').each do |char|
-              @map["\e[#{char.ord};#{mod}u"] = "#{pref}+#{char.upcase}"
-            end
-          end
-
-          {
-            'Esc' => "\e",
-            'Enter' => "\r",
-            'Tab' => "\t",
-            'Back' => "\u007F",
-            'Shift+Tab' => "\e[Z"
-          }.each_pair do |name, code|
-            @map[code] = name
-            @map["\e#{code}"] = "Alt+#{name}" # Kitty
-          end
-
-          # overrides and additional keys
-          @map.merge!(
-            "\b" => 'Ctrl+Back',
-            "\e\b" => 'Ctrl+Alt+Back', # Kitty
-            "\4" => 'Del',
-            "\e[5" => 'PgUp',
-            "\e[6" => 'PgDown',
-            # SS3 control (VT 100 etc)
-            "\eOA" => 'Up',
-            "\eOB" => 'Down',
-            "\eOC" => 'Right',
-            "\eOD" => 'Left',
-            "\eOP" => 'F1',
-            "\eOQ" => 'F2',
-            "\eOR" => 'F3',
-            "\eOS" => 'F4',
-            "\eO2P" => 'Shift+F1',
-            "\eO2Q" => 'Shift+F2',
-            "\eO2R" => 'Shift+F3',
-            "\eO2S" => 'Shift+F4',
-            "\eOt" => 'F5',
-            "\eOu" => 'F6',
-            "\eOv" => 'F7',
-            "\eOw" => 'F8',
-            "\eOl" => 'F9',
-            "\eOx" => 'F10'
-          )
-        end
+  READ_DUMB_INP =
+    lambda do
+      STDIN.getc
+    rescue Interrupt
+      nil
+    rescue IOError, SystemCallError
+      @inp = -> {}
+      nil
+    end
 
-        @mods = {
-          2 => 'Shift',
-          3 => 'Alt',
-          4 => 'Alt-Shift',
-          5 => 'Ctrl',
-          6 => 'Ctrl-Shift',
-          7 => 'Ctrl-Alt',
-          8 => 'Ctrl-Alt-Shift',
-          9 => 'Meta',
-          10 => 'Meta-Shift',
-          11 => 'Meta-Alt',
-          12 => 'Meta-Alt-Shift',
-          13 => 'Ctrl-Meta',
-          14 => 'Ctrl-Meta-Shift',
-          15 => 'Ctrl-Meta-Alt',
-          16 => 'Ctrl-Meta-Alt-Shift'
-        }.compare_by_identity
+  READ_TTY_INP =
+    lambda do
+      key = STDIN.getch
+      while (nc = STDIN.read_nonblock(1, exception: false))
+        String === nc ? key += nc : break
       end
-      .to_hash
-      .freeze
+      key
+    rescue Interrupt
+      key
+    rescue IOError, SystemCallError
+      @inp = READ_DUMB_INP
+      nil
+    end
 
-  private_constant :KEY_MAP
+  dir = __dir__
+  autoload :LegacyMode, "#{dir}/input/legacy_mode.rb"
+  autoload :CSIUMode, "#{dir}/input/csiu_mode.rb"
+  private_constant :READ_DUMB_INP, :READ_TTY_INP, :LegacyMode, :CSIUMode
 end

data/lib/terminal/rspec/helper.rb

@@ -7,6 +7,7 @@ RSpec.shared_context 'with Terminal' do |mod, ansi: true, winsize: [25, 80]|
   let(:terminal) do
     load('terminal/ansi/attributes.rb', wrapper_module)
     load('terminal/ansi.rb', wrapper_module)
+    load('terminal/input/legacy_mode.rb', wrapper_module)
     load('terminal/input.rb', wrapper_module)
     load('terminal/detect.rb', wrapper_module)
     load('terminal.rb', wrapper_module)

data/lib/terminal/version.rb

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

data/lib/terminal.rb

@@ -6,16 +6,21 @@ require_relative 'terminal/input'
 #
 # Terminal access with support for ANSI control codes and
 # [BBCode-like](https://en.wikipedia.org/wiki/BBCode) embedded text attribute
-# syntax.
+# syntax (see {Ansi.bbcode}).
 #
-# It automagically detects whether your terminal supports ANSI features.
+# 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}).
 #
 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.
+    # ANSI control codes to the terminal, {read_key} will not support CSIu.
     #
     # @attribute [r] ansi?
     # @return [Boolean] whether ANSI control codes are supported

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -34,6 +34,8 @@ files:
 - lib/terminal/ansi/named_colors.rb
 - lib/terminal/detect.rb
 - lib/terminal/input.rb
+- lib/terminal/input/csiu_mode.rb
+- lib/terminal/input/legacy_mode.rb
 - lib/terminal/preload.rb
 - lib/terminal/rspec/helper.rb
 - lib/terminal/text.rb
@@ -47,7 +49,7 @@ metadata:
   rubygems_mfa_required: 'true'
   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/0.9.1/Terminal
+  documentation_uri: https://rubydoc.info/gems/terminal_rb/0.9.3/Terminal
 rdoc_options: []
 require_paths:
 - lib