1 module FlattenTypes where
4 import Data.Traversable
5 import qualified Data.Foldable as Foldable
6 import qualified Control.Monad.State as State
13 -- | A signal identifier
16 -- | A map of a Haskell value to signal ids
17 type SignalMap = HsValueMap SignalId
19 -- | A state identifier
22 -- | How is a given (single) value in a function's type (ie, argument or
23 -- return value) used?
25 Port -- ^ Use it as a port (input or output)
26 | State StateId -- ^ Use it as state (input or output). The int is used to
27 -- match input state to output state.
28 | HighOrder { -- ^ Use it as a high order function input
29 hoName :: String, -- ^ Which function is passed in?
30 hoArgs :: [HsUseMap] -- ^ Which arguments are already applied? This
31 -- ^ map should only contain Port and other
34 deriving (Show, Eq, Ord)
36 -- | Is this HsValueUse a state use?
37 isStateUse :: HsValueUse -> Bool
38 isStateUse (State _) = True
41 -- | A map from a Haskell value to the use of each single value
42 type HsUseMap = HsValueMap HsValueUse
44 -- | Builds a HsUseMap with the same structure has the given HsValueMap in
45 -- which all the Single elements are marked as State, with increasing state
47 useAsState :: HsValueMap a -> HsUseMap
51 -- Traverse the existing map, resulting in a function that maps an initial
52 -- state number to the final state number and the new map
53 PassState f = traverse asState map
54 -- Run this function to get the new map
56 -- This function maps each element to a State with a unique number, by
57 -- incrementing the state count.
58 asState x = PassState (\s -> (s+1, State s))
60 -- | Builds a HsUseMap with the same structure has the given HsValueMap in
61 -- which all the Single elements are marked as Port.
62 useAsPort :: HsValueMap a -> HsUseMap
63 useAsPort map = fmap (\x -> Port) map
65 -- | A Haskell function with a specific signature. The signature defines what
66 -- use the arguments and return value of the function get.
67 data HsFunction = HsFunction {
69 hsFuncArgs :: [HsUseMap],
71 } deriving (Show, Eq, Ord)
73 hasState :: HsFunction -> Bool
75 any (Foldable.any isStateUse) (hsFuncArgs hsfunc)
76 || Foldable.any isStateUse (hsFuncRes hsfunc)
78 -- | Something that defines a signal
80 -- | A flattened function application
82 appFunc :: HsFunction,
83 appArgs :: [SignalMap],
86 -- | A conditional signal definition
93 -- | Unconditional signal definition
95 defSrc :: Either SignalId SignalExpr,
99 -- | An expression on signals
101 EqLit SignalId String -- ^ Is the given signal equal to the given (VHDL) literal
102 | Literal String -- ^ A literal value
103 | Eq SignalId SignalId -- ^ A comparison between to signals
106 -- Returns the function used by the given SigDef, if any
107 usedHsFunc :: SigDef -> Maybe HsFunction
108 usedHsFunc (FApp hsfunc _ _) = Just hsfunc
109 usedHsFunc _ = Nothing
111 -- | How is a given signal used in the resulting VHDL?
113 SigPortIn -- | Use as an input port
114 | SigPortOut -- | Use as an input port
115 | SigInternal -- | Use as an internal signal
116 | SigStateOld StateId -- | Use as the current internal state
117 | SigStateNew StateId -- | Use as the new internal state
118 | SigSubState -- | Do not use, state variable is used in a subcircuit
120 -- | Is this a port signal use?
121 isPortSigUse :: SigUse -> Bool
122 isPortSigUse SigPortIn = True
123 isPortSigUse SigPortOut = True
124 isPortSigUse _ = False
126 -- | Is this a state signal use? Returns false for substate.
127 isStateSigUse :: SigUse -> Bool
128 isStateSigUse (SigStateOld _) = True
129 isStateSigUse (SigStateNew _) = True
130 isStateSigUse _ = False
132 -- | Is this an internal signal use?
133 isInternalSigUse :: SigUse -> Bool
134 isInternalSigUse SigInternal = True
135 isInternalSigUse _ = False
137 -- | Information on a signal definition
138 data SignalInfo = SignalInfo {
139 sigName :: Maybe String,
142 nameHints :: [String]
145 -- | A flattened function
146 data FlatFunction = FlatFunction {
147 flat_args :: [SignalMap],
148 flat_res :: SignalMap,
149 flat_defs :: [SigDef],
150 flat_sigs :: [(SignalId, SignalInfo)]
153 -- | Lookup a given signal id in a signal map, and return the associated
154 -- SignalInfo. Errors out if the signal was not found.
155 signalInfo :: [(SignalId, SignalInfo)] -> SignalId -> SignalInfo
156 signalInfo sigs id = Maybe.fromJust $ lookup id sigs
158 -- | A list of binds in effect at a particular point of evaluation
160 CoreBndr, -- ^ The bind name
161 BindValue -- ^ The value bound to it
165 Either -- ^ The bind value which is either
169 HsValueUse, -- ^ or a HighOrder function
170 [SignalId] -- ^ With these signals already applied to it
173 -- | The state during the flattening of a single function
174 type FlattenState = State.State ([SigDef], [(SignalId, SignalInfo)], SignalId)
176 -- | Add an application to the current FlattenState
177 addDef :: SigDef -> FlattenState ()
179 (defs, sigs, n) <- State.get
180 State.put (d:defs, sigs, n)
182 -- | Generates a new signal id, which is unique within the current flattening.
183 genSignalId :: SigUse -> Type.Type -> FlattenState SignalId
184 genSignalId use ty = do
185 (defs, sigs, n) <- State.get
186 -- Generate a new numbered but unnamed signal
187 let s = (n, SignalInfo Nothing use ty [])
188 State.put (defs, s:sigs, n+1)
191 -- | Add a name hint to the given signal
192 addNameHint :: String -> SignalId -> FlattenState ()
193 addNameHint hint id = do
194 info <- getSignalInfo id
195 let hints = nameHints info
196 let hints' = (hint:hints)
197 setSignalInfo id (info {nameHints = hints'})
199 -- | Returns the SignalInfo for the given signal. Errors if the signal is not
200 -- known in the session.
201 getSignalInfo :: SignalId -> FlattenState SignalInfo
202 getSignalInfo id = do
203 (defs, sigs, n) <- State.get
204 return $ signalInfo sigs id
206 setSignalInfo :: SignalId -> SignalInfo -> FlattenState ()
207 setSignalInfo id' info' = do
208 (defs, sigs, n) <- State.get
209 let sigs' = map (\(id, info) -> (id, if id == id' then info' else info)) sigs
210 State.put (defs, sigs', n)