hack_assembler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c382e0c2ca7ae32e05aec74da6e0ab061d6fdbf
-  data.tar.gz: 022d493d48819e560fd0ad763395d5a677718dbf
+  metadata.gz: 16849ad49ea5724294483935e3bd416de48576fa
+  data.tar.gz: eb36db703661f2acc60e2c8e7781581e6998b4fb
 SHA512:
-  metadata.gz: 125e257a54f2695db744394ac9f9e8f474beb43690a48583177a080a1f77305adb223507d2bbe0cbd8c1dd0fca8e7562c8c25faebfbb9659e796f3c0c11b213b
-  data.tar.gz: b94dfaf5371f68bfb91c74556e8de03cb556db95ee2ef4341a82b9381fc8414106ca83c754e09f8957950297d9546288a2f5ce8dcd99b694e2de258843108680
+  metadata.gz: 92a36fcda84358674b2c0699bf548639604312bf7a874da237d3fb7203cb4c5c71dbd04e1870915c226861cb61349bfcc0744b9f485eb0b73ef71ddcab4a9e61
+  data.tar.gz: 93822f4774998d3d4ba30ed8b0aa7df089ebedd4573f7a988845d96f2ede6492615e695aac88d6f3b3f30bd490f2e937781f9ebfc5d7fe737e82a288859f191f

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/Fuffi/hack2asm.svg?branch=master)](https://travis-ci.org/Fuffi/hack_assembler)
+[![Build Status](https://travis-ci.org/Fuffi/hack-assembler.svg?branch=master)](https://travis-ci.org/Fuffi/hack-assembler)
 
 # Hack Assembler
 
@@ -21,8 +21,16 @@ Or install it yourself as:
 ## Usage
 
 After installing the Gem you can run this command from your terminal:
+
     hack_assembler <input-file.asm> <output-file.hack>
 
+## TO DOs
+
+* Refactor code and tests
+* Add better error reporting
+* Make sure any valid symbol name is recognized
+
+
 ## Contributing
 
 1. Fork it

data/lib/hack_assembler.rb

@@ -6,13 +6,18 @@ require_relative 'hack_assembler/destination_translator'
 require_relative 'hack_assembler/jump_translator'
 require_relative 'hack_assembler/c_instruction'
 require_relative 'hack_assembler/assembler'
+require_relative 'hack_assembler/symbol_table'
 
 module HackAssembler
   def self.translate_file(input_file, output_file)
     source_file = File.open(input_file)
     source_code = source_file.read
 
-    machine_code = Assembler.translate(source_code)
+    symbol_table = SymbolTable.new
+
+    label_less_code = Assembler.scan_and_remove_labels(source_code, symbol_table)
+    processed_source = Assembler.process_symbols(label_less_code, symbol_table)
+    machine_code = Assembler.translate(processed_source)
 
     File.open(output_file, 'w') { |file| file.write(machine_code); file.close }
 

data/lib/hack_assembler/assembler.rb

@@ -1,13 +1,56 @@
 module HackAssembler
   module Assembler
+    def self.scan_and_remove_labels(source_code, symbol_table)
+      machine_code_line_number = 0
+      label_less_code = ''
+      source_code.each_line do |line|
+        if is_empty_line?(line) || is_comment_line?(line)
+          label_less_code << line
+          next
+        end
+
+        clean_line = line.strip
+
+        match = /\((.*)\)/.match(clean_line)
+        if match
+          label = match[1]
+
+          symbol_table.add_label_address(label, machine_code_line_number)
+          label_less_code << "\n"
+        else
+          machine_code_line_number += 1
+          label_less_code << line
+        end
+      end
+
+      label_less_code
+    end
+
+    def self.process_symbols(source_code, symbol_table)
+      processed_code = ''
+      source_code.each_line do |line|
+        clean_line = line.strip
+
+        match = /@([^0-9].*)/.match(clean_line)
+        if match
+          symbol = match[1]
+
+          address = symbol_table.get_address(symbol)
+          line = "@#{address}\n"
+        end
+
+        processed_code << line
+      end
+
+      processed_code
+    end
+
     def self.translate(source_code)
       machine_code = ''
 
-      source_code_extract = source_code.gsub(/^[\s]*$\n/, '')
+      source_code.each_line do |line|
+        next if is_empty_line?(line) || is_comment_line?(line)
 
-      source_code_extract.each_line do |line|
-        next if line.start_with? '//'
-        
         clean_line = line.strip
 
         instruction = clean_line.start_with?('@') ? AInstruction : CInstruction
@@ -17,5 +60,18 @@ module HackAssembler
 
       machine_code
     end
+
+    private
+    def self.is_empty_line?(line)
+      line =~ /^[\s]*$\n/
+    end
+
+    def self.is_comment_line?(line)
+      line.start_with? '//'
+    end
+
+    def self.is_label_line?(line)
+      line =~ /\(.*\)/
+    end
   end
 end

data/lib/hack_assembler/symbol_table.rb

@@ -0,0 +1,48 @@
+module HackAssembler
+  class SymbolTable
+    def initialize
+      @num_variable_symbols = 0
+
+      @symbol_table = {
+        'R0' => '0',
+        'R1' => '1',
+        'R2' => '2',
+        'R3' => '3',
+        'R4' => '4',
+        'R5' => '5',
+        'R6' => '6',
+        'R7' => '7',
+        'R8' => '8',
+        'R9' => '9',
+        'R10' => '10',
+        'R11' => '11',
+        'R12' => '12',
+        'R13' => '13',
+        'R14' => '14',
+        'R15' => '15',
+        'SCREEN' => '16384',
+        'KBD' => '24576',
+        'SP' => '0',
+        'LCL' => '1',
+        'ARG' => '2',
+        'THIS' => '3',
+        'THAT' => '4'
+      }
+    end
+
+    def get_address(symbol)
+      address = @symbol_table[symbol]
+      if address.nil?
+        address =  (16 + @num_variable_symbols).to_s
+        @symbol_table[symbol] = address
+        @num_variable_symbols += 1
+      end
+
+      address
+    end
+
+    def add_label_address(symbol, address)
+      @symbol_table[symbol] = address.to_s
+    end
+  end
+end

data/lib/hack_assembler/version.rb

@@ -1,3 +1,3 @@
 module HackAssembler
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/assembler_test.rb

@@ -1,27 +1,72 @@
-require 'test_helper'
-
-class AssemblerTest < Minitest::Test
-  def test_translates_a_and_c_instructions
-    source_code = "@4\n" << "0;JMP\n"
-    bytecode = Assembler.translate(source_code)
-    assert_equal "0000000000000100\n" << "1110101010000111\n", bytecode
-  end
-
-  def test_ignores_comments
-    source_code = "// A comment\n" << "@4\n" << "// Another comment\n"
-    bytecode = Assembler.translate(source_code)
-    assert_equal "0000000000000100\n", bytecode
-  end
-
-  def test_ignores_empty_lines
-    source_code = "\n@4\n\n"
-    bytecode = Assembler.translate(source_code)
-    assert_equal "0000000000000100\n", bytecode
-  end
-
-  def test_ignores_indentation_and_trailing_spaces
-    source_code = "  @4  \n"
-    bytecode = Assembler.translate(source_code)
-    assert_equal "0000000000000100\n", bytecode
-  end
-end
+require 'test_helper'
+
+class AssemblerTest < Minitest::Test
+  def test_translates_a_and_c_instructions
+    source_code = "@4\n" << "0;JMP\n"
+    bytecode = Assembler.translate(source_code)
+    assert_equal "0000000000000100\n" << "1110101010000111\n", bytecode
+  end
+
+  def test_ignores_comments
+    source_code = "// A comment\n" << "@4\n" << "// Another comment\n"
+    bytecode = Assembler.translate(source_code)
+    assert_equal "0000000000000100\n", bytecode
+  end
+
+  def test_ignores_empty_lines
+    source_code = "\n@4\n\n"
+    bytecode = Assembler.translate(source_code)
+    assert_equal "0000000000000100\n", bytecode
+  end
+
+  def test_ignores_indentation_and_trailing_spaces
+    source_code = "  @4  \n"
+    bytecode = Assembler.translate(source_code)
+    assert_equal "0000000000000100\n", bytecode
+  end
+
+  def test_that_scan_and_remove_labels_adds_labels_to_symbol_table
+    symbol_table = SymbolTable.new
+
+    source_code = "(LOOP)\n" << "@LOOP\n" << "  \n" << "(END_LOOP)\n" << "@END_LOOP\n"
+    Assembler.scan_and_remove_labels(source_code, symbol_table)
+
+    loop_address = symbol_table.get_address('LOOP')
+    end_address = symbol_table.get_address('END_LOOP')
+
+    assert_equal '0', loop_address
+    assert_equal '1', end_address
+  end
+
+  def test_that_it_processes_built_in_symbols
+    symbol_table = SymbolTable.new
+
+    source_code = "@R0\n" << "@R15\n"
+    processed_code = Assembler.process_symbols(source_code, symbol_table)
+
+    assert_equal "@0\n" << "@15\n", processed_code
+  end
+
+  def test_that_it_does_not_change_symbols
+    symbol_table = SymbolTable.new
+
+    source_code = "@256\n" << "@0\n"
+    processed_code = Assembler.process_symbols(source_code, symbol_table)
+
+    assert_equal "@256\n" << "@0\n", processed_code
+  end
+
+  def test_that_it_translates_code_with_symbols_and_labels
+    symbol_table = SymbolTable.new
+
+    source_code = "(START_LOOP)\n" << "@START_LOOP\n" << "(END_LOOP)\n" << "@END_LOOP"
+
+    label_less_code = Assembler.scan_and_remove_labels(source_code, symbol_table)
+
+    processed_code = Assembler.process_symbols(label_less_code, symbol_table)
+
+    bytecode = Assembler.translate(processed_code)
+
+    assert_equal "0000000000000000\n" << "0000000000000001\n", bytecode
+  end
+end

data/test/symbol_table_test.rb

@@ -0,0 +1,146 @@
+require 'test_helper'
+
+class SymbolTableTest < Minitest::Test
+  def setup
+    @symbol_table = SymbolTable.new
+  end
+
+  def test_that_adds_one_variable_symbol
+    address = @symbol_table.get_address('index')
+    assert_equal '16', address
+  end
+
+  def test_that_adds_two_variable_symbols
+    @symbol_table.get_address('index')
+    address = @symbol_table.get_address('count')
+    assert_equal '17', address
+  end
+
+  def test_that_addresses_dont_change
+    @symbol_table.get_address('index')
+    @symbol_table.get_address('count')
+    address = @symbol_table.get_address('index')
+    assert_equal '16', address
+  end
+
+  def test_add_one_label_address
+    @symbol_table.add_label_address('END', 32)
+    address = @symbol_table.get_address('END')
+    assert '32', address
+  end
+
+  def test_reserved_symbol_r0
+    address = @symbol_table.get_address('R0')
+    assert_equal '0', address
+  end
+
+  def test_reserved_symbol_r1
+    address = @symbol_table.get_address('R1')
+    assert_equal '1', address
+  end
+
+  def test_reserved_symbol_r2
+    address = @symbol_table.get_address('R2')
+    assert_equal '2', address
+  end
+
+  def test_reserved_symbol_r3
+    address = @symbol_table.get_address('R3')
+    assert_equal '3', address
+  end
+
+  def test_reserved_symbol_r4
+    address = @symbol_table.get_address('R4')
+    assert_equal '4', address
+  end
+
+  def test_reserved_symbol_r5
+    address = @symbol_table.get_address('R5')
+    assert_equal '5', address
+  end
+
+  def test_reserved_symbol_r6
+    address = @symbol_table.get_address('R6')
+    assert_equal '6', address
+  end
+
+  def test_reserved_symbol_r7
+    address = @symbol_table.get_address('R7')
+    assert_equal '7', address
+  end
+
+  def test_reserved_symbol_r8
+    address = @symbol_table.get_address('R8')
+    assert_equal '8', address
+  end
+
+  def test_reserved_symbol_r9
+    address = @symbol_table.get_address('R9')
+    assert_equal '9', address
+  end
+
+  def test_reserved_symbol_r10
+    address = @symbol_table.get_address('R10')
+    assert_equal '10', address
+  end
+
+  def test_reserved_symbol_r11
+    address = @symbol_table.get_address('R11')
+    assert_equal '11', address
+  end
+
+  def test_reserved_symbol_r12
+    address = @symbol_table.get_address('R12')
+    assert_equal '12', address
+  end
+
+  def test_reserved_symbol_r13
+    address = @symbol_table.get_address('R13')
+    assert_equal '13', address
+  end
+
+  def test_reserved_symbol_r14
+    address = @symbol_table.get_address('R14')
+    assert_equal '14', address
+  end
+
+  def test_reserved_symbol_r15
+    address = @symbol_table.get_address('R15')
+    assert_equal '15', address
+  end
+
+  def test_reserved_symbol_screen
+    address = @symbol_table.get_address('SCREEN')
+    assert_equal '16384', address
+  end
+
+  def test_reserved_symbol_kbd
+    address = @symbol_table.get_address('KBD')
+    assert_equal '24576', address
+  end
+
+  def test_reserved_symbol_sp
+    address = @symbol_table.get_address('SP')
+    assert_equal '0', address
+  end
+
+  def test_reserved_symbol_lcl
+    address = @symbol_table.get_address('LCL')
+    assert_equal '1', address
+  end
+
+  def test_reserved_symbol_arg
+    address = @symbol_table.get_address('ARG')
+    assert_equal '2', address
+  end
+
+  def test_reserved_symbol_this
+    address = @symbol_table.get_address('THIS')
+    assert_equal '3', address
+  end
+
+  def test_reserved_symbol_that
+    address = @symbol_table.get_address('THAT')
+    assert_equal '4', address
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hack_assembler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Federico Rebora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2015-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,12 +64,10 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
-- Pong.asm
-- PongL.asm
 - README.md
 - Rakefile
 - bin/hack_assembler
-- hack2asm.gemspec
+- hack_assembler.gemspec
 - lib/hack_assembler.rb
 - lib/hack_assembler/a_instruction.rb
 - lib/hack_assembler/assembler.rb
@@ -78,8 +76,8 @@ files:
 - lib/hack_assembler/destination_translator.rb
 - lib/hack_assembler/jump_translator.rb
 - lib/hack_assembler/parser_error.rb
+- lib/hack_assembler/symbol_table.rb
 - lib/hack_assembler/version.rb
-- out.hack
 - test/a_instruction_test.rb
 - test/assembler_test.rb
 - test/c_instruction_test.rb
@@ -87,6 +85,7 @@ files:
 - test/destination_translator_test.rb
 - test/hack2asm_test.rb
 - test/jump_translator_test.rb
+- test/symbol_table_test.rb
 - test/test_helper.rb
 homepage: ''
 licenses:
@@ -120,4 +119,5 @@ test_files:
 - test/destination_translator_test.rb
 - test/hack2asm_test.rb
 - test/jump_translator_test.rb
+- test/symbol_table_test.rb
 - test/test_helper.rb