kaitai-struct-visualizer 0.5 → 0.11

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

@@ -1,293 +1,302 @@
+# frozen_string_literal: true
+
 require 'kaitai/struct/visualizer/version'
 
 module Kaitai::Struct::Visualizer
-class HexViewer
-  def initialize(ui, buf, shift_x = 0, tree = nil)
-    @ui = ui
-    @buf = buf
-    @shift_x = shift_x
-    @tree = tree
-
-    @embedded = not(tree.nil?)
-    @max_scr_ln = @ui.rows - 3
-
-    @addr = 0
-    @scroll_y = 0
-    reset_cur
-    raise if @cur_x.nil?
-  end
+  class HexViewer
+    attr_accessor :shift_x
 
-  def buf=(buf)
-    @buf = buf
-  end
+    def initialize(ui, buf, tree = nil)
+      @ui = ui
+      @buf = buf
+      @shift_x = 0
+      @tree = tree
 
-  def addr; @addr; end
-  def addr=(a)
-    @addr = a
-    reset_cur
-  end
+      @embedded = !tree.nil?
+      @max_scr_ln = @ui.rows - 3
 
-  def reset_cur
-    @cur_y = addr_to_row(@addr)
-    @cur_x = addr_to_col(@addr)
-  end
+      @addr = 0
+      @scroll_y = 0
+      reset_cur
+      raise if @cur_x.nil?
+    end
 
-  def highlight(regions)
-    highlight_hide
-    @hl_regions = regions
-    highlight_show
-  end
+    attr_writer :buf
 
-  def ensure_visible
-    scr_y = row_to_scr(@cur_y)
-    if scr_y < 0
-      @scroll_y = @cur_y
-      redraw
-      highlight_show
-    elsif scr_y > @max_scr_ln
-      @scroll_y = @cur_y - @max_scr_ln
-      redraw
+    attr_reader :addr
+
+    def addr=(a)
+      @addr = a
+      reset_cur
+    end
+
+    def reset_cur
+      @cur_y = addr_to_row(@addr)
+      @cur_x = addr_to_col(@addr)
+    end
+
+    def highlight(regions)
+      highlight_hide
+      @hl_regions = regions
       highlight_show
     end
-  end
 
