neser 1.2.0

NESER - Nintendo Emulation Systems Engine (Rust). Desktop and WebAssembly frontends.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
//! Reusable mapper template types to reduce boilerplate code.
//!
//! These generic mapper implementations provide standard patterns used across multiple
//! simple mappers, ensuring consistent behavior and reducing duplicated code.
//!
//! # Benefits
//!
//! Using mapper templates significantly reduces code duplication:
//! - **CNROM**: Reduced from ~110 lines to ~25 lines (77% reduction)
//! - **UxROM**: Reduced from ~130 lines to ~30 lines (77% reduction)
//! - **GxROM**: Reduced from ~125 lines to ~25 lines (80% reduction)
//! - **ColorDreams**: Reduced from ~125 lines to ~25 lines (80% reduction)
//!
//! Total: Eliminated ~400+ lines of boilerplate while ensuring consistent behavior.
//!
//! # Available Templates
//!
//! - [`SimpleFixedPrgMapper`] - Fixed PRG bank + bank-selectable CHR-ROM (CNROM pattern)
//! - [`SimpleBankedPrgMapper`] - Bank-selectable PRG + CHR-RAM (UxROM pattern)
//! - [`DualBank32Mapper`] - 32KB PRG bank + 8KB CHR bank selection (GxROM/ColorDreams pattern)
//!
//! # When to Use
//!
//! Use these templates when creating a new mapper that matches one of the standard patterns.
//! If your mapper has special behavior (IRQ counters, custom mirroring control, expansion
//! audio, etc.), you'll need a custom implementation instead.
//!
//! ## SimpleFixedPrgMapper
//!
//! Use for mappers with:
//! - Fixed PRG-ROM (no PRG banking)
//! - Bank-switchable CHR-ROM
//! - Simple register at $8000-$FFFF that selects CHR bank
//!
//! **Examples:** CNROM (mapper 3)
//!
//! **Not suitable for:**
//! - CPROM (mapper 13) - has CHR-RAM with special banking (lower 4KB switchable, upper 4KB fixed)
//!
//! ```rust,ignore
//! // Example: Define a new mapper similar to CNROM
//! pub type MyFixedPrgMapper = SimpleFixedPrgMapper<8, 185>;
//!
//! let mapper = MyFixedPrgMapper::new(prg_rom, chr_rom, MirroringMode::Horizontal);
//! ```
//!
//! ## SimpleBankedPrgMapper
//!
//! Use for mappers with:
//! - Bank-switchable PRG-ROM (typically 16KB banks)
//! - Fixed last PRG bank
//! - CHR-RAM (not CHR-ROM)
//! - Simple register at $8000-$FFFF that selects PRG bank
//!
//! **Examples:** UxROM (mapper 2)
//!
//! **Not suitable for:**
//! - AxROM (mapper 7) - has programmable mirroring control
//! - Camerica (mapper 71) - has separate mirroring register
//!
//! ```rust,ignore
//! // Example: Define a new UxROM-style mapper with 16KB banks
//! pub type MyBankedPrgMapper = SimpleBankedPrgMapper<16, 94, true>;
//!
//! let mapper = MyBankedPrgMapper::new(prg_rom, chr_rom, MirroringMode::Vertical);
//! ```
//!
//! ## DualBank32Mapper
//!
//! Use for mappers with:
//! - 32KB PRG bank selection
//! - 8KB CHR bank selection
//! - Single register that controls both banks
//! - Different bit masks for PRG and CHR bank selection
//!
//! **Examples:** GxROM (mapper 66), ColorDreams (mapper 11)
//!
//! ```rust,ignore
//! // Example: GxROM uses PRG bits 4-5, CHR bits 0-1, no bus conflicts
//! pub type MyGxROMStyle = DualBank32Mapper<0b0011, 4, 0b0011, 0, false, 66>;
//!
//! // Example: ColorDreams uses PRG bits 0-1, CHR bits 4-7, with bus conflicts
//! pub type MyColorDreamsStyle = DualBank32Mapper<0b0011, 0, 0b1111, 4, true, 11>;
//!
//! // `ctx` is a `MapperContext` created by the cartridge loader
//! let mapper = MyGxROMStyle::new(ctx);
//! ```

use super::base_mapper::BaseMapper;
use super::mapper::MapperContext;
use crate::nes::cartridge::{Mapper, MapperCapabilities};

/// Compute the PRG-RAM size in KB from a mapper context.
///
/// Returns `0` when the header did not explicitly specify PRG-RAM or
/// indicated zero banks.
fn prg_ram_size_kb(ctx: &MapperContext) -> usize {
    if ctx.prg_ram_size_specified && ctx.prg_ram_banks_8k > 0 {
        ctx.prg_ram_banks_8k as usize * 8
    } else {
        0
    }
}

/// Simple mapper with fixed PRG-ROM and bank-selectable CHR-ROM.
///
/// This template implements the CNROM pattern used by several simple mappers:
/// - Fixed PRG-ROM (no banking)
/// - CHR-ROM with configurable bank size
/// - Any write to $8000-$FFFF selects CHR bank
///
/// # Type Parameters
///
/// - `CHR_BANK_KB`: Size of CHR banks in kilobytes (typically 8)
/// - `MAPPER_NUM`: Mapper number for identification
///
/// # Example
///
/// ```rust,ignore
/// // CNROM (Mapper 3) with 8KB CHR banks
/// type CNROMMapper = SimpleFixedPrgMapper<8, 3>;
///
/// let mapper = CNROMMapper::new(prg_rom, chr_rom, MirroringMode::Horizontal);
/// ```
pub struct SimpleFixedPrgMapper<const CHR_BANK_KB: usize, const MAPPER_NUM: u8> {
    base: BaseMapper,
    /// Raw CHR bank register value (for snapshot/restore).
    chr_bank_raw: u8,
}

impl<const CHR_BANK_KB: usize, const MAPPER_NUM: u8> SimpleFixedPrgMapper<CHR_BANK_KB, MAPPER_NUM> {
    /// Create a new SimpleFixedPrgMapper.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Mapper construction context with ROM data and header details
    pub fn new(ctx: MapperContext) -> Self {
        // Submapper 1 = explicitly no bus conflicts; all others (including 0 = original
        // CNROM hardware) emulate AND-type bus conflicts.
        let bus_conflicts = ctx.submapper != 1;
        let capabilities = MapperCapabilities {
            has_chr_banking: true,
            max_prg_ram_kb: prg_ram_size_kb(&ctx),
            chr_bank_size_kb: CHR_BANK_KB,
            ..Default::default()
        };

        let mut base = BaseMapper::new(&ctx, capabilities);
        base.configure_chr_banking(CHR_BANK_KB * 1024);
        base.set_bus_conflicts(bus_conflicts);

        Self {
            base,
            chr_bank_raw: 0,
        }
    }
}

impl<const CHR_BANK_KB: usize, const MAPPER_NUM: u8> Mapper
    for SimpleFixedPrgMapper<CHR_BANK_KB, MAPPER_NUM>
{
    fn base(&self) -> &BaseMapper {
        &self.base
    }

    fn base_mut(&mut self) -> &mut BaseMapper {
        &mut self.base
    }

    fn write_prg(&mut self, addr: u16, value: u8) {
        if self.base.try_write_prg_ram(addr, value) {
            return;
        }

        // Any write to $8000-$FFFF sets the CHR bank select.
        // Bus conflicts use fixed PRG-ROM (not banked) since this mapper has no PRG banking.
        if (0x8000..=0xFFFF).contains(&addr) {
            let effective = if self.base.has_bus_conflicts() {
                value & self.base.read_prg_rom_fixed(addr)
            } else {
                value
            };
            self.chr_bank_raw = effective;
            self.base.select_chr_page(0, effective as i16);
        }
    }

    fn registers_snapshot(&self) -> Vec<u8> {
        vec![self.chr_bank_raw]
    }

    fn restore_registers(&mut self, data: &[u8]) {
        if let Some(&value) = data.first() {
            self.chr_bank_raw = value;
            self.base.select_chr_page(0, value as i16);
        }
    }
}

