terminal_rb 0.6.0

data/lib/terminal/detect.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Terminal
+  module Detect
+    class << self
+      def application
+        return :kitty if ENV.key?('KITTY_PID')
+        app_from_term_program || app_from_term
+      end
+
+      def colors
+        case app_from_term_program
+        when :kitty, :ghostty, :vscode, :iterm
+          16_777_216
+        else
+          term = ENV['TERM'] or return 8
+          return 16_777_216 if /[+-]direct/.match?(term)
+          match = /[-+](\d+)color/.match(term) and return match[1].to_i
+          match = /[-+](\d+)bit/.match(term) and return 2**match[1].to_i
+          ret = color_by_name[term] and return ret
+          if /^(
+            iTerm\s?\d*\.app
+            |nsterm-build\d+
+            |terminology(-[0-9.]+)?
+            )$/x.match?(
+               term
+             )
+            return 256
+          end
+          if /^(dg+ccc|dgunix+ccc|d430.*?[-+](dg|unix).*?[-+]ccc)$/.match?(term)
+            return 52
+          end
+          8
+        end
+      end
+
+      private
+
+      def app_from_term_program
+        value = ENV['TERM_PROGRAM'] or return
+        {
+          'Apple_Terminal' => :macos,
+          'CodeEditApp_Terminal' => :code_edit,
+          'FluentTerminal' => :fluent,
+          'ghostty' => :ghostty,
+          'Hyper' => :hyper,
+          'HyperTerm' => :hyper,
+          'iTerm.app' => :iterm,
+          'Terminus' => :terminus,
+          'tmux' => :tmux,
+          'vscode' => :vscode,
+          'WarpTerminal' => :warp,
+          'WezTerm' => :wezterm
+        }[
+          value
+        ]
+      end
+
+      def app_from_term
+        value = ENV['TERM'] or return
+        {
+          'alacritty' => :alacritty,
+          'amiga' => :amiga,
+          'd430' => :dg_unix,
+          'd470' => :dg_unix,
+          'dg+' => :dg_unix,
+          'dgunix' => :dg_unix,
+          'hp+' => :hpterm,
+          'hpterm' => :hpterm,
+          'mintty' => :mintty,
+          'ms-terminal' => :ms_terminal,
+          'ncr260' => :ncr260,
+          'nsterm' => :nsterm,
+          'terminator' => :terminator,
+          'terminology' => :terminology,
+          'termite' => :termite,
+          'vt100' => :vt100,
+          'wy350' => :wyse,
+          'wy370' => :wyse,
+          'xnuppc' => :xnuppc
+        }.each_pair { |str, type| return type if value.start_with?(str) }
+      end
+
+      def color_by_name
+        {
+          'alacritty' => 256,
+          'kitty' => 256,
+          'mintty' => 256,
+          'ms-terminal' => 256,
+          'nsterm' => 256,
+          'terminator' => 256,
+          'termite' => 256,
+          'vscode' => 256,
+          'hpterm-color' => 64,
+          'wy370-105k' => 64,
+          'wy370-EPC' => 64,
+          'wy370-nk' => 64,
+          'wy370-rv' => 64,
+          'wy370-tek' => 64,
+          'wy370-vb' => 64,
+          'wy370-w' => 64,
+          'wy370-wvb' => 64,
+          'wy370' => 64,
+          'amiga-vnc' => 16,
+          'd430-dg' => 16,
+          'd430-unix-25' => 16,
+          'd430-unix-s' => 16,
+          'd430-unix-sr' => 16,
+          'd430-unix-w' => 16,
+          'd430-unix' => 16,
+          'd430c-dg' => 16,
+          'd430c-unix-25' => 16,
+          'd430c-unix-s' => 16,
+          'd430c-unix-sr' => 16,
+          'd430c-unix-w' => 16,
+          'd430c-unix' => 16,
+          'd470-7b' => 16,
+          'd470-dg' => 16,
+          'd470' => 16,
+          'd470c-7b' => 16,
+          'd470c-dg|' => 16,
+          'd470c' => 16,
+          'dg+color' => 16,
+          'dg+fixed' => 16,
+          'dgmode+color' => 16,
+          'dgunix+fixed' => 16,
+          'hp+color' => 16,
+          'ncr260wy325pp' => 16,
+          'ncr260wy325wpp' => 16,
+          'ncr260wy350pp' => 16,
+          'ncr260wy350wpp' => 16,
+          'nsterm-7-c' => 16,
+          'nsterm-bce' => 16,
+          'nsterm-c-acs' => 16,
+          'nsterm-c-s-7' => 16,
+          'nsterm-c-s-acs' => 16,
+          'nsterm-c-s' => 16,
+          'nsterm-c' => 16,
+          'nsterm+c' => 16,
+          'vt100' => 8,
+          'wy350' => 8,
+          'xnuppc' => 8,
+          'dumb' => 2,
+          'dummy' => 2
+        }
+      end
+    end
+  end
+
+  private_constant :Detect
+end

