keyboard_map 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25ca369fcb1d0e1d108dbeb543d3b0a284cfff550886c6ce5d1ee4857450ea58
+  data.tar.gz: 67a599e04714db40a08f13c57203de64be1319a627505e88b47769cc96aacd2c
+SHA512:
+  metadata.gz: 3e8ff18adc0ce259a0570c552370adc5b06827f35fd57f759466e2efb913cb51144905268549dfaeea3fa81d3ae1e45d18856d5a20f1c3bd2daf1357362a4a1f
+  data.tar.gz: 58975bc916c978e5778a4082960b00924d49d15ae7fc0e86d4c17df4e0a69e52072ca8a7ba2b86201dd3d99fa53678f98300374ea958c17708305304bcdf1fbb

data/.gitignore

@@ -0,0 +1,12 @@
+*~
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in keyboard_map.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Vidar Hokstad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# KeyboardMap
+
+Process key-presses and map escape-sequences to symbols.
+
+Dealing with raw keyboard input is painful because something like cursor-up
+can return several different sequences depending on terminal, *and* because
+there is no terribly simple algorithm determining what represents the
+end of a single sequence. In fact some software relies on key-presses being
+slow enough to set a timeout and read character by character.
+
+KeyboardMap allows you to handle the reads in whichever way you prefer.
+It simply provides a simple state machine that will return an array of
+the keyboard events found so far.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keyboard_map'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyboard_map
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vidarh/keyboard_map.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Install bundle"
+task :bundle do
+  system("bundle install --path=./vendor/bundle")
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keyboard_map"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/keyboard_map.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "keyboard_map/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyboard_map"
+  spec.version       = KeyboardMap::VERSION
+  spec.authors       = ["Vidar Hokstad"]
+  spec.email         = ["vidar@hokstad.com"]
+
+  spec.summary       = "Read characters from the console and map special keys to symbols"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/vidarh/keyboard_map"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/keyboard_map/version.rb

@@ -0,0 +1,3 @@
+class KeyboardMap
+  VERSION = "0.1.0"
+end

data/lib/keyboard_map.rb

