snes_utils 0.2.0 → 0.3.0

data/lib/vas/vas.rb

@@ -4,19 +4,24 @@ module SnesUtils
   class Vas
     WDC65816 = :wdc65816
     SPC700 = :spc700
+    SUPERFX = :superfx
 
     DIRECTIVE = [
-      '.65816', '.spc700', '.org', '.base', '.db', '.rb', '.incbin', '.incsrc', '.define'
+      '.65816', '.spc700', '.superfx', '.org', '.base', '.db', '.rb', '.incbin'
     ]
 
     LABEL_OPERATORS = ['@', '!', '<', '>', '\^']
 
-    def initialize(filename)
+    def initialize(filename, outfile)
       raise "File not found: #{filename}" unless File.file?(filename)
 
       @filename = filename
-      @file = {}
+      @outfile = outfile
+      @file = []
       @label_registry = []
+      @reading_macro = false
+      @current_macro = nil
+      @macros_registry = {}
       @define_registry = {}
       @incbin_list = []
       @byte_sequence_list = []
@@ -38,7 +43,7 @@ module SnesUtils
       write_label_registry
       insert_bytes
       incbin
-      write
+      write(@outfile)
     end
 
     def construct_file(filename = @filename)
@@ -47,27 +52,101 @@ module SnesUtils
         next if line.empty?
 
         if line.start_with?('.include')
+          raise "can't include file within macro" if @reading_macro
+
           directive = line.split(' ')
           inc_filename = directive[1].to_s.strip.chomp
+          dir = File.dirname(filename)
 
-          construct_file(inc_filename)
+          construct_file(File.join(dir, inc_filename))
         elsif line.start_with?('.define')
+          raise "can't define variable within macro" if @reading_macro
+
           args = line.split(' ')
           key = "#{args[1]}"
-          val = args[2..-1].join(' ').split(';').first.strip.chomp
+          raw_val = args[2..-1].join(' ').split(';').first
+          raise "Missing value for : #{key}" if raw_val.nil?
+
+          val = raw_val.strip.chomp
 
           raise "Already defined: #{key}" unless @define_registry[key].nil?
           @define_registry[key] = val
+        elsif line.start_with?('.call')
+          raise "can't call macro within macro" if @reading_macro
+
+          args = line.split(' ')
+          macro_name = args[1]
+          macro_args = args[2..-1].join.split(',')
+          call_macro(macro_name, macro_args, line_no + 1)
+        elsif line.start_with?('.macro')
+          raise "can't have nested macro" if @reading_macro
+
+          args = line.split(' ')
+          macro_name = args[1]
+          macro_args = args[2..-1].join.split(',')
+          init_macro(macro_name, macro_args)
         else
           new_line = replace_define(line)
+          line_info = { line: new_line, orig_line: line, line_no: line_no + 1, filename: filename }
 
-          @file[SecureRandom.uuid] = { line: new_line, orig_line: line, line_no: line_no + 1, filename: filename }
+          if @reading_macro
+            line.start_with?('.endm') ? save_macro : @current_macro[:lines] << line_info
+          else
+            @file << line_info
+          end
         end
       end
+    end
 
