tty2-reader 0.9.0.1

data/lib/tty2/reader/history.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module TTY2
+  class Reader
+    # A class responsible for storing a history of all lines entered by
+    # user when interacting with shell prompt.
+    #
+    # @api private
+    class History
+      include Enumerable
+      extend Forwardable
+
+      # Default maximum size
+      DEFAULT_SIZE = 32 << 4
+
+      # Default exclude
+      DEFAULT_EXCLUDE = ->(line) { line.chomp == "" }
+
+      def_delegators :@history, :size, :length, :to_s, :inspect
+
+      # Set and retrieve the maximum size of the buffer
+      attr_accessor :max_size
+
+      # The current index
+      #
+      # @return [Integer]
+      #
+      # @api private
+      attr_reader :index
+
+      # Decides whether or not to allow cycling through stored lines.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      attr_accessor :cycle
+
+      # Decides wether or not duplicate lines are stored.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      attr_accessor :duplicates
+
+      # Dictates which lines are stored.
+      #
+      # @return [Proc]
+      #
+      # @public
+      attr_accessor :exclude
+
+      # Create a History buffer
+      #
+      # @param [Integer] max_size
+      #   the maximum size for history buffer
+      # @param [Boolean] cycle
+      #   whether or not the history should cycle, false by default
+      # @param [Boolean] duplicates
+      #   whether or not to store duplicates, true by default
+      # @param [Boolean] exclude
+      #   a Proc to exclude items from storing in history
+      #
+      # @api public
+      def initialize(max_size = DEFAULT_SIZE, duplicates: true, cycle: false,
+                     exclude: DEFAULT_EXCLUDE)
+        @max_size   = max_size
+        @index      = nil
+        @history    = []
+        @duplicates = duplicates
+        @exclude    = exclude
+        @cycle      = cycle
+
+        yield self if block_given?
+      end
+
+      # Iterates over history lines
+      #
+      # @api public
+      def each(&block)
+        if block_given?
+          @history.each(&block)
+        else
+          @history.to_enum
+        end
+      end
+
+      # Add the last typed line to history buffer
+      #
+      # @param [String] line
+      #
+      # @api public
+      def push(line)
+        @history.delete(line) unless @duplicates
+        return if line.to_s.empty? || @exclude[line]
+
+        @history.shift if size >= max_size
+        @history << line
+        @index = @history.size - 1
+
+        self
+      end
+      alias << push
+
+      # Replace the current line with a new one
+      #
+      # @param [String] line
+      #   the new line to replace with
+      #
+      # @api public
+      def replace(line)
+        return if @index.to_i >= size
+
+        @history[index] = line.dup
+      end
+
+      # Move the pointer to the next line in the history
+      #
+      # @api public
+      def next
+        return if size.zero?
+
+        if @index == size - 1
+          @index = 0 if @cycle
+        else
+          @index += 1
+        end
+      end
+
+      def next?
+        size > 0 && !(@index == size - 1 && !@cycle)
+      end
+
+      # Move the pointer to the previous line in the history
+      def previous
+        return if size.zero?
+
+        if @index.zero?
+          @index = size - 1 if @cycle
+        else
+          @index -= 1
+        end
+      end
+
+      def previous?
+        size > 0 && !(@index < 0 && !@cycle)
+      end
+
+      # Return line at the specified index
+      #
+      # @raise [IndexError] index out of range
+      #
+      # @api public
+      def [](index)
+        if index < 0
+          index += @history.size if index < 0
+        end
+        line = @history[index]
+        if line.nil?
+          raise IndexError, "invalid index"
+        end
+        line.dup
+      end
+
+      # Get current line
+      #
+      # @api public
+      def get
+        return if size.zero?
+
+        self[@index]
+      end
+
+      # Empty all history lines
+      #
+      # @api public
+      def clear
+        @history.clear
+        @index = 0
+      end
+    end # History
+  end # Reader
+end # TTY2

data/lib/tty2/reader/key_event.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "keys"
+
+module TTY2
+  class Reader
+    # Responsible for meta-data information about key pressed
+    #
+    # @api private
+    class Key < Struct.new(:name, :ctrl, :meta, :shift)
+      def initialize(*)
+        super(nil, false, false, false)
+      end
+    end
+
+    # Represents key event emitted during keyboard press
+    #
+    # @api public
+    class KeyEvent < Struct.new(:key, :value, :line)
+      # Create key event from read input codes
+      #
+      # @param [Hash[Symbol]] keys
+      #   the keys and codes mapping
+      # @param [Array[Integer]] codes
+      #
+      # @return [KeyEvent]
+      #
+      # @api public
+      def self.from(keys, char, line = Line.new)
+        key = Key.new
+        key.name = (name = keys[char]) ? name : :ignore
+
+        case char
+        when proc { |c| c =~ /^[a-z]{1}$/ }
+          key.name = :alpha
+        when proc { |c| c =~ /^[A-Z]{1}$/ }
+          key.name = :alpha
+          key.shift = true
+        when proc { |c| c =~ /^\d+$/ }
+          key.name = :num
+        when proc { |cs| !Keys.ctrl_keys[cs].nil? }
+          key.ctrl = true
+        end
+
+        new(key, char, line)
+      end
+
+      # Check if key event can be triggered
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def trigger?
+        !key.nil? && !key.name.nil?
+      end
+    end # KeyEvent
+  end # Reader
+end # TTY2

