n65 0.5.0 → 1.0.0

data/spec/lib/n65/symbol_table_spec.rb

@@ -0,0 +1,291 @@
+# frozen_string_literal: true
+
+require_relative '../../../lib/n65'
+require_relative '../../../lib/n65/symbol_table'
+
+RSpec.describe(N65::SymbolTable) do
+  subject { described_class.new }
+
+  context 'when defining a global symbol' do
+    before { subject.define_symbol('dog', 'woof') }
+
+    it 'can resolve the value' do
+      expect(subject.resolve_symbol('dog')).to eq('woof')
+    end
+  end
+
+  context 'when entering a sub-scope' do
+    before do
+      subject.enter_scope('animals')
+      subject.define_symbol('dog', 'woof')
+    end
+
+    it 'can resolve the value' do
+      expect(subject.resolve_symbol('dog')).to eq('woof')
+    end
+
+    it 'can resolve the value with full dot syntax' do
+      expect(subject.resolve_symbol('animals.dog')).to eq('woof')
+    end
+  end
+
+  context 'when accessing a symbol at higher scope' do
+    before do
+      subject.enter_scope('outer')
+      subject.define_symbol('dog', 'woof')
+      subject.enter_scope('inner')
+      subject.define_symbol('pig', 'oink')
+    end
+
+    it 'can resolve the outer value without dot syntax' do
+      expect(subject.resolve_symbol('dog')).to eq('woof')
+    end
+
+    it 'can resolve the value in current scope' do
+      expect(subject.resolve_symbol('pig')).to eq('oink')
+    end
+  end
+
+  context 'when a symbol from an outer scope is shadowed' do
+    before do
+      subject.enter_scope('outer')
+      subject.define_symbol('dog', 'woof')
+      subject.enter_scope('inner')
+      subject.define_symbol('dog', 'bark')
+    end
+
+    it 'the inner scope shadows the outer' do
+      expect(subject.resolve_symbol('dog')).to eq('bark')
+    end
+
+    it 'does not shadow it when we leave the inner scope' do
+      subject.exit_scope
+      expect(subject.resolve_symbol('dog')).to eq('woof')
+    end
+
+    it 'can access inner via dot syntax if we exit both scopes' do
+      subject.exit_scope
+      subject.exit_scope
+      expect(subject.resolve_symbol('outer.inner.dog')).to eq('bark')
+    end
+  end
+
+  context 'when trying to access a symbol not in scope' do
+    before do
+      subject.enter_scope('animals')
+      subject.define_symbol('dog', 'woof')
+      subject.exit_scope
+    end
+
+    it 'is undefined' do
+      expect { subject.resolve_symbol('dog') }.to raise_error(described_class::UndefinedSymbol)
+    end
+  end
+
+  context 'when trying to access a symbol not in scope' do
+    before do
+      subject.enter_scope('animals')
+      subject.define_symbol('dog', 'woof')
+      subject.exit_scope
+    end
+
+    it 'can be accessed by full path' do
+      expect(subject.resolve_symbol('animals.dog')).to eq('woof')
+    end
+  end
+
+  context 'when we have two symbols with the same name in different scopes' do
+    before do
+      subject.define_symbol('dog', 'woof')
+      subject.enter_scope('animals')
+      subject.define_symbol('dog', 'woof woof')
+      subject.exit_scope
+    end
+
+    it 'can access each by full path' do
+      expect(subject.resolve_symbol('dog')).to eq('woof')
+    end
+
+    it 'can access each by full path' do
+      expect(subject.resolve_symbol('animals.dog')).to eq('woof woof')
+    end
+  end
+
+  context 'when trying to access symbols at top scope' do
+    before do
+      subject.define_symbol('dog', 'woof')
+      subject.enter_scope('animals')
+      subject.define_symbol('dog', 'woof woof')
+    end
+
+    it 'can use the global prefix' do
+      expect(subject.resolve_symbol('global.dog')).to eq('woof')
+    end
+  end
+
+  context 'when creating an anonymous scope' do
+    before do
+      subject.define_symbol('dog', 'woof')
+      subject.enter_scope
+      subject.define_symbol('dog', 'woof woof')
+    end
+
+    it 'gets the value in the current anonymous scope' do
+      expect(subject.resolve_symbol('dog')).to eq('woof woof')
+    end
+
+    it 'can get the outer dog by dot syntax' do
+      expect(subject.resolve_symbol('global.dog')).to eq('woof')
+    end
+
+    it 'can get the outer dog by exiting anonymous scope and resolving' do
+      subject.exit_scope
+      expect(subject.resolve_symbol('dog')).to eq('woof')
+    end
+  end
+
+  context 'when trying to exit the top most scope' do
+    it 'raises an error' do
+      expect { subject.exit_scope }.to raise_error(described_class::CantExitScope)
+    end
+  end
+
+  context 'when checking the address value of a scope' do
+    let(:assembler) { N65::Assembler.new }
+    let(:program) do
+      <<~'ASM'
+        .ines {"prog": 1, "char": 0, "mapper": 0, "mirror": 0}
+        .org $8000
+        .segment prog 0
+        .scope main
+          sei
+          cld
+          lda #$00
+          jmp main
+        .
+        jmp main
+        jmp global.main
+      ASM
+    end
+
+    before { assembler.assemble_string(program) }
+
+    it 'assigns the value of the scope main to the program counter value' do
+      expect(assembler.symbol_table.resolve_symbol('global.main')).to eq(0x8000)
+    end
+  end
+
+  context 'when we try to jump to a forward declared symbol' do
+    let(:assembler) { N65::Assembler.new }
+    let(:program) do
+      <<~'ASM'
+        .ines {"prog": 1, "char": 0, "mapper": 0, "mirror": 0}
+        .org $8000
+        .scope main
+          sei
+          cld
+          lda #$00
+          bne forward_symbol
+          nop
+          nop
+          nop
+          forward_symbol:
+          rts
+        .
+      ASM
+    end
+    let(:correct_binary) do
+      [
+        0x78,        # SEI
+        0xd8,        # CLD
+        0xa9, 0x0,   # LDA immediate 0
+        0xd0, 0x3,   # BNE +3
+        0xea,        # NOP
+        0xea,        # NOP
+        0xea,        # NOP
+        0x60         # RTS
+      ]
+    end
+    let(:emitted_rom) { assembler.emit_binary_rom.bytes[16...26] }
+
+    before { assembler.assemble_string(program) }
+
+    it 'assembles the branch to forward_symbol correctly' do
+      expect(emitted_rom).to eq(correct_binary)
+    end
+  end
+
+  context 'when setting a symbols value' do
+    before do
+      subject.define_symbol('variable', 0xff)
+    end
+
+    it 'can resolve to that value' do
+      expect(subject.resolve_symbol('variable')).to eq(0xff)
+    end
+  end
+
+  context 'when performing artithmetic on a symbol' do
+    before do
+      subject.define_symbol('variable', 0x20)
+    end
+
+    it 'can perform addition on the symbol' do
+      expect(subject.resolve_symbol('variable+1')).to eq(0x21)
+    end
+
+    it 'can perform subtraction on the symbol' do
+      expect(subject.resolve_symbol('variable-16')).to eq(0x10)
+    end
+
+    it 'can perform multiplication on the symbol' do
+      expect(subject.resolve_symbol('variable*2')).to eq(0x40)
+    end
+
+    it 'can perform division on the symbol' do
+      expect(subject.resolve_symbol('variable/2')).to eq(0x10)
+    end
+  end
+
+  context 'when performing arithmetic on a scope struct' do
+    let(:assembler) { N65::Assembler.new }
+    let(:program) do
+      <<~'ASM'
+        .ines {"prog": 1, "char": 0, "mapper": 0, "mirror": 0}
+
+        .org $0020
+        .scope struct
+          .space a 1
+          .space b 1
+        .
+
+        .org $8000
+        .scope main
+          sei
+          cld
+          lda struct+1 zp
+          lda struct*2 zp
+          rts
+        .
+      ASM
+    end
+    let(:emitted_rom) { assembler.emit_binary_rom.bytes[16...23] }
+    let(:correct_binary) do
+      [
+        0x78,         #  sei
+        0xd8,         #  cld
+        0xa5,         #  lda
+        0x21,         #  $20 + 1
+        0xa5,         #  lda
+        0x40,         #  $20 * 2
+        0x60          #  rts
+      ]
+    end
+
+    before { assembler.assemble_string(program) }
+
+    it 'assembles the symbol arithmetic correctly' do
+      expect(emitted_rom).to eq(correct_binary)
+    end
+  end
+end