-  def run
-    c = nil
-    loop {
-      @ui.goto(0, @max_scr_ln + 1)
-      printf "%08x (%d, %d)", @addr, @cur_x, @cur_y
-
-      @ui.goto(col_to_col_char(@cur_x), row_to_scr(@cur_y))
-      c = @ui.read_char_mapped
-      case c
-      when :tab
-        return if @embedded
-      when :left_arrow
-        if @addr > 0
-          @addr -= 1
-          @cur_x -= 1
-          if @cur_x < 0
-            @cur_y -= 1
-            @cur_x = PER_LINE - 1
+    def ensure_visible
+      scr_y = row_to_scr(@cur_y)
+      if scr_y.negative?
+        @scroll_y = @cur_y
+        redraw
+        highlight_show
+      elsif scr_y > @max_scr_ln
+        @scroll_y = @cur_y - @max_scr_ln
+        redraw
+        highlight_show
+      end
+    end
+
+    def run
+      c = nil
+      loop do
+        @ui.goto(0, @max_scr_ln + 1)
+        printf '%08x (%d, %d)', @addr, @cur_x, @cur_y
+
+        @ui.goto(col_to_col_char(@cur_x), row_to_scr(@cur_y))
+        c = @ui.read_char_mapped
+        case c
+        when :tab
+          return if @embedded
+        when :left_arrow
+          if @addr.positive?
+            @addr -= 1
+            @cur_x -= 1
+            if @cur_x.negative?
+              @cur_y -= 1
+              @cur_x = PER_LINE - 1
+            end
           end
-        end
-      when :right_arrow
-        if @addr < @buf.size
-          @addr += 1
-          @cur_x += 1
-          if @cur_x >= PER_LINE
-            @cur_y += 1
+        when :right_arrow
+          if @addr < @buf.size
+            @addr += 1
+            @cur_x += 1
+            if @cur_x >= PER_LINE
+              @cur_y += 1
+              @cur_x = 0
+            end
+          end
+        when :up_arrow
+          @addr -= PER_LINE
+          @cur_y -= 1
+          clamp_cursor
+        when :down_arrow
+          @addr += PER_LINE
+          @cur_y += 1
+          clamp_cursor
+        when :pg_dn
+          @addr += PER_LINE * PAGE_ROWS
+          @cur_y += PAGE_ROWS
+          clamp_cursor
+        when :pg_up
+          @addr -= PER_LINE * PAGE_ROWS
+          @cur_y -= PAGE_ROWS
+          clamp_cursor
+        when :home
+          if @cur_x.zero?
+            @addr = 0
+            @cur_y = 0
+          else
+            @addr -= @cur_x
             @cur_x = 0
           end
+          clamp_cursor
+        when :end
+          if @cur_x == PER_LINE - 1
+            @addr = @buf.size - 1
+            reset_cur
+          else
+            @addr = @addr - @cur_x + PER_LINE - 1
+            @cur_x = PER_LINE - 1
+          end
+          clamp_cursor
+        when 'w'
+          fn = @ui.input_str('Write buffer to file', 'Filename')
+          File.open(fn, 'w') do |out|
+            out.write(@buf)
+          end
+          @ui.clear
+          redraw
+        when 'q'
+          @tree&.do_exit
+          return
         end
-      when :up_arrow
-        @addr -= PER_LINE
-        @cur_y -= 1
-        clamp_cursor
-      when :down_arrow
-        @addr += PER_LINE
-        @cur_y += 1
-        clamp_cursor
-      when :pg_dn
-        @addr += PER_LINE * PAGE_ROWS
-        @cur_y += PAGE_ROWS
-        clamp_cursor
-      when :pg_up
-        @addr -= PER_LINE * PAGE_ROWS
-        @cur_y -= PAGE_ROWS
-        clamp_cursor
-      when :home
-        if @cur_x == 0
-          @addr = 0
-          @cur_y = 0
-        else
-          @addr -= @cur_x
-          @cur_x = 0
-        end
-        clamp_cursor
-      when :end
-        if @cur_x == PER_LINE - 1
-          @addr = @buf.size - 1
-          reset_cur
-        else
-          @addr = @addr - @cur_x + PER_LINE - 1
-          @cur_x = PER_LINE - 1
-        end
-        clamp_cursor
-      when 'w'
-        fn = @ui.input_str('Write buffer to file', 'Filename')
-        File.open(fn, 'w') { |out|
-          out.write(@buf)
-        }
-        @ui.clear
-        redraw
-      when 'q'
-        @tree.do_exit if @tree
-        return
-      end
 
-      ensure_visible
-    }
-  end
+        ensure_visible
+      end
+    end
 
-  def clamp_cursor
-    if @addr < 0
-      @addr = 0
-      @cur_x = 0
-      @cur_y = 0
-    elsif @addr >= @buf.size
-      @addr = @buf.size - 1
-      reset_cur
+    def clamp_cursor
+      if @addr.negative?
+        @addr = 0
+        @cur_x = 0
+        @cur_y = 0
+      elsif @addr >= @buf.size
+        @addr = @buf.size - 1
+        reset_cur
+      end
     end
-  end
 
-  PER_LINE = 16
-  PER_GROUP = 4
-  PAGE_ROWS = 20
-  FMT = "%08x: %-#{PER_LINE * 3}s| %-#{PER_LINE}s\n"
+    PER_LINE = 16
+    PER_GROUP = 4
+    PAGE_ROWS = 20
+    FMT = "%08x: %-#{PER_LINE * 3}s| %-#{PER_LINE}s\n"
 
-  def self.line_width
-    #8 + 2 + 3 * PER_LINE + 2 + PER_LINE
-    12 + 4 * PER_LINE
-  end
+    def self.line_width
+      # 8 + 2 + 3 * PER_LINE + 2 + PER_LINE
+      12 + 4 * PER_LINE
+    end
 
-  def col_to_col_hex(c)
-    #8 + 2 + 3 * c
-    @shift_x + 10 + 3 * c
-  end
+    def col_to_col_hex(c)
+      # 8 + 2 + 3 * c
+      @shift_x + 10 + 3 * c
+    end
 
-  def col_to_col_char(c)
-    #8 + 2 + 3 * PER_LINE + 2
-    @shift_x + 12 + 3 * PER_LINE + c
-  end
+    def col_to_col_char(c)
+      # 8 + 2 + 3 * PER_LINE + 2
+      @shift_x + 12 + 3 * PER_LINE + c
+    end
 
