2 -- Simple module providing some types used by Translator. These are in a
3 -- separate module to prevent circular dependencies in Pretty for example.
5 {-# LANGUAGE TemplateHaskell #-}
6 module CLasH.Translator.TranslatorTypes where
9 import qualified Control.Monad.Trans.State as State
10 import qualified Data.Map as Map
11 import qualified Data.Accessor.Template
16 import qualified CoreSyn
18 import qualified HscTypes
19 import qualified UniqSupply
22 import qualified Language.VHDL.AST as AST
25 import CLasH.VHDL.VHDLTypes
27 -- | A specification of an entity we can generate VHDL for. Consists of the
28 -- binder of the top level entity, an optional initial state and an optional
30 type EntitySpec = (CoreSyn.CoreBndr, Maybe CoreSyn.CoreExpr, Maybe CoreSyn.CoreExpr)
32 -- | A function that knows which parts of a module to compile
34 HscTypes.CoreModule -- ^ The module to look at
35 -> GHC.Ghc [EntitySpec]
37 -----------------------------------------------------------------------------
38 -- The TranslatorSession
39 -----------------------------------------------------------------------------
41 -- A orderable equivalent of CoreSyn's Type for use as a map key
42 newtype OrdType = OrdType { getType :: Type.Type }
43 instance Eq OrdType where
44 (OrdType a) == (OrdType b) = Type.tcEqType a b
45 instance Ord OrdType where
46 compare (OrdType a) (OrdType b) = Type.tcCmpType a b
48 data HType = StdType OrdType |
49 ADTType String [HType] |
57 -- A map of a Core type to the corresponding type name
58 type TypeMap = Map.Map HType (AST.VHDLId, Either AST.TypeDef AST.SubtypeIn)
60 -- A map of a vector Core element type and function name to the coressponding
61 -- VHDLId of the function and the function body.
62 type TypeFunMap = Map.Map (OrdType, String) (AST.VHDLId, AST.SubProgBody)
64 type TfpIntMap = Map.Map OrdType Int
65 -- A substate that deals with type generation
66 data TypeState = TypeState {
67 -- | A map of Core type -> VHDL Type
69 -- | A list of type declarations
70 tsTypeDecls_ :: [AST.PackageDecItem],
71 -- | A map of vector Core type -> VHDL type function
72 tsTypeFuns_ :: TypeFunMap,
73 tsTfpInts_ :: TfpIntMap,
74 tsHscEnv_ :: HscTypes.HscEnv
78 $( Data.Accessor.Template.deriveAccessors ''TypeState )
81 type TypeSession = State.State TypeState
82 -- A global state for the translator
83 data TranslatorState = TranslatorState {
84 tsUniqSupply_ :: UniqSupply.UniqSupply
85 , tsType_ :: TypeState
86 , tsBindings_ :: Map.Map CoreSyn.CoreBndr CoreSyn.CoreExpr
87 , tsNormalized_ :: Map.Map CoreSyn.CoreBndr CoreSyn.CoreExpr
88 , tsEntities_ :: Map.Map CoreSyn.CoreBndr Entity
89 , tsArchitectures_ :: Map.Map CoreSyn.CoreBndr (Architecture, [CoreSyn.CoreBndr])
93 $( Data.Accessor.Template.deriveAccessors ''TranslatorState )
95 type TranslatorSession = State.State TranslatorState
97 -----------------------------------------------------------------------------
99 -----------------------------------------------------------------------------
101 -- Does the given binder reference a top level binder in the current
103 isTopLevelBinder :: CoreSyn.CoreBndr -> TranslatorSession Bool
104 isTopLevelBinder bndr = do
105 bindings <- getA tsBindings
106 return $ Map.member bndr bindings
108 -- Finds the value of a global binding, if available
109 getGlobalBind :: CoreSyn.CoreBndr -> TranslatorSession (Maybe CoreSyn.CoreExpr)
110 getGlobalBind bndr = do
111 bindings <- getA tsBindings
112 return $ Map.lookup bndr bindings
114 -- Adds a new global binding with the given value
115 addGlobalBind :: CoreSyn.CoreBndr -> CoreSyn.CoreExpr -> TranslatorSession ()
116 addGlobalBind bndr expr = modA tsBindings (Map.insert bndr expr)
118 -- Returns a list of all global binders
119 getGlobalBinders :: TranslatorSession [CoreSyn.CoreBndr]
120 getGlobalBinders = do
121 bindings <- getA tsBindings
122 return $ Map.keys bindings
124 -- vim: set ts=8 sw=2 sts=2 expandtab: