mini_term 0.1.0

data/lib/mini_term/windows/link.rb

@@ -0,0 +1,71 @@
+# coding: utf-8
+
+# Link Ruby to the Windows API calls needed by MiniTerm
+module MiniTerm
+
+  # The magic numbers for the handles.
+  STDIN_ID = -10
+  STDOUT_ID = -11
+
+  # MiniTerm needs to retrieve standard handles.
+  get_handle_proc = Win32API.new("kernel32", "GetStdHandle", ['L'], 'L')
+
+  define_singleton_method(:get_handle) do |handle_index|
+    get_handle_proc.call(handle_index)
+  end
+
+  # Well, stdout's handle in particular.
+  def self.stdout_handle
+    get_handle(STDOUT_ID)
+  end
+
+  # Well, stdin's handle in particular.
+  def self.stdin_handle
+    get_handle(STDIN_ID)
+  end
+
+  # MiniTerm needs to get the current stdin mode
+  get_mode_proc = Win32API.new("kernel32", "GetConsoleMode", ['L', 'P'], 'I')
+
+  define_singleton_method(:get_console_mode) do |buffer|
+    get_mode_proc.call(stdin_handle, buffer)
+  end
+
+  # MiniTerm needs to set the current stdin mode
+  set_mode_proc = Win32API.new("kernel32", "SetConsoleMode", ['L', 'L'], 'I')
+
+  define_singleton_method(:set_console_mode) do |new_mode|
+    set_mode_proc.call(stdin_handle, new_mode)
+  end
+
+  # MiniTerm needs to retrieve screen info.
+  get_screen_info_proc = Win32API.new("kernel32",
+                                      "GetConsoleScreenBufferInfo",
+                                      ['L','P'], 'L')
+
+  define_singleton_method(:get_screen_info) do |buffer|
+    get_screen_info_proc.call(stdout_handle, buffer)
+  end
+
+  # MiniTerm needs to move the cursor about.
+  set_cursor_posn_proc = Win32API.new("kernel32",
+                                      "SetConsoleCursorPosition",
+                                      ['L','L'], 'L')
+
+  define_singleton_method(:set_cursor_posn) do |position|
+    set_cursor_posn_proc.call(stdout_handle, position)
+  end
+
+  # MiniTerm needs to know if any keystrokes are waiting.
+  getch_proc = Win32API.new("msvcrt", "_getch", [], 'I')
+  define_singleton_method(:getch) { getch_proc.call.chr }
+
+  # MiniTerm needs to get a single character in raw mode.
+  kbhit_proc = Win32API.new("msvcrt", "_kbhit", [], 'I')
+  define_singleton_method(:kbhit) { kbhit_proc.call }
+
+  # MiniTerm needs to make some noise.
+  beep_proc  = Win32API.new("user32", "MessageBeep", ['L'], '0')
+  define_singleton_method(:beep) { beep_proc.call(0); self }
+
+end

data/lib/mini_term/windows/output.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+# MiniTerm needs to put text on the screen! (Windows Specific Code)
+module MiniTerm
+
+  # Put some text onto the screen.
+  def self.print(text)
+    STDOUT.print(text)
+    self
+  end
+
+  # See link.rb for the beep method.
+
+  # Clear the screen and home the cursor
+  def self.clear_screen
+    system("cls")
+    self
+  end
+
+end

data/lib/mini_term/windows/raw_input.rb

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+# Get input from the user in raw mode. (Windows Specific Code)
+module MiniTerm
+
+  # The sleep interval waiting for a key to be pressed.
+  WAIT_SLEEP = 0.02
+  TERM_MODE_MASK         = 0xFFFFFFFF
+  ENABLE_LINE_INPUT      = 0x00000002
+  ENABLE_PROCESSED_INPUT = 0x00000001
+
+  # Is there a character waiting?
+  def self.has_raw_char?
+    raw { kbhit != 0 }
+  end
+
+  # Get a uncooked character keystroke.
+  def self.get_raw_char
+    fail MiniTermNotRaw, "Not in raw mode." unless raw?
+
+    while (kbhit == 0)
+      sleep(WAIT_SLEEP)
+    end
+
+    getch
+  end
+
+private
+
+  # Get user input uncooked, with no echo or buffering.
+  def self.begin_raw_input
+    @saved_mode = get_term_mode
+
+    mask = TERM_MODE_MASK ^
+           (@options[:pass_ctrl_s] ? ENABLE_LINE_INPUT : 0) ^
+           (@options[:pass_ctrl_c] ? ENABLE_PROCESSED_INPUT : 0)
+
+    # Clear the ENABLE_LINE_INPUT and ENABLE_PROCESSED_INPUT flags.
+    # See https://docs.microsoft.com/en-us/windows/console/setconsolemode
+    set_term_mode(@saved_mode & mask)
+    @raw_input = true
+  end
+
+  # Done with raw mode for now.
+  def self.end_raw_input
+    set_term_mode(@saved_mode)
+    @raw_input = false
+  end
+
+end