/// Simple mapper with bank-selectable PRG and CHR-RAM.
///
/// Supports two PRG banking layouts, selected by the `FIXED_LAST` const generic:
/// - `FIXED_LAST = true` (UxROM): switchable lower bank, fixed last bank at upper window
/// - `FIXED_LAST = false` (Mapper 180): fixed first bank at lower window, switchable upper bank
/// - CHR-RAM (not CHR-ROM)
/// - Any write to $8000-$FFFF selects PRG bank
///
/// # Type Parameters
///
/// - `PRG_BANK_KB`: Size of PRG banks in kilobytes (typically 16)
/// - `MAPPER_NUM`: Mapper number for identification
/// - `FIXED_LAST`: When `true`, fixes the last bank at `$C000$FFFF` (UxROM pattern).
///   When `false`, fixes the first bank at `$8000–$BFFF` (Mapper 180 pattern).
///
/// # Example
///
/// ```rust,ignore
/// // UxROM (Mapper 2) with 16KB PRG banks, fixed last bank
/// type UxROMMapper = SimpleBankedPrgMapper<16, 2, true>;
///
/// let mapper = UxROMMapper::new(prg_rom, chr_rom, MirroringMode::Horizontal);
/// ```
pub struct SimpleBankedPrgMapper<
    const PRG_BANK_KB: usize,
    const MAPPER_NUM: u8,
    const FIXED_LAST: bool,
> {
    base: BaseMapper,
    /// Current PRG bank selection register value.
    bank_select: u8,
    /// Mask applied to bank register based on ROM size.
    bank_select_mask: u8,
}

impl<const PRG_BANK_KB: usize, const MAPPER_NUM: u8, const FIXED_LAST: bool>
    SimpleBankedPrgMapper<PRG_BANK_KB, MAPPER_NUM, FIXED_LAST>
{
    /// Create a new SimpleBankedPrgMapper.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Mapper construction context with ROM data and header details
    pub fn new(ctx: MapperContext) -> Self {
        let prg_bank_size = PRG_BANK_KB * 1024;
        let num_banks = (ctx.prg_rom.len() / prg_bank_size).max(1);
        let bank_select_mask = (num_banks.next_power_of_two() - 1) as u8;
        // Submapper 2 = explicitly no bus conflicts; all others (including 0 = original
        // UxROM hardware) emulate AND-type bus conflicts.
        let bus_conflicts = ctx.submapper != 2;

        let capabilities = MapperCapabilities {
            max_prg_ram_kb: prg_ram_size_kb(&ctx),
            prg_bank_size_kb: PRG_BANK_KB,
            ..Default::default()
        };

        let mut base = BaseMapper::new(&ctx, capabilities);
        base.configure_prg_banking(prg_bank_size);
        if FIXED_LAST {
            // UxROM pattern: fix the last bank at the upper window ($C000$FFFF)
            base.select_prg_page(1, -1);
        } else {
            // Mapper 180 pattern: fix bank 0 at the lower window ($8000–$BFFF)
            base.select_prg_page(0, 0);
        }
        base.set_bus_conflicts(bus_conflicts);

        Self {
            base,
            bank_select: 0,
            bank_select_mask,
        }
    }
}

impl<const PRG_BANK_KB: usize, const MAPPER_NUM: u8, const FIXED_LAST: bool> Mapper
    for SimpleBankedPrgMapper<PRG_BANK_KB, MAPPER_NUM, FIXED_LAST>
{
    fn base(&self) -> &BaseMapper {
        &self.base
    }

    fn base_mut(&mut self) -> &mut BaseMapper {
        &mut self.base
    }

    fn write_prg(&mut self, addr: u16, value: u8) {
        if self.base.try_write_prg_ram(addr, value) {
            return;
        }

        // Any write to $8000-$FFFF sets the bank register (masked to hardware width).
        if (0x8000..=0xFFFF).contains(&addr) {
            let effective = self.base.apply_bus_conflict(addr, value);
            self.bank_select = effective & self.bank_select_mask;
            let switchable_page = if FIXED_LAST { 0 } else { 1 };
            self.base
                .select_prg_page(switchable_page, self.bank_select as i16);
        }
    }

    fn registers_snapshot(&self) -> Vec<u8> {
        vec![self.bank_select]
    }

    fn restore_registers(&mut self, data: &[u8]) {
        if !data.is_empty() {
            self.bank_select = data[0];
            let switchable_page = if FIXED_LAST { 0 } else { 1 };
            self.base
                .select_prg_page(switchable_page, self.bank_select as i16);
        }
    }
}

