vtparser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d622edd5fbb0b4f47cb9831699c466aeabc3da9c6bed99370cc7d99d169c8c02
+  data.tar.gz: 33eccc5b843d8c5d734a06d5b2b3d389462c23ea568bf9456ed55a38d6f1a50a
+SHA512:
+  metadata.gz: 0e5c6dd30582e24e0ad63b142446280b1be31d51cbae543b78c0019bf626ce2d477ea7bf002ab3707c7dd8056df886d33304eaa2a9509c30a9cac7ac6148e4b9
+  data.tar.gz: ab1f60a0cdd8e079274bb8a7d6a285287b81a3fe1304462086ccdb71910fe09451faadaa4f3ce8935b6a63fdc579a856e069558e7183c8a7c659924e7ad32417

data/.bash_history

@@ -0,0 +1,117 @@
+rspec
+rspec
+rspec
+rspec
+rspec
+rspec
+rspec
+rspec
+rspec
+rspec
+rspec ./spec/vtparser_spec.rb:153
+rspec ./spec/vtparser_spec.rb:153
+rspec ./spec/vtparser_spec.rb:153
+rspec ./spec/vtparser_spec.rb:153
+rspec ./spec/vtparser_spec.rb:153
+rspec ./spec/vtparser_spec.rb:153
+rspec
+rspec
+rspec
+rspec ./spec/vtparser_spec.rb:37
+rspec ./spec/vtparser_spec.rb:37
+rspec
+rspec
+rspec       expect(output).to eq(input)
+rspec ./spec/vtparser_spec.rb:156
+rspec ./spec/vtparser_spec.rb:156
+rspec ./spec/vtparser_spec.rb:156
+rspec ./spec/vtparser_spec.rb:156
+rspec 
+rspec 
+D
+rspec ./spec/vtparser_spec.rb
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb:137 
+rspec ./spec/vtparser_spec.rb
+rspec ./spec/vtparser_spec.rb
+rspec ./spec/vtparser_spec.rb
+bundle
+rspec ./spec/vtparser_spec.rb
+rspec ./spec/vtparser_spec.rb
+ruby lib/vtparser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+bundle
+bundle
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+irb
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'yarn add --dev esbuild from "."'
+ruby lib/vtparser/parser.rb 'joe'
+joe
+ruby lib/vtparser/parser.rb 'vim'
+vim
+ruby example/indent_cli.rb 'vim'
+ruby examples/indent_cli.rb 'vim'
+ruby examples/indent_cli.rb 'vim'
+ruby examples/indent_cli.rb 'vim'
+ruby examples/indent_cli.rb 'joe'
+ruby examples/indent_cli.rb 'joe'
+ruby examples/indent_cli.rb 'joe'
+lsss
+less
+less README.md 
+ls
+exit
+ls
+ruby examples/indent_cli.rb 'less'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+less README.md
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/indent_cli.rb 'less README.md'
+ruby examples/test.rb 
+kkllllijjaaa
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/test.rb 
+ruby examples/indent_cli.rb
+ruby examples/indent_cli.rb 'bundle gem test17'
+ruby examples/indent_cli.rb 'bundle gem test18'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-01
+
+- Initial release

data/README.md

@@ -0,0 +1,53 @@
+# VT 100 Parser Gem
+
+This gem is a parser for VT100 terminal escape sequences. It is based on the C code from https://github.com/haberman/vtparse/.
+
+## Background on VT100 Escape Sequences
+
+See https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add vtparser
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install vtparser
+```
+
+## Basic Usage
+
+See the minimal example below and the [`examples`](https://github.com/coezbek/vtparser/examples) directory for more examples.
+
+```ruby
+require 'vtparser'
+
+# Instantiate the parser with a block to handle actions
+parser = VTParser.new do |action, ch, intermediate_chars, params|
+
+  # For this minimal example, we'll just turn everything back strings to print
+  print VtParser::to_ansi(action, ch, intermediate_chars, params)
+
+end
+
+# Sample input containing ANSI escape sequences
+input = "\e[31mHello, \e[1mWorld!\e[0m"
+
+# Parse the input
+parser.parse(input)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/coezbek/vtparser.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/examples/indent_cli.rb

