termcontroller 0.1.0 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1fad37d234332ef83aa87356c2ce2cb16f0625bc5e53e37db193e2d0f0343fd
-  data.tar.gz: cad01ac6503432df902fe0c1d204c6698d13088376e23a418c1d7ca5d5709cab
+  metadata.gz: 137ab6e058cbc71d9ac66d57479fcb01a9ab87fb403c795c553c880498c21410
+  data.tar.gz: b51e7f7353b269fc8e0375d858e9c0ee8605ea0e340b1c4f000ec4557e6ac281
 SHA512:
-  metadata.gz: b0d4ba2609f21e798a4ea6798d02f94f7dba23f6011d015568206c219dbccedb8b994c6d66e30fc4b25c6e4ab9c56b7455f12aa1dec856ba5dac4eddcae77e4e
-  data.tar.gz: 7d4b1b9a57cc196538851e537403e2ff8bafbfeab55d22ad3fccbf70ad27c4df22bc0ac99701c1ffa587af02baeb62f2ac088527bd1655a26f39d7cc9cdee01d
+  metadata.gz: 4a1d7893783340263e8d92ed7503ef239b77407e4466305f2fbbb1700b73108bb34d23eb34f8fcb3f8680bf5ac40f191cce9eba7ff8d3188d4213c0885c04d16
+  data.tar.gz: a6270a9cb7c27ee6744540013e6abc599851f846cc5b8b1a76bc08f34a4bc1784cf60ef89e999e588d653afa38f3e407f3d12c9ae4bfddf61e01529e8d5638ce

data/.gitignore

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

data/Gemfile

@@ -3,5 +3,6 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in termcontroller.gemspec
 gemspec
 
+gem "keyboard_map" #, path: "../keyboard_map"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"

data/README.md

@@ -1,8 +1,14 @@
 # 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.
+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).
 
-TODO: Delete this and the text above, and describe your gem
+**YOU ALMOST CERTAINLY DO NOT YET WANT TO USE THIS FOR YOUR OWN CODE**
+
+I do intend to clean it up and make it usable for others, but it's not
+there yet - if you think it'd be useful for you, feel free to drop me a
+message.
 
 ## Installation
 
@@ -22,19 +28,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'termcontroller'
+
+class Target
+  def initialize
+    # Second argument is a keyboard mapping.
+    @ctrl = Termcontroller::Controller.new(self, {
+      :f1 => :help
+    })
+  end
+
+  def help
+    puts "This is a help text"
+  end
+
+  def run
+    loop do
+      p @ctrl.handle_input
+      print "\r"
+    end
+  end
+
+  def ctrl_c; exit; end
+end
+
+puts "Ctrl+c to quit"
+Target.new.run
+```
+
+
 
 ## 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,290 @@
+# coding utf-8
+
+require 'io/console'
+require 'fcntl'
+
+# # 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.
+#
+# Note that *currently* `#handle_input` will block on retrieving a
+# command with no timeout. This is because Re is the only current
+# client of this class, and *currently* does not have a need for
+# anything async. That *will* change, as Re will eventually start
+# receiving evented updates. Current "hack" to work around this:
+# push things into the `commands` queue. This may well be the ongoing
+# way to do it, and I might consider breaking it out.
+#
+# 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.
+#
+# That said there are lots of hacks in here that needs to be cleaned up
+#
+# FIXME: Should probably treat this as a singleton.
+#
+#
+
+require 'keyboard_map'
+
+module Termcontroller
+  DOUBLE_CLICK_INTERVAL=0.5
+
+  class Controller
+    @@controllers = []
+
+    attr_reader :lastcmd, :commands
+
+    def initialize(target=nil, keybindings={})
+      @m = Mutex.new
+
+      @target = target
+      @target_stack = []
+
+      @keybindings = keybindings
+      @buf = ""
+      @commands = Queue.new
+      @mode = :cooked
+
+      @kb = KeyboardMap.new
+      @con = IO.console
+      raise if !@con
+
+      at_exit { quit }
+      trap("CONT")  { resume }
+      trap("WINCH") { @commands << :resize }
+
+      setup
+
+      @t = Thread.new { readloop }
+
+      @@controllers << @t
+
+    end
+
+    def paused?; @mode == :pause; end
+
+    def push_target(t)
+      @target_stack << @target
+      @target = t
+    end
+
+    def pop_target
+      t = @target
+      @target = @target_stack.pop
+      t
+    end
+
+
+    #
+    # Pause processing so you can read directly from stdin
+    # yourself. E.g. to use Readline, or to suspend
+    #
+    def pause
+      @m.synchronize do
+        old = @mode
+        begin
+          @mode = :pause
+          IO.console.cooked!
+          cleanup
+          r = yield
+          setup
+          r
+        rescue Interrupt
+        ensure
+          @mode = old
+        end
+      end
+    end
+
+    # FIXME: The first event after the yield
+    # appears to fail to pass the mapping.
+    # Maybe move the mapping to the client thread?
+    def raw
+      keybindings = @keybindings
+      @keybindings = {}
+      push_target(nil)
+      yield
+    rescue Interrupt
+    ensure
+      @keybindings = keybindings
+      pop_target
+    end
+
+    def handle_input
+      if c = @commands.pop
+        do_command(c)
+      end
+      return Array(c)
+    end
+
+    def suspend
+      pause do
+        yield if block_given?
+        Process.kill("STOP", 0)
+      end
+    end
+
+    def resume
+      @mode = :cooked
+      setup
+      @commands << [:resume]
+    end
+
+    private # # ########################################################
+
+    def setup
+      STDOUT.print "\e[?2004h" # Enable bracketed paste
+      STDOUT.print "\e[?1000h" # Enable mouse reporting
+      STDOUT.print "\e[?1002h" # Enable mouse *move when clicked* reporting
+      STDOUT.print "\e[?1006h" # Enable extended reporting
+      STDOUT.print "\e[?25l"   # Hide cursor
+      @con.raw!
+    end
+
+    def cleanup
+      # Some programs, like more and docker struggles if the terminal
+      # is not returned to blocking mode
+      stdin_flags = STDIN.fcntl(Fcntl::F_GETFL)
+      STDIN.fcntl(Fcntl::F_SETFL, stdin_flags & ~Fcntl::O_NONBLOCK) #
+
+      @con.cooked!
+      STDOUT.print "\e[?2004l" #Disable bracketed paste
+      STDOUT.print "\e[?1000l" #Disable mouse reporting
+      STDOUT.print "\e[?25h"   # Show cursor
+    end
+
+    def quit
+      @@controllers.each {|t| t.kill }
+      cleanup
+    end
+
+
+    def fill_buf
+      # We do this to ensure the other thread gets a chance
+      sleep(0.01)
+
+      @m.synchronize do
+        @con.raw!
+        return if !IO.select([$stdin],nil,nil,0.1)
+        str = $stdin.read_nonblock(4096)
+
+        # FIXME...
+        str.force_encoding("utf-8")
+        @buf << str
+      end
+    rescue IO::WaitReadable
+    end
+
+
+    def getc
+      while @buf.empty?
+        fill_buf
+      end
+      @buf.slice!(0) if !paused? && @mode == :cooked
+    rescue Interrupt
+    end
+
+    # We do this because @keybindings can be changed
+    # on the main thread if the client changes the bindings,
+    # e.g. by calling `#raw`. This is the *only* sanctioned
+    # way to look up the binding.
+    #
+    def map(key, map = @keybindings)
+      map && key ? map[key.to_sym] : nil
+    end
+
+    def get_command
+      # Keep track of compound mapping
+      cmap = nil
+      cmdstr = ""
+
+      loop do
+        c = nil
+        char = getc
+        return nil if !char
+
+        a = Array(@kb.call(char))
+        c1 = a.first
+
+        if c1 == :mouse_up
+          t  = Time.now
+          dt = @lastclick ? t - @lastclick : 999
+          if dt < DOUBLE_CLICK_INTERVAL
+            c1 = :mouse_doubleclick
+          else
+            c1 = :mouse_click
+          end
+          @lastclick = t
+        end
+
+        c = map(c1, cmap || @keybindings)
+
+        if c.nil? && c1.kind_of?(String)
+          return [:char, c1]
+        end
+
+        if c.nil?
+          if c1
+            args = c1.respond_to?(:args) ? c1.args : []
+            @lastcmd = cmdstr + c1.to_sym.to_s
+            return Array(c1.to_sym).concat(args || [])
+          else
+            @lastcmd = cmdstr + char.inspect
+            return nil
+          end
+        end
+
+        str = c1.to_sym.to_s.split("_").join(" ")
+        if cmdstr.empty?
+          cmdstr = str
+        else
+          cmdstr += " + " + str
+        end
+
+        if c.kind_of?(Hash) # Compound mapping
+          cmap = c
+        else
+          @lastcmd = cmdstr + " (#{c.to_s})" if c.to_s != @lastcmd
+          return c
+        end
+      end
+    end
+
+    def read_input
+      c = get_command
+      if !c
+        Thread.pass
+        return
+      end
+
+      @commands << c
+    end
+
+    def readloop
+      loop do
+        if @mode == :cooked
+          read_input
+        else
+          fill_buf
+        end
+      end
+    end
+
+    def do_command(c)
+      return nil if !c || !@target
+      a = Array(c)
+      if @target.respond_to?(a.first)
+        @target.instance_eval { send(*a) }
+      else
+        @lastcmd = "Unbound: #{a.first.inspect}"
+      end
+    end
+
+  end
+end

data/lib/termcontroller/version.rb

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

data/lib/termcontroller.rb

@@ -1,6 +1,6 @@
 require "termcontroller/version"
+require "termcontroller/controller"
 
 module Termcontroller
   class Error < StandardError; end
-  # Your code goes here...
 end

data/termcontroller.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.add_dependency "keyboard_map", ">=0.1.3"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: termcontroller
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '0.3'
 platform: ruby
 authors:
 - Vidar Hokstad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: keyboard_map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 description: 
 email:
 - vidar@hokstad.com
@@ -27,6 +41,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