/// Dual 32KB bank mapper with separate PRG and CHR bank selection.
///
/// This template implements the GxROM/ColorDreams pattern:
/// - 32KB PRG bank selection
/// - 8KB CHR bank selection
/// - Single register controls both banks with different bit masks
///
/// # Type Parameters
///
/// - `PRG_MASK`: Bit mask for PRG bank selection (e.g., 0b0011 for 2 bits)
/// - `PRG_SHIFT`: Bit shift for PRG bank (e.g., 4 for bits 4-5)
/// - `CHR_MASK`: Bit mask for CHR bank selection (e.g., 0b0011 for 2 bits)
/// - `CHR_SHIFT`: Bit shift for CHR bank (e.g., 0 for bits 0-1)
/// - `BUS_CONFLICTS`: Whether bus conflicts are enabled (CPU read AND write value)
/// - `MAPPER_NUM`: Mapper number for identification
///
/// # Example
///
/// ```rust,ignore
/// // GxROM (Mapper 66): PRG bits 4-5, CHR bits 0-1, no bus conflicts
/// type GxROMMapper = DualBank32Mapper<0b0011, 4, 0b0011, 0, false, 66>;
///
/// // ColorDreams (Mapper 11): PRG bits 0-1, CHR bits 4-7, with bus conflicts
/// type ColorDreamsMapper = DualBank32Mapper<0b0011, 0, 0b1111, 4, true, 11>;
///
/// // `ctx` is a `MapperContext` created by the cartridge loader
/// let mapper = GxROMMapper::new(ctx);
/// ```
pub struct DualBank32Mapper<
    const PRG_MASK: u8,
    const PRG_SHIFT: u8,
    const CHR_MASK: u8,
    const CHR_SHIFT: u8,
    const BUS_CONFLICTS: bool,
    const MAPPER_NUM: u8,
> {
    base: BaseMapper,
    /// Raw PRG bank register value (for snapshot/restore).
    prg_bank_raw: u8,
    /// Raw CHR bank register value (for snapshot/restore).
    chr_bank_raw: u8,
}

impl<
    const PRG_MASK: u8,
    const PRG_SHIFT: u8,
    const CHR_MASK: u8,
    const CHR_SHIFT: u8,
    const BUS_CONFLICTS: bool,
    const MAPPER_NUM: u8,
> DualBank32Mapper<PRG_MASK, PRG_SHIFT, CHR_MASK, CHR_SHIFT, BUS_CONFLICTS, MAPPER_NUM>
{
    /// Create a new DualBank32Mapper.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Mapper construction context with ROM data and header details
    pub fn new(ctx: MapperContext) -> Self {
        let capabilities = MapperCapabilities {
            has_chr_banking: true,
            max_prg_ram_kb: prg_ram_size_kb(&ctx),
            ..Default::default()
        };

        let mut base = BaseMapper::new(&ctx, capabilities);
        base.configure_prg_banking(32 * 1024); // 32KB pages → 1 slot
        base.configure_chr_banking(8 * 1024); // 8KB pages → 1 slot
        base.set_bus_conflicts(BUS_CONFLICTS);

        Self {
            base,
            prg_bank_raw: 0,
            chr_bank_raw: 0,
        }
    }
}

impl<
    const PRG_MASK: u8,
    const PRG_SHIFT: u8,
    const CHR_MASK: u8,
    const CHR_SHIFT: u8,
    const BUS_CONFLICTS: bool,
    const MAPPER_NUM: u8,