@@ -0,0 +1,232 @@
+# coding: utf-8
+# frozen-string-literals: true
+
+require "keyboard_map/version"
+require 'set'
+
+class KeyboardMap
+  attr_reader :buf
+
+  class Event
+    attr_reader :modifiers,:key
+
+
+    def initialize(key,*modifiers)
+      @modifiers = Set[*modifiers.map(&:to_sym)]
+      @key = key
+    end
+
+    def to_sym
+      (modifiers.to_a.sort << key).join("_").to_sym
+    end
+
+    def ==(ev)
+      case ev
+      when Event
+        return @modifiers == ev.modifiers && @key == ev.key
+      when Symbol
+        return self.to_sym == ev
+      else
+        return self.to_s == ev
+      end
+    end
+  end
+
+  SINGLE_KEY_EVENT = {
+    "\t" => :tab,
+    "\r" => :enter,
+    "\u007F" => :backspace
+  }.freeze
+
+  # \e[ starts a CSI sequence. This maps the final character in the CSI
+  # sequence to a key and how to interpret the parameters.
+  CSI_BASIC_MAP = {
+    "A"    => :up,
+    "B"    => :down,
+    "C"    => :right,
+    "D"    => :left,
+    "E"    => :keypad_5,
+    "F"    => :end,
+    "H"    => :home,
+    "P"    => :f1,
+    "Q"    => :f2,
+    "R"    => :f3,
+    "S"    => :f4,
+  }.freeze
+
+  # \e[{parameter1}{;...}~ from parameter1 => key
+  CSI_TILDE_MAP = {
+    "2"   => :insert,
+    "3"   => :delete,
+    "5"   => :page_up,
+    "6"   => :page_down,
+    "11"  => :f1,
+    "12"  => :f2,
+    "13"  => :f3,
+    "14"  => :f4,
+    "15"  => :f5,
+    "17"  => :f6,
+    "18"  => :f7,
+    "19"  => :f8,
+    "20"  => :f9,
+    "21"  => :f10,
+    "23"  => :f11,
+    "24"  => :f12,
+    "200" => :start_paste,
+    "201" => :end_paste,
+  }.freeze
+
+  # Map of simple/non-parameterised escape sequences to symbols
+  ESCAPE_MAP = {
+    "\e[Z"    => Event.new(:tab,:shift),
+    "\eOP"    => :f1,
+    "\eOQ"    => :f2,
+    "\eOR"    => :f3,
+    "\eOS"    => :f4
+  }.freeze
+
+  CSI_FINAL_BYTE = 0x40..0x7e
+
+  @@key_events = {}
+  def self.event(key,*modifiers)
+    e = Event.new(key,*modifiers)
+    k = e.to_sym
+    @@key_events[k] ||= e
+    @@key_events[k]
+  end
+
+  def meta(key)
+    self.class.event(key,:meta)
+  end
+
+  ESC = "\e"
+
+  def initialize
+    @tmp = ""
+    @buf = ""
+    @state = :text
+  end
+
+  def call(input)
+    @buf << input
+    run
+  end
+
+  def map_escape(seq)
+    if sym = ESCAPE_MAP[seq]
+      return sym
+    end
+    return Event.new(seq,:esc)
+  end
+
+  def ss3(ch)
+    tmp = @tmp
+    tmp << ch
+    @tmp = ""
+    @state = :text
+    return map_escape(tmp)
+  end
+
+  def map_modifiers(mod)
+    return [] if mod.nil?
+    mod = mod.to_i - 1
+    [].tap do |m|
+      m << :shift if (mod & 1) == 1
+      m << :meta  if (mod & 2) == 2
+      m << :ctrl  if (mod & 4) == 4
+    end
+  end
+
+  def map_csi(seq)
+    if sym = ESCAPE_MAP[seq]
+      return sym
+    end
+    final = seq[-1]
+    params = String(seq[2..-2]).split(";")
+    modifiers = []
+    if final == "~"
+      key = CSI_TILDE_MAP[params[0]]
+      if key
+        modifiers = map_modifiers(params[1])
+      end
+    else
+      key = CSI_BASIC_MAP[final]
+      modifiers = map_modifiers(params[1]) if key && params.first == "1" && params.size == 2
+    end
+
+    return Event.new(key,*Array(modifiers)) if key
+    return Event.new((params << final).join("_"), :csi)
+  end
+
+
+  def csi(ch)
+    @tmp << ch
+    return nil if !CSI_FINAL_BYTE.member?(ch.ord)
+    @state = :text
+    tmp = @tmp
+    @tmp = ""
+    return map_csi(tmp)
+  end
+
+  def esc(ch)
+    if ch == "["
+      @state = :csi
+      @tmp << ch
+      return nil
+    elsif ch == "O"
+      @state = :ss3
+      @tmp << ch
+      return nil
+    elsif ch == "\t"
+      @state = :text
+      @tmp = ""
+      return meta(:tab)
+    elsif ch == "\e"
+      return :esc
+    end
+    @state = :text
+    @tmp = ""
+    return meta(ch)
+  end
+
+  def text(ch)
+    if ch == ESC
+      @state = :esc
+      out = @tmp.empty? ? nil : @tmp
+      @tmp = ESC.dup
+      return out
+    end
+
+    if m = SINGLE_KEY_EVENT[ch]
+      tmp = @tmp
+      @tmp = ""
+      return [self.class.event(m)] if tmp.empty?
+      return [tmp, self.class.event(m)]
+    end
+
+    if ch.ord < 32
+      tmp = @tmp
+      @tmp = ""
+      ev = self.class.event((ch.ord+96).chr,:ctrl)
+      return [ev] if tmp.empty?
+      return [tmp,ev]
+    end
+
+    @tmp << ch
+    nil
+  end
+
+  def run
+    out = []
+    while !@buf.empty?
+      ch = @buf.slice!(0)
+      r = send(@state,ch)
+      out.concat(Array(r)) if r
+    end
+    if !@tmp.empty? && @state == :text
+      out << @tmp
+      @tmp = ""
+    end
+    out
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: keyboard_map
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vidar Hokstad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Read characters from the console and map special keys to symbols
+email:
+- vidar@hokstad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keyboard_map.gemspec
+- lib/keyboard_map.rb
+- lib/keyboard_map/version.rb
+homepage: https://github.com/vidarh/keyboard_map
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Read characters from the console and map special keys to symbols
+test_files: []