@@ -1,2285 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE ConstraintKinds #-}
4−{-# LANGUAGE EmptyDataDecls #-}
5−{-# LANGUAGE ExistentialQuantification #-}
6−{-# LANGUAGE FlexibleContexts #-}
7−{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE FunctionalDependencies #-}
9−{-# LANGUAGE GADTs #-}
10−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11−{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MagicHash #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE MultiWayIf #-}
15−{-# LANGUAGE RankNTypes #-}
16−{-# LANGUAGE RoleAnnotations #-}
17−{-# LANGUAGE ScopedTypeVariables #-}
18−{-# LANGUAGE TypeFamilies #-}
19−{-# LANGUAGE TypeOperators #-}
20−{-# LANGUAGE UndecidableInstances #-}
21−-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
22−-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
23−module Reflex.Spider.Internal
24− ( Spider
25− , SpiderEnv (..)
26− , Global
27− , SpiderHost
28− , runSpiderHost
29− , newSpiderEnv
30− , askSpiderEnv
31− ) where
32−
33−import Control.Applicative
34−import Control.Concurrent
35−import Control.Exception
36−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
37−import Control.Monad.Exception
38−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
39−import Control.Monad.Primitive
40−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence)
41−import Control.Monad.Ref
42−import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
43−import Data.Align
44−import Data.Coerce
45−import Data.Dependent.Map (DMap, DSum (..))
46−import qualified Data.Dependent.Map as DMap
47−import Data.Foldable hiding (concat, elem, sequence_)
48−import Data.Function
49−import Data.Functor.Compose
50−import Data.GADT.Compare
51−import Data.IntMap.Strict (IntMap)
52−import qualified Data.IntMap.Strict as IntMap
53−import Data.IORef
54−import Data.List hiding (foldl')
55−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
56−import qualified Data.List.NonEmpty as NonEmpty
57−import Data.Maybe
58−import Data.Monoid (mempty, (<>))
59−import Data.Some (Some)
60−import qualified Data.Some as Some
61−import Data.These
62−import Data.Traversable
63−import Data.Tree (Forest, Tree (..), drawForest)
64−import Data.Word
65−import GHC.IORef (IORef (..))
66−import GHC.Stack
67−import System.IO.Unsafe
68−import System.Mem.Weak
69−import Unsafe.Coerce
70−
71−import Data.WeakBag (WeakBag, WeakBagTicket)
72−import qualified Data.WeakBag as WeakBag
73−import qualified Reflex.Class as R
74−import qualified Reflex.Host.Class as R
75−
76−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
77−import Prelude hiding (any, concat, mapM, mapM_, sequence)
78−
79−debugPropagate :: Bool
80−
81−debugInvalidateHeight :: Bool
82−
83−debugInvalidate :: Bool
84−
85−#ifdef DEBUG
86−
87−#define DEBUG_NODEIDS
88−
89−debugPropagate = True
90−
91−debugInvalidateHeight = False
92−
93−debugInvalidate = True
94−
95−class HasNodeId a where
96− getNodeId :: a -> Int
97−
98−instance HasNodeId (Hold x p a) where
99− getNodeId = holdNodeId
100−
101−instance HasNodeId (PushSubscribed x a b) where
102− getNodeId = pushSubscribedNodeId
103−
104−instance HasNodeId (SwitchSubscribed x a) where
105− getNodeId = switchSubscribedNodeId
106−
107−instance HasNodeId (MergeSubscribed x a) where
108− getNodeId = mergeSubscribedNodeId
109−
110−instance HasNodeId (FanSubscribed x a) where
111− getNodeId = fanSubscribedNodeId
112−
113−instance HasNodeId (CoincidenceSubscribed x a) where
114− getNodeId = coincidenceSubscribedNodeId
115−
116−instance HasNodeId (RootSubscribed x a) where
117− getNodeId = rootSubscribedNodeId
118−
119−instance HasNodeId (Pull x a) where
120− getNodeId = pullNodeId
121−
122−{-# INLINE showNodeId #-}
123−showNodeId :: HasNodeId a => a -> String
124−showNodeId = ("#"<>) . show . getNodeId
125−
126−showSubscriberType :: Subscriber x a -> String
127−showSubscriberType = \case
128− SubscriberPush _ _ -> "SubscriberPush"
129− SubscriberMerge _ _ -> "SubscriberMerge"
130− SubscriberFan _ -> "SubscriberFan"
131− SubscriberMergeChange _ -> "SubscriberMergeChange"
132− SubscriberHold _ -> "SubscriberHold"
133− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
134− SubscriberSwitch _ -> "SubscriberSwitch"
135− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
136− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
137− SubscriberHandle -> "SubscriberHandle"
138−
139−showEventType :: Event x a -> String
140−showEventType = \case
141− EventRoot _ _ -> "EventRoot"
142− EventNever -> "EventNever"
143− EventPush _ -> "EventPush"
144− EventMerge _ -> "EventMerge"
145− EventFan _ _ -> "EventFan"
146− EventSwitch _ -> "EventSwitch"
147− EventCoincidence _ -> "EventCoincidence"
148− EventHold _ -> "EventHold"
149− EventDyn _ -> "EventDyn"
150− EventHoldIdentity _ -> "EventHoldIdentity"
151− EventDynIdentity _ -> "EventDynIdentity"
152−
153−#else
154−
155−debugPropagate = False
156−
157−debugInvalidateHeight = False
158−
159−debugInvalidate = False
160−
161−-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
162−{-# INLINE showNodeId #-}
163−showNodeId :: a -> String
164−showNodeId _ = ""
165−
166−#endif
167−
168−#ifdef DEBUG_NODEIDS
169−{-# NOINLINE nextNodeIdRef #-}
170−nextNodeIdRef :: IORef Int
171−nextNodeIdRef = unsafePerformIO $ newIORef 1
172−
173−newNodeId :: IO Int
174−newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
175−
176−{-# NOINLINE unsafeNodeId #-}
177−unsafeNodeId :: a -> Int
178−unsafeNodeId a = unsafePerformIO $ do
179− touch a
180− newNodeId
181−#endif
182−
183−--------------------------------------------------------------------------------
184−-- Event
185−--------------------------------------------------------------------------------
186−
187−newtype Event x a = Event { subscribe :: Subscriber x a -> EventM x (EventSubscription x a) }
188−
189−wrap :: Monad m => (t -> EventSubscribed x a) -> (Subscriber x a -> m (WeakBagTicket (Subscriber x a), t)) -> Subscriber x a -> m (EventSubscription x a)
190−wrap tag getSpecificSubscribed sub = do
191− (sln, subd) <- getSpecificSubscribed sub
192− return $ EventSubscription (Just sln) $ tag subd
193−
194−eventRoot :: GCompare k => k a -> Root x k -> Event x a
195−eventRoot !k !r = Event $ wrap EventSubscribedRoot $ liftIO . getRootSubscribed k r
196−
197−eventNever :: Event x a
198−eventNever = Event $ \_ -> return $ EventSubscription Nothing EventSubscribedNever
199−
200−eventPush :: Push x b a -> Event x a
201−eventPush !p = Event $ wrap EventSubscribedPush $ getPushSubscribed p
202−
203−eventMerge :: (GCompare k, a ~ DMap k Identity) => Merge x k -> Event x a
204−eventMerge !m = Event $ wrap EventSubscribedMerge $ getMergeSubscribed m
205−
206−eventFan :: GCompare k => k a -> Fan x k -> Event x a
207−eventFan !k !f = Event $ wrap (EventSubscribedFan k) $ getFanSubscribed k f
208−
209−eventSwitch :: Switch x a -> Event x a
210−eventSwitch !s = Event $ wrap EventSubscribedSwitch $ getSwitchSubscribed s
211−
212−eventCoincidence :: Coincidence x a -> Event x a
213−eventCoincidence !c = Event $ wrap EventSubscribedCoincidence $ getCoincidenceSubscribed c
214−
215−eventHold :: (a ~ p b, R.Patch p) => Hold x p b -> Event x a
216−eventHold !h = Event $ subscribeHoldEvent h
217−
218−eventDyn :: (a ~ p b, R.Patch p) => Dyn x p b -> Event x a
219−eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
220−
221−eventHoldIdentity :: (a ~ Identity b) => Hold x Identity b -> Event x a
222−eventHoldIdentity !h = Event $ subscribeHoldEvent h
223−
224−eventDynIdentity :: (a ~ Identity b) => Dyn x Identity b -> Event x a
225−eventDynIdentity !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
226−
227−{-# INLINE subscribeCoincidenceInner #-}
228−subscribeCoincidenceInner :: CanSubscribe x m => Event x a -> Height -> CoincidenceSubscribed x a -> m (Maybe a, Height, EventSubscribed x a)
229−subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
230− subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
231− subscription@(EventSubscription _ innerSubd) <- subscribe inner subInner
232− innerOcc <- liftIO $ readEventSubscribed innerSubd
233− innerHeight <- liftIO $ getEventSubscribedHeight innerSubd
234− let height = max innerHeight outerHeight
235− defer $ SomeResetCoincidence subscription $ if height > outerHeight then Just subscribedUnsafe else Nothing
236− return (innerOcc, height, innerSubd)
237−
238−--------------------------------------------------------------------------------
239−-- Subscriber
240−--------------------------------------------------------------------------------
241−
242−data Subscriber x a
243− = forall b. SubscriberPush (a -> ComputeM x (Maybe b)) (PushSubscribed x a b) --TODO: Why does this have the pushCompute in it?
244− | forall k. GCompare k => SubscriberMerge !(k a) (MergeSubscribed x k) --TODO: Can we inline the GCompare?
245− | forall k. (a ~ R.PatchDMap (DMap k (Event x)), GCompare k) => SubscriberMergeChange (MergeSubscribed x k)
246− | forall k. (GCompare k, a ~ DMap k Identity) => SubscriberFan (FanSubscribed x k)
247− | forall p b. (a ~ p b, R.Patch p) => SubscriberHold !(Hold x p b)
248− | forall b. (a ~ Identity b) => SubscriberHoldIdentity !(Hold x Identity b)
249− | SubscriberSwitch (SwitchSubscribed x a)
250− | forall b. a ~ Event x b => SubscriberCoincidenceOuter (CoincidenceSubscribed x b)
251− | SubscriberCoincidenceInner (CoincidenceSubscribed x a)
252− | SubscriberHandle
253−
254−-- These function are constructor functions that are marked NOINLINE so they are
255−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
256−-- so any weak references that are attached to the constructors will have their
257−-- finalizer run. Using the opaque constructor, does not see the
258−-- constructor application, so it behaves like an IORef and cannot be fused away.
259−--
260−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
261−-- the weak pointer to it in some cases.
262−
263−--TODO: I think all of these noinlines are now unnecessary
264−{-# NOINLINE newSubscriberPush #-}
265−newSubscriberPush :: (a -> ComputeM x (Maybe b)) -> PushSubscribed x a b -> IO (Subscriber x a)
266−newSubscriberPush compute subd = return $! SubscriberPush compute subd
267−
268−{-# RULES
269− "newSubscriberHold/Identity" forall h. newSubscriberHold h = newSubscriberHoldIdentity h
270− #-}
271−{-# NOINLINE newSubscriberHold #-}
272−newSubscriberHold :: R.Patch p => Hold x p a -> IO (Subscriber x (p a))
273−newSubscriberHold h = return $! SubscriberHold h
274−
275−{-# NOINLINE newSubscriberHoldIdentity #-}
276−newSubscriberHoldIdentity :: Hold x Identity a -> IO (Subscriber x (Identity a))
277−newSubscriberHoldIdentity h = return $! SubscriberHoldIdentity h
278−
279−{-# NOINLINE newSubscriberMerge #-}
280−newSubscriberMerge :: GCompare k => k a -> MergeSubscribed x k -> IO (Subscriber x a)
281−newSubscriberMerge k subd = return $! SubscriberMerge k subd
282−
283−{-# NOINLINE newSubscriberMergeChange #-}
284−newSubscriberMergeChange :: GCompare k => MergeSubscribed x k -> IO (Subscriber x (R.PatchDMap (DMap k (Event x))))
285−newSubscriberMergeChange subd = return $! SubscriberMergeChange subd
286−
287−{-# NOINLINE newSubscriberFan #-}
288−newSubscriberFan :: GCompare k => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
289−newSubscriberFan subd = return $! SubscriberFan subd
290−
291−{-# NOINLINE newSubscriberSwitch #-}
292−newSubscriberSwitch :: SwitchSubscribed x a -> IO (Subscriber x a)
293−newSubscriberSwitch subd = return $! SubscriberSwitch subd
294−
295−{-# NOINLINE newSubscriberCoincidenceOuter #-}
296−newSubscriberCoincidenceOuter :: CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
297−newSubscriberCoincidenceOuter subd = return $! SubscriberCoincidenceOuter subd
298−
299−{-# NOINLINE newSubscriberCoincidenceInner #-}
300−newSubscriberCoincidenceInner :: CoincidenceSubscribed x a -> IO (Subscriber x a)
301−newSubscriberCoincidenceInner subd = return $! SubscriberCoincidenceInner subd
302−
303−invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
304−invalidateSubscriberHeight old s = case s of
305− SubscriberPush _ subscribed -> do
306− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
307− WeakBag.traverse (pushSubscribedSubscribers subscribed) $ invalidateSubscriberHeight old
308− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
309− SubscriberMerge _ subscribed -> do
310− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
311− removeMergeHeight old subscribed
312− invalidateMergeHeight subscribed
313− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
314− SubscriberMergeChange _ -> return () -- Doesn't affect the height of the merge, because its changes are delayed
315− SubscriberFan subscribed -> do
316− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
317− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
318− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
319− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
320− SubscriberHold _ -> return ()
321− SubscriberHoldIdentity _ -> return ()
322− SubscriberSwitch subscribed -> do
323− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
324− oldHeight <- readIORef $ switchSubscribedHeight subscribed
325− when (oldHeight /= invalidHeight) $ do
326− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
327− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
328− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
329− SubscriberCoincidenceOuter subscribed -> do
330− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
331− invalidateCoincidenceHeight subscribed
332− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
333− SubscriberCoincidenceInner subscribed -> do
334− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
335− invalidateCoincidenceHeight subscribed
336− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
337− SubscriberHandle -> return ()
338−
339−recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
340−recalculateSubscriberHeight new s = case s of
341− SubscriberPush _ subscribed -> do
342− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed
343− WeakBag.traverse (pushSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
344− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberPush" <> showNodeId subscribed <> " done"
345− SubscriberMerge _ subscribed -> do
346− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed
347− addMergeHeight new subscribed
348− revalidateMergeHeight subscribed
349− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberMerge" <> showNodeId subscribed <> " done"
350− SubscriberMergeChange _ -> return ()
351− SubscriberFan subscribed -> do
352− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
353− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
354− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
355− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
356− SubscriberHold _ -> return ()
357− SubscriberHoldIdentity _ -> return ()
358− SubscriberSwitch subscribed -> do
359− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
360− updateSwitchHeight new subscribed
361− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
362− SubscriberCoincidenceOuter subscribed -> do
363− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
364− recalculateCoincidenceHeight subscribed
365− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
366− SubscriberCoincidenceInner subscribed -> do
367− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
368− recalculateCoincidenceHeight subscribed
369− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
370− SubscriberHandle -> return ()
371−
372−-- | Propagate everything at the current height
373−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
374−propagate a subscribers = withIncreasedDepth $ do
375− -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
376− --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
377− WeakBag.traverse subscribers $ \s -> case s of
378− SubscriberPush compute subscribed -> {-# SCC "traversePush" #-} do
379− tracePropagate $ "SubscriberPush" <> showNodeId subscribed
380− occ <- runComputeM $ compute a
381− case occ of
382− Nothing -> return () -- No need to write a Nothing back into the Ref
383− Just o -> do
384− liftIO $ writeIORef (pushSubscribedOccurrence subscribed) occ
385− scheduleClear $ pushSubscribedOccurrence subscribed
386− propagate o $ pushSubscribedSubscribers subscribed
387− SubscriberMerge k subscribed -> {-# SCC "traverseMerge" #-} do
388− tracePropagate $ "SubscriberMerge" <> showNodeId subscribed
389− oldM <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
390− let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge" <> showNodeId subscribed) k (Identity a) oldM
391− tracePropagate $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
392− liftIO $ writeIORef (mergeSubscribedAccum subscribed) $! newM
393− when (DMap.null oldM) $ do -- Only schedule the firing once
394− height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
395− --TODO: assertions about height
396− currentHeight <- getCurrentHeight
397− when (height <= currentHeight) $ do
398− myStack <- liftIO $ whoCreatedIORef $ mergeSubscribedCachedSubscribed subscribed
399− if height /= invalidHeight
400− then error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
401− else liftIO $ do
402− nodesInvolvedInCycle <- walkInvalidHeightParents $ EventSubscribedMerge subscribed
403− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
404− error $ "Causality loop found:\n" <> drawForest (listsToForest stacks)
405− scheduleMerge height subscribed
406− SubscriberMergeChange subscribed -> {-# SCC "traverseMergeChange" #-} do
407− tracePropagate $ "SubscriberMerge" <> showNodeId subscribed
408− defer $ SomeMergeUpdate a subscribed
409− SubscriberFan subscribed -> {-# SCC "traverseFan" #-} do
410− subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
411− tracePropagate $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
412− --TODO: We need a better DMap intersection; here, we are assuming that the number of firing keys is small and the number of subscribers is large
413− forM_ (DMap.toList a) $ \(k :=> Identity v) -> {-# SCC "SubscriberFan" #-} case DMap.lookup k subs of
414− Nothing -> do
415− tracePropagate "No subscriber for key"
416− return ()
417− Just subsubs -> do
418− propagate v $ _fanSubscribedChildren_list subsubs
419− return ()
420− SubscriberHold h -> {-# SCC "traverseHold" #-} propagateSubscriberHold h a
421− SubscriberHoldIdentity h -> {-# SCC "traverseHoldIdentity" #-} propagateSubscriberHold h a
422− SubscriberSwitch subscribed -> {-# SCC "traverseSwitch" #-} do
423− tracePropagate $ "SubscriberSwitch" <> showNodeId subscribed
424− liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
425− scheduleClear $ switchSubscribedOccurrence subscribed
426− propagate a $ switchSubscribedSubscribers subscribed
427− SubscriberCoincidenceOuter subscribed -> {-# SCC "traverseCoincidenceOuter" #-} do
428− tracePropagate $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
429− outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
430− tracePropagate $ " outerHeight = " <> show outerHeight
431− (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
432− tracePropagate $ " isJust occ = " <> show (isJust occ)
433− tracePropagate $ " innerHeight = " <> show innerHeight
434− liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
435− scheduleClear $ coincidenceSubscribedInnerParent subscribed
436− case occ of
437− Nothing -> do
438− when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
439− writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
440− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
441− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
442− Just o -> do -- Since it's already firing, no need to adjust height
443− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
444− scheduleClear $ coincidenceSubscribedOccurrence subscribed
445− propagate o $ coincidenceSubscribedSubscribers subscribed
446− SubscriberCoincidenceInner subscribed -> {-# SCC "traverseCoincidenceInner" #-} do
447− tracePropagate $ "SubscriberCoincidenceInner" <> showNodeId subscribed
448− occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
449− case occ of
450− Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
451− Nothing -> do
452− liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
453− scheduleClear $ coincidenceSubscribedOccurrence subscribed
454− propagate a $ coincidenceSubscribedSubscribers subscribed
455− SubscriberHandle -> {-# SCC "traverseHandle" #-} tracePropagate "SubscriberHandle"
456−
457−--------------------------------------------------------------------------------
458−-- EventSubscribed
459−--------------------------------------------------------------------------------
460−
461−data EventSubscribed x a
462− = EventSubscribedRoot {-# NOUNPACK #-} (RootSubscribed x a)
463− | EventSubscribedNever
464− | forall b. EventSubscribedPush !(PushSubscribed x b a)
465− | forall k. (GCompare k, a ~ DMap k Identity) => EventSubscribedMerge !(MergeSubscribed x k)
466− | forall k. GCompare k => EventSubscribedFan !(k a) !(FanSubscribed x k)
467− | EventSubscribedSwitch !(SwitchSubscribed x a)
468− | EventSubscribedCoincidence !(CoincidenceSubscribed x a)
469−
470−readEventSubscribed :: EventSubscribed x a -> IO (Maybe a)
471−readEventSubscribed = \case
472− EventSubscribedRoot rs -> readRootSubscribed rs
473− EventSubscribedNever -> return Nothing
474− EventSubscribedPush ps -> readPushSubscribed ps
475− EventSubscribedMerge ms -> readMergeSubscribed ms
476− EventSubscribedFan k fs -> readFanSubscribed k fs
477− EventSubscribedSwitch ss -> readSwitchSubscribed ss
478− EventSubscribedCoincidence cs -> readCoincidenceSubscribed cs
479−
480−{-# INLINE subscribeEventSubscribed #-}
481−subscribeEventSubscribed :: EventSubscribed x a -> Subscriber x a -> IO (Maybe (WeakBagTicket (Subscriber x a)))
482−subscribeEventSubscribed es sub = case es of
483− EventSubscribedRoot r -> do
484− traceSubscribe $ "subscribeEventSubscribed Root"
485− Just <$> subscribeRootSubscribed r sub
486− EventSubscribedNever -> do
487− traceSubscribe $ "subscribeEventSubscribed Never"
488− return Nothing
489− EventSubscribedPush subscribed -> do
490− traceSubscribe $ "subscribeEventSubscribed Push"
491− Just <$> subscribePushSubscribed subscribed sub
492− EventSubscribedFan k subscribed -> do
493− traceSubscribe $ "subscribeEventSubscribed Fan"
494− Just <$> subscribeFanSubscribed k subscribed sub
495− EventSubscribedMerge subscribed -> do
496− traceSubscribe $ "subscribeEventSubscribed Merge"
497− Just <$> subscribeMergeSubscribed subscribed sub
498− EventSubscribedSwitch subscribed -> do
499− traceSubscribe $ "subscribeEventSubscribed Switch"
500− Just <$> subscribeSwitchSubscribed subscribed sub
501− EventSubscribedCoincidence subscribed -> do
502− traceSubscribe $ "subscribeEventSubscribed Coincidence"
503− Just <$> subscribeCoincidenceSubscribed subscribed sub
504−
505−{-# INLINE eventSubscribedGetParents #-}
506−eventSubscribedGetParents :: EventSubscribed x a -> IO [Some (EventSubscribed x)]
507−eventSubscribedGetParents = \case
508− EventSubscribedRoot _ -> return []
509− EventSubscribedNever -> return []
510− EventSubscribedPush subscribed -> return [Some.This $ _eventSubscription_subscribed $ pushSubscribedParent subscribed]
511− EventSubscribedFan _ subscribed -> return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
512− EventSubscribedMerge subscribed -> do
513− ps <- readIORef $ mergeSubscribedParents subscribed
514− return $ R.ffor (DMap.toList ps) $ \(_ :=> v) -> Some.This $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription v
515− EventSubscribedSwitch subscribed -> do
516− s <- readIORef $ switchSubscribedCurrentParent subscribed
517− return [Some.This $ _eventSubscription_subscribed s]
518− EventSubscribedCoincidence subscribed -> do
519− innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
520− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
521− innerParents = maybeToList $ fmap Some.This innerSubscription
522− return $ outerParent : innerParents
523−
524−getEventSubscribedHeight :: EventSubscribed x a -> IO Height
525−getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
526−
527−{-# INLINE eventSubscribedHeightRef #-}
528−eventSubscribedHeightRef :: EventSubscribed x a -> IORef Height
529−eventSubscribedHeightRef = \case
530− EventSubscribedRoot _ -> zeroRef
531− EventSubscribedNever -> zeroRef
532− EventSubscribedPush subscribed -> pushSubscribedHeight subscribed
533− EventSubscribedFan _ subscribed -> eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
534− EventSubscribedMerge subscribed -> mergeSubscribedHeight subscribed
535− EventSubscribedSwitch subscribed -> switchSubscribedHeight subscribed
536− EventSubscribedCoincidence subscribed -> coincidenceSubscribedHeight subscribed
537−
538−whoCreatedEventSubscribed :: EventSubscribed x a -> IO [String]
539−whoCreatedEventSubscribed = \case
540− EventSubscribedRoot _ -> return ["root"]
541− EventSubscribedNever -> return ["never"]
542− EventSubscribedPush subscribed -> whoCreatedIORef $ pushSubscribedCachedSubscribed subscribed
543− EventSubscribedFan _ subscribed -> whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
544− EventSubscribedMerge subscribed -> whoCreatedIORef $ mergeSubscribedCachedSubscribed subscribed
545− EventSubscribedSwitch subscribed -> whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
546− EventSubscribedCoincidence subscribed -> whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
547−
548−{-# INLINE eventSubscribedHasOwnHeightRef #-}
549−eventSubscribedHasOwnHeightRef :: EventSubscribed x a -> Bool
550−eventSubscribedHasOwnHeightRef = \case
551− EventSubscribedRoot _ -> False
552− EventSubscribedNever -> False
553− EventSubscribedPush _ -> False
554− EventSubscribedFan _ _ -> False
555− EventSubscribedMerge _ -> True
556− EventSubscribedSwitch _ -> True
557− EventSubscribedCoincidence _ -> True
558−
559−walkInvalidHeightParents :: EventSubscribed x a -> IO [Some (EventSubscribed x)]
560−walkInvalidHeightParents s0 = do
561− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
562− h <- liftIO $ readIORef $ eventSubscribedHeightRef s
563− when (h == invalidHeight) $ do
564− when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
565− modify (Some.This s :)
566− mapM_ loop =<< liftIO (eventSubscribedGetParents s)
567− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
568− return subscribers
569−
570−{-# INLINE subscribeHoldEvent #-}
571−subscribeHoldEvent :: (CanSubscribe x m, R.Patch p) => Hold x p a -> Subscriber x (p a) -> m (EventSubscription x (p a))
572−subscribeHoldEvent h sub = do
573− EventSubscription _ subd <- getHoldEventSubscription h
574− sln <- liftIO $ subscribeEventSubscribed subd sub
575− return $ EventSubscription sln subd
576−
577−--------------------------------------------------------------------------------
578−-- EventSubscription
579−--------------------------------------------------------------------------------
580−
581−data EventSubscription x a = EventSubscription
582− { _eventSubscription_ticket :: !(Maybe (WeakBagTicket (Subscriber x a)))
583− , _eventSubscription_subscribed :: !(EventSubscribed x a)
584− }
585−
586−unsubscribe :: EventSubscription x a -> IO ()
587−unsubscribe (EventSubscription msln _) = forM_ msln $ \sln -> WeakBag.remove sln
588−
589−--------------------------------------------------------------------------------
590−-- Combinators
591−--------------------------------------------------------------------------------
592−
593−--TODO: Figure out why certain things are not 'representational', then make them
594−--representational so we can use coerce
595−
596−--type role Hold representational
597−data Hold x p a
598− = Hold { holdValue :: !(IORef a)
599− , holdInvalidators :: !(IORef [Weak (Invalidator x)])
600− , holdParent :: !(IORef (Either (Event x (p a)) (EventSubscription x (p a)))) -- Keeps its parent alive (will be undefined until the hold is initialized) --TODO: Probably shouldn't be an IORef
601−#ifdef DEBUG_NODEIDS
602− , holdNodeId :: Int
603−#endif
604− }
605−
606−data EventEnv x
607− = EventEnv { eventEnvSpiderEnv :: !(SpiderEnv x)
608− , eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
609− , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
610− , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
611− , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
612− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
613− , eventEnvRootClears :: !(IORef [SomeRootClear])
614− , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
615− , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
616− , eventEnvDelayedMerges :: !(IORef (IntMap [DelayedMerge x]))
617− }
618−
619−{-# INLINE runEventM #-}
620−runEventM :: EventM x a -> EventEnv x -> IO a
621−runEventM = runReaderT . unEventM
622−
623−class MonadIO m => Defer a m where
624− getDeferralQueue :: m (IORef [a])
625−
626−{-# INLINE defer #-}
627−defer :: Defer a m => a -> m ()
628−defer a = do
629− q <- getDeferralQueue
630− liftIO $ modifyIORef' q (a:)
631−
632−instance Defer (SomeAssignment x) (EventM x) where
633− {-# INLINE getDeferralQueue #-}
634− getDeferralQueue = EventM $ asks eventEnvAssignments
635−
636−instance Defer (SomeHoldInit x) (EventM x) where
637− {-# INLINE getDeferralQueue #-}
638− getDeferralQueue = EventM $ asks eventEnvHoldInits
639−
640−instance Defer (SomeHoldInit x) (BehaviorM x) where
641− {-# INLINE getDeferralQueue #-}
642− getDeferralQueue = BehaviorM $ asks snd
643−
644−instance Defer (SomeMergeUpdate x) (EventM x) where
645− {-# INLINE getDeferralQueue #-}
646− getDeferralQueue = EventM $ asks eventEnvMergeUpdates
647−
648−instance Defer (SomeMergeInit x) (EventM x) where
649− {-# INLINE getDeferralQueue #-}
650− getDeferralQueue = EventM $ asks eventEnvMergeInits
651−
652−class HasCurrentHeight x m | m -> x where
653− getCurrentHeight :: m Height
654− scheduleMerge :: Height -> MergeSubscribed x a -> m ()
655−
656−instance HasCurrentHeight x (EventM x) where
657− {-# INLINE getCurrentHeight #-}
658− getCurrentHeight = EventM $ do
659− heightRef <- asks eventEnvCurrentHeight
660− liftIO $ readIORef heightRef
661− {-# INLINE scheduleMerge #-}
662− scheduleMerge height subscribed = EventM $ do
663− delayedRef <- asks eventEnvDelayedMerges
664− liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [DelayedMerge subscribed]
665−
666−class HasSpiderEnv x m | m -> x where
667− -- | Retrieve the current SpiderEnv
668− askSpiderEnv :: m (SpiderEnv x)
669−
670−instance HasSpiderEnv x (EventM x) where
671− {-# INLINE askSpiderEnv #-}
672− askSpiderEnv = EventM $ asks eventEnvSpiderEnv
673−
674−instance HasSpiderEnv x (SpiderHost x) where
675− {-# INLINE askSpiderEnv #-}
676− askSpiderEnv = SpiderHost ask
677−
678−putCurrentHeight :: Height -> EventM x ()
679−putCurrentHeight h = EventM $ do
680− heightRef <- asks eventEnvCurrentHeight
681− liftIO $ writeIORef heightRef $! h
682−
683−instance Defer SomeClear (EventM x) where
684− {-# INLINE getDeferralQueue #-}
685− getDeferralQueue = EventM $ asks eventEnvClears
686−
687−{-# INLINE scheduleClear #-}
688−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
689−scheduleClear r = defer $ SomeClear r
690−
691−instance Defer SomeRootClear (EventM x) where
692− {-# INLINE getDeferralQueue #-}
693− getDeferralQueue = EventM $ asks eventEnvRootClears
694−
695−{-# INLINE scheduleRootClear #-}
696−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
697−scheduleRootClear r = defer $ SomeRootClear r
698−
699−instance Defer (SomeResetCoincidence x) (EventM x) where
700− {-# INLINE getDeferralQueue #-}
701− getDeferralQueue = EventM $ asks eventEnvResetCoincidences
702−
703−-- Note: hold cannot examine its event until after the phase is over
704−{-# SPECIALIZE hold :: R.Patch p => a -> Event x (p a) -> EventM x (Hold x p a) #-}
705−{-# SPECIALIZE hold :: R.Patch p => a -> Event x (p a) -> ComputeM x (Hold x p a) #-}
706−hold :: (R.Patch p, Defer (SomeHoldInit x) m) => a -> Event x (p a) -> m (Hold x p a)
707−hold v0 e = do
708− valRef <- liftIO $ newIORef v0
709− invsRef <- liftIO $ newIORef []
710− parentRef <- liftIO $ newIORef $ Left e
711−#ifdef DEBUG_NODEIDS
712− nodeId <- liftIO newNodeId
713−#endif
714− let h = Hold
715− { holdValue = valRef
716− , holdInvalidators = invsRef
717− , holdParent = parentRef
718−#ifdef DEBUG_NODEIDS
719− , holdNodeId = nodeId
720−#endif
721− }
722− defer $ SomeHoldInit h
723− return h
724−
725−{-# INLINE getHoldEventSubscription #-}
726−getHoldEventSubscription :: forall m p a x. (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer SomeClear m, R.Patch p, HasCurrentHeight x m, Defer (SomeMergeInit x) m, Defer (SomeResetCoincidence x) m, HasSpiderEnv x m, m ~ EventM x) => Hold x p a -> m (EventSubscription x (p a))
727−getHoldEventSubscription h = do
728− ep <- liftIO $ readIORef $ holdParent h
729− case ep of
730− Right subd -> return subd
731− Left e -> do
732− subscriptionRef <- liftIO $ newIORef $ error "getHoldEventSubscription: subdRef uninitialized"
733− subscription@(EventSubscription _ subd) <- subscribe e =<< liftIO (newSubscriberHold h)
734− liftIO $ writeIORef subscriptionRef $! subscription
735− occ <- liftIO $ readEventSubscribed subd
736− case occ of
737− Nothing -> return ()
738− Just o -> do
739− old <- liftIO $ readIORef $ holdValue h
740− case R.apply o old of
741− Nothing -> return ()
742− Just new -> do
743− -- Need to evaluate these so that we don't retain the Hold itself
744− v <- liftIO $ evaluate $ holdValue h
745− i <- liftIO $ evaluate $ holdInvalidators h
746− defer $ SomeAssignment v i new
747− liftIO $ writeIORef (holdParent h) $ Right subscription
748− return subscription
749−
750−type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
751−
752−--type role BehaviorM representational
753−-- BehaviorM can sample behaviors
754−newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderT (BehaviorEnv x) IO a } deriving (Functor, Applicative, MonadIO, MonadFix)
755−
756−instance Monad (BehaviorM x) where
757− {-# INLINE (>>=) #-}
758− BehaviorM x >>= f = BehaviorM $ x >>= unBehaviorM . f
759− {-# INLINE (>>) #-}
760− BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
761− {-# INLINE return #-}
762− return x = BehaviorM $ return x
763− {-# INLINE fail #-}
764− fail s = BehaviorM $ fail s
765−
766−data BehaviorSubscribed x a
767− = forall p. BehaviorSubscribedHold (Hold x p a)
768− | BehaviorSubscribedPull (PullSubscribed x a)
769−
770−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
771−
772−--type role PullSubscribed representational
773−data PullSubscribed x a
774− = PullSubscribed { pullSubscribedValue :: !a
775− , pullSubscribedInvalidators :: !(IORef [Weak (Invalidator x)])
776− , pullSubscribedOwnInvalidator :: !(Invalidator x)
777− , pullSubscribedParents :: ![SomeBehaviorSubscribed x] -- Need to keep parent behaviors alive, or they won't let us know when they're invalidated
778− }
779−
780−--type role Pull representational
781−data Pull x a
782− = Pull { pullValue :: !(IORef (Maybe (PullSubscribed x a)))
783− , pullCompute :: !(BehaviorM x a)
784−#ifdef DEBUG_NODEIDS
785− , pullNodeId :: Int
786−#endif
787− }
788−
789−data Invalidator x
790− = forall a. InvalidatorPull (Pull x a)
791− | forall a. InvalidatorSwitch (SwitchSubscribed x a)
792−
793−data RootSubscribed x a = forall k. GCompare k => RootSubscribed
794− { rootSubscribedKey :: !(k a)
795− , rootSubscribedCachedSubscribed :: !(IORef (DMap k (RootSubscribed x))) -- From the original Root
796− , rootSubscribedSubscribers :: !(WeakBag (Subscriber x a))
797− , rootSubscribedOccurrence :: !(IO (Maybe a)) -- Lookup from rootOccurrence
798− , rootSubscribedUninit :: IO ()
799− , rootSubscribedWeakSelf :: !(IORef (Weak (RootSubscribed x a))) --TODO: Can we make this a lazy non-IORef and then force it manually to avoid an indirection each time we use it?
800−#ifdef DEBUG_NODEIDS
801− , rootSubscribedNodeId :: Int
802−#endif
803− }
804−
805−data Root x (k :: * -> *)
806− = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
807− , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
808− , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
809− }
810−
811−data SomeHoldInit x = forall p a. R.Patch p => SomeHoldInit !(Hold x p a)
812−
813−data SomeMergeUpdate x = forall k. GCompare k => SomeMergeUpdate (R.PatchDMap (DMap k (Event x))) (MergeSubscribed x k)
814−
815−data SomeMergeInit x = forall k. GCompare k => SomeMergeInit !(MergeSubscribed x k) !(Event x (R.PatchDMap (DMap k (Event x))))
816−
817−data SomeEventSubscription x = forall a. SomeEventSubscription (EventSubscription x a)
818−
819−-- EventM can do everything BehaviorM can, plus create holds
820−newtype EventM x (a :: *) = EventM { unEventM :: ReaderT (EventEnv x) IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException) -- The environment should be Nothing if we are not in a frame, and Just if we are - in which case it is a list of assignments to be done after the frame is over
821−
822−data PushSubscribed x a b
823− = PushSubscribed { pushSubscribedCachedSubscribed :: !(IORef (Maybe (PushSubscribed x a b)))
824− , pushSubscribedOccurrence :: !(IORef (Maybe b)) -- If the current height is less than our height, this should always be Nothing; during our height, this will get filled in at some point, always before our children are notified; after our height, this will be filled in with the correct value (Nothing if we are not firing, Just if we are)
825− , pushSubscribedHeight :: !(IORef Height)
826− , pushSubscribedSubscribers :: !(WeakBag (Subscriber x b))
827− , pushSubscribedSelf :: !(Subscriber x a) -- Hold this in memory to ensure our WeakReferences don't die --TODO: Probably unneeded now
828− , pushSubscribedWeakSelf :: !(IORef (Weak (PushSubscribed x a b)))
829− , pushSubscribedParent :: !(EventSubscription x a)
830−#ifdef DEBUG_NODEIDS
831− , pushSubscribedNodeId :: Int
832−#endif
833− }
834−
835−newtype ComputeM x a = ComputeM (ReaderT (IORef [SomeHoldInit x]) IO a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
836−
837−instance Defer (SomeHoldInit x) (ComputeM x) where
838− getDeferralQueue = ComputeM ask
839−
840−{-# SPECIALIZE runComputeM :: ComputeM x a -> EventM x a #-}
841−runComputeM :: Defer (SomeHoldInit x) m => ComputeM x a -> m a
842−runComputeM (ComputeM a) = liftIO . runReaderT a =<< getDeferralQueue
843−
844−data Push x a b
845− = Push { pushCompute :: !(a -> ComputeM x (Maybe b)) -- Compute the current firing value; assumes that its parent has been computed --TODO: This only uses Defer SomeHoldInit EventM; perhaps only the hold init queue should be passed in (also, perhaps those hold inits can be accelerated - can there be a loop we would need to worry about?)
846− , pushParent :: !(Event x a)
847− , pushSubscribed :: !(IORef (Maybe (PushSubscribed x a b))) --TODO: Can we replace this with an unsafePerformIO thunk?
848− }
849−
850−data MergeSubscribedParent (x :: *) k a = MergeSubscribedParent !(EventSubscription x a) !(Subscriber x a)
851−
852−mergeSubscribedParentSubscription :: MergeSubscribedParent x k a -> EventSubscription x a
853−mergeSubscribedParentSubscription (MergeSubscribedParent es _) = es
854−
855−data HeightBag = HeightBag
856− { _heightBag_size :: {-# UNPACK #-} !Int
857− , _heightBag_contents :: !(IntMap Word) -- Number of excess in each bucket
858− }
859− deriving (Show, Read, Eq, Ord)
860−
861−heightBagEmpty :: HeightBag
862−heightBagEmpty = heightBagVerify $ HeightBag 0 IntMap.empty
863−
864−heightBagSize :: HeightBag -> Int
865−heightBagSize = _heightBag_size
866−
867−heightBagFromList :: [Height] -> HeightBag
868−heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
869−
870−heightBagAdd :: Height -> HeightBag -> HeightBag
871−heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
872−
873−heightBagRemove :: Height -> HeightBag -> HeightBag
874−heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
875− Nothing -> error $ "heightBagRemove: Height " <> show h <> " not present in bag " <> show b
876− Just old -> HeightBag (pred s) $ case old of
877− 0 -> IntMap.delete h c
878− _ -> IntMap.insert h (pred old) c
879−
880−heightBagMax :: HeightBag -> Height
881−heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
882− Just ((h, _), _) -> Height h
883− Nothing -> zeroHeight
884−
885−heightBagVerify :: HeightBag -> HeightBag
886−#ifdef DEBUG
887−heightBagVerify b@(HeightBag s c) = if
888− | s /= IntMap.size c + fromIntegral (sum (IntMap.elems c))
889− -> error $ "heightBagVerify: size doesn't match: " <> show b
890− | unHeight invalidHeight `IntMap.member` c
891− -> error $ "heightBagVerify: contains invalid height: " <> show b
892− | otherwise -> b
893−#else
894−heightBagVerify = id
895−#endif
896−
897−data MergeSubscribed x k
898− = MergeSubscribed { mergeSubscribedCachedSubscribed :: !(IORef (Maybe (MergeSubscribed x k))) -- From the original merge
899− , mergeSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
900− , mergeSubscribedAccum :: !(IORef (DMap k Identity)) -- This will accumulate occurrences until our height is reached, at which point it will be transferred to mergeSubscribedOccurrence
901− , mergeSubscribedHeight :: !(IORef Height)
902− , mergeSubscribedHeightBag :: !(IORef HeightBag)
903− , mergeSubscribedSubscribers :: !(WeakBag (Subscriber x (DMap k Identity)))
904− , mergeSubscribedChange :: !(IORef (Subscriber x (R.PatchDMap (DMap k (Event x))), EventSubscribed x (R.PatchDMap (DMap k (Event x)))))
905− , mergeSubscribedParents :: !(IORef (DMap k (MergeSubscribedParent x k)))
906− , mergeSubscribedWeakSelf :: !(IORef (Weak (MergeSubscribed x k)))
907−#ifdef DEBUG_NODEIDS
908− , mergeSubscribedNodeId :: Int
909−#endif
910− }
911−
912−--TODO: DMap sucks; we should really write something better (with a functor for the value as well as the key)
913−data Merge x k
914− = Merge { mergeParents :: !(Dynamic x R.PatchDMap (DMap k (Event x)))
915− , mergeSubscribed :: !(IORef (Maybe (MergeSubscribed x k)))
916− }
917−
918−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
919− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
920− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
921− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
922− }
923−
924−data FanSubscribed (x :: *) k
925− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
926− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
927− , fanSubscribedParent :: !(EventSubscription x (DMap k Identity))
928−#ifdef DEBUG_NODEIDS
929− , fanSubscribedNodeId :: Int
930−#endif
931− }
932−
933−data Fan x k
934− = Fan { fanParent :: !(Event x (DMap k Identity))
935− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
936− }
937−
938−data SwitchSubscribed x a
939− = SwitchSubscribed { switchSubscribedCachedSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
940− , switchSubscribedOccurrence :: !(IORef (Maybe a))
941− , switchSubscribedHeight :: !(IORef Height)
942− , switchSubscribedSubscribers :: !(WeakBag (Subscriber x a))
943− , switchSubscribedOwnInvalidator :: {-# NOUNPACK #-} !(Invalidator x)
944− , switchSubscribedOwnWeakInvalidator :: !(IORef (Weak (Invalidator x)))
945− , switchSubscribedBehaviorParents :: !(IORef [SomeBehaviorSubscribed x])
946− , switchSubscribedParent :: !(Behavior x (Event x a))
947− , switchSubscribedCurrentParent :: !(IORef (EventSubscription x a))
948− , switchSubscribedWeakSelf :: !(IORef (Weak (SwitchSubscribed x a)))
949−#ifdef DEBUG_NODEIDS
950− , switchSubscribedNodeId :: Int
951−#endif
952− }
953−
954−data Switch x a
955− = Switch { switchParent :: !(Behavior x (Event x a))
956− , switchSubscribed :: !(IORef (Maybe (SwitchSubscribed x a)))
957− }
958−
959−{-# ANN CoincidenceSubscribed "HLint: ignore Redundant bracket" #-}
960−data CoincidenceSubscribed x a
961− = CoincidenceSubscribed { coincidenceSubscribedCachedSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
962− , coincidenceSubscribedOccurrence :: !(IORef (Maybe a))
963− , coincidenceSubscribedSubscribers :: !(WeakBag (Subscriber x a))
964− , coincidenceSubscribedHeight :: !(IORef Height)
965− , coincidenceSubscribedOuter :: {-# NOUNPACK #-} (Subscriber x (Event x a))
966− , coincidenceSubscribedOuterParent :: !(EventSubscription x (Event x a))
967− , coincidenceSubscribedInnerParent :: !(IORef (Maybe (EventSubscribed x a)))
968− , coincidenceSubscribedWeakSelf :: !(IORef (Weak (CoincidenceSubscribed x a)))
969−#ifdef DEBUG_NODEIDS
970− , coincidenceSubscribedNodeId :: Int
971−#endif
972− }
973−
974−data Coincidence x a
975− = Coincidence { coincidenceParent :: !(Event x (Event x a))
976− , coincidenceSubscribed :: !(IORef (Maybe (CoincidenceSubscribed x a)))
977− }
978−
979−{-# NOINLINE newInvalidatorSwitch #-}
980−newInvalidatorSwitch :: SwitchSubscribed x a -> IO (Invalidator x)
981−newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
982−
983−{-# NOINLINE newInvalidatorPull #-}
984−newInvalidatorPull :: Pull x a -> IO (Invalidator x)
985−newInvalidatorPull p = return $! InvalidatorPull p
986−
987−data Dynamic x p a
988− = DynamicHold !(Hold x p a)
989− | p ~ Identity => DynamicHoldIdentity !(Hold x Identity a)
990− | DynamicConst !a
991− | DynamicDyn !(Dyn x p a)
992− | p ~ Identity => DynamicDynIdentity !(Dyn x Identity a)
993−
994−{-# INLINE current #-}
995−current :: R.Patch p => Dynamic x p a -> Behavior x a
996−current = \case
997− DynamicHold h -> BehaviorHold h
998− DynamicHoldIdentity h -> BehaviorHoldIdentity h
999− DynamicConst a -> BehaviorConst a
1000− DynamicDyn d -> BehaviorDyn d
1001− DynamicDynIdentity d -> BehaviorDynIdentity d
1002−
1003−--TODO: If you only need updated, not current, can we avoid actually constructing the Hold?
1004−{-# INLINE updated #-}
1005−updated :: R.Patch p => Dynamic x p a -> Event x (p a)
1006−updated = \case
1007− DynamicHold h -> eventHold h
1008− DynamicHoldIdentity h -> eventHoldIdentity h
1009− DynamicConst _ -> eventNever
1010− DynamicDyn d -> eventDyn d
1011− DynamicDynIdentity d -> eventDynIdentity d
1012−
1013−newMapDyn :: (a -> b) -> Dynamic x Identity a -> Dynamic x Identity b
1014−newMapDyn f d = DynamicDynIdentity $ unsafeDyn (fmap f $ readBehaviorTracked $ current d) (Identity . f . runIdentity <$> updated d)
1015−
1016−instance Functor (Dynamic x Identity) where
1017− fmap = newMapDyn
1018−
1019−instance Applicative (Dynamic x Identity) where
1020− pure = DynamicConst
1021− (<*>) = zipDynWith ($)
1022− _ *> b = b
1023− a <* _ = a
1024−
1025−instance R.FunctorMaybe (Event x) where
1026− fmapMaybe f = push $ return . f
1027−
1028−instance Align (Event x) where
1029− nil = eventNever
1030− align ea eb = R.fmapMaybe R.dmapToThese $ merge $ DynamicConst $ DMap.fromList [R.LeftTag :=> ea, R.RightTag :=> eb]
1031−
1032−--TODO: Avoid the duplication between this and R.zipDynWith
1033−zipDynWith :: (a -> b -> c) -> Dynamic x Identity a -> Dynamic x Identity b -> Dynamic x Identity c
1034−zipDynWith f da db =
1035− let eab = align (updated da) (updated db)
1036− ec = flip push eab $ \o -> do
1037− (a, b) <- case o of
1038− This (Identity a) -> do
1039− b <- readBehaviorUntracked $ current db
1040− return (a, b)
1041− That (Identity b) -> do
1042− a <- readBehaviorUntracked $ current da
1043− return (a, b)
1044− These (Identity a) (Identity b) -> return (a, b)
1045− return $ Just $ Identity $ f a b
1046− in DynamicDynIdentity $ unsafeDyn (f <$> readBehaviorUntracked (current da) <*> readBehaviorUntracked (current db)) ec
1047−
1048−instance Monad (Dynamic x Identity) where
1049− {-# INLINE return #-}
1050− return = pure
1051− {-# INLINE (>>=) #-}
1052− x >>= f = DynamicDynIdentity $ newJoinDyn $ newMapDyn f x --TODO: (>>), fail
1053− {-# INLINE (>>) #-}
1054− _ >> y = y
1055− {-# INLINE fail #-}
1056− fail _ = error "Dynamic does not support 'fail'"
1057−
1058−newtype Dyn x p a = Dyn { unDyn :: IORef (Either (BehaviorM x a, Event x (p a)) (Hold x p a)) }
1059−
1060−unsafeDyn :: BehaviorM x a -> Event x (p a) -> Dyn x p a
1061−unsafeDyn readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1062− where x = (readV0, v')
1063−
1064−newJoinDyn :: Dynamic x Identity (Dynamic x Identity a) -> Dyn x Identity a
1065−newJoinDyn d =
1066− let readV0 = readBehaviorTracked . current =<< readBehaviorTracked (current d)
1067− eOuter = push (fmap (Just . Identity) . readBehaviorUntracked . current . runIdentity) $ updated d
1068− eInner = switch $ updated <$> current d
1069− eBoth = coincidence $ updated . runIdentity <$> updated d
1070− v' = unSpiderEvent $ R.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
1071− in unsafeDyn readV0 v'
1072−
1073−--type role Behavior representational
1074−data Behavior x a
1075− = forall p. BehaviorHold !(Hold x p a)
1076− | BehaviorHoldIdentity !(Hold x Identity a)
1077− | BehaviorConst !a
1078− | BehaviorPull !(Pull x a)
1079− | BehaviorDynIdentity !(Dyn x Identity a)
1080− | forall p. R.Patch p => BehaviorDyn !(Dyn x p a)
1081−
1082−-- ResultM can read behaviors and events
1083−type ResultM = EventM
1084−
1085−{-# NOINLINE unsafeNewIORef #-}
1086−unsafeNewIORef :: a -> b -> IORef b
1087−unsafeNewIORef _ b = unsafePerformIO $ newIORef b
1088−
1089−instance Functor (Event x) where
1090− fmap f = push $ return . Just . f
1091−
1092−instance Functor (Behavior x) where
1093− fmap f = pull . fmap f . readBehaviorTracked
1094−
1095−{-# NOINLINE push #-} --TODO: If this is helpful, we can get rid of the unsafeNewIORef and use unsafePerformIO directly
1096−push :: (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
1097−push f e = eventPush $ Push
1098− { pushCompute = f
1099− , pushParent = e
1100− , pushSubscribed = unsafeNewIORef (f, e) Nothing --TODO: Does the use of the tuple here create unnecessary overhead?
1101− }
1102−-- DISABLED: {- RULES "push/push" forall f g e. push f (push g e) = push (maybe (return Nothing) f <=< g) e #-}
1103−
1104−{-# NOINLINE pull #-}
1105−pull :: BehaviorM x a -> Behavior x a
1106−pull a = BehaviorPull $ Pull
1107− { pullCompute = a
1108− , pullValue = unsafeNewIORef a Nothing
1109−#ifdef DEBUG_NODEIDS
1110− , pullNodeId = unsafeNodeId a
1111−#endif
1112− }
1113−
1114−{-# NOINLINE switch #-}
1115−switch :: Behavior x (Event x a) -> Event x a
1116−switch a = eventSwitch $ Switch
1117− { switchParent = a
1118− , switchSubscribed = unsafeNewIORef a Nothing
1119− }
1120−
1121−coincidence :: Event x (Event x a) -> Event x a
1122−coincidence a = eventCoincidence $ Coincidence
1123− { coincidenceParent = a
1124− , coincidenceSubscribed = unsafeNewIORef a Nothing
1125− }
1126−
1127−-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1128−run :: [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1129−run roots after = do
1130− tracePropagate $ "Running an event frame with " <> show (length roots) <> " events"
1131− spiderEnv <- SpiderHost ask
1132− result <- SpiderHost $ lift $ withMVar (_spiderEnv_lock spiderEnv) $ \_ -> flip runReaderT spiderEnv $ unSpiderHost $ runFrame $ do
1133− rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1134− occBefore <- liftIO $ do
1135− occBefore <- readIORef occRef
1136− writeIORef occRef $! DMap.insert k a occBefore
1137− return occBefore
1138− if DMap.null occBefore
1139− then do scheduleRootClear occRef
1140− return $ Just r
1141− else return Nothing
1142− forM_ (catMaybes rootsToPropagate) $ \(RootTrigger (subscribersRef, _, _) :=> Identity a) -> do
1143− propagate a subscribersRef
1144− delayedRef <- EventM $ asks eventEnvDelayedMerges
1145− let go = do
1146− delayed <- liftIO $ readIORef delayedRef
1147− case IntMap.minViewWithKey delayed of
1148− Nothing -> return ()
1149− Just ((currentHeight, cur), future) -> do
1150− tracePropagate $ "Running height " ++ show currentHeight
1151− putCurrentHeight $ Height currentHeight
1152− liftIO $ writeIORef delayedRef $! future
1153− forM_ cur $ \d -> case d of
1154− DelayedMerge subscribed -> do
1155− height <- liftIO $ readIORef $ mergeSubscribedHeight subscribed
1156− case height `compare` Height currentHeight of
1157− LT -> error "Somehow a merge's height has been decreased after it was scheduled"
1158− GT -> scheduleMerge height subscribed -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1159− EQ -> do
1160− m <- liftIO $ readIORef $ mergeSubscribedAccum subscribed
1161− liftIO $ writeIORef (mergeSubscribedAccum subscribed) $! DMap.empty
1162− --TODO: Assert that m is not empty
1163− liftIO $ writeIORef (mergeSubscribedOccurrence subscribed) $ Just m
1164− scheduleClear $ mergeSubscribedOccurrence subscribed
1165− propagate m $ mergeSubscribedSubscribers subscribed
1166− go
1167− go
1168− putCurrentHeight maxBound
1169− after
1170− tracePropagate "Done running an event frame"
1171− return result
1172−
1173−data SomeClear = forall a. SomeClear (IORef (Maybe a))
1174−
1175−data SomeRootClear = forall k. SomeRootClear (IORef (DMap k Identity))
1176−
1177−data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1178−
1179−data DelayedMerge x = forall k. DelayedMerge (MergeSubscribed x k)
1180−
1181−debugFinalize :: Bool
1182−debugFinalize = False
1183−
1184−mkWeakPtrWithDebug :: a -> String -> IO (Weak a)
1185−mkWeakPtrWithDebug x debugNote = do
1186− x' <- evaluate x
1187− mkWeakPtr x' $
1188− if debugFinalize
1189− then Just $ putStrLn $ "finalizing: " ++ debugNote
1190− else Nothing
1191−
1192−type WeakList a = [Weak a]
1193−
1194−{-# INLINE withIncreasedDepth #-}
1195−#ifdef DEBUG
1196−withIncreasedDepth :: CanTrace x m => m a -> m a
1197−withIncreasedDepth a = do
1198− spiderEnv <- askSpiderEnv
1199− liftIO $ modifyIORef' (_spiderEnv_depth spiderEnv) succ
1200− result <- a
1201− liftIO $ modifyIORef' (_spiderEnv_depth spiderEnv) pred
1202− return result
1203−#else
1204−withIncreasedDepth :: m a -> m a
1205−withIncreasedDepth = id
1206−#endif
1207−
1208−type CanTrace x m = (HasSpiderEnv x m, MonadIO m)
1209−
1210−{-# INLINE tracePropagate #-}
1211−tracePropagate :: (CanTrace x m) => String -> m ()
1212−tracePropagate = traceWhen debugPropagate
1213−
1214−{-# INLINE traceSubscribe #-}
1215−traceSubscribe :: String -> IO ()
1216−traceSubscribe = when debugSubscribe . liftIO . putStrLn
1217−
1218−{-# INLINE traceInvalidate #-}
1219−traceInvalidate :: String -> IO ()
1220−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1221−
1222−{-# INLINE traceWhen #-}
1223−traceWhen :: (CanTrace x m) => Bool -> String -> m ()
1224−traceWhen b message = traceMWhen b $ return message
1225−
1226−{-# INLINE traceMWhen #-}
1227−traceMWhen :: (CanTrace x m) => Bool -> m String -> m ()
1228−traceMWhen b getMessage = when b $ do
1229− message <- getMessage
1230−#ifdef DEBUG
1231− spiderEnv <- askSpiderEnv
1232− d <- liftIO $ readIORef $ _spiderEnv_depth spiderEnv
1233−#else
1234− let d = 0
1235−#endif
1236− liftIO $ putStrLn $ replicate d ' ' <> message
1237−
1238−whoCreatedIORef :: IORef a -> IO [String]
1239−whoCreatedIORef (IORef a) = whoCreated $! a
1240−
1241−groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1242−groupByHead = \case
1243− [] -> []
1244− (x :| xs) : t -> case groupByHead t of
1245− [] -> [(x, xs :| [])]
1246− l@((y, yss) : t')
1247− | x == y -> (x, xs `NonEmpty.cons` yss) : t'
1248− | otherwise -> (x, xs :| []) : l
1249−
1250−listsToForest :: Eq a => [[a]] -> Forest a
1251−listsToForest l = fmap (\(a, l') -> Node a $ listsToForest $ toList l') $ groupByHead $ catMaybes $ fmap nonEmpty l
1252−
1253−{-# INLINE propagateSubscriberHold #-}
1254−propagateSubscriberHold :: R.Patch p => Hold x p a -> p a -> EventM x ()
1255−propagateSubscriberHold h a = do
1256− {-# SCC "trace" #-} traceMWhen debugPropagate $ liftIO $ do
1257− invalidators <- liftIO $ readIORef $ holdInvalidators h
1258− return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1259− v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1260− case {-# SCC "apply" #-} R.apply a v of
1261− Nothing -> return ()
1262− Just v' -> do
1263− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1264− vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1265− iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1266− defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1267−
1268−data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x a) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1269−
1270−{-# SPECIALIZE readBehaviorUntracked :: Behavior x a -> BehaviorM x a #-}
1271−{-# SPECIALIZE readBehaviorUntracked :: Behavior x a -> EventM x a #-}
1272−readBehaviorUntracked :: Defer (SomeHoldInit x) m => Behavior x a -> m a
1273−readBehaviorUntracked b = do
1274− holdInits <- getDeferralQueue
1275− liftIO $ runBehaviorM (readBehaviorTracked b) Nothing holdInits --TODO: Specialize readBehaviorTracked to the Nothing and Just cases
1276−
1277−runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1278−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1279−
1280−askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1281−askInvalidator = do
1282− (!m, _) <- BehaviorM ask
1283− case m of
1284− Nothing -> return Nothing
1285− Just (!wi, _) -> return $ Just wi
1286−
1287−askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1288−askParentsRef = do
1289− (!m, _) <- BehaviorM ask
1290− case m of
1291− Nothing -> return Nothing
1292− Just (_, !p) -> return $ Just p
1293−
1294−askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1295−askBehaviorHoldInits = do
1296− (_, !his) <- BehaviorM ask
1297− return his
1298−
1299−readBehaviorTracked :: Behavior x a -> BehaviorM x a
1300−readBehaviorTracked b = case b of
1301− BehaviorHold h -> readHoldTracked h
1302− BehaviorHoldIdentity h -> readHoldTracked h
1303− BehaviorConst a -> return a
1304− BehaviorPull p -> do
1305− val <- liftIO $ readIORef $ pullValue p
1306− case val of
1307− Just subscribed -> do
1308− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
1309− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
1310− liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
1311− return $ pullSubscribedValue subscribed
1312− Nothing -> do
1313− i <- liftIO $ newInvalidatorPull p
1314− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
1315− parentsRef <- liftIO $ newIORef []
1316− holdInits <- askBehaviorHoldInits
1317− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
1318− invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
1319− parents <- liftIO $ readIORef parentsRef
1320− let subscribed = PullSubscribed
1321− { pullSubscribedValue = a
1322− , pullSubscribedInvalidators = invsRef
1323− , pullSubscribedOwnInvalidator = i
1324− , pullSubscribedParents = parents
1325− }
1326− liftIO $ writeIORef (pullValue p) $ Just subscribed
1327− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
1328− return a
1329− BehaviorDyn d -> readHoldTracked =<< getDynHold d
1330− BehaviorDynIdentity d -> readHoldTracked =<< getDynHold d
1331−
1332−{-# INLINE readHoldTracked #-}
1333−readHoldTracked :: Hold x p a -> BehaviorM x a
1334−readHoldTracked h = do
1335− result <- liftIO $ readIORef $ holdValue h
1336− askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
1337− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
1338− return result
1339−
1340−{-# INLINE getDynHold #-}
1341−getDynHold :: (Defer (SomeHoldInit x) m, R.Patch p) => Dyn x p a -> m (Hold x p a)
1342−getDynHold d = do
1343− mh <- liftIO $ readIORef $ unDyn d
1344− case mh of
1345− Right h -> return h
1346− Left (readV0, v') -> do
1347− holdInits <- getDeferralQueue
1348− v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1349− h <- hold v0 v'
1350− liftIO $ writeIORef (unDyn d) $ Right h
1351− return h
1352−
1353−readRootSubscribed :: RootSubscribed x a -> IO (Maybe a)
1354−readRootSubscribed = rootSubscribedOccurrence
1355−
1356−readPushSubscribed :: PushSubscribed x b a -> IO (Maybe a)
1357−readPushSubscribed subscribed = do
1358− result <- readIORef $ pushSubscribedOccurrence subscribed -- Since ResultM is always called after the final height is reached, this will always be valid
1359− touch $ pushSubscribedSelf subscribed
1360− return result
1361−
1362−readMergeSubscribed :: MergeSubscribed x k -> IO (Maybe (DMap k Identity))
1363−readMergeSubscribed subscribed = do
1364− result <- readIORef $ mergeSubscribedOccurrence subscribed
1365− touch $ mergeSubscribedParents subscribed
1366− return result
1367−
1368−readFanSubscribed :: GCompare k => k a -> FanSubscribed x k -> IO (Maybe a)
1369−readFanSubscribed k fs = do
1370− parentOcc <- readEventSubscribed $ _eventSubscription_subscribed $ fanSubscribedParent fs
1371− return $ coerce $ DMap.lookup k =<< parentOcc
1372−
1373−readSwitchSubscribed :: SwitchSubscribed x a -> IO (Maybe a)
1374−readSwitchSubscribed subscribed = do
1375− result <- readIORef $ switchSubscribedOccurrence subscribed
1376− touch $ switchSubscribedOwnInvalidator subscribed
1377− return result
1378−
1379−readCoincidenceSubscribed :: CoincidenceSubscribed x a -> IO (Maybe a)
1380−readCoincidenceSubscribed subscribed = do
1381− result <- readIORef $ coincidenceSubscribedOccurrence subscribed
1382− touch $ coincidenceSubscribedOuter subscribed
1383− --TODO: do we need to touch the inner subscriber?
1384− return result
1385−
1386−-- Always refers to 0
1387−{-# NOINLINE zeroRef #-}
1388−zeroRef :: IORef Height
1389−zeroRef = unsafePerformIO $ newIORef zeroHeight
1390−
1391−{-# INLINE debugSubscribe #-}
1392−debugSubscribe :: Bool
1393−debugSubscribe = False
1394−
1395−type CanSubscribe x m =
1396− ( HasSpiderEnv x m
1397− , HasCurrentHeight x m
1398− , Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m -- The things we need to lazily initialize state
1399− , Defer SomeClear m -- Wiping out event firings
1400− , Defer (SomeAssignment x) m -- Updating state
1401− , Defer (SomeResetCoincidence x) m
1402− , m ~ EventM x
1403− )
1404−
1405−getRootSubscribed :: GCompare k => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a), RootSubscribed x a)
1406−getRootSubscribed k r sub = do
1407− mSubscribed <- readIORef $ rootSubscribed r
1408− case DMap.lookup k mSubscribed of
1409− Just subscribed -> {-# SCC "hitRoot" #-} do
1410− sln <- subscribeRootSubscribed subscribed sub
1411− return (sln, subscribed)
1412− Nothing -> {-# SCC "missRoot" #-} do
1413− weakSelf <- newIORef $ error "getRootSubscribed: weakSelfRef not initialized"
1414− let !cached = rootSubscribed r
1415− uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1416− (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1417− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1418− uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1419− writeIORef uninitRef $! uninit
1420− let subscribed = RootSubscribed
1421− { rootSubscribedKey = k
1422− , rootSubscribedCachedSubscribed = cached
1423− , rootSubscribedOccurrence = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1424− , rootSubscribedSubscribers = subs
1425− , rootSubscribedUninit = uninit
1426− , rootSubscribedWeakSelf = weakSelf
1427−#ifdef DEBUG_NODEIDS
1428− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1429−#endif
1430− }
1431− writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "RootSubscribed"
1432− modifyIORef' (rootSubscribed r) $ DMap.insertWith (error $ "getRootSubscribed: duplicate key inserted into Root") k subscribed --TODO: I think we can just write back mSubscribed rather than re-reading it
1433− return (sln, subscribed)
1434−
1435−{-# ANN cleanupRootSubscribed "HLint: ignore Redundant bracket" #-}
1436−cleanupRootSubscribed :: RootSubscribed x a -> IO ()
1437−cleanupRootSubscribed self@(RootSubscribed { rootSubscribedKey = k, rootSubscribedCachedSubscribed = cached }) = do
1438− rootSubscribedUninit self
1439− modifyIORef' cached $ DMap.delete k
1440−
1441−{-# INLINE subscribeRootSubscribed #-}
1442−subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1443−subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1444−
1445−-- When getPushSubscribed returns, the PushSubscribed returned will have a fully filled-in
1446−{-# SPECIALIZE getPushSubscribed :: Push x a b -> Subscriber x b -> EventM x (WeakBagTicket (Subscriber x b), PushSubscribed x a b) #-}
1447−getPushSubscribed :: CanSubscribe x m => Push x a b -> Subscriber x b -> m (WeakBagTicket (Subscriber x b), PushSubscribed x a b)
1448−getPushSubscribed p sub = do
1449− mSubscribed <- liftIO $ readIORef $ pushSubscribed p
1450− case mSubscribed of
1451− Just subscribed -> {-# SCC "hitPush" #-} do
1452− sln <- liftIO $ subscribePushSubscribed subscribed sub
1453− return (sln, subscribed)
1454− Nothing -> {-# SCC "missPush" #-} do -- Not yet subscribed
1455− subscribedRef <- liftIO $ newIORef $ error "getPushSubscribed: subscribed not yet intialized"
1456− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1457− s <- liftIO $ newSubscriberPush (pushCompute p) subscribedUnsafe
1458− subscription@(EventSubscription _ subd) <- subscribe (pushParent p) s
1459− parentOcc <- liftIO $ readEventSubscribed subd
1460− occ <- runComputeM $ join <$> mapM (pushCompute p) parentOcc
1461− occRef <- liftIO $ newIORef occ
1462− when (isJust occ) $ scheduleClear occRef
1463− weakSelf <- liftIO $ newIORef $ error "getPushSubscribed: weakSelf not initialized"
1464− let !cached = pushSubscribed p
1465− (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupPushSubscribed
1466− let subscribed = PushSubscribed
1467− { pushSubscribedCachedSubscribed = cached
1468− , pushSubscribedOccurrence = occRef
1469− , pushSubscribedHeight = eventSubscribedHeightRef subd -- Since pushes have the same height as their parents, share the ref
1470− , pushSubscribedSubscribers = subs
1471− , pushSubscribedSelf = s
1472− , pushSubscribedWeakSelf = weakSelf
1473− , pushSubscribedParent = subscription
1474−#ifdef DEBUG_NODEIDS
1475− , pushSubscribedNodeId = unsafeNodeId p
1476−#endif
1477− }
1478− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "PushSubscribed"
1479− liftIO $ writeIORef subscribedRef $! subscribed
1480− liftIO $ writeIORef (pushSubscribed p) $ Just subscribed
1481− return (sln, subscribed)
1482−
1483−cleanupPushSubscribed :: PushSubscribed x a b -> IO ()
1484−cleanupPushSubscribed self = do
1485− unsubscribe $ pushSubscribedParent self
1486− writeIORef (pushSubscribedCachedSubscribed self) $ Nothing
1487−
1488−{-# INLINE subscribePushSubscribed #-}
1489−subscribePushSubscribed :: PushSubscribed x a b -> Subscriber x b -> IO (WeakBagTicket (Subscriber x b))
1490−subscribePushSubscribed subscribed sub = WeakBag.insert sub (pushSubscribedSubscribers subscribed) (pushSubscribedWeakSelf subscribed) cleanupPushSubscribed
1491−
1492−{-# SPECIALIZE getMergeSubscribed :: GCompare k => Merge x k -> Subscriber x (DMap k Identity) -> EventM x (WeakBagTicket (Subscriber x (DMap k Identity)), MergeSubscribed x k) #-}
1493−getMergeSubscribed :: forall x k m. (CanSubscribe x m, GCompare k) => Merge x k -> Subscriber x (DMap k Identity) -> m (WeakBagTicket (Subscriber x (DMap k Identity)), MergeSubscribed x k)
1494−getMergeSubscribed m sub = do
1495− mSubscribed <- liftIO $ readIORef $ mergeSubscribed m
1496− case mSubscribed of
1497− Just subscribed -> {-# SCC "hitMerge" #-} do
1498− sln <- liftIO $ subscribeMergeSubscribed subscribed sub
1499− return (sln, subscribed)
1500− Nothing -> {-# SCC "missMerge" #-} do
1501− subscribedRef <- liftIO $ newIORef $ error "getMergeSubscribed: subscribedRef not yet initialized"
1502− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1503− initialParents <- readBehaviorUntracked $ current $ mergeParents m
1504− subscribers :: [(Maybe (DSum k Identity), Height, DSum k (MergeSubscribedParent x k))] <- forM (DMap.toList initialParents) $ {-# SCC "getMergeSubscribed.a" #-} \(k :=> e) -> do
1505− s <- {-# SCC "getMergeSubscribed.a.1" #-} liftIO $ newSubscriberMerge k subscribedUnsafe
1506− subscription@(EventSubscription _ parentSubd) <- {-# SCC "getMergeSubscribed.a.2" #-} subscribe e s
1507− parentOcc <- {-# SCC "getMergeSubscribed.a.3" #-} liftIO $ readEventSubscribed parentSubd
1508− height <- {-# SCC "getMergeSubscribed.a.4" #-} liftIO $ getEventSubscribedHeight parentSubd
1509− {-# SCC "getMergeSubscribed.a.5" #-} return $ (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription s)
1510− let dm = DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1511− heights = fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1512− myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1513− myHeight = if invalidHeight `elem` heights
1514− then invalidHeight
1515− else succHeight $ heightBagMax myHeightBag
1516− currentHeight <- getCurrentHeight
1517− let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1518− then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1519− else (Nothing, dm)
1520− unless (DMap.null accum) $ do
1521− scheduleMerge myHeight subscribedUnsafe
1522− occRef <- liftIO $ newIORef occ
1523− when (isJust occ) $ scheduleClear occRef
1524− accumRef <- liftIO $ newIORef accum
1525− heightRef <- liftIO $ newIORef myHeight
1526− heightMapRef <- liftIO $ newIORef myHeightBag
1527− weakSelf <- liftIO $ newIORef $ error "getMergeSubscribed: weakSelf not yet initialized"
1528− (subs, sln) <- liftIO $ WeakBag.singleton sub weakSelf cleanupMergeSubscribed
1529− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1530− parentsRef <- liftIO $ newIORef $ DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1531− let !subscribed = MergeSubscribed
1532− { mergeSubscribedCachedSubscribed = mergeSubscribed m
1533− , mergeSubscribedOccurrence = occRef
1534− , mergeSubscribedAccum = accumRef
1535− , mergeSubscribedHeight = heightRef
1536− , mergeSubscribedHeightBag = heightMapRef
1537− , mergeSubscribedSubscribers = subs
1538− , mergeSubscribedChange = changeSubdRef
1539− , mergeSubscribedParents = parentsRef
1540− , mergeSubscribedWeakSelf = weakSelf
1541−#ifdef DEBUG_NODEIDS
1542− , mergeSubscribedNodeId = unsafeNodeId m
1543−#endif
1544− }
1545− defer $ SomeMergeInit subscribed $ updated $ mergeParents m
1546− liftIO $ writeIORef subscribedRef $! subscribed
1547− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "MergeSubscribed"
1548− liftIO $ writeIORef (mergeSubscribed m) $ Just subscribed
1549− return (sln, subscribed)
1550−
1551−cleanupMergeSubscribed :: MergeSubscribed x k -> IO ()
1552−cleanupMergeSubscribed subscribed = do
1553− parents <- readIORef $ mergeSubscribedParents subscribed
1554− forM_ (DMap.toList parents) $ \(_ :=> msp) -> unsubscribe $ mergeSubscribedParentSubscription msp
1555− -- Not necessary, because this whole MergeSubscribed is dead: writeIORef (mergeSubscribedParents subscribed) DMap.empty
1556− writeIORef (mergeSubscribedCachedSubscribed subscribed) $ Nothing -- Get rid of the cached subscribed
1557−
1558−{-# INLINE subscribeMergeSubscribed #-}
1559−subscribeMergeSubscribed :: MergeSubscribed x k -> Subscriber x (DMap k Identity) -> IO (WeakBagTicket (Subscriber x (DMap k Identity)))
1560−subscribeMergeSubscribed subscribed sub = WeakBag.insert sub (mergeSubscribedSubscribers subscribed) (mergeSubscribedWeakSelf subscribed) cleanupMergeSubscribed
1561−
1562−{-# SPECIALIZE getFanSubscribed :: GCompare k => k a -> Fan x k -> Subscriber x a -> EventM x (WeakBagTicket (Subscriber x a), FanSubscribed x k) #-}
1563−getFanSubscribed :: (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, HasCurrentHeight x m, Defer (SomeResetCoincidence x) m, HasSpiderEnv x m, m ~ EventM x, GCompare k) => k a -> Fan x k -> Subscriber x a -> m (WeakBagTicket (Subscriber x a), FanSubscribed x k)
1564−getFanSubscribed k f sub = do
1565− mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1566− case mSubscribed of
1567− Just subscribed -> {-# SCC "hitFan" #-} do
1568− sln <- liftIO $ subscribeFanSubscribed k subscribed sub
1569− return (sln, subscribed)
1570− Nothing -> {-# SCC "missFan" #-} do
1571− subscribedRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribedRef not yet initialized"
1572− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1573− s <- liftIO $ newSubscriberFan subscribedUnsafe
1574− subscription <- subscribe (fanParent f) s
1575− weakSelf <- liftIO $ newIORef $ error "getFanSubscribed: weakSelf not yet initialized"
1576− (subsForK, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupFanSubscribed
1577− subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1578− let subscribed = FanSubscribed
1579− { fanSubscribedCachedSubscribed = fanSubscribed f
1580− , fanSubscribedParent = subscription
1581− , fanSubscribedSubscribers = subscribersRef
1582−#ifdef DEBUG_NODEIDS
1583− , fanSubscribedNodeId = unsafeNodeId f
1584−#endif
1585− }
1586− let !self = (k, subscribed)
1587− liftIO $ writeIORef subscribersRef $! DMap.singleton k $ FanSubscribedChildren subsForK self weakSelf
1588− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug self "FanSubscribed"
1589− liftIO $ writeIORef subscribedRef $! subscribed
1590− liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1591− return (slnForSub, subscribed)
1592−
1593−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1594−cleanupFanSubscribed (k, subscribed) = do
1595− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1596− let reducedSubscribers = DMap.delete k subscribers
1597− if DMap.null reducedSubscribers
1598− then do
1599− unsubscribe $ fanSubscribedParent subscribed
1600− -- Not necessary in this case, because this whole FanSubscribed is dead: writeIORef (fanSubscribedSubscribers subscribed) reducedSubscribers
1601− writeIORef (fanSubscribedCachedSubscribed subscribed) Nothing
1602− else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1603−
1604−{-# INLINE subscribeFanSubscribed #-}
1605−subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1606−subscribeFanSubscribed k subscribed sub = do
1607− subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1608− case DMap.lookup k subscribers of
1609− Nothing -> {-# SCC "missSubscribeFanSubscribed" #-} do
1610− let !self = (k, subscribed)
1611− weakSelf <- newIORef =<< mkWeakPtrWithDebug self "FanSubscribed"
1612− (list, sln) <- WeakBag.singleton sub weakSelf cleanupFanSubscribed
1613− writeIORef (fanSubscribedSubscribers subscribed) $! DMap.insertWith (error "subscribeEventSubscribed: key that we just failed to find is present - should be impossible") k (FanSubscribedChildren list self weakSelf) subscribers
1614− return sln
1615− Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1616−
1617−{-# SPECIALIZE getSwitchSubscribed :: Switch x a -> Subscriber x a -> EventM x (WeakBagTicket (Subscriber x a), SwitchSubscribed x a) #-}
1618−getSwitchSubscribed :: (Defer (SomeHoldInit x) m, Defer (SomeAssignment x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, Defer (SomeResetCoincidence x) m, HasCurrentHeight x m, HasSpiderEnv x m, m ~ EventM x) => Switch x a -> Subscriber x a -> m (WeakBagTicket (Subscriber x a), SwitchSubscribed x a)
1619−getSwitchSubscribed s sub = do
1620− mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1621− case mSubscribed of
1622− Just subscribed -> {-# SCC "hitSwitch" #-} do
1623− sln <- liftIO $ subscribeSwitchSubscribed subscribed sub
1624− return (sln, subscribed)
1625− Nothing -> {-# SCC "missSwitch" #-} do
1626− subscribedRef <- liftIO $ newIORef $ error "getSwitchSubscribed: subscribed has not yet been created"
1627− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1628− i <- liftIO $ newInvalidatorSwitch subscribedUnsafe
1629− mySub <- liftIO $ newSubscriberSwitch subscribedUnsafe
1630− wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorSwitch"
1631− wiRef <- liftIO $ newIORef wi
1632− parentsRef <- liftIO $ newIORef [] --TODO: This should be unnecessary, because it will always be filled with just the single parent behavior
1633− holdInits <- getDeferralQueue
1634− e <- liftIO $ runBehaviorM (readBehaviorTracked (switchParent s)) (Just (wi, parentsRef)) holdInits
1635− subscription@(EventSubscription _ subd) <- subscribe e mySub
1636− subscriptionRef <- liftIO $ newIORef subscription
1637− parentOcc <- liftIO $ readEventSubscribed subd
1638− occRef <- liftIO $ newIORef parentOcc
1639− when (isJust parentOcc) $ scheduleClear occRef
1640− heightRef <- liftIO $ newIORef =<< getEventSubscribedHeight subd
1641− weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1642− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1643− let !subscribed = SwitchSubscribed
1644− { switchSubscribedCachedSubscribed = switchSubscribed s
1645− , switchSubscribedOccurrence = occRef
1646− , switchSubscribedHeight = heightRef
1647− , switchSubscribedSubscribers = subs
1648− , switchSubscribedOwnInvalidator = i
1649− , switchSubscribedOwnWeakInvalidator = wiRef
1650− , switchSubscribedBehaviorParents = parentsRef
1651− , switchSubscribedParent = switchParent s
1652− , switchSubscribedCurrentParent = subscriptionRef
1653− , switchSubscribedWeakSelf = weakSelf
1654−#ifdef DEBUG_NODEIDS
1655− , switchSubscribedNodeId = unsafeNodeId s
1656−#endif
1657− }
1658− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1659− liftIO $ writeIORef subscribedRef $! subscribed
1660− liftIO $ writeIORef (switchSubscribed s) $ Just subscribed
1661− return (slnForSub, subscribed)
1662−
1663−cleanupSwitchSubscribed :: SwitchSubscribed x a -> IO ()
1664−cleanupSwitchSubscribed subscribed = do
1665− unsubscribe =<< readIORef (switchSubscribedCurrentParent subscribed)
1666− finalize =<< readIORef (switchSubscribedOwnWeakInvalidator subscribed) -- We don't need to get invalidated if we're dead
1667− writeIORef (switchSubscribedCachedSubscribed subscribed) Nothing
1668−
1669−{-# INLINE subscribeSwitchSubscribed #-}
1670−subscribeSwitchSubscribed :: SwitchSubscribed x a -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1671−subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1672−
1673−{-# SPECIALIZE getCoincidenceSubscribed :: Coincidence x a -> Subscriber x a -> EventM x (WeakBagTicket (Subscriber x a), CoincidenceSubscribed x a) #-}
1674−getCoincidenceSubscribed :: forall x a m. (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, HasCurrentHeight x m, Defer (SomeResetCoincidence x) m, HasSpiderEnv x m, m ~ EventM x) => Coincidence x a -> Subscriber x a -> m (WeakBagTicket (Subscriber x a), CoincidenceSubscribed x a)
1675−getCoincidenceSubscribed c sub = do
1676− mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1677− case mSubscribed of
1678− Just subscribed -> {-# SCC "hitCoincidence" #-} do
1679− sln <- liftIO $ subscribeCoincidenceSubscribed subscribed sub
1680− return (sln, subscribed)
1681− Nothing -> {-# SCC "missCoincidence" #-} do
1682− subscribedRef <- liftIO $ newIORef $ error "getCoincidenceSubscribed: subscribed has not yet been created"
1683− subscribedUnsafe <- liftIO $ unsafeInterleaveIO $ readIORef subscribedRef
1684− subOuter <- liftIO $ newSubscriberCoincidenceOuter subscribedUnsafe
1685− outerSubscription@(EventSubscription _ outerSubd) <- subscribe (coincidenceParent c) subOuter
1686− outerOcc <- liftIO $ readEventSubscribed outerSubd
1687− outerHeight <- liftIO $ getEventSubscribedHeight outerSubd
1688− (occ, height, mInnerSubd) <- case outerOcc of
1689− Nothing -> return (Nothing, outerHeight, Nothing)
1690− Just o -> do
1691− (occ, height, innerSubd) <- subscribeCoincidenceInner o outerHeight subscribedUnsafe
1692− return (occ, height, Just innerSubd)
1693− occRef <- liftIO $ newIORef occ
1694− when (isJust occ) $ scheduleClear occRef
1695− heightRef <- liftIO $ newIORef height
1696− innerSubdRef <- liftIO $ newIORef mInnerSubd
1697− scheduleClear innerSubdRef
1698− weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1699− (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1700− let subscribed = CoincidenceSubscribed
1701− { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1702− , coincidenceSubscribedOccurrence = occRef
1703− , coincidenceSubscribedHeight = heightRef
1704− , coincidenceSubscribedSubscribers = subs
1705− , coincidenceSubscribedOuter = subOuter
1706− , coincidenceSubscribedOuterParent = outerSubscription
1707− , coincidenceSubscribedInnerParent = innerSubdRef
1708− , coincidenceSubscribedWeakSelf = weakSelf
1709−#ifdef DEBUG_NODEIDS
1710− , coincidenceSubscribedNodeId = unsafeNodeId c
1711−#endif
1712− }
1713− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1714− liftIO $ writeIORef subscribedRef $! subscribed
1715− liftIO $ writeIORef (coincidenceSubscribed c) $ Just subscribed
1716− return (slnForSub, subscribed)
1717−
1718−cleanupCoincidenceSubscribed :: CoincidenceSubscribed x a -> IO ()
1719−cleanupCoincidenceSubscribed subscribed = do
1720− unsubscribe $ coincidenceSubscribedOuterParent subscribed
1721− writeIORef (coincidenceSubscribedCachedSubscribed subscribed) Nothing
1722−
1723−{-# INLINE subscribeCoincidenceSubscribed #-}
1724−subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO (WeakBagTicket (Subscriber x a))
1725−subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1726−
1727−{-# INLINE merge #-}
1728−merge :: GCompare k => Dynamic x R.PatchDMap (DMap k (Event x)) -> Event x (DMap k Identity)
1729−merge m = eventMerge $ Merge
1730− { mergeParents = m
1731− , mergeSubscribed = unsafeNewIORef m Nothing
1732− }
1733−
1734−newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
1735−
1736−fan :: GCompare k => Event x (DMap k Identity) -> EventSelector x k
1737−fan e =
1738− let f = Fan
1739− { fanParent = e
1740− , fanSubscribed = unsafeNewIORef e Nothing
1741− }
1742− in EventSelector $ \k -> eventFan k f
1743−
1744−runHoldInits :: IORef [SomeHoldInit x] -> IORef [SomeMergeInit x] -> EventM x ()
1745−runHoldInits holdInitRef mergeInitRef = do
1746− holdInits <- liftIO $ readIORef holdInitRef
1747− mergeInits <- liftIO $ readIORef mergeInitRef
1748− unless (null holdInits && null mergeInits) $ do
1749− liftIO $ writeIORef holdInitRef []
1750− liftIO $ writeIORef mergeInitRef []
1751− mapM_ initHold holdInits
1752− mapM_ initMerge mergeInits
1753− runHoldInits holdInitRef mergeInitRef
1754−
1755−initHold :: SomeHoldInit x -> EventM x ()
1756−initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
1757−
1758−initMerge :: SomeMergeInit x -> EventM x ()
1759−initMerge (SomeMergeInit subscribed changed) = do
1760− changeSub <- liftIO $ newSubscriberMergeChange subscribed
1761− EventSubscription _ changeSubd <- subscribe changed changeSub
1762− change <- liftIO $ readEventSubscribed changeSubd
1763− forM_ change $ \c -> defer $ SomeMergeUpdate c subscribed
1764− liftIO $ writeIORef (mergeSubscribedChange subscribed) (changeSub, changeSubd)
1765−
1766−-- | Run an event action outside of a frame
1767−runFrame :: forall x a. EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
1768−runFrame a = SpiderHost $ ask >>= \spiderEnv -> lift $ do
1769− -- Clear out pending unsubscriptions; these will need to happen eventually anyway, and might cause us a lot of extra work during the frame, so get rid of them now
1770− pendingCleanups <- atomicModifyIORef (_spiderEnv_cleanups spiderEnv) $ \x -> ([], x)
1771− {-# SCC "cleanups" #-} sequence_ pendingCleanups
1772− toAssignRef <- newIORef [] -- This should only actually get used when events are firing
1773− holdInitRef <- newIORef []
1774− mergeUpdateRef <- newIORef []
1775− mergeInitRef <- newIORef []
1776− heightRef <- newIORef zeroHeight
1777− toClearRef <- newIORef []
1778− toClearRootRef <- newIORef []
1779− coincidenceInfosRef <- newIORef []
1780− delayedRef <- liftIO $ newIORef IntMap.empty
1781− let env = EventEnv spiderEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef
1782− let go = do
1783− result <- a
1784− runHoldInits holdInitRef mergeInitRef -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
1785− return result
1786− result <- runEventM go env
1787− toClear <- readIORef toClearRef
1788− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
1789− toClearRoot <- readIORef toClearRootRef
1790− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
1791− toAssign <- readIORef toAssignRef
1792− toReconnectRef <- newIORef []
1793− coincidenceInfos <- readIORef coincidenceInfosRef
1794− forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
1795− writeIORef vRef v
1796− when debugInvalidate $ putStrLn $ "Invalidating Hold"
1797− writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
1798− mergeUpdates <- readIORef mergeUpdateRef
1799− writeIORef mergeUpdateRef []
1800− let updateMerge :: SomeMergeUpdate x -> IO [SomeEventSubscription x]
1801− updateMerge (SomeMergeUpdate (R.PatchDMap p :: R.PatchDMap (DMap k (Event x))) m) = do
1802− oldParents <- readIORef $ mergeSubscribedParents m
1803− let f (subscriptionsToKill, ps) (k :=> Compose me) = do
1804− (mOldSubd, newPs) <- case me of
1805− Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1806− Just e -> do
1807− s <- liftIO $ newSubscriberMerge k m
1808− subscription@(EventSubscription _ subd) <- subscribe e s
1809− let newParent = MergeSubscribedParent subscription s
1810− newParentHeight <- liftIO $ getEventSubscribedHeight subd
1811− liftIO $ addMergeHeight newParentHeight m
1812− return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1813− forM_ mOldSubd $ \oldSubd -> do
1814− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ mergeSubscribedParentSubscription oldSubd
1815− liftIO $ removeMergeHeight oldHeight m
1816− return (maybeToList (SomeEventSubscription . mergeSubscribedParentSubscription <$> mOldSubd) ++ subscriptionsToKill, newPs)
1817− (subscriptionsToKill, newParents) <- flip runEventM env $ foldM f ([], oldParents) $ DMap.toList p --TODO: I think this runEventM is OK, since no events are firing at this time, but it might not be
1818− writeIORef (mergeSubscribedParents m) $! newParents
1819− return subscriptionsToKill
1820− when debugPropagate $ putStrLn "Updating merges"
1821− mergeSubscriptionsToKill <- concat <$> mapM updateMerge mergeUpdates
1822− when debugPropagate $ putStrLn "Updating merges done"
1823− toReconnect <- readIORef toReconnectRef
1824− switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1825− oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
1826− wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
1827− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
1828− finalize wi
1829− i <- evaluate $ switchSubscribedOwnInvalidator subscribed
1830− wi' <- mkWeakPtrWithDebug i "wi'"
1831− writeIORef (switchSubscribedOwnWeakInvalidator subscribed) $! wi'
1832− writeIORef (switchSubscribedBehaviorParents subscribed) []
1833− writeIORef holdInitRef [] --TODO: Should we reuse this?
1834− e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) holdInitRef
1835− runEventM (runHoldInits holdInitRef mergeInitRef) env --TODO: Is this actually OK? It seems like it should be, since we know that no events are firing at this point, but it still seems inelegant
1836− --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1837− sub <- newSubscriberSwitch subscribed
1838− subscription <- runReaderT (unSpiderHost (runFrame ({-# SCC "subscribeSwitch" #-} subscribe e sub))) spiderEnv --TODO: Assert that the event isn't firing --TODO: This should not loop because none of the events should be firing, but still, it is inefficient
1839− {-
1840− stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1841− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
1842− EventRoot _ -> "EventRoot"
1843− EventNever -> "EventNever"
1844− _ -> "something else"
1845− -}
1846− writeIORef (switchSubscribedCurrentParent subscribed) $! subscription
1847− return $ SomeEventSubscription oldSubscription
1848− forM_ mergeSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1849− forM_ switchSubscriptionsToKill $ \(SomeEventSubscription oldSubscription) -> liftIO $ unsubscribe oldSubscription
1850− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1851− EventSubscription _ subd' <- readIORef $ switchSubscribedCurrentParent subscribed
1852− parentHeight <- getEventSubscribedHeight subd'
1853− myHeight <- readIORef $ switchSubscribedHeight subscribed
1854− when (parentHeight /= myHeight) $ do
1855− writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1856− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
1857− forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> do
1858− invalidateMergeHeight m --TODO: In addition to when the patch is completely empty, we should also not run this if it has some Nothing values, but none of them have actually had any effect; potentially, we could even check for Just values with no effect (e.g. by comparing their IORefs and ignoring them if they are unchanged); actually, we could just check if the new height is different
1859− forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
1860− unsubscribe subscription
1861− mapM_ invalidateCoincidenceHeight mcs
1862− forM_ coincidenceInfos $ \(SomeResetCoincidence _ mcs) -> mapM_ recalculateCoincidenceHeight mcs
1863− forM_ mergeUpdates $ \(SomeMergeUpdate _ m) -> revalidateMergeHeight m
1864− forM_ toReconnect $ \(SomeSwitchSubscribed subscribed) -> do
1865− height <- calculateSwitchHeight subscribed
1866− updateSwitchHeight height subscribed
1867− return result
1868−
1869−newtype Height = Height { unHeight :: Int } deriving (Show, Read, Eq, Ord, Bounded)
1870−
1871−{-# INLINE zeroHeight #-}
1872−zeroHeight :: Height
1873−zeroHeight = Height 0
1874−
1875−{-# INLINE invalidHeight #-}
1876−invalidHeight :: Height
1877−invalidHeight = Height (-1000)
1878−
1879−-- | An invalid height that is currently being traversed, e.g. by walkInvalidHeightParents
1880−{-# INLINE invalidHeightBeingTraversed #-}
1881−invalidHeightBeingTraversed :: Height
1882−invalidHeightBeingTraversed = Height (-1001)
1883−
1884−{-# INLINE succHeight #-}
1885−succHeight :: Height -> Height
1886−succHeight h@(Height a) =
1887− if h == invalidHeight
1888− then invalidHeight
1889− else Height $ succ a
1890−
1891−removeMergeHeight :: Height -> MergeSubscribed x k -> IO ()
1892−removeMergeHeight oldParentHeight subscribed = do
1893− when debugInvalidateHeight $ putStrLn $ "removeMergeHeight: " <> show oldParentHeight <> " Merge" <> showNodeId subscribed
1894− oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1895− let newHeights = heightBagRemove oldParentHeight oldHeights
1896− writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1897−
1898−invalidateMergeHeight :: MergeSubscribed x k -> IO ()
1899−invalidateMergeHeight subscribed = do
1900− oldHeight <- readIORef $ mergeSubscribedHeight subscribed
1901− -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
1902− when (oldHeight /= invalidHeight) $ do
1903− writeIORef (mergeSubscribedHeight subscribed) $! invalidHeight
1904− WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1905−
1906−addMergeHeight :: Height -> MergeSubscribed x k -> IO ()
1907−addMergeHeight newParentHeight subscribed = do
1908− when debugInvalidateHeight $ putStrLn $ "addMergeHeight: " <> show newParentHeight <> " Merge" <> showNodeId subscribed
1909− oldHeights <- readIORef $ mergeSubscribedHeightBag subscribed
1910− let newHeights = heightBagAdd newParentHeight oldHeights
1911− writeIORef (mergeSubscribedHeightBag subscribed) $! newHeights
1912−
1913−revalidateMergeHeight :: MergeSubscribed x k -> IO ()
1914−revalidateMergeHeight subscribed = do
1915− currentHeight <- readIORef $ mergeSubscribedHeight subscribed
1916− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
1917− heights <- readIORef $ mergeSubscribedHeightBag subscribed
1918− parents <- readIORef $ mergeSubscribedParents subscribed
1919− -- When the number of heights in the bag reaches the number of parents, we should have a valid height
1920− case heightBagSize heights `compare` DMap.size parents of
1921− LT -> return ()
1922− EQ -> do
1923− let height = succHeight $ heightBagMax heights
1924− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1925− writeIORef (mergeSubscribedHeight subscribed) $! height
1926− WeakBag.traverse (mergeSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1927− GT -> error $ "revalidateMergeHeight: more heights than parents for Merge" <> showNodeId subscribed
1928−
1929−invalidateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
1930−invalidateCoincidenceHeight subscribed = do
1931− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1932− when (oldHeight /= invalidHeight) $ do
1933− writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
1934− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1935−
1936−updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
1937−updateSwitchHeight new subscribed = do
1938− oldHeight <- readIORef $ switchSubscribedHeight subscribed
1939− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1940− when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1941− writeIORef (switchSubscribedHeight subscribed) $! new
1942− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1943−
1944−recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
1945−recalculateCoincidenceHeight subscribed = do
1946− oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1947− when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1948− height <- calculateCoincidenceHeight subscribed
1949− when (height /= invalidHeight) $ do
1950− writeIORef (coincidenceSubscribedHeight subscribed) $! height
1951− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1952−
1953−calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
1954−calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
1955−
1956−calculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO Height
1957−calculateCoincidenceHeight subscribed = do
1958− outerHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
1959− innerHeight <- maybe (return zeroHeight) getEventSubscribedHeight =<< readIORef (coincidenceSubscribedInnerParent subscribed)
1960− return $ if outerHeight == invalidHeight || innerHeight == invalidHeight then invalidHeight else max outerHeight innerHeight
1961−
1962−data SomeSwitchSubscribed x = forall a. SomeSwitchSubscribed {-# NOUNPACK #-} (SwitchSubscribed x a)
1963−
1964−invalidate :: IORef [SomeSwitchSubscribed x] -> WeakList (Invalidator x) -> IO (WeakList (Invalidator x))
1965−invalidate toReconnectRef wis = do
1966− forM_ wis $ \wi -> do
1967− mi <- deRefWeak wi
1968− case mi of
1969− Nothing -> do
1970− traceInvalidate "invalidate Dead"
1971− return () --TODO: Should we clean this up here?
1972− Just i -> do
1973− finalize wi -- Once something's invalidated, it doesn't need to hang around; this will change when some things are strict
1974− case i of
1975− InvalidatorPull p -> do
1976− traceInvalidate $ "invalidate: Pull" <> showNodeId p
1977− mVal <- readIORef $ pullValue p
1978− forM_ mVal $ \val -> do
1979− writeIORef (pullValue p) Nothing
1980− writeIORef (pullSubscribedInvalidators val) =<< evaluate =<< invalidate toReconnectRef =<< readIORef (pullSubscribedInvalidators val)
1981− InvalidatorSwitch subscribed -> do
1982− traceInvalidate $ "invalidate: Switch" <> showNodeId subscribed
1983− modifyIORef' toReconnectRef (SomeSwitchSubscribed subscribed :)
1984− return [] -- Since we always finalize everything, always return an empty list --TODO: There are some things that will need to be re-subscribed every time; we should try to avoid finalizing them
1985−
1986−--------------------------------------------------------------------------------
1987−-- Reflex integration
1988−--------------------------------------------------------------------------------
1989−
1990−-- | The default, global Spider environment
1991−type Spider = SpiderEnv Global
1992−
1993−-- | Designates the default, global Spider timeline
1994−data Global
1995−
1996−{-# NOINLINE globalSpiderEnv #-}
1997−globalSpiderEnv :: SpiderEnv Global
1998−globalSpiderEnv = unsafePerformIO unsafeNewSpiderEnv
1999−
2000−-- | Stores all global data relevant to a particular Spider timeline; only one
2001−-- value should exist for each type @x@
2002−data SpiderEnv x = SpiderEnv
2003− { _spiderEnv_toUnsubscribe :: !(IORef [SomeEventSubscription x])
2004− , _spiderEnv_lock :: !(MVar ())
2005− , _spiderEnv_cleanups :: !(IORef [IO ()])
2006−#ifdef DEBUG
2007− , _spiderEnv_depth :: !(IORef Int)
2008−#endif
2009− }
2010−type role SpiderEnv nominal
2011−
2012−instance GEq SpiderEnv where
2013− a `geq` b = if _spiderEnv_lock a == _spiderEnv_lock b
2014− then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderEnv can't have two different 'x' arguments
2015− else Nothing
2016−
2017−unsafeNewSpiderEnv :: forall x. IO (SpiderEnv x)
2018−unsafeNewSpiderEnv = do
2019− toUnsubscribe <- newIORef []
2020− lock <- newMVar ()
2021− cleanups <- newIORef []
2022−#ifdef DEBUG
2023− depthRef <- newIORef 0
2024−#endif
2025− return $ SpiderEnv
2026− { _spiderEnv_toUnsubscribe = toUnsubscribe
2027− , _spiderEnv_lock = lock
2028− , _spiderEnv_cleanups = cleanups
2029−#ifdef DEBUG
2030− , _spiderEnv_depth = depthRef
2031−#endif
2032− }
2033−
2034−-- | Create a new SpiderEnv
2035−newSpiderEnv :: IO (Some SpiderEnv)
2036−newSpiderEnv = Some.This <$> unsafeNewSpiderEnv
2037−
2038−newtype SpiderPullM x a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2039−
2040−newtype SpiderPushM x a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2041−
2042−instance R.Reflex (SpiderEnv x) where
2043− newtype Behavior (SpiderEnv x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2044− newtype Event (SpiderEnv x) a = SpiderEvent { unSpiderEvent :: Event x a }
2045− newtype Dynamic (SpiderEnv x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x Identity a } deriving (Functor, Applicative, Monad)
2046− newtype Incremental (SpiderEnv x) p a = SpiderIncremental { unSpiderIncremental :: Dynamic x p a }
2047− type PullM (SpiderEnv x) = SpiderPullM x
2048− type PushM (SpiderEnv x) = SpiderPushM x
2049− {-# INLINABLE never #-}
2050− never = SpiderEvent eventNever
2051− {-# INLINABLE constant #-}
2052− constant = SpiderBehavior . BehaviorConst
2053− {-# INLINABLE push #-}
2054− push f = SpiderEvent . push (coerce f) . unSpiderEvent
2055− {-# INLINABLE pull #-}
2056− pull = SpiderBehavior . pull . coerce
2057− {-# INLINABLE merge #-}
2058− merge = SpiderEvent . merge . DynamicConst . (unsafeCoerce :: DMap k (R.Event (SpiderEnv x)) -> DMap k (Event x))
2059− {-# INLINABLE fan #-}
2060− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2061− {-# INLINABLE switch #-}
2062− switch = SpiderEvent . switch . (unsafeCoerce :: Behavior x (R.Event (SpiderEnv x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2063− {-# INLINABLE coincidence #-}
2064− coincidence = SpiderEvent . coincidence . (unsafeCoerce :: Event x (R.Event (SpiderEnv x) a) -> Event x (Event x a)) . unSpiderEvent
2065− {-# INLINABLE current #-}
2066− current = SpiderBehavior . current . unSpiderDynamic
2067− {-# INLINABLE updated #-}
2068− updated = SpiderEvent . fmap runIdentity . updated . unSpiderDynamic
2069− {-# INLINABLE unsafeBuildDynamic #-}
2070− unsafeBuildDynamic readV0 v' = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (coerce readV0) $ addIdentity $ unSpiderEvent v'
2071− {-# INLINABLE unsafeBuildIncremental #-}
2072− unsafeBuildIncremental readV0 dv = SpiderIncremental $ DynamicDyn $ unsafeDyn (coerce readV0) $ unSpiderEvent dv
2073− {-# INLINABLE mergeIncremental #-}
2074− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x R.PatchDMap (DMap k (R.Event (SpiderEnv x))) -> Dynamic x R.PatchDMap (DMap k (Event x))) . unSpiderIncremental
2075− {-# INLINABLE currentIncremental #-}
2076− currentIncremental = SpiderBehavior . current . unSpiderIncremental
2077− {-# INLINABLE updatedIncremental #-}
2078− updatedIncremental = SpiderEvent . updated . unSpiderIncremental
2079− {-# INLINABLE incrementalToDynamic #-}
2080− incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ DynamicDynIdentity $ unsafeDyn (readBehaviorUntracked $ current i) $ flip push (updated i) $ \p -> do
2081− c <- readBehaviorUntracked $ current i
2082− return $ Identity <$> R.apply p c --TODO: Avoid the redundant 'apply'
2083−
2084−instance R.MonadSample (SpiderEnv x) (EventM x) where
2085− {-# INLINABLE sample #-}
2086− sample (SpiderBehavior b) = readBehaviorUntracked b
2087−
2088−instance R.MonadHold (SpiderEnv x) (EventM x) where
2089− {-# INLINABLE hold #-}
2090− hold = holdSpiderEventM
2091− {-# INLINABLE holdDyn #-}
2092− holdDyn = holdDynSpiderEventM
2093− {-# INLINABLE holdIncremental #-}
2094− holdIncremental = holdIncrementalSpiderEventM
2095−
2096−holdSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Behavior (SpiderEnv x) a)
2097−holdSpiderEventM v0 e = fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2098−
2099−holdDynSpiderEventM :: a -> R.Event (SpiderEnv x) a -> EventM x (R.Dynamic (SpiderEnv x) a)
2100−holdDynSpiderEventM v0 e = fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2101−
2102−holdIncrementalSpiderEventM :: R.Patch p => a -> R.Event (SpiderEnv x) (p a) -> EventM x (R.Incremental (SpiderEnv x) p a)
2103−holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2104−
2105−instance R.MonadHold (SpiderEnv x) (SpiderHost x) where
2106− {-# INLINABLE hold #-}
2107− hold v0 e = R.runHostFrame $ R.hold v0 e
2108− {-# INLINABLE holdDyn #-}
2109− holdDyn v0 e = R.runHostFrame $ R.holdDyn v0 e
2110− {-# INLINABLE holdIncremental #-}
2111− holdIncremental v0 e = R.runHostFrame $ R.holdIncremental v0 e
2112−
2113−instance R.MonadSample (SpiderEnv x) (SpiderHost x) where
2114− {-# INLINABLE sample #-}
2115− sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2116−
2117−instance R.MonadSample (SpiderEnv x) (SpiderPullM x) where
2118− {-# INLINABLE sample #-}
2119− sample = coerce . readBehaviorTracked . unSpiderBehavior
2120−
2121−instance R.MonadSample (SpiderEnv x) (SpiderPushM x) where
2122− {-# INLINABLE sample #-}
2123− sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2124−
2125−instance R.MonadHold (SpiderEnv x) (SpiderPushM x) where
2126− {-# INLINABLE hold #-}
2127− hold v0 e = R.current <$> R.holdDyn v0 e
2128− {-# INLINABLE holdDyn #-}
2129− holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity e
2130− {-# INLINABLE holdIncremental #-}
2131− holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . DynamicHold <$> hold v0 e
2132−
2133−data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2134−newtype SpiderEventHandle x a = SpiderEventHandle { unSpiderEventHandle :: EventSubscription x a }
2135−
2136−instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHostFrame x) where
2137− {-# INLINABLE subscribeEvent #-}
2138− subscribeEvent e = SpiderHostFrame $ do
2139− subscription <- subscribe (unSpiderEvent e) SubscriberHandle --TODO: Unsubscribe eventually (manually and/or with weak ref)
2140− return $ SpiderEventHandle subscription
2141−
2142−instance R.ReflexHost (SpiderEnv x) where
2143− type EventTrigger (SpiderEnv x) = RootTrigger x
2144− type EventHandle (SpiderEnv x) = SpiderEventHandle x
2145− type HostFrame (SpiderEnv x) = SpiderHostFrame x
2146−
2147−instance R.MonadReadEvent (SpiderEnv x) (ReadPhase x) where
2148− {-# INLINABLE readEvent #-}
2149− readEvent h = ReadPhase $ fmap (fmap return) $ liftIO $ do
2150− let EventSubscription sln subscribed = unSpiderEventHandle h
2151− result <- readEventSubscribed subscribed
2152− touch sln
2153− return result
2154−
2155−instance MonadRef (EventM x) where
2156− type Ref (EventM x) = Ref IO
2157− {-# INLINABLE newRef #-}
2158− {-# INLINABLE readRef #-}
2159− {-# INLINABLE writeRef #-}
2160− newRef = liftIO . newRef
2161− readRef = liftIO . readRef
2162− writeRef r a = liftIO $ writeRef r a
2163−
2164−instance MonadAtomicRef (EventM x) where
2165− {-# INLINABLE atomicModifyRef #-}
2166− atomicModifyRef r f = liftIO $ atomicModifyRef r f
2167−
2168−-- | The monad for actions that manipulate a Spider timeline identified by @x@
2169−newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderEnv x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2170−
2171−instance Monad (SpiderHost x) where
2172− {-# INLINABLE (>>=) #-}
2173− SpiderHost x >>= f = SpiderHost $ x >>= unSpiderHost . f
2174− {-# INLINABLE (>>) #-}
2175− SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2176− {-# INLINABLE return #-}
2177− return x = SpiderHost $ return x
2178− {-# INLINABLE fail #-}
2179− fail s = SpiderHost $ fail s
2180−
2181−-- | Run an action affecting the global Spider timeline; this will be guarded by
2182−-- a mutex for that timeline
2183−runSpiderHost :: SpiderHost Global a -> IO a
2184−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderEnv
2185−
2186−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2187−
2188−instance Monad (SpiderHostFrame x) where
2189− {-# INLINABLE (>>=) #-}
2190− SpiderHostFrame x >>= f = SpiderHostFrame $ x >>= runSpiderHostFrame . f
2191− {-# INLINABLE (>>) #-}
2192− SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2193− {-# INLINABLE return #-}
2194− return x = SpiderHostFrame $ return x
2195− {-# INLINABLE fail #-}
2196− fail s = SpiderHostFrame $ fail s
2197−
2198−instance R.MonadSample (SpiderEnv x) (SpiderHostFrame x) where
2199− sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2200−
2201−addIdentity :: Event x a -> Event x (Identity a)
2202−--addIdentity = fmap Identity
2203−addIdentity = unsafeCoerce
2204−
2205−instance R.MonadHold (SpiderEnv x) (SpiderHostFrame x) where
2206− {-# INLINABLE hold #-}
2207− hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . BehaviorHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2208− {-# INLINABLE holdDyn #-}
2209− holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . DynamicHoldIdentity) $ hold v0 $ addIdentity $ unSpiderEvent e
2210− {-# INLINABLE holdIncremental #-}
2211− holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . DynamicHold) $ hold v0 $ unSpiderEvent e
2212−
2213−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2214−newEventWithTriggerIO f = do
2215− es <- newFanEventWithTriggerIO $ \Refl -> f
2216− return $ select es Refl
2217−
2218−newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2219−newFanEventWithTriggerIO f = do
2220− occRef <- newIORef DMap.empty
2221− subscribedRef <- newIORef DMap.empty
2222− let !r = Root
2223− { rootOccurrence = occRef
2224− , rootSubscribed = subscribedRef
2225− , rootInit = f
2226− }
2227− return $ EventSelector $ \k -> eventRoot k r
2228−
2229−instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHost x) where
2230− newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
2231− newFanEventWithTrigger f = SpiderHost $ lift $ do
2232− es <- newFanEventWithTriggerIO f
2233− return $ R.EventSelector $ SpiderEvent . select es
2234−
2235−instance R.MonadReflexCreateTrigger (SpiderEnv x) (SpiderHostFrame x) where
2236− newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2237− newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2238− es <- newFanEventWithTriggerIO f
2239− return $ R.EventSelector $ SpiderEvent . select es
2240−
2241−instance R.MonadSubscribeEvent (SpiderEnv x) (SpiderHost x) where
2242− {-# INLINABLE subscribeEvent #-}
2243− subscribeEvent = subscribeEventSpiderHost
2244−
2245−subscribeEventSpiderHost :: R.Event (SpiderEnv x) a -> SpiderHost x (R.EventHandle (SpiderEnv x) a)
2246−subscribeEventSpiderHost e = do
2247− subscription <- runFrame $ subscribe (unSpiderEvent e) SubscriberHandle --TODO: Unsubscribe eventually (manually and/or with weak ref)
2248− return $ SpiderEventHandle subscription
2249−
2250−newtype ReadPhase x a = ReadPhase (ResultM x a) deriving (Functor, Applicative, Monad, MonadFix)
2251−
2252−instance R.MonadSample (SpiderEnv x) (ReadPhase x) where
2253− {-# INLINABLE sample #-}
2254− sample = ReadPhase . R.sample
2255−
2256−instance R.MonadHold (SpiderEnv x) (ReadPhase x) where
2257− {-# INLINABLE hold #-}
2258− hold v0 e = ReadPhase $ R.hold v0 e
2259− {-# INLINABLE holdDyn #-}
2260− holdDyn v0 e = ReadPhase $ R.holdDyn v0 e
2261− {-# INLINABLE holdIncremental #-}
2262− holdIncremental v0 e = ReadPhase $ R.holdIncremental v0 e
2263−
2264−instance R.MonadReflexHost (SpiderEnv x) (SpiderHost x) where
2265− type ReadPhase (SpiderHost x) = ReadPhase x
2266− fireEventsAndRead es (ReadPhase a) = run es a
2267− runHostFrame = runFrame . runSpiderHostFrame
2268−
2269−instance MonadRef (SpiderHost x) where
2270− type Ref (SpiderHost x) = Ref IO
2271− newRef = SpiderHost . newRef
2272− readRef = SpiderHost . readRef
2273− writeRef r = SpiderHost . writeRef r
2274−
2275−instance MonadAtomicRef (SpiderHost x) where
2276− atomicModifyRef r = SpiderHost . atomicModifyRef r
2277−
2278−instance MonadRef (SpiderHostFrame x) where
2279− type Ref (SpiderHostFrame x) = Ref IO
2280− newRef = SpiderHostFrame . newRef
2281− readRef = SpiderHostFrame . readRef
2282− writeRef r = SpiderHostFrame . writeRef r
2283−
2284−instance MonadAtomicRef (SpiderHostFrame x) where
2285− atomicModifyRef r = SpiderHostFrame . atomicModifyRef r