data/utils/opcode_table_to_yaml.rb

@@ -1,91 +1,89 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-###############################################################################
-##  http://www.6502.org/tutorials/6502opcodes.html
-##  This web page has information about each and every 6502 instruction
-##  Specifically: 
-##
-##  - Description of what each of the instructions do
-##  - Which modes are supported by which instructions, immediate, zero page
-##    zero page x, and y, absolute, indirect, relative etc.
-##  - The hex codes each instruction assembles to, in each mode.
-##  - The lengths in bytes of each instruction, by mode
-##  - The possibly variable number of cycles each instruction takes.
-##
-##  There are 56 of them, and in my programmer laziness I just wrote this
-##  script to parse the page into the data structure that you see in 
-##  opcodes.yaml.  This really helped in creating the assembler, and
-##  it had basically everything I needed to know, and sped up writing
-##  this by huge factor.  So, yay to this page, and this script!
+##############################################################################
+# From http://www.6502.org/tutorials/6502opcodes.html
+# This web page has information about each and every 6502 instruction
+# Specifically:
+#
+# - Description of what each of the instructions do
+# - Which modes are supported by which instructions, immediate, zero page
+#   zero page x, and y, absolute, indirect, relative etc.
+# - The hex codes each instruction assembles to, in each mode.
+# - The lengths in bytes of each instruction, by mode
+# - The possibly variable number of cycles each instruction takes.
+#
+# There are 56 of them, and in my programmer laziness I just wrote this
+# script to parse the page into the data structure that you see in
+# opcodes.yaml.  This really helped in creating the assembler, and
+# it had basically everything I needed to know, and sped up writing
+# this by huge factor.  So, yay to this page, and this script!
 
 require 'yaml'
 
