Upgrade edition, fix lints

Author: sinon

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "chip8"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 categories = ["no-std"]
 
 [dependencies]

Justfile

@@ -12,6 +12,3 @@ test:
     cargo nextest run --all-targets --no-fail-fast
 
 t:test
-
-lox_run:build
-    cargo run run test.lox 

README.md

@@ -3,3 +3,39 @@
 [![codecov](https://codecov.io/gh/sinon/chip8/graph/badge.svg?token=9QYDO9E4RU)](https://codecov.io/gh/sinon/chip8)
 
 Spec: <http://devernay.free.fr/hacks/chip8/C8TECH10.HTM>
+
+## Run ROMs
+
+### Pong
+
+`cargo run pong`
+
+Controls:
+- Player 1 Up: 1
+- Player 1 Down: Q
+- Player 2 Up: 4
+- Player 2 Up: R
+- Quit: Esc
+
+
+### Guess
+
+`cargo run guess`
+
+### Maze
+
+`cargo run maze`
+
+
+## Development
+
+### Tests
+
+`cargo test`
+or
+`just t`
+
+### Lint
+
+`just lint`
+

src/lib.rs

@@ -2,6 +2,7 @@
 //! <http://devernay.free.fr/hacks/chip8/C8TECH10.HTM>
 
 #![no_std]
+#![allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
 
 const RAM_SIZE: usize = 4096;
 // The original implementation of the Chip-8 language used a 64x32-pixel monochrome display with this format:
@@ -89,7 +90,7 @@ impl Default for Chip8Emulator {
 impl Chip8Emulator {
     #[must_use]
     pub fn new() -> Self {
-        let mut emu: Self = Default::default();
+        let mut emu: Self = Self::default();
         emu.memory[..(16 * 5)].copy_from_slice(&FONT_SPRITES);
         emu
     }
@@ -404,8 +405,8 @@ impl Chip8Emulator {
         // See instruction 8xy3 for more information on XOR, and section 2.4, Display, for more information on the Chip-8 screen and sprites.
 
         // Implementation based on: <https://aquova.net/emudev/chip8/5-instr.html>
-        let x_coord = self.v_registers[x as usize] as u16;
-        let y_coord = self.v_registers[y as usize] as u16;
+        let x_coord = u16::from(self.v_registers[x as usize]);
+        let y_coord = u16::from(self.v_registers[y as usize]);
 
         let num_rows = u16::from(d);
         let mut flipped = false;
@@ -520,7 +521,7 @@ impl Chip8Emulator {
         // The interpreter takes the decimal value of Vx, and places the hundreds digit in memory at location in I,
         // the tens digit at location I+1, and the ones digit at location I+2.
         // https://en.wikipedia.org/wiki/Binary-coded_decimal
-        let vx = self.v_registers[x as usize] as f64;
+        let vx = f64::from(self.v_registers[x as usize]);
 
         let hundredths = (vx / 100.0).floor() as u8;
         let tenths = ((vx / 10.0) % 10.0).floor() as u8;

src/main.rs

@@ -1,3 +1,5 @@
+#![allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
+
 use std::{io, time::Duration};
 
 use chip8::{Chip8Emulator, SCREEN_WIDTH};
@@ -7,15 +9,15 @@ use itertools::Itertools;
 use ratatui::crossterm::event::KeyboardEnhancementFlags;
 use ratatui::crossterm::event::PushKeyboardEnhancementFlags;
 use ratatui::{
+    DefaultTerminal, Frame,
     crossterm::event::{self, Event, KeyCode, KeyEvent, KeyEventKind},
     layout::{Constraint, Layout, Position, Rect},
     style::Color,
     symbols::Marker,
     widgets::{
-        canvas::{Canvas, Points},
         Block, Widget,
+        canvas::{Canvas, Points},
     },
-    DefaultTerminal, Frame,
 };
 
 #[derive(Parser, Debug)]
@@ -45,13 +47,14 @@ fn main() -> io::Result<()> {
         io::stderr(),
         PushKeyboardEnhancementFlags(KeyboardEnhancementFlags::REPORT_EVENT_TYPES)
     )?;
-    let app_result = App::new(command).run(&mut terminal);
+    let app_result = App::new(&command).run(&mut terminal);
     ratatui::restore();
     app_result
 }
 
 impl App {
-    pub fn new(command: Commands) -> Self {
+    #[must_use]
+    pub fn new(command: &Commands) -> Self {
         let pong = include_bytes!("./roms/PONG");
         let guess = include_bytes!("./roms/GUESS");
         let maze = include_bytes!("./roms/MAZE");
@@ -61,13 +64,15 @@ impl App {
             Commands::Guess => emulator.load_data(guess),
             Commands::Maze => emulator.load_data(maze),
         }
-        App {
+        Self {
             emulator,
             exit: false,
             points: vec![],
         }
     }
-
+    /// # Errors
+    /// - reading events
+    /// - fails to draw state to terminal
     pub fn run(&mut self, terminal: &mut DefaultTerminal) -> io::Result<()> {
         while !self.exit {
             for _ in 0..10 {
@@ -89,17 +94,10 @@ impl App {
 
     fn handle_events(&mut self) -> io::Result<()> {
         if event::poll(Duration::from_millis(16))? {
-            match event::read()? {
-                Event::Key(key_event) => {
-                    let pressed = if key_event.kind == KeyEventKind::Press {
-                        true
-                    } else {
-                        false
-                    };
-                    self.handle_key_event(key_event, pressed)
-                }
-                _ => {}
-            };
+            if let Event::Key(key_event) = event::read()? {
+                let pressed = key_event.kind == KeyEventKind::Press;
+                self.handle_key_event(key_event, pressed);
+            }
         }
         Ok(())
     }
@@ -112,18 +110,18 @@ impl App {
             KeyCode::Char('2') => Some(0x2),
             KeyCode::Char('3') => Some(0x3),
             KeyCode::Char('4') => Some(0xC),
-            KeyCode::Char('q') | KeyCode::Char('Q') => Some(0x4),
-            KeyCode::Char('w') | KeyCode::Char('W') => Some(0x5),
-            KeyCode::Char('e') | KeyCode::Char('E') => Some(0x6),
-            KeyCode::Char('r') | KeyCode::Char('R') => Some(0xD),
-            KeyCode::Char('a') | KeyCode::Char('A') => Some(0x7),
-            KeyCode::Char('s') | KeyCode::Char('S') => Some(0x8),
-            KeyCode::Char('d') | KeyCode::Char('D') => Some(0x9),
-            KeyCode::Char('f') | KeyCode::Char('F') => Some(0xE),
-            KeyCode::Char('z') | KeyCode::Char('Z') => Some(0xA),
-            KeyCode::Char('x') | KeyCode::Char('X') => Some(0x0),
-            KeyCode::Char('c') | KeyCode::Char('C') => Some(0xB),
-            KeyCode::Char('v') | KeyCode::Char('V') => Some(0xB),
+            KeyCode::Char('q' | 'Q') => Some(0x4),
+            KeyCode::Char('w' | 'W') => Some(0x5),
+            KeyCode::Char('e' | 'E') => Some(0x6),
+            KeyCode::Char('r' | 'R') => Some(0xD),
+            KeyCode::Char('a' | 'A') => Some(0x7),
+            KeyCode::Char('s' | 'S') => Some(0x8),
+            KeyCode::Char('d' | 'D') => Some(0x9),
+            KeyCode::Char('f' | 'F') => Some(0xE),
+            KeyCode::Char('z' | 'Z') => Some(0xA),
+            KeyCode::Char('x' | 'X') => Some(0x0),
+            KeyCode::Char('c' | 'C') => Some(0xB),
+            KeyCode::Char('v' | 'V') => Some(0xF),
             _ => None,
         };
 
@@ -132,7 +130,7 @@ impl App {
         }
     }
 
-    fn exit(&mut self) {
+    const fn exit(&mut self) {
         self.exit = true;
     }