@@ -0,0 +1,84 @@
+require 'pty'
+require "tty-prompt" # for winsize call below
+require 'rainbow/refinement' # for colorizing output
+using Rainbow
+require_relative '../lib/vtparser'
+
+# Get the command from ARGV
+command = ARGV.join(' ')
+if command.empty?
+  puts "Usage: ruby indent_cli.rb '<command>'"
+  exit 1
+end
+
+line_indent = '   ▐  '.yellow
+first_line = true
+parser = VTParser.new do |action, ch, intermediate_chars, params|
+  print line_indent if first_line
+  first_line = false
+
+  to_output = VTParser::to_ansi(action, ch, intermediate_chars, params)
+
+  case action
+  when :print, :execute, :put, :osc_put
+    if ch == "\n" || ch == "\r"
+      print ch
+      print line_indent
+      next
+    end
+  when :csi_dispatch
+    if to_output == "\e[2K"
+      print "\e[2K"
+      print line_indent
+      next
+    else
+      if ch == 'G'
+        # puts "to_output: #{to_output.inspect} action: #{action} ch: #{ch.inspect}"
+        # && parser.params.size == 1
+        print "\e[#{parser.params[0] + 6}G"
+
+        next
+      end
+    end
+  end
+
+  print to_output
+end
+
+begin
+  PTY.spawn(command) do |stdout_and_stderr, stdin, pid|
+
+    Thread.new do     
+      while pid != nil
+        stdin.write(STDIN.readpartial(1024)) # Requires user to press enter!
+      end
+    rescue => e
+      puts "Error: #{e}"
+      exit(0)
+    end
+
+    begin
+      stdout_and_stderr.winsize = $stdout.winsize
+
+      stdout_and_stderr.each_char do |char|
+
+        parser.parse(char)
+
+      end
+    rescue Errno::EIO
+      # End of output
+    end
+
+    # Wait for the child process to exit
+    Process.wait(pid)
+    pid = nil
+    exit_status = $?.exitstatus
+    result = exit_status == 0
+
+    # Clear the line, reset the cursor to the start of the line
+    print "\e[2K\e[1G"
+  end
+
+rescue PTY::ChildExited => e
+  puts "The child process exited: #{e}"
+end

data/lib/vtparser/parser.rb

