terminal_rb 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 834587f3bf9e66077d0ad33b8391100863ec8932e4eafd31077684c8a982d03c
-  data.tar.gz: fd95fac927978b7bdbc39d71797d165b42a787a6a35139418c6a445192258e83
+  metadata.gz: 756d1e0e016472a063f9d64650f4731ef6e8fe272d6a84c4e001119f050af3ea
+  data.tar.gz: 74c24ba64e08e6dc79605c17b0ded59ecb8784a45f95dbe5be7f231c889fdab7
 SHA512:
-  metadata.gz: 7f5284ff90de5ee142d3e11414df40148eef0dca7bb216e000f4f7a3474c416bba644cdb2a44656612eae33bb7e0933424ef34161a7cd247b89054ab99538bbe
-  data.tar.gz: 979db236870e067f58d25e18ca4bc5ce088c1558b8db8c59e95017656c28cf6e762593849fa4e9d44a2d716654b81e02d643ca43d2ba83528410070c8a8e70c7
+  metadata.gz: 68bb81c425cb5df44650acc351a28cbbb3eccaea53b405167f1207ba3dc528093de6322bac087fad9301da7470711b4cd399f120233637e9b92f1727e9e2d4c9
+  data.tar.gz: 9e855ec0401d22c615fd6ff25e2adae7717ecbf3578ea40425e5ef580b9520ee23130c8d49814034f682590166d2319070c17c18407962fc8782b18c1fffe4fa

data/README.md