-  def row_to_scr(r)
-    r - @scroll_y
-  end
+    def row_to_scr(r)
+      r - @scroll_y
+    end
 
-  def redraw
-    i = row_col_to_addr(@scroll_y, 0)
-    row = 0
+    def redraw
+      i = row_col_to_addr(@scroll_y, 0)
+      row = 0
 
-    while row <= @max_scr_ln do
-      line = @buf[i, PER_LINE]
-      return unless line
+      while row <= @max_scr_ln
+        line = @buf[i, PER_LINE]
+        return unless line
 
-      @ui.goto(@shift_x, row)
+        @ui.goto(@shift_x, row)
 
-      hex = line.bytes.map { |x| sprintf('%02x', x) }.join(' ')
-      char = line.bytes.map { |x| byte_to_display_char(x) }.join
+        hex = line.bytes.map { |x| format('%02x', x) }.join(' ')
+        char = line.bytes.map { |x| byte_to_display_char(x) }.join
 
-      printf FMT, i, hex, char
-      i += PER_LINE
-      row += 1
+        printf FMT, i, hex, char
+        i += PER_LINE
+        row += 1
+      end
     end
-  end
 
-  def each_highlight_region
-    return if @hl_regions.nil?
-    n = @hl_regions.size
-    (n - 1).downto(0).each { |i|
-      p1 = @hl_regions[i][0]
-      p2 = @hl_regions[i][1]
-      yield i, p1, p2 unless p1.nil?
-    }
-  end
+    def each_highlight_region
+      return if @hl_regions.nil?
 
-  def highlight_hide
-    each_highlight_region { |i, p1, p2|
-      highlight_draw(p1, p2)
-    }
-  end
+      n = @hl_regions.size
+      (n - 1).downto(0).each do |i|
+        p1 = @hl_regions[i][0]
+        p2 = @hl_regions[i][1]
+        yield i, p1, p2 unless p1.nil?
+      end
+    end
 
-  def highlight_show
-    each_highlight_region { |i, p1, p2|
-      @ui.bg_color = @ui.highlight_colors[i]
-      @ui.fg_color = :black
-      highlight_draw(p1, p2)
-    }
-    @ui.reset_colors
-  end
+    def highlight_hide
+      each_highlight_region do |_i, p1, p2|
+        highlight_draw(p1, p2)
+      end
+    end
 
-  def highlight_draw(p1, p2)
-    r = row_to_scr(addr_to_row(p1))
-    return if r > @max_scr_ln
-    if r < 0
-      c = 0
-      r = 0
-      i = row_col_to_addr(@scroll_y, 0)
-      return if i >= p2
-    else
-      c = addr_to_col(p1)
-      i = p1
+    def highlight_show
+      each_highlight_region do |i, p1, p2|
+        @ui.bg_color = @ui.highlight_colors[i]
+        @ui.fg_color = :black
+        highlight_draw(p1, p2)
+      end
+      @ui.reset_colors
     end
 
-    highlight_draw_hex(r, c, i, p2)
-    highlight_draw_char(r, c, i, p2)
-  end
+    def highlight_draw(p1, p2)
+      r = row_to_scr(addr_to_row(p1))
+      return if r > @max_scr_ln
 
-  def highlight_draw_hex(r, c, i, p2)
-    @ui.goto(col_to_col_hex(c), r)
-    while i < p2
-      v = byte_at(i)
-      return if v.nil?
-      printf('%02x ', v)
-      c += 1
-      if c >= PER_LINE
+      if r.negative?
         c = 0
-        r += 1
-        return if r > @max_scr_ln
-        @ui.goto(col_to_col_hex(c), r)
+        r = 0
+        i = row_col_to_addr(@scroll_y, 0)
+        return if i >= p2
+      else
+        c = addr_to_col(p1)
+        i = p1
       end
-      i += 1
+
+      highlight_draw_hex(r, c, i, p2)
+      highlight_draw_char(r, c, i, p2)
     end
-  end
 
-  def highlight_draw_char(r, c, i, p2)
-    @ui.goto(col_to_col_char(c), r)
+    def highlight_draw_hex(r, c, i, p2)
+      @ui.goto(col_to_col_hex(c), r)
+      while i < p2
+        v = byte_at(i)
+        return if v.nil?
 
