kaitai-struct-visualizer 0.5 → 0.11

data/lib/kaitai/tui.rb

@@ -1,109 +1,100 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Kaitai
+  class TUI
+    extend Forwardable
+    def_delegators :@console, :rows, :cols, :goto, :clear, :fg_color=, :bg_color=, :reset_colors, :read_char_mapped
+
+    attr_reader :highlight_colors
+
+    def initialize
+      if TUI.windows?
+        require 'kaitai/console_windows'
+        @console = ConsoleWindows.new
+        @highlight_colors = %i[bright_white bright_cyan cyan gray]
+      else
+        require 'kaitai/console_ansi'
+        @console = ConsoleANSI.new
+        @highlight_colors = %i[bright_white bright_cyan cyan gray]
+      end
+    end
 
-class TUI
-  extend Forwardable
-  def_delegators :@console, :rows, :cols, :goto, :clear, :fg_color=, :bg_color=, :reset_colors, :read_char_mapped
-
-  attr_reader :highlight_colors
-
-  def initialize
-    if TUI::is_windows?
-      require 'kaitai/console_windows'
-      @console = ConsoleWindows.new
-      @highlight_colors = [
-        :white,
-        :aqua,
-        :blue,
-        :green,
-        :white,
-      ]
-    else
-      require 'kaitai/console_ansi'
-      @console = ConsoleANSI.new
-      @highlight_colors = [
-        :gray14,
-        :gray11,
-        :gray8,
-        :gray5,
-        :gray2,
-      ]
+    def on_resize=(handler)
+      @console.on_resize = handler
     end
-  end
 
-  def message_box_exception(e)
-    message_box("Error while parsing", e.message)
-  end
+    def message_box_exception(e)
+      message_box('Error while parsing', e.message)
+    end
 
-  SINGLE_CHARSET = '┌┐└┘─│'
-  HEAVY_CHARSET  = '┏┓┗┛━┃'
-  DOUBLE_CHARSET = '╔╗╚╝═║'
-
-  CHAR_TL = 0
-  CHAR_TR = 1
-  CHAR_BL = 2
-  CHAR_BR = 3
-  CHAR_H  = 4
-  CHAR_V  = 5
-
-  def message_box(header, msg)
-    top_y = @console.rows / 2 - 5
-    draw_rectangle(10, top_y, @console.cols - 20, 10)
-    @console.goto(@console.cols / 2 - (header.length / 2) - 1, top_y)
-    print ' ', header, ' '
-    @console.goto(11, top_y + 1)
-    puts msg
-    draw_button(@console.cols / 2 - 10, top_y + 8, 10, 'OK')
-    loop {
-      c = @console.read_char_mapped
-      return if c == :enter
-    }
-  end
+    SINGLE_CHARSET = '┌┐└┘─│'
+    HEAVY_CHARSET  = '┏┓┗┛━┃'
+    DOUBLE_CHARSET = '╔╗╚╝═║'
+
+    CHAR_TL = 0
+    CHAR_TR = 1
+    CHAR_BL = 2
+    CHAR_BR = 3
+    CHAR_H  = 4
+    CHAR_V  = 5
+
+    def message_box(header, msg)
+      top_y = @console.rows / 2 - 5
+      draw_rectangle(10, top_y, @console.cols - 20, 10)
+      @console.goto(@console.cols / 2 - (header.length / 2) - 1, top_y)
+      print ' ', header, ' '
+      @console.goto(11, top_y + 1)
+      puts msg
+      draw_button(@console.cols / 2 - 10, top_y + 8, 10, 'OK')
+      loop do
+        c = @console.read_char_mapped
+        return if c == :enter
+      end
+    end
 
-  def input_str(header, msg)
-    top_y = @console.rows / 2 - 5
-    draw_rectangle(10, top_y, @console.cols - 20, 10)
-    goto(@console.cols / 2 - (header.length / 2) - 1, top_y)
-    print ' ', header, ' '
+    def input_str(header, _msg)
+      top_y = @console.rows / 2 - 5
+      draw_rectangle(10, top_y, @console.cols - 20, 10)
+      goto(@console.cols / 2 - (header.length / 2) - 1, top_y)
+      print ' ', header, ' '
 
-    goto(11, top_y + 1)
-    Readline.readline('', false)
-  end
+      goto(11, top_y + 1)
+      Readline.readline('', false)
+    end
 
