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
99 -- Returns the function used by the given SigDef, if any
100 usedHsFunc :: SigDef -> Maybe HsFunction
101 usedHsFunc (FApp hsfunc _ _) = Just hsfunc
102 usedHsFunc _ = Nothing
104 -- | How is a given signal used in the resulting VHDL?
106 SigPortIn -- | Use as an input port
107 | SigPortOut -- | Use as an input port
108 | SigInternal -- | Use as an internal signal
109 | SigStateOld StateId -- | Use as the current internal state
110 | SigStateNew StateId -- | Use as the new internal state
111 | SigSubState -- | Do not use, state variable is used in a subcircuit
113 -- | Is this a port signal use?
114 isPortSigUse :: SigUse -> Bool
115 isPortSigUse SigPortIn = True
116 isPortSigUse SigPortOut = True
117 isPortSigUse _ = False
119 -- | Is this a state signal use? Returns false for substate.
120 isStateSigUse :: SigUse -> Bool
121 isStateSigUse (SigStateOld _) = True
122 isStateSigUse (SigStateNew _) = True
123 isStateSigUse _ = False
125 -- | Is this an internal signal use?
126 isInternalSigUse :: SigUse -> Bool
127 isInternalSigUse SigInternal = True
128 isInternalSigUse _ = False
130 -- | Information on a signal definition
131 data SignalInfo = SignalInfo {
132 sigName :: Maybe String,
137 -- | A flattened function
138 data FlatFunction = FlatFunction {
139 flat_args :: [SignalMap],
140 flat_res :: SignalMap,
141 flat_defs :: [SigDef],
142 flat_sigs :: [(SignalId, SignalInfo)]
145 -- | Lookup a given signal id in a signal map, and return the associated
146 -- SignalInfo. Errors out if the signal was not found.
147 signalInfo :: [(SignalId, SignalInfo)] -> SignalId -> SignalInfo
148 signalInfo sigs id = Maybe.fromJust $ lookup id sigs
150 -- | A list of binds in effect at a particular point of evaluation
152 CoreBndr, -- ^ The bind name
153 Either -- ^ The bind value which is either
157 HsValueUse, -- ^ or a HighOrder function
158 [SignalId] -- ^ With these signals already applied to it
162 -- | The state during the flattening of a single function
163 type FlattenState = State.State ([SigDef], [(SignalId, SignalInfo)], SignalId)
165 -- | Add an application to the current FlattenState
166 addDef :: SigDef -> FlattenState ()
168 (defs, sigs, n) <- State.get
169 State.put (d:defs, sigs, n)
171 -- | Generates a new signal id, which is unique within the current flattening.
172 genSignalId :: SigUse -> Type.Type -> FlattenState SignalId
173 genSignalId use ty = do
174 (defs, sigs, n) <- State.get
175 -- Generate a new numbered but unnamed signal
176 let s = (n, SignalInfo Nothing use ty)
177 State.put (defs, s:sigs, n+1)