data/lib/mini_term/windows/set_posn.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+
+# Give MiniTerm control of the cursor position. (Windows Specific Code)
+module MiniTerm
+
+  # Set the row (optional) and column of the cursor.
+  def self.set_posn(row: get_cursor_row, column:)
+    set_cursor_posn(row * 65536 + column)
+    self
+  end
+
+end

data/lib/mini_term/windows/term_info.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+# Get size info about the console window. (Windows Specific Code)
+module MiniTerm
+
+  # Get term_info [rows, cols]
+  def self.term_info
+    raw_buffer = 0.chr * 24
+    get_screen_info(raw_buffer)
+
+    width = (raw_buffer[0,2].unpack('S'))[0]
+    _left, top, _right, bottom = raw_buffer[10,8].unpack('SSSS')
+
+    [bottom - top + 1, width]
+  end
+
+private
+
+  # Get the current terminal mode.
+  def self.get_term_mode
+    raw_buffer = 0.chr * 8
+    get_console_mode(raw_buffer)
+    raw_buffer[0,4].unpack('L')[0]
+  end
+
+  # Get the current terminal mode.
+  def self.set_term_mode(new_mode)
+    set_console_mode(new_mode)
+  end
+
+  # Get the current row of the cursor.
+  def self.get_cursor_row
+    raw_buffer = 0.chr * 24
+    get_screen_info(raw_buffer)
+    (raw_buffer[6,2].unpack('S'))[0]
+  end
+
+end

data/lib/mini_term/windows/win_32_api.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+# Replacement support for deprecated win_32_api gem, with thanks to the
+# ConnorAtherton/rb-readline project from where this code originates.
+module MiniTerm
+
+  require 'fiddle'
+
+  #The classic Win32API gem is deprecated, so we emulate it with fiddle.
+  class Win32API
+    DLL   = {}
+    TYPES = {"0" => Fiddle::TYPE_VOID,
+             "S" => Fiddle::TYPE_VOIDP,
+             "I" => Fiddle::TYPE_LONG}
+
+    def initialize(dll_name, func, import, export = "0", _ct = nil)
+      @proto = import.join.tr("VPpNnLlIi", "0SSI").chomp('0').split('')
+      handle = DLL[dll_name] ||= Fiddle.dlopen(dll_name)
+      @func = Fiddle::Function.new(handle[func], TYPES.values_at(*@proto), 1)
+    end
+
+    def call(*args)
+      args.each_with_index do |x, i|
+        if @proto[i] == "S"
+          args[i] = [x == 0 ? nil : x].pack("p").unpack("l!*")[0]
+        end
+      end
+
+      @func.call(*args).to_i
+    end
+
+  end
+end

data/lib/mini_term/windows.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+# Get appropriate access to Windows API calls
+if MiniTerm.java?
+  require 'win32api'
+else
+  require_relative 'windows/win_32_api'
+end
+
+require_relative 'windows/link'
+require_relative 'windows/term_info'
+require_relative 'windows/set_posn'
+require_relative 'windows/raw_input'
+require_relative 'windows/output'
+
+module MiniTerm
+
+  # What options are supported in this Windows?
+  VALID_OPTIONS = [:quiet, :strict, :pass_ctrl_s, :pass_ctrl_c].freeze
+
+end

data/lib/mini_term.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+require 'rbconfig'
+
+require_relative "mini_term/common/char_defs"
+require_relative "mini_term/common/term_info"
+require_relative "mini_term/common/raw_input"
+require_relative "mini_term/common/mapper"
+require_relative "mini_term/common/mapped_input"
+require_relative "mini_term/version"
+
+# A simple, portable terminal interface object. (Common Code)
+module MiniTerm
+  host_os = RbConfig::CONFIG['host_os']
+
+  #What operating platform is in effect?
+  TERM_PLATFORM =
+    case host_os
+    when /mswin|msys|mingw|bccwin|wince|emc/
+      :windows
+    when /cygwin/
+      :cygwin
+    when /darwin|mac os/
+      :macosx
+    when /linux/
+      :linux
+    when /solaris|bsd/
+      :unix
+    else
+      raise "Unknown os: #{host_os.inspect}"
+    end
+
+  TERM_TYPE = (TERM_PLATFORM == :windows) ? :windows : :ansi
+
+  #Is Java present in the environment?
+  TERM_JAVA = (RUBY_PLATFORM =~ /java/) ? true : false
+
+  # Is this Windows?
+  def self.windows?
+    TERM_TYPE == :windows
+  end
+
+  # Is this ANSI?
+  def self.ansi?
+    TERM_TYPE == :ansi
+  end
+
+  # Are we running under Java?
+  def self.java?
+    TERM_JAVA
+  end
+end
+
+# Load in the appropriate code.
+if MiniTerm.windows?
+  require_relative 'mini_term/windows'
+elsif MiniTerm.ansi?
+  require_relative 'mini_term/ansi'
+else
+  # This should never happen unless incorrect changes are made.
+  fail MiniTermWTF, "Invalid terminal type: #{MiniTerm::TERM_TYPE.inspect}"
+end

