c8dasm 0.99.0

data/lib/c8dasm/assemblies/asmd.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Asmd < AsmBase
+
+    def to_s
+      "DRW V#{x}, V#{y}, #{@opcode[3]}"
+    end
+
+  end
+end
+

data/lib/c8dasm/assemblies/asme.rb

@@ -0,0 +1,16 @@
+module C8dasm
+
+  class Asme < AsmBase
+
+    def to_s
+      if kk == 'a1'
+        "SKNP V#{x}"
+      elsif kk == '9e'
+        "SKP V#{x}"
+      end
+    end
+
+  end
+end
+
+

data/lib/c8dasm/assemblies/asmf.rb

@@ -0,0 +1,20 @@
+module C8dasm
+
+  class Asmf < AsmBase
+
+    def to_s
+      case kk
+      when '07' then "LD V#{x}, DT"
+      when '0a' then "LD V#{x}, KEY"
+      when '15' then "LD DT, V#{x}"
+      when '18' then "LD ST, V#{x}"
+      when '1e' then "ADD I, V#{x}"
+      when '29' then "LD F, V#{x}"
+      when '33' then "LD B, V#{x}"
+      when '55' then "LD [I], V#{x}"
+      when '65' then "LD V#{x}, [I]"
+      end
+    end
+
+  end
+end

data/lib/c8dasm/assembly.rb

@@ -0,0 +1,22 @@
+module C8dasm
+
+  class Assembly
+
+    def initialize(opcode)
+      @opcode = opcode
+      @assembly = build_assembly.to_s || ''
+    end
+
+    def to_s
+      @assembly
+    end
+
+    private
+
+    def build_assembly
+      klass = Kernel.const_get('C8dasm::Asm' + @opcode[0])
+      klass.new(@opcode)
+    end
+
+  end
+end

data/lib/c8dasm/chip8_reader.rb

@@ -0,0 +1,38 @@
+module C8dasm
+
+  # Read a Chip-8 binary file.
+  #
+  # Examples
+  #
+  #   reader = Chip8Reader.new('./MAZE')
+  #   p reader.opcodes.first
+  #   #=> "a21e"
+  class Chip8Reader
+
+    # Creates a Chip8Reader instance.
+    #
+    # filename - The String name of the binary file to read.
+    def initialize(filename)
+      @file = File.new(filename, 'rb')
+      @opcodes = []
+      binaries_to_opcodes
+      @file.close
+    end
+
+    # Returns an Array of String Chip-8 opcodes.
+    attr_reader :opcodes
+
+    private
+
+    def binaries_to_opcodes
+      while not @file.eof?
+        @opcodes << sprintf("%02x%02x", @file.readbyte, @file.readbyte)
+      end
+    rescue EOFError
+      puts 'Error while reading entry file.'
+      exit(2)
+    end
+
+  end
+
+end

data/lib/c8dasm/comment.rb

@@ -0,0 +1,23 @@
+module C8dasm
+
+  class Comment
+
+    def initialize(opcode)
+      @opcode = opcode
+      @comment = build_comment.to_s || '***WARNING*** UNKNOWN INSTRUCTION!'
+    end
+
+    def to_s
+      @comment
+    end
+
+    private
+
+    def build_comment
+      klass = Kernel.const_get('C8dasm::Comment' + @opcode[0])
+      klass.new(@opcode)
+    end
+
+  end
+
+end

data/lib/c8dasm/comments.rb

@@ -0,0 +1,17 @@
+require "c8dasm/comments/comment_base"
+require "c8dasm/comments/comment0"
+require "c8dasm/comments/comment1"
+require "c8dasm/comments/comment2"
+require "c8dasm/comments/comment3"
+require "c8dasm/comments/comment4"
+require "c8dasm/comments/comment5"
+require "c8dasm/comments/comment6"
+require "c8dasm/comments/comment7"
+require "c8dasm/comments/comment8"
+require "c8dasm/comments/comment9"
+require "c8dasm/comments/commenta"
+require "c8dasm/comments/commentb"
+require "c8dasm/comments/commentc"
+require "c8dasm/comments/commentd"
+require "c8dasm/comments/commente"
+require "c8dasm/comments/commentf"

data/lib/c8dasm/comments/comment0.rb

@@ -0,0 +1,14 @@
+module C8dasm
+
+  class Comment0 < CommentBase
+
+    def to_s
+      if @opcode == '00ee'
+        "Returns from this subroutine."
+      elsif @opcode == '00e0'
+        "Clear the display."
+      end
+    end
+
+  end
+end

data/lib/c8dasm/comments/comment1.rb

@@ -0,0 +1,10 @@
+module C8dasm
+
+  class Comment1 < CommentBase
+
+    def to_s
+      "Jump to location #{nnn}."
+    end
+
+  end
+end

data/lib/c8dasm/comments/comment2.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Comment2 < CommentBase
+
+    def to_s
+      "Call subroutine at #{nnn}."
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/comment3.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Comment3 < CommentBase
+
+    def to_s
+      "Skip next instruction if V#{x} = #{kk}."
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/comment4.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Comment4 < CommentBase
+
+    def to_s
+      "Skip next instruction if V#{x} != #{kk}."
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/comment5.rb