-  def draw_rectangle(x, y, w, h, charset = DOUBLE_CHARSET)
-    goto(x, y)
-    print charset[CHAR_TL]
-    print charset[CHAR_H] * (w - 2)
-    print charset[CHAR_TR]
-
-    ((y + 1)..(y + h - 1)).each { |i|
-      goto(x, i)
-      print charset[CHAR_V]
-      print ' ' * (w - 2)
-      print charset[CHAR_V]
-    }
-
-    goto(x, y + h)
-    print charset[CHAR_BL]
-    print charset[CHAR_H] * (w - 2)
-    print charset[CHAR_BR]
-  end
+    def draw_rectangle(x, y, w, h, charset = DOUBLE_CHARSET)
+      goto(x, y)
+      print charset[CHAR_TL]
+      print charset[CHAR_H] * (w - 2)
+      print charset[CHAR_TR]
+
+      ((y + 1)..(y + h - 1)).each do |i|
+        goto(x, i)
+        print charset[CHAR_V]
+        print ' ' * (w - 2)
+        print charset[CHAR_V]
+      end
+
+      goto(x, y + h)
+      print charset[CHAR_BL]
+      print charset[CHAR_H] * (w - 2)
+      print charset[CHAR_BR]
+    end
 
-  def draw_button(x, y, w, caption)
-    goto(x, y)
-    puts "[ #{caption} ]"
-  end
+    def draw_button(x, y, _w, caption)
+      goto(x, y)
+      puts "[ #{caption} ]"
+    end
 
-  # Regexp borrowed from
-  # http://stackoverflow.com/questions/170956/how-can-i-find-which-operating-system-my-ruby-program-is-running-on
-  @@is_windows = (RUBY_PLATFORM =~ /cygwin|mswin|mingw|bccwin|wince|emx/) ? true : false
+    # Regexp borrowed from
+    # http://stackoverflow.com/questions/170956/how-can-i-find-which-operating-system-my-ruby-program-is-running-on
+    @@is_windows = (RUBY_PLATFORM =~ /cygwin|mswin|mingw|bccwin|wince|emx/) ? true : false
 
-  # Detects if current platform is Windows-based.
-  def self.is_windows?
-    @@is_windows
+    # Detects whether the current platform is Windows-based.
+    def self.windows?
+      @@is_windows
+    end
   end
 end
-
-end

metadata

@@ -1,57 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: kaitai-struct-visualizer
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.11'
 platform: ruby
 authors:
 - Mikhail Yakshin
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2025-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: 9.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 9.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
-  type: :development
+        version: '3.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: kaitai-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
 description: |
   Kaitai Struct is a declarative language used for describe various binary data structures, laid out in files or in memory: i.e. binary file formats, network stream packet formats, etc.
 
@@ -60,30 +85,36 @@ description: |
   This package is a visualizer tool for .ksy files. Given a particular binary file and .ksy file(s) that describe its format, it can visualize internal data structures in a tree form and a multi-level highlight hex viewer.
 email: greycat@kaitai.io
 executables:
+- ksdump
 - ksv
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/ksdump
 - bin/ksv
-- kaitai-struct-visualizer.gemspec
 - lib/kaitai/console_ansi.rb
 - lib/kaitai/console_windows.rb
 - lib/kaitai/struct/visualizer.rb
 - lib/kaitai/struct/visualizer/hex_viewer.rb
+- lib/kaitai/struct/visualizer/ks_error_matcher.rb
+- lib/kaitai/struct/visualizer/ksy_compiler.rb
 - lib/kaitai/struct/visualizer/node.rb
+- lib/kaitai/struct/visualizer/obj_to_h.rb
+- lib/kaitai/struct/visualizer/parser.rb
 - lib/kaitai/struct/visualizer/tree.rb
 - lib/kaitai/struct/visualizer/version.rb
 - lib/kaitai/struct/visualizer/visualizer.rb
-- lib/kaitai/struct/visualizer/visualizer_main.rb
-- lib/kaitai/struct/visualizer/visualizer_ruby.rb
 - lib/kaitai/tui.rb
-homepage: http://kaitai.io
+homepage: https://kaitai.io/
 licenses:
