kaitai-struct-visualizer 0.7 → 0.11

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

@@ -1,263 +1,234 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 
 require 'kaitai/struct/visualizer/version'
 require 'kaitai/struct/visualizer/node'
 require 'kaitai/struct/visualizer/hex_viewer'
+require 'kaitai/struct/visualizer/ks_error_matcher'
 
 module Kaitai::Struct::Visualizer
-class Tree
-  def initialize(ui, st)
-    @ui = ui
-    @st = st
-    @root = Node.new(self, st, 0)
-    @root.id = '[root]'
+  class Tree
+    def initialize(ui, st)
+      @ui = ui
+      @st = st
+      @root = Node.new(self, st, 0)
+      @root.id = '[root]'
 
-    @cur_io = nil
-    @hv = HexViewer.new(ui, nil, self)
-    @hv_hidden = false
+      @cur_io = nil
+      @hv = HexViewer.new(ui, nil, self)
+      @hv_hidden = false
 
-    recalc_sizes
+      recalc_sizes
 
-    @cur_line = 0
-    @cur_shift = 0
-    @do_exit = false
+      @cur_line = 0
+      @cur_shift = 0
+      @do_exit = false
 
-    @ui.on_resize = proc {
-      recalc_sizes
-      redraw
-      @hv.redraw
-    }
-  end
+      @ui.on_resize = proc { |redraw_needed|
+        recalc_sizes
+        redraw      if redraw_needed
+        @hv.redraw  if redraw_needed
+      }
+    end
 
-  def recalc_sizes
-    @max_scr_ln = @ui.rows - 3
-    @hv.shift_x = @ui.cols - HexViewer.line_width - 1
-  end
+    def recalc_sizes
+      @max_scr_ln = @ui.rows - 3
+      @hv.shift_x = @ui.cols - HexViewer.line_width - 1
+    end
 
-  def run
-    c = nil
-    loop {
-      t = redraw
+    def run
+      loop do
+        t = redraw
 
-      if @cur_node.nil? and not @cur_line.nil?
-        # gone beyond the end of the tree
-        @cur_line = @root.height - 1
-        clamp_cursor
-        redraw
-      end
+        if @cur_node.nil? && !@cur_line.nil?
+          # gone beyond the end of the tree
+          @cur_line = @root.height - 1
+          clamp_cursor
+          redraw
+        end
 
-      raise '@cur_line is undetermined' if @cur_line.nil?
-      raise '@cur_node is undetermined' if @cur_node.nil?
+        raise '@cur_line is undetermined' if @cur_line.nil?
+        raise '@cur_node is undetermined' if @cur_node.nil?
 
-      thv = Benchmark.realtime {
-        unless @hv_hidden
-          hv_update_io
+        thv = Benchmark.realtime do
+          unless @hv_hidden
+            hv_update_io
 
-          unless @cur_node.pos1.nil?
-            if (@hv.addr < @cur_node.pos1) or (@hv.addr >= @cur_node.pos2)
+            if !@cur_node.pos1.nil? && ((@hv.addr < @cur_node.pos1) || (@hv.addr >= @cur_node.pos2))
               @hv.addr = @cur_node.pos1
               @hv.ensure_visible
             end
-          end
 
-          @hv.redraw
-          regs = highlight_regions(4)
-          @hv.highlight(regs)
+            @hv.redraw
+            regs = highlight_regions(4)
+            @hv.highlight(regs)
+          end
         end
-      }
 
-      @ui.goto(0, @max_scr_ln + 1)
-      printf "all: %d, tree: %d, tree_draw: %d, hexview: %d, ln: %d, ", (t + thv) * 1e6, t * 1e6, @draw_time * 1e6, thv * 1e6, @ln
-      puts "highlight = #{@cur_node.pos1}..#{@cur_node.pos2}"
-      #puts "keypress: #{c.inspect}"
-
-      begin
-        process_keypress
-      rescue EOFError => e
-        @ui.message_box_exception(e)
-      rescue Kaitai::Struct::Stream::UnexpectedDataError => e
-        @ui.message_box_exception(e)
-      end
+        @ui.goto(0, @max_scr_ln + 1)
+        printf 'all: %d, tree: %d, tree_draw: %d, hexview: %d, ln: %d, ', (t + thv) * 1e6, t * 1e6, @draw_time * 1e6, thv * 1e6, @ln
+        puts "highlight = #{@cur_node.pos1}..#{@cur_node.pos2}"
+        # puts "keypress: #{c.inspect}"
 
-      return if @do_exit
+        begin
+          process_keypress
+        rescue Kaitai::Struct::Visualizer::KSErrorMatcher => e
+          @ui.message_box_exception(e)
+        end
 
-      clamp_cursor
-    }
-  end
+        return if @do_exit
 
