zobjinspect 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-07-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/zlibinspect
+bin/zobjinspect
+lib/library_file.rb
+lib/object_file.rb
+lib/zobjinspect.rb
+test/block_device.lib.bin
+test/read_block.o.bin
+test/test_library_file.rb
+test/test_object_file.rb

data/README.txt

@@ -0,0 +1,42 @@
+= zobjinspect
+
+* http://zobjinspect.rubyforge.org
+
+== DESCRIPTION:
+
+* A set of utilities for inspecting object and library files generated
+  by z80asm, the assembler from z88dk - http://www.z88dk.org/
+
+== SYNOPSIS:
+
+  zobjinspect something.o 
+  zlibinspect something_else.lib
+
+== INSTALL:
+
+* sudo gem install zobjinspect
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Matthew Westcott
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/zobjinspect.rb'
+
+Hoe.new('zobjinspect', Zobjinspect::VERSION) do |p|
+  p.developer('Matt Westcott', 'matt@west.co.tt')
+end
+
+# vim: syntax=Ruby

data/bin/zlibinspect

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'library_file'
+
+io = File.open(ARGV[0])
+LibraryFile.read(io).each do |mod|
+	puts mod.describe
+	puts "---------------\n\n"
+end

data/bin/zobjinspect

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'object_file'
+
+io = File.open(ARGV[0])
+puts ObjectFile.read(io).describe

data/lib/library_file.rb

@@ -0,0 +1,21 @@
+require 'object_file'
+
+module LibraryFile
+	def self.read(io)
+		if io.read(8) != 'Z80LMF01'
+			raise "not a Z80asm library file"
+		end
+		
+		next_object_file_ptr = 8
+		
+		objects = []
+		
+		while next_object_file_ptr != 0xffffffff
+			io.seek(next_object_file_ptr)
+			next_object_file_ptr, next_object_file_length = io.read(8).unpack('VV')
+			objects << ObjectFile.read(io)
+		end
+		
+		objects
+	end
+end

data/lib/object_file.rb

@@ -0,0 +1,81 @@
+class ObjectFile < Struct.new(
+	:name, :org_address, :expression_declarations, :name_declarations, :library_name_declarations)
+
+	class ExpressionDeclaration < Struct.new(:type, :patchptr, :expression)
+	end
+
+	class NameDeclaration < Struct.new(:scope, :type, :value, :name)
+	end
+
+	def self.read(io)
+		if io.read(8) != 'Z80RMF01'
+			raise "not a Z80asm object file"
+		end
+		org_address, module_name_ptr, expression_declarations_ptr,
+			name_declarations_ptr, library_name_declarations_ptr,
+			machine_code_block_ptr = io.read(22).unpack('vVVVVV')
+		
+		expression_declarations = []
+		if expression_declarations_ptr != 0xffffffff
+			expression_declarations_length = [name_declarations_ptr, library_name_declarations_ptr, module_name_ptr].min - expression_declarations_ptr
+			expression_declarations_bin =
+				io.read(expression_declarations_length)
+			until expression_declarations_bin == ''
+				type, patchptr, length =
+					expression_declarations_bin.slice!(0...4).unpack('a1vc')
+				expression = expression_declarations_bin.slice!(0...length)
+				expression_declarations_bin.slice!(0) # strip off null
+				expression_declarations << ExpressionDeclaration.new(type, patchptr, expression)
+			end
+		end
+
+		name_declarations = []
+		if name_declarations_ptr != 0xffffffff
+			name_declarations_length = [library_name_declarations_ptr, module_name_ptr].min - name_declarations_ptr
+			name_declarations_bin =
+				io.read(name_declarations_length)
+			until name_declarations_bin == ''
+				scope, type, value, length =
+					name_declarations_bin.slice!(0...7).unpack('a1a1Vc')
+				name = name_declarations_bin.slice!(0...length)
+				name_declarations << NameDeclaration.new(scope, type, value, name)
+			end
+		end
+		
+		library_name_declarations = []
+		if library_name_declarations_ptr != 0xffffffff
+			library_name_declarations_bin =
+				io.read(module_name_ptr - library_name_declarations_ptr)
+			until library_name_declarations_bin == ''
+				length = library_name_declarations_bin.slice!(0)
+				library_name_declarations << library_name_declarations_bin.slice!(0...length)
+			end
+		end
+		
+		module_name_length, = io.read(1).unpack('c')
+		module_name = io.read(module_name_length)
+		
+		new(module_name, org_address, expression_declarations, name_declarations,
+			library_name_declarations)
+	end
+	
+	def describe
+		out = ''
+		out << "#{name}, org #{org_address}\n===============\n"
+		out << "Expression declarations:\n"
+		for expr in expression_declarations
+			out << "#{expr.type == 'C' ? 'Constant' : 'Relocatable address'} at #{expr.patchptr} = #{expr.expression}\n"
+		end
+
+		out << "\nName declarations:\n"
+		for name in name_declarations
+			out << "#{name.scope} #{name.type} #{name.name} = #{name.value}\n"
+		end
+
+		out << "\nLibrary name declarations:\n"
+		for name in library_name_declarations
+			out << "#{name}\n"
+		end
+		out
+	end
+end

