n65 0.5.0 → 1.0.0

data/lib/n65/directives/exit_scope.rb

@@ -1,35 +1,25 @@
+# frozen_string_literal: true
+
 require_relative '../instruction_base'
 
 module N65
-
-
-  ####
-  ##  This directive to include bytes
+  # This directive to include bytes
   class ExitScope < InstructionBase
-
-
-    ####
-    ##  Try to parse an incbin directive
     def self.parse(line)
       match_data = line.match(/^\.$/)
       return nil if match_data.nil?
+
       ExitScope.new
     end
 
-
-    ####
-    ##  Execute on the assembler
+    # Execute on the assembler
     def exec(assembler)
       assembler.symbol_table.exit_scope
     end
 
-
-    ####
-    ##  Display
+    # Display
     def to_s
-      "."
+      '.'
     end
-
   end
-
 end

data/lib/n65/directives/inc.rb

@@ -1,67 +1,51 @@
+# frozen_string_literal: true
+
 require_relative '../instruction_base'
 
 module N65
-
-
-  ####
-  ##  This directive instruction can include another asm file
+  # This directive instruction can include another asm file
   class Inc < InstructionBase
+    SYSTEM_INCLUDE = "#{File.dirname(__FILE__)}/../../../nes_lib"
 
-    ####  System include directory
-    SystemInclude = File.dirname(__FILE__) + "/../../../nes_lib"
-
-    ####  Custom Exceptions
     class FileNotFound < StandardError; end
 
-
-    ####
-    ##  Try to parse an incbin directive
+    # Try to parse an incbin directive
     def self.parse(line)
-      ##  Do We have a system directory include?
+      # Do We have a system directory include?
       match_data = line.match(/^\.inc <([^>]+)>$/)
       unless match_data.nil?
-        filename = File.join(SystemInclude, match_data[1])
+        filename = File.join(SYSTEM_INCLUDE, match_data[1])
         return Inc.new(filename)
       end
 
-      ##  Do We have a project relative directory include?
+      # Do We have a project relative directory include?
       match_data = line.match(/^\.inc "([^"]+)"$/)
       unless match_data.nil?
         filename = File.join(Dir.pwd, match_data[1])
         return Inc.new(filename)
       end
 
-      ##  Nope, not an inc directive
+      # Nope, not an inc directive
       nil
     end
 
-
-    ####
-    ##  Initialize with filename
+    # Initialize with filename
     def initialize(filename)
       @filename = filename
     end
 
-
-    ####
-    ##  Execute on the assembler
+    # Execute on the assembler
     def exec(assembler)
-      unless File.exists?(@filename)
-        fail(FileNotFound, ".inc can't find #{@filename}")
-      end
+      raise(FileNotFound, ".inc can't find #{@filename}") unless File.exist?(@filename)
+
       File.read(@filename).split(/\n/).each do |line|
         assembler.assemble_one_line(line)
       end
     end
 
-
-    ####
-    ##  Display
+    # Display
     def to_s
       ".inc \"#{@filename}\""
     end
-
-
   end
-
 end

data/lib/n65/directives/incbin.rb

@@ -1,51 +1,33 @@
+# frozen_string_literal: true
+
 require_relative '../instruction_base'
 
 module N65
-
-
-  ####
-  ##  This directive instruction can include a binary file
+  # This directive instruction can include a binary file
   class IncBin < InstructionBase
-
-    ####  Custom Exceptions
     class FileNotFound < StandardError; end
 
-
-    ####
-    ##  Try to parse an incbin directive
     def self.parse(line)
       match_data = line.match(/^\.incbin "([^"]+)"$/)
       return nil if match_data.nil?
+
       filename = match_data[1]
       IncBin.new(filename)
     end
 
-
-    ####
-    ##  Initialize with filename
     def initialize(filename)
       @filename = filename
     end
 
-
-    ####
-    ##  Execute on the assembler
     def exec(assembler)
-      unless File.exists?(@filename)
-        fail(FileNotFound, ".incbin can't find #{@filename}")
-      end
+      raise(FileNotFound, ".incbin can't find #{@filename}") unless File.exist?(@filename)
+
       data = File.read(@filename).unpack('C*')
       assembler.write_memory(data)
     end
 
