chore: extract core emulator to own crate, add actions for testing

.github/workflows/action.yml

@@ -0,0 +1,42 @@
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  main_test:
+    name: Test changes to main
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install toolchain
+        run: curl https://sh.rustup.rs -sSf | sh -s -- --profile minimal --default-toolchain stable -y && echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+      
+      - name: Run cargo tests (meowgb-core)
+        run: cargo test -p meowgb-core
+
+      - name: Run test ROM (blargg cpu_instrs)
+        if: always()
+        run: cargo run --bin meowgb-tests --release -- test-roms/blargg/roms/cpu_instrs.gb test -m 100000000 -s meowgb-tests/expected_output/cpu_instrs.bin
+      
+      - name: Run test ROM (blargg instr_timing)
+        if: always()
+        run: cargo run --bin meowgb-tests --release -- test-roms/blargg/roms/instr_timing.gb test -m 100000000 -s meowgb-tests/expected_output/instr_timing.bin
+
+      - name: Run test ROM (mealybug-tearoom-tests intr_1_2_timing)
+        if: always()
+        run: cargo run --bin meowgb-tests --release -- test-roms/mealybug-tearoom-tests/roms/intr_1_2_timing-GS.gb test -m 100000000 -s meowgb-tests/expected_output/intr_1_2_timing-GS.bin
+
+      - name: Run test ROM (mealybug-tearoom-tests intr_2_0_timing)
+        if: always()
+        run: cargo run --bin meowgb-tests --release -- test-roms/mealybug-tearoom-tests/roms/intr_2_0_timing.gb test -m 100000000 -s meowgb-tests/expected_output/intr_2_0_timing.bin
+
+      - name: Run test ROM (mealybug-tearoom-tests stat_lyc_onoff)
+        if: always()
+        run: cargo run --bin meowgb-tests --release -- test-roms/mealybug-tearoom-tests/roms/stat_lyc_onoff.gb test -m 100000000 -s meowgb-tests/expected_output/stat_lyc_onoff.bin
+      
+      - name: Run test ROM (mealybug-tearoom-tests stat_irq_blocking)
+        if: always()
+        run: cargo run --bin meowgb-tests --release -- test-roms/mealybug-tearoom-tests/roms/stat_irq_blocking.gb test -m 100000000 -s meowgb-tests/expected_output/stat_irq_blocking.bin

Cargo.lock

@@ -1063,22 +1063,32 @@ checksum = "523dc4f511e55ab87b694dc30d0f820d60906ef06413f93d4d7a1385599cc149"
 name = "meowgb"
 version = "0.1.0"
 dependencies = [
- "bmp",
  "chrono",
  "clap",
  "config",
  "env_logger",
  "log",
- "meowgb-opcode",
- "paste",
+ "meowgb-core",
  "pixels",
  "serde",
- "sha1",
  "thiserror",
  "winit",
  "winit_input_helper",
 ]
 
+[[package]]
+name = "meowgb-core"
+version = "0.1.0"
+dependencies = [
+ "bmp",
+ "chrono",
+ "log",
+ "meowgb-opcode",
+ "paste",
+ "sha1",
+ "thiserror",
+]
+
 [[package]]
 name = "meowgb-opcode"
 version = "0.1.0"
@@ -1094,7 +1104,7 @@ name = "meowgb-tests"
 version = "0.1.0"
 dependencies = [
  "clap",
- "meowgb",
+ "meowgb-core",
  "thiserror",
 ]
 

Cargo.toml

@@ -1,3 +1,3 @@
 [workspace]
 resolver = "2"
-members = ["meowgb", "meowgb-opcode", "meowgb-tests"]
+members = ["meowgb", "meowgb-core", "meowgb-opcode", "meowgb-tests"]

meowgb-core/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "meowgb-core"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+log = "0.4.14"
+paste = "1.0.6"
+meowgb-opcode = { path = "../meowgb-opcode" }
+bmp = "0.5.0"
+chrono = "0.4.19"
+thiserror = "1.0.30"
+sha1 = { version = "0.10.6", features = ["std"] }

meowgb-core/src/lib.rs

@@ -1,12 +1,8 @@
-use std::io::Stdout;
-
 pub mod gameboy;
