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 module TranslatorTypes where
7 import qualified Control.Monad.State as State
8 import qualified Data.Map as Map
10 import qualified HscTypes
12 import qualified ForSyDe.Backend.VHDL.AST as AST
19 -- | A map from a HsFunction identifier to various stuff we collect about a
20 -- function along the way.
21 type FuncMap = Map.Map HsFunction FuncData
23 -- | Some stuff we collect about a function along the way.
24 data FuncData = FuncData {
25 flatFunc :: Maybe FlatFunction,
26 funcEntity :: Maybe Entity,
27 funcArch :: Maybe AST.ArchBody
30 data VHDLSession = VHDLSession {
31 coreMod :: HscTypes.CoreModule, -- The current module
32 nameCount :: Int, -- A counter that can be used to generate unique names
33 funcs :: FuncMap -- A map from HsFunction to FlatFunction, HWFunction, VHDL Entity and Architecture
36 -- | Add the function to the session
37 addFunc :: HsFunction -> VHDLState ()
39 modFuncMap (Map.insert hsfunc (FuncData Nothing Nothing Nothing))
41 -- | Find the given function in the current session
42 getFunc :: HsFunction -> VHDLState (Maybe FuncData)
44 fs <- State.gets funcs -- Get the funcs element from the session
45 return $ Map.lookup hsfunc fs
47 -- | Gets all functions from the current session
48 getFuncs :: VHDLState [(HsFunction, FuncData)]
50 fs <- State.gets funcs -- Get the funcs element from the session
51 return $ Map.toList fs
53 -- | Gets all the functions from the current session
54 getHsFuncs :: VHDLState [HsFunction]
56 fs <- State.gets funcs -- Get the funcs element from the session
59 -- | Sets the FlatFunction for the given HsFunction in the current session.
60 setFlatFunc :: HsFunction -> FlatFunction -> VHDLState ()
61 setFlatFunc hsfunc flatfunc =
62 modFunc (\d -> d { flatFunc = Just flatfunc }) hsfunc
64 -- | Sets the Entity for the given HsFunction in the current session.
65 setEntity :: HsFunction -> Entity -> VHDLState ()
66 setEntity hsfunc entity =
67 modFunc (\d -> d { funcEntity = Just entity }) hsfunc
69 -- | Sets the Entity for the given HsFunction in the current session.
70 setArchitecture :: HsFunction -> AST.ArchBody -> VHDLState ()
71 setArchitecture hsfunc arch =
72 modFunc (\d -> d { funcArch = Just arch }) hsfunc
74 -- | Modify a function in the map using the given function
75 modFunc :: (FuncData -> FuncData) -> HsFunction -> VHDLState ()
77 modFuncMap (Map.adjust f hsfunc)
79 -- | Modify the function map in the session using the given function
80 modFuncMap :: (FuncMap -> FuncMap) -> VHDLState ()
82 fs <- State.gets funcs -- Get the funcs element from the session
84 State.modify (\x -> x {funcs = fs' })
86 -- | Apply the given function to all functions in the map, and collect the
87 -- results. The function is allowed to change the function map in the
88 -- session, but any new functions added will not be mapped.
89 modFuncs :: (HsFunction -> FuncData -> VHDLState ()) -> VHDLState ()
96 fdata_maybe <- getFunc hsfunc
98 Nothing -> do return ()
99 Just fdata -> f hsfunc fdata
101 getModule :: VHDLState HscTypes.CoreModule
102 getModule = State.gets coreMod -- Get the coreMod element from the session
104 type VHDLState = State.State VHDLSession
106 -- Makes the given name unique by appending a unique number.
107 -- This does not do any checking against existing names, so it only guarantees
108 -- uniqueness with other names generated by uniqueName.
109 uniqueName :: String -> VHDLState String
111 count <- State.gets nameCount -- Get the funcs element from the session
112 State.modify (\s -> s {nameCount = count + 1})
113 return $ name ++ "_" ++ (show count)
115 -- vim: set ts=8 sw=2 sts=2 expandtab: