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
//! Contains operations on CPU registers

pub use crate::instructions::{AccRegister, ByteRegisterTarget, StackRegister};

use core::convert::TryFrom;

use alloc::string::String;

pub struct RegisterParseError(String);

#[derive(Debug, PartialEq, Eq, Copy, Clone)]
/// All 8-bit registers
pub enum ByteRegister {
    A,
    F,
    B,
    C,
    D,
    E,
    H,
    L,
}

impl core::str::FromStr for ByteRegister {
    type Err = RegisterParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "A" => Ok(ByteRegister::A),
            "B" => Ok(ByteRegister::B),
            "C" => Ok(ByteRegister::C),
            "D" => Ok(ByteRegister::D),
            "E" => Ok(ByteRegister::E),
            "F" => Ok(ByteRegister::F),
            "H" => Ok(ByteRegister::H),
            "L" => Ok(ByteRegister::L),
            _ => Err(RegisterParseError(String::from(s))),
        }
    }
}

#[derive(Debug, PartialEq, Eq, Copy, Clone)]
/// All 16-bit registers
pub enum WordRegister {
    AF,
    BC,
    DE,
    HL,
    SP,
    PC,
}

impl WordRegister {
    pub fn all() -> [WordRegister; 6] {
        use WordRegister as wr;
        [wr::AF, wr::BC, wr::DE, wr::HL, wr::SP, wr::PC]
    }
}

impl core::str::FromStr for WordRegister {
    type Err = RegisterParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "AF" => Ok(WordRegister::AF),
            "BC" => Ok(WordRegister::BC),
            "DE" => Ok(WordRegister::DE),
            "HL" => Ok(WordRegister::HL),
            "SP" => Ok(WordRegister::SP),
            "PC" => Ok(WordRegister::PC),
            _ => Err(RegisterParseError(String::from(s))),
        }
    }
}

impl From<AccRegister> for WordRegister {
    fn from(reg: AccRegister) -> WordRegister {
        match reg {
            AccRegister::AF => WordRegister::AF,
            AccRegister::BC => WordRegister::BC,
            AccRegister::DE => WordRegister::DE,
            AccRegister::HL => WordRegister::HL,
        }
    }
}

impl From<StackRegister> for WordRegister {
    fn from(reg: StackRegister) -> WordRegister {
        match reg {
            StackRegister::SP => WordRegister::SP,
            StackRegister::BC => WordRegister::BC,
            StackRegister::DE => WordRegister::DE,
            StackRegister::HL => WordRegister::HL,
        }
    }
}

#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum WordByte {
    High,
    Low,
}

impl ByteRegister {
    /// Returns whether this 8-bit register is the high or low byte
    /// of its 16bit register
    pub fn lookup_byte(self) -> WordByte {
        match self {
            ByteRegister::A => WordByte::High,
            ByteRegister::F => WordByte::Low,
            ByteRegister::B => WordByte::High,
            ByteRegister::C => WordByte::Low,
            ByteRegister::D => WordByte::High,
            ByteRegister::E => WordByte::Low,
            ByteRegister::H => WordByte::High,
            ByteRegister::L => WordByte::Low,
        }
    }

    /// Returns which 16-bit register this 8-bit register
    /// is part of
    pub fn lookup_word_register(self) -> WordRegister {
        match self {
            ByteRegister::A => WordRegister::AF,
            ByteRegister::F => WordRegister::AF,
            ByteRegister::B => WordRegister::BC,
            ByteRegister::C => WordRegister::BC,
            ByteRegister::D => WordRegister::DE,
            ByteRegister::E => WordRegister::DE,
            ByteRegister::H => WordRegister::HL,
            ByteRegister::L => WordRegister::HL,
        }
    }
}

impl TryFrom<ByteRegisterTarget> for ByteRegister {
    type Error = ();

    fn try_from(lookup: ByteRegisterTarget) -> Result<ByteRegister, ()> {
        match lookup {
            ByteRegisterTarget::A => Ok(ByteRegister::A),
            ByteRegisterTarget::B => Ok(ByteRegister::B),
            ByteRegisterTarget::C => Ok(ByteRegister::C),
            ByteRegisterTarget::D => Ok(ByteRegister::D),
            ByteRegisterTarget::E => Ok(ByteRegister::E),
            ByteRegisterTarget::H => Ok(ByteRegister::H),
            ByteRegisterTarget::L => Ok(ByteRegister::L),
            ByteRegisterTarget::HLIndirect => Err(()),
        }
    }
}

/// Represents a CPU flag set after some instructions.
///
/// Note that many instructions leave flags alone,
/// and others may repurpose them for side channel information.
pub enum Flag {
    /// The last arithmetic operation resulted in 0
    Zero,
    /// The last arithmetic operation was a subtract type operation
    /// 0 = Add, 1 = Sub
    AddSubtract,
    /// The last arithmetic operation contained a carry between nibbles
    HalfCarry,
    /// The last arithmetic operation overflowed or underflowed
    Carry,
}

impl Flag {
    /// Returns which bit of the flag register represents this flag
    pub fn bit(&self) -> u8 {
        match self {
            Flag::Zero => 7,
            Flag::AddSubtract => 6,
            Flag::HalfCarry => 5,
            Flag::Carry => 4,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_lookup_register() {
        assert_eq!(ByteRegister::A.lookup_word_register(), WordRegister::AF);
        assert_eq!(ByteRegister::F.lookup_word_register(), WordRegister::AF);
        assert_eq!(ByteRegister::B.lookup_word_register(), WordRegister::BC);
        assert_eq!(ByteRegister::C.lookup_word_register(), WordRegister::BC);
        assert_eq!(ByteRegister::D.lookup_word_register(), WordRegister::DE);
        assert_eq!(ByteRegister::E.lookup_word_register(), WordRegister::DE);
        assert_eq!(ByteRegister::H.lookup_word_register(), WordRegister::HL);
        assert_eq!(ByteRegister::L.lookup_word_register(), WordRegister::HL);
    }

    #[test]
    fn test_flag_bit() {
        assert_eq!(Flag::Zero.bit(), 7);
        assert_eq!(Flag::AddSubtract.bit(), 6);
        assert_eq!(Flag::HalfCarry.bit(), 5);
        assert_eq!(Flag::Carry.bit(), 4);
    }
}