-    while i < p2
-      v = byte_at(i)
-      return if v.nil?
-      print byte_to_display_char(v)
-      c += 1
-      if c >= PER_LINE
-        c = 0
-        r += 1
-        return if r > @max_scr_ln
-        @ui.goto(col_to_col_char(c), r)
+        printf('%02x ', v)
+        c += 1
+        if c >= PER_LINE
+          c = 0
+          r += 1
+          return if r > @max_scr_ln
+
+          @ui.goto(col_to_col_hex(c), r)
+        end
+        i += 1
       end
-      i += 1
     end
-  end
 
-  def byte_at(i)
-    v = @buf[i]
-    if v.nil?
-      nil
-    else
-      v.ord
+    def highlight_draw_char(r, c, i, p2)
+      @ui.goto(col_to_col_char(c), r)
+
+      while i < p2
+        v = byte_at(i)
+        return if v.nil?
+
+        print byte_to_display_char(v)
+        c += 1
+        if c >= PER_LINE
+          c = 0
+          r += 1
+          return if r > @max_scr_ln
+
+          @ui.goto(col_to_col_char(c), r)
+        end
+        i += 1
+      end
+    end
+
+    def byte_at(i)
+      v = @buf[i]
+      if v.nil?
+        nil
+      else
+        v.ord
+      end
     end
-  end
 
-  def byte_to_display_char(x)
-    if x < 0x20 or x >= 0x7f
-      '.'
-    else
-      x.chr
+    def byte_to_display_char(x)
+      if (x < 0x20) || (x >= 0x7f)
+        '.'
+      else
+        x.chr
+      end
     end
-  end
 
-  def addr_to_row(addr)
-    addr / PER_LINE
-  end
+    def addr_to_row(addr)
+      addr / PER_LINE
+    end
 
-  def addr_to_col(addr)
-    addr % PER_LINE
-  end
+    def addr_to_col(addr)
+      addr % PER_LINE
+    end
 
-  def row_col_to_addr(row, col)
-    row * PER_LINE + col
+    def row_col_to_addr(row, col)
+      row * PER_LINE + col
+    end
   end
 end
-end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'kaitai/struct/struct'
+
+module Kaitai::Struct::Visualizer
+  class KSErrorMatcher
+    def self.===(exc)
+      return true if exc.is_a?(EOFError)
+      return true if exc.is_a?(ArgumentError)
+      return true if exc.is_a?(NoMethodError)
+      return true if exc.is_a?(TypeError)
+
+      # Raised by the runtime library's seek() implementation for negative offsets, see
+      # https://github.com/kaitai-io/kaitai_struct_ruby_runtime/blob/0fa62e64949f68cb001b58b7b45e15580d154ac9/lib/kaitai/struct/struct.rb#L637
+      return true if exc.is_a?(Errno::EINVAL)
+
+      # KaitaiStructError is a common ancestor of all Validation*Error and
+      # UndecidedEndiannessError classes since 0.9. However, it doesn't exist in
+      # the runtime library before 0.9, so we first make sure it's defined
+      # before we access it (accessing an undefined item would result in a
+      # NameError).
+      return true if
+        defined?(Kaitai::Struct::KaitaiStructError) &&
+        exc.is_a?(Kaitai::Struct::KaitaiStructError)
+      # Since 0.9, UndecidedEndiannessError is a subclass of KaitaiStructError
+      # (which was already handled above), but in 0.8 it was derived directly
+      # from Exception (in which case it hasn't been handled yet). Also,
+      # switchable default endianness is a new feature in 0.8, so the
+      # UndecidedEndiannessError class doesn't exist in older runtimes at all.
+      return true if
+        defined?(Kaitai::Struct::Stream::UndecidedEndiannessError) &&
+        exc.is_a?(Kaitai::Struct::Stream::UndecidedEndiannessError)
+      # UnexpectedDataError is no longer thrown by KSC-generated code since 0.9 -
+      # it has been superseded by ValidationNotEqualError. It still exists
+      # even in the 0.10 runtime library, but it will be removed one day, so
+      # we'll also check if it's defined.
+      return true if
+        defined?(Kaitai::Struct::Stream::UnexpectedDataError) &&
+        exc.is_a?(Kaitai::Struct::Stream::UnexpectedDataError)
+
+      false
+    end
+  end
+end