@@ -0,0 +1,12 @@
+module C8dasm
+
+  class Comment5 < CommentBase
+
+    def to_s
+      "Skip next instruction if V#{x} = V#{y}."
+    end
+
+  end
+
+end
+

data/lib/c8dasm/comments/comment6.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Comment6 < CommentBase
+
+    def to_s
+      "Puts the value #{kk} into register V#{x}."
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/comment7.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Comment7 < CommentBase
+
+    def to_s
+        "V#{x} = V#{x} + #{kk}."
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/comment8.rb

@@ -0,0 +1,25 @@
+module C8dasm
+
+  class Comment8 < CommentBase
+
+    def to_s
+      case @opcode[3]
+      when '0'
+        "Set V#{x} = V#{y}."
+      when '2'
+        "Set V#{x} = V#{x} AND V#{y}."
+      when '3'
+        "Set V#{x} = V#{x} XOR V#{y}."
+      when '4'
+        "Set V#{x} = V#{x} + V#{y}, set VF = carry."
+      when '5'
+        "Set V#{x} = V#{x} - V#{y}, set VF = NOT borrow."
+      when '6'
+        "Set V#{x} = V#{y} SHR 1."
+      when 'e'
+        "Set V#{x} = V#{y} SHL 1."
+      end
+    end
+
+  end
+end

data/lib/c8dasm/comments/comment9.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Comment9 < CommentBase
+
+    def to_s
+      "Skip next instruction if V#{x} != V#{y}."
+    end
+
+  end
+
+end

data/lib/c8dasm/comments/comment_base.rb

@@ -0,0 +1,26 @@
+module C8dasm
+
+  class CommentBase
+
+    def initialize(opcode)
+      @opcode = opcode
+    end
+
+    def nnn
+      @opcode[1, 3]
+    end
+
+    def kk
+      @opcode[2, 2]
+    end
+
+    def x
+      @opcode[1]
+    end
+
+    def y
+      @opcode[2]
+    end
+
+  end
+end

data/lib/c8dasm/comments/commenta.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Commenta < CommentBase
+
+    def to_s
+      "Puts #{nnn} into register I."
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/commentb.rb

@@ -0,0 +1,12 @@
+module C8dasm
+
+  class Commentb < CommentBase
+
+    def to_s
+      "Jump to location #{nnn} + V0."
+    end
+
+  end
+
+end
+

data/lib/c8dasm/comments/commentc.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Commentc < CommentBase
+
+    def to_s
+      "Puts random byte AND #{kk} into register V#{x}."
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/commentd.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Commentd < CommentBase
+
+    def to_s
+      "Draws #{@opcode[3]}-byte sprite from I at (V#{x}, V#{y})"
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/commente.rb

@@ -0,0 +1,15 @@
+module C8dasm
+
+  class Commente < CommentBase
+
+    def to_s
+      if kk == 'a1'
+        "Skip next inst. if V#{x} key is not pressed."
+      elsif kk == '9e'
+        "Skip next inst. if V#{x} key is pressed."
+      end
+    end
+
+  end
+end
+

data/lib/c8dasm/comments/commentf.rb

@@ -0,0 +1,30 @@
+module C8dasm
+
+  class Commentf < CommentBase
+
+    def to_s
+      case kk
+      when '07'
+        "Set V#{x} = delay timer value."
+      when '0a'
+        "Wait key press, store its value in V#{x}."
+      when '15'
+        "Set delay timer = V#{x}."
+      when '18'
+        "Set sound timer = V#{x}."
+      when '1e'
+        "Set I = I + V#{x}."
+      when '29'
+        "Set I = location of sprite for digit V#{x}."
+      when '33'
+        "Store BCD of V#{x} at I, I+1, and I+2."
+      when '55'
+        "Store registers V0..V#{x} starting at I."
+      when '65'
+        "Load registers V0..V#{x} starting from I."
+      end
+    end
+
+  end
+end
+

data/lib/c8dasm/opcode.rb

@@ -0,0 +1,34 @@
+module C8dasm
+
+  # Represents an opcode, in the sense of a disassembly file.
+  #
+  # Examples
+  #
+  #   o = Opcode.new('a21e')
+  #   o.line     #=> '200:a21e  LD I, 21e  ;Puts 21e into register I.'
+  #
+  #   o.opcode   #=> 'a21e'
+  #   o.assembly #=> 'LD I, 21e'
+  #   o.comment  #=> 'Puts 21e into register I.'
+  #   o.address  #=> '200'
+  class Opcode
+
+    # Creates a new Opcode instance.
+    #
+    # opcode  - The String opcode to represents.
+    # address - The Fixnum address of this opcode. Default is 0x200.
+    def initialize(opcode, address: 0x200)
+      @assembly = Assembly.new(opcode).to_s
+      @opcode = opcode
+      @comment = Comment.new(opcode).to_s
+      @address = sprintf("%03x", address)
+      @line = "#@address:#@opcode  " +
+              sprintf("%-14s", @assembly) +
+              ";#@comment"
+    end
+
+    attr_reader :opcode, :assembly, :comment, :address, :line
+
+  end
+
+end