terminal_rb 1.0.6 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f2f93f672f13936c9415cf3a474533df0f5785da3272f3482a02842a0607917
-  data.tar.gz: 52a1498c80085ea7667b7641416f406ae8694e02505a0c3201efd5f150f8d986
+  metadata.gz: 8a5e3a8b375cd45eef93b2316251d14da8732b80e27fb1192bbf8fb87a9bf297
+  data.tar.gz: f10bcbf23b3e8ecd01bc51a8772f2099dbe5950bb561bc26d854e6c3d2fb382d
 SHA512:
-  metadata.gz: 41cfbe3e34fa3db0af51674dc0f70f32dd08fb20d2b3a1040eff2834c65440f917f2ecea021500037658fbcf613373148c8399fdb29b7ea987916e71c570a65d
-  data.tar.gz: b6485ac5e2a9ba17ec72ffadc94cad6f5348ab846f885d12e9a68a338c15baeaa0d564ce1e1a4d2f946505887782e02dfd7221fc03e60bd3e7bb40afb88b47a1
+  metadata.gz: a3c0cbfe105fccd17923c6ba7f43faf797b2df1fcc5d76d8bf138b1593156c5e23dc2a9700be17fa61e8f744151bb756943a482f9eca501087ffabb257e7e608
+  data.tar.gz: 60616eb76bbc7d01e1759274220390611887bbafe12f2d3b7cda8eb68dcd6cee491ce6b477235ce9a8b5e43b372e6d3e6c7a8ff81962a67eb78a20cb58fe7523

data/README.md

@@ -1,10 +1,10 @@
-# Terminal.rb v1.0.6
+# Terminal.rb v1.0.9
 
 Terminal.rb supports you with input and output on your terminal. Simple [BBCode](https://en.wikipedia.org/wiki/BBCode)-like markup for attributes and coloring, word-wise line breaks, correct special key recognition and mouse event reporting enable you to implement your CLI app quickly and easily.
 
 - 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/1.0.6/Terminal)
