amaterasu 0.6.0

data/lib/amaterasu/utils/bit_ops.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module Utils
+    # Bit Operation utility module.
+    module BitOps
+      module_function
+
+      def set_bit(value, pos)
+        value | (1 << pos)
+      end
+
+      def clear_bit(value, pos)
+        value & ~(1 << pos)
+      end
+
+      def bit(value, pos)
+        (value >> pos) & 1
+      end
+    end
+  end
+end

data/lib/amaterasu.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'debug'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect('cli' => 'CLI')
+loader.inflector.inflect('hal' => 'HAL')
+loader.inflector.inflect('sdl2' => 'SDL2')
+loader.setup
+
+# Base module to mirror the emulator name and group everything.
+module Amaterasu; end

data/sig/akane/cartridge/rom.rbs

@@ -0,0 +1,29 @@
+module Amaterasu
+  class Cartridge
+    class Rom
+      CARTRIDGE_TYPES: Hash[Integer, Symbol]
+      ROM_SIZES: Hash[Integer, Integer]
+      RAM_SIZES: Hash[Integer, Integer]
+
+      def self.from_file: (String file_path) -> Rom
+
+      def initialize: (Array[Integer] data) -> void
+
+      def read_byte: (Integer offset) -> Integer
+      def header: () -> Array[Integer]
+      def title: () -> String
+      def manufacturer_code: () -> Array[Integer]
+      def cgb_flag: () -> Integer
+      def new_licensee_code: () -> Array[Integer]
+      def sgb_flag: () -> Integer
+      def cartridge_type: () -> Symbol
+      def rom_size: () -> Integer
+      def ram_size: () -> Integer
+      def destination_code: () -> Integer
+      def old_licensee_code: () -> Integer
+      def mask_rom_version: () -> Integer
+      def header_checksum: () -> Integer
+      def valid_checksum?: () -> bool
+    end
+  end
+end

data/sig/akane/cartridge.rbs

@@ -0,0 +1,12 @@
+module Amaterasu
+  class Cartridge
+    def self.load_rom: (String file_path) -> Cartridge
+
+    def initialize: (rom: Rom, ?mbc: nil, ?ram: nil) -> void
+
+    def read_rom: (Integer offset) -> Integer
+    def write_rom: (Integer offset, Integer value) -> void
+    def read_ram: (Integer offset) -> Integer
+    def write_ram: (Integer offset, Integer value) -> void
+  end
+end

data/sig/akane/cli.rbs

@@ -0,0 +1,16 @@
+module Amaterasu
+  class CLI
+    type emulator_options = {
+      audio: String?,
+      cycles: Integer?,
+      debug: bool,
+      profile: Symbol?,
+      steps: Integer?,
+      trace: Array[String]?,
+      video: String?,
+      rom_path: String
+    }
+
+    def self.parse: (Array[String] arguments) -> emulator_options
+  end
+end

data/sig/akane/emulator.rbs

@@ -0,0 +1,19 @@
+module Amaterasu
+  class Emulator
+    CYCLES_PER_FRAME: Integer
+
+    def initialize: (
+      audio: String,
+      cycles: Integer,
+      debug: bool,
+      profiling: String,
+      steps: Integer,
+      trace: String,
+      video: String,
+      rom_path: String
+    ) -> void
+    def start: (CLI::emulator_options options) -> void
+    def advance_cycle: () -> void
+    def stop: () -> void
+  end
+end

data/sig/akane/game_boy/apu.rbs

@@ -0,0 +1,7 @@
+module Amaterasu
+  module GameBoy
+    class Apu
+      def tick: () -> void
+    end
+  end
+end

data/sig/akane/game_boy/bus.rbs