-  def process_keypress
-    c = @ui.read_char_mapped
-    case c
-    when :up_arrow
-      @cur_line -= 1
-      @cur_node = nil
-    when :down_arrow
-      @cur_line += 1
-      @cur_node = nil
-    when :left_arrow
-      if @cur_node.open?
-        @cur_node.close
-      else
-        par = @cur_node.parent
-        if par
-          @cur_line = nil
-          @cur_node = par
-        end
+        clamp_cursor
       end
-    when :right_arrow
-      if @cur_node.openable?
+    end
+
+    def process_keypress
+      c = @ui.read_char_mapped
+      case c
+      when :up_arrow
+        @cur_line -= 1
+        @cur_node = nil
+      when :down_arrow
+        @cur_line += 1
+        @cur_node = nil
+      when :left_arrow
         if @cur_node.open?
-          @cur_line += 1
-          @cur_node = nil
+          @cur_node.close
         else
-          @cur_node.open
+          par = @cur_node.parent
+          if par
+            @cur_line = nil
+            @cur_node = par
+          end
         end
-      end
-    when :home
-      @cur_line = @cur_shift = 0
-      @cur_node = nil
-    when :end
-      @cur_line = @root.height - 1
-      @cur_node = nil
-    when :pg_up
-      @cur_line -= 20
-      @cur_node = nil
-    when :pg_dn
-      @cur_line += 20
-      @cur_node = nil
-    when :enter
-      if @cur_node.hex?
-        @ui.clear
-        hv = HexViewer.new(@ui, @cur_node.value)
-        hv.redraw
-        hv.run
+      when :right_arrow
+        if @cur_node.openable?
+          if @cur_node.open?
+            @cur_line += 1
+            @cur_node = nil
+          else
+            @cur_node.open
+          end
+        end
+      when :home
+        @cur_line = @cur_shift = 0
+        @cur_node = nil
+      when :end
+        @cur_line = @root.height - 1
+        @cur_node = nil
+      when :pg_up
+        @cur_line -= 20
+        @cur_node = nil
+      when :pg_dn
+        @cur_line += 20
+        @cur_node = nil
+      when :enter
+        if @cur_node.hex?
+          @ui.clear
+          hv = HexViewer.new(@ui, @cur_node.value)
+          hv.redraw
+          hv.run
+          @ui.clear
+          redraw
+        else
+          @cur_node.toggle
+        end
+      when :tab
+        @hv.run
+      when 'H'
+        @hv_hidden = !@hv_hidden
         @ui.clear
         redraw
-      else
-        @cur_node.toggle
+      when 'q'
+        @do_exit = true
       end
-    when :tab
-      @hv.run
-    when 'H'
-      @hv_hidden = !@hv_hidden
-      @ui.clear
-      redraw
-    when 'q'
-      @do_exit = true
     end
-  end
 
-  def clamp_cursor
-    if @cur_line
-      @cur_line = 0 if @cur_line < 0
+    def clamp_cursor
+      return unless @cur_line
 
-      if @cur_line - @cur_shift < 0
-        @cur_shift = @cur_line
-      end
-      if @cur_line - @cur_shift > @max_scr_ln
-        @cur_shift = @cur_line - @max_scr_ln
+      @cur_line = 0 if @cur_line.negative?
+
+      @cur_shift = @cur_line if (@cur_line - @cur_shift).negative?
+      @cur_shift = @cur_line - @max_scr_ln if (@cur_line - @cur_shift) > @max_scr_ln
+    end
+
+    def redraw
+      @draw_time = 0
+      Benchmark.realtime do
+        @ui.clear
+        @ln = 0
+        draw_rec(@root)
       end
     end
-  end
 
-  def redraw
-    @draw_time = 0
-    Benchmark.realtime {
-      @ui.clear
-      @ln = 0
-      draw_rec(@root)
-    }
-  end
+    def draw_rec(n)
+      scr_ln = @ln - @cur_shift
+      return if @cur_node && (scr_ln > @max_scr_ln)
+
+      if @ln == @cur_line
+        # Seeking cur_node by cur_line
+        @cur_node = n
+        @ui.bg_color = :white
+        @ui.fg_color = :black
+      elsif @cur_node == n
+        # Seeking cur_line by cur_node
+        @cur_line = @ln
+        @ui.bg_color = :white
+        @ui.fg_color = :black
+      end
 