-
-    ####
-    ##  Display
     def to_s
       ".incbin \"#{@filename}\""
     end
-
-
   end
-
 end

data/lib/n65/directives/ines_header.rb

@@ -1,53 +1,92 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative '../instruction_base'
 
 module N65
-
-
-  ####
-  ##  This directive instruction can setup an ines header
   class INESHeader < InstructionBase
-    attr_reader :prog, :char, :mapper, :mirror
+    attr_reader :prog, :char, :mapper, :mirror, :battery_backed, :fourscreen_vram, :prog_ram, :tv
+
+    DEFAULTS = {
+      prog: 1,
+      char: 0,
+      mapper: 0,
+      mirror: 0,
+      battery_backed: 0,
+      fourscreen_vram: 0,
+      prog_ram: 0,
+      tv: 0
+    }.freeze
 
-
-    ####
-    ##  Implementation of the parser for this directive
     def self.parse(line)
       match_data = line.match(/^\.ines (.+)$/)
       return nil if match_data.nil?
 
       header = JSON.parse(match_data[1])
-      INESHeader.new(header['prog'], header['char'], header['mapper'], header['mirror'])
+      header = header.each_with_object({}) do |(key, val), hash|
+        hash[key.to_sym] = val
+      end
+
+      header = DEFAULTS.merge(header)
+
+      INESHeader.new(
+        header[:prog],
+        header[:char],
+        header[:mapper],
+        header[:mirror],
+        header[:battery_backed],
+        header[:fourscreen_vram],
+        header[:prog_ram],
+        header[:tv]
+      )
     end
 
-
-    ####
-    ##  Construct a header
-    def initialize(prog, char, mapper, mirror)
-      @prog, @char, @mapper, @mirror = prog, char, mapper, mirror
+    # Construct a header
+    def initialize(prog, char, mapper, mirror, battery_backed, fourscreen_vram, prog_ram, tv)
+      @prog = prog
+      @char = char
+      @mapper = mapper
+      @mirror = mirror
+      @battery_backed = battery_backed
+      @fourscreen_vram = fourscreen_vram
+      @prog_ram = prog_ram
+      @tv = tv
     end
 
-
-    ####
-    ##  Exec function the assembler will call
+    # Exec function the assembler will call
     def exec(assembler)
       assembler.set_ines_header(self)
     end
 
-
-    ####
-    ##  Emit the header bytes, this is not exactly right, but it works for now.
+    # Emit the header bytes
     def emit_bytes
-      [0x4E, 0x45, 0x53, 0x1a, @prog, @char, @mapper, @mirror, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0]
+      mapper_lo_nybble = (@mapper & 0x0f)
+      mapper_hi_nybble = (@mapper & 0xf0) >> 4
+
+      flag6 = 0
+      flag6 |= 0x1 if @mirror == 1
+      flag6 |= 0x2 if @battery_backed == 1
+      flag6 |= 0x8 if @fourscreen_vram == 1
+      flag6 |= (mapper_lo_nybble << 4)
+
+      flag7 = 0
+      flag7 |= (mapper_hi_nybble << 4)
+
+      [0x4E, 0x45, 0x53, 0x1a,
+       @prog & 0xff,
+       @char & 0xff,
+       flag6 & 0xff,
+       flag7 & 0xff,
+       @prog_ram & 0xff,
+       0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0]
     end
 
-
-    ####
-    ##  Display
+    # Display
     def to_s
-      ".ines {\"prog\": #{@prog}, \"char\": #{@char}, \"mapper\": #{@mapper}, \"mirror\": #{@mirror}}"
+      [".ines {\"prog\": #{@prog}, \"char\": #{@char}, \"mapper\": #{@mapper}, ",
+       "\"mirror\": #{@mirror}}, \"battery_backed\": #{@battery_backed}, ",
+       "\"fourscreen_vram\": #{@fourscreen_vram}, \"prog_ram\": #{@prog_ram}, ",
+       "\"tv\": #{@tv}"].join
     end
-
   end
-
 end

data/lib/n65/directives/label.rb

@@ -1,46 +1,33 @@
+# frozen_string_literal: true
 
 module N65
-
-  ####
-  ##  This class represents a label, and will create 
-  ##  an entry in the symbol table associated with 
-  ##  the address it appears at.
+  # This class represents a label, and will create
+  # an entry in the symbol table associated with
+  # the address it appears at.
   class Label
-
-    ####
-    ##  Try to parse as a label
     def self.parse(line)
       match_data = line.match(/^([a-zA-Z][a-zA-Z0-9_]+):$/)
       unless match_data.nil?
         label = match_data[1].to_sym
-        return self.new(label)
+        return new(label)
       end
       nil
     end
 
-
-    ####
-    ##  Create a new label object
+    # Create a new label object
     def initialize(symbol)
       @symbol = symbol
     end
 
-
-    ####
-    ##  Create an entry in the symbol table for this label
+    # Create an entry in the symbol table for this label
     def exec(assembler)
       program_counter = assembler.program_counter
       assembler.symbol_table.define_symbol(@symbol, program_counter)
     end
 
-
-    ####
-    ##  Display
+    # Display
     def to_s
       "#{@symbol}:"
     end
-
-
   end
-
 end

data/lib/n65/directives/org.rb

@@ -1,47 +1,37 @@
+# frozen_string_literal: true
+
 require_relative '../instruction_base'
 
 module N65
-
-  ####
-  ##  This is an .org directive
+  # This is an .org directive
   class Org < InstructionBase
     attr_reader :address
 
-    ####
-    ##  Try to parse an .org statement
     def self.parse(line)
       match_data = line.match(/^\.org\s+\$([0-9A-Fa-f]{4})$/)
       return nil if match_data.nil?
+
       address = match_data[1].to_i(16)
       Org.new(address)
     end
 
-    
-    ####
-    ##  Initialized with address to switch to
+    # Initialized with address to switch to
     def initialize(address)
       @address = address
     end
 
-
-    ####
-    ##  Exec this directive on the assembler
+    # Exec this directive on the assembler
     def exec(assembler)
       assembler.program_counter = address
     end
 
-
-    ####
-    ##  Display
+    # Display
     def to_s
       if @address <= 0xff
-        ".org $%2.X" % @address
+        '.org $%2.X' % @address
       else
-        ".org $%4.X" % @address
+        '.org $%4.X' % @address
       end
     end
-
   end
-
 end
-

data/lib/n65/directives/segment.rb

@@ -1,13 +1,8 @@
-require_relative '../instruction_base' 
-module N65
-
+# frozen_string_literal: true
 
-  ####
-  ##  This directive instruction can include a binary file
+require_relative '../instruction_base'
+module N65
   class Segment < InstructionBase
-
-    ####
-    ##  Try to parse a dw directive
     def self.parse(line)
       match_data = line.match(/^.segment (prog|char) (\d+)$/i)
       unless match_data.nil?
@@ -17,29 +12,20 @@ module N65
       nil
     end
 
-
-    ####
-    ##  Initialize with filename
+    # Initialize with filename
     def initialize(segment, bank)
       @bank = bank
       @segment = segment
     end
 
-
-    ####
-    ##  Execute the segment and bank change on the assembler
+    # Execute the segment and bank change on the assembler
     def exec(assembler)
       assembler.current_segment = @segment
       assembler.current_bank = @bank
     end
 
-
-    ####
-    ##  Display
     def to_s
       ".segment #{@segment} #{@bank}"
     end
-
   end
-
 end

data/lib/n65/directives/space.rb

@@ -1,46 +1,34 @@
+# frozen_string_literal: true
+
 require_relative '../instruction_base'
 
 module N65
-
-
-  ####
   ##  This directive gives a symbolic name for memory and creates space for a variable in RAM
   class Space < InstructionBase
-
-    ####
-    ##  Try to parse a .space directive
     def self.parse(line)
       match_data = line.match(/^.space\s+([a-zA-Z]?[a-zA-Z0-9_]+?)\s+([0-9]+)$/)
       return nil if match_data.nil?
-      _, name, size = match_data.to_a
 
+      _, name, size = match_data.to_a
       Space.new(name, size.to_i)
     end
 
-
-    ####
-    ##  Initialize some memory space with a name
+    # Initialize some memory space with a name
     def initialize(name, size)
       @name = name
       @size = size
     end
 
