Upgraded dependencies and cleaned up

Author: TylerBloom

Cargo.toml

@@ -1,7 +1,6 @@
 [workspace]
 members = [
     "spirit",
-    "appirition",
     "tombstone",
     "ghast",
 ]

spirit/Cargo.toml

@@ -3,12 +3,10 @@ name = "spirit"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 # serde_json = { version = "1.0" }
 # hex = { version = "0.4", features = ["serde"] }
-derive_more = "1.0"
+derive_more = { version = "1.0", features = ["full"] }
 array-concat = "0.5.2"
 # once_cell = "1.19"
 tracing = "0.1.40"

spirit/src/cpu.rs

@@ -8,6 +8,7 @@ use std::{
     sync::{Mutex, OnceLock},
 };
 
+use serde::{Deserialize, Serialize};
 use tracing::{info, info_span, trace};
 
 use crate::{
@@ -19,9 +20,11 @@ use crate::{
     mem::MemoryMap,
 };
 
-#[derive(Debug, Default, Hash, Clone, PartialEq, Eq, derive_more::Display)]
+#[derive(
+    Debug, Default, Hash, Clone, PartialEq, Eq, derive_more::Display, Serialize, Deserialize,
+)]
 #[display(
-    fmt = "CPU {{ A=0x{:0>2X} F={} B=0x{:0>2X} C=0x{:0>2X} D=0x{:0>2X} E=0x{:0>2X} H=0x{:0>2X} L=0x{:0>2X} SP=0x{:0>2X} PC=0x{:0>2X} IME={} Done={} }}",
+    "CPU {{ A=0x{:0>2X} F={} B=0x{:0>2X} C=0x{:0>2X} D=0x{:0>2X} E=0x{:0>2X} H=0x{:0>2X} L=0x{:0>2X} SP=0x{:0>2X} PC=0x{:0>2X} IME={} Done={} }}",
     a,
     f,
     b,
@@ -54,7 +57,9 @@ pub struct Cpu {
     pub state: CpuState,
 }
 
-#[derive(Debug, Default, Hash, Clone, Copy, PartialEq, Eq, derive_more::Display)]
+#[derive(
+    Debug, Default, Hash, Clone, Copy, PartialEq, Eq, derive_more::Display, Serialize, Deserialize,
+)]
 #[repr(u8)]
 pub enum CpuState {
     #[default]
@@ -81,13 +86,15 @@ pub enum RegisterFlags {
     C,
 }
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash, derive_more::Display)]
+#[derive(
+    Debug, Clone, Copy, PartialEq, Eq, Default, Hash, derive_more::Display, Serialize, Deserialize,
+)]
 #[display(
-    fmt = "Flags(Z={} N={} H={} C={})",
-    "*z as u8",
-    "*n as u8",
-    "*h as u8",
-    "*c as u8"
+    "Flags(Z={} N={} H={} C={})",
+    *z as u8,
+    *n as u8,
+    *h as u8,
+    *c as u8
 )]
 pub struct Flags {
     /// The zero flag

spirit/src/lib.rs

@@ -14,7 +14,9 @@
     clippy::all
 )]
 
-use std::borrow::Cow;
+use std::{borrow::Cow, ops::{Deref, DerefMut}};
+
+use serde::{Deserialize, Serialize};
 
 use cpu::{check_bit_const, Cpu, CpuState};
 use lookup::Instruction;
@@ -31,21 +33,31 @@ pub mod rom;
 pub(crate) mod utils;
 
 /// Represents a Gameboy color with a cartridge inserted.
-#[derive(Debug, Hash)]
+#[derive(Debug, Hash, Serialize, Deserialize)]
 pub struct Gameboy {
     pub mem: MemoryMap,
     pub ppu: Ppu,
     cpu: Cpu,
 }
 
+#[must_use = "Start up sequence is lazy and should be ticked. Dropping this object to complete the startup sequence instantly."]
+pub struct StartUpSequence {
+    gb: Gameboy,
+    op: Instruction,
+    counter: u8,
+    done: bool,
+    /// The memory that the ROM contains that get mapped over during the startup process.
+    remap_mem: StartUpHeaders,
+}
+
 impl Gameboy {
     /// Takes data that represents the data stored on a game cartridge and uses it to construct the
-    pub fn new<'a, C: Into<Cow<'a, [u8]>>>(cart: C) -> Self {
-        Self {
+    pub fn new<'a, C: Into<Cow<'a, [u8]>>>(cart: C) -> StartUpSequence {
+        StartUpSequence::new(Self {
             mem: MemoryMap::new(cart),
             cpu: Cpu::new(),
             ppu: Ppu::new(),
-        }
+        })
     }
 
     pub fn next_frame(&mut self) -> FrameSequence<'_> {
@@ -109,12 +121,6 @@ impl Gameboy {
         })
     }
 
-    /// Runs the power-up sequence for the gameboy. During this time, the Gameboy remaps part of
-    /// the memory to read from the start up sequence.
-    pub fn start_up(self) -> StartUpSequence {
-        StartUpSequence::new(self)
-    }
-
     /// This returns a state that will track the number of required clock ticks it takes to
     /// complete the next operation. If the state is dropped before the required number of ticks,
     /// the intruction is automatically ran.
@@ -232,16 +238,6 @@ impl Drop for StepProcess<'_> {
     }
 }
 
-#[must_use = "Start up sequence is lazy and should be ticked. Dropping this object to complete the startup sequence instantly."]
-pub struct StartUpSequence {
-    gb: Gameboy,
-    op: Instruction,
-    counter: u8,
-    done: bool,
-    /// The memory that the ROM contains that get mapped over during the startup process.
-    remap_mem: StartUpHeaders,
-}
-
 impl StartUpSequence {
     pub fn frame_step(&mut self) -> StartUpFrame<'_> {
         StartUpFrame::new(self)
@@ -252,6 +248,20 @@ impl StartUpSequence {
     }
 }
 
+impl Deref for StartUpSequence {
+    type Target = Gameboy;
+
+    fn deref(&self) -> &Self::Target {
+        self.gb()
+    }
+}
+
+impl DerefMut for StartUpSequence {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.gb
+    }
+}
+
 impl StartUpSequence {
     fn new(mut gb: Gameboy) -> Self {
         let remap_mem = gb.mem.start_up_remap();
@@ -409,16 +419,6 @@ mod tests {
 
     #[test_log::test]
     fn start_up_completion() {
-        let mut gb = Gameboy::new(include_bytes!("../tests/roms/acid/which.gb"));
-        gb.start_up().complete();
-    }
-
-    #[test]
-    fn frame_by_frame_start_up() {
-        let mut gb = Gameboy::new(include_bytes!("../tests/roms/acid/which.gb"));
-        let mut seq = gb.start_up();
-        while !seq.is_complete() {
-            seq.frame_step().complete();
-        }
+        Gameboy::new(include_bytes!("../tests/roms/acid/which.gb")).complete();
     }
 }