feat: ppu-viewer

README.md

@@ -9,8 +9,6 @@
 [build]: https://github.com/lukexor/tetanes/actions/workflows/ci.yml
 [doc status]: https://img.shields.io/docsrs/tetanes?style=plastic
 [docs]: https://docs.rs/tetanes/
-[codecov]: https://codecov.io/gh/lukexor/tetanes/branch/main/graph/badge.svg?token=AMQJJ7B0LS
-[coverage]: https://codecov.io/gh/lukexor/tetanes
 [latest version]: https://img.shields.io/crates/v/tetanes?style=plastic
 [crates.io]: https://crates.io/crates/tetanes
 [downloads]: https://img.shields.io/crates/d/tetanes?style=plastic
@@ -153,7 +151,8 @@ This will install the latest released version of the `TetaNES` binary to your
 `cargo` bin directory located at either `$HOME/.cargo/bin/` on a Unix-like
 platform or `%USERPROFILE%\.cargo\bin` on Windows.
 
-Alternatively, if you have [`cargo binstall`](https://crates.io/crates/cargo-binstall/) installed:
+Alternatively, if you have [`cargo binstall`](https://crates.io/crates/cargo-binstall/)
+installed:
 
 ```sh
 cargo binstall tetanes

tetanes-core/src/control_deck.rs

@@ -6,6 +6,7 @@ use crate::{
     cart::{self, Cart},
     common::{Clock, NesRegion, Regional, Reset, ResetKind, Sram},
     cpu::Cpu,
+    debug::Debugger,
     fs,
     genie::{self, GenieCode},
     input::{FourPlayer, Joypad, Player},
@@ -423,6 +424,21 @@ impl ControlDeck {
         self.cpu.bus.ppu.emulate_warmup = enabled;
     }
 
+    /// Adds a debugger callback to be executed any time the debugger conditions
+    /// match.
+    pub fn add_debugger(&mut self, debugger: Debugger) {
+        match debugger {
+            Debugger::Ppu(debugger) => self.cpu.bus.ppu.debugger = Some(debugger),
+        }
+    }
+
+    /// Removes a debugger callback.
+    pub fn remove_debugger(&mut self, debugger: Debugger) {
+        match debugger {
+            Debugger::Ppu(_) => self.cpu.bus.ppu.debugger = None,
+        }
+    }
+
     /// Returns the name of the currently loaded ROM [`Cart`]. Returns `None` if no ROM is loaded.
     #[inline]
     #[must_use]

tetanes-core/src/cpu.rs

@@ -187,6 +187,8 @@ impl Cpu {
         if cpu.bus.ppu.bus.chr_rom.is_empty() {
             cpu.bus.ppu.bus.chr_rom = std::mem::take(&mut self.bus.ppu.bus.chr_rom);
         };
+        // Doesn't make sense to load a debugger from a previous state
+        cpu.bus.ppu.debugger = std::mem::take(&mut self.bus.ppu.debugger);
         *self = cpu;
     }
 

tetanes-core/src/debug.rs

@@ -0,0 +1,37 @@
+use crate::ppu::Ppu;
+use std::sync::Arc;
+
+#[derive(Debug, Clone, PartialEq)]
+#[must_use]
+pub enum Debugger {
+    Ppu(PpuDebugger),
+}
+
+impl From<PpuDebugger> for Debugger {
+    fn from(debugger: PpuDebugger) -> Self {
+        Self::Ppu(debugger)
+    }
+}
+
+#[derive(Clone)]
+#[must_use]
+pub struct PpuDebugger {
+    pub cycle: u32,
+    pub scanline: u32,
+    pub callback: Arc<dyn Fn(Ppu) + Send + Sync + 'static>,
+}
+
+impl PartialEq for PpuDebugger {
+    fn eq(&self, other: &Self) -> bool {
+        self.cycle == other.cycle && self.scanline == other.scanline
+    }
+}
+
+impl std::fmt::Debug for PpuDebugger {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.debug_struct("PpuDebugger")
+            .field("cycle", &self.cycle)
+            .field("scanline", &self.scanline)
+            .finish_non_exhaustive()
+    }
+}

tetanes-core/src/lib.rs

@@ -8,6 +8,7 @@ pub mod action;
 pub mod apu;
 pub mod bus;
 pub mod cart;
+pub mod debug;
 pub mod fs;
 pub mod time;
 #[macro_use]