data/lib/tty2/reader/keys.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module TTY2
+  class Reader
+    # Mapping of escape codes to keys
+    module Keys
+      def ctrl_keys
+        {
+          ?\C-a => :ctrl_a,
+          ?\C-b => :ctrl_b,
+          ?\C-c => :ctrl_c,
+          ?\C-d => :ctrl_d,
+          ?\C-e => :ctrl_e,
+          ?\C-f => :ctrl_f,
+          ?\C-g => :ctrl_g,
+          ?\C-h => :ctrl_h, # identical to "\b"
+          ?\C-i => :ctrl_i, # identical to "\t"
+          ?\C-j => :ctrl_j, # identical to "\n"
+          ?\C-k => :ctrl_k,
+          ?\C-l => :ctrl_l,
+          ?\C-m => :ctrl_m, # identical to "\r"
+          ?\C-n => :ctrl_n,
+          ?\C-o => :ctrl_o,
+          ?\C-p => :ctrl_p,
+          ?\C-q => :ctrl_q,
+          ?\C-r => :ctrl_r,
+          ?\C-s => :ctrl_s,
+          ?\C-t => :ctrl_t,
+          ?\C-u => :ctrl_u,
+          ?\C-v => :ctrl_v,
+          ?\C-w => :ctrl_w,
+          ?\C-x => :ctrl_x,
+          ?\C-y => :ctrl_y,
+          ?\C-z => :ctrl_z,
+          ?\C-@ => :ctrl_space,
+          ?\C-| => :ctrl_backslash, # both Ctrl-| & Ctrl-\
+          ?\C-] => :ctrl_square_close,
+          "\e[1;5A" => :ctrl_up,
+          "\e[1;5B" => :ctrl_down,
+          "\e[1;5C" => :ctrl_right,
+          "\e[1;5D" => :ctrl_left
+        }
+      end
+      module_function :ctrl_keys
+
+      def keys
+        {
+          "\t" => :tab,
+          "\n" => :enter,
+          "\r" => :return,
+          "\e" => :escape,
+          " "  => :space,
+          "\x7F"  => :backspace,
+          "\e[1~" => :home,
+          "\e[2~" => :insert,
+          "\e[3~" => :delete,
+          "\e[3;2~" => :shift_delete,
+          "\e[3;5~" => :ctrl_delete,
+          "\e[4~" => :end,
+          "\e[5~" => :page_up,
+          "\e[6~" => :page_down,
+          "\e[7~" => :home, # xrvt
+          "\e[8~" => :end, # xrvt
+
+          "\e[A" => :up,
+          "\e[B" => :down,
+          "\e[C" => :right,
+          "\e[D" => :left,
+          "\e[E" => :clear,
+          "\e[H" => :home,
+          "\e[F" => :end,
+          "\e[Z" => :shift_tab,
+
+          # xterm/gnome
+          "\eOA" => :up,
+          "\eOB" => :down,
+          "\eOC" => :right,
+          "\eOD" => :left,
+          "\eOE" => :clear,
+          "\eOF" => :end,
+          "\eOH" => :home,
+
+          "\eOP" => :f1, # xterm
+          "\eOQ" => :f2, # xterm
+          "\eOR" => :f3, # xterm
+          "\eOS" => :f4, # xterm
+          "\e[[A" => :f1, # linux
+          "\e[[B" => :f2, # linux
+          "\e[[C" => :f3, # linux
+          "\e[[D" => :f4, # linux
+          "\e[[E" => :f5, # linux
+          "\e[11~" => :f1, # rxvt-unicode
+          "\e[12~" => :f2, # rxvt-unicode
+          "\e[13~" => :f3, # rxvt-unicode
+          "\e[14~" => :f4, # rxvt-unicode
+          "\e[15~" => :f5,
+          "\e[17~" => :f6,
+          "\e[18~" => :f7,
+          "\e[19~" => :f8,
+          "\e[20~" => :f9,
+          "\e[21~" => :f10,
+          "\e[23~" => :f11,
+          "\e[24~" => :f12,
+          "\e[25~" => :f13,
+          "\e[26~" => :f14,
+          "\e[28~" => :f15,
+          "\e[29~" => :f16,
+          "\e[31~" => :f17,
+          "\e[32~" => :f18,
+          "\e[33~" => :f19,
+          "\e[34~" => :f20,
+          # xterm
+          "\e[1;2P" => :f13,
+          "\e[2;2Q" => :f14,
+          "\e[1;2S"  => :f16,
+          "\e[15;2~" => :f17,
+          "\e[17;2~" => :f18,
+          "\e[18;2~" => :f19,
+          "\e[19;2~" => :f20,
+          "\e[20;2~" => :f21,
+          "\e[21;2~" => :f22,
+          "\e[23;2~" => :f23,
+          "\e[24;2~" => :f24,
+        }
+      end
+      module_function :keys
+
+      def win_keys
+        {
+          "\t" => :tab,
+          "\n" => :enter,
+          "\r" => :return,
+          "\e" => :escape,
+          " "  => :space,
+          "\b" => :backspace,
+          [224, 71].pack("U*") => :home,
+          [224, 79].pack("U*") => :end,
+          [224, 82].pack("U*") => :insert,
+          [224, 83].pack("U*") => :delete,
+          [224, 73].pack("U*") => :page_up,
+          [224, 81].pack("U*") => :page_down,
+
+          [224, 72].pack("U*") => :up,
+          [224, 80].pack("U*") => :down,
+          [224, 77].pack("U*") => :right,
+          [224, 75].pack("U*") => :left,
+          [224, 83].pack("U*") => :clear,
+
+          "\x00;" => :f1,
+          "\x00<" => :f2,
+          "\x00"  => :f3,
+          "\x00=" => :f4,
+          "\x00?" => :f5,
+          "\x00@" => :f6,
+          "\x00A" => :f7,
+          "\x00B" => :f8,
+          "\x00C" => :f9,
+          "\x00D" => :f10,
+          "\x00\x85" => :f11,
+          "\x00\x86" => :f12
+        }
+      end
+      module_function :win_keys
+    end # Keys
+  end # Reader
+end # TTY2