-##  Instruction name, and output structure to fill in.
+# Instruction name, and output structure to fill in.
 name = :adc
-output = {name => {}}
+output = { name: {} }
 
-##  Copy paste the tables from that website into this heredoc:
-text =<<-TEXT
-Immediate     ADC #$44      $69  2   2
-Zero Page     ADC $44       $65  2   3
-Zero Page,X   ADC $44,X     $75  2   4
-Absolute      ADC $4400     $6D  3   4
-Absolute,X    ADC $4400,X   $7D  3   4+
-Absolute,Y    ADC $4400,Y   $79  3   4+
-Indirect,X    ADC ($44,X)   $61  2   6
-Indirect,Y    ADC ($44),Y   $71  2   5+
+# Copy paste the tables from that website into this heredoc:
+text = <<~'TEXT'
+  Immediate     ADC #$44      $69  2   2
+  Zero Page     ADC $44       $65  2   3
+  Zero Page,X   ADC $44,X     $75  2   4
+  Absolute      ADC $4400     $6D  3   4
+  Absolute,X    ADC $4400,X   $7D  3   4+
+  Absolute,Y    ADC $4400,Y   $79  3   4+
+  Indirect,X    ADC ($44,X)   $61  2   6
+  Indirect,Y    ADC ($44),Y   $71  2   5+
 TEXT
 
-
-##  And now iterate over each line to extract the info
+# And now iterate over each line to extract the info
 lines = text.split(/\n/)
 lines.each do |line|
-
-  ##  Grab out the values we care about
+  # Grab out the values we care about
   parts = line.split
   cycles, len, hex = parts[-1], parts[-2], parts[-3]
-  hex = "0x%X" % hex.gsub('$', '').to_i(16)
+  hex = format('0x%X', hex.gsub('$', '').to_i(16))
 
   match_data = cycles.match(/([0-9]+)(\+?)/)
   cycles = match_data[1]
   boundary = match_data[2]