+- Help: [rubydoc.info](https://rubydoc.info/gems/terminal_rb/1.0.9/Terminal)
 
 ## Features
 

data/examples/bbcode.rb

@@ -6,28 +6,28 @@ Terminal.puts <<~TEXT
 
   ✅ [b bright_green]Terminal.rb::Ansi[/b] — BBCode:[/]
 
-              [b]Bold[/b]   [\\b][d]...[/d][\\/b] [\\bold][d]   ...  [/d][\\/bold]
-               [dim]Dim[/dim]   [\\d][d]...[/d][\\/d] [\\dim][d]   ...   [/d][\\/dim]
-            [i]Italic[/i]   [\\i][d]...[/d][\\/i] [\\italic][d]  ... [/d][\\/italic]
+              [b]Bold[/b]   [\\b][d]...[/d][\\/b] [\\bold][d]........[/d][\\/bold]
+               [dim]Dim[/dim]   [\\d][d]...[/d][\\/d] [\\dim][d].........[/d][\\/dim]
+            [i]Italic[/i]   [\\i][d]...[/d][\\/i] [\\italic][d]......[/d][\\/italic]
          [u]Underline[/u]   [\\u][d]...[/d][\\/u] [\\underline][d]...[/d][\\/underline]
-              [h]Hide[/h]   [\\h][d]...[/d][\\/h] [\\hide][d]   ...  [/d][\\/hide]
+              [h]Hide[/h]   [\\h][d]...[/d][\\/h] [\\hide][d]........[/d][\\/hide]
 
-            [inv]Invert[/inv]   [\\inv][d]  ... [/d][\\/inv] [\\invert][d]...[/d][\\/invert]
+            [inv]Invert[/inv]   [\\inv][d]......[/d][\\/inv] [\\invert][d]...[/d][\\/invert]
             [strike]Strike[/strike]   [\\strike][d]...[/d][\\/strike]
-             [blink]Blink[/blink]   [\\blink][d] ...[/d][\\/blink]
+             [blink]Blink[/blink]   [\\blink][d]....[/d][\\/blink]
 
-         [u]Underline[/u]   [\\u][d] ... [/d][\\/u]   [\\underline][d]    ...   [/d][\\/underline]
-  [uu]Double underline[/uu]   [\\uu][d] ...[/d][\\/uu]  [\\double_underline][d]...[/d][\\/double_underline]
-   [cu]Curly underline[/cu]   [\\cu][d] ...[/d][\\/cu]  [\\curly_underline][d] ...[/d][\\/curly_underline]
+         [u]Underline[/u]   [\\u][d].....[/d][\\/u]   [\\underline][d]..........[/d][\\/underline]
+  [uu]Double underline[/uu]   [\\uu][d]....[/d][\\/uu]  [\\double_underline][d]...[/d][\\/double_underline]
+   [cu]Curly underline[/cu]   [\\cu][d]....[/d][\\/cu]  [\\curly_underline][d]...[/d] [\\/curly_underline]
   [dau]Dashed underline[/dau]   [\\dau][d]...[/d][\\/dau] [\\dashed_underline][d]...[/d][\\/dashed_underline]
   [dou]Dotted underline[/dou]   [\\dou][d]...[/d][\\/dou] [\\dotted_underline][d]...[/d][\\/dotted_underline]
 
-           [fraktur]Fraktur[/fraktur]   [\\fraktur][d] ... [/d][\\/fraktur]
-            [framed]Framed[/framed]   [\\framed][d]  ... [/d][\\/framed]
+           [fraktur]Fraktur[/fraktur]   [\\fraktur][d].....[/d][\\/fraktur]
+            [framed]Framed[/framed]   [\\framed][d]......[/d][\\/framed]
          [encircled]Encircled[/encircled]   [\\encircled][d]...[/d][\\/encircled]
 
-         [ovr]Overlined[/ovr]   [\\ovr][d]...[/d][\\/ovr] [\\overlined][d] ... [/d][\\/overlined]
-         [sub]Subscript[/sub]   [\\sub][d]...[/d][\\/sub] [\\subscript][d] ... [/d][\\/subscript]
+         [ovr]Overlined[/ovr]   [\\ovr][d]...[/d][\\/ovr] [\\overlined][d].....[/d][\\/overlined]
+         [sub]Subscript[/sub]   [\\sub][d]...[/d][\\/sub] [\\subscript][d].....[/d][\\/subscript]
        [sup]Superscript[/sup]   [\\sup][d]...[/d][\\/sup] [\\superscript][d]...[/d][\\/superscript]
 
 TEXT

data/examples/key-codes.rb

@@ -6,7 +6,7 @@ Terminal.puts <<~TEXT
 
   ✅ [b bright_green]Terminal.rb[/b] — Key Codes:[/fg]
      Press any key to display it's control code and name.
-     [bright_black]([b]#{Terminal.input_mode}[/b] mode  - exit with ESC)[/fg]
+     [bright_black]([b]#{Terminal.input_mode}[/b] mode – exit with ESC)[/fg]
 
 TEXT
 

data/lib/terminal/ansi.rb

@@ -16,7 +16,7 @@ module Terminal
   #   Terminal::Ansi[:on_blue]      # => "\e[44m"
   #
   # @example BBCode to ANSI
-  #   Terminal::Ansi.bbcode('[bold]Hello[/bold]') # => "\e[1mHello\e[m"
+  #   Terminal::Ansi.bbcode('[bold]Hello[/bold]') # => "\e[1mHello\e[22m"
   #
   module Ansi
     class << self
@@ -39,7 +39,7 @@ module Terminal
       def named_colors = NAMED_COLORS.keys.map!(&:to_sym)
 
       #
-      # @!group ANSI Control Code Generation
+      # @!group Text Attribute Code Generation
       #
 
       # Generate an ANSI escape sequence from attribute names or color
@@ -67,20 +67,12 @@ module Terminal
         "\e[#{
           attributes
             .map! do |arg|
-              case arg
-              when String
-                @attr_map[arg] || _invalid(arg)
-              when Symbol
-                @attrs_map[arg] || _invalid(arg)
-              when (0..255)
-                "38;5;#{arg}"
-              when (256..511)
-                "48;5;#{arg - 256}"
-              when (512..767)
-                "58;5;#{arg - 512}"
-              else
-                _invalid(arg)
-              end
+              next @attr_str_map[arg] || _invalid(arg) if arg.is_a?(String)
+              next @attr_sym_map[arg] || _invalid(arg) if arg.is_a?(Symbol)
+              _invalid(arg) unless arg.is_a?(Integer)
+              next "38;5;#{arg}" if arg >= 0 && arg <= 255
+              next "48;5;#{arg - 256}" if arg >= 256 && arg <= 511
+              arg >= 512 && arg <= 767 ? "58;5;#{arg - 512}" : _invalid(arg)
             end
             .join(';')
         }m"
@@ -130,9 +122,11 @@ module Terminal
       #   attribute is invalid
       def try_convert(attributes, separator: ' ')
         return unless attributes
-        return if (attributes = attributes.to_s.split(separator)).empty?
-        attributes.uniq!
-        "\e[#{attributes.map! { @attr_map[it] || return }.join(';')}m"
+        unless (attributes = attributes.to_s.split(separator)).empty?
+          # attributes.uniq!
+          codes = attributes.map { @attr_str_map[it] || break }
+          "\e[#{codes.join(';')}m" if codes
+        end
       end
 
       # Generate rainbow-colored text using true color (24-bit) ANSI
@@ -163,7 +157,7 @@ module Terminal
       #
       # @!endgroup
       #
-      # @!group BBcode Generation
+      # @!group BBCode Generation
       #
 
       # Convert BBCode markup to ANSI escape codes.
@@ -186,11 +180,16 @@ module Terminal
       def bbcode(str)
         str = str.to_s
         return str.dup unless str.index('[')
-        str.gsub(@re_bbcode) do |match_str|
-          match = Regexp.last_match(1) or next match_str
-          next try_convert(match) || match_str if match[0] != '\\'
-          match[0] = ''
-          "[#{match}]"
+        str.gsub(@re_bbcode) do |match|
+          hit = @bbcc[match] and next hit
+          next "[#{match[2..]}" if (fc = match[1]) == '\\'
+          @bbcc.clear if @bbcc.size == 1024
+          @bbcc[match] = if fc == ']' || (att = match[1..-2].split).empty?
+            match
+          else
+            att = att.map { @attr_str_map[it] || break }
+            att ? "\e[#{att.join(';')}m" : match
+          end
         end
       end
 
@@ -206,15 +205,12 @@ module Terminal
       def unbbcode(str)
         str = str.to_s
         return str.dup unless str.index('[')
-        str.gsub(@re_bbcode) do |match_str|
-          match = Regexp.last_match(1) or next match_str
-          if match[0] == '\\'
-            match[0] = ''
-            next "[#{match}]"
-          end
-          next match_str if (match = match.split).empty?
-          next if match.all? { @attr_map[it] }
-          match_str
+        str.gsub(@re_bbcode) do |match|
+          hit = @bbcc[match] and next hit[0] == '[' ? hit : nil
+          next match if (fc = match[1]) == ']'
+          next "[#{match[2..]}" if fc == '\\'
+          next match if (att = match[1..-2].split).empty?
+          match unless att.map { @attr_str_map[it] || break }
         end
       end
 
@@ -232,13 +228,11 @@ module Terminal
       def escape_bbcode(str)
         str = str.to_s
         return str.dup unless str.index('[')
-        str.gsub(@re_bbcode) do |match_str|
-          fc = match_str[1]
-          next match_str if fc == '\\' || fc == ']'
-          match = Regexp.last_match(1) or next match_str
-          next match_str if (parts = match.split).empty?
-          next "[\\#{match}]" if parts.all? { @attr_map[it] }
-          match_str
+        str.gsub(@re_bbcode) do |match|
+          hit = @bbcc[match] and hit[1] == '\\' ? hit : "[\\#{match[1..]}"
+          next match if (fc = match[1]) == '\\' || fc == ']'
+          next match if (att = match[1..-2].split).empty?
+          att.map { @attr_str_map[it] || break } ? "[\\#{match[1..]}" : match
         end
       end
 
@@ -269,14 +263,9 @@ module Terminal
       # @return [true, false]
       def valid?(*attributes)
         attributes.all? do |arg|
-          case arg
-          when String
-            @attr_map[arg]
-          when Symbol
-            @attrs_map[arg]
-          when (0..767)
-            true
-          end
+          next @attr_str_map[arg] if arg.is_a?(String)
+          next @attr_sym_map[arg] if arg.is_a?(Symbol)
+          arg.is_a?(Integer) && arg >= 0 && arg <= 767
         end
       end
 
@@ -298,7 +287,7 @@ module Terminal
       #
       # @!endgroup
       #
-      # @!group ANSI Control Code Generation
+      # @!group Cursor and Screen Control Codes
       #
 
       # Move cursor up.
@@ -453,54 +442,26 @@ module Terminal
       # @return (see .[])
       def line_erase(part = :all) = "\e[#{@line_erase[part]}K"
 
-      # Set the terminal window title.
-      # @note Supported by Hyper, iTerm2, Kitty, macOS Terminal, Tabby,
-      #   WezTerm.
-      #
-      # @example
-      #   Terminal.raw_write(Terminal::Ansi.title('My App'))
-      #
-      # @param title [String] the title text
-      # @return (see .[])
-      def title(title) = "\e]0;#{title}\a"
-
-      # Start a hyperlink (OSC 8).
-      #
-      # @note Supported by Ghostty, iTerm2, Kitty, Rio, Tabby, WezTerm.
-      #
-      # @see .link
-      # @see .link_end
       #
-      # @param url [#to_s] the link URL
-      # @param params [Hash] optional link parameters (e.g., `id:`)
-      # @return (see .[])
-      def link_start(url, **params)
-        "\e]8;#{params.map { it.join('=') }.join(':')};#{url}\a"
-      end
-
-      # End a hyperlink.
+      # @!endgroup
       #
-      # @see .link_start
+      # @!group Terminal Integration Codes
       #
-      # @return (see .[])
-      def link_end = +LINK_END
 
-      # Create a complete hyperlink (OSC 8).
+      # Set the terminal window title.
       #
-      # @see .link_start
-      # @see .link_end
+      # @note Supported by iTerm2, Kitty, macOS Terminal, Tabby,
+      #   WezTerm.
       #
       # @example
-      #   Terminal::Ansi.link('https://example.com', 'Example')
+      #   Terminal.raw_write(Terminal::Ansi.title('My App'))
       #
-      # @param (see .link_start)
-      # @param text [String] the visible link text
+      # @param title [#to_s] the title text
       # @return (see .[])
-      def link(url, text, **params)
-        "#{link_start(url, **params)}#{text}#{LINK_END}"
-      end
+      def title(title) = "\e]0;#{_no_bell(title)}\a"
 
       # Send a desktop notification via the terminal.
+      #
       # @note Supported by Ghostty, iTerm2, Kitty, WezTerm.
       #
       # @example
@@ -508,7 +469,7 @@ module Terminal
       #
       # @param text [to_s] the notification text
       # @return (see .[])
-      def notify(text) = "\e]9;#{text}\a"
+      def notify(text) = "\e]9;#{_no_bell(text)}\a"
 
       # Show or update a progress indicator in the terminal tab/title
       # bar.
@@ -545,10 +506,100 @@ module Terminal
         "\e]9;4;#{state};#{percent.to_i.clamp(0, 100)}\a"
       end
 
+      # @comment Should we implement this?
+      #
+      #   # Request attention.
+      #   #
+      #   # @note Supported by iTerm2.
+      #   #
+      #   # @param action [true, :bounce, :once, :fireworks, false, :stop]
+      #   #   start bouncing dock icon (`true`, `:bounce`),
+      #   #   bounce dock icon once (`:once`)
+      #   #   or stop attention (`false`, `:stop`)
+      #   # @return (see .[])
+      #   def attention(action = :bounce)
+      #     "\e]1337;RequestAttention=#{
+      #       case action
+      #       when true, :bounce
+      #         'yes'
+      #       when :once, :fireworks
+      #         action
+      #       else
+      #         'no'
+      #       end
+      #     }\a"
+      #   end
+
+      # Create or start a hyperlink.
+      #
+      # @note Supported by Ghostty, iTerm2, Kitty, Rio, Tabby, WezTerm.
+      #
+      # @see .link_end
+      #
+      # @example
+      #   Terminal::Ansi.link('https://example.com', 'Example')
+      #
+      # @param url [#to_s] the link URL
+      # @param text [nil, #to_s] the visible link text
+      # @param params [Hash] optional link parameters (e.g., `id:`)
+      # @return (see .[])
+      def link(url, text = nil, **params)
+        start =
+          "\e]8;#{
+            _no_bell(params.map { it.join('=') }.join(':'))
+          };#{_no_bell(url)}\a"
+        text ? "#{start}#{_no_bell(text)}#{LINK_END}" : start
+      end
+
+      # End a hyperlink.
+      #
+      # @see .link
+      #
+      # @return (see .[])
+      def link_end = +LINK_END
+
+      # Copy text to clipboard.
+      #
+      # @note Supported by Ghostty, iTerm2, Kitty, Rio, Tabby, WezTerm.
+      #
+      # @param text [#to_s] text to copy
+      # @return (see .[])
+      def clipboard(text) = "\e]52;c;#{[text.to_s].pack('m0')}\a"
+
+      # Show or update the session status of the terminal.
+      #
+      # @note Supported by iTerm2.
+      #
+      # @example
+      #   Terminal.raw_write(Terminal::Ansi.status(text: 'Working'))
+      #   Terminal.raw_write(Terminal::Ansi.status(indicator: '#fa00fa'))
+      #   Terminal.raw_write(Terminal::Ansi.status(indicator: :f00))
+      #   Terminal.raw_write(Terminal::Ansi.status) # reset the status
+      #
+      # @param text [nil, #to_s] status text
+      # @param detail [nil, #to_s] status detail text
+      # @param color [nil, String, Symbol] text color
+      # @param indicator [nil, String, Symbol] status indicator color
+      # @return (see .[])
+      def status(text: nil, detail: nil, color: nil, indicator: nil)
+        str = text ? ";status=#{_no_bell(text)}" : ''
+        indicator = _try_rgb(indicator) and str << ";indicator=#{indicator}"
+        color = _try_rgb(color) and str << ";color=#{color}"
+        str << "detail=#{_no_bell(detail)}" if detail
+        str.empty? ? +STATUS_RESET : "\e]21337#{str}\a"
+      end
+
+      # Reset session status of the terminal.
+      #
+      # @see .status
+      #
+      # @return (see .[])
+      def status_reset = +STATUS_RESET
+
       # Scale text using the
       # [text sizing protocol](https://sw.kovidgoyal.net/kitty/text-sizing-protocol).
       #
-      # @note Only supported by Kitty.
+      # @note Supported by Kitty.
       #
       # @example Double-height Greeting
       #   Terminal::Ansi.scale('Hello Ruby!', scale: 2)
@@ -614,18 +665,25 @@ module Terminal
           caller(1)
         )
       end
