termtime 1.0.0

data/lib/termtime/terminfo.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "termtime/db"
+
+module TermTime
+  class TermInfo
+    class Number
+      attr_reader :value, :db
+
+      def initialize v, db
+        @value = v
+        @db = db
+        freeze
+      end
+
+      def tiname; @db.tiname; end
+    end
+
+    class String
+      attr_reader :value, :db
+
+      def initialize v, db
+        @value = v
+        @db = db
+        freeze
+      end
+
+      def tiname; @db.tiname; end
+
+      def tparm(...)
+        TermTime.tparm(value, ...)
+      end
+    end
+
+    def initialize fname = ENV["TERM"]
+      unless File.file? fname
+        fname = "/usr/share/terminfo/#{fname.getbyte(0).to_s(16)}/#{fname}"
+      end
+
+      File.open fname, "rb" do |f|
+        magic,
+          names_size,
+          booleans_size,
+          short_int_count,
+          offset_count,
+          string_table_size = f.read((2 * 6)).unpack("ssssss")
+
+        raise unless magic == 0432
+        @names = f.read(names_size - 1).force_encoding("UTF-8").freeze
+        raise unless f.readbyte == 0
+        @flags = f.read(booleans_size - 1)
+
+        f.readbyte
+        f.readbyte if f.pos % 2 != 0 # alignment
+
+        @numbers = f.read(short_int_count * 2)
+        strings = f.read(offset_count * 2)
+        string_table = f.read(string_table_size)
+        @strings = decode_strings(strings, string_table)
+      end
+    end
+
+    def flags
+      flags = []
+      @flags.bytesize.times do |i|
+        if @flags.getbyte(i) > 0
+          flags << DB::BOOLEAN_LIST.fetch(i)
+        end
+      end
+      flags
+    end
+
+    def numbers
+      numbers = []
+      @numbers.unpack("s*").each_with_index do |v, i|
+        next if v == -1
+        numbers << Number.new(v, DB::NUMBER_LIST.fetch(i))
+      end
+      numbers
+    end
+
+    def strings
+      @strings.values
+    end
+
+    def getnum name
+      offset = DB::NUMBERS.fetch(name).i * 2
+      @numbers.getbyte(offset) | (@numbers.getbyte(offset + 1) << 8)
+    end
+
+    def getflag name
+      @flags.getbyte(DB::BOOLEANS.fetch(name).i) == 1
+    end
+
+    def getstr name
+      str(name).value
+    end
+
+    def str name
+      @strings.fetch(name)
+    end
+
+    def str? name
+      @strings.key?(name)
+    end
+
+    def names
+      @names.split("|")
+    end
+
+    private
+
+    def decode_strings str_offsets, string_table
+      strings = {}
+      str_offsets.unpack("s*").each_with_index do |v, i|
+        next if v == -1
+        next if i >= DB::STRING_LIST.length
+
+        len = string_table.byteindex("\0", v) - v
+        str = string_table.byteslice(v, len).freeze
+        x = DB::STRING_LIST.fetch(i)
+        strings[x.tiname] = String.new(str, x)
+      end
+      strings
+    end
+  end
+end

data/lib/termtime/version.rb

@@ -0,0 +1,3 @@
+module TermTime
+  VERSION = "1.0.0"
+end

