termcontroller 0.1.0 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1fad37d234332ef83aa87356c2ce2cb16f0625bc5e53e37db193e2d0f0343fd
-  data.tar.gz: cad01ac6503432df902fe0c1d204c6698d13088376e23a418c1d7ca5d5709cab
+  metadata.gz: ccc884e481a6ba710cb7edbd7edc1b05c20ed49e7f8e81cb0288813472006466
+  data.tar.gz: 6738a465db9c70c9d4d67f1626957de5209fbfbee95557cf9115f8734ff970e9
 SHA512:
-  metadata.gz: b0d4ba2609f21e798a4ea6798d02f94f7dba23f6011d015568206c219dbccedb8b994c6d66e30fc4b25c6e4ab9c56b7455f12aa1dec856ba5dac4eddcae77e4e
-  data.tar.gz: 7d4b1b9a57cc196538851e537403e2ff8bafbfeab55d22ad3fccbf70ad27c4df22bc0ac99701c1ffa587af02baeb62f2ac088527bd1655a26f39d7cc9cdee01d
+  metadata.gz: d6c8d516c1a855d46833a6ead5e0a28ab2a682b1ce18a8039d301933acb2811d627b65c62b2ecbd0298c8379af98a7502d86a542342fc3c48911f996ab57cfba
+  data.tar.gz: 5f313f8f34231eaa7715c0df26e7abd470ee770af60cdbffb4c4dc7f1f8c08132df5e1f4558b713e26a9be307e5f496c51cfd7817efb12c6ac557dbe87d8e5e5

data/.gitignore

