c8dasm 0.99.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 960ec7c6a8d76ad08c1b481f63e40788d3b2547c
+  data.tar.gz: f1a9a569beebd417784cc90c04513762d691d769
+SHA512:
+  metadata.gz: d1f105e12fe48146e976436b1c68208698d9f8d536af64e2841a5fc70c78144d280e80951fdcf1eff4586454e15817cfe50bcef36f17a5797169df04150a2fb6
+  data.tar.gz: acd3e8a7b88ab659522d057494aa704905018d8238a3f80840896da7c78db34e871747055c0dd5a03189eee28ec7c161bea1c36055101c62a5aafe84f1d05c7d

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+TODO
+sidenotes.md

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in c8dasm.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,15 @@
+c8dasm - a disassembler for chip8
+Copyright (C) 2015  Xavier Nayrac
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,109 @@
+# C8dasm
+
+`c8dasm` is a utility to disassemble a Chip8 binary file.
+
+## Installation
+
+Install it as:
+
+    $ gem install c8dasm
+
+## Usage
+
+    $ c8dasm chip8file
+
+### Example
+
+    $ c8dasm MAZE
+    200:a21e  LD I, 21e     ;Puts 21e into register I.
+    202:c201  RND V2, 01    ;Puts random byte AND 01 into register V2.
+    204:3201  SE V2, 01     ;Skip next instruction if V2 = 01.
+    206:a21a  LD I, 21a     ;Puts 21a into register I.
+    208:d014  DRW V0, V1, 4 ;Draws 4-byte sprite from I at (V0, V1)
+    20a:7004  ADD V0, 04    ;V0 = V0 + 04.
+    20c:3040  SE V0, 40     ;Skip next instruction if V0 = 40.
+    20e:1200  JP 200        ;Jump to location 200.
+    210:6000  LD V0, 00     ;Puts the value 00 into register V0.
+    212:7104  ADD V1, 04    ;V1 = V1 + 04.
+    ...
+
+## License
+
+GPLv3
+
+## Standard Chip-8 Instructions (What's remain to do)
+
+- [x] 00E0 - CLS
+- [x] 00EE - RET
+- [ ] 0nnn - SYS addr
+- [x] 1nnn - JP addr
+- [x] 2nnn - CALL addr
+- [x] 3xkk - SE Vx, byte
+- [x] 4xkk - SNE Vx, byte
+- [x] 5xy0 - SE Vx, Vy
+- [x] 6xkk - LD Vx, byte
+- [x] 7xkk - ADD Vx, byte
+- [x] 8xy0 - LD Vx, Vy
+- [ ] 8xy1 - OR Vx, Vy
+- [x] 8xy2 - AND Vx, Vy
+- [x] 8xy3 - XOR Vx, Vy
+- [x] 8xy4 - ADD Vx, Vy
+- [x] 8xy5 - SUB Vx, Vy
+- [x] 8xy6 - SHR Vx {, Vy}
+- [ ] 8xy7 - SUBN Vx, Vy
+- [x] 8xyE - SHL Vx {, Vy}
+- [x] 9xy0 - SNE Vx, Vy
+- [x] Annn - LD I, addr
+- [x] Bnnn - JP V0, addr
+- [x] Cxkk - RND Vx, byte
+- [x] Dxyn - DRW Vx, Vy, nibble
+- [x] Ex9E - SKP Vx
+- [x] ExA1 - SKNP Vx
+- [x] Fx07 - LD Vx, DT
+- [x] Fx0A - LD Vx, KEY
+- [x] Fx15 - LD DT, Vx
+- [x] Fx18 - LD ST, Vx
+- [x] Fx1E - ADD I, Vx
+- [x] Fx29 - LD F, Vx
+- [x] Fx33 - LD B, Vx
+- [x] Fx55 - LD [I], Vx
+- [x] Fx65 - LD Vx, [I]
+
+## TODO
+
+Check input file.
+
+Option --help and --version.
+
+Data range display option, for instance:
+
+    $ c8dasm --data=21a,221 MAZE
+    200:a21e  LD I, 21e     ;Puts 21e into register I.
+    202:c201  RND V2, 01    ;Puts random byte AND 01 into register V2.
+    204:3201  SE V2, 01     ;Skip next instruction if V2 = 01.
+    206:a21a  LD I, 21a     ;Puts 21a into register I.
+    208:d014  DRW V0, V1, 4 ;Draws 4-byte sprite from I at (V0, V1)
+    20a:7004  ADD V0, 04    ;V0 = V0 + 04.
+    20c:3040  SE V0, 40     ;Skip next instruction if V0 = 40.
+    20e:1200  JP 200        ;Jump to location 200.
+    210:6000  LD V0, 00     ;Puts the value 00 into register V0.
+    212:7104  ADD V1, 04    ;V1 = V1 + 04.
+    214:3120  SE V1, 20     ;Skip next instruction if V1 = 20.
+    216:1200  JP 200        ;Jump to location 200.
+    218:1218  JP 218        ;Jump to location 218.
+    21a:80    @.......
+    21b:40    .@......
+    21c:20    ..@.....
+    21d:10    ...@....
+    21e:20    ..@.....
+    21f:40    .@......
+    220:80    @.......
+    221:10    ...@....
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/c8dasm/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/c8dasm

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'c8dasm'
+
+reader = C8dasm::Chip8Reader.new(ARGV[0])
+
+counter_base = 0x200
+
+opcodes = reader.opcodes.map.with_index do |item, index|
+  C8dasm::Opcode.new(item, address: counter_base + 2 * index)
+end
+
+opcodes.each {|opcode| puts opcode.line }