-  hash = {:hex => hex, :len => len, :cycles => cycles, :boundry_add => boundary != ""}
+  hash = { hex: hex, len: len, cycles: cycles, boundry_add: boundary != '' }
 
-  ##  And now decide which mode the line belongs to, collecting each listed mode
+  # And now decide which mode the line belongs to, collecting each listed mode
   hash = case line
-  when /^Accumulator/
-    {:accumulator => hash}
-  when /^Immediate/
-    {:immediate => hash}
-  when /^Zero Page,X/
-    {:zero_page_x => hash}
-  when /^Zero Page,Y/
-    {:zero_page_y => hash}
-  when /^Zero Page/
-    {:zero_page => hash}
-  when /^Absolute,X/
-    {:absolute_x => hash}
-  when /^Absolute,Y/
-    {:absolute_y => hash}
-  when /^Absolute/
-    {:absolute => hash}
-  when /^Indirect,X/
-    {:indirect_x => hash}
-  when /^Indirect,Y/
-    {:indirect_y => hash}
-  when /^Indirect/
-    {:indirect => hash}
-  when /^Implied/
-    {:implied => hash}
-  else 
-    {}
-  end
+         when /^Accumulator/
+           { accumulator: hash }
+         when /^Immediate/
+           { immediate: hash }
+         when /^Zero Page,X/
+           { zero_page_x: hash }
+         when /^Zero Page,Y/
+           { zero_page_y: hash }
+         when /^Zero Page/
+           { zero_page: hash }
+         when /^Absolute,X/
+           { absolute_x: hash }
+         when /^Absolute,Y/
+           { absolute_y: hash }
+         when /^Absolute/
+           { absolute: hash }
+         when /^Indirect,X/
+           { indirect_x: hash }
+         when /^Indirect,Y/
+           { indirect_y: hash }
+         when /^Indirect/
+           { indirect: hash }
+         when /^Implied/
+           { implied: hash }
+         else
+           {}
+         end
   output[name].merge!(hash)
 end
 
-##  Now output some yaml, and I only had to do this about 45 times
-##  instead of laboriously and mistak-pronely doing it by hand.
+# Now output some yaml, and I only had to do this about 45 times
+# instead of laboriously and mistak-pronely doing it by hand.
 puts YAML.dump(output).gsub("'", '')
 
-##  See opcodes.yaml
-
+# See opcodes.yaml

metadata

@@ -1,44 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: n65
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Safiire
-autorequire: 
 bindir: bin
-cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEijCCAvKgAwIBAgIBATANBgkqhkiG9w0BAQsFADBFMRAwDgYDVQQDDAdzYWZp
+  aXJlMRwwGgYKCZImiZPyLGQBGRYMaXJrZW5raXR0aWVzMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTI2MDczMTIyMzIyN1oXDTI3MDczMTIyMzIyN1owRTEQMA4GA1UE
+  AwwHc2FmaWlyZTEcMBoGCgmSJomT8ixkARkWDGlya2Vua2l0dGllczETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAM0L
+  DaMnUQ6jVoPfLrU3xznh53NKFHxK7fuCzn8T4fe8NysBpTaDpMVdDGMjUyMZ7dIH
+  ufJwC2twDfcX1i95U8xy8g9Pymec9l6huwcu8gZjCwwv4sGejsJBh3w/mrfIAG0d
+  iORSnGl9dU+JfFC8fKdMnVNhS4DoXhwpvtwTyZz8S83b3A85nd4ArcLIRu87jt3R
+  PSg3VChmr19RQemPq9tMOrVRaaV1dCF48pcchFTh4nSuTZorAWI1LMmbod3X0L4c
+  NLKhSy8409BuC8MzQW/Poi5AGju9nhu7wXSpyCjzc/iOKR4OBsxwWc1OSTAhEN+P
+  CbImbFyqnyOi170ZqJsAxIkIRRJ7gHcbjCTtLzlLBhM4EMi1IDXrg+d1Wo8HCOPU
+  FGye9mJ6hYDN99+ei6ODhBnVmmPW1KhqoRuhaZIakXn0v2k+/MLFPDdhSyDe4ina
+  QwnB2xtzzhDsQhGZkqYtwq1CtCtZLb9jxbkcb2FZxwZU1Fga+ft0RaU209syGQID
+  AQABo4GEMIGBMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBTLktC6
+  gboWK+oVAacBV/TuMNhc6TAjBgNVHREEHDAagRhzYWZpaXJlQGlya2Vua2l0dGll
+  cy5jb20wIwYDVR0SBBwwGoEYc2FmaWlyZUBpcmtlbmtpdHRpZXMuY29tMA0GCSqG
+  SIb3DQEBCwUAA4IBgQC5ZnrbrUIMVIeq2Xpn1MrhmZlD0Bl6BTTb4tjO8AMod8AY
+  9bmBCfzXBNwF0prPvrwaZ6eTnLgPeByNHhXO7HcaQTZhyTOZdhUJ4YQjFO+emf5B
+  0WSsB1nU+vc0P+T0vdCxhpFfze0pXuAfef/hnLaFsTWvSZv0CBNSirtGSfdvGEYZ
+  YLA4bSs/HxL1NGlPaS/gSQic5BQapTH+Dy2iV0o45WXpdtSdJS9c9wPe3N1wi99U
+  rOl0/s70mlMRZZK4C06ioiWpOxANxZZQZ9AgaCh04NkVvx9iCoNrXktMlwBQBsUm
+  25TerYzsddkZm0rETJy9WebcdzbPHyr3EvXBbEsEa4yAKIrgndfo5lJmf4rFhZK3
+  lewUuIe+L/6Z/OHQO6v9yZ0i2ZZrGm/F/l/gDNWyPoWjmYhCb2SeL8je3QKkbv0V
+  yXnUU4CUd3nGqZ+O+K5FDHxyhZ+bVXB8KWm7VLsPEC1kPdYIOj3gNhjY0FNuwpex
+  cOU2xo9QjOzgxd3rzy4=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: An NES assembler for the 6502 microprocessor written in Ruby
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An NES assembler for the 6502 microprocessor in pure Ruby
 email:
 - safiire@irkenkitties.com
 executables:
@@ -46,20 +101,23 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/n65
 - data/opcodes.yaml
+- everdrive_transfer/everdrive.rb
 - examples/beep.asm
 - examples/demo.asm
 - examples/mario2.asm
 - examples/mario2.char
-- examples/music_driver.asm
 - examples/noise.asm
 - examples/pulse_chord.asm
+- examples/scales.asm
 - images/assembler_demo.png
 - lib/n65.rb
 - lib/n65/directives/ascii.rb
@@ -85,30 +143,15 @@ files:
 - lib/n65/version.rb
 - n65.gemspec
 - nes_lib/nes.sym
-- test/test_memory_space.rb
-- test/test_symbol_table.rb
-- utils/midi/Makefile
-- utils/midi/c_scale.mid
-- utils/midi/convert
-- utils/midi/guitar.mid
-- utils/midi/include/event.h
-- utils/midi/include/file.h
-- utils/midi/include/helpers.h
-- utils/midi/include/track.h
-- utils/midi/lil_melody.mid
-- utils/midi/mi_feabhra.mid
-- utils/midi/midi_to_nes.rb
-- utils/midi/source/convert.cpp
-- utils/midi/source/event.cpp
-- utils/midi/source/file.cpp
-- utils/midi/source/helpers.cpp
-- utils/midi/source/track.cpp
+- spec/.rubocop.yml
+- spec/assembler_spec.rb
+- spec/lib/n65/memory_space_spec.rb
+- spec/lib/n65/symbol_table_spec.rb
 - utils/opcode_table_to_yaml.rb
 homepage: http://github.com/safiire/n65
 licenses:
-- GPL2
+- GPL-2.0-or-later
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,18 +159,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 4.0.4
 specification_version: 4
-summary: An NES assembler for the 6502 microprocessor written in Ruby
+summary: An NES assembler for the 6502 microprocessor
 test_files:
-- test/test_memory_space.rb
-- test/test_symbol_table.rb
+- spec/.rubocop.yml
+- spec/assembler_spec.rb
+- spec/lib/n65/memory_space_spec.rb
+- spec/lib/n65/symbol_table_spec.rb