-- GPL-3.0+
-metadata: {}
-post_install_message: 
+- GPL-3.0-or-later
+metadata:
+  bug_tracker_uri: https://github.com/kaitai-io/kaitai_struct_visualizer/issues
+  homepage_uri: https://kaitai.io/
+  source_code_uri: https://github.com/kaitai-io/kaitai_struct_visualizer
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -91,16 +122,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+requirements:
+- kaitai-struct-compiler (https://kaitai.io/#download), the version must match the
+  kaitai-struct gem (check using `ksv --version`)
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Advanced hex viewer and binary structure exploration tool (visualizer) using
   Kaitai Struct ksy files

data/kaitai-struct-visualizer.gemspec

@@ -1,37 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require File.expand_path("../lib/kaitai/struct/visualizer/version", __FILE__)
-require 'date'
-
-Gem::Specification.new { |s|
-  s.name = 'kaitai-struct-visualizer'
-  s.version = Kaitai::Struct::Visualizer::VERSION
-  s.date = Date.today.to_s
-
-  s.authors = ['Mikhail Yakshin']
-  s.email = 'greycat@kaitai.io'
-
-  s.homepage = 'http://kaitai.io'
-  s.summary = 'Advanced hex viewer and binary structure exploration tool (visualizer) using Kaitai Struct ksy files'
-  s.license = 'GPL-3.0+'
-  s.description = <<-EOF
-Kaitai Struct is a declarative language used for describe various binary data structures, laid out in files or in memory: i.e. binary file formats, network stream packet formats, etc.
-
-The main idea is that a particular format is described in Kaitai Struct language (.ksy file) and then can be compiled with ksc into source files in one of the supported programming languages. These modules will include a generated code for a parser that can read described data structure from a file / stream and give access to it in a nice, easy-to-comprehend API.
-
-This package is a visualizer tool for .ksy files. Given a particular binary file and .ksy file(s) that describe its format, it can visualize internal data structures in a tree form and a multi-level highlight hex viewer.
-EOF
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ['lib']
-
-  s.files = `git ls-files`.split("\n")
-  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
-
-  s.add_development_dependency "bundler", "~> 1.3"
-  s.add_development_dependency 'rake', '~> 10'
-#  s.add_development_dependency 'rspec', '~> 3'
-
-  s.add_dependency 'kaitai-struct', "~> 0.4"
-}

data/lib/kaitai/struct/visualizer/visualizer_main.rb

@@ -1,42 +0,0 @@
-require 'kaitai/struct/visualizer/version'
-require 'kaitai/struct/visualizer/visualizer'
-require 'kaitai/tui'
-
-module Kaitai::Struct::Visualizer
-
-class ExternalCompilerVisualizer < Visualizer
-  def compile_format(fn)
-    main_class_name = nil
-    Dir.mktmpdir { |code_dir|
-      args = ['--debug', '-t', 'ruby', fn, '-d', code_dir]
-
-      # UNIX-based systems run ksc via a shell wrapper that requires
-      # extra '--' in invocation to disambiguate our '-d' from java runner
-      # '-d' (which allows to pass defines to JVM). Windows-based systems
-      # do not need and do not support this extra '--', so we don't add it
-      # on Windows.
-      args.unshift('--') unless Kaitai::TUI::is_windows?
-
-      system('kaitai-struct-compiler', *args)
-      if $?.exitstatus != 0
-        st = $?.exitstatus
-        $stderr.puts("ksv: unable to find and execute kaitai-struct-compiler in your PATH") if st == 127
-        exit st
-      end
-
-      puts "Compilation OK"
-
-      compiled_path = Dir.glob("#{code_dir}/*.rb")[0]
-
-      require compiled_path
-
-      puts "Class loaded OK"
-
-      main_class_name = File.readlines(compiled_path).grep(/^class /)[0].strip.gsub(/^class /, '').gsub(/ <.*$/, '')
-    }
-
-    return main_class_name
-  end
-end
-
-end

data/lib/kaitai/struct/visualizer/visualizer_ruby.rb

@@ -1,18 +0,0 @@
-require 'ks_ruby_compiler'
-
-class RubyCompilerVisualizer extends Visualizer
-  def compile
-    Dir.mktmpdir { |code_dir|
-      compiled_path = "#{code_dir}/compiled.rb"
-      @compiler = CompileToRuby.new(@format_fn, compiled_path)
-      @compiler.compile
-
-      require compiled_path
-
-      main_class_name = @compiler.type2class(@compiler.desc['meta']['id'])
-      #puts "Main class: #{main_class_name}"
-      main_class = Kernel::const_get(main_class_name)
-      @data = main_class.from_file(@bin_fn)
-    }
-  end
-end