data/mini_term.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mini_term/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_term"
+  spec.version       = MiniTerm::VERSION
+  spec.authors       = ["PeterCamilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+  spec.homepage      = "https://github.com/PeterCamilleri/mini_term"
+
+  spec.summary       = %q{A portable encapsulation of the console terminal.}
+  spec.description   = %q{A portable encapsulation of the console terminal. } +
+                       %q{Supports Linux, Mac, Windows, and Cygwin. }
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|docs)/})
+  end
+
+  spec.require_paths = ["lib"]
+  spec.bindir        = "exe"
+  spec.executables   = spec
+                         .files
+                         .reject { |f| f.downcase == 'exe/readme.md'}
+                         .grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.required_ruby_version = '>=2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'minitest_visible', "~> 0.1"
+  spec.add_development_dependency 'reek', "~> 5.0.2"
+end

data/rakefile.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+desc "Run a scan for smelly code!"
+task :reek do |t|
+  `reek --no-color lib > reek.txt`
+end
+
+desc "Fire up an IRB session with mini_term preloaded."
+task :console do
+  system "ruby irbt.rb local"
+end
+
+desc "What version of mini_term is this?"
+task :vers do |t|
+  puts
+  puts "mini_term version = #{MiniTerm::VERSION}"
+end
+
+desc "Alternative test procedure"
+task :alt_test, :target do |t, args|
+  args.with_defaults(:target => 'test')
+  here  = File.dirname(__FILE__)
+  target = "#{here}/#{args[:target]}/*.rb"
+  puts "Target files = #{target}"
+  puts
+
+  block = "{|file| require file if File.basename(file) =~ /test/}"
+  code  = "Dir['#{target}'].each #{block}"
+
+  system "ruby -e\"#{code}\""
+end

data/samples/test_map.rb

@@ -0,0 +1,30 @@
+# A sample test map for use with the mapped_key_test program.
+# These demonstrate overriding the mappings built into the program.
+
+$mini_term_exit_info = {}
+
+MiniTerm.add_map(:windows) do |map|
+
+  # Make local copies of the prefixes for brevity.
+  x00 = MiniTerm::PREFIX_00
+  xe0 = MiniTerm::PREFIX_E0
+
+  #The Cancel key
+  map["\e"]    = :cancel
+
+  #End of Input
+  map["\x1A"]  = :end_of_input
+
+  $mini_term_exit_info[:windows] = [:end_of_input, "Ctrl+z"]
+end
+
+MiniTerm.add_map(:ansi) do |map|
+
+  #The Cancel key
+  map["\f"]    = :cancel
+
+  #End of Input
+  map["\ez"]   = :end_of_input
+
+  $mini_term_exit_info[:ansi] = [:end_of_input, "Alt+z"]
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: mini_term
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PeterCamilleri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+description: 'A portable encapsulation of the console terminal. Supports Linux, Mac,
+  Windows, and Cygwin. '
+email:
+- peter.c.camilleri@gmail.com
+executables:
+- mapped_key_test
+- mini_term_blizzard
+- mini_term_code_points
+- raw_key_test
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- exe/README.md
+- exe/mapped_key_test
+- exe/mini_term_blizzard
+- exe/mini_term_code_points
+- exe/raw_key_test
+- irbt.rb
+- lib/mini_term.rb
+- lib/mini_term/ansi.rb
+- lib/mini_term/ansi/output.rb
+- lib/mini_term/ansi/raw_input.rb
+- lib/mini_term/ansi/set_posn.rb
+- lib/mini_term/ansi/term_info.rb
+- lib/mini_term/common/char_defs.rb
+- lib/mini_term/common/mapped_input.rb
+- lib/mini_term/common/mapper.rb
+- lib/mini_term/common/raw_input.rb
+- lib/mini_term/common/term_info.rb
+- lib/mini_term/exceptions.rb
+- lib/mini_term/version.rb
+- lib/mini_term/windows.rb
+- lib/mini_term/windows/link.rb
+- lib/mini_term/windows/output.rb
+- lib/mini_term/windows/raw_input.rb
+- lib/mini_term/windows/set_posn.rb
+- lib/mini_term/windows/term_info.rb
+- lib/mini_term/windows/win_32_api.rb
+- mini_term.gemspec
+- rakefile.rb
+- samples/test_map.rb
+homepage: https://github.com/PeterCamilleri/mini_term
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A portable encapsulation of the console terminal.
+test_files: []