+    def init_macro(name, args)
+      @current_macro = { name: name, args: args, lines: [] }
+      @reading_macro = true
+    end
+
+    def save_macro
+      name = @current_macro[:name]
+      raise "macro `#{name}` already defined" unless @macros_registry[name].nil?
+      @macros_registry[name] = @current_macro
+      @reading_macro = false
+    end
+
+    def call_macro(name, raw_args, line_no)
+      macro = @macros_registry[name]
+      uuid = SecureRandom.uuid
+      raise "line #{line_no}: call of undefined macro `#{name}`" if macro.nil?
+
+      args_names = @macros_registry[name][:args]
+      if args_names.count != raw_args.count
+        raise "line #{line_no}: wrong number of arguments for macro `#{name}` expected : #{args_names.count}, given: #{raw_args.count}"
+      end
+      args = {}
+      args_names.count.times do |i|
+        args[args_names[i]] = raw_args[i]
+      end
+
+      macro[:lines].each_with_index do |line_info|
+        line = line_info[:line]
+
+        if line.include?('%')
+          # replace variable with arg
+          matches = line.match(/%(\w+)%?/)
+          if matches[1] == 'MACRO_ID'
+            value = uuid.delete('-')
+          else
+            value = args[matches[1]]
+          end
+          raise "line #{line_no}: undefined variable `#{matches[1]}` for macro `#{name}`" if value.nil?
+          replaced_line = line.gsub(/#{matches[0]}/, value)
+          @file << line_info.merge(line: replace_define(replaced_line))
+        else
+          @file << line_info
+        end
+      end
     end
 
     def replace_define(line)
+      # TODO also support multiple define on same line
+      # hint : generalize replace_eval_label ?
       found = nil
 
       @define_registry.keys.each do |key|
@@ -77,17 +156,16 @@ module SnesUtils
         end
       end
 
-
       return line if found.nil?
 
       val = @define_registry[found]
 
-      line.gsub(/\b#{found}/, val)
+      line.gsub(/\b#{found}\b/, val)
     end
 
     def assemble_file(pass)
-      @file.each do |key, val|
-        @line = val[:line]
+      @file.each do |line|
+        @line = line[:line]
 
         if @line.include?(':')
           arr = @line.split(':')
@@ -95,7 +173,7 @@ module SnesUtils
           unless /^\w+$/ =~ label
             raise "Invalid label: #{label}"
           end
-          register_label(label) if pass == 0
+          register_label(label, pass) # if pass == 0
           next unless arr[1]
           instruction = arr[1].strip.chomp
         else
@@ -105,14 +183,14 @@ module SnesUtils
         next if instruction.empty?
 
         if instruction.start_with?(*DIRECTIVE)
-          process_directive(instruction, pass)
+          process_directive(instruction, pass, line)
           next
         end
 
         begin
           bytes = LineAssembler.new(instruction, **options).assemble
         rescue => e
-          puts "Error at line #{val[:filename]}##{val[:line_no]} - (#{val[:orig_line]}) : #{e}"
+          puts "Error at line #{line[:filename]}##{line[:line_no]} - (#{line[:orig_line]}) : #{e}"
           exit(1)
         end
 
@@ -121,9 +199,14 @@ module SnesUtils
       end
     end
 
-    def register_label(label)
-      raise "Label already defined: #{label}" if @label_registry.detect { |l| l[0] == label }
-      @label_registry << [label, @program_counter + @origin]
+    def register_label(label, pass)
+      if pass == 0
+        raise "Label already defined: #{label}" if @label_registry.detect { |l| l[0] == label }
+        @label_registry << [label, @program_counter + @origin]
+      else
+        index = @label_registry.index { |l| l[0] == label }
+        @label_registry[index][1] = @program_counter + @origin
+      end
     end
 
     def insert(bytes, insert_at = insert_index)
@@ -134,7 +217,12 @@ module SnesUtils
       @program_counter + @base
     end
 
-    def write(filename = 'out.smc')
+    def write(filename)
+      if filename.nil?
+        dir = File.dirname(@filename)
+        filename = File.join(dir, 'out.sfc')
+      end
+
       File.open(filename, 'w+b') do |file|
         file.write([@memory.map { |i| Vas::hex(i) }.join].pack('H*'))
       end
@@ -155,7 +243,7 @@ module SnesUtils
       }
     end
 
-    def process_directive(instruction, pass)
+    def process_directive(instruction, pass, line_info)
       directive = instruction.split(' ')
 
       case directive[0]
@@ -163,21 +251,54 @@ module SnesUtils
         @cpu = WDC65816
       when '.spc700'
         @cpu = SPC700
+      when '.superfx'
+        @cpu = SUPERFX
       when '.org'
         update_origin(directive[1].to_i(16))
       when '.base'
         @base = directive[1].to_i(16)
       when '.incbin'
-        @program_counter += prepare_incbin(directive[1].to_s.strip.chomp, pass)
+        inc_filename = directive[1].to_s.strip.chomp
+        dir = File.dirname(line_info[:filename])
+        @program_counter += prepare_incbin(File.join(dir, inc_filename), pass)
       when '.db'
         raw_line = directive[1..-1].join.to_s.strip.chomp
         line = LineAssembler.new(raw_line, **options).replace_labels(raw_line)
 
         @program_counter += define_bytes(line, pass)
       when '.rb'
-        @program_counter += directive[1].to_i(16)
-      when '.define'
-        # TODO
+        arg = directive[1..-1].join
+
+        count = self.class.replace_eval_label(@label_registry, arg)
+        @program_counter += count.is_a?(String) ? count.to_i(16) : count
+      end
+    end
+
+    def self.replace_eval_label(registry, arg)
+      return arg unless matches = /({(.*)})(w)?$/.match(arg)
+
+      found = {}
+
+      registry.each do |key, val|
+        if arg.match(/\b#{key}\b/)
+          found[key] = val
+        end
+      end
+
+      return arg.to_i(16) if found.empty?
+
+      new_arg = matches[2]
+
+      found.each do |key, val|
+        new_arg = new_arg.gsub(/\b#{key}\b/, val.to_s)
+      end
+
+      if matches[3] == 'w'
+        res = eval(new_arg).to_s(16).rjust(4, '0')[-4..-1]
+        arg[0..-2].gsub(matches[1], res)
+      else
+        res = eval(new_arg).to_s(16).rjust(2, '0')[-2..-1]
+        arg.gsub(matches[1], res)
       end
     end
 
@@ -230,7 +351,13 @@ module SnesUtils
     def write_label_registry
       longest = @label_registry.map{|r| r[0] }.max_by(&:length)
 
-      File.open('labels.txt', 'w+b') do |file|
+      if @outfile.nil?
+        dir = File.dirname(@filename)
+      else
+        dir = File.dirname(@outfile)
+      end
+
+      File.open(File.join(dir, 'labels.txt'), 'w+b') do |file|
         @label_registry.each do |label|
           adjusted_label = label[0].ljust(longest.length, ' ')
           raw_address = Vas::hex(label[1], 6)
@@ -238,6 +365,21 @@ module SnesUtils
           file.write "#{adjusted_label} #{address}\n"
         end
       end
+      File.open(File.join(dir, 'labels.msl'), 'w+b') do |file|
+        @label_registry.each do |label|
+          if label[1] >= 0x7e0000 && label[1] <= 0x7fffff
+            bank = label[1] & 0xff0000
+            address = "WORK:#{Vas::hex(label[1] - bank)}:#{label[0]}:"
+          else
+            bank = label[1] & 0xff0000
+            bank_i = bank >> 16 & 0xf
+            # low rom only for now
+            prg_addr = label[1] - bank - 0x8000 + bank_i * 0x8000
+            address = "PRG:#{Vas::hex(prg_addr)}:#{label[0]}:"
+          end
+          file.write "#{address}\n"
+        end
+      end
     end
   end
 
@@ -254,10 +396,11 @@ module SnesUtils
       mnemonic = instruction[0].upcase
       raw_operand = instruction[1].to_s
 
-      raw_operand = replace_label(raw_operand)
+      raw_operand = Vas.replace_eval_label(@label_registry, raw_operand)
+      raw_operand = replace_label(raw_operand).downcase # TODO -> generalize replace_label_eval
 
       opcode_data = detect_opcode(mnemonic, raw_operand)
-      raise "Invalid syntax" unless opcode_data
+      raise "Invalid syntax #{@line}" unless opcode_data
 
       opcode = opcode_data[:opcode]
       @mode = opcode_data[:mode]
@@ -265,6 +408,8 @@ module SnesUtils
 
       operand_data = detect_operand(raw_operand)
 
+      return process_fx_instruction(opcode_data, operand_data) if special_fx_instruction?(opcode_data[:alt])
+
       operand = process_operand(operand_data)
 
       return [opcode, *operand]
@@ -304,7 +449,7 @@ module SnesUtils
         value = value & 0x00ffff
         new_value = Vas::hex(value, 4)
       when '!'
-        value = value | (((@current_address >> 16) & 0xff) << 16)
+        value = value # | (((@current_address >> 16) & 0xff) << 16) # BUG HERE
         new_value = Vas::hex(value, 6)
       when '<'
         value = value & 0x0000ff
@@ -344,6 +489,48 @@ module SnesUtils
       end
     end
 
+    def process_fx_instruction(opcode_data, operand_data)
+      alt = opcode_data[:alt]
+
+      return [alt, opcode_data[:opcode]].compact if @mode == :imp
+
+      if fx_mov_instruction?
+        reg1 = operand_data[1].to_i(10)
+        raise "Invalid register R#{reg1}" if reg1 > 15
+        reg2 = operand_data[2].to_i(10)
+        raise "Invalid register R#{reg2}" if reg2 > 15
+
+        raw_opcode = opcode_data[:opcode]
+        tmp_opcode = raw_opcode | (reg2 << 8) | reg1
+        opcode = [((tmp_opcode >> 8) & 0xff), ((tmp_opcode >> 0) & 0xff)]
+
+        operand = nil
+      else
+        base = @mode == :imm4 ? 16 : 10
+        index = inverted_dest_instruction? ? 2 : 1
+
+        opcode_suffix = operand_data[index].to_i(base)
+        opcode_prefix = opcode_data[:opcode]
+        opcode = (opcode_prefix << 4) | opcode_suffix
+
+        operand = process_fx_operand(operand_data, alt.nil? ? 0 : 1)
+      end
+
+      [alt, *opcode, *operand].compact
+    end
+
+    def process_fx_operand(operand_data, alt)
+      return unless double_operand_instruction?
+
+      index = inverted_dest_instruction? ? 1 : 2
+      operand = operand_data[index]&.to_i(16)
+
+      raise 'Invalid address, must be multiple of 2' if short_addr_instruction? && operand.odd?
+      operand /= 2 if short_addr_instruction?
+
+      little_endian(operand, @length - 1 - alt)
+    end
+
     def process_double_operand_instruction(operand_data)
       if bit_instruction?
         process_bit_operand(operand_data)
@@ -379,7 +566,6 @@ module SnesUtils
         relative_addr += 0x100 if relative_addr < 0
         relative_addr
       end
-
     end
 
     def little_endian(operand, length)
@@ -403,5 +589,21 @@ module SnesUtils
     def rel_instruction?
       SnesUtils.const_get(@cpu.capitalize)::Definitions::REL_INSTRUCTIONS.include?(@mode)
     end
+
+    def special_fx_instruction?(alt)
+      @cpu == Vas::SUPERFX && (SnesUtils.const_get(@cpu.capitalize)::Definitions::SFX_INSTRUCTIONS.include?(@mode) || !alt.nil?)
+    end
+
+    def fx_mov_instruction?
+      @cpu == Vas::SUPERFX && SnesUtils.const_get(@cpu.capitalize)::Definitions::MOV_INSTRUCTIONS.include?(@mode)
+    end
+
+    def short_addr_instruction?
+      @cpu == Vas::SUPERFX && SnesUtils.const_get(@cpu.capitalize)::Definitions::SHORT_ADDR_INSTRUCTIONS.include?(@mode)
+    end
+
+    def inverted_dest_instruction?
+      @cpu == Vas::SUPERFX && SnesUtils.const_get(@cpu.capitalize)::Definitions::INV_DEST_INSTRUCTIONS.include?(@mode)
+    end
   end
 end

data/spec/mini_assembler_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+require 'snes_utils'
+
+describe SnesUtils::MiniAssembler do
+  let(:mini_asm) { SnesUtils::MiniAssembler.new }
+
+  describe '#parse_address' do
+    subject { mini_asm.parse_address(line) }
+
+    context 'when address is given' do
+      let(:line) { '300: lda #$12' }
+
+      it 'returns the address given' do
+        expect(subject).to eq(0x300)
+      end
+    end
+
+    context 'when address is implied' do
+      let(:line) { 'lda #$12' }
+
+      it 'returns the current address' do
+        expect(subject).to eq(0)
+      end
+    end
+  end
+
+  describe '#parse_instruction' do
+    subject { mini_asm.parse_instruction(line) }
+    context 'imm8' do
+      let(:line) { 'ora #17' }
+
+      it do
+        expect(subject).to eq [['09', '17'], 2, 0]
+      end
+    end
+
+    context 'abs' do
+      let(:line) { 'lda $1234' }
+
+      it do
+        expect(subject).to eq [['AD','34','12'], 3, 0]
+      end
+    end
+
+    context 'imp' do
+      let(:line) { '300:xce' }
+
+      it do
+        expect(subject).to eq [['FB'], 1, 0x300]
+      end
+    end
+
+    context 'idly' do
+      let(:line) { 'ADC [$12],Y' }
+
+      it do
+        expect(subject).to eq [['77', '12'], 2, 0]
+      end
+    end
+
+    context 'bm' do
+      let(:line) { 'MVN $12,$34' }
+
+      it do
+        expect(subject).to eq [['54', '34', '12'], 3, 0]
+      end
+    end
+
+    describe 'relative addressing' do
+      context '8 bit rel postivie' do
+        let(:line) { '300:BMI 305' }
+
+        it { expect(subject).to eq [['30', '03'], 2, 0x300] }
+      end
+
+      context '8 bit rel negative' do
+        let(:line) { '30a:bcc 300' }
+
+        it { expect(subject).to eq [['90', 'F4'], 2, 0x30a] }
+      end
+
+      context '16 bit rel postivie' do
+        let(:line) { '304:BRL $03A0' }
+
+        it { expect(subject).to eq [['82', '99', '00'], 3, 0x304] }
+      end
+
+      context '16 bit rel negative' do
+        let(:line) { '3bf:per 37a' }
+
+        it { expect(subject).to eq [['62', 'B8', 'FF'], 3, 0x3bf] }
+      end
+    end
+  end
+
+  describe '#disassemble_range' do
+    subject { mini_asm.disassemble_range(0, count) }
+
+    let(:count) { 1 }
+
+    before { mini_asm.instance_variable_set(:@memory, memory) }
+
+    context 'when cpu is 65816' do
+      let(:memory) { ['82', '99', '00'] }
+
+      it { expect(subject).to eq ['00/0000: 82 99 00              BRL 009C {+0099}'] }
+    end
+
+    context 'when cpu is spc700' do
+      let(:memory) { ['00'] }
+
+      before { mini_asm.instance_variable_set(:@cpu, :spc700) }
+
+      it { expect(subject).to eq ['00/0000: 00                    NOP'] }
+    end
+  end
+
+  describe '#read' do
+    let(:file) { 'spec/fixtures/test.asm' }
+    before { mini_asm.read(file) }
+    let(:memory) do
+      ["A9", "12", "78", "18", "C9", "14", "3A", "D0",
+       "FD", "00", "00", "80", "02", "42", "12", "AD",
+       "34", "12", "80", "F2", nil,  nil,  nil,  nil,
+       nil,  nil,  nil,  nil,  nil,  nil,  nil,  nil,
+       "E4", "12", "4F", "12", "50", "FC", "53", "12",
+       "F9",  "FA", "22", "11",  nil,  nil,  nil,  nil,
+       "11", "22", "33", "44", "55", "66", "77", "88",
+       "DE", "AF", "FA", "CE", "DE", "CA", "FE", "12"]
+    end
+
+    it 'sets memory correctly' do
+      expect(mini_asm.instance_variable_get(:@memory)).to eq memory
+    end
+  end
+end