data/lib/zobjinspect.rb

@@ -0,0 +1,3 @@
+class Zobjinspect
+  VERSION = '1.0.0'
+end

data/test/test_library_file.rb

@@ -0,0 +1,14 @@
+require "test/unit"
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require "library_file"
+
+class TestLibraryFile < Test::Unit::TestCase
+  def test_library_file
+    io = File.open "#{File.dirname(__FILE__)}/block_device.lib.bin"
+    library_file = LibraryFile.read(io)
+    assert_equal 2, library_file.size
+    assert_equal "READ_BLOCK", library_file[0].name
+    assert_equal "READ_BLOCK_CALLEE", library_file[1].name
+  end
+end

data/test/test_object_file.rb

@@ -0,0 +1,28 @@
+require "test/unit"
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require "object_file"
+
+class TestObjectFile < Test::Unit::TestCase
+  def test_object_file
+    io = File.open "#{File.dirname(__FILE__)}/read_block.o.bin"
+    obj = ObjectFile.read(io)
+    assert_equal "READ_BLOCK", obj.name
+    assert_equal 0xffff, obj.org_address
+
+    assert_equal 1, obj.expression_declarations.size
+    expr = obj.expression_declarations[0]
+    assert_equal "C", expr.type
+    assert_equal 13, expr.patchptr
+    assert_equal "READ_BLOCK_CALLEE+ASMDISP_READ_BLOCK_CALLEE", expr.expression
+
+    assert_equal 1, obj.name_declarations.size
+    name = obj.name_declarations[0]
+    assert_equal "X", name.scope
+    assert_equal "A", name.type
+    assert_equal 0, name.value
+    assert_equal "READ_BLOCK", name.name
+    
+    assert_equal ["READ_BLOCK_CALLEE"], obj.library_name_declarations
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: zobjinspect
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matt Westcott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: "* A set of utilities for inspecting object and library files generated by z80asm, the assembler from z88dk - http://www.z88dk.org/"
+email: 
+- matt@west.co.tt
+executables: 
+- zlibinspect
+- zobjinspect
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/zlibinspect
+- bin/zobjinspect
+- lib/library_file.rb
+- lib/object_file.rb
+- lib/zobjinspect.rb
+- test/block_device.lib.bin
+- test/read_block.o.bin
+- test/test_library_file.rb
+- test/test_object_file.rb
+has_rdoc: true
+homepage: http://zobjinspect.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: zobjinspect
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: "* A set of utilities for inspecting object and library files generated by z80asm, the assembler from z88dk - http://www.z88dk.org/"
+test_files: 
+- test/test_library_file.rb
+- test/test_object_file.rb