-#[allow(unused)]
-mod settings;
 
 pub fn setup_test_emulator<const ROM_LENGTH: usize>(
 	test_opcodes: [u8; ROM_LENGTH],
-) -> gameboy::Gameboy<Stdout> {
+) -> gameboy::Gameboy<std::io::Stdout> {
 	let mut gameboy = gameboy::Gameboy::new(None, std::io::stdout());
 
 	let mut cartridge = gameboy::mapper::NoMBC { rom: [0u8; 0x8000], ram: None };

meowgb-core/tests/flow_opcodes.rs

@@ -1,4 +1,4 @@
-use meowgb::setup_test_emulator;
+use meowgb_core::setup_test_emulator;
 
 macro_rules! conditional_jump_relative_testgen {
 	($flag:ident, $not_opcode:literal, $opcode:literal) => {

meowgb-core/tests/load_store_move_opcodes.rs

@@ -1,4 +1,4 @@
-use meowgb::setup_test_emulator;
+use meowgb_core::setup_test_emulator;
 
 macro_rules! ld_reg_imm_u16_testgen {
 	($hireg:ident, $loreg:ident, $opcode:literal) => {

meowgb-core/tests/misc_opcodes.rs

@@ -1,4 +1,4 @@
-use meowgb::setup_test_emulator;
+use meowgb_core::setup_test_emulator;
 
 #[test]
 fn test_nop() {

meowgb-tests/Cargo.toml

@@ -7,5 +7,5 @@ edition = "2021"
 
 [dependencies]
 clap = { version = "4.4.12", features = ["derive"] }
-meowgb = { path = "../meowgb" }
+meowgb-core = { path = "../meowgb-core" }
 thiserror = "1.0.56"

meowgb-tests/src/main.rs

@@ -1,7 +1,7 @@
 use std::{path::{PathBuf, Path}, sync::{RwLock, Arc}, time::{Duration, Instant}};
 
 use clap::{Parser, Subcommand};
-use meowgb::gameboy::{Gameboy, serial::SerialWriter};
+use meowgb_core::gameboy::{Gameboy, serial::SerialWriter};
 
 #[derive(Debug, Parser)]
 /// DMG Emulator

meowgb/Cargo.toml

@@ -6,17 +6,14 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-bmp = "0.5.0"
-chrono = "0.4.19"
+meowgb-core = { path = "../meowgb-core" }
 clap = { version = "4.4.12", features = ["derive"] }
 config = "0.13.4"
-meowgb-opcode = { path = "../meowgb-opcode" }
 env_logger = "0.10.1"
-log = "0.4.14"
-paste = "1.0.6"
 pixels = "0.13.0"
 serde = { version = "1.0.130", features = ["derive"] }
-sha1 = { version = "0.10.6", features = ["std"] }
 thiserror = "1.0.30"
 winit = { version = "0.29.7", default-features = false, features = ["serde", "rwh_05"] }
 winit_input_helper = "0.15.1"
+chrono = "0.4.31"
+log = "0.4.20"

meowgb/src/main.rs

@@ -1,4 +1,3 @@
-mod gameboy;
 mod settings;
 mod window;
 
@@ -10,7 +9,7 @@ use std::{
 
 use chrono::{Duration, Utc};
 use clap::Parser;
-use gameboy::{Gameboy, bootrom::{BootromParseError, verify_parse_bootrom}};
+use meowgb_core::gameboy::{Gameboy, bootrom::{BootromParseError, verify_parse_bootrom}};
 use settings::DeemgeeConfig;
 use window::EmulatorWindowEvent;
 

meowgb/src/window.rs

@@ -106,8 +106,8 @@ pub fn run_window(
 		let window_size = window.inner_size();
 		let surface_texture = SurfaceTexture::new(window_size.width, window_size.height, &window);
 		Pixels::new(
-			crate::gameboy::ppu::FB_WIDTH,
-			crate::gameboy::ppu::FB_HEIGHT,
+			meowgb_core::gameboy::ppu::FB_WIDTH,
+			meowgb_core::gameboy::ppu::FB_HEIGHT,
 			surface_texture,
 		)
 		.unwrap()