+
+      def _try_rgb(str)
+        mt = /\A?#?([[:xdigit:]]{3,6})\z/.match(str.to_s)&.[](1) or return
+        "##{mt.size == 6 ? mt : mt[..2]}"
+      end
+
+      def _no_bell(str) = str.to_s.tr("\a", '')
     end
 
     @re_test =
       /
-      (?:\e\[[\x30-\x3f]*[\x20-\x2f]*[a-zA-Z])
-      |
-      (?:\e\]\d+(?:;[^\a\e]+)*(?:\a|\e\\))
-    /x
+        (?:\e\[[\x30-\x3f]*[\x20-\x2f]*[a-zA-Z])
+      | (?:\e\]\d+(?:;[^\a\e]+)*(?:\a|\e\\))
+      /x
 
-    @re_bbcode = /(?:\[((?~[\[\]]))\])/
+    @re_bbcode_old = /(?:\[((?~[\[\]]))\])/
+    @re_bbcode = /(?:\[(?~[\[\]]))\]/
 
-    clr_map = {
+    color_map = {
       # foreground
       'black' => '30',
       'red' => '31',
@@ -684,9 +742,9 @@ module Terminal
       'on_bright_white' => '107'
     }
 
-    @colors = clr_map.keys.map!(&:to_sym).sort!.freeze
+    @colors = color_map.keys.map!(&:to_sym).sort!.freeze
 
-    attr_map = {
+    @attr_base_map = {
       'reset' => '',
       'bold' => '1',
       'faint' => '2',
@@ -743,7 +801,7 @@ module Terminal
       'dashed_underline_off' => '4:0'
     }
 
-    attr_alias = ->(t, s) { attr_map[t] = attr_map[s] }
+    attr_alias = ->(t, s) { @attr_base_map[t] = @attr_base_map[s] }
 
     # aliases:
     attr_alias['off', 'reset']
@@ -768,18 +826,18 @@ module Terminal
     attr_alias['sup', 'superscript']
     attr_alias['sub', 'subscript']
 
-    @attributes = attr_map.keys.map!(&:to_sym).sort!.freeze
+    @attributes = @attr_base_map.keys.map!(&:to_sym).sort!.freeze
 
     # shortcuts disable:
-    attr_map.keys.each do |n|
+    @attr_base_map.keys.each do |n|
       attr_alias["/#{n.delete_suffix('_off')}", n] if n.end_with?('_off')
     end
 
     # additional shortcuts disable:
     attr_alias['/', 'reset']
-    attr_map['/bg'] = clr_map['on_default']
-    attr_map['/fg'] = clr_map['default']
-    attr_map['/ul'] = clr_map['ul_default']
+    @attr_base_map['/bg'] = color_map['on_default']
+    @attr_base_map['/fg'] = color_map['default']
+    @attr_base_map['/ul'] = color_map['ul_default']
 
     attr_alias['/b', 'bold_off']
     attr_alias['/d', 'dim_off']
@@ -800,29 +858,33 @@ module Terminal
     @cbase.default = '38'
     @cbase.freeze
 
-    @attr_map =
-      Hash.new do |_, str|
-        b, v = /\A(on|ul)?_?#?([[:xdigit:]]{1,6})\z/.match(str)&.captures
+    @attr_base_map.merge!(color_map).freeze
+
+    @attr_str_map = @attr_base_map.dup
+    @attr_str_map.default_proc =
+      proc do |h, s|
+        if h.size > 1024 # cache limit
+          h.keep_if { |key, _| @attr_base_map.key?(key) }
+        end
+        b, v = /\A(on|ul)?_?#?([[:xdigit:]]{1,6})\z/.match(s)&.captures
         unless v
-          b = /\A(on|ul)?_?([a-z]{3,}[0-9]{0,3})\z/.match(str) or next
-          v = NAMED_COLORS[b[2]] or next
-          next "#{@cbase[b[1]]};#{v}"
+          b = /\A(on|ul)?_?([a-z]{3,}[0-9]{0,3})\z/.match(s) or next h[s] = nil
+          next h[s] = (v = NAMED_COLORS[b[2]]) ? "#{@cbase[b[1]]};#{v}" : nil
         end
-        case v.size
-        when 1, 2
-          "#{@cbase[b]};5;#{v.hex}"
-        when 3
-          "#{@cbase[b]};2;#{(v[0] * 2).hex};#{(v[1] * 2).hex};#{(v[2] * 2).hex}"
-        when 6
+        h[s] = if v.size == 6
           "#{@cbase[b]};2;#{v[0, 2].hex};#{v[2, 2].hex};#{v[4, 2].hex}"
+        elsif v.size == 3
+          "#{@cbase[b]};2;#{(v[0] * 2).hex};#{(v[1] * 2).hex};#{(v[2] * 2).hex}"
+        elsif v.size < 3
+          "#{@cbase[b]};5;#{v.hex}"
         end
       end
-    attr_map.merge!(clr_map).keys.sort!.each { @attr_map[it] = attr_map[it] }
-    @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
+    @attr_sym_map = @attr_base_map.transform_keys(&:to_sym)
+    @attr_sym_map.compare_by_identity
+    @attr_sym_map.default_proc = proc { |h, s| h[s] = @attr_str_map[s.to_s] }
+
+    @bbcc = {} # BBCode cache
 
     @screen_erase = { below: nil, above: '1', scrollback: '3' }
     @screen_erase.default = '2'
@@ -907,6 +969,16 @@ module Terminal
     # @private
     LINE_ERASE_PREV = -"#{cursor_prev_line(nil)}#{LINE_ERASE}"
 
+    # @comment Supported by Terminal, iTerm, WezTerm:
+    # @private
+    LINE_DOUBLE_HEIGHT_TOP = "\e#3"
+    # @private
+    LINE_DOUBLE_HEIGHT_BOTTOM = "\e#4"
+    # @private
+    LINE_SINGLE_WIDTH = "\e#5"
+    # @private
+    LINE_DOUBLE_WIDTH = "\e#6"
+
     # @private
     LINK_END = "\e]8;;\a"
 
@@ -915,6 +987,9 @@ module Terminal
     # @private
     PROGRESS_SHOW_INDETERMINATE = "\e]9;4;3;0\a"
 
+    # @private
+    STATUS_RESET = "\e]21337;status=;indicator=;status-color=\a"
+
     # @comment seems not widely supported:
     #   doubled: def cursor_column(column = 1) = "\e[#{column}`"
     #   doubled: def cursor_row(row = 1) = "\e[#{row}d"
@@ -932,13 +1007,6 @@ module Terminal
     #
     #   def set_scroll_region(top = nil, bottom = nil) = "\e[#{top};#{bottom}r"
 
-    # @comment other:
-    #   "\eE" same as "\r\n"
-    #   "\eD" same as "\n" but preserves column
-    #   "\eM" reverse "\n"
-    #   "\e[6n" report Cursor Position as "ESC \[ row ; col R"
-    #   "\e[21t report window’s title as ESC ] l title ESC \"
-
     # @comment TODO:
     #   https://sw.kovidgoyal.net/kitty/desktop-notifications
     #   https://sw.kovidgoyal.net/kitty/pointer-shapes

data/lib/terminal/input/dumb.rb

@@ -2,7 +2,7 @@
 
 module Terminal
   # @private
-  module DumpInput
+  module DumbInput
     def input_mode = :dumb
 
     def on_key_event(*)
@@ -32,5 +32,5 @@ module Terminal
     end
   end
 
-  private_constant :DumpInput
+  private_constant :DumbInput
 end

data/lib/terminal/input/key_event.rb

@@ -9,9 +9,9 @@ module Terminal
   # @see Terminal.read_key_event
   #
   # @example Parse a raw escape sequence
-  #   event = Terminal::KeyEvent["\r"]
-  #   event.key     # => :Enter
-  #   event.name    # => "Enter"
+  #   event = Terminal::KeyEvent["a"]
+  #   event.key     # => "a"
+  #   event.name    # => "a"
   #   event.simple? # => true
   #
   # @example Inspect modifier keys
@@ -33,7 +33,7 @@ module Terminal
     # @see #modifiers
     # @see #modifier?
     #
-    # @return [Integer] modifier_bits bitmask
+    # @return [Integer] bitmask of the active modifiers
     attr_reader :modifier_bits
 
     # Names of active modifier keys.

data/lib/terminal/input.rb

@@ -14,7 +14,6 @@ module Terminal
   # @example
   #   Terminal.input_mode # => :csi_u
   #
-  # @attribute [r] input_mode
   # @return [Symbol] `:csi_u`, `:legacy`, `:dumb`, or `:error`
 
   #
@@ -33,7 +32,7 @@ module Terminal
   #
   #   @example
   #     Terminal.on_key_event(mouse: true) do |event|
-  #       break if event.name == 'ESC'
+  #       break if event.name == 'Esc'
   #       puts event.name
   #     end
   #
@@ -69,7 +68,7 @@ module Terminal
         extend AnsiInput
       when :dumb
         require_relative('input/dumb')
-        extend DumpInput
+        extend DumbInput
       else
         __input_error
       end