]> gitweb.michael.orlitzky.com - hath.git/blobdiff - src/Octet.hs
Update for QuickCheck 2.
[hath.git] / src / Octet.hs
index f8af4df8c90ec51f6db9bac93e92a1d1abc7c79f..7faf1d7851c18ac864147c2b5220c568ffe1a5b4 100644 (file)
@@ -1,19 +1,59 @@
 module Octet where
 
-import Bit
+import Test.HUnit
+import Test.QuickCheck
+
+import Bit as B
+import Maskable
+import Maskbits
 
 -- An Octet consists of eight bits. For our purposes, the most
 -- significant bit will come "first." That is, b1 is in the 2^7
 -- place while b8 is in the 2^0 place.
-data Octet = Octet { b1 :: Bit,
-                     b2 :: Bit,
-                     b3 :: Bit,
-                     b4 :: Bit,
-                     b5 :: Bit,
-                     b6 :: Bit,
-                     b7 :: Bit,
-                     b8 :: Bit }
-           deriving (Eq, Show)
+data Octet = None | Octet { b1 :: Bit,
+                            b2 :: Bit,
+                            b3 :: Bit,
+                            b4 :: Bit,
+                            b5 :: Bit,
+                            b6 :: Bit,
+                            b7 :: Bit,
+                            b8 :: Bit }
+           deriving (Eq)
+
+
+instance Show Octet where
+    show Octet.None = "None"
+    show oct = show (octet_to_int oct)
+
+
+instance Arbitrary Octet where
+    arbitrary = do
+      a1 <- arbitrary :: Gen Bit
+      a2 <- arbitrary :: Gen Bit
+      a3 <- arbitrary :: Gen Bit
+      a4 <- arbitrary :: Gen Bit
+      a5 <- arbitrary :: Gen Bit
+      a6 <- arbitrary :: Gen Bit
+      a7 <- arbitrary :: Gen Bit
+      a8 <- arbitrary :: Gen Bit
+      return (Octet a1 a2 a3 a4 a5 a6 a7 a8)
+
+
+instance Maskable Octet where
+    apply_mask _ Maskbits.None _ = Octet.None
+    apply_mask Octet.None _ _    = Octet.None
+    apply_mask oct mask bit
+        | mask == Eight = oct
+        | mask == Seven = oct { b8 = bit }
+        | mask == Six = oct { b8 = bit, b7 = bit }
+        | mask == Five = oct { b8 = bit, b7 = bit, b6 = bit }
+        | mask == Four = oct { b8 = bit, b7 = bit, b6 = bit, b5 = bit }
+        | mask == Three = oct { b8 = bit, b7 = bit, b6 = bit, b5 = bit, b4 = bit }
+        | mask == Two = oct { b8 = bit, b7 = bit, b6 = bit, b5 = bit, b4 = bit, b3 = bit }
+        | mask == Maskbits.One = oct { b8 = bit, b7 = bit, b6 = bit, b5 = bit, b4 = bit, b3 = bit, b2 = bit }
+        | mask == Maskbits.Zero = oct { b8 = bit, b7 = bit, b6 = bit, b5 = bit, b4 = bit, b3 = bit, b2 = bit, b1 = bit }
+        | otherwise = Octet.None
+
 
 -- Convert each bit to its integer value, and multiply by the
 -- appropriate power of two. Sum them up, and we should get an integer
@@ -27,30 +67,68 @@ octet_to_int x =
     8   * (bit_to_int (b5 x)) +
     4   * (bit_to_int (b6 x)) +
     2   * (bit_to_int (b7 x)) +
-    0   * (bit_to_int (b8 x))
+    1   * (bit_to_int (b8 x))
+
 
 
--- Supply an integer greater than 255 at your own risk.
 octet_from_int :: Int -> Octet
 octet_from_int x
-    | (x < 0) = min_octet 
+    | (x < 0) || (x > 255) = Octet.None
     | otherwise = (Octet a1 a2 a3 a4 a5 a6 a7 a8)
     where
-      a1 = if (x `mod` 128) > 0 then One else Zero
-      a2 = if (x `mod` 64)  > 0 then One else Zero
-      a3 = if (x `mod` 32)  > 0 then One else Zero           
-      a4 = if (x `mod` 16)  > 0 then One else Zero
-      a5 = if (x `mod` 8)   > 0 then One else Zero
-      a6 = if (x `mod` 4)   > 0 then One else Zero
-      a7 = if (x `mod` 2)   > 0 then One else Zero           
-      a8 = if (x `mod` 1)   > 0 then One else Zero
+      a1 = if (x >= 128) then B.One else B.Zero
+      a2 = if ((x `mod` 128) >= 64) then B.One else B.Zero
+      a3 = if ((x `mod` 64)  >= 32) then B.One else B.Zero
+      a4 = if ((x `mod` 32)  >= 16) then B.One else B.Zero
+      a5 = if ((x `mod` 16)  >= 8)  then B.One else B.Zero
+      a6 = if ((x `mod` 8)   >= 4)  then B.One else B.Zero
+      a7 = if ((x `mod` 4)   >= 2)  then B.One else B.Zero
+      a8 = if ((x `mod` 2)   == 1)  then B.One else B.Zero
+
+
+octet_from_string :: String -> Octet
+octet_from_string s =
+    case (reads s :: [(Int, String)]) of
+      []   -> Octet.None
+      x:_ -> octet_from_int (fst x)
 
 
 -- The octet with the least possible value.
 min_octet :: Octet
-min_octet = Octet Zero Zero Zero Zero Zero Zero Zero Zero
+min_octet = Octet B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero
 
 
 -- The octet with the greatest possible value.
 max_octet :: Octet
-max_octet = Octet One One One One One One One One
+max_octet = Octet B.One B.One B.One B.One B.One B.One B.One B.One
+
+
+
+-- HUnit Tests
+test_octet_from_int1 :: Test
+test_octet_from_int1 =
+    TestCase $ assertEqual "octet_from_int 128 should parse as 10000000" oct1 (octet_from_int 128)
+    where
+      oct1 = Octet B.One B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero
+
+
+test_octet_mask1 :: Test
+test_octet_mask1 =
+    TestCase $ assertEqual "The network bits of 255/4 should equal 240" oct2 (apply_mask oct1 Four B.Zero)
+    where
+      oct1 = octet_from_int 255
+      oct2 = octet_from_int 240
+
+
+test_octet_mask2 :: Test
+test_octet_mask2 =
+    TestCase $ assertEqual "The network bits of 255/1 should equal 128" oct2 (apply_mask oct1 Maskbits.One B.Zero)
+    where
+      oct1 = octet_from_int 255
+      oct2 = octet_from_int 128
+
+
+octet_tests :: [Test]
+octet_tests = [ test_octet_from_int1,
+                test_octet_mask1,
+                test_octet_mask2 ]