@@ -0,0 +1,305 @@
+class VTParser
+  attr_reader :intermediate_chars, :params
+
+  def initialize(&block)
+    @callback = block
+    @state = :GROUND
+    @intermediate_chars = ''
+    @params = []
+    @ignore_flagged = false
+    initialize_states
+    build_state_transitions
+  end
+
+  def parse(data)
+    data.each_char do |ch|
+      # ch = byte.chr
+      do_state_change(ch)
+    end
+  end
+
+  def initialize_states
+    @states = {
+      :GROUND => {
+        (0x00..0x17) => :execute,
+        0x19 => :execute,
+        (0x1c..0x1f) => :execute,
+        (0x20..0x7f) => :print,
+      },
+      :ESCAPE => {
+        :on_entry => :clear,
+        (0x00..0x17) => :execute,
+        0x19 => :execute,
+        (0x1c..0x1f) => :execute,
+        0x7f => :ignore,
+        (0x20..0x2f) => [:collect, :ESCAPE_INTERMEDIATE],
+        (0x30..0x4f) => [:esc_dispatch, :GROUND],
+        (0x51..0x57) => [:esc_dispatch, :GROUND],
+        0x59 => [:esc_dispatch, :GROUND],
+        0x5a => [:esc_dispatch, :GROUND],
+        0x5c => [:esc_dispatch, :GROUND],
+        (0x60..0x7e) => [:esc_dispatch, :GROUND],
+        0x5b => :CSI_ENTRY,
+        0x5d => :OSC_STRING,
+        0x50 => :DCS_ENTRY,
+        0x58 => :SOS_PM_APC_STRING,
+        0x5e => :SOS_PM_APC_STRING,
+        0x5f => :SOS_PM_APC_STRING,
+      },
+      :ESCAPE_INTERMEDIATE => {
+        (0x00..0x17) => :execute,
+        0x19 => :execute,
+        (0x1c..0x1f) => :execute,
+        (0x20..0x2f) => :collect,
+        0x7f => :ignore,
+        (0x30..0x7e) => [:esc_dispatch, :GROUND],
+      },
+      :CSI_ENTRY => {
+        :on_entry => :clear,
+        (0x00..0x17) => :execute,
+        0x19 => :execute,
+        (0x1c..0x1f) => :execute,
+        0x7f => :ignore,
+        (0x20..0x2f) => [:collect, :CSI_INTERMEDIATE],
+        0x3a => :CSI_IGNORE,
+        (0x30..0x39) => [:param, :CSI_PARAM],
+        0x3b => [:param, :CSI_PARAM],
+        (0x3c..0x3f) => [:collect, :CSI_PARAM],
+        (0x40..0x7e) => [:csi_dispatch, :GROUND],
+      },
+      :CSI_PARAM => {
+        (0x00..0x17) => :execute,
+        0x19 => :execute,
+        (0x1c..0x1f) => :execute,
+        (0x30..0x39) => :param,
+        0x3b => :param,
+        0x7f => :ignore,
+        0x3a => :CSI_IGNORE,
+        (0x3c..0x3f) => :CSI_IGNORE,
+        (0x20..0x2f) => [:collect, :CSI_INTERMEDIATE],
+        (0x40..0x7e) => [:csi_dispatch, :GROUND],
+      },
+      :CSI_INTERMEDIATE => {
+        (0x00..0x17) => :execute,
+        0x19 => :execute,
+        (0x1c..0x1f) => :execute,
+        (0x20..0x2f) => :collect,
+        0x7f => :ignore,
+        (0x30..0x3f) => :CSI_IGNORE,
+        (0x40..0x7e) => [:csi_dispatch, :GROUND],
+      },
+      :CSI_IGNORE => {
+        (0x00..0x17) => :execute,
+        0x19 => :execute,
+        (0x1c..0x1f) => :execute,
+        (0x20..0x7f) => :ignore,
+      },
+      :DCS_ENTRY => {
+        :on_entry => :clear,
+        (0x00..0x17) => :ignore,
+        0x19 => :ignore,
+        (0x1c..0x1f) => :ignore,
+        0x7f => :ignore,
+        0x3a => :DCS_IGNORE,
+        (0x20..0x2f) => [:collect, :DCS_INTERMEDIATE],
+        (0x30..0x39) => [:param, :DCS_PARAM],
+        0x3b => [:param, :DCS_PARAM],
+        (0x3c..0x3f) => [:collect, :DCS_PARAM],
+        (0x40..0x7e) => [:collect, :DCS_PASSTHROUGH], # Changed CÖ so that the final character is collected
+      },
+      :DCS_PARAM => {
+        (0x00..0x17) => :ignore,
+        0x19 => :ignore,
+        (0x1c..0x1f) => :ignore,
+        (0x30..0x39) => :param,
+        0x3b => :param,
+        0x7f => :ignore,
+        0x3a => :DCS_IGNORE,
+        (0x3c..0x3f) => :DCS_IGNORE,
+        (0x20..0x2f) => [:collect, :DCS_INTERMEDIATE],
+        (0x40..0x7e) => [:collect, :DCS_PASSTHROUGH], # Changed CÖ so that the final character is collected
+      },
+      :DCS_INTERMEDIATE => {
+        (0x00..0x17) => :ignore,
+        0x19 => :ignore,
+        (0x1c..0x1f) => :ignore,
+        (0x20..0x2f) => :collect,
+        0x7f => :ignore,
+        (0x30..0x3f) => :DCS_IGNORE,
+        (0x40..0x7e) => [:collect, :DCS_PASSTHROUGH], # Changed CÖ so that the final character is collected
+      },
+      :DCS_PASSTHROUGH => {
+        :on_entry => :hook,
+        (0x00..0x17) => :put,
+        0x19 => :put,
+        (0x1c..0x1f) => :put,
+        (0x20..0x7e) => :put,
+        0x7f => :ignore,
+        :on_exit => :unhook,
+      },
+      :DCS_IGNORE => {
+        (0x00..0x17) => :ignore,
+        0x19 => :ignore,
+        (0x1c..0x1f) => :ignore,
+        (0x20..0x7f) => :ignore,
+      },
+      :OSC_STRING => {
+        :on_entry => :osc_start,
+        (0x00..0x17) => :ignore,
+        0x19 => :ignore,
+        (0x1c..0x1f) => :ignore,
+        (0x20..0x7f) => :osc_put,
+        :on_exit => :osc_end,
+      },
+      :SOS_PM_APC_STRING => {
+        (0x00..0x17) => :ignore,
+        0x19 => :ignore,
+        (0x1c..0x1f) => :ignore,
+        (0x20..0x7f) => :ignore,
+      },
+    }
+
+    @anywhere_transitions = {
+      0x18 => [:execute, :GROUND],
+      0x1a => [:execute, :GROUND],
+      (0x80..0x8f) => [:execute, :GROUND],
+      (0x91..0x97) => [:execute, :GROUND],
+      0x99 => [:execute, :GROUND],
+      0x9a => [:execute, :GROUND],
+      0x9c => :GROUND,
+      0x1b => :ESCAPE,
+      0x98 => :SOS_PM_APC_STRING,
+      0x9e => :SOS_PM_APC_STRING,
+      0x9f => :SOS_PM_APC_STRING,
+      0x90 => :DCS_ENTRY,
+      0x9d => :OSC_STRING,
+      0x9b => :CSI_ENTRY,
+    }
+  end
+
+  def build_state_transitions
+    @state_transitions = {}
+    @states.each do |state, transitions|
+      expanded_transitions = expand_transitions(transitions)
+      anywhere_transitions = expand_transitions(@anywhere_transitions)
+      merged_transitions = anywhere_transitions.merge(expanded_transitions) { |_, _, newval| newval }
+      on_entry = merged_transitions.delete(:on_entry)
+      on_exit = merged_transitions.delete(:on_exit)
+      @state_transitions[state] = {
+        transitions: merged_transitions,
+        on_entry: on_entry,
+        on_exit: on_exit,
+      }
+    end
+  end
+
+  def expand_transitions(transitions)
+    expanded = {}
+    transitions.each do |key, value|
+      if key.is_a?(Range)
+        key.each do |k|
+          expanded[k] = value
+        end
+      else
+        expanded[key] = value
+      end
+    end
+    expanded
+  end
+
+  def do_state_change(ch)
+
+    state_info = @state_transitions[@state]
+    transitions = state_info[:transitions]
+    action_state = transitions[ch.ord]
+
+    action, new_state = nil, nil
+    
+    if action_state
+      if action_state.is_a?(Array)
+        action = action_state[0]
+        new_state = action_state[1]
+      else
+        if @states.key?(action_state)
+          new_state = action_state
+        else
+          action = action_state
+        end
+      end
+    else
+      action = :ignore
+    end
+    # pp "before_state: #{@state} action_state: #{action_state} - ch: #{ch} ch0x: #{ch.ord.to_s(16)} - action: #{action} - new_state: #{new_state}"
+    # pp "action_state: #{action_state} - ch: #{ch}"
+    
+    if new_state
+      on_exit = state_info[:on_exit]
+      handle_action(on_exit, nil) if on_exit
+    end
+      
+    handle_action(action, ch) if action
+    
+    if new_state
+      @state = new_state
+      new_state_info = @state_transitions[@state]
+      on_entry = new_state_info[:on_entry]
+      handle_action(on_entry, nil) if on_entry
+    end
+  end
+
+  def handle_action(action, ch)
+    case action
+    when :execute, :print, :esc_dispatch, :csi_dispatch, :hook, :put, :unhook, :osc_start, :osc_put, :osc_end
+      @callback.call(action, ch, intermediate_chars, params) if @callback
+    when :ignore
+      # Do nothing
+      @callback.call(action, ch, intermediate_chars, params) if @callback 
+    when :collect
+      unless @ignore_flagged
+        @intermediate_chars << ch
+      end
+    when :param
+      if ch == ';'
+        @params << 0
+      else
+        if @params.empty?
+          @params << 0
+        end
+        @params[-1] = @params[-1] * 10 + (ch.ord - '0'.ord)
+      end
+    when :clear
+      @intermediate_chars = ''
+      @params = []
+      @ignore_flagged = false
+    else
+      @callback.call(:error, ch, intermediate_chars, params) if @callback
+    end
+  end
+
+  def self.to_ansi(action, ch, intermediate_chars, params)
+      
+    case action
+    when :print, :execute, :put, :osc_put, :ignore
+      # Output the character
+      return ch if ch
+    when :hook
+      return "\eP#{intermediate_chars}"
+    when :esc_dispatch
+      return "\e#{intermediate_chars}#{ch}"
+    when :csi_dispatch
+      # Output ESC [ followed by parameters, intermediates, and final character
+      return "\e[#{params.join(';')}#{intermediate_chars}#{ch}"
+    when :osc_start
+      return "\e]"
+    when :osc_end
+      return "\x07"  # BEL character to end OSC
+    when :unhook
+      return "" # \e must come from ESCAPE state
+    else
+      raise "Unknown action: #{action}"
+    end
+
+    raise
+  end
+
+end

data/lib/vtparser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vtparser
+  VERSION = "0.1.0"
+end

data/lib/vtparser.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "vtparser/version"
+require_relative "vtparser/parser"
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: vtparser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Oezbek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+description: A pure Ruby VT100 parser that can be used to parse ANSI escape sequences.
+email:
+- c.oezbek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bash_history"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- examples/indent_cli.rb
+- lib/vtparser.rb
+- lib/vtparser/parser.rb
+- lib/vtparser/version.rb
+homepage: https://github.com/coezbek/vtparser
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/coezbek/vtparser
+  source_code_uri: https://github.com/coezbek/vtparser
+  changelog_uri: https://github.com/coezbek/vtparser/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: Pure Ruby VT100 parser
+test_files: []