@@ -0,0 +1,684 @@
1+{-# LANGUAGE AllowAmbiguousTypes #-}
3+{-# LANGUAGE EmptyDataDecls #-}
4+{-# LANGUAGE ExistentialQuantification #-}
5+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
9+{-# LANGUAGE Rank2Types #-}
10+{-# LANGUAGE RecursiveDo #-}
11+{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE StandaloneDeriving #-}
13+{-# LANGUAGE TypeFamilies #-}
14+{-# LANGUAGE TypeOperators #-}
15+{-# LANGUAGE UndecidableInstances #-}
16+{-# LANGUAGE InstanceSigs #-}
17+#ifdef USE_REFLEX_OPTIMIZER
18+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
20+module Reflex.Requester.Base.Internal where
23+import Reflex.Adjustable.Class
25+import Reflex.Host.Class
26+import Reflex.PerformEvent.Class
27+import Reflex.PostBuild.Class
28+import Reflex.Requester.Class
29+import Reflex.TriggerEvent.Class
30+import Reflex.EventWriter.Base
31+import Reflex.EventWriter.Class
33+import Control.Applicative (liftA2)
34+import Control.Monad.Exception
35+import Control.Monad.Identity
36+import Control.Monad.Primitive
37+import Control.Monad.Reader
38+import Control.Monad.Ref
39+import Control.Monad.State.Strict
42+import Data.Dependent.Map (DMap, DSum (..))
43+import qualified Data.Dependent.Map as DMap
44+import Data.Functor.Compose
45+import Data.Functor.Misc
46+import Data.IntMap.Strict (IntMap)
47+import qualified Data.IntMap.Strict as IntMap
49+import qualified Data.Map as Map
50+import Data.Monoid ((<>))
52+import qualified Data.Semigroup as S
53+import Data.Some (Some(Some))
54+import Data.Type.Equality
55+import Data.Sequence (Seq)
56+import qualified Data.Sequence as Seq
57+import Data.TagMap (TagMap)
58+import qualified Data.TagMap as TagMap
60+import Data.Unique.Tag.Local
61+import qualified Data.Unique.Tag as Global
62+import Data.GADT.Compare
63+import Data.Witherable
70+--TODO: The use of Seq in this module could probably be replaced with something
71+--even cheaper. We do need O(1) append, but we don't need associativity until
72+--the very end, when we're smashing everything together. This could be
73+--implemented as a binary tree whose representation isn't associative, but which
74+--doesn't allow any external party to observe the lack of associativity.
76+data RequestData ps request = forall s. RequestData !(TagGen ps s) !(Seq (RequestEnvelope s request))
77+data ResponseData ps response = forall s. ResponseData !(TagGen ps s) !(TagMap s response)
79+traverseRequesterData :: forall m request response. Applicative m => (forall a. request a -> m (response a)) -> RequestData (PrimState m) request -> m (ResponseData (PrimState m) response)
80+traverseRequesterData f (RequestData tg es) = ResponseData tg . TagMap.fromList <$> wither g (toList es)
81+ where g (RequestEnvelope mt req) = case mt of
82+ Just t -> Just . (t :=>) <$> f req
83+ Nothing -> Nothing <$ f req
85+runRequesterT :: forall t request response m a
90+ => RequesterT t request response m a
91+ -> Event t (ResponseData (PrimState m) response)
92+ -> m (a, Event t (RequestData (PrimState m) request))
93+runRequesterT (RequesterT a) wrappedResponses = withRequesterInternalT $ \(requests :: Event t (Seq (RequestEnvelope s request))) -> do
94+ (_, tg) <- RequesterInternalT ask
95+ result <- (unsafeCoerce :: RequesterInternalT FakeRequesterStatePhantom t request response m a -> RequesterInternalT s t request response m a) a
96+ let responses = fforMaybe wrappedResponses $ \(ResponseData tg' m) -> case tg `geq` tg' of
97+ Nothing -> trace ("runRequesterT: bad TagGen: expected " <> show tg <> " but got " <> show tg') Nothing --TODO: Warn somehow
99+ pure (responses, (result, fmapCheap (RequestData tg) requests))
101+instance MonadTrans (RequesterInternalT s t request response) where
102+ lift = RequesterInternalT . lift . lift
104+instance MonadTrans (RequesterT t request response) where
105+ lift a = RequesterT $ RequesterInternalT $ lift $ lift a
107+-- | Run a 'RequesterT' action. The resulting 'Event' will fire whenever
108+-- requests are made, and responses should be provided in the input 'Event'.
109+-- The 'Tag' keys will be used to return the responses to the same place the
110+-- requests were issued.
111+withRequesterInternalT
116+ => (forall s. Event t (Seq (RequestEnvelope s request)) -> RequesterInternalT s t request response m (Event t (TagMap s response), a))
118+withRequesterInternalT f = withTagGen $ \tg -> do
119+ rec let RequesterInternalT a = f requests
120+ ((responses, result), requests) <- runEventWriterT $ runReaderT a (fanTag responses, tg)
123+data RequestEnvelope s request = forall a. RequestEnvelope {-# UNPACK #-} !(Maybe (Tag s a)) !(request a)
125+-- This is because using forall ruins inlining
126+data FakeRequesterStatePhantom
128+newtype RequesterT t (request :: * -> *) (response :: * -> *) m a = RequesterT { unRequesterT :: RequesterInternalT FakeRequesterStatePhantom t request response m a }
129+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException)
131+newtype RequesterInternalT s t request response m a = RequesterInternalT { unRequesterInternalT :: ReaderT (EventSelectorTag t s response, TagGen (PrimState m) s) (EventWriterT t (Seq (RequestEnvelope s request)) m) a }
133+ ( Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
134+#if MIN_VERSION_base(4,9,1)
135+ , MonadAsyncException
139+-- I don't think this can actually be supported without an unsafeCoerce
140+-- #if MIN_VERSION_base(4,9,1)
141+-- instance MonadAsyncException m => MonadAsyncException (RequesterT t request response m) where
142+-- mask f = RequesterT $ mask $ \unmask -> unRequesterT $ f $ \x -> RequesterT $ unmask $ unRequesterT x
145+instance MonadSample t m => MonadSample t (RequesterT t request response m)
146+instance MonadHold t m => MonadHold t (RequesterT t request response m)
147+instance PostBuild t m => PostBuild t (RequesterT t request response m)
148+instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
150+instance MonadSample t m => MonadSample t (RequesterInternalT s t request response m)
151+instance MonadHold t m => MonadHold t (RequesterInternalT s t request response m)
152+instance PostBuild t m => PostBuild t (RequesterInternalT s t request response m)
153+instance TriggerEvent t m => TriggerEvent t (RequesterInternalT s t request response m)
155+instance PrimMonad m => PrimMonad (RequesterT t request response m) where
156+ type PrimState (RequesterT t request response m) = PrimState m
157+ primitive = lift . primitive
159+-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
160+instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
161+ mempty = pure mempty
162+ mappend = liftA2 mappend
164+instance (S.Semigroup a, Monad m) => S.Semigroup (RequesterT t request response m a) where
165+ (<>) = liftA2 (S.<>)
167+instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
168+ type Performable (RequesterT t request response m) = Performable m
169+ performEvent_ = lift . performEvent_
170+ performEvent = lift . performEvent
172+instance MonadRef m => MonadRef (RequesterT t request response m) where
173+ type Ref (RequesterT t request response m) = Ref m
174+ newRef = lift . newRef
175+ readRef = lift . readRef
176+ writeRef r = lift . writeRef r
178+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (RequesterT t request response m) where
179+ newEventWithTrigger = lift . newEventWithTrigger
180+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
182+instance MonadReader r m => MonadReader r (RequesterT t request response m) where
184+ local f (RequesterT a) = RequesterT $ RequesterInternalT $ mapReaderT (mapEventWriterT $ local f) $ unRequesterInternalT a
185+ reader = lift . reader
187+instance (Reflex t, PrimMonad m) => Requester t (RequesterT t request response m) where
188+ type Request (RequesterT t request response m) = request
189+ type Response (RequesterT t request response m) = response
190+ requesting e = RequesterT $ requesting e
191+ requesting_ e = RequesterT $ requesting_ e
193+instance (Reflex t, PrimMonad m) => Requester t (RequesterInternalT s t request response m) where
194+ type Request (RequesterInternalT s t request response m) = request
195+ type Response (RequesterInternalT s t request response m) = response
196+ requesting e = RequesterInternalT $ do
198+ t <- lift $ lift $ newTag tg
199+ tellEvent $ fmapCheap (Seq.singleton . RequestEnvelope (Just t)) e
200+ pure $ selectTag s t
201+ requesting_ e = RequesterInternalT $ do
202+ tellEvent $ fmapCheap (Seq.singleton . RequestEnvelope Nothing) e
204+instance (Adjustable t m, MonadHold t m) => Adjustable t (RequesterInternalT s t request response m) where
205+ {-# INLINABLE runWithReplace #-}
206+ runWithReplace (RequesterInternalT a0) a' = RequesterInternalT $ runWithReplace a0 (coerceEvent a')
207+ {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
208+ traverseIntMapWithKeyWithAdjust f dm0 dm' = RequesterInternalT $ traverseIntMapWithKeyWithAdjust (coerce . f) dm0 dm'
209+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
210+ traverseDMapWithKeyWithAdjust f dm0 dm' = RequesterInternalT $ traverseDMapWithKeyWithAdjust (coerce . f) dm0 dm'
211+ {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
212+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = RequesterInternalT $ traverseDMapWithKeyWithAdjustWithMove (coerce . f) dm0 dm'
214+instance (Adjustable t m, MonadHold t m) => Adjustable t (RequesterT t request response m) where
215+ {-# INLINABLE runWithReplace #-}
216+ runWithReplace (RequesterT a0) a' = RequesterT $ runWithReplace a0 (fmapCheap unRequesterT a')
217+ {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
218+ traverseIntMapWithKeyWithAdjust f dm0 dm' = RequesterT $ traverseIntMapWithKeyWithAdjust (\k v -> unRequesterT $ f k v) dm0 dm'
219+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
220+ traverseDMapWithKeyWithAdjust f dm0 dm' = RequesterT $ traverseDMapWithKeyWithAdjust (\k v -> unRequesterT $ f k v) dm0 dm'
221+ {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
222+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = RequesterT $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unRequesterT $ f k v) dm0 dm'
224+{-# INLINABLE runWithReplaceRequesterTWith #-}
225+runWithReplaceRequesterTWith :: forall m t request response a b. (Reflex t, MonadHold t m
228+ => (forall a' b'. m a' -> Event t (m b') -> RequesterT t request response m (a', Event t b'))
229+ -> RequesterT t request response m a
230+ -> Event t (RequesterT t request response m b)
231+ -> RequesterT t request response m (a, Event t b)
232+runWithReplaceRequesterTWith f (RequesterT a0) a' = RequesterT $ do
236+import GHC.Exts (Any)
239+--TODO: Make this module type-safe
241+newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
243+newtype RequesterData f = RequesterData (TagMap (Entry f))
245+data RequesterDataKey a where
246+ RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
247+ RequesterDataKey_Multi :: {-# UNPACK #-} !(MyTag Multi) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a --TODO: Don't put a second Int here (or in the other Multis); use a single Int instead
248+ RequesterDataKey_Multi2 :: {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
249+ RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
251+singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
252+singletonRequesterData rdk v = case rdk of
253+ RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
254+ RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
255+ RequesterDataKey_Multi2 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ Map.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
256+ RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
258+requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
259+requesterDataToList (RequesterData m) = do
260+ k :=> Entry e <- tagMapToList m
262+ MyTagType_Single -> return $ RequesterDataKey_Single k :=> e
263+ MyTagType_Multi -> do
264+ (k', e') <- IntMap.toList e
265+ k'' :=> e'' <- requesterDataToList e'
266+ return $ RequesterDataKey_Multi k k' k'' :=> e''
267+ MyTagType_Multi2 -> do
268+ (k', e') <- Map.toList e
269+ (k'', e'') <- IntMap.toList e'
270+ k''' :=> e''' <- requesterDataToList e''
271+ return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
272+ MyTagType_Multi3 -> do
273+ (k', e') <- IntMap.toList e
274+ (k'', e'') <- IntMap.toList e'
275+ k''' :=> e''' <- requesterDataToList e''
276+ return $ RequesterDataKey_Multi3 k k' k'' k''' :=> e'''
278+singletonTagMap :: forall f a. MyTag a -> f a -> TagMap f
279+singletonTagMap (MyTag k) v = TagMap $ IntMap.singleton k $ (unsafeCoerce :: f a -> Any) v
281+tagMapToList :: forall f. TagMap f -> [DSum MyTag f]
282+tagMapToList (TagMap m) = f <$> IntMap.toList m
283+ where f :: (Int, Any) -> DSum MyTag f
284+ f (k, v) = MyTag k :=> (unsafeCoerce :: Any -> f a) v
286+traverseTagMapWithKey :: forall t f g. Applicative t => (forall a. MyTag a -> f a -> t (g a)) -> TagMap f -> t (TagMap g)
287+traverseTagMapWithKey f (TagMap m) = TagMap <$> IntMap.traverseWithKey g m
289+ g :: Int -> Any -> t Any
290+ g k v = (unsafeCoerce :: g a -> Any) <$> f (MyTag k) ((unsafeCoerce :: Any -> f a) v)
292+-- | Runs in reverse to accommodate for the fact that we accumulate it in reverse
293+traverseRequesterData :: forall m request response. Applicative m => (forall a. request a -> m (response a)) -> RequesterData request -> m (RequesterData response)
294+traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWithKey go m --TODO: reverse this, since our tags are in reverse order
295+ where go :: forall x. MyTag x -> Entry request x -> m (Entry response x)
296+ go k (Entry request) = Entry <$> case myKeyType k of
297+ MyTagType_Single -> f request
298+ MyTagType_Multi -> traverse (traverseRequesterData f) request
299+ MyTagType_Multi2 -> traverse (traverse (traverseRequesterData f)) request
300+ MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
302+-- | 'traverseRequesterData' with its arguments flipped
303+forRequesterData :: forall request response m. Applicative m => RequesterData request -> (forall a. request a -> m (response a)) -> m (RequesterData response)
304+forRequesterData r f = traverseRequesterData f r
306+data MyTagType :: * -> * where
307+ MyTagType_Single :: MyTagType (Single a)
308+ MyTagType_Multi :: MyTagType Multi
309+ MyTagType_Multi2 :: MyTagType (Multi2 k)
310+ MyTagType_Multi3 :: MyTagType Multi3
312+myKeyType :: MyTag x -> MyTagType x
313+myKeyType (MyTag k) = case k .&. 0x3 of
314+ 0x0 -> unsafeCoerce MyTagType_Single
315+ 0x1 -> unsafeCoerce MyTagType_Multi
316+ 0x2 -> unsafeCoerce MyTagType_Multi2
317+ 0x3 -> unsafeCoerce MyTagType_Multi3
318+ t -> error $ "Reflex.Requester.Base.myKeyType: no such key type" <> show t
322+data Multi2 (k :: * -> *)
325+class MyTagTypeOffset x where
326+ myTagTypeOffset :: proxy x -> Int
328+instance MyTagTypeOffset (Single a) where
329+ myTagTypeOffset _ = 0x0
331+instance MyTagTypeOffset Multi where
332+ myTagTypeOffset _ = 0x1
334+instance MyTagTypeOffset (Multi2 k) where
335+ myTagTypeOffset _ = 0x2
337+instance MyTagTypeOffset Multi3 where
338+ myTagTypeOffset _ = 0x3
340+type family EntryContents request a where
341+ EntryContents request (Single a) = request a
342+ EntryContents request Multi = IntMap (RequesterData request)
343+ EntryContents request (Multi2 k) = Map (Some k) (IntMap (RequesterData request))
344+ EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
346+newtype Entry request x = Entry { unEntry :: EntryContents request x }
348+{-# INLINE singleEntry #-}
349+singleEntry :: f a -> Entry f (Single a)
352+{-# INLINE multiEntry #-}
353+multiEntry :: IntMap (RequesterData f) -> Entry f Multi
356+{-# INLINE unMultiEntry #-}
357+unMultiEntry :: Entry f Multi -> IntMap (RequesterData f)
358+unMultiEntry = unEntry
360+-- | We use a hack here to pretend we have x ~ request a; we don't want to use a GADT, because GADTs (even with zero-size existential contexts) can't be newtypes
361+-- WARNING: This type should never be exposed. In particular, this is extremely unsound if a MyTag from one run of runRequesterT is ever compared against a MyTag from another
362+newtype MyTag x = MyTag Int deriving (Show, Eq, Ord, Enum)
364+newtype MyTagWrap (f :: * -> *) x = MyTagWrap Int deriving (Show, Eq, Ord, Enum)
366+{-# INLINE castMyTagWrap #-}
367+castMyTagWrap :: MyTagWrap f (Entry f x) -> MyTagWrap g (Entry g x)
368+castMyTagWrap = coerce
370+instance GEq MyTag where
371+ (MyTag a) `geq` (MyTag b) =
373+ then Just $ unsafeCoerce Refl
376+instance GCompare MyTag where
377+ (MyTag a) `gcompare` (MyTag b) =
378+ case a `compare` b of
380+ EQ -> unsafeCoerce GEQ
383+instance GEq (MyTagWrap f) where
384+ (MyTagWrap a) `geq` (MyTagWrap b) =
386+ then Just $ unsafeCoerce Refl
389+instance GCompare (MyTagWrap f) where
390+ (MyTagWrap a) `gcompare` (MyTagWrap b) =
391+ case a `compare` b of
393+ EQ -> unsafeCoerce GEQ
396+data RequesterState t (request :: * -> *) = RequesterState
397+ { _requesterState_nextMyTag :: {-# UNPACK #-} !Int -- Starts at -4 and goes down by 4 each time, to accommodate two 'type' bits at the bottom
398+ , _requesterState_requests :: ![(Int, Event t Any)]
401+-- | A basic implementation of 'Requester'.
402+newtype RequesterT t request (response :: * -> *) m a = RequesterT { unRequesterT :: StateT (RequesterState t request) (ReaderT (EventSelectorInt t Any) m) a }
403+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
404+-- MonadAsyncException can't be derived on ghc-8.0.1; we use base-4.9.1 as a proxy for ghc-8.0.2
405+#if MIN_VERSION_base(4,9,1)
406+ , MonadAsyncException
411+-- | Run a 'RequesterT' action. The resulting 'Event' will fire whenever
412+-- requests are made, and responses should be provided in the input 'Event'.
413+-- The 'Tag' keys will be used to return the responses to the same place the
414+-- requests were issued.
415+runRequesterT :: (Reflex t, Monad m)
416+ => RequesterT t request response m a
417+ -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
418+ -> m (a, Event t (RequesterData request)) --TODO: we need to hide these 'MyTag's here, because they're unsafe to mix in the wild
419+runRequesterT (RequesterT a) responses = do
420+ (result, s) <- runReaderT (runStateT a $ RequesterState (-4) []) $ fanInt $
421+ coerceEvent responses
422+ return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
424+-- | Map a function over the request and response of a 'RequesterT'
426+ :: (Reflex t, MonadFix m)
427+ => (forall x. req x -> req' x) -- ^ The function to map over the request
428+ -> (forall x. rsp' x -> rsp x) -- ^ The function to map over the response
429+ -> RequesterT t req rsp m a -- ^ The internal 'RequesterT' whose input and output will be transformed
430+ -> RequesterT t req' rsp' m a -- ^ The resulting 'RequesterT'
431+withRequesterT freq frsp child = do
432+ rec let rsp = fmap (runIdentity . traverseRequesterData (Identity . frsp)) rsp'
433+ (a, req) <- lift $ runRequesterT child rsp
434+ rsp' <- fmap (flip selectInt 0 . fanInt . fmapCheap unMultiEntry) $ requesting' $
435+ fmapCheap (multiEntry . IntMap.singleton 0) $ fmap (runIdentity . traverseRequesterData (Identity . freq)) req
438+instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
439+ type Request (RequesterT t request response m) = request
440+ type Response (RequesterT t request response m) = response
441+ requesting = fmap coerceEvent . responseFromTag . castMyTagWrap <=< tagRequest . (coerceEvent :: Event t (request a) -> Event t (Entry request (Single a)))
442+ requesting_ = void . tagRequest . fmapCheap singleEntry
444+{-# INLINE tagRequest #-}
445+tagRequest :: forall m x t request response. (Monad m, MyTagTypeOffset x) => Event t (Entry request x) -> RequesterT t request response m (MyTagWrap request (Entry request x))
447+ old <- RequesterT get
448+ let n = _requesterState_nextMyTag old .|. myTagTypeOffset (Proxy :: Proxy x)
450+ RequesterT $ put $ RequesterState
451+ { _requesterState_nextMyTag = _requesterState_nextMyTag old - 0x4
452+ , _requesterState_requests = (n, (unsafeCoerce :: Event t (Entry request x) -> Event t Any) req) : _requesterState_requests old
456+{-# INLINE responseFromTag #-}
457+responseFromTag :: Monad m => MyTagWrap response (Entry response x) -> RequesterT t request response m (Event t (Entry response x))
458+responseFromTag (MyTagWrap t) = do
459+ responses :: EventSelectorInt t Any <- RequesterT ask
460+ return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
462+instance MonadTrans (RequesterT t request response) where
463+ lift = RequesterT . lift . lift
465+instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
466+ type Performable (RequesterT t request response m) = Performable m
467+ performEvent_ = lift . performEvent_
468+ performEvent = lift . performEvent
470+instance MonadRef m => MonadRef (RequesterT t request response m) where
471+ type Ref (RequesterT t request response m) = Ref m
472+ newRef = lift . newRef
473+ readRef = lift . readRef
474+ writeRef r = lift . writeRef r
476+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (RequesterT t request response m) where
477+ newEventWithTrigger = lift . newEventWithTrigger
478+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
480+instance MonadReader r m => MonadReader r (RequesterT t request response m) where
482+ local f (RequesterT a) = RequesterT $ mapStateT (mapReaderT $ local f) a
483+ reader = lift . reader
485+instance (Reflex t, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (RequesterT t request response m) where
486+ runWithReplace = runWithReplaceRequesterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
487+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') patchIntMapNewElementsMap mergeIntIncremental
488+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
489+ traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental
490+ traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove
492+requesting' :: (MyTagTypeOffset x, Monad m) => Event t (Entry request x) -> RequesterT t request response m (Event t (Entry response x))
493+requesting' = responseFromTag . castMyTagWrap <=< tagRequest
495+{-# INLINABLE runWithReplaceRequesterTWith #-}
496+runWithReplaceRequesterTWith :: forall m t request response a b. (Reflex t, MonadHold t m
499+ => (forall a' b'. m a' -> Event t (m b') -> RequesterT t request response m (a', Event t b'))
500+ -> RequesterT t request response m a
501+ -> Event t (RequesterT t request response m b)
502+ -> RequesterT t request response m (a, Event t b)
503+runWithReplaceRequesterTWith f a0 a' = do
504+ rec na' <- numberOccurrencesFrom 1 a'
505+ responses <- fmap (fmapCheap unMultiEntry) $ requesting' $ fmapCheap multiEntry $ switchPromptlyDyn requests --TODO: Investigate whether we can really get rid of the prompt stuff here
506+ let responses' = fanInt responses
507+ ((result0, requests0), v') <- f (runRequesterT a0 (selectInt responses' 0)) $ fmapCheap (\(n, a) -> fmap ((,) n) $ runRequesterT a $ selectInt responses' n) na'
508+ requests <- holdDyn (fmapCheap (IntMap.singleton 0) requests0) $ fmapCheap (\(n, (_, reqs)) -> fmapCheap (IntMap.singleton n) reqs) v'
509+ return (result0, fmapCheap (fst . snd) v')
511+{-# INLINE traverseIntMapWithKeyWithAdjustRequesterTWith #-}
512+traverseIntMapWithKeyWithAdjustRequesterTWith :: forall t request response m v v' p.
515+ , PatchTarget (p (Event t (IntMap (RequesterData request)))) ~ IntMap (Event t (IntMap (RequesterData request)))
516+ , Patch (p (Event t (IntMap (RequesterData request))))
520+ => ( (IntMap.Key -> (IntMap.Key, v) -> m (Event t (IntMap (RequesterData request)), v'))
521+ -> IntMap (IntMap.Key, v)
522+ -> Event t (p (IntMap.Key, v))
523+ -> RequesterT t request response m (IntMap (Event t (IntMap (RequesterData request)), v'), Event t (p (Event t (IntMap (RequesterData request)), v')))
525+ -> (p (Event t (IntMap (RequesterData request))) -> IntMap (Event t (IntMap (RequesterData request))))
526+ -> (Incremental t (p (Event t (IntMap (RequesterData request)))) -> Event t (IntMap (IntMap (RequesterData request))))
527+ -> (IntMap.Key -> v -> RequesterT t request response m v')
530+ -> RequesterT t request response m (IntMap v', Event t (p v'))
531+traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIncremental f dm0 dm' = do
532+ rec response <- requesting' $ fmapCheap pack $ promptRequests `mappend` mergePatchIncremental requests --TODO: Investigate whether we can really get rid of the prompt stuff here
533+ let responses :: EventSelectorInt t (IntMap (RequesterData response))
534+ responses = fanInt $ fmapCheap unpack response
535+ unpack :: Entry response Multi3 -> IntMap (IntMap (RequesterData response))
537+ pack :: IntMap (IntMap (RequesterData request)) -> Entry request Multi3
539+ f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
541+ (result, myRequests) <- runRequesterT (f k v) $ mapMaybeCheap (IntMap.lookup n) $ selectInt responses k --TODO: Instead of doing mapMaybeCheap, can we share a fanInt across all instances of a given key, or at least the ones that are adjacent in time?
542+ return (fmapCheap (IntMap.singleton n) myRequests, result)
543+ ndm' <- numberOccurrencesFrom 1 dm'
544+ (children0, children') <- base f' (fmap ((,) 0) dm0) $ fmap (\(n, dm) -> fmap ((,) n) dm) ndm' --TODO: Avoid this somehow, probably by adding some sort of per-cohort information passing to Adjustable
545+ let result0 = fmap snd children0
546+ result' = fforCheap children' $ fmap snd
547+ requests0 :: IntMap (Event t (IntMap (RequesterData request)))
548+ requests0 = fmap fst children0
549+ requests' :: Event t (p (Event t (IntMap (RequesterData request))))
550+ requests' = fforCheap children' $ fmap fst
551+ promptRequests :: Event t (IntMap (IntMap (RequesterData request)))
552+ promptRequests = coincidence $ fmapCheap (mergeInt . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
553+ requests <- holdIncremental requests0 requests'
554+ return (result0, result')
556+{-# INLINE traverseDMapWithKeyWithAdjustRequesterTWith #-}
557+traverseDMapWithKeyWithAdjustRequesterTWith :: forall k t request response m v v' p p'.
561+ , PatchTarget (p' (Some k) (Event t (IntMap (RequesterData request)))) ~ Map (Some k) (Event t (IntMap (RequesterData request)))
562+ , Patch (p' (Some k) (Event t (IntMap (RequesterData request))))
565+ => (forall k' v1 v2. GCompare k'
566+ => (forall a. k' a -> v1 a -> m (v2 a))
568+ -> Event t (p k' v1)
569+ -> RequesterT t request response m (DMap k' v2, Event t (p k' v2))
571+ -> (forall v1 v2. (forall a. v1 a -> v2 a) -> p k v1 -> p k v2)
572+ -> (forall v1 v2. (forall a. v1 a -> v2) -> p k v1 -> p' (Some k) v2)
573+ -> (forall v2. p' (Some k) v2 -> Map (Some k) v2)
574+ -> (forall a. Incremental t (p' (Some k) (Event t a)) -> Event t (Map (Some k) a))
575+ -> (forall a. k a -> v a -> RequesterT t request response m (v' a))
578+ -> RequesterT t request response m (DMap k v', Event t (p k v'))
579+traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchNewElements mergePatchIncremental f dm0 dm' = do
580+ rec response <- requesting' $ fmapCheap pack $ promptRequests `mappend` mergePatchIncremental requests --TODO: Investigate whether we can really get rid of the prompt stuff here
581+ let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
582+ responses = fanMap $ fmapCheap unpack response
583+ unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
585+ pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
587+ f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
588+ f' k (Compose (n, v)) = do
589+ (result, myRequests) <- runRequesterT (f k v) $ mapMaybeCheap (IntMap.lookup n) $ select responses (Const2 (Some k))
590+ return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
591+ ndm' <- numberOccurrencesFrom 1 dm'
592+ (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
593+ let result0 = DMap.map (snd . getCompose) children0
594+ result' = fforCheap children' $ mapPatch $ snd . getCompose
595+ requests0 :: Map (Some k) (Event t (IntMap (RequesterData request)))
596+ requests0 = weakenDMapWith (fst . getCompose) children0
597+ requests' :: Event t (p' (Some k) (Event t (IntMap (RequesterData request))))
598+ requests' = fforCheap children' $ weakenPatchWith $ fst . getCompose
599+ promptRequests :: Event t (Map (Some k) (IntMap (RequesterData request)))
600+ promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
601+ requests <- holdIncremental requests0 requests'
602+ return (result0, result')
604+data Decoder rawResponse response =
605+ forall a. Decoder (RequesterDataKey a) (rawResponse -> response a)
607+-- | Matches incoming responses with previously-sent requests
608+-- and uses the provided request "decoder" function to process
609+-- incoming responses.
610+matchResponsesWithRequests
611+ :: forall t rawRequest rawResponse request response m.
616+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
617+ -- ^ Given a request (from 'Requester'), produces the wire format of the
618+ -- request and a function used to process the associated response
619+ -> Event t (RequesterData request)
620+ -- ^ The outgoing requests
621+ -> Event t (Int, rawResponse)
622+ -- ^ The incoming responses, tagged by an identifying key
623+ -> m ( Event t (Map Int rawRequest)
624+ , Event t (RequesterData response)
626+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
627+ -- by the 'RequesterData' key of the associated outgoing request
628+matchResponsesWithRequests f send recv = do
629+ rec nextId <- hold 1 $ fmap (\(next, _, _) -> next) outgoing
630+ waitingFor :: Incremental t (PatchMap Int (Decoder rawResponse response)) <-
631+ holdIncremental mempty $ leftmost
632+ [ fmap (\(_, outstanding, _) -> outstanding) outgoing
635+ let outgoing = processOutgoing nextId send
636+ incoming = processIncoming waitingFor recv
637+ return (fmap (\(_, _, rawReqs) -> rawReqs) outgoing, fst <$> incoming)
639+ -- Tags each outgoing request with an identifying integer key
640+ -- and returns the next available key, a map of response decoders
641+ -- for requests for which there are outstanding responses, and the
642+ -- raw requests to be sent out.
645+ -- The next available key
646+ -> Event t (RequesterData request)
647+ -- The outgoing request
649+ , PatchMap Int (Decoder rawResponse response)
650+ , Map Int rawRequest )
651+ -- The new next-available-key, a map of requests expecting responses, and the tagged raw requests
652+ processOutgoing nextId out = flip pushAlways out $ \dm -> do
653+ oldNextId <- sample nextId
654+ let (result, newNextId) = flip runState oldNextId $ forM (requesterDataToList dm) $ \(k :=> v) -> do
657+ let (rawReq, rspF) = f v
658+ return (n, rawReq, Decoder k rspF)
659+ patchWaitingFor = PatchMap $ Map.fromList $
660+ (\(n, _, dec) -> (n, Just dec)) <$> result
661+ toSend = Map.fromList $ (\(n, rawReq, _) -> (n, rawReq)) <$> result
662+ return (newNextId, patchWaitingFor, toSend)
663+ -- Looks up the each incoming raw response in a map of response
664+ -- decoders and returns the decoded response and a patch that can
665+ -- be used to clear the ID of the consumed response out of the queue
666+ -- of expected responses.
668+ :: Incremental t (PatchMap Int (Decoder rawResponse response))
669+ -- A map of outstanding expected responses
670+ -> Event t (Int, rawResponse)
671+ -- A incoming response paired with its identifying key
672+ -> Event t (RequesterData response, PatchMap Int v)
673+ -- The decoded response and a patch that clears the outstanding responses queue
674+ processIncoming waitingFor inc = flip push inc $ \(n, rawRsp) -> do
675+ wf <- sample $ currentIncremental waitingFor
676+ case Map.lookup n wf of
677+ Nothing -> return Nothing -- TODO How should lookup failures be handled here? They shouldn't ever happen..
678+ Just (Decoder k rspF) -> do
679+ let rsp = rspF rawRsp
681+ ( singletonRequesterData k rsp
682+ , PatchMap $ Map.singleton n Nothing