-  def draw_rec(n)
-    scr_ln = @ln - @cur_shift
-    return if @cur_node and scr_ln > @max_scr_ln
-
-    if @ln == @cur_line
-      # Seeking cur_node by cur_line
-      @cur_node = n
-      @ui.bg_color = :gray
-      @ui.fg_color = :black
-    elsif @cur_node == n
-      # Seeking cur_line by cur_node
-      @cur_line = @ln
-      @ui.bg_color = :gray
-      @ui.fg_color = :black
-    end
+      @draw_time += Benchmark.realtime do
+        # n.draw(@ui) if scr_ln >= 0
+        n.draw(@ui) if (scr_ln >= 0) && (scr_ln <= @max_scr_ln)
+      end
 
-    @draw_time += Benchmark.realtime {
-#      n.draw(@ui) if scr_ln >= 0
-      n.draw(@ui) if scr_ln >= 0 and scr_ln <= @max_scr_ln
-    }
+      @ui.reset_colors if @ln == @cur_line
+      @ln += 1
 
-    @ui.reset_colors if @ln == @cur_line
-    @ln += 1
-    if n.open?
-      n.children.each { |ch|
+      return unless n.open?
+
+      n.children.each do |ch|
         draw_rec(ch)
         break if scr_ln > @max_scr_ln
-      }
+      end
     end
-  end
 
-  def do_exit
-    @do_exit = true
-  end
+    def do_exit
+      @do_exit = true
+    end
+
+    def hv_update_io
+      io = @cur_node.io
+      return unless io != @cur_io
 
-  def hv_update_io
-    io = @cur_node.io
-    if io != @cur_io
       @cur_io = io
       io.seek(0)
       buf = io.read_bytes_full
       @hv.buf = buf
 
-#      @hv.redraw
+      # @hv.redraw
     end
-  end
 
-  def highlight_regions(max_levels)
-    node = @cur_node
-    r = []
-    max_levels.times { |i|
-      return r if node.nil?
-      r << [node.pos1, node.pos2]
-      node = node.parent
-    }
-    r
-  end
+    def highlight_regions(max_levels)
+      node = @cur_node
+      r = []
+      max_levels.times do |_i|
+        return r if node.nil?
 
-  def tree_width
-    if @hv_hidden
-      @ui.cols
-    else
-      @hv.shift_x
+        r << [node.pos1, node.pos2]
+        node = node.parent
+      end
+      r
     end
-  end
 
-  def self.explore_object(obj, level)
-    root = Node.new(obj, level)
-    if obj.is_a?(Fixnum) or obj.is_a?(String)
-      # do nothing else
-    elsif obj.is_a?(Array)
-      root = Node.new(obj, level)
-      obj.each_with_index { |el, i|
-        n = explore_object(el, level + 1)
-        n.id = i
-        root.add(n)
-      }
-    else
-      root = Node.new(obj, level)
-      obj.instance_variables.each { |k|
-        k = k.to_s
-        next if k =~ /^@_/
-        el = obj.instance_eval(k)
-        n = explore_object(el, level + 1)
-        n.id = k
-        root.add(n)
-      }
+    def tree_width
+      if @hv_hidden
+        @ui.cols
+      else
+        @hv.shift_x
+      end
     end
-    root
   end
 end
-end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Kaitai
   module Struct
     module Visualizer
-      VERSION = '0.7'
+      VERSION = '0.11'
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'kaitai/struct/visualizer/version'
 require 'kaitai/tui'
 require 'kaitai/struct/visualizer/parser'
@@ -8,17 +10,17 @@ require 'zlib'
 require 'stringio'
 
 module Kaitai::Struct::Visualizer
-class Visualizer < Parser
-  def run
-    load_exc = load
+  class Visualizer < Parser
+    def run
+      load_exc = load
 
-    @ui = Kaitai::TUI.new
-    @tree = Tree.new(@ui, @data)
+      @ui = Kaitai::TUI.new
+      @tree = Tree.new(@ui, @data)
 
-    @tree.redraw
-    @ui.message_box_exception(load_exc) if load_exc
+      @tree.redraw
+      @ui.message_box_exception(load_exc) if load_exc
 
-    @tree.run
+      @tree.run
+    end
   end
 end
-end

data/lib/kaitai/struct/visualizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'kaitai/struct/visualizer/version'
 require 'kaitai/struct/visualizer/visualizer'
 require 'kaitai/struct/visualizer/ksy_compiler'

data/lib/kaitai/tui.rb

@@ -1,113 +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::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,
-      ]
+  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
-  end
 
-  def on_resize=(handler)
-    @console.on_resize = handler
-  end
+    def on_resize=(handler)
+      @console.on_resize = handler
+    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