-
-    ####
-    ##  .space creates a symbol at the current PC, and then advances PC by size
+    # .space creates a symbol at the current PC, and then advances PC by size
     def exec(assembler)
       program_counter = assembler.program_counter
       assembler.symbol_table.define_symbol(@name, program_counter)
       assembler.program_counter += @size
     end
 
-
-    ####
-    ##  Display
+    # Display
     def to_s
       ".space #{@name} #{@size}"
     end
-
   end
-
 end

data/lib/n65/front_end.rb

@@ -1,81 +1,80 @@
+# frozen_string_literal: true
+
 require 'optparse'
 require_relative '../n65'
 
 module N65
-
-  ####
-  ##  This class handles the front end aspects, 
-  ##  parsing the commandline options and running the assembler
+  # This class handles the front end aspects,
+  # parsing the commandline options and running the assembler
   class FrontEnd
-
-    ####
-    ##  Initialize with ARGV commandline
     def initialize(argv)
-      @options = {:output_file => nil}
+      @options = { output_file: nil, write_symbol_table: false, quiet: false, cycle_count: false }
       @argv = argv.dup
     end
 
-
-    ####
-    ##  Run the assembler
+    # Run the assembler
     def run
-      ##  First use the option parser
       parser = create_option_parser
       parser.parse!(@argv)
 
-      ##  Whatever is leftover in argv the input files
       if @argv.size.zero?
-        STDERR.puts("No input files")
+        warn('No input files')
         exit(1)
       end
 
-      ##  Only can assemble one file at once for now
+      # Only can assemble one file at once for now
       if @argv.size != 1
-        STDERR.puts "Can only assemble one input file at once :("
+        warn('Can only assemble one input file at once, but you can use .inc and .incbin directives')
         exit(1)
       end
 
       input_file = @argv.shift
 
-      ##  Make sure the input file exists
-      unless File.exists?(input_file)
-        STDERR.puts "Input file #{input_file} does not exist"
+      # Make sure the input file exists
+      unless File.exist?(input_file)
+        warn("Input file #{input_file} does not exist")
         exit(1)
       end
-      
-      ##  Maybe they didn't provide an output file name, so we'll guess
+
+      # Maybe they didn't provide an output file name, so we'll guess
       if @options[:output_file].nil?
         ext = File.extname(input_file)
-        @options[:output_file] = input_file.gsub(ext, '') + '.nes'
+        @options[:output_file] = "#{input_file.gsub(ext, '')}.nes"
       end
 
       if @options.values.any?(&:nil?)
-        STDERR.puts "Missing options try --help"
+        warn('Missing options try --help')
         exit(1)
       end
 
-      #begin
-        N65::Assembler.from_file(input_file, @options[:output_file])
-      #rescue StandardError => error
-        #STDERR.puts("Assemble Failed!")
-        #STDERR.puts(error.class)
-        #if error.message
-          #STDERR.puts(error.message)
-        #end
-        #exit(1)
-      #end
+      N65::Assembler.from_file(input_file, @options)
     end
 
     private
 
-    ####
-    ##  Create a commandline option parser
     def create_option_parser
       OptionParser.new do |opts|
-        opts.banner = "Usage: #{$0} [options] <input_file.asm>"
+        opts.banner = "Usage: #{$PROGRAM_NAME} [options] <input_file.asm>"
 
         opts.on('-o', '--outfile filename', 'outfile') do |output_file|
-          @options[:output_file] = output_file;
+          @options[:output_file] = output_file
+        end
+
+        opts.on('-s', '--symbols', 'Outputs a symbol map') do
+          @options[:write_symbol_table] = true
+        end
+
+        opts.on('-c', '--cycles', 'Outputs a cycle count yaml document') do
+          @options[:cycle_count] = true
+        end
+
+        opts.on('-q', '--quiet', 'No output on success') do
+          @options[:quiet] = true
+        end
+
+        opts.on('-v', '--version', 'Displays Version') do
+          puts "N65 Assembler Version #{N65::VERSION}"
+          exit
         end
 
         opts.on('-h', '--help', 'Displays Help') do
@@ -84,7 +83,5 @@ module N65
         end
       end
     end
-
   end
-
 end