data/lib/terminal/input.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require 'io/console'
+
+module Terminal
+  class << self
+    # Read next keyboard input.
+    #
+    # 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
+    # @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
+    def read_key(mode: :named)
+      key = _raw_read_key or return
+      return key if mode == :raw
+      mode == :both ? [key, _key_name(key)] : _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
+      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)
+    end
+  end
+
+  @in = STDIN
+
+  KEY_MAP =
+    Module
+      .new do
+        def self.add_modifiers(**keys)
+          @mods.each_pair do |mod, pref|
+            @map.merge!(
+              keys.to_h do |name, code|
+                ["\e[1;#{mod}#{code}", "#{pref}+#{name}"]
+              end
+            )
+          end
+        end
+
+        def self.add_keys(**keys)
+          @map.merge!(keys.to_h { |name, code| ["\e[#{code}", name] })
+          add_modifiers(**keys)
+        end
+
+        def self.add_fkeys(**keys)
+          @map.merge!(keys.to_h { |name, code| ["\e[#{code}~", name] })
+          @mods.each_pair do |mod, prefix|
+            @map.merge!(
+              keys.to_h do |name, code|
+                ["\e[#{code};#{mod}~", "#{prefix}+#{name}"]
+              end
+            )
+          end
+        end
+
+        def self.add_alt_keys(**keys)
+          keys.each_pair do |name, code|
+            @map[code] = name
+            @map["\e#{code}"] = "Alt+#{name}" # kitty
+          end
+        end
+
+        def self.to_hash
+          # control codes
+          num = 0
+          @map = ('A'..'Z').to_h { [(num += 1).chr, "Ctrl+#{_1}"] }
+
+          add_keys('F1' => 'P', 'F2' => 'Q', 'F3' => 'R', 'F4' => 'S')
+
+          add_keys(
+            '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
+
+          add_alt_keys(
+            'ESC' => "\e",
+            'ENTER' => "\r",
+            'TAB' => "\t",
+            'BACK' => "\u007F",
+            'Ctrl+BACK' => "\b",
+            'Shift+TAB' => "\e[Z"
+          )
+
+          # overrides and additional keys
+          @map.merge!(
+            "\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
+
+        @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
+      end
+      .to_hash
+      .freeze
+
+  private_constant :KEY_MAP
+end

data/lib/terminal/preload.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../terminal'
+require_relative 'ansi/named_colors'
+require_relative 'text'
+require_relative 'text/char_width'
+require_relative 'detect'
+require_relative 'version'

data/lib/terminal/rspec/helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'with Terminal' do |mod, ansi: true, winsize: [25, 80]|
+  let(:wrapper_module) { Module.new }
+  let(:stdout) { double(:STDOUT, winsize: winsize, tty?: ansi) }
+  let(:stdoutput) { [] }
+  let(:terminal) do
+    load('terminal/ansi/attributes.rb', wrapper_module)
+    load('terminal/ansi.rb', wrapper_module)
+    load('terminal/input.rb', wrapper_module)
+    load('terminal/detect.rb', wrapper_module)
+    load('terminal.rb', wrapper_module)
+    wrapper_module::Terminal
+  end
+
+  before do
+    allow(stdout).to receive(:write) do |*args|
+      stdoutput.concat(args)
+      nil
+    end
+
+    wrapper_module::STDOUT = stdout unless defined?(wrapper_module::STDOUT)
+
+    unless ansi
+      allow(ENV).to receive(:[]).and_call_original
+      allow(ENV).to receive(:[]).with('LINES').and_return winsize.first
+      allow(ENV).to receive(:[]).with('COLUMNS').and_return winsize.last
+    end
+
+    mod.__send__(:remove_const, :Terminal) if defined?(mod::Terminal)
+    mod.__send__(:const_set, :Terminal, terminal)
+  end
+end