> Mapper for DualBank32Mapper<PRG_MASK, PRG_SHIFT, CHR_MASK, CHR_SHIFT, BUS_CONFLICTS, MAPPER_NUM>
{
    fn base(&self) -> &BaseMapper {
        &self.base
    }

    fn base_mut(&mut self) -> &mut BaseMapper {
        &mut self.base
    }

    fn write_prg(&mut self, addr: u16, value: u8) {
        if self.base.try_write_prg_ram(addr, value) {
            return;
        }

        if (0x8000..=0xFFFF).contains(&addr) {
            // Apply bus conflicts if enabled (AND write value with ROM data)
            let effective = self.base.apply_bus_conflict(addr, value);
            // Extract PRG and CHR banks using configured masks and shifts
            self.chr_bank_raw = (effective >> CHR_SHIFT) & CHR_MASK;
            self.prg_bank_raw = (effective >> PRG_SHIFT) & PRG_MASK;
            self.base.select_chr_page(0, self.chr_bank_raw as i16);
            self.base.select_prg_page(0, self.prg_bank_raw as i16);
        }
    }

    fn registers_snapshot(&self) -> Vec<u8> {
        vec![self.prg_bank_raw, self.chr_bank_raw]
    }

    fn restore_registers(&mut self, data: &[u8]) {
        if let Some(&value) = data.first() {
            self.prg_bank_raw = value;
            self.base.select_prg_page(0, value as i16);
        }
        if let Some(&value) = data.get(1) {
            self.chr_bank_raw = value;
            self.base.select_chr_page(0, value as i16);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::super::mapper::MapperContext;
    use super::*;
    use crate::nes::cartridge::NametableLayout;

    // Test helper to create banked data
    fn banked_data(bank_size: usize, num_banks: usize) -> Vec<u8> {
        let mut data = vec![0; bank_size * num_banks];
        for bank in 0..num_banks {
            let start = bank * bank_size;
            let end = start + bank_size;
            for byte in &mut data[start..end] {
                *byte = bank as u8;
            }
        }
        data
    }

    // SimpleFixedPrgMapper tests
    mod simple_fixed_prg {
        use super::*;

        type TestMapper = SimpleFixedPrgMapper<8, 3>;

        #[test]
        fn test_fixed_prg_no_banking() {
            let mut prg_rom = vec![0; 32 * 1024];
            for (i, byte) in prg_rom.iter_mut().enumerate() {
                *byte = (i / 1024) as u8;
            }

            let mapper = TestMapper::new(MapperContext::new_for_test(
                3,
                prg_rom,
                vec![0; 32 * 1024],
                NametableLayout::Horizontal,
            ));

            assert_eq!(mapper.read_prg(0x8000), 0);
            assert_eq!(mapper.read_prg(0x9000), 4);
            assert_eq!(mapper.read_prg(0xC000), 16);
            assert_eq!(mapper.read_prg(0xFFFF), 31);
        }

        #[test]
        fn test_chr_bank_switching() {
            let mut chr_rom = vec![0; 32 * 1024];
            for bank in 0..4 {
                let start = bank * 8 * 1024;
                let end = start + 8 * 1024;
                for byte in &mut chr_rom[start..end] {
                    *byte = (bank * 10) as u8;
                }
            }

            let mut mapper = TestMapper::new(MapperContext::new_for_test(
                3,
                vec![0xFF; 32 * 1024], // 0xFF ensures bus conflicts don't mask the bank select
                chr_rom,
                NametableLayout::Horizontal,
            ));

            assert_eq!(mapper.read_chr(0x0000), 0);

            mapper.write_prg(0x8000, 1);
            assert_eq!(mapper.read_chr(0x0000), 10);

            mapper.write_prg(0x8000, 2);
            assert_eq!(mapper.read_chr(0x0000), 20);

            mapper.write_prg(0x8000, 3);
            assert_eq!(mapper.read_chr(0x0000), 30);
        }

        #[test]
        fn test_chr_bank_wrapping() {
            let mut chr_rom = vec![0; 16 * 1024]; // Only 2 banks
            for bank in 0..2 {
                let start = bank * 8 * 1024;
                let end = start + 8 * 1024;
                for byte in &mut chr_rom[start..end] {
                    *byte = (bank * 50) as u8;
                }
            }

            let mut mapper = TestMapper::new(MapperContext::new_for_test(
                3,
                vec![0xFF; 32 * 1024], // 0xFF ensures bus conflicts don't mask the bank select
                chr_rom,
                NametableLayout::Vertical,
            ));

            mapper.write_prg(0x8000, 0b0000_0001);
            assert_eq!(mapper.read_chr(0x0000), 50);

            // Writing higher bits should wrap (only 2 banks available)
            mapper.write_prg(0x8000, 0b0000_0011); // Bank 3 wraps to bank 1
            assert_eq!(mapper.read_chr(0x0000), 50);
        }

        #[test]
        fn test_registers_snapshot_restore() {
            let mut chr_rom = vec![0; 32 * 1024];
            for bank in 0..4 {
                let start = bank * 8 * 1024;
                let end = start + 8 * 1024;
                for byte in &mut chr_rom[start..end] {
                    *byte = (bank * 7) as u8;
                }
            }

            let mut mapper = TestMapper::new(MapperContext::new_for_test(
                3,
                vec![0xFF; 32 * 1024], // 0xFF ensures bus conflicts don't mask the bank select
                chr_rom.clone(),
                NametableLayout::Horizontal,
            ));
            mapper.write_prg(0x8000, 0b0000_0011);

            let registers = mapper.registers_snapshot();

            let mut restored = TestMapper::new(MapperContext::new_for_test(
                3,
                vec![0xFF; 32 * 1024], // 0xFF ensures bus conflicts don't mask the bank select
                chr_rom,
                NametableLayout::Horizontal,
            ));
            restored.restore_registers(&registers);

            assert_eq!(restored.read_chr(0x0000), 21);
            assert_eq!(restored.read_chr(0x1FFF), 21);
        }

        #[test]
        fn test_mapper_number() {
            let mapper = TestMapper::new(MapperContext::new_for_test(
                3,
                vec![0; 32 * 1024],
                vec![0; 32 * 1024],
                NametableLayout::Horizontal,
            ));
            assert_eq!(mapper.mapper_number(), 3);
        }
    }

    // SimpleBankedPrgMapper tests
    mod simple_banked_prg {
        use super::*;

        type TestMapper = SimpleBankedPrgMapper<16, 2, true>;

        #[test]
        fn test_prg_bank_switching() {
            let mut prg_rom = vec![0; 128 * 1024]; // 8 banks of 16KB
            for bank in 0..8 {
                let start = bank * 16 * 1024;
                let end = start + 16 * 1024;
                for byte in &mut prg_rom[start..end] {
                    *byte = bank as u8;
                }
            }

            let mut mapper = TestMapper::new(
                MapperContext::new_for_test(2, prg_rom, vec![], NametableLayout::Horizontal)
                    .with_submapper(2),
            );

            // Initially bank 0 at $8000-$BFFF
            assert_eq!(mapper.read_prg(0x8000), 0);

            // Last bank (7) at $C000-$FFFF
            assert_eq!(mapper.read_prg(0xC000), 7);
            assert_eq!(mapper.read_prg(0xFFFF), 7);

            // Switch to bank 3
            mapper.write_prg(0x8000, 3);
            assert_eq!(mapper.read_prg(0x8000), 3);
            assert_eq!(mapper.read_prg(0xBFFF), 3);

            // Last bank unchanged
            assert_eq!(mapper.read_prg(0xC000), 7);
        }

        #[test]
        fn test_chr_ram() {
            let mut mapper = TestMapper::new(MapperContext::new_for_test(
                2,
                vec![0; 128 * 1024],
                vec![],
                NametableLayout::Horizontal,
            ));

            mapper.write_chr(0x0000, 0xAA);
            mapper.write_chr(0x1000, 0xBB);
            mapper.write_chr(0x1FFF, 0xCC);

            assert_eq!(mapper.read_chr(0x0000), 0xAA);
            assert_eq!(mapper.read_chr(0x1000), 0xBB);
            assert_eq!(mapper.read_chr(0x1FFF), 0xCC);
        }

        #[test]
        fn test_fixed_last_bank() {
            let mut prg_rom = vec![0; 256 * 1024]; // 16 banks
            for bank in 0..16 {
                let start = bank * 16 * 1024;
                let end = start + 16 * 1024;
                for byte in &mut prg_rom[start..end] {
                    *byte = (bank + 100) as u8;
                }
            }

            let mut mapper = TestMapper::new(MapperContext::new_for_test(
                2,
                prg_rom,
                vec![],
                NametableLayout::Horizontal,
            ));

            // Last bank should always be 115 (bank 15 + 100)
            assert_eq!(mapper.read_prg(0xC000), 115);

            mapper.write_prg(0x8000, 0);
            assert_eq!(mapper.read_prg(0xC000), 115);

            mapper.write_prg(0x8000, 5);
            assert_eq!(mapper.read_prg(0xC000), 115);
        }

        #[test]
        fn test_registers_snapshot_restore() {
            let mut prg_rom = vec![0; 128 * 1024];
            for bank in 0..8 {
                let start = bank * 16 * 1024;
                let end = start + 16 * 1024;
                for byte in &mut prg_rom[start..end] {
                    *byte = bank as u8;
                }
            }

            let mut mapper = TestMapper::new(
                MapperContext::new_for_test(
                    2,
                    prg_rom.clone(),
                    vec![],
                    NametableLayout::Horizontal,
                )
                .with_submapper(2),
            );
            mapper.write_prg(0x8000, 3);
            mapper.write_chr(0x0000, 0x5A);

            let regs = mapper.registers_snapshot();
            let chr = mapper.chr_ram_snapshot();

            let mut restored = TestMapper::new(
                MapperContext::new_for_test(2, prg_rom, vec![], NametableLayout::Horizontal)
                    .with_submapper(2),
            );
            restored.restore_registers(&regs);
            restored.restore_chr_ram(&chr);

            assert_eq!(restored.read_prg(0x8000), 3);
            assert_eq!(restored.read_chr(0x0000), 0x5A);
        }

        #[test]
        fn test_mapper_number() {
            let mapper = TestMapper::new(MapperContext::new_for_test(
                2,
                vec![0; 128 * 1024],
                vec![],
                NametableLayout::Horizontal,
            ));
            assert_eq!(mapper.mapper_number(), 2);
        }
    }

    // DualBank32Mapper tests
    mod dual_bank32 {
        use super::*;

        // GxROM: PRG bits 4-5, CHR bits 0-1, no bus conflicts
        type GxROMTestMapper = DualBank32Mapper<0b0011, 4, 0b0011, 0, false, 66>;
        // Wide 4-bit masks: PRG bits 4-7, CHR bits 0-3, no bus conflicts
        // (tests wider mask values than GxROM's 2-bit masks)
        type WideMaskTestMapper = DualBank32Mapper<0b1111, 4, 0b1111, 0, false, 11>;
        // Bus conflict variant: PRG bits 0-1, CHR bits 4-7, bus conflicts enabled
        // (matches real ColorDreams register layout)
        type BusConflictTestMapper = DualBank32Mapper<0b0011, 0, 0b1111, 4, true, 11>;

        #[test]
        fn test_gxrom_bank_selection() {
            let prg_rom = banked_data(32 * 1024, 4);
            let chr_rom = banked_data(8 * 1024, 4);

            let mut mapper = GxROMTestMapper::new(MapperContext::new_for_test(
                66,
                prg_rom,
                chr_rom,
                NametableLayout::Horizontal,
            ));

            // Initial banks
            assert_eq!(mapper.read_prg(0x8000), 0);
            assert_eq!(mapper.read_chr(0x0000), 0);

            // Select PRG bank 1, CHR bank 2: 0b0001_0010 = 0x12
            mapper.write_prg(0x8000, 0x12);
            assert_eq!(mapper.read_prg(0x8000), 1);
            assert_eq!(mapper.read_chr(0x0000), 2);
        }

        #[test]
        fn test_wide_mask_bank_selection() {
            let prg_rom = banked_data(32 * 1024, 16);
            let chr_rom = banked_data(8 * 1024, 16);

            let mut mapper = WideMaskTestMapper::new(MapperContext::new_for_test(
                11,
                prg_rom,
                chr_rom,
                NametableLayout::Horizontal,
            ));

            // Select PRG bank 8, CHR bank 5: 0b1000_0101 = 0x85
            mapper.write_prg(0x8000, 0x85);
            assert_eq!(mapper.read_prg(0x8000), 8);
            assert_eq!(mapper.read_chr(0x0000), 5);

            // Select PRG bank 15, CHR bank 15: 0b1111_1111 = 0xFF
            mapper.write_prg(0x8000, 0xFF);
            assert_eq!(mapper.read_prg(0x8000), 15);
            assert_eq!(mapper.read_chr(0x0000), 15);
        }

        #[test]
        fn test_bank_wrapping() {
            let prg_rom = banked_data(32 * 1024, 4); // Only 4 banks
            let chr_rom = banked_data(8 * 1024, 2); // Only 2 banks

            let mut mapper = WideMaskTestMapper::new(MapperContext::new_for_test(
                11,
                prg_rom,
                chr_rom,
                NametableLayout::Horizontal,
            ));

            // Select bank 5, should wrap to bank 1 (5 % 4 = 1)
            mapper.write_prg(0x8000, 0x50); // 0b0101_0000
            assert_eq!(mapper.read_prg(0x8000), 1);

            // Select CHR bank 3, should wrap to bank 1 (3 % 2 = 1)
            mapper.write_prg(0x8000, 0x03); // 0b0000_0011
            assert_eq!(mapper.read_chr(0x0000), 1);
        }

        #[test]
        fn test_registers_snapshot_restore() {
            let prg_rom = banked_data(32 * 1024, 4);
            let chr_rom = banked_data(8 * 1024, 4);

            let mut mapper = GxROMTestMapper::new(MapperContext::new_for_test(
                66,
                prg_rom.clone(),
                chr_rom.clone(),
                NametableLayout::Horizontal,
            ));
            mapper.write_prg(0x8000, 0x21); // PRG bank 2, CHR bank 1

            let snapshot = mapper.registers_snapshot();

            let mut restored = GxROMTestMapper::new(MapperContext::new_for_test(
                66,
                prg_rom,
                chr_rom,
                NametableLayout::Horizontal,
            ));
            restored.restore_registers(&snapshot);

            assert_eq!(restored.read_prg(0x8000), 2);
            assert_eq!(restored.read_chr(0x0000), 1);
        }

        #[test]
        fn test_mapper_numbers() {
            let prg_rom = vec![0; 128 * 1024];
            let chr_rom = vec![0; 32 * 1024];

            let gxrom = GxROMTestMapper::new(MapperContext::new_for_test(
                66,
                prg_rom.clone(),
                chr_rom.clone(),
                NametableLayout::Horizontal,
            ));
            assert_eq!(gxrom.mapper_number(), 66);

            let wide_mask = WideMaskTestMapper::new(MapperContext::new_for_test(
                11,
                prg_rom,
                chr_rom,
                NametableLayout::Horizontal,
            ));
            assert_eq!(wide_mask.mapper_number(), 11);
        }

        #[test]
        fn test_bus_conflicts_mask_write_value() {
            // PRG-ROM bank 0 filled with 0x00: bus conflict ANDs write value with 0x00
            let mut prg_rom = vec![0u8; 4 * 32 * 1024];
            // Bank 1 filled with 0x01
            for byte in &mut prg_rom[32 * 1024..2 * 32 * 1024] {
                *byte = 0x01;
            }
            let chr_rom = banked_data(8 * 1024, 16);

            let mut mapper = BusConflictTestMapper::new(MapperContext::new_for_test(
                11,
                prg_rom,
                chr_rom,
                NametableLayout::Horizontal,
            ));

            // Bank 0 is selected, all bytes are 0x00.
            // Write 0x01 to $8000: bus conflict → 0x01 & 0x00 = 0x00, so bank stays 0.
            mapper.write_prg(0x8000, 0x01);
            assert_eq!(
                mapper.read_prg(0x8000),
                0,
                "bus conflict should mask the write"
            );
        }

        #[test]
        fn test_no_bus_conflicts_when_disabled() {
            let prg_rom = banked_data(32 * 1024, 4);
            let chr_rom = banked_data(8 * 1024, 4);

            let mut mapper = GxROMTestMapper::new(MapperContext::new_for_test(
                66,
                prg_rom,
                chr_rom,
                NametableLayout::Horizontal,
            ));

            // Write bank 1 to PRG (bit 4 = 0x10): no bus conflicts, so it works
            mapper.write_prg(0x8000, 0x10);
            assert_eq!(
                mapper.read_prg(0x8000),
                1,
                "no bus conflict, bank should switch"
            );
        }
    }
}