Add unit test for opcode modifier table

Author: ian-h-chamberlain

Cargo.lock

@@ -5,6 +5,7 @@ authors = ["Ian Chamberlain <[email protected]>"]
 edition = "2018"
 
 [dependencies]
+itertools = "0.8.0"
 lazy_static = "1.2.0"
 pest_derive = "2.1.0"
 pest = "2.1.0"

Cargo.toml

@@ -1,10 +1,16 @@
+// Extern crates requiring macro_use
 #[macro_use]
 extern crate pest_derive;
+
+// Extern crates
+extern crate itertools;
 extern crate pest;
 
+pub use parser::parse;
+
+// Modules requiring macro_use
 #[macro_use]
 mod util;
 
-pub mod parser;
-
 mod load_file;
+mod parser;

src/lib.rs

@@ -35,13 +35,13 @@ enum_string!(pub PseudoOpcode, {
 });
 
 enum_string!(pub Modifier, {
-    A => "A",
-    B => "B",
-    AB => "AB",
-    BA => "BA",
-    F => "F",
-    X => "X",
-    I => "I",
+    A   => "A",
+    B   => "B",
+    AB  => "AB",
+    BA  => "BA",
+    F   => "F",
+    X   => "X",
+    I   => "I",
 });
 
 impl Default for Modifier {
@@ -52,6 +52,8 @@ impl Default for Modifier {
 
 impl Modifier {
     pub fn from_context(opcode: Opcode, a_mode: AddressMode, b_mode: AddressMode) -> Modifier {
+        /// Implemented based on the ICWS '94 document,
+        /// section A.2.1.2: ICWS'88 to ICWS'94 Conversion
         use Opcode::*;
 
         match opcode {
@@ -67,6 +69,7 @@ impl Modifier {
                         Mov | Cmp | Seq | Sne => Modifier::I,
                         Slt => Modifier::B,
                         Add | Sub | Mul | Div | Mod => Modifier::F,
+                        _ => unreachable!(),
                     }
                 }
             }
@@ -75,14 +78,14 @@ impl Modifier {
 }
 
 enum_string!(pub AddressMode, {
-    Immediate => "#",
-    Direct => "$",
-    IndirectA => "*",
-    IndirectB => "@",
-    PreDecIndirectA => "{",
-    PreDecIndirectB => "<",
-    PostIncIndirectA => "}",
-    PostIncIndirectB => ">",
+    Immediate           => "#",
+    Direct              => "$",
+    IndirectA           => "*",
+    IndirectB           => "@",
+    PreDecIndirectA     => "{",
+    PreDecIndirectB     => "<",
+    PostIncIndirectA    => "}",
+    PostIncIndirectB    => ">",
 });
 
 impl Default for AddressMode {
@@ -214,8 +217,20 @@ impl PartialEq for Core {
 
 #[cfg(test)]
 mod tests {
+    use itertools::iproduct;
+    use lazy_static::lazy_static;
+
+    use std::str::FromStr;
+
     use super::*;
 
+    lazy_static! {
+        static ref all_modes: vec::Vec<AddressMode> = ["#", "$", "@", "<", ">", "*", "{", "}"]
+            .iter()
+            .map(|mode_str| AddressMode::from_str(mode_str).unwrap())
+            .collect();
+    }
+
     #[test]
     fn default_instruction() {
         let expected_instruction = Instruction {
@@ -233,4 +248,61 @@ mod tests {
 
         assert_eq!(Instruction::default(), expected_instruction)
     }
+
+    #[test]
+    fn dat_from_context() {
+        for (&a_mode, &b_mode) in iproduct!(all_modes.iter(), all_modes.iter()) {
+            assert_eq!(
+                Modifier::from_context(Opcode::Dat, a_mode, b_mode),
+                Modifier::F
+            );
+        }
+    }
+
+    #[test]
+    fn modifier_b_from_context() {
+        use Opcode::*;
+
+        let opcodes = [Jmp, Jmz, Jmn, Djn, Spl, Nop];
+
+        for (&a_mode, &b_mode) in iproduct!(all_modes.iter(), all_modes.iter()) {
+            for &opcode in opcodes.iter() {
+                assert_eq!(Modifier::from_context(opcode, a_mode, b_mode), Modifier::B);
+            }
+        }
+
+        let a_modes: vec::Vec<AddressMode> = ["$", "@", "<", ">", "*", "{", "}"]
+            .iter()
+            .map(|mode_str| AddressMode::from_str(mode_str).unwrap())
+            .collect();
+
+        for &a_mode in a_modes.iter() {
+            for &b_mode in all_modes.iter() {
+                assert_eq!(
+                    Modifier::from_context(Opcode::Slt, a_mode, b_mode),
+                    Modifier::B
+                )
+            }
+        }
+
+        // TODO Mov, Cmp. Seq, Sne -> B
+    }
+
+    #[test]
+    fn modifier_ab_from_context() {
+        use Opcode::*;
+
+        let opcodes = [Mov, Cmp, Seq, Sne, Add, Sub, Mul, Div, Mod, Slt];
+
+        for &b_mode in all_modes.iter() {
+            for &opcode in opcodes.iter() {
+                assert_eq!(
+                    Modifier::from_context(opcode, AddressMode::Immediate, b_mode),
+                    Modifier::AB
+                );
+            }
+        }
+    }
+
+    // TODO Mode I
 }

src/load_file.rs

@@ -18,7 +18,7 @@ macro_rules! enum_string {
             $($variant,)*
         }
 
-        impl std::string::ToString for $name {
+        impl ::std::string::ToString for $name {
             fn to_string(&self) -> String {
                 use $name::*;
                 match *self {
@@ -27,7 +27,7 @@ macro_rules! enum_string {
             }
         }
 
-        impl std::str::FromStr for $name {
+        impl ::std::str::FromStr for $name {
             type Err = String;
             fn from_str(input_str: &str) -> Result<Self, Self::Err> {
                 use $name::*;

src/util.rs

@@ -1,14 +1,12 @@
 extern crate corewa_rs;
 
-use corewa_rs::parser;
-
 #[test]
 fn test_parse() {
     let test_warrior = include_str!("test_file.red");
 
     println!("Parsing warrior:\n{}", test_warrior);
 
-    let core = parser::parse(test_warrior).unwrap();
+    let core = corewa_rs::parse(test_warrior).unwrap();
 
     println!("Loaded core:\n{:?}", core);