@@ -0,0 +1,25 @@
+module Amaterasu
+  module GameBoy
+    class Bus
+      def initialize: (
+        cartridge: Amaterasu::Cartridge,
+        ppu: Ppu,
+        apu: Apu,
+        wram: Ram,
+        hram: Ram,
+        interrupts: Interrupts,
+        timer: Timer,
+        serial: Serial,
+        joypad: Joypad
+      ) -> void
+
+      def read_byte: (address: Integer) -> Integer
+      def write_byte: (address: Integer, value: Integer) -> void
+
+      private
+
+      def read_io: (Integer address) -> Integer
+      def write_io: (Integer address, Integer value) -> void
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/adc.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Adc < Base
+          def initialize: (cpu: Cpu, source: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol source) -> Proc
+          def adc_a: (Integer value) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/add16.rbs

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Add16 < Base
+          def initialize: (cpu: Cpu, target: Symbol, source: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol source, Symbol target) -> Proc
+          def add16: (Integer value) -> void
+          def add16_sig8: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/add8.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Add8 < Base
+          def initialize: (cpu: Cpu, source: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol source) -> Proc
+          def add_a: (Integer value) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/and.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class And < Base
+          def initialize: (cpu: Cpu, source: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol source) -> Proc
+          def and_a: (Integer value) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/base.rbs

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Base
+          attr_reader mnemonic: String
+
+          def initialize: (cpu: Cpu) -> void
+          def execute: () -> void
+
+          private
+
+          def format_operand: (Symbol ?operand) -> String
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/call.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Call < Base
+          def initialize: (cpu: Cpu, ?condition: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol ?condition) -> Proc
+          def call: (bool condition) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_bit.rbs

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbBit < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, bit_pos: Integer, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Integer bit_pos, Symbol target) -> Proc
+          def bit_test: (Integer bit, Integer target_value) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_res.rbs

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbRes < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, bit_pos: Integer, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Integer bit_pos, Symbol target) -> Proc
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_rl.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbRl < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def rl_reg8: (Integer reg8_value) -> void
+          def rl_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_rlc.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbRlc < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def rlc_reg8: (Integer reg8_value) -> void
+          def rlc_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_rr.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbRr < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def rr_reg8: (Integer reg8_value) -> void
+          def rr_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_rrc.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbRrc < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def rrc_reg8: (Integer reg8_value) -> void
+          def rrc_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_set.rbs

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbSet < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, bit_pos: Integer, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Integer bit_pos, Symbol target) -> Proc
+          def set: (Integer bit_pos, Symbol target) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_sla.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbSla < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def sla_reg8: (Integer reg8_value) -> void
+          def sla_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_sra.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbSra < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def sra_reg8: (Integer reg8) -> void
+          def sra_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_srl.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbSrl < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def srl_reg8: (Integer reg8) -> void
+          def srl_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cb_swap.rbs

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class CbSwap < Base
+          include Utils::BitOps
+
+          def initialize: (cpu: Cpu, target: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol target) -> Proc
+          def swap: (Integer reg8) -> void
+          def swap_mem_hl: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/cp.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Cp < Base
+          def initialize: (cpu: Cpu, source: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol source) -> Proc
+          def cp_a: (Integer value) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/daa.rbs

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Daa < Base
+          def initialize: (cpu: Cpu) -> void
+
+          private
+
+          def daa: () -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/dec.rbs

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Dec < Base
+          def initialize: (cpu: Cpu, operand: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol operand) -> Proc
+          def dec: (Integer value) -> Integer
+          def dec16: (Integer value) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/di.rbs

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Di < Base
+          def initialize: (cpu: Cpu) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/ei.rbs

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Ei < Base
+          def initialize: (cpu: Cpu) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/halt.rbs

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Halt < Base
+          def initialize: (cpu: Cpu) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/inc.rbs

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Inc < Base
+          def initialize: (cpu: Cpu, operand: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol operand) -> Proc
+          def inc: (Integer value) -> Integer
+          def inc16: (Integer value) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/jp.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Jp < Base
+          def initialize: (cpu: Cpu, location: Symbol, ?condition: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol location, Symbol ?condition) -> Proc
+          def jp: (condition: bool) -> void
+        end
+      end
+    end
+  end
+end

data/sig/akane/game_boy/cpu/instructions/jr.rbs

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Amaterasu
+  module GameBoy
+    class Cpu
+      module Instructions
+        class Jr < Base
+          def initialize: (cpu: Cpu, ?condition: Symbol) -> void
+
+          private
+
+          def build_logic: (Symbol ?condition) -> Proc
+          def jr: (bool condition) -> void
+        end
+      end
+    end
+  end
+end