1 files changed, 70 insertions, 0 deletions
diff --git a/src/VeriFuzz/General.hs b/src/VeriFuzz/General.hs
new file mode 100644
index 0000000..dbd1da0
--- /dev/null
+++ b/src/VeriFuzz/General.hs
@@ -0,0 +1,70 @@
+{-|
+Module      : VeriFuzz.Simulator.General
+Description : Class of the simulator.
+Copyright   : (c) 2018-2019, Yann Herklotz Grave
+License     : BSD-3
+Maintainer  : ymherklotz [at] gmail [dot] com
+Stability   : experimental
+Portability : POSIX
+
+Class of the simulator and the synthesize tool.
+-}
+
+module VeriFuzz.Simulator.General where
+
+import           Data.Bits             (shiftL)
+import           Data.ByteString       (ByteString)
+import qualified Data.ByteString       as B
+import           Data.Text             (Text)
+import qualified Data.Text             as T
+import           Prelude               hiding (FilePath)
+import           Shelly
+import           System.FilePath.Posix (takeBaseName)
+import           VeriFuzz.Verilog.AST
+
+-- | Simulator class.
+class Simulator a where
+  toText :: a -> Text
+
+-- | Simulation type class.
+class (Simulator a) => Simulate a where
+  runSim :: a            -- ^ Simulator instance
+         -> ModDecl      -- ^ Module to simulate
+         -> [ByteString] -- ^ Inputs to simulate
+         -> Sh Int       -- ^ Returns the value of the hash at the output of the testbench.
+
+-- | Synthesize type class.
+class (Simulator a) => Synthesize a where
+  runSynth :: a        -- ^ Synthesize tool instance
+           -> ModDecl  -- ^ Module to synthesize
+           -> FilePath -- ^ Output verilog file for the module
+           -> Sh ()    -- ^ does not return any values
+
+rootPath :: Sh FilePath
+rootPath = do
+  current <- pwd
+  maybe current fromText <$> get_env "VERIFUZZ_ROOT"
+
+timeout :: FilePath -> [Text] -> Sh Text
+timeout = command1 "timeout" ["180"] . toTextIgnore
+{-# INLINE timeout #-}
+
+timeout_ :: FilePath -> [Text] -> Sh ()
+timeout_ = command1_ "timeout" ["180"] . toTextIgnore
+{-# INLINE timeout_ #-}
+
+-- | Helper function to convert bytestrings to integers
+bsToI :: ByteString -> Integer
+bsToI = B.foldl' (\i b -> (i `shiftL` 8) + fromIntegral b) 0
+{-# INLINE bsToI #-}
+
+noPrint :: Sh a -> Sh a
+noPrint =
+  print_stdout False . print_stderr False
+
+echoP :: Text -> Sh ()
+echoP t = do
+  fn <- pwd
+  echo $ bname fn <> " :: " <> t
+  where
+    bname = T.pack . takeBaseName . T.unpack . toTextIgnore