@@ -6,6 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+*~
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,8 +1,8 @@
 # Termcontroller
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/termcontroller`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A very basic Controller (in the MVC sense) for Ruby terminal
+applications. This was pulled out of my text editor,
+[Re](https://github.com/vidarh/re).
 
 ## Installation
 
@@ -26,15 +26,23 @@ 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.
+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).
+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/[USERNAME]/termcontroller.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/vidarh/termcontroller.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/lib/termcontroller/controller.rb

@@ -0,0 +1,258 @@
+# coding: utf-8
+
+require 'io/console'
+
+# # Controller
+#
+# This is way too ill defined. The purpose is to be able to have a
+# separate thread handle the keyboard processing asynchronously,
+# reading from the input, and for an application to then be able to
+# call into it to read a command, or to have the controller dispatch
+# the command directly to a specified target object based on the
+# key bindings.
+#
+# It works well enough to e.g. allow temporarily pausing the processing
+# and then dispatching "binding.pry" and re-enable the processing when
+# it returns.
+#
+# FIXME: Split it into a separate gem.
+#
+# FIXME: Should probably treat this as a singleton.
+#
+#
+
+module Termcontroller
+  class Controller
+
+    attr_reader :lastcmd,:lastkey,:lastchar
+    attr_accessor :mode
+
+    @@con = IO.console
+  
+    # Pause *any* Controller instance
+    @@pause = false
+    def self.pause!
+      old = @@pause
+      @@pause = true
+      @@con.cooked do
+        yield
+      end
+    ensure
+      @@pause = old
+    end
+
+    def paused?
+      @mode == :pause || @@pause
+    end
+
+    def initialize(target, keybindings)
+      @target = target
+      @keybindings = keybindings
+      @buf = ""
+      @commands = []
+      @mode = :cooked
+
+      @kb = KeyboardMap.new
+      @@con = @con = IO.console
+      raise if !@con
+    
+      at_exit do
+        cleanup
+      end
+      
+      trap("CONT") { resume }
+
+    @t = Thread.new { readloop }
+  end
+
+  def setup
+    STDOUT.print "\e[?2004h" # Enable bracketed paste
+    STDOUT.print "\e[?1000h" # Enable mouse reporting
+    STDOUT.print "\e[?1006h" # Enable extended reporting
+  end
+
+  def cleanup
+    STDOUT.print "\e[?2004l" #Disable bracketed paste
+    STDOUT.print "\e[?1000l" #Disable mouse reporting
+  end
+
+  def readloop
+    loop do
+      if paused?
+        sleep(0.05)
+      elsif @mode == :cooked
+        read_input
+      else
+        fill_buf
+      end
+    end
+  end
+
+  def pause
+    old = @mode
+    @mode = :pause
+    sleep(0.1)
+    IO.console.cooked!
+    yield
+  rescue Interrupt
+  ensure
+    @mode = old
+  end
+
+  def fill_buf(timeout=0.1)
+    if paused?
+      sleep(0.1)
+      Thread.pass
+      return
+    end
+    @con.raw!
+    return if !IO.select([$stdin],nil,nil,0.1)
+    str = $stdin.read_nonblock(4096)
+    str.force_encoding("utf-8")
+    @buf << str
+  rescue IO::WaitReadable
+  end
+
+  def getc(timeout=0.1)
+    if !paused?
+      while @buf.empty?
+        fill_buf
+      end
+      @buf.slice!(0) if !paused? && @mode == :cooked
+    else
+      sleep(0.1)
+      Thread.pass
+      return nil
+    end
+  rescue Interrupt
+  end
+
+  def raw
+    @mode = :raw
+    yield
+  rescue Interrupt
+  ensure
+    @mode = :cooked
+  end
+
+  def read_char
+    sleep(0.01) if @buf.empty?
+    @buf.slice!(0)
+  rescue Interrupt
+  end
+
+  def get_command
+    map = @keybindings
+    loop do
+      c = nil
+      char = getc
+      return nil if !char
+
+      c1 = Array(@kb.call(char)).first
+      c = map[c1.to_sym] if c1
+
+      if c.nil? && c1.kind_of?(String)
+        return [:insert_char, c1]
+      end
+
+      if c.nil?
+        if c1
+          @lastchar = c1.to_sym
+          args = c1.respond_to?(:args) ? c1.args : []
+          return Array(c1.to_sym).concat(args || [])
+        else
+          @lastchar = char.inspect
+          return nil
+        end
+      end
+
+      if c.kind_of?(Hash)
+        map = c
+      else
+        @lastchar = c1.to_sym.to_s.split("_").join(" ")
+        @lastchar += " (#{c.to_s})" if c.to_s != @lastchar
+        return c
+      end
+    end
+  end
+
+  def do_command(c)
+    return nil if !c
+    if @target.respond_to?(Array(c).first)
+      @lastcmd = c
+      @target.instance_eval { send(*Array(c)) }
+    else
+      @lastchar = "Unbound: #{Array(c).first.inspect}"
+    end
+  end
+
+  def read_input
+    c = get_command
+    if !c
+      Thread.pass
+      return
+    end
+    if Array(c).first == :insert_char
+      # FIXME: Attempt to combine multiple :insert_char into one.
+      #Probably should happen in get_command
+      #while (c2 = get_command) && Array(c2).first == :insert_char
+      #  c.last << c2.last
+      #end
+      #@commands << c
+      #c = c2
+      #return nil if !c
+    end
+    @commands << c
+    Thread.pass
+  end
+
+  def next_command
+    if @commands.empty?
+      sleep(0.001)
+      Thread.pass
+    end
+    @commands.shift
+  end
+
+  def handle_input(prefix="",timeout=0.1)
+    if c = next_command
+      do_command(c)
+    end
+    return c
+  end
+
+  def pry(e=nil)
+    pause do
+      cleanup
+      puts ANSI.cls
+      binding.pry
+    end
+    setup
+  end
+
+  def suspend
+    pause do
+      yield if block_given?
+      Process.kill("STOP", 0)
+    end
+  end
+
+  def resume
+    @mode = :cooked
+    setup
+  end
+end
+end
+
+at_exit do
+  #
+  # FIXME: This is a workaround for Controller putting
+  # STDIN into nonblocking mode and not cleaning up, which
+  # causes all kind of problems with a variety of tools (more,
+  # docker etc.) which expect it to be blocking.
+  Termcontroller::Controller.pause! do
+    stdin_flags = STDIN.fcntl(Fcntl::F_GETFL)
+    STDIN.fcntl(Fcntl::F_SETFL, stdin_flags & ~Fcntl::O_NONBLOCK) #
+    IO.console.cooked!
+  end
+end

data/lib/termcontroller/version.rb

@@ -1,3 +1,3 @@
 module Termcontroller
-  VERSION = "0.1.0"
+  VERSION = "0.2"
 end

data/lib/termcontroller.rb

@@ -1,4 +1,5 @@
 require "termcontroller/version"
+require "termcontroller/controller"
 
 module Termcontroller
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: termcontroller
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '0.2'
 platform: ruby
 authors:
 - Vidar Hokstad
@@ -27,6 +27,7 @@ files:
 - bin/console
 - bin/setup
 - lib/termcontroller.rb
+- lib/termcontroller/controller.rb
 - lib/termcontroller/version.rb
 - termcontroller.gemspec
 homepage: https://github.com/vidarh/termcontroller