data/c8dasm.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'c8dasm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "c8dasm"
+  spec.version       = C8dasm::VERSION
+  spec.authors       = ["lkdjiin"]
+  spec.email         = ["xavier.nayrac@gmail.com"]
+  spec.summary       = %q{Disassembler for Chip8 binaries.}
+  spec.description   = %q{c8dasm is a utility to disassemble a Chip8 binary file.}
+  spec.homepage      = ""
+  spec.license       = "GPLv3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/c8dasm.rb

@@ -0,0 +1,11 @@
+require "c8dasm/version"
+require "c8dasm/chip8_reader"
+require "c8dasm/opcode"
+require "c8dasm/assembly"
+require "c8dasm/assemblies"
+require "c8dasm/comment"
+require "c8dasm/comments"
+
+# A desassembly utility for Chip-8.
+module C8dasm
+end

data/lib/c8dasm/assemblies.rb

@@ -0,0 +1,18 @@
+require "c8dasm/assemblies/asm_base"
+require "c8dasm/assemblies/asm0"
+require "c8dasm/assemblies/asm1"
+require "c8dasm/assemblies/asm2"
+require "c8dasm/assemblies/asm3"
+require "c8dasm/assemblies/asm4"
+require "c8dasm/assemblies/asm5"
+require "c8dasm/assemblies/asm6"
+require "c8dasm/assemblies/asm7"
+require "c8dasm/assemblies/asm8"
+require "c8dasm/assemblies/asm9"
+require "c8dasm/assemblies/asma"
+require "c8dasm/assemblies/asmb"
+require "c8dasm/assemblies/asmc"
+require "c8dasm/assemblies/asmd"
+require "c8dasm/assemblies/asme"
+require "c8dasm/assemblies/asmf"
+

data/lib/c8dasm/assemblies/asm0.rb

@@ -0,0 +1,15 @@
+module C8dasm
+
+  class Asm0 < AsmBase
+
+    def to_s
+      if @opcode == '00ee'
+        "RET"
+      elsif @opcode == '00e0'
+        "CLS"
+      end
+    end
+
+  end
+end
+

data/lib/c8dasm/assemblies/asm1.rb

@@ -0,0 +1,10 @@
+module C8dasm
+
+  class Asm1 < AsmBase
+
+    def to_s
+      "JP #{nnn}"
+    end
+
+  end
+end

data/lib/c8dasm/assemblies/asm2.rb

@@ -0,0 +1,10 @@
+module C8dasm
+
+  class Asm2 < AsmBase
+
+    def to_s
+      "CALL #{nnn}"
+    end
+
+  end
+end

data/lib/c8dasm/assemblies/asm3.rb

@@ -0,0 +1,10 @@
+module C8dasm
+
+  class Asm3 < AsmBase
+
+    def to_s
+      "SE V#{x}, #{kk}"
+    end
+
+  end
+end

data/lib/c8dasm/assemblies/asm4.rb

@@ -0,0 +1,9 @@
+module C8dasm
+
+  class Asm4 < AsmBase
+
+    def to_s
+      "SNE V#{x}, #{kk}"
+    end
+  end
+end

data/lib/c8dasm/assemblies/asm5.rb

@@ -0,0 +1,12 @@
+module C8dasm
+
+  class Asm5 < AsmBase
+
+    def to_s
+      "SE V#{x}, V#{y}"
+    end
+
+  end
+
+end
+

data/lib/c8dasm/assemblies/asm6.rb

@@ -0,0 +1,9 @@
+module C8dasm
+
+  class Asm6 < AsmBase
+
+    def to_s
+      "LD V#{x}, #{kk}"
+    end
+  end
+end

data/lib/c8dasm/assemblies/asm7.rb

@@ -0,0 +1,9 @@
+module C8dasm
+
+  class Asm7 < AsmBase
+
+    def to_s
+      "ADD V#{x}, #{kk}"
+    end
+  end
+end

data/lib/c8dasm/assemblies/asm8.rb

@@ -0,0 +1,23 @@
+module C8dasm
+
+  class Asm8 < AsmBase
+
+    def to_s
+      case last_opcode
+      when '0' then "LD V#{x}, V#{y}"
+      when '2' then "AND V#{x}, V#{y}"
+      when '3' then "XOR V#{x}, V#{y}"
+      when '4' then "ADD V#{x}, V#{y}"
+      when '5' then "SUB V#{x}, V#{y}"
+      when '6' then "SHR V#{x}, V#{y}"
+      when 'e' then "SHL V#{x}, V#{y}"
+      end
+    end
+
+    def last_opcode
+      @opcode[3]
+    end
+
+  end
+end
+

data/lib/c8dasm/assemblies/asm9.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Asm9 < AsmBase
+
+    def to_s
+      "SNE V#{x}, V#{y}"
+    end
+
+  end
+
+end

data/lib/c8dasm/assemblies/asm_base.rb

@@ -0,0 +1,26 @@
+module C8dasm
+
+  class AsmBase
+
+    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/assemblies/asma.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Asma < AsmBase
+
+    def to_s
+      "LD I, #{nnn}"
+    end
+
+  end
+end
+

data/lib/c8dasm/assemblies/asmb.rb

@@ -0,0 +1,12 @@
+module C8dasm
+
+  class Asmb < AsmBase
+
+    def to_s
+      "JP V0, #{nnn}"
+    end
+
+  end
+
+end
+

data/lib/c8dasm/assemblies/asmc.rb

@@ -0,0 +1,11 @@
+module C8dasm
+
+  class Asmc < AsmBase
+
+    def to_s
+      "RND V#{x}, #{kk}"
+    end
+
+  end
+end
+