Mark all signals as ports or states when appropriate.
[matthijs/master-project/cλash.git] / FlattenTypes.hs
index 81088bae598b75a503b407cb29bfe6e81dcc3e87..ce1f22dc00bbece034db0108d6ae6b6f52217cc0 100644 (file)
@@ -1,37 +1,20 @@
 module FlattenTypes where
 
+import qualified Maybe
 import Data.Traversable
+import qualified Data.Foldable as Foldable
 import qualified Control.Monad.State as State
 
 import CoreSyn
+import qualified Type
 
 import HsValueMap
 
 -- | A signal identifier
-type SignalId = Int
+type UnnamedSignal = Int
 
--- | A use of a signal
-data SignalUse = SignalUse {
-  sigUseId :: SignalId
-} deriving (Show, Eq)
-
--- | A def of a signal
-data SignalDef = SignalDef {
-  sigDefId :: SignalId
-} deriving (Show, Eq)
-
--- | A map of a Haskell value to signal uses
-type SignalUseMap = HsValueMap SignalUse
--- | A map of a Haskell value to signal defs
-type SignalDefMap = HsValueMap SignalDef
-
--- | Translate a SignalUseMap to an equivalent SignalDefMap
-useMapToDefMap :: SignalUseMap -> SignalDefMap
-useMapToDefMap = fmap (\(SignalUse u) -> SignalDef u)
-
--- | Translate a SignalDefMap to an equivalent SignalUseMap 
-defMapToUseMap :: SignalDefMap -> SignalUseMap
-defMapToUseMap = fmap (\(SignalDef u) -> SignalUse u)
+-- | A map of a Haskell value to signal ids
+type SignalMap sigid = HsValueMap sigid
 
 -- | How is a given (single) value in a function's type (ie, argument or
 -- return value) used?
@@ -47,6 +30,11 @@ data HsValueUse =
   }
   deriving (Show, Eq, Ord)
 
+-- | Is this HsValueUse a state use?
+isStateUse :: HsValueUse -> Bool
+isStateUse (State _) = True
+isStateUse _         = False
+
 -- | A map from a Haskell value to the use of each single value
 type HsUseMap = HsValueMap HsValueUse
 
@@ -79,60 +67,91 @@ data HsFunction = HsFunction {
   hsFuncRes  :: HsUseMap
 } deriving (Show, Eq, Ord)
 
+hasState :: HsFunction -> Bool
+hasState hsfunc = 
+  any (Foldable.any isStateUse) (hsFuncArgs hsfunc)
+  || Foldable.any isStateUse (hsFuncRes hsfunc)
+
 -- | A flattened function application
-data FApp = FApp {
+data FApp sigid = FApp {
   appFunc :: HsFunction,
-  appArgs :: [SignalUseMap],
-  appRes  :: SignalDefMap
+  appArgs :: [SignalMap sigid],
+  appRes  :: SignalMap sigid
 } deriving (Show, Eq)
 
 -- | A conditional signal definition
-data CondDef = CondDef {
-  cond    :: SignalUse,
-  high    :: SignalUse,
-  low     :: SignalUse,
-  condRes :: SignalDef
+data CondDef sigid = CondDef {
+  cond    :: sigid,
+  high    :: sigid,
+  low     :: sigid,
+  condRes :: sigid
 } deriving (Show, Eq)
 
+-- | How is a given signal used in the resulting VHDL?
+data SigUse = 
+  SigPortIn          -- | Use as an input port
+  | SigPortOut       -- | Use as an input port
+  | SigInternal      -- | Use as an internal signal
+  | SigStateOld Int  -- | Use as the current internal state
+  | SigStateNew Int  -- | Use as the new internal state
+  | SigSubState      -- | Do not use, state variable is used in a subcircuit
+
+-- | Information on a signal definition
+data SignalInfo = SignalInfo {
+  sigName :: Maybe String,
+  sigUse  :: SigUse,
+  sigTy   :: Type.Type
+}
+
 -- | A flattened function
-data FlatFunction = FlatFunction {
-  args   :: [SignalDefMap],
-  res    :: SignalUseMap,
-  --sigs   :: [SignalDef],
-  apps   :: [FApp],
-  conds  :: [CondDef]
-} deriving (Show, Eq)
+data FlatFunction' sigid = FlatFunction {
+  flat_args   :: [SignalMap sigid],
+  flat_res    :: SignalMap sigid,
+  flat_apps   :: [FApp sigid],
+  flat_conds  :: [CondDef sigid],
+  flat_sigs   :: [(sigid, SignalInfo)]
+}
+
+-- | Lookup a given signal id in a signal map, and return the associated
+--   SignalInfo. Errors out if the signal was not found.
+signalInfo :: Eq sigid => [(sigid, SignalInfo)] -> sigid -> SignalInfo
+signalInfo sigs id = Maybe.fromJust $ lookup id sigs
+
+-- | A flat function that does not have its signals named
+type FlatFunction = FlatFunction' UnnamedSignal
 
 -- | A list of binds in effect at a particular point of evaluation
 type BindMap = [(
   CoreBndr,            -- ^ The bind name
   Either               -- ^ The bind value which is either
-    SignalUseMap       -- ^ a signal
+    (SignalMap UnnamedSignal)
+                       -- ^ a signal
     (
       HsValueUse,      -- ^ or a HighOrder function
-      [SignalUse]      -- ^ With these signals already applied to it
+      [UnnamedSignal]  -- ^ With these signals already applied to it
     )
   )]
 
 -- | The state during the flattening of a single function
-type FlattenState = State.State ([FApp], [CondDef], SignalId)
+type FlattenState = State.State ([FApp UnnamedSignal], [CondDef UnnamedSignal], [(UnnamedSignal, SignalInfo)], UnnamedSignal)
 
 -- | Add an application to the current FlattenState
-addApp :: FApp -> FlattenState ()
+addApp :: (FApp UnnamedSignal) -> FlattenState ()
 addApp a = do
-  (apps, conds, n) <- State.get
-  State.put (a:apps, conds, n)
+  (apps, conds, sigs, n) <- State.get
+  State.put (a:apps, conds, sigs, n)
 
 -- | Add a conditional definition to the current FlattenState
-addCondDef :: CondDef -> FlattenState ()
+addCondDef :: (CondDef UnnamedSignal) -> FlattenState ()
 addCondDef c = do
-  (apps, conds, n) <- State.get
-  State.put (apps, c:conds, n)
+  (apps, conds, sigs, n) <- State.get
+  State.put (apps, c:conds, sigs, n)
 
 -- | Generates a new signal id, which is unique within the current flattening.
-genSignalId :: FlattenState SignalId 
-genSignalId = do
-  (apps, conds, n) <- State.get
-  State.put (apps, conds, n+1)
+genSignalId :: SigUse -> Type.Type -> FlattenState UnnamedSignal 
+genSignalId use ty = do
+  (apps, conds, sigs, n) <- State.get
+  -- Generate a new numbered but unnamed signal
+  let s = (n, SignalInfo Nothing use ty)
+  State.put (apps, conds, s:sigs, n+1)
   return n
-