@@ -14,7 +14,7 @@ Terminal access with super fast ANSI control codes support and [BBCode-like](htt
 - [NO_COLOR convention](https://no-color.org) support
 - 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
-- generation of word-by-word wrapped text
+- word-wise line break generator
 - supports [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol)
 
 ## Examples

data/examples/bbcode.rb

@@ -7,12 +7,13 @@ Terminal.puts <<~TEXT
   ✅ [b bright_green]Terminal.rb::Ansi[/b] — BBCode:[/]
 
               [b]Bold[/b]   [\\b]...[\\/b] or [\\bold]...[\\/bold]
-             [faint]Faint[/faint]   [\\faint]...[\\/faint]
-            [i]Italic[/i]   [\\i]...[\\/i] or [\\|italic]...[\\/italic]
+             [dim]Dim[/dim]     [\\d]...[\\/d] or [\\dim]...[\\/dim]
+            [i]Italic[/i]   [\\i]...[\\/i] or [\\italic]...[\\/italic]
+         [u]Underline[/u]   [\\u]...[\\/u] or [\\|undeline]...[\\/undeline]
             [inv]Invert[/inv]   [\\inv]...[\\/inv] or [\\invert]...[\\/invert]
-            [strike]Strike[/strike]   [\\strike]...[\\/strike]
               [h]Hide[/h]   [\\h]...[\\/h] or [\\hide]...[\\/hide] or [\\conceal]...[\\/conceal]
-        [blink]Slow blink[/blink]   [\\blink]...[\\/blink] or [\\slow_blink]...[\\/slow_blink]
+            [strike]Strike[/strike]   [\\strike]...[\\/strike]
+             [blink]Blink[/blink]   [\\blink]...[\\/blink]
          [u]Underline[/u]   [\\u]...[\\/u] or [\\underline]...[\\/underline]
   [uu]Double underline[/uu]   [\\uu]...[\\/uu] or [\\double_underline]...[\\/double_underline]
    [cu]Curly underline[/cu]   [\\cu]...[\\/cu] or [\\curly_underline]...[\\/curly_underline]

data/lib/terminal/ansi.rb

@@ -12,7 +12,7 @@ module Terminal
       #
       # @attribute [r] attributes
       # @return [Array<Symbol>] all attribute names
-      def attributes = @attr_sym.keys
+      def attributes = @attributes.dup
 
       # Supported 3/4-bit color names.
       #
@@ -20,7 +20,7 @@ module Terminal
       #
       # @attribute [r] colors
       # @return [Array<Symbol>] all color names
-      def colors = @colors_sym.keys
+      def colors = @colors.dup
 
       # Supported basic 24-bit (Kitty compatible) color names.
       #
@@ -99,10 +99,9 @@ module Terminal
             .map do |arg|
               case arg
               when String
-                @attr[arg] || @colors[arg] || _color(arg) || _invalid(arg)
+                @attr_map[arg] || _invalid(arg)
               when Symbol
-                @attr_sym[arg] || @colors_sym[arg] || _color(arg) ||
-                  _invalid(arg)
+                @attrs_map[arg] || _invalid(arg)
               when (0..255)
                 "38;5;#{arg}"
               when (256..511)
@@ -179,11 +178,7 @@ module Terminal
       def try_convert(attributes, separator: ' ')
         return unless attributes
         return if (attributes = attributes.to_s.split(separator)).empty?
-        "\e[#{
-          attributes
-            .map! { @attr[_1] || @colors[_1] || _color(_1) || return }
-            .join(';')
-        }m"
+        "\e[#{attributes.map! { @attr_map[_1] || return }.join(';')}m"
       end
 
       # Test if all given attributes are valid.
@@ -196,9 +191,9 @@ module Terminal
         attributes.all? do |arg|
           case arg
           when String
-            @attr[arg] || @colors[arg] || _color(arg)
+            @attr_map[arg]
           when Symbol
-            @attr_sym[arg] || @colors_sym[arg] || _color(arg)
+            @attrs_map[arg]
           when (0..767)
             true
           end
@@ -249,7 +244,7 @@ module Terminal
           match = Regexp.last_match(1) or next match_str
           next "[#{match[1..]}]" if match[0] == '\\'
           next match_str if (match = match.split).empty?
-          next if match.all? { @attr[_1] || @colors[_1] || _color(_1) }
+          next if match.all? { @attr_map[_1] }
           match_str
         end
       end
@@ -277,7 +272,7 @@ module Terminal
             match = Regexp.last_match(1) or next match_str
             next "[#{match[1..]}]" if match[0] == '\\'
             next match_str if (match = match.split).empty?
-            next if match.all? { @attr[_1] || @colors[_1] || _color(_1) }
+            next if match.all? { @attr_map[_1] }
             match_str
           end
         str.index("\e") ? str.gsub!(@re_test, '') : str
@@ -586,9 +581,9 @@ module Terminal
       end
     end
 
-    @cbase =
-      { 'bg' => '48', 'on' => '48', 'ul' => '58' }.tap { _1.default = '38' }
-        .freeze
+    @cbase = { 'bg' => '48', 'on' => '48', 'ul' => '58' }
+    @cbase.default = '38'
+    @cbase.freeze
 
     @re_test =
       /
@@ -599,7 +594,195 @@ module Terminal
 
     @re_bbcode = /(?:\[((?~[\[\]]))\])/
 
-    require_relative 'ansi/attributes'
+    attr_map = {
+      '' => 'reset',
+      '1' => 'bold',
+      '2' => 'faint',
+      '3' => 'italic',
+      '4' => 'underline',
+      '5' => 'blink',
+      '6' => 'rapid_blink',
+      '7' => 'invert',
+      '8' => 'hide',
+      '9' => 'strike',
+      '10' => 'primary_font',
+      '11' => 'font1',
+      '12' => 'font2',
+      '13' => 'font3',
+      '14' => 'font4',
+      '15' => 'font5',
+      '16' => 'font6',
+      '17' => 'font7',
+      '18' => 'font8',
+      '19' => 'font9',
+      '20' => 'fraktur',
+      '21' => 'double_underline',
+      '22' => 'bold_off', # faint_off
+      '23' => 'italic_off', # fraktur_off
+      '24' => 'underline_off', # double_underline_off
+      '25' => 'blink_off', # rapid_blink_off
+      '26' => 'proportional',
+      '27' => 'invert_off',
+      '28' => 'hide_off',
+      '29' => 'strike_off',
+      # colors ...
+      '50' => 'proportional_off',
+      '51' => 'framed',
+      '52' => 'encircled',
+      '53' => 'overlined',
+      '54' => 'framed_off', # encircled_off
+      '55' => 'overlined_off',
+      # ...
+      '73' => 'superscript',
+      '74' => 'subscript',
+      '75' => 'superscript_off', # subscript_off
+      # special underline
+      '4:3' => 'curly_underline',
+      '4:4' => 'dotted_underline',
+      '4:5' => 'dashed_underline',
+      '4:0' => 'curly_underline_off' # dotted_underline_off, dashed_underline_off
+    }.invert
+    attr_alias = ->(t, s) { attr_map[t] = attr_map[s] }
+
+    clr_map = {
+      # foreground
+      '30' => 'black',
+      '31' => 'red',
+      '32' => 'green',
+      '33' => 'yellow',
+      '34' => 'blue',
+      '35' => 'magenta',
+      '36' => 'cyan',
+      '37' => 'white',
+      '39' => 'default', # reset
+      # background
+      '40' => 'on_black',
+      '41' => 'on_red',
+      '42' => 'on_green',
+      '43' => 'on_yellow',
+      '44' => 'on_blue',
+      '45' => 'on_magenta',
+      '46' => 'on_cyan',
+      '47' => 'on_white',
+      '49' => 'on_default', # reset
+      # underline
+      '58;2;0;0;0' => 'ul_black',
+      '58;2;0;0;128' => 'ul_blue',
+      '58;2;0;0;255' => 'ul_bright_blue',
+      '58;2;0;128;0' => 'ul_green',
+      '58;2;0;128;128' => 'ul_cyan',
+      '58;2;0;255;0' => 'ul_bright_green',
+      '58;2;0;255;255' => 'ul_bright_cyan',
+      '58;2;128;0;0' => 'ul_red',
+      '58;2;128;0;128' => 'ul_magenta',
+      '58;2;128;128;0' => 'ul_yellow',
+      '58;2;128;128;128' => 'ul_white',
+      '58;2;255;0;0' => 'ul_bright_red',
+      '58;2;255;0;255' => 'ul_bright_magenta',
+      '58;2;255;255;0' => 'ul_bright_yellow',
+      '58;2;255;255;255' => 'ul_bright_white',
+      '58;2;64;64;64' => 'ul_bright_black',
+      '59' => 'ul_default', # reset
+      # bright foreground
+      '90' => 'bright_black',
+      '91' => 'bright_red',
+      '92' => 'bright_green',
+      '93' => 'bright_yellow',
+      '94' => 'bright_blue',
+      '95' => 'bright_magenta',
+      '96' => 'bright_cyan',
+      '97' => 'bright_white',
+      # bright background
+      '100' => 'on_bright_black',
+      '101' => 'on_bright_red',
+      '102' => 'on_bright_green',
+      '103' => 'on_bright_yellow',
+      '104' => 'on_bright_blue',
+      '105' => 'on_bright_magenta',
+      '106' => 'on_bright_cyan',
+      '107' => 'on_bright_white'
+    }.invert
+    clr_alias = ->(t, s) { clr_map[t] = clr_map[s] }
+
+    %w[black red green yellow blue magenta cyan white].each do |name|
+      clr_alias["fg_#{name}", name]
+      clr_alias["bg_#{name}", "on_#{name}"]
+      clr_alias["fg_bright_#{name}", "bright_#{name}"]
+      clr_alias["bg_bright_#{name}", "on_bright_#{name}"]
+    end
+    clr_alias['fg_default', 'default']
+    clr_alias['bg_default', 'on_default']
+
+    attr_alias['faint_off', 'bold_off']
+    attr_alias['fraktur_off', 'italic_off']
+    attr_alias['double_underline_off', 'underline_off']
+    attr_alias['rapid_blink_off', 'blink_off']
+    attr_alias['encircled_off', 'framed_off']
+    attr_alias['subscript_off', 'superscript_off']
+    attr_alias['dotted_underline_off', 'curly_underline_off']
+    attr_alias['dashed_underline_off', 'curly_underline_off']
+
+    # extra aliases:
+    attr_alias['off', 'reset']
+    attr_alias['dim', 'faint']
+    attr_alias['dim_off', 'faint_off']
+    attr_alias['conceal', 'hide']
+    attr_alias['conceal_off', 'hide_off']
+    attr_alias['reveal', 'hide_off']
+    attr_alias['spacing', 'proportional']
+    attr_alias['spacing_off', 'proportional_off']
+
+    # shortcuts:
+    attr_alias['b', 'bold']
+    attr_alias['d', 'dim']
+    attr_alias['i', 'italic']
+    attr_alias['u', 'underline']
+    attr_alias['inv', 'invert']
+    attr_alias['h', 'hide']
+    attr_alias['s', 'strike']
+    attr_alias['uu', 'double_underline']
+    attr_alias['ovr', 'overlined']
+    attr_alias['sup', 'superscript']
+    attr_alias['sub', 'subscript']
+    attr_alias['cu', 'curly_underline']
+    attr_alias['dau', 'dashed_underline']
+    attr_alias['dou', 'dotted_underline']
+
+    @colors = clr_map.keys.map!(&:to_sym).sort!.freeze
+    @attributes = attr_map.keys.map!(&:to_sym).sort!.freeze
+
+    # shortcuts disable:
+    attr_map.keys.each do |n|
+      attr_alias["/#{n.delete_suffix('_off')}", n] if n.end_with?('_off')
+    end
+    attr_alias['/b', 'bold_off']
+    attr_alias['/d', 'dim_off']
+    attr_alias['/i', 'italic_off']
+    attr_alias['/u', 'underline_off']
+    attr_alias['/inv', 'invert_off']
+    attr_alias['/h', 'hide_off']
+    attr_alias['/s', 'strike_off']
+    attr_alias['/uu', 'double_underline_off']
+    attr_alias['/ovr', 'overlined_off']
+    attr_alias['/sup', 'superscript_off']
+    attr_alias['/sub', 'subscript_off']
+    attr_alias['/cu', 'curly_underline_off']
+    attr_alias['/dau', 'dashed_underline_off']
+    attr_alias['/dou', 'dotted_underline_off']
+
+    # additional shortcuts disable:
+    attr_alias['/', 'reset']
+    attr_map['/fg'] = clr_map['default']
+    attr_map['/bg'] = clr_map['on_default']
+    attr_map['/ul'] = clr_map['ul_default']
+
+    @attr_map = Hash.new { _color(_2) }
+    attr_map.merge!(clr_map).keys.sort!.each { @attr_map[_1] = attr_map[_1] }
+    @attr_map.freeze
+
+    @attrs_map = @attr_map.transform_keys(&:to_sym)
+    @attrs_map.default_proc = @attr_map.default_proc
+    @attrs_map.compare_by_identity.freeze
 
     autoload :NAMED_COLORS, "#{__dir__}/ansi/named_colors.rb"
     private_constant :NAMED_COLORS
@@ -689,14 +872,6 @@ module Terminal
     #
     #   def set_scroll_region(top = nil, bottom = nil) = "\e[#{top};#{bottom}r"
 
-    # @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
-
     # @comment other:
     #   "\eE" same as "\r\n"
     #   "\eD" same as "\n" but preserves X coord
@@ -705,5 +880,13 @@ module Terminal
     #   "\e[21t report window’s title as ESC ] l title ESC \"
     #   "\e[?1004h" report focus lost "\e[O" and focus get "\e[I"
     #     (disable by "\e[?1004l")
+
+    # @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/{as_key_event.rb → key_event.rb}

@@ -1,19 +1,39 @@
 # frozen_string_literal: true
 
 module Terminal
-  module AsKeyEvent
+  #
+  # Key event reported from {read_key_event}.
+  #
+  class KeyEvent
     class << self
+      # @attribute [w] caching
+      # @return [true, false] whether KeyCodes should be cached
+      def caching = !!@cache
+
+      # @attribute [w] caching
+      def caching=(value)
+        if value
+          @cache ||= {}
+        else
+          @cache = nil
+        end
+      end
+
+      # Translate a keyboard input string into a related KeyEvent
+      #
+      # @param [String] raw keyboard input
+      # @return [KeyEvent] related key event
       def [](raw)
-        return KeyEvent.new(raw, *@single_key[raw.ord]) if raw.size == 1
-        return KeyEvent.unknown(raw) if raw[0] != "\e"
+        return new(raw, *@single_key[raw.ord]) if raw.size == 1
+        return unknown(raw) if raw[0] != "\e"
         return esc1(raw, raw[1]) if raw.size == 2 # ESC ?
         case raw[1]
         when "\e" # ESC ESC ...
           return esc_esc(raw)
         when 'O'
-          return KeyEvent.new(raw, *@ss3[raw[2].ord]) if raw.size == 3 # ESC O ?
+          return 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 [ ?
+          return 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
@@ -29,18 +49,25 @@ module Terminal
             return mouse_sgr(raw) if raw[2] == '<'
           end
         end
-        KeyEvent.unknown(raw)
+        unknown(raw)
+      end
+
+      # @!visibility private
+      def new(raw, key = raw, modifier = 0, extra = nil)
+        @cache ? (@cache[raw] ||= super.freeze) : super.freeze
       end
 
       private
 
+      def unknown(raw) = new(raw, nil)
+
       def csi_u(raw)
         # ESC [ <code> u
         # ESC [ <code> ; <modifier> u
-        return KeyEvent.unknown(raw) if raw.size < 4
+        return unknown(raw) if raw.size < 4
         idx = raw.index(';')
         code = raw[2..(idx ? idx - 1 : -2)].to_i
-        KeyEvent.new(
+        new(
           raw,
           @csiu[code] || code.chr(Encoding::UTF_8),
           idx ? [raw[(idx + 1)..-2].to_i - 1, 0].max : 0
@@ -50,9 +77,9 @@ module Terminal
       def legacy(raw)
         # ESC [ <code> ~
         # ESC [ <code> ; <modifier> ~
-        return KeyEvent.unknown(raw) if raw.size < 4
+        return unknown(raw) if raw.size < 4
         idx = raw.index(';')
-        KeyEvent.new(
+        new(
           raw,
           @csi[raw[2..(idx ? idx - 1 : -2)].to_i],
           idx ? [raw[(idx + 1)..-2].to_i - 1, 0].max : 0
@@ -62,23 +89,23 @@ module Terminal
       def csi1(raw)
         # ESC [ 1 ; [~ABCDEFHPQRS]
         # ESC [ 1 ; <modifier> [~ABCDEFHPQRS]
-        return KeyEvent.unknown(raw) if raw.size < 5
+        return unknown(raw) if raw.size < 5
         key, modifier = @ss3[raw[-1].ord]
         modifier ||= 0
-        return KeyEvent.new(raw, nil, modifier) unless key
+        return new(raw, nil, modifier) unless key
         modifier |= [raw[4..-2].to_i - 1, 0].max if raw.size > 5
-        KeyEvent.new(raw, key, modifier)
+        new(raw, key, modifier)
       end
 
       def esc_esc(raw)
         return esc1(raw, raw[2]) if raw.size == 3 # ESC ESC ?
         ret = self[raw[1..]]
-        KeyEvent.new(raw, ret.key, ret.modifier | 2) # ESC ESC ...
+        new(raw, ret.key, ret.modifier | 2) # ESC ESC ...
       end
 
       def esc1(raw, char)
         key, modifier = @esc1[char.ord]
-        KeyEvent.new(raw, key || char, modifier || 2)
+        new(raw, key || char, modifier || 2)
       end
 
       def mouse_vt200(raw)
@@ -89,25 +116,25 @@ module Terminal
       def mouse_sgr(raw)
         # ESC [ < <code> ; <col> ; <row> M
         # ESC [ < <code> ; <col> ; <row> m
-        return KeyEvent.unknown(raw) if raw.size < 8
+        return 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)
+        bcr.size == 3 ? mouse_event(raw, *bcr) : unknown(raw)
       end
 
       def mouse_urxvt(raw)
         # ESC [ <code> ; <col> ; <row> M
-        return KeyEvent.unknown(raw) if raw.size < 8
+        return 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)
+        bcr.size == 3 ? mouse_event(raw, *bcr) : unknown(raw)
       end
 
       def mouse_event(raw, btn, col, row)
-        return KeyEvent.unknown(raw) if btn < 0 || col < 1 || row < 1
+        return 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])
+        new(raw, key, modifier, [col, row])
       end
 
       def mouse_event_key(btn)
@@ -118,6 +145,79 @@ module Terminal
       end
     end
 
+    # Event string 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 event string
+    attr_reader :raw
+
+    # Pressed key without any modifiers.
+    # This can be a string for simple keys like `"a"` or a Symbol like `:F12`.
+    # @return [String, Symbol] key without modifiers
+    attr_reader :key
+
+    # Modifier key code. This represents the encoded key modifier like `Shift`
+    # or `Alt`.
+    #
+    # @return [Integer] modifier key code
+    attr_reader :modifier
+
+    # @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
+    # keys.
+    #
+    # @return [String] key name
+    attr_reader :name
+
+    # @attribute [r] modifier?
+    # @return [true, false] whether a key modifier was pressed
+    def modifier? = @modifier != 0
+
+    # @attribute [r] simple?
+    # @return [true, false] whether a simple key was pressed
+    def simple? = @raw == @name
+
+    # All pressed keys.
+    # This is composed by all {modifier} and the {key}.
+    #
+    # @return [Array<Symbol, String>] all pressed keys
+    def to_a = @ary.dup
+
+    # @!visibility private
+    def to_ary = simple? ? [@raw] : [@raw, @name]
+
+    # @!visibility private
+    def to_s = @name.dup
+
+    # @!visibility private
+    def inspect = "<#{self.class.name} #{to_ary.map(&:inspect).join(' ')}>"
+
+    # @!visibility private
+    def freeze
+      @raw.freeze
+      @key.freeze
+      @extra.freeze
+      @name.freeze
+      super
+    end
+
+    private
+
+    def initialize(raw, key, modifier, extra)
+      @raw = raw
+      @key = key
+      @modifier = modifier
+      @extra = extra
+      @ary = MODIFIERS.filter_map { |b, n| n if modifier.allbits?(b) }
+      @ary << key if key
+      @name = @ary.join('+') # .encode(Encoding::UTF_8)
+    end
+
     @mouse_kind = %i[
       MButton1
       MButton2
@@ -310,6 +410,19 @@ module Terminal
       0x20 => :Space,
       0x7f => :Back
     }.compare_by_identity.freeze
+
+    @cache = {}
+
+    MODIFIERS = {
+      1 => :Shift,
+      2 => :Alt,
+      4 => :Ctrl,
+      8 => :Super,
+      16 => :Hyper,
+      32 => :Meta,
+      64 => :Caps,
+      128 => :Num
+    }.freeze
+    private_constant :MODIFIERS
   end
-  private_constant :AsKeyEvent
 end

data/lib/terminal/input.rb

@@ -26,13 +26,13 @@ module Terminal
     # The input will be returned as named key codes like "Ctrl+c" by default.
     # This can be changed by `mode`.
     #
-    # @deprecated Use arther {read_key_event} for better input handling.
+    # @deprecated Use rather {read_key_event} for better input handling.
     #
     # @param [:named, :raw, :both] mode modifies the result
     # @return [String] key code ("as is") in `:raw` mode
     # @return [String] key name in `:named` mode
     # @return [[String, String]] key code and key name in `:both` mode
-    # @return [nil] in any error case
+    # @return [nil] in error case
     def read_key(mode: :named)
       event = read_key_event or return
       return event.raw if mode == :raw
@@ -43,7 +43,7 @@ module Terminal
     # Read next {KeyEvent} from standard input.
     #
     # @return [KeyEvent] next event
-    # @return [nil] on any error
+    # @return [nil] in error case
     def read_key_event
       case input_mode
       when :dumb
@@ -52,23 +52,23 @@ module Terminal
         KeyEvent.new(raw, *opts)
       when :csi_u, :legacy
         # raw = with_mouse ? read_tty_with_mouse : read_tty
-        AsKeyEvent[raw] if (raw = read_tty)
+        KeyEvent[raw] if (raw = read_tty)
       end
     end
 
     private
 
     def find_input_mode
+      # order is important!
       im = ENV['INPUT_MODE']
       return :dumb if im == 'dumb'
       return :legacy if im == 'legacy'
       return :dumb unless STDIN.tty?
       if ansi? && _write("\e[>1u\e[?u\e[c") && csi_u?
         at_exit { _write("\e[<u") }
-        :csi_u
-      else
-        :legacy
+        return :csi_u
       end
+      :legacy
     rescue Interrupt
       :legacy
     rescue IOError, SystemCallError
@@ -130,120 +130,5 @@ module Terminal
     private_constant :DUMB_KEYS
   end
 
-  #
-  # Key event reported from {read_key_event}.
-  #
-  class KeyEvent
-    class << self
-      # @attribute [w] caching
-      # @return [true, false] whether KeyCodes should be cached
-      def caching = !!@cache
-
-      # @attribute [w] caching
-      def caching=(value)
-        if value
-          @cache ||= {}
-        else
-          @cache = nil
-        end
-      end
-
-      # @!visibility private
-      def new(raw, key = raw, modifier = 0, extra = nil)
-        @cache ? (@cache[raw] ||= super.freeze) : super.freeze
-      end
-
-      # @!visibility private
-      def unknown(raw) = new(raw, nil)
-    end
-
-    # Event string received from standard input.
-    # This can be a simple value like `"a"`or `"\e[24;6~"` (for Shift+Ctrl+F12).
-    #
-    # @return [String] received event string
-    attr_reader :raw
-
-    # Pressed key without any modifiers.
-    # This can be a string for simple keys like `"a"` or a Symbol like `:F12`.
-    # @return [String, Symbol] key without modifiers
-    attr_reader :key
-
-    # Modifier key code. This represents the encoded key modifier like `Shift`
-    # or `Alt`.
-    #
-    # @return [Integer] modifier key code
-    attr_reader :modifier
-
-    # @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
-    # keys.
-    #
-    # @return [String] key name
-    attr_reader :name
-
-    # @attribute [r] modifier?
-    # @return [true, false] whether a key modifier was pressed
-    def modifier? = @modifier != 0
-
-    # @attribute [r] simple?
-    # @return [true, false] whether a simple char was pressed
-    def simple? = @raw == @name
-
-    # All pressed keys.
-    # This is composed by all {modifier} and the {key}.
-    #
-    # @return [Array<Symbol, String>] all pressed keys
-    def to_a = @ary.dup
-
-    # @!visibility private
-    def to_ary = simple? ? [@raw] : [@raw, @name]
-
-    # @!visibility private
-    def to_s = @name.dup
-
-    # @!visibility private
-    def inspect = "<#{self.class.name} #{to_ary.map(&:inspect).join(' ')}>"
-
-    # @!visibility private
-    def freeze
-      @raw.freeze
-      @key.freeze
-      @extra.freeze
-      @name.freeze
-      super
-    end
-
-    private
-
-    def initialize(raw, key, modifier, extra)
-      @raw = raw
-      @key = key
-      @modifier = modifier
-      @extra = extra
-      @ary = MODIFIERS.filter_map { |b, n| n if modifier.allbits?(b) }
-      @ary << key if key
-      @name = @ary.join('+').encode(Encoding::UTF_8)
-    end
-
-    @cache = {}
-
-    MODIFIERS = {
-      1 => :Shift,
-      2 => :Alt,
-      4 => :Ctrl,
-      8 => :Super,
-      16 => :Hyper,
-      32 => :Meta,
-      64 => :Caps,
-      128 => :Num
-    }.freeze
-    private_constant :MODIFIERS
-  end
-
-  autoload :AsKeyEvent, "#{__dir__}/input/as_key_event.rb"
-  private_constant :AsKeyEvent
+  autoload :KeyEvent, "#{__dir__}/input/key_event.rb"
 end

data/lib/terminal/rspec/helper.rb

@@ -2,6 +2,7 @@
 
 RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, colors: 256, size: [25, 80], pos: [1, 1]|
   let(:stdout) { [] }
+  let(:stdin) { [] }
   let(:stdoutstr) { stdout.join }
 
   before do
@@ -9,21 +10,22 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
     allow(Terminal).to receive(:application).with(no_args).and_return(
       application
     )
+    allow(Terminal).to receive(:input_mode).with(no_args).and_return(
+      ansi ? :csi_u : :dumb
+    )
     allow(Terminal).to receive(:colors).with(no_args).and_return(
       colors == :true_color ? 16_777_216 : colors
     )
     allow(Terminal).to receive(:size).with(no_args).and_return(size)
     allow(Terminal).to receive(:pos).with(no_args).and_return(pos)
-    allow(Terminal).to receive(:hide_cursor).with(no_args).and_return(Terminal)
-    allow(Terminal).to receive(:show_cursor).with(no_args).and_return(Terminal)
-
-    if ansi
-      bbc = ->(s) { Terminal::Ansi.bbcode(s) }
-      nobbc = lambda(&:to_s)
-    else
-      bbc = ->(s) { Terminal::Ansi.plain(s) }
-      nobbc = ->(s) { Terminal::Ansi.undecorate(s) }
-    end
+
+    bbcode_ = {
+      true =>
+        ansi ?
+          ->(s) { Terminal::Ansi.bbcode(s) } :
+          ->(s) { Terminal::Ansi.plain(s) },
+      false => ansi ? lambda(&:to_s) : ->(s) { Terminal::Ansi.undecorate(s) }
+    }.compare_by_identity
 
     allow(Terminal).to receive(:<<) do |object|
       stdout.push(bbcode[object]) unless object.nil?
@@ -31,7 +33,7 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
     end
 
     allow(Terminal).to receive(:print) do |*objects, bbcode: true|
-      bbcode = bbcode ? bbc : nobbc
+      bbcode = bbcode_[bbcode]
       objects.flatten.each { stdout.push(bbcode[_1]) unless _1.nil? }
       nil
     end
@@ -42,7 +44,7 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
         stdout.push("\n")
         next
       end
-      bbcode = bbcode ? bbc : nobbc
+      bbcode = bbcode_[bbcode]
       objects.each do |s|
         next stdout.push("\n") if s.nil?
         stdout.push(s = bbcode[s])
@@ -55,5 +57,9 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
       stdout.push(object = object.to_s)
       object.bytesize
     end
+
+    allow(Terminal).to receive(:read_key_event) do
+      Terminal::KeyEvent[stdin.shift || raise('stdin buffer is empty')]
+    end
   end
 end

data/lib/terminal/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -9,9 +9,8 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: |
-  Terminal access with super fast ANSI control codes support and
-  BBCode-like embedded text attribute syntax.
+description: 'Terminal access with super fast ANSI control codes support, modern CSIu
+  input, word-wise line break, BBCode-like embedded text attribute syntax. '
 executables:
 - bbcode
 extensions: []
@@ -30,11 +29,10 @@ files:
 - examples/key-codes.rb
 - lib/terminal.rb
 - lib/terminal/ansi.rb
-- lib/terminal/ansi/attributes.rb
 - lib/terminal/ansi/named_colors.rb
 - lib/terminal/detect.rb
 - lib/terminal/input.rb
-- lib/terminal/input/as_key_event.rb
+- lib/terminal/input/key_event.rb
 - lib/terminal/rspec/helper.rb
 - lib/terminal/text.rb
 - lib/terminal/text/char_width.rb
@@ -65,5 +63,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.1
 specification_version: 4
-summary: Fast terminal access with ANSI and BBCode support.
+summary: Fast terminal access with ANSI, CSIu, BBCode, word-wise line break support.
 test_files: []

data/lib/terminal/ansi/attributes.rb

@@ -1,206 +0,0 @@
-# frozen_string_literal: true
-
-module Terminal
-  module Ansi
-    @attr = {
-      '/' => '',
-      '/b' => '22',
-      '/blink' => '25',
-      '/bold' => '22',
-      '/conceal' => '28',
-      '/cu' => '4:0',
-      '/curly_underline' => '4:0',
-      '/dashed_underline' => '4:0',
-      '/dau' => '4:0',
-      '/dim' => '22',
-      '/dotted_underline' => '4:0',
-      '/dou' => '4:0',
-      '/double_underline' => '24',
-      '/encircled' => '54',
-      '/faint' => '22',
-      '/fraktur' => '23',
-      '/framed' => '54',
-      '/h' => '28',
-      '/hide' => '28',
-      '/i' => '23',
-      '/inv' => '27',
-      '/invert' => '27',
-      '/italic' => '23',
-      '/overlined' => '55',
-      '/ovr' => '55',
-      '/proportional' => '50',
-      '/slow_blink' => '25',
-      '/spacing' => '50',
-      '/strike' => '29',
-      '/sub' => '75',
-      '/subscript' => '75',
-      '/sup' => '75',
-      '/superscript' => '75',
-      '/u' => '24',
-      '/underline' => '24',
-      '/uu' => '24',
-      'b' => '1',
-      'blink' => '5',
-      'blink_off' => '25',
-      'bold' => '1',
-      'bold_off' => '22',
-      'conceal' => '8',
-      'cu' => '4:3',
-      'curly_underline' => '4:3',
-      'curly_underline_off' => '4:0',
-      'dashed_underline' => '4:5',
-      'dashed_underline_off' => '4:0',
-      'dau' => '4:5',
-      'default_font' => '10',
-      'dim' => '2',
-      'dotted_underline' => '4:4',
-      'dotted_underline_off' => '4:0',
-      'dou' => '4:4',
-      'double_underline' => '21',
-      'double_underline_off' => '24',
-      'encircled' => '52',
-      'encircled_off' => '54',
-      'faint' => '2',
-      'faint_off' => '22',
-      'font1' => '11',
-      'font2' => '12',
-      'font3' => '13',
-      'font4' => '14',
-      'font5' => '15',
-      'font6' => '16',
-      'font7' => '17',
-      'font8' => '18',
-      'font9' => '19',
-      'fraktur' => '20',
-      'fraktur_off' => '23',
-      'framed' => '51',
-      'framed_off' => '54',
-      'h' => '8',
-      'hide' => '8',
-      'hide_off' => '28',
-      'i' => '3',
-      'inv' => '7',
-      'invert' => '7',
-      'invert_off' => '27',
-      'italic' => '3',
-      'italic_off' => '23',
-      'overlined' => '53',
-      'overlined_off' => '55',
-      'ovr' => '53',
-      'primary_font' => '10',
-      'proportional' => '26',
-      'proportional_off' => '50',
-      'rapid_blink' => '6',
-      'reset' => '',
-      'reveal' => '28',
-      'slow_blink' => '5',
-      'spacing' => '26',
-      'strike' => '9',
-      'strike_off' => '29',
-      'sub' => '74',
-      'subscript' => '74',
-      'subscript_off' => '75',
-      'sup' => '73',
-      'superscript' => '73',
-      'superscript_off' => '75',
-      'u' => '4',
-      'underline' => '4',
-      'underline_off' => '24',
-      'uu' => '21'
-    }.freeze
-
-    @colors = {
-      '/bg' => '49',
-      '/fg' => '39',
-      '/ul' => '59',
-      'bg_black' => '40',
-      'bg_blue' => '44',
-      'bg_bright_black' => '100',
-      'bg_bright_blue' => '104',
-      'bg_bright_cyan' => '106',
-      'bg_bright_green' => '102',
-      'bg_bright_magenta' => '105',
-      'bg_bright_red' => '101',
-      'bg_bright_white' => '107',
-      'bg_bright_yellow' => '103',
-      'bg_cyan' => '46',
-      'bg_default' => '49',
-      'bg_green' => '42',
-      'bg_magenta' => '45',
-      'bg_red' => '41',
-      'bg_white' => '47',
-      'bg_yellow' => '43',
-      'black' => '30',
-      'blue' => '34',
-      'bright_black' => '90',
-      'bright_blue' => '94',
-      'bright_cyan' => '96',
-      'bright_green' => '92',
-      'bright_magenta' => '95',
-      'bright_red' => '91',
-      'bright_white' => '97',
-      'bright_yellow' => '93',
-      'cyan' => '36',
-      'default' => '39',
-      'fg_black' => '30',
-      'fg_blue' => '34',
-      'fg_bright_black' => '90',
-      'fg_bright_blue' => '94',
-      'fg_bright_cyan' => '96',
-      'fg_bright_green' => '92',
-      'fg_bright_magenta' => '95',
-      'fg_bright_red' => '91',
-      'fg_bright_white' => '97',
-      'fg_bright_yellow' => '93',
-      'fg_cyan' => '36',
-      'fg_default' => '39',
-      'fg_green' => '32',
-      'fg_magenta' => '35',
-      'fg_red' => '31',
-      'fg_white' => '37',
-      'fg_yellow' => '33',
-      'green' => '32',
-      'magenta' => '35',
-      'on_black' => '40',
-      'on_blue' => '44',
-      'on_bright_black' => '100',
-      'on_bright_blue' => '104',
-      'on_bright_cyan' => '106',
-      'on_bright_green' => '102',
-      'on_bright_magenta' => '105',
-      'on_bright_red' => '101',
-      'on_bright_white' => '107',
-      'on_bright_yellow' => '103',
-      'on_cyan' => '46',
-      'on_default' => '49',
-      'on_green' => '42',
-      'on_magenta' => '45',
-      'on_red' => '41',
-      'on_white' => '47',
-      'on_yellow' => '43',
-      'red' => '31',
-      'ul_black' => '58;2;0;0;0',
-      'ul_blue' => '58;2;0;0;128',
-      'ul_bright_black' => '58;2;64;64;64',
-      'ul_bright_blue' => '58;2;0;0;255',
-      'ul_bright_cyan' => '58;2;0;255;255',
-      'ul_bright_green' => '58;2;0;255;0',
-      'ul_bright_magenta' => '58;2;255;0;255',
-      'ul_bright_red' => '58;2;255;0;0',
-      'ul_bright_white' => '58;2;255;255;255',
-      'ul_bright_yellow' => '58;2;255;255;0',
-      'ul_cyan' => '58;2;0;128;128',
-      'ul_default' => '59',
-      'ul_green' => '58;2;0;128;0',
-      'ul_magenta' => '58;2;128;0;128',
-      'ul_red' => '58;2;128;0;0',
-      'ul_white' => '58;2;128;128;128',
-      'ul_yellow' => '58;2;128;128;0',
-      'white' => '37',
-      'yellow' => '33'
-    }.freeze
-
-    @attr_sym = @attr.transform_keys(&:to_sym).compare_by_identity.freeze
-    @colors_sym = @colors.transform_keys(&:to_sym).compare_by_identity.freeze
-  end
-end