data/lib/termtime.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "strscan"
+
+module TermTime
+  autoload :TermInfo, "termtime/terminfo"
+  autoload :DB, "termtime/db"
+
+  def self.tparm fmt, p1 = 0, p2 = 0, p3 = 0, p4 = 0, p5 = 0, p6 = 0, p7 = 0, p8 = 0, p9 = 0
+    return fmt unless fmt =~ /%/
+
+    regs = [p1, p2, p3, p4, p5, p6, p7, p8, p9]
+    stack = []
+
+    scan = StringScanner.new fmt
+    buff = ''.b
+
+    while !scan.eos?
+      start = scan.pos
+      case
+      when scan.skip(/%i/)
+        regs[0] += 1
+        regs[1] += 1
+      when scan.skip(/%t/)
+        if stack.pop == 0
+          scan.skip_until(/%e/)
+        else
+        end
+      when scan.skip(/%c/)
+        buff << stack.pop
+      when scan.skip(/%</)
+        y = stack.pop
+        x = stack.pop
+        stack << (x < y ? 1 : 0)
+      when scan.skip(/%>/)
+        y = stack.pop
+        x = stack.pop
+        stack << (x > y ? 1 : 0)
+      when scan.skip(/%\+/) then stack << (stack.pop + stack.pop)
+      when scan.skip(/%\*/) then stack << (stack.pop * stack.pop)
+      when scan.skip(/%-/)
+        y = stack.pop
+        x = stack.pop
+        stack << (x - y)
+      when scan.skip(/%\//)
+        y = stack.pop
+        x = stack.pop
+        stack << (x / y)
+      when scan.skip(/%m/)
+        y = stack.pop
+        x = stack.pop
+        stack << (x % y)
+      when scan.skip(/%!/) then stack << (stack.pop == 0 ? 1 : 0)
+      when scan.skip(/%=/) then stack << (stack.pop == stack.pop ? 1 : 0)
+      when scan.skip(/%%/) then buff << "%"
+      when scan.skip(/%e/)
+        # if we made it to %e, we must have been in the true branch,
+        # so skip until after %;
+        if !scan.skip_until(/%;/)
+          break;
+        end
+      when scan.skip(/%l/) then raise NotImplementedError
+      when scan.skip(/%&/) then stack << (stack.pop & stack.pop)
+      when scan.skip(/%\|/) then stack << (stack.pop | stack.pop)
+      when scan.skip(/%\^/) then stack << (stack.pop ^ stack.pop)
+      when scan.skip(/%~/) then stack << (~stack.pop)
+      when scan.skip(/%'.'/) then stack << fmt.getbyte(start + 2)
+      when scan.skip(/%A/)
+        stack << (stack.pop != 0 && stack.pop != 0 ? 1 : 0)
+      when scan.skip(/%O/)
+        stack << (stack.pop != 0 || stack.pop != 0 ? 1 : 0)
+      when scan.skip(/%[;?]/)
+      when scan.skip(/%{\d+}/)
+        stack << fmt.byteslice(start + 2, scan.pos - start - 3).to_i
+      when scan.skip(/%p[0-9]/)
+        stack.push regs[(fmt.getbyte(scan.pos - 1) - 0x30) - 1]
+      when str = scan.scan(/%([0-9].[0-9])?[dsoxX]/)
+        buff << sprintf(str, stack.pop)
+      when str = scan.scan(/[^%]+/)
+        buff << str
+      else
+        p scan
+        raise
+      end
+    end
+    buff
+  end
+end

data/templates/lib/termtime/db.rb.erb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# GENERATED FILE, DO NOT EDIT
+# :stopdoc:
+module TermTime
+  module DB
+    class Capability
+      attr_reader :name, :tiname, :titype, :tcname, :key_name, :value, :flags, :desc, :i
+
+      def initialize(name, tiname, titype, tcname, key_name, value, flags, desc, i)
+        @name = name
+        @tiname = tiname
+        @titype = titype
+        @tcname = tcname
+        @key_name = key_name
+        @value = value
+        @flags = flags
+        @desc = desc
+        @i = i
+      end
+    end
+    class Boolean < Capability; end
+    class Number < Capability; end
+    class String < Capability; end
+
+    BOOLEANS = {
+<% info["bool"].each_with_index do |bool, i| %>
+      <%= bool[1].dump %> => Boolean.new(
+<% bool.map(&:dump).each do |f| %>
+        <%= f %>,
+<% end %>
+        <%= i %>,
+      ).freeze,
+<% end %>
+    }.freeze
+    BOOLEAN_LIST = BOOLEANS.values
+
+    NUMBERS = {
+<% info["num"].each_with_index do |bool, i| %>
+      <%= bool[1].dump %> => Number.new(
+<% bool.map(&:dump).each do |f| %>
+        <%= f %>,
+<% end %>
+        <%= i %>,
+      ).freeze,
+<% end %>
+    }.freeze
+    NUMBER_LIST = NUMBERS.values
+
+    STRINGS = {
+<% info["str"].each_with_index do |bool, i| %>
+      <%= bool[1].dump %> => String.new(
+<% bool.map(&:dump).each do |f| %>
+        <%= f %>,
+<% end %>
+        <%= i %>,
+      ).freeze,
+<% end %>
+    }.freeze
+    STRING_LIST = STRINGS.values
+  end
+end
+# :startdoc:

data/termtime.gemspec

@@ -0,0 +1,17 @@
+require_relative "lib/termtime/version"
+
+Gem::Specification.new do |s|
+  s.name        = "termtime"
+  s.version     = TermTime::VERSION
+  s.summary     = "Pure Ruby terminfo library"
+  s.description = "This is a pure Ruby terminfo library"
+  s.authors     = [ "Aaron Patterson" ]
+  s.email       = "tenderlove@ruby-lang.org"
+  s.files       = `git ls-files -z`.split("\x0")
+  s.test_files  = s.files.grep(%r{^test/})
+  s.homepage    = "https://github.com/tenderlove/termtime"
+  s.license     = "Apache-2.0"
+
+  s.add_development_dependency("rake", "~> 13.0")
+  s.add_development_dependency("minitest", "~> 5.20")
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require "minitest/autorun"
+
+module TermTime
+  class Test < Minitest::Test
+    FIXTURES = File.expand_path(File.join(File.dirname(__FILE__), "fixtures"))
+  end
+end

data/test/terminfo_test.rb

@@ -0,0 +1,105 @@
+require "helper"
+require "termtime"
+
+module TermTime
+  class TermInfoTest < Test
+    def test_info
+      ti = TermInfo.new File.join(FIXTURES, "xterm-256color")
+      assert_equal ["xterm-256color", "xterm with 256 colors"], ti.names
+      assert_equal ["am", "bce", "ccc", "xenl", "km", "mir", "msgr", "npc", "mc5i"].sort, ti.flags.map(&:tiname).sort
+      assert ti.getflag("am")
+      assert ti.getflag("npc")
+      assert_equal ["colors", "cols", "it", "lines", "pairs"].sort, ti.numbers.map(&:tiname).sort
+      assert_equal [256, 80, 8, 24, 32767], ti.numbers.sort_by(&:tiname).map(&:value)
+
+      assert_equal 256, ti.getnum("colors")
+      assert_equal 24, ti.getnum("lines")
+
+      assert_equal "\e[H\e[2J", ti.getstr("clear")
+    end
+
+    def test_adm3a
+      ti = TermInfo.new File.join(FIXTURES, "adm3a")
+      assert_equal ["adm3a", "lsi adm3a"], ti.names
+      assert_equal ["am"], ti.flags.map(&:tiname)
+      assert ti.getflag("am")
+      refute ti.getflag("npc")
+
+      assert_equal ["cols", "lines"].sort, ti.numbers.map(&:tiname).sort
+      assert_equal [80, 24], ti.numbers.sort_by(&:tiname).map(&:value)
+
+      assert_equal ["bel", "clear", "cr", "cub1", "cud1", "cuf1", "cup", "cuu1", "home", "ind", "kcub1", "kcud1", "kcuf1", "kcuu1", "rs2"], ti.strings.map(&:tiname).sort
+
+      assert_equal ["\a", "\x1A$<1/>", "\r", "\b", "\n", "\f", "\e=%p1%' '%+%c%p2%' '%+%c", "\v", "\x1E", "\n", "\b", "\n", "\f", "\v", "\x0E"], ti.strings.sort_by(&:tiname).map(&:value)
+    end
+
+    def test_getstr_tparm
+      ti = TermInfo.new File.join(FIXTURES, "xterm-256color")
+      assert_equal "\e[2D", ti.str("cub").tparm(2)
+    end
+
+    def test_tparm
+      assert_equal "1;1", TermTime.tparm("%i%p1%d;%p2%d")
+      assert_equal "0;0", TermTime.tparm("%p1%d;%p2%d")
+      assert_equal "1;2", TermTime.tparm("%i%p1%d;%p2%d", 0, 1)
+      assert_equal "true", TermTime.tparm("%p1%ttrue%efalse%;", 1)
+      assert_equal "false", TermTime.tparm("%p1%ttrue%efalse%;", 0)
+      assert_equal "8", TermTime.tparm("%{8}%d")
+      assert_equal "%", TermTime.tparm("%%")
+      assert_equal [40].pack("C"), TermTime.tparm("%{40}%c")
+    end
+
+    def test_tparm_lt
+      assert_equal "less", TermTime.tparm("%?%p1%{8}%<%tless%emore%?", 0)
+      assert_equal "less", TermTime.tparm("%?%p1%{8}%<%tless%emore%;", 0)
+      assert_equal "more", TermTime.tparm("%?%p1%{8}%<%tless%emore%;", 8)
+    end
+
+    def test_tparm_gt
+      assert_equal "less", TermTime.tparm("%?%p1%{8}%>%tmore%eless%;", 0)
+      assert_equal "more", TermTime.tparm("%?%p1%{8}%>%tmore%eless%;", 9)
+    end
+
+    def test_tparm_eq
+      assert_equal "no", TermTime.tparm("%?%p1%{8}%=%tyes%eno%;", 0)
+      assert_equal "yes", TermTime.tparm("%?%p1%{8}%=%tyes%eno%;", 8)
+    end
+
+    def test_tparm_math
+      assert_equal "9", TermTime.tparm("%{8}%p1%+%d", 1)
+      assert_equal "7", TermTime.tparm("%{8}%p1%-%d", 1)
+      assert_equal "16", TermTime.tparm("%{8}%p1%*%d", 2)
+      assert_equal "4", TermTime.tparm("%{8}%p1%/%d", 2)
+      assert_equal "1", TermTime.tparm("%{9}%p1%m%d", 2)
+    end
+
+    def test_tparm_bits
+      assert_equal "1", TermTime.tparm("%{9}%p1%&%d", 1)
+      assert_equal "9", TermTime.tparm("%{8}%p1%|%d", 1)
+      assert_equal "6", TermTime.tparm("%{5}%p1%^%d", 3)
+      assert_equal "-6", TermTime.tparm("%{5}%~%d")
+    end
+
+    def test_tparm_bool
+      assert_equal "1", TermTime.tparm("%{0}%!%d")
+      assert_equal "0", TermTime.tparm("%{5}%!%d")
+    end
+
+    def test_tparm_logic
+      assert_equal "1", TermTime.tparm("%p1%p2%A%d", 1, 5)
+      assert_equal "0", TermTime.tparm("%p1%p2%A%d", 1, 0)
+      assert_equal "1", TermTime.tparm("%p1%p2%O%d", 1, 5)
+      assert_equal "1", TermTime.tparm("%p1%p2%O%d", 1, 0)
+    end
+
+    def test_tparm_char_constant
+      assert_equal "65", TermTime.tparm("%'A'%d")
+    end
+
+    def test_odk
+      x = "\e]4;1;rgb:00/00/01\e\\"
+      y = TermTime.tparm("\e]4;%p1%d;rgb:%p2%{255}%*%{1000}%/%2.2X/%p3%{255}%*%{1000}%/%2.2X/%p4%{255}%*%{1000}%/%2.2X\e\\", 1, 2, 3, 4)
+      assert_equal x, y
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: termtime
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+original_platform: ''
+authors:
+- Aaron Patterson
+bindir: bin
+cert_chain: []
+date: 2024-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+description: This is a pure Ruby terminfo library
+email: tenderlove@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- assets/termtime.png
+- lib/termtime.rb
+- lib/termtime/db.rb
+- lib/termtime/terminfo.rb
+- lib/termtime/version.rb
+- templates/lib/termtime/db.rb.erb
+- termtime.gemspec
+- test/fixtures/adm3
+- test/fixtures/adm3a
+- test/fixtures/xterm-256color
+- test/helper.rb
+- test/terminfo_test.rb
+homepage: https://github.com/tenderlove/termtime
+licenses:
+- Apache-2.0
+metadata: {}
+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: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: Pure Ruby terminfo library
+test_files:
+- test/fixtures/adm3
+- test/fixtures/adm3a
+- test/fixtures/xterm-256color
+- test/helper.rb
+- test/terminfo_test.rb