yane 1.1.11

An N.E.S. emulator and emulation library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

// Create an NES from a test rom
#[macro_export]
macro_rules! nes_with_rom {
    ($rom_path: literal) => {
        Nes::with_cartridge(Cartridge::from_ines(include_bytes!($rom_path), None).unwrap())
    };
}

// Advance the NES a certain number of frames
#[macro_export]
macro_rules! advance_nes_frames {
    ($nes: ident, $frames: literal) => {{
        use yane::core::Settings;
        let s = Settings::default();
        // Run the emulator a bit
        (0..($frames)).for_each(|_| {
            $nes.advance_frame(&s)
                .expect("Error when advancing NES by a frame");
        });
    }};
}

// Run a test rom
#[macro_export]
macro_rules! rom_test {
    ($nes_file: literal, $num_frames: literal) => {
        let file_contents = include_bytes!($nes_file);
        let mut nes = Nes::with_cartridge(Cartridge::from_ines(file_contents, None).unwrap());

        advance_nes_frames!(nes, $num_frames);

        assert_background_snapshot!(nes);
    };
    // Default to 300 frames
    ($nes_file: literal) => {
        rom_test!($nes_file, 300);
    };
}

#[macro_export]
macro_rules! set_button {
    ($nes: ident, $player_number: literal, $key: ident, $value: literal) => {{
        let mut controller = $nes.controllers[$player_number];
        controller.$key = $value;
        $nes.set_controller_state($player_number, controller);
        println!("{:?}", controller);
    }};
}
#[macro_export]
macro_rules! press_button {
    ($nes: ident, $player_number: literal, $key: ident) => {
        set_button!($nes, $player_number, $key, true);
    };
}
#[macro_export]
macro_rules! release_button {
    ($nes: ident, $player_number: literal, $key: ident) => {
        set_button!($nes, $player_number, $key, false);
    };
}

#[macro_export]
macro_rules! assert_background_snapshot {
    ($nes: ident) => {
        // Compare background
        insta::assert_debug_snapshot!($nes.ppu.nametable_ram.as_slice());
    };
    ($name: literal, $nes: ident) => {
        insta::assert_debug_snapshot!($name, $nes.ppu.nametable_ram.as_slice());
    };
}