on develop help sign in
.github/workflows/haskell.ymlnew file+41
since splitsnapshots
unifiedsplit
@@ -0,0 +1,41 @@
1+name: github-action
2+
3+on: [push, pull_request]
4+
5+jobs:
6+ build:
7+ strategy:
8+ matrix:
9+ ghc: ['8.4.4', '8.6.5', '8.8.4', '8.10.2']
10+ os: ['ubuntu-latest', 'macos-latest']
11+ runs-on: ${{ matrix.os }}
12+
13+ name: GHC ${{ matrix.ghc }} on ${{ matrix.os }}
14+ steps:
15+ - uses: actions/checkout@v2
16+ - uses: actions/setup-haskell@v1
17+ with:
18+ ghc-version: ${{ matrix.ghc }}
19+ - name: Cache
20+ uses: actions/cache@v1
21+ env:
22+ cache-name: cache-cabal
23+ with:
24+ path: ~/.cabal
25+ key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
26+ restore-keys: |
27+ ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
28+ ${{ runner.os }}-${{ matrix.ghc }}-build-
29+ ${{ runner.os }}-${{ matrix.ghc }}-
30+ ${{ runner.os }}
31+
32+ - name: Install dependencies
33+ run: |
34+ cabal update
35+ cabal build --only-dependencies --enable-tests --enable-benchmarks
36+ - name: Build
37+ run: cabal build --enable-tests --enable-benchmarks all
38+ - name: Run tests
39+ run: cabal test all
40+ - name: Build Docs
41+ run: cabal haddock
.stylish-haskell.yaml+2−3
@@ -149,6 +149,5 @@ columns: 110
149# needs to be aware of these, so it can parse the file correctly.
149# needs to be aware of these, so it can parse the file correctly.
150#
150#
151# No language extensions are enabled by default.
151# No language extensions are enabled by default.
152−# language_extensions:
152+language_extensions:
153− # - TemplateHaskell
153+ - TemplateHaskell
154− # - QuasiQuotes
.travis.ymldeleted−15
@@ -1,15 +0,0 @@
1−# Cache Buster: 0
2−language: nix
3−cache:
4− directories:
5− - /nix
6−matrix:
7− include:
8− - env: COMPILER=ghc7103
9− - env: COMPILER=ghc801
10− - env: COMPILER=ghcjs
11−script:
12− - set -e
13− - nix-build -E "with (import <nixpkgs> {}); pkgs.haskell.packages.$COMPILER.callPackage ./default.nix { }"
14− - nix-collect-garbage -d # This is important to do right before 'script' ends so the cache gets GCed
15−
CONTRIBUTING.mdnew file+66
@@ -0,0 +1,66 @@
1+# Contribution Guide
2+
3+Contributions and issue reports are encouraged and appreciated!
4+
5+- [Opening Issues](#opening-issues)
6+- [Submitting Changes](#submitting-changes)
7+ - [Guidelines for Commit Messages](#guidelines-for-commit-messages)
8+ - [Guidelines for Pull Requests](#guidelines-for-pull-requests)
9+ - [Code Quality](#code-quality)
10+ - [Documentation](#documentation)
11+
12+## Opening Issues
13+
14+Before opening an issue, please check whether your issue has already been reported. Assuming it has not:
15+
16+* Describe the issue you're encountering or the suggestion you're making
17+* Include any relevant steps to reproduce or code samples you can. It's always easier for us to debug if we have something that demonstrates the error.
18+* Let us know what version of reflex you were using. If you're using a github checkout, provide the git hash.
19+* Describe how you're building reflex (i.e., via reflex-platform, cabal install, stack, obelisk, etc.). If you're using reflex-platform or obelisk, provide the git hash of your checkout.
20+
21+## Submitting Changes
22+
23+### Guidelines for Commit Messages
24+
25+#### Summary Line
26+The summary line of your commit message should summarize the changes being made. Commit messages should be written in the imperative mood and should describe what happens when the commit is applied.
27+
28+One way to think about it is that your commit message should be able to complete the sentence:
29+"When applied, this commit will..."
30+
31+#### Body
32+For breaking changes, new features, refactors, or other major changes, the body of the commit message should describe the motivation behind the change in greater detail and may include references to the issue tracker. The body shouldn't repeat code/comments from the diff.
33+
34+### Guidelines for Pull Requests
35+
36+Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.
37+
38+### Code Quality
39+
40+#### Warnings
41+
42+Your pull request should add no new warnings to the project. It should also generally not disable any warnings.
43+
44+#### Build and Test
45+
46+Make sure the project builds and that the tests pass! This will generally also be checked by CI before merge, but trying it yourself first means you'll catch problems earlier and your contribution can be merged that much sooner!
47+
48+#### Dependencies
49+
50+Include version bounds whenever adding a dependency to the library stanza of the cabal file. Note that libraries added to reflex.cabal also need to be added to default.nix.
51+
52+### Documentation
53+
54+#### In the code
55+We're always striving to improve documentation. Please include [haddock](https://haskell-haddock.readthedocs.io/en/latest/index.html) documentation for any added code, and update the documentation for any code you modify.
56+
57+#### In the [Changelog](ChangeLog.md)
58+Add an entry to the changelog when your PR:
59+* Adds a feature
60+* Deprecates something
61+* Includes a breaking change
62+* Makes any other change that will impact users
63+
64+#### In the [Readme](README.md)
65+The readme is the first place a lot of people look for information about the repository. Update any parts of the readme that are affected by your PR.
66+
ChangeLog.mdnew file+151
@@ -0,0 +1,151 @@
1+# Revision history for reflex
2+
3+## 0.8.2.0
4+
5+* Add `matchResponseMapWithRequests`, which it similar to `matchResponsesWithRequests` but allows processing of multiple responses at once.
6+
7+## 0.8.1.1
8+
9+* Allow newer hlint for older GHCs, and add upper bound for newer GHCs
10+
11+## 0.8.1.0
12+
13+* Add support for GHC 8.10
14+* Drop support for GHC < 8.4
15+
16+## 0.8.0.0
17+
18+* Replace 0.7.2.0 with 0.8.0.0 to reflect the `MonadHold` interface change. Deprecates 0.7.2.0.
19+
20+## 0.7.2.0 -- *Deprecated*
21+
22+* ([#416](https://github.com/reflex-frp/reflex/pull/416)) Add `now :: m (Event t ())` to `MonadHold`.
23+* Extend some dependency version bounds
24+* Fix HLint 3 test
25+
26+## 0.7.1.1
27+
28+*Backport release*.
29+Changes do not carry forward to 0.7.2.0.
30+
31+* Add support for GHC 8.10
32+* Drop support for GHC < 8.4
33+* Extend some dependency version bounds
34+* Fix HLint 3 test
35+
36+## 0.7.1.0
37+
38+* ([#413](https://github.com/reflex-frp/reflex/pull/413), [#417](https://github.com/reflex-frp/reflex/pull/417)) Add `Reflex.Host.Headless` module which provides `runHeadlessApp` as an easy way to run a Reflex network in a "headless" environment.
39+* ([#420](https://github.com/reflex-frp/reflex/pull/420)) Add a [`Data.Zip.Unzip`](https://hackage.haskell.org/package/semialign-1.1/docs/Data-Zip.html#t:Unzip) instance for `Event`.
40+* ([#419](https://github.com/reflex-frp/reflex/pull/419)) Add `distributeIntMapOverDynPure` and `joinDynThroughIntMap` as convenience functions for working with `Dynamic` `IntMap`s.
41+
42+
43+## 0.7.0.0
44+
45+* Add lifting instances for most classes to `Reflex.Profiled.Profiled`. ([#398](https://github.com/reflex-frp/reflex/pull/398))
46+* Class `MonadQuery t q m` now has a `Monad m` superclass constraint. ([#400](https://github.com/reflex-frp/reflex/pull/400))
47+* **(Breaking change)** Rename class `MonadBehaviorWriter` -> `BehaviorWriter` for consistency with `EventWriter`/`DynamicWriter`. ([#401](https://github.com/reflex-frp/reflex/pull/401))
48+* Introduce deprecated alias `MonadBehaviorWriter = BehaviorWriter`. ([#401](https://github.com/reflex-frp/reflex/pull/401))
49+* Fix bug in spider where event subscriptions would be prematurely finalized due to over-aggressive inlining. ([#409](https://github.com/reflex-frp/reflex/pull/409))
50+* Add instances of `PerformEvent` and `TriggerEvent` for `MaybeT`. ([#395](https://github.com/reflex-frp/reflex/pull/395))
51+
52+## 0.6.4.1
53+
54+* Fix a bug in the Reflex Profiled transformer where
55+ `Reflex.Class.mergeIncrementalG` and
56+ `Reflex.Class.mergeIncrementalWithMoveG` implementations referenced
57+ itself instead of the inner transformed timeline, causing an
58+ infinite loop.
59+
60+## 0.6.4
61+
62+* Support GHC 8.8
63+
64+* Add `Reflex.Query.Base.mapQueryT`. See that module for documentation
65+
66+* The `Reflex.Patch.*` modules were moved to the `patch` library.
67+ They are `Data.Patch.*` there, but reexported under their old names for backwards compatability here.
68+
69+* Additional instances for `Query` classes for basic types.
70+
71+* Add cabal flags `debug-propagation` and `debug-event-cycles` to build in debugging
72+ code for performance and for cyclic dependencies between events
73+
74+## 0.6.3
75+
76+* `Data.WeakBag.traverse` and `Data.FastWeakBag.traverse` have been deprecated.
77+ They are replaced with `Data.WeakBag.traverse_` and `Data.FastWeakBag.traverse_`, respectively.
78+
79+* Fixes a bug in `Reflex.Patch.MapWithMove.patchThatSortsMapWith` that was producing invalid `PatchMapWithMove`.
80+
81+* Add missing `NotReady` instances:
82+ - `instance NotReady (SpiderTimeline x) (SpiderHost x)`
83+ - `instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x))`
84+
85+## 0.6.2.4
86+
87+* Update to monoidal-containers 0.6
88+
89+## 0.6.2.3
90+
91+* Add an upper-bound to witherable
92+
93+## 0.6.2.2
94+
95+* Support these >= 1. Add `split-these` flag to control whether to use new these/semialign combination or not.
96+
97+* Update version bounds to fix some CI failures
98+
99+* Add travis CI configuration
100+
101+## 0.6.2.1
102+
103+* Generalize `fan` to `fanG` to take a `DMap` with non-`Identity`
104+ functor:
105+ * `fan` to `fanG`
106+ * `EventSelectorG` for `fanG` result selector.
107+
108+* Reduce the amount of unsafeCoerce in coercing newtypes under Event/Dynamic/Behavior.
109+ * Add fused ReaderIO for the purpose of coercion (ReaderT's third argument has nominal role preventing automated coerce)
110+ * Add incrementalCoercion/coerceIncremental to go with dynamicCoercion/coerceDynamic
111+
112+* Generalize merging functions:
113+ `merge` to `mergeG`,
114+ `mergeIncremental` to `mergeIncrementalG`,
115+ `mergeIncrementalWithMove` to `mergeIncrementalWithMoveG`.
116+
117+* Generalize distribute function:
118+ `distributeDMapOverDynPure` to `distributeDMapOverDynPureG`,
119+
120+## 0.6.2.0
121+
122+* Fix `holdDyn` so that it is lazy in its event argument
123+ These produce `DMap`s whose values needn't be `Identity`.
124+
125+* Stop using the now-deprecated `*Tag` classes (e.g., `ShowTag`).
126+
127+* Fix `holdDyn` so that it is lazy in its event argument.
128+
129+## 0.6.1.0
130+
131+* Re-export all of `Data.Map.Monoidal`
132+
133+* Fix `QueryT` and `RequesterT` tests
134+
135+## 0.6.0.0 -- 2019-03-20
136+
137+* Deprecate `FunctorMaybe` in favor of `Data.Witherable.Filterable`. We still export `fmapMaybe`, `ffilter`, etc., but they all rely on `Filterable` now.
138+
139+* Rename `MonadDynamicWriter` to `DynamicWriter` and add a deprecation for the old name.
140+
141+* Remove many deprecated functions.
142+
143+* Add a `Num` instance for `Dynamic`.
144+
145+* Add `matchRequestsWithResponses` to make it easier to use `Requester` with protocols that don't do this matching for you.
146+
147+* Add `withRequesterT` to map functions over the request and response of a `RequesterT`.
148+
149+* Suppress nil patches in `QueryT` as an optimization. The `Query` type must now have an `Eq` instance.
150+
151+* Add `throttleBatchWithLag` to `Reflex.Time`. See that module for details.
Quickref.md+143−11
@@ -13,7 +13,6 @@ Some of these functions are *pure*: They operate on Events, Behaviors, or Dynam
13[S] -- Function runs in any monad supporting MonadSample
13[S] -- Function runs in any monad supporting MonadSample
14[H] -- Function runs in any monad supporting MonadHold
14[H] -- Function runs in any monad supporting MonadHold
15```
15```
16−
17Since MonadHold depends on MonadSample, any [S] function also runs in [H] context.
16Since MonadHold depends on MonadSample, any [S] function also runs in [H] context.
18
17
19## Functions producing Event
18## Functions producing Event
@@ -31,6 +30,7 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
31[ ] ffilter :: (a -> Bool) -> Event a -> Event a
30[ ] ffilter :: (a -> Bool) -> Event a -> Event a
32[ ] ffor :: Event a -> (a -> b) -> Event b
31[ ] ffor :: Event a -> (a -> b) -> Event b
33[ ] fforMaybe :: Event a -> (a -> Maybe b) -> Event b
32[ ] fforMaybe :: Event a -> (a -> Maybe b) -> Event b
33+[ ] <$ :: a -> Event b -> Event a
34
34
35-- Event to identical Event with debug trace. (Only prints if Event is ultimately used.)
35-- Event to identical Event with debug trace. (Only prints if Event is ultimately used.)
36[ ] traceEvent :: Show a => String -> Event a -> Event a
36[ ] traceEvent :: Show a => String -> Event a -> Event a
@@ -46,24 +46,27 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
46[ ] attachPromptlyDynWith :: (a -> b -> c) -> Dynamic a -> Event b -> Event c
46[ ] attachPromptlyDynWith :: (a -> b -> c) -> Dynamic a -> Event b -> Event c
47[ ] attachWithMaybe :: (a -> b -> Maybe c) -> Behavior a -> Event b -> Event c
47[ ] attachWithMaybe :: (a -> b -> Maybe c) -> Behavior a -> Event b -> Event c
48[ ] attachPromptlyDynWithMaybe :: (a -> b -> Maybe c) -> Dynamic a -> Event b -> Event c
48[ ] attachPromptlyDynWithMaybe :: (a -> b -> Maybe c) -> Dynamic a -> Event b -> Event c
49+[ ] <@> :: Behavior (a -> b) -> Event a -> Event b
50+[ ] <@ :: Behavior a -> Event b -> Event a
49
51
50-- Combine multiple Events
52-- Combine multiple Events
51[ ] <> :: Semigroup a => Event a -> Event a -> Event a
53[ ] <> :: Semigroup a => Event a -> Event a -> Event a
52[ ] difference :: Event a -> Event b -> Event a
54[ ] difference :: Event a -> Event b -> Event a
53[ ] align :: Event a -> Event b -> Event (These a b)
55[ ] align :: Event a -> Event b -> Event (These a b)
54[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
56[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
57+ -- Note align functions from Data.Align in semialign package
55[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
58[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
56[ ] leftmost :: [Event a] -> Event a
59[ ] leftmost :: [Event a] -> Event a
57[ ] mergeList :: [Event a] -> Event (NonEmpty a)
60[ ] mergeList :: [Event a] -> Event (NonEmpty a)
58−[ ] merge :: GCompare k => DMap (WrapArg Event k) -> Event (DMap k)
61+[ ] merge :: GCompare k => DMap k Event -> Event (DMap k Identity)
59[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
62[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
60
63
61-- Efficient one-to-many fanout
64-- Efficient one-to-many fanout
62−[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
65+[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
63−[ ] fan :: GCompare k => Event (DMap k) -> EventSelector k
66+[ ] fan :: GCompare k => Event (DMap k Identity) -> EventSelector k
64−[ ] select :: EventSelector k -> k a -> Event a
67+[ ] select :: EventSelector k -> k a -> Event a
65−[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
68+[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
66−[ ] fanThese :: Event (These a b) -> (Event a, Event b)
69+[ ] fanThese :: Event (These a b) -> (Event a, Event b)
67
70
68-- Event to Event via function that can sample current values
71-- Event to Event via function that can sample current values
69[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
72[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
@@ -96,6 +99,10 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
96[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
99[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
97-- ... plus many more due to typeclass membership
100-- ... plus many more due to typeclass membership
98
101
102+-- Combine multiple behaviors via applicative instance
103+[ ] ffor2 :: Behavior a -> Behavior b -> (a -> b -> c) -> Behavior c
104+[ ] ffor3 :: Behavior a -> Behavior b -> Behavior c -> (a -> b -> c -> d) -> Behavior d
105+
99-- Behavior to Behavior by sampling current values
106-- Behavior to Behavior by sampling current values
100[S] sample :: Behavior a -> m a
107[S] sample :: Behavior a -> m a
101[ ] pull :: m a -> Behavior a
108[ ] pull :: m a -> Behavior a
@@ -133,12 +140,17 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
133[ ] >>= :: Dynamic a -> (a -> Dynamic b) -> Dynamic b
140[ ] >>= :: Dynamic a -> (a -> Dynamic b) -> Dynamic b
134[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
141[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
135
142
143+-- Combine multiple dynamics via applicative instance
144+[ ] ffor2 :: Dynamic a -> Dynamic b -> (a -> b -> c) -> Dynamic c
145+[ ] ffor3 :: Dynamic a -> Dynamic b -> Dynamic c -> (a -> b -> c -> d) -> Dynamic d
146+
136-- Efficient one-to-many fanout
147-- Efficient one-to-many fanout
137[ ] demux :: Ord k => Dynamic k -> Demux k
148[ ] demux :: Ord k => Dynamic k -> Demux k
138[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
149[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
139
150
140-- Dynamic to Dynamic, removing updates w/o value change
151-- Dynamic to Dynamic, removing updates w/o value change
141−[ ] uniqDyn :: Eq a => Dynamic a -> Dynamic a
152+[H] holdUniqDyn :: Eq a => Dynamic a -> m (Dynamic a)
153+[H] holdUniqDynBy :: (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
142
154
143-- Dynamic to identical Dynamic with debug trace. (Only prints if Dynamic is ultimately used.)
155-- Dynamic to identical Dynamic with debug trace. (Only prints if Dynamic is ultimately used.)
144[ ] traceDyn :: Show a => String -> Dynamic a -> Dynamic a
156[ ] traceDyn :: Show a => String -> Dynamic a -> Dynamic a
@@ -155,8 +167,8 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
155-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
167-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
156[ ] switch :: Behavior (Event a) -> Event a
168[ ] switch :: Behavior (Event a) -> Event a
157
169
158−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
170+-- Flatten Dynamic-of-Event to Event. New Event is used immediately.
159−[ ] switchPromptlyDyn :: Dynamic (Event a) -> Event a
171+[ ] switchDyn :: Dynamic (Event a) -> Event a
160
172
161-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
173-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
162[ ] coincidence :: Event (Event a) -> Event a
174[ ] coincidence :: Event (Event a) -> Event a
@@ -179,5 +191,125 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
179
191
180-- Similar to above, for Events. Created Event initially tracks the first argument.
192-- Similar to above, for Events. Created Event initially tracks the first argument.
181-- At switchover, the output Event immediately tracks the new Event.
193-- At switchover, the output Event immediately tracks the new Event.
182−[H] switchPromptly :: Event a -> Event (Event a) -> m (Event a)
194+[H] switchHold :: Event a -> Event (Event a) -> m (Event a)
195+```
196+
197+## Typeclasses to introspect and modify an FRP network.
198+
199+The functions mentioned above are used to create a static FRP network.
200+There are additional typeclasses that can be used to modify the FRP network, to have it interact with IO action, or to introspect the building of the network.
201+
202+The typeclasses and their associated annotations include:
203+
204+- `PostBuild`
205+ Fire an Event when an FRP network has been set up.
206+ ```haskell
207+ [B] -- Function runs in any monad supporting PostBuild
208+ ```
209+
210+- `Adjustable`
211+ Use Events to add or remove pieces of an FRP network.
212+ ```haskell
213+ [A] -- Function runs in any monad supporting Adjustable
214+ ```
215+
216+- `TriggerEvent`
217+ Create new externally-fired Events from within an FRP network.
218+ ```haskell
219+ [T] -- Function runs in any monad supporting TriggerEvent
220+ ```
221+
222+- `PerformEvent`
223+ Use Events to trigger IO actions and to collect their results.
224+ ```haskell
225+ [P] -- Function runs in any monad supporting PerformEvent
226+ ```
227+
228+## Startup
229+
230+```haskell
231+-- One-shot Event that is triggered once the FRP network has been built
232+[B] getPostBuild :: m (Event ())
233+```
234+
235+## Collection management functions
236+
237+```haskell
238+-- Turn a Dynamic key/value map into a set of dynamically-changing widgets.
239+[H,A,B] listWithKey :: Ord k =>
240+ Dynamic (Map k v) -> (k -> Dynamic v -> m a ) -> m (Dynamic (Map k a))
241+
242+-- Same as above where the widget constructor doesn't care about the key.
243+[H,A,B] list :: Ord k =>
244+ Dynamic (Map k v) -> ( Dynamic v -> m a ) -> m (Dynamic (Map k a))
245+
246+-- Even simpler version where there are no keys and we just use a list.
247+[H,A,B] simpleList ::
248+ Dynamic [v] -> ( Dynamic v -> m a ) -> m (Dynamic [a])
249+
250+-- Like listWithKey specialized for widgets returning (Event a).
251+[H,A,B] listViewWithKey :: Ord k =>
252+ Dynamic (Map k v) -> (k -> Dynamic v -> m (Event a)) -> m (Event (Map k a))
253+
254+-- Create a dynamically-changing set of widgets, one of which is selected at any time.
255+[H,A,B] selectViewListWithKey_ :: Ord k => Dynamic k ->
256+ Dynamic (Map k v) -> (k -> Dynamic v -> Dynamic Bool -> m (Event a)) -> m (Event k)
257+
258+-- Same as listWithKey, but takes initial values and an updates Event instead of a Dynamic.
259+[H,A] listWithKeyShallowDiff :: Ord k =>
260+ Map k v -> Event (Map k (Maybe v)) -> (k -> v -> Event v -> m a) -> m (Dynamic (Map k a))
261+```
262+
263+## Creating new events from within an FRP network.
264+
265+```haskell
266+-- Create a new Event and a function that will cause the Event to fire, from within an FRP network
267+[T] newTriggerEvent :: m (Event a, a -> IO ())
268+```
269+
270+## Connecting to the real world (I/O)
271+
272+```haskell
273+-- Run side-effecting actions in Event when it occurs; returned Event contains
274+-- results. Side effects run in the (Performable m) monad which is associated with
275+-- the (PerformEvent t m) typeclass constraint.
276+-- This allows for working with IO when a ((MonadIO (Performable m)) constraint is available.
277+[P] performEvent :: Event (Performable m a ) -> m (Event a)
278+
279+-- Just run side-effects; no return Event
280+[P] performEvent_ :: Event (Performable m ()) -> m ()
281+
282+-- Actions run asynchronously; actions are given a callback to send return values
283+[P,T] performEventAsync :: Event ((a -> IO ()) -> Performable m ()) -> m (Event a)
284+```
285+
286+### Time
287+
288+```haskell
289+-- Create Event at given interval with given basis time.
290+[P,T] tickLossy :: NominalDiffTime -> UTCTime -> m (Event t TickInfo)
291+
292+-- Delay an Event's occurrences by a given amount in seconds.
293+[P,T] delay :: NominalDiffTime -> Event t a -> m (Event t a)
294+```
295+
296+## Networks
297+
298+```haskell
299+-- Functions from Reflex.Adjustable / Reflex.Network used to deal with Dynamics/Events carrying (m a)
300+
301+[A] runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
302+
303+-- Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
304+-- The returned Event of network results occurs when the Dynamic does. Note: Often, the type a is an Event,
305+-- in which case the return value is an Event-of-Events that would typically be flattened (via switchHold).
306+[P,A] networkView :: Dynamic (m a) -> m (Event a)
307+
308+-- Given an initial network and an Event of network-creating actions, create a network that is recreated whenever the
309+-- Event fires. The returned Dynamic of network results occurs when the Event does. Note: Often, the type a is an
310+-- Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
311+[H,A] networkHold :: m a -> Event (m a) -> m (Dynamic a)
312+
313+-- Render a placeholder network to be shown while another network is not yet done building
314+[P,A] untilReady :: m a -> m b -> m (a, Event b)
183```
315```
README.md+15−11
@@ -1,19 +1,23 @@
1−## Reflex
1+# [Reflex](https://reflex-frp.org/)
2−### Practical Functional Reactive Programming
3
2
4−Reflex is an fully-deterministic, higher-order Functional Reactive Programming (FRP) interface and an engine that efficiently implements that interface.
3+[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/reflex.svg)](https://hackage.haskell.org/package/reflex) [![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/reflex/badge)](https://matrix.hackage.haskell.org/#/package/reflex) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/reflex-frp/reflex/blob/master/LICENSE)
5
4
6−[Reflex-DOM](https://github.com/reflex-frp/reflex-dom) is a framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
5+Interactive programs without callbacks or side-effects. Functional Reactive Programming (FRP) uses composable events and time-varying values to describe interactive systems as pure functions. Just like other pure functional code, functional reactive code is easier to get right on the first try, maintain, and reuse.
7
6
8−Comprehensive documentation is still a work in progress, but a tutorial for Reflex and Reflex-DOM is available at https://github.com/reflex-frp/reflex-platform and an introductory talk given at the New York Haskell Meetup is available here: [Part 1](https://www.youtube.com/watch?v=mYvkcskJbc4) / [Part 2](https://www.youtube.com/watch?v=3qfc9XFVo2c).
7+Reflex is a fully-deterministic, higher-order Functional Reactive Programming interface and an engine that efficiently implements that interface.
9
8
10−A summary of Reflex functions is available in the [quick reference](Quickref.md).
9+**Visit https://reflex-frp.org for more information, tutorials, documentation and [examples](https://examples.reflex-frp.org/).**
11
10
12−### Additional resources
11+## Resources
13−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
14
12
13+* [Official Website](https://reflex-frp.org)
14+* [Quick Reference](Quickref.md)
15+* [Reflex-DOM](https://github.com/reflex-frp/reflex-dom): A framework built on Reflex that facilitates the development of web pages, including highly-interactive single-page apps.
16+* [Obelisk](https://github.com/obsidiansystems/obelisk#obelisk): A framework built on Reflex and Reflex-DOM for functional reactive web and mobile applications, with batteries included.
17+* [Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
15−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
18+* [/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
19+* [irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
16
20
17−[hackage](https://hackage.haskell.org/package/reflex)
21+## Hacking
18
22
19−[irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
23+From the root of a [Reflex Platform](https://github.com/reflex-frp/reflex-platform) checkout, run `./scripts/hack-on haskell-overlays/reflex-packages/dep/reflex`. This will check out the reflex source code into the `haskell-overlays/reflex-packages/dep/reflex` directory. You can then point that checkout at your fork, make changes, etc. Use the `./try-reflex` or `./scripts/work-on` scripts to start a shell in which you can test your changes.
bench-cbits/checkCapability.c+11−12
@@ -42,7 +42,7 @@ typedef struct Task_ {
42 // or just continue immediately. It's a workaround for the fact
42 // or just continue immediately. It's a workaround for the fact
43 // that signalling a condition variable doesn't do anything if the
43 // that signalling a condition variable doesn't do anything if the
44 // thread is already running, but we want it to be sticky.
44 // thread is already running, but we want it to be sticky.
45− rtsBool wakeup;
45+ HsBool wakeup;
46#endif
46#endif
47
47
48 // This points to the Capability that the Task "belongs" to. If
48 // This points to the Capability that the Task "belongs" to. If
@@ -62,14 +62,14 @@ typedef struct Task_ {
62 // The current top-of-stack InCall
62 // The current top-of-stack InCall
63 struct InCall_ *incall;
63 struct InCall_ *incall;
64
64
65− nat n_spare_incalls;
65+ uint32_t n_spare_incalls;
66 struct InCall_ *spare_incalls;
66 struct InCall_ *spare_incalls;
67
67
68− rtsBool worker; // == rtsTrue if this is a worker Task
68+ HsBool worker; // == rtsTrue if this is a worker Task
69− rtsBool stopped; // this task has stopped or exited Haskell
69+ HsBool stopped; // this task has stopped or exited Haskell
70
70
71 // So that we can detect when a finalizer illegally calls back into Haskell
71 // So that we can detect when a finalizer illegally calls back into Haskell
72− rtsBool running_finalizers;
72+ HsBool running_finalizers;
73
73
74 // Links tasks on the returning_tasks queue of a Capability, and
74 // Links tasks on the returning_tasks queue of a Capability, and
75 // on spare_workers.
75 // on spare_workers.
@@ -88,7 +88,7 @@ struct Capability_ {
88 StgFunTable f;
88 StgFunTable f;
89 StgRegTable r;
89 StgRegTable r;
90
90
91− nat no; // capability number.
91+ uint32_t no; // capability number.
92
92
93 // The Task currently holding this Capability. This task has
93 // The Task currently holding this Capability. This task has
94 // exclusive access to the contents of this Capability (apart from
94 // exclusive access to the contents of this Capability (apart from
@@ -98,12 +98,12 @@ struct Capability_ {
98
98
99 // true if this Capability is running Haskell code, used for
99 // true if this Capability is running Haskell code, used for
100 // catching unsafe call-ins.
100 // catching unsafe call-ins.
101− rtsBool in_haskell;
101+ HsBool in_haskell;
102
102
103 // Has there been any activity on this Capability since the last GC?
103 // Has there been any activity on this Capability since the last GC?
104− nat idle;
104+ uint32_t idle;
105
105
106− rtsBool disabled;
106+ HsBool disabled;
107
107
108 // The run queue. The Task owning this Capability has exclusive
108 // The run queue. The Task owning this Capability has exclusive
109 // access to its run queue, so can wake up threads without
109 // access to its run queue, so can wake up threads without
@@ -159,7 +159,7 @@ struct Capability_ {
159#if defined(THREADED_RTS)
159#if defined(THREADED_RTS)
160 // Worker Tasks waiting in the wings. Singly-linked.
160 // Worker Tasks waiting in the wings. Singly-linked.
161 Task *spare_workers;
161 Task *spare_workers;
162− nat n_spare_workers; // count of above
162+ uint32_t n_spare_workers; // count of above
163
163
164 // This lock protects:
164 // This lock protects:
165 // running_task
165 // running_task
@@ -192,10 +192,9 @@ struct Capability_ {
192
192
193 // Per-capability STM-related data
193 // Per-capability STM-related data
194 StgTVarWatchQueue *free_tvar_watch_queues;
194 StgTVarWatchQueue *free_tvar_watch_queues;
195− StgInvariantCheckQueue *free_invariant_check_queues;
196 StgTRecChunk *free_trec_chunks;
195 StgTRecChunk *free_trec_chunks;
197 StgTRecHeader *free_trec_headers;
196 StgTRecHeader *free_trec_headers;
198− nat transaction_tokens;
197+ uint32_t transaction_tokens;
199} // typedef Capability is defined in RtsAPI.h
198} // typedef Capability is defined in RtsAPI.h
200 // We never want a Capability to overlap a cache line with anything
199 // We never want a Capability to overlap a cache line with anything
201 // else, so round it up to a cache line size:
200 // else, so round it up to a cache line size:
bench/Main.hs+7−6
@@ -20,6 +20,7 @@ import qualified Data.Dependent.Map as DMap
20import Data.Dependent.Sum
20import Data.Dependent.Sum
21import Data.Functor.Misc
21import Data.Functor.Misc
22import Data.IORef
22import Data.IORef
23+import Data.Maybe (fromJust)
23import Reflex
24import Reflex
24import Reflex.Host.Class
25import Reflex.Host.Class
25
26
@@ -70,7 +71,7 @@ micros =
70 , withSetupWHNF "fireEventsOnly"
71 , withSetupWHNF "fireEventsOnly"
71 (newEventWithTriggerRef >>= subscribePair)
72 (newEventWithTriggerRef >>= subscribePair)
72 (\(_, trigger) -> do
73 (\(_, trigger) -> do
73− Just key <- liftIO $ readIORef trigger
74+ key <- fromJust <$> liftIO (readIORef trigger)
74 fireEvents [key :=> Identity (42 :: Int)])
75 fireEvents [key :=> Identity (42 :: Int)])
75 , withSetupWHNF "fireEventsAndRead(head/merge1)"
76 , withSetupWHNF "fireEventsAndRead(head/merge1)"
76 (setupMerge 1 >>= subscribePair)
77 (setupMerge 1 >>= subscribePair)
@@ -84,14 +85,14 @@ micros =
84 , withSetupWHNF "fireEventsOnly(head/merge100)"
85 , withSetupWHNF "fireEventsOnly(head/merge100)"
85 (setupMerge 100 >>= subscribePair)
86 (setupMerge 100 >>= subscribePair)
86 (\(_, t:_) -> do
87 (\(_, t:_) -> do
87− Just key <- liftIO $ readIORef t
88+ key <- fromJust <$> liftIO (readIORef t)
88 fireEvents [key :=> Identity (42 :: Int)])
89 fireEvents [key :=> Identity (42 :: Int)])
89 , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev, _) -> hold (42 :: Int) ev
90 , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev, _) -> hold (42 :: Int) ev
90 , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
91 , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
91 ]
92 ]
92
93
93setupMerge :: Int
94setupMerge :: Int
94− -> SpiderHost Global ( Event (SpiderEnv Global) (DMap (Const2 Int a) Identity)
95+ -> SpiderHost Global ( Event (SpiderTimeline Global) (DMap (Const2 Int a) Identity)
95 , [IORef (Maybe (EventTrigger Spider a))]
96 , [IORef (Maybe (EventTrigger Spider a))]
96 )
97 )
97setupMerge num = do
98setupMerge num = do
@@ -99,11 +100,11 @@ setupMerge num = do
99 let !m = DMap.fromList [Const2 i :=> v | (i,v) <- zip [0..] evs]
100 let !m = DMap.fromList [Const2 i :=> v | (i,v) <- zip [0..] evs]
100 pure (merge m, triggers)
101 pure (merge m, triggers)
101
102
102−subscribePair :: (Event (SpiderEnv Global) a, b) -> SpiderHost Global (EventHandle (SpiderEnv Global) a, b)
103+subscribePair :: (Event (SpiderTimeline Global) a, b) -> SpiderHost Global (EventHandle (SpiderTimeline Global) a, b)
103subscribePair (ev, b) = (,b) <$> subscribeEvent ev
104subscribePair (ev, b) = (,b) <$> subscribeEvent ev
104
105
105−fireAndRead :: IORef (Maybe (EventTrigger (SpiderEnv Global) a)) -> a -> EventHandle (SpiderEnv Global) b
106+fireAndRead :: IORef (Maybe (EventTrigger (SpiderTimeline Global) a)) -> a -> EventHandle (SpiderTimeline Global) b
106 -> SpiderHost Global (Maybe b)
107 -> SpiderHost Global (Maybe b)
107fireAndRead trigger val subd = do
108fireAndRead trigger val subd = do
108− Just key <- liftIO $ readIORef trigger
109+ key <- fromJust <$> liftIO (readIORef trigger)
109 fireEventsAndRead [key :=> Identity val] $ readEvent subd >>= sequence
110 fireEventsAndRead [key :=> Identity val] $ readEvent subd >>= sequence
bench/RunAll.hs+1−1
@@ -136,7 +136,7 @@ benchmarks = implGroup "spider" runSpiderHost cases
136pattern RunTestCaseFlag = "--run-test-case"
136pattern RunTestCaseFlag = "--run-test-case"
137
137
138spawnBenchmark :: String -> Benchmark
138spawnBenchmark :: String -> Benchmark
139−spawnBenchmark name = Benchmark name $ Benchmarkable $ \n -> do
139+spawnBenchmark name = bench name . toBenchmarkable $ \n -> do
140 self <- getExecutablePath
140 self <- getExecutablePath
141 callProcess self [RunTestCaseFlag, name, show n, "+RTS", "-N1"]
141 callProcess self [RunTestCaseFlag, name, show n, "+RTS", "-N1"]
142
142
cabal.haskell-cinew file+23
@@ -0,0 +1,23 @@
1+distribution: xenial
2+benchmarks: False
3+unconstrained: False
4+installed: -all
5+
6+-- https://github.com/haskell/cabal/issues/6106
7+install-dependencies: False
8+
9+constraint-set no-th
10+ constraints: reflex -use-template-haskell
11+
12+constraint-set old-these
13+ ghc: <8.8
14+ constraints: these <1
15+
16+constraint-set old-witherable
17+ constraints: witherable <0.3.2
18+
19+constraint-set debug-propagation
20+ constraints: reflex +debug-propagation
21+
22+constraint-set debug-cycles
23+ constraints: reflex +debug-cycles
cabal.projectnew file+1
@@ -0,0 +1 @@
1+packages: .
default.nixdeleted−34
@@ -1,34 +0,0 @@
1−{ mkDerivation, ghc, base, bifunctors, containers, deepseq
2−, dependent-map, dependent-sum, exception-transformers
3−, haskell-src-exts, haskell-src-meta, hlint, lens, MemoTrie
4−, monad-control, mtl, primitive, ref-tf, semigroupoids
5−, semigroups, split, stdenv, stm, syb, template-haskell
6−, these, transformers, transformers-compat, prim-uniq
7−, data-default
8−, useTemplateHaskell ? true
9−}:
10−mkDerivation {
11− pname = "reflex";
12− version = "0.5.0";
13− src = builtins.filterSource (path: type: baseNameOf path != ".git") ./.;
14− libraryHaskellDepends = [
15− base bifunctors containers dependent-map dependent-sum
16− exception-transformers lens
17− MemoTrie monad-control mtl primitive ref-tf semigroupoids
18− semigroups stm syb template-haskell these transformers
19− transformers-compat prim-uniq
20− base bifunctors containers deepseq dependent-map dependent-sum
21− mtl ref-tf split transformers data-default
22− ] ++ (if !useTemplateHaskell then [] else [
23− haskell-src-exts haskell-src-meta
24− ]);
25− testHaskellDepends = if ghc.isGhcjs or false then [] else [
26− hlint
27− ];
28− configureFlags = if useTemplateHaskell then [] else [
29− "-f-use-template-haskell"
30− ];
31− homepage = "https://github.com/reflex-frp/reflex";
32− description = "Higher-order Functional Reactive Programming";
33− license = stdenv.lib.licenses.bsd3;
34−}
dep/reflex-platform/default.nixnew file+7
@@ -0,0 +1,7 @@
1+# DO NOT HAND-EDIT THIS FILE
2+import ((import <nixpkgs> {}).fetchFromGitHub (
3+ let json = builtins.fromJSON (builtins.readFile ./github.json);
4+ in { inherit (json) owner repo rev sha256;
5+ private = json.private or false;
6+ }
7+))
dep/reflex-platform/github.jsonnew file+7
@@ -0,0 +1,7 @@
1+{
2+ "owner": "reflex-frp",
3+ "repo": "reflex-platform",
4+ "branch": "develop",
5+ "rev": "f628398d076243a0851b27e625b37f65dff9b89b",
6+ "sha256": "0sl0hf1glgyb1vmf2mhw4r9ipmcqk1y19d3wsic7dix2jwywzrh9"
7+}
reflex.cabal+331−61
@@ -1,7 +1,17 @@
1Name: reflex
1Name: reflex
2−Version: 0.5.0
2+Version: 0.8.2.0
3Synopsis: Higher-order Functional Reactive Programming
3Synopsis: Higher-order Functional Reactive Programming
4+Description:
5+ Interactive programs without callbacks or side-effects.
6+ Functional Reactive Programming (FRP) uses composable events and time-varying
7+ values to describe interactive systems as pure functions.
8+ Just like other pure functional code, functional reactive code is easier
9+ to get right on the first try, maintain, and reuse.
10+ .
4−Description: Reflex is a high-performance, deterministic, higher-order Functional Reactive Programming system
11+ Reflex is a fully-deterministic, higher-order Functional Reactive Programming
12+ interface and an engine that efficiently implements that interface.
13+ .
14+ <https://reflex-frp.org>
5License: BSD3
15License: BSD3
6License-file: LICENSE
16License-file: LICENSE
7Author: Ryan Trinkle
17Author: Ryan Trinkle
@@ -9,14 +19,17 @@ Maintainer: ryan.trinkle@gmail.com
9Stability: Experimental
19Stability: Experimental
10Category: FRP
20Category: FRP
11Build-type: Simple
21Build-type: Simple
12−Cabal-version: >=1.9.2
22+Cabal-version: 1.22
13−homepage: https://github.com/reflex-frp/reflex
23+homepage: https://reflex-frp.org
14bug-reports: https://github.com/reflex-frp/reflex/issues
24bug-reports: https://github.com/reflex-frp/reflex/issues
25+extra-source-files:
26+ README.md
27+ Quickref.md
28+ ChangeLog.md
15
29
16−flag specialize-to-spidertimeline-global
30+tested-with:
17− description: Specialize all Reflex functions to the SpiderTimeline Global implementation. This may improve performance, but will disable all other implementations.
31+ GHC ==8.4.4 || ==8.6.5 || ==8.8.1 || ==8.10.2,
18− default: False
32+ GHCJS ==8.6
19− manual: True
20
33
21flag use-reflex-optimizer
34flag use-reflex-optimizer
22 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
35 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
@@ -28,99 +41,168 @@ flag use-template-haskell
28 default: True
41 default: True
29 manual: True
42 manual: True
30
43
31−flag expose-all-unfoldings
44+flag debug-trace-events
32− description: Build the library with -fexpose-all-unfoldings which can help client code specialize better
45+ description: Add instrumentation that outputs the stack trace of the definition of an event whenever it is subscribed to. Warning: It is very slow!
33 default: False
46 default: False
34 manual: True
47 manual: True
35
48
36−flag debug-trace-events
49+flag fast-weak
37− description: add instrumentation that outputs the stack trace of the definition of an event whenever it is subscribed to. Warning: It is very slow!
50+ description: Use the primitive implementation of FastWeak in GHCJS; note that this requires GHCJS to be built with FastWeak and FastWeakBag present in the RTS, which is not the default
51+ default: False
52+ manual: True
53+
54+flag debug-propagation
55+ description: Enable debugging of spider internals
38 default: False
56 default: False
39 manual: True
57 manual: True
40
58
59+flag debug-cycles
60+ description: Enable debugging of event cycles
61+ default: False
62+ manual: True
63+
64+flag split-these
65+ description: Use split these/semialign packages
66+ manual: False
67+ default: True
68+
41library
69library
70+ default-language: Haskell2010
42 hs-source-dirs: src
71 hs-source-dirs: src
43 build-depends:
72 build-depends:
44 MemoTrie == 0.6.*,
73 MemoTrie == 0.6.*,
45− base >= 4.7 && < 4.11,
74+ base >= 4.11 && < 4.15,
46− bifunctors >= 5.2 && < 5.5,
75+ bifunctors >= 5.2 && < 5.6,
76+ comonad >= 5.0.4 && < 5.1,
77+ constraints >= 0.10 && <0.14,
78+ constraints-extras >= 0.3 && < 0.4,
47− containers == 0.5.*,
79+ containers >= 0.6 && < 0.7,
48 data-default >= 0.5 && < 0.8,
80 data-default >= 0.5 && < 0.8,
49− dependent-map >= 0.2.4 && < 0.3,
81+ dependent-map >= 0.3 && < 0.5,
50 exception-transformers == 0.4.*,
82 exception-transformers == 0.4.*,
51 lens >= 4.7 && < 5,
83 lens >= 4.7 && < 5,
84+ mmorph >= 1.0 && < 1.2,
52 monad-control >= 1.0.1 && < 1.1,
85 monad-control >= 1.0.1 && < 1.1,
53 mtl >= 2.1 && < 2.3,
86 mtl >= 2.1 && < 2.3,
87+ patch >= 0.0.1 && < 0.1,
54− prim-uniq >= 0.1.0.1 && < 0.2,
88+ prim-uniq >= 0.1.0.1 && < 0.3,
55− primitive >= 0.5 && < 0.7,
89+ primitive >= 0.5 && < 0.8,
90+ profunctors >= 5.3 && < 5.7,
91+ random == 1.1.*,
56 ref-tf == 0.4.*,
92 ref-tf == 0.4.*,
57 reflection == 2.1.*,
93 reflection == 2.1.*,
58 semigroupoids >= 4.0 && < 6,
94 semigroupoids >= 4.0 && < 6,
59− semigroups >= 0.16 && < 0.19,
60− stm == 2.4.*,
95+ stm >= 2.4 && < 2.6,
61− syb >= 0.5 && < 0.7,
96+ syb >= 0.5 && < 0.8,
62− these >= 0.4 && < 0.8,
97+ time >= 1.4 && < 1.10,
63− transformers >= 0.2,
98+ transformers >= 0.5.6.0 && < 0.6,
64− transformers-compat >= 0.3
99+ unbounded-delays >= 0.1.0.0 && < 0.2,
100+ witherable >= 0.3 && < 0.5
101+
102+ if flag(split-these)
103+ build-depends: these >= 1 && <1.2,
104+ semialign >=1 && <1.2,
105+ monoidal-containers >= 0.6 && < 0.7
106+ else
107+ build-depends: these >= 0.4 && <0.9,
108+ monoidal-containers == 0.4.0.0
65
109
66 exposed-modules:
110 exposed-modules:
67− Data.Functor.Misc,
111+ Control.Monad.ReaderIO
112+ Data.AppendMap,
113+ Data.FastMutableIntMap,
114+ Data.FastWeakBag,
115+ Data.Map.Misc,
68 Data.WeakBag,
116 Data.WeakBag,
69 Reflex,
117 Reflex,
70 Reflex.Class,
118 Reflex.Class,
71− Reflex.EventWriter,
119+ Reflex.Adjustable.Class,
120+ Reflex.BehaviorWriter.Base,
121+ Reflex.BehaviorWriter.Class,
122+ Reflex.Collection,
72 Reflex.Dynamic,
123 Reflex.Dynamic,
73 Reflex.Dynamic.Uniq,
124 Reflex.Dynamic.Uniq,
74 Reflex.DynamicWriter,
125 Reflex.DynamicWriter,
126+ Reflex.DynamicWriter.Base,
127+ Reflex.DynamicWriter.Class,
128+ Reflex.EventWriter,
129+ Reflex.EventWriter.Base,
130+ Reflex.EventWriter.Class,
131+ Reflex.FastWeak,
75 Reflex.FunctorMaybe,
132 Reflex.FunctorMaybe,
76 Reflex.Host.Class,
133 Reflex.Host.Class,
77− Reflex.Patch,
134+ Reflex.Host.Headless,
78− Reflex.TriggerEvent.Base,
135+ Reflex.Network,
79− Reflex.TriggerEvent.Class,
136+ Reflex.NotReady.Class,
80 Reflex.PerformEvent.Base,
137 Reflex.PerformEvent.Base,
81 Reflex.PerformEvent.Class,
138 Reflex.PerformEvent.Class,
82 Reflex.PostBuild.Base,
139 Reflex.PostBuild.Base,
83 Reflex.PostBuild.Class,
140 Reflex.PostBuild.Class,
141+ Reflex.Profiled,
142+ Reflex.Pure,
143+ Reflex.Query.Base,
144+ Reflex.Query.Class,
84 Reflex.Requester.Base,
145 Reflex.Requester.Base,
85 Reflex.Requester.Class,
146 Reflex.Requester.Class,
86 Reflex.Spider,
147 Reflex.Spider,
87− Reflex.Spider.Internal
148+ Reflex.Spider.Internal,
149+ Reflex.Time,
150+ Reflex.TriggerEvent.Base,
151+ Reflex.TriggerEvent.Class,
152+ Reflex.Widget.Basic,
153+ Reflex.Workflow
88
154
89− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2
155+ reexported-modules:
90− ghc-prof-options: -fprof-auto
156+ patch:Data.Functor.Misc,
157+ patch:Data.Patch as Reflex.Patch,
158+ patch:Data.Patch.Class as Reflex.Patch.Class,
159+ patch:Data.Patch.DMap as Reflex.Patch.DMap,
160+ patch:Data.Patch.DMapWithMove as Reflex.Patch.DMapWithMove,
161+ patch:Data.Patch.IntMap as Reflex.Patch.IntMap,
162+ patch:Data.Patch.Map as Reflex.Patch.Map,
163+ patch:Data.Patch.MapWithMove as Reflex.Patch.MapWithMove
91
164
92− if flag(specialize-to-spidertimeline-global)
165+ ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
93− cpp-options: -DSPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
94− else
95− exposed-modules: Reflex.Pure
96
166
97 if flag(debug-trace-events)
167 if flag(debug-trace-events)
98 cpp-options: -DDEBUG_TRACE_EVENTS
168 cpp-options: -DDEBUG_TRACE_EVENTS
99− build-depends: bytestring
169+ build-depends:
170+ bytestring >= 0.10.8 && < 0.11
100
171
101 if flag(use-reflex-optimizer)
172 if flag(use-reflex-optimizer)
102 cpp-options: -DUSE_REFLEX_OPTIMIZER
173 cpp-options: -DUSE_REFLEX_OPTIMIZER
103 build-depends: ghc
174 build-depends: ghc
104 exposed-modules: Reflex.Optimizer
175 exposed-modules: Reflex.Optimizer
105
176
177+ if flag(debug-propagation)
178+ cpp-options: -DDEBUG -DDEBUG_TRACE_PROPAGATION -DDEBUG_TRACE_INVALIDATION
179+
180+ if flag(debug-cycles)
181+ cpp-options: -DDEBUG_CYCLES
182+
106 if flag(use-template-haskell)
183 if flag(use-template-haskell)
107 cpp-options: -DUSE_TEMPLATE_HASKELL
184 cpp-options: -DUSE_TEMPLATE_HASKELL
108 build-depends:
185 build-depends:
109− dependent-sum >= 0.3 && < 0.5,
186+ dependent-sum >= 0.6 && < 0.8,
110− haskell-src-exts >= 1.16 && < 1.18,
187+ haskell-src-exts >= 1.16 && < 1.24,
111− haskell-src-meta == 0.6.*,
188+ haskell-src-meta >= 0.6 && < 0.9,
112− template-haskell >= 2.9 && < 2.12
189+ template-haskell >= 2.9 && < 2.17
113 exposed-modules:
190 exposed-modules:
114 Reflex.Dynamic.TH
191 Reflex.Dynamic.TH
115 other-extensions: TemplateHaskell
192 other-extensions: TemplateHaskell
116 else
193 else
117 build-depends:
194 build-depends:
118− dependent-sum == 0.4.*
195+ dependent-sum >= 0.6 && < 0.8
196+
197+ if flag(fast-weak) && impl(ghcjs)
198+ cpp-options: -DGHCJS_FAST_WEAK
119
199
120− if flag(expose-all-unfoldings)
200+ if impl(ghcjs)
121− ghc-options: -fexpose-all-unfoldings
201+ build-depends:
202+ ghcjs-base == 0.2.*
122
203
123test-suite semantics
204test-suite semantics
205+ default-language: Haskell2010
124 type: exitcode-stdio-1.0
206 type: exitcode-stdio-1.0
125 main-is: semantics.hs
207 main-is: semantics.hs
126 hs-source-dirs: test
208 hs-source-dirs: test
@@ -129,89 +211,273 @@ test-suite semantics
129 base,
211 base,
130 bifunctors,
212 bifunctors,
131 containers,
213 containers,
132− deepseq >= 1.3 && < 1.5,
214+ deepseq,
133 dependent-map,
215 dependent-map,
134 dependent-sum,
216 dependent-sum,
135 mtl,
217 mtl,
136 ref-tf,
218 ref-tf,
137 reflex,
219 reflex,
138 split,
220 split,
139− transformers >= 0.3
221+ transformers
140− if flag(specialize-to-spidertimeline-global)
222+ other-modules:
141− buildable: False
223+ Reflex.Bench.Focused
224+ Reflex.Plan.Pure
225+ Reflex.Plan.Reflex
226+ Reflex.Test
227+ Reflex.Test.Micro
228+ Reflex.TestPlan
229+
230+test-suite CrossImpl
231+ default-language: Haskell2010
232+ type: exitcode-stdio-1.0
233+ main-is: Reflex/Test/CrossImpl.hs
234+ hs-source-dirs: test
235+ ghc-options: -O2 -Wall -rtsopts
236+ build-depends:
237+ base,
238+ containers,
239+ dependent-map,
240+ dependent-sum,
241+ deepseq,
242+ mtl,
243+ transformers,
244+ ref-tf,
245+ reflex
246+ other-modules:
247+ Reflex.Test
248+ Reflex.TestPlan
249+ Reflex.Plan.Reflex
250+ Reflex.Plan.Pure
142
251
143test-suite hlint
252test-suite hlint
253+ default-language: Haskell2010
144 type: exitcode-stdio-1.0
254 type: exitcode-stdio-1.0
145 main-is: hlint.hs
255 main-is: hlint.hs
146 hs-source-dirs: test
256 hs-source-dirs: test
147− build-depends: base, hlint == 1.9.*
257+ build-depends: base
258+ , directory
259+ , filepath
260+ , filemanip
261+ if impl(ghc >= 8.8)
262+ build-depends: hlint >= 3 && < 4
263+ else
264+ build-depends: hlint (< 2.1 || >= 2.2.2) && < 4
148 if impl(ghcjs)
265 if impl(ghcjs)
149 buildable: False
266 buildable: False
150
267
151test-suite EventWriterT
268test-suite EventWriterT
269+ default-language: Haskell2010
152 type: exitcode-stdio-1.0
270 type: exitcode-stdio-1.0
153 main-is: EventWriterT.hs
271 main-is: EventWriterT.hs
154 hs-source-dirs: test
272 hs-source-dirs: test
155 build-depends: base
273 build-depends: base
274+ , containers
275+ , deepseq
276+ , dependent-map
277+ , dependent-sum
278+ , lens
279+ , mtl
280+ , these
281+ , transformers
282+ , reflex
283+ , ref-tf
284+
285+ if flag(split-these)
286+ build-depends: these-lens
287+
288+ other-modules:
289+ Test.Run
290+
291+
292+test-suite DebugCycles
293+ default-language: Haskell2010
294+ type: exitcode-stdio-1.0
295+ main-is: DebugCycles.hs
296+ hs-source-dirs: test
297+ ghc-options: -threaded
298+ build-depends: base
299+ , containers
300+ , deepseq
301+ , dependent-map
156 , dependent-sum
302 , dependent-sum
303+ , hspec
304+ , lens
305+ , mtl
306+ , these
157 , transformers
307 , transformers
158 , reflex
308 , reflex
159 , ref-tf
309 , ref-tf
310+ , witherable
311+ , proctest
312+
313+
314+ if flag(split-these)
315+ build-depends: these-lens, semialign
316+
317+ other-modules:
318+ Test.Run
319+
160
320
161test-suite RequesterT
321test-suite RequesterT
322+ default-language: Haskell2010
162 type: exitcode-stdio-1.0
323 type: exitcode-stdio-1.0
163 main-is: RequesterT.hs
324 main-is: RequesterT.hs
164 hs-source-dirs: test
325 hs-source-dirs: test
165 build-depends: base
326 build-depends: base
166− , dependent-sum
327+ , constraints
328+ , constraints-extras
329+ , containers
330+ , deepseq
167 , dependent-map
331 , dependent-map
332+ , dependent-sum
333+ , lens
334+ , mtl
335+ , ref-tf
336+ , reflex
337+ , text
338+ , these
168 , transformers
339 , transformers
340+
341+ if flag(split-these)
342+ build-depends: these-lens
343+
344+ other-modules:
345+ Reflex.TestPlan
346+ Reflex.Plan.Pure
347+ Test.Run
348+
349+test-suite Headless
350+ default-language: Haskell2010
351+ type: exitcode-stdio-1.0
352+ main-is: Headless.hs
353+ hs-source-dirs: test
354+ build-depends: base
355+ , reflex
356+
357+test-suite Adjustable
358+ default-language: Haskell2010
359+ type: exitcode-stdio-1.0
360+ main-is: Adjustable.hs
361+ hs-source-dirs: test
362+ build-depends: base
363+ , containers
364+ , dependent-sum
169 , reflex
365 , reflex
170 , ref-tf
366 , ref-tf
367+ , these
368+
369+ other-modules:
370+ Test.Run
371+
372+test-suite QueryT
373+ default-language: Haskell2010
374+ type: exitcode-stdio-1.0
375+ main-is: QueryT.hs
376+ hs-source-dirs: test
377+ build-depends: base
378+ , containers
379+ , dependent-map
380+ , dependent-sum
381+ , deepseq
382+ , lens
383+ , monoidal-containers
384+ , mtl
385+ , patch
386+ , ref-tf
387+ , reflex
388+ , these
389+ , transformers
390+
391+ if flag(split-these)
392+ build-depends: semialign, these-lens
393+
394+ other-modules:
395+ Test.Run
396+ Reflex.TestPlan
397+ Reflex.Plan.Reflex
398+ Reflex.Plan.Pure
171
399
172test-suite GC-Semantics
400test-suite GC-Semantics
401+ default-language: Haskell2010
173 type: exitcode-stdio-1.0
402 type: exitcode-stdio-1.0
174 main-is: GC.hs
403 main-is: GC.hs
175 hs-source-dirs: test
404 hs-source-dirs: test
176− if flag(specialize-to-spidertimeline-global)
177− buildable: False
178 build-depends: base
405 build-depends: base
406+ , containers
179 , dependent-sum
407 , dependent-sum
180 , dependent-map
408 , dependent-map
409+ , deepseq
410+ , mtl
411+ , patch
181 , these
412 , these
182 , transformers
413 , transformers
183 , reflex
414 , reflex
184 , ref-tf
415 , ref-tf
185
416
417+ if flag(split-these)
418+ build-depends: semialign
419+
420+ other-modules:
421+ Reflex.Plan.Pure
422+ Reflex.Plan.Reflex
423+ Reflex.TestPlan
424+ Test.Run
425+
426+test-suite rootCleanup
427+ default-language: Haskell2010
428+ type: exitcode-stdio-1.0
429+ main-is: rootCleanup.hs
430+ hs-source-dirs: test
431+ build-depends: base
432+ , containers
433+ , deepseq
434+ , dependent-sum
435+ , mtl
436+ , reflex
437+ , ref-tf
438+ , these
439+ other-modules:
440+ Reflex.Plan.Pure
441+ Reflex.TestPlan
442+ Test.Run
443+
186benchmark spider-bench
444benchmark spider-bench
445+ default-language: Haskell2010
187 type: exitcode-stdio-1.0
446 type: exitcode-stdio-1.0
188− hs-source-dirs: bench
447+ hs-source-dirs: bench test
189 main-is: Main.hs
448 main-is: Main.hs
190 ghc-options: -Wall -O2 -rtsopts
449 ghc-options: -Wall -O2 -rtsopts
191 build-depends:
450 build-depends:
192 base,
451 base,
452+ containers,
193− criterion == 1.1.*,
453+ criterion,
194− deepseq >= 1.3 && < 1.5,
454+ deepseq,
195 dependent-map,
455 dependent-map,
196 dependent-sum,
456 dependent-sum,
457+ ref-tf,
197 mtl,
458 mtl,
198 primitive,
459 primitive,
199 reflex,
460 reflex,
461+ split,
200 stm,
462 stm,
201− transformers >= 0.3
463+ transformers
464+ other-modules:
465+ Reflex.TestPlan
466+ Reflex.Plan.Reflex
467+ Reflex.Bench.Focused
202
468
203benchmark saulzar-bench
469benchmark saulzar-bench
470+ default-language: Haskell2010
204 type: exitcode-stdio-1.0
471 type: exitcode-stdio-1.0
205 hs-source-dirs: bench test
472 hs-source-dirs: bench test
206 c-sources: bench-cbits/checkCapability.c
473 c-sources: bench-cbits/checkCapability.c
207 main-is: RunAll.hs
474 main-is: RunAll.hs
208 ghc-options: -Wall -O2 -rtsopts -threaded
475 ghc-options: -Wall -O2 -rtsopts -threaded
209− ghc-prof-options: -fprof-auto
210 build-depends:
476 build-depends:
211 base,
477 base,
212− containers == 0.5.*,
478+ containers,
213− criterion == 1.1.*,
479+ criterion,
214− deepseq >= 1.3 && < 1.5,
480+ deepseq,
215 dependent-map,
481 dependent-map,
216 dependent-sum,
482 dependent-sum,
217 loch-th,
483 loch-th,
@@ -223,7 +489,11 @@ benchmark saulzar-bench
223 split,
489 split,
224 stm,
490 stm,
225 time,
491 time,
226− transformers >= 0.3
492+ transformers
493+ other-modules:
494+ Reflex.TestPlan
495+ Reflex.Plan.Reflex
496+ Reflex.Bench.Focused
227
497
228source-repository head
498source-repository head
229 type: git
499 type: git
release.nixnew file+58
@@ -0,0 +1,58 @@
1+{ reflex-platform-fun ? import ./dep/reflex-platform
2+, supportedSystems ? ["x86_64-linux" "x86_64-darwin"]
3+}:
4+
5+let
6+ native-reflex-platform = reflex-platform-fun {};
7+ inherit (native-reflex-platform.nixpkgs) lib;
8+
9+ perPlatform = lib.genAttrs supportedSystems (system: let
10+ reflex-platform = reflex-platform-fun { inherit system; };
11+ compilers = [
12+ "ghc"
13+ "ghcjs"
14+ ] ++ lib.optionals (reflex-platform.androidSupport) [
15+ "ghcAndroidAarch64"
16+ "ghcAndroidAarch32"
17+ ] ++ lib.optionals (reflex-platform.iosSupport) [
18+ "ghcIosAarch64"
19+ ];
20+ variations = map (v: "reflex" + v) [
21+ "-dontUseTemplateHaskell"
22+ ""
23+ ];
24+ compilerPkgs = lib.genAttrs compilers (ghc: let
25+ variationPkgs = lib.genAttrs variations (variation: let
26+ reflex-platform = reflex-platform-fun {
27+ inherit system;
28+ __useTemplateHaskell = variation == "reflex"; # TODO hack
29+ haskellOverlays = [
30+ # Use this package's source for reflex
31+ (self: super: {
32+ _dep = super._dep // {
33+ reflex = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [
34+ "release.nix"
35+ ".git"
36+ "dist"
37+ "cabal.haskell-ci"
38+ "cabal.project"
39+ ".travis.yml"
40+ ])) ./.;
41+ };
42+ })
43+ ];
44+ };
45+ in reflex-platform.${ghc}.reflex);
46+ in variationPkgs // {
47+ cache = reflex-platform.pinBuildInputs "reflex-${system}-${ghc}"
48+ (builtins.attrValues variationPkgs);
49+ });
50+ in compilerPkgs // {
51+ cache = reflex-platform.pinBuildInputs "reflex-${system}"
52+ (map (a: a.cache) (builtins.attrValues compilerPkgs));
53+ });
54+
55+ metaCache = native-reflex-platform.pinBuildInputs "reflex-everywhere"
56+ (map (a: a.cache) (builtins.attrValues perPlatform));
57+
58+in perPlatform // { inherit metaCache; }
src/Control/Monad/ReaderIO.hsnew file+60
@@ -0,0 +1,60 @@
1+{-# language RoleAnnotations #-}
2+{-# language MultiParamTypeClasses #-}
3+{-# language FlexibleInstances #-}
4+{-# language CPP #-}
5+module Control.Monad.ReaderIO
6+ (
7+ ReaderIO (..)
8+ )
9+ where
10+
11+import Control.Monad.Fix
12+#if MIN_VERSION_base(4,10,0)
13+import Control.Applicative
14+#endif
15+import Control.Monad
16+import Control.Monad.Reader.Class
17+import Control.Monad.IO.Class
18+
19+-- | An approximate clone of @RIO@ from the @rio@ package, but not based on
20+-- @ReaderT@. The trouble with @ReaderT@ is that its third type argument has a
21+-- @nominal@ role, so we can't coerce through it when it's wrapped in some
22+-- other @data@ type. Ugh.
23+newtype ReaderIO e a = ReaderIO { runReaderIO :: e -> IO a }
24+type role ReaderIO representational representational
25+
26+instance Functor (ReaderIO e) where
27+ fmap = liftM
28+ {-# INLINE fmap #-}
29+ a <$ m = m >> pure a
30+ {-# INLINE (<$) #-}
31+
32+instance Applicative (ReaderIO e) where
33+ pure a = ReaderIO $ \_ -> pure a
34+ {-# INLINE pure #-}
35+ (<*>) = ap
36+ {-# INLINE (<*>) #-}
37+#if MIN_VERSION_base(4,10,0)
38+ liftA2 = liftM2
39+ {-# INLINE liftA2 #-}
40+#endif
41+ (*>) = (>>)
42+ {-# INLINE (*>) #-}
43+
44+instance Monad (ReaderIO e) where
45+ ReaderIO q >>= f = ReaderIO $ \e -> q e >>= \a -> runReaderIO (f a) e
46+ {-# INLINE (>>=) #-}
47+
48+instance MonadFix (ReaderIO e) where
49+ mfix f = ReaderIO $ \e -> mfix $ \r -> runReaderIO (f r) e
50+ {-# INLINE mfix #-}
51+
52+instance MonadIO (ReaderIO e) where
53+ liftIO m = ReaderIO $ \_ -> m
54+ {-# INLINE liftIO #-}
55+
56+instance MonadReader e (ReaderIO e) where
57+ ask = ReaderIO pure
58+ {-# INLINE ask #-}
59+ local f (ReaderIO m) = ReaderIO (m . f)
60+ {-# INLINE local #-}
src/Data/AppendMap.hsnew file+84
@@ -0,0 +1,84 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE PatternSynonyms #-}
6+{-# LANGUAGE RoleAnnotations #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# OPTIONS_GHC -fno-warn-orphans #-}
10+-- |
11+-- Module:
12+-- Data.AppendMap
13+-- Description:
14+-- Instances and convenience functions for 'Data.Map.Monoidal'. We use
15+-- monoidal-containers to take advantage of its better monoid instance.
16+-- 'Data.Map' has @mappend = union@, which is left-biased. 'MonoidalMap'
17+-- has @mappend = unionWith mappend@ instead.
18+module Data.AppendMap
19+ ( module Data.AppendMap
20+ , module Data.Map.Monoidal
21+ ) where
22+
23+import Prelude hiding (null)
24+
25+import Data.Coerce
26+import Data.Default
27+import Data.Map (Map)
28+#if MIN_VERSION_containers(0,5,11)
29+import qualified Data.Map.Internal.Debug as Map (showTree, showTreeWith)
30+#else
31+import qualified Data.Map as Map (showTree, showTreeWith)
32+#endif
33+import qualified Data.Witherable as W
34+import Data.Map.Monoidal
35+import qualified Data.Map.Monoidal as MonoidalMap
36+
37+
38+{-# DEPRECATED AppendMap "Use 'MonoidalMap' instead" #-}
39+-- | AppendMap is a synonym for 'Data.Map.Monoidal.MonoidalMap'
40+type AppendMap = MonoidalMap
41+
42+{-# DEPRECATED _unAppendMap "Use 'getMonoidalMap' instead" #-}
43+-- | A synonym for 'getMonoidalMap'
44+_unAppendMap :: MonoidalMap k v -> Map k v
45+_unAppendMap = getMonoidalMap
46+
47+-- | Pattern synonym for 'MonoidalMap'
48+pattern AppendMap :: Map k v -> MonoidalMap k v
49+pattern AppendMap m = MonoidalMap m
50+
51+#if !MIN_VERSION_witherable(0,3,2)
52+instance W.Filterable (MonoidalMap k) where
53+ mapMaybe = MonoidalMap.mapMaybe
54+#endif
55+
56+-- | Deletes a key, returning 'Nothing' if the result is empty.
57+nonEmptyDelete :: Ord k => k -> MonoidalMap k a -> Maybe (MonoidalMap k a)
58+nonEmptyDelete k vs =
59+ let deleted = delete k vs
60+ in if null deleted
61+ then Nothing
62+ else Just deleted
63+
64+-- | Like 'mapMaybe' but indicates whether the resulting container is empty
65+mapMaybeNoNull :: (a -> Maybe b)
66+ -> MonoidalMap token a
67+ -> Maybe (MonoidalMap token b)
68+mapMaybeNoNull f as =
69+ let bs = mapMaybe f as
70+ in if null bs
71+ then Nothing
72+ else Just bs
73+
74+-- TODO: Move instances to `Data.Patch`
75+-- | Displays a 'MonoidalMap' as a tree. See 'Data.Map.Lazy.showTree' for details.
76+showTree :: forall k a. (Show k, Show a) => MonoidalMap k a -> String
77+showTree = coerce (Map.showTree :: Map k a -> String)
78+
79+-- | Displays a 'MonoidalMap' as a tree, using the supplied function to convert nodes to string.
80+showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> MonoidalMap k a -> String
81+showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
82+
83+instance Default (MonoidalMap k a) where
84+ def = empty
src/Data/FastMutableIntMap.hsnew file+97
@@ -0,0 +1,97 @@
1+{-# LANGUAGE TypeFamilies #-}
2+-- |
3+-- Module:
4+-- Data.FastMutableIntMap
5+-- Description:
6+-- A mutable version of 'IntMap'
7+module Data.FastMutableIntMap
8+ ( FastMutableIntMap
9+ , new
10+ , newEmpty
11+ , insert
12+ , isEmpty
13+ , getFrozenAndClear
14+ , size
15+ , applyPatch
16+ , PatchIntMap (..)
17+ , traverseIntMapPatchWithKey
18+ , lookup
19+ , forIntersectionWithImmutable_
20+ , for_
21+ , patchIntMapNewElements
22+ , patchIntMapNewElementsMap
23+ , getDeletions
24+ , toList
25+ ) where
26+
27+--TODO: Pure JS version
28+--TODO: Fast copy to FastIntMap
29+--TODO: Fast patch type
30+
31+import Prelude hiding (lookup)
32+
33+import Control.Monad.IO.Class
34+import Data.Foldable (traverse_)
35+import Data.IntMap.Strict (IntMap)
36+import qualified Data.IntMap.Strict as IntMap
37+import Data.IORef
38+import Data.Patch.Class
39+import Data.Patch.IntMap
40+
41+-- | A 'FastMutableIntMap' holds a map of values of type @a@ and allows low-overhead modifications via IO.
42+-- Operations on 'FastMutableIntMap' run in IO.
43+newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
44+
45+-- | Create a new 'FastMutableIntMap' out of an 'IntMap'
46+new :: IntMap a -> IO (FastMutableIntMap a)
47+new m = FastMutableIntMap <$> newIORef m
48+
49+-- | Create a new empty 'FastMutableIntMap'
50+newEmpty :: IO (FastMutableIntMap a)
51+newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
52+
53+-- | Insert an element into a 'FastMutableIntMap' at the given key
54+insert :: FastMutableIntMap a -> Int -> a -> IO ()
55+insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
56+
57+-- | Attempt to lookup an element by key in a 'FastMutableIntMap'
58+lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
59+lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
60+
61+-- | Runs the provided action over the intersection of a 'FastMutableIntMap' and an 'IntMap'
62+forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
63+forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
64+ a <- liftIO $ readIORef r
65+ traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
66+
67+-- | Runs the provided action over the values of a 'FastMutableIntMap'
68+for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
69+for_ (FastMutableIntMap r) f = do
70+ a <- liftIO $ readIORef r
71+ traverse_ f a
72+
73+-- | Checks whether a 'FastMutableIntMap' is empty
74+isEmpty :: FastMutableIntMap a -> IO Bool
75+isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
76+
77+-- | Retrieves the size of a 'FastMutableIntMap'
78+size :: FastMutableIntMap a -> IO Int
79+size (FastMutableIntMap r) = IntMap.size <$> readIORef r
80+
81+-- | Make an immutable snapshot of the datastructure and clear it
82+getFrozenAndClear :: FastMutableIntMap a -> IO (IntMap a)
83+getFrozenAndClear (FastMutableIntMap r) = do
84+ result <- readIORef r
85+ writeIORef r IntMap.empty
86+ return result
87+
88+-- | Updates the value of a 'FastMutableIntMap' with the given patch (see 'Data.Patch.IntMap'),
89+-- and returns an 'IntMap' with the modified keys and values.
90+applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
91+applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
92+ v <- readIORef r
93+ writeIORef r $! applyAlways p v
94+ return $ IntMap.intersection v m
95+
96+toList :: FastMutableIntMap a -> IO [(Int, a)]
97+toList (FastMutableIntMap r) = IntMap.toList <$> readIORef r
src/Data/FastWeakBag.hsnew file+161
@@ -0,0 +1,161 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ExistentialQuantification #-}
3+#ifdef USE_REFLEX_OPTIMIZER
4+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
5+#endif
6+#ifdef GHCJS_FAST_WEAK
7+{-# LANGUAGE ForeignFunctionInterface #-}
8+{-# LANGUAGE JavaScriptFFI #-}
9+#endif
10+-- | This module defines the 'FastWeakBag' type, which represents a mutable
11+-- collection of items that does not cause the items to be retained in memory.
12+-- This is useful for situations where a value needs to be inspected or modified
13+-- if it is still alive, but can be ignored if it is dead.
14+module Data.FastWeakBag
15+ ( FastWeakBag
16+ , FastWeakBagTicket
17+ , empty
18+ , isEmpty
19+ , insert
20+ , traverse
21+ , traverse_
22+ , remove
23+ -- * Internal functions
24+ -- These will not always be available.
25+#ifndef GHCJS_FAST_WEAK
26+ , _weakBag_children --TODO: Don't export this
27+#endif
28+ ) where
29+
30+import Prelude hiding (traverse)
31+
32+import Control.Monad
33+import Control.Monad.IO.Class
34+
35+#ifdef GHCJS_FAST_WEAK
36+import GHCJS.Types
37+import Reflex.FastWeak (js_isNull, unsafeFromRawJSVal, unsafeToRawJSVal)
38+#else
39+import Control.Exception
40+import Data.IntMap.Strict (IntMap)
41+import qualified Data.IntMap.Strict as IntMap
42+import Data.IORef
43+import System.Mem.Weak
44+#endif
45+
46+-- | A 'FastWeakBag' holds a set of values of type @/a/@, but does not retain them -
47+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
48+-- alive, the 'FastWeakBag' will continue to refer to them.
49+#ifdef GHCJS_FAST_WEAK
50+newtype FastWeakBag a = FastWeakBag JSVal
51+#else
52+data FastWeakBag a = FastWeakBag
53+ { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
54+ , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a))) -- ^ Map of items contained by the 'FastWeakBag'
55+ }
56+#endif
57+
58+-- | When inserting an item into a 'FastWeakBag', a 'FastWeakBagTicket' is returned. If
59+-- the caller retains the ticket, the item is guranteed to stay in memory (and
60+-- thus in the 'FastWeakBag'). The ticket can also be used to remove the item from
61+-- the 'FastWeakBag' prematurely (i.e. while it is still alive), using 'remove'.
62+#ifdef GHCJS_FAST_WEAK
63+newtype FastWeakBagTicket a = FastWeakBagTicket JSVal
64+#else
65+data FastWeakBagTicket a = FastWeakBagTicket
66+ { _weakBagTicket_weakItem :: {-# UNPACK #-} !(Weak a)
67+ , _weakBagTicket_item :: {-# NOUNPACK #-} !a
68+ }
69+#endif
70+
71+-- | Insert an item into a 'FastWeakBag'.
72+{-# INLINE insert #-}
73+insert :: a -- ^ The item
74+ -> FastWeakBag a -- ^ The 'FastWeakBag' to insert into
75+ -> IO (FastWeakBagTicket a) -- ^ Returns a 'FastWeakBagTicket' that ensures the item
76+ -- is retained and allows the item to be removed.
77+#ifdef GHCJS_FAST_WEAK
78+insert a wb = js_insert (unsafeToRawJSVal a) wb
79+foreign import javascript unsafe "$r = new h$FastWeakBagTicket($2, $1);" js_insert :: JSVal -> FastWeakBag a -> IO (FastWeakBagTicket a)
80+#else
81+insert a (FastWeakBag nextId children) = {-# SCC "insert" #-} do
82+ a' <- evaluate a
83+ myId <- atomicModifyIORef' nextId $ \n -> (succ n, n)
84+ let cleanup = atomicModifyIORef' children $ \cs -> (IntMap.delete myId cs, ())
85+ wa <- mkWeakPtr a' $ Just cleanup
86+ atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
87+ return $ FastWeakBagTicket
88+ { _weakBagTicket_weakItem = wa
89+ , _weakBagTicket_item = a'
90+ }
91+#endif
92+
93+-- | Create an empty 'FastWeakBag'.
94+{-# INLINE empty #-}
95+empty :: IO (FastWeakBag a)
96+#ifdef GHCJS_FAST_WEAK
97+empty = js_empty
98+foreign import javascript unsafe "$r = new h$FastWeakBag();" js_empty :: IO (FastWeakBag a)
99+#else
100+empty = {-# SCC "empty" #-} do
101+ nextId <- newIORef 1
102+ children <- newIORef IntMap.empty
103+ let bag = FastWeakBag
104+ { _weakBag_nextId = nextId
105+ , _weakBag_children = children
106+ }
107+ return bag
108+#endif
109+
110+-- | Check whether a 'FastWeakBag' is empty.
111+{-# INLINE isEmpty #-}
112+isEmpty :: FastWeakBag a -> IO Bool
113+#ifdef GHCJS_FAST_WEAK
114+isEmpty = js_isEmpty
115+foreign import javascript unsafe "(function(){ for(var i = 0; i < $1.tickets.length; i++) { if($1.tickets[i] !== null) { return false; } }; return true; })()" js_isEmpty :: FastWeakBag a -> IO Bool --TODO: Clean up as we go along so this isn't O(n) every time
116+#else
117+isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
118+#endif
119+
120+{-# INLINE traverse_ #-}
121+-- | Visit every node in the given list. If new nodes are appended during the
122+-- traversal, they will not be visited. Every live node that was in the list
123+-- when the traversal began will be visited exactly once; however, no guarantee
124+-- is made about the order of the traversal.
125+traverse_ :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
126+#ifdef GHCJS_FAST_WEAK
127+traverse_ wb f = do
128+ let go cursor = when (not $ js_isNull cursor) $ do
129+ val <- liftIO $ js_getTicketValue cursor
130+ f $ unsafeFromRawJSVal val
131+ go =<< liftIO (js_getNext (FastWeakBagTicket cursor))
132+ go =<< liftIO (js_getInitial wb)
133+foreign import javascript unsafe "(function(){ for(var i = $1.tickets.length - 1; i >= 0; i--) { if($1.tickets[i] !== null) { return $1.tickets[i]; } }; return null; })()" js_getInitial :: FastWeakBag a -> IO JSVal --TODO: Clean up as we go along so this isn't O(n) every time -- Result can be null or a FastWeakBagTicket a
134+foreign import javascript unsafe "$r = $1.val;" js_getTicketValue :: JSVal -> IO JSVal
135+--TODO: Fix the race condition where if a cursor is deleted (presumably using 'remove', below) while we're holding it, it can't find its way back to the correct bag
136+foreign import javascript unsafe "(function(){ for(var i = $1.pos - 1; i >= 0; i--) { if($1.bag.tickets[i] !== null) { return $1.bag.tickets[i]; } }; return null; })()" js_getNext :: FastWeakBagTicket a -> IO JSVal --TODO: Clean up as we go along so this isn't O(n) every time -- Result can be null or a FastWeakBagTicket a
137+#else
138+traverse_ (FastWeakBag _ children) f = {-# SCC "traverse_" #-} do
139+ cs <- liftIO $ readIORef children
140+ forM_ cs $ \c -> do
141+ ma <- liftIO $ deRefWeak c
142+ mapM_ f ma
143+#endif
144+
145+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
146+traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
147+traverse = traverse_
148+
149+-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
150+-- on the same 'FastWeakBagTicket'.
151+{-# INLINE remove #-}
152+remove :: FastWeakBagTicket a -> IO ()
153+#ifdef GHCJS_FAST_WEAK
154+remove = js_remove
155+foreign import javascript unsafe "$1.bag.tickets[$1.pos] = null; $1.bag = new h$FastWeakBag(); $1.bag.tickets.push($1); $1.pos = 0;" js_remove :: FastWeakBagTicket a -> IO () --TODO: Don't bother with the new surrogate FastWeakBag; instead, make the GC check for bag === null, and then null it out here
156+#else
157+remove (FastWeakBagTicket w _) = {-# SCC "remove" #-} finalize w
158+#endif
159+--TODO: Should 'remove' also drop the reference to the item?
160+
161+--TODO: can/should we provide a null FastWeakBagTicket?
src/Data/Functor/Misc.hsdeleted−237
@@ -1,237 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE KindSignatures #-}
7−{-# LANGUAGE LambdaCase #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE PolyKinds #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE StandaloneDeriving #-}
13−#ifdef USE_REFLEX_OPTIMIZER
14−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
15−#endif
16−-- | This module provides types and functions with no particular theme, but
17−-- which are relevant to the use of 'Functor'-based datastructures like
18−-- 'Data.Dependent.Map.DMap'.
19−module Data.Functor.Misc
20− ( -- * Const2
21− Const2 (..)
22− , dmapToMap
23− , dmapToMapWith
24− , mapToDMap
25− , weakenDMapWith
26− -- * WrapArg
27− , WrapArg (..)
28− -- * Convenience functions for DMap
29− , mapWithFunctorToDMap
30− , mapKeyValuePairsMonotonic
31− , combineDMapsWithKey
32− , EitherTag (..)
33− , dmapToThese
34− , eitherToDSum
35− , dsumToEither
36− -- * Deprecated functions
37− , sequenceDmap
38− , wrapDMap
39− , rewrapDMap
40− , unwrapDMap
41− , unwrapDMapMaybe
42− , extractFunctorDMap
43− ) where
44−
45−import Control.Applicative (Applicative, (<$>))
46−import Control.Monad.Identity
47−import Data.Dependent.Map (DMap)
48−import qualified Data.Dependent.Map as DMap
49−import Data.Dependent.Sum
50−import Data.GADT.Compare
51−import Data.GADT.Show
52−import Data.Map (Map)
53−import qualified Data.Map as Map
54−import Data.Some (Some)
55−import qualified Data.Some as Some
56−import Data.These
57−import Data.Typeable hiding (Refl)
58−
59−--------------------------------------------------------------------------------
60−-- Const2
61−--------------------------------------------------------------------------------
62−
63−-- | 'Const2' stores a value of a given type 'k' and ensures that a particular
64−-- type 'v' is always given for the last type parameter
65−data Const2 :: * -> x -> x -> * where
66− Const2 :: k -> Const2 k v v
67− deriving (Typeable)
68−
69−deriving instance Show k => Show (Const2 k v v)
70−
71−instance Show k => GShow (Const2 k v) where
72− gshowsPrec n x@(Const2 _) = showsPrec n x
73−
74−instance (Show k, Show (f v)) => ShowTag (Const2 k v) f where
75− showTaggedPrec (Const2 _) = showsPrec
76−
77−instance Eq k => GEq (Const2 k v) where
78− geq (Const2 a) (Const2 b) =
79− if a == b
80− then Just Refl
81− else Nothing
82−
83−instance Ord k => GCompare (Const2 k v) where
84− gcompare (Const2 a) (Const2 b) = case compare a b of
85− LT -> GLT
86− EQ -> GEQ
87− GT -> GGT
88−
89−-- | Convert a 'DMap' to a regular 'Map'
90−dmapToMap :: DMap (Const2 k v) Identity -> Map k v
91−dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
92−
93−dmapToMapWith :: (f v -> v') -> DMap (Const2 k v) f -> Map k v'
94−dmapToMapWith f = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, f v)) . DMap.toAscList
95−
96−-- | Convert a regular 'Map' to a 'DMap'
97−mapToDMap :: Map k v -> DMap (Const2 k v) Identity
98−mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
99−
100−-- | Convert a regular 'Map', where the values are already wrapped in a functor,
101−-- to a 'DMap'
102−mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
103−mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
104−
105−weakenDMapWith :: (forall a. v a -> v') -> DMap k v -> Map (Some k) v'
106−weakenDMapWith f = Map.fromDistinctAscList . map (\(k :=> v) -> (Some.This k, f v)) . DMap.toAscList
107−
108−--------------------------------------------------------------------------------
109−-- WrapArg
110−--------------------------------------------------------------------------------
111−
112−-- | 'WrapArg' can be used to tag a value in one functor with a type
113−-- representing another functor. This was primarily used with dependent-map <
114−-- 0.2, in which the value type was not wrapped in a separate functor.
115−data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
116− WrapArg :: f a -> WrapArg g f (g a)
117−
118−instance GEq f => GEq (WrapArg g f) where
119− geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
120−
121−instance GCompare f => GCompare (WrapArg g f) where
122− gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
123− GLT -> GLT
124− GEQ -> GEQ
125− GGT -> GGT
126−
127−--------------------------------------------------------------------------------
128−-- Convenience functions for DMap
129−--------------------------------------------------------------------------------
130−
131−-- | Map over all key/value pairs in a 'DMap', potentially altering the key as
132−-- well as the value. The provided function MUST preserve the ordering of the
133−-- keys, or the resulting 'DMap' will be malformed.
134−mapKeyValuePairsMonotonic :: (DSum k v -> DSum k' v') -> DMap k v -> DMap k' v'
135−mapKeyValuePairsMonotonic f = DMap.fromDistinctAscList . map f . DMap.toAscList
136−
137−{-# INLINE combineDMapsWithKey #-}
138−-- | Union two 'DMap's of different types, yielding another type. Each key that
139−-- is present in either input map will be present in the output.
140−combineDMapsWithKey :: forall f g h i.
141− GCompare f
142− => (forall a. f a -> These (g a) (h a) -> i a)
143− -> DMap f g
144− -> DMap f h
145− -> DMap f i
146−combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
147− where go :: [DSum f g] -> [DSum f h] -> [DSum f i]
148− go [] hs = map (\(hk :=> hv) -> hk :=> f hk (That hv)) hs
149− go gs [] = map (\(gk :=> gv) -> gk :=> f gk (This gv)) gs
150− go gs@((gk :=> gv) : gs') hs@((hk :=> hv) : hs') = case gk `gcompare` hk of
151− GLT -> (gk :=> f gk (This gv)) : go gs' hs
152− GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
153− GGT -> (hk :=> f hk (That hv)) : go gs hs'
154−
155−-- | Extract the values of a 'DMap' of 'EitherTag's.
156−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
157−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
158− (Nothing, Nothing) -> Nothing
159− (Just (Identity a), Nothing) -> Just $ This a
160− (Nothing, Just (Identity b)) -> Just $ That b
161− (Just (Identity a), Just (Identity b)) -> Just $ These a b
162−
163−-- | Tag type for 'Either' to use it as a 'DSum'.
164−data EitherTag l r a where
165− LeftTag :: EitherTag l r l
166− RightTag :: EitherTag l r r
167−
168−instance GEq (EitherTag l r) where
169− geq a b = case (a, b) of
170− (LeftTag, LeftTag) -> Just Refl
171− (RightTag, RightTag) -> Just Refl
172− _ -> Nothing
173−
174−instance GCompare (EitherTag l r) where
175− gcompare a b = case (a, b) of
176− (LeftTag, LeftTag) -> GEQ
177− (LeftTag, RightTag) -> GLT
178− (RightTag, LeftTag) -> GGT
179− (RightTag, RightTag) -> GEQ
180−
181−instance GShow (EitherTag l r) where
182− gshowsPrec _ a = case a of
183− LeftTag -> showString "LeftTag"
184− RightTag -> showString "RightTag"
185−
186−instance (Show l, Show r) => ShowTag (EitherTag l r) Identity where
187− showTaggedPrec t n (Identity a) = case t of
188− LeftTag -> showsPrec n a
189− RightTag -> showsPrec n a
190−
191−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
192−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
193−eitherToDSum = \case
194− Left a -> (LeftTag :=> Identity a)
195− Right b -> (RightTag :=> Identity b)
196−
197−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
198−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
199−dsumToEither = \case
200− (LeftTag :=> Identity a) -> Left a
201− (RightTag :=> Identity b) -> Right b
202−
203−--------------------------------------------------------------------------------
204−-- Deprecated functions
205−--------------------------------------------------------------------------------
206−
207−{-# INLINE sequenceDmap #-}
208−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ t -> fmap Identity t)' instead" #-}
209−-- | Run the actions contained in the 'DMap'
210−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
211−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
212−
213−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
214−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
215−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
216−wrapDMap f = DMap.map $ f . runIdentity
217−
218−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
219−-- | Replace one functor for a 'DMap''s values with a different functor
220−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
221−rewrapDMap = DMap.map
222−
223−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
224−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
225−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
226−unwrapDMap f = DMap.map $ Identity . f
227−
228−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
229−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
230−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
231−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
232−
233−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
234−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
235−-- underlying functor
236−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
237−extractFunctorDMap = mapKeyValuePairsMonotonic $ \(Const2 k :=> Identity v) -> Const2 k :=> v
src/Data/Map/Misc.hsnew file+71
@@ -0,0 +1,71 @@
1+{-# LANGUAGE LambdaCase #-}
2+-- | Additional functions for manipulating 'Map's.
3+module Data.Map.Misc
4+ (
5+ -- * Working with Maps
6+ diffMapNoEq
7+ , diffMap
8+ , applyMap
9+ , mapPartitionEithers
10+ , applyMapKeysSet
11+ ) where
12+
13+import Data.Align
14+import Data.Map (Map)
15+import qualified Data.Map as Map
16+import Data.Maybe
17+import Data.Set (Set)
18+import qualified Data.Set as Set
19+import Data.These
20+
21+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new@ respectively. @Just@ represents an association present in @new@ and @Nothing@
22+-- represents an association only present in @old@ but no longer present in @new@.
23+--
24+-- Similar to 'diffMap' but doesn't require 'Eq' on the values, thus can't tell if a value has changed or not.
25+diffMapNoEq :: (Ord k) => Map k v -> Map k v -> Map k (Maybe v)
26+diffMapNoEq olds news = flip Map.mapMaybe (align olds news) $ \case
27+ This _ -> Just Nothing
28+ These _ new -> Just $ Just new
29+ That new -> Just $ Just new
30+
31+-- |Produce a @'Map' k (Maybe v)@ by comparing two @'Map' k v@s, @old@ and @new respectively. @Just@ represents an association present in @new@ and either not
32+-- present in @old@ or where the value has changed. @Nothing@ represents an association only present in @old@ but no longer present in @new@.
33+--
34+-- See also 'diffMapNoEq' for a similar but weaker version which does not require 'Eq' on the values but thus can't indicated a value not changing between
35+-- @old@ and @new@ with @Nothing@.
36+diffMap :: (Ord k, Eq v) => Map k v -> Map k v -> Map k (Maybe v)
37+diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
38+ This _ -> Just Nothing
39+ These old new
40+ | old == new -> Nothing
41+ | otherwise -> Just $ Just new
42+ That new -> Just $ Just new
43+
44+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new map from the given input @'Map' k v@.
45+--
46+-- See also 'Data.Patch.Map' and 'Data.Patch.MapWithMove'.
47+applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
48+applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
49+ where (deletions, insertions) = Map.mapEither maybeToEither patch
50+ maybeToEither = \case
51+ Nothing -> Left ()
52+ Just r -> Right r
53+
54+-- |Split a @'Map' k (Either a b)@ into @Map k a@ and @Map k b@, equivalent to @'Map.mapEither' id@
55+{-# DEPRECATED mapPartitionEithers "Use 'mapEither' instead" #-}
56+mapPartitionEithers :: Map k (Either a b) -> (Map k a, Map k b)
57+mapPartitionEithers = Map.mapEither id
58+
59+-- |Given a @'Map' k (Maybe v)@ representing keys to insert/update (@Just@) or delete (@Nothing@), produce a new @'Set' k@ from the given input set.
60+--
61+-- Equivalent to:
62+--
63+-- @
64+-- applyMapKeysSet patch ('Map.keysSet' m) == 'Map.keysSet' ('applyMap' patch m)
65+-- @
66+--
67+-- but avoids the intervening @Map@ and needs no values.
68+applyMapKeysSet :: Ord k => Map k (Maybe v) -> Set k -> Set k
69+applyMapKeysSet patch old = Map.keysSet insertions `Set.union` (old `Set.difference` Map.keysSet deletions)
70+ where (insertions, deletions) = Map.partition isJust patch
71+
src/Data/WeakBag.hs+17−12
@@ -15,26 +15,29 @@ module Data.WeakBag
15 , singleton
15 , singleton
16 , insert
16 , insert
17 , traverse
17 , traverse
18+ , traverse_
18 , remove
19 , remove
20+ -- * Internal functions
21+ -- These will not always be available.
22+ , _weakBag_children --TODO: Don't export this
19 ) where
23 ) where
20
24
25+import Prelude hiding (traverse)
26+
21import Control.Exception
27import Control.Exception
22−import Control.Monad hiding (forM_, mapM_)
28+import Control.Monad
23import Control.Monad.IO.Class
29import Control.Monad.IO.Class
24−import Data.Foldable (forM_, mapM_)
25import Data.IntMap.Strict (IntMap)
30import Data.IntMap.Strict (IntMap)
26import qualified Data.IntMap.Strict as IntMap
31import qualified Data.IntMap.Strict as IntMap
27import Data.IORef
32import Data.IORef
28import System.Mem.Weak
33import System.Mem.Weak
29
34
30−import Prelude hiding (mapM_, traverse)
31−
32−-- | A @WeakBag a@ holds a set of values of type @a@, but does not retain them -
35+-- | A 'WeakBag' holds a set of values of type @/a/@, but does not retain them -
33−-- that is, they can still be garbage-collected. As long as the @a@s remain
36+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
34-- alive, the 'WeakBag' will continue to refer to them.
37-- alive, the 'WeakBag' will continue to refer to them.
35data WeakBag a = WeakBag
38data WeakBag a = WeakBag
36 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
39 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
37− , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a)))
40+ , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a))) -- ^ The items referenced by the WeakBag
38 }
41 }
39
42
40-- | When inserting an item into a 'WeakBag', a 'WeakBagTicket' is returned. If
43-- | When inserting an item into a 'WeakBag', a 'WeakBagTicket' is returned. If
@@ -69,8 +72,6 @@ insert a (WeakBag nextId children) wbRef finalizer = {-# SCC "insert" #-} do
69 let !csWithoutMe = IntMap.delete myId cs
72 let !csWithoutMe = IntMap.delete myId cs
70 in (csWithoutMe, csWithoutMe)
73 in (csWithoutMe, csWithoutMe)
71 when (IntMap.null csWithoutMe) $ finalizer b
74 when (IntMap.null csWithoutMe) $ finalizer b
72− return ()
73− return ()
74 wa <- mkWeakPtr a' $ Just cleanup
75 wa <- mkWeakPtr a' $ Just cleanup
75 atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
76 atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
76 return $ WeakBagTicket
77 return $ WeakBagTicket
@@ -99,18 +100,22 @@ singleton a wbRef finalizer = {-# SCC "singleton" #-} do
99 ticket <- insert a bag wbRef finalizer
100 ticket <- insert a bag wbRef finalizer
100 return (bag, ticket)
101 return (bag, ticket)
101
102
102−{-# INLINE traverse #-}
103+{-# INLINE traverse_ #-}
103-- | Visit every node in the given list. If new nodes are appended during the
104-- | Visit every node in the given list. If new nodes are appended during the
104-- traversal, they will not be visited. Every live node that was in the list
105-- traversal, they will not be visited. Every live node that was in the list
105-- when the traversal began will be visited exactly once; however, no guarantee
106-- when the traversal began will be visited exactly once; however, no guarantee
106-- is made about the order of the traversal.
107-- is made about the order of the traversal.
107−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
108+traverse_ :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
108−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
109+traverse_ (WeakBag _ children) f = {-# SCC "traverse" #-} do
109 cs <- liftIO $ readIORef children
110 cs <- liftIO $ readIORef children
110 forM_ cs $ \c -> do
111 forM_ cs $ \c -> do
111 ma <- liftIO $ deRefWeak c
112 ma <- liftIO $ deRefWeak c
112 mapM_ f ma
113 mapM_ f ma
113
114
115+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
116+traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
117+traverse = traverse_
118+
114-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
119-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
115-- on the same 'WeakBagTicket'.
120-- on the same 'WeakBagTicket'.
116{-# INLINE remove #-}
121{-# INLINE remove #-}
src/Reflex.hs+13−2
@@ -6,19 +6,30 @@ module Reflex
6 ) where
6 ) where
7
7
8import Reflex.Class as X
8import Reflex.Class as X
9−import Reflex.EventWriter as X
9+import Reflex.Adjustable.Class as X
10+import Reflex.BehaviorWriter.Base as X
11+import Reflex.BehaviorWriter.Class as X
12+import Reflex.Collection as X
10import Reflex.Dynamic as X
13import Reflex.Dynamic as X
14+import Reflex.EventWriter.Base as X
15+import Reflex.EventWriter.Class as X
11#ifdef USE_TEMPLATE_HASKELL
16#ifdef USE_TEMPLATE_HASKELL
12import Reflex.Dynamic.TH as X
17import Reflex.Dynamic.TH as X
13#endif
18#endif
14import Reflex.Dynamic.Uniq as X
19import Reflex.Dynamic.Uniq as X
15−import Reflex.DynamicWriter as X
20+import Reflex.DynamicWriter.Base as X
21+import Reflex.DynamicWriter.Class as X
22+import Reflex.NotReady.Class as X
16import Reflex.PerformEvent.Base as X
23import Reflex.PerformEvent.Base as X
17import Reflex.PerformEvent.Class as X
24import Reflex.PerformEvent.Class as X
18import Reflex.PostBuild.Base as X
25import Reflex.PostBuild.Base as X
19import Reflex.PostBuild.Class as X
26import Reflex.PostBuild.Class as X
27+import Reflex.Profiled as X
28+import Reflex.Query.Base as X
29+import Reflex.Query.Class as X
20import Reflex.Requester.Base as X
30import Reflex.Requester.Base as X
21import Reflex.Requester.Class as X
31import Reflex.Requester.Class as X
22import Reflex.Spider as X
32import Reflex.Spider as X
33+import Reflex.Time as X
23import Reflex.TriggerEvent.Base as X
34import Reflex.TriggerEvent.Base as X
24import Reflex.TriggerEvent.Class as X
35import Reflex.TriggerEvent.Class as X
src/Reflex/Adjustable/Class.hsnew file+140
@@ -0,0 +1,140 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE FunctionalDependencies #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+#ifdef USE_REFLEX_OPTIMIZER
11+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12+#endif
13+-- |
14+-- Module:
15+-- Reflex.Adjustable.Class
16+-- Description:
17+-- A class for actions that can be "adjusted" over time based on some 'Event'
18+-- such that, when observed after the firing of any such 'Event', the result
19+-- is as though the action was originally run with the 'Event's value.
20+module Reflex.Adjustable.Class
21+ (
22+ -- * The Adjustable typeclass
23+ Adjustable(..)
24+ , sequenceDMapWithAdjust
25+ , sequenceDMapWithAdjustWithMove
26+ , mapMapWithAdjustWithMove
27+ -- * Deprecated aliases
28+ , MonadAdjust
29+ ) where
30+
31+import Control.Monad.Identity
32+import Control.Monad.Reader
33+import Data.Dependent.Map (DMap)
34+import Data.GADT.Compare (GCompare(..))
35+import qualified Data.Dependent.Map as DMap
36+import Data.Functor.Constant
37+import Data.Functor.Misc
38+import Data.IntMap.Strict (IntMap)
39+import qualified Data.IntMap.Strict as IntMap
40+import Data.Map (Map)
41+
42+import Reflex.Class
43+import Data.Patch.DMapWithMove
44+
45+-- | A 'Monad' that supports adjustment over time. After an action has been
46+-- run, if the given events fire, it will adjust itself so that its net effect
47+-- is as though it had originally been run with the new value. Note that there
48+-- is some issue here with persistent side-effects: obviously, IO (and some
49+-- other side-effects) cannot be undone, so it is up to the instance implementer
50+-- to determine what the best meaning for this class is in such cases.
51+class (Reflex t, Monad m) => Adjustable t m | m -> t where
52+ runWithReplace
53+ :: m a
54+ -> Event t (m b)
55+ -> m (a, Event t b)
56+
57+ traverseIntMapWithKeyWithAdjust
58+ :: (IntMap.Key -> v -> m v')
59+ -> IntMap v
60+ -> Event t (PatchIntMap v)
61+ -> m (IntMap v', Event t (PatchIntMap v'))
62+
63+ traverseDMapWithKeyWithAdjust
64+ :: GCompare k
65+ => (forall a. k a -> v a -> m (v' a))
66+ -> DMap k v
67+ -> Event t (PatchDMap k v)
68+ -> m (DMap k v', Event t (PatchDMap k v'))
69+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
70+ traverseDMapWithKeyWithAdjust f dm0 dm' = fmap (fmap (fmap fromPatchWithMove)) $
71+ traverseDMapWithKeyWithAdjustWithMove f dm0 $ fmap toPatchWithMove dm'
72+ where
73+ toPatchWithMove (PatchDMap m) = PatchDMapWithMove $ DMap.map toNodeInfoWithMove m
74+ toNodeInfoWithMove = \case
75+ ComposeMaybe (Just v) -> NodeInfo (From_Insert v) $ ComposeMaybe Nothing
76+ ComposeMaybe Nothing -> NodeInfo From_Delete $ ComposeMaybe Nothing
77+ fromPatchWithMove (PatchDMapWithMove m) = PatchDMap $ DMap.map fromNodeInfoWithMove m
78+ fromNodeInfoWithMove (NodeInfo from _) = ComposeMaybe $ case from of
79+ From_Insert v -> Just v
80+ From_Delete -> Nothing
81+ From_Move _ -> error "traverseDMapWithKeyWithAdjust: implementation of traverseDMapWithKeyWithAdjustWithMove inserted spurious move"
82+
83+ traverseDMapWithKeyWithAdjustWithMove
84+ :: GCompare k
85+ => (forall a. k a -> v a -> m (v' a))
86+ -> DMap k v
87+ -> Event t (PatchDMapWithMove k v)
88+ -> m (DMap k v', Event t (PatchDMapWithMove k v'))
89+
90+instance Adjustable t m => Adjustable t (ReaderT r m) where
91+ runWithReplace a0 a' = do
92+ r <- ask
93+ lift $ runWithReplace (runReaderT a0 r) $ fmap (`runReaderT` r) a'
94+ traverseIntMapWithKeyWithAdjust f dm0 dm' = do
95+ r <- ask
96+ lift $ traverseIntMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
97+ traverseDMapWithKeyWithAdjust f dm0 dm' = do
98+ r <- ask
99+ lift $ traverseDMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
100+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
101+ r <- ask
102+ lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
103+
104+-- | Traverse a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
105+-- to the 'DMap' can add, remove, or update values.
106+sequenceDMapWithAdjust
107+ :: (GCompare k, Adjustable t m)
108+ => DMap k m
109+ -> Event t (PatchDMap k m)
110+ -> m (DMap k Identity, Event t (PatchDMap k Identity))
111+sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
112+
113+-- | Traverses a 'DMap' of 'Adjustable' actions, running each of them. The provided 'Event' of patches
114+-- to the 'DMap' can add, remove, update, move, or swap values.
115+sequenceDMapWithAdjustWithMove
116+ :: (GCompare k, Adjustable t m)
117+ => DMap k m
118+ -> Event t (PatchDMapWithMove k m)
119+ -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
120+sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
121+
122+-- | Traverses a 'Map', running the provided 'Adjustable' action. The provided 'Event' of patches to the 'Map'
123+-- can add, remove, update, move, or swap values.
124+mapMapWithAdjustWithMove
125+ :: forall t m k v v'. (Adjustable t m, Ord k)
126+ => (k -> v -> m v')
127+ -> Map k v
128+ -> Event t (PatchMapWithMove k v)
129+ -> m (Map k v', Event t (PatchMapWithMove k v'))
130+mapMapWithAdjustWithMove f m0 m' = do
131+ (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
132+ return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
133+
134+--------------------------------------------------------------------------------
135+-- Deprecated functions
136+--------------------------------------------------------------------------------
137+
138+{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
139+-- | Synonym for 'Adjustable'
140+type MonadAdjust = Adjustable
src/Reflex/BehaviorWriter/Base.hsnew file+211
@@ -0,0 +1,211 @@
1+{-|
2+Module: Reflex.BehaviorWriter.Base
3+Description: Implementation of BehaviorWriter
4+-}
5+{-# LANGUAGE CPP #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE GADTs #-}
8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE RankNTypes #-}
11+{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE TypeFamilies #-}
13+{-# LANGUAGE UndecidableInstances #-}
14+{-# LANGUAGE StandaloneDeriving #-}
15+#ifdef USE_REFLEX_OPTIMIZER
16+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
17+#endif
18+module Reflex.BehaviorWriter.Base
19+ ( BehaviorWriterT (..)
20+ , runBehaviorWriterT
21+ , withBehaviorWriterT
22+ ) where
23+
24+import Control.Monad.Exception
25+import Control.Monad.Identity
26+import Control.Monad.IO.Class
27+import Control.Monad.Morph
28+import Control.Monad.Reader
29+import Control.Monad.Ref
30+import Control.Monad.State.Strict
31+import Data.Dependent.Map (DMap)
32+import qualified Data.Dependent.Map as DMap
33+import Data.Functor.Misc
34+import Data.IntMap (IntMap)
35+import qualified Data.IntMap as IntMap
36+import Data.Map (Map)
37+import qualified Data.Map as Map
38+import Data.Some (Some)
39+
40+import Reflex.Class
41+import Reflex.Adjustable.Class
42+import Reflex.BehaviorWriter.Class
43+import Reflex.Host.Class
44+import Reflex.PerformEvent.Class
45+import Reflex.PostBuild.Class
46+import Reflex.Query.Class
47+import Reflex.Requester.Class
48+import Reflex.TriggerEvent.Class
49+
50+-- | A basic implementation of 'BehaviorWriter'.
51+newtype BehaviorWriterT t w m a = BehaviorWriterT { unBehaviorWriterT :: StateT [Behavior t w] m a }
52+ -- The list is kept in reverse order
53+ deriving
54+ ( Functor
55+ , Applicative
56+ , Monad
57+ , MonadTrans
58+ , MFunctor
59+ , MonadIO
60+ , MonadFix
61+ , MonadAsyncException
62+ , MonadException
63+ )
64+
65+-- | Run a 'BehaviorWriterT' action. The behavior writer output will be provided
66+-- along with the result of the action.
67+runBehaviorWriterT :: (Monad m, Reflex t, Monoid w) => BehaviorWriterT t w m a -> m (a, Behavior t w)
68+runBehaviorWriterT (BehaviorWriterT a) = do
69+ (result, ws) <- runStateT a []
70+ return (result, mconcat $ reverse ws)
71+
72+-- | Map a function over the output of a 'BehaviorWriterT'.
73+withBehaviorWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m)
74+ => (w -> w')
75+ -> BehaviorWriterT t w m a
76+ -> BehaviorWriterT t w' m a
77+withBehaviorWriterT f dw = do
78+ (r, d) <- lift $ do
79+ (r, d) <- runBehaviorWriterT dw
80+ let d' = fmap f d
81+ return (r, d')
82+ tellBehavior d
83+ return r
84+
85+deriving instance MonadHold t m => MonadHold t (BehaviorWriterT t w m)
86+deriving instance MonadSample t m => MonadSample t (BehaviorWriterT t w m)
87+
88+instance MonadRef m => MonadRef (BehaviorWriterT t w m) where
89+ type Ref (BehaviorWriterT t w m) = Ref m
90+ newRef = lift . newRef
91+ readRef = lift . readRef
92+ writeRef r = lift . writeRef r
93+
94+instance MonadAtomicRef m => MonadAtomicRef (BehaviorWriterT t w m) where
95+ atomicModifyRef r = lift . atomicModifyRef r
96+
97+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (BehaviorWriterT t w m) where
98+ newEventWithTrigger = lift . newEventWithTrigger
99+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
100+
101+instance (Monad m, Monoid w, Reflex t) => BehaviorWriter t w (BehaviorWriterT t w m) where
102+ tellBehavior w = BehaviorWriterT $ modify (w :)
103+
104+instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
105+ ask = lift ask
106+ local f (BehaviorWriterT a) = BehaviorWriterT $ mapStateT (local f) a
107+ reader = lift . reader
108+
109+instance PerformEvent t m => PerformEvent t (BehaviorWriterT t w m) where
110+ type Performable (BehaviorWriterT t w m) = Performable m
111+ performEvent_ = lift . performEvent_
112+ performEvent = lift . performEvent
113+
114+instance TriggerEvent t m => TriggerEvent t (BehaviorWriterT t w m) where
115+ newTriggerEvent = lift newTriggerEvent
116+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
117+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
118+
119+instance PostBuild t m => PostBuild t (BehaviorWriterT t w m) where
120+ getPostBuild = lift getPostBuild
121+
122+instance MonadState s m => MonadState s (BehaviorWriterT t w m) where
123+ get = lift get
124+ put = lift . put
125+
126+instance Requester t m => Requester t (BehaviorWriterT t w m) where
127+ type Request (BehaviorWriterT t w m) = Request m
128+ type Response (BehaviorWriterT t w m) = Response m
129+ requesting = lift . requesting
130+ requesting_ = lift . requesting_
131+
132+instance (MonadQuery t q m, Monad m) => MonadQuery t q (BehaviorWriterT t w m) where
133+ tellQueryIncremental = lift . tellQueryIncremental
134+ askQueryResult = lift askQueryResult
135+ queryIncremental = lift . queryIncremental
136+
137+instance (Adjustable t m, Monoid w, MonadHold t m, Reflex t) => Adjustable t (BehaviorWriterT t w m) where
138+ runWithReplace a0 a' = do
139+ (result0, result') <- lift $ runWithReplace (runBehaviorWriterT a0) $ runBehaviorWriterT <$> a'
140+ tellBehavior . join =<< hold (snd result0) (snd <$> result')
141+ return (fst result0, fst <$> result')
142+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustImpl traverseIntMapWithKeyWithAdjust
143+ traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith
144+
145+traverseIntMapWithKeyWithAdjustImpl
146+ :: forall t w v' p p' v m.
147+ ( PatchTarget (p' (Behavior t w)) ~ IntMap (Behavior t w)
148+ , Patch (p' (Behavior t w))
149+ , Monoid w
150+ , Reflex t
151+ , MonadHold t m
152+ , Functor p
153+ , p ~ p'
154+ )
155+ => ( (IntMap.Key -> v -> m (v', Behavior t w))
156+ -> IntMap v
157+ -> Event t (p v)
158+ -> m (IntMap (v', Behavior t w), Event t (p (v', Behavior t w)))
159+ )
160+ -> (IntMap.Key -> v -> BehaviorWriterT t w m v')
161+ -> IntMap v
162+ -> Event t (p v)
163+ -> BehaviorWriterT t w m (IntMap v', Event t (p v'))
164+traverseIntMapWithKeyWithAdjustImpl base f (dm0 :: IntMap v) dm' = do
165+ (result0, result') <- lift $ base (\k v -> runBehaviorWriterT $ f k v) dm0 dm'
166+ let liftedResult0 = fmap fst result0
167+ liftedResult' = fmap (fmap fst) result'
168+ liftedWritten0 :: IntMap (Behavior t w)
169+ liftedWritten0 = fmap snd result0
170+ liftedWritten' = fmap (fmap snd) result'
171+ i <- holdIncremental liftedWritten0 liftedWritten'
172+ tellBehavior $ pull $ do
173+ m <- sample $ currentIncremental i
174+ mconcat . IntMap.elems <$> traverse sample m
175+ return (liftedResult0, liftedResult')
176+
177+newtype BehaviorWriterTLoweredResult t w v a = BehaviorWriterTLoweredResult (v a, Behavior t w)
178+
179+traverseDMapWithKeyWithAdjustImpl
180+ :: forall t w k v' p p' v m.
181+ ( PatchTarget (p' (Some k) (Behavior t w)) ~ Map (Some k) (Behavior t w)
182+ , Patch (p' (Some k) (Behavior t w))
183+ , Monoid w
184+ , Reflex t
185+ , MonadHold t m
186+ )
187+ => ( (forall a. k a -> v a -> m (BehaviorWriterTLoweredResult t w v' a))
188+ -> DMap k v
189+ -> Event t (p k v)
190+ -> m (DMap k (BehaviorWriterTLoweredResult t w v'), Event t (p k (BehaviorWriterTLoweredResult t w v')))
191+ )
192+ -> ((forall a. BehaviorWriterTLoweredResult t w v' a -> v' a) -> p k (BehaviorWriterTLoweredResult t w v') -> p k v')
193+ -> ((forall a. BehaviorWriterTLoweredResult t w v' a -> Behavior t w) -> p k (BehaviorWriterTLoweredResult t w v') -> p' (Some k) (Behavior t w))
194+ -> (forall a. k a -> v a -> BehaviorWriterT t w m (v' a))
195+ -> DMap k v
196+ -> Event t (p k v)
197+ -> BehaviorWriterT t w m (DMap k v', Event t (p k v'))
198+traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith f (dm0 :: DMap k v) dm' = do
199+ (result0, result') <- lift $ base (\k v -> fmap BehaviorWriterTLoweredResult $ runBehaviorWriterT $ f k v) dm0 dm'
200+ let getValue (BehaviorWriterTLoweredResult (v, _)) = v
201+ getWritten (BehaviorWriterTLoweredResult (_, w)) = w
202+ liftedResult0 = DMap.map getValue result0
203+ liftedResult' = ffor result' $ mapPatch getValue
204+ liftedWritten0 :: Map (Some k) (Behavior t w)
205+ liftedWritten0 = weakenDMapWith getWritten result0
206+ liftedWritten' = ffor result' $ weakenPatchWith getWritten
207+ i <- holdIncremental liftedWritten0 liftedWritten'
208+ tellBehavior $ pull $ do
209+ m <- sample $ currentIncremental i
210+ mconcat . Map.elems <$> traverse sample m
211+ return (liftedResult0, liftedResult')
src/Reflex/BehaviorWriter/Class.hsnew file+31
@@ -0,0 +1,31 @@
1+{-|
2+Module: Reflex.BehaviorWriter.Class
3+Description: This module defines the 'BehaviorWriter' class
4+-}
5+{-# LANGUAGE CPP #-}
6+{-# LANGUAGE ConstraintKinds #-}
7+{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE FunctionalDependencies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+#ifdef USE_REFLEX_OPTIMIZER
11+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12+#endif
13+module Reflex.BehaviorWriter.Class
14+ ( MonadBehaviorWriter
15+ , BehaviorWriter(..)
16+ ) where
17+
18+import Control.Monad.Reader (ReaderT, lift)
19+import Reflex.Class (Behavior)
20+
21+{-# DEPRECATED MonadBehaviorWriter "Use 'BehaviorWriter' instead" #-}
22+-- | Type synonym for 'BehaviorWriter'
23+type MonadBehaviorWriter = BehaviorWriter
24+
25+-- | 'BehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
26+-- and combines them monoidally to provide a 'Behavior' result.
27+class (Monad m, Monoid w) => BehaviorWriter t w m | m -> t w where
28+ tellBehavior :: Behavior t w -> m ()
29+
30+instance BehaviorWriter t w m => BehaviorWriter t w (ReaderT r m) where
31+ tellBehavior = lift . tellBehavior
src/Reflex/Class.hs+1026−340
@@ -1,11 +1,14 @@
1+{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
3+{-# LANGUAGE ConstraintKinds #-}
4+{-# LANGUAGE DefaultSignatures #-}
2{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
7{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE GADTs #-}
8{-# LANGUAGE GADTs #-}
6{-# LANGUAGE LambdaCase #-}
9{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE NoMonomorphismRestriction #-}
10{-# LANGUAGE NoMonomorphismRestriction #-}
11+{-# LANGUAGE PolyKinds #-}
9{-# LANGUAGE RankNTypes #-}
12{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE RecursiveDo #-}
13{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE RoleAnnotations #-}
14{-# LANGUAGE RoleAnnotations #-}
@@ -13,42 +16,56 @@
13{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE TypeFamilies #-}
14{-# LANGUAGE TypeOperators #-}
17{-# LANGUAGE TypeOperators #-}
15{-# LANGUAGE UndecidableInstances #-}
18{-# LANGUAGE UndecidableInstances #-}
19+{-# LANGUAGE Trustworthy #-}
16#ifdef USE_REFLEX_OPTIMIZER
20#ifdef USE_REFLEX_OPTIMIZER
17{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
21{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
18#endif
22#endif
19−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
20−{-# LANGUAGE EmptyDataDecls #-}
21−{-# OPTIONS_GHC -Wno-redundant-constraints #-}
22−#endif
23
23
24+-- |
25+-- Module:
26+-- Reflex.Class
27+-- Description:
24−-- | This module contains the Reflex interface, as well as a variety of
28+-- This module contains the Reflex interface, as well as a variety of
25−-- convenience functions for working with 'Event's, 'Behavior's, and other
29+-- convenience functions for working with 'Event's, 'Behavior's, and other
26−-- signals.
30+-- signals.
27module Reflex.Class
31module Reflex.Class
28− ( module Reflex.Patch
32+ ( module Data.Patch
29 -- * Primitives
33 -- * Primitives
30 , Reflex (..)
34 , Reflex (..)
35+ , mergeInt
31 , coerceBehavior
36 , coerceBehavior
32 , coerceEvent
37 , coerceEvent
33 , coerceDynamic
38 , coerceDynamic
39+ , coerceIncremental
34 , MonadSample (..)
40 , MonadSample (..)
35 , MonadHold (..)
41 , MonadHold (..)
36− -- ** 'fan'-related types
42+ -- ** 'fan' related types
37 , EventSelector (..)
43 , EventSelector (..)
38− -- ** 'Incremental'-related types
44+ , EventSelectorG (..)
45+ , EventSelectorInt (..)
39 -- * Convenience functions
46 -- * Convenience functions
40 , constDyn
47 , constDyn
41 , pushAlways
48 , pushAlways
42 -- ** Combining 'Event's
49 -- ** Combining 'Event's
43 , leftmost
50 , leftmost
51+ , merge
52+ , mergeIncremental
53+ , mergeIncrementalWithMove
44 , mergeMap
54 , mergeMap
55+ , mergeIntMap
45 , mergeMapIncremental
56 , mergeMapIncremental
46 , mergeMapIncrementalWithMove
57 , mergeMapIncrementalWithMove
58+ , mergeIntMapIncremental
59+ , coincidencePatchMap
60+ , coincidencePatchMapWithMove
61+ , coincidencePatchIntMap
47 , mergeList
62 , mergeList
48 , mergeWith
63 , mergeWith
49 , difference
64 , difference
65+ , alignEventWithMaybe
50 -- ** Breaking up 'Event's
66 -- ** Breaking up 'Event's
51 , splitE
67 , splitE
68+ , fan
52 , fanEither
69 , fanEither
53 , fanThese
70 , fanThese
54 , fanMap
71 , fanMap
@@ -56,11 +73,16 @@ module Reflex.Class
56 , EitherTag (..)
73 , EitherTag (..)
57 , eitherToDSum
74 , eitherToDSum
58 , dsumToEither
75 , dsumToEither
59− -- ** Switching between 'Event's
76+ , factorEvent
60− , switchPromptly
77+ , filterEventKey
61− , switchPromptOnly
78+ -- ** Collapsing 'Event . Event'
79+ , switchHold
80+ , switchHoldPromptly
81+ , switchHoldPromptOnly
82+ , switchHoldPromptOnlyIncremental
62 -- ** Using 'Event's to sample 'Behavior's
83 -- ** Using 'Event's to sample 'Behavior's
63 , tag
84 , tag
85+ , tagMaybe
64 , attach
86 , attach
65 , attachWith
87 , attachWith
66 , attachWithMaybe
88 , attachWithMaybe
@@ -68,20 +90,53 @@ module Reflex.Class
68 , gate
90 , gate
69 -- ** Combining 'Dynamic's
91 -- ** Combining 'Dynamic's
70 , distributeDMapOverDynPure
92 , distributeDMapOverDynPure
93+ , distributeDMapOverDynPureG
71 , distributeListOverDyn
94 , distributeListOverDyn
72 , distributeListOverDynWith
95 , distributeListOverDynWith
73 , zipDyn
96 , zipDyn
74 , zipDynWith
97 , zipDynWith
75 -- ** Accumulating state
98 -- ** Accumulating state
76 , Accumulator (..)
99 , Accumulator (..)
100+ , accumDyn
101+ , accumMDyn
102+ , accumMaybeDyn
103+ , accumMaybeMDyn
104+ , mapAccumDyn
105+ , mapAccumMDyn
106+ , mapAccumMaybeDyn
107+ , mapAccumMaybeMDyn
108+ , accumB
109+ , accumMB
110+ , accumMaybeB
111+ , accumMaybeMB
112+ , mapAccumB
113+ , mapAccumMB
114+ , mapAccumMaybeB
115+ , mapAccumMaybeMB
77 , mapAccum_
116 , mapAccum_
78 , mapAccumM_
117 , mapAccumM_
79 , mapAccumMaybe_
118 , mapAccumMaybe_
80 , mapAccumMaybeM_
119 , mapAccumMaybeM_
120+ , accumIncremental
121+ , accumMIncremental
122+ , accumMaybeIncremental
123+ , accumMaybeMIncremental
124+ , mapAccumIncremental
125+ , mapAccumMIncremental
126+ , mapAccumMaybeIncremental
127+ , mapAccumMaybeMIncremental
81 , zipListWithEvent
128 , zipListWithEvent
82− , headE
129+ , numberOccurrences
130+ , numberOccurrencesFrom
131+ , numberOccurrencesFrom_
132+ , (<@>)
133+ , (<@)
83 , tailE
134 , tailE
84 , headTailE
135 , headTailE
136+ , takeWhileE
137+ , takeWhileJustE
138+ , dropWhileE
139+ , takeDropWhileJustE
85 , switcher
140 , switcher
86 -- * Debugging functions
141 -- * Debugging functions
87 , traceEvent
142 , traceEvent
@@ -89,21 +144,24 @@ module Reflex.Class
89 -- * Unsafe functions
144 -- * Unsafe functions
90 , unsafeDynamic
145 , unsafeDynamic
91 , unsafeMapIncremental
146 , unsafeMapIncremental
92− -- * 'FunctorMaybe'
147+ -- * 'Filterable' convenience functions
93− , FunctorMaybe (..)
148+ , FunctorMaybe -- fmapMaybe is purposely not exported from deprecated 'FunctorMaybe' and the new alias is exported instead
149+ , mapMaybe -- Re-exported for convenience
150+ , fmapMaybe
94 , fforMaybe
151 , fforMaybe
95 , ffilter
152 , ffilter
153+ , filterLeft
154+ , filterRight
96 -- * Miscellaneous convenience functions
155 -- * Miscellaneous convenience functions
97 , ffor
156 , ffor
98− , MonadAdjust (..)
157+ , ffor2
99− , sequenceDMapWithAdjust
158+ , ffor3
100− , sequenceDMapWithAdjustWithMove
101− , mapMapWithAdjustWithMove
102 -- * Deprecated functions
159 -- * Deprecated functions
103− , appendEvents
160+ , switchPromptly
104− , onceE
161+ , switchPromptOnly
105− , sequenceThese
162+ -- * "Cheap" functions
106 , fmapMaybeCheap
163 , fmapMaybeCheap
164+ , mapMaybeCheap
107 , fmapCheap
165 , fmapCheap
108 , fforCheap
166 , fforCheap
109 , fforMaybeCheap
167 , fforMaybeCheap
@@ -111,93 +169,65 @@ module Reflex.Class
111 , tagCheap
169 , tagCheap
112 , mergeWithCheap
170 , mergeWithCheap
113 , mergeWithCheap'
171 , mergeWithCheap'
114−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
172+ -- * Slow, but general, implementations
115− , Spider
173+ , slowHeadE
116− , SpiderEnv
117− , SpiderTimeline
118− , Global
119− , Behavior (..)
120− , Event (..)
121− , Dynamic (..)
122− , Incremental (..)
123− , never
124− , constant
125− , push
126− , pushCheap
127− , pull
128− , merge
129− , fan
130− , switch
131− , coincidence
132− , current
133− , updated
134− , unsafeBuildDynamic
135− , unsafeBuildIncremental
136− , mergeIncremental
137− , currentIncremental
138− , updatedIncremental
139− , incrementalToDynamic
140− , behaviorCoercion
141− , eventCoercion
142− , dynamicCoercion
143−#endif
144 ) where
174 ) where
145
175
176+#ifdef MIN_VERSION_semialign
177+import Prelude hiding (zip, zipWith)
178+
179+#if MIN_VERSION_these(0,8,0)
180+import Data.These.Combinators (justThese)
181+#endif
182+#if MIN_VERSION_semialign(1,1,0)
183+import Data.Zip (Zip (..), Unzip (..))
184+#endif
185+#endif
186+
146import Control.Applicative
187import Control.Applicative
147−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
188+import Control.Monad.Identity
148−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
189+import Control.Monad.Reader
149−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
190+import Control.Monad.State.Strict
150−import Control.Monad.Trans.Cont (ContT ())
191+import Control.Monad.Trans.Cont (ContT)
151−import Control.Monad.Trans.Except (ExceptT ())
192+import Control.Monad.Trans.Except (ExceptT)
152−import Control.Monad.Trans.RWS (RWST ())
193+import Control.Monad.Trans.RWS (RWST)
153−import Control.Monad.Trans.Writer (WriterT ())
194+import Control.Monad.Trans.Writer (WriterT)
154import Data.Align
195import Data.Align
155import Data.Bifunctor
196import Data.Bifunctor
156import Data.Coerce
197import Data.Coerce
157import Data.Default
198import Data.Default
158−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
199+import Data.Dependent.Map (DMap)
200+import Data.Dependent.Sum (DSum (..))
159import qualified Data.Dependent.Map as DMap
201import qualified Data.Dependent.Map as DMap
160−import Data.Either
202+import Data.Functor.Compose
203+import Data.Functor.Product
204+import Data.GADT.Compare (GEq (..), GCompare (..))
205+import Data.FastMutableIntMap (PatchIntMap)
161import Data.Foldable
206import Data.Foldable
162−import Data.Functor.Bind hiding (join)
207+import Data.Functor.Bind
163−import qualified Data.Functor.Bind as Bind
164−import Data.Functor.Constant
165import Data.Functor.Misc
208import Data.Functor.Misc
166import Data.Functor.Plus
209import Data.Functor.Plus
210+import Data.IntMap.Strict (IntMap)
211+import qualified Data.IntMap.Strict as IntMap
167import Data.List.NonEmpty (NonEmpty (..))
212import Data.List.NonEmpty (NonEmpty (..))
168import Data.Map (Map)
213import Data.Map (Map)
169−import Data.Maybe
214+import Data.Semigroup (Semigroup (..))
170−import Data.Monoid hiding (Alt, (<>))
215+import Data.Some (Some(Some))
171−import Data.Semigroup (Semigroup, sconcat, stimes, (<>))
172import Data.String
216import Data.String
173import Data.These
217import Data.These
174−import Data.Traversable
175import Data.Type.Coercion
218import Data.Type.Coercion
176−import Reflex.FunctorMaybe
219+import Data.Type.Equality ((:~:) (..))
177−import Reflex.Patch
220+import Data.Witherable (Filterable(..))
178−
221+import qualified Data.Witherable as W
179−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
222+import Reflex.FunctorMaybe (FunctorMaybe)
180−import Reflex.Spider.Internal (EventM, Global, HasSpiderTimeline, SpiderHost (..), SpiderHostFrame (..),
181− SpiderPullM, SpiderPushM (..), behaviorHoldIdentity, dynamicConst,
182− dynamicCurrent, dynamicDynIdentity, dynamicHold, dynamicHoldIdentity,
183− dynamicUpdated, newMapDyn, readBehaviorTracked, readBehaviorUntracked,
184− runFrame, runSpiderHostFrame, unsafeDyn)
185−import qualified Reflex.Spider.Internal
223+import qualified Reflex.FunctorMaybe
186−import qualified Reflex.Spider.Internal as S
224+import Data.Patch
187−import Unsafe.Coerce
225+import qualified Data.Patch.MapWithMove as PatchMapWithMove
188−#endif
189−
190−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
191−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
192
226
193import Debug.Trace (trace)
227import Debug.Trace (trace)
194
228
195−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
196−#include "Spider/SpiderTimeline.include.hs"
197−#endif
198−
199-- | The 'Reflex' class contains all the primitive functionality needed for
229-- | The 'Reflex' class contains all the primitive functionality needed for
200−-- Functional Reactive Programming (FRP). The @t@ type parameter indicates
230+-- Functional Reactive Programming (FRP). The @/t/@ type parameter indicates
201-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
231-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
202-- and the type of the timeline determines the FRP engine to be used. For most
232-- and the type of the timeline determines the FRP engine to be used. For most
203-- purposes, the 'Reflex.Spider' implementation is recommended.
233-- purposes, the 'Reflex.Spider' implementation is recommended.
@@ -207,9 +237,6 @@ class ( MonadHold t (PushM t)
207 , Functor (Dynamic t)
237 , Functor (Dynamic t)
208 , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
238 , Applicative (Dynamic t) -- Necessary for GHC <= 7.8
209 , Monad (Dynamic t)
239 , Monad (Dynamic t)
210−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
211− , t ~ SpiderTimeline Global
212−#endif
213 ) => Reflex t where
240 ) => Reflex t where
214 -- | A container for a value that can change over time. 'Behavior's can be
241 -- | A container for a value that can change over time. 'Behavior's can be
215 -- sampled at will, but it is not possible to be notified when they change
242 -- sampled at will, but it is not possible to be notified when they change
@@ -232,7 +259,6 @@ class ( MonadHold t (PushM t)
232 type PushM t :: * -> *
259 type PushM t :: * -> *
233 -- | A monad for doing complex pull-based calculations efficiently
260 -- | A monad for doing complex pull-based calculations efficiently
234 type PullM t :: * -> *
261 type PullM t :: * -> *
235−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
236 -- | An 'Event' with no occurrences
262 -- | An 'Event' with no occurrences
237 never :: Event t a
263 never :: Event t a
238 -- | Create a 'Behavior' that always has the given value
264 -- | Create a 'Behavior' that always has the given value
@@ -247,18 +273,23 @@ class ( MonadHold t (PushM t)
247 -- recomputed whenever any of the read 'Behavior's changes
273 -- recomputed whenever any of the read 'Behavior's changes
248 pull :: PullM t a -> Behavior t a
274 pull :: PullM t a -> Behavior t a
249 -- | Merge a collection of events; the resulting 'Event' will only occur if at
275 -- | Merge a collection of events; the resulting 'Event' will only occur if at
250− -- least one input event is occuring, and will contain all of the input keys
276+ -- least one input event is occurring, and will contain all of the input keys
251 -- that are occurring simultaneously
277 -- that are occurring simultaneously
278+
252− merge :: GCompare k => DMap k (Event t) -> Event t (DMap k Identity) --TODO: Generalize to get rid of DMap use --TODO: Provide a type-level guarantee that the result is not empty
279+ --TODO: Generalize to get rid of DMap use --TODO: Provide a type-level guarantee that the result is not empty
280+ mergeG :: GCompare k => (forall a. q a -> Event t (v a))
281+ -> DMap k q -> Event t (DMap k v)
282+
253− -- | Efficiently fan-out an event to many destinations. This function should
283+ -- | Efficiently fan-out an event to many destinations. You should save the
254− -- be partially applied, and then the result applied repeatedly to create
284+ -- result in a @let@-binding, and then repeatedly 'selectG' on the result to
255− -- child events
285+ -- create child events
256− fan :: GCompare k => Event t (DMap k Identity) -> EventSelector t k --TODO: Can we help enforce the partial application discipline here? The combinator is worthless without it
286+ fanG :: GCompare k => Event t (DMap k v) -> EventSelectorG t k v
287+
257 -- | Create an 'Event' that will occur whenever the currently-selected input
288 -- | Create an 'Event' that will occur whenever the currently-selected input
258 -- 'Event' occurs
289 -- 'Event' occurs
259 switch :: Behavior t (Event t a) -> Event t a
290 switch :: Behavior t (Event t a) -> Event t a
260− -- | Create an 'Event' that will occur whenever the input event is occurring
291+ -- | Create an 'Event' that will occur whenever the input event is occurring -- and its occurrence value, another 'Event', is also occurring.
261− -- and its occurrence value, another 'Event', is also occurring
292+ -- You maybe looking for '@switchHold@ @never@' instead.
262 coincidence :: Event t (Event t a) -> Event t a
293 coincidence :: Event t (Event t a) -> Event t a
263 -- | Extract the 'Behavior' of a 'Dynamic'.
294 -- | Extract the 'Behavior' of a 'Dynamic'.
264 current :: Dynamic t a -> Behavior t a
295 current :: Dynamic t a -> Behavior t a
@@ -267,14 +298,19 @@ class ( MonadHold t (PushM t)
267 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
298 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
268 -- recent firing of the given 'Event', if any.
299 -- recent firing of the given 'Event', if any.
269 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
300 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
270− -- | Create a new 'Incremental'. The given 'PullM''s value must always change
301+ -- | Create a new 'Incremental'. The given "PullM"'s value must always change
271 -- in the same way that the accumulated application of patches would change
302 -- in the same way that the accumulated application of patches would change
272 -- that value.
303 -- that value.
273 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
274 -- | Create a merge whose parents can change over time
305 -- | Create a merge whose parents can change over time
306+ mergeIncrementalG :: GCompare k
307+ => (forall a. q a -> Event t (v a))
275− mergeIncremental :: GCompare k => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
308+ -> Incremental t (PatchDMap k q)
309+ -> Event t (DMap k v)
276 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
310 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
311+ mergeIncrementalWithMoveG :: GCompare k
312+ => (forall a. q a -> Event t (v a))
277− mergeIncrementalWithMove :: GCompare k => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
313+ -> Incremental t (PatchDMapWithMove k q) -> Event t (DMap k v)
278 -- | Extract the 'Behavior' component of an 'Incremental'
314 -- | Extract the 'Behavior' component of an 'Incremental'
279 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
315 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
280 -- | Extract the 'Event' component of an 'Incremental'
316 -- | Extract the 'Event' component of an 'Incremental'
@@ -290,76 +326,30 @@ class ( MonadHold t (PushM t)
290 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
326 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
291 -- occurrence type
327 -- occurrence type
292 dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
328 dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
293−#endif
329+ -- | Construct a 'Coercion' for an 'Incremental' given 'Coercion's for its
294−
330+ -- patch target and patch types.
295−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
331+ incrementalCoercion
296−instance t ~ SpiderTimeline Global => Reflex t where
332+ :: Coercion (PatchTarget a) (PatchTarget b) -> Coercion a b -> Coercion (Incremental t a) (Incremental t b)
297− newtype Behavior t a = SpiderBehavior { unSpiderBehavior :: Reflex.Spider.Internal.Behavior Global a }
333+ mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
298− newtype Event t a = SpiderEvent { unSpiderEvent :: Reflex.Spider.Internal.Event Global a }
334+ fanInt :: Event t (IntMap a) -> EventSelectorInt t a
299− newtype Dynamic t a = SpiderDynamic { unSpiderDynamic :: Reflex.Spider.Internal.Dynamic Global (Identity a) } -- deriving (Functor, Applicative, Monad)
335+
300− newtype Incremental t p = SpiderIncremental { unSpiderIncremental :: Reflex.Spider.Internal.Dynamic Global p }
336+-- | Efficiently fan-out an event to many destinations. You should save the
301− type PullM t = SpiderPullM Global
337+-- result in a @let@-binding, and then repeatedly 'select' on the result to
302− type PushM t = SpiderPushM Global
338+-- create child events
303−never :: Reflex t => Event t a
339+fan :: forall t k. (Reflex t, GCompare k)
304−constant :: Reflex t => a -> Behavior t a
340+ => Event t (DMap k Identity) -> EventSelector t k
341+ --TODO: Can we help enforce the partial application discipline here? The combinator is worthless without it
342+fan e = EventSelector (fixup (selectG (fanG e) :: k a -> Event t (Identity a)) :: forall a. k a -> Event t a)
343+ where
344+ fixup :: forall a. (k a -> Event t (Identity a)) -> k a -> Event t a
345+ fixup = case eventCoercion Coercion :: Coercion (Event t (Identity a)) (Event t a) of
346+ Coercion -> coerce
347+
348+--TODO: Specialize this so that we can take advantage of knowing that there's no changing going on
349+-- | Constructs a single 'Event' out of a map of events. The output event may fire with multiple
350+-- keys simultaneously.
305−push :: Reflex t => (a -> PushM t (Maybe b)) -> Event t a -> Event t b
351+mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
306−pushCheap :: Reflex t => (a -> PushM t (Maybe b)) -> Event t a -> Event t b
352+mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
307−pull :: Reflex t => PullM t a -> Behavior t a
308−merge :: (Reflex t, GCompare k) => DMap k (Event t) -> Event t (DMap k Identity)
309−fan :: (Reflex t, GCompare k) => Event t (DMap k Identity) -> EventSelector t k
310−switch :: Reflex t => Behavior t (Event t a) -> Event t a
311−coincidence :: Reflex t => Event t (Event t a) -> Event t a
312−current :: Reflex t => Dynamic t a -> Behavior t a
313−updated :: Reflex t => Dynamic t a -> Event t a
314−unsafeBuildDynamic :: Reflex t => PullM t a -> Event t a -> Dynamic t a
315−unsafeBuildIncremental :: (Reflex t, Patch p) => PullM t (PatchTarget p) -> Event t p -> Incremental t p
316−mergeIncremental :: (Reflex t, GCompare k) => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
317−currentIncremental :: (Reflex t, Patch p) => Incremental t p -> Behavior t (PatchTarget p)
318−updatedIncremental :: (Reflex t, Patch p) => Incremental t p -> Event t p
319−incrementalToDynamic :: (Reflex t, Patch p) => Incremental t p -> Dynamic t (PatchTarget p)
320−behaviorCoercion :: Reflex t => Coercion a b -> Coercion (Behavior t a) (Behavior t b)
321−eventCoercion :: Reflex t => Coercion a b -> Coercion (Event t a) (Event t b)
322−dynamicCoercion :: Reflex t => Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
323−{-# INLINE never #-}
324−never = SpiderEvent S.eventNever
325−{-# INLINE constant #-}
326−constant = SpiderBehavior . S.behaviorConst
327−{-# INLINE push #-}
328−push f = SpiderEvent . S.push (coerce f) . unSpiderEvent
329−{-# INLINE pushCheap #-}
330−pushCheap f = SpiderEvent . S.pushCheap (coerce f) . unSpiderEvent
331−{-# INLINE pull #-}
332−pull = SpiderBehavior . S.pull . coerce
333−{-# INLINE merge #-}
334−merge = SpiderEvent . S.merge . S.dynamicConst . (coerce :: DMap k (Event (SpiderTimeline x)) -> DMap k (S.Event x))
335−{-# INLINE fan #-}
336−fan e = EventSelector $ SpiderEvent . S.select (S.fan (unSpiderEvent e))
337−{-# INLINE switch #-}
338−switch = SpiderEvent . S.switch . (coerce :: S.Behavior x (Event (SpiderTimeline x) a) -> S.Behavior x (S.Event x a)) . unSpiderBehavior
339−{-# INLINE coincidence #-}
340−coincidence = SpiderEvent . S.coincidence . (coerce :: S.Event x (Event (SpiderTimeline x) a) -> S.Event x (S.Event x a)) . unSpiderEvent
341−{-# INLINE current #-}
342−current = SpiderBehavior . S.dynamicCurrent . unSpiderDynamic
343−{-# INLINE updated #-}
344−updated = coerceEvent . SpiderEvent . dynamicUpdated . unSpiderDynamic
345−{-# INLINE unsafeBuildDynamic #-}
346−unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeDyn (coerce readV0) $ coerce $ unSpiderEvent v'
347−{-# INLINE unsafeBuildIncremental #-}
348−unsafeBuildIncremental readV0 dv = SpiderIncremental $ S.dynamicDyn $ unsafeDyn (coerce readV0) $ unSpiderEvent dv
349−{-# INLINE mergeIncremental #-}
350−mergeIncremental = SpiderEvent . S.merge . (unsafeCoerce :: S.Dynamic x (PatchDMap k (Event (SpiderTimeline x))) -> S.Dynamic x (PatchDMap k (S.Event x))) . unSpiderIncremental
351−{-# INLINE currentIncremental #-}
352−currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
353−{-# INLINE updatedIncremental #-}
354−updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
355−{-# INLINE incrementalToDynamic #-}
356−incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ unsafeDyn (readBehaviorUntracked $ dynamicCurrent i) $ flip S.push (dynamicUpdated i) $ \p -> do
357− c <- readBehaviorUntracked $ dynamicCurrent i
358− return $ Identity <$> apply p c
359−eventCoercion Coercion = Coercion
360−behaviorCoercion Coercion = Coercion
361−dynamicCoercion = unsafeCoerce
362−#endif
363
353
364-- | Coerce a 'Behavior' between representationally-equivalent value types
354-- | Coerce a 'Behavior' between representationally-equivalent value types
365coerceBehavior :: (Reflex t, Coercible a b) => Behavior t a -> Behavior t b
355coerceBehavior :: (Reflex t, Coercible a b) => Behavior t a -> Behavior t b
@@ -373,8 +363,14 @@ coerceEvent = coerceWith $ eventCoercion Coercion
373coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
363coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
374coerceDynamic = coerceWith $ dynamicCoercion Coercion
364coerceDynamic = coerceWith $ dynamicCoercion Coercion
375
365
366+-- | Coerce an 'Incremental' between representationally-equivalent value types
367+coerceIncremental
368+ :: (Reflex t, Coercible a b, Coercible (PatchTarget a) (PatchTarget b))
369+ => Incremental t a -> Incremental t b
370+coerceIncremental = coerceWith $ incrementalCoercion Coercion Coercion
371+
376-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
372-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
377−-- _must_ change when and only when the 'Event' fires, such that the
373+-- __must__ change when and only when the 'Event' fires, such that the
378-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
374-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
379-- if this is not the case, the resulting 'Dynamic' will behave
375-- if this is not the case, the resulting 'Dynamic' will behave
380-- nondeterministically.
376-- nondeterministically.
@@ -402,30 +398,168 @@ class MonadSample t m => MonadHold t m where
402 -- value and will be updated whenever the given 'Event' occurs. The update
398 -- value and will be updated whenever the given 'Event' occurs. The update
403 -- takes effect immediately after the 'Event' occurs; if the occurrence that
399 -- takes effect immediately after the 'Event' occurs; if the occurrence that
404 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
400 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
405− -- the 'Behavior', it will see the _old_ value of the 'Behavior', not the new
401+ -- the 'Behavior', it will see the __old__ value of the 'Behavior', not the new
406 -- one.
402 -- one.
407 hold :: a -> Event t a -> m (Behavior t a)
403 hold :: a -> Event t a -> m (Behavior t a)
404+ default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
405+ hold v0 = lift . hold v0
408 -- | Create a 'Dynamic' value using the given initial value that changes every
406 -- | Create a 'Dynamic' value using the given initial value that changes every
409 -- time the 'Event' occurs.
407 -- time the 'Event' occurs.
410 holdDyn :: a -> Event t a -> m (Dynamic t a)
408 holdDyn :: a -> Event t a -> m (Dynamic t a)
409+ default holdDyn :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Dynamic t a)
410+ holdDyn v0 = lift . holdDyn v0
411 -- | Create an 'Incremental' value using the given initial value that changes
411 -- | Create an 'Incremental' value using the given initial value that changes
412 -- every time the 'Event' occurs.
412 -- every time the 'Event' occurs.
413 holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
413 holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
414+ default holdIncremental :: (Patch p, m ~ f m', MonadTrans f, MonadHold t m') => PatchTarget p -> Event t p -> m (Incremental t p)
415+ holdIncremental v0 = lift . holdIncremental v0
416+ buildDynamic :: PushM t a -> Event t a -> m (Dynamic t a)
417+ {-
418+ default buildDynamic :: (m ~ f m', MonadTrans f, MonadHold t m') => PullM t a -> Event t a -> m (Dynamic t a)
419+ buildDynamic getV0 = lift . buildDynamic getV0
420+ -}
421+ -- | Create a new 'Event' that only occurs only once, on the first occurrence of
422+ -- the supplied 'Event'.
423+ headE :: Event t a -> m (Event t a)
424+ -- | An event which only occurs at the current moment in time, such that:
425+ --
426+ -- > coincidence (pushAlways (\a -> (a <$) <$> now) e) = e
427+ --
428+ now :: m (Event t ())
429+ default now :: (m ~ f m', MonadTrans f, MonadHold t m') => m (Event t ())
430+ now = lift now
431+
432+-- | Accumulate an 'Incremental' with the supplied initial value and the firings of the provided 'Event',
433+-- using the combining function to produce a patch.
434+accumIncremental
435+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
436+ => (PatchTarget p -> b -> p)
437+ -> PatchTarget p
438+ -> Event t b
439+ -> m (Incremental t p)
440+accumIncremental f = accumMaybeIncremental $ \v o -> Just $ f v o
441+
442+-- | Similar to 'accumIncremental' but the combining function runs in 'PushM'
443+accumMIncremental
444+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
445+ => (PatchTarget p -> b -> PushM t p)
446+ -> PatchTarget p
447+ -> Event t b
448+ -> m (Incremental t p)
449+accumMIncremental f = accumMaybeMIncremental $ \v o -> Just <$> f v o
450+
451+-- | Similar to 'accumIncremental' but allows filtering of updates (by dropping updates when the
452+-- combining function produces @Nothing@)
453+accumMaybeIncremental
454+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
455+ => (PatchTarget p -> b -> Maybe p)
456+ -> PatchTarget p
457+ -> Event t b
458+ -> m (Incremental t p)
459+accumMaybeIncremental f = accumMaybeMIncremental $ \v o -> return $ f v o
460+
461+-- | Similar to 'accumMaybeMIncremental' but the combining function runs in 'PushM'
462+accumMaybeMIncremental
463+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
464+ => (PatchTarget p -> b -> PushM t (Maybe p))
465+ -> PatchTarget p
466+ -> Event t b
467+ -> m (Incremental t p)
468+accumMaybeMIncremental f z e = do
469+ rec let e' = flip push e $ \o -> do
470+ v <- sample $ currentIncremental d'
471+ f v o
472+ d' <- holdIncremental z e'
473+ return d'
474+
475+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event'
476+-- with a function that both accumulates and produces a value to fire
477+-- as an 'Event'. Returns both the accumulated value and the constructed
478+-- 'Event'.
479+mapAccumIncremental
480+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
481+ => (PatchTarget p -> b -> (p, c))
482+ -> PatchTarget p
483+ -> Event t b
484+ -> m (Incremental t p, Event t c)
485+mapAccumIncremental f = mapAccumMaybeIncremental $ \v o -> bimap Just Just $ f v o
486+
487+-- | Like 'mapAccumIncremental' but the combining function runs in 'PushM'
488+mapAccumMIncremental
489+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
490+ => (PatchTarget p -> b -> PushM t (p, c))
491+ -> PatchTarget p
492+ -> Event t b
493+ -> m (Incremental t p, Event t c)
494+mapAccumMIncremental f = mapAccumMaybeMIncremental $ \v o -> bimap Just Just <$> f v o
495+
496+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event' with
497+-- a function that both optionally accumulates and optionally produces
498+-- a value to fire as a separate output 'Event'.
499+-- Note that because 'Nothing's are discarded in both cases, the output
500+-- 'Event' may fire even though the output 'Incremental' has not changed, and
501+-- the output 'Incremental' may update even when the output 'Event' is not firing.
502+mapAccumMaybeIncremental
503+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
504+ => (PatchTarget p -> b -> (Maybe p, Maybe c))
505+ -> PatchTarget p
506+ -> Event t b
507+ -> m (Incremental t p, Event t c)
508+mapAccumMaybeIncremental f = mapAccumMaybeMIncremental $ \v o -> return $ f v o
509+
510+-- | Like 'mapAccumMaybeIncremental' but the combining function is a 'PushM' action
511+mapAccumMaybeMIncremental
512+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
513+ => (PatchTarget p -> b -> PushM t (Maybe p, Maybe c))
514+ -> PatchTarget p
515+ -> Event t b
516+ -> m (Incremental t p, Event t c)
517+mapAccumMaybeMIncremental f z e = do
518+ rec let e' = flip push e $ \o -> do
519+ v <- sample $ currentIncremental d'
520+ result <- f v o
521+ return $ case result of
522+ (Nothing, Nothing) -> Nothing
523+ _ -> Just result
524+ d' <- holdIncremental z $ mapMaybe fst e'
525+ return (d', mapMaybe snd e')
526+
527+-- | A somewhat slow implementation of 'headE'
528+slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
529+slowHeadE e = do
530+ rec be <- hold e $ fmapCheap (const never) e'
531+ let e' = switch be
532+ return e'
414
533
415-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
534-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
416-- key. This is much more efficient than filtering for each key with
535-- key. This is much more efficient than filtering for each key with
417−-- 'fmapMaybe'.
536+-- 'mapMaybe'.
418newtype EventSelector t k = EventSelector
537newtype EventSelector t k = EventSelector
419 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
538 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
420 -- determined by the type of the key, so this can be used to fan-out
539 -- determined by the type of the key, so this can be used to fan-out
421 -- 'Event's whose sub-'Event's have different types.
540 -- 'Event's whose sub-'Event's have different types.
422 --
541 --
423 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
542 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
424− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
543+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
425 -- occurrences of an 'Event'.
544 -- occurrences of an 'Event'.
426 select :: forall a. k a -> Event t a
545 select :: forall a. k a -> Event t a
427 }
546 }
428
547
548+newtype EventSelectorG t k v = EventSelectorG
549+ { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
550+ -- determined by the type of the key, so this can be used to fan-out
551+ -- 'Event's whose sub-'Event's have different types.
552+ --
553+ -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
554+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
555+ -- occurrences of an 'Event'.
556+ selectG :: forall a. k a -> Event t (v a)
557+ }
558+
559+-- | Efficiently select an 'Event' keyed on 'Int'. This is more efficient than manually
560+-- filtering by key.
561+newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
562+
429--------------------------------------------------------------------------------
563--------------------------------------------------------------------------------
430-- Instances
564-- Instances
431--------------------------------------------------------------------------------
565--------------------------------------------------------------------------------
@@ -437,6 +571,9 @@ instance MonadHold t m => MonadHold t (ReaderT r m) where
437 hold a0 = lift . hold a0
571 hold a0 = lift . hold a0
438 holdDyn a0 = lift . holdDyn a0
572 holdDyn a0 = lift . holdDyn a0
439 holdIncremental a0 = lift . holdIncremental a0
573 holdIncremental a0 = lift . holdIncremental a0
574+ buildDynamic a0 = lift . buildDynamic a0
575+ headE = lift . headE
576+ now = lift now
440
577
441instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
578instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
442 sample = lift . sample
579 sample = lift . sample
@@ -445,6 +582,9 @@ instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
445 hold a0 = lift . hold a0
582 hold a0 = lift . hold a0
446 holdDyn a0 = lift . holdDyn a0
583 holdDyn a0 = lift . holdDyn a0
447 holdIncremental a0 = lift . holdIncremental a0
584 holdIncremental a0 = lift . holdIncremental a0
585+ buildDynamic a0 = lift . buildDynamic a0
586+ headE = lift . headE
587+ now = lift now
448
588
449instance MonadSample t m => MonadSample t (StateT s m) where
589instance MonadSample t m => MonadSample t (StateT s m) where
450 sample = lift . sample
590 sample = lift . sample
@@ -453,6 +593,9 @@ instance MonadHold t m => MonadHold t (StateT s m) where
453 hold a0 = lift . hold a0
593 hold a0 = lift . hold a0
454 holdDyn a0 = lift . holdDyn a0
594 holdDyn a0 = lift . holdDyn a0
455 holdIncremental a0 = lift . holdIncremental a0
595 holdIncremental a0 = lift . holdIncremental a0
596+ buildDynamic a0 = lift . buildDynamic a0
597+ headE = lift . headE
598+ now = lift now
456
599
457instance MonadSample t m => MonadSample t (ExceptT e m) where
600instance MonadSample t m => MonadSample t (ExceptT e m) where
458 sample = lift . sample
601 sample = lift . sample
@@ -461,6 +604,9 @@ instance MonadHold t m => MonadHold t (ExceptT e m) where
461 hold a0 = lift . hold a0
604 hold a0 = lift . hold a0
462 holdDyn a0 = lift . holdDyn a0
605 holdDyn a0 = lift . holdDyn a0
463 holdIncremental a0 = lift . holdIncremental a0
606 holdIncremental a0 = lift . holdIncremental a0
607+ buildDynamic a0 = lift . buildDynamic a0
608+ headE = lift . headE
609+ now = lift now
464
610
465instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
611instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
466 sample = lift . sample
612 sample = lift . sample
@@ -469,6 +615,9 @@ instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
469 hold a0 = lift . hold a0
615 hold a0 = lift . hold a0
470 holdDyn a0 = lift . holdDyn a0
616 holdDyn a0 = lift . holdDyn a0
471 holdIncremental a0 = lift . holdIncremental a0
617 holdIncremental a0 = lift . holdIncremental a0
618+ buildDynamic a0 = lift . buildDynamic a0
619+ headE = lift . headE
620+ now = lift now
472
621
473instance MonadSample t m => MonadSample t (ContT r m) where
622instance MonadSample t m => MonadSample t (ContT r m) where
474 sample = lift . sample
623 sample = lift . sample
@@ -477,6 +626,9 @@ instance MonadHold t m => MonadHold t (ContT r m) where
477 hold a0 = lift . hold a0
626 hold a0 = lift . hold a0
478 holdDyn a0 = lift . holdDyn a0
627 holdDyn a0 = lift . holdDyn a0
479 holdIncremental a0 = lift . holdIncremental a0
628 holdIncremental a0 = lift . holdIncremental a0
629+ buildDynamic a0 = lift . buildDynamic a0
630+ headE = lift . headE
631+ now = lift now
480
632
481--------------------------------------------------------------------------------
633--------------------------------------------------------------------------------
482-- Convenience functions
634-- Convenience functions
@@ -491,6 +643,14 @@ pushAlways f = push (fmap Just . f)
491ffor :: Functor f => f a -> (a -> b) -> f b
643ffor :: Functor f => f a -> (a -> b) -> f b
492ffor = flip fmap
644ffor = flip fmap
493
645
646+-- | Rotated version of 'liftA2'.
647+ffor2 :: Applicative f => f a -> f b -> (a -> b -> c) -> f c
648+ffor2 a b f = liftA2 f a b
649+
650+-- | Rotated version of 'liftA3'.
651+ffor3 :: Applicative f => f a -> f b -> f c -> (a -> b -> c -> d) -> f d
652+ffor3 a b c f = liftA3 f a b c
653+
494instance Reflex t => Applicative (Behavior t) where
654instance Reflex t => Applicative (Behavior t) where
495 pure = constant
655 pure = constant
496 f <*> x = pull $ sample f `ap` sample x
656 f <*> x = pull $ sample f `ap` sample x
@@ -518,7 +678,9 @@ instance Reflex t => Monad (Behavior t) where
518 a >>= f = pull $ sample a >>= sample . f
678 a >>= f = pull $ sample a >>= sample . f
519 -- Note: it is tempting to write (_ >> b = b); however, this would result in (fail x >> return y) succeeding (returning y), which violates the law that (a >> b = a >>= \_ -> b), since the implementation of (>>=) above actually will fail. Since we can't examine 'Behavior's other than by using sample, I don't think it's possible to write (>>) to be more efficient than the (>>=) above.
679 -- Note: it is tempting to write (_ >> b = b); however, this would result in (fail x >> return y) succeeding (returning y), which violates the law that (a >> b = a >>= \_ -> b), since the implementation of (>>=) above actually will fail. Since we can't examine 'Behavior's other than by using sample, I don't think it's possible to write (>>) to be more efficient than the (>>=) above.
520 return = constant
680 return = constant
681+#if !MIN_VERSION_base(4,13,0)
521 fail = error "Monad (Behavior t) does not support fail"
682 fail = error "Monad (Behavior t) does not support fail"
683+#endif
522
684
523instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
685instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
524 mempty = constant mempty
686 mempty = constant mempty
@@ -534,32 +696,51 @@ instance (Reflex t, Num a) => Num (Behavior t a) where
534 negate = fmap negate
696 negate = fmap negate
535 signum = fmap signum
697 signum = fmap signum
536
698
699+instance (Num a, Reflex t) => Num (Dynamic t a) where
700+ (+) = liftA2 (+)
701+ (*) = liftA2 (*)
702+ abs = fmap abs
703+ signum = fmap signum
704+ fromInteger = pure . fromInteger
705+ negate = fmap negate
706+ (-) = liftA2 (-)
707+
537instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
708instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
538 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
709 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
539 sconcat = pull . fmap sconcat . mapM sample
710 sconcat = pull . fmap sconcat . mapM sample
540−#if MIN_VERSION_semigroups(0,17,0)
541 stimes n = fmap $ stimes n
711 stimes n = fmap $ stimes n
542−#else
543− times1p n = fmap $ times1p n
544−#endif
545
712
713+-- | Alias for 'mapMaybe'
714+fmapMaybe :: Filterable f => (a -> Maybe b) -> f a -> f b
715+fmapMaybe = mapMaybe
716+
546−-- | Flipped version of 'fmapMaybe'.
717+-- | Flipped version of 'mapMaybe'.
547−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
718+fforMaybe :: Filterable f => f a -> (a -> Maybe b) -> f b
548−fforMaybe = flip fmapMaybe
719+fforMaybe = flip mapMaybe
549
720
550-- | Filter 'f a' using the provided predicate.
721-- | Filter 'f a' using the provided predicate.
551−-- Relies on 'fforMaybe'.
552−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
722+ffilter :: Filterable f => (a -> Bool) -> f a -> f a
553−ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
723+ffilter = W.filter
724+
725+-- | Filter 'Left's from 'f (Either a b)' into 'a'.
726+filterLeft :: Filterable f => f (Either a b) -> f a
727+filterLeft = mapMaybe (either Just (const Nothing))
728+
729+-- | Filter 'Right's from 'f (Either a b)' into 'b'.
730+filterRight :: Filterable f => f (Either a b) -> f b
731+filterRight = mapMaybe (either (const Nothing) Just)
554
732
555-- | Left-biased event union (prefers left event on simultaneous
733-- | Left-biased event union (prefers left event on simultaneous
556-- occurrence).
734-- occurrence).
557instance Reflex t => Alt (Event t) where
735instance Reflex t => Alt (Event t) where
558 ev1 <!> ev2 = leftmost [ev1, ev2]
736 ev1 <!> ev2 = leftmost [ev1, ev2]
559
737
560−-- | 'Event' intersection (convenient interface to 'coincidence').
738+-- | 'Event' intersection. Only occurs when both events are co-incident.
561instance Reflex t => Apply (Event t) where
739instance Reflex t => Apply (Event t) where
562− evf <.> evx = coincidence (fmap (<$> evx) evf)
740+ evf <.> evx = mapMaybe f (align evf evx) where
741+ f (These g a) = Just (g a)
742+ f _ = Nothing
743+
563
744
564-- | 'Event' intersection (convenient interface to 'coincidence').
745-- | 'Event' intersection (convenient interface to 'coincidence').
565instance Reflex t => Bind (Event t) where
746instance Reflex t => Bind (Event t) where
@@ -568,11 +749,18 @@ instance Reflex t => Bind (Event t) where
568
749
569instance Reflex t => Functor (Event t) where
750instance Reflex t => Functor (Event t) where
570 {-# INLINE fmap #-}
751 {-# INLINE fmap #-}
571− fmap f = fmapMaybe $ Just . f
752+ fmap f = mapMaybe $ Just . f
753+ {-# INLINE (<$) #-}
754+ x <$ e = fmapCheap (const x) e
572
755
756+-- TODO Remove this instance
573instance Reflex t => FunctorMaybe (Event t) where
757instance Reflex t => FunctorMaybe (Event t) where
574 {-# INLINE fmapMaybe #-}
758 {-# INLINE fmapMaybe #-}
759+ fmapMaybe = mapMaybe
760+
761+instance Reflex t => Filterable (Event t) where
762+ {-# INLINE mapMaybe #-}
575− fmapMaybe f = push $ return . f
763+ mapMaybe f = push $ return . f
576
764
577-- | Never: @'zero' = 'never'@.
765-- | Never: @'zero' = 'never'@.
578instance Reflex t => Plus (Event t) where
766instance Reflex t => Plus (Event t) where
@@ -583,7 +771,13 @@ instance Reflex t => Plus (Event t) where
583tag :: Reflex t => Behavior t b -> Event t a -> Event t b
771tag :: Reflex t => Behavior t b -> Event t a -> Event t b
584tag b = pushAlways $ \_ -> sample b
772tag b = pushAlways $ \_ -> sample b
585
773
774+-- | Replace each occurrence value of the 'Event' with the value of the
775+-- 'Behavior' at that time; if it is 'Just', fire with the contained value; if
776+-- it is 'Nothing', drop the occurrence.
777+tagMaybe :: Reflex t => Behavior t (Maybe b) -> Event t a -> Event t b
778+tagMaybe b = push $ \_ -> sample b
779+
586−-- | Create a new 'Event' that combines occurences of supplied 'Event' with the
780+-- | Create a new 'Event' that combines occurrences of supplied 'Event' with the
587-- current value of the 'Behavior'.
781-- current value of the 'Behavior'.
588attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
782attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
589attach = attachWith (,)
783attach = attachWith (,)
@@ -593,48 +787,118 @@ attach = attachWith (,)
593attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
787attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
594attachWith f = attachWithMaybe $ \a b -> Just $ f a b
788attachWith f = attachWithMaybe $ \a b -> Just $ f a b
595
789
596−-- | Create a new 'Event' by combining each occurence with the current value of
790+-- | Create a new 'Event' by combining each occurrence with the current value of
597-- the 'Behavior'. The occurrence is discarded if the combining function returns
791-- the 'Behavior'. The occurrence is discarded if the combining function returns
598-- Nothing
792-- Nothing
599attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
793attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
600attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
794attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
601
795
602−-- | Create a new 'Event' that only occurs only once, on the first occurence of
603−-- the supplied 'Event'.
604−headE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
605−headE e = do
606− rec be <- hold e $ fmap (const never) e'
607− let e' = switch be
608− return e'
609−
610−-- | Create a new 'Event' that occurs on all but the first occurence of the
796+-- | Create a new 'Event' that occurs on all but the first occurrence of the
611-- supplied 'Event'.
797-- supplied 'Event'.
612−tailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
798+tailE :: (Reflex t, MonadHold t m) => Event t a -> m (Event t a)
613tailE e = snd <$> headTailE e
799tailE e = snd <$> headTailE e
614
800
615−-- | Create a tuple of two 'Event's with the first one occuring only the first
801+-- | Create a tuple of two 'Event's with the first one occurring only the first
616−-- time the supplied 'Event' occurs and the second occuring on all but the first
802+-- time the supplied 'Event' occurs and the second occurring on all but the first
617−-- occurence.
803+-- occurrence.
618−headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)
804+headTailE :: (Reflex t, MonadHold t m) => Event t a -> m (Event t a, Event t a)
619headTailE e = do
805headTailE e = do
620 eHead <- headE e
806 eHead <- headE e
621 be <- hold never $ fmap (const e) eHead
807 be <- hold never $ fmap (const e) eHead
622 return (eHead, switch be)
808 return (eHead, switch be)
623
809
810+-- | Take the streak of occurrences starting at the current time for which the
811+-- event returns 'True'.
812+--
813+-- Starting at the current time, fire all the occurrences of the 'Event' for
814+-- which the given predicate returns 'True'. When first 'False' is returned,
815+-- do not fire, and permanently stop firing, even if 'True' values would have
816+-- been encountered later.
817+takeWhileE
818+ :: forall t m a
819+ . (Reflex t, MonadFix m, MonadHold t m)
820+ => (a -> Bool)
821+ -> Event t a
822+ -> m (Event t a)
823+takeWhileE f = takeWhileJustE $ \v -> guard (f v) $> v
824+
825+-- | Take the streak of occurrences starting at the current time for which the
826+-- event returns 'Just b'.
827+--
828+-- Starting at the current time, fire all the occurrences of the 'Event' for
829+-- which the given predicate returns 'Just b'. When first 'Nothing' is returned,
830+-- do not fire, and permanently stop firing, even if 'Just b' values would have
831+-- been encountered later.
832+takeWhileJustE
833+ :: forall t m a b
834+ . (Reflex t, MonadFix m, MonadHold t m)
835+ => (a -> Maybe b)
836+ -> Event t a
837+ -> m (Event t b)
838+takeWhileJustE f e = do
839+ rec let (eBad, eTrue) = fanEither $ ffor e' $ \a -> case f a of
840+ Nothing -> Left never
841+ Just b -> Right b
842+ eFirstBad <- headE eBad
843+ e' <- switchHold e eFirstBad
844+ return eTrue
845+
846+-- | Drop the streak of occurrences starting at the current time for which the
847+-- event returns 'True'.
848+--
849+-- Starting at the current time, do not fire all the occurrences of the 'Event'
850+-- for which the given predicate returns 'True'. When 'False' is first
851+-- returned, do fire, and permanently continue firing, even if 'True' values
852+-- would have been encountered later.
853+dropWhileE
854+ :: forall t m a
855+ . (Reflex t, MonadFix m, MonadHold t m)
856+ => (a -> Bool)
857+ -> Event t a
858+ -> m (Event t a)
859+dropWhileE f e = snd <$> takeDropWhileJustE (\v -> guard (f v) $> v) e
860+
861+-- | Both take and drop the streak of occurrences starting at the current time
862+-- for which the event returns 'Just b'.
863+--
864+-- For the left event, starting at the current time, fire all the occurrences
865+-- of the 'Event' for which the given function returns 'Just b'. When
866+-- 'Nothing' is returned, do not fire, and permanently stop firing, even if
867+-- 'Just b' values would have been encountered later.
868+--
869+-- For the right event, do not fire until the first occurrence where the given
870+-- function returns 'Nothing', and fire that one and all subsequent
871+-- occurrences. Even if the function would have again returned 'Just b', keep
872+-- on firing.
873+takeDropWhileJustE
874+ :: forall t m a b
875+ . (Reflex t, MonadFix m, MonadHold t m)
876+ => (a -> Maybe b)
877+ -> Event t a
878+ -> m (Event t b, Event t a)
879+takeDropWhileJustE f e = do
880+ rec let (eBad, eGood) = fanEither $ ffor e' $ \a -> case f a of
881+ Nothing -> Left ()
882+ Just b -> Right b
883+ eFirstBad <- headE eBad
884+ e' <- switchHold e (never <$ eFirstBad)
885+ eRest <- switchHoldPromptOnly never (e <$ eFirstBad)
886+ return (eGood, eRest)
887+
624−-- | Split the supplied 'Event' into two individual 'Event's occuring at the
888+-- | Split the supplied 'Event' into two individual 'Event's occurring at the
625-- same time with the respective values from the tuple.
889-- same time with the respective values from the tuple.
626splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
890splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
627splitE e = (fmap fst e, fmap snd e)
891splitE e = (fmap fst e, fmap snd e)
628
892
629-- | Print the supplied 'String' and the value of the 'Event' on each
893-- | Print the supplied 'String' and the value of the 'Event' on each
630−-- occurence. This should /only/ be used for debugging.
894+-- occurrence. This should /only/ be used for debugging.
631--
895--
632-- Note: As with Debug.Trace.trace, the message will only be printed if the
896-- Note: As with Debug.Trace.trace, the message will only be printed if the
633-- 'Event' is actually used.
897-- 'Event' is actually used.
634traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
898traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
635traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
899traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
636
900
637−-- | Print the output of the supplied function on each occurence of the
901+-- | Print the output of the supplied function on each occurrence of the
638-- 'Event'. This should /only/ be used for debugging.
902-- 'Event'. This should /only/ be used for debugging.
639--
903--
640-- Note: As with Debug.Trace.trace, the message will only be printed if the
904-- Note: As with Debug.Trace.trace, the message will only be printed if the
@@ -645,11 +909,7 @@ traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
645instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
909instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
646 (<>) = alignWith (mergeThese (<>))
910 (<>) = alignWith (mergeThese (<>))
647 sconcat = fmap sconcat . mergeList . toList
911 sconcat = fmap sconcat . mergeList . toList
648−#if MIN_VERSION_semigroups(0,17,0)
649 stimes n = fmap $ stimes n
912 stimes n = fmap $ stimes n
650−#else
651− times1p n = fmap $ times1p n
652−#endif
653
913
654instance (Semigroup a, Reflex t) => Monoid (Event t a) where
914instance (Semigroup a, Reflex t) => Monoid (Event t a) where
655 mempty = never
915 mempty = never
@@ -665,10 +925,9 @@ mergeWith = mergeWith' id
665
925
666{-# INLINE mergeWith' #-}
926{-# INLINE mergeWith' #-}
667mergeWith' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
927mergeWith' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
668−mergeWith' f g es = fmap (Prelude.foldl1 g . map (\(Const2 _ :=> Identity v) -> f v) . DMap.toList)
928+mergeWith' f g es = fmap (Prelude.foldl1 g . fmap f)
669− . merge
929+ . mergeInt
670− . DMap.fromDistinctAscList
930+ . IntMap.fromDistinctAscList
671− . map (\(k, v) -> Const2 k :=> v)
672 $ zip [0 :: Int ..] es
931 $ zip [0 :: Int ..] es
673
932
674-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
933-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
@@ -679,25 +938,38 @@ leftmost :: Reflex t => [Event t a] -> Event t a
679leftmost = mergeWith const
938leftmost = mergeWith const
680
939
681-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
940-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
682−-- list occurs and has a list of the values of all 'Event's occuring at that
941+-- list occurs and has a list of the values of all 'Event's occurring at that
683-- time.
942-- time.
684mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
943mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
685mergeList [] = never
944mergeList [] = never
686−mergeList es = mergeWithCheap' (:|[]) (<>) es
945+mergeList es = mergeWithFoldCheap' id es
687−
946+
947+unsafeMapIncremental
948+ :: (Reflex t, Patch p, Patch p')
688−unsafeMapIncremental :: (Reflex t, Patch p, Patch p') => (PatchTarget p -> PatchTarget p') -> (p -> p') -> Incremental t p -> Incremental t p'
949+ => (PatchTarget p -> PatchTarget p')
950+ -> (p -> p')
951+ -> Incremental t p
952+ -> Incremental t p'
689unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
953unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
690
954
691-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
955-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
692-- occurs if at least one of them occurs and has a map of values of all 'Event's
956-- occurs if at least one of them occurs and has a map of values of all 'Event's
693−-- occuring at that time.
957+-- occurring at that time.
694mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
958mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
695mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
959mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
696
960
961+-- | Like 'mergeMap' but for 'IntMap'.
962+mergeIntMap :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
963+mergeIntMap = fmap dmapToIntMap . merge . intMapWithFunctorToDMap
964+
697-- | Create a merge whose parents can change over time
965-- | Create a merge whose parents can change over time
698mergeMapIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t a)) -> Event t (Map k a)
966mergeMapIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t a)) -> Event t (Map k a)
699mergeMapIncremental = fmap dmapToMap . mergeIncremental . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWith id)
967mergeMapIncremental = fmap dmapToMap . mergeIncremental . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWith id)
700
968
969+-- | Create a merge whose parents can change over time
970+mergeIntMapIncremental :: Reflex t => Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
971+mergeIntMapIncremental = fmap dmapToIntMap . mergeIncremental . unsafeMapIncremental intMapWithFunctorToDMap (const2IntPatchDMapWith id)
972+
701-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
973-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
702mergeMapIncrementalWithMove :: (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Event t a)) -> Event t (Map k a)
974mergeMapIncrementalWithMove :: (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Event t a)) -> Event t (Map k a)
703mergeMapIncrementalWithMove = fmap dmapToMap . mergeIncrementalWithMove . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWithMoveWith id)
975mergeMapIncrementalWithMove = fmap dmapToMap . mergeIncrementalWithMove . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWithMoveWith id)
@@ -707,7 +979,7 @@ fanEither :: Reflex t => Event t (Either a b) -> (Event t a, Event t b)
707fanEither e =
979fanEither e =
708 let justLeft = either Just (const Nothing)
980 let justLeft = either Just (const Nothing)
709 justRight = either (const Nothing) Just
981 justRight = either (const Nothing) Just
710− in (fmapMaybe justLeft e, fmapMaybe justRight e)
982+ in (mapMaybe justLeft e, mapMaybe justRight e)
711
983
712-- | Split the event into separate events for 'This' and 'That' values,
984-- | Split the event into separate events for 'This' and 'That' values,
713-- allowing them to fire simultaneously when the input value is 'These'.
985-- allowing them to fire simultaneously when the input value is 'These'.
@@ -719,47 +991,141 @@ fanThese e =
719 that (That y) = Just y
991 that (That y) = Just y
720 that (These _ y) = Just y
992 that (These _ y) = Just y
721 that _ = Nothing
993 that _ = Nothing
722− in (fmapMaybe this e, fmapMaybe that e)
994+ in (mapMaybe this e, mapMaybe that e)
723
995
724-- | Split the event into an 'EventSelector' that allows efficient selection of
996-- | Split the event into an 'EventSelector' that allows efficient selection of
725-- the individual 'Event's.
997-- the individual 'Event's.
726fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
998fanMap :: (Reflex t, Ord k) => Event t (Map k a) -> EventSelector t (Const2 k a)
727fanMap = fan . fmap mapToDMap
999fanMap = fan . fmap mapToDMap
728
1000
729−-- | Switches to the new event whenever it receives one. Whenever a new event
1001+-- | Switches to the new event whenever it receives one. Only the old event is
1002+-- considered the moment a new one is switched in; the output event will fire at
1003+-- that moment only if the old event does.
1004+--
1005+-- Because the simultaneous firing case is irrelevant, this function imposes
1006+-- laxer "timing requirements" on the overall circuit, avoiding many potential
1007+-- cyclic dependency / metastability failures. It's also more performant. Use
1008+-- this rather than 'switchHoldPromptly' and 'switchHoldPromptOnly' unless you
1009+-- are absolutely sure you need to act on the new event in the coincidental
1010+-- case.
1011+switchHold :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1012+switchHold ea0 eea = switch <$> hold ea0 eea
1013+
1014+-- | Switches to the new event whenever it receives one. Whenever a new event is
730−-- is provided, if it is firing, its value will be the resulting event's value;
1015+-- provided, if it is firing, its value will be the resulting event's value; if
731−-- if it is not firing, but the old one is, the old one's value will be used.
1016+-- it is not firing, but the old one is, the old one's value will be used.
1017+--
1018+-- 'switchHold', by always forwarding the old event the moment it is switched
1019+-- out, avoids many potential cyclic dependency problems / metastability
1020+-- problems. It's also more performant. Use it instead unless you are sure you
1021+-- cannot.
732−switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1022+switchHoldPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
733−switchPromptly ea0 eea = do
1023+switchHoldPromptly ea0 eea = do
734 bea <- hold ea0 eea
1024 bea <- hold ea0 eea
735 let eLag = switch bea
1025 let eLag = switch bea
736 eCoincidences = coincidence eea
1026 eCoincidences = coincidence eea
737 return $ leftmost [eCoincidences, eLag]
1027 return $ leftmost [eCoincidences, eLag]
738
1028
739−-- | 'switch'es to a new event whenever it receives one. At the moment of
1029+-- | switches to a new event whenever it receives one. At the moment of
740-- switching, the old event will be ignored if it fires, and the new one will be
1030-- switching, the old event will be ignored if it fires, and the new one will be
741-- used if it fires; this is the opposite of 'switch', which will use only the
1031-- used if it fires; this is the opposite of 'switch', which will use only the
742-- old value.
1032-- old value.
1033+--
1034+-- 'switchHold', by always forwarding the old event the moment it is switched
1035+-- out, avoids many potential cyclic dependency problems / metastability
1036+-- problems. It's also more performant. Use it instead unless you are sure you
1037+-- cannot.
743−switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1038+switchHoldPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
744−switchPromptOnly e0 e' = do
1039+switchHoldPromptOnly e0 e' = do
745 eLag <- switch <$> hold e0 e'
1040 eLag <- switch <$> hold e0 e'
746 return $ coincidence $ leftmost [e', eLag <$ eLag]
1041 return $ coincidence $ leftmost [e', eLag <$ eLag]
747
1042
1043+-- | When the given outer event fires, condense the inner events into the contained patch. Non-firing inner events will be replaced with deletions.
1044+coincidencePatchMap :: (Reflex t, Ord k) => Event t (PatchMap k (Event t v)) -> Event t (PatchMap k v)
1045+coincidencePatchMap e = fmapCheap PatchMap $ coincidence $ ffor e $ \(PatchMap m) -> mergeMap $ ffor m $ \case
1046+ Nothing -> fmapCheap (const Nothing) e
1047+ Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
1048+
1049+-- | See 'coincidencePatchMap'
1050+coincidencePatchIntMap :: Reflex t => Event t (PatchIntMap (Event t v)) -> Event t (PatchIntMap v)
1051+coincidencePatchIntMap e = fmapCheap PatchIntMap $ coincidence $ ffor e $ \(PatchIntMap m) -> mergeIntMap $ ffor m $ \case
1052+ Nothing -> fmapCheap (const Nothing) e
1053+ Just ev -> leftmost [fmapCheap Just ev, fmapCheap (const Nothing) e]
1054+
1055+-- | See 'coincidencePatchMap'
1056+coincidencePatchMapWithMove :: (Reflex t, Ord k) => Event t (PatchMapWithMove k (Event t v)) -> Event t (PatchMapWithMove k v)
1057+coincidencePatchMapWithMove e = fmapCheap unsafePatchMapWithMove $ coincidence $ ffor e $ \p -> mergeMap $ ffor (unPatchMapWithMove p) $ \ni -> case PatchMapWithMove._nodeInfo_from ni of
1058+ PatchMapWithMove.From_Delete -> fforCheap e $ \_ ->
1059+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Delete }
1060+ PatchMapWithMove.From_Move k -> fforCheap e $ \_ ->
1061+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Move k }
1062+ PatchMapWithMove.From_Insert ev -> leftmost
1063+ [ fforCheap ev $ \v ->
1064+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Insert v }
1065+ , fforCheap e $ \_ ->
1066+ ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Delete }
1067+ ]
1068+
1069+-- | Given a 'PatchTarget' of events (e.g., a 'Map' with 'Event' values) and an event of 'Patch'es
1070+-- (e.g., a 'PatchMap' with 'Event' values), produce an 'Event' of the 'PatchTarget' type that
1071+-- fires with the patched value.
1072+switchHoldPromptOnlyIncremental
1073+ :: forall t m p pt w
1074+ . ( Reflex t
1075+ , MonadHold t m
1076+ , Patch (p (Event t w))
1077+ , PatchTarget (p (Event t w)) ~ pt (Event t w)
1078+ , Patch (p w)
1079+ , PatchTarget (p w) ~ pt w
1080+ , Monoid (pt w)
1081+ )
1082+ => (Incremental t (p (Event t w)) -> Event t (pt w))
1083+ -> (Event t (p (Event t w)) -> Event t (p w))
1084+ -> pt (Event t w)
1085+ -> Event t (p (Event t w))
1086+ -> m (Event t (pt w))
1087+switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch e0 e' = do
1088+ lag <- mergePatchIncremental <$> holdIncremental e0 e'
1089+ pure $ ffor (align lag (coincidencePatch e')) $ \case
1090+ This old -> old
1091+ That new -> new `applyAlways` mempty
1092+ These old new -> new `applyAlways` old
1093+
748instance Reflex t => Align (Event t) where
1094instance Reflex t => Align (Event t) where
749 nil = never
1095 nil = never
750− align = alignWithMaybe Just
1096+#if MIN_VERSION_these(0, 8, 0)
1097+instance Reflex t => Semialign (Event t) where
1098+#endif
1099+ align = alignEventWithMaybe Just
1100+
1101+#ifdef MIN_VERSION_semialign
1102+#if MIN_VERSION_semialign(1,1,0)
1103+instance Reflex t => Zip (Event t) where
1104+#endif
1105+ zip x y = mapMaybe justThese $ align x y
1106+#endif
1107+
1108+#ifdef MIN_VERSION_semialign
1109+#if MIN_VERSION_semialign(1,1,0)
1110+instance Reflex t => Unzip (Event t) where
1111+ unzip = splitE
1112+#endif
1113+#endif
751
1114
752-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
1115-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
753−-- the 'Behavior' is true at the time of occurence.
1116+-- the 'Behavior' is true at the time of occurrence.
754gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
1117gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
755gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
1118gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
756
1119
757−-- | Create a new behavior given a starting behavior and switch to a the behvior
1120+-- | Create a new behavior given a starting behavior and switch to the behavior
758−-- carried by the event when it fires.
1121+-- carried by the event when it fires.
759switcher :: (Reflex t, MonadHold t m)
1122switcher :: (Reflex t, MonadHold t m)
760 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
1123 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
761switcher b eb = pull . (sample <=< sample) <$> hold b eb
1124switcher b eb = pull . (sample <=< sample) <$> hold b eb
762
1125
1126+instance (Reflex t, IsString a) => IsString (Dynamic t a) where
1127+ fromString = pure . fromString
1128+
763-- | Combine two 'Dynamic's. The result will change whenever either (or both)
1129-- | Combine two 'Dynamic's. The result will change whenever either (or both)
764-- input 'Dynamic' changes. Equivalent to @zipDynWith (,)@.
1130-- input 'Dynamic' changes. Equivalent to @zipDynWith (,)@.
765zipDyn :: Reflex t => Dynamic t a -> Dynamic t b -> Dynamic t (a, b)
1131zipDyn :: Reflex t => Dynamic t a -> Dynamic t b -> Dynamic t (a, b)
@@ -767,7 +1133,7 @@ zipDyn = zipDynWith (,)
767
1133
768-- | Combine two 'Dynamic's with a combining function. The result will change
1134-- | Combine two 'Dynamic's with a combining function. The result will change
769-- whenever either (or both) input 'Dynamic' changes.
1135-- whenever either (or both) input 'Dynamic' changes.
770−-- More efficient than liftA2.
1136+-- More efficient than 'liftA2'.
771zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
1137zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
772zipDynWith f da db =
1138zipDynWith f da db =
773 let eab = align (updated da) (updated db)
1139 let eab = align (updated da) (updated db)
@@ -783,6 +1149,10 @@ zipDynWith f da db =
783 return $ Just $ f a b
1149 return $ Just $ f a b
784 in unsafeBuildDynamic (f <$> sample (current da) <*> sample (current db)) ec
1150 in unsafeBuildDynamic (f <$> sample (current da) <*> sample (current db)) ec
785
1151
1152+instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
1153+ (<>) = zipDynWith (<>)
1154+ stimes n = fmap $ stimes n
1155+
786instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
1156instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
787 mconcat = distributeListOverDynWith mconcat
1157 mconcat = distributeListOverDynWith mconcat
788 mempty = constDyn mempty
1158 mempty = constDyn mempty
@@ -790,14 +1160,23 @@ instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
790
1160
791-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
1161-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
792-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
1162-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
793−-- through the use of multiple uses of 'zipWithDyn' or 'Applicative' operators.
1163+-- through the use of multiple uses of 'zipDynWith' or 'Applicative' operators.
794distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
1164distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
795−distributeDMapOverDynPure dm = case DMap.toList dm of
1165+distributeDMapOverDynPure = distributeDMapOverDynPureG coerceDynamic
1166+
1167+-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
1168+-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
1169+-- through the use of multiple uses of 'zipDynWith' or 'Applicative' operators.
1170+distributeDMapOverDynPureG
1171+ :: forall t k q v. (Reflex t, GCompare k)
1172+ => (forall a. q a -> Dynamic t (v a))
1173+ -> DMap k q -> Dynamic t (DMap k v)
1174+distributeDMapOverDynPureG nt dm = case DMap.toList dm of
796 [] -> constDyn DMap.empty
1175 [] -> constDyn DMap.empty
797− [k :=> v] -> fmap (DMap.singleton k . Identity) v
1176+ [k :=> v] -> DMap.singleton k <$> nt v
798 _ ->
1177 _ ->
799− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
1178+ let getInitial = DMap.traverseWithKey (\_ -> sample . current . nt) dm
800− edmPre = merge $ DMap.map updated dm
1179+ edmPre = mergeG getCompose $ DMap.map (Compose . updated . nt) dm
801 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
1180 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
802 olds <- sample $ current result
1181 olds <- sample $ current result
803 return $ DMap.unionWithKey (\_ _ new -> new) olds news
1182 return $ DMap.unionWithKey (\_ _ new -> new) olds news
@@ -809,23 +1188,73 @@ distributeListOverDyn = distributeListOverDynWith id
809
1188
810-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
1189-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
811distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
1190distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
812−distributeListOverDynWith f = fmap (f . map (\(Const2 _ :=> Identity v) -> v) . DMap.toList) . distributeDMapOverDynPure . DMap.fromList . map (\(k, v) -> Const2 k :=> v) . zip [0 :: Int ..]
1191+distributeListOverDynWith f =
1192+ fmap (f . map fromDSum . DMap.toAscList) .
1193+ distributeDMapOverDynPure .
1194+ DMap.fromDistinctAscList .
1195+ zipWith toDSum [0..]
1196+ where
1197+ toDSum :: Int -> Dynamic t a -> DSum (Const2 Int a) (Dynamic t)
1198+ toDSum k v = Const2 k :=> v
1199+ fromDSum :: DSum (Const2 Int a) Identity -> a
1200+ fromDSum (Const2 _ :=> Identity v) = v
813
1201
814-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
1202-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
815-- unless the second supplied 'Event' occurs simultaneously.
1203-- unless the second supplied 'Event' occurs simultaneously.
816difference :: Reflex t => Event t a -> Event t b -> Event t a
1204difference :: Reflex t => Event t a -> Event t b -> Event t a
817−difference = alignWithMaybe $ \case
1205+difference = alignEventWithMaybe $ \case
818 This a -> Just a
1206 This a -> Just a
819− _ -> Nothing
1207+ _ -> Nothing
820−
1208+
821−-- (intentially not exported, for now)
1209+-- | Zips two values by taking the union of their shapes and combining with the provided function.
822−alignWithMaybe
1210+-- 'Nothing' values are dropped.
823− :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
1211+alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
824−alignWithMaybe f ea eb =
1212+alignEventWithMaybe f ea eb = mapMaybe (f <=< dmapToThese) $
825− fmapMaybe (f <=< dmapToThese)
826− $ merge
827− $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
1213+ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
828−
1214+
1215+-- | Produces an 'Event' that fires only when the input event fires with a 'DSum' key that
1216+-- matches the provided key.
1217+filterEventKey
1218+ :: forall t m k v a.
1219+ ( Reflex t
1220+ , MonadFix m
1221+ , MonadHold t m
1222+ , GEq k
1223+ )
1224+ => k a
1225+ -> Event t (DSum k v)
1226+ -> m (Event t (v a))
1227+filterEventKey k kv' = do
1228+ let f :: DSum k v -> Maybe (v a)
1229+ f (newK :=> newV) = case newK `geq` k of
1230+ Just Refl -> Just newV
1231+ Nothing -> Nothing
1232+ takeWhileJustE f kv'
1233+
1234+-- | "Factor" the input 'DSum' 'Event' to produce an 'Event' which
1235+-- fires when the 'DSum' key changes and contains both the value of the
1236+-- 'DSum' at switchover and an 'Event' of values produced by subsequent
1237+-- firings of the input 'Event' that do not change the 'DSum' key.
1238+factorEvent
1239+ :: forall t m k v a.
1240+ ( Reflex t
1241+ , MonadFix m
1242+ , MonadHold t m
1243+ , GEq k
1244+ )
1245+ => k a
1246+ -> Event t (DSum k v)
1247+ -> m (Event t (v a), Event t (DSum k (Product v (Compose (Event t) v))))
1248+factorEvent k0 kv' = do
1249+ key :: Behavior t (Some k) <- hold (Some k0) $ fmapCheap (\(k :=> _) -> Some k) kv'
1250+ let update = flip push kv' $ \(newKey :=> newVal) -> sample key >>= \case
1251+ Some oldKey -> case newKey `geq` oldKey of
1252+ Just Refl -> return Nothing
1253+ Nothing -> do
1254+ newInner <- filterEventKey newKey kv'
1255+ return $ Just $ newKey :=> Pair newVal (Compose newInner)
1256+ eInitial <- filterEventKey k0 kv'
1257+ return (eInitial, update)
829
1258
830--------------------------------------------------------------------------------
1259--------------------------------------------------------------------------------
831-- Accumulator
1260-- Accumulator
@@ -833,6 +1262,12 @@ alignWithMaybe f ea eb =
833
1262
834-- | An 'Accumulator' type can be built by accumulating occurrences of an
1263-- | An 'Accumulator' type can be built by accumulating occurrences of an
835-- 'Event'.
1264-- 'Event'.
1265+#if __GLASGOW_HASKELL__ < 802
1266+{-# WARNING accum "ghc < 8.2.1 doesn't seem to be able to specialize functions in this class, which can lead to poor performance" #-}
1267+{-# WARNING accumM "ghc < 8.2.1 doesn't seem to be able to specialize functions in this class, which can lead to poor performance" #-}
1268+{-# WARNING accumMaybe "ghc < 8.2.1 doesn't seem to be able to specialize functions in this class, which can lead to poor performance" #-}
1269+{-# WARNING accumMaybeM "ghc < 8.2.1 doesn't seem to be able to specialize functions in this class, which can lead to poor performance" #-}
1270+#endif
836class Reflex t => Accumulator t f | f -> t where
1271class Reflex t => Accumulator t f | f -> t where
837 accum :: (MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (f a)
1272 accum :: (MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (f a)
838 accum f = accumMaybe $ \v o -> Just $ f v o
1273 accum f = accumMaybe $ \v o -> Just $ f v o
@@ -849,61 +1284,239 @@ class Reflex t => Accumulator t f | f -> t where
849 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
1284 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
850 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
1285 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
851
1286
1287+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1288+-- with the provided function. See 'foldDyn'.
1289+accumDyn
1290+ :: (Reflex t, MonadHold t m, MonadFix m)
1291+ => (a -> b -> a)
1292+ -> a
1293+ -> Event t b
1294+ -> m (Dynamic t a)
1295+accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
1296+
1297+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1298+-- with the provided 'PushM' action.
1299+accumMDyn
1300+ :: (Reflex t, MonadHold t m, MonadFix m)
1301+ => (a -> b -> PushM t a)
1302+ -> a
1303+ -> Event t b
1304+ -> m (Dynamic t a)
1305+accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
1306+
1307+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1308+-- with the provided function, discarding 'Nothing' results.
1309+accumMaybeDyn
1310+ :: (Reflex t, MonadHold t m, MonadFix m)
1311+ => (a -> b -> Maybe a)
1312+ -> a
1313+ -> Event t b
1314+ -> m (Dynamic t a)
1315+accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
1316+
1317+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1318+-- with the provided 'PushM' action, discarding 'Nothing' results.
1319+accumMaybeMDyn
1320+ :: (Reflex t, MonadHold t m, MonadFix m)
1321+ => (a -> b -> PushM t (Maybe a))
1322+ -> a
1323+ -> Event t b
1324+ -> m (Dynamic t a)
1325+accumMaybeMDyn f z e = do
1326+ rec let e' = flip push e $ \o -> do
1327+ v <- sample $ current d'
1328+ f v o
1329+ d' <- holdDyn z e'
1330+ return d'
1331+
1332+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event'
1333+-- with a function that both accumulates and produces a value to fire
1334+-- as an 'Event'. Returns both the accumulated value and an 'Event'.
1335+mapAccumDyn
1336+ :: (Reflex t, MonadHold t m, MonadFix m)
1337+ => (a -> b -> (a, c))
1338+ -> a
1339+ -> Event t b
1340+ -> m (Dynamic t a, Event t c)
1341+mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
1342+
1343+-- | Similar to 'mapAccumDyn' except that the combining function is a
1344+-- 'PushM' action.
1345+mapAccumMDyn
1346+ :: (Reflex t, MonadHold t m, MonadFix m)
1347+ => (a -> b -> PushM t (a, c))
1348+ -> a
1349+ -> Event t b
1350+ -> m (Dynamic t a, Event t c)
1351+mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
1352+
1353+-- | Accumulate a 'Dynamic' by folding occurrences of an 'Event' with
1354+-- a function that both optionally accumulates and optionally produces
1355+-- a value to fire as a separate output 'Event'.
1356+-- Note that because 'Nothing's are discarded in both cases, the output
1357+-- 'Event' may fire even though the output 'Dynamic' has not changed, and
1358+-- the output 'Dynamic' may update even when the output 'Event' is not firing.
1359+mapAccumMaybeDyn
1360+ :: (Reflex t, MonadHold t m, MonadFix m)
1361+ => (a -> b -> (Maybe a, Maybe c))
1362+ -> a
1363+ -> Event t b
1364+ -> m (Dynamic t a, Event t c)
1365+mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
1366+
1367+-- | Like 'mapAccumMaybeDyn' except that the combining function is a
1368+-- 'PushM' action.
1369+mapAccumMaybeMDyn
1370+ :: (Reflex t, MonadHold t m, MonadFix m)
1371+ => (a -> b -> PushM t (Maybe a, Maybe c))
1372+ -> a
1373+ -> Event t b
1374+ -> m (Dynamic t a, Event t c)
1375+mapAccumMaybeMDyn f z e = do
1376+ rec let e' = flip push e $ \o -> do
1377+ v <- sample $ current d'
1378+ result <- f v o
1379+ return $ case result of
1380+ (Nothing, Nothing) -> Nothing
1381+ _ -> Just result
1382+ d' <- holdDyn z $ mapMaybe fst e'
1383+ return (d', mapMaybe snd e')
1384+
1385+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1386+-- with the provided function.
1387+{-# INLINE accumB #-}
1388+accumB
1389+ :: (Reflex t, MonadHold t m, MonadFix m)
1390+ => (a -> b -> a)
1391+ -> a
1392+ -> Event t b
1393+ -> m (Behavior t a)
1394+accumB f = accumMaybeB $ \v o -> Just $ f v o
1395+
1396+-- | Like 'accumB' except that the combining function is a 'PushM' action.
1397+{-# INLINE accumMB #-}
1398+accumMB
1399+ :: (Reflex t, MonadHold t m, MonadFix m)
1400+ => (a -> b -> PushM t a)
1401+ -> a
1402+ -> Event t b
1403+ -> m (Behavior t a)
1404+accumMB f = accumMaybeMB $ \v o -> Just <$> f v o
1405+
1406+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1407+-- with the provided function, discarding 'Nothing' results.
1408+{-# INLINE accumMaybeB #-}
1409+accumMaybeB
1410+ :: (Reflex t, MonadHold t m, MonadFix m)
1411+ => (a -> b -> Maybe a)
1412+ -> a
1413+ -> Event t b
1414+ -> m (Behavior t a)
1415+accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1416+
1417+-- | Like 'accumMaybeB' except that the combining function is a 'PushM' action.
1418+{-# INLINE accumMaybeMB #-}
1419+accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
1420+accumMaybeMB f z e = do
1421+ rec let e' = flip push e $ \o -> do
1422+ v <- sample d'
1423+ f v o
1424+ d' <- hold z e'
1425+ return d'
1426+
1427+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1428+-- with a function that both accumulates and produces a value to fire
1429+-- as an 'Event'. Returns both the accumulated value and an 'Event'.
1430+{-# INLINE mapAccumB #-}
1431+mapAccumB
1432+ :: (Reflex t, MonadHold t m, MonadFix m)
1433+ => (a -> b -> (a, c))
1434+ -> a
1435+ -> Event t b
1436+ -> m (Behavior t a, Event t c)
1437+mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1438+
1439+-- | Like 'mapAccumB' except that the combining function is a 'PushM' action.
1440+{-# INLINE mapAccumMB #-}
1441+mapAccumMB
1442+ :: (Reflex t, MonadHold t m, MonadFix m)
1443+ => (a -> b -> PushM t (a, c))
1444+ -> a
1445+ -> Event t b
1446+ -> m (Behavior t a, Event t c)
1447+mapAccumMB f = mapAccumMaybeMB $ \v o -> bimap Just Just <$> f v o
1448+
1449+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event' with
1450+-- a function that both optionally accumulates and optionally produces
1451+-- a value to fire as a separate output 'Event'. 'Nothing's are discarded.
1452+{-# INLINE mapAccumMaybeB #-}
1453+mapAccumMaybeB
1454+ :: (Reflex t, MonadHold t m, MonadFix m)
1455+ => (a -> b -> (Maybe a, Maybe c))
1456+ -> a
1457+ -> Event t b
1458+ -> m (Behavior t a, Event t c)
1459+mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
1460+
1461+-- | Like 'mapAccumMaybeB' except that the combining function is a 'PushM' action.
1462+{-# INLINE mapAccumMaybeMB #-}
1463+mapAccumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Behavior t a, Event t c)
1464+mapAccumMaybeMB f z e = do
1465+ rec let e' = flip push e $ \o -> do
1466+ v <- sample d'
1467+ result <- f v o
1468+ return $ case result of
1469+ (Nothing, Nothing) -> Nothing
1470+ _ -> Just result
1471+ d' <- hold z $ mapMaybe fst e'
1472+ return (d', mapMaybe snd e')
1473+
852-- | Accumulate occurrences of an 'Event', producing an output occurrence each
1474-- | Accumulate occurrences of an 'Event', producing an output occurrence each
853-- time. Discard the underlying 'Accumulator'.
1475-- time. Discard the underlying 'Accumulator'.
1476+{-# INLINE mapAccum_ #-}
854mapAccum_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Event t c)
1477mapAccum_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Event t c)
855mapAccum_ f z e = do
1478mapAccum_ f z e = do
856− (_ :: Behavior t a, result) <- mapAccum f z e
1479+ (_, result) <- mapAccumB f z e
857 return result
1480 return result
858
1481
859-- | Accumulate occurrences of an 'Event', possibly producing an output
1482-- | Accumulate occurrences of an 'Event', possibly producing an output
860-- occurrence each time. Discard the underlying 'Accumulator'.
1483-- occurrence each time. Discard the underlying 'Accumulator'.
1484+{-# INLINE mapAccumMaybe_ #-}
861mapAccumMaybe_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
1485mapAccumMaybe_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
862mapAccumMaybe_ f z e = do
1486mapAccumMaybe_ f z e = do
863− (_ :: Behavior t a, result) <- mapAccumMaybe f z e
1487+ (_, result) <- mapAccumMaybeB f z e
864 return result
1488 return result
865
1489
866-- | Accumulate occurrences of an 'Event', using a 'PushM' action and producing
1490-- | Accumulate occurrences of an 'Event', using a 'PushM' action and producing
867-- an output occurrence each time. Discard the underlying 'Accumulator'.
1491-- an output occurrence each time. Discard the underlying 'Accumulator'.
1492+{-# INLINE mapAccumM_ #-}
868mapAccumM_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Event t c)
1493mapAccumM_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Event t c)
869mapAccumM_ f z e = do
1494mapAccumM_ f z e = do
870− (_ :: Behavior t a, result) <- mapAccumM f z e
1495+ (_, result) <- mapAccumMB f z e
871 return result
1496 return result
872
1497
873-- | Accumulate occurrences of an 'Event', using a 'PushM' action and possibly
1498-- | Accumulate occurrences of an 'Event', using a 'PushM' action and possibly
874-- producing an output occurrence each time. Discard the underlying
1499-- producing an output occurrence each time. Discard the underlying
875-- 'Accumulator'.
1500-- 'Accumulator'.
1501+{-# INLINE mapAccumMaybeM_ #-}
876mapAccumMaybeM_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
1502mapAccumMaybeM_ :: forall t m a b c. (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Event t c)
877mapAccumMaybeM_ f z e = do
1503mapAccumMaybeM_ f z e = do
878− (_ :: Behavior t a, result) <- mapAccumMaybeM f z e
1504+ (_, result) <- mapAccumMaybeMB f z e
879 return result
1505 return result
880
1506
881instance Reflex t => Accumulator t (Dynamic t) where
1507instance Reflex t => Accumulator t (Dynamic t) where
882− accumMaybeM f z e = do
1508+ accumMaybeM = accumMaybeMDyn
883− rec let e' = flip push e $ \o -> do
884− v <- sample $ current d'
885− f v o
886− d' <- holdDyn z e'
887− return d'
888− mapAccumMaybeM f z e = do
1509+ mapAccumMaybeM = mapAccumMaybeMDyn
889− rec let e' = flip push e $ \o -> do
890− v <- sample $ current d'
891− result <- f v o
892− return $ case result of
893− (Nothing, Nothing) -> Nothing
894− _ -> Just result
895− d' <- holdDyn z $ fmapMaybe fst e'
896− return (d', fmapMaybe snd e')
897
1510
898instance Reflex t => Accumulator t (Behavior t) where
1511instance Reflex t => Accumulator t (Behavior t) where
899− accumMaybeM f z e = current <$> accumMaybeM f z e
1512+ accumMaybeM = accumMaybeMB
900− mapAccumMaybeM f z e = first current <$> mapAccumMaybeM f z e
1513+ mapAccumMaybeM = mapAccumMaybeMB
901
1514
902instance Reflex t => Accumulator t (Event t) where
1515instance Reflex t => Accumulator t (Event t) where
903 accumMaybeM f z e = updated <$> accumMaybeM f z e
1516 accumMaybeM f z e = updated <$> accumMaybeM f z e
904 mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
1517 mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
905
1518
906−-- | Create a new 'Event' by combining each occurence with the next value of the
1519+-- | Create a new 'Event' by combining each occurrence with the next value of the
907-- list using the supplied function. If the list runs out of items, all
1520-- list using the supplied function. If the list runs out of items, all
908-- subsequent 'Event' occurrences will be ignored.
1521-- subsequent 'Event' occurrences will be ignored.
909zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
1522zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
@@ -913,101 +1526,174 @@ zipListWithEvent f l e = do
913 _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
1526 _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
914 mapAccumMaybe_ f' l e
1527 mapAccumMaybe_ f' l e
915
1528
916−-- | A 'Monad' that supports adjustment over time. After an action has been
1529+-- | Assign a number to each occurrence of the given 'Event', starting from 0
917−-- run, if the given events fire, it will adjust itself so that its net effect
1530+{-# INLINE numberOccurrences #-}
918−-- is as though it had originally been run with the new value. Note that there
1531+numberOccurrences :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Event t (b, a))
919−-- is some issue here with persistent side-effects: obviously, IO (and some
1532+numberOccurrences = numberOccurrencesFrom 0
920−-- other side-effects) cannot be undone, so it is up to the instance implementer
1533+
921−-- to determine what the best meaning for this class is in such cases.
1534+-- | Assign a number to each occurrence of the given 'Event'
922−class (Reflex t, Monad m) => MonadAdjust t m | m -> t where
1535+{-# INLINE numberOccurrencesFrom #-}
923− runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
1536+numberOccurrencesFrom :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t (b, a))
924− traverseDMapWithKeyWithAdjust :: GCompare k => (forall a. k a -> v a -> m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> m (DMap k v', Event t (PatchDMap k v'))
1537+numberOccurrencesFrom = mapAccum_ (\n a -> let !next = n + 1 in (next, (n, a)))
925− traverseDMapWithKeyWithAdjustWithMove :: GCompare k => (forall a. k a -> v a -> m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> m (DMap k v', Event t (PatchDMapWithMove k v'))
1538+
926−
1539+-- | Assign a number to each occurrence of the given 'Event'; discard the occurrences' values
927−instance (Reflex t, MonadAdjust t m) => MonadAdjust t (ReaderT r m) where
1540+{-# INLINE numberOccurrencesFrom_ #-}
928− runWithReplace a0 a' = do
1541+numberOccurrencesFrom_ :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t b)
929− r <- ask
1542+numberOccurrencesFrom_ = mapAccum_ (\n _ -> let !next = n + 1 in (next, n))
930− lift $ runWithReplace (runReaderT a0 r) $ fmap (`runReaderT` r) a'
1543+
931− traverseDMapWithKeyWithAdjust f dm0 dm' = do
1544+-- | This is used to sample the value of a 'Behavior' using an 'Event'.
932− r <- ask
1545+--
933− lift $ traverseDMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
1546+-- The '<@>' operator is intended to be used in conjunction with
934− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
1547+-- the 'Applicative' instance for 'Behavior'.
935− r <- ask
1548+--
936− lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
1549+-- This is useful when we want to combine the values of one 'Event' and
937−
1550+-- the value of several 'Behavior's at the time the 'Event' is firing.
938−sequenceDMapWithAdjust :: (GCompare k, MonadAdjust t m) => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
1551+--
939−sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
1552+-- If we have:
940−
1553+--
941−sequenceDMapWithAdjustWithMove :: (GCompare k, MonadAdjust t m) => DMap k m -> Event t (PatchDMapWithMove k m) -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
1554+-- > f :: a -> b -> c -> d
942−sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
1555+-- > b1 :: Behavior t a
943−
1556+-- > b2 :: Behavior t b
944−mapMapWithAdjustWithMove :: forall t m k v v'. (MonadAdjust t m, Ord k) => (k -> v -> m v') -> Map k v -> Event t (PatchMapWithMove k v) -> m (Map k v', Event t (PatchMapWithMove k v'))
1557+-- > e :: Event t c
945−mapMapWithAdjustWithMove f m0 m' = do
1558+--
946− (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
1559+-- then we can do:
947− return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
1560+--
1561+-- > f <$> b1 <*> b2 <@> e :: Event t d
1562+--
1563+-- in order to apply the function 'f' to the relevant values.
1564+--
1565+-- The alternative would be something like:
1566+--
1567+-- > attachWith (\(x1, x2) y -> f x1 x2 y) ((,) <$> b1 <*> b2) e :: Event t d
1568+--
1569+-- or a variation involing a custom data type to hold the combination of
1570+-- 'Behavior's even when that combination might only ever be used by 'f'.
1571+--
1572+-- A more suggestive example might be:
1573+--
1574+-- > handleMouse <$> bPlayerState <*> bMousePosition <@> eMouseClick :: Event t (GameState -> GameState)
1575+--
1576+(<@>) :: Reflex t => Behavior t (a -> b) -> Event t a -> Event t b
1577+(<@>) b = push $ \x -> do
1578+ f <- sample b
1579+ return . Just . f $ x
1580+infixl 4 <@>
1581+
1582+-- | An version of '<@>' that does not use the value of the 'Event'.
1583+--
1584+-- Alternatively, it is 'tag' in operator form.
1585+--
1586+-- This is useful when we want to combine the values of several
1587+-- 'Behavior's at particular points in time using an 'Applicative'
1588+-- style syntax.
1589+--
1590+-- If we have:
1591+--
1592+-- > g :: a -> b -> d
1593+-- > b1 :: Behavior t a
1594+-- > b2 :: Behavior t b
1595+-- > e :: Event t c
1596+--
1597+-- where 'e' is firing at the points in time of interest.
1598+--
1599+-- Then we can use '<@':
1600+--
1601+-- > g <$> b1 <*> b2 <@ e :: Event t d
1602+--
1603+-- to combine the values of 'b1' and 'b2' at each of those points of time,
1604+-- with the function 'g' being used to combine the values.
1605+--
1606+-- This is the same as '<@>' except that the 'Event' is being used only
1607+-- to act as a trigger.
1608+(<@) :: (Reflex t) => Behavior t b -> Event t a -> Event t b
1609+(<@) = tag
1610+infixl 4 <@
948
1611
949------------------
1612------------------
950-- Cheap Functions
1613-- Cheap Functions
951------------------
1614------------------
952
1615
1616+-- | A "cheap" version of 'pushAlways'. See the performance note on 'pushCheap'.
953{-# INLINE pushAlwaysCheap #-}
1617{-# INLINE pushAlwaysCheap #-}
954pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
1618pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
955pushAlwaysCheap f = pushCheap (fmap Just . f)
1619pushAlwaysCheap f = pushCheap (fmap Just . f)
956
1620
1621+-- | A "cheap" version of 'mapMaybe'. See the performance note on 'pushCheap'.
1622+{-# INLINE mapMaybeCheap #-}
1623+mapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1624+mapMaybeCheap f = pushCheap $ return . f
1625+
1626+-- | An alias for 'mapMaybeCheap'
957{-# INLINE fmapMaybeCheap #-}
1627{-# INLINE fmapMaybeCheap #-}
958fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1628fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
959−fmapMaybeCheap f = pushCheap $ return . f
1629+fmapMaybeCheap = mapMaybeCheap
960
1630
1631+
1632+-- | A "cheap" version of 'fforMaybe'. See the performance note on 'pushCheap'.
961{-# INLINE fforMaybeCheap #-}
1633{-# INLINE fforMaybeCheap #-}
962fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1634fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
963−fforMaybeCheap = flip fmapMaybeCheap
1635+fforMaybeCheap = flip mapMaybeCheap
964
1636
1637+-- | A "cheap" version of 'ffor'. See the performance note on 'pushCheap'.
965{-# INLINE fforCheap #-}
1638{-# INLINE fforCheap #-}
966fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
1639fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
967fforCheap = flip fmapCheap
1640fforCheap = flip fmapCheap
968
1641
1642+-- | A "cheap" version of 'fmap'. See the performance note on 'pushCheap'.
969{-# INLINE fmapCheap #-}
1643{-# INLINE fmapCheap #-}
970fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
1644fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
971fmapCheap f = pushCheap $ return . Just . f
1645fmapCheap f = pushCheap $ return . Just . f
972
1646
1647+-- | A "cheap" version of 'tag'. See the performance note on 'pushCheap'.
973{-# INLINE tagCheap #-}
1648{-# INLINE tagCheap #-}
974tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
1649tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
975tagCheap b = pushAlwaysCheap $ \_ -> sample b
1650tagCheap b = pushAlwaysCheap $ \_ -> sample b
976
1651
1652+-- | Merge a collection of events; the resulting 'Event' will only occur if at
1653+-- least one input event is occurring, and will contain all of the input keys
1654+-- that are occurring simultaneously
1655+merge :: (Reflex t, GCompare k) => DMap k (Event t) -> Event t (DMap k Identity)
1656+merge = mergeG coerceEvent
1657+{-# INLINE merge #-}
1658+
1659+-- | Create a merge whose parents can change over time
1660+mergeIncremental :: (Reflex t, GCompare k)
1661+ => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
1662+mergeIncremental = mergeIncrementalG coerceEvent
1663+
1664+-- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
1665+mergeIncrementalWithMove :: (Reflex t, GCompare k)
1666+ => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
1667+mergeIncrementalWithMove = mergeIncrementalWithMoveG coerceEvent
1668+
1669+-- | A "cheap" version of 'mergeWithCheap'. See the performance note on 'pushCheap'.
977{-# INLINE mergeWithCheap #-}
1670{-# INLINE mergeWithCheap #-}
978mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
1671mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
979mergeWithCheap = mergeWithCheap' id
1672mergeWithCheap = mergeWithCheap' id
980
1673
1674+-- | A "cheap" version of 'mergeWithCheap''. See the performance note on 'pushCheap'.
981{-# INLINE mergeWithCheap' #-}
1675{-# INLINE mergeWithCheap' #-}
982mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
1676mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
983−mergeWithCheap' f g es = fmapCheap (Prelude.foldl1 g . map (\(Const2 _ :=> Identity v) -> f v) . DMap.toList)
1677+mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
984− . merge
1678+
1679+-- | A "cheap" version of 'mergeWithFoldCheap''. See the performance note on 'pushCheap'.
1680+{-# INLINE mergeWithFoldCheap' #-}
1681+mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
1682+mergeWithFoldCheap' f es =
1683+ fmapCheap (f . (\(h : t) -> h :| t) . IntMap.elems)
1684+ . mergeInt
985− . DMap.fromDistinctAscList
1685+ . IntMap.fromDistinctAscList
986− . map (\(k, v) -> Const2 k :=> v)
987− $ zip [0 :: Int ..] es
1686+ $ zip [0 :: Int ..] es
988
1687
989--------------------------------------------------------------------------------
1688--------------------------------------------------------------------------------
990-- Deprecated functions
1689-- Deprecated functions
991--------------------------------------------------------------------------------
1690--------------------------------------------------------------------------------
992
1691
993−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
1692+{-# DEPRECATED switchPromptly "Use 'switchHoldPromptly' instead. The 'switchHold*' naming convention was chosen because those functions are more closely related to each other than they are to 'switch'. " #-}
994−-- occurs. If both occur at the same time they are combined using 'mappend'.
1693+-- | See 'switchHoldPromptly'
995−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
996−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
1694+switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
997−appendEvents = alignWith $ mergeThese mappend
1695+switchPromptly = switchHoldPromptly
998−
1696+{-# DEPRECATED switchPromptOnly "Use 'switchHoldPromptOnly' instead. The 'switchHold*' naming convention was chosen because those functions are more closely related to each other than they are to 'switch'. " #-}
999−-- | Alias for 'headE'
1697+-- | See 'switchHoldPromptOnly'
1000−{-# DEPRECATED onceE "Use 'headE' instead" #-}
1698+switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
1001−onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
1699+switchPromptOnly = switchHoldPromptOnly
1002−onceE = headE
1003−
1004−-- | Run both sides of a 'These' monadically, combining the results.
1005−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
1006−#ifdef USE_TEMPLATE_HASKELL
1007−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
1008−#endif
1009−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
1010−sequenceThese t = case t of
1011− This ma -> fmap This ma
1012− These ma mb -> liftM2 These ma mb
1013− That mb -> fmap That mb
src/Reflex/Collection.hsnew file+225
@@ -0,0 +1,225 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE FlexibleInstances #-}
3+{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE RecursiveDo #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+#ifdef USE_REFLEX_OPTIMIZER
11+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12+#endif
13+-- |
14+-- Module:
15+-- Reflex.Collection
16+module Reflex.Collection
17+ (
18+ -- * Widgets on Collections
19+ listHoldWithKey
20+ , listWithKey
21+ , listWithKeyShallowDiff
22+ , listViewWithKey
23+ , selectViewListWithKey
24+ , selectViewListWithKey_
25+ -- * List Utils
26+ , list
27+ , simpleList
28+ ) where
29+
30+#ifdef MIN_VERSION_semialign
31+import Prelude hiding (zip, zipWith)
32+#if MIN_VERSION_semialign(1,1,0)
33+import Data.Zip (Zip (..))
34+#endif
35+#endif
36+
37+import Control.Monad.Identity
38+import Data.Align
39+import Data.Functor.Misc
40+import Data.Map (Map)
41+import qualified Data.Map as Map
42+import Data.Map.Misc
43+import Data.These
44+
45+import Reflex.Class
46+import Reflex.Adjustable.Class
47+import Reflex.Dynamic
48+import Reflex.PostBuild.Class
49+
50+-- | Create a set of widgets based on the provided 'Map'. When the
51+-- input 'Event' fires, remove widgets for keys with the value 'Nothing'
52+-- and add/replace widgets for keys with 'Just' values.
53+listHoldWithKey
54+ :: forall t m k v a
55+ . (Ord k, Adjustable t m, MonadHold t m)
56+ => Map k v
57+ -> Event t (Map k (Maybe v))
58+ -> (k -> v -> m a)
59+ -> m (Dynamic t (Map k a))
60+listHoldWithKey m0 m' f = do
61+ let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
62+ dm' = fmap
63+ (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey
64+ (\k v -> ComposeMaybe $ fmap (f k) v)
65+ )
66+ m'
67+ (a0, a') <- sequenceDMapWithAdjust dm0 dm'
68+
69+ --TODO: Move the dmapToMap to the righthand side so it doesn't get
70+ --fully redone every time
71+ fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a'
72+
73+--TODO: Something better than Dynamic t (Map k v) - we want something
74+--where the Events carry diffs, not the whole value
75+listWithKey
76+ :: forall t k v m a
77+ . (Ord k, Adjustable t m, PostBuild t m, MonadFix m, MonadHold t m)
78+ => Dynamic t (Map k v)
79+ -> (k -> Dynamic t v -> m a)
80+ -> m (Dynamic t (Map k a))
81+listWithKey vals mkChild = do
82+ postBuild <- getPostBuild
83+ let childValChangedSelector = fanMap $ updated vals
84+
85+ -- We keep track of changes to children values in the mkChild
86+ -- function we pass to listHoldWithKey The other changes we need
87+ -- to keep track of are child insertions and
88+ -- deletions. diffOnlyKeyChanges keeps track of insertions and
89+ -- deletions but ignores value changes, since they're already
90+ -- accounted for.
91+ diffOnlyKeyChanges olds news =
92+ flip Map.mapMaybe (align olds news) $ \case
93+ This _ -> Just Nothing
94+ These _ _ -> Nothing
95+ That new -> Just $ Just new
96+ rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
97+ let changeVals :: Event t (Map k (Maybe v))
98+ changeVals =
99+ attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
100+ [ updated vals
101+
102+ -- TODO: This should probably be added to the
103+ -- attachWith, not to the updated; if we were using
104+ -- diffMap instead of diffMapNoEq, I think it might not
105+ -- work
106+ , tag (current vals) postBuild
107+ ]
108+ listHoldWithKey Map.empty changeVals $ \k v ->
109+ mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
110+
111+-- | Display the given map of items (in key order) using the builder
112+-- function provided, and update it with the given event. 'Nothing'
113+-- update entries will delete the corresponding children, and 'Just'
114+-- entries will create them if they do not exist or send an update
115+-- event to them if they do.
116+listWithKeyShallowDiff
117+ :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m)
118+ => Map k v
119+ -> Event t (Map k (Maybe v))
120+ -> (k -> v -> Event t v -> m a)
121+ -> m (Dynamic t (Map k a))
122+listWithKeyShallowDiff initialVals valsChanged mkChild = do
123+ let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
124+ sentVals <- foldDyn applyMap (void initialVals) $ fmap (fmap void) valsChanged
125+ let relevantPatch patch _ = case patch of
126+
127+ -- Even if we let a Nothing through when the element doesn't
128+ -- already exist, this doesn't cause a problem because it is
129+ -- ignored
130+ Nothing -> Just Nothing
131+
132+ -- We don't want to let spurious re-creations of items through
133+ Just _ -> Nothing
134+ listHoldWithKey
135+ initialVals
136+ (attachWith (flip (Map.differenceWith relevantPatch))
137+ (current sentVals)
138+ valsChanged
139+ )
140+ $ \k v -> mkChild k v $ select childValChangedSelector $ Const2 k
141+
142+--TODO: Something better than Dynamic t (Map k v) - we want something
143+--where the Events carry diffs, not the whole value
144+-- | Create a dynamically-changing set of Event-valued widgets. This
145+-- is like 'listWithKey', specialized for widgets returning @/Event t a/@.
146+-- 'listWithKey' would return @/Dynamic t (Map k (Event t a))/@ in
147+-- this scenario, but 'listViewWithKey' flattens this to
148+-- @/Event t (Map k a)/@ via 'switch'.
149+listViewWithKey
150+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
151+ => Dynamic t (Map k v)
152+ -> (k -> Dynamic t v -> m (Event t a))
153+ -> m (Event t (Map k a))
154+listViewWithKey vals mkChild =
155+ switch . fmap mergeMap <$> listViewWithKey' vals mkChild
156+
157+listViewWithKey'
158+ :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m)
159+ => Dynamic t (Map k v)
160+ -> (k -> Dynamic t v -> m a)
161+ -> m (Behavior t (Map k a))
162+listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
163+
164+-- | Create a dynamically-changing set of widgets, one of which is
165+-- selected at any time.
166+selectViewListWithKey
167+ :: forall t m k v a
168+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
169+ => Dynamic t k
170+ -- ^ Current selection key
171+ -> Dynamic t (Map k v)
172+ -- ^ Dynamic key/value map
173+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
174+ -- ^ Function to create a widget for a given key from Dynamic value
175+ -- and Dynamic Bool indicating if this widget is currently selected
176+ -> m (Event t (k, a))
177+ -- ^ Event that fires when any child's return Event fires. Contains
178+ -- key of an arbitrary firing widget.
179+selectViewListWithKey selection vals mkChild = do
180+ -- For good performance, this value must be shared across all children
181+ let selectionDemux = demux selection
182+ selectChild <- listWithKey vals $ \k v -> do
183+ let selected = demuxed selectionDemux k
184+ selectSelf <- mkChild k v selected
185+ return $ fmap ((,) k) selectSelf
186+ return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
187+
188+-- | Like 'selectViewListWithKey' but discards the value of the list
189+-- item widget's output 'Event'.
190+selectViewListWithKey_
191+ :: forall t m k v a
192+ . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
193+ => Dynamic t k
194+ -- ^ Current selection key
195+ -> Dynamic t (Map k v)
196+ -- ^ Dynamic key/value map
197+ -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a))
198+ -- ^ Function to create a widget for a given key from Dynamic value
199+ -- and Dynamic Bool indicating if this widget is currently selected
200+ -> m (Event t k)
201+ -- ^ Event that fires when any child's return Event fires. Contains
202+ -- key of an arbitrary firing widget.
203+selectViewListWithKey_ selection vals mkChild =
204+ fmap fst <$> selectViewListWithKey selection vals mkChild
205+
206+-- | Create a dynamically-changing set of widgets from a Dynamic
207+-- key/value map. Unlike the 'withKey' variants, the child widgets
208+-- are insensitive to which key they're associated with.
209+list
210+ :: (Ord k, Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
211+ => Dynamic t (Map k v)
212+ -> (Dynamic t v -> m a)
213+ -> m (Dynamic t (Map k a))
214+list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
215+
216+-- | Create a dynamically-changing set of widgets from a Dynamic list.
217+simpleList
218+ :: (Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m)
219+ => Dynamic t [v]
220+ -> (Dynamic t v -> m a)
221+ -> m (Dynamic t [a])
222+simpleList xs mkChild =
223+ fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap
224+ (Map.fromList . zip [(1 :: Int) ..])
225+ xs
src/Reflex/Dynamic.hs+160−201
@@ -8,45 +8,63 @@
8{-# LANGUAGE NoMonomorphismRestriction #-}
8{-# LANGUAGE NoMonomorphismRestriction #-}
9{-# LANGUAGE PolyKinds #-}
9{-# LANGUAGE PolyKinds #-}
10{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE RankNTypes #-}
11+{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE ScopedTypeVariables #-}
12{-# LANGUAGE ScopedTypeVariables #-}
13+{-# LANGUAGE StandaloneDeriving #-}
12{-# LANGUAGE TypeFamilies #-}
14{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeOperators #-}
15{-# LANGUAGE TypeOperators #-}
14{-# LANGUAGE UndecidableInstances #-}
16{-# LANGUAGE UndecidableInstances #-}
15#ifdef USE_REFLEX_OPTIMIZER
17#ifdef USE_REFLEX_OPTIMIZER
16{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
18{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
17#endif
19#endif
20+-- |
21+-- Module:
22+-- Reflex.Dynamic
23+-- Description:
18−-- | This module contains various functions for working with 'Dynamic' values.
24+-- This module contains various functions for working with 'Dynamic' values.
19−-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
25+-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
20module Reflex.Dynamic
26module Reflex.Dynamic
21 ( -- * Basics
27 ( -- * Basics
22 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
28 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
23 , current
29 , current
24 , updated
30 , updated
25 , holdDyn
31 , holdDyn
32+ , mapDynM
33+ , forDynM
26 , constDyn
34 , constDyn
27− , uniqDyn
28− , uniqDynBy
29 , count
35 , count
30 , toggle
36 , toggle
37+ , switchDyn
31 , switchPromptlyDyn
38 , switchPromptlyDyn
32 , tagPromptlyDyn
39 , tagPromptlyDyn
33 , attachPromptlyDyn
40 , attachPromptlyDyn
34 , attachPromptlyDynWith
41 , attachPromptlyDynWith
35 , attachPromptlyDynWithMaybe
42 , attachPromptlyDynWithMaybe
43+ , maybeDyn
44+ , eitherDyn
45+ , factorDyn
46+ , scanDyn
47+ , scanDynMaybe
48+ , holdUniqDyn
49+ , holdUniqDynBy
50+ , improvingMaybe
36 , foldDyn
51 , foldDyn
37 , foldDynM
52 , foldDynM
38 , foldDynMaybe
53 , foldDynMaybe
39 , foldDynMaybeM
54 , foldDynMaybeM
40 , joinDynThroughMap
55 , joinDynThroughMap
56+ , joinDynThroughIntMap
41 , traceDyn
57 , traceDyn
42 , traceDynWith
58 , traceDynWith
43 , splitDynPure
59 , splitDynPure
44 , distributeMapOverDynPure
60 , distributeMapOverDynPure
61+ , distributeIntMapOverDynPure
45 , distributeDMapOverDynPure
62 , distributeDMapOverDynPure
46 , distributeListOverDynPure
63 , distributeListOverDynPure
47 , Demux
64 , Demux
48 , demux
65 , demux
49 , demuxed
66 , demuxed
67+ -- * Miscellaneous
50 -- Things that probably aren't very useful:
68 -- Things that probably aren't very useful:
51 , HList (..)
69 , HList (..)
52 , FHList (..)
70 , FHList (..)
@@ -56,72 +74,80 @@ module Reflex.Dynamic
56 , AllAreFunctors (..)
74 , AllAreFunctors (..)
57 , HListPtr (..)
75 , HListPtr (..)
58 , distributeFHListOverDynPure
76 , distributeFHListOverDynPure
59− -- Unsafe
77+ -- * Unsafe
60 , unsafeDynamic
78 , unsafeDynamic
61− -- * Deprecated functions
62− , apDyn
63− , attachDyn
64− , attachDynWith
65− , attachDynWithMaybe
66− , collectDyn
67− , combineDyn
68− , distributeDMapOverDyn
69− , distributeFHListOverDyn
70− , forDyn
71− , forDynM
72− , getDemuxed
73− , joinDyn
74− , mapDyn
75− , mapDynM
76− , mconcatDyn
77− , nubDyn
78− , splitDyn
79− , tagDyn
80 ) where
79 ) where
81
80
82−import Prelude hiding (mapM, mapM_)
81+import Data.Functor.Compose
83−
84import Data.Functor.Misc
82import Data.Functor.Misc
85import Reflex.Class
83import Reflex.Class
86
84
87−import Control.Applicative ((<*>))
85+import Control.Monad
88−import Control.Monad hiding (forM, forM_, mapM, mapM_)
89import Control.Monad.Fix
86import Control.Monad.Fix
90−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
87+import Control.Monad.Identity
91import Data.Align
88import Data.Align
92import Data.Dependent.Map (DMap)
89import Data.Dependent.Map (DMap)
93import qualified Data.Dependent.Map as DMap
90import qualified Data.Dependent.Map as DMap
94import Data.Dependent.Sum (DSum (..))
91import Data.Dependent.Sum (DSum (..))
95−import Data.GADT.Compare ((:~:) (..), GCompare (..), GEq (..), GOrdering (..))
92+import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
93+import Data.IntMap (IntMap)
94+import qualified Data.IntMap as IntMap
96import Data.Map (Map)
95import Data.Map (Map)
97−import Data.Monoid
96+import Data.Maybe
97+import Data.Monoid ((<>))
98import Data.These
98import Data.These
99+import Data.Type.Equality ((:~:) (..))
99
100
100import Debug.Trace
101import Debug.Trace
101
102
103+-- | Map a sampling function over a 'Dynamic'.
104+mapDynM :: forall t m a b. (Reflex t, MonadHold t m) => (forall m'. MonadSample t m' => a -> m' b) -> Dynamic t a -> m (Dynamic t b)
105+mapDynM f d = buildDynamic (f =<< sample (current d)) $ pushAlways f (updated d)
106+
107+-- | Flipped version of 'mapDynM'
108+forDynM :: forall t m a b. (Reflex t, MonadHold t m) => Dynamic t a -> (forall m'. MonadSample t m' => a -> m' b) -> m (Dynamic t b)
109+forDynM d f = mapDynM f d
110+
102-- | Create a new 'Dynamic' that only signals changes if the values actually
111-- | Create a new 'Dynamic' that only signals changes if the values actually
103-- changed.
112-- changed.
104−uniqDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
113+holdUniqDyn :: (Reflex t, MonadHold t m, MonadFix m, Eq a) => Dynamic t a -> m (Dynamic t a)
105−uniqDyn = uniqDynBy (==)
114+holdUniqDyn = holdUniqDynBy (==)
106
115
107-- | Create a new 'Dynamic' that changes only when the underlying 'Dynamic'
116-- | Create a new 'Dynamic' that changes only when the underlying 'Dynamic'
108-- changes and the given function returns 'False' when given both the old and
117-- changes and the given function returns 'False' when given both the old and
109-- the new values.
118-- the new values.
110−uniqDynBy :: Reflex t => (a -> a -> Bool) -> Dynamic t a -> Dynamic t a
119+holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
111−uniqDynBy eq d =
120+holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
112− let e' = attachWithMaybe (\x x' -> if x' `eq` x then Nothing else Just x') (current d) (updated d)
121+
122+-- | @/Dynamic Maybe/@ that can only update from @/Nothing/@ to @/Just/@ or @/Just/@ to @/Just/@ (i.e., cannot revert to @/Nothing/@)
123+improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
124+improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
125+
126+-- | Create a 'Dynamic' that accumulates values from another 'Dynamic'. This
127+-- function does not force its input 'Dynamic' until the output 'Dynamic' is
128+-- forced.
129+scanDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b) -> (a -> b -> b) -> Dynamic t a -> m (Dynamic t b)
130+scanDyn z f = scanDynMaybe z (\a b -> Just $ f a b)
131+
132+-- | Like 'scanDyn', but the the accumulator function may decline to update the
133+-- result 'Dynamic''s value.
134+scanDynMaybe :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b) -> (a -> b -> Maybe b) -> Dynamic t a -> m (Dynamic t b)
135+scanDynMaybe z f d = do
136+ rec d' <- buildDynamic (z <$> sample (current d)) $ flip push (updated d) $ \a -> do
113− in unsafeDynamic (current d) e'
137+ b <- sample $ current d'
138+ return $ f a b
139+ return d'
114
140
115-- | Create a 'Dynamic' using the initial value and change it each time the
141-- | Create a 'Dynamic' using the initial value and change it each time the
116-- 'Event' occurs using a folding function on the previous value and the value
142-- 'Event' occurs using a folding function on the previous value and the value
117-- of the 'Event'.
143-- of the 'Event'.
118foldDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> b) -> b -> Event t a -> m (Dynamic t b)
144foldDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> b) -> b -> Event t a -> m (Dynamic t b)
119−foldDyn = accum . flip
145+foldDyn = accumDyn . flip
120
146
121-- | Like 'foldDyn', but the combining function is a 'PushM' action, so it
147-- | Like 'foldDyn', but the combining function is a 'PushM' action, so it
122-- can 'sample' existing 'Behaviors' and 'hold' new ones.
148-- can 'sample' existing 'Behaviors' and 'hold' new ones.
123foldDynM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t b) -> b -> Event t a -> m (Dynamic t b)
149foldDynM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t b) -> b -> Event t a -> m (Dynamic t b)
124−foldDynM = accumM . flip
150+foldDynM = accumMDyn . flip
125
151
126-- | Create a 'Dynamic' using the provided initial value and change it each time
152-- | Create a 'Dynamic' using the provided initial value and change it each time
127-- the provided 'Event' occurs, using a function to combine the old value with
153-- the provided 'Event' occurs, using a function to combine the old value with
@@ -130,14 +156,14 @@ foldDynM = accumM . flip
130-- 'Dynamic''s 'updated' 'Event' will fire in the 'Just' case, and will not fire
156-- 'Dynamic''s 'updated' 'Event' will fire in the 'Just' case, and will not fire
131-- in the 'Nothing' case.
157-- in the 'Nothing' case.
132foldDynMaybe :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe b) -> b -> Event t a -> m (Dynamic t b)
158foldDynMaybe :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe b) -> b -> Event t a -> m (Dynamic t b)
133−foldDynMaybe = accumMaybe . flip
159+foldDynMaybe = accumMaybeDyn . flip
134
160
135-- | Like 'foldDynMaybe', but the combining function is a 'PushM' action, so it
161-- | Like 'foldDynMaybe', but the combining function is a 'PushM' action, so it
136-- can 'sample' existing 'Behaviors' and 'hold' new ones.
162-- can 'sample' existing 'Behaviors' and 'hold' new ones.
137foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
163foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
138−foldDynMaybeM = accumMaybeM . flip
164+foldDynMaybeM = accumMaybeMDyn . flip
139
165
140−-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
166+-- | Create a new 'Dynamic' that counts the occurrences of the 'Event'.
141count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
167count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
142count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
168count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
143
169
@@ -146,10 +172,25 @@ count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
146toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
172toggle :: (Reflex t, MonadHold t m, MonadFix m) => Bool -> Event t a -> m (Dynamic t Bool)
147toggle = foldDyn (const not)
173toggle = foldDyn (const not)
148
174
175+-- | Switches to the new 'Event' whenever it receives one. Only the old event is
176+-- considered the moment a new one is switched in; the output event will fire at
177+-- that moment if only if the old event does.
178+--
179+-- Prefer this to 'switchPromptlyDyn' where possible. The lack of doing double
180+-- work when the outer and (new) inner fires means this imposes fewer "timing
181+-- requirements" and thus is far more easy to use without introducing fresh
182+-- failure cases. 'switchDyn' is also more performant.
183+switchDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
184+switchDyn d = switch (current d)
185+
149-- | Switches to the new 'Event' whenever it receives one. Switching occurs
186-- | Switches to the new 'Event' whenever it receives one. Switching occurs
150−-- *before* the inner 'Event' fires - so if the 'Dynamic' changes and both the
187+-- __before__ the inner 'Event' fires - so if the 'Dynamic' changes and both the
151-- old and new inner Events fire simultaneously, the output will fire with the
188-- old and new inner Events fire simultaneously, the output will fire with the
152−-- value of the *new* 'Event'.
189+-- value of the __new__ 'Event'.
190+--
191+-- Prefer 'switchDyn' to this where possible. The timing requirements that
192+-- switching before imposes are likely to bring down your app unless you are
193+-- very careful. 'switchDyn' is also more performant.
153switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
194switchPromptlyDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
154switchPromptlyDyn de =
195switchPromptlyDyn de =
155 let eLag = switch $ current de
196 let eLag = switch $ current de
@@ -165,28 +206,31 @@ splitDynPure d = (fmap fst d, fmap snd d)
165distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
206distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
166distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
207distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
167
208
209+-- | Convert an 'IntMap' with 'Dynamic' elements into a 'Dynamic' of an 'IntMap' with
210+-- non-'Dynamic' elements.
211+distributeIntMapOverDynPure :: (Reflex t) => IntMap (Dynamic t v) -> Dynamic t (IntMap v)
212+distributeIntMapOverDynPure = fmap dmapToIntMap . distributeDMapOverDynPure . intMapWithFunctorToDMap
213+
168-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
214-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
169-- non-'Dynamic' elements, preserving the order of the elements.
215-- non-'Dynamic' elements, preserving the order of the elements.
216+{-# DEPRECATED distributeListOverDynPure "Use 'distributeListOverDyn' instead" #-}
170distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
217distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
171−distributeListOverDynPure =
218+distributeListOverDynPure = distributeListOverDyn
172− fmap (map fromDSum . DMap.toAscList) .
173− distributeDMapOverDynPure .
174− DMap.fromDistinctAscList .
175− zipWith toDSum [0..]
176− where
177− toDSum :: Int -> Dynamic t a -> DSum (Const2 Int a) (Dynamic t)
178− toDSum k v = Const2 k :=> v
179− fromDSum :: DSum (Const2 Int a) Identity -> a
180− fromDSum (Const2 _ :=> Identity v) = v
181
219
182--TODO: Generalize this to functors other than Maps
220--TODO: Generalize this to functors other than Maps
183-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
221-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
184-- with the current values of the 'Dynamic's in a map.
222-- with the current values of the 'Dynamic's in a map.
185joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
223joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
186−joinDynThroughMap = joinDyn . fmap distributeMapOverDynPure
224+joinDynThroughMap = (distributeMapOverDynPure =<<)
187
225
226+-- | Combine a 'Dynamic' of an 'IntMap' of 'Dynamic's into a 'Dynamic'
227+-- with the current values of the 'Dynamic's in a map.
228+joinDynThroughIntMap :: forall t a. (Reflex t) => Dynamic t (IntMap (Dynamic t a)) -> Dynamic t (IntMap a)
229+joinDynThroughIntMap = (distributeIntMapOverDynPure =<<)
230+
188−-- | Print the value of the 'Dynamic' on each change and prefix it
231+-- | Print the value of the 'Dynamic' when it is first read and on each
232+-- subsequent change that is observed (as 'traceEvent'), prefixed with the
189−-- with the provided string. This should /only/ be used for debugging.
233+-- provided string. This should /only/ be used for debugging.
190--
234--
191-- Note: Just like Debug.Trace.trace, the value will only be shown if something
235-- Note: Just like Debug.Trace.trace, the value will only be shown if something
192-- else in the system is depending on it.
236-- else in the system is depending on it.
@@ -194,7 +238,8 @@ traceDyn :: (Reflex t, Show a) => String -> Dynamic t a -> Dynamic t a
194traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
238traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
195
239
196-- | Print the result of applying the provided function to the value
240-- | Print the result of applying the provided function to the value
197−-- of the 'Dynamic' on each change. This should /only/ be used for
241+-- of the 'Dynamic' when it is first read and on each subsequent change
242+-- that is observed (as 'traceEvent'). This should /only/ be used for
198-- debugging.
243-- debugging.
199--
244--
200-- Note: Just like Debug.Trace.trace, the value will only be shown if something
245-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -210,36 +255,35 @@ traceDynWith f d =
210-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
255-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
211-- each time the 'Event' occurs.
256-- each time the 'Event' occurs.
212--
257--
213−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
258+-- Note: @/tagPromptlyDyn d e/@ differs from @/tag (current d) e/@ in the case that @/e/@ is firing
214−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
259+-- at the same time that @/d/@ is changing. With @/tagPromptlyDyn d e/@, the __new__ value of @/d/@
215−-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
260+-- will replace the value of @/e/@, whereas with @/tag (current d) e/@, the __old__ value
216-- will be used, since the 'Behavior' won't be updated until the end of the frame.
261-- will be used, since the 'Behavior' won't be updated until the end of the frame.
217-- Additionally, this means that the output 'Event' may not be used to directly change
262-- Additionally, this means that the output 'Event' may not be used to directly change
218−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
263+-- the input 'Dynamic', because that would mean its value depends on itself. __When creating__
219−-- cyclic data flows, generally `tag (current d) e` is preferred.
264+-- __cyclic data flows, generally @/tag (current d) e/@ is preferred.__
220tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
265tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
221tagPromptlyDyn = attachPromptlyDynWith const
266tagPromptlyDyn = attachPromptlyDynWith const
222
267
223-- | Attach the current value of the 'Dynamic' to the value of the
268-- | Attach the current value of the 'Dynamic' to the value of the
224-- 'Event' each time it occurs.
269-- 'Event' each time it occurs.
225--
270--
226−-- Note: `attachPromptlyDyn d` is not the same as `attach (current d)`. See 'tagPromptlyDyn' for details.
271+-- Note: @/attachPromptlyDyn d/@ is not the same as @/attach (current d)/@. See 'tagPromptlyDyn' for details.
227attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
272attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
228attachPromptlyDyn = attachPromptlyDynWith (,)
273attachPromptlyDyn = attachPromptlyDynWith (,)
229
274
230-- | Combine the current value of the 'Dynamic' with the value of the
275-- | Combine the current value of the 'Dynamic' with the value of the
231-- 'Event' each time it occurs.
276-- 'Event' each time it occurs.
232--
277--
233−-- Note: `attachPromptlyDynWith f d` is not the same as `attachWith f (current d)`. See 'tagPromptlyDyn' for details.
278+-- Note: @/attachPromptlyDynWith f d/@ is not the same as @/attachWith f (current d)/@. See 'tagPromptlyDyn' for details.
234attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
279attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
235attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
280attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
236
281
237−-- | Create a new 'Event' by combining the value at each occurence with the
282+-- | Create a new 'Event' by combining the value at each occurrence with the
238-- current value of the 'Dynamic' value and possibly filtering if the combining
283-- current value of the 'Dynamic' value and possibly filtering if the combining
239-- function returns 'Nothing'.
284-- function returns 'Nothing'.
240--
285--
241−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
286+-- Note: @/attachPromptlyDynWithMaybe f d/@ is not the same as @/attachWithMaybe f (current d)/@. See 'tagPromptlyDyn' for details.
242−-- (current d)`. See 'tagPromptlyDyn' for details.
243attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
287attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
244attachPromptlyDynWithMaybe f d e =
288attachPromptlyDynWithMaybe f d e =
245 let e' = attach (current d) e
289 let e' = attach (current d) e
@@ -248,6 +292,49 @@ attachPromptlyDynWithMaybe f d e =
248 These (_, b) a -> f a b -- Both events are firing, so use the newer value
292 These (_, b) a -> f a b -- Both events are firing, so use the newer value
249 That _ -> Nothing -- The tagging event isn't firing, so don't fire
293 That _ -> Nothing -- The tagging event isn't firing, so don't fire
250
294
295+-- | Factor a @/Dynamic t (Maybe a)/@ into a @/Dynamic t (Maybe (Dynamic t a))/@,
296+-- such that the outer 'Dynamic' is updated only when the "Maybe"'s constructor
297+-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
298+-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
299+-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
300+-- existing inner 'Dynamic' will become constant, and will not change when the
301+-- outer constructor changes back to 'Nothing'.
302+maybeDyn :: forall t a m. (Reflex t, MonadFix m, MonadHold t m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe (Dynamic t a)))
303+maybeDyn = fmap (fmap unpack) . eitherDyn . fmap pack
304+ where pack = \case
305+ Nothing -> Left ()
306+ Just a -> Right a
307+ unpack = \case
308+ Left _ -> Nothing
309+ Right a -> Just a
310+
311+-- | Turns a 'Dynamic t (Either a b)' into a 'Dynamic t (Either (Dynamic t a) (Dynamic t b))' such that
312+-- the outer 'Dynamic' is updated only when the 'Either' constructor changes (e.g., from 'Left' to 'Right').
313+eitherDyn :: forall t a b m. (Reflex t, MonadFix m, MonadHold t m) => Dynamic t (Either a b) -> m (Dynamic t (Either (Dynamic t a) (Dynamic t b)))
314+eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
315+ where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
316+ unpack = \case
317+ LeftTag :=> Compose a -> Left $ coerceDynamic a
318+ RightTag :=> Compose b -> Right $ coerceDynamic b
319+
320+-- | Factor a 'Dynamic t DSum' into a 'Dynamic' 'DSum' containing nested 'Dynamic' values.
321+-- The outer 'Dynamic' updates only when the key of the 'DSum' changes, while the update of the inner
322+-- 'Dynamic' represents updates within the current key.
323+factorDyn :: forall t m k v. (Reflex t, MonadHold t m, GEq k)
324+ => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
325+factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
326+ update :: Event t (DSum k (Compose (Dynamic t) v))
327+ update = flip push (updated d) $ \(newKey :=> newVal) -> do
328+ (oldKey :=> _) <- sample (current d)
329+ case newKey `geq` oldKey of
330+ Just Refl -> return Nothing
331+ Nothing -> Just <$> holdKey (newKey :=> newVal)
332+
333+ holdKey (k :=> v) = do
334+ inner' <- filterEventKey k (updated d)
335+ inner <- holdDyn v inner'
336+ return $ k :=> Compose inner
337+
251--------------------------------------------------------------------------------
338--------------------------------------------------------------------------------
252-- Demux
339-- Demux
253--------------------------------------------------------------------------------
340--------------------------------------------------------------------------------
@@ -261,7 +348,7 @@ attachPromptlyDynWithMaybe f d e =
261--
348--
262-- > demuxed (demux d) k === fmap (== k) d
349-- > demuxed (demux d) k === fmap (== k) d
263--
350--
264−-- However, the when getDemuxed is used multiple times, the complexity is only
351+-- However, when 'demuxed' is used multiple times, the complexity is only
265-- /O(log(n))/, rather than /O(n)/ for fmap.
352-- /O(log(n))/, rather than /O(n)/ for fmap.
266data Demux t k = Demux { demuxValue :: Behavior t k
353data Demux t k = Demux { demuxValue :: Behavior t k
267 , demuxSelector :: EventSelector t (Const2 k Bool)
354 , demuxSelector :: EventSelector t (Const2 k Bool)
@@ -347,6 +434,9 @@ data HListPtr l a where
347 HHeadPtr :: HListPtr (h ': t) h
434 HHeadPtr :: HListPtr (h ': t) h
348 HTailPtr :: HListPtr t a -> HListPtr (h ': t) a
435 HTailPtr :: HListPtr t a -> HListPtr (h ': t) a
349
436
437+deriving instance Eq (HListPtr l a)
438+deriving instance Ord (HListPtr l a)
439+
350fhlistToDMap :: forall (f :: * -> *) l. FHList f l -> DMap (HListPtr l) f
440fhlistToDMap :: forall (f :: * -> *) l. FHList f l -> DMap (HListPtr l) f
351fhlistToDMap = DMap.fromList . go
441fhlistToDMap = DMap.fromList . go
352 where go :: forall l'. FHList f l' -> [DSum (HListPtr l') f]
442 where go :: forall l'. FHList f l' -> [DSum (HListPtr l') f]
@@ -412,7 +502,7 @@ instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
412
502
413-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
503-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
414-- single 'Dynamic' whose value represents all the current values of the input's
504-- single 'Dynamic' whose value represents all the current values of the input's
415−-- consitutent 'Dynamic's.
505+-- constituent 'Dynamic's.
416collectDynPure :: ( RebuildSortedHList (HListElems b)
506collectDynPure :: ( RebuildSortedHList (HListElems b)
417 , IsHList a, IsHList b
507 , IsHList a, IsHList b
418 , AllAreFunctors (Dynamic t) (HListElems b)
508 , AllAreFunctors (Dynamic t) (HListElems b)
@@ -453,134 +543,3 @@ instance IsHList (a, b, c, d, e, f) where
453#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
543#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
454 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
544 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
455#endif
545#endif
456−
457−--------------------------------------------------------------------------------
458−-- Deprecated functions
459−--------------------------------------------------------------------------------
460−
461−-- | Map a function over a 'Dynamic'.
462−{-# DEPRECATED mapDyn "Use 'return . fmap f' instead of 'mapDyn f'; consider eliminating monadic style" #-}
463−mapDyn :: (Reflex t, Monad m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
464−mapDyn f = return . fmap f
465−
466−-- | Map a sampling function over a 'Dynamic'. The sampling function will use the input 'Dynamic''s 'current' 'Behavior' until the first time its 'updated' 'Event' fires, at which point it will be invoked only once each time the 'Event' fires.
467−{-# DEPRECATED mapDynM "Consider using the Monad instance for Dynamic instead." #-}
468−mapDynM :: forall t m a b. (Reflex t, MonadHold t m) => (forall m'. MonadSample t m' => a -> m' b) -> Dynamic t a -> m (Dynamic t b)
469−mapDynM f d = do
470− let e' = push (fmap Just . f :: a -> PushM t (Maybe b)) $ updated d
471− eb' = fmap constant e'
472− v0 = pull $ f =<< sample (current d)
473− bb' :: Behavior t (Behavior t b) <- hold v0 eb'
474− let b' = pull $ sample =<< sample bb'
475− return $ unsafeDynamic b' e'
476−
477−-- | Flipped version of 'mapDyn'.
478−{-# DEPRECATED forDyn "Use 'return . ffor a' instead of 'forDyn a'; consider eliminating monadic style" #-}
479−forDyn :: (Reflex t, Monad m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
480−forDyn a = return . ffor a
481−
482−-- | Flipped version of 'mapDynM'
483−{-# DEPRECATED forDynM "Consider using the Monad instance for Dynamic instead." #-}
484−forDynM :: forall t m a b. (Reflex t, MonadHold t m) => Dynamic t a -> (forall m'. MonadSample t m' => a -> m' b) -> m (Dynamic t b)
485−forDynM d f = mapDynM f d
486−
487−-- | Split the 'Dynamic' into two 'Dynamic's, each taking the respective value
488−-- of the tuple.
489−{-# DEPRECATED splitDyn "Use 'return . splitDynPure' instead; consider eliminating monadic style" #-}
490−splitDyn :: (Reflex t, Monad m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
491−splitDyn = return . splitDynPure
492−
493−-- | Merge the 'Dynamic' values using their 'Monoid' instance.
494−{-# DEPRECATED mconcatDyn "Use 'return . mconcat' instead; consider eliminating monadic style" #-}
495−mconcatDyn :: forall t m a. (Reflex t, Monad m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
496−mconcatDyn = return . mconcat
497−
498−-- | This function no longer needs to be monadic; see 'distributeMapOverDynPure'.
499−{-# DEPRECATED distributeDMapOverDyn "Use 'return . distributeDMapOverDynPure' instead; consider eliminating monadic style" #-}
500−distributeDMapOverDyn :: (Reflex t, Monad m, GCompare k) => DMap k (Dynamic t) -> m (Dynamic t (DMap k Identity))
501−distributeDMapOverDyn = return . distributeDMapOverDynPure
502−
503−-- | Merge two 'Dynamic's into a new one using the provided function. The new
504−-- 'Dynamic' changes its value each time one of the original 'Dynamic's changes
505−-- its value.
506−{-# DEPRECATED combineDyn "Use 'return (zipDynWith f a b)' instead of 'combineDyn f a b'; consider eliminating monadic style" #-}
507−combineDyn :: forall t m a b c. (Reflex t, Monad m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
508−combineDyn f a b = return $ zipDynWith f a b
509−
510−-- | A psuedo applicative version of ap for 'Dynamic'. Example useage:
511−--
512−-- > do
513−-- > person <- Person `mapDyn` dynFirstName
514−-- > `apDyn` dynListName
515−-- > `apDyn` dynAge
516−-- > `apDyn` dynAddress
517−{-# DEPRECATED apDyn "Use 'ffor m (<*> a)' instead of 'apDyn m a'; consider eliminating monadic style, since Dynamics are now Applicative and can be used with applicative style directly" #-}
518−#ifdef USE_TEMPLATE_HASKELL
519−{-# ANN apDyn "HLint: ignore Use fmap" #-}
520−#endif
521−apDyn :: forall t m a b. (Reflex t, Monad m)
522− => m (Dynamic t (a -> b))
523− -> Dynamic t a
524− -> m (Dynamic t b)
525−apDyn m a = fmap (<*> a) m
526−
527−--TODO: The pattern of using hold (sample b0) can be reused in various places as a safe way of building certain kinds of Dynamics; see if we can factor this out
528−-- | This function no longer needs to be monadic, so it has been replaced by
529−-- 'demuxed', which is pure.
530−{-# DEPRECATED getDemuxed "Use 'return . demuxed d' instead of 'getDemuxed d'; consider eliminating monadic style" #-}
531−getDemuxed :: (Reflex t, Monad m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
532−getDemuxed d = return . demuxed d
533−
534−-- | This function no longer needs to be monadic, so it has been replaced by
535−-- 'distributeFHListOverDynPure', which is pure.
536−{-# DEPRECATED distributeFHListOverDyn "Use 'return . distributeFHListOverDynPure' instead; consider eliminating monadic style" #-}
537−distributeFHListOverDyn :: forall t m l. (Reflex t, Monad m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
538−distributeFHListOverDyn = return . distributeFHListOverDynPure
539−
540−-- | This function no longer needs to be monadic, so it has been replaced by
541−-- 'collectDynPure', which is pure.
542−{-# DEPRECATED collectDyn "Use 'return . collectDynPure' instead; consider eliminating monadic style" #-}
543−collectDyn :: ( RebuildSortedHList (HListElems b)
544− , IsHList a, IsHList b
545− , AllAreFunctors (Dynamic t) (HListElems b)
546− , Reflex t, Monad m
547− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
548− ) => a -> m (Dynamic t b)
549−collectDyn = return . collectDynPure
550−
551−-- | This function has been renamed to 'tagPromptlyDyn' to clarify its
552−-- semantics.
553−{-# DEPRECATED tagDyn "Use 'tagPromptlyDyn' instead" #-}
554−tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
555−tagDyn = tagPromptlyDyn
556−
557−-- | This function has been renamed to 'attachPromptlyDyn' to clarify its
558−-- semantics.
559−{-# DEPRECATED attachDyn "Use 'attachPromptlyDyn' instead" #-}
560−attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
561−attachDyn = attachPromptlyDyn
562−
563−-- | This function has been renamed to 'attachPromptlyDynWith' to clarify its
564−-- semantics.
565−{-# DEPRECATED attachDynWith "Use 'attachPromptlyDynWith' instead" #-}
566−attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
567−attachDynWith = attachPromptlyDynWith
568−
569−-- | This function has been renamed to 'attachPromptlyDynWithMaybe' to clarify
570−-- its semantics.
571−{-# DEPRECATED attachDynWithMaybe "Use 'attachPromptlyDynWithMaybe' instead" #-}
572−attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
573−attachDynWithMaybe = attachPromptlyDynWithMaybe
574−
575−-- | Combine an inner and outer 'Dynamic' such that the resulting 'Dynamic''s
576−-- current value will always be equal to the current value's current value, and
577−-- will change whenever either the inner or the outer (or both) values change.
578−{-# DEPRECATED joinDyn "Use 'join' instead" #-}
579−joinDyn :: Reflex t => Dynamic t (Dynamic t a) -> Dynamic t a
580−joinDyn = join
581−
582−-- | 'nubDyn''s behavior is not quite analogous to 'nub''s behavior, so it has
583−-- been renamed to 'uniqDyn'
584−{-# DEPRECATED nubDyn "Use 'uniqDyn' instead" #-}
585−nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
586−nubDyn = uniqDyn
src/Reflex/Dynamic/TH.hs+14−28
@@ -13,9 +13,6 @@ module Reflex.Dynamic.TH
13 ( qDynPure
13 ( qDynPure
14 , unqDyn
14 , unqDyn
15 , mkDynPure
15 , mkDynPure
16− -- * Deprecated functions
17− , qDyn
18− , mkDyn
19 ) where
16 ) where
20
17
21import Reflex.Dynamic
18import Reflex.Dynamic
@@ -23,7 +20,7 @@ import Reflex.Dynamic
23import Control.Monad.State
20import Control.Monad.State
24import Data.Data
21import Data.Data
25import Data.Generics
22import Data.Generics
26−import Data.Monoid
23+import Data.Monoid ((<>))
27import qualified Language.Haskell.Exts as Hs
24import qualified Language.Haskell.Exts as Hs
28import qualified Language.Haskell.Meta.Syntax.Translate as Hs
25import qualified Language.Haskell.Meta.Syntax.Translate as Hs
29import Language.Haskell.TH
26import Language.Haskell.TH
@@ -47,8 +44,8 @@ qDynPure qe = do
47 _ -> gmapM f d
44 _ -> gmapM f d
48 (e', exprsReversed) <- runStateT (gmapM f e) []
45 (e', exprsReversed) <- runStateT (gmapM f e) []
49 let exprs = reverse exprsReversed
46 let exprs = reverse exprsReversed
50− arg = foldr (\a b -> ConE 'FHCons `AppE` a `AppE` b) (ConE 'FHNil) $ map snd exprs
47+ arg = foldr (\a b -> ConE 'FHCons `AppE` snd a `AppE` b) (ConE 'FHNil) exprs
51− param = foldr (\a b -> ConP 'HCons [VarP a, b]) (ConP 'HNil []) $ map fst exprs
48+ param = foldr (\a b -> ConP 'HCons [VarP (fst a), b]) (ConP 'HNil []) exprs
52 [| $(return $ LamE [param] e') <$> distributeFHListOverDynPure $(return arg) |]
49 [| $(return $ LamE [param] e') <$> distributeFHListOverDynPure $(return arg) |]
53
50
54-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
51-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
@@ -84,37 +81,26 @@ mkDynPure = QuasiQuoter
84 }
81 }
85
82
86mkDynExp :: String -> Q Exp
83mkDynExp :: String -> Q Exp
87−mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] }) s of
84+mkDynExp s = case Hs.parseExpWithMode Hs.defaultParseMode { Hs.extensions = [ Hs.EnableExtension Hs.TemplateHaskell ] } s of
88 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
85 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
89 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
86 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
90 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
87 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
88+#if MIN_VERSION_haskell_src_exts(1,18,0)
89+ antiE :: Hs.Exp Hs.SrcSpanInfo -> Hs.Exp Hs.SrcSpanInfo
90+ antiE x = case x of
91+ Hs.SpliceExp l se ->
92+ Hs.App l (Hs.Var l $ Hs.Qual l (Hs.ModuleName l modName) (Hs.Ident l occName)) $ case se of
93+ Hs.IdSplice l2 v -> Hs.Var l2 $ Hs.UnQual l2 $ Hs.Ident l2 v
94+ Hs.ParenSplice _ ps -> ps
95+ _ -> x
96+#else
91 antiE x = case x of
97 antiE x = case x of
92 Hs.SpliceExp se ->
98 Hs.SpliceExp se ->
93 Hs.App (Hs.Var $ Hs.Qual (Hs.ModuleName modName) (Hs.Ident occName)) $ case se of
99 Hs.App (Hs.Var $ Hs.Qual (Hs.ModuleName modName) (Hs.Ident occName)) $ case se of
94 Hs.IdSplice v -> Hs.Var $ Hs.UnQual $ Hs.Ident v
100 Hs.IdSplice v -> Hs.Var $ Hs.UnQual $ Hs.Ident v
95 Hs.ParenSplice ps -> ps
101 Hs.ParenSplice ps -> ps
96 _ -> x
102 _ -> x
103+#endif
97 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
104 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
98 | modName == modName' && occName == occName' = 'unqMarker
105 | modName == modName' && occName == occName' = 'unqMarker
99 reinstateUnqDyn x = x
106 reinstateUnqDyn x = x
100−
101−--------------------------------------------------------------------------------
102−-- Deprecated
103−--------------------------------------------------------------------------------
104−
105−{-# DEPRECATED qDyn "Instead of $(qDyn x), use return $(qDynPure x)" #-}
106−-- | Like 'qDynPure', but wraps its result monadically using 'return'. This is
107−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
108−qDyn :: Q Exp -> Q Exp
109−qDyn qe = [| return $(qDynPure qe) |]
110−
111−{-# DEPRECATED mkDyn "Instead of [mkDyn| x |], use return [mkDynPure| x |]" #-}
112−-- | Like 'mkDynPure', but wraps its result monadically using 'return'. This is
113−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
114−mkDyn :: QuasiQuoter
115−mkDyn = QuasiQuoter
116− { quoteExp = \s -> [| return $(mkDynExp s) |]
117− , quotePat = error "mkDyn: pattern splices are not supported"
118− , quoteType = error "mkDyn: type splices are not supported"
119− , quoteDec = error "mkDyn: declaration splices are not supported"
120− }
src/Reflex/Dynamic/Uniq.hs+5−5
@@ -17,7 +17,6 @@ module Reflex.Dynamic.Uniq
17import Control.Applicative (Applicative (..))
17import Control.Applicative (Applicative (..))
18import GHC.Exts
18import GHC.Exts
19import Reflex.Class
19import Reflex.Class
20−import Reflex.Dynamic
21
20
22-- | A 'Dynamic' whose 'updated' 'Event' will never fire with the same value as
21-- | A 'Dynamic' whose 'updated' 'Event' will never fire with the same value as
23-- the 'current' 'Behavior''s contents. In order to maintain this constraint,
22-- the 'current' 'Behavior''s contents. In order to maintain this constraint,
@@ -32,7 +31,7 @@ newtype UniqDynamic t a = UniqDynamic { unUniqDynamic :: Dynamic t a }
32
31
33-- | Construct a 'UniqDynamic' by eliminating redundant updates from a 'Dynamic'.
32-- | Construct a 'UniqDynamic' by eliminating redundant updates from a 'Dynamic'.
34uniqDynamic :: Reflex t => Dynamic t a -> UniqDynamic t a
33uniqDynamic :: Reflex t => Dynamic t a -> UniqDynamic t a
35−uniqDynamic d = UniqDynamic $ unsafeBuildDynamic (sample $ current d) $ flip push (updated d) $ \new -> do --TODO: It would be very nice if we had an uncached push here
34+uniqDynamic d = UniqDynamic $ unsafeBuildDynamic (sample $ current d) $ flip pushCheap (updated d) $ \new -> do
36 old <- sample $ current d --TODO: Is it better to sample ourselves here?
35 old <- sample $ current d --TODO: Is it better to sample ourselves here?
37 return $ unsafeJustChanged old new
36 return $ unsafeJustChanged old new
38
37
@@ -47,7 +46,7 @@ uniqDynamic d = UniqDynamic $ unsafeBuildDynamic (sample $ current d) $ flip pus
47-- instance, but can be equal by pointer equality. This may cause 'UniqDynamic'
46-- instance, but can be equal by pointer equality. This may cause 'UniqDynamic'
48-- to lose changes from NaN to NaN.
47-- to lose changes from NaN to NaN.
49fromUniqDynamic :: (Reflex t, Eq a) => UniqDynamic t a -> Dynamic t a
48fromUniqDynamic :: (Reflex t, Eq a) => UniqDynamic t a -> Dynamic t a
50−fromUniqDynamic (UniqDynamic d) = uniqDynBy superEq d
49+fromUniqDynamic (UniqDynamic d) = unsafeDynamic (current d) e'
51 where
50 where
52 -- Only consider values different if they fail both pointer equality /and/
51 -- Only consider values different if they fail both pointer equality /and/
53 -- 'Eq' equality. This is to make things a bit more deterministic in the
52 -- 'Eq' equality. This is to make things a bit more deterministic in the
@@ -57,6 +56,7 @@ fromUniqDynamic (UniqDynamic d) = uniqDynBy superEq d
57 -- nonequal by pointer quality. I suspect that it is impossible to make the
56 -- nonequal by pointer quality. I suspect that it is impossible to make the
58 -- behavior deterministic in this case.
57 -- behavior deterministic in this case.
59 superEq a b = a `unsafePtrEq` b || a == b
58 superEq a b = a `unsafePtrEq` b || a == b
59+ e' = attachWithMaybe (\x x' -> if x' `superEq` x then Nothing else Just x') (current d) (updated d)
60
60
61-- | Create a UniqDynamic without uniqing it on creation. This will be slightly
61-- | Create a UniqDynamic without uniqing it on creation. This will be slightly
62-- faster than uniqDynamic when used with a Dynamic whose values are always (or
62-- faster than uniqDynamic when used with a Dynamic whose values are always (or
@@ -81,13 +81,13 @@ instance Reflex t => Accumulator t (UniqDynamic t) where
81 let f' old change = do
81 let f' old change = do
82 mNew <- f old change
82 mNew <- f old change
83 return $ unsafeJustChanged old =<< mNew
83 return $ unsafeJustChanged old =<< mNew
84− d <- accumMaybeM f' z e
84+ d <- accumMaybeMDyn f' z e
85 return $ UniqDynamic d
85 return $ UniqDynamic d
86 mapAccumMaybeM f z e = do
86 mapAccumMaybeM f z e = do
87 let f' old change = do
87 let f' old change = do
88 (mNew, output) <- f old change
88 (mNew, output) <- f old change
89 return (unsafeJustChanged old =<< mNew, output)
89 return (unsafeJustChanged old =<< mNew, output)
90− (d, out) <- mapAccumMaybeM f' z e
90+ (d, out) <- mapAccumMaybeMDyn f' z e
91 return (UniqDynamic d, out)
91 return (UniqDynamic d, out)
92
92
93instance Reflex t => Functor (UniqDynamic t) where
93instance Reflex t => Functor (UniqDynamic t) where
src/Reflex/DynamicWriter.hs+4−190
@@ -1,193 +1,7 @@
1−-- | This module defines 'MonadDynamicWriter' and 'DynamicWriterT', its standard
2−-- implementation.
3−{-# LANGUAGE CPP #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−{-# LANGUAGE FunctionalDependencies #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8−{-# LANGUAGE LambdaCase #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10−{-# LANGUAGE RankNTypes #-}
11−{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−#ifdef USE_REFLEX_OPTIMIZER
15−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
16−#endif
17module Reflex.DynamicWriter
1module Reflex.DynamicWriter
18− ( MonadDynamicWriter (..)
2+ {-# DEPRECATED "Use 'Reflex.DynamicWriter.Class' and 'Reflex.DynamicWrite.Base' instead, or just import 'Reflex'" #-}
19− , DynamicWriterT (..)
3+ ( module X
20− , runDynamicWriterT
21− , withDynamicWriterT
22 ) where
4 ) where
23
5
24−import Control.Monad.Exception
6+import Reflex.DynamicWriter.Base as X
25−import Control.Monad.Identity
26−import Control.Monad.IO.Class
27−import Control.Monad.Reader
28−import Control.Monad.Ref
29−import Control.Monad.State.Strict
30−import Data.Align
31−import Data.Dependent.Map (DMap)
32−import qualified Data.Dependent.Map as DMap
33−import Data.Functor.Misc
34−import Data.Map (Map)
35−import qualified Data.Map as Map
36−import Data.Semigroup
37−import Data.Some (Some)
38−import Data.These
39−import Reflex.Class
7+import Reflex.DynamicWriter.Class as X
40−import Reflex.Host.Class
41−import Reflex.PerformEvent.Class
42−import Reflex.PostBuild.Class
43−import Reflex.Requester.Class
44−import Reflex.TriggerEvent.Class
45−
46−instance MonadTrans (DynamicWriterT t w) where
47− lift = DynamicWriterT . lift
48−
49−mapIncrementalMapValues :: (Reflex t, Patch (p v), Patch (p v'), PatchTarget (p v) ~ f v, PatchTarget (p v') ~ f v', Functor p, Functor f) => (v -> v') -> Incremental t (p v) -> Incremental t (p v')
50−mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
51−
52−mergeDynIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Dynamic t v)) -> Incremental t (PatchMap k v)
53−mergeDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
54− where changedValues = fmap (PatchMap . fmap Just) $ mergeMapIncremental $ mapIncrementalMapValues updated a
55− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchMap m) -> PatchMap <$> mapM (mapM (sample . current)) m
56−
57−mergeDynIncrementalWithMove :: (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Dynamic t v)) -> Incremental t (PatchMapWithMove k v)
58−mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ alignWith f addedAndRemovedValues changedValues
59− where changedValues = mergeMapIncrementalWithMove $ mapIncrementalMapValues updated a
60− addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ fmap unsafePatchMapWithMove . mapM (mapM (sample . current)) . unPatchMapWithMove
61− f x = unsafePatchMapWithMove $
62− let (p, changed) = case x of
63− This p_ -> (unPatchMapWithMove p_, mempty)
64− That c -> (mempty, c)
65− These p_ c -> (unPatchMapWithMove p_, c)
66− (pWithNewVals, noLongerMoved) = flip runState [] $ forM p $ \case
67− MapEdit_Insert moved v -> return $ MapEdit_Insert moved v
68− MapEdit_Delete moved -> return $ MapEdit_Delete moved
69− MapEdit_Move moved k -> case Map.lookup k changed of
70− Nothing -> return $ MapEdit_Move moved k
71− Just v -> do
72− modify (k:)
73− return $ MapEdit_Insert moved v
74− noLongerMovedMap = Map.fromList $ fmap (\k -> (k, ())) noLongerMoved
75− removeMovedFlag = \case --TODO: Check if moved was true before, in each case?
76− MapEdit_Insert _ v -> MapEdit_Insert False v
77− MapEdit_Delete _ -> MapEdit_Delete False
78− MapEdit_Move _ k -> MapEdit_Move False k
79− in Map.differenceWith (\e _ -> Just $ removeMovedFlag e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
80−
81−-- | A basic implementation of 'MonadDynamicWriter'.
82−newtype DynamicWriterT t w m a = DynamicWriterT { unDynamicWriterT :: StateT [Dynamic t w] m a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadHold t, MonadSample t, MonadAsyncException, MonadException) -- The list is kept in reverse order
83−
84−instance MonadRef m => MonadRef (DynamicWriterT t w m) where
85− type Ref (DynamicWriterT t w m) = Ref m
86− newRef = lift . newRef
87− readRef = lift . readRef
88− writeRef r = lift . writeRef r
89−
90−instance MonadAtomicRef m => MonadAtomicRef (DynamicWriterT t w m) where
91− atomicModifyRef r = lift . atomicModifyRef r
92−
93−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DynamicWriterT t w m) where
94− newEventWithTrigger = lift . newEventWithTrigger
95− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
96−
97−-- | Run a 'DynamicWriterT' action. The dynamic writer output will be provided
98−-- along with the result of the action.
99−runDynamicWriterT :: (MonadFix m, Reflex t, Monoid w) => DynamicWriterT t w m a -> m (a, Dynamic t w)
100−runDynamicWriterT (DynamicWriterT a) = do
101− (result, ws) <- runStateT a []
102− return (result, mconcat $ reverse ws)
103−
104−-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
105−-- and combines them monoidally to provide a 'Dynamic' result.
106−class (Monad m, Monoid w) => MonadDynamicWriter t w m | m -> t w where
107− tellDyn :: Dynamic t w -> m ()
108−
109−instance (Monad m, Monoid w, Reflex t) => MonadDynamicWriter t w (DynamicWriterT t w m) where
110− tellDyn w = DynamicWriterT $ modify (w :)
111−
112−instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
113− ask = lift ask
114− local f (DynamicWriterT a) = DynamicWriterT $ mapStateT (local f) a
115− reader = lift . reader
116−
117−instance PerformEvent t m => PerformEvent t (DynamicWriterT t w m) where
118− type Performable (DynamicWriterT t w m) = Performable m
119− performEvent_ = lift . performEvent_
120− performEvent = lift . performEvent
121−
122−instance TriggerEvent t m => TriggerEvent t (DynamicWriterT t w m) where
123− newTriggerEvent = lift newTriggerEvent
124− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
125− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
126−
127−instance PostBuild t m => PostBuild t (DynamicWriterT t w m) where
128− getPostBuild = lift getPostBuild
129−
130−instance MonadDynamicWriter t w m => MonadDynamicWriter t w (ReaderT r m) where
131− tellDyn = lift . tellDyn
132−
133−instance MonadState s m => MonadState s (DynamicWriterT t w m) where
134− get = lift get
135− put = lift . put
136−
137−newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
138−
139−-- | When the execution of a 'DynamicWriterT' action is adjusted using
140−-- 'MonadAdjust', the 'Dynamic' output of that action will also be updated to
141−-- match.
142−instance (MonadAdjust t m, MonadFix m, Monoid w, MonadHold t m, Reflex t) => MonadAdjust t (DynamicWriterT t w m) where
143− runWithReplace a0 a' = do
144− (result0, result') <- lift $ runWithReplace (runDynamicWriterT a0) $ runDynamicWriterT <$> a'
145− tellDyn . join =<< holdDyn (snd result0) (snd <$> result')
146− return (fst result0, fst <$> result')
147− traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjust mapPatchDMap weakenPatchDMapWith mergeDynIncremental
148− traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith mergeDynIncrementalWithMove
149−
150−traverseDMapWithKeyWithAdjustImpl :: forall t w k v' p p' v m. (PatchTarget (p' (Some k) (Dynamic t w)) ~ Map (Some k) (Dynamic t w), PatchTarget (p' (Some k) w) ~ Map (Some k) w, Patch (p' (Some k) w), Patch (p' (Some k) (Dynamic t w)), MonadFix m, Monoid w, Reflex t, MonadHold t m)
151− => ( (forall a. k a -> v a -> m (DynamicWriterTLoweredResult t w v' a))
152− -> DMap k v
153− -> Event t (p k v)
154− -> m (DMap k (DynamicWriterTLoweredResult t w v'), Event t (p k (DynamicWriterTLoweredResult t w v')))
155− )
156− -> ((forall a. DynamicWriterTLoweredResult t w v' a -> v' a) -> p k (DynamicWriterTLoweredResult t w v') -> p k v')
157− -> ((forall a. DynamicWriterTLoweredResult t w v' a -> Dynamic t w) -> p k (DynamicWriterTLoweredResult t w v') -> p' (Some k) (Dynamic t w))
158− -> (Incremental t (p' (Some k) (Dynamic t w)) -> Incremental t (p' (Some k) w))
159− -> (forall a. k a -> v a -> DynamicWriterT t w m (v' a))
160− -> DMap k v
161− -> Event t (p k v)
162− -> DynamicWriterT t w m (DMap k v', Event t (p k v'))
163−traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith mergeMyDynIncremental f (dm0 :: DMap k v) dm' = do
164− (result0, result') <- lift $ base (\k v -> fmap DynamicWriterTLoweredResult $ runDynamicWriterT $ f k v) dm0 dm'
165− let getValue (DynamicWriterTLoweredResult (v, _)) = v
166− getWritten (DynamicWriterTLoweredResult (_, w)) = w
167− liftedResult0 = DMap.map getValue result0
168− liftedResult' = ffor result' $ mapPatch getValue
169− liftedWritten0 :: Map (Some k) (Dynamic t w)
170− liftedWritten0 = weakenDMapWith getWritten result0
171− liftedWritten' = ffor result' $ weakenPatchWith getWritten
172− --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
173− i <- holdIncremental liftedWritten0 liftedWritten'
174− tellDyn $ fmap (mconcat . Map.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
175− return (liftedResult0, liftedResult')
176−
177−-- | Map a function over the output of a 'DynamicWriterT'.
178−withDynamicWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m, MonadFix m)
179− => (w -> w')
180− -> DynamicWriterT t w m a
181− -> DynamicWriterT t w' m a
182−withDynamicWriterT f dw = do
183− (r, d) <- lift $ do
184− (r, d) <- runDynamicWriterT dw
185− let d' = fmap f d
186− return (r, d')
187− tellDyn d
188− return r
189−
190−instance Requester t m => Requester t (DynamicWriterT t w m) where
191− type Request (DynamicWriterT t w m) = Request m
192− type Response (DynamicWriterT t w m) = Response m
193− withRequesting f = DynamicWriterT $ withRequesting $ unDynamicWriterT . f
src/Reflex/DynamicWriter/Base.hsnew file+246
@@ -0,0 +1,246 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE FlexibleInstances #-}
3+{-# LANGUAGE GADTs #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE RankNTypes #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TypeFamilies #-}
11+{-# LANGUAGE UndecidableInstances #-}
12+{-# LANGUAGE StandaloneDeriving #-}
13+#ifdef USE_REFLEX_OPTIMIZER
14+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
15+#endif
16+module Reflex.DynamicWriter.Base
17+ ( DynamicWriterT (..)
18+ , runDynamicWriterT
19+ , withDynamicWriterT
20+ ) where
21+
22+import Control.Monad.Exception
23+import Control.Monad.Identity
24+import Control.Monad.IO.Class
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
27+import Control.Monad.Reader
28+import Control.Monad.Ref
29+import Control.Monad.State.Strict
30+import Data.Align
31+import Data.Dependent.Map (DMap)
32+import qualified Data.Dependent.Map as DMap
33+import Data.FastMutableIntMap
34+import Data.Functor.Misc
35+import Data.IntMap (IntMap)
36+import qualified Data.IntMap as IntMap
37+import Data.Map (Map)
38+import qualified Data.Map as Map
39+import Data.Semigroup (Semigroup(..))
40+import Data.Some (Some)
41+import Data.These
42+
43+import Reflex.Adjustable.Class
44+import Reflex.Class
45+import Reflex.DynamicWriter.Class
46+import Reflex.EventWriter.Class (EventWriter, tellEvent)
47+import Reflex.Host.Class
48+import qualified Data.Patch.MapWithMove as MapWithMove
49+import Reflex.PerformEvent.Class
50+import Reflex.PostBuild.Class
51+import Reflex.Query.Class
52+import Reflex.Requester.Class
53+import Reflex.TriggerEvent.Class
54+
55+mapIncrementalMapValues :: (Reflex t, Patch (p v), Patch (p v'), PatchTarget (p v) ~ f v, PatchTarget (p v') ~ f v', Functor p, Functor f) => (v -> v') -> Incremental t (p v) -> Incremental t (p v')
56+mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
57+
58+mergeDynIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Dynamic t v)) -> Incremental t (PatchMap k v)
59+mergeDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
60+ where changedValues = fmap (PatchMap . fmap Just) $ mergeMapIncremental $ mapIncrementalMapValues updated a
61+ addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchMap m) -> PatchMap <$> mapM (mapM (sample . current)) m
62+
63+mergeIntMapDynIncremental :: Reflex t => Incremental t (PatchIntMap (Dynamic t v)) -> Incremental t (PatchIntMap v)
64+mergeIntMapDynIncremental a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ addedAndRemovedValues <> changedValues
65+ where changedValues = fmap (PatchIntMap . fmap Just) $ mergeIntMapIncremental $ mapIncrementalMapValues updated a
66+ addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ \(PatchIntMap m) -> PatchIntMap <$> mapM (mapM (sample . current)) m
67+
68+mergeDynIncrementalWithMove :: forall t k v. (Reflex t, Ord k) => Incremental t (PatchMapWithMove k (Dynamic t v)) -> Incremental t (PatchMapWithMove k v)
69+mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current) =<< sample (currentIncremental a)) $ alignWith f addedAndRemovedValues changedValues
70+ where changedValues = mergeMapIncrementalWithMove $ mapIncrementalMapValues updated a
71+ addedAndRemovedValues = flip pushAlways (updatedIncremental a) $ fmap unsafePatchMapWithMove . mapM (mapM (sample . current)) . unPatchMapWithMove
72+ f :: These (PatchMapWithMove k v) (Map k v) -> PatchMapWithMove k v
73+ f x = unsafePatchMapWithMove $
74+ let (p, changed) = case x of
75+ This p_ -> (unPatchMapWithMove p_, mempty)
76+ That c -> (mempty, c)
77+ These p_ c -> (unPatchMapWithMove p_, c)
78+ (pWithNewVals, noLongerMoved) = flip runState [] $ forM p $ MapWithMove.nodeInfoMapMFrom $ \case
79+ MapWithMove.From_Insert v -> return $ MapWithMove.From_Insert v
80+ MapWithMove.From_Delete -> return MapWithMove.From_Delete
81+ MapWithMove.From_Move k -> case Map.lookup k changed of
82+ Nothing -> return $ MapWithMove.From_Move k
83+ Just v -> do
84+ modify (k:)
85+ return $ MapWithMove.From_Insert v
86+ noLongerMovedMap = Map.fromList $ fmap (, ()) noLongerMoved
87+ in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
88+
89+-- | A basic implementation of 'DynamicWriter'.
90+newtype DynamicWriterT t w m a = DynamicWriterT { unDynamicWriterT :: StateT [Dynamic t w] m a }
91+ -- The list is kept in reverse order
92+ deriving
93+ ( Functor
94+ , Applicative
95+ , Monad
96+ , MonadTrans
97+ , MFunctor
98+ , MonadIO
99+ , MonadFix
100+ , MonadAsyncException
101+ , MonadException
102+ )
103+
104+deriving instance MonadHold t m => MonadHold t (DynamicWriterT t w m)
105+deriving instance MonadSample t m => MonadSample t (DynamicWriterT t w m)
106+
107+
108+instance MonadRef m => MonadRef (DynamicWriterT t w m) where
109+ type Ref (DynamicWriterT t w m) = Ref m
110+ newRef = lift . newRef
111+ readRef = lift . readRef
112+ writeRef r = lift . writeRef r
113+
114+instance MonadAtomicRef m => MonadAtomicRef (DynamicWriterT t w m) where
115+ atomicModifyRef r = lift . atomicModifyRef r
116+
117+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (DynamicWriterT t w m) where
118+ newEventWithTrigger = lift . newEventWithTrigger
119+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
120+
121+-- | Run a 'DynamicWriterT' action. The dynamic writer output will be provided
122+-- along with the result of the action.
123+runDynamicWriterT :: (MonadFix m, Reflex t, Monoid w) => DynamicWriterT t w m a -> m (a, Dynamic t w)
124+runDynamicWriterT (DynamicWriterT a) = do
125+ (result, ws) <- runStateT a []
126+ return (result, mconcat $ reverse ws)
127+
128+instance (Monad m, Monoid w, Reflex t) => DynamicWriter t w (DynamicWriterT t w m) where
129+ tellDyn w = DynamicWriterT $ modify (w :)
130+
131+instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
132+ ask = lift ask
133+ local f (DynamicWriterT a) = DynamicWriterT $ mapStateT (local f) a
134+ reader = lift . reader
135+
136+instance PerformEvent t m => PerformEvent t (DynamicWriterT t w m) where
137+ type Performable (DynamicWriterT t w m) = Performable m
138+ performEvent_ = lift . performEvent_
139+ performEvent = lift . performEvent
140+
141+instance TriggerEvent t m => TriggerEvent t (DynamicWriterT t w m) where
142+ newTriggerEvent = lift newTriggerEvent
143+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
144+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
145+
146+instance PostBuild t m => PostBuild t (DynamicWriterT t w m) where
147+ getPostBuild = lift getPostBuild
148+
149+instance MonadState s m => MonadState s (DynamicWriterT t w m) where
150+ get = lift get
151+ put = lift . put
152+
153+instance PrimMonad m => PrimMonad (DynamicWriterT t w m) where
154+ type PrimState (DynamicWriterT t w m) = PrimState m
155+ primitive = lift . primitive
156+
157+newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
158+
159+-- | When the execution of a 'DynamicWriterT' action is adjusted using
160+-- 'Adjustable', the 'Dynamic' output of that action will also be updated to
161+-- match.
162+instance (Adjustable t m, MonadFix m, Monoid w, MonadHold t m, Reflex t) => Adjustable t (DynamicWriterT t w m) where
163+ runWithReplace a0 a' = do
164+ (result0, result') <- lift $ runWithReplace (runDynamicWriterT a0) $ runDynamicWriterT <$> a'
165+ tellDyn . join =<< holdDyn (snd result0) (snd <$> result')
166+ return (fst result0, fst <$> result')
167+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustImpl traverseIntMapWithKeyWithAdjust mergeIntMapDynIncremental
168+ traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjust mapPatchDMap weakenPatchDMapWith mergeDynIncremental
169+ traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove weakenPatchDMapWithMoveWith mergeDynIncrementalWithMove
170+
171+traverseDMapWithKeyWithAdjustImpl :: forall t w k v' p p' v m. (PatchTarget (p' (Some k) (Dynamic t w)) ~ Map (Some k) (Dynamic t w), PatchTarget (p' (Some k) w) ~ Map (Some k) w, Patch (p' (Some k) w), Patch (p' (Some k) (Dynamic t w)), MonadFix m, Monoid w, Reflex t, MonadHold t m)
172+ => ( (forall a. k a -> v a -> m (DynamicWriterTLoweredResult t w v' a))
173+ -> DMap k v
174+ -> Event t (p k v)
175+ -> m (DMap k (DynamicWriterTLoweredResult t w v'), Event t (p k (DynamicWriterTLoweredResult t w v')))
176+ )
177+ -> ((forall a. DynamicWriterTLoweredResult t w v' a -> v' a) -> p k (DynamicWriterTLoweredResult t w v') -> p k v')
178+ -> ((forall a. DynamicWriterTLoweredResult t w v' a -> Dynamic t w) -> p k (DynamicWriterTLoweredResult t w v') -> p' (Some k) (Dynamic t w))
179+ -> (Incremental t (p' (Some k) (Dynamic t w)) -> Incremental t (p' (Some k) w))
180+ -> (forall a. k a -> v a -> DynamicWriterT t w m (v' a))
181+ -> DMap k v
182+ -> Event t (p k v)
183+ -> DynamicWriterT t w m (DMap k v', Event t (p k v'))
184+traverseDMapWithKeyWithAdjustImpl base mapPatch weakenPatchWith mergeMyDynIncremental f (dm0 :: DMap k v) dm' = do
185+ (result0, result') <- lift $ base (\k v -> fmap DynamicWriterTLoweredResult $ runDynamicWriterT $ f k v) dm0 dm'
186+ let getValue (DynamicWriterTLoweredResult (v, _)) = v
187+ getWritten (DynamicWriterTLoweredResult (_, w)) = w
188+ liftedResult0 = DMap.map getValue result0
189+ liftedResult' = ffor result' $ mapPatch getValue
190+ liftedWritten0 :: Map (Some k) (Dynamic t w)
191+ liftedWritten0 = weakenDMapWith getWritten result0
192+ liftedWritten' = ffor result' $ weakenPatchWith getWritten
193+ --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
194+ i <- holdIncremental liftedWritten0 liftedWritten'
195+ tellDyn $ fmap (mconcat . Map.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
196+ return (liftedResult0, liftedResult')
197+
198+traverseIntMapWithKeyWithAdjustImpl :: forall t w v' p p' v m. (PatchTarget (p' (Dynamic t w)) ~ IntMap (Dynamic t w), PatchTarget (p' w) ~ IntMap w, Patch (p' w), Patch (p' (Dynamic t w)), MonadFix m, Monoid w, Reflex t, MonadHold t m, Functor p, p ~ p')
199+ => ( (IntMap.Key -> v -> m (v', Dynamic t w))
200+ -> IntMap v
201+ -> Event t (p v)
202+ -> m (IntMap (v', Dynamic t w), Event t (p (v', Dynamic t w)))
203+ )
204+ -> (Incremental t (p' (Dynamic t w)) -> Incremental t (p' w))
205+ -> (IntMap.Key -> v -> DynamicWriterT t w m v')
206+ -> IntMap v
207+ -> Event t (p v)
208+ -> DynamicWriterT t w m (IntMap v', Event t (p v'))
209+traverseIntMapWithKeyWithAdjustImpl base mergeMyDynIncremental f (dm0 :: IntMap v) dm' = do
210+ (result0, result') <- lift $ base (\k v -> runDynamicWriterT $ f k v) dm0 dm'
211+ let liftedResult0 = fmap fst result0
212+ liftedResult' = fmap (fmap fst) result'
213+ liftedWritten0 :: IntMap (Dynamic t w)
214+ liftedWritten0 = fmap snd result0
215+ liftedWritten' = fmap (fmap snd) result'
216+ --TODO: We should be able to improve the performance here by incrementally updating the mconcat of the merged Dynamics
217+ i <- holdIncremental liftedWritten0 liftedWritten'
218+ tellDyn $ fmap (mconcat . IntMap.elems) $ incrementalToDynamic $ mergeMyDynIncremental i
219+ return (liftedResult0, liftedResult')
220+
221+-- | Map a function over the output of a 'DynamicWriterT'.
222+withDynamicWriterT :: (Monoid w, Monoid w', Reflex t, MonadHold t m, MonadFix m)
223+ => (w -> w')
224+ -> DynamicWriterT t w m a
225+ -> DynamicWriterT t w' m a
226+withDynamicWriterT f dw = do
227+ (r, d) <- lift $ do
228+ (r, d) <- runDynamicWriterT dw
229+ let d' = fmap f d
230+ return (r, d')
231+ tellDyn d
232+ return r
233+
234+instance Requester t m => Requester t (DynamicWriterT t w m) where
235+ type Request (DynamicWriterT t w m) = Request m
236+ type Response (DynamicWriterT t w m) = Response m
237+ requesting = lift . requesting
238+ requesting_ = lift . requesting_
239+
240+instance (MonadQuery t q m, Monad m) => MonadQuery t q (DynamicWriterT t w m) where
241+ tellQueryIncremental = lift . tellQueryIncremental
242+ askQueryResult = lift askQueryResult
243+ queryIncremental = lift . queryIncremental
244+
245+instance EventWriter t w m => EventWriter t w (DynamicWriterT t v m) where
246+ tellEvent = lift . tellEvent
src/Reflex/DynamicWriter/Class.hsnew file+28
@@ -0,0 +1,28 @@
1+-- | This module defines the 'DynamicWriter' class.
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE CPP #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FunctionalDependencies #-}
6+{-# LANGUAGE UndecidableInstances #-}
7+#ifdef USE_REFLEX_OPTIMIZER
8+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
9+#endif
10+module Reflex.DynamicWriter.Class
11+ ( MonadDynamicWriter
12+ , DynamicWriter(..)
13+ ) where
14+
15+import Control.Monad.Reader (ReaderT, lift)
16+import Reflex.Class (Dynamic)
17+
18+{-# DEPRECATED MonadDynamicWriter "Use 'DynamicWriter' instead" #-}
19+-- | Type synonym for 'DynamicWriter'
20+type MonadDynamicWriter = DynamicWriter
21+
22+-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
23+-- and combines them monoidally to provide a 'Dynamic' result.
24+class (Monad m, Monoid w) => DynamicWriter t w m | m -> t w where
25+ tellDyn :: Dynamic t w -> m ()
26+
27+instance DynamicWriter t w m => DynamicWriter t w (ReaderT r m) where
28+ tellDyn = lift . tellDyn
src/Reflex/EventWriter.hs+4−164
@@ -1,167 +1,7 @@
1−-- | This module provides 'EventWriterT', the standard implementation of
2−-- 'EventWriter'.
3−{-# LANGUAGE CPP #-}
4−{-# LANGUAGE ExistentialQuantification #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9−{-# LANGUAGE Rank2Types #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−#ifdef USE_REFLEX_OPTIMIZER
14−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
15−#endif
16module Reflex.EventWriter
1module Reflex.EventWriter
17− ( EventWriterT (..)
2+ {-# DEPRECATED "Use 'Reflex.EventWriter.Class' and 'Reflex.EventWriter.Base' instead, or just import 'Reflex'" #-}
18− , runEventWriterT
3+ ( module X
19− , EventWriter (..)
20− , runWithReplaceEventWriterTWith
21− , sequenceDMapWithAdjustEventWriterTWith
22 ) where
4 ) where
23
5
24−import Reflex.Class
6+import Reflex.EventWriter.Base as X
25−import Reflex.Host.Class
26−import Reflex.PerformEvent.Class
27−import Reflex.PostBuild.Class
28−import Reflex.Requester.Class
7+import Reflex.EventWriter.Class as X
29−import Reflex.TriggerEvent.Class
30−
31−import Control.Monad.Exception
32−import Control.Monad.Identity
33−import Control.Monad.Reader
34−import Control.Monad.Ref
35−import Control.Monad.State.Strict
36−import Data.Dependent.Map (DMap)
37−import qualified Data.Dependent.Map as DMap
38−import Data.Foldable
39−import Data.Functor.Compose
40−import Data.Functor.Misc
41−import qualified Data.List.NonEmpty as NonEmpty
42−import Data.Map (Map)
43−import Data.Semigroup
44−import Data.Sequence
45−import Data.Some (Some)
46−import Data.Tuple
47−
48−-- | 'EventWriter' efficiently collects 'Event' values using 'tellEvent'
49−-- and combines them monoidally to provide an 'Event' result.
50−class (Monad m, Monoid w) => EventWriter t w m | m -> t w where
51− tellEvent :: Event t w -> m ()
52−
53−-- | A basic implementation of 'EventWriter'.
54−newtype EventWriterT t w m a = EventWriterT { unEventWriterT :: StateT (Seq (Event t w)) m a }
55− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException, MonadAsyncException)
56−
57−-- | Run a 'EventWriterT' action.
58−runEventWriterT :: (Reflex t, Monad m, Semigroup w) => EventWriterT t w m a -> m (a, Event t w)
59−runEventWriterT (EventWriterT a) = do
60− (result, requests) <- runStateT a mempty
61− return (result, mconcat $ toList requests)
62−
63−instance (Reflex t, Monad m, Monoid w) => EventWriter t w (EventWriterT t w m) where
64− tellEvent w = EventWriterT $ modify (|> w)
65−
66−instance MonadTrans (EventWriterT t w) where
67− lift = EventWriterT . lift
68−
69−instance MonadSample t m => MonadSample t (EventWriterT t w m) where
70− sample = lift . sample
71−
72−instance MonadHold t m => MonadHold t (EventWriterT t w m) where
73− hold v0 = lift . hold v0
74− holdDyn v0 = lift . holdDyn v0
75− holdIncremental v0 = lift . holdIncremental v0
76−
77−instance (Reflex t, MonadAdjust t m, MonadHold t m, Monoid w, Semigroup w) => MonadAdjust t (EventWriterT t w m) where
78− runWithReplace = runWithReplaceEventWriterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
79− traverseDMapWithKeyWithAdjust = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElements mergeMapIncremental
80− traverseDMapWithKeyWithAdjustWithMove = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElements mergeMapIncrementalWithMove
81−
82−instance Requester t m => Requester t (EventWriterT t w m) where
83− type Request (EventWriterT t w m) = Request m
84− type Response (EventWriterT t w m) = Response m
85− withRequesting f = EventWriterT $ withRequesting $ unEventWriterT . f
86−
87−
88−-- | Given a function like 'runWithReplace' for the underlying monad, implement
89−-- 'runWithReplace' for 'EventWriterT'. This is necessary when the underlying
90−-- monad doesn't have a 'MonadAdjust' instance or to override the default
91−-- 'MonadAdjust' behavior.
92−runWithReplaceEventWriterTWith :: forall m t w a b. (Reflex t, MonadHold t m, Monoid w)
93− => (forall a' b'. m a' -> Event t (m b') -> EventWriterT t w m (a', Event t b'))
94− -> EventWriterT t w m a
95− -> Event t (EventWriterT t w m b)
96− -> EventWriterT t w m (a, Event t b)
97−runWithReplaceEventWriterTWith f a0 a' = do
98− let g :: EventWriterT t w m c -> m (c, Seq (Event t w))
99− g (EventWriterT r) = runStateT r mempty
100− (result0, result') <- f (g a0) $ fmap g a'
101− request <- holdDyn (fmapCheap (mconcat . NonEmpty.toList) $ mergeList $ toList $ snd result0) $ fmapCheap (fmapCheap (mconcat . NonEmpty.toList) . mergeList . toList . snd) result'
102− -- We add these two separately to take advantage of the free merge being done later. The coincidence case must come first so that it has precedence if both fire simultaneously. (Really, we should probably block the 'switch' whenever 'updated' fires, but switchPromptlyDyn has the same issue.)
103− EventWriterT $ modify $ flip (|>) $ coincidence $ updated request
104− EventWriterT $ modify $ flip (|>) $ switch $ current request
105− return (fst result0, fmapCheap fst result')
106−
107−-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceDMapWithAdjust'.
108−sequenceDMapWithAdjustEventWriterTWith :: forall t m p p' w k v v'. (Reflex t, MonadHold t m, Monoid w, Semigroup w, Patch (p' (Some k) (Event t w)), PatchTarget (p' (Some k) (Event t w)) ~ Map (Some k) (Event t w))
109− => ( (forall a. k a -> v a -> m (Compose ((,) (Seq (Event t w))) v' a))
110− -> DMap k v
111− -> Event t (p k v)
112− -> EventWriterT t w m (DMap k (Compose ((,) (Seq (Event t w))) v'), Event t (p k (Compose ((,) (Seq (Event t w))) v')))
113− )
114− -> ((forall a. Compose ((,) (Seq (Event t w))) v' a -> v' a) -> p k (Compose ((,) (Seq (Event t w))) v') -> p k v')
115− -> ((forall a. Compose ((,) (Seq (Event t w))) v' a -> Event t w) -> p k (Compose ((,) (Seq (Event t w))) v') -> p' (Some k) (Event t w))
116− -> (p' (Some k) (Event t w) -> [Event t w])
117− -> (Incremental t (p' (Some k) (Event t w)) -> Event t (Map (Some k) w))
118− -> (forall a. k a -> v a -> EventWriterT t w m (v' a))
119− -> DMap k v
120− -> Event t (p k v)
121− -> EventWriterT t w m (DMap k v', Event t (p k v'))
122−sequenceDMapWithAdjustEventWriterTWith base mapPatch weakenPatchWith patchNewElements mergePatchIncremental f dm0 dm' = do
123− let f' :: forall a. k a -> v a -> m (Compose ((,) (Seq (Event t w))) v' a)
124− f' k v = Compose . swap <$> runStateT (unEventWriterT $ f k v) mempty
125− (children0, children') <- base f' dm0 dm'
126− let result0 = DMap.map (snd . getCompose) children0
127− result' = fforCheap children' $ mapPatch $ snd . getCompose
128− requests0 :: Map (Some k) (Event t w)
129− requests0 = weakenDMapWith (mconcat . toList . fst . getCompose) children0
130− requests' :: Event t (p' (Some k) (Event t w))
131− requests' = fforCheap children' $ weakenPatchWith $ mconcat . toList . fst . getCompose
132− childRequestMap :: Incremental t (p' (Some k) (Event t w)) <- holdIncremental requests0 requests'
133− -- We add these two separately to take advantage of the free merge being done later. The coincidence case must come first so that it has precedence if both fire simultaneously. (Really, we should probably block the 'switch' whenever 'updated' fires, but switchPromptlyDyn has the same issue.)
134− EventWriterT $ modify $ flip (|>) $ coincidence $ fforCheap requests' $ \p -> mconcat $ patchNewElements p --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
135− EventWriterT $ modify $ flip (|>) $ fold <$> mergePatchIncremental childRequestMap
136− return (result0, result')
137−
138−instance PerformEvent t m => PerformEvent t (EventWriterT t w m) where
139− type Performable (EventWriterT t w m) = Performable m
140− performEvent_ = lift . performEvent_
141− performEvent = lift . performEvent
142−
143−instance PostBuild t m => PostBuild t (EventWriterT t w m) where
144− getPostBuild = lift getPostBuild
145−
146−instance TriggerEvent t m => TriggerEvent t (EventWriterT t w m) where
147− newTriggerEvent = lift newTriggerEvent
148− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
149− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
150−
151−instance MonadReader r m => MonadReader r (EventWriterT t w m) where
152− ask = lift ask
153− local f (EventWriterT a) = EventWriterT $ mapStateT (local f) a
154− reader = lift . reader
155−
156−instance MonadRef m => MonadRef (EventWriterT t w m) where
157− type Ref (EventWriterT t w m) = Ref m
158− newRef = lift . newRef
159− readRef = lift . readRef
160− writeRef r = lift . writeRef r
161−
162−instance MonadAtomicRef m => MonadAtomicRef (EventWriterT t w m) where
163− atomicModifyRef r = lift . atomicModifyRef r
164−
165−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (EventWriterT t w m) where
166− newEventWithTrigger = lift . newEventWithTrigger
167− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
src/Reflex/EventWriter/Base.hsnew file+317
@@ -0,0 +1,317 @@
1+-- | This module provides 'EventWriterT', the standard implementation of
2+-- 'EventWriter'.
3+{-# LANGUAGE CPP #-}
4+{-# LANGUAGE ExistentialQuantification #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE Rank2Types #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TypeFamilies #-}
11+{-# LANGUAGE TypeOperators #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+#ifdef USE_REFLEX_OPTIMIZER
14+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
15+#endif
16+module Reflex.EventWriter.Base
17+ ( EventWriterT (..)
18+ , runEventWriterT
19+ , runWithReplaceEventWriterTWith
20+ , sequenceDMapWithAdjustEventWriterTWith
21+ , mapEventWriterT
22+ , withEventWriterT
23+ ) where
24+
25+import Reflex.Adjustable.Class
26+import Reflex.Class
27+import Reflex.EventWriter.Class (EventWriter, tellEvent)
28+import Reflex.DynamicWriter.Class (DynamicWriter, tellDyn)
29+import Reflex.Host.Class
30+import Reflex.PerformEvent.Class
31+import Reflex.PostBuild.Class
32+import Reflex.Query.Class
33+import Reflex.Requester.Class
34+import Reflex.TriggerEvent.Class
35+
36+import Control.Monad.Exception
37+import Control.Monad.Identity
38+import Control.Monad.Morph
39+import Control.Monad.Primitive
40+import Control.Monad.Reader
41+import Control.Monad.Ref
42+import Control.Monad.State.Strict
43+import Data.Dependent.Map (DMap)
44+import qualified Data.Dependent.Map as DMap
45+import Data.Dependent.Sum (DSum (..))
46+import Data.Functor.Compose
47+import Data.Functor.Misc
48+import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
49+import Data.IntMap.Strict (IntMap)
50+import qualified Data.IntMap.Strict as IntMap
51+import Data.List.NonEmpty (NonEmpty (..))
52+import Data.Map (Map)
53+import qualified Data.Map as Map
54+import Data.Semigroup
55+import Data.Some (Some)
56+import Data.Tuple
57+import Data.Type.Equality
58+
59+import Unsafe.Coerce
60+
61+{-# DEPRECATED TellId "Do not construct this directly; use tellId instead" #-}
62+newtype TellId w x
63+ = TellId Int -- ^ WARNING: Do not construct this directly; use 'tellId' instead
64+ deriving (Show, Eq, Ord, Enum)
65+
66+tellId :: Int -> TellId w w
67+tellId = TellId
68+{-# INLINE tellId #-}
69+
70+tellIdRefl :: TellId w x -> w :~: x
71+tellIdRefl _ = unsafeCoerce Refl
72+
73+withTellIdRefl :: TellId w x -> (w ~ x => r) -> r
74+withTellIdRefl tid r = case tellIdRefl tid of
75+ Refl -> r
76+
77+instance GEq (TellId w) where
78+ a `geq` b =
79+ withTellIdRefl a $
80+ withTellIdRefl b $
81+ if a == b
82+ then Just Refl
83+ else Nothing
84+
85+instance GCompare (TellId w) where
86+ a `gcompare` b =
87+ withTellIdRefl a $
88+ withTellIdRefl b $
89+ case a `compare` b of
90+ LT -> GLT
91+ EQ -> GEQ
92+ GT -> GGT
93+
94+data EventWriterState t w = EventWriterState
95+ { _eventWriterState_nextId :: {-# UNPACK #-} !Int -- Always negative (and decreasing over time)
96+ , _eventWriterState_told :: ![DSum (TellId w) (Event t)] -- In increasing order
97+ }
98+
99+-- | A basic implementation of 'EventWriter'.
100+newtype EventWriterT t w m a = EventWriterT { unEventWriterT :: StateT (EventWriterState t w) m a }
101+ deriving
102+ ( Functor
103+ , Applicative
104+ , Monad
105+ , MonadTrans
106+ , MFunctor
107+ , MonadFix
108+ , MonadIO
109+ , MonadException
110+ , MonadAsyncException
111+ )
112+
113+-- | Run a 'EventWriterT' action.
114+runEventWriterT :: forall t m w a. (Reflex t, Monad m, Semigroup w) => EventWriterT t w m a -> m (a, Event t w)
115+runEventWriterT (EventWriterT a) = do
116+ (result, requests) <- runStateT a $ EventWriterState (-1) []
117+ let combineResults :: DMap (TellId w) Identity -> w
118+ combineResults = sconcat
119+ . (\(h : t) -> h :| t) -- Unconditional; 'merge' guarantees that it will only fire with non-empty DMaps
120+ . DMap.foldlWithKey (\vs tid (Identity v) -> withTellIdRefl tid $ v : vs) [] -- This is where we finally reverse the DMap to get things in the correct order
121+ return (result, fmap combineResults $ merge $ DMap.fromDistinctAscList $ _eventWriterState_told requests) --TODO: We can probably make this fromDistinctAscList more efficient by knowing the length in advance, but this will require exposing internals of DMap; also converting it to use a strict list might help
122+
123+instance (Reflex t, Monad m, Semigroup w) => EventWriter t w (EventWriterT t w m) where
124+ tellEvent w = EventWriterT $ modify $ \old ->
125+ let myId = _eventWriterState_nextId old
126+ in EventWriterState
127+ { _eventWriterState_nextId = pred myId
128+ , _eventWriterState_told = (tellId myId :=> w) : _eventWriterState_told old
129+ }
130+
131+instance MonadSample t m => MonadSample t (EventWriterT t w m) where
132+ sample = lift . sample
133+
134+instance MonadHold t m => MonadHold t (EventWriterT t w m) where
135+ {-# INLINABLE hold #-}
136+ hold v0 = lift . hold v0
137+ {-# INLINABLE holdDyn #-}
138+ holdDyn v0 = lift . holdDyn v0
139+ {-# INLINABLE holdIncremental #-}
140+ holdIncremental v0 = lift . holdIncremental v0
141+ {-# INLINABLE buildDynamic #-}
142+ buildDynamic a0 = lift . buildDynamic a0
143+ {-# INLINABLE headE #-}
144+ headE = lift . headE
145+ {-# INLINABLE now #-}
146+ now = lift now
147+
148+instance (Reflex t, Adjustable t m, MonadHold t m, Semigroup w) => Adjustable t (EventWriterT t w m) where
149+ runWithReplace = runWithReplaceEventWriterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
150+ traverseIntMapWithKeyWithAdjust = sequenceIntMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') mergeIntIncremental coincidencePatchIntMap
151+ traverseDMapWithKeyWithAdjust = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith mergeMapIncremental coincidencePatchMap
152+ traverseDMapWithKeyWithAdjustWithMove = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith mergeMapIncrementalWithMove coincidencePatchMapWithMove
153+
154+instance Requester t m => Requester t (EventWriterT t w m) where
155+ type Request (EventWriterT t w m) = Request m
156+ type Response (EventWriterT t w m) = Response m
157+ requesting = lift . requesting
158+ requesting_ = lift . requesting_
159+
160+-- | Given a function like 'runWithReplace' for the underlying monad, implement
161+-- 'runWithReplace' for 'EventWriterT'. This is necessary when the underlying
162+-- monad doesn't have a 'Adjustable' instance or to override the default
163+-- 'Adjustable' behavior.
164+runWithReplaceEventWriterTWith :: forall m t w a b. (Reflex t, MonadHold t m, Semigroup w)
165+ => (forall a' b'. m a' -> Event t (m b') -> EventWriterT t w m (a', Event t b'))
166+ -> EventWriterT t w m a
167+ -> Event t (EventWriterT t w m b)
168+ -> EventWriterT t w m (a, Event t b)
169+runWithReplaceEventWriterTWith f a0 a' = do
170+ (result0, result') <- f (runEventWriterT a0) $ fmapCheap runEventWriterT a'
171+ tellEvent =<< switchHoldPromptOnly (snd result0) (fmapCheap snd result')
172+ return (fst result0, fmapCheap fst result')
173+
174+-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceIntMapWithAdjust'.
175+sequenceIntMapWithAdjustEventWriterTWith
176+ :: forall t m p w v v'
177+ . ( Reflex t
178+ , MonadHold t m
179+ , Semigroup w
180+ , Functor p
181+ , Patch (p (Event t w))
182+ , PatchTarget (p (Event t w)) ~ IntMap (Event t w)
183+ , Patch (p w)
184+ , PatchTarget (p w) ~ IntMap w
185+ )
186+ => ( (IntMap.Key -> v -> m (Event t w, v'))
187+ -> IntMap v
188+ -> Event t (p v)
189+ -> EventWriterT t w m (IntMap (Event t w, v'), Event t (p (Event t w, v')))
190+ )
191+ -> (Incremental t (p (Event t w)) -> Event t (PatchTarget (p w)))
192+ -> (Event t (p (Event t w)) -> Event t (p w))
193+ -> (IntMap.Key -> v -> EventWriterT t w m v')
194+ -> IntMap v
195+ -> Event t (p v)
196+ -> EventWriterT t w m (IntMap v', Event t (p v'))
197+sequenceIntMapWithAdjustEventWriterTWith base mergePatchIncremental coincidencePatch f dm0 dm' = do
198+ let f' :: IntMap.Key -> v -> m (Event t w, v')
199+ f' k v = swap <$> runEventWriterT (f k v)
200+ (children0, children') <- base f' dm0 dm'
201+ let result0 = fmap snd children0
202+ result' = fmapCheap (fmap snd) children'
203+ requests0 :: IntMap (Event t w)
204+ requests0 = fmap fst children0
205+ requests' :: Event t (p (Event t w))
206+ requests' = fmapCheap (fmap fst) children'
207+ e <- switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch requests0 requests'
208+ tellEvent $ fforMaybeCheap e $ \m ->
209+ case IntMap.elems m of
210+ [] -> Nothing
211+ h : t -> Just $ sconcat $ h :| t
212+ return (result0, result')
213+
214+-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceDMapWithAdjust'.
215+sequenceDMapWithAdjustEventWriterTWith
216+ :: forall t m p p' w k v v'
217+ . ( Reflex t
218+ , MonadHold t m
219+ , Semigroup w
220+ , Patch (p' (Some k) (Event t w))
221+ , PatchTarget (p' (Some k) (Event t w)) ~ Map (Some k) (Event t w)
222+ , GCompare k
223+ , Patch (p' (Some k) w)
224+ , PatchTarget (p' (Some k) w) ~ Map (Some k) w
225+ )
226+ => ( (forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a))
227+ -> DMap k v
228+ -> Event t (p k v)
229+ -> EventWriterT t w m (DMap k (Compose ((,) (Event t w)) v'), Event t (p k (Compose ((,) (Event t w)) v')))
230+ )
231+ -> ((forall a. Compose ((,) (Event t w)) v' a -> v' a) -> p k (Compose ((,) (Event t w)) v') -> p k v')
232+ -> ((forall a. Compose ((,) (Event t w)) v' a -> Event t w) -> p k (Compose ((,) (Event t w)) v') -> p' (Some k) (Event t w))
233+ -> (Incremental t (p' (Some k) (Event t w)) -> Event t (PatchTarget (p' (Some k) w)))
234+ -> (Event t (p' (Some k) (Event t w)) -> Event t (p' (Some k) w))
235+ -> (forall a. k a -> v a -> EventWriterT t w m (v' a))
236+ -> DMap k v
237+ -> Event t (p k v)
238+ -> EventWriterT t w m (DMap k v', Event t (p k v'))
239+sequenceDMapWithAdjustEventWriterTWith base mapPatch weakenPatchWith mergePatchIncremental coincidencePatch f dm0 dm' = do
240+ let f' :: forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a)
241+ f' k v = Compose . swap <$> runEventWriterT (f k v)
242+ (children0, children') <- base f' dm0 dm'
243+ let result0 = DMap.map (snd . getCompose) children0
244+ result' = fforCheap children' $ mapPatch $ snd . getCompose
245+ requests0 :: Map (Some k) (Event t w)
246+ requests0 = weakenDMapWith (fst . getCompose) children0
247+ requests' :: Event t (p' (Some k) (Event t w))
248+ requests' = fforCheap children' $ weakenPatchWith $ fst . getCompose
249+ e <- switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch requests0 requests'
250+ tellEvent $ fforMaybeCheap e $ \m ->
251+ case Map.elems m of
252+ [] -> Nothing
253+ h : t -> Just $ sconcat $ h :| t
254+ return (result0, result')
255+
256+instance PerformEvent t m => PerformEvent t (EventWriterT t w m) where
257+ type Performable (EventWriterT t w m) = Performable m
258+ performEvent_ = lift . performEvent_
259+ performEvent = lift . performEvent
260+
261+instance PostBuild t m => PostBuild t (EventWriterT t w m) where
262+ getPostBuild = lift getPostBuild
263+
264+instance TriggerEvent t m => TriggerEvent t (EventWriterT t w m) where
265+ newTriggerEvent = lift newTriggerEvent
266+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
267+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
268+
269+instance MonadReader r m => MonadReader r (EventWriterT t w m) where
270+ ask = lift ask
271+ local f (EventWriterT a) = EventWriterT $ mapStateT (local f) a
272+ reader = lift . reader
273+
274+instance MonadRef m => MonadRef (EventWriterT t w m) where
275+ type Ref (EventWriterT t w m) = Ref m
276+ newRef = lift . newRef
277+ readRef = lift . readRef
278+ writeRef r = lift . writeRef r
279+
280+instance MonadAtomicRef m => MonadAtomicRef (EventWriterT t w m) where
281+ atomicModifyRef r = lift . atomicModifyRef r
282+
283+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (EventWriterT t w m) where
284+ newEventWithTrigger = lift . newEventWithTrigger
285+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
286+
287+instance (MonadQuery t q m, Monad m) => MonadQuery t q (EventWriterT t w m) where
288+ tellQueryIncremental = lift . tellQueryIncremental
289+ askQueryResult = lift askQueryResult
290+ queryIncremental = lift . queryIncremental
291+
292+instance DynamicWriter t w m => DynamicWriter t w (EventWriterT t v m) where
293+ tellDyn = lift . tellDyn
294+
295+instance PrimMonad m => PrimMonad (EventWriterT t w m) where
296+ type PrimState (EventWriterT t w m) = PrimState m
297+ primitive = lift . primitive
298+
299+-- | Map a function over the output of a 'EventWriterT'.
300+withEventWriterT :: (Semigroup w, Semigroup w', Reflex t, MonadHold t m)
301+ => (w -> w')
302+ -> EventWriterT t w m a
303+ -> EventWriterT t w' m a
304+withEventWriterT f ew = do
305+ (r, e) <- lift $ do
306+ (r, e) <- runEventWriterT ew
307+ let e' = fmap f e
308+ return (r, e')
309+ tellEvent e
310+ return r
311+
312+-- | Change the monad underlying an EventWriterT
313+mapEventWriterT
314+ :: (forall x. m x -> n x)
315+ -> EventWriterT t w m a
316+ -> EventWriterT t w n a
317+mapEventWriterT f (EventWriterT a) = EventWriterT $ mapStateT f a
src/Reflex/EventWriter/Class.hsnew file+26
@@ -0,0 +1,26 @@
1+-- | This module defines the 'EventWriter' class.
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE FunctionalDependencies #-}
5+{-# LANGUAGE UndecidableInstances #-}
6+#ifdef USE_REFLEX_OPTIMIZER
7+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
8+#endif
9+module Reflex.EventWriter.Class
10+ ( EventWriter (..)
11+ ) where
12+
13+import Control.Monad.Reader (ReaderT, lift)
14+import Data.Semigroup (Semigroup)
15+
16+import Reflex.Class (Event)
17+
18+
19+-- | 'EventWriter' efficiently collects 'Event' values using 'tellEvent'
20+-- and combines them via 'Semigroup' to provide an 'Event' result.
21+class (Monad m, Semigroup w) => EventWriter t w m | m -> t w where
22+ tellEvent :: Event t w -> m ()
23+
24+
25+instance EventWriter t w m => EventWriter t w (ReaderT r m) where
26+ tellEvent = lift . tellEvent
src/Reflex/FastWeak.hsnew file+210
@@ -0,0 +1,210 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+#if GHCJS_FAST_WEAK
5+{-# LANGUAGE ForeignFunctionInterface #-}
6+{-# LANGUAGE JavaScriptFFI #-}
7+#endif
8+
9+-- |
10+-- Module:
11+-- Reflex.FastWeak
12+-- Description:
13+-- 'FastWeak' is a weak pointer to some value, and 'FastWeakTicket' ensures the value
14+-- referred to by a 'FastWeak' stays live while the ticket is held (live).
15+--
16+-- On GHC or GHCJS when not built with the @fast-weak@ cabal flag, 'FastWeak' is a wrapper
17+-- around the simple version of 'System.Mem.Weak.Weak' where the key and value are the same.
18+--
19+-- On GHCJS when built with the @fast-weak@ cabal flag, 'FastWeak' is implemented directly
20+-- in JS using @h$FastWeak@ and @h$FastWeakTicket@ which are a nonstandard part of the GHCJS RTS.
21+module Reflex.FastWeak
22+ ( FastWeakTicket
23+ , FastWeak
24+ , mkFastWeakTicket
25+ , getFastWeakTicketValue
26+ , getFastWeakTicketWeak
27+ , getFastWeakValue
28+ , getFastWeakTicket
29+ , emptyFastWeak
30+#ifdef GHCJS_FAST_WEAK
31+ --TODO: Move these elsewhere
32+ , unsafeFromRawJSVal
33+ , unsafeToRawJSVal
34+ , js_isNull
35+#endif
36+ ) where
37+
38+import GHC.Exts (Any)
39+import Unsafe.Coerce
40+
41+#ifdef GHCJS_FAST_WEAK
42+import GHCJS.Types
43+#else
44+import Control.Exception (evaluate)
45+import System.IO.Unsafe
46+import System.Mem.Weak
47+#endif
48+
49+
50+#ifdef GHCJS_FAST_WEAK
51+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
52+-- can be used to get the referred to value without fear of @Nothing,
53+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
54+--
55+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeakTicket@.
56+newtype FastWeakTicket a = FastWeakTicket JSVal
57+
58+-- | A reference to some value which can be garbage collected if there are only
59+-- weak references to the value left.
60+--
61+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
62+--
63+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using
64+-- 'getFastWeakTicket' if the value hasn't been collected yet.
65+--
66+-- Implemented by way of special support in the GHCJS RTS, @h$FastWeak@.
67+newtype FastWeak a = FastWeak JSVal
68+
69+-- Just designed to mirror JSVal, so that we can unsafeCoerce between the two
70+data Val a = Val { unVal :: a }
71+
72+-- | Coerce a JSVal that represents the heap object of a value of type @a@ into a value of type @a@
73+unsafeFromRawJSVal :: JSVal -> a
74+unsafeFromRawJSVal v = unVal (unsafeCoerce v)
75+
76+-- | Coerce a heap object of type @a@ into a 'JSVal' which represents that object.
77+unsafeToRawJSVal :: a -> JSVal
78+unsafeToRawJSVal v = unsafeCoerce (Val v)
79+#else
80+-- | A 'FastWeak' which has been promoted to a strong reference. 'getFastWeakTicketValue'
81+-- can be used to get the referred to value without fear of @Nothing@,
82+-- and 'getFastWeakTicketWeak' can be used to get the weak version.
83+data FastWeakTicket a = FastWeakTicket
84+ { _fastWeakTicket_val :: !a
85+ , _fastWeakTicket_weak :: {-# UNPACK #-} !(Weak a)
86+ }
87+
88+-- | A reference to some value which can be garbage collected if there are only weak references to the value left.
89+--
90+-- 'getFastWeakValue' can be used to try and obtain a strong reference to the value.
91+--
92+-- The value in a @FastWeak@ can also be kept alive by obtaining a 'FastWeakTicket' using 'getFastWeakTicket'
93+-- if the value hasn't been collected yet.
94+--
95+-- Synonymous with 'Weak'.
96+type FastWeak a = Weak a
97+#endif
98+
99+-- | Return the @a@ kept alive by the given 'FastWeakTicket'.
100+--
101+-- This needs to be in IO so we know that we've relinquished the ticket.
102+getFastWeakTicketValue :: FastWeakTicket a -> IO a
103+#ifdef GHCJS_FAST_WEAK
104+getFastWeakTicketValue t = do
105+ v <- js_ticketVal t
106+ return $ unsafeFromRawJSVal v
107+
108+foreign import javascript unsafe "$r = $1.val;" js_ticketVal :: FastWeakTicket a -> IO JSVal
109+#else
110+getFastWeakTicketValue = return . _fastWeakTicket_val
111+#endif
112+
113+-- | Get the value referred to by a 'FastWeak' if it hasn't yet been collected,
114+-- or @Nothing@ if it has been collected.
115+getFastWeakValue :: FastWeak a -> IO (Maybe a)
116+#ifdef GHCJS_FAST_WEAK
117+getFastWeakValue w = do
118+ r <- js_weakVal w
119+ case js_isNull r of
120+ True -> return Nothing
121+ False -> return $ Just $ unsafeFromRawJSVal r
122+
123+foreign import javascript unsafe "$1 === null" js_isNull :: JSVal -> Bool
124+
125+foreign import javascript unsafe "$r = ($1.ticket === null) ? null : $1.ticket.val;" js_weakVal :: FastWeak a -> IO JSVal
126+#else
127+getFastWeakValue = deRefWeak
128+#endif
129+
130+-- | Try to create a 'FastWeakTicket' for the given 'FastWeak' which will ensure the value referred
131+-- remains alive. Returns @Just@ if the value hasn't been collected
132+-- and a ticket can therefore be obtained, @Nothing@ if it's been collected.
133+getFastWeakTicket :: forall a. FastWeak a -> IO (Maybe (FastWeakTicket a))
134+#ifdef GHCJS_FAST_WEAK
135+getFastWeakTicket w = do
136+ r <- js_weakTicket w
137+ case js_isNull r of
138+ True -> return Nothing
139+ False -> return $ Just $ FastWeakTicket r
140+
141+foreign import javascript unsafe "$r = $1.ticket;" js_weakTicket :: FastWeak a -> IO JSVal
142+#else
143+getFastWeakTicket w = do
144+ deRefWeak w >>= \case
145+ Nothing -> return Nothing
146+ Just v -> return $ Just $ FastWeakTicket
147+ { _fastWeakTicket_val = v
148+ , _fastWeakTicket_weak = w
149+ }
150+#endif
151+
152+-- | Create a 'FastWeakTicket' directly from a value, creating a 'FastWeak' in the process
153+-- which can be obtained with 'getFastWeakTicketValue'.
154+--
155+-- This function is marked NOINLINE so it is opaque to GHC.
156+-- If we do not do this, then GHC will sometimes fuse the constructor away
157+-- so any weak references that are attached to the ticket will have their
158+-- finalizer run. Using the opaque constructor, GHC does not see the
159+-- constructor application, so it behaves like an IORef and cannot be fused away.
160+--
161+-- The result is also evaluated to WHNF, since forcing a thunk invalidates
162+-- the weak pointer to it in some cases.
163+{-# NOINLINE mkFastWeakTicket #-}
164+mkFastWeakTicket :: a -> IO (FastWeakTicket a)
165+-- I think it's fine if this is lazy - it'll retain the 'a', but so would the output; we just need to make sure it's forced before we start relying on the
166+-- associated FastWeak to actually be weak
167+#ifdef GHCJS_FAST_WEAK
168+mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
169+
170+foreign import javascript unsafe "$r = new h$FastWeakTicket($1);" js_fastWeakTicket :: JSVal -> IO (FastWeakTicket a)
171+#else
172+mkFastWeakTicket v = do
173+ v' <- evaluate v
174+ w <- mkWeakPtr v' Nothing
175+ return $ FastWeakTicket
176+ { _fastWeakTicket_val = v'
177+ , _fastWeakTicket_weak = w
178+ }
179+#endif
180+
181+-- | Demote a 'FastWeakTicket'; which ensures the value is alive, to a 'FastWeak' which doesn't.
182+-- Note that unless the ticket for the same 'FastWeak' is held in some other way
183+-- the value might be collected immediately.
184+getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
185+-- Needs IO so that it can force the value - otherwise, could end up with a reference to the Ticket, which would retain the value
186+#ifdef GHCJS_FAST_WEAK
187+foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak' :: FastWeakTicket a -> IO (FastWeak a)
188+{-# INLINE getFastWeakTicketWeak #-}
189+getFastWeakTicketWeak = getFastWeakTicketWeak'
190+#else
191+getFastWeakTicketWeak = return . _fastWeakTicket_weak
192+#endif
193+
194+-- | A weak reference that is always empty
195+emptyFastWeak :: FastWeak a
196+emptyFastWeak = unsafeCoerce w
197+ where w :: FastWeak Any
198+#ifdef GHCJS_FAST_WEAK
199+ w = js_emptyWeak
200+#else
201+ w = unsafePerformIO $ do
202+ w' <- mkWeakPtr undefined Nothing
203+ finalize w'
204+ return w'
205+#endif
206+{-# NOINLINE emptyFastWeak #-}
207+
208+#ifdef GHCJS_FAST_WEAK
209+foreign import javascript unsafe "$r = new h$FastWeak(null);" js_emptyWeak :: FastWeak Any
210+#endif
src/Reflex/FunctorMaybe.hs+34−16
@@ -1,29 +1,47 @@
1+{-# LANGUAGE CPP #-}
2+#if MIN_VERSION_base(4,9,0)
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE StandaloneDeriving #-}
5+#endif
6+
7+-- |
8+-- Module:
9+-- Reflex.FunctorMaybe
10+-- Description:
1−-- | This module defines the FunctorMaybe class, which extends Functors with the
11+-- This module defines the FunctorMaybe class, which extends Functors with the
2−-- ability to delete values.
12+-- ability to delete values.
3module Reflex.FunctorMaybe
13module Reflex.FunctorMaybe
4 ( FunctorMaybe (..)
14 ( FunctorMaybe (..)
5 ) where
15 ) where
6
16
7−import Data.Maybe
17+import Data.IntMap (IntMap)
18+import Data.Map (Map)
19+#if MIN_VERSION_base(4,9,0)
20+import Data.Semigroup (Option(..))
21+#endif
22+import Data.Witherable
8
23
9--TODO: See if there's a better class in the standard libraries already
24--TODO: See if there's a better class in the standard libraries already
10
25
11-- | A class for values that combines filtering and mapping using 'Maybe'.
26-- | A class for values that combines filtering and mapping using 'Maybe'.
12−-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@. Also similar is the
27+-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@.
13−-- @Witherable@ typeclass, but it requires @Foldable f@ and @Traverable f@,
28+{-# DEPRECATED FunctorMaybe "Use 'Filterable' from Data.Witherable instead" #-}
14−-- and e.g. 'Event' is instance of neither.
15−--
16−-- A definition of 'fmapMaybe' must satisfy the following laws:
17−--
18−-- [/identity/]
19−-- @'fmapMaybe' 'Just' ≡ 'id'@
20−--
21−-- [/composition/]
22−-- @'fmapMaybe' (f <=< g) ≡ 'fmapMaybe' f . 'fmapMaybe' g@
23class FunctorMaybe f where
29class FunctorMaybe f where
24 -- | Combined mapping and filtering function.
30 -- | Combined mapping and filtering function.
25 fmapMaybe :: (a -> Maybe b) -> f a -> f b
31 fmapMaybe :: (a -> Maybe b) -> f a -> f b
26
32
33+instance FunctorMaybe Maybe where
27−-- | @fmapMaybe f = catMaybes . fmap f@
34+ fmapMaybe = mapMaybe
35+
36+#if MIN_VERSION_base(4,9,0)
37+deriving instance FunctorMaybe Option
38+#endif
39+
28instance FunctorMaybe [] where
40instance FunctorMaybe [] where
29− fmapMaybe f = catMaybes . fmap f
41+ fmapMaybe = mapMaybe
42+
43+instance FunctorMaybe (Map k) where
44+ fmapMaybe = mapMaybe
45+
46+instance FunctorMaybe IntMap where
47+ fmapMaybe = mapMaybe
src/Reflex/Host/Class.hs+6−26
@@ -4,7 +4,6 @@
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE GADTs #-}
6{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE RankNTypes #-}
7{-# LANGUAGE RankNTypes #-}
9{-# LANGUAGE RoleAnnotations #-}
8{-# LANGUAGE RoleAnnotations #-}
10{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
@@ -30,38 +29,19 @@ module Reflex.Host.Class
30
29
31import Reflex.Class
30import Reflex.Class
32
31
33−import Control.Applicative
34−import Control.Monad
35import Control.Monad.Fix
32import Control.Monad.Fix
36import Control.Monad.Identity
33import Control.Monad.Identity
37import Control.Monad.Ref
34import Control.Monad.Ref
38import Control.Monad.Trans
35import Control.Monad.Trans
39−import Control.Monad.Trans.Cont (ContT ())
36+import Control.Monad.Trans.Cont (ContT)
40−import Control.Monad.Trans.Except (ExceptT ())
37+import Control.Monad.Trans.Except (ExceptT)
41−import Control.Monad.Trans.Reader (ReaderT ())
38+import Control.Monad.Trans.Reader (ReaderT)
42−import Control.Monad.Trans.RWS (RWST ())
39+import Control.Monad.Trans.RWS (RWST)
43−import Control.Monad.Trans.State (StateT ())
40+import Control.Monad.Trans.State (StateT)
44import qualified Control.Monad.Trans.State.Strict as Strict
41import qualified Control.Monad.Trans.State.Strict as Strict
45−import Control.Monad.Trans.Writer (WriterT ())
42+import Control.Monad.Trans.Writer (WriterT)
46import Data.Dependent.Sum (DSum (..))
43import Data.Dependent.Sum (DSum (..))
47import Data.GADT.Compare
44import Data.GADT.Compare
48−import Data.Monoid
49−
50−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
51−import Control.Monad.Primitive (touch)
52−import Data.IORef
53−import Reflex.Spider.Internal (EventM (..), HasSpiderTimeline, RootTrigger, SpiderEventHandle (..),
54− SpiderHost (..), SpiderHostFrame (..), Subscriber (..), newEventWithTriggerIO,
55− newFanEventWithTriggerIO, run, runFrame, scheduleClear, subscribe)
56−import qualified Reflex.Spider.Internal
57−#endif
58−
59−-- Note: this import must come last to silence warnings from AMP
60−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
61−
62−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
63−#include "../Spider/SpiderTimelineHost.include.hs"
64−#endif
65
45
66-- | Framework implementation support class for the reflex implementation
46-- | Framework implementation support class for the reflex implementation
67-- represented by @t@.
47-- represented by @t@.
src/Reflex/Host/Headless.hsnew file+128
@@ -0,0 +1,128 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE TypeFamilies #-}
5+{-# LANGUAGE ConstraintKinds #-}
6+
7+module Reflex.Host.Headless where
8+
9+import Control.Concurrent.Chan (newChan, readChan)
10+import Control.Monad (unless)
11+import Control.Monad.Fix (MonadFix, fix)
12+import Control.Monad.IO.Class (MonadIO, liftIO)
13+import Control.Monad.Primitive (PrimMonad)
14+import Control.Monad.Ref (MonadRef, Ref, readRef)
15+import Data.Dependent.Sum (DSum (..), (==>))
16+import Data.Foldable (for_)
17+import Data.Functor.Identity (Identity(..))
18+import Data.IORef (IORef, readIORef)
19+import Data.Maybe (catMaybes, fromMaybe)
20+import Data.Traversable (for)
21+
22+import Reflex
23+import Reflex.Host.Class
24+
25+type MonadHeadlessApp t m =
26+ ( Adjustable t m
27+ , MonadFix m
28+ , MonadHold t m
29+ , MonadIO (HostFrame t)
30+ , MonadIO (Performable m)
31+ , MonadIO m
32+ , MonadRef (HostFrame t)
33+ , NotReady t m
34+ , PerformEvent t m
35+ , PostBuild t m
36+ , PrimMonad (HostFrame t)
37+ , Ref (HostFrame t) ~ IORef
38+ , Ref m ~ IORef
39+ , Reflex t
40+ , ReflexHost t
41+ , TriggerEvent t m
42+ )
43+
44+-- | Run a headless FRP network. Inside the action, you will most probably use
45+-- the capabilities provided by the 'TriggerEvent' and 'PerformEvent' type
46+-- classes to interface the FRP network with the outside world. Useful for
47+-- testing. Each headless network runs on its own spider timeline.
48+runHeadlessApp
49+ :: (forall t m. MonadHeadlessApp t m => m (Event t ()))
50+ -- ^ The action to be run in the headless FRP network. The FRP network is
51+ -- closed at the first occurrence of the resulting 'Event'.
52+ -> IO ()
53+runHeadlessApp guest =
54+ -- We are using the 'Spider' implementation of reflex. Running the host
55+ -- allows us to take actions on the FRP timeline.
56+ withSpiderTimeline $ runSpiderHostForTimeline $ do
57+ -- Create the "post-build" event and associated trigger. This event fires
58+ -- once, when the application starts.
59+ (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
60+ -- Create a queue to which we will write 'Event's that need to be
61+ -- processed.
62+ events <- liftIO newChan
63+ -- Run the "guest" application, providing the appropriate context. We'll
64+ -- pure the result of the action, and a 'FireCommand' that will be used to
65+ -- trigger events.
66+ (result, fc@(FireCommand fire)) <- do
67+ hostPerformEventT $ -- Allows the guest app to run
68+ -- 'performEvent', so that actions
69+ -- (e.g., IO actions) can be run when
70+ -- 'Event's fire.
71+
72+ flip runPostBuildT postBuild $ -- Allows the guest app to access to
73+ -- a "post-build" 'Event'
74+
75+ flip runTriggerEventT events $ -- Allows the guest app to create new
76+ -- events and triggers and write
77+ -- those triggers to a channel from
78+ -- which they will be read and
79+ -- processed.
80+ guest
81+
82+ -- Read the trigger reference for the post-build event. This will be
83+ -- 'Nothing' if the guest application hasn't subscribed to this event.
84+ mPostBuildTrigger <- readRef postBuildTriggerRef
85+
86+ -- Subscribe to an 'Event' of that the guest application can use to
87+ -- request application shutdown. We'll check whether this 'Event' is firing
88+ -- to determine whether to terminate.
89+ shutdown <- subscribeEvent result
90+
91+ -- When there is a subscriber to the post-build event, fire the event.
92+ soa <- for mPostBuildTrigger $ \postBuildTrigger ->
93+ fire [postBuildTrigger :=> Identity ()] $ isFiring shutdown
94+
95+ -- The main application loop. We wait for new events and fire those that
96+ -- have subscribers. If we detect a shutdown request, the application
97+ -- terminates.
98+ unless (or (fromMaybe [] soa)) $ fix $ \loop -> do
99+ -- Read the next event (blocking).
100+ ers <- liftIO $ readChan events
101+ stop <- do
102+ -- Fire events that have subscribers.
103+ fireEventTriggerRefs fc ers $
104+ -- Check if the shutdown 'Event' is firing.
105+ isFiring shutdown
106+ if or stop
107+ then pure ()
108+ else loop
109+ where
110+ isFiring ev = readEvent ev >>= \case
111+ Nothing -> pure False
112+ Just _ -> pure True
113+ -- Use the given 'FireCommand' to fire events that have subscribers
114+ -- and call the callback for the 'TriggerInvocation' of each.
115+ fireEventTriggerRefs
116+ :: MonadIO m
117+ => FireCommand t m
118+ -> [DSum (EventTriggerRef t) TriggerInvocation]
119+ -> ReadPhase m a
120+ -> m [a]
121+ fireEventTriggerRefs (FireCommand fire) ers rcb = do
122+ mes <- liftIO $
123+ for ers $ \(EventTriggerRef er :=> TriggerInvocation a _) -> do
124+ me <- readIORef er
125+ pure $ fmap (==> a) me
126+ a <- fire (catMaybes mes) rcb
127+ liftIO $ for_ ers $ \(_ :=> TriggerInvocation _ cb) -> cb
128+ pure a
src/Reflex/Network.hsnew file+45
@@ -0,0 +1,45 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE MultiParamTypeClasses #-}
3+#ifdef USE_REFLEX_OPTIMIZER
4+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
5+#endif
6+-- |
7+-- Module:
8+-- Reflex.Network
9+-- Description:
10+-- This module provides combinators for building FRP graphs/networks and modifying them dynamically.
11+module Reflex.Network
12+ ( networkView
13+ , networkHold
14+ , untilReady
15+ ) where
16+
17+import Reflex.Class
18+import Reflex.Adjustable.Class
19+import Reflex.NotReady.Class
20+import Reflex.PostBuild.Class
21+
22+-- | A 'Dynamic' "network": Takes a 'Dynamic' of network-creating actions and replaces the network whenever the 'Dynamic' updates.
23+-- The returned Event of network results fires at post-build time and when the 'Dynamic' updates.
24+-- Note: Often, the type 'a' is an Event, in which case the return value is an Event-of-Events, where the outer 'Event' fires
25+-- when switching networks. Such an 'Event' would typically be flattened (via 'switchPromptly').
26+networkView :: (NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
27+networkView child = do
28+ postBuild <- getPostBuild
29+ let newChild = leftmost [updated child, tagCheap (current child) postBuild]
30+ snd <$> runWithReplace notReady newChild
31+
32+-- | Given an initial "network" and an 'Event' of network-creating actions, create a network that is recreated whenever the Event fires.
33+-- The returned Dynamic of network results occurs when the Event does.
34+-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
35+networkHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
36+networkHold child0 newChild = do
37+ (result0, newResult) <- runWithReplace child0 newChild
38+ holdDyn result0 newResult
39+
40+-- | Render a placeholder network to be shown while another network is not yet
41+-- done building
42+untilReady :: (Adjustable t m, PostBuild t m) => m a -> m b -> m (a, Event t b)
43+untilReady a b = do
44+ postBuild <- getPostBuild
45+ runWithReplace a $ b <$ postBuild
src/Reflex/NotReady/Class.hsnew file+77
@@ -0,0 +1,77 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DefaultSignatures #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FunctionalDependencies #-}
6+{-# LANGUAGE TypeFamilies #-}
7+{-# LANGUAGE UndecidableInstances #-}
8+#ifdef USE_REFLEX_OPTIMIZER
9+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
10+#endif
11+module Reflex.NotReady.Class
12+ ( NotReady(..)
13+ ) where
14+
15+import Control.Monad.Reader (ReaderT)
16+import Control.Monad.Trans
17+import Control.Monad.Trans.Writer (WriterT)
18+
19+import Reflex.BehaviorWriter.Base (BehaviorWriterT)
20+import Reflex.Class
21+import Reflex.DynamicWriter.Base (DynamicWriterT)
22+import Reflex.EventWriter.Base (EventWriterT)
23+import Reflex.Host.Class
24+import Reflex.PerformEvent.Base (PerformEventT (..))
25+import Reflex.PostBuild.Base (PostBuildT)
26+import Reflex.Query.Base (QueryT)
27+import Reflex.Requester.Base (RequesterT)
28+import Reflex.TriggerEvent.Base (TriggerEventT)
29+
30+class Monad m => NotReady t m | m -> t where
31+ notReadyUntil :: Event t a -> m ()
32+ default notReadyUntil :: (MonadTrans f, m ~ f m', NotReady t m') => Event t a -> m ()
33+ notReadyUntil = lift . notReadyUntil
34+
35+ notReady :: m ()
36+ default notReady :: (MonadTrans f, m ~ f m', NotReady t m') => m ()
37+ notReady = lift notReady
38+
39+instance NotReady t m => NotReady t (ReaderT r m) where
40+ notReadyUntil = lift . notReadyUntil
41+ notReady = lift notReady
42+
43+instance (NotReady t m, Monoid w) => NotReady t (WriterT w m) where
44+ notReadyUntil = lift . notReadyUntil
45+ notReady = lift notReady
46+
47+instance NotReady t m => NotReady t (PostBuildT t m) where
48+ notReadyUntil = lift . notReadyUntil
49+ notReady = lift notReady
50+
51+instance NotReady t m => NotReady t (EventWriterT t w m) where
52+ notReadyUntil = lift . notReadyUntil
53+ notReady = lift notReady
54+
55+instance NotReady t m => NotReady t (DynamicWriterT t w m) where
56+ notReadyUntil = lift . notReadyUntil
57+ notReady = lift notReady
58+
59+instance NotReady t m => NotReady t (BehaviorWriterT t w m) where
60+ notReadyUntil = lift . notReadyUntil
61+ notReady = lift notReady
62+
63+instance NotReady t m => NotReady t (QueryT t q m) where
64+ notReadyUntil = lift . notReadyUntil
65+ notReady = lift notReady
66+
67+instance (ReflexHost t, NotReady t (HostFrame t)) => NotReady t (PerformEventT t m) where
68+ notReadyUntil = PerformEventT . notReadyUntil
69+ notReady = PerformEventT notReady
70+
71+instance NotReady t m => NotReady t (RequesterT t request response m) where
72+ notReadyUntil = lift . notReadyUntil
73+ notReady = lift notReady
74+
75+instance NotReady t m => NotReady t (TriggerEventT t m) where
76+ notReadyUntil = lift . notReadyUntil
77+ notReady = lift notReady
src/Reflex/Optimizer.hs+19−5
@@ -1,10 +1,14 @@
1−-- | This module provides a GHC plugin designed to improve code that uses
2−-- Reflex. Currently, it just adds an INLINABLE pragma to any top-level
3−-- definition that doesn't have an explicit inlining pragma. In the future,
4−-- additional optimizations are likely to be added.
5{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
6{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE LambdaCase #-}
7{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
4+-- |
5+-- Module:
6+-- Reflex.Optimizer
7+-- Description:
8+-- This module provides a GHC plugin designed to improve code that uses
9+-- Reflex. Currently, it just adds an INLINABLE pragma to any top-level
10+-- definition that doesn't have an explicit inlining pragma. In the future,
11+-- additional optimizations are likely to be added.
8module Reflex.Optimizer
12module Reflex.Optimizer
9 ( plugin
13 ( plugin
10 ) where
14 ) where
@@ -16,6 +20,11 @@ import Control.Arrow
16import CoreMonad
20import CoreMonad
17import Data.String
21import Data.String
18import GhcPlugins
22import GhcPlugins
23+
24+#if MIN_VERSION_base(4,9,0)
25+import Prelude hiding ((<>))
26+#endif
27+
19#endif
28#endif
20
29
21#ifdef ghcjs_HOST_OS
30#ifdef ghcjs_HOST_OS
@@ -31,7 +40,12 @@ plugin :: Plugin
31plugin = defaultPlugin { installCoreToDos = install }
40plugin = defaultPlugin { installCoreToDos = install }
32
41
33install :: [CommandLineOption] -> [CoreToDo] -> CoreM [CoreToDo]
42install :: [CommandLineOption] -> [CoreToDo] -> CoreM [CoreToDo]
43+install [] p = do
44+ liftIO $ putStrLn $ showSDocUnsafe $ ppr p
45+ let f = \case
46+ simpl@(CoreDoSimplify _ _) -> [CoreDoSpecialising, simpl]
47+ x -> [x]
34−install [] p = return $ makeInlinable : p
48+ return $ makeInlinable : concatMap f p
35install options@(_:_) p = do
49install options@(_:_) p = do
36 warnMsg $ "Reflex.Optimizer: ignoring " <> fromString (show $ length options) <> " command-line options"
50 warnMsg $ "Reflex.Optimizer: ignoring " <> fromString (show $ length options) <> " command-line options"
37 install [] p
51 install [] p
src/Reflex/Patch.hsdeleted−388
@@ -1,388 +0,0 @@
1−-- | This module defines the 'Patch' class, which is used by Reflex to manage
2−-- changes to 'Reflex.Class.Incremental' values.
3−{-# LANGUAGE CPP #-}
4−{-# LANGUAGE DeriveFoldable #-}
5−{-# LANGUAGE DeriveFunctor #-}
6−{-# LANGUAGE DeriveTraversable #-}
7−{-# LANGUAGE FlexibleContexts #-}
8−{-# LANGUAGE GADTs #-}
9−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10−{-# LANGUAGE LambdaCase #-}
11−{-# LANGUAGE PolyKinds #-}
12−{-# LANGUAGE Rank2Types #-}
13−{-# LANGUAGE ScopedTypeVariables #-}
14−{-# LANGUAGE StandaloneDeriving #-}
15−{-# LANGUAGE TypeFamilies #-}
16−module Reflex.Patch
17− ( Patch (..)
18− , PatchDMap (..)
19− , mapPatchDMap
20− , traversePatchDMap
21− , traversePatchDMapWithKey
22− , weakenPatchDMapWith
23− , patchDMapToPatchMapWith
24− , const2PatchDMapWith
25− , ComposeMaybe (..)
26− , PatchMap (..)
27− , patchMapNewElements
28− , Group (..)
29− , Additive
30− , AdditivePatch (..)
31− , PatchMapWithMove
32− , unPatchMapWithMove
33− , unsafePatchMapWithMove
34− , patchMapWithMoveNewElements
35− , MapEdit (..)
36− , mapEditMoved
37− , mapEditSetMoved
38− , PatchDMapWithMove
39− , unPatchDMapWithMove
40− , unsafePatchDMapWithMove
41− , patchThatSortsMapWith
42− , patchThatChangesAndSortsMapWith
43− , mapPatchDMapWithMove
44− , traversePatchDMapWithMove
45− , traversePatchDMapWithMoveWithKey
46− , weakenPatchDMapWithMoveWith
47− , patchDMapWithMoveToPatchMapWithMoveWith
48− , const2PatchDMapWithMoveWith
49− , DMapEdit (..)
50− , dmapEditMoved
51− -- * Test functions
52− , validPatchMapWithMove
53− , knownValidPatchMapWithMove
54− , knownInvalidPatchMapWithMove
55− ) where
56−
57−import Control.Arrow
58−import Control.Monad.Identity
59−import Control.Monad.State
60−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
61−import qualified Data.Dependent.Map as DMap
62−import Data.Foldable
63−import Data.Function
64−import Data.Functor.Constant
65−import Data.Functor.Misc
66−import Data.List
67−import Data.Map (Map)
68−import qualified Data.Map as Map
69−import Data.Maybe
70−import Data.Semigroup (Semigroup (..), stimesIdempotentMonoid, (<>))
71−import Data.Set (Set)
72−import qualified Data.Set as Set
73−import Data.Some (Some)
74−import qualified Data.Some as Some
75−import Data.Tuple
76−
77−-- | A 'Patch' type represents a kind of change made to a datastructure.
78−class Patch p where
79− type PatchTarget p :: *
80− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
81− -- 'Nothing'.
82− apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
83−
84−-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
85−-- make the 'f' parameter have a nominal type role. We need f to be
86−-- representational so that we can use safe 'coerce'.
87−newtype ComposeMaybe f a = ComposeMaybe { getComposeMaybe :: Maybe (f a) }
88−
89−deriving instance Functor f => Functor (ComposeMaybe f)
90−
91−instance Patch (Identity a) where
92− type PatchTarget (Identity a) = a
93− apply (Identity a) _ = Just a
94−
95−-- | A set of changes to a 'DMap'. Any element may be inserted/updated or
96−-- deleted.
97−newtype PatchDMap k v = PatchDMap (DMap k (ComposeMaybe v))
98−
99−deriving instance GCompare k => Semigroup (PatchDMap k v)
100−
101−deriving instance GCompare k => Monoid (PatchDMap k v)
102−
103−instance GCompare k => Patch (PatchDMap k v) where
104− type PatchTarget (PatchDMap k v) = DMap k v
105− apply (PatchDMap diff) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
106− where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
107− deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
108− nothingToJust = \case
109− Nothing -> Just $ Constant ()
110− Just _ -> Nothing
111−
112−mapPatchDMap :: (forall a. v a -> v' a) -> PatchDMap k v -> PatchDMap k v'
113−mapPatchDMap f (PatchDMap p) = PatchDMap $ DMap.map (ComposeMaybe . fmap f . getComposeMaybe) p
114−
115−traversePatchDMap :: Applicative m => (forall a. v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
116−traversePatchDMap f = traversePatchDMapWithKey $ const f
117−
118−traversePatchDMapWithKey :: Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
119−traversePatchDMapWithKey f (PatchDMap p) = PatchDMap <$> DMap.traverseWithKey (\k (ComposeMaybe v) -> ComposeMaybe <$> traverse (f k) v) p
120−
121−weakenPatchDMapWith :: (forall a. v a -> v') -> PatchDMap k v -> PatchMap (Some k) v'
122−weakenPatchDMapWith f (PatchDMap p) = PatchMap $ weakenDMapWith (fmap f . getComposeMaybe) p
123−
124−patchDMapToPatchMapWith :: (f v -> v') -> PatchDMap (Const2 k v) f -> PatchMap k v'
125−patchDMapToPatchMapWith f (PatchDMap p) = PatchMap $ dmapToMapWith (fmap f . getComposeMaybe) p
126−
127−const2PatchDMapWith :: forall k v f a. (v -> f a) -> PatchMap k v -> PatchDMap (Const2 k a) f
128−const2PatchDMapWith f (PatchMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
129− where g :: (k, Maybe v) -> DSum (Const2 k a) (ComposeMaybe f)
130− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
131−
132−-- | A set of changes to a 'Map'. Any element may be inserted/updated or
133−-- deleted.
134−newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
135−
136−instance Ord k => Patch (PatchMap k v) where
137− type PatchTarget (PatchMap k v) = Map k v
138− apply (PatchMap p) old = Just $! insertions `Map.union` (old `Map.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
139− where insertions = Map.mapMaybeWithKey (const id) p
140− deletions = Map.mapMaybeWithKey (const nothingToJust) p
141− nothingToJust = \case
142− Nothing -> Just ()
143− Just _ -> Nothing
144−
145−instance Ord k => Semigroup (PatchMap k v) where
146− PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
147− -- PatchMap is idempotent, so stimes n is id for every n
148−#if MIN_VERSION_semigroups(0,17,0)
149− stimes = stimesIdempotentMonoid
150−#else
151− times1p n x = case compare n 0 of
152− LT -> error "stimesIdempotentMonoid: negative multiplier"
153− EQ -> mempty
154− GT -> x
155−#endif
156−
157−instance Ord k => Monoid (PatchMap k v) where
158− mempty = PatchMap mempty
159− mappend = (<>)
160−
161−instance Functor (PatchMap k) where
162− fmap f = PatchMap . fmap (fmap f) . unPatchMap
163−
164−-- | Returns all the new elements that will be added to the 'Map'
165−patchMapNewElements :: PatchMap k v -> [v]
166−patchMapNewElements (PatchMap p) = catMaybes $ Map.elems p
167−
168−---- Patches based on commutative groups
169−
170−-- | A 'Group' is a 'Monoid' where every element has an inverse.
171−class (Semigroup q, Monoid q) => Group q where
172− negateG :: q -> q
173− (~~) :: q -> q -> q
174− r ~~ s = r <> negateG s
175−
176−-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
177−class Semigroup q => Additive q where
178−
179−-- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
180−newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
181−
182−instance Additive p => Patch (AdditivePatch p) where
183− type PatchTarget (AdditivePatch p) = p
184− apply (AdditivePatch p) q = Just $ p <> q
185−
186−data MapEdit k v
187− = MapEdit_Insert Bool v -- ^ Insert the given value here
188− | MapEdit_Delete Bool -- ^ Delete the existing value, if any, from here
189− | MapEdit_Move Bool k -- ^ Move the value here from the given key
190− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
191−
192−mapEditMoved :: MapEdit k v -> Bool
193−mapEditMoved = \case
194− MapEdit_Insert moved _ -> moved
195− MapEdit_Delete moved -> moved
196− MapEdit_Move moved _ -> moved
197−
198−mapEditSetMoved :: Bool -> MapEdit k v -> MapEdit k v
199−mapEditSetMoved moved = \case
200− MapEdit_Insert _ v -> MapEdit_Insert moved v
201− MapEdit_Delete _ -> MapEdit_Delete moved
202− MapEdit_Move _ k -> MapEdit_Move moved k
203−
204−-- | Patch a DMap with additions, deletions, and moves.
205−-- Invariants:
206−-- * The same source key may not be moved to two destination keys.
207−-- * Any key that is the source of a Move must also be edited
208−-- (otherwise, the Move would duplicate it)
209−data PatchMapWithMove k v = PatchMapWithMove (Map k (MapEdit k v)) deriving (Show, Eq, Ord, Functor, Foldable, Traversable)
210−
211−unPatchMapWithMove :: PatchMapWithMove k v -> Map k (MapEdit k v)
212−unPatchMapWithMove (PatchMapWithMove p) = p
213−
214−-- | Warning: when using this function, you must ensure that the invariants of
215−-- 'PatchMapWithMove' are preserved; they will not be checked.
216−unsafePatchMapWithMove :: Map k (MapEdit k v) -> PatchMapWithMove k v
217−unsafePatchMapWithMove = PatchMapWithMove
218−
219−instance Ord k => Patch (PatchMapWithMove k v) where
220− type PatchTarget (PatchMapWithMove k v) = Map k v
221− apply (PatchMapWithMove p) old = Just $! insertions `Map.union` (old `Map.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
222− where insertions = flip Map.mapMaybeWithKey p $ const $ \case
223− MapEdit_Insert _ v -> Just v
224− MapEdit_Move _ k -> Map.lookup k old
225− MapEdit_Delete _ -> Nothing
226− deletions = flip Map.mapMaybeWithKey p $ const $ \case
227− MapEdit_Delete _ -> Just ()
228− _ -> Nothing
229−
230−-- | Returns all the new elements that will be added to the 'Map'
231−patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
232−patchMapWithMoveNewElements (PatchMapWithMove p) = catMaybes $ flip fmap (Map.elems p) $ \case
233− MapEdit_Insert _ v -> Just v
234− MapEdit_Move _ _ -> Nothing
235− MapEdit_Delete _ -> Nothing
236−
237−validPatchMapWithMove :: Ord k => PatchMapWithMove k v -> Bool
238−validPatchMapWithMove (PatchMapWithMove p) =
239− let moveSources = catMaybes $ flip fmap (Map.elems p) $ \case
240− MapEdit_Move _ k -> Just k
241− _ -> Nothing
242− in and
243− [ -- All Moves must have unique source keys - a single source key can't be moved to two destinations
244− all (==1) $ Map.fromListWith (+) $ fmap (\k -> (k, 1 :: Integer )) moveSources
245− , -- All Move source keys must also be patched - since the value's being moved elsewhere, the original must either be Deleted or replaced (with Insert or Move)
246− all (isJust . flip Map.lookup p) moveSources
247− ]
248−
249−knownValidPatchMapWithMove :: [PatchMapWithMove Int Int]
250−knownValidPatchMapWithMove =
251− [ PatchMapWithMove mempty
252− , PatchMapWithMove $ Map.fromList
253− [ (1, MapEdit_Move True 2)
254− , (2, MapEdit_Move True 1)
255− ]
256− ]
257−
258−knownInvalidPatchMapWithMove :: [PatchMapWithMove Int Int]
259−knownInvalidPatchMapWithMove =
260− [ -- Invalid because we move 2 to 1, but don't specify what to do with 2
261− PatchMapWithMove $ Map.singleton 1 $ MapEdit_Move False 2
262− , -- Invalid because we have multiple moves from 3
263− PatchMapWithMove $ Map.fromList
264− [ (1, MapEdit_Move False 3)
265− , (2, MapEdit_Move False 3)
266− , (3, MapEdit_Delete True)
267− ]
268− ]
269−
270−patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
271−patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g l $ sortBy (cmp `on` snd) l
272− where l = Map.toList m
273− g (to, _) (from, _) = if to == from
274− then Nothing
275− else Just (to, MapEdit_Move True from)
276−
277−patchThatChangesAndSortsMapWith :: (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
278−patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patch
279− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
280− newList = Map.toList newByIndexUnsorted
281− newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
282− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
283− let f k v = do
284− remainingValues <- get
285− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
286− then Map.delete v remainingValues
287− else Map.insert v remainingKeys remainingValues
288− case Map.lookup v remainingValues of
289− Nothing -> return $ MapEdit_Insert True v -- There's no existing value we can take
290− Just fromKs ->
291− if k `Set.member` fromKs
292− then do
293− putRemainingKeys $ Set.delete k fromKs
294− return $ MapEdit_Move True k -- There's an existing value, and it's here, so no patch necessary
295− else do
296− Just (fromK, remainingKeys) <- return $ Set.minView fromKs -- There's an existing value, but it's not here; move it here
297− putRemainingKeys remainingKeys
298− return $ MapEdit_Move True fromK
299− Map.traverseWithKey f newByIndex
300− unusedOldKeys = fold unusedValuesByValue
301− pointlessMove k = \case
302− MapEdit_Move _ k' | k == k' -> True
303− _ -> False
304− keyWasMoved k = k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
305− patch = unsafePatchMapWithMove $ Map.filterWithKey (\k v -> not $ pointlessMove k v) $ Map.mergeWithKey (\k a _ -> Just $ mapEditSetMoved (keyWasMoved k) a) (Map.mapWithKey $ \k -> mapEditSetMoved $ keyWasMoved k) (Map.mapWithKey $ \k _ -> MapEdit_Delete $ keyWasMoved k) insertsAndMoves oldByIndex
306−
307−data DMapEdit (k :: a -> *) (v :: a -> *) :: a -> * where
308− -- | Insert the given value here
309− DMapEdit_Insert :: Bool -> v a -> DMapEdit k v a
310− -- | Delete the existing value, if any, from here
311− DMapEdit_Delete :: Bool -> DMapEdit k v a
312− -- | Move the value here from the given key
313− DMapEdit_Move :: Bool -> k a -> DMapEdit k v a
314−
315−dmapEditMoved :: DMapEdit k v a -> Bool
316−dmapEditMoved = \case
317− DMapEdit_Insert moved _ -> moved
318− DMapEdit_Delete moved -> moved
319− DMapEdit_Move moved _ -> moved
320−
321−-- | Like 'PatchMapWithMove', but for 'DMap'.
322−newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (DMapEdit k v))
323−
324−unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (DMapEdit k v)
325−unPatchDMapWithMove (PatchDMapWithMove p) = p
326−
327−-- | Warning: when using this function, you must ensure that the invariants of
328−-- 'PatchDMapWithMove' are preserved; they will not be checked.
329−unsafePatchDMapWithMove :: DMap k (DMapEdit k v) -> PatchDMapWithMove k v
330−unsafePatchDMapWithMove = PatchDMapWithMove
331−
332−mapPatchDMapWithMove :: forall k v v'. (forall a. v a -> v' a) -> PatchDMapWithMove k v -> PatchDMapWithMove k v'
333−mapPatchDMapWithMove f (PatchDMapWithMove p) = PatchDMapWithMove $ DMap.map g p
334− where g :: forall a. DMapEdit k v a -> DMapEdit k v' a
335− g = \case
336− DMapEdit_Insert moved v -> DMapEdit_Insert moved $ f v
337− DMapEdit_Delete moved -> DMapEdit_Delete moved
338− DMapEdit_Move moved k -> DMapEdit_Move moved k
339−
340−traversePatchDMapWithMove :: forall m k v v'. Applicative m => (forall a. v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
341−traversePatchDMapWithMove f = traversePatchDMapWithMoveWithKey $ const f
342−
343−traversePatchDMapWithMoveWithKey :: forall m k v v'. Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
344−traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) = PatchDMapWithMove <$> DMap.traverseWithKey g p
345− where g :: forall a. k a -> DMapEdit k v a -> m (DMapEdit k v' a)
346− g k = \case
347− DMapEdit_Insert moved v -> DMapEdit_Insert moved <$> f k v
348− DMapEdit_Delete moved -> pure $ DMapEdit_Delete moved
349− DMapEdit_Move moved fromKey -> pure $ DMapEdit_Move moved fromKey
350−
351−weakenPatchDMapWithMoveWith :: forall k v v'. (forall a. v a -> v') -> PatchDMapWithMove k v -> PatchMapWithMove (Some k) v'
352−weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenDMapWith g p
353− where g :: forall a. DMapEdit k v a -> MapEdit (Some k) v'
354− g = \case
355− DMapEdit_Insert moved v -> MapEdit_Insert moved $ f v
356− DMapEdit_Delete moved -> MapEdit_Delete moved
357− DMapEdit_Move moved k -> MapEdit_Move moved $ Some.This k
358−
359−patchDMapWithMoveToPatchMapWithMoveWith :: forall k f v v'. (f v -> v') -> PatchDMapWithMove (Const2 k v) f -> PatchMapWithMove k v'
360−patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ dmapToMapWith g p
361− where g :: DMapEdit (Const2 k v) f v -> MapEdit k v'
362− g = \case
363− DMapEdit_Insert moved v -> MapEdit_Insert moved $ f v
364− DMapEdit_Delete moved -> MapEdit_Delete moved
365− DMapEdit_Move moved (Const2 k) -> MapEdit_Move moved k
366−
367−const2PatchDMapWithMoveWith :: forall k v f a. (v -> f a) -> PatchMapWithMove k v -> PatchDMapWithMove (Const2 k a) f
368−const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
369− where g :: (k, MapEdit k v) -> DSum (Const2 k a) (DMapEdit (Const2 k a) f)
370− g (k, e) = Const2 k :=> case e of
371− MapEdit_Insert moved v -> DMapEdit_Insert moved $ f v
372− MapEdit_Delete moved -> DMapEdit_Delete moved
373− MapEdit_Move moved fromKey -> DMapEdit_Move moved $ Const2 fromKey
374−
375−instance GCompare k => Patch (PatchDMapWithMove k v) where
376− type PatchTarget (PatchDMapWithMove k v) = DMap k v
377− apply (PatchDMapWithMove p) old = Just $! insertions `DMap.union` (old `DMap.difference` deletions) --TODO: return Nothing sometimes --Note: the strict application here is critical to ensuring that incremental merges don't hold onto all their prerequisite events forever; can we make this more robust?
378− where insertions = DMap.mapMaybeWithKey insertFunc p
379− insertFunc :: forall a. k a -> DMapEdit k v a -> Maybe (v a)
380− insertFunc _ = \case
381− DMapEdit_Insert _ v -> Just v
382− DMapEdit_Move _ k -> DMap.lookup k old
383− DMapEdit_Delete _ -> Nothing
384− deletions = DMap.mapMaybeWithKey deleteFunc p
385− deleteFunc :: forall a. k a -> DMapEdit k v a -> Maybe (Constant () a)
386− deleteFunc _ = \case
387− DMapEdit_Delete _ -> Just $ Constant ()
388− _ -> Nothing
src/Reflex/PerformEvent/Base.hs+29−5
@@ -25,6 +25,7 @@ module Reflex.PerformEvent.Base
25 ) where
25 ) where
26
26
27import Reflex.Class
27import Reflex.Class
28+import Reflex.Adjustable.Class
28import Reflex.Host.Class
29import Reflex.Host.Class
29import Reflex.PerformEvent.Class
30import Reflex.PerformEvent.Class
30import Reflex.Requester.Base
31import Reflex.Requester.Base
@@ -40,6 +41,9 @@ import Data.Coerce
40import Data.Dependent.Map (DMap)
41import Data.Dependent.Map (DMap)
41import qualified Data.Dependent.Map as DMap
42import qualified Data.Dependent.Map as DMap
42import Data.Dependent.Sum
43import Data.Dependent.Sum
44+import Data.IntMap.Strict (IntMap)
45+import qualified Data.IntMap.Strict as IntMap
46+import qualified Data.Semigroup as S
43
47
44-- | A function that fires events for the given 'EventTrigger's and then runs
48-- | A function that fires events for the given 'EventTrigger's and then runs
45-- any followup actions provided via 'PerformEvent'. The given 'ReadPhase'
49-- any followup actions provided via 'PerformEvent'. The given 'ReadPhase'
@@ -57,27 +61,30 @@ deriving instance ReflexHost t => Monad (PerformEventT t m)
57deriving instance ReflexHost t => MonadFix (PerformEventT t m)
61deriving instance ReflexHost t => MonadFix (PerformEventT t m)
58deriving instance (ReflexHost t, MonadIO (HostFrame t)) => MonadIO (PerformEventT t m)
62deriving instance (ReflexHost t, MonadIO (HostFrame t)) => MonadIO (PerformEventT t m)
59deriving instance (ReflexHost t, MonadException (HostFrame t)) => MonadException (PerformEventT t m)
63deriving instance (ReflexHost t, MonadException (HostFrame t)) => MonadException (PerformEventT t m)
64+deriving instance (ReflexHost t, Monoid a) => Monoid (PerformEventT t m a)
65+deriving instance (ReflexHost t, S.Semigroup a) => S.Semigroup (PerformEventT t m a)
60
66
61instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
67instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
62 type PrimState (PerformEventT t m) = PrimState (HostFrame t)
68 type PrimState (PerformEventT t m) = PrimState (HostFrame t)
63 primitive = PerformEventT . lift . primitive
69 primitive = PerformEventT . lift . primitive
64
70
65−instance (ReflexHost t, Ref m ~ Ref IO, PrimMonad (HostFrame t)) => PerformEvent t (PerformEventT t m) where
71+instance (ReflexHost t, Ref m ~ Ref IO) => PerformEvent t (PerformEventT t m) where
66 type Performable (PerformEventT t m) = HostFrame t
72 type Performable (PerformEventT t m) = HostFrame t
67 {-# INLINABLE performEvent_ #-}
73 {-# INLINABLE performEvent_ #-}
68 performEvent_ = PerformEventT . requesting_
74 performEvent_ = PerformEventT . requesting_
69 {-# INLINABLE performEvent #-}
75 {-# INLINABLE performEvent #-}
70 performEvent = PerformEventT . requestingIdentity
76 performEvent = PerformEventT . requestingIdentity
71
77
72−instance (ReflexHost t, PrimMonad (HostFrame t)) => MonadAdjust t (PerformEventT t m) where
78+instance (ReflexHost t, PrimMonad (HostFrame t)) => Adjustable t (PerformEventT t m) where
73 runWithReplace outerA0 outerA' = PerformEventT $ runWithReplaceRequesterTWith f (coerce outerA0) (coerceEvent outerA')
79 runWithReplace outerA0 outerA' = PerformEventT $ runWithReplaceRequesterTWith f (coerce outerA0) (coerceEvent outerA')
74 where f :: HostFrame t a -> Event t (HostFrame t b) -> RequesterT t (HostFrame t) Identity (HostFrame t) (a, Event t b)
80 where f :: HostFrame t a -> Event t (HostFrame t b) -> RequesterT t (HostFrame t) Identity (HostFrame t) (a, Event t b)
75 f a0 a' = do
81 f a0 a' = do
76 result0 <- lift a0
82 result0 <- lift a0
77 result' <- requestingIdentity a'
83 result' <- requestingIdentity a'
78 return (result0, result')
84 return (result0, result')
85+ traverseIntMapWithKeyWithAdjust f outerDm0 outerDm' = PerformEventT $ traverseIntMapWithKeyWithAdjustRequesterTWith (defaultAdjustIntBase traverseIntMapPatchWithKey) patchIntMapNewElementsMap mergeIntIncremental (\k v -> unPerformEventT $ f k v) (coerce outerDm0) (coerceEvent outerDm')
79− traverseDMapWithKeyWithAdjust f outerDm0 outerDm' = PerformEventT $ sequenceDMapWithAdjustRequesterTWith (defaultAdjustBase traversePatchDMapWithKey) mapPatchDMap weakenPatchDMapWith patchMapNewElements mergeMapIncremental (\k v -> unPerformEventT $ f k v) (coerce outerDm0) (coerceEvent outerDm')
86+ traverseDMapWithKeyWithAdjust f outerDm0 outerDm' = PerformEventT $ traverseDMapWithKeyWithAdjustRequesterTWith (defaultAdjustBase traversePatchDMapWithKey) mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental (\k v -> unPerformEventT $ f k v) (coerce outerDm0) (coerceEvent outerDm')
80− traverseDMapWithKeyWithAdjustWithMove f outerDm0 outerDm' = PerformEventT $ sequenceDMapWithAdjustRequesterTWith (defaultAdjustBase traversePatchDMapWithMoveWithKey) mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElements mergeMapIncrementalWithMove (\k v -> unPerformEventT $ f k v) (coerce outerDm0) (coerceEvent outerDm')
87+ traverseDMapWithKeyWithAdjustWithMove f outerDm0 outerDm' = PerformEventT $ traverseDMapWithKeyWithAdjustRequesterTWith (defaultAdjustBase traversePatchDMapWithMoveWithKey) mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove (\k v -> unPerformEventT $ f k v) (coerce outerDm0) (coerceEvent outerDm')
81
88
82defaultAdjustBase :: forall t v v2 k' p. (Monad (HostFrame t), PrimMonad (HostFrame t), Reflex t)
89defaultAdjustBase :: forall t v v2 k' p. (Monad (HostFrame t), PrimMonad (HostFrame t), Reflex t)
83 => ((forall a. k' a -> v a -> HostFrame t (v2 a)) -> p k' v -> HostFrame t (p k' v2))
90 => ((forall a. k' a -> v a -> HostFrame t (v2 a)) -> p k' v -> HostFrame t (p k' v2))
@@ -90,6 +97,17 @@ defaultAdjustBase traversePatchWithKey f' dm0 dm' = do
90 result' <- requestingIdentity $ ffor dm' $ traversePatchWithKey f'
97 result' <- requestingIdentity $ ffor dm' $ traversePatchWithKey f'
91 return (result0, result')
98 return (result0, result')
92
99
100+defaultAdjustIntBase :: forall t v v2 p. (Monad (HostFrame t), PrimMonad (HostFrame t), Reflex t)
101+ => ((IntMap.Key -> v -> HostFrame t v2) -> p v -> HostFrame t (p v2))
102+ -> (IntMap.Key -> v -> HostFrame t v2)
103+ -> IntMap v
104+ -> Event t (p v)
105+ -> RequesterT t (HostFrame t) Identity (HostFrame t) (IntMap v2, Event t (p v2))
106+defaultAdjustIntBase traversePatchWithKey f' dm0 dm' = do
107+ result0 <- lift $ IntMap.traverseWithKey f' dm0
108+ result' <- requestingIdentity $ ffor dm' $ traversePatchWithKey f'
109+ return (result0, result')
110+
93instance ReflexHost t => MonadReflexCreateTrigger t (PerformEventT t m) where
111instance ReflexHost t => MonadReflexCreateTrigger t (PerformEventT t m) where
94 {-# INLINABLE newEventWithTrigger #-}
112 {-# INLINABLE newEventWithTrigger #-}
95 newEventWithTrigger = PerformEventT . lift . newEventWithTrigger
113 newEventWithTrigger = PerformEventT . lift . newEventWithTrigger
@@ -123,7 +141,7 @@ hostPerformEventT a = do
123 case mToPerform of
141 case mToPerform of
124 Nothing -> return [result']
142 Nothing -> return [result']
125 Just toPerform -> do
143 Just toPerform -> do
126− responses <- runHostFrame $ DMap.traverseWithKey (\_ v -> Identity <$> v) toPerform
144+ responses <- runHostFrame $ traverseRequesterData (fmap Identity) toPerform
127 mrt <- readRef responseTrigger
145 mrt <- readRef responseTrigger
128 let followupEventTriggers = case mrt of
146 let followupEventTriggers = case mrt of
129 Just rt -> [rt :=> Identity responses]
147 Just rt -> [rt :=> Identity responses]
@@ -142,6 +160,12 @@ instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
142 holdDyn v0 v' = PerformEventT $ lift $ holdDyn v0 v'
160 holdDyn v0 v' = PerformEventT $ lift $ holdDyn v0 v'
143 {-# INLINABLE holdIncremental #-}
161 {-# INLINABLE holdIncremental #-}
144 holdIncremental v0 v' = PerformEventT $ lift $ holdIncremental v0 v'
162 holdIncremental v0 v' = PerformEventT $ lift $ holdIncremental v0 v'
163+ {-# INLINABLE buildDynamic #-}
164+ buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
165+ {-# INLINABLE headE #-}
166+ headE = PerformEventT . lift . headE
167+ {-# INLINABLE now #-}
168+ now = PerformEventT . lift $ now
145
169
146instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
170instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
147 type Ref (PerformEventT t m) = Ref (HostFrame t)
171 type Ref (PerformEventT t m) = Ref (HostFrame t)
src/Reflex/PerformEvent/Class.hs+6−2
@@ -5,11 +5,9 @@
5{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleContexts #-}
6{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FunctionalDependencies #-}
7{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE TypeFamilies #-}
10{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE UndecidableInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
14#ifdef USE_REFLEX_OPTIMIZER
12#ifdef USE_REFLEX_OPTIMIZER
15{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
13{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,6 +21,7 @@ import Reflex.Class
23import Reflex.TriggerEvent.Class
21import Reflex.TriggerEvent.Class
24
22
25import Control.Monad.Reader
23import Control.Monad.Reader
24+import Control.Monad.Trans.Maybe (MaybeT (..))
26
25
27-- | 'PerformEvent' represents actions that can trigger other actions based on
26-- | 'PerformEvent' represents actions that can trigger other actions based on
28-- 'Event's.
27-- 'Event's.
@@ -62,3 +61,8 @@ instance PerformEvent t m => PerformEvent t (ReaderT r m) where
62 performEvent e = do
61 performEvent e = do
63 r <- ask
62 r <- ask
64 lift $ performEvent $ flip runReaderT r <$> e
63 lift $ performEvent $ flip runReaderT r <$> e
64+
65+instance PerformEvent t m => PerformEvent t (MaybeT m) where
66+ type Performable (MaybeT m) = MaybeT (Performable m)
67+ performEvent_ = lift . performEvent_ . fmapCheap (void . runMaybeT)
68+ performEvent = lift . fmap (fmapMaybe id) . performEvent . fmapCheap runMaybeT
src/Reflex/PostBuild/Base.hs+69−13
@@ -9,7 +9,6 @@
9{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
10{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE TypeFamilies #-}
11{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE UndecidableInstances #-}
12{-# LANGUAGE UndecidableInstances #-}
14#ifdef USE_REFLEX_OPTIMIZER
13#ifdef USE_REFLEX_OPTIMIZER
15{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
14{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -17,23 +16,31 @@
17module Reflex.PostBuild.Base
16module Reflex.PostBuild.Base
18 ( PostBuildT (..)
17 ( PostBuildT (..)
19 , runPostBuildT
18 , runPostBuildT
19+ -- * Internal
20+ , mapIntMapWithAdjustImpl
21+ , mapDMapWithAdjustImpl
20 ) where
22 ) where
21
23
22import Reflex.Class
24import Reflex.Class
25+import Reflex.Adjustable.Class
23import Reflex.Host.Class
26import Reflex.Host.Class
24import Reflex.PerformEvent.Class
27import Reflex.PerformEvent.Class
25import Reflex.PostBuild.Class
28import Reflex.PostBuild.Class
26import Reflex.TriggerEvent.Class
29import Reflex.TriggerEvent.Class
27
30
31+import Control.Applicative (liftA2)
28import Control.Monad.Exception
32import Control.Monad.Exception
29import Control.Monad.Identity
33import Control.Monad.Identity
30import Control.Monad.Primitive
34import Control.Monad.Primitive
31import Control.Monad.Reader
35import Control.Monad.Reader
32import Control.Monad.Ref
36import Control.Monad.Ref
33−import Control.Monad.Trans.Control
37+import qualified Control.Monad.Trans.Control as TransControl
34import Data.Dependent.Map (DMap)
38import Data.Dependent.Map (DMap)
35import qualified Data.Dependent.Map as DMap
39import qualified Data.Dependent.Map as DMap
36import Data.Functor.Compose
40import Data.Functor.Compose
41+import Data.IntMap.Strict (IntMap)
42+import qualified Data.IntMap.Strict as IntMap
43+import qualified Data.Semigroup as S
37
44
38-- | Provides a basic implementation of 'PostBuild'.
45-- | Provides a basic implementation of 'PostBuild'.
39newtype PostBuildT t m a = PostBuildT { unPostBuildT :: ReaderT (Event t ()) m a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadTrans, MonadException, MonadAsyncException)
46newtype PostBuildT t m a = PostBuildT { unPostBuildT :: ReaderT (Event t ()) m a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadTrans, MonadException, MonadAsyncException)
@@ -45,17 +52,18 @@ newtype PostBuildT t m a = PostBuildT { unPostBuildT :: ReaderT (Event t ()) m a
45runPostBuildT :: PostBuildT t m a -> Event t () -> m a
52runPostBuildT :: PostBuildT t m a -> Event t () -> m a
46runPostBuildT (PostBuildT a) = runReaderT a
53runPostBuildT (PostBuildT a) = runReaderT a
47
54
55+-- TODO: Monoid and Semigroup can likely be derived once ReaderT has them.
56+instance (Monoid a, Applicative m) => Monoid (PostBuildT t m a) where
57+ mempty = pure mempty
58+ mappend = liftA2 mappend
59+
60+instance (S.Semigroup a, Applicative m) => S.Semigroup (PostBuildT t m a) where
61+ (<>) = liftA2 (S.<>)
62+
48instance PrimMonad m => PrimMonad (PostBuildT x m) where
63instance PrimMonad m => PrimMonad (PostBuildT x m) where
49 type PrimState (PostBuildT x m) = PrimState m
64 type PrimState (PostBuildT x m) = PrimState m
50 primitive = lift . primitive
65 primitive = lift . primitive
51
66
52−instance MonadTransControl (PostBuildT t) where
53− type StT (PostBuildT t) a = StT (ReaderT (Event t ())) a
54− {-# INLINABLE liftWith #-}
55− liftWith = defaultLiftWith PostBuildT unPostBuildT
56− {-# INLINABLE restoreT #-}
57− restoreT = defaultRestoreT PostBuildT
58−
59instance (Reflex t, Monad m) => PostBuild t (PostBuildT t m) where
67instance (Reflex t, Monad m) => PostBuild t (PostBuildT t m) where
60 {-# INLINABLE getPostBuild #-}
68 {-# INLINABLE getPostBuild #-}
61 getPostBuild = PostBuildT ask
69 getPostBuild = PostBuildT ask
@@ -71,13 +79,19 @@ instance MonadHold t m => MonadHold t (PostBuildT t m) where
71 holdDyn v0 = lift . holdDyn v0
79 holdDyn v0 = lift . holdDyn v0
72 {-# INLINABLE holdIncremental #-}
80 {-# INLINABLE holdIncremental #-}
73 holdIncremental v0 = lift . holdIncremental v0
81 holdIncremental v0 = lift . holdIncremental v0
82+ {-# INLINABLE buildDynamic #-}
83+ buildDynamic a0 = lift . buildDynamic a0
84+ {-# INLINABLE headE #-}
85+ headE = lift . headE
86+ {-# INLINABLE now #-}
87+ now = lift now
74
88
75instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
89instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
76− type Performable (PostBuildT t m) = PostBuildT t (Performable m)
90+ type Performable (PostBuildT t m) = Performable m
77 {-# INLINABLE performEvent_ #-}
91 {-# INLINABLE performEvent_ #-}
78− performEvent_ e = liftWith $ \run -> performEvent_ $ fmap run e
92+ performEvent_ = lift . performEvent_
79 {-# INLINABLE performEvent #-}
93 {-# INLINABLE performEvent #-}
80− performEvent e = liftWith $ \run -> performEvent $ fmap run e
94+ performEvent = lift . performEvent
81
95
82instance (ReflexHost t, MonadReflexCreateTrigger t m) => MonadReflexCreateTrigger t (PostBuildT t m) where
96instance (ReflexHost t, MonadReflexCreateTrigger t m) => MonadReflexCreateTrigger t (PostBuildT t m) where
83 {-# INLINABLE newEventWithTrigger #-}
97 {-# INLINABLE newEventWithTrigger #-}
@@ -105,16 +119,46 @@ instance MonadAtomicRef m => MonadAtomicRef (PostBuildT t m) where
105 {-# INLINABLE atomicModifyRef #-}
119 {-# INLINABLE atomicModifyRef #-}
106 atomicModifyRef r = lift . atomicModifyRef r
120 atomicModifyRef r = lift . atomicModifyRef r
107
121
108−instance (Reflex t, MonadHold t m, MonadFix m, MonadAdjust t m, PerformEvent t m) => MonadAdjust t (PostBuildT t m) where
122+instance (Reflex t, MonadHold t m, MonadFix m, Adjustable t m, PerformEvent t m) => Adjustable t (PostBuildT t m) where
109 runWithReplace a0 a' = do
123 runWithReplace a0 a' = do
110 postBuild <- getPostBuild
124 postBuild <- getPostBuild
111 lift $ do
125 lift $ do
112 rec result@(_, result') <- runWithReplace (runPostBuildT a0 postBuild) $ fmap (\v -> runPostBuildT v =<< headE voidResult') a'
126 rec result@(_, result') <- runWithReplace (runPostBuildT a0 postBuild) $ fmap (\v -> runPostBuildT v =<< headE voidResult') a'
113 let voidResult' = fmapCheap (\_ -> ()) result'
127 let voidResult' = fmapCheap (\_ -> ()) result'
114 return result
128 return result
129+ {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
130+ traverseIntMapWithKeyWithAdjust = mapIntMapWithAdjustImpl traverseIntMapWithKeyWithAdjust
131+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
115 traverseDMapWithKeyWithAdjust = mapDMapWithAdjustImpl traverseDMapWithKeyWithAdjust mapPatchDMap
132 traverseDMapWithKeyWithAdjust = mapDMapWithAdjustImpl traverseDMapWithKeyWithAdjust mapPatchDMap
116 traverseDMapWithKeyWithAdjustWithMove = mapDMapWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove
133 traverseDMapWithKeyWithAdjustWithMove = mapDMapWithAdjustImpl traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove
117
134
135+{-# INLINABLE mapIntMapWithAdjustImpl #-}
136+mapIntMapWithAdjustImpl :: forall t m v v' p. (Reflex t, MonadFix m, MonadHold t m, Functor p)
137+ => ( (IntMap.Key -> (Event t (), v) -> m v')
138+ -> IntMap (Event t (), v)
139+ -> Event t (p (Event t (), v))
140+ -> m (IntMap v', Event t (p v'))
141+ )
142+ -> (IntMap.Key -> v -> PostBuildT t m v')
143+ -> IntMap v
144+ -> Event t (p v)
145+ -> PostBuildT t m (IntMap v', Event t (p v'))
146+mapIntMapWithAdjustImpl base f dm0 dm' = do
147+ postBuild <- getPostBuild
148+ let loweredDm0 = fmap ((,) postBuild) dm0
149+ f' :: IntMap.Key -> (Event t (), v) -> m v'
150+ f' k (e, v) = do
151+ runPostBuildT (f k v) e
152+ lift $ do
153+ rec (result0, result') <- base f' loweredDm0 loweredDm'
154+ cohortDone <- numberOccurrencesFrom_ 1 result'
155+ numberedDm' <- numberOccurrencesFrom 1 dm'
156+ let postBuild' = fanInt $ fmapCheap (`IntMap.singleton` ()) cohortDone
157+ loweredDm' = flip pushAlways numberedDm' $ \(n, p) -> do
158+ return $ fmap ((,) (selectInt postBuild' n)) p
159+ return (result0, result')
160+
161+{-# INLINABLE mapDMapWithAdjustImpl #-}
118mapDMapWithAdjustImpl :: forall t m k v v' p. (Reflex t, MonadFix m, MonadHold t m)
162mapDMapWithAdjustImpl :: forall t m k v v' p. (Reflex t, MonadFix m, MonadHold t m)
119 => ( (forall a. k a -> Compose ((,) (Bool, Event t ())) v a -> m (v' a))
163 => ( (forall a. k a -> Compose ((,) (Bool, Event t ())) v a -> m (v' a))
120 -> DMap k (Compose ((,) (Bool, Event t ())) v)
164 -> DMap k (Compose ((,) (Bool, Event t ())) v)
@@ -140,3 +184,15 @@ mapDMapWithAdjustImpl base mapPatch f dm0 dm' = do
140 let voidResult' = fmapCheap (\_ -> ()) result'
184 let voidResult' = fmapCheap (\_ -> ()) result'
141 let loweredDm' = ffor dm' $ mapPatch (Compose . (,) (True, voidResult'))
185 let loweredDm' = ffor dm' $ mapPatch (Compose . (,) (True, voidResult'))
142 return (result0, result')
186 return (result0, result')
187+
188+--------------------------------------------------------------------------------
189+-- Deprecated functionality
190+--------------------------------------------------------------------------------
191+
192+-- | Deprecated
193+instance TransControl.MonadTransControl (PostBuildT t) where
194+ type StT (PostBuildT t) a = TransControl.StT (ReaderT (Event t ())) a
195+ {-# INLINABLE liftWith #-}
196+ liftWith = TransControl.defaultLiftWith PostBuildT unPostBuildT
197+ {-# INLINABLE restoreT #-}
198+ restoreT = TransControl.defaultRestoreT PostBuildT
src/Reflex/PostBuild/Class.hs+8−2
@@ -4,10 +4,8 @@
4{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DataKinds #-}
5{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE TypeFamilies #-}
8{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
11{-# LANGUAGE UndecidableInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
12#ifdef USE_REFLEX_OPTIMIZER
10#ifdef USE_REFLEX_OPTIMIZER
13{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
11{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -19,6 +17,8 @@ module Reflex.PostBuild.Class
19import Reflex.Class
17import Reflex.Class
20
18
21import Control.Monad.Reader
19import Control.Monad.Reader
20+import Control.Monad.State
21+import qualified Control.Monad.State.Strict as Strict
22
22
23-- | 'PostBuild' represents an action that is notified via an 'Event' when it
23-- | 'PostBuild' represents an action that is notified via an 'Event' when it
24-- has finished executing. Note that the specific definition of "finished" is
24-- has finished executing. Note that the specific definition of "finished" is
@@ -32,3 +32,9 @@ class (Reflex t, Monad m) => PostBuild t m | m -> t where
32
32
33instance PostBuild t m => PostBuild t (ReaderT r m) where
33instance PostBuild t m => PostBuild t (ReaderT r m) where
34 getPostBuild = lift getPostBuild
34 getPostBuild = lift getPostBuild
35+
36+instance PostBuild t m => PostBuild t (StateT s m) where
37+ getPostBuild = lift getPostBuild
38+
39+instance PostBuild t m => PostBuild t (Strict.StateT s m) where
40+ getPostBuild = lift getPostBuild
src/Reflex/Profiled.hsnew file+281
@@ -0,0 +1,281 @@
1+{-# LANGUAGE EmptyDataDecls #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+{-# LANGUAGE InstanceSigs #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE StandaloneDeriving #-}
9+{-# LANGUAGE TypeFamilies #-}
10+{-# LANGUAGE UndecidableInstances #-}
11+{-# LANGUAGE PolyKinds #-}
12+{-# LANGUAGE TypeApplications #-}
13+{-# LANGUAGE RankNTypes #-}
14+-- |
15+-- Module:
16+-- Reflex.Profiled
17+-- Description:
18+-- This module contains an instance of the 'Reflex' class that provides
19+-- profiling/cost-center information.
20+module Reflex.Profiled where
21+
22+import Control.Monad
23+import Control.Monad.Exception
24+import Control.Monad.Fix
25+import Control.Monad.Primitive
26+import Control.Monad.Reader
27+import Control.Monad.Ref
28+import Control.Monad.State.Strict (StateT, execStateT, modify)
29+import Data.Bifunctor
30+import Data.Coerce
31+import Data.Dependent.Map (DMap)
32+import Data.GADT.Compare (GCompare)
33+import Data.FastMutableIntMap
34+import Data.IORef
35+import Data.List
36+import Data.Map (Map)
37+import qualified Data.Map.Strict as Map
38+import Data.Monoid ((<>))
39+import Data.Ord
40+import Data.Profunctor.Unsafe ((#.))
41+import qualified Data.Semigroup as S
42+import Data.Type.Coercion
43+import Foreign.Ptr
44+import GHC.Foreign
45+import GHC.IO.Encoding
46+import GHC.Stack
47+import Reflex.Adjustable.Class
48+import Reflex.BehaviorWriter.Class
49+import Reflex.Class
50+import Reflex.DynamicWriter.Class
51+import Reflex.EventWriter.Class
52+import Reflex.Host.Class
53+import Reflex.NotReady.Class
54+import Reflex.PerformEvent.Class
55+import Reflex.PostBuild.Class
56+import Reflex.Query.Class
57+import Reflex.Requester.Class
58+import Reflex.TriggerEvent.Class
59+
60+import System.IO.Unsafe
61+
62+data ProfiledTimeline t
63+
64+{-# NOINLINE profilingData #-}
65+profilingData :: IORef (Map (Ptr CostCentreStack) Int)
66+profilingData = unsafePerformIO $ newIORef Map.empty
67+
68+data CostCentreTree = CostCentreTree
69+ { _costCentreTree_ownEntries :: !Int
70+ , _costCentreTree_cumulativeEntries :: !Int
71+ , _costCentreTree_children :: !(Map (Ptr CostCentre) CostCentreTree)
72+ }
73+ deriving (Show, Eq, Ord)
74+
75+instance S.Semigroup CostCentreTree where
76+ (CostCentreTree oa ea ca) <> (CostCentreTree ob eb cb) =
77+ CostCentreTree (oa + ob) (ea + eb) $ Map.unionWith (S.<>) ca cb
78+
79+instance Monoid CostCentreTree where
80+ mempty = CostCentreTree 0 0 mempty
81+ mappend = (S.<>)
82+
83+getCostCentreStack :: Ptr CostCentreStack -> IO [Ptr CostCentre]
84+getCostCentreStack = go []
85+ where go l ccs = if ccs == nullPtr
86+ then return l
87+ else do
88+ cc <- ccsCC ccs
89+ parent <- ccsParent ccs
90+ go (cc : l) parent
91+
92+toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
93+toCostCentreTree ccs n =
94+ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty)
95+ <$> getCostCentreStack ccs
96+
97+getCostCentreTree :: IO CostCentreTree
98+getCostCentreTree = do
99+ vals <- readIORef profilingData
100+ mconcat <$> mapM (uncurry toCostCentreTree) (Map.toList vals)
101+
102+formatCostCentreTree :: CostCentreTree -> IO String
103+formatCostCentreTree cct0 = unlines . reverse <$> execStateT (go 0 cct0) []
104+ where go :: Int -> CostCentreTree -> StateT [String] IO ()
105+ go depth cct = do
106+ let children = sortOn (Down . _costCentreTree_cumulativeEntries . snd) $ Map.toList $ _costCentreTree_children cct
107+ indent = mconcat $ replicate depth " "
108+ forM_ children $ \(cc, childCct) -> do
109+ lbl <- liftIO $ peekCString utf8 =<< ccLabel cc
110+ mdl <- liftIO $ peekCString utf8 =<< ccModule cc
111+ loc <- liftIO $ peekCString utf8 =<< ccSrcSpan cc
112+ let description = mdl <> "." <> lbl <> " (" <> loc <> ")"
113+ modify $ (:) $ indent <> description <> "\t" <> show (_costCentreTree_cumulativeEntries childCct) <> "\t" <> show (_costCentreTree_ownEntries childCct)
114+ go (succ depth) childCct
115+
116+showProfilingData :: IO ()
117+showProfilingData = do
118+ putStr =<< formatCostCentreTree =<< getCostCentreTree
119+
120+writeProfilingData :: FilePath -> IO ()
121+writeProfilingData p = do
122+ writeFile p =<< formatCostCentreTree =<< getCostCentreTree
123+
124+newtype ProfiledM m a = ProfiledM { runProfiledM :: m a }
125+ deriving (Functor, Applicative, Monad, MonadFix, MonadException, MonadAsyncException)
126+
127+profileEvent :: Reflex t => Event t a -> Event t a
128+profileEvent e = unsafePerformIO $ do
129+ stack <- getCurrentCCS e
130+ let f x = unsafePerformIO $ do
131+ modifyIORef' profilingData $ Map.insertWith (+) stack 1
132+ return $ return $ Just x
133+ return $ pushCheap f e
134+
135+--TODO: Instead of profiling just the input or output of each one, profile all the inputs and all the outputs
136+
137+instance Reflex t => Reflex (ProfiledTimeline t) where
138+ newtype Behavior (ProfiledTimeline t) a = Behavior_Profiled { unBehavior_Profiled :: Behavior t a }
139+ newtype Event (ProfiledTimeline t) a = Event_Profiled { unEvent_Profiled :: Event t a }
140+ newtype Dynamic (ProfiledTimeline t) a = Dynamic_Profiled { unDynamic_Profiled :: Dynamic t a }
141+ newtype Incremental (ProfiledTimeline t) p = Incremental_Profiled { unIncremental_Profiled :: Incremental t p }
142+ type PushM (ProfiledTimeline t) = ProfiledM (PushM t)
143+ type PullM (ProfiledTimeline t) = ProfiledM (PullM t)
144+ never = Event_Profiled never
145+ constant = Behavior_Profiled . constant
146+ push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
147+ pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
148+ pull = Behavior_Profiled . pull . coerce
149+ fanG (Event_Profiled e) = EventSelectorG $ coerce $ selectG (fanG $ profileEvent e)
150+ mergeG :: forall z (k :: z -> *) q v. GCompare k
151+ => (forall a. q a -> Event (ProfiledTimeline t) (v a))
152+ -> DMap k q -> Event (ProfiledTimeline t) (DMap k v)
153+ mergeG nt = Event_Profiled #. mergeG (coerce nt)
154+ switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
155+ coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
156+ current (Dynamic_Profiled d) = coerce $ current d
157+ updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
158+ unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
159+ unsafeBuildIncremental (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildIncremental a0 a'
160+ mergeIncrementalG nt res = Event_Profiled $ mergeIncrementalG (coerce nt) (coerce res)
161+ mergeIncrementalWithMoveG nt res = Event_Profiled $ mergeIncrementalWithMoveG (coerce nt) (coerce res)
162+ currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
163+ updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
164+ incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
165+ behaviorCoercion c =
166+ Coercion `trans` behaviorCoercion @t c `trans` Coercion
167+ eventCoercion c =
168+ Coercion `trans` eventCoercion @t c `trans` Coercion
169+ dynamicCoercion c =
170+ Coercion `trans` dynamicCoercion @t c `trans` Coercion
171+ incrementalCoercion c d =
172+ Coercion `trans` incrementalCoercion @t c d `trans` Coercion
173+ mergeIntIncremental = Event_Profiled . mergeIntIncremental .
174+ coerceWith (Coercion `trans` incrementalCoercion Coercion Coercion `trans` Coercion)
175+ fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
176+
177+deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
178+deriving instance Applicative (Dynamic t) => Applicative (Dynamic (ProfiledTimeline t))
179+deriving instance Monad (Dynamic t) => Monad (Dynamic (ProfiledTimeline t))
180+
181+instance MonadHold t m => MonadHold (ProfiledTimeline t) (ProfiledM m) where
182+ hold v0 (Event_Profiled v') = ProfiledM $ Behavior_Profiled <$> hold v0 v'
183+ holdDyn v0 (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> holdDyn v0 v'
184+ holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
185+ buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
186+ headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
187+ now = ProfiledM $ Event_Profiled <$> now
188+
189+instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
190+ sample (Behavior_Profiled b) = ProfiledM $ sample b
191+
192+instance Adjustable t m => Adjustable (ProfiledTimeline t) (ProfiledM m) where
193+ runWithReplace a0 a' = (fmap . fmap) coerce . lift $
194+ runWithReplace (coerce a0) (coerce $ coerce <$> a')
195+ traverseIntMapWithKeyWithAdjust f dm0 dm' = (fmap . fmap) coerce . lift $
196+ traverseIntMapWithKeyWithAdjust (\k v -> coerce $ f k v) dm0 (coerce dm')
197+ traverseDMapWithKeyWithAdjust f dm0 dm' = (fmap . fmap) coerce . lift $
198+ traverseDMapWithKeyWithAdjust (\k v -> coerce $ f k v) dm0 (coerce dm')
199+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = (fmap . fmap) coerce . lift $
200+ traverseDMapWithKeyWithAdjustWithMove (\k v -> coerce $ f k v) dm0 (coerce dm')
201+
202+instance MonadTrans ProfiledM where
203+ lift = ProfiledM
204+
205+instance MonadIO m => MonadIO (ProfiledM m) where
206+ liftIO = lift . liftIO
207+
208+instance PerformEvent t m => PerformEvent (ProfiledTimeline t) (ProfiledM m) where
209+ type Performable (ProfiledM m) = Performable m
210+ performEvent_ = lift . performEvent_ . coerce
211+ performEvent = lift . fmap coerce . performEvent . coerce
212+
213+instance TriggerEvent t m => TriggerEvent (ProfiledTimeline t) (ProfiledM m) where
214+ newTriggerEvent = first coerce <$> lift newTriggerEvent
215+ newTriggerEventWithOnComplete = first coerce <$> lift newTriggerEventWithOnComplete
216+ newEventWithLazyTriggerWithOnComplete f = coerce <$> lift (newEventWithLazyTriggerWithOnComplete f)
217+
218+instance PostBuild t m => PostBuild (ProfiledTimeline t) (ProfiledM m) where
219+ getPostBuild = coerce <$> lift getPostBuild
220+
221+instance NotReady t m => NotReady (ProfiledTimeline t) (ProfiledM m) where
222+ notReady = lift notReady
223+ notReadyUntil = lift . notReadyUntil . coerce
224+
225+instance BehaviorWriter t w m => BehaviorWriter (ProfiledTimeline t) w (ProfiledM m) where
226+ tellBehavior = lift . tellBehavior . coerce
227+
228+instance DynamicWriter t w m => DynamicWriter (ProfiledTimeline t) w (ProfiledM m) where
229+ tellDyn = lift . tellDyn . coerce
230+
231+instance EventWriter t w m => EventWriter (ProfiledTimeline t) w (ProfiledM m) where
232+ tellEvent = lift . tellEvent . coerce
233+
234+instance MonadQuery t q m => MonadQuery (ProfiledTimeline t) q (ProfiledM m) where
235+ tellQueryIncremental = lift . tellQueryIncremental . coerce
236+ askQueryResult = coerce <$> lift askQueryResult
237+ queryIncremental = fmap coerce . lift . queryIncremental . coerce
238+
239+instance Requester t m => Requester (ProfiledTimeline t) (ProfiledM m) where
240+ type Request (ProfiledM m) = Request m
241+ type Response (ProfiledM m) = Response m
242+
243+ requesting = fmap coerce . lift . requesting . coerce
244+ requesting_ = lift . requesting_ . coerce
245+
246+instance MonadRef m => MonadRef (ProfiledM m) where
247+ type Ref (ProfiledM m) = Ref m
248+ newRef = lift . newRef
249+ readRef = lift . readRef
250+ writeRef r = lift . writeRef r
251+
252+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger (ProfiledTimeline t) (ProfiledM m) where
253+ newEventWithTrigger = lift . fmap coerce . newEventWithTrigger
254+ newFanEventWithTrigger f = do
255+ es <- lift $ newFanEventWithTrigger f
256+ return $ EventSelector $ \k -> coerce $ select es k
257+
258+instance MonadReader r m => MonadReader r (ProfiledM m) where
259+ ask = lift ask
260+ local f (ProfiledM a) = ProfiledM $ local f a
261+ reader = lift . reader
262+
263+instance ReflexHost t => ReflexHost (ProfiledTimeline t) where
264+ type EventTrigger (ProfiledTimeline t) = EventTrigger t
265+ type EventHandle (ProfiledTimeline t) = EventHandle t
266+ type HostFrame (ProfiledTimeline t) = ProfiledM (HostFrame t)
267+
268+instance MonadSubscribeEvent t m => MonadSubscribeEvent (ProfiledTimeline t) (ProfiledM m) where
269+ subscribeEvent = lift . subscribeEvent . coerce
270+
271+instance PrimMonad m => PrimMonad (ProfiledM m) where
272+ type PrimState (ProfiledM m) = PrimState m
273+ primitive = lift . primitive
274+
275+instance MonadReflexHost t m => MonadReflexHost (ProfiledTimeline t) (ProfiledM m) where
276+ type ReadPhase (ProfiledM m) = ProfiledM (ReadPhase m)
277+ fireEventsAndRead ts r = lift $ fireEventsAndRead ts $ coerce r
278+ runHostFrame = lift . runHostFrame . coerce
279+
280+instance MonadReadEvent t m => MonadReadEvent (ProfiledTimeline t) (ProfiledM m) where
281+ readEvent = lift . fmap coerce . readEvent
src/Reflex/Pure.hs+58−30
@@ -5,6 +5,9 @@
5{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE TypeFamilies #-}
7{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE RankNTypes #-}
9+{-# LANGUAGE PolyKinds #-}
10+
8#ifdef USE_REFLEX_OPTIMIZER
11#ifdef USE_REFLEX_OPTIMIZER
9{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
12{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
10#endif
13#endif
@@ -13,11 +16,13 @@
13-- * MonadSample (Pure t) ((->) t)
16-- * MonadSample (Pure t) ((->) t)
14-- * MonadHold (Pure t) ((->) t)
17-- * MonadHold (Pure t) ((->) t)
15{-# OPTIONS_GHC -fno-warn-orphans #-}
18{-# OPTIONS_GHC -fno-warn-orphans #-}
16−
19+-- |
20+-- Module: Reflex.Pure
21+-- Description:
17−-- | This module provides a pure implementation of Reflex, which is intended to
22+-- This module provides a pure implementation of Reflex, which is intended to
18−-- serve as a reference for the semantics of the Reflex class. All
23+-- serve as a reference for the semantics of the Reflex class. All
19−-- implementations of Reflex should produce the same results as this
24+-- implementations of Reflex should produce the same results as this
20−-- implementation, although performance and laziness/strictness may differ.
25+-- implementation, although performance and laziness/strictness may differ.
21module Reflex.Pure
26module Reflex.Pure
22 ( Pure
27 ( Pure
23 , Behavior (..)
28 , Behavior (..)
@@ -26,27 +31,26 @@ module Reflex.Pure
26 , Incremental (..)
31 , Incremental (..)
27 ) where
32 ) where
28
33
29−#if !MIN_VERSION_base(4,8,0)
30−import Control.Applicative
31−#endif
32−
33import Control.Monad
34import Control.Monad
34−import Data.Dependent.Map (DMap, GCompare)
35+import Data.Dependent.Map (DMap)
36+import Data.GADT.Compare (GCompare)
35import qualified Data.Dependent.Map as DMap
37import qualified Data.Dependent.Map as DMap
36−import Data.Functor.Identity
38+import Data.IntMap (IntMap)
39+import qualified Data.IntMap as IntMap
37import Data.Maybe
40import Data.Maybe
38import Data.MemoTrie
41import Data.MemoTrie
39import Data.Monoid
42import Data.Monoid
40import Data.Type.Coercion
43import Data.Type.Coercion
41import Reflex.Class
44import Reflex.Class
45+import Data.Kind (Type)
42
46
43-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
47-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
44−-- with the type @t@.
48+-- with the type @/t/@.
45−data Pure t
49+data Pure (t :: Type)
46
50
47−-- | The Enum instance of t must be dense: for all x :: t, there must not exist
51+-- | The 'Enum' instance of @/t/@ must be dense: for all @/x :: t/@, there must not exist
48−-- any y :: t such that pred x < y < x. The HasTrie instance will be used
52+-- any @/y :: t/@ such that @/'pred' x < y < x/@. The 'HasTrie' instance will be used
49−-- exclusively to memoize functions of t, not for any of its other capabilities.
53+-- exclusively to memoize functions of @/t/@, not for any of its other capabilities.
50instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
54instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
51
55
52 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
56 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
@@ -75,17 +79,19 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
75 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
79 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
76 -- warning because the GCompare instance is not used; however, removing the
80 -- warning because the GCompare instance is not used; however, removing the
77 -- GCompare instance produces a different warning, due to that constraint
81 -- GCompare instance produces a different warning, due to that constraint
78− -- being present in the original class definition
82+ -- being present in the original class definition.
79
83
80− --merge :: GCompare k => DMap k (Event (Pure t)) -> Event (Pure t) (DMap k Identity)
84+ --mergeG :: GCompare k => (forall a. q a -> Event (Pure t) (v a))
85+ -- -> DMap k q -> Event (Pure t) (DMap k v)
81− merge events = Event $ memo $ \t ->
86+ mergeG nt events = Event $ memo $ \t ->
82− let currentOccurrences = DMap.mapMaybeWithKey (\_ (Event a) -> Identity <$> a t) events
87+ let currentOccurrences = DMap.mapMaybeWithKey (\_ q -> case nt q of Event a -> a t) events
83 in if DMap.null currentOccurrences
88 in if DMap.null currentOccurrences
84 then Nothing
89 then Nothing
85 else Just currentOccurrences
90 else Just currentOccurrences
86
91
92+-- The instance signature doeesn't compile, leave commented for documentation
87− fan :: GCompare k => Event (Pure t) (DMap k Identity) -> EventSelector (Pure t) k
93+-- fanG :: GCompare k => Event (Pure t) (DMap k v) -> EventSelectorG (Pure t) k v
88− fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= fmap runIdentity . DMap.lookup k
94+ fanG e = EventSelectorG $ \k -> Event $ \t -> unEvent e t >>= DMap.lookup k
89
95
90 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
96 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
91 switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
97 switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
@@ -108,8 +114,8 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
108 --a) -> Incremental (Pure t) p a
114 --a) -> Incremental (Pure t) p a
109 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
115 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
110
116
111− mergeIncremental = mergeIncrementalImpl
117+ mergeIncrementalG = mergeIncrementalImpl
112− mergeIncrementalWithMove = mergeIncrementalImpl
118+ mergeIncrementalWithMoveG = mergeIncrementalImpl
113
119
114 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
120 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
115
121
@@ -124,14 +130,28 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
124 behaviorCoercion Coercion = Coercion
130 behaviorCoercion Coercion = Coercion
125 eventCoercion Coercion = Coercion
131 eventCoercion Coercion = Coercion
126 dynamicCoercion Coercion = Coercion
132 dynamicCoercion Coercion = Coercion
133+ incrementalCoercion Coercion Coercion = Coercion
127
134
135+ fanInt e = EventSelectorInt $ \k -> Event $ \t -> unEvent e t >>= IntMap.lookup k
136+
137+ mergeIntIncremental = mergeIntIncrementalImpl
138+
128−mergeIncrementalImpl :: (PatchTarget p ~ DMap k (Event (Pure t)), GCompare k) => Incremental (Pure t) p -> Event (Pure t) (DMap k Identity)
139+mergeIncrementalImpl :: (PatchTarget p ~ DMap k q, GCompare k)
140+ => (forall a. q a -> Event (Pure t) (v a))
141+ -> Incremental (Pure t) p -> Event (Pure t) (DMap k v)
129−mergeIncrementalImpl i = Event $ \t ->
142+mergeIncrementalImpl nt i = Event $ \t ->
130− let results = DMap.mapMaybeWithKey (\_ (Event e) -> Identity <$> e t) $ fst $ unIncremental i t
143+ let results = DMap.mapMaybeWithKey (\_ q -> case nt q of Event e -> e t) $ fst $ unIncremental i t
131 in if DMap.null results
144 in if DMap.null results
132 then Nothing
145 then Nothing
133 else Just results
146 else Just results
134
147
148+mergeIntIncrementalImpl :: (PatchTarget p ~ IntMap (Event (Pure t) a)) => Incremental (Pure t) p -> Event (Pure t) (IntMap a)
149+mergeIntIncrementalImpl i = Event $ \t ->
150+ let results = IntMap.mapMaybeWithKey (\_ (Event e) -> e t) $ fst $ unIncremental i t
151+ in if IntMap.null results
152+ then Nothing
153+ else Just results
154+
135instance Functor (Dynamic (Pure t)) where
155instance Functor (Dynamic (Pure t)) where
136 fmap f d = Dynamic $ \t -> let (cur, upd) = unDynamic d t
156 fmap f d = Dynamic $ \t -> let (cur, upd) = unDynamic d t
137 in (f cur, fmap f upd)
157 in (f cur, fmap f upd)
@@ -169,9 +189,11 @@ instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
169 else let lastTime = pred sampleTime
189 else let lastTime = pred sampleTime
170 in fromMaybe (f lastTime) $ unEvent e lastTime
190 in fromMaybe (f lastTime) $ unEvent e lastTime
171
191
192+ holdDyn v0 = buildDynamic (return v0)
193+
172− holdDyn :: a -> Event (Pure t) a -> t -> Dynamic (Pure t) a
194+ buildDynamic :: (t -> a) -> Event (Pure t) a -> t -> Dynamic (Pure t) a
173− holdDyn initialValue e initialTime =
195+ buildDynamic initialValue e initialTime =
174− let Behavior f = hold initialValue e initialTime
196+ let Behavior f = hold (initialValue initialTime) e initialTime
175 in Dynamic $ \t -> (f t, unEvent e t)
197 in Dynamic $ \t -> (f t, unEvent e t)
176
198
177 holdIncremental :: Patch p => PatchTarget p -> Event (Pure t) p -> t -> Incremental (Pure t) p
199 holdIncremental :: Patch p => PatchTarget p -> Event (Pure t) p -> t -> Incremental (Pure t) p
@@ -187,3 +209,9 @@ instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
187 in case unEvent e lastTime of
209 in case unEvent e lastTime of
188 Nothing -> lastValue
210 Nothing -> lastValue
189 Just x -> fromMaybe lastValue $ apply x lastValue
211 Just x -> fromMaybe lastValue $ apply x lastValue
212+
213+ headE = slowHeadE
214+ now t = Event $ guard . (t ==)
215+
216+
217+
src/Reflex/Query/Base.hsnew file+346
@@ -0,0 +1,346 @@
1+{-# LANGUAGE FlexibleInstances #-}
2+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3+{-# LANGUAGE InstanceSigs #-}
4+{-# LANGUAGE LambdaCase #-}
5+{-# LANGUAGE MultiParamTypeClasses #-}
6+{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+{-# LANGUAGE StandaloneDeriving #-}
11+
12+module Reflex.Query.Base
13+ ( QueryT (..)
14+ , runQueryT
15+ , mapQuery
16+ , mapQueryResult
17+ , dynWithQueryT
18+ , withQueryT
19+ , mapQueryT
20+ ) where
21+
22+import Control.Applicative (liftA2)
23+import Control.Monad.Exception
24+import Control.Monad.Fix
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
27+import Control.Monad.Reader
28+import Control.Monad.Ref
29+import Control.Monad.State.Strict
30+import Data.Align
31+import Data.Dependent.Map (DMap)
32+import qualified Data.Dependent.Map as DMap
33+import Data.Dependent.Sum (DSum(..))
34+import Data.Foldable
35+import Data.Functor.Compose
36+import Data.Functor.Misc
37+import Data.GADT.Compare (GCompare)
38+import Data.IntMap (IntMap)
39+import qualified Data.IntMap as IntMap
40+import Data.Map (Map)
41+import qualified Data.Map as Map
42+import Data.Monoid ((<>))
43+import qualified Data.Semigroup as S
44+import Data.Some (Some(Some))
45+import Data.These
46+
47+import Reflex.Class
48+import Reflex.Adjustable.Class
49+import Reflex.DynamicWriter.Class
50+import Reflex.EventWriter.Base
51+import Reflex.EventWriter.Class
52+import Reflex.Host.Class
53+import qualified Data.Patch.MapWithMove as MapWithMove
54+import Reflex.PerformEvent.Class
55+import Reflex.PostBuild.Class
56+import Reflex.Query.Class
57+import Reflex.Requester.Class
58+import Reflex.TriggerEvent.Class
59+
60+newtype QueryT t q m a = QueryT { unQueryT :: StateT [Behavior t q] (EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m)) a }
61+ deriving (Functor, Applicative, Monad, MonadException, MonadFix, MonadIO, MonadAtomicRef)
62+
63+deriving instance MonadHold t m => MonadHold t (QueryT t q m)
64+deriving instance MonadSample t m => MonadSample t (QueryT t q m)
65+
66+runQueryT :: (MonadFix m, Additive q, Group q, Reflex t) => QueryT t q m a -> Dynamic t (QueryResult q) -> m (a, Incremental t (AdditivePatch q))
67+runQueryT (QueryT a) qr = do
68+ ((r, bs), es) <- runReaderT (runEventWriterT (runStateT a mempty)) qr
69+ return (r, unsafeBuildIncremental (foldlM (\b c -> (b <>) <$> sample c) mempty bs) (fmapCheap AdditivePatch es))
70+
71+newtype QueryTLoweredResult t q v = QueryTLoweredResult (v, [Behavior t q])
72+
73+getQueryTLoweredResultValue :: QueryTLoweredResult t q v -> v
74+getQueryTLoweredResultValue (QueryTLoweredResult (v, _)) = v
75+
76+getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
77+getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
78+
79+maskMempty :: (Eq a, Monoid a) => a -> Maybe a
80+maskMempty x = if x == mempty then Nothing else Just x
81+
82+instance (Reflex t, MonadFix m, Group q, Additive q, Query q, Eq q, MonadHold t m, Adjustable t m) => Adjustable t (QueryT t q m) where
83+ runWithReplace (QueryT a0) a' = do
84+ ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
85+ let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
86+ sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
87+ bs' = fmapCheap snd $ r'
88+ bbs <- hold bs0 bs'
89+ let patches = flip pushCheap bs' $ \newBs -> do
90+ oldBs <- sample bbs
91+ maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
92+ QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
93+ QueryT $ lift $ tellEvent patches
94+ return (r0, fmapCheap fst r')
95+
96+ traverseIntMapWithKeyWithAdjust :: forall v v'. (IntMap.Key -> v -> QueryT t q m v') -> IntMap v -> Event t (PatchIntMap v) -> QueryT t q m (IntMap v', Event t (PatchIntMap v'))
97+ traverseIntMapWithKeyWithAdjust f im0 im' = do
98+ let f' :: IntMap.Key -> v -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (QueryTLoweredResult t q v')
99+ f' k v = fmap QueryTLoweredResult $ flip runStateT [] $ unQueryT $ f k v
100+ (result0, result') <- QueryT $ lift $ traverseIntMapWithKeyWithAdjust f' im0 im'
101+ let liftedResult0 = IntMap.map getQueryTLoweredResultValue result0
102+ liftedResult' = fforCheap result' $ \(PatchIntMap p) -> PatchIntMap $
103+ IntMap.map (fmap getQueryTLoweredResultValue) p
104+ liftedBs0 :: IntMap [Behavior t q]
105+ liftedBs0 = IntMap.map getQueryTLoweredResultWritten result0
106+ liftedBs' :: Event t (PatchIntMap [Behavior t q])
107+ liftedBs' = fforCheap result' $ \(PatchIntMap p) -> PatchIntMap $
108+ IntMap.map (fmap getQueryTLoweredResultWritten) p
109+ sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
110+ sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
111+ accumBehaviors :: forall m'. MonadHold t m'
112+ => IntMap [Behavior t q]
113+ -> PatchIntMap [Behavior t q]
114+ -> m' ( Maybe (IntMap [Behavior t q])
115+ , Maybe (AdditivePatch q))
116+ -- f accumulates the child behavior state we receive from running traverseIntMapWithKeyWithAdjust for the underlying monad.
117+ -- When an update occurs, it also computes a patch to communicate to the parent QueryT state.
118+ -- bs0 is a Map denoting the behaviors of the current children.
119+ -- pbs is a PatchMap denoting an update to the behaviors of the current children
120+ accumBehaviors bs0 pbs@(PatchIntMap bs') = do
121+ let p k bs = case IntMap.lookup k bs0 of
122+ Nothing -> case bs of
123+ -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
124+ Nothing -> return mempty
125+ -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
126+ Just newBs -> sampleBs newBs
127+ Just oldBs -> case bs of
128+ -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
129+ Nothing -> negateG <$> sampleBs oldBs
130+ -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
131+ -- composed with the sampling the child's new state.
132+ Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
133+ -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
134+ -- child patches and wrap them in AdditivePatch.
135+ patch <- AdditivePatch . fold <$> IntMap.traverseWithKey p bs'
136+ return (apply pbs bs0, Just patch)
137+ (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
138+ tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
139+ return (liftedResult0, liftedResult')
140+
141+ traverseDMapWithKeyWithAdjust :: forall (k :: * -> *) v v'. (GCompare k) => (forall a. k a -> v a -> QueryT t q m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> QueryT t q m (DMap k v', Event t (PatchDMap k v'))
142+ traverseDMapWithKeyWithAdjust f dm0 dm' = do
143+ let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
144+ f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
145+ (result0, result') <- QueryT $ lift $ traverseDMapWithKeyWithAdjust f' dm0 dm'
146+ let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
147+ liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
148+ mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
149+ liftedBs0 :: Map (Some k) [Behavior t q]
150+ liftedBs0 = Map.fromDistinctAscList $ (\(k :=> Compose r) -> (Some k, getQueryTLoweredResultWritten r)) <$> DMap.toList result0
151+ liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
152+ liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
153+ Map.fromDistinctAscList $ (\(k :=> ComposeMaybe mr) -> (Some k, fmap (getQueryTLoweredResultWritten . getCompose) mr)) <$> DMap.toList p
154+ sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
155+ sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
156+ accumBehaviors :: forall m'. MonadHold t m'
157+ => Map (Some k) [Behavior t q]
158+ -> PatchMap (Some k) [Behavior t q]
159+ -> m' ( Maybe (Map (Some k) [Behavior t q])
160+ , Maybe (AdditivePatch q))
161+ -- f accumulates the child behavior state we receive from running traverseDMapWithKeyWithAdjust for the underlying monad.
162+ -- When an update occurs, it also computes a patch to communicate to the parent QueryT state.
163+ -- bs0 is a Map denoting the behaviors of the current children.
164+ -- pbs is a PatchMap denoting an update to the behaviors of the current children
165+ accumBehaviors bs0 pbs@(PatchMap bs') = do
166+ let p k bs = case Map.lookup k bs0 of
167+ Nothing -> case bs of
168+ -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
169+ Nothing -> return Nothing
170+ -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
171+ Just newBs -> maskMempty <$> sampleBs newBs
172+ Just oldBs -> case bs of
173+ -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
174+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
175+ -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
176+ -- composed with the sampling the child's new state.
177+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
178+ -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
179+ -- child patches and wrap them in AdditivePatch.
180+ patch <- fold <$> Map.traverseWithKey p bs'
181+ return (apply pbs bs0, AdditivePatch <$> patch)
182+ (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
183+ tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
184+ return (liftedResult0, liftedResult')
185+
186+ traverseDMapWithKeyWithAdjustWithMove :: forall (k :: * -> *) v v'. (GCompare k) => (forall a. k a -> v a -> QueryT t q m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> QueryT t q m (DMap k v', Event t (PatchDMapWithMove k v'))
187+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
188+ let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
189+ f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
190+ (result0, result') <- QueryT $ lift $ traverseDMapWithKeyWithAdjustWithMove f' dm0 dm'
191+ let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
192+ liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
193+ liftedBs0 :: Map (Some k) [Behavior t q]
194+ liftedBs0 = Map.fromDistinctAscList $ (\(k :=> Compose r) -> (Some k, getQueryTLoweredResultWritten r)) <$> DMap.toList result0
195+ liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
196+ liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
197+ Map.fromDistinctAscList $ (\(k :=> mr) -> (Some k, fmap (fmap (getQueryTLoweredResultWritten . getCompose)) mr)) <$> DMap.toList p -}
198+ sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
199+ sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
200+ accumBehaviors' :: forall m'. MonadHold t m'
201+ => Map (Some k) [Behavior t q]
202+ -> PatchMapWithMove (Some k) [Behavior t q]
203+ -> m' ( Maybe (Map (Some k) [Behavior t q])
204+ , Maybe (AdditivePatch q))
205+ -- f accumulates the child behavior state we receive from running traverseDMapWithKeyWithAdjustWithMove for the underlying monad.
206+ -- When an update occurs, it also computes a patch to communicate to the parent QueryT state.
207+ -- bs0 is a Map denoting the behaviors of the current children.
208+ -- pbs is a PatchMapWithMove denoting an update to the behaviors of the current children
209+ accumBehaviors' bs0 pbs = do
210+ let bs' = unPatchMapWithMove pbs
211+ p k bs = case Map.lookup k bs0 of
212+ Nothing -> case MapWithMove._nodeInfo_from bs of
213+ -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
214+ MapWithMove.From_Delete -> return Nothing
215+ -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
216+ MapWithMove.From_Insert newBs -> maskMempty <$> sampleBs newBs
217+ MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
218+ Nothing -> return Nothing
219+ Just newBs -> maskMempty <$> sampleBs newBs
220+ Just oldBs -> case MapWithMove._nodeInfo_from bs of
221+ -- If the update is to delete the state for a child that already exists, the patch is the negation of the child's current state
222+ MapWithMove.From_Delete -> maskMempty . negateG <$> sampleBs oldBs
223+ -- If the update is to update the state for a child that already exists, the patch is the negation of sampling the child's current state
224+ -- composed with the sampling the child's new state.
225+ MapWithMove.From_Insert newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
226+ MapWithMove.From_Move k'
227+ | k' == k -> return Nothing
228+ | otherwise -> case Map.lookup k' bs0 of
229+ -- If we are moving from a non-existent key, that is a delete
230+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
231+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
232+ -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
233+ -- child patches and wrap them in AdditivePatch.
234+ patch <- fold <$> Map.traverseWithKey p bs'
235+ return (apply pbs bs0, AdditivePatch <$> patch)
236+ (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
237+ tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
238+ return (liftedResult0, liftedResult')
239+
240+instance MonadTrans (QueryT t q) where
241+ lift = QueryT . lift . lift . lift
242+
243+instance MFunctor (QueryT t q) where
244+ hoist = mapQueryT
245+
246+instance PrimMonad m => PrimMonad (QueryT t q m) where
247+ type PrimState (QueryT t q m) = PrimState m
248+ primitive = lift . primitive
249+
250+instance PostBuild t m => PostBuild t (QueryT t q m) where
251+ getPostBuild = lift getPostBuild
252+
253+instance (MonadAsyncException m) => MonadAsyncException (QueryT t q m) where
254+ mask f = QueryT $ mask $ \unMask -> unQueryT $ f $ QueryT . unMask . unQueryT
255+
256+instance TriggerEvent t m => TriggerEvent t (QueryT t q m) where
257+ newTriggerEvent = lift newTriggerEvent
258+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
259+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
260+
261+instance PerformEvent t m => PerformEvent t (QueryT t q m) where
262+ type Performable (QueryT t q m) = Performable m
263+ performEvent_ = lift . performEvent_
264+ performEvent = lift . performEvent
265+
266+instance MonadRef m => MonadRef (QueryT t q m) where
267+ type Ref (QueryT t q m) = Ref m
268+ newRef = QueryT . newRef
269+ readRef = QueryT . readRef
270+ writeRef r = QueryT . writeRef r
271+
272+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (QueryT t q m) where
273+ newEventWithTrigger = QueryT . newEventWithTrigger
274+ newFanEventWithTrigger a = QueryT . lift $ newFanEventWithTrigger a
275+
276+-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
277+instance (Monoid a, Monad m) => Monoid (QueryT t q m a) where
278+ mempty = pure mempty
279+ mappend = (<>)
280+
281+instance (S.Semigroup a, Monad m) => S.Semigroup (QueryT t q m a) where
282+ (<>) = liftA2 (S.<>)
283+
284+-- | withQueryT's QueryMorphism argument needs to be a group homomorphism in order to behave correctly
285+withQueryT :: (MonadFix m, PostBuild t m, Group q, Group q', Additive q, Additive q', Query q')
286+ => QueryMorphism q q'
287+ -> QueryT t q m a
288+ -> QueryT t q' m a
289+withQueryT f a = do
290+ r' <- askQueryResult
291+ (result, q) <- lift $ runQueryT a $ mapQueryResult f <$> r'
292+ tellQueryIncremental $ unsafeBuildIncremental
293+ (fmap (mapQuery f) (sample (currentIncremental q)))
294+ (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
295+ return result
296+
297+-- | Maps a function over a 'QueryT' that can change the underlying monad
298+mapQueryT :: (forall b. m b -> n b) -> QueryT t q m a -> QueryT t q n a
299+mapQueryT f (QueryT a) = QueryT $ mapStateT (mapEventWriterT (mapReaderT f)) a
300+
301+-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
302+dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
303+ => Dynamic t (QueryMorphism q q')
304+ -> QueryT t q m a
305+ -> QueryT t q' m a
306+dynWithQueryT f q = do
307+ r' <- askQueryResult
308+ (result, q') <- lift $ runQueryT q $ zipDynWith mapQueryResult f r'
309+ tellQueryIncremental $ zipDynIncrementalWith mapQuery f q'
310+ return result
311+ where zipDynIncrementalWith g da ib =
312+ let eab = align (updated da) (updatedIncremental ib)
313+ ec = flip push eab $ \case
314+ This a -> do
315+ aOld <- sample $ current da
316+ b <- sample $ currentIncremental ib
317+ return $ Just $ AdditivePatch (g a b ~~ g aOld b)
318+ That (AdditivePatch b) -> do
319+ a <- sample $ current da
320+ return $ Just $ AdditivePatch $ g a b
321+ These a (AdditivePatch b) -> do
322+ aOld <- sample $ current da
323+ bOld <- sample $ currentIncremental ib
324+ return $ Just $ AdditivePatch $ mconcat [ g a bOld, negateG (g aOld bOld), g a b]
325+ in unsafeBuildIncremental (g <$> sample (current da) <*> sample (currentIncremental ib)) ec
326+
327+instance (Monad m, Group q, Additive q, Query q, Reflex t) => MonadQuery t q (QueryT t q m) where
328+ tellQueryIncremental q = do
329+ QueryT (modify (currentIncremental q:))
330+ QueryT (lift (tellEvent (fmapCheap unAdditivePatch (updatedIncremental q))))
331+ askQueryResult = QueryT ask
332+ queryIncremental q = do
333+ tellQueryIncremental q
334+ zipDynWith crop (incrementalToDynamic q) <$> askQueryResult
335+
336+instance Requester t m => Requester t (QueryT t q m) where
337+ type Request (QueryT t q m) = Request m
338+ type Response (QueryT t q m) = Response m
339+ requesting = lift . requesting
340+ requesting_ = lift . requesting_
341+
342+instance EventWriter t w m => EventWriter t w (QueryT t q m) where
343+ tellEvent = lift . tellEvent
344+
345+instance DynamicWriter t w m => DynamicWriter t w (QueryT t q m) where
346+ tellDyn = lift . tellDyn
src/Reflex/Query/Class.hsnew file+158
@@ -0,0 +1,158 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FunctionalDependencies #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE UndecidableInstances #-}
9+-- |
10+-- Module:
11+-- Reflex.Query.Class
12+-- Description:
13+-- A class that ties together queries to some data source and their results,
14+-- providing methods for requesting data from the source and accumulating
15+-- streamed results.
16+module Reflex.Query.Class
17+ ( Query (..)
18+ , QueryMorphism (..)
19+ , SelectedCount (..)
20+ , combineSelectedCounts
21+
22+ , MonadQuery (..)
23+ , tellQueryDyn
24+ , queryDyn
25+ , subQuery
26+ , mapQuery
27+ , mapQueryResult
28+ ) where
29+
30+import Control.Category (Category)
31+import qualified Control.Category as Cat
32+import Control.Monad.Reader
33+import Data.Bits
34+import Data.Data
35+import Data.Ix
36+import Data.Map.Monoidal (MonoidalMap)
37+import qualified Data.Map.Monoidal as MonoidalMap
38+import Data.Semigroup (Semigroup(..))
39+import Foreign.Storable
40+import Data.Void
41+import Data.Monoid hiding ((<>))
42+import Control.Applicative
43+
44+import Reflex.Class
45+
46+-- | A 'Query' can be thought of as a declaration of interest in some set of data.
47+-- A 'QueryResult' is the set of data associated with that interest set.
48+-- The @crop@ function provides a way to determine what part of a given 'QueryResult'
49+-- is relevant to a given 'Query'.
50+class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
51+ type QueryResult a :: *
52+ crop :: a -> QueryResult a -> QueryResult a
53+
54+instance (Ord k, Query v) => Query (MonoidalMap k v) where
55+ type QueryResult (MonoidalMap k v) = MonoidalMap k (QueryResult v)
56+ crop q r = MonoidalMap.intersectionWith (flip crop) r q
57+
58+-- | the result of two queries is both results.
59+instance (Query a, Query b) => Query (a, b) where
60+ type QueryResult (a, b) = (QueryResult a, QueryResult b)
61+ crop (x, x') (y, y') = (crop x y, crop x' y')
62+
63+-- | Trivial queries have trivial results.
64+instance Query () where
65+ type QueryResult () = ()
66+ crop _ _ = ()
67+
68+-- | The result of an absurd query is trivial; If you can ask the question, the
69+-- answer cannot tell you anything you didn't already know.
70+--
71+-- 'QueryResult Void = @Void@' seems like it would also work, but that has
72+-- problems of robustness. In some applications, an unasked question can still
73+-- be answered, so it is important that the result is inhabited even when the
74+-- question isn't. Applications that wish to prevent this can mandate that the
75+-- query result be paired with the query: then the whole response will be
76+-- uninhabited as desired.
77+instance Query Void where
78+ type QueryResult Void = ()
79+ crop = absurd
80+
81+#if MIN_VERSION_base(4,12,0)
82+-- | We can lift queries into monoidal containers.
83+-- But beware of Applicatives whose monoid is different from (pure mempty, liftA2 mappend)
84+instance (Query q, Applicative f) => Query (Ap f q) where
85+ type QueryResult (Ap f q) = Ap f (QueryResult q)
86+ crop = liftA2 crop
87+#endif
88+
89+-- | QueryMorphism's must be group homomorphisms when acting on the query type
90+-- and compatible with the query relationship when acting on the query result.
91+data QueryMorphism q q' = QueryMorphism
92+ { _queryMorphism_mapQuery :: q -> q'
93+ , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
94+ }
95+
96+instance Category QueryMorphism where
97+ id = QueryMorphism id id
98+ qm . qm' = QueryMorphism
99+ { _queryMorphism_mapQuery = mapQuery qm . mapQuery qm'
100+ , _queryMorphism_mapQueryResult = mapQueryResult qm' . mapQueryResult qm
101+ }
102+
103+-- | Apply a 'QueryMorphism' to a 'Query'
104+mapQuery :: QueryMorphism q q' -> q -> q'
105+mapQuery = _queryMorphism_mapQuery
106+
107+-- | Map a 'QueryMorphism' to a 'QueryResult'
108+mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
109+mapQueryResult = _queryMorphism_mapQueryResult
110+
111+-- | This type can be used to track of the frequency of interest in a given 'Query'. See note on
112+-- 'combineSelectedCounts'
113+newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
114+ deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
115+
116+instance Semigroup SelectedCount where
117+ SelectedCount a <> SelectedCount b = SelectedCount (a + b)
118+
119+instance Monoid SelectedCount where
120+ mempty = SelectedCount 0
121+ mappend = (<>)
122+
123+instance Group SelectedCount where
124+ negateG (SelectedCount a) = SelectedCount (negate a)
125+
126+instance Additive SelectedCount
127+
128+-- | The Semigroup\/Monoid\/Group instances for a Query containing 'SelectedCount's should use
129+-- this function which returns Nothing if the result is 0. This allows the pruning of leaves
130+-- of the 'Query' that are no longer wanted.
131+combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
132+combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
133+
134+-- | A class that allows sending of 'Query's and retrieval of 'QueryResult's. See 'queryDyn' for a commonly
135+-- used interface.
136+class (Group q, Additive q, Query q, Monad m) => MonadQuery t q m | m -> q t where
137+ tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
138+ askQueryResult :: m (Dynamic t (QueryResult q))
139+ queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
140+
141+instance MonadQuery t q m => MonadQuery t q (ReaderT r m) where
142+ tellQueryIncremental = lift . tellQueryIncremental
143+ askQueryResult = lift askQueryResult
144+ queryIncremental = lift . queryIncremental
145+
146+-- | Produce and send an 'Incremental' 'Query' from a 'Dynamic' 'Query'.
147+tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
148+tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
149+
150+-- | Retrieve 'Dynamic'ally updating 'QueryResult's for a 'Dynamic'ally updating 'Query'.
151+queryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
152+queryDyn q = do
153+ tellQueryDyn q
154+ zipDynWith crop q <$> askQueryResult
155+
156+-- | Use a query morphism to operate on a smaller version of a query.
157+subQuery :: (Reflex t, MonadQuery t q2 m) => QueryMorphism q1 q2 -> Dynamic t q1 -> m (Dynamic t (QueryResult q1))
158+subQuery (QueryMorphism f g) x = fmap g <$> queryDyn (fmap f x)
src/Reflex/Requester/Base.hs+507−50
@@ -1,83 +1,373 @@
1-- | This module provides 'RequesterT', the standard implementation of
1-- | This module provides 'RequesterT', the standard implementation of
2-- 'Requester'.
2-- 'Requester'.
3+{-# LANGUAGE AllowAmbiguousTypes #-}
4+{-# LANGUAGE ApplicativeDo #-}
3{-# LANGUAGE CPP #-}
5{-# LANGUAGE CPP #-}
6+{-# LANGUAGE EmptyDataDecls #-}
4{-# LANGUAGE ExistentialQuantification #-}
7{-# LANGUAGE ExistentialQuantification #-}
5{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE FlexibleInstances #-}
9+{-# LANGUAGE GADTs #-}
6{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
11{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE Rank2Types #-}
12{-# LANGUAGE Rank2Types #-}
13+{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE ScopedTypeVariables #-}
15+{-# LANGUAGE StandaloneDeriving #-}
10{-# LANGUAGE TypeFamilies #-}
16{-# LANGUAGE TypeFamilies #-}
17+{-# LANGUAGE TypeOperators #-}
11{-# LANGUAGE UndecidableInstances #-}
18{-# LANGUAGE UndecidableInstances #-}
12−{-# LANGUAGE StandaloneDeriving #-}
13#ifdef USE_REFLEX_OPTIMIZER
19#ifdef USE_REFLEX_OPTIMIZER
14{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
20{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
15#endif
21#endif
16module Reflex.Requester.Base
22module Reflex.Requester.Base
17 ( RequesterT (..)
23 ( RequesterT (..)
18 , runRequesterT
24 , runRequesterT
25+ , withRequesterT
19 , runWithReplaceRequesterTWith
26 , runWithReplaceRequesterTWith
20− , sequenceDMapWithAdjustRequesterTWith
27+ , traverseIntMapWithKeyWithAdjustRequesterTWith
28+ , traverseDMapWithKeyWithAdjustRequesterTWith
29+ , RequesterData
30+ , RequesterDataKey
31+ , traverseRequesterData
32+ , forRequesterData
33+ , requesterDataToList
34+ , singletonRequesterData
35+ , matchResponsesWithRequests
36+ , matchResponseMapWithRequests
37+ , multiEntry
38+ , unMultiEntry
39+ , requesting'
21 ) where
40 ) where
22
41
23import Reflex.Class
42import Reflex.Class
24−import Reflex.EventWriter
43+import Reflex.Adjustable.Class
44+import Reflex.Dynamic
25import Reflex.Host.Class
45import Reflex.Host.Class
26import Reflex.PerformEvent.Class
46import Reflex.PerformEvent.Class
27import Reflex.PostBuild.Class
47import Reflex.PostBuild.Class
28import Reflex.Requester.Class
48import Reflex.Requester.Class
29import Reflex.TriggerEvent.Class
49import Reflex.TriggerEvent.Class
30
50
51+import Control.Applicative (liftA2)
31import Control.Monad.Exception
52import Control.Monad.Exception
32import Control.Monad.Identity
53import Control.Monad.Identity
54+import Control.Monad.Morph
33import Control.Monad.Primitive
55import Control.Monad.Primitive
34import Control.Monad.Reader
56import Control.Monad.Reader
35import Control.Monad.Ref
57import Control.Monad.Ref
36import Control.Monad.State.Strict
58import Control.Monad.State.Strict
59+import Data.Bits
37import Data.Coerce
60import Data.Coerce
61+import Data.Constraint
38−import Data.Dependent.Map (DMap, DSum (..))
62+import Data.Dependent.Map (DMap)
39import qualified Data.Dependent.Map as DMap
63import qualified Data.Dependent.Map as DMap
64+import Data.Dependent.Sum (DSum (..))
65+import Data.Functor.Compose
40import Data.Functor.Misc
66import Data.Functor.Misc
67+import Data.IntMap.Strict (IntMap)
68+import qualified Data.IntMap.Strict as IntMap
41import Data.Map (Map)
69import Data.Map (Map)
70+import qualified Data.Map as Map
71+import Data.Monoid ((<>))
72+import Data.Proxy
73+import qualified Data.Semigroup as S
74+import Data.Some (Some(Some))
75+import Data.Type.Equality
42import Data.Unique.Tag
76import Data.Unique.Tag
43−import Data.Some (Some)
77+
78+import GHC.Exts (Any)
79+import Unsafe.Coerce
80+
81+--TODO: Make this module type-safe
82+
83+newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
84+
85+newtype RequesterData f = RequesterData (TagMap (Entry f))
86+
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
90+data RequesterDataKey a where
91+ RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
92+ RequesterDataKey_Multi :: {-# UNPACK #-} !(MyTag Multi) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a --TODO: Don't put a second Int here (or in the other Multis); use a single Int instead
93+ RequesterDataKey_Multi2 :: GCompare k => {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
94+ RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
95+
96+singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
97+singletonRequesterData rdk v = case rdk of
98+ RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
99+ RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
100+ RequesterDataKey_Multi2 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ Multi2Contents
101+ { _multi2Contents_values = Map.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
102+ , _multi2Contents_dict = Dict
103+ }
104+ RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
105+
106+mergeRequesterData :: RequesterData f -> RequesterData f -> RequesterData f
107+mergeRequesterData (RequesterData a) (RequesterData b) = RequesterData $ mergeTagMap a b
108+
109+mergeTagMap :: forall f. TagMap (Entry f) -> TagMap (Entry f) -> TagMap (Entry f)
110+mergeTagMap (TagMap m) (TagMap n) =
111+ TagMap $ IntMap.unionWithKey (g' combiner) m n
112+ where
113+ combiner :: forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a
114+ combiner k (Entry a) (Entry b) = Entry $ case myKeyType k of
115+ MyTagType_Single -> a
116+ MyTagType_Multi -> IntMap.unionWith mergeRequesterData a b
117+ MyTagType_Multi2 -> case _multi2Contents_dict a of
118+ Dict -> Multi2Contents
119+ { _multi2Contents_values = Map.unionWith (IntMap.unionWith mergeRequesterData) (_multi2Contents_values a) (_multi2Contents_values b)
120+ , _multi2Contents_dict = Dict
121+ }
122+ MyTagType_Multi3 -> IntMap.unionWith (IntMap.unionWith mergeRequesterData) a b
123+ g' :: (forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a) -> Int -> Any -> Any -> Any
124+ g' f rawKey a b =
125+ let k = MyTag rawKey :: MyTag a
126+ fromAny :: Any -> Entry f a
127+ fromAny = unsafeCoerce
128+ toAny :: Entry f a -> Any
129+ toAny = unsafeCoerce
130+ in toAny $ f k (fromAny a) (fromAny b)
131+
132+requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
133+requesterDataToList (RequesterData m) = do
134+ k :=> Entry e <- tagMapToList m
135+ case myKeyType k of
136+ MyTagType_Single -> return $ RequesterDataKey_Single k :=> e
137+ MyTagType_Multi -> do
138+ (k', e') <- IntMap.toList e
139+ k'' :=> e'' <- requesterDataToList e'
140+ return $ RequesterDataKey_Multi k k' k'' :=> e''
141+ MyTagType_Multi2 -> case _multi2Contents_dict e of
142+ Dict -> do
143+ (k', e') <- Map.toList $ _multi2Contents_values e
144+ (k'', e'') <- IntMap.toList e'
145+ k''' :=> e''' <- requesterDataToList e''
146+ return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
147+ MyTagType_Multi3 -> do
148+ (k', e') <- IntMap.toList e
149+ (k'', e'') <- IntMap.toList e'
150+ k''' :=> e''' <- requesterDataToList e''
151+ return $ RequesterDataKey_Multi3 k k' k'' k''' :=> e'''
152+
153+singletonTagMap :: forall f a. MyTag a -> f a -> TagMap f
154+singletonTagMap (MyTag k) v = TagMap $ IntMap.singleton k $ (unsafeCoerce :: f a -> Any) v
155+
156+tagMapToList :: forall f. TagMap f -> [DSum MyTag f]
157+tagMapToList (TagMap m) = f <$> IntMap.toList m
158+ where f :: (Int, Any) -> DSum MyTag f
159+ f (k, v) = MyTag k :=> (unsafeCoerce :: Any -> f a) v
160+
161+traverseTagMapWithKey :: forall t f g. Applicative t => (forall a. MyTag a -> f a -> t (g a)) -> TagMap f -> t (TagMap g)
162+traverseTagMapWithKey f (TagMap m) = TagMap <$> IntMap.traverseWithKey g m
163+ where
164+ g :: Int -> Any -> t Any
165+ g k v = (unsafeCoerce :: g a -> Any) <$> f (MyTag k) ((unsafeCoerce :: Any -> f a) v)
166+
167+-- | Runs in reverse to accommodate for the fact that we accumulate it in reverse
168+traverseRequesterData :: forall m request response. Applicative m => (forall a. request a -> m (response a)) -> RequesterData request -> m (RequesterData response)
169+traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWithKey go m --TODO: reverse this, since our tags are in reverse order
170+ where go :: forall x. MyTag x -> Entry request x -> m (Entry response x)
171+ go k (Entry request) = Entry <$> case myKeyType k of
172+ MyTagType_Single -> f request
173+ MyTagType_Multi -> traverse (traverseRequesterData f) request
174+ MyTagType_Multi2 -> case request of
175+ Multi2Contents { _multi2Contents_values = request', _multi2Contents_dict = Dict } -> do
176+ v <- traverse (traverse (traverseRequesterData f)) request'
177+ pure $ Multi2Contents
178+ { _multi2Contents_values = v
179+ , _multi2Contents_dict = Dict
180+ }
181+ MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
182+
183+-- | 'traverseRequesterData' with its arguments flipped
184+forRequesterData :: forall request response m. Applicative m => RequesterData request -> (forall a. request a -> m (response a)) -> m (RequesterData response)
185+forRequesterData r f = traverseRequesterData f r
186+
187+data MyTagType :: * -> * where
188+ MyTagType_Single :: MyTagType (Single a)
189+ MyTagType_Multi :: MyTagType Multi
190+ MyTagType_Multi2 :: MyTagType (Multi2 k)
191+ MyTagType_Multi3 :: MyTagType Multi3
192+
193+myKeyType :: MyTag x -> MyTagType x
194+myKeyType (MyTag k) = case k .&. 0x3 of
195+ 0x0 -> unsafeCoerce MyTagType_Single
196+ 0x1 -> unsafeCoerce MyTagType_Multi
197+ 0x2 -> unsafeCoerce MyTagType_Multi2
198+ 0x3 -> unsafeCoerce MyTagType_Multi3
199+ t -> error $ "Reflex.Requester.Base.myKeyType: no such key type" <> show t
200+
201+data Single a
202+data Multi
203+data Multi2 (k :: * -> *)
204+data Multi3
205+
206+class MyTagTypeOffset x where
207+ myTagTypeOffset :: proxy x -> Int
208+
209+instance MyTagTypeOffset (Single a) where
210+ myTagTypeOffset _ = 0x0
211+
212+instance MyTagTypeOffset Multi where
213+ myTagTypeOffset _ = 0x1
214+
215+instance MyTagTypeOffset (Multi2 k) where
216+ myTagTypeOffset _ = 0x2
217+
218+instance MyTagTypeOffset Multi3 where
219+ myTagTypeOffset _ = 0x3
220+
221+type family EntryContents request a where
222+ EntryContents request (Single a) = request a
223+ EntryContents request Multi = IntMap (RequesterData request)
224+ EntryContents request (Multi2 k) = Multi2Contents k request
225+ EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
226+
227+data Multi2Contents k request = Multi2Contents
228+ { _multi2Contents_dict :: {-# UNPACK #-} !(Dict (GCompare k)) -- This is a Dict instead of an existential context because we only want to use it in certain circumstances
229+ , _multi2Contents_values :: {-# UNPACK #-} !(Map (Some k) (IntMap (RequesterData request)))
230+ }
231+
232+newtype Entry request x = Entry { unEntry :: EntryContents request x }
233+
234+{-# INLINE singleEntry #-}
235+singleEntry :: f a -> Entry f (Single a)
236+singleEntry = Entry
237+
238+{-# INLINE multiEntry #-}
239+multiEntry :: IntMap (RequesterData f) -> Entry f Multi
240+multiEntry = Entry
241+
242+{-# INLINE unMultiEntry #-}
243+unMultiEntry :: Entry f Multi -> IntMap (RequesterData f)
244+unMultiEntry = unEntry
245+
246+-- | We use a hack here to pretend we have x ~ request a; we don't want to use a GADT, because GADTs (even with zero-size existential contexts) can't be newtypes
247+-- WARNING: This type should never be exposed. In particular, this is extremely unsound if a MyTag from one run of runRequesterT is ever compared against a MyTag from another
248+newtype MyTag x = MyTag Int deriving (Show, Eq, Ord, Enum)
249+
250+newtype MyTagWrap (f :: * -> *) x = MyTagWrap Int deriving (Show, Eq, Ord, Enum)
251+
252+{-# INLINE castMyTagWrap #-}
253+castMyTagWrap :: MyTagWrap f (Entry f x) -> MyTagWrap g (Entry g x)
254+castMyTagWrap = coerce
255+
256+instance GEq MyTag where
257+ (MyTag a) `geq` (MyTag b) =
258+ if a == b
259+ then Just $ unsafeCoerce Refl
260+ else Nothing
261+
262+instance GCompare MyTag where
263+ (MyTag a) `gcompare` (MyTag b) =
264+ case a `compare` b of
265+ LT -> GLT
266+ EQ -> unsafeCoerce GEQ
267+ GT -> GGT
268+
269+instance GEq (MyTagWrap f) where
270+ (MyTagWrap a) `geq` (MyTagWrap b) =
271+ if a == b
272+ then Just $ unsafeCoerce Refl
273+ else Nothing
274+
275+instance GCompare (MyTagWrap f) where
276+ (MyTagWrap a) `gcompare` (MyTagWrap b) =
277+ case a `compare` b of
278+ LT -> GLT
279+ EQ -> unsafeCoerce GEQ
280+ GT -> GGT
281+
282+data RequesterState t (request :: * -> *) = RequesterState
283+ { _requesterState_nextMyTag :: {-# UNPACK #-} !Int -- Starts at -4 and goes down by 4 each time, to accommodate two 'type' bits at the bottom
284+ , _requesterState_requests :: ![(Int, Event t Any)]
285+ }
44
286
45-- | A basic implementation of 'Requester'.
287-- | A basic implementation of 'Requester'.
46−newtype RequesterT t request response m a = RequesterT { unRequesterT :: EventWriterT t (DMap (Tag (PrimState m)) request) (ReaderT (EventSelector t (WrapArg response (Tag (PrimState m)))) m) a }
288+newtype RequesterT t request (response :: * -> *) m a = RequesterT { unRequesterT :: StateT (RequesterState t request) (ReaderT (EventSelectorInt t Any) m) a }
47− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException)
289+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
290+-- MonadAsyncException can't be derived on ghc-8.0.1; we use base-4.9.1 as a proxy for ghc-8.0.2
291+#if MIN_VERSION_base(4,9,1)
292+ , MonadAsyncException
293+#endif
294+ )
48
295
49deriving instance MonadSample t m => MonadSample t (RequesterT t request response m)
296deriving instance MonadSample t m => MonadSample t (RequesterT t request response m)
50deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
297deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
51deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
298deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
52deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
299deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
53
300
301+instance PrimMonad m => PrimMonad (RequesterT t request response m) where
302+ type PrimState (RequesterT t request response m) = PrimState m
303+ primitive = lift . primitive
304+
305+-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
306+instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
307+ mempty = pure mempty
308+ mappend = liftA2 mappend
309+
310+instance (S.Semigroup a, Monad m) => S.Semigroup (RequesterT t request response m a) where
311+ (<>) = liftA2 (S.<>)
312+
313+
54-- | Run a 'RequesterT' action. The resulting 'Event' will fire whenever
314-- | Run a 'RequesterT' action. The resulting 'Event' will fire whenever
55-- requests are made, and responses should be provided in the input 'Event'.
315-- requests are made, and responses should be provided in the input 'Event'.
56-- The 'Tag' keys will be used to return the responses to the same place the
316-- The 'Tag' keys will be used to return the responses to the same place the
57-- requests were issued.
317-- requests were issued.
58−
59runRequesterT :: (Reflex t, Monad m)
318runRequesterT :: (Reflex t, Monad m)
60 => RequesterT t request response m a
319 => RequesterT t request response m a
61− -> Event t (DMap (Tag (PrimState m)) response)
320+ -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
62− -> m (a, Event t (DMap (Tag (PrimState m)) request))
321+ -> m (a, Event t (RequesterData request)) --TODO: we need to hide these 'MyTag's here, because they're unsafe to mix in the wild
63runRequesterT (RequesterT a) responses = do
322runRequesterT (RequesterT a) responses = do
64− (result, requests) <- runReaderT (runEventWriterT a) $ fan $
323+ (result, s) <- runReaderT (runStateT a $ RequesterState (-4) []) $ fanInt $
65− mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e) <$> responses
324+ coerceEvent responses
66− return (result, requests)
325+ return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
326+
327+-- | Map a function over the request and response of a 'RequesterT'
328+withRequesterT
329+ :: (Reflex t, MonadFix m)
330+ => (forall x. req x -> req' x) -- ^ The function to map over the request
331+ -> (forall x. rsp' x -> rsp x) -- ^ The function to map over the response
332+ -> RequesterT t req rsp m a -- ^ The internal 'RequesterT' whose input and output will be transformed
333+ -> RequesterT t req' rsp' m a -- ^ The resulting 'RequesterT'
334+withRequesterT freq frsp child = do
335+ rec let rsp = fmap (runIdentity . traverseRequesterData (Identity . frsp)) rsp'
336+ (a, req) <- lift $ runRequesterT child rsp
337+ rsp' <- fmap (flip selectInt 0 . fanInt . fmapCheap unMultiEntry) $ requesting' $
338+ fmapCheap (multiEntry . IntMap.singleton 0) $ fmap (runIdentity . traverseRequesterData (Identity . freq)) req
339+ return a
67
340
68−instance (Reflex t, PrimMonad m) => Requester t (RequesterT t request response m) where
341+instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
69 type Request (RequesterT t request response m) = request
342 type Request (RequesterT t request response m) = request
70 type Response (RequesterT t request response m) = response
343 type Response (RequesterT t request response m) = response
71− withRequesting a = do
344+ requesting = fmap coerceEvent . responseFromTag . castMyTagWrap <=< tagRequest . (coerceEvent :: Event t (request a) -> Event t (Entry request (Single a)))
72− t <- lift newTag
345+ requesting_ = void . tagRequest . fmapCheap singleEntry
346+
347+{-# INLINE tagRequest #-}
348+tagRequest :: forall m x t request response. (Monad m, MyTagTypeOffset x) => Event t (Entry request x) -> RequesterT t request response m (MyTagWrap request (Entry request x))
349+tagRequest req = do
350+ old <- RequesterT get
351+ let n = _requesterState_nextMyTag old .|. myTagTypeOffset (Proxy :: Proxy x)
352+ t = MyTagWrap n
353+ RequesterT $ put $ RequesterState
354+ { _requesterState_nextMyTag = _requesterState_nextMyTag old - 0x4
355+ , _requesterState_requests = (n, (unsafeCoerce :: Event t (Entry request x) -> Event t Any) req) : _requesterState_requests old
356+ }
357+ return t
358+
359+{-# INLINE responseFromTag #-}
360+responseFromTag :: forall m t request response x. Monad m => MyTagWrap response (Entry response x) -> RequesterT t request response m (Event t (Entry response x))
361+responseFromTag (MyTagWrap t) = do
73− s <- RequesterT ask
362+ responses :: EventSelectorInt t Any <- RequesterT ask
74− (req, result) <- a $ select s $ WrapArg t
363+ return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
75− RequesterT $ tellEvent $ fmapCheap (DMap.singleton t) req
76− return result
77
364
78instance MonadTrans (RequesterT t request response) where
365instance MonadTrans (RequesterT t request response) where
79 lift = RequesterT . lift . lift
366 lift = RequesterT . lift . lift
80
367
368+instance MFunctor (RequesterT t request response) where
369+ hoist f = RequesterT . hoist (hoist f) . unRequesterT
370+
81instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
371instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
82 type Performable (RequesterT t request response m) = Performable m
372 type Performable (RequesterT t request response m) = Performable m
83 performEvent_ = lift . performEvent_
373 performEvent_ = lift . performEvent_
@@ -95,34 +385,88 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (RequesterT
95
385
96instance MonadReader r m => MonadReader r (RequesterT t request response m) where
386instance MonadReader r m => MonadReader r (RequesterT t request response m) where
97 ask = lift ask
387 ask = lift ask
98− local f (RequesterT (EventWriterT a)) = RequesterT $ EventWriterT $ mapStateT (mapReaderT $ local f) a
388+ local f (RequesterT a) = RequesterT $ mapStateT (mapReaderT $ local f) a
99 reader = lift . reader
389 reader = lift . reader
100
390
101−instance (Reflex t, MonadAdjust t m, MonadHold t m) => MonadAdjust t (RequesterT t request response m) where
391+instance (Reflex t, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (RequesterT t request response m) where
102− runWithReplace (RequesterT a) em = RequesterT $ runWithReplace a (coerceEvent em)
392+ runWithReplace = runWithReplaceRequesterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
103− traverseDMapWithKeyWithAdjust f dm edm = RequesterT $ traverseDMapWithKeyWithAdjust (\k v -> unRequesterT $ f k v) (coerce dm) (coerceEvent edm)
393+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') patchIntMapNewElementsMap mergeIntIncremental
394+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
395+ traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental
104− traverseDMapWithKeyWithAdjustWithMove f dm edm = RequesterT $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unRequesterT $ f k v) (coerce dm) (coerceEvent edm)
396+ traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove
397+
398+requesting' :: (MyTagTypeOffset x, Monad m) => Event t (Entry request x) -> RequesterT t request response m (Event t (Entry response x))
399+requesting' = responseFromTag . castMyTagWrap <=< tagRequest
105
400
401+{-# INLINABLE runWithReplaceRequesterTWith #-}
106−runWithReplaceRequesterTWith :: forall m t request response a b. (Reflex t, MonadHold t m)
402+runWithReplaceRequesterTWith :: forall m t request response a b. (Reflex t, MonadHold t m
403+ , MonadFix m
404+ )
107 => (forall a' b'. m a' -> Event t (m b') -> RequesterT t request response m (a', Event t b'))
405 => (forall a' b'. m a' -> Event t (m b') -> RequesterT t request response m (a', Event t b'))
108 -> RequesterT t request response m a
406 -> RequesterT t request response m a
109 -> Event t (RequesterT t request response m b)
407 -> Event t (RequesterT t request response m b)
110 -> RequesterT t request response m (a, Event t b)
408 -> RequesterT t request response m (a, Event t b)
111−runWithReplaceRequesterTWith f a0 a' =
409+runWithReplaceRequesterTWith f a0 a' = do
112− let f' :: forall a' b'. ReaderT (EventSelector t (WrapArg response (Tag (PrimState m)))) m a'
410+ rec na' <- numberOccurrencesFrom 1 a'
113− -> Event t (ReaderT (EventSelector t (WrapArg response (Tag (PrimState m)))) m b')
411+ responses <- fmap (fmapCheap unMultiEntry) $ requesting' $ fmapCheap multiEntry $ switchPromptlyDyn requests --TODO: Investigate whether we can really get rid of the prompt stuff here
114− -> EventWriterT t (DMap (Tag (PrimState m)) request) (ReaderT (EventSelector t (WrapArg response (Tag (PrimState m)))) m) (a', Event t b')
412+ let responses' = fanInt responses
115− f' x y = do
413+ ((result0, requests0), v') <- f (runRequesterT a0 (selectInt responses' 0)) $ fmapCheap (\(n, a) -> fmap ((,) n) $ runRequesterT a $ selectInt responses' n) na'
116− r <- EventWriterT $ ask
414+ requests <- holdDyn (fmapCheap (IntMap.singleton 0) requests0) $ fmapCheap (\(n, (_, reqs)) -> fmapCheap (IntMap.singleton n) reqs) v'
117− unRequesterT (f (runReaderT x r) (fmapCheap (`runReaderT` r) y))
415+ return (result0, fmapCheap (fst . snd) v')
118− in RequesterT $ runWithReplaceEventWriterTWith f' (coerce a0) (coerceEvent a')
416+
119−
417+{-# INLINE traverseIntMapWithKeyWithAdjustRequesterTWith #-}
418+traverseIntMapWithKeyWithAdjustRequesterTWith :: forall t request response m v v' p.
419+ ( Reflex t
420+ , MonadHold t m
421+ , PatchTarget (p (Event t (IntMap (RequesterData request)))) ~ IntMap (Event t (IntMap (RequesterData request)))
422+ , Patch (p (Event t (IntMap (RequesterData request))))
423+ , Functor p
424+ , MonadFix m
425+ )
426+ => ( (IntMap.Key -> (IntMap.Key, v) -> m (Event t (IntMap (RequesterData request)), v'))
427+ -> IntMap (IntMap.Key, v)
428+ -> Event t (p (IntMap.Key, v))
429+ -> RequesterT t request response m (IntMap (Event t (IntMap (RequesterData request)), v'), Event t (p (Event t (IntMap (RequesterData request)), v')))
430+ )
431+ -> (p (Event t (IntMap (RequesterData request))) -> IntMap (Event t (IntMap (RequesterData request))))
432+ -> (Incremental t (p (Event t (IntMap (RequesterData request)))) -> Event t (IntMap (IntMap (RequesterData request))))
433+ -> (IntMap.Key -> v -> RequesterT t request response m v')
434+ -> IntMap v
435+ -> Event t (p v)
436+ -> RequesterT t request response m (IntMap v', Event t (p v'))
437+traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIncremental f dm0 dm' = do
438+ rec response <- requesting' $ fmapCheap pack $ promptRequests `mappend` mergePatchIncremental requests --TODO: Investigate whether we can really get rid of the prompt stuff here
439+ let responses :: EventSelectorInt t (IntMap (RequesterData response))
440+ responses = fanInt $ fmapCheap unpack response
441+ unpack :: Entry response Multi3 -> IntMap (IntMap (RequesterData response))
442+ unpack = unEntry
443+ pack :: IntMap (IntMap (RequesterData request)) -> Entry request Multi3
444+ pack = Entry
445+ f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
446+ f' k (n, v) = do
447+ (result, myRequests) <- runRequesterT (f k v) $ mapMaybeCheap (IntMap.lookup n) $ selectInt responses k --TODO: Instead of doing mapMaybeCheap, can we share a fanInt across all instances of a given key, or at least the ones that are adjacent in time?
448+ return (fmapCheap (IntMap.singleton n) myRequests, result)
449+ ndm' <- numberOccurrencesFrom 1 dm'
450+ (children0, children') <- base f' (fmap ((,) 0) dm0) $ fmap (\(n, dm) -> fmap ((,) n) dm) ndm' --TODO: Avoid this somehow, probably by adding some sort of per-cohort information passing to Adjustable
451+ let result0 = fmap snd children0
452+ result' = fforCheap children' $ fmap snd
453+ requests0 :: IntMap (Event t (IntMap (RequesterData request)))
454+ requests0 = fmap fst children0
455+ requests' :: Event t (p (Event t (IntMap (RequesterData request))))
456+ requests' = fforCheap children' $ fmap fst
457+ promptRequests :: Event t (IntMap (IntMap (RequesterData request)))
458+ promptRequests = coincidence $ fmapCheap (mergeInt . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
459+ requests <- holdIncremental requests0 requests'
460+ return (result0, result')
461+
462+{-# INLINE traverseDMapWithKeyWithAdjustRequesterTWith #-}
120−sequenceDMapWithAdjustRequesterTWith :: forall k t request response m v v' p p'.
463+traverseDMapWithKeyWithAdjustRequesterTWith :: forall k t request response m v v' p p'.
121 ( GCompare k
464 ( GCompare k
122 , Reflex t
465 , Reflex t
123 , MonadHold t m
466 , MonadHold t m
124− , PatchTarget (p' (Some k) (Event t (DMap (Tag (PrimState m)) request))) ~ Map (Some k) (Event t (DMap (Tag (PrimState m)) request))
467+ , PatchTarget (p' (Some k) (Event t (IntMap (RequesterData request)))) ~ Map (Some k) (Event t (IntMap (RequesterData request)))
125− , Patch (p' (Some k) (Event t (DMap (Tag (PrimState m)) request)))
468+ , Patch (p' (Some k) (Event t (IntMap (RequesterData request))))
469+ , MonadFix m
126 )
470 )
127 => (forall k' v1 v2. GCompare k'
471 => (forall k' v1 v2. GCompare k'
128 => (forall a. k' a -> v1 a -> m (v2 a))
472 => (forall a. k' a -> v1 a -> m (v2 a))
@@ -130,21 +474,134 @@ sequenceDMapWithAdjustRequesterTWith :: forall k t request response m v v' p p'.
130 -> Event t (p k' v1)
474 -> Event t (p k' v1)
131 -> RequesterT t request response m (DMap k' v2, Event t (p k' v2))
475 -> RequesterT t request response m (DMap k' v2, Event t (p k' v2))
132 )
476 )
133− -> (forall v1. (forall a. v1 a -> v' a) -> p k v1 -> p k v')
477+ -> (forall v1 v2. (forall a. v1 a -> v2 a) -> p k v1 -> p k v2)
134 -> (forall v1 v2. (forall a. v1 a -> v2) -> p k v1 -> p' (Some k) v2)
478 -> (forall v1 v2. (forall a. v1 a -> v2) -> p k v1 -> p' (Some k) v2)
135− -> (forall v2. p' (Some k) v2 -> [v2])
479+ -> (forall v2. p' (Some k) v2 -> Map (Some k) v2)
136 -> (forall a. Incremental t (p' (Some k) (Event t a)) -> Event t (Map (Some k) a))
480 -> (forall a. Incremental t (p' (Some k) (Event t a)) -> Event t (Map (Some k) a))
137 -> (forall a. k a -> v a -> RequesterT t request response m (v' a))
481 -> (forall a. k a -> v a -> RequesterT t request response m (v' a))
138 -> DMap k v
482 -> DMap k v
139 -> Event t (p k v)
483 -> Event t (p k v)
140 -> RequesterT t request response m (DMap k v', Event t (p k v'))
484 -> RequesterT t request response m (DMap k v', Event t (p k v'))
141−sequenceDMapWithAdjustRequesterTWith base mapPatch weakenPatchWith patchNewElements mergePatchIncremental f dm0 dm' =
485+traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchNewElements mergePatchIncremental f dm0 dm' = do
142− let base' :: forall v1 v2.
486+ rec response <- requesting' $ fmapCheap pack $ promptRequests `mappend` mergePatchIncremental requests --TODO: Investigate whether we can really get rid of the prompt stuff here
143− (forall a. k a -> v1 a -> ReaderT (EventSelector t (WrapArg response (Tag (PrimState m)))) m (v2 a))
487+ let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
144− -> DMap k v1
488+ responses = fanMap $ fmapCheap unpack response
145− -> Event t (p k v1)
489+ unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
146− -> EventWriterT t (DMap (Tag (PrimState m)) request) (ReaderT (EventSelector t (WrapArg response (Tag (PrimState m)))) m) (DMap k v2, Event t (p k v2))
490+ unpack = _multi2Contents_values . unEntry
147− base' f' x y = do
491+ pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
148− r <- EventWriterT ask
492+ pack m = Entry $ Multi2Contents { _multi2Contents_values = m, _multi2Contents_dict = Dict }
149− unRequesterT $ base (\k v -> runReaderT (f' k v) r) x y
493+ f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
150− in RequesterT $ sequenceDMapWithAdjustEventWriterTWith base' mapPatch weakenPatchWith patchNewElements mergePatchIncremental (\k v -> unRequesterT $ f k v) (coerce dm0) (coerceEvent dm')
494+ f' k (Compose (n, v)) = do
495+ (result, myRequests) <- runRequesterT (f k v) $ mapMaybeCheap (IntMap.lookup n) $ select responses (Const2 (Some k))
496+ return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
497+ ndm' <- numberOccurrencesFrom 1 dm'
498+ (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
499+ let result0 = DMap.map (snd . getCompose) children0
500+ result' = fforCheap children' $ mapPatch $ snd . getCompose
501+ requests0 :: Map (Some k) (Event t (IntMap (RequesterData request)))
502+ requests0 = weakenDMapWith (fst . getCompose) children0
503+ requests' :: Event t (p' (Some k) (Event t (IntMap (RequesterData request))))
504+ requests' = fforCheap children' $ weakenPatchWith $ fst . getCompose
505+ promptRequests :: Event t (Map (Some k) (IntMap (RequesterData request)))
506+ promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
507+ requests <- holdIncremental requests0 requests'
508+ return (result0, result')
509+
510+data Decoder rawResponse response =
511+ forall a. Decoder (RequesterDataKey a) (rawResponse -> response a)
512+
513+matchResponsesWithRequests
514+ :: forall t rawRequest rawResponse request response m.
515+ ( MonadFix m
516+ , MonadHold t m
517+ , Reflex t
518+ )
519+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
520+ -- ^ Given a request (from 'Requester'), produces the wire format of the
521+ -- request and a function used to process the associated response
522+ -> Event t (RequesterData request)
523+ -- ^ The outgoing requests
524+ -> Event t (Int, rawResponse)
525+ -- ^ The incoming responses, tagged by an identifying key
526+ -> m ( Event t (Map Int rawRequest)
527+ , Event t (RequesterData response)
528+ )
529+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
530+ -- by the 'RequesterData' key of the associated outgoing request
531+matchResponsesWithRequests f send recv = matchResponseMapWithRequests f send $ uncurry Map.singleton <$> recv
532+
533+-- | Matches incoming responses with previously-sent requests
534+-- and uses the provided request "decoder" function to process
535+-- incoming responses.
536+matchResponseMapWithRequests
537+ :: forall t rawRequest rawResponse request response m.
538+ ( MonadFix m
539+ , MonadHold t m
540+ , Reflex t
541+ )
542+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
543+ -- ^ Given a request (from 'Requester'), produces the wire format of the
544+ -- request and a function used to process the associated response
545+ -> Event t (RequesterData request)
546+ -- ^ The outgoing requests
547+ -> Event t (Map Int rawResponse)
548+ -- ^ A map of incoming responses, tagged by an identifying key
549+ -> m ( Event t (Map Int rawRequest)
550+ , Event t (RequesterData response)
551+ )
552+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
553+ -- by the 'RequesterData' key of the associated outgoing request
554+matchResponseMapWithRequests f send recv = do
555+ rec nextId <- hold 1 $ fmap (\(next, _, _) -> next) outgoing
556+ waitingFor :: Incremental t (PatchMap Int (Decoder rawResponse response)) <-
557+ holdIncremental mempty $ leftmost
558+ [ fmap (\(_, outstanding, _) -> outstanding) outgoing
559+ , snd <$> incoming
560+ ]
561+ let outgoing = processOutgoing nextId send
562+ incoming = processIncoming waitingFor recv
563+ return (fmap (\(_, _, rawReqs) -> rawReqs) outgoing, fst <$> incoming)
564+ where
565+ -- Tags each outgoing request with an identifying integer key
566+ -- and returns the next available key, a map of response decoders
567+ -- for requests for which there are outstanding responses, and the
568+ -- raw requests to be sent out.
569+ processOutgoing
570+ :: Behavior t Int
571+ -- The next available key
572+ -> Event t (RequesterData request)
573+ -- The outgoing request
574+ -> Event t ( Int
575+ , PatchMap Int (Decoder rawResponse response)
576+ , Map Int rawRequest )
577+ -- The new next-available-key, a map of requests expecting responses, and the tagged raw requests
578+ processOutgoing nextId out = flip pushAlways out $ \dm -> do
579+ oldNextId <- sample nextId
580+ let (result, newNextId) = flip runState oldNextId $ forM (requesterDataToList dm) $ \(k :=> v) -> do
581+ n <- get
582+ put $ succ n
583+ let (rawReq, rspF) = f v
584+ return (n, rawReq, Decoder k rspF)
585+ patchWaitingFor = PatchMap $ Map.fromList $
586+ (\(n, _, dec) -> (n, Just dec)) <$> result
587+ toSend = Map.fromList $ (\(n, rawReq, _) -> (n, rawReq)) <$> result
588+ return (newNextId, patchWaitingFor, toSend)
589+ -- Looks up the each incoming raw response in a map of response
590+ -- decoders and returns the decoded response and a patch that can
591+ -- be used to clear the ID of the consumed response out of the queue
592+ -- of expected responses.
593+ processIncoming
594+ :: Incremental t (PatchMap Int (Decoder rawResponse response))
595+ -- A map of outstanding expected responses
596+ -> Event t (Map Int rawResponse)
597+ -- A incoming response paired with its identifying key
598+ -> Event t (RequesterData response, PatchMap Int v)
599+ -- The decoded response and a patch that clears the outstanding responses queue
600+ processIncoming waitingFor inc = flip push inc $ \rspMap -> do
601+ wf <- sample $ currentIncremental waitingFor
602+ let match rawRsp (Decoder k rspF) =
603+ let rsp = rspF rawRsp
604+ in singletonRequesterData k rsp
605+ matches = Map.intersectionWith match rspMap wf
606+ pure $ if Map.null matches then Nothing else Just
607+ (Map.foldl' mergeRequesterData emptyRequesterData matches, PatchMap $ Nothing <$ matches)
src/Reflex/Requester/Class.hs+20−35
@@ -6,7 +6,7 @@
6{-# LANGUAGE CPP #-}
6{-# LANGUAGE CPP #-}
7{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE FunctionalDependencies #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
9+{-# LANGUAGE RecursiveDo #-}
10{-# LANGUAGE TypeFamilies #-}
10{-# LANGUAGE TypeFamilies #-}
11{-# LANGUAGE UndecidableInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
12#ifdef USE_REFLEX_OPTIMIZER
12#ifdef USE_REFLEX_OPTIMIZER
@@ -14,8 +14,7 @@
14#endif
14#endif
15module Reflex.Requester.Class
15module Reflex.Requester.Class
16 ( Requester (..)
16 ( Requester (..)
17− , requesting
17+ , withRequesting
18− , requesting_
19 , requestingIdentity
18 , requestingIdentity
20 ) where
19 ) where
21
20
@@ -36,52 +35,38 @@ class (Reflex t, Monad m) => Requester t m | m -> t where
36 type Request m :: * -> *
35 type Request m :: * -> *
37 -- | The type of responses that this 'Requester' can receive
36 -- | The type of responses that this 'Requester' can receive
38 type Response m :: * -> *
37 type Response m :: * -> *
39− -- | Usually, end-user code should use 'requesting', 'requesting_', or
38+ -- | Emit a request whenever the given 'Event' fires, and return responses in
40− -- 'requestingIdentity'. For implementers of 'Requester', this function
39+ -- the resulting 'Event'.
41− -- provides a convenient way to define instances of the typeclass that
40+ requesting :: Event t (Request m a) -> m (Event t (Response m a))
42− -- efficiently support the underlying operations without needing to use
41+ -- | Emit a request whenever the given 'Event' fires, and ignore all responses.
43− -- 'Control.Monad.Fix.MonadFix'.
42+ requesting_ :: Event t (Request m a) -> m ()
44− withRequesting :: (Event t (Response m a) -> m (Event t (Request m a), r)) -> m r
43+
45
44
46instance Requester t m => Requester t (ReaderT r m) where
45instance Requester t m => Requester t (ReaderT r m) where
47 type Request (ReaderT r m) = Request m
46 type Request (ReaderT r m) = Request m
48 type Response (ReaderT r m) = Response m
47 type Response (ReaderT r m) = Response m
49− withRequesting f = do
48+ requesting = lift . requesting
50− r <- ask
49+ requesting_ = lift . requesting_
51− lift $ withRequesting $ (`runReaderT` r) . f
52
50
53instance Requester t m => Requester t (StateT s m) where
51instance Requester t m => Requester t (StateT s m) where
54 type Request (StateT s m) = Request m
52 type Request (StateT s m) = Request m
55 type Response (StateT s m) = Response m
53 type Response (StateT s m) = Response m
56− withRequesting f = do
54+ requesting = lift . requesting
57− old <- get
55+ requesting_ = lift . requesting_
58− (result, new) <- lift $ withRequesting $ \x -> do
59− ((request, result), new) <- runStateT (f x) old
60− return (request, (result, new))
61− put new
62− return result
63
56
64instance Requester t m => Requester t (Lazy.StateT s m) where
57instance Requester t m => Requester t (Lazy.StateT s m) where
65 type Request (Lazy.StateT s m) = Request m
58 type Request (Lazy.StateT s m) = Request m
66 type Response (Lazy.StateT s m) = Response m
59 type Response (Lazy.StateT s m) = Response m
67− withRequesting f = do
60+ requesting = lift . requesting
68− old <- Lazy.get
61+ requesting_ = lift . requesting_
69− (result, new) <- lift $ withRequesting $ \x -> do
70− ((request, result), new) <- Lazy.runStateT (f x) old
71− return (request, (result, new))
72− Lazy.put new
73− return result
74−
75−-- | Emit a request whenever the given 'Event' fires, and return responses in
76−-- the resulting 'Event'.
77−requesting :: Requester t m => Event t (Request m a) -> m (Event t (Response m a))
78−requesting req = withRequesting $ return . (,) req
79−
80−-- | Emit a request whenever the given 'Event' fires, and ignore all responses.
81−requesting_ :: Requester t m => Event t (Request m a) -> m ()
82−requesting_ req = withRequesting $ \_ -> return (req, ())
83
62
84-- | Emit a request whenever the given 'Event' fires, and unwrap the responses
63-- | Emit a request whenever the given 'Event' fires, and unwrap the responses
85-- before returning them. @Response m@ must be 'Identity'.
64-- before returning them. @Response m@ must be 'Identity'.
86requestingIdentity :: (Requester t m, Response m ~ Identity) => Event t (Request m a) -> m (Event t a)
65requestingIdentity :: (Requester t m, Response m ~ Identity) => Event t (Request m a) -> m (Event t a)
87requestingIdentity = fmap coerceEvent . requesting
66requestingIdentity = fmap coerceEvent . requesting
67+
68+withRequesting :: (Requester t m, MonadFix m) => (Event t (Response m a) -> m (Event t (Request m a), r)) -> m r
69+withRequesting f = do
70+ rec response <- requesting request
71+ (request, result) <- f response
72+ return result
src/Reflex/Spider.hs+5−7
@@ -1,22 +1,20 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2+-- |
3+-- Module:
4+-- Reflex.Spider
5+-- Description:
2−-- | This module exports all of the user-facing functionality of the 'Spider'
6+-- This module exports all of the user-facing functionality of the 'Spider' 'Reflex' engine
3−-- 'Reflex' engine
4module Reflex.Spider
7module Reflex.Spider
5 ( Spider
8 ( Spider
6 , SpiderTimeline
9 , SpiderTimeline
7 , Global
10 , Global
8 , SpiderHost
11 , SpiderHost
9 , runSpiderHost
12 , runSpiderHost
10−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
11 , runSpiderHostForTimeline
13 , runSpiderHostForTimeline
12 , newSpiderTimeline
14 , newSpiderTimeline
13 , withSpiderTimeline
15 , withSpiderTimeline
14−#endif
15 -- * Deprecated
16 -- * Deprecated
16 , SpiderEnv
17 , SpiderEnv
17 ) where
18 ) where
18
19
19−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
20−import Reflex.Class
21−#endif
22import Reflex.Spider.Internal
20import Reflex.Spider.Internal
src/Reflex/Spider/Internal.hs+1302−548
@@ -9,40 +9,49 @@
9{-# LANGUAGE GADTs #-}
9{-# LANGUAGE GADTs #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10{-# LANGUAGE GeneralizedNewtypeDeriving #-}
11{-# LANGUAGE LambdaCase #-}
11{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MagicHash #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE MultiWayIf #-}
15{-# LANGUAGE RankNTypes #-}
12{-# LANGUAGE RankNTypes #-}
16{-# LANGUAGE RoleAnnotations #-}
13{-# LANGUAGE RoleAnnotations #-}
17{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE ScopedTypeVariables #-}
18{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeFamilies #-}
19{-# LANGUAGE TypeOperators #-}
16{-# LANGUAGE TypeOperators #-}
20{-# LANGUAGE UndecidableInstances #-}
17{-# LANGUAGE UndecidableInstances #-}
18+{-# LANGUAGE PolyKinds #-}
19+{-# LANGUAGE DeriveFunctor #-}
20+{-# LANGUAGE StandaloneDeriving #-}
21+{-# LANGUAGE InstanceSigs #-}
22+{-# LANGUAGE MultiWayIf #-}
23+
21#ifdef USE_REFLEX_OPTIMIZER
24#ifdef USE_REFLEX_OPTIMIZER
22{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
25{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
23#endif
26#endif
24−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
25−{-# OPTIONS_GHC -fno-warn-orphans #-}
27+{-# OPTIONS_GHC -Wunused-binds #-}
26−#endif
27-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
28-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
28-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
29-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
29module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
30module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
30
31
32+#if MIN_VERSION_base(4,10,0)
31−import Control.Applicative
33+import Control.Applicative (liftA2)
34+#endif
32import Control.Concurrent
35import Control.Concurrent
33import Control.Exception
36import Control.Exception
34−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
37+import Control.Monad hiding (forM, forM_, mapM, mapM_)
35import Control.Monad.Exception
38import Control.Monad.Exception
36−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
39+import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
37import Control.Monad.Primitive
40import Control.Monad.Primitive
38−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence)
41+import Control.Monad.Reader.Class
42+import Control.Monad.IO.Class
43+import Control.Monad.ReaderIO
39import Control.Monad.Ref
44import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
40import Data.Align
47import Data.Align
41import Data.Coerce
48import Data.Coerce
42−import Data.Dependent.Map (DMap, DSum (..))
49+import Data.Dependent.Map (DMap)
43import qualified Data.Dependent.Map as DMap
50import qualified Data.Dependent.Map as DMap
51+import Data.Dependent.Sum (DSum (..))
52+import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
53+import qualified Data.FastMutableIntMap as FastMutableIntMap
44import Data.Foldable hiding (concat, elem, sequence_)
54import Data.Foldable hiding (concat, elem, sequence_)
45−import Data.Function
46import Data.Functor.Constant
55import Data.Functor.Constant
47import Data.Functor.Misc
56import Data.Functor.Misc
48import Data.Functor.Product
57import Data.Functor.Product
@@ -50,56 +59,73 @@ import Data.GADT.Compare
50import Data.IntMap.Strict (IntMap)
59import Data.IntMap.Strict (IntMap)
51import qualified Data.IntMap.Strict as IntMap
60import qualified Data.IntMap.Strict as IntMap
52import Data.IORef
61import Data.IORef
53−import Data.List hiding (foldl')
62+import Data.Kind (Type)
54−import Data.Maybe
63+import Data.Maybe hiding (mapMaybe)
55−import Data.Monoid ((<>))
64+import Data.Monoid (mempty, (<>))
56import Data.Proxy
65import Data.Proxy
57import Data.These
66import Data.These
58import Data.Traversable
67import Data.Traversable
59−import Data.Word
68+import Data.Type.Equality ((:~:)(Refl))
69+import Data.Witherable (Filterable, mapMaybe)
60−import GHC.Exts
70+import GHC.Exts hiding (toList)
61import GHC.IORef (IORef (..))
71import GHC.IORef (IORef (..))
62import GHC.Stack
72import GHC.Stack
63−import Reflex.FunctorMaybe
73+import Reflex.FastWeak
64import System.IO.Unsafe
74import System.IO.Unsafe
65import System.Mem.Weak
75import System.Mem.Weak
66import Unsafe.Coerce
76import Unsafe.Coerce
67
77
78+#ifdef MIN_VERSION_semialign
79+#if MIN_VERSION_these(0,8,0)
80+import Data.These.Combinators (justThese)
81+#endif
82+#if MIN_VERSION_semialign(1,1,0)
83+import Data.Zip (Zip (..))
84+#endif
85+#endif
86+
68#ifdef DEBUG_CYCLES
87#ifdef DEBUG_CYCLES
69import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
88import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
89+#endif
90+
70import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
91import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
71import qualified Data.List.NonEmpty as NonEmpty
92import qualified Data.List.NonEmpty as NonEmpty
72−import Data.Monoid (mempty)
73import Data.Tree (Forest, Tree (..), drawForest)
93import Data.Tree (Forest, Tree (..), drawForest)
74−#endif
94+import Data.List (isPrefixOf)
95+
96+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
97+import qualified Data.FastWeakBag as FastWeakBag
75
98
76−import Data.WeakBag (WeakBag, WeakBagTicket)
77−import qualified Data.WeakBag as WeakBag
78−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
79import Data.Reflection
99import Data.Reflection
80−import Data.Some (Some)
100+import Data.Some (Some(Some))
81−import qualified Data.Some as Some
82import Data.Type.Coercion
101import Data.Type.Coercion
102+import Data.Profunctor.Unsafe ((#.), (.#))
103+import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
104+import qualified Data.WeakBag as WeakBag
83import qualified Reflex.Class
105import qualified Reflex.Class
84import qualified Reflex.Class as R
106import qualified Reflex.Class as R
85import qualified Reflex.Host.Class
107import qualified Reflex.Host.Class
86−#endif
87−import Reflex.Patch
108+import Reflex.NotReady.Class
88−
109+import Data.Patch
89−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
90−import Prelude hiding (any, concat, mapM, mapM_, sequence)
111+import Reflex.PerformEvent.Base (PerformEventT)
91
112
92#ifdef DEBUG_TRACE_EVENTS
113#ifdef DEBUG_TRACE_EVENTS
93−import System.IO (stderr)
94import qualified Data.ByteString.Char8 as BS8
114import qualified Data.ByteString.Char8 as BS8
115+import System.IO (stderr)
116+import Data.List (isPrefixOf)
95#endif
117#endif
96
118
97−#ifdef DEBUG_TRACE_EVENTS
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
98
122
123+#ifdef DEBUG_TRACE_EVENTS
99withStackOneLine :: (BS8.ByteString -> a) -> a
124withStackOneLine :: (BS8.ByteString -> a) -> a
100withStackOneLine expr = unsafePerformIO $ do
125withStackOneLine expr = unsafePerformIO $ do
101 stack <- currentCallStack
126 stack <- currentCallStack
102− return (expr (BS8.pack (unwords (reverse stack))))
127+ return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
128+ where dropInternal = filterStack "Reflex.Spider.Internal"
103
129
104#endif
130#endif
105
131
@@ -110,28 +136,42 @@ debugInvalidateHeight :: Bool
110debugInvalidate :: Bool
136debugInvalidate :: Bool
111
137
112#ifdef DEBUG
138#ifdef DEBUG
113−
114#define DEBUG_NODEIDS
139#define DEBUG_NODEIDS
115
140
141+#ifdef DEBUG_TRACE_PROPAGATION
116debugPropagate = True
142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
117
146
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
118debugInvalidateHeight = False
150debugInvalidateHeight = False
151+#endif
119
152
153+#ifdef DEBUG_TRACE_INVALIDATION
120debugInvalidate = True
154debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
121
158
122class HasNodeId a where
159class HasNodeId a where
123 getNodeId :: a -> Int
160 getNodeId :: a -> Int
124
161
125−instance HasNodeId (Hold x p a) where
162+instance HasNodeId (CacheSubscribed x a) where
126− getNodeId = holdNodeId
163+ getNodeId = _cacheSubscribed_nodeId
127
164
128−instance HasNodeId (PushSubscribed x a b) where
165+instance HasNodeId (FanInt x a) where
129− getNodeId = pushSubscribedNodeId
166+ getNodeId = _fanInt_nodeId
167+
168+instance HasNodeId (Hold x p) where
169+ getNodeId = holdNodeId
130
170
131instance HasNodeId (SwitchSubscribed x a) where
171instance HasNodeId (SwitchSubscribed x a) where
132 getNodeId = switchSubscribedNodeId
172 getNodeId = switchSubscribedNodeId
133
173
134−instance HasNodeId (FanSubscribed x a) where
174+instance HasNodeId (FanSubscribed x v a) where
135 getNodeId = fanSubscribedNodeId
175 getNodeId = fanSubscribedNodeId
136
176
137instance HasNodeId (CoincidenceSubscribed x a) where
177instance HasNodeId (CoincidenceSubscribed x a) where
@@ -145,41 +185,16 @@ instance HasNodeId (Pull x a) where
145
185
146{-# INLINE showNodeId #-}
186{-# INLINE showNodeId #-}
147showNodeId :: HasNodeId a => a -> String
187showNodeId :: HasNodeId a => a -> String
148−showNodeId = ("#"<>) . show . getNodeId
188+showNodeId = showNodeId' . getNodeId
149−
189+
150−showSubscriberType :: Subscriber x a -> String
190+showNodeId' :: Int -> String
151−showSubscriberType = \case
191+showNodeId' = ("#"<>) . show
152− SubscriberPush _ _ -> "SubscriberPush"
192+
153− SubscriberMerge _ _ -> "SubscriberMerge"
154− SubscriberFan _ -> "SubscriberFan"
155− SubscriberMergeChange _ -> "SubscriberMergeChange"
156− SubscriberHold _ -> "SubscriberHold"
157− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
158− SubscriberSwitch _ -> "SubscriberSwitch"
159− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
160− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
161− SubscriberHandle -> "SubscriberHandle"
162−
163−showEventType :: Event x a -> String
164−showEventType = \case
165− EventRoot _ _ -> "EventRoot"
166− EventNever -> "EventNever"
167− EventPush _ -> "EventPush"
168− EventMerge _ -> "EventMerge"
169− EventFan _ _ -> "EventFan"
170− EventSwitch _ -> "EventSwitch"
171− EventCoincidence _ -> "EventCoincidence"
172− EventHold _ -> "EventHold"
173− EventDyn _ -> "EventDyn"
174− EventHoldIdentity _ -> "EventHoldIdentity"
175− EventDynIdentity _ -> "EventDynIdentity"
176
193
177#else
194#else
178
195
179debugPropagate = False
196debugPropagate = False
180−
181debugInvalidateHeight = False
197debugInvalidateHeight = False
182−
183debugInvalidate = False
198debugInvalidate = False
184
199
185-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -187,6 +202,10 @@ debugInvalidate = False
187showNodeId :: a -> String
202showNodeId :: a -> String
188showNodeId _ = ""
203showNodeId _ = ""
189
204
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
208+
190#endif
209#endif
191
210
192#ifdef DEBUG_NODEIDS
211#ifdef DEBUG_NODEIDS
@@ -196,12 +215,6 @@ nextNodeIdRef = unsafePerformIO $ newIORef 1
196
215
197newNodeId :: IO Int
216newNodeId :: IO Int
198newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
199−
200−{-# NOINLINE unsafeNodeId #-}
201−unsafeNodeId :: a -> Int
202−unsafeNodeId a = unsafePerformIO $ do
203− touch a
204− newNodeId
205#endif
218#endif
206
219
207--------------------------------------------------------------------------------
220--------------------------------------------------------------------------------
@@ -237,85 +250,165 @@ subscribeAndRead = unEvent
237-- | Construct an 'Event' equivalent to that constructed by 'push', but with no
250-- | Construct an 'Event' equivalent to that constructed by 'push', but with no
238-- caching; if the computation function is very cheap, this is (much) more
251-- caching; if the computation function is very cheap, this is (much) more
239-- efficient than 'push'
252-- efficient than 'push'
240−{-# NOINLINE pushCheap #-}
253+{-# INLINE [1] pushCheap #-}
241pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
254pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
242−pushCheap f e = Event $ \sub -> do
255+pushCheap !f e = Event $ \sub -> do
243− (subscription, occ) <- subscribeAndRead e $ sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
244 { subscriberPropagate = \a -> do
257 { subscriberPropagate = \a -> do
245− mb <- runComputeM $ f a
258+ mb <- f a
246 mapM_ (subscriberPropagate sub) mb
259 mapM_ (subscriberPropagate sub) mb
247 }
260 }
248− occ' <- join <$> mapM (runComputeM . f) occ
261+ occ' <- join <$> mapM f occ
249 return (subscription, occ')
262 return (subscription, occ')
250
263
264+-- | A subscriber that never triggers other 'Event's
265+{-# INLINE terminalSubscriber #-}
266+terminalSubscriber :: (a -> EventM x ()) -> Subscriber x a
267+terminalSubscriber p = Subscriber
268+ { subscriberPropagate = p
269+ , subscriberInvalidateHeight = \_ -> return ()
270+ , subscriberRecalculateHeight = \_ -> return ()
271+ }
272+
273+-- | Subscribe to an Event only for the duration of one occurrence
274+{-# INLINE subscribeAndReadHead #-}
275+subscribeAndReadHead :: HasSpiderTimeline x => Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
276+subscribeAndReadHead e sub = do
277+ subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
279+ { subscriberPropagate = \a -> do
280+ liftIO $ unsubscribe =<< readIORef subscriptionRef
281+ subscriberPropagate sub a
282+ }
283+ liftIO $ case occ of
284+ Nothing -> writeIORef subscriptionRef $! subscription
285+ Just _ -> unsubscribe subscription
286+ return (subscription, occ)
287+
288+--TODO: Make this lazy in its input event
289+headE :: (MonadIO m, Defer (SomeMergeInit x) m, HasSpiderTimeline x) => Event x a -> m (Event x a)
290+headE originalE = do
291+ parent <- liftIO $ newIORef $ Just originalE
292+ defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
293+ let clearParent = liftIO $ writeIORef parent Nothing
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
295+ when (isJust occ) clearParent
296+ return $ Event $ \sub ->
297+ liftIO (readIORef parent) >>= \case
298+ Nothing -> subscribeAndReadNever
299+ Just e -> subscribeAndReadHead e sub
300+
251data CacheSubscribed x a
301data CacheSubscribed x a
252− = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(WeakBag (Subscriber x a))
302+ = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
253− , _cacheSubscribed_weakSelf :: {-# UNPACK #-} !(IORef (Weak (CacheSubscribed x a)))
254 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
255− , _cacheSubscribed_cached :: {-# UNPACK #-} !(IORef (Maybe (CacheSubscribed x a)))
256 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
257 }
308 }
258
309
310+nowSpiderEventM :: (HasSpiderTimeline x) => EventM x (R.Event (SpiderTimeline x) ())
311+nowSpiderEventM =
312+ SpiderEvent <$> now
313+
314+now :: (MonadIO m, Defer (Some Clear) m, HasSpiderTimeline x
315+ ) => m (Event x ())
316+now = do
317+ nowOrNot <- liftIO $ newIORef $ Just ()
318+ scheduleClear nowOrNot
319+ return . Event $ \_ -> do
320+ occ <- liftIO . readIORef $ nowOrNot
321+ return ( EventSubscription (return ()) eventSubscribedNow
322+ , occ
323+ )
324+
259-- | Construct an 'Event' whose value is guaranteed not to be recomputed
325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
260-- repeatedly
326-- repeatedly
261--
327--
262--TODO: Try a caching strategy where we subscribe directly to the parent when
328--TODO: Try a caching strategy where we subscribe directly to the parent when
263−--there's only one subscriber, and then build our own WeakBag only when a second
329+--there's only one subscriber, and then build our own FastWeakBag only when a second
264--subscriber joins
330--subscriber joins
265−{-# NOINLINE cacheEvent #-}
331+{-# NOINLINE [0] cacheEvent #-}
266−cacheEvent :: HasSpiderTimeline x => Event x a -> Event x a
332+cacheEvent :: forall x a. HasSpiderTimeline x => Event x a -> Event x a
267cacheEvent e =
333cacheEvent e =
268#ifdef DEBUG_TRACE_EVENTS
334#ifdef DEBUG_TRACE_EVENTS
269 withStackOneLine $ \callSite -> Event $
335 withStackOneLine $ \callSite -> Event $
270#else
336#else
271 Event $
337 Event $
272#endif
338#endif
273− let !mSubscribedRef = unsafeNewIORef e Nothing
339+ unsafePerformIO $ do
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
341+ <- newIORef emptyFastWeak
274− in \sub -> {-# SCC "cacheEvent" #-} do
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
275#ifdef DEBUG_TRACE_EVENTS
343#ifdef DEBUG_TRACE_EVENTS
276 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
277#endif
345#endif
278− mSubscribed <- liftIO $ readIORef mSubscribedRef
346+ subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
279− case mSubscribed of
347+ Just subscribedTicket -> return subscribedTicket
280− Just subscribed -> liftIO $ do
281− ticket <- WeakBag.insert sub (_cacheSubscribed_subscribers subscribed) (_cacheSubscribed_weakSelf subscribed) cleanupCacheSubscribed
282− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
283− let es = EventSubscribed
284− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
285− , eventSubscribedRetained = toAny subscribed
286− }
287− return (EventSubscription (WeakBag.remove ticket >> touch ticket) es, occ)
288 Nothing -> do
348 Nothing -> do
289− weakSelf <- liftIO $ newIORef $ error "cacheEvent: weakSelf not yet intialized"
349+#ifdef DEBUG_NODEIDS
290− (subscribers, ticket) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCacheSubscribed
350+ nodeId <- liftIO newNodeId
351+#endif
352+ subscribers <- liftIO FastWeakBag.empty
291− occRef <- liftIO $ newIORef undefined
353+ occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
354+#ifdef DEBUG_NODEIDS
355+ (parentSub, occ) <- subscribeAndRead e $ debugSubscriber' ("cacheEvent" <> showNodeId' nodeId) $ Subscriber
356+#else
292 (parentSub, occ) <- subscribeAndRead e $ Subscriber
357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
358+#endif
293− { subscriberPropagate = \a -> do
359+ { subscriberPropagate = \a -> do
294− liftIO $ writeIORef occRef $ Just a
360+ liftIO $ writeIORef occRef (Just a)
295− scheduleClear occRef
361+ scheduleClear occRef
296− propagate a subscribers
362+ propagateFast a subscribers
297− , subscriberInvalidateHeight = \old -> do
298− WeakBag.traverse subscribers $ invalidateSubscriberHeight old
363+ , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
299− , subscriberRecalculateHeight = \new -> do
300− WeakBag.traverse subscribers $ recalculateSubscriberHeight new
364+ , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
301− }
365+ }
302− liftIO $ writeIORef occRef occ
366+ when (isJust occ) $ do
367+ liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
303− when (isJust occ) $ scheduleClear occRef
368+ scheduleClear occRef
304 let !subscribed = CacheSubscribed
369 let !subscribed = CacheSubscribed
305 { _cacheSubscribed_subscribers = subscribers
370 { _cacheSubscribed_subscribers = subscribers
306− , _cacheSubscribed_weakSelf = weakSelf
307 , _cacheSubscribed_parent = parentSub
371 , _cacheSubscribed_parent = parentSub
308− , _cacheSubscribed_cached = mSubscribedRef
309 , _cacheSubscribed_occurrence = occRef
372 , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
310 }
376 }
377+ subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
311− liftIO $ writeIORef mSubscribedRef $ Just subscribed
378+ liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
312− liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "PushSubscribed"
379+ return subscribedTicket
380+ liftIO $ cacheSubscription sub mSubscribedRef subscribedTicket
381+
382+cacheSubscription :: Subscriber x a -> IORef (FastWeak (CacheSubscribed x a))
383+ -> FastWeakTicket (CacheSubscribed x a) -> IO (EventSubscription x, Maybe a)
384+cacheSubscription sub mSubscribedRef subscribedTicket = do
385+ subscribed <- getFastWeakTicketValue subscribedTicket
386+ ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
387+ occ <- readIORef $ _cacheSubscribed_occurrence subscribed
388+
389+ let parentSub = _cacheSubscribed_parent subscribed
390+ es = EventSubscription
391+ { _eventSubscription_unsubscribe = do
392+ FastWeakBag.remove ticket
393+
394+ isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
395+ when isEmpty $ do
396+ writeIORef mSubscribedRef emptyFastWeak
397+ unsubscribe parentSub
398+ touch ticket
399+ touch subscribedTicket
400+ , _eventSubscription_subscribed = EventSubscribed
313− return (EventSubscription (WeakBag.remove ticket >> touch ticket) (EventSubscribed (eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub) (toAny subscribed)), occ)
401+ { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub
402+ , eventSubscribedRetained = toAny subscribedTicket
403+#ifdef DEBUG_CYCLES
404+ , eventSubscribedGetParents = return [_eventSubscription_subscribed parentSub]
405+ , eventSubscribedHasOwnHeightRef = False
406+ , eventSubscribedWhoCreated = whoCreatedIORef mSubscribedRef
407+#endif
408+ }
409+ }
410+ return (es, occ)
314
411
315−cleanupCacheSubscribed :: CacheSubscribed x a -> IO ()
316−cleanupCacheSubscribed self = do
317− unsubscribe $ _cacheSubscribed_parent self
318− writeIORef (_cacheSubscribed_cached self) Nothing
319
412
320subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
321subscribe e s = fst <$> subscribeAndRead e s
414subscribe e s = fst <$> subscribeAndRead e s
@@ -327,13 +420,16 @@ wrap tag getSpecificSubscribed sub = do
327 let es = tag subd
420 let es = tag subd
328 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
329
422
330−eventRoot :: GCompare k => k a -> Root x k -> Event x a
423+eventRoot :: (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Event x a
331eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
332
425
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
333eventNever :: Event x a
429eventNever :: Event x a
334−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
430+eventNever = Event $ const subscribeAndReadNever
335
431
336−eventFan :: (GCompare k, HasSpiderTimeline x) => k a -> Fan x k -> Event x a
432+eventFan :: (GCompare k, HasSpiderTimeline x) => k a -> Fan x k v -> Event x (v a)
337eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
338
434
339eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
@@ -342,14 +438,14 @@ eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
342eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
438eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
343eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
439eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
344
440
345−eventHold :: HasSpiderTimeline x => Hold x p -> Event x p
441+eventHold :: Hold x p -> Event x p
346eventHold !h = Event $ subscribeHoldEvent h
442eventHold !h = Event $ subscribeHoldEvent h
347
443
348eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
444eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
349eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
445eventDyn !j = Event $ \sub -> getDynHold j >>= \h -> subscribeHoldEvent h sub
350
446
351{-# INLINE subscribeCoincidenceInner #-}
447{-# INLINE subscribeCoincidenceInner #-}
352−subscribeCoincidenceInner :: CanSubscribe x m => Event x a -> Height -> CoincidenceSubscribed x a -> m (Maybe a, Height, EventSubscribed x)
448+subscribeCoincidenceInner :: HasSpiderTimeline x => Event x a -> Height -> CoincidenceSubscribed x a -> EventM x (Maybe a, Height, EventSubscribed x)
353subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
449subscribeCoincidenceInner inner outerHeight subscribedUnsafe = do
354 subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
450 subInner <- liftIO $ newSubscriberCoincidenceInner subscribedUnsafe
355 (subscription@(EventSubscription _ innerSubd), innerOcc) <- subscribeAndRead inner subInner
451 (subscription@(EventSubscription _ innerSubd), innerOcc) <- subscribeAndRead inner subInner
@@ -368,16 +464,6 @@ data Subscriber x a = Subscriber
368 , subscriberRecalculateHeight :: !(Height -> IO ())
464 , subscriberRecalculateHeight :: !(Height -> IO ())
369 }
465 }
370
466
371−--TODO: Move this comment to WeakBag
372−-- These function are constructor functions that are marked NOINLINE so they are
373−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
374−-- so any weak references that are attached to the constructors will have their
375−-- finalizer run. Using the opaque constructor, does not see the
376−-- constructor application, so it behaves like an IORef and cannot be fused away.
377−--
378−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
379−-- the weak pointer to it in some cases.
380−
381newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
382newSubscriberHold h = return $ Subscriber
468newSubscriberHold h = return $ Subscriber
383 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -385,85 +471,68 @@ newSubscriberHold h = return $ Subscriber
385 , subscriberRecalculateHeight = \_ -> return ()
471 , subscriberRecalculateHeight = \_ -> return ()
386 }
472 }
387
473
388−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
474+newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
389−newSubscriberFan subscribed = return $ Subscriber
475+newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
390 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
391 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
477 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
392− tracePropagate (Proxy :: Proxy x) $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
478+ tracePropagate (Proxy :: Proxy x) $ show (DMap.size subs) <> " keys subscribed, " <> show (DMap.size a) <> " keys firing"
393 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
394 scheduleClear $ fanSubscribedOccurrence subscribed
480 scheduleClear $ fanSubscribedOccurrence subscribed
395− let f _ (Pair (Identity v) subsubs) = do
481+ let f _ (Pair v subsubs) = do
396 propagate v $ _fanSubscribedChildren_list subsubs
482 propagate v $ _fanSubscribedChildren_list subsubs
397 return $ Constant ()
483 return $ Constant ()
398 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
399 return ()
485 return ()
400 , subscriberInvalidateHeight = \old -> do
486 , subscriberInvalidateHeight = \old -> do
401− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
402 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
403− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
404− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
405 , subscriberRecalculateHeight = \new -> do
489 , subscriberRecalculateHeight = \new -> do
406− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
407 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
408− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
409− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
410 }
492 }
411
493
412newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
413−newSubscriberSwitch subscribed = return $ Subscriber
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
414 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
415− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
416 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
417 scheduleClear $ switchSubscribedOccurrence subscribed
498 scheduleClear $ switchSubscribedOccurrence subscribed
418 propagate a $ switchSubscribedSubscribers subscribed
499 propagate a $ switchSubscribedSubscribers subscribed
419 , subscriberInvalidateHeight = \_ -> do
500 , subscriberInvalidateHeight = \_ -> do
420− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
421 oldHeight <- readIORef $ switchSubscribedHeight subscribed
501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
422 when (oldHeight /= invalidHeight) $ do
502 when (oldHeight /= invalidHeight) $ do
423 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
424− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
425− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
426− , subscriberRecalculateHeight = \new -> do
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
427− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
428− updateSwitchHeight new subscribed
429− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
430− }
506+ }
431
507
432newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
433−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
434 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
435− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
436 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
437 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
438 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
439 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
440 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
441 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
442 scheduleClear $ coincidenceSubscribedInnerParent subscribed
518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
443 case occ of
519 case occ of
444− Nothing -> do
520+ Nothing ->
445 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
446 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
447− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
448− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
449 Just o -> do -- Since it's already firing, no need to adjust height
525 Just o -> do -- Since it's already firing, no need to adjust height
450 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
451 scheduleClear $ coincidenceSubscribedOccurrence subscribed
527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
452 propagate o $ coincidenceSubscribedSubscribers subscribed
528 propagate o $ coincidenceSubscribedSubscribers subscribed
453− , subscriberInvalidateHeight = \_ -> do
454− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
455− invalidateCoincidenceHeight subscribed
529+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
456− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
457− , subscriberRecalculateHeight = \_ -> do
458− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
459− recalculateCoincidenceHeight subscribed
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
460− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
461 }
531 }
462
532
463newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
464−newSubscriberCoincidenceInner subscribed = return $ Subscriber
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
465 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
466− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
467 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
468 case occ of
537 case occ of
469 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -471,14 +540,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
471 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
472 scheduleClear $ coincidenceSubscribedOccurrence subscribed
541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
473 propagate a $ coincidenceSubscribedSubscribers subscribed
542 propagate a $ coincidenceSubscribedSubscribers subscribed
474− , subscriberInvalidateHeight = \_ -> do
475− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
476− invalidateCoincidenceHeight subscribed
543+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
477− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
478− , subscriberRecalculateHeight = \_ -> do
479− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
480− recalculateCoincidenceHeight subscribed
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
481− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
482 }
545 }
483
546
484invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -488,11 +551,18 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
488recalculateSubscriberHeight = flip subscriberRecalculateHeight
551recalculateSubscriberHeight = flip subscriberRecalculateHeight
489
552
490-- | Propagate everything at the current height
553-- | Propagate everything at the current height
491−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
554+propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
492−propagate a subscribers = withIncreasedDepth $ do
555+propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
556+ -- 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
557+ --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
558+ WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
559+
560+-- | Propagate everything at the current height
561+propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
562+propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
493 -- 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
563 -- 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
494 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
495− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
496
566
497--------------------------------------------------------------------------------
567--------------------------------------------------------------------------------
498-- EventSubscribed
568-- EventSubscribed
@@ -501,11 +571,16 @@ propagate a subscribers = withIncreasedDepth $ do
501toAny :: a -> Any
571toAny :: a -> Any
502toAny = unsafeCoerce
572toAny = unsafeCoerce
503
573
574+-- Why do we use Any here, instead of just giving eventSubscribedRetained an
575+-- existential type? Sadly, GHC does not currently know how to unbox types
576+-- with existentially quantified fields. So instead we just coerce values
577+-- to type Any on the way in. Since we never coerce them back, this is
578+-- perfectly safe.
504data EventSubscribed x = EventSubscribed
579data EventSubscribed x = EventSubscribed
505 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
506 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
507#ifdef DEBUG_CYCLES
582#ifdef DEBUG_CYCLES
508− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
509 , eventSubscribedHasOwnHeightRef :: !Bool
584 , eventSubscribedHasOwnHeightRef :: !Bool
510 , eventSubscribedWhoCreated :: !(IO [String])
585 , eventSubscribedWhoCreated :: !(IO [String])
511#endif
586#endif
@@ -532,13 +607,23 @@ eventSubscribedNever = EventSubscribed
532 , eventSubscribedWhoCreated = return ["never"]
607 , eventSubscribedWhoCreated = return ["never"]
533#endif
608#endif
534 }
609 }
610+eventSubscribedNow :: EventSubscribed x
611+eventSubscribedNow = EventSubscribed
612+ { eventSubscribedHeightRef = zeroRef
613+ , eventSubscribedRetained = toAny ()
614+#ifdef DEBUG_CYCLES
615+ , eventSubscribedGetParents = return []
616+ , eventSubscribedHasOwnHeightRef = False
617+ , eventSubscribedWhoCreated = return ["now"]
618+#endif
619+ }
535
620
536−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
537eventSubscribedFan !subscribed = EventSubscribed
622eventSubscribedFan !subscribed = EventSubscribed
538 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
539 , eventSubscribedRetained = toAny subscribed
624 , eventSubscribedRetained = toAny subscribed
540#ifdef DEBUG_CYCLES
625#ifdef DEBUG_CYCLES
541− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
542 , eventSubscribedHasOwnHeightRef = False
627 , eventSubscribedHasOwnHeightRef = False
543 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
544#endif
629#endif
@@ -551,7 +636,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
551#ifdef DEBUG_CYCLES
636#ifdef DEBUG_CYCLES
552 , eventSubscribedGetParents = do
637 , eventSubscribedGetParents = do
553 s <- readIORef $ switchSubscribedCurrentParent subscribed
638 s <- readIORef $ switchSubscribedCurrentParent subscribed
554− return [Some.This $ _eventSubscription_subscribed s]
639+ return [_eventSubscription_subscribed s]
555 , eventSubscribedHasOwnHeightRef = True
640 , eventSubscribedHasOwnHeightRef = True
556 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
557#endif
642#endif
@@ -564,8 +649,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
564#ifdef DEBUG_CYCLES
649#ifdef DEBUG_CYCLES
565 , eventSubscribedGetParents = do
650 , eventSubscribedGetParents = do
566 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
567− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
568− innerParents = maybeToList $ fmap Some.This innerSubscription
653+ innerParents = maybeToList $ innerSubscription
569 return $ outerParent : innerParents
654 return $ outerParent : innerParents
570 , eventSubscribedHasOwnHeightRef = True
655 , eventSubscribedHasOwnHeightRef = True
571 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -579,20 +664,20 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
579whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
580whoCreatedEventSubscribed = eventSubscribedWhoCreated
665whoCreatedEventSubscribed = eventSubscribedWhoCreated
581
666
582−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
583walkInvalidHeightParents s0 = do
668walkInvalidHeightParents s0 = do
584− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
669+ subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
585 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
586 when (h == invalidHeight) $ do
671 when (h == invalidHeight) $ do
587 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
588− modify (Some.This s :)
673+ modify (s :)
589 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
590− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
591 return subscribers
676 return subscribers
592#endif
677#endif
593
678
594{-# INLINE subscribeHoldEvent #-}
679{-# INLINE subscribeHoldEvent #-}
595−subscribeHoldEvent :: CanSubscribe x m => Hold x p -> Subscriber x p -> m (EventSubscription x, Maybe p)
680+subscribeHoldEvent :: Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
596subscribeHoldEvent = subscribeAndRead . holdEvent
681subscribeHoldEvent = subscribeAndRead . holdEvent
597
682
598--------------------------------------------------------------------------------
683--------------------------------------------------------------------------------
@@ -615,7 +700,7 @@ behaviorPull !p = Behavior $ do
615 val <- liftIO $ readIORef $ pullValue p
700 val <- liftIO $ readIORef $ pullValue p
616 case val of
701 case val of
617 Just subscribed -> do
702 Just subscribed -> do
618− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
619 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
620 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
621 return $ pullSubscribedValue subscribed
706 return $ pullSubscribedValue subscribed
@@ -624,7 +709,7 @@ behaviorPull !p = Behavior $ do
624 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
625 parentsRef <- liftIO $ newIORef []
710 parentsRef <- liftIO $ newIORef []
626 holdInits <- askBehaviorHoldInits
711 holdInits <- askBehaviorHoldInits
627− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
628 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
629 parents <- liftIO $ readIORef parentsRef
714 parents <- liftIO $ readIORef parentsRef
630 let subscribed = PullSubscribed
715 let subscribed = PullSubscribed
@@ -634,7 +719,7 @@ behaviorPull !p = Behavior $ do
634 , pullSubscribedParents = parents
719 , pullSubscribedParents = parents
635 }
720 }
636 liftIO $ writeIORef (pullValue p) $ Just subscribed
721 liftIO $ writeIORef (pullValue p) $ Just subscribed
637− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
722+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
638 return a
723 return a
639
724
640behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
@@ -645,7 +730,8 @@ readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
645readHoldTracked h = do
730readHoldTracked h = do
646 result <- liftIO $ readIORef $ holdValue h
731 result <- liftIO $ readIORef $ holdValue h
647 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
732 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
648− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
733+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedHold h)) :))
734+ liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
649 return result
735 return result
650
736
651{-# INLINABLE readBehaviorUntracked #-}
737{-# INLINABLE readBehaviorUntracked #-}
@@ -658,42 +744,46 @@ readBehaviorUntracked b = do
658-- Dynamic
744-- Dynamic
659--------------------------------------------------------------------------------
745--------------------------------------------------------------------------------
660
746
747+type DynamicS x p = Dynamic x (PatchTarget p) p
748+
661−data Dynamic x p = Dynamic
749+data Dynamic x target p = Dynamic
662− { dynamicCurrent :: !(Behavior x (PatchTarget p))
750+ { dynamicCurrent :: !(Behavior x target)
663− , dynamicUpdated :: !(Event x p)
751+ , dynamicUpdated :: Event x p -- This must be lazy; see the comment on holdEvent --TODO: Would this let us eliminate `Dyn`?
664 }
752 }
665
753
666−dynamicHold :: HasSpiderTimeline x => Hold x p -> Dynamic x p
754+deriving instance (HasSpiderTimeline x) => Functor (Dynamic x target)
755+
756+
757+
758+
759+dynamicHold :: Hold x p -> DynamicS x p
667dynamicHold !h = Dynamic
760dynamicHold !h = Dynamic
668 { dynamicCurrent = behaviorHold h
761 { dynamicCurrent = behaviorHold h
669 , dynamicUpdated = eventHold h
762 , dynamicUpdated = eventHold h
670 }
763 }
671
764
672−dynamicHoldIdentity :: HasSpiderTimeline x => Hold x (Identity a) -> Dynamic x (Identity a)
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
673dynamicHoldIdentity = dynamicHold
766dynamicHoldIdentity = dynamicHold
674
767
675−dynamicConst :: PatchTarget p -> Dynamic x p
768+dynamicConst :: PatchTarget p -> DynamicS x p
676dynamicConst !a = Dynamic
769dynamicConst !a = Dynamic
677 { dynamicCurrent = behaviorConst a
770 { dynamicCurrent = behaviorConst a
678 , dynamicUpdated = eventNever
771 , dynamicUpdated = eventNever
679 }
772 }
680
773
681−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
682dynamicDyn !d = Dynamic
775dynamicDyn !d = Dynamic
683 { dynamicCurrent = behaviorDyn d
776 { dynamicCurrent = behaviorDyn d
684 , dynamicUpdated = eventDyn d
777 , dynamicUpdated = eventDyn d
685 }
778 }
686
779
687−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
688dynamicDynIdentity = dynamicDyn
781dynamicDynIdentity = dynamicDyn
689
782
690--------------------------------------------------------------------------------
783--------------------------------------------------------------------------------
691-- Combinators
784-- Combinators
692--------------------------------------------------------------------------------
785--------------------------------------------------------------------------------
693
786
694−--TODO: Figure out why certain things are not 'representational', then make them
695−--representational so we can use coerce
696−
697--type role Hold representational
787--type role Hold representational
698data Hold x p
788data Hold x p
699 = Hold { holdValue :: !(IORef (PatchTarget p))
789 = Hold { holdValue :: !(IORef (PatchTarget p))
@@ -705,9 +795,7 @@ data Hold x p
705#endif
795#endif
706 }
796 }
707
797
708−-- | A statically allocated 'SpiderTimeline'; this is the only instance of
798+-- | A statically allocated 'SpiderTimeline'
709−-- 'SpiderTimeline' that can used when using
710−-- -fspecialize-to-spidertimeline-global.
711data Global
799data Global
712
800
713{-# NOINLINE globalSpiderTimelineEnv #-}
801{-# NOINLINE globalSpiderTimelineEnv #-}
@@ -716,27 +804,37 @@ globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
716
804
717-- | Stores all global data relevant to a particular Spider timeline; only one
805-- | Stores all global data relevant to a particular Spider timeline; only one
718-- value should exist for each type @x@
806-- value should exist for each type @x@
807+newtype SpiderTimelineEnv x = STE {unSTE :: SpiderTimelineEnv' x}
808+-- We implement SpiderTimelineEnv with a newtype wrapper so
809+-- we can get the coercions we want safely.
810+type role SpiderTimelineEnv nominal
811+
719−data SpiderTimelineEnv x = SpiderTimelineEnv
812+data SpiderTimelineEnv' x = SpiderTimelineEnv
720 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
721 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
722#ifdef DEBUG
815#ifdef DEBUG
723 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
724#endif
817#endif
725 }
818 }
726−type role SpiderTimelineEnv nominal
819+type role SpiderTimelineEnv' phantom
820+
821+instance Eq (SpiderTimelineEnv x) where
822+ _ == _ = True -- Since only one exists of each type
727
823
728instance GEq SpiderTimelineEnv where
824instance GEq SpiderTimelineEnv where
729− a `geq` b = if _spiderTimeline_lock a == _spiderTimeline_lock b
825+ a `geq` b = if _spiderTimeline_lock (unSTE a) == _spiderTimeline_lock (unSTE b)
730 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
731 else Nothing
827 else Nothing
732
828
733data EventEnv x
829data EventEnv x
734 = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
830 = EventEnv { eventEnvAssignments :: !(IORef [SomeAssignment x]) -- Needed for Subscribe
735 , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
831 , eventEnvHoldInits :: !(IORef [SomeHoldInit x]) -- Needed for Subscribe
832+ , eventEnvDynInits :: !(IORef [SomeDynInit x])
736 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
737 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
738− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
739− , eventEnvRootClears :: !(IORef [SomeRootClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
740 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
741 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
742 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
@@ -747,7 +845,7 @@ runEventM :: EventM x a -> IO a
747runEventM = unEventM
845runEventM = unEventM
748
846
749asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
847asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
750−asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
848+asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (unSTE (spiderTimeline :: SpiderTimelineEnv x))
751
849
752class MonadIO m => Defer a m where
850class MonadIO m => Defer a m where
753 getDeferralQueue :: m (IORef [a])
851 getDeferralQueue :: m (IORef [a])
@@ -766,6 +864,10 @@ instance HasSpiderTimeline x => Defer (SomeHoldInit x) (EventM x) where
766 {-# INLINE getDeferralQueue #-}
864 {-# INLINE getDeferralQueue #-}
767 getDeferralQueue = asksEventEnv eventEnvHoldInits
865 getDeferralQueue = asksEventEnv eventEnvHoldInits
768
866
867+instance HasSpiderTimeline x => Defer (SomeDynInit x) (EventM x) where
868+ {-# INLINE getDeferralQueue #-}
869+ getDeferralQueue = asksEventEnv eventEnvDynInits
870+
769instance Defer (SomeHoldInit x) (BehaviorM x) where
871instance Defer (SomeHoldInit x) (BehaviorM x) where
770 {-# INLINE getDeferralQueue #-}
872 {-# INLINE getDeferralQueue #-}
771 getDeferralQueue = BehaviorM $ asks snd
873 getDeferralQueue = BehaviorM $ asks snd
@@ -792,11 +894,7 @@ instance HasSpiderTimeline x => HasCurrentHeight x (EventM x) where
792 delayedRef <- asksEventEnv eventEnvDelayedMerges
894 delayedRef <- asksEventEnv eventEnvDelayedMerges
793 liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
895 liftIO $ modifyIORef' delayedRef $ IntMap.insertWith (++) (unHeight height) [subscribed]
794
896
795−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
796−class x ~ Global => HasSpiderTimeline x where
797−#else
798class HasSpiderTimeline x where
897class HasSpiderTimeline x where
799−#endif
800 -- | Retrieve the current SpiderTimelineEnv
898 -- | Retrieve the current SpiderTimelineEnv
801 spiderTimeline :: SpiderTimelineEnv x
899 spiderTimeline :: SpiderTimelineEnv x
802
900
@@ -808,21 +906,29 @@ putCurrentHeight h = do
808 heightRef <- asksEventEnv eventEnvCurrentHeight
906 heightRef <- asksEventEnv eventEnvCurrentHeight
809 liftIO $ writeIORef heightRef $! h
907 liftIO $ writeIORef heightRef $! h
810
908
811−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
812 {-# INLINE getDeferralQueue #-}
910 {-# INLINE getDeferralQueue #-}
813 getDeferralQueue = asksEventEnv eventEnvClears
911 getDeferralQueue = asksEventEnv eventEnvClears
814
912
815{-# INLINE scheduleClear #-}
913{-# INLINE scheduleClear #-}
816−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
817−scheduleClear r = defer $ SomeClear r
915+scheduleClear r = defer $ Some $ Clear r
916+
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
918+ {-# INLINE getDeferralQueue #-}
919+ getDeferralQueue = asksEventEnv eventEnvIntClears
920+
921+{-# INLINE scheduleIntClear #-}
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
923+scheduleIntClear r = defer $ Some $ IntClear r
818
924
819−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
820 {-# INLINE getDeferralQueue #-}
926 {-# INLINE getDeferralQueue #-}
821 getDeferralQueue = asksEventEnv eventEnvRootClears
927 getDeferralQueue = asksEventEnv eventEnvRootClears
822
928
823{-# INLINE scheduleRootClear #-}
929{-# INLINE scheduleRootClear #-}
824−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
825−scheduleRootClear r = defer $ SomeRootClear r
931+scheduleRootClear r = defer $ Some $ RootClear r
826
932
827instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
828 {-# INLINE getDeferralQueue #-}
934 {-# INLINE getDeferralQueue #-}
@@ -851,7 +957,7 @@ hold v0 e = do
851 return h
957 return h
852
958
853{-# INLINE getHoldEventSubscription #-}
959{-# INLINE getHoldEventSubscription #-}
854−getHoldEventSubscription :: forall m p x. (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer SomeClear m, Patch p, HasCurrentHeight x m, Defer (SomeMergeInit x) m, Defer (SomeResetCoincidence x) m, HasSpiderTimeline x, m ~ EventM x) => Hold x p -> m (EventSubscription x)
960+getHoldEventSubscription :: forall p x. (HasSpiderTimeline x, Patch p) => Hold x p -> EventM x (EventSubscription x)
855getHoldEventSubscription h = do
961getHoldEventSubscription h = do
856 ep <- liftIO $ readIORef $ holdParent h
962 ep <- liftIO $ readIORef $ holdParent h
857 case ep of
963 case ep of
@@ -877,9 +983,9 @@ getHoldEventSubscription h = do
877
983
878type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
879
985
880−--type role BehaviorM representational
881-- BehaviorM can sample behaviors
986-- BehaviorM can sample behaviors
882−newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderT (BehaviorEnv x) IO a } deriving (Functor, Applicative, MonadIO, MonadFix)
987+newtype BehaviorM x a = BehaviorM { unBehaviorM :: ReaderIO (BehaviorEnv x) a }
988+ deriving (Functor, Applicative, MonadIO, MonadFix, MonadReader (BehaviorEnv x))
883
989
884instance Monad (BehaviorM x) where
990instance Monad (BehaviorM x) where
885 {-# INLINE (>>=) #-}
991 {-# INLINE (>>=) #-}
@@ -888,14 +994,16 @@ instance Monad (BehaviorM x) where
888 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
889 {-# INLINE return #-}
995 {-# INLINE return #-}
890 return x = BehaviorM $ return x
996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
891 {-# INLINE fail #-}
998 {-# INLINE fail #-}
892 fail s = BehaviorM $ fail s
999 fail s = BehaviorM $ fail s
1000+#endif
893
1001
894data BehaviorSubscribed x a
1002data BehaviorSubscribed x a
895 = forall p. BehaviorSubscribedHold (Hold x p)
1003 = forall p. BehaviorSubscribedHold (Hold x p)
896 | BehaviorSubscribedPull (PullSubscribed x a)
1004 | BehaviorSubscribedPull (PullSubscribed x a)
897
1005
898−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
899
1007
900--type role PullSubscribed representational
1008--type role PullSubscribed representational
901data PullSubscribed x a
1009data PullSubscribed x a
@@ -930,7 +1038,7 @@ data RootSubscribed x a = forall k. GCompare k => RootSubscribed
930#endif
1038#endif
931 }
1039 }
932
1040
933−data Root x (k :: * -> *)
1041+data Root x k
934 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
1042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
935 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
1043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
936 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
1044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
@@ -938,6 +1046,8 @@ data Root x (k :: * -> *)
938
1046
939data SomeHoldInit x = forall p. Patch p => SomeHoldInit !(Hold x p)
1047data SomeHoldInit x = forall p. Patch p => SomeHoldInit !(Hold x p)
940
1048
1049+data SomeDynInit x = forall p. Patch p => SomeDynInit !(Dyn x p)
1050+
941data SomeMergeUpdate x = SomeMergeUpdate
1051data SomeMergeUpdate x = SomeMergeUpdate
942 { _someMergeUpdate_update :: !(EventM x [EventSubscription x])
1052 { _someMergeUpdate_update :: !(EventM x [EventSubscription x])
943 , _someMergeUpdate_invalidateHeight :: !(IO ())
1053 , _someMergeUpdate_invalidateHeight :: !(IO ())
@@ -947,16 +1057,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
947newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
1057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
948
1058
949-- EventM can do everything BehaviorM can, plus create holds
1059-- EventM can do everything BehaviorM can, plus create holds
950−newtype EventM x a = EventM { unEventM :: 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
1060+newtype EventM x a = EventM { unEventM :: IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException)
951−
952−newtype ComputeM x a = ComputeM (ReaderT (IORef [SomeHoldInit x]) IO a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
953−
954−instance Defer (SomeHoldInit x) (ComputeM x) where
955− getDeferralQueue = ComputeM ask
956−
957−{-# INLINABLE runComputeM #-}
958−runComputeM :: Defer (SomeHoldInit x) m => ComputeM x a -> m a
959−runComputeM (ComputeM a) = liftIO . runReaderT a =<< getDeferralQueue
960
1061
961newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
1062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
962
1063
@@ -981,7 +1082,8 @@ heightBagFromList :: [Height] -> HeightBag
981heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
1082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
982
1083
983heightBagAdd :: Height -> HeightBag -> HeightBag
1084heightBagAdd :: Height -> HeightBag -> HeightBag
984−heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
1085+heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $
1086+ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
985
1087
986heightBagRemove :: Height -> HeightBag -> HeightBag
1088heightBagRemove :: Height -> HeightBag -> HeightBag
987heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
1089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -990,6 +1092,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
990 0 -> IntMap.delete h c
1092 0 -> IntMap.delete h c
991 _ -> IntMap.insert h (pred old) c
1093 _ -> IntMap.insert h (pred old) c
992
1094
1095+heightBagRemoveMaybe :: Height -> HeightBag -> Maybe HeightBag
1096+heightBagRemoveMaybe (Height h) b@(HeightBag s c) = heightBagVerify . removed <$> IntMap.lookup h c where
1097+ removed old = HeightBag (pred s) $ case old of
1098+ 0 -> IntMap.delete h c
1099+ _ -> IntMap.insert h (pred old) c
1100+
1101+
993heightBagMax :: HeightBag -> Height
1102heightBagMax :: HeightBag -> Height
994heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
1103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
995 Just ((h, _), _) -> Height h
1104 Just ((h, _), _) -> Height h
@@ -1007,25 +1116,25 @@ heightBagVerify b@(HeightBag s c) = if
1007heightBagVerify = id
1116heightBagVerify = id
1008#endif
1117#endif
1009
1118
1010−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1119+data FanSubscribedChildren x k v a = FanSubscribedChildren
1011− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1120+ { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x (v a)))
1012− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1121+ , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k v)
1013− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
1122+ , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k v)))
1014 }
1123 }
1015
1124
1016−data FanSubscribed (x :: *) k
1125+data FanSubscribed x k v
1017− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1126+ = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1018− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1127+ , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k v)))
1019− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
1128+ , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k v))) -- This DMap should never be empty
1020 , fanSubscribedParent :: !(EventSubscription x)
1129 , fanSubscribedParent :: !(EventSubscription x)
1021#ifdef DEBUG_NODEIDS
1130#ifdef DEBUG_NODEIDS
1022 , fanSubscribedNodeId :: Int
1131 , fanSubscribedNodeId :: Int
1023#endif
1132#endif
1024 }
1133 }
1025
1134
1026−data Fan x k
1135+data Fan x k v
1027− = Fan { fanParent :: !(Event x (DMap k Identity))
1136+ = Fan { fanParent :: !(Event x (DMap k v))
1028− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1137+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1029 }
1138 }
1030
1139
1031data SwitchSubscribed x a
1140data SwitchSubscribed x a
@@ -1079,20 +1188,35 @@ newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
1079newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
1080newInvalidatorPull p = return $! InvalidatorPull p
1189newInvalidatorPull p = return $! InvalidatorPull p
1081
1190
1082−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1083− fmapMaybe f = push $ return . f
1192+ mapMaybe f = push $ return . f
1084
1193
1085instance HasSpiderTimeline x => Align (Event x) where
1194instance HasSpiderTimeline x => Align (Event x) where
1086 nil = eventNever
1195 nil = eventNever
1196+#if MIN_VERSION_these(0, 8, 0)
1197+instance HasSpiderTimeline x => Semialign (Event x) where
1198+#endif
1087− align ea eb = fmapMaybe dmapToThese $ merge $ dynamicConst $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
1199+ align ea eb = mapMaybe dmapToThese $ mergeG coerce $ dynamicConst $
1200+ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1201+
1202+#ifdef MIN_VERSION_semialign
1203+#if MIN_VERSION_semialign(1,1,0)
1204+instance HasSpiderTimeline x => Zip (Event x) where
1205+#endif
1206+ zip x y = mapMaybe justThese $ align x y
1207+#endif
1208+
1209+data DynType x p = UnsafeDyn !(BehaviorM x (PatchTarget p), Event x p)
1210+ | BuildDyn !(EventM x (PatchTarget p), Event x p)
1211+ | HoldDyn !(Hold x p)
1088
1212
1089−newtype Dyn x p = Dyn { unDyn :: IORef (Either (BehaviorM x (PatchTarget p), Event x p) (Hold x p)) }
1213+newtype Dyn (x :: Type) p = Dyn { unDyn :: IORef (DynType x p) }
1090
1214
1091−newMapDyn :: HasSpiderTimeline x => (a -> b) -> Dynamic x (Identity a) -> Dynamic x (Identity b)
1215+newMapDyn :: HasSpiderTimeline x => (a -> b) -> DynamicS x (Identity a) -> DynamicS x (Identity b)
1092−newMapDyn f d = dynamicDynIdentity $ unsafeDyn (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1216+newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
1093
1217
1094--TODO: Avoid the duplication between this and R.zipDynWith
1218--TODO: Avoid the duplication between this and R.zipDynWith
1095−zipDynWith :: HasSpiderTimeline x => (a -> b -> c) -> Dynamic x (Identity a) -> Dynamic x (Identity b) -> Dynamic x (Identity c)
1219+zipDynWith :: HasSpiderTimeline x => (a -> b -> c) -> DynamicS x (Identity a) -> DynamicS x (Identity b) -> DynamicS x (Identity c)
1096zipDynWith f da db =
1220zipDynWith f da db =
1097 let eab = align (dynamicUpdated da) (dynamicUpdated db)
1221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
1098 ec = flip push eab $ \o -> do
1222 ec = flip push eab $ \o -> do
@@ -1105,19 +1229,22 @@ zipDynWith f da db =
1105 return (a, b)
1229 return (a, b)
1106 These (Identity a) (Identity b) -> return (a, b)
1230 These (Identity a) (Identity b) -> return (a, b)
1107 return $ Just $ Identity $ f a b
1231 return $ Just $ Identity $ f a b
1108− in dynamicDynIdentity $ unsafeDyn (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1232+ in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
1109
1233
1234+buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => EventM x (PatchTarget p) -> Event x p -> m (Dyn x p)
1235+buildDynamic readV0 v' = do
1236+ result <- liftIO $ newIORef $ BuildDyn (readV0, v')
1237+ let !d = Dyn result
1238+ defer $ SomeDynInit d
1239+ return d
1240+
1110−unsafeDyn :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1241+unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1111−unsafeDyn readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1242+unsafeBuildDynamic readV0 v' =
1112− where x = (readV0, v')
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
1113
1244
1114-- ResultM can read behaviors and events
1245-- ResultM can read behaviors and events
1115type ResultM = EventM
1246type ResultM = EventM
1116
1247
1117−{-# NOINLINE unsafeNewIORef #-}
1118−unsafeNewIORef :: a -> b -> IORef b
1119−unsafeNewIORef _ b = unsafePerformIO $ newIORef b
1120−
1121instance HasSpiderTimeline x => Functor (Event x) where
1248instance HasSpiderTimeline x => Functor (Event x) where
1122 fmap f = push $ return . Just . f
1249 fmap f = push $ return . Just . f
1123
1250
@@ -1130,33 +1257,42 @@ push f e = cacheEvent (pushCheap f e)
1130
1257
1131{-# INLINABLE pull #-}
1258{-# INLINABLE pull #-}
1132pull :: BehaviorM x a -> Behavior x a
1259pull :: BehaviorM x a -> Behavior x a
1133−pull a = behaviorPull $ Pull
1260+pull a = unsafePerformIO $ do
1134− { pullCompute = a
1261+ ref <- newIORef Nothing
1135− , pullValue = unsafeNewIORef a Nothing
1136#ifdef DEBUG_NODEIDS
1262#ifdef DEBUG_NODEIDS
1137− , pullNodeId = unsafeNodeId a
1263+ nid <- newNodeId
1138#endif
1264#endif
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
1139− }
1271+ }
1140
1272
1141{-# INLINABLE switch #-}
1273{-# INLINABLE switch #-}
1142switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1143−switch a = eventSwitch $ Switch
1277+ pure $ eventSwitch $ Switch
1144− { switchParent = a
1278+ { switchParent = a
1145− , switchSubscribed = unsafeNewIORef a Nothing
1279+ , switchSubscribed = ref
1146− }
1280+ }
1147
1281
1148coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1149−coincidence a = eventCoincidence $ Coincidence
1285+ pure $ eventCoincidence $ Coincidence
1150− { coincidenceParent = a
1286+ { coincidenceParent = a
1151− , coincidenceSubscribed = unsafeNewIORef a Nothing
1287+ , coincidenceSubscribed = ref
1152− }
1288+ }
1153
1289
1154-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
1155run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
1156run roots after = do
1292run roots after = do
1157 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1158− t <- SpiderHost ask
1294+ let t = spiderTimeline :: SpiderTimelineEnv x
1159− result <- SpiderHost $ lift $ withMVar (_spiderTimeline_lock t) $ \_ -> flip runReaderT t $ unSpiderHost $ runFrame $ do
1295+ result <- SpiderHost $ withMVar (_spiderTimeline_lock (unSTE t)) $ \_ -> unSpiderHost $ runFrame $ do
1160 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
1161 occBefore <- liftIO $ do
1297 occBefore <- liftIO $ do
1162 occBefore <- readIORef occRef
1298 occBefore <- readIORef occRef
@@ -1194,9 +1330,11 @@ scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
1194 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
1195 EQ -> a
1331 EQ -> a
1196
1332
1197−data SomeClear = forall a. SomeClear (IORef (Maybe a))
1333+newtype Clear a = Clear (IORef (Maybe a))
1198
1334
1199−data SomeRootClear = forall k. SomeRootClear (IORef (DMap k Identity))
1335+newtype IntClear a = IntClear (IORef (IntMap a))
1336+
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
1200
1338
1201data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
1202
1340
@@ -1208,55 +1346,110 @@ mkWeakPtrWithDebug x debugNote = do
1208 x' <- evaluate x
1346 x' <- evaluate x
1209 mkWeakPtr x' $
1347 mkWeakPtr x' $
1210 if debugFinalize
1348 if debugFinalize
1211− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
1212 else Nothing
1350 else Nothing
1213
1351
1214type WeakList a = [Weak a]
1352type WeakList a = [Weak a]
1215
1353
1216−{-# INLINE withIncreasedDepth #-}
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1355+
1356+
1357+
1358+
1217#ifdef DEBUG
1359#ifdef DEBUG
1360+
1361+debugSubscriber :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> IO (Subscriber x a)
1362+debugSubscriber description = return . debugSubscriber' description
1363+
1364+debugSubscriber' :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> Subscriber x a
1365+debugSubscriber' description subscribed = Subscriber
1366+ {
1367+ subscriberPropagate = \m -> do
1368+ tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
1369+ subscriberPropagate subscribed m
1370+ , subscriberInvalidateHeight = \old -> do
1371+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1372+ subscriberInvalidateHeight subscribed old
1373+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
1374+ , subscriberRecalculateHeight = \new -> do
1375+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1376+ subscriberRecalculateHeight subscribed new
1377+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
1378+ }
1379+
1380+
1218−withIncreasedDepth :: CanTrace x m => m a -> m a
1381+{-# INLINE withIncreasedDepth #-}
1382+withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1219−withIncreasedDepth a = do
1383+withIncreasedDepth _ a = do
1220− spiderTimeline <- askSpiderTimelineEnv
1221− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) succ
1384+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
1222 result <- a
1385 result <- a
1223− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
1224 return result
1387 return result
1225−#else
1226−withIncreasedDepth :: m a -> m a
1227−withIncreasedDepth = id
1228−#endif
1229−
1230−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1231
1388
1232{-# INLINE tracePropagate #-}
1389{-# INLINE tracePropagate #-}
1233tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1234−tracePropagate p = traceWhen p debugPropagate
1391+tracePropagate p = when debugPropagate . trace p
1235
1392
1236{-# INLINE traceInvalidate #-}
1393{-# INLINE traceInvalidate #-}
1237traceInvalidate :: String -> IO ()
1394traceInvalidate :: String -> IO ()
1238−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1395+traceInvalidate = when debugInvalidate . liftIO . debugStrLn
1396+
1397+{-# INLINE traceInvalidateHeight #-}
1398+traceInvalidateHeight :: String -> IO ()
1399+traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
1239
1400
1240−{-# INLINE traceWhen #-}
1401+{-# INLINE trace #-}
1241−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1402+trace :: (CanTrace x m) => proxy x -> String -> m ()
1242−traceWhen p b message = traceMWhen p b $ return message
1403+trace p message = traceM p $ return message
1243
1404
1244−{-# INLINE traceMWhen #-}
1405+{-# INLINE traceM #-}
1245−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1406+traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
1246−traceMWhen _ b getMessage = when b $ do
1407+traceM _ getMessage = do
1247 message <- getMessage
1408 message <- getMessage
1248−#ifdef DEBUG
1249− spiderTimeline <- askSpiderTimelineEnv
1250− d <- liftIO $ readIORef $ _spiderTimeline_depth spiderTimeline
1409+ d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1410+ liftIO $ debugStrLn $ replicate d ' ' <> message
1411+
1251#else
1412#else
1252− let d = 0
1413+
1414+{-# INLINE withIncreasedDepth #-}
1415+withIncreasedDepth :: proxy x -> m a -> m a
1416+withIncreasedDepth _ = id
1417+
1418+{-# INLINE tracePropagate #-}
1419+tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1420+tracePropagate _ _ = return ()
1421+
1422+{-# INLINE traceInvalidate #-}
1423+traceInvalidate :: String -> IO ()
1424+traceInvalidate _ = return ()
1425+
1426+{-# INLINE traceInvalidateHeight #-}
1427+traceInvalidateHeight :: String -> IO ()
1428+traceInvalidateHeight _ = return ()
1429+
1430+{-# INLINE debugSubscriber #-}
1431+debugSubscriber :: String -> Subscriber x a -> IO (Subscriber x a)
1432+debugSubscriber _ = return
1433+
1434+{-# INLINE debugSubscriber' #-}
1435+debugSubscriber' :: String -> Subscriber x a -> Subscriber x a
1436+debugSubscriber' _ = id
1437+
1438+
1439+
1440+{-# INLINE trace #-}
1441+trace :: (CanTrace x m) => proxy x -> String -> m ()
1442+trace _ _ = return ()
1443+
1444+{-# INLINE traceM #-}
1445+traceM :: (CanTrace x m) => proxy x -> m String -> m ()
1446+traceM _ _ = return ()
1447+
1253#endif
1448#endif
1254− liftIO $ putStrLn $ replicate d ' ' <> message
1255
1449
1256whoCreatedIORef :: IORef a -> IO [String]
1450whoCreatedIORef :: IORef a -> IO [String]
1257whoCreatedIORef (IORef a) = whoCreated $! a
1451whoCreatedIORef (IORef a) = whoCreated $! a
1258
1452
1259−#ifdef DEBUG_CYCLES
1260groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
1261groupByHead = \case
1454groupByHead = \case
1262 [] -> []
1455 [] -> []
@@ -1267,20 +1460,54 @@ groupByHead = \case
1267 | otherwise -> (x, xs :| []) : l
1460 | otherwise -> (x, xs :| []) : l
1268
1461
1269listsToForest :: Eq a => [[a]] -> Forest a
1462listsToForest :: Eq a => [[a]] -> Forest a
1270−listsToForest l = fmap (\(a, l') -> Node a $ listsToForest $ toList l') $ groupByHead $ catMaybes $ fmap nonEmpty l
1463+listsToForest lists = buildForest <$> groupByHead (mapMaybe nonEmpty lists)
1464+ where buildForest (a, lists') = Node a $ listsToForest $ toList lists'
1465+
1466+showStacks :: [[String]] -> String
1467+showStacks = drawForest . listsToForest . fmap (filterStack "Reflex.Spider.Internal")
1468+
1469+filterStack :: String -> [String] -> [String]
1470+#ifdef DEBUG_HIDE_INTERNALS
1471+filterStack prefix = filter (not . (prefix `isPrefixOf`))
1472+#else
1473+filterStack prefix = id
1474+#endif
1475+
1476+#ifdef DEBUG_CYCLES
1477+
1478+data EventLoopException = EventLoopException [[String]]
1479+instance Exception EventLoopException
1480+
1481+instance Show EventLoopException where
1482+ show (EventLoopException stacks) = "causality loop detected:\n" <> if null stacks
1483+ then "no location information, compile with profiling enabled for stack tree"
1484+ else showStacks stacks
1485+
1486+#else
1487+
1488+data EventLoopException = EventLoopException
1489+instance Exception EventLoopException
1490+
1491+instance Show EventLoopException where
1492+ show EventLoopException = "causality loop detected: \n" <>
1493+ "compile reflex with flag 'debug-cycles' and compile with profiling enabled for stack tree"
1494+
1271#endif
1495#endif
1272
1496
1497+
1273{-# INLINE propagateSubscriberHold #-}
1498{-# INLINE propagateSubscriberHold #-}
1274propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
1275propagateSubscriberHold h a = do
1500propagateSubscriberHold h a = do
1276− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
1277 invalidators <- liftIO $ readIORef $ holdInvalidators h
1502 invalidators <- liftIO $ readIORef $ holdInvalidators h
1278 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
1279 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
1280 case {-# SCC "apply" #-} apply a v of
1506 case {-# SCC "apply" #-} apply a v of
1281 Nothing -> return ()
1507 Nothing -> return ()
1282 Just v' -> do
1508 Just v' -> do
1283− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate (Proxy :: Proxy x) $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1509+ {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
1510+ tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
1284 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
1285 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
1286 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
1513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1288,25 +1515,25 @@ propagateSubscriberHold h a = do
1288data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
1289
1516
1290runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1291−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
1292
1519
1293askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
1294askInvalidator = do
1521askInvalidator = do
1295− (!m, _) <- BehaviorM ask
1522+ (!m, _) <- ask
1296 case m of
1523 case m of
1297 Nothing -> return Nothing
1524 Nothing -> return Nothing
1298 Just (!wi, _) -> return $ Just wi
1525 Just (!wi, _) -> return $ Just wi
1299
1526
1300askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
1301askParentsRef = do
1528askParentsRef = do
1302− (!m, _) <- BehaviorM ask
1529+ (!m, _) <- ask
1303 case m of
1530 case m of
1304 Nothing -> return Nothing
1531 Nothing -> return Nothing
1305 Just (_, !p) -> return $ Just p
1532 Just (_, !p) -> return $ Just p
1306
1533
1307askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
1308askBehaviorHoldInits = do
1535askBehaviorHoldInits = do
1309− (_, !his) <- BehaviorM ask
1536+ (_, !his) <- ask
1310 return his
1537 return his
1311
1538
1312{-# INLINE getDynHold #-}
1539{-# INLINE getDynHold #-}
@@ -1314,30 +1541,27 @@ getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
1314getDynHold d = do
1541getDynHold d = do
1315 mh <- liftIO $ readIORef $ unDyn d
1542 mh <- liftIO $ readIORef $ unDyn d
1316 case mh of
1543 case mh of
1317− Right h -> return h
1544+ HoldDyn h -> return h
1318− Left (readV0, v') -> do
1545+ UnsafeDyn (readV0, v') -> do
1319 holdInits <- getDeferralQueue
1546 holdInits <- getDeferralQueue
1320 v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1547 v0 <- liftIO $ runBehaviorM readV0 Nothing holdInits
1548+ hold' v0 v'
1549+ BuildDyn (readV0, v') -> do
1550+ v0 <- liftIO $ runEventM readV0
1551+ hold' v0 v'
1552+ where
1553+ hold' v0 v' = do
1321 h <- hold v0 v'
1554 h <- hold v0 v'
1322− liftIO $ writeIORef (unDyn d) $ Right h
1555+ liftIO $ writeIORef (unDyn d) $ HoldDyn h
1323 return h
1556 return h
1324
1557
1558+
1325-- Always refers to 0
1559-- Always refers to 0
1326{-# NOINLINE zeroRef #-}
1560{-# NOINLINE zeroRef #-}
1327zeroRef :: IORef Height
1561zeroRef :: IORef Height
1328zeroRef = unsafePerformIO $ newIORef zeroHeight
1562zeroRef = unsafePerformIO $ newIORef zeroHeight
1329
1563
1330−type CanSubscribe x m =
1564+getRootSubscribed :: forall k x a. (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
1331− ( HasSpiderTimeline x
1332− , HasCurrentHeight x m
1333− , Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m -- The things we need to lazily initialize state
1334− , Defer SomeClear m -- Wiping out event firings
1335− , Defer (SomeAssignment x) m -- Updating state
1336− , Defer (SomeResetCoincidence x) m
1337− , m ~ EventM x
1338− )
1339−
1340−getRootSubscribed :: GCompare k => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
1341getRootSubscribed k r sub = do
1565getRootSubscribed k r sub = do
1342 mSubscribed <- readIORef $ rootSubscribed r
1566 mSubscribed <- readIORef $ rootSubscribed r
1343 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
1567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1351,10 +1575,15 @@ getRootSubscribed k r sub = do
1351 let !cached = rootSubscribed r
1575 let !cached = rootSubscribed r
1352 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
1353 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1354− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1578+
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
1355 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
1356 writeIORef uninitRef $! uninit
1582 writeIORef uninitRef $! uninit
1357− let subscribed = RootSubscribed
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
1586+ let !subscribed = RootSubscribed
1358 { rootSubscribedKey = k
1587 { rootSubscribedKey = k
1359 , rootSubscribedCachedSubscribed = cached
1588 , rootSubscribedCachedSubscribed = cached
1360 , rootSubscribedOccurrence = getOcc
1589 , rootSubscribedOccurrence = getOcc
@@ -1362,10 +1591,20 @@ getRootSubscribed k r sub = do
1362 , rootSubscribedUninit = uninit
1591 , rootSubscribedUninit = uninit
1363 , rootSubscribedWeakSelf = weakSelf
1592 , rootSubscribedWeakSelf = weakSelf
1364#ifdef DEBUG_NODEIDS
1593#ifdef DEBUG_NODEIDS
1365− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1594+ , rootSubscribedNodeId = nid
1366#endif
1595#endif
1367 }
1596 }
1368− writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "RootSubscribed"
1597+ -- If we die at the same moment that all our children die, they will
1598+ -- try to clean us up but will fail because their Weak reference to us
1599+ -- will also be dead. So, if we are dying, check if there are any
1600+ -- children; since children don't bother cleaning themselves up if
1601+ -- their parents are already dead, I don't think there's a race
1602+ -- condition here. However, if there are any children, then we can
1603+ -- infer that we need to clean ourselves up, so we do.
1604+ finalCleanup = do
1605+ cs <- readIORef $ _weakBag_children subs
1606+ when (not $ IntMap.null cs) (cleanupRootSubscribed subscribed)
1607+ writeIORef weakSelf =<< evaluate =<< mkWeakPtr subscribed (Just finalCleanup)
1369 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
1608 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
1370 occ <- getOcc
1609 occ <- getOcc
1371 return (sln, subscribed, occ)
1610 return (sln, subscribed, occ)
@@ -1382,8 +1621,90 @@ cleanupRootSubscribed self@RootSubscribed { rootSubscribedKey = k, rootSubscribe
1382subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1621subscribeRootSubscribed :: RootSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1383subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1622subscribeRootSubscribed subscribed sub = WeakBag.insert sub (rootSubscribedSubscribers subscribed) (rootSubscribedWeakSelf subscribed) cleanupRootSubscribed
1384
1623
1624+newtype EventSelectorInt x a = EventSelectorInt { selectInt :: Int -> Event x a }
1625+
1626+data FanInt x a = FanInt
1627+ { _fanInt_subscribers :: {-# UNPACK #-} !(FastMutableIntMap (FastWeakBag (Subscriber x a))) --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1628+ , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
1629+ , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1630+#ifdef DEBUG_NODEIDS
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1632+#endif
1633+ }
1634+
1635+newFanInt :: IO (FanInt x a)
1636+newFanInt = do
1637+ subscribers <- FastMutableIntMap.newEmpty --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
1638+ subscriptionRef <- newIORef $ error "fanInt: no subscription"
1639+ occRef <- newIORef $ error "fanInt: no occurrence"
1640+#ifdef DEBUG_NODEIDS
1641+ nodeId <- newNodeId
1642+#endif
1643+ return $ FanInt
1644+ { _fanInt_subscribers = subscribers
1645+ , _fanInt_subscriptionRef = subscriptionRef
1646+ , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
1650+ }
1651+
1652+fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1653+fanInt p = unsafePerformIO $ do
1654+ self <- newFanInt
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
1656+ isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
1657+ when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
1660+ { subscriberPropagate = \m -> do
1661+ liftIO $ writeIORef (_fanInt_occRef self) m
1662+ scheduleIntClear $ _fanInt_occRef self
1663+ FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> --TODO: Do we need to know that no subscribers are being added as we traverse?
1664+ FastWeakBag.traverse_ b $ \s ->
1665+ subscriberPropagate s v
1666+ , subscriberInvalidateHeight = \old ->
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1668+ FastWeakBag.traverse_ b $ \s ->
1669+ subscriberInvalidateHeight s old
1670+ , subscriberRecalculateHeight = \new ->
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1672+ FastWeakBag.traverse_ b $ \s ->
1673+ subscriberRecalculateHeight s new
1674+ }
1675+ liftIO $ do
1676+ writeIORef (_fanInt_subscriptionRef self) subscription
1677+ writeIORef (_fanInt_occRef self) $ fromMaybe IntMap.empty parentOcc
1678+ scheduleIntClear $ _fanInt_occRef self
1679+ liftIO $ do
1680+ b <- FastMutableIntMap.lookup (_fanInt_subscribers self) k >>= \case
1681+ Nothing -> do
1682+ b <- FastWeakBag.empty
1683+ FastMutableIntMap.insert (_fanInt_subscribers self) k b
1684+ return b
1685+ Just b -> return b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
1687+ currentOcc <- readIORef (_fanInt_occRef self)
1688+
1689+ subscribed <- fanIntSubscribed ticket self
1690+ return (EventSubscription (FastWeakBag.remove ticket) subscribed, IntMap.lookup k currentOcc)
1691+
1692+fanIntSubscribed :: FastWeakBagTicket k -> FanInt x a -> IO (EventSubscribed x)
1693+fanIntSubscribed ticket self = do
1694+ subscribedParent <- _eventSubscription_subscribed <$> readIORef (_fanInt_subscriptionRef self)
1695+ return $ EventSubscribed
1696+ { eventSubscribedHeightRef = eventSubscribedHeightRef subscribedParent
1697+ , eventSubscribedRetained = toAny (_fanInt_subscriptionRef self, ticket)
1698+#ifdef DEBUG_CYCLES
1699+ , eventSubscribedGetParents = return [subscribedParent]
1700+ , eventSubscribedHasOwnHeightRef = False
1701+ , eventSubscribedWhoCreated = whoCreatedIORef $ _fanInt_subscriptionRef self
1702+#endif
1703+ }
1704+
1705+
1385{-# INLINABLE getFanSubscribed #-}
1706{-# INLINABLE getFanSubscribed #-}
1386−getFanSubscribed :: (Defer (SomeAssignment x) m, Defer (SomeHoldInit x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, HasCurrentHeight x m, Defer (SomeResetCoincidence x) m, HasSpiderTimeline x, m ~ EventM x, GCompare k) => k a -> Fan x k -> Subscriber x a -> m (WeakBagTicket, FanSubscribed x k, Maybe a)
1707+getFanSubscribed :: (HasSpiderTimeline x, GCompare k) => k a -> Fan x k v -> Subscriber x (v a) -> EventM x (WeakBagTicket, FanSubscribed x k v, Maybe (v a))
1387getFanSubscribed k f sub = do
1708getFanSubscribed k f sub = do
1388 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
1389 case mSubscribed of
1710 case mSubscribed of
@@ -1401,13 +1722,16 @@ getFanSubscribed k f sub = do
1401 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
1402 occRef <- liftIO $ newIORef parentOcc
1723 occRef <- liftIO $ newIORef parentOcc
1403 when (isJust parentOcc) $ scheduleClear occRef
1724 when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
1404 let subscribed = FanSubscribed
1728 let subscribed = FanSubscribed
1405 { fanSubscribedCachedSubscribed = fanSubscribed f
1729 { fanSubscribedCachedSubscribed = fanSubscribed f
1406 , fanSubscribedOccurrence = occRef
1730 , fanSubscribedOccurrence = occRef
1407 , fanSubscribedParent = subscription
1731 , fanSubscribedParent = subscription
1408 , fanSubscribedSubscribers = subscribersRef
1732 , fanSubscribedSubscribers = subscribersRef
1409#ifdef DEBUG_NODEIDS
1733#ifdef DEBUG_NODEIDS
1410− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
1411#endif
1735#endif
1412 }
1736 }
1413 let !self = (k, subscribed)
1737 let !self = (k, subscribed)
@@ -1417,7 +1741,7 @@ getFanSubscribed k f sub = do
1417 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
1418 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
1419
1743
1420−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
1421cleanupFanSubscribed (k, subscribed) = do
1745cleanupFanSubscribed (k, subscribed) = do
1422 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1423 let reducedSubscribers = DMap.delete k subscribers
1747 let reducedSubscribers = DMap.delete k subscribers
@@ -1429,7 +1753,7 @@ cleanupFanSubscribed (k, subscribed) = do
1429 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
1430
1754
1431{-# INLINE subscribeFanSubscribed #-}
1755{-# INLINE subscribeFanSubscribed #-}
1432−subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k -> Subscriber x a -> IO WeakBagTicket
1756+subscribeFanSubscribed :: GCompare k => k a -> FanSubscribed x k v -> Subscriber x (v a) -> IO WeakBagTicket
1433subscribeFanSubscribed k subscribed sub = do
1757subscribeFanSubscribed k subscribed sub = do
1434 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
1435 case DMap.lookup k subscribers of
1759 case DMap.lookup k subscribers of
@@ -1442,7 +1766,7 @@ subscribeFanSubscribed k subscribed sub = do
1442 Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1766 Just (FanSubscribedChildren list _ weakSelf) -> {-# SCC "hitSubscribeFanSubscribed" #-} WeakBag.insert sub list weakSelf cleanupFanSubscribed
1443
1767
1444{-# INLINABLE getSwitchSubscribed #-}
1768{-# INLINABLE getSwitchSubscribed #-}
1445−getSwitchSubscribed :: (Defer (SomeHoldInit x) m, Defer (SomeAssignment x) m, Defer (SomeMergeInit x) m, Defer SomeClear m, Defer (SomeResetCoincidence x) m, HasCurrentHeight x m, HasSpiderTimeline x, m ~ EventM x) => Switch x a -> Subscriber x a -> m (WeakBagTicket, SwitchSubscribed x a, Maybe a)
1769+getSwitchSubscribed :: HasSpiderTimeline x => Switch x a -> Subscriber x a -> EventM x (WeakBagTicket, SwitchSubscribed x a, Maybe a)
1446getSwitchSubscribed s sub = do
1770getSwitchSubscribed s sub = do
1447 mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1771 mSubscribed <- liftIO $ readIORef $ switchSubscribed s
1448 case mSubscribed of
1772 case mSubscribed of
@@ -1467,6 +1791,9 @@ getSwitchSubscribed s sub = do
1467 when (isJust parentOcc) $ scheduleClear occRef
1791 when (isJust parentOcc) $ scheduleClear occRef
1468 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
1469 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
1470 let !subscribed = SwitchSubscribed
1797 let !subscribed = SwitchSubscribed
1471 { switchSubscribedCachedSubscribed = switchSubscribed s
1798 { switchSubscribedCachedSubscribed = switchSubscribed s
1472 , switchSubscribedOccurrence = occRef
1799 , switchSubscribedOccurrence = occRef
@@ -1479,7 +1806,7 @@ getSwitchSubscribed s sub = do
1479 , switchSubscribedCurrentParent = subscriptionRef
1806 , switchSubscribedCurrentParent = subscriptionRef
1480 , switchSubscribedWeakSelf = weakSelf
1807 , switchSubscribedWeakSelf = weakSelf
1481#ifdef DEBUG_NODEIDS
1808#ifdef DEBUG_NODEIDS
1482− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
1483#endif
1810#endif
1484 }
1811 }
1485 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
1812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
@@ -1498,7 +1825,7 @@ subscribeSwitchSubscribed :: SwitchSubscribed x a -> Subscriber x a -> IO WeakBa
1498subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1825subscribeSwitchSubscribed subscribed sub = WeakBag.insert sub (switchSubscribedSubscribers subscribed) (switchSubscribedWeakSelf subscribed) cleanupSwitchSubscribed
1499
1826
1500{-# INLINABLE getCoincidenceSubscribed #-}
1827{-# INLINABLE getCoincidenceSubscribed #-}
1501−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, HasSpiderTimeline x, m ~ EventM x) => Coincidence x a -> Subscriber x a -> m (WeakBagTicket, CoincidenceSubscribed x a, Maybe a)
1828+getCoincidenceSubscribed :: forall x a. HasSpiderTimeline x => Coincidence x a -> Subscriber x a -> EventM x (WeakBagTicket, CoincidenceSubscribed x a, Maybe a)
1502getCoincidenceSubscribed c sub = do
1829getCoincidenceSubscribed c sub = do
1503 mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1830 mSubscribed <- liftIO $ readIORef $ coincidenceSubscribed c
1504 case mSubscribed of
1831 case mSubscribed of
@@ -1524,6 +1851,9 @@ getCoincidenceSubscribed c sub = do
1524 scheduleClear innerSubdRef
1851 scheduleClear innerSubdRef
1525 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
1526 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
1527 let subscribed = CoincidenceSubscribed
1857 let subscribed = CoincidenceSubscribed
1528 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
1529 , coincidenceSubscribedOccurrence = occRef
1859 , coincidenceSubscribedOccurrence = occRef
@@ -1534,7 +1864,7 @@ getCoincidenceSubscribed c sub = do
1534 , coincidenceSubscribedInnerParent = innerSubdRef
1864 , coincidenceSubscribedInnerParent = innerSubdRef
1535 , coincidenceSubscribedWeakSelf = weakSelf
1865 , coincidenceSubscribedWeakSelf = weakSelf
1536#ifdef DEBUG_NODEIDS
1866#ifdef DEBUG_NODEIDS
1537− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
1538#endif
1868#endif
1539 }
1869 }
1540 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
1870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
@@ -1551,189 +1881,259 @@ cleanupCoincidenceSubscribed subscribed = do
1551subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
1552subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
1553
1883
1554−{-# INLINE merge #-}
1884+{-# INLINE mergeG #-}
1555−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1885+mergeG :: forall k q x v. (HasSpiderTimeline x, GCompare k)
1556−merge d = cacheEvent (mergeCheap d)
1886+ => (forall a. q a -> Event x (v a))
1887+ -> DynamicS x (PatchDMap k q) -> Event x (DMap k v)
1888+mergeG nt d = cacheEvent (mergeCheap nt d)
1557
1889
1558{-# INLINE mergeWithMove #-}
1890{-# INLINE mergeWithMove #-}
1559−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1891+mergeWithMove :: forall k v q x. (HasSpiderTimeline x, GCompare k)
1560−mergeWithMove d = cacheEvent (mergeCheapWithMove d)
1892+ => (forall a. q a -> Event x (v a))
1893+ -> DynamicS x (PatchDMapWithMove k q) -> Event x (DMap k v)
1894+mergeWithMove nt d = cacheEvent (mergeCheapWithMove nt d)
1561
1895
1562{-# INLINE [1] mergeCheap #-}
1896{-# INLINE [1] mergeCheap #-}
1563−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1897+mergeCheap
1564−mergeCheap = mergeCheap' getInitialSubscribers updateMe destroy DMap.size
1898+ :: forall k x q v. (HasSpiderTimeline x, GCompare k)
1899+ => (forall a. q a -> Event x (v a))
1900+ -> DynamicS x (PatchDMap k q)
1901+ -> Event x (DMap k v)
1902+mergeCheap nt = mergeGCheap' unMergeSubscribedParent getInitialSubscribers updateMe destroy
1565 where
1903 where
1566− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
1567 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
1568 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
1569 (mOldSubd, newPs) <- case me of
1907 (mOldSubd, newPs) <- case me of
1570 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1571 Just e -> do
1909 Just e -> do
1572 let s = subscriber $ return k
1910 let s = subscriber $ return k
1573− subscription@(EventSubscription _ subd) <- subscribe e s
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
1574 newParentHeight <- liftIO $ getEventSubscribedHeight subd
1912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
1575 let newParent = MergeSubscribedParent subscription
1913 let newParent = MergeSubscribedParent subscription
1576 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1577 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1578 forM_ mOldSubd $ \oldSubd -> do
1916 forM_ mOldSubd $ \oldSubd -> do
1579− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
1580 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1581 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
1582 foldM f ([], oldParents) $ DMap.toList p
1922 foldM f ([], oldParents) $ DMap.toList p
1583− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1923+
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
1584 getInitialSubscribers initialParents subscriber = do
1925 getInitialSubscribers initialParents subscriber = do
1585 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1586 let s = subscriber $ return k
1927 let s = subscriber $ return k
1587− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1588 height <- liftIO $ getEventSubscribedHeight parentSubd
1929 height <- liftIO $ getEventSubscribedHeight parentSubd
1589− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription)
1930+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParent subscription)
1590 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1591 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1592 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1593 )
1934 )
1935+
1594 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
1595 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
1596
1938
1597{-# INLINE [1] mergeCheapWithMove #-}
1939{-# INLINE [1] mergeCheapWithMove #-}
1598−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1940+mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
1599−mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy DMap.size
1941+ => (forall a. q a -> Event x (v a))
1942+ -> DynamicS x (PatchDMapWithMove k q)
1943+ -> Event x (DMap k v)
1944+mergeCheapWithMove nt = mergeGCheap' _mergeSubscribedParentWithMove_subscription getInitialSubscribers updateMe destroy
1600 where
1945 where
1601− updateMe :: MergeUpdateFunc k x (PatchDMapWithMove k (Event x)) (MergeSubscribedParentWithMove x k)
1946+ updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
1602− updateMe subscriber heightBagRef oldParents pWrapped = do
1947+ updateMe subscriber heightBagRef oldParents p = do
1603− let p = unPatchDMapWithMove pWrapped
1948+ -- Prepare new parents for insertion
1604− let f (subscriptionsToKill, ps) (k :=> edit) = do
1949+ let subscribeParent :: forall a. k a -> Event x (v a) -> EventM x (MergeSubscribedParentWithMove x k a)
1605− let deleteHere = return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
1950+ subscribeParent k e = do
1606− insertHere e = do
1951+ keyRef <- liftIO $ newIORef k
1607− keyRef <- liftIO $ newIORef k
1952+ let s = subscriber $ liftIO $ readIORef keyRef
1608− let s = subscriber $ liftIO $ readIORef keyRef
1953+ subscription@(EventSubscription _ subd) <- subscribe e s
1609− subscription@(EventSubscription _ subd) <- subscribe e s
1954+ liftIO $ do
1610− liftIO $ do
1955+ newParentHeight <- getEventSubscribedHeight subd
1611− newParentHeight <- getEventSubscribedHeight subd
1956+ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1612− let newParent = MergeSubscribedParentWithMove subscription keyRef
1957+ return $ MergeSubscribedParentWithMove subscription keyRef
1613− modifyIORef' heightBagRef $ heightBagAdd newParentHeight
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
1614− return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
1959+ -- Collect old parents for deletion and update the keys of moved parents
1615− (mOldSubd, newPs) <- case edit of
1960+ let moveOrDelete :: forall a. k a -> PatchDMapWithMove.NodeInfo k q a -> MergeSubscribedParentWithMove x k a -> Constant (EventM x (Maybe (EventSubscription x))) a
1616− DMapEdit_Delete moved -> do
1961+ moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
1617− (toDelete, newPs) <- deleteHere
1962+ Nothing -> do
1618− return (if moved then Nothing else toDelete, newPs)
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1619− DMapEdit_Insert moved e -> do
1964+ _mergeSubscribedParentWithMove_subscription parent
1620− (toDelete, newPs) <- insertHere e
1965+
1621− return (if moved then Nothing else toDelete, newPs)
1622− DMapEdit_Move moved sourceKey -> do
1623− (toDelete, newPs) <- case DMap.lookup sourceKey ps of
1624− Nothing -> deleteHere
1625− Just s@(MergeSubscribedParentWithMove _ keyRef) -> do
1626− liftIO $ writeIORef keyRef k
1627− return $ DMap.insertLookupWithKey' (\_ new _ -> new) k s ps
1628− return (if moved then Nothing else toDelete, newPs)
1629− forM_ mOldSubd $ \oldSubd -> do
1630− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription oldSubd
1631 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
1632− return (maybeToList (_mergeSubscribedParentWithMove_subscription <$> mOldSubd) ++ subscriptionsToKill, newPs)
1967+ return $ Just $ _mergeSubscribedParentWithMove_subscription parent
1633− foldM f ([], oldParents) $ DMap.toList p
1968+ Just toKey -> do
1634− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1969+ liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
1970+ return Nothing
1971+ toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1972+ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1973+
1974+ return (toDelete, applyAlways p' oldParents)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
1635 getInitialSubscribers initialParents subscriber = do
1976 getInitialSubscribers initialParents subscriber = do
1636 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
1637 keyRef <- liftIO $ newIORef k
1978 keyRef <- liftIO $ newIORef k
1638 let s = subscriber $ liftIO $ readIORef keyRef
1979 let s = subscriber $ liftIO $ readIORef keyRef
1639− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
1640 height <- liftIO $ getEventSubscribedHeight parentSubd
1981 height <- liftIO $ getEventSubscribedHeight parentSubd
1641− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1982+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1642 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
1643 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
1644 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
1645 )
1986 )
1987+
1646 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
1647 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
1648
1990
1649−type MergeUpdateFunc k x p s
1991+type MergeUpdateFunc k v x p s
1650− = (forall a. EventM x (k a) -> Subscriber x a)
1992+ = (forall a. EventM x (k a) -> Subscriber x (v a))
1651 -> IORef HeightBag
1993 -> IORef HeightBag
1652 -> DMap k s
1994 -> DMap k s
1653 -> p
1995 -> p
1654 -> EventM x ([EventSubscription x], DMap k s)
1996 -> EventM x ([EventSubscription x], DMap k s)
1655
1997
1656−type MergeInitFunc k x s
1998+type MergeGetSubscription x s = forall a. s a -> EventSubscription x
1657− = DMap k (Event x)
1999+
1658− -> (forall a. EventM x (k a) -> Subscriber x a)
2000+type MergeInitFunc k v q x s
1659− -> EventM x (DMap k Identity, [Height], DMap k s)
2001+ = DMap k q
2002+ -> (forall a. EventM x (k a) -> Subscriber x (v a))
2003+ -> EventM x (DMap k v, [Height], DMap k s)
1660
2004
1661type MergeDestroyFunc k s
2005type MergeDestroyFunc k s
1662 = DMap k s
2006 = DMap k s
1663 -> IO ()
2007 -> IO ()
1664
2008
1665−{-# INLINE mergeCheap' #-}
2009+data Merge x k v s = Merge
1666−mergeCheap' :: forall k x p s. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k (Event x)) => MergeInitFunc k x s -> MergeUpdateFunc k x p s -> MergeDestroyFunc k s -> (DMap k s -> Int) -> Dynamic x p -> Event x (DMap k Identity)
2010+ { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
1667−mergeCheap' getInitialSubscribers updateFunc destroy numParents d = Event $ \sub -> do
2011+ , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
2012+ , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
2015+ }
2016+
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
2018+invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
2019+
2020+invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
2021+invalidateMergeHeight' heightRef sub = do
2022+ oldHeight <- readIORef heightRef
2023+ -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
2024+ when (oldHeight /= invalidHeight) $ do
2025+ writeIORef heightRef $! invalidHeight
2026+ subscriberInvalidateHeight sub oldHeight
2027+
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
2029+revalidateMergeHeight m = do
2030+ currentHeight <- readIORef $ _merge_heightRef m
2031+
2032+ -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2033+ when (currentHeight == invalidHeight) $ do
2034+ heights <- readIORef $ _merge_heightBagRef m
2035+ parents <- readIORef $ _merge_parentsRef m
2036+ -- When the number of heights in the bag reaches the number of parents, we should have a valid height
2037+ case heightBagSize heights `compare` DMap.size parents of
2038+ LT -> return ()
2039+ EQ -> do
2040+ let height = succHeight $ heightBagMax heights
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
2042+ writeIORef (_merge_heightRef m) $! height
2043+ subscriberRecalculateHeight (_merge_sub m) height
2044+ GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
2045+
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
2047+scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
2048+ vals <- liftIO $ readIORef $ _merge_accumRef m
2049+ -- Once we're done with this, we can clear it immediately, because if there's a cacheEvent in front of us,
2050+ -- it'll handle subsequent subscribers, and if not, we won't get subsequent subscribers
2051+ liftIO $ writeIORef (_merge_accumRef m) $! DMap.empty
2052+ --TODO: Assert that m is not empty
2053+ subscriberPropagate (_merge_sub m) vals
2054+
2055+checkCycle :: HasSpiderTimeline x => EventSubscribed x -> EventM x ()
2056+checkCycle subscribed = liftIO $ do
2057+ height <- readIORef (eventSubscribedHeightRef subscribed)
2058+
2059+ -- currentHeight <- getCurrentHeight
2060+ -- when (height <= currentHeight) $ if height /= invalidHeight
2061+ -- then do
2062+ -- myStack <- liftIO $ whoCreatedIORef undefined --TODO
2063+ -- error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
2064+ -- else liftIO $
2065+ when (height == invalidHeight) $
2066+#ifdef DEBUG_CYCLES
2067+ do
2068+ nodesInvolvedInCycle <- walkInvalidHeightParents subscribed
2069+ stacks <- forM nodesInvolvedInCycle whoCreatedEventSubscribed
2070+ throwIO (EventLoopException stacks)
2071+#else
2072+ throwIO EventLoopException
2073+#endif
2074+
2075+
2076+mergeSubscriber :: forall x k v s a. (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> EventM x (k a) -> Subscriber x (v a)
2077+mergeSubscriber subscribed m getKey = Subscriber
2078+ { subscriberPropagate = \a -> do
2079+ oldM <- liftIO $ readIORef $ _merge_accumRef m
2080+ k <- getKey
2081+ let newM = DMap.insertWith (error "Same key fired multiple times for Merge") k a oldM
2082+ tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
2083+ liftIO $ writeIORef (_merge_accumRef m) $! newM
2084+ when (DMap.null oldM) $ do -- Only schedule the firing once
2085+ height <- liftIO $ readIORef $ _merge_heightRef m
2086+ checkCycle subscribed
2087+
2088+ scheduleMergeSelf m height
2089+ , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
2090+ modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
2091+ invalidateMergeHeight m
2092+ , subscriberRecalculateHeight = \new -> do
2093+ modifyIORef' (_merge_heightBagRef m) $ heightBagAdd new
2094+ revalidateMergeHeight m
2095+ }
2096+
2097+--TODO: Be able to run as much of this as possible promptly
2098+updateMerge :: (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
2099+updateMerge subscribed m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
2100+ where updateMe = do
2101+ oldParents <- liftIO $ readIORef $ _merge_parentsRef m
2102+ (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
2103+ liftIO $ writeIORef (_merge_parentsRef m) $! newParents
2104+ return subscriptionsToKill
2105+
2106+{-# INLINE mergeGCheap' #-}
2107+mergeGCheap' :: forall k v x p s q. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k q)
2108+ => MergeGetSubscription x s -> MergeInitFunc k v q x s -> MergeUpdateFunc k v x p s -> MergeDestroyFunc k s -> DynamicS x p -> Event x (DMap k v)
2109+mergeGCheap' getParent getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
1668 initialParents <- readBehaviorUntracked $ dynamicCurrent d
2110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
1669 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
2111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
1670 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
2112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
1671 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
2113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
1672 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
2114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1673− let scheduleSelf height = scheduleMerge' height heightRef $ do
2115+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1674− m <- liftIO $ readIORef accumRef
2116+
1675− liftIO $ writeIORef accumRef $! DMap.empty
2117+ let subscribed = EventSubscribed
1676− --TODO: Assert that m is not empty
2118+ { eventSubscribedHeightRef = heightRef
1677− subscriberPropagate sub m
2119+ , eventSubscribedRetained = toAny (parentsRef, changeSubdRef)
1678− invalidateMyHeight = do
1679− oldHeight <- readIORef heightRef
1680− when (oldHeight /= invalidHeight) $ do -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
1681− writeIORef heightRef $! invalidHeight
1682− subscriberInvalidateHeight sub oldHeight
1683− revalidateMyHeight = do
1684− currentHeight <- readIORef heightRef
1685− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
1686− heights <- readIORef heightBagRef
1687− parents <- readIORef parentsRef
1688− -- When the number of heights in the bag reaches the number of parents, we should have a valid height
1689− case heightBagSize heights `compare` numParents parents of
1690− LT -> return ()
1691− EQ -> do
1692− let height = succHeight $ heightBagMax heights
1693− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
1694− writeIORef heightRef $! height
1695− subscriberRecalculateHeight sub height
1696− GT -> error $ "revalidateMergeHeight: more heights than parents for Merge"
1697− subscriber :: forall a. EventM x (k a) -> Subscriber x a
1698− subscriber getKey = Subscriber
1699− { subscriberPropagate = \a -> do
1700− oldM <- liftIO $ readIORef accumRef
1701− k <- getKey
1702− let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge") k (Identity a) oldM
1703− tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
1704− liftIO $ writeIORef accumRef $! newM
1705− when (DMap.null oldM) $ do -- Only schedule the firing once
1706− height <- liftIO $ readIORef heightRef
1707− --TODO: assertions about height
1708− currentHeight <- getCurrentHeight
1709− when (height <= currentHeight) $ do
1710− if height /= invalidHeight
1711− then do
1712− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1713− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1714− else liftIO $ do
1715#ifdef DEBUG_CYCLES
2120#ifdef DEBUG_CYCLES
1716− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
2121+ , eventSubscribedGetParents = do
1717− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
2122+ let getParent' (_ :=> v) = _eventSubscription_subscribed (getParent v)
1718− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
2123+ fmap getParent' . DMap.toList <$> readIORef parentsRef
1719−#else
2124+ , eventSubscribedHasOwnHeightRef = False
1720− let cycleInfo = ""
2125+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
1721#endif
2126#endif
1722− error $ "Causality loop found" <> cycleInfo
2127+ }
1723− scheduleSelf height
2128+
1724− , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
2129+ m = Merge
1725− modifyIORef' heightBagRef $ heightBagRemove old
2130+ { _merge_parentsRef = parentsRef
1726− invalidateMyHeight
2131+ , _merge_heightBagRef = heightBagRef
1727− , subscriberRecalculateHeight = \new -> do
2132+ , _merge_heightRef = heightRef
1728− modifyIORef' heightBagRef $ heightBagAdd new
2133+ , _merge_sub = sub
1729− revalidateMyHeight
2134+ , _merge_accumRef = accumRef
1730 }
2135 }
1731− let updateMe x = do
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
1732− oldParents <- liftIO $ readIORef parentsRef
1733− (subscriptionsToKill, newParents) <- updateFunc subscriber heightBagRef oldParents x
1734− liftIO $ writeIORef parentsRef $! newParents
1735− return subscriptionsToKill
1736− (dm, heights, initialParentState) <- getInitialSubscribers initialParents subscriber
1737 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
2137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
1738 myHeight = if invalidHeight `elem` heights
2138 myHeight = if invalidHeight `elem` heights
1739 then invalidHeight
2139 then invalidHeight
@@ -1742,114 +2142,236 @@ mergeCheap' getInitialSubscribers updateFunc destroy numParents d = Event $ \sub
1742 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
2142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
1743 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
2143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
1744 else (Nothing, dm)
2144 else (Nothing, dm)
1745− unless (DMap.null accum) $ do
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
1746− scheduleSelf myHeight
1747− occRef <- liftIO $ newIORef occ
1748− when (isJust occ) $ scheduleClear occRef
1749 liftIO $ writeIORef accumRef $! accum
2146 liftIO $ writeIORef accumRef $! accum
1750 liftIO $ writeIORef heightRef $! myHeight
2147 liftIO $ writeIORef heightRef $! myHeight
1751 liftIO $ writeIORef heightBagRef $! myHeightBag
2148 liftIO $ writeIORef heightBagRef $! myHeightBag
1752− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
1753 liftIO $ writeIORef parentsRef $! initialParentState
2149 liftIO $ writeIORef parentsRef $! initialParentState
1754 defer $ SomeMergeInit $ do
2150 defer $ SomeMergeInit $ do
1755− let s = Subscriber
2151+ let changeSubscriber = Subscriber
1756 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1757− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
1758− defer $ SomeMergeUpdate (updateMe a) invalidateMyHeight revalidateMyHeight
2154+ defer $ updateMerge subscribed m updateFunc a
1759 , subscriberInvalidateHeight = \_ -> return ()
2155 , subscriberInvalidateHeight = \_ -> return ()
1760 , subscriberRecalculateHeight = \_ -> return ()
2156 , subscriberRecalculateHeight = \_ -> return ()
1761 }
2157 }
1762− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2158+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
1763− forM_ change $ \c -> defer $ SomeMergeUpdate (updateMe c) invalidateMyHeight revalidateMyHeight
2159+ forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
1764 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
1765 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
1766 -- its subscription.
2162 -- its subscription.
1767− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
1768 let unsubscribeAll = destroy =<< readIORef parentsRef
2164 let unsubscribeAll = destroy =<< readIORef parentsRef
1769− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
2165+
1770− , occ
2166+ return (EventSubscription unsubscribeAll subscribed, occ)
1771− )
2167+
2168+
2169+mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2170+mergeInt = cacheEvent . mergeIntCheap
2171+
2172+{-# INLINABLE mergeIntCheap #-}
2173+mergeIntCheap :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2174+mergeIntCheap d = Event $ \sub -> do
2175+ initialParents <- readBehaviorUntracked $ dynamicCurrent d
2176+ accum <- liftIO $ FastMutableIntMap.newEmpty
2177+ heightRef <- liftIO $ newIORef zeroHeight
2178+ heightBagRef <- liftIO $ newIORef heightBagEmpty
2179+ parents <- liftIO $ FastMutableIntMap.newEmpty
2180+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2181+ let subscribed = EventSubscribed
2182+ { eventSubscribedHeightRef = heightRef
2183+ , eventSubscribedRetained = toAny (parents, changeSubdRef)
2184+#ifdef DEBUG_CYCLES
2185+ , eventSubscribedGetParents = fmap (_eventSubscription_subscribed . snd) <$> FastMutableIntMap.toList parents
2186+ , eventSubscribedHasOwnHeightRef = False
2187+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2188+#endif
2189+ }
2190+ let scheduleSelf = do
2191+ height <- liftIO $ readIORef $ heightRef
2192+ scheduleMerge' height heightRef $ do
2193+ vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
2194+ subscriberPropagate sub vals
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
2196+ recalculateMyHeight = do
2197+ currentHeight <- readIORef heightRef
2198+ when (currentHeight == invalidHeight) $ do --TODO: This will almost always be true; can we get rid of this check and just proceed to the next one always?
2199+ heights <- readIORef heightBagRef
2200+ numParents <- FastMutableIntMap.size parents
2201+ case heightBagSize heights `compare` numParents of
2202+ LT -> return ()
2203+ EQ -> do
2204+ let height = succHeight $ heightBagMax heights
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
2206+ writeIORef heightRef $! height
2207+ subscriberRecalculateHeight sub height
2208+ GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
2209+ mySubscriber k = Subscriber
2210+ { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
2213+ wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2214+ liftIO $ FastMutableIntMap.insert accum k a
2215+ when wasEmpty scheduleSelf
2216+ , subscriberInvalidateHeight = \old -> do
2217+ modifyIORef' heightBagRef $ heightBagRemove old
2218+ invalidateMyHeight
2219+ , subscriberRecalculateHeight = \new -> do
2220+ modifyIORef' heightBagRef $ heightBagAdd new
2221+ recalculateMyHeight
2222+ }
2223+ forM_ (IntMap.toList initialParents) $ \(k, p) -> do
2224+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead p $ mySubscriber k
2225+ liftIO $ do
2226+ forM_ parentOcc $ FastMutableIntMap.insert accum k
2227+ FastMutableIntMap.insert parents k subscription
2228+ height <- getEventSubscribedHeight parentSubd
2229+ if height == invalidHeight
2230+ then writeIORef heightRef invalidHeight
2231+ else do
2232+ modifyIORef' heightBagRef $ heightBagAdd height
2233+ modifyIORef' heightRef $ \oldHeight ->
2234+ if oldHeight == invalidHeight
2235+ then invalidHeight
2236+ else max (succHeight height) oldHeight
2237+ myHeight <- liftIO $ readIORef heightRef
2238+ currentHeight <- getCurrentHeight
2239+ isEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
2240+ occ <- if currentHeight >= myHeight -- If we should have fired by now
2241+ then if isEmpty
2242+ then return Nothing
2243+ else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
2244+ else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
2245+ return Nothing
2246+ defer $ SomeMergeInit $ do
2247+ let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
2248+ where
2249+ u = do
2250+ let f k newParent = do
2251+ subscription@(EventSubscription _ subd) <- subscribe newParent $ mySubscriber k
2252+ newParentHeight <- liftIO $ getEventSubscribedHeight subd
2253+ liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
2254+ return subscription
2255+ newSubscriptions <- FastMutableIntMap.traverseIntMapPatchWithKey f a
2256+ oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
2257+ liftIO $ for_ oldParents $ \oldParent -> do
2258+ oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
2261+ modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
2262+ return $ IntMap.elems oldParents
2263+ let changeSubscriber = Subscriber
2264+ { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
2265+ tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
2266+ defer $ updateMe a
2267+ , subscriberInvalidateHeight = \_ -> return ()
2268+ , subscriberRecalculateHeight = \_ -> return ()
2269+ }
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2271+ forM_ change $ \c -> defer $ updateMe c
2272+ -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
2273+ -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
2274+ -- its subscription.
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
2276+ let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2277+
2278+
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
1772
2280
1773newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2281newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
2282+newtype EventSelectorG x k v = EventSelectorG { selectG :: forall a. k a -> Event x (v a) }
1774
2283
1775−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2284+fanG :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k v) -> EventSelectorG x k v
1776−fan e =
2285+fanG e = unsafePerformIO $ do
2286+ ref <- newIORef Nothing
1777 let f = Fan
2287 let f = Fan
1778 { fanParent = e
2288 { fanParent = e
1779− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
1780 }
2290 }
1781− in EventSelector $ \k -> eventFan k f
2291+ pure $ EventSelectorG $ \k -> eventFan k f
1782
2292
1783−runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeMergeInit x] -> EventM x ()
2293+runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
1784−runHoldInits holdInitRef mergeInitRef = do
2294+runHoldInits holdInitRef dynInitRef mergeInitRef = do
1785 holdInits <- liftIO $ readIORef holdInitRef
2295 holdInits <- liftIO $ readIORef holdInitRef
2296+ dynInits <- liftIO $ readIORef dynInitRef
1786 mergeInits <- liftIO $ readIORef mergeInitRef
2297 mergeInits <- liftIO $ readIORef mergeInitRef
1787− unless (null holdInits && null mergeInits) $ do
2298+ unless (null holdInits && null dynInits && null mergeInits) $ do
1788 liftIO $ writeIORef holdInitRef []
2299 liftIO $ writeIORef holdInitRef []
2300+ liftIO $ writeIORef dynInitRef []
1789 liftIO $ writeIORef mergeInitRef []
2301 liftIO $ writeIORef mergeInitRef []
1790 mapM_ initHold holdInits
2302 mapM_ initHold holdInits
2303+ mapM_ initDyn dynInits
1791 mapM_ unSomeMergeInit mergeInits
2304 mapM_ unSomeMergeInit mergeInits
1792− runHoldInits holdInitRef mergeInitRef
2305+ runHoldInits holdInitRef dynInitRef mergeInitRef
1793
2306
1794initHold :: HasSpiderTimeline x => SomeHoldInit x -> EventM x ()
2307initHold :: HasSpiderTimeline x => SomeHoldInit x -> EventM x ()
1795initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
2308initHold (SomeHoldInit h) = void $ getHoldEventSubscription h
1796
2309
2310+initDyn :: HasSpiderTimeline x => SomeDynInit x -> EventM x ()
2311+initDyn (SomeDynInit d) = void $ getDynHold d
2312+
1797newEventEnv :: IO (EventEnv x)
2313newEventEnv :: IO (EventEnv x)
1798newEventEnv = do
2314newEventEnv = do
1799 toAssignRef <- newIORef [] -- This should only actually get used when events are firing
2315 toAssignRef <- newIORef [] -- This should only actually get used when events are firing
1800 holdInitRef <- newIORef []
2316 holdInitRef <- newIORef []
2317+ dynInitRef <- newIORef []
1801 mergeUpdateRef <- newIORef []
2318 mergeUpdateRef <- newIORef []
1802 mergeInitRef <- newIORef []
2319 mergeInitRef <- newIORef []
1803 heightRef <- newIORef zeroHeight
2320 heightRef <- newIORef zeroHeight
1804 toClearRef <- newIORef []
2321 toClearRef <- newIORef []
2322+ toClearIntRef <- newIORef []
1805 toClearRootRef <- newIORef []
2323 toClearRootRef <- newIORef []
1806 coincidenceInfosRef <- newIORef []
2324 coincidenceInfosRef <- newIORef []
1807 delayedRef <- newIORef IntMap.empty
2325 delayedRef <- newIORef IntMap.empty
1808− return $ EventEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef
2326+ return $ EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef
1809
2327
1810clearEventEnv :: EventEnv x -> IO ()
2328clearEventEnv :: EventEnv x -> IO ()
1811−clearEventEnv (EventEnv toAssignRef holdInitRef mergeUpdateRef mergeInitRef toClearRef toClearRootRef heightRef coincidenceInfosRef delayedRef) = do
2329+clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeInitRef toClearRef toClearIntRef toClearRootRef heightRef coincidenceInfosRef delayedRef) = do
1812 writeIORef toAssignRef []
2330 writeIORef toAssignRef []
1813 writeIORef holdInitRef []
2331 writeIORef holdInitRef []
2332+ writeIORef dynInitRef []
1814 writeIORef mergeUpdateRef []
2333 writeIORef mergeUpdateRef []
1815 writeIORef mergeInitRef []
2334 writeIORef mergeInitRef []
1816 writeIORef heightRef zeroHeight
2335 writeIORef heightRef zeroHeight
1817 writeIORef toClearRef []
2336 writeIORef toClearRef []
2337+ writeIORef toClearIntRef []
1818 writeIORef toClearRootRef []
2338 writeIORef toClearRootRef []
1819 writeIORef coincidenceInfosRef []
2339 writeIORef coincidenceInfosRef []
1820 writeIORef delayedRef IntMap.empty
2340 writeIORef delayedRef IntMap.empty
1821
2341
1822-- | Run an event action outside of a frame
2342-- | Run an event action outside of a frame
1823runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
1824−runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2344+runFrame a = SpiderHost $ do
1825− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1826 let go = do
2346 let go = do
1827 result <- a
2347 result <- a
1828− runHoldInits (eventEnvHoldInits env) (eventEnvMergeInits env) -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
2348+ runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits env) -- This must happen before doing the assignments, in case subscribing a Hold causes existing Holds to be read by the newly-propagated events
1829 return result
2349 return result
1830 result <- runEventM go
2350 result <- runEventM go
1831 toClear <- readIORef $ eventEnvClears env
2351 toClear <- readIORef $ eventEnvClears env
1832− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
2352+ forM_ toClear $ \(Some (Clear ref)) -> {-# SCC "clear" #-} writeIORef ref Nothing
2353+ toClearInt <- readIORef $ eventEnvIntClears env
2354+ forM_ toClearInt $ \(Some (IntClear ref)) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
1833 toClearRoot <- readIORef $ eventEnvRootClears env
2355 toClearRoot <- readIORef $ eventEnvRootClears env
1834− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2356+ forM_ toClearRoot $ \(Some (RootClear ref)) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
1835 toAssign <- readIORef $ eventEnvAssignments env
2357 toAssign <- readIORef $ eventEnvAssignments env
1836 toReconnectRef <- newIORef []
2358 toReconnectRef <- newIORef []
1837 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
2359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
1838 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
2360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
1839 writeIORef vRef v
2361 writeIORef vRef v
1840− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2362+ traceInvalidate $ "Invalidating Hold"
1841 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
2363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
1842 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
2364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
1843 writeIORef (eventEnvMergeUpdates env) []
2365 writeIORef (eventEnvMergeUpdates env) []
1844− when debugPropagate $ putStrLn "Updating merges"
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
1845 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
1846− when debugPropagate $ putStrLn "Updating merges done"
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
1847 toReconnect <- readIORef toReconnectRef
2369 toReconnect <- readIORef toReconnectRef
1848 clearEventEnv env
2370 clearEventEnv env
1849 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
2371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
1850 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
2372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
1851 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
1852− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
1853 finalize wi
2375 finalize wi
1854 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
2376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
1855 wi' <- mkWeakPtrWithDebug i "wi'"
2377 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -1857,13 +2379,13 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
1857 writeIORef (switchSubscribedBehaviorParents subscribed) []
2379 writeIORef (switchSubscribedBehaviorParents subscribed) []
1858 writeIORef (eventEnvHoldInits env) [] --TODO: Should we reuse this?
2380 writeIORef (eventEnvHoldInits env) [] --TODO: Should we reuse this?
1859 e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) $ eventEnvHoldInits env
2381 e <- runBehaviorM (readBehaviorTracked (switchSubscribedParent subscribed)) (Just (wi', switchSubscribedBehaviorParents subscribed)) $ eventEnvHoldInits env
1860− runEventM $ runHoldInits (eventEnvHoldInits env) (eventEnvMergeInits 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
2382+ runEventM $ runHoldInits (eventEnvHoldInits env) (eventEnvDynInits env) (eventEnvMergeInits 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
1861 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
2383 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
1862 sub <- newSubscriberSwitch subscribed
2384 sub <- newSubscriberSwitch subscribed
1863− subscription <- runReaderT (unSpiderHost (runFrame ({-# SCC "subscribeSwitch" #-} subscribe e sub))) spiderTimeline --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
2385+ subscription <- unSpiderHost $ runFrame $ {-# SCC "subscribeSwitch" #-} subscribe e sub --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
1864 {-
2386 {-
1865 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2387 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
1866− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2388+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
1867 EventRoot _ -> "EventRoot"
2389 EventRoot _ -> "EventRoot"
1868 EventNever -> "EventNever"
2390 EventNever -> "EventNever"
1869 _ -> "something else"
2391 _ -> "something else"
@@ -1878,7 +2400,7 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
1878 myHeight <- readIORef $ switchSubscribedHeight subscribed
2400 myHeight <- readIORef $ switchSubscribedHeight subscribed
1879 when (parentHeight /= myHeight) $ do
2401 when (parentHeight /= myHeight) $ do
1880 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
1881− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
1882 mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --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
2404 mapM_ _someMergeUpdate_invalidateHeight mergeUpdates --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
1883 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
2405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
1884 unsubscribe subscription
2406 unsubscribe subscription
@@ -1919,7 +2441,7 @@ invalidateCoincidenceHeight subscribed = do
1919 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
2441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
1920 when (oldHeight /= invalidHeight) $ do
2442 when (oldHeight /= invalidHeight) $ do
1921 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
1922− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
1923
2445
1924updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
2446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
1925updateSwitchHeight new subscribed = do
2447updateSwitchHeight new subscribed = do
@@ -1927,7 +2449,7 @@ updateSwitchHeight new subscribed = do
1927 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1928 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
2450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
1929 writeIORef (switchSubscribedHeight subscribed) $! new
2451 writeIORef (switchSubscribedHeight subscribed) $! new
1930− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
1931
2453
1932recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
2454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
1933recalculateCoincidenceHeight subscribed = do
2455recalculateCoincidenceHeight subscribed = do
@@ -1936,7 +2458,7 @@ recalculateCoincidenceHeight subscribed = do
1936 height <- calculateCoincidenceHeight subscribed
2458 height <- calculateCoincidenceHeight subscribed
1937 when (height /= invalidHeight) $ do
2459 when (height /= invalidHeight) $ do
1938 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
1939− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
1940
2462
1941calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
2463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
1942calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
2464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
@@ -1975,13 +2497,218 @@ invalidate toReconnectRef wis = do
1975-- Reflex integration
2497-- Reflex integration
1976--------------------------------------------------------------------------------
2498--------------------------------------------------------------------------------
1977
2499
1978−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2500+-- | Designates the default, global Spider timeline
1979−-- When we're specializing, we include this from Reflex.Class instead, because
2501+data SpiderTimeline x
1980−-- it needs access to these types; when we're not, we want them here, so our
2502+type role SpiderTimeline nominal
1981−-- instance isn't an orphan instance.
2503+
1982−#include "SpiderTimeline.include.hs"
2504+-- | The default, global Spider environment
1983−#include "SpiderTimelineHost.include.hs"
2505+type Spider = SpiderTimeline Global
2506+
2507+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (EventM x) where
2508+ {-# INLINABLE sample #-}
2509+ sample (SpiderBehavior b) = readBehaviorUntracked b
2510+
2511+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (EventM x) where
2512+ {-# INLINABLE hold #-}
2513+ hold = holdSpiderEventM
2514+ {-# INLINABLE holdDyn #-}
2515+ holdDyn = holdDynSpiderEventM
2516+ {-# INLINABLE holdIncremental #-}
2517+ holdIncremental = holdIncrementalSpiderEventM
2518+ {-# INLINABLE buildDynamic #-}
2519+ buildDynamic = buildDynamicSpiderEventM
2520+ {-# INLINABLE headE #-}
2521+ headE = R.slowHeadE
2522+-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523+ {-# INLINABLE now #-}
2524+ now = nowSpiderEventM
2525+
2526+instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
2527+ {-# INLINABLE sample #-}
2528+ sample = coerce . readBehaviorTracked . unSpiderBehavior
2529+
2530+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPushM x) where
2531+ {-# INLINABLE sample #-}
2532+ sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
2533+
2534+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderPushM x) where
2535+ {-# INLINABLE hold #-}
2536+ hold v0 e = Reflex.Class.current <$> Reflex.Class.holdDyn v0 e
2537+ {-# INLINABLE holdDyn #-}
2538+ holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce e
2539+ {-# INLINABLE holdIncremental #-}
2540+ holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> Reflex.Spider.Internal.hold v0 e
2541+ {-# INLINABLE buildDynamic #-}
2542+ buildDynamic getV0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce e
2543+ {-# INLINABLE headE #-}
2544+ headE = R.slowHeadE
2545+-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546+ {-# INLINABLE now #-}
2547+ now = SpiderPushM nowSpiderEventM
2548+
2549+
2550+instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
2551+ {-# INLINE return #-}
2552+ return = pure
2553+ {-# INLINE (>>=) #-}
2554+ x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
2555+ {-# INLINE (>>) #-}
2556+ (>>) = (*>)
2557+#if !MIN_VERSION_base(4,13,0)
2558+ {-# INLINE fail #-}
2559+ fail _ = error "Dynamic does not support 'fail'"
2560+#endif
2561+
2562+{-# INLINABLE newJoinDyn #-}
2563+newJoinDyn :: HasSpiderTimeline x => DynamicS x (Identity (DynamicS x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
2564+newJoinDyn d =
2565+ let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
2566+ eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
2567+ eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
2568+ eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
2569+ v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
2570+ in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
2571+
2572+instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
2573+ fmap = mapDynamicSpider
2574+ x <$ d = R.unsafeBuildDynamic (return x) $ x <$ R.updated d
2575+
2576+mapDynamicSpider :: HasSpiderTimeline x => (a -> b) -> Reflex.Class.Dynamic (SpiderTimeline x) a -> Reflex.Class.Dynamic (SpiderTimeline x) b
2577+mapDynamicSpider f = SpiderDynamic . newMapDyn f . unSpiderDynamic
2578+{-# INLINE [1] mapDynamicSpider #-}
2579+
2580+instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
2581+ pure = SpiderDynamic . dynamicConst
2582+#if MIN_VERSION_base(4,10,0)
2583+ liftA2 f a b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith f (unSpiderDynamic a) (unSpiderDynamic b)
1984#endif
2584#endif
2585+ SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
2586+ a *> b = R.unsafeBuildDynamic (R.sample $ R.current b) $ R.leftmost [R.updated b, R.tag (R.current b) $ R.updated a]
2587+ (<*) = flip (*>) -- There are no effects, so order doesn't matter
2588+
2589+holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
2590+holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2591+
2592+holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2593+holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2594+
2595+holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
2596+holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2597+
2598+buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPushM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2599+buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2600+
2601+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
2602+ {-# INLINABLE hold #-}
2603+ hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
2604+ {-# INLINABLE holdDyn #-}
2605+ holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
2606+ {-# INLINABLE holdIncremental #-}
2607+ holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
2608+ {-# INLINABLE buildDynamic #-}
2609+ buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
2610+ {-# INLINABLE headE #-}
2611+ headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
2615+
2616+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
2617+ sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
2618+
2619+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
2620+ {-# INLINABLE hold #-}
2621+ hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2622+ {-# INLINABLE holdDyn #-}
2623+ holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
2624+ {-# INLINABLE holdIncremental #-}
2625+ holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
2626+ {-# INLINABLE buildDynamic #-}
2627+ buildDynamic getV0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
2628+ {-# INLINABLE headE #-}
2629+ headE = R.slowHeadE
2630+-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
2633+
2634+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
2635+ {-# INLINABLE sample #-}
2636+ sample = runFrame . readBehaviorUntracked . unSpiderBehavior
2637+
2638+instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2639+ {-# INLINABLE sample #-}
2640+ sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
2641+
2642+instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2643+ {-# INLINABLE hold #-}
2644+ hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
2645+ {-# INLINABLE holdDyn #-}
2646+ holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
2647+ {-# INLINABLE holdIncremental #-}
2648+ holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
2649+ {-# INLINABLE buildDynamic #-}
2650+ buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
2651+ {-# INLINABLE headE #-}
2652+ headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
2655+
2656+--------------------------------------------------------------------------------
2657+-- Deprecated items
2658+--------------------------------------------------------------------------------
2659+
2660+-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
2661+{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
2662+type SpiderEnv = SpiderTimeline
2663+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2664+ {-# INLINABLE subscribeEvent #-}
2665+ subscribeEvent e = SpiderHostFrame $ do
2666+ --TODO: Unsubscribe eventually (manually and/or with weak ref)
2667+ val <- liftIO $ newIORef Nothing
2668+ subscription <- subscribe (unSpiderEvent e) $ Subscriber
2669+ { subscriberPropagate = \a -> do
2670+ liftIO $ writeIORef val $ Just a
2671+ scheduleClear val
2672+ , subscriberInvalidateHeight = \_ -> return ()
2673+ , subscriberRecalculateHeight = \_ -> return ()
2674+ }
2675+ return $ SpiderEventHandle
2676+ { spiderEventHandleSubscription = subscription
2677+ , spiderEventHandleValue = val
2678+ }
2679+
2680+instance HasSpiderTimeline x => Reflex.Host.Class.ReflexHost (SpiderTimeline x) where
2681+ type EventTrigger (SpiderTimeline x) = RootTrigger x
2682+ type EventHandle (SpiderTimeline x) = SpiderEventHandle x
2683+ type HostFrame (SpiderTimeline x) = SpiderHostFrame x
2684+
2685+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
2686+ {-# NOINLINE readEvent #-}
2687+ readEvent h = Reflex.Spider.Internal.ReadPhase $ fmap (fmap return) $ liftIO $ do
2688+ result <- readIORef $ spiderEventHandleValue h
2689+ touch h
2690+ return result
2691+
2692+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2693+ newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2694+ newFanEventWithTrigger f = SpiderHost $ do
2695+ es <- newFanEventWithTriggerIO f
2696+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2697+
2698+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2699+ newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
2700+ newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
2701+ es <- newFanEventWithTriggerIO f
2702+ return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
2703+
2704+instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
2705+ {-# INLINABLE subscribeEvent #-}
2706+ subscribeEvent = runFrame . runSpiderHostFrame . Reflex.Host.Class.subscribeEvent
2707+
2708+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
2709+ type ReadPhase (SpiderHost x) = Reflex.Spider.Internal.ReadPhase x
2710+ fireEventsAndRead es (Reflex.Spider.Internal.ReadPhase a) = run es a
2711+ runHostFrame = runFrame . runSpiderHostFrame
1985
2712
1986unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
2713unsafeNewSpiderTimelineEnv :: forall x. IO (SpiderTimelineEnv x)
1987unsafeNewSpiderTimelineEnv = do
2714unsafeNewSpiderTimelineEnv = do
@@ -1990,7 +2717,7 @@ unsafeNewSpiderTimelineEnv = do
1990#ifdef DEBUG
2717#ifdef DEBUG
1991 depthRef <- newIORef 0
2718 depthRef <- newIORef 0
1992#endif
2719#endif
1993− return $ SpiderTimelineEnv
2720+ return $ STE $ SpiderTimelineEnv
1994 { _spiderTimeline_lock = lock
2721 { _spiderTimeline_lock = lock
1995 , _spiderTimeline_eventEnv = env
2722 , _spiderTimeline_eventEnv = env
1996#ifdef DEBUG
2723#ifdef DEBUG
@@ -1998,41 +2725,40 @@ unsafeNewSpiderTimelineEnv = do
1998#endif
2725#endif
1999 }
2726 }
2000
2727
2001−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2002-- | Create a new SpiderTimelineEnv
2728-- | Create a new SpiderTimelineEnv
2003newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2004−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
2005
2731
2006−data LocalSpiderTimeline x s
2732+data LocalSpiderTimeline (x :: Type) s
2007
2733
2008instance Reifies s (SpiderTimelineEnv x) =>
2734instance Reifies s (SpiderTimelineEnv x) =>
2009 HasSpiderTimeline (LocalSpiderTimeline x s) where
2735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2010− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
2011
2737
2012localSpiderTimeline
2738localSpiderTimeline
2013− :: Proxy s
2739+ :: proxy s
2014 -> SpiderTimelineEnv x
2740 -> SpiderTimelineEnv x
2015 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2016−localSpiderTimeline _ = unsafeCoerce
2742+localSpiderTimeline _ = coerce
2017
2743
2018-- | Pass a new timeline to the given function.
2744-- | Pass a new timeline to the given function.
2019withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
2020withSpiderTimeline k = do
2746withSpiderTimeline k = do
2021 env <- unsafeNewSpiderTimelineEnv
2747 env <- unsafeNewSpiderTimelineEnv
2022 reify env $ \s -> k $ localSpiderTimeline s env
2748 reify env $ \s -> k $ localSpiderTimeline s env
2023−#endif
2024
2749
2025−newtype SpiderPullM x a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2750+newtype SpiderPullM (x :: Type) a = SpiderPullM (BehaviorM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2751+
2752+type ComputeM = EventM
2026
2753
2027−newtype SpiderPushM x a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2754+newtype SpiderPushM (x :: Type) a = SpiderPushM (ComputeM x a) deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
2028
2755
2029−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2030instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2031 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
2032 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
2033 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2759 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2034− newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x (Identity a) } -- deriving (Functor, Applicative, Monad)
2760+ newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: DynamicS x (Identity a) } -- deriving (Functor, Applicative, Monad)
2035− newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: Dynamic x p }
2761+ newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: DynamicS x p }
2036 type PullM (SpiderTimeline x) = SpiderPullM x
2762 type PullM (SpiderTimeline x) = SpiderPullM x
2037 type PushM (SpiderTimeline x) = SpiderPushM x
2763 type PushM (SpiderTimeline x) = SpiderPushM x
2038 {-# INLINABLE never #-}
2764 {-# INLINABLE never #-}
@@ -2045,10 +2771,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2045 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
2046 {-# INLINABLE pull #-}
2772 {-# INLINABLE pull #-}
2047 pull = SpiderBehavior . pull . coerce
2773 pull = SpiderBehavior . pull . coerce
2048− {-# INLINABLE merge #-}
2774+ {-# INLINABLE fanG #-}
2049− merge = SpiderEvent . merge . dynamicConst . (coerce :: DMap k (R.Event (SpiderTimeline x)) -> DMap k (Event x))
2775+ fanG e = R.EventSelectorG $ SpiderEvent . selectG (fanG (unSpiderEvent e))
2050− {-# INLINABLE fan #-}
2776+ {-# INLINABLE mergeG #-}
2051− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2777+ mergeG
2778+ :: forall k2 (k :: k2 -> *) q (v :: k2 -> *). GCompare k
2779+ => (forall a. q a -> R.Event (SpiderTimeline x) (v a))
2780+ -> DMap k q
2781+ -> R.Event (SpiderTimeline x) (DMap k v)
2782+ mergeG nt = SpiderEvent . mergeG (unSpiderEvent #. nt) . dynamicConst
2052 {-# INLINABLE switch #-}
2783 {-# INLINABLE switch #-}
2053 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
2054 {-# INLINABLE coincidence #-}
2785 {-# INLINABLE coincidence #-}
@@ -2056,27 +2787,31 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
2056 {-# INLINABLE current #-}
2787 {-# INLINABLE current #-}
2057 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
2058 {-# INLINABLE updated #-}
2789 {-# INLINABLE updated #-}
2059− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
2060 {-# INLINABLE unsafeBuildDynamic #-}
2791 {-# INLINABLE unsafeBuildDynamic #-}
2061− unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeDyn (coerce readV0) $ coerce $ unSpiderEvent v'
2792+ unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
2062 {-# INLINABLE unsafeBuildIncremental #-}
2793 {-# INLINABLE unsafeBuildIncremental #-}
2063− unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeDyn (coerce readV0) $ unSpiderEvent dv
2794+ unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2064− {-# INLINABLE mergeIncremental #-}
2795+ {-# INLINABLE mergeIncrementalG #-}
2065− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2796+ mergeIncrementalG nt = SpiderEvent #. mergeG (coerce #. nt) .# unSpiderIncremental
2066− {-# INLINABLE mergeIncrementalWithMove #-}
2797+ {-# INLINABLE mergeIncrementalWithMoveG #-}
2067− mergeIncrementalWithMove = SpiderEvent . mergeWithMove . (unsafeCoerce :: Dynamic x (PatchDMapWithMove k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMapWithMove k (Event x))) . unSpiderIncremental
2798+ mergeIncrementalWithMoveG nt = SpiderEvent #. mergeWithMove (coerce #. nt) .# unSpiderIncremental
2068 {-# INLINABLE currentIncremental #-}
2799 {-# INLINABLE currentIncremental #-}
2069 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
2070 {-# INLINABLE updatedIncremental #-}
2801 {-# INLINABLE updatedIncremental #-}
2071 updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
2802 updatedIncremental = SpiderEvent . dynamicUpdated . unSpiderIncremental
2072 {-# INLINABLE incrementalToDynamic #-}
2803 {-# INLINABLE incrementalToDynamic #-}
2073− incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ unsafeDyn (readBehaviorUntracked $ dynamicCurrent i) $ flip push (dynamicUpdated i) $ \p -> do
2804+ incrementalToDynamic (SpiderIncremental i) = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (readBehaviorUntracked $ dynamicCurrent i) $ flip push (dynamicUpdated i) $ \p -> do
2074 c <- readBehaviorUntracked $ dynamicCurrent i
2805 c <- readBehaviorUntracked $ dynamicCurrent i
2075 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
2076 eventCoercion Coercion = Coercion
2807 eventCoercion Coercion = Coercion
2077 behaviorCoercion Coercion = Coercion
2808 behaviorCoercion Coercion = Coercion
2078− dynamicCoercion = unsafeCoerce --TODO: How can we avoid this unsafeCoerce? This is safe only because we know how Identity works as a Patch instance
2809+ dynamicCoercion Coercion = Coercion
2079−#endif
2810+ incrementalCoercion Coercion Coercion = Coercion
2811+ {-# INLINABLE mergeIntIncremental #-}
2812+ mergeIntIncremental = SpiderEvent . mergeInt . coerce
2813+ {-# INLINABLE fanInt #-}
2814+ fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
2080
2815
2081data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2816data RootTrigger x a = forall k. GCompare k => RootTrigger (WeakBag (Subscriber x a), IORef (DMap k Identity), k a)
2082
2817
@@ -2099,7 +2834,7 @@ instance MonadAtomicRef (EventM x) where
2099 atomicModifyRef r f = liftIO $ atomicModifyRef r f
2834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
2100
2835
2101-- | The monad for actions that manipulate a Spider timeline identified by @x@
2836-- | The monad for actions that manipulate a Spider timeline identified by @x@
2102−newtype SpiderHost x a = SpiderHost { unSpiderHost :: ReaderT (SpiderTimelineEnv x) IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2837+newtype SpiderHost (x :: Type) a = SpiderHost { unSpiderHost :: IO a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2103
2838
2104instance Monad (SpiderHost x) where
2839instance Monad (SpiderHost x) where
2105 {-# INLINABLE (>>=) #-}
2840 {-# INLINABLE (>>=) #-}
@@ -2108,22 +2843,27 @@ instance Monad (SpiderHost x) where
2108 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
2109 {-# INLINABLE return #-}
2844 {-# INLINABLE return #-}
2110 return x = SpiderHost $ return x
2845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
2111 {-# INLINABLE fail #-}
2847 {-# INLINABLE fail #-}
2112− fail s = SpiderHost $ fail s
2848+ fail = MonadFail.fail
2849+#endif
2850+
2851+instance MonadFail (SpiderHost x) where
2852+ {-# INLINABLE fail #-}
2853+ fail s = SpiderHost $ MonadFail.fail s
2113
2854
2114-- | Run an action affecting the global Spider timeline; this will be guarded by
2855-- | Run an action affecting the global Spider timeline; this will be guarded by
2115-- a mutex for that timeline
2856-- a mutex for that timeline
2116runSpiderHost :: SpiderHost Global a -> IO a
2857runSpiderHost :: SpiderHost Global a -> IO a
2117−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderTimelineEnv
2858+runSpiderHost (SpiderHost a) = a
2118
2859
2119−#ifndef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
2120-- | Run an action affecting a given Spider timeline; this will be guarded by a
2860-- | Run an action affecting a given Spider timeline; this will be guarded by a
2121-- mutex for that timeline
2861-- mutex for that timeline
2122runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2123−runSpiderHostForTimeline (SpiderHost a) = runReaderT a
2863+runSpiderHostForTimeline (SpiderHost a) _ = a
2124−#endif
2125
2864
2126−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a } deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2865+newtype SpiderHostFrame (x :: Type) a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2866+ deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
2127
2867
2128instance Monad (SpiderHostFrame x) where
2868instance Monad (SpiderHostFrame x) where
2129 {-# INLINABLE (>>=) #-}
2869 {-# INLINABLE (>>=) #-}
@@ -2132,15 +2872,21 @@ instance Monad (SpiderHostFrame x) where
2132 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
2133 {-# INLINABLE return #-}
2873 {-# INLINABLE return #-}
2134 return x = SpiderHostFrame $ return x
2874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
2135 {-# INLINABLE fail #-}
2876 {-# INLINABLE fail #-}
2136 fail s = SpiderHostFrame $ fail s
2877 fail s = SpiderHostFrame $ fail s
2878+#endif
2879+
2880+instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
2881+ notReadyUntil _ = pure ()
2882+ notReady = pure ()
2137
2883
2138−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2884+newEventWithTriggerIO :: forall x a. HasSpiderTimeline x => (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2139newEventWithTriggerIO f = do
2885newEventWithTriggerIO f = do
2140 es <- newFanEventWithTriggerIO $ \Refl -> f
2886 es <- newFanEventWithTriggerIO $ \Refl -> f
2141 return $ select es Refl
2887 return $ select es Refl
2142
2888
2143−newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2889+newFanEventWithTriggerIO :: (HasSpiderTimeline x, GCompare k) => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2144newFanEventWithTriggerIO f = do
2890newFanEventWithTriggerIO f = do
2145 occRef <- newIORef DMap.empty
2891 occRef <- newIORef DMap.empty
2146 subscribedRef <- newIORef DMap.empty
2892 subscribedRef <- newIORef DMap.empty
@@ -2174,3 +2920,11 @@ instance MonadAtomicRef (SpiderHostFrame x) where
2174instance PrimMonad (SpiderHostFrame x) where
2920instance PrimMonad (SpiderHostFrame x) where
2175 type PrimState (SpiderHostFrame x) = PrimState IO
2921 type PrimState (SpiderHostFrame x) = PrimState IO
2176 primitive = SpiderHostFrame . EventM . primitive
2922 primitive = SpiderHostFrame . EventM . primitive
2923+
2924+instance NotReady (SpiderTimeline x) (SpiderHost x) where
2925+ notReadyUntil _ = return ()
2926+ notReady = return ()
2927+
2928+instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x)) where
2929+ notReadyUntil _ = return ()
2930+ notReady = return ()
src/Reflex/Spider/SpiderTimeline.include.hsdeleted−122
@@ -1,122 +0,0 @@
1−-- | Designates the default, global Spider timeline
2−data SpiderTimeline x
3−type role SpiderTimeline nominal
4−
5−-- | The default, global Spider environment
6−type Spider = SpiderTimeline Global
7−
8−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (EventM x) where
9− {-# INLINABLE sample #-}
10− sample (SpiderBehavior b) = readBehaviorUntracked b
11−
12−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (EventM x) where
13− {-# INLINABLE hold #-}
14− hold = holdSpiderEventM
15− {-# INLINABLE holdDyn #-}
16− holdDyn = holdDynSpiderEventM
17− {-# INLINABLE holdIncremental #-}
18− holdIncremental = holdIncrementalSpiderEventM
19−
20−instance (
21−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
22− x ~ Global
23−#endif
24− ) => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
25− {-# INLINABLE sample #-}
26− sample = coerce . readBehaviorTracked . unSpiderBehavior
27−
28−instance (
29−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
30− x ~ Global
31−#endif
32− ) => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPushM x) where
33− {-# INLINABLE sample #-}
34− sample (SpiderBehavior b) = SpiderPushM $ readBehaviorUntracked b
35−
36−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderPushM x) where
37− {-# INLINABLE hold #-}
38− hold v0 e = Reflex.Class.current <$> Reflex.Class.holdDyn v0 e
39− {-# INLINABLE holdDyn #-}
40− holdDyn v0 (SpiderEvent e) = SpiderPushM $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce e
41− {-# INLINABLE holdIncremental #-}
42− holdIncremental v0 (SpiderEvent e) = SpiderPushM $ SpiderIncremental . dynamicHold <$> Reflex.Spider.Internal.hold v0 e
43−
44−instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
45− {-# INLINE return #-}
46− return = pure
47− {-# INLINE (>>=) #-}
48− x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
49− {-# INLINE (>>) #-}
50− _ >> y = y
51− {-# INLINE fail #-}
52− fail _ = error "Dynamic does not support 'fail'"
53−
54−newJoinDyn :: HasSpiderTimeline x => Reflex.Spider.Internal.Dynamic x (Identity (Reflex.Spider.Internal.Dynamic x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
55−newJoinDyn d =
56− let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
57− eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
58− eInner = Reflex.Spider.Internal.switch $ dynamicUpdated <$> dynamicCurrent d
59− eBoth = Reflex.Spider.Internal.coincidence $ dynamicUpdated . runIdentity <$> dynamicUpdated d
60− v' = unSpiderEvent $ Reflex.Class.leftmost $ map SpiderEvent [eBoth, eOuter, eInner]
61− in unsafeDyn readV0 v'
62−
63−instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
64− fmap f = SpiderDynamic . newMapDyn f . unSpiderDynamic
65−
66−instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
67− pure = SpiderDynamic . dynamicConst
68− SpiderDynamic a <*> SpiderDynamic b = SpiderDynamic $ Reflex.Spider.Internal.zipDynWith ($) a b
69− _ *> b = b
70− a <* _ = a
71−
72−holdSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Behavior (SpiderTimeline x) a)
73−holdSpiderEventM v0 e = fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
74−
75−holdDynSpiderEventM :: HasSpiderTimeline x => a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
76−holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
77−
78−holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
79−holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
80−
81−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
82− {-# INLINABLE hold #-}
83− hold v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.hold v0 e
84− {-# INLINABLE holdDyn #-}
85− holdDyn v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdDyn v0 e
86− {-# INLINABLE holdIncremental #-}
87− holdIncremental v0 e = runFrame . runSpiderHostFrame $ Reflex.Class.holdIncremental v0 e
88−
89−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
90− sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
91−
92−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHostFrame x) where
93− {-# INLINABLE hold #-}
94− hold v0 e = SpiderHostFrame $ fmap (SpiderBehavior . behaviorHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
95− {-# INLINABLE holdDyn #-}
96− holdDyn v0 e = SpiderHostFrame $ fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.Spider.Internal.hold v0 $ coerce $ unSpiderEvent e
97− {-# INLINABLE holdIncremental #-}
98− holdIncremental v0 e = SpiderHostFrame $ fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
99−
100−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
101− {-# INLINABLE sample #-}
102− sample = runFrame . readBehaviorUntracked . unSpiderBehavior
103−
104−instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
105− {-# INLINABLE sample #-}
106− sample = Reflex.Spider.Internal.ReadPhase . Reflex.Class.sample
107−
108−instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
109− {-# INLINABLE hold #-}
110− hold v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.hold v0 e
111− {-# INLINABLE holdDyn #-}
112− holdDyn v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdDyn v0 e
113− {-# INLINABLE holdIncremental #-}
114− holdIncremental v0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.holdIncremental v0 e
115−
116−--------------------------------------------------------------------------------
117−-- Deprecated items
118−--------------------------------------------------------------------------------
119−
120−-- | 'SpiderEnv' is the old name for 'SpiderTimeline'
121−{-# DEPRECATED SpiderEnv "Use 'SpiderTimelineEnv' instead" #-}
122−type SpiderEnv = SpiderTimeline
src/Reflex/Spider/SpiderTimelineHost.include.hsdeleted−57
@@ -1,57 +0,0 @@
1−instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHostFrame x) where
2− {-# INLINABLE subscribeEvent #-}
3− subscribeEvent e = SpiderHostFrame $ do
4− --TODO: Unsubscribe eventually (manually and/or with weak ref)
5− val <- liftIO $ newIORef Nothing
6− subscription <- subscribe (unSpiderEvent e) $ Subscriber
7− { subscriberPropagate = \a -> do
8− liftIO $ writeIORef val $ Just a
9− scheduleClear val
10− , subscriberInvalidateHeight = \_ -> return ()
11− , subscriberRecalculateHeight = \_ -> return ()
12− }
13− return $ SpiderEventHandle
14− { spiderEventHandleSubscription = subscription
15− , spiderEventHandleValue = val
16− }
17−
18−instance HasSpiderTimeline x => Reflex.Host.Class.ReflexHost (SpiderTimeline x) where
19− type EventTrigger (SpiderTimeline x) = RootTrigger x
20− type EventHandle (SpiderTimeline x) = SpiderEventHandle x
21− type HostFrame (SpiderTimeline x) = SpiderHostFrame x
22−
23−instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline x) (Reflex.Spider.Internal.ReadPhase x) where
24− {-# NOINLINE readEvent #-}
25− readEvent h = Reflex.Spider.Internal.ReadPhase $ fmap (fmap return) $ liftIO $ do
26− result <- readIORef $ spiderEventHandleValue h
27− touch h
28− return result
29−
30−instance (
31−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
32− x ~ Global
33−#endif
34− ) => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
35− newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
36− newFanEventWithTrigger f = SpiderHost $ lift $ do
37− es <- newFanEventWithTriggerIO f
38− return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
39−
40−instance (
41−#ifdef SPECIALIZE_TO_SPIDERTIMELINE_GLOBAL
42− x ~ Global
43−#endif
44− ) => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
45− newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
46− newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
47− es <- newFanEventWithTriggerIO f
48− return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
49−
50−instance HasSpiderTimeline x => Reflex.Host.Class.MonadSubscribeEvent (SpiderTimeline x) (SpiderHost x) where
51− {-# INLINABLE subscribeEvent #-}
52− subscribeEvent = runFrame . runSpiderHostFrame . Reflex.Host.Class.subscribeEvent
53−
54−instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexHost (SpiderTimeline x) (SpiderHost x) where
55− type ReadPhase (SpiderHost x) = Reflex.Spider.Internal.ReadPhase x
56− fireEventsAndRead es (Reflex.Spider.Internal.ReadPhase a) = run es a
57− runHostFrame = runFrame . runSpiderHostFrame
src/Reflex/Time.hsnew file+384
@@ -0,0 +1,384 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveGeneric #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE FlexibleContexts #-}
6+{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE RecursiveDo #-}
8+{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TupleSections #-}
10+{-# LANGUAGE TypeFamilies #-}
11+#ifdef USE_TEMPLATE_HASKELL
12+{-# LANGUAGE TemplateHaskell #-}
13+#endif
14+-- |
15+-- Module:
16+-- Reflex.Time
17+-- Description:
18+-- Clocks, timers, and other time-related functions.
19+module Reflex.Time where
20+
21+import Reflex.Class
22+import Reflex.Dynamic
23+import Reflex.PerformEvent.Class
24+import Reflex.PostBuild.Class
25+import Reflex.TriggerEvent.Class
26+
27+import Control.Concurrent
28+import qualified Control.Concurrent.Thread.Delay as Concurrent
29+import Control.Lens hiding ((|>))
30+import Control.Monad
31+import Control.Monad.Fix
32+import Control.Monad.IO.Class
33+import Data.Align
34+import Data.Data (Data)
35+import Data.Fixed
36+import Data.Semigroup (Semigroup(..))
37+import Data.Sequence (Seq, (|>))
38+import qualified Data.Sequence as Seq
39+import Data.These
40+import Data.Time.Clock
41+import Data.Typeable
42+import GHC.Generics (Generic)
43+import System.Random
44+
45+-- | Metadata associated with a timer "tick"
46+data TickInfo
47+ = TickInfo { _tickInfo_lastUTC :: UTCTime
48+ -- ^ UTC time immediately after the last tick.
49+ , _tickInfo_n :: Integer
50+ -- ^ Number of time periods or ticks since the start of the timer
51+ , _tickInfo_alreadyElapsed :: NominalDiffTime
52+ -- ^ Amount of time that has elapsed in the current tick period.
53+ }
54+ deriving (Eq, Ord, Show, Typeable)
55+
56+-- | Fires an 'Event' once every time provided interval elapses, approximately.
57+-- The provided 'UTCTime' is used bootstrap the determination of how much time has elapsed with each tick.
58+-- This is a special case of 'tickLossyFrom' that uses the post-build event to start the tick thread.
59+tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
60+tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
61+
62+-- | Fires an 'Event' once every time provided interval elapses, approximately.
63+-- This is a special case of 'tickLossyFrom' that uses the post-build event to start the tick thread and the time of the post-build as the tick basis time.
64+tickLossyFromPostBuildTime :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> m (Event t TickInfo)
65+tickLossyFromPostBuildTime dt = do
66+ postBuild <- getPostBuild
67+ postBuildTime <- performEvent $ liftIO getCurrentTime <$ postBuild
68+ tickLossyFrom' $ (dt,) <$> postBuildTime
69+
70+-- | Fires an 'Event' approximately each time the provided interval elapses. If the system starts running behind, occurrences will be dropped rather than buffered.
71+-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the provided initial time.
72+tickLossyFrom
73+ :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
74+ => NominalDiffTime
75+ -- ^ The length of a tick interval
76+ -> UTCTime
77+ -- ^ The basis time from which intervals count and with which the initial calculation of elapsed time will be made.
78+ -> Event t a
79+ -- ^ Event that starts a tick generation thread. Usually you want this to
80+ -- be something like the result of getPostBuild that only fires once. But
81+ -- there could be uses for starting multiple timer threads.
82+ -> m (Event t TickInfo)
83+tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
84+
85+-- | Generalization of tickLossyFrom that takes the delay and initial time as an 'Event'.
86+tickLossyFrom'
87+ :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
88+ => Event t (NominalDiffTime, UTCTime)
89+ -- ^ Event that starts a tick generation thread. Usually you want this to
90+ -- be something like the result of 'getPostBuild' that only fires once. But
91+ -- there could be uses for starting multiple timer threads.
92+ -> m (Event t TickInfo)
93+tickLossyFrom' e = do
94+ rec result <- performEventAsync $ callAtNextInterval <$> leftmost [e, snd <$> result]
95+ return $ fst <$> result
96+ where callAtNextInterval pair cb = void $ liftIO $ forkIO $ do
97+ tick <- uncurry getCurrentTick pair
98+ Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
99+ cb (tick, pair)
100+
101+-- | Like 'tickLossy', but immediately calculates the first tick and provides a 'Dynamic' that is updated as ticks fire.
102+clockLossy :: (MonadIO m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), PostBuild t m, MonadHold t m, MonadFix m) => NominalDiffTime -> UTCTime -> m (Dynamic t TickInfo)
103+clockLossy dt t0 = do
104+ initial <- liftIO $ getCurrentTick dt t0
105+ e <- tickLossy dt t0
106+ holdDyn initial e
107+
108+-- | Generates a 'TickInfo', given the specified interval and timestamp. The 'TickInfo' will include the
109+-- current time, the number of ticks that have elapsed since the timestamp, and the amount of time that
110+-- has elapsed since the start time of this tick.
111+getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
112+getCurrentTick dt t0 = do
113+ t <- getCurrentTime
114+ let offset = t `diffUTCTime` t0
115+ (n, alreadyElapsed) = offset `divMod'` dt
116+ return $ TickInfo t n alreadyElapsed
117+
118+-- | Delay an Event's occurrences by a given amount in seconds.
119+delay :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
120+delay dt e = performEventAsync $ ffor e $ \a cb -> liftIO $ void $ forkIO $ do
121+ Concurrent.delay $ ceiling $ dt * 1000000
122+ cb a
123+
124+-- | Send events with Poisson timing with the given basis and rate
125+-- Each occurrence of the resulting event will contain the index of
126+-- the current interval, with 0 representing the basis time
127+poissonLossyFrom
128+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
129+ => g
130+ -> Double
131+ -- ^ Poisson event rate (Hz)
132+ -> UTCTime
133+ -- ^ Baseline time for events
134+ -> Event t a
135+ -- ^ Event that starts a tick generation thread. Usually you want this to
136+ -- be something like the result of getPostBuild that only fires once. But
137+ -- there could be uses for starting multiple timer threads.
138+ -- Start sending events in response to the event parameter.
139+ -> m (Event t TickInfo)
140+poissonLossyFrom rnd rate = inhomogeneousPoissonFrom rnd (constant rate) rate
141+
142+
143+-- | Send events with Poisson timing with the given basis and rate
144+-- Each occurrence of the resulting event will contain the index of
145+-- the current interval, with 0 representing the basis time.
146+-- Automatically begin sending events when the DOM is built
147+poissonLossy
148+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, PostBuild t m)
149+ => g
150+ -> Double
151+ -- ^ Poisson event rate (Hz)
152+ -> UTCTime
153+ -- ^ Baseline time for events
154+ -> m (Event t TickInfo)
155+poissonLossy rnd rate t0 = poissonLossyFrom rnd rate t0 =<< getPostBuild
156+
157+-- | Send events with inhomogeneous Poisson timing with the given basis
158+-- and variable rate. Provide a maxRate that you expect to support.
159+inhomogeneousPoissonFrom
160+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
161+ => g
162+ -> Behavior t Double
163+ -> Double
164+ -> UTCTime
165+ -> Event t a
166+ -> m (Event t TickInfo)
167+inhomogeneousPoissonFrom rnd rate maxRate t0 e = do
168+
169+ -- Create a thread for producing homogeneous poisson events
170+ -- along with random Doubles (usage of Double's explained below)
171+ ticksWithRateRand <- performEventAsync $
172+ fmap callAtNextInterval e
173+
174+ -- Filter homogeneous events according to associated
175+ -- random values and the current rate parameter
176+ return $ attachWithMaybe filterFun rate ticksWithRateRand
177+
178+ where
179+
180+ -- Inhomogeneous poisson processes are built from faster
181+ -- homogeneous ones by randomly dropping events from the
182+ -- fast process. For each fast homogeneous event, choose
183+ -- a uniform random sample from (0, rMax). If the
184+ -- inhomogeneous rate at this moment is greater than the
185+ -- random sample, then keep this event, otherwise drop it
186+ filterFun :: Double -> (TickInfo, Double) -> Maybe TickInfo
187+ filterFun r (tInfo, p)
188+ | r >= p = Just tInfo
189+ | otherwise = Nothing
190+
191+ callAtNextInterval _ cb = void $ liftIO $ forkIO $ go t0 rnd cb 0
192+
193+ go tTargetLast lastGen cb lastN = do
194+ t <- getCurrentTime
195+
196+ -- Generate random numbers for this poisson interval (u)
197+ -- and sample-retention likelihood (p)
198+ let (u, nextGen) = randomR (0,1) lastGen
199+ (p :: Double, nextGen') = randomR (0,maxRate) nextGen
200+
201+ -- Inter-event interval is drawn from exponential
202+ -- distribution accourding to u
203+ let dt = realToFrac $ (-1) * log u / maxRate :: NominalDiffTime
204+ nEvents = lastN + 1
205+ alreadyElapsed = diffUTCTime t tTargetLast
206+ tTarget = addUTCTime dt tTargetLast
207+ thisDelay = realToFrac $ diffUTCTime tTarget t :: Double
208+ Concurrent.delay $ ceiling $ thisDelay * 1000000
209+ _ <- cb (TickInfo t nEvents alreadyElapsed, p)
210+ go tTarget nextGen' cb nEvents
211+
212+-- | Send events with inhomogeneous Poisson timing with the given basis
213+-- and variable rate. Provide a maxRate that you expect to support
214+inhomogeneousPoisson
215+ :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, PostBuild t m)
216+ => g
217+ -> Behavior t Double
218+ -> Double
219+ -> UTCTime
220+ -> m (Event t TickInfo)
221+inhomogeneousPoisson rnd rate maxRate t0 =
222+ inhomogeneousPoissonFrom rnd rate maxRate t0 =<< getPostBuild
223+
224+-- | Block occurrences of an Event until the given number of seconds elapses without
225+-- the Event firing, at which point the last occurrence of the Event will fire.
226+debounce :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
227+debounce dt e = do
228+ n :: Dynamic t Integer <- count e
229+ let tagged = attachPromptlyDynWith (,) n e
230+ delayed <- delay dt tagged
231+ return $ attachWithMaybe (\n' (t, v) -> if n' == t then Just v else Nothing) (current n) delayed
232+
233+-- | When the given 'Event' occurs, wait the given amount of time and collect
234+-- all occurrences during that time. Then, fire the output 'Event' with the
235+-- collected output.
236+batchOccurrences :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t (Seq a))
237+batchOccurrences t newValues = do
238+ let f s x = (Just newState, out)
239+ where newState = case x of
240+ This a -> s |> a
241+ That _ -> mempty
242+ These a _ -> Seq.singleton a
243+ out = case x of
244+ This _ -> if Seq.null s then Just () else Nothing
245+ That _ -> Nothing
246+ These _ _ -> Just ()
247+ rec (buffer, toDelay) <- mapAccumMaybe f mempty $ align newValues delayed
248+ delayed <- delay t toDelay
249+ return $ tag buffer delayed
250+
251+-- | Throttle an input event, ensuring that at least a given amount of time passes between occurrences of the output event. If the input event occurs too
252+-- frequently, the output event occurs with the most recently seen input value after the given delay passes since the last occurrence of the output.
253+-- If the output event has not occurred recently, occurrences of the input event will cause the output event to fire immediately.
254+throttle :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
255+throttle t e = do
256+ let f (immediate, buffer) x = case x of -- (Just newState, out)
257+ This a -- If only the input event fires
258+ | immediate -> -- and we're in immediate mode
259+ -- Immediate mode turns off, and the buffer is empty.
260+ -- We fire the output event with the input event value immediately.
261+ (Just (False, Nothing), Just a)
262+ | otherwise -> -- and we're not in immediate mode
263+ -- Immediate mode remains off, and we replace the contents of the buffer (if any) with the input value.
264+ -- We don't fire the output event.
265+ (Just (False, Just a), Nothing)
266+ That _ -> -- If only the delayed output event fires,
267+ case buffer of
268+ Nothing -> -- and the buffer is empty:
269+ -- Immediate mode turns back on, and the buffer remains empty.
270+ -- We don't fire.
271+ (Just (True, Nothing), Nothing)
272+ Just b -> -- and the buffer is full:
273+ -- Immediate mode remains off, and the buffer is cleared.
274+ -- We fire with the buffered value.
275+ (Just (False, Nothing), Just b)
276+ These a _ -> -- If both the input and delayed output event fire simultaneously:
277+ -- Immediate mode turns off, and the buffer is empty.
278+ -- We fire with the input event's value, as it is the most recent we have seen at this moment.
279+ (Just (False, Nothing), Just a)
280+ rec (_, outE) <- mapAccumMaybeDyn f (True, Nothing) $ align e delayed -- We start in immediate mode with an empty buffer.
281+ delayed <- delay t outE
282+ return outE
283+
284+data ThrottleState b
285+ = ThrottleState_Immediate
286+ | ThrottleState_Buffered (ThrottleBuffer b)
287+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
288+
289+data ThrottleBuffer b
290+ = ThrottleBuffer_Empty -- Empty conflicts with lens, and hiding it would require turning
291+ -- on PatternSynonyms
292+ | ThrottleBuffer_Full b
293+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
294+
295+instance Semigroup b => Semigroup (ThrottleBuffer b) where
296+ x <> y = case x of
297+ ThrottleBuffer_Empty -> y
298+ ThrottleBuffer_Full b1 -> case y of
299+ ThrottleBuffer_Empty -> x
300+ ThrottleBuffer_Full b2 -> ThrottleBuffer_Full $ b1 <> b2
301+ {-# INLINE (<>) #-}
302+
303+instance Semigroup b => Monoid (ThrottleBuffer b) where
304+ mempty = ThrottleBuffer_Empty
305+ {-# INLINE mempty #-}
306+ mappend = (<>)
307+ {-# INLINE mappend #-}
308+
309+-- | Throttle an input event, ensuring that the output event doesn't occur more often than you are ready for it. If the input event occurs too
310+-- frequently, the output event will contain semigroup-based summaries of the input firings that happened since the last output firing.
311+-- If the output event has not occurred recently, occurrences of the input event will cause the output event to fire immediately.
312+-- The first parameter is a function that receives access to the output event, and should construct an event that fires when the receiver is
313+-- ready for more input. For example, using @delay 20@ would give a simple time-based throttle.
314+--
315+-- NB: The provided lag function must *actually* delay the event.
316+throttleBatchWithLag :: (MonadFix m, MonadHold t m, PerformEvent t m, Semigroup a) => (Event t () -> m (Event t ())) -> Event t a -> m (Event t a)
317+-- Invariants:
318+-- * Immediate mode must turn off whenever output is produced.
319+-- * Output must be produced whenever immediate mode turns from on to off.
320+-- * Immediate mode can only go from off to on when the delayed event fires.
321+-- * Every input firing must go into either an immediate output firing or the
322+-- buffer, but not both.
323+-- * An existing full buffer must either stay in the buffer or go to output,
324+-- but not both.
325+throttleBatchWithLag lag e = do
326+ let f state x = case x of -- (Just $ newState, out)
327+ This a -> -- If only the input event fires
328+ case state of
329+ ThrottleState_Immediate -> -- and we're in immediate mode
330+ -- Immediate mode turns off, and the buffer is empty.
331+ -- We fire the output event with the input event value immediately.
332+ (Just $ ThrottleState_Buffered $ ThrottleBuffer_Empty, Just a)
333+ ThrottleState_Buffered b -> -- and we're not in immediate mode
334+ -- Immediate mode remains off, and we accumulate the input value.
335+ -- We don't fire the output event.
336+ (Just $ ThrottleState_Buffered $ b <> ThrottleBuffer_Full a, Nothing)
337+ That _ -> -- If only the delayed output event fires,
338+ case state of
339+ ThrottleState_Immediate -> -- and we're in immediate mode
340+ -- Nothing happens.
341+ (Nothing, Nothing)
342+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
343+ -- Immediate mode turns back on, and the buffer remains empty.
344+ -- We don't fire.
345+ (Just ThrottleState_Immediate, Nothing)
346+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
347+ -- Immediate mode remains off, and the buffer is cleared.
348+ -- We fire with the buffered value.
349+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just b)
350+ These a _ -> -- If both the input and delayed output event fire simultaneously:
351+ case state of
352+ ThrottleState_Immediate -> -- and we're in immediate mode
353+ -- Immediate mode turns off, and the buffer is empty.
354+ -- We fire with the input event's value, as it is the most recent we have seen at this moment.
355+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
356+ ThrottleState_Buffered ThrottleBuffer_Empty -> -- and the buffer is empty:
357+ -- Immediate mode stays off, and the buffer remains empty.
358+ -- We fire with the input event's value.
359+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just a)
360+ ThrottleState_Buffered (ThrottleBuffer_Full b) -> -- and the buffer is full:
361+ -- Immediate mode remains off, and the buffer is cleared.
362+ -- We fire with everything including the buffered value.
363+ (Just $ ThrottleState_Buffered ThrottleBuffer_Empty, Just (b <> a))
364+ rec (_stateDyn, outE) <- mapAccumMaybeDyn f
365+ ThrottleState_Immediate -- We start in immediate mode with an empty buffer.
366+ (align e delayed)
367+ delayed <- lag (void outE)
368+ return outE
369+
370+#ifdef USE_TEMPLATE_HASKELL
371+makeLensesWith (lensRules & simpleLenses .~ True) ''TickInfo
372+#else
373+tickInfo_lastUTC :: Lens' TickInfo UTCTime
374+tickInfo_lastUTC f (TickInfo x1 x2 x3) = (\y -> TickInfo y x2 x3) <$> f x1
375+{-# INLINE tickInfo_lastUTC #-}
376+
377+tickInfo_n :: Lens' TickInfo Integer
378+tickInfo_n f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 y x3) <$> f x2
379+{-# INLINE tickInfo_n #-}
380+
381+tickInfo_alreadyElapsed :: Lens' TickInfo NominalDiffTime
382+tickInfo_alreadyElapsed f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 x2 y) <$> f x3
383+{-# INLINE tickInfo_alreadyElapsed #-}
384+#endif
src/Reflex/TriggerEvent/Base.hs+43−4
@@ -13,12 +13,19 @@ module Reflex.TriggerEvent.Base
13 , EventTriggerRef (..)
13 , EventTriggerRef (..)
14 ) where
14 ) where
15
15
16+import Control.Applicative (liftA2)
16import Control.Concurrent
17import Control.Concurrent
17import Control.Monad.Exception
18import Control.Monad.Exception
19+import Control.Monad.Primitive
18import Control.Monad.Reader
20import Control.Monad.Reader
19import Control.Monad.Ref
21import Control.Monad.Ref
22+import Data.Coerce
20import Data.Dependent.Sum
23import Data.Dependent.Sum
24+import Data.IORef
25+import Data.Monoid ((<>))
26+import qualified Data.Semigroup as S
21import Reflex.Class
27import Reflex.Class
28+import Reflex.Adjustable.Class
22import Reflex.Host.Class
29import Reflex.Host.Class
23import Reflex.PerformEvent.Class
30import Reflex.PerformEvent.Class
24import Reflex.PostBuild.Class
31import Reflex.PostBuild.Class
@@ -29,21 +36,28 @@ import Reflex.TriggerEvent.Class
29data TriggerInvocation a = TriggerInvocation a (IO ())
36data TriggerInvocation a = TriggerInvocation a (IO ())
30
37
31-- | A reference to an 'EventTrigger' suitable for firing with 'TriggerEventT'.
38-- | A reference to an 'EventTrigger' suitable for firing with 'TriggerEventT'.
32−newtype EventTriggerRef t m a = EventTriggerRef { unEventTriggerRef :: Ref m (Maybe (EventTrigger t a)) }
39+newtype EventTriggerRef t a = EventTriggerRef { unEventTriggerRef :: IORef (Maybe (EventTrigger t a)) }
33
40
34-- | A basic implementation of 'TriggerEvent'.
41-- | A basic implementation of 'TriggerEvent'.
35−newtype TriggerEventT t m a = TriggerEventT { unTriggerEventT :: ReaderT (Chan [DSum (EventTriggerRef t m) TriggerInvocation]) m a } deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException, MonadAsyncException)
42+newtype TriggerEventT t m a = TriggerEventT { unTriggerEventT :: ReaderT (Chan [DSum (EventTriggerRef t) TriggerInvocation]) m a }
43+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException, MonadAsyncException)
36
44
37-- | Run a 'TriggerEventT' action. The argument should be a 'Chan' into which
45-- | Run a 'TriggerEventT' action. The argument should be a 'Chan' into which
38-- 'TriggerInvocation's can be passed; it is expected that some other thread
46-- 'TriggerInvocation's can be passed; it is expected that some other thread
39-- will be responsible for popping values out of the 'Chan' and firing their
47-- will be responsible for popping values out of the 'Chan' and firing their
40-- 'EventTrigger's.
48-- 'EventTrigger's.
41−runTriggerEventT :: TriggerEventT t m a -> Chan [DSum (EventTriggerRef t m) TriggerInvocation] -> m a
49+runTriggerEventT :: TriggerEventT t m a -> Chan [DSum (EventTriggerRef t) TriggerInvocation] -> m a
42runTriggerEventT = runReaderT . unTriggerEventT
50runTriggerEventT = runReaderT . unTriggerEventT
43
51
44instance MonadTrans (TriggerEventT t) where
52instance MonadTrans (TriggerEventT t) where
53+ {-# INLINABLE lift #-}
45 lift = TriggerEventT . lift
54 lift = TriggerEventT . lift
46
55
56+instance PrimMonad m => PrimMonad (TriggerEventT t m) where
57+ type PrimState (TriggerEventT t m) = PrimState m
58+ {-# INLINABLE primitive #-}
59+ primitive = lift . primitive
60+
47instance PerformEvent t m => PerformEvent t (TriggerEventT t m) where
61instance PerformEvent t m => PerformEvent t (TriggerEventT t m) where
48 type Performable (TriggerEventT t m) = Performable m
62 type Performable (TriggerEventT t m) = Performable m
49 {-# INLINABLE performEvent_ #-}
63 {-# INLINABLE performEvent_ #-}
@@ -104,8 +118,33 @@ instance MonadHold t m => MonadHold t (TriggerEventT t m) where
104 holdDyn v0 v' = lift $ holdDyn v0 v'
118 holdDyn v0 v' = lift $ holdDyn v0 v'
105 {-# INLINABLE holdIncremental #-}
119 {-# INLINABLE holdIncremental #-}
106 holdIncremental v0 v' = lift $ holdIncremental v0 v'
120 holdIncremental v0 v' = lift $ holdIncremental v0 v'
121+ {-# INLINABLE buildDynamic #-}
122+ buildDynamic a0 = lift . buildDynamic a0
123+ {-# INLINABLE headE #-}
124+ headE = lift . headE
125+ {-# INLINABLE now #-}
126+ now = lift now
127+
128+instance Adjustable t m => Adjustable t (TriggerEventT t m) where
129+ {-# INLINABLE runWithReplace #-}
130+ runWithReplace (TriggerEventT a0) a' = TriggerEventT $ runWithReplace a0 (coerceEvent a')
131+ {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
132+ traverseIntMapWithKeyWithAdjust f dm0 dm' = TriggerEventT $ traverseIntMapWithKeyWithAdjust (coerce . f) dm0 dm'
133+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
134+ traverseDMapWithKeyWithAdjust f dm0 dm' = TriggerEventT $ traverseDMapWithKeyWithAdjust (coerce . f) dm0 dm'
135+ {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
136+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = TriggerEventT $ traverseDMapWithKeyWithAdjustWithMove (coerce . f) dm0 dm'
137+
138+-- TODO: Monoid and Semigroup can likely be derived once ReaderT has them.
139+instance (Monoid a, Applicative m) => Monoid (TriggerEventT t m a) where
140+ mempty = pure mempty
141+ mappend = (<>)
142+
143+instance (S.Semigroup a, Applicative m) => S.Semigroup (TriggerEventT t m a) where
144+ (<>) = liftA2 (S.<>)
145+
107
146
108-- | Retrieve the current 'Chan'; event trigger invocations pushed into it will
147-- | Retrieve the current 'Chan'; event trigger invocations pushed into it will
109-- be fired.
148-- be fired.
110−askEvents :: Monad m => TriggerEventT t m (Chan [DSum (EventTriggerRef t m) TriggerInvocation])
149+askEvents :: Monad m => TriggerEventT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
111askEvents = TriggerEventT ask
150askEvents = TriggerEventT ask
src/Reflex/TriggerEvent/Class.hs+18−1
@@ -2,7 +2,6 @@
2-- new 'Event's that can be triggered from 'IO'.
2-- new 'Event's that can be triggered from 'IO'.
3{-# LANGUAGE FlexibleInstances #-}
3{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FunctionalDependencies #-}
4{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE UndecidableInstances #-}
5{-# LANGUAGE UndecidableInstances #-}
7module Reflex.TriggerEvent.Class
6module Reflex.TriggerEvent.Class
8 ( TriggerEvent (..)
7 ( TriggerEvent (..)
@@ -11,6 +10,9 @@ module Reflex.TriggerEvent.Class
11import Reflex.Class
10import Reflex.Class
12
11
13import Control.Monad.Reader
12import Control.Monad.Reader
13+import Control.Monad.State
14+import qualified Control.Monad.State.Strict as Strict
15+import Control.Monad.Trans.Maybe (MaybeT)
14
16
15--TODO: Shouldn't have IO hard-coded
17--TODO: Shouldn't have IO hard-coded
16-- | 'TriggerEvent' represents actions that can create 'Event's that can be
18-- | 'TriggerEvent' represents actions that can create 'Event's that can be
@@ -36,3 +38,18 @@ instance TriggerEvent t m => TriggerEvent t (ReaderT r m) where
36 newTriggerEvent = lift newTriggerEvent
38 newTriggerEvent = lift newTriggerEvent
37 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
39 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
38 newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
40 newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
41+
42+instance TriggerEvent t m => TriggerEvent t (StateT s m) where
43+ newTriggerEvent = lift newTriggerEvent
44+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
45+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
46+
47+instance TriggerEvent t m => TriggerEvent t (Strict.StateT s m) where
48+ newTriggerEvent = lift newTriggerEvent
49+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
50+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
51+
52+instance TriggerEvent t m => TriggerEvent t (MaybeT m) where
53+ newTriggerEvent = lift newTriggerEvent
54+ newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
55+ newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
src/Reflex/Widget/Basic.hsnew file+44
@@ -0,0 +1,44 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ExplicitForAll #-}
3+{-# LANGUAGE MultiParamTypeClasses #-}
4+{-# LANGUAGE RecursiveDo #-}
5+#ifdef USE_REFLEX_OPTIMIZER
6+{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
7+#endif
8+
9+module Reflex.Widget.Basic where
10+
11+import Control.Monad.Fix (MonadFix)
12+import Data.Map (Map)
13+
14+import Reflex.Class
15+import Reflex.Adjustable.Class
16+import Data.Patch.MapWithMove
17+
18+
19+-- | Build sortable content in such a way that re-sorting it can cause minimal
20+-- disruption to an existing context.
21+--
22+-- Naively re-sorting a list of images would destroy every image and add them back
23+-- in the new order. This framework is able to avoid that by preserving the
24+-- identity of each image and simply moving it to the new location.
25+--
26+-- Example:
27+--
28+-- > let sortByFst = buttonA $> comparing fst
29+-- > sortBySnd = buttonB $> comparing snd
30+-- > sortEvent = leftmost [sortByFst, sortBySnd]
31+-- > sortableList
32+-- > (\k v -> text $ "\n" ++ show k ++ " " ++ v) -- show each element on a new line
33+-- > (Map.fromList $ zip [0..] [(3, "a"), (2, "b"), (1, "c")])
34+-- > sortEvent
35+sortableList :: forall t m k v a. (MonadHold t m, MonadFix m, Adjustable t m, Ord k)
36+ => (k -> v -> m a) -- ^ Function to render the content for each key/value pair
37+ -> Map k v -- ^ The sortable list with an initial ordering determined by the @Map@ keys in ascending order
38+ -> Event t (v -> v -> Ordering) -- ^ An event carrying a sort function for the list
39+ -> m (Map k a)
40+sortableList f m0 reSortFunc = do
41+ rec let reSortPatch = attachWith (flip patchThatSortsMapWith) (currentIncremental m) reSortFunc
42+ m <- holdIncremental m0 reSortPatch
43+ (results, _) <- mapMapWithAdjustWithMove f m0 reSortPatch
44+ pure results
src/Reflex/Workflow.hsnew file+50
@@ -0,0 +1,50 @@
1+{-# LANGUAGE RecursiveDo #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
3+-- |
4+-- Module:
5+-- Reflex.Workflow
6+-- Description:
7+-- Provides a convenient way to describe a series of interrelated widgets that
8+-- can send data to, invoke, and replace one another. Useful for modeling user interface
9+-- "workflows."
10+module Reflex.Workflow (
11+ Workflow (..)
12+ , workflow
13+ , workflowView
14+ , mapWorkflow
15+ , mapWorkflowCheap
16+ ) where
17+
18+import Control.Arrow ((***))
19+import Control.Monad.Fix (MonadFix)
20+
21+import Reflex.Class
22+import Reflex.Adjustable.Class
23+import Reflex.Network
24+import Reflex.NotReady.Class
25+import Reflex.PostBuild.Class
26+
27+-- | A widget in a workflow
28+-- When the 'Event' returned by a 'Workflow' fires, the current 'Workflow' is replaced by the one inside the firing 'Event'. A series of 'Workflow's must share the same return type.
29+newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
30+
31+-- | Runs a 'Workflow' and returns the 'Dynamic' result of the 'Workflow' (i.e., a 'Dynamic' of the value produced by the current 'Workflow' node, and whose update 'Event' fires whenever one 'Workflow' is replaced by another).
32+workflow :: forall t m a. (Reflex t, Adjustable t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
33+workflow w0 = do
34+ rec eResult <- networkHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
35+ return $ fmap fst eResult
36+
37+-- | Similar to 'workflow', but outputs an 'Event' that fires at post-build time and whenever the current 'Workflow' is replaced by the next 'Workflow'.
38+workflowView :: forall t m a. (Reflex t, NotReady t m, Adjustable t m, MonadFix m, MonadHold t m, PostBuild t m) => Workflow t m a -> m (Event t a)
39+workflowView w0 = do
40+ rec eResult <- networkView . fmap unWorkflow =<< holdDyn w0 eReplace
41+ eReplace <- fmap switch $ hold never $ fmap snd eResult
42+ return $ fmap fst eResult
43+
44+-- | Map a function over a 'Workflow', possibly changing the return type.
45+mapWorkflow :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
46+mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
47+
48+-- | Map a "cheap" function over a 'Workflow'. Refer to the documentation for 'pushCheap' for more information and performance considerations.
49+mapWorkflowCheap :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
50+mapWorkflowCheap f (Workflow x) = Workflow (fmap (f *** fmapCheap (mapWorkflowCheap f)) x)
stylizenew file+4
@@ -0,0 +1,4 @@
1+#!/usr/bin/env bash
2+set -euo pipefail
3+
4+for x in **/*.hs ; do stylish-haskell -i "$x" ; done
test/Adjustable.hsnew file+62
@@ -0,0 +1,62 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE RecursiveDo #-}
5+
6+module Main where
7+
8+import Control.Monad.Fix
9+import Data.Maybe
10+import qualified Data.Map as Map
11+
12+import Reflex
13+import Reflex.EventWriter.Base
14+import Reflex.Network
15+import Reflex.Patch.MapWithMove
16+import Test.Run
17+
18+main :: IO ()
19+main = do
20+ let actions = [ Increment, Update0th, Increment, Swap, Increment, Increment ]
21+ os <- runAppB testPatchMapWithMove $ map Just actions
22+ -- If the final counter value in the adjusted widgets corresponds to the number of times it has
23+ -- been incremented, we know that the networks haven't broken.
24+ let expectedCount = length $ ffilter (== Increment) actions
25+ -- let !True = last (last os) == [expectedCount,expectedCount] -- TODO re-enable this test after issue #369 has been resolved
26+ return ()
27+
28+data PatchMapTestAction
29+ = Increment
30+ | Swap
31+ | Update0th
32+ deriving Eq
33+
34+-- See https://github.com/reflex-frp/reflex/issues/369 for the bug that this is testing.
35+testPatchMapWithMove
36+ :: forall t m
37+ . ( Reflex t
38+ , Adjustable t m
39+ , MonadHold t m
40+ , MonadFix m
41+ )
42+ => Event t PatchMapTestAction
43+ -> m (Behavior t [Int])
44+testPatchMapWithMove pulse = do
45+ let pulseAction = ffor pulse $ \case
46+ Increment -> Nothing
47+ Swap -> patchMapWithMove $ Map.fromList
48+ [ (0, NodeInfo (From_Move 1) (Just 1))
49+ , (1, NodeInfo (From_Move 0) (Just 0))
50+ ]
51+ Update0th -> patchMapWithMove $ Map.fromList
52+ [ (0, NodeInfo (From_Insert 'z') Nothing) ]
53+ (_, result) <- runBehaviorWriterT $ mdo
54+ counter <- foldDyn (+) 1 $ fmapMaybe (\e -> if isNothing e then Just 1 else Nothing) pulseAction
55+ _ <- mapMapWithAdjustWithMove
56+ (\_ _ -> networkHold
57+ (tellBehavior $ constant [])
58+ ((\t -> tellBehavior $ constant [t]) <$> updated counter))
59+ (Map.fromList $ zip [0..] "ab")
60+ (fmapMaybe id pulseAction)
61+ return ()
62+ return result
test/DebugCycles.hsnew file+171
@@ -0,0 +1,171 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE PatternSynonyms #-}
8+{-# LANGUAGE RankNTypes #-}
9+
10+module Main where
11+
12+import Data.Foldable
13+import Control.Lens
14+import Control.Applicative
15+import Control.Monad
16+import Control.Monad.Fix
17+import Control.Exception
18+import System.Timeout
19+import Data.Maybe (isJust)
20+import Data.Functor.Misc
21+import qualified Data.Map as Map
22+import Data.Map (Map)
23+import qualified Data.IntMap as IntMap
24+import Data.IntMap (IntMap)
25+import Data.These
26+import Data.Align
27+import Reflex
28+import Reflex.EventWriter.Base
29+import Test.Run
30+import Test.Hspec
31+import Reflex.Spider.Internal (EventLoopException)
32+import Data.Witherable (Filterable)
33+
34+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
35+import Data.These.Lens
36+#endif
37+
38+type Widget t m = (MonadHold t m, Reflex t, MonadFix m)
39+
40+connectDyn :: Widget t m => Event t () -> (Dynamic t a, Dynamic t a) -> m (Dynamic t a)
41+connectDyn e (d, d') = do
42+ dd <- holdDyn d (d' <$ e)
43+ return $ join dd
44+
45+dynLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
46+dynLoop (e1, e2) = do
47+ -- "heightBagRemove: Height 2 not present in bag HeightBag {_heightBag_size = 2, _heightBag_contents = fromList [(0,1)]}"
48+ rec
49+ d <- count e1
50+ d' <- connectDyn e2 (d, liftA2 (+) d d')
51+ return $ updated d'
52+
53+connectOnCoincidence :: Widget t m => Event t () -> Event t a -> m (Event t a)
54+connectOnCoincidence click e = do
55+ d <- holdDyn never (e <$ click)
56+ return $ coincidence (updated d)
57+
58+coincidenceLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
59+coincidenceLoop (e1, e2) = do
60+-- "heightBagRemove: Height 1 not present in bag HeightBag {_heightBag_size = 1, _heightBag_contents = fromList [(0,0)]}"
61+-- (simpler version of dynLoop)
62+ rec
63+ e' <- connectOnCoincidence e2 (updated d)
64+ d <- count (align e' e1)
65+ return $ updated d
66+
67+addHeight :: Reflex t => Event t a -> Event t a
68+addHeight e = leftmost [e4, e4] where
69+ e1 = leftmost [e, e]
70+ e2 = leftmost [e1, e1]
71+ e3 = leftmost [e2, e2]
72+ e4 = leftmost [e3, e3]
73+
74+-- Take an existing test and build it inside a
75+buildLoop :: Widget t m => (forall t m. Widget t m => (Event t Int, Event t ()) -> m (Event t Int)) -> (Event t Int, Event t ()) -> m (Event t Int)
76+buildLoop test (e1, e2) = switchHold never buildLoop
77+ where buildLoop = pushAlways (const $ test (e1, e2)) e2
78+
79+connectButtonPromptly :: Widget t m => Event t () -> Event t a -> m (Event t a)
80+connectButtonPromptly click e = do
81+ d <- holdDyn never (e <$ click)
82+ return (switchDyn d)
83+
84+connectButton :: Widget t m => Event t () -> Event t a -> m (Event t a)
85+connectButton click e = do
86+ d <- hold never (e <$ click)
87+ return (switch d)
88+
89+switchLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
90+switchLoop01 (e1, e2) = do
91+ rec
92+ e' <- connectButton e2 (updated d)
93+ d <- count (align e' e1)
94+ return $ updated d
95+
96+mergeLoop :: forall t m. (Adjustable t m, Widget t m) => (Event t Int, Event t ()) -> m (Event t Int)
97+mergeLoop (e1, e2) = do
98+ rec
99+ (_, e) <- runEventWriterT $
100+ runWithReplace w (leftmost [w <$ e1])
101+ return (sum <$> e)
102+ where
103+ w = do
104+ c <- count e1
105+ tellEvent (updated ((pure <$> c) :: Dynamic t [Int]))
106+
107+switchLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
108+switchLoop02 (e1, e2) = do
109+ rec
110+ e' <- connectButton e2 (updated d)
111+ d <- count (leftmost [e', e1])
112+ return $ updated d
113+
114+switchLoop03 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
115+switchLoop03 (e1, e2) = do
116+ rec
117+ e' <- connectButton e2 (addHeight $ updated d)
118+ d <- count (align e' e1)
119+ return $ updated d
120+
121+staticLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
122+staticLoop01 (e1, e2) = do
123+ rec
124+ d <- foldDyn (+) (0 :: Int) (1 <$ align e1 (updated d))
125+ return $ updated d
126+
127+staticLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
128+staticLoop02 (e1, e2) = do
129+ rec
130+ d <- foldDyn (+) (0 :: Int) (leftmost [e1, updated d])
131+ return $ updated d
132+
133+buildStaticLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
134+buildStaticLoop (e1, e2) = switchHold never buildLoop
135+ where buildLoop = pushAlways (const $ staticLoop01 (e1, e2)) e2
136+
137+splitThese :: Filterable f => f (These a b) -> (f a, f b)
138+splitThese f = (mapMaybe (preview here) f, mapMaybe (preview there) f)
139+
140+main :: IO ()
141+main = hspec $ do
142+ describe "DebugCycles" $ do
143+ it "throws EventLoopException on switchLoop01" $ do
144+ check switchLoop01
145+ it "throws EventLoopException on switchLoop02" $ do
146+ check switchLoop02
147+ it "throws EventLoopException on switchLoop03" $ do
148+ check switchLoop03
149+ it "throws EventLoopException on buildSwitchLoop" $ do
150+ check $ buildLoop switchLoop01
151+ xit "throws EventLoopException on mergeLoop" $ do
152+ check mergeLoop
153+ xit "throws EventLoopException on staticLoop01" $ do
154+ check staticLoop01
155+ xit "throws EventLoopException on staticLoop02" $ do
156+ check staticLoop02
157+ xit "throws EventLoopException on buildStaticLoop" $ do
158+ check buildStaticLoop
159+ xit "throws EventLoopException on coincidenceLoop" $ do
160+ check coincidenceLoop
161+ xit "throws EventLoopException on dynLoop" $ do
162+ check dynLoop
163+ xit "throws EventLoopException on buildCoincidenceLoop" $ do
164+ check $ buildLoop coincidenceLoop
165+ where
166+ milliseconds = (*1000)
167+ occs = [ This 1, This 2, That (), This 3, That (), This 1 ]
168+ check test = do
169+ let action = timeout (milliseconds 50) $ do
170+ runApp' (test . splitThese) (Just <$> occs)
171+ action `shouldThrow` (const True :: Selector EventLoopException)
test/EventWriterT.hs+126−53
@@ -1,61 +1,134 @@
1−{-# LANGUAGE FlexibleContexts, GADTs #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
2module Main where
7module Main where
3
8
9+import Control.Lens
4import Control.Monad
10import Control.Monad
5−import Control.Monad.IO.Class
11+import Control.Monad.Fix
6−import Control.Monad.Ref
12+import qualified Data.Dependent.Map as DMap
7−import Data.Dependent.Sum
13+import Data.Functor.Misc
8−import Data.IORef
14+import qualified Data.Map as M
9−import Data.List
15+import Data.These
10−import Data.Functor.Identity
11
16
12−import Reflex
17+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
13−import Reflex.EventWriter
18+import Data.These.Lens
14−import Reflex.Host.Class
19+#endif
15−import Reflex.PerformEvent.Base
16
20
17−import System.Exit (exitFailure)
21+import Reflex
22+import Reflex.EventWriter.Base
23+import Test.Run
18
24
19main :: IO ()
25main :: IO ()
20main = do
26main = do
21− (Just out1, Nothing) <- runApp app1
27+ os1@[[Just [10,9,8,7,6,5,4,3,2,1]]] <- runApp' (unwrapApp testOrdering) $
22− print out1
28+ [ Just ()
23− (Just out2, Just (out3, out4)) <- runApp app2
29+ ]
24− print out2
30+ print os1
25− print out3
31+ os2@[[Just [1,3,5,7,9]],[Nothing,Nothing],[Just [2,4,6,8,10]],[Just [2,4,6,8,10],Nothing]]
26− print out4
32+ <- runApp' (unwrapApp testSimultaneous) $ map Just $
27− when (sort out1 /= out1 || map (+1) out2 /= out3 || out3 /= out4) exitFailure
33+ [ This ()
28−
34+ , That ()
29−runApp :: (Show a, t ~ SpiderTimeline Global, m ~ SpiderHost Global)
35+ , This ()
30− => (Event t () -> EventWriterT t [a] (PerformEventT t m) (Maybe (Ref m (Maybe (EventTrigger t ())))))
36+ , These () ()
31− -> IO (Maybe [a], Maybe ([a], [a]))
37+ ]
32−runApp x = runSpiderHost $ do
38+ print os2
33− (pulseE, pulseTriggerRef) <- newEventWithTriggerRef
39+ os3@[[Nothing, Just [2]]] <- runApp' (unwrapApp testMoribundTellEvent) [Just ()]
34− ((mactuateRef, e), FireCommand fire) <- hostPerformEventT $ runEventWriterT (x pulseE)
40+ print os3
35− hnd <- subscribeEvent e
41+ os4@[[Nothing, Just [2]]] <- runApp' (unwrapApp testMoribundTellEventDMap) [Just ()]
36− out1 <- fireEventRefAndRead pulseTriggerRef () hnd
42+ print os4
37− out2 <- fmap join $ forM mactuateRef $ \actuateRef -> do
43+ os5@[[Nothing, Just [1, 2]]] <- runApp' (unwrapApp testLiveTellEventDMap) [Just ()]
38− let readPhase = do
44+ print os5
39− mGetValue <- readEvent hnd
45+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
40− case mGetValue of
46+ print os6
41− Nothing -> return Nothing
47+ let ![[Nothing, Nothing]] = os6
42− Just getValue -> fmap Just getValue
48+ return ()
43− mactuate <- readRef actuateRef
49+
44− mpulse <- readRef pulseTriggerRef
50+unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
45− forM ((,) <$> mactuate <*> mpulse) $ \(actuate, pulse) -> do
51+unwrapApp x appIn = do
46− _ <- fire [actuate :=> Identity ()] $ return ()
52+ ((), e) <- runEventWriterT $ x appIn
47− [Just a] <- fire [pulse :=> Identity ()] $ readPhase
53+ return e
48− [Just b, Nothing] <- fire [actuate :=> Identity (), pulse :=> Identity ()] $ readPhase
54+
49− return (a,b)
55+testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
50− return (out1, out2)
56+testOrdering pulse = forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
51−
57+
52−app1 :: (Reflex t, Ref m ~ IORef, EventWriter t [Int] m) => Event t () -> m (Maybe (Ref m (Maybe (EventTrigger t ()))))
58+testSimultaneous :: (Reflex t, Adjustable t m, MonadHold t m) => Event t (These () ()) -> EventWriterT t [Int] m ()
53−app1 e = do
59+testSimultaneous pulse = do
54− forM_ [1..10] $ \i -> tellEvent ([i] <$ e)
60+ let e0 = fmapMaybe (^? here) pulse
55− return Nothing
61+ e1 = fmapMaybe (^? there) pulse
56−
62+ forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
57−app2 :: (Reflex t, Ref m ~ IORef, EventWriter t [Int] m, MonadAdjust t m, MonadReflexCreateTrigger t m, MonadRef m) => Event t () -> m (Maybe (Ref m (Maybe (EventTrigger t ()))))
63+
58−app2 e = do
64+-- | Test that a widget telling and event which fires at the same time it has been replaced
59− (pulse, pulseTriggerRef) <- newEventWithTriggerRef
65+-- doesn't count along with the new widget.
60− forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e)) $ ffor pulse $ \_ -> tellEvent ([i+1] <$ e)
66+testMoribundTellEvent
61− return (Just pulseTriggerRef)
67+ :: forall t m
68+ . ( Reflex t
69+ , Adjustable t m
70+ , MonadHold t m
71+ , MonadFix m
72+ )
73+ => Event t ()
74+ -> EventWriterT t [Int] m ()
75+testMoribundTellEvent pulse = do
76+ rec let tellIntOnReplace :: Int -> EventWriterT t [Int] m ()
77+ tellIntOnReplace x = tellEvent $ [x] <$ rwrFinished
78+ (_, rwrFinished) <- runWithReplace (tellIntOnReplace 1) $ tellIntOnReplace 2 <$ pulse
79+ return ()
80+
81+-- | The equivalent of 'testMoribundTellEvent' for 'traverseDMapWithKeyWithAdjust'.
82+testMoribundTellEventDMap
83+ :: forall t m
84+ . ( Reflex t
85+ , Adjustable t m
86+ , MonadHold t m
87+ , MonadFix m
88+ )
89+ => Event t ()
90+ -> EventWriterT t [Int] m ()
91+testMoribundTellEventDMap pulse = do
92+ rec let tellIntOnReplace :: Int -> EventWriterT t [Int] m ()
93+ tellIntOnReplace x = tellEvent $ [x] <$ rwrFinished
94+ (_, rwrFinished :: Event t (PatchDMap (Const2 () Int) Identity)) <-
95+ traverseDMapWithKeyWithAdjust
96+ (\(Const2 ()) (Identity v) -> Identity . const v <$> tellIntOnReplace v)
97+ (mapToDMap $ M.singleton () 1)
98+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton () 2) <$ pulse)
99+ return ()
100+
101+-- | Ensures that elements which are _not_ removed can still fire 'tellEvent's
102+-- during the same frame as other elements are updated.
103+testLiveTellEventDMap
104+ :: forall t m
105+ . ( Reflex t
106+ , Adjustable t m
107+ , MonadHold t m
108+ , MonadFix m
109+ )
110+ => Event t ()
111+ -> EventWriterT t [Int] m ()
112+testLiveTellEventDMap pulse = do
113+ rec let tellIntOnReplace :: Int -> EventWriterT t [Int] m ()
114+ tellIntOnReplace x = tellEvent $ [x] <$ rwrFinished
115+ (_, rwrFinished :: Event t (PatchDMap (Const2 Int ()) Identity)) <-
116+ traverseDMapWithKeyWithAdjust
117+ (\(Const2 k) (Identity ()) -> Identity <$> tellIntOnReplace k)
118+ (mapToDMap $ M.singleton 1 ())
119+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
120+ return ()
121+
122+delayedPulse
123+ :: forall t m
124+ . ( Reflex t
125+ , Adjustable t m
126+ , MonadHold t m
127+ , MonadFix m
128+ )
129+ => Event t ()
130+ -> EventWriterT t [Int] m ()
131+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
132+ -- This has the effect of delaying pulse' from pulse
133+ (_, pulse') <- runWithReplace (pure ()) $ pure [1] <$ pulse
134+ tellEvent pulse'
test/GC.hs+14−8
@@ -1,4 +1,9 @@
1−{-# LANGUAGE OverloadedStrings, FlexibleContexts, GADTs, TypeFamilies, RankNTypes, ScopedTypeVariables, LambdaCase #-}
1+{-# LANGUAGE FlexibleContexts #-}
2+{-# LANGUAGE GADTs #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE RankNTypes #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE TypeFamilies #-}
2module Main where
7module Main where
3
8
4import Control.Monad
9import Control.Monad
@@ -13,15 +18,17 @@ import Data.GADT.Compare
13import Data.IORef
18import Data.IORef
14import Data.Semigroup
19import Data.Semigroup
15import Data.These
20import Data.These
21+import Data.Type.Equality ((:~:)(Refl))
16
22
17import Data.Functor.Misc
23import Data.Functor.Misc
18−import Reflex.Patch
24+import Data.Patch
19
25
20−import qualified Reflex.Spider.Internal as S
21import qualified Reflex.Host.Class as Host
26import qualified Reflex.Host.Class as Host
27+import qualified Reflex.Spider.Internal as S
22
28
23−import System.Mem
24import System.Exit
29import System.Exit
30+import System.Mem
31+import Data.Coerce
25
32
26main :: IO ()
33main :: IO ()
27main = do
34main = do
@@ -41,7 +48,7 @@ hostPerf ref = S.runSpiderHost $ do
41 eventToPerform <- Host.runHostFrame $ do
48 eventToPerform <- Host.runHostFrame $ do
42 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
49 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
43 <- S.SpiderHostFrame
50 <- S.SpiderHostFrame
44− $ fmap ( S.merge
51+ $ fmap ( S.mergeG coerce
45 . S.dynamicHold)
52 . S.dynamicHold)
46 $ S.hold DMap.empty
53 $ S.hold DMap.empty
47 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
54 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
@@ -50,8 +57,8 @@ hostPerf ref = S.runSpiderHost $ do
50 { S.subscriberPropagate = S.subscriberPropagate sub
57 { S.subscriberPropagate = S.subscriberPropagate sub
51 }
58 }
52 return (s, o))
59 return (s, o))
53− $ runIdentity <$> S.select
60+ $ runIdentity . runIdentity <$> S.selectG
54− (S.fan $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
61+ (S.fanG $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
55 (WrapArg Request)
62 (WrapArg Request)
56 return $ alignWith (mergeThese (<>))
63 return $ alignWith (mergeThese (<>))
57 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
64 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
@@ -77,7 +84,6 @@ hostPerf ref = S.runSpiderHost $ do
77 Nothing -> []
84 Nothing -> []
78 Host.fireEventsAndRead followupEventTriggers $ return ()
85 Host.fireEventsAndRead followupEventTriggers $ return ()
79 return ()
86 return ()
80− return ()
81
87
82data Tell a where
88data Tell a where
83 Action :: Tell ()
89 Action :: Tell ()
test/Headless.hsnew file+10
@@ -0,0 +1,10 @@
1+module Main where
2+
3+import Reflex
4+import Reflex.Host.Headless (runHeadlessApp)
5+
6+main :: IO ()
7+main = do
8+ runHeadlessApp $ do
9+ pb <- getPostBuild
10+ performEvent (pure <$> pb)
test/QueryT.hsnew file+142
@@ -0,0 +1,142 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFunctor #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+
11+import Control.Lens
12+import Control.Monad.Fix
13+import Data.Align
14+import qualified Data.AppendMap as AMap
15+import Data.Functor.Misc
16+import Data.Map (Map)
17+import qualified Data.Map as Map
18+import Data.Map.Monoidal (MonoidalMap)
19+import Data.Semigroup
20+import Data.These
21+
22+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
23+import Data.These.Lens
24+#endif
25+
26+import Reflex
27+import Data.Patch.MapWithMove
28+import Test.Run
29+
30+newtype MyQuery = MyQuery SelectedCount
31+ deriving (Show, Read, Eq, Ord, Monoid, Semigroup, Additive, Group)
32+
33+instance Query MyQuery where
34+ type QueryResult MyQuery = ()
35+ crop _ _ = ()
36+
37+instance (Ord k, Query a, Eq (QueryResult a), Align (MonoidalMap k)) => Query (Selector k a) where
38+ type QueryResult (Selector k a) = Selector k (QueryResult a)
39+ crop q r = undefined
40+
41+newtype Selector k a = Selector { unSelector :: MonoidalMap k a }
42+ deriving (Show, Read, Eq, Ord, Functor)
43+
44+#if !(MIN_VERSION_monoidal_containers(0,4,1))
45+deriving instance Ord k => Align (MonoidalMap k)
46+#endif
47+
48+instance (Ord k, Eq a, Monoid a, Align (MonoidalMap k)) => Semigroup (Selector k a) where
49+ (Selector a) <> (Selector b) = Selector $ fmapMaybe id $ f a b
50+ where
51+ f = alignWith $ \case
52+ This x -> Just x
53+ That y -> Just y
54+ These x y ->
55+ let z = x `mappend` y
56+ in if z == mempty then Nothing else Just z
57+
58+instance (Ord k, Eq a, Monoid a, Align (MonoidalMap k)) => Monoid (Selector k a) where
59+ mempty = Selector AMap.empty
60+ mappend = (<>)
61+
62+instance (Eq a, Ord k, Group a, Align (MonoidalMap k)) => Group (Selector k a) where
63+ negateG = fmap negateG
64+
65+instance (Eq a, Ord k, Group a, Align (MonoidalMap k)) => Additive (Selector k a)
66+
67+main :: IO ()
68+main = do
69+ [0, 1, 1, 0] <- fmap (map fst . concat) $
70+ runApp (testQueryT testRunWithReplace) () $ map (Just . That) $
71+ [ That (), This (), That () ]
72+ [0, 1, 1, 0] <- fmap (map fst . concat) $
73+ runApp (testQueryT testSequenceDMapWithAdjust) () $ map (Just . That) $
74+ [ That (), This (), That () ]
75+ [0, 1, 1, 0] <- fmap (map fst . concat) $
76+ runApp (testQueryT testSequenceDMapWithAdjustWithMove) () $ map (Just . That) $
77+ [ That (), This (), That () ]
78+ return ()
79+
80+testQueryT :: (Reflex t, MonadFix m)
81+ => (Event t () -> Event t () -> QueryT t (Selector Int MyQuery) m ())
82+ -> AppIn t () (These () ())
83+ -> m (AppOut t Int Int)
84+testQueryT w (AppIn _ pulse) = do
85+ let replace = fmapMaybe (^? here) pulse
86+ increment = fmapMaybe (^? there) pulse
87+ (_, q) <- runQueryT (w replace increment) $ pure mempty
88+ let qDyn = head . AMap.keys . unSelector <$> incrementalToDynamic q
89+ return $ AppOut
90+ { _appOut_behavior = current qDyn
91+ , _appOut_event = updated qDyn
92+ }
93+
94+testRunWithReplace :: ( Reflex t
95+ , Adjustable t m
96+ , MonadHold t m
97+ , MonadFix m
98+ , MonadQuery t (Selector Int MyQuery) m)
99+ => Event t ()
100+ -> Event t ()
101+ -> m ()
102+testRunWithReplace replace increment = do
103+ let w = do
104+ n <- count increment
105+ queryDyn $ zipDynWith (\x y -> Selector (AMap.singleton (x :: Int) y)) n $ pure $ MyQuery $ SelectedCount 1
106+ _ <- runWithReplace w $ w <$ replace
107+ return ()
108+
109+testSequenceDMapWithAdjust :: ( Reflex t
110+ , Adjustable t m
111+ , MonadHold t m
112+ , MonadFix m
113+ , MonadQuery t (Selector Int MyQuery) m)
114+ => Event t ()
115+ -> Event t ()
116+ -> m ()
117+testSequenceDMapWithAdjust replace increment = do
118+ _ <- listHoldWithKey (Map.singleton () ()) (Map.singleton () (Just ()) <$ replace) $ \_ _ -> do
119+ n <- count increment
120+ queryDyn $ zipDynWith (\x y -> Selector (AMap.singleton (x :: Int) y)) n $ pure $ MyQuery $ SelectedCount 1
121+ return ()
122+
123+testSequenceDMapWithAdjustWithMove :: ( Reflex t
124+ , Adjustable t m
125+ , MonadHold t m
126+ , MonadFix m
127+ , MonadQuery t (Selector Int MyQuery) m)
128+ => Event t ()
129+ -> Event t ()
130+ -> m ()
131+testSequenceDMapWithAdjustWithMove replace increment = do
132+ _ <- listHoldWithKeyWithMove (Map.singleton () ()) (Map.singleton () (Just ()) <$ replace) $ \_ _ -> do
133+ n <- count increment
134+ queryDyn $ zipDynWith (\x y -> Selector (AMap.singleton (x :: Int) y)) n $ pure $ MyQuery $ SelectedCount 1
135+ return ()
136+
137+-- scam it out to test traverseDMapWithAdjustWithMove
138+listHoldWithKeyWithMove :: forall t m k v a. (Ord k, MonadHold t m, Adjustable t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> m a) -> m (Dynamic t (Map k a))
139+listHoldWithKeyWithMove m0 m' f = do
140+ (n0, n') <- mapMapWithAdjustWithMove f m0 $ ffor m' $ PatchMapWithMove . Map.map (\v -> NodeInfo (maybe From_Delete From_Insert v) Nothing)
141+ incrementalToDynamic <$> holdIncremental n0 n'
142+-- -}
test/Reflex/Bench/Focused.hs+13−1
@@ -130,6 +130,16 @@ mapDynChain = iterM (return . fmap (+1))
130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
132
132
133+holdDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134+holdDynChain = iterM (\d -> sample (current d) >>= flip holdDyn (updated d))
135+
136+buildDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
137+buildDynChain = iterM (\d -> do
138+ let b = fmap (+1) (current d)
139+ e = fmap (*2) (updated d)
140+ buildDynamic (sample b) e)
141+
142+
133combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
143combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
144combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
135
145
@@ -184,7 +194,7 @@ switchMergeBehaviors mapChanges = pull . joinMap <$> holdMap mapChanges
184
194
185-- | Turn an UpdatedMap into a Dynamic by applying the differences to the initial value
195-- | Turn an UpdatedMap into a Dynamic by applying the differences to the initial value
186holdMapDyn :: (Reflex t, MonadHold t m, MonadFix m, Ord k) => UpdatedMap t k a -> m (Dynamic t (Map k a))
196holdMapDyn :: (Reflex t, MonadHold t m, MonadFix m, Ord k) => UpdatedMap t k a -> m (Dynamic t (Map k a))
187−holdMapDyn (UpdatedMap initial changes) = foldDyn (flip (Map.foldWithKey modify)) initial changes
197+holdMapDyn (UpdatedMap initial changes) = foldDyn (flip (Map.foldrWithKey modify)) initial changes
188
198
189 where
199 where
190 modify k Nothing items = Map.delete k items
200 modify k Nothing items = Map.delete k items
@@ -308,6 +318,8 @@ dynamics :: Word -> [(String, TestCase)]
308dynamics n =
318dynamics n =
309 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
319 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
310 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
320 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
321+ , testE "holdDynChain" $ fmap updated $ holdDynChain n =<< d
322+ , testE "buildDynChain" $ fmap updated $ buildDynChain n =<< d
311 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
323 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
312 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
324 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
313 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
325 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
test/Reflex/Plan/Pure.hs+7−4
@@ -39,6 +39,9 @@ instance MonadHold (Pure Int) PurePlan where
39 hold initial = liftPlan . hold initial
39 hold initial = liftPlan . hold initial
40 holdDyn initial = liftPlan . holdDyn initial
40 holdDyn initial = liftPlan . holdDyn initial
41 holdIncremental initial = liftPlan . holdIncremental initial
41 holdIncremental initial = liftPlan . holdIncremental initial
42+ buildDynamic getInitial = liftPlan . buildDynamic getInitial
43+ headE = liftPlan . headE
44+ now = liftPlan now
42
45
43instance MonadSample (Pure Int) PurePlan where
46instance MonadSample (Pure Int) PurePlan where
44 sample = liftPlan . sample
47 sample = liftPlan . sample
@@ -53,15 +56,15 @@ instance TestPlan (Pure Int) PurePlan where
53runPure :: PurePlan a -> (a, IntSet)
56runPure :: PurePlan a -> (a, IntSet)
54runPure (PurePlan p) = runStateT p mempty $ 0
57runPure (PurePlan p) = runStateT p mempty $ 0
55
58
56−relavantTimes :: IntSet -> IntSet
59+relevantTimes :: IntSet -> IntSet
57−relavantTimes occs = IntSet.fromList [0..l + 1]
60+relevantTimes occs = IntSet.fromList [0..l + 1]
58 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
61 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
59
62
60testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
63testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
61−testBehavior (b, occs) = IntMap.fromSet (sample b) (relavantTimes occs)
64+testBehavior (b, occs) = IntMap.fromSet (sample b) (relevantTimes occs)
62
65
63testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
66testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
64−testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relavantTimes occs)
67+testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relevantTimes occs)
65
68
66
69
67
70
test/Reflex/Plan/Reflex.hs+2−2
@@ -74,13 +74,13 @@ deriving instance ReflexHost t => MonadFix (Plan t)
74
74
75
75
76instance (ReflexHost t, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO) => TestPlan t (Plan t) where
76instance (ReflexHost t, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO) => TestPlan t (Plan t) where
77− plan occurances = Plan $ do
77+ plan occurrences = Plan $ do
78 (e, ref) <- newEventWithTriggerRef
78 (e, ref) <- newEventWithTriggerRef
79 modify (IntMap.unionWith mappend (firings ref))
79 modify (IntMap.unionWith mappend (firings ref))
80 return e
80 return e
81
81
82 where
82 where
83− firings ref = IntMap.fromList (makeFiring ref <$> occurances)
83+ firings ref = IntMap.fromList (makeFiring ref <$> occurrences)
84 makeFiring ref (t, a) = (fromIntegral t, [Firing ref a])
84 makeFiring ref (t, a) = (fromIntegral t, [Firing ref a])
85
85
86
86
test/Reflex/Test/CrossImpl.hs+58−35
@@ -4,15 +4,14 @@
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FunctionalDependencies #-}
5{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE GADTs #-}
6{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE LambdaCase #-}
8{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
9{-# LANGUAGE NoMonomorphismRestriction #-}
8{-# LANGUAGE NoMonomorphismRestriction #-}
10{-# LANGUAGE RankNTypes #-}
9{-# LANGUAGE RankNTypes #-}
10+{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE ScopedTypeVariables #-}
12{-# LANGUAGE TypeFamilies #-}
12{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeOperators #-}
13{-# LANGUAGE TypeOperators #-}
14{-# LANGUAGE UndecidableInstances #-}
14{-# LANGUAGE UndecidableInstances #-}
15−module Reflex.Test.CrossImpl (test) where
16
15
17import Prelude hiding (and, foldl, mapM, mapM_, sequence, sequence_)
16import Prelude hiding (and, foldl, mapM, mapM_, sequence, sequence_)
18
17
@@ -22,22 +21,21 @@ import Reflex.Dynamic
22import Reflex.Host.Class
21import Reflex.Host.Class
23import qualified Reflex.Pure as P
22import qualified Reflex.Pure as P
24import qualified Reflex.Spider.Internal as S
23import qualified Reflex.Spider.Internal as S
24+import qualified Reflex.Profiled as Prof
25
25
26import Control.Arrow (second, (&&&))
26import Control.Arrow (second, (&&&))
27import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
27import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
28import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
28import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
29−import Control.Monad.Writer hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
29+import Data.Dependent.Sum (DSum (..))
30−import Data.Dependent.Map (DSum (..))
31import Data.Foldable
30import Data.Foldable
32import Data.Map.Strict (Map)
31import Data.Map.Strict (Map)
33import qualified Data.Map.Strict as Map
32import qualified Data.Map.Strict as Map
34import qualified Data.Set as Set
33import qualified Data.Set as Set
34+import Data.Monoid
35import Data.Traversable
35import Data.Traversable
36import System.Exit
36import System.Exit
37import System.Mem
37import System.Mem
38
38
39−import System.IO.Unsafe
40−
41mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
39mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
42mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
40mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
43 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
41 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
@@ -74,11 +72,14 @@ instance MapMSignals (Event t a) (Event t' a) t t' where
74instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
72instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
75 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
73 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
76
74
77−testSpider :: (forall m t. TestCaseConstraint t m => (Behavior t a, Event t b) -> m (Behavior t c, Event t d)) -> (Map Int a, Map Int b) -> (Map Int c, Map Int d)
75+testTimeline
78−testSpider builder (bMap, eMap) = unsafePerformIO $ S.runSpiderHost $ do
76+ :: (forall m t. TestCaseConstraint t m => (Behavior t a, Event t b) -> m (Behavior t c, Event t d))
77+ -> (Map Int a, Map Int b)
78+ -> (forall m t. (MonadReflexHost t m, MonadIO m, MonadRef m, Ref m ~ Ref IO, MonadSample t m) => m (Map Int c, Map Int d))
79+testTimeline builder (bMap, eMap) = do
79 (re, reTrigger) <- newEventWithTriggerRef
80 (re, reTrigger) <- newEventWithTriggerRef
80 (rb, rbTrigger) <- newEventWithTriggerRef
81 (rb, rbTrigger) <- newEventWithTriggerRef
81− b <- runHostFrame $ hold (error "testSpider: No value for input behavior yet") rb
82+ b <- runHostFrame $ hold (error "testTimeline: No value for input behavior yet") rb
82 (b', e') <- runHostFrame $ builder (b, re)
83 (b', e') <- runHostFrame $ builder (b, re)
83 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
84 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
84 let times = relevantTestingTimes (bMap, eMap)
85 let times = relevantTestingTimes (bMap, eMap)
@@ -103,15 +104,19 @@ testAgreement :: (Eq c, Eq d, Show c, Show d) => (forall m t. TestCaseConstraint
103testAgreement builder inputs = do
104testAgreement builder inputs = do
104 let identityResult = testPure builder inputs
105 let identityResult = testPure builder inputs
105 tracePerf "---------" $ return ()
106 tracePerf "---------" $ return ()
106− let spiderResult = testSpider builder inputs
107+ spiderResult <- S.runSpiderHost $ testTimeline builder inputs
108+ tracePerf "---------" $ return ()
109+ profiledResult <- S.runSpiderHost $ Prof.runProfiledM $ testTimeline builder inputs
107 tracePerf "---------" $ return ()
110 tracePerf "---------" $ return ()
108− let resultsAgree = identityResult == spiderResult
111+ let resultsAgree = identityResult == spiderResult && identityResult == profiledResult
109 if resultsAgree
112 if resultsAgree
110− then do putStrLn "Success:"
113+ then do --putStrLn "Success:"
111− print identityResult
114+ --print identityResult
115+ return ()
112 else do putStrLn "Failure:"
116 else do putStrLn "Failure:"
113 putStrLn $ "Pure result: " <> show identityResult
117 putStrLn $ "Pure result: " <> show identityResult
114 putStrLn $ "Spider result: " <> show spiderResult
118 putStrLn $ "Spider result: " <> show spiderResult
119+ putStrLn $ "Profiled result: " <> show profiledResult
115 return resultsAgree
120 return resultsAgree
116
121
117type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
122type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
@@ -127,8 +132,8 @@ testCases =
127 e' <- updated <$> count e
132 e' <- updated <$> count e
128 b' <- hold (0 :: Int) e'
133 b' <- hold (0 :: Int) e'
129 return (b', e')
134 return (b', e')
130− , (,) "onceE-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
135+ , (,) "headE-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
131− e' <- onceE $ leftmost [e, e]
136+ e' <- headE $ leftmost [e, e]
132 return (b, e')
137 return (b, e')
133 , (,) "switch-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
138 , (,) "switch-1" $ TestCase (Map.singleton 0 "asdf", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
134 let e' = fmap (const e) e
139 let e' = fmap (const e) e
@@ -151,35 +156,35 @@ testCases =
151 let e' = leftmost [e, e]
156 let e' = leftmost [e, e]
152 e'' <- switch <$> hold e' (fmap (const e) e)
157 e'' <- switch <$> hold e' (fmap (const e) e)
153 return (b, e'')
158 return (b, e'')
154− , (,) "switchPromptly-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
159+ , (,) "switchHoldPromptly-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
155 let e' = fmap (const e) e
160 let e' = fmap (const e) e
156− e'' <- switchPromptly never e'
161+ e'' <- switchHoldPromptly never e'
157 return (b, e'')
162 return (b, e'')
158− , (,) "switchPromptly-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
163+ , (,) "switchHoldPromptly-2" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
159 let e' = fmap (const e) e
164 let e' = fmap (const e) e
160− e'' <- switchPromptly never $ leftmost [e', e']
165+ e'' <- switchHoldPromptly never $ leftmost [e', e']
161 return (b, e'')
166 return (b, e'')
162− , (,) "switchPromptly-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
167+ , (,) "switchHoldPromptly-3" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
163 let e' = leftmost [e, e]
168 let e' = leftmost [e, e]
164− e'' <- switchPromptly never (fmap (const e) e')
169+ e'' <- switchHoldPromptly never (fmap (const e) e')
165 return (b, e'')
170 return (b, e'')
166− , (,) "switchPromptly-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
171+ , (,) "switchHoldPromptly-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
167 let e' = leftmost [e, e]
172 let e' = leftmost [e, e]
168− e'' <- switchPromptly never (fmap (const e') e)
173+ e'' <- switchHoldPromptly never (fmap (const e') e)
169 return (b, e'')
174 return (b, e'')
170 , (,) "switch-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
175 , (,) "switch-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
171 let e' = leftmost [e, e]
176 let e' = leftmost [e, e]
172 e'' <- switch <$> hold never (fmap (const e') e)
177 e'' <- switch <$> hold never (fmap (const e') e)
173 return (b, e'')
178 return (b, e'')
174− , (,) "switchPromptly-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
179+ , (,) "switchHoldPromptly-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
175 let e' = flip push e $ \_ -> do
180 let e' = flip push e $ \_ -> do
176− Just <$> onceE e
181+ Just <$> headE e
177− e'' <- switchPromptly never e'
182+ e'' <- switchHoldPromptly never e'
178 return (b, e'')
183 return (b, e'')
179− , (,) "switchPromptly-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
184+ , (,) "switchHoldPromptly-6" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
180 let e' = flip pushAlways e $ \_ -> do
185 let e' = flip pushAlways e $ \_ -> do
181− switchPromptly e never
186+ switchHoldPromptly e never
182− e'' <- switchPromptly never e'
187+ e'' <- switchHoldPromptly never e'
183 return (b, e'')
188 return (b, e'')
184 , (,) "coincidence-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
189 , (,) "coincidence-1" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
185 let e' = flip pushAlways e $ \_ -> return e
190 let e' = flip pushAlways e $ \_ -> return e
@@ -194,7 +199,7 @@ testCases =
194 e'' = coincidence e'
199 e'' = coincidence e'
195 return (b, e'')
200 return (b, e'')
196 , (,) "coincidence-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
201 , (,) "coincidence-4" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj"), (3, "asdf")]) $ \(b, e) -> do
197− let e' = flip pushAlways e $ \_ -> onceE e
202+ let e' = flip pushAlways e $ \_ -> headE e
198 e'' = coincidence e'
203 e'' = coincidence e'
199 return (b, e'')
204 return (b, e'')
200 , (,) "coincidence-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer")]) $ \(b, e) -> do
205 , (,) "coincidence-5" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer")]) $ \(b, e) -> do
@@ -214,17 +219,35 @@ testCases =
214 eCoincidences = coincidence $ fmap (const e') e
219 eCoincidences = coincidence $ fmap (const e') e
215 return (b, eCoincidences)
220 return (b, eCoincidences)
216 , (,) "holdWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
221 , (,) "holdWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
217− eo <- onceE e
222+ eo <- headE e
218 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
223 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
219 let b' = pull $ sample =<< sample bb
224 let b' = pull $ sample =<< sample bb
220 return (b', e)
225 return (b', e)
226+ , (,) "foldDynWhileFiring" $ TestCase (Map.singleton 0 "zxc", Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(_, e) -> do
227+ d <- foldDyn (:) [] $
228+ pushAlways (\a -> foldDyn (:) [a] e) e
229+ let b = current (join (fmap distributeListOverDynPure d))
230+ return (b, e)
221 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
231 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
222 bb <- hold "b" e
232 bb <- hold "b" e
223− bd <- hold never . fmap (const e) =<< onceE e
233+ bd <- hold never . fmap (const e) =<< headE e
224− eOuter <- pushAlways sample . fmap (const bb) <$> onceE e
234+ eOuter <- pushAlways sample . fmap (const bb) <$> headE e
225 let eInner = switch bd
235 let eInner = switch bd
226 e' = leftmost [eOuter, eInner]
236 e' = leftmost [eOuter, eInner]
227 return (b, e')
237 return (b, e')
238+ , (,) "holdUniqDyn-laziness" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList (zip [1 :: Int ..] [1 :: Int, 2, 2, 3, 3, 3, 4, 4, 4, 4])) $ \(_, e :: Event t Int) -> do
239+ rec result <- holdUniqDyn d
240+ d <- holdDyn (0 :: Int) e
241+ return (current result, updated result)
242+
243+
244+
245+ {-
246+ , (,) "mergeIncrementalWithMove" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, PatchDMapWithMove.moveDMapKey LeftTag RightTag), (2, mempty)]) $ \(b, e :: Event t (PatchDMapWithMove (EitherTag () ()) (Const2 () ()))) -> do
247+ x <- holdIncremental (DMap.singleton LeftTag $ void e) $ PatchDMapWithMove.mapPatchDMapWithMove (\(Const2 _) -> void e) <$> e
248+ let e' = mergeIncrementalWithMove x :: Event t (DMap (EitherTag () ()) Identity)
249+ return (b, e')
250+ -}
228 ]
251 ]
229
252
230splitRecombineEvent :: Reflex t => Event t a -> Event t String
253splitRecombineEvent :: Reflex t => Event t a -> Event t String
@@ -234,8 +257,8 @@ splitRecombineEvent e =
234 in leftmost [ea, eb]
257 in leftmost [ea, eb]
235
258
236
259
237−test :: IO ()
260+main :: IO ()
238−test = do
261+main = do
239 results <- forM testCases $ \(name, TestCase inputs builder) -> do
262 results <- forM testCases $ \(name, TestCase inputs builder) -> do
240 putStrLn $ "Test: " <> name
263 putStrLn $ "Test: " <> name
241 testAgreement builder inputs
264 testAgreement builder inputs
test/Reflex/Test/Micro.hs+84−17
@@ -3,6 +3,7 @@
3{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE GADTs #-}
5{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
@@ -23,6 +24,24 @@ import Data.Monoid
23
24
24import Prelude
25import Prelude
25
26
27+pushDyn :: (Reflex t, MonadHold t m) => (a -> PushM t b) -> Dynamic t a -> m (Dynamic t b)
28+pushDyn f d = buildDynamic (sample (current d) >>= f) (pushAlways f (updated d))
29+
30+foldedDyn :: (Reflex t, MonadHold t m) => (a -> a -> a) -> Dynamic t a -> m (Dynamic t a)
31+foldedDyn f d = fmap join $ flip buildDynamic never $ do
32+ a <- sample (current d)
33+ foldDyn f a (updated d)
34+
35+scannedDyn :: (Reflex t, MonadHold t m) => Dynamic t a -> m (Dynamic t [a])
36+scannedDyn = fmap (fmap reverse) . foldedDyn (<>) . fmap pure
37+
38+scanInnerDyns :: (Reflex t, MonadHold t m) => Dynamic t (Dynamic t a) -> m (Dynamic t [a])
39+scanInnerDyns d = do
40+ scans <- scannedDyn d
41+ return (join (fmap distributeListOverDynPure scans))
42+
43+
44+
26{-# ANN testCases "HLint: ignore Functor law" #-}
45{-# ANN testCases "HLint: ignore Functor law" #-}
27testCases :: [(String, TestCase)]
46testCases :: [(String, TestCase)]
28testCases =
47testCases =
@@ -128,36 +147,36 @@ testCases =
128 return $ coincidence $ flip pushAlways e $ const $ do
147 return $ coincidence $ flip pushAlways e $ const $ do
129 switch <$> hold ("x" <$ e) (e <$ e)
148 switch <$> hold ("x" <$ e) (e <$ e)
130
149
131− , testE "switchPromptly-1" $ do
150+ , testE "switchHoldPromptly-1" $ do
132 e <- events1
151 e <- events1
133 let e' = e <$ e
152 let e' = e <$ e
134− switchPromptly never $ e <$ e'
153+ switchHoldPromptly never $ e <$ e'
135
154
136− , testE "switchPromptly-2" $ do
155+ , testE "switchHoldPromptly-2" $ do
137 e <- events1
156 e <- events1
138− switchPromptly never $ deep (e <$ e)
157+ switchHoldPromptly never $ deep (e <$ e)
139
158
140− , testE "switchPromptly-3" $ do
159+ , testE "switchHoldPromptly-3" $ do
141 e <- events1
160 e <- events1
142− switchPromptly never $ (e <$ deep e)
161+ switchHoldPromptly never $ (e <$ deep e)
143
162
144− , testE "switchPromptly-4" $ do
163+ , testE "switchHoldPromptly-4" $ do
145 e <- events1
164 e <- events1
146− switchPromptly never $ (deep e <$ e)
165+ switchHoldPromptly never $ (deep e <$ e)
147
166
148 , testE "switch-5" $ do
167 , testE "switch-5" $ do
149 e <- events1
168 e <- events1
150 switch <$> hold never (deep e <$ e)
169 switch <$> hold never (deep e <$ e)
151
170
152− , testE "switchPromptly-5" $ do
171+ , testE "switchHoldPromptly-5" $ do
153 e <- events1
172 e <- events1
154− switchPromptly never $ flip push e $
173+ switchHoldPromptly never $ flip push e $
155 const (Just <$> headE e)
174 const (Just <$> headE e)
156
175
157− , testE "switchPromptly-6" $ do
176+ , testE "switchHoldPromptly-6" $ do
158 e <- events1
177 e <- events1
159− switchPromptly never $ flip pushAlways e $
178+ switchHoldPromptly never $ flip pushAlways e $
160− const (switchPromptly e never)
179+ const (switchHoldPromptly e never)
161
180
162 , testE "coincidence-1" $ do
181 , testE "coincidence-1" $ do
163 e <- events1
182 e <- events1
@@ -201,6 +220,14 @@ testCases =
201 bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
220 bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
202 return $ pull $ sample =<< sample bb
221 return $ pull $ sample =<< sample bb
203
222
223+
224+ , testB "foldDynWhileFiring" $ do
225+ e <- events1
226+ d <- foldDyn (:) [] $
227+ pushAlways (\a -> foldDyn (:) [a] e) e
228+
229+ return $ current (join (fmap distributeListOverDynPure d))
230+
204 , testE "joinDyn" $ do
231 , testE "joinDyn" $ do
205 e <- events1
232 e <- events1
206 bb <- hold "b" e
233 bb <- hold "b" e
@@ -223,6 +250,38 @@ testCases =
223 d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
250 d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
224
251
225 return $ current $ zipDynWith (<>) d1 d2
252 return $ current $ zipDynWith (<>) d1 d2
253+
254+ , testB "buildDynamicStrictness" $ do
255+ rec
256+ d'' <- pushDyn return d'
257+ d' <- pushDyn return d
258+ d <- holdDyn "0" =<< events1
259+
260+ _ <- sample (current d'')
261+ return (current d'')
262+
263+ , testB "factorDyn" $ do
264+ d <- holdDyn (Left "a") =<< eithers
265+
266+ eithers' <- eitherDyn d
267+ let unFactor = either id id
268+ return $ current (join (fmap unFactor eithers'))
269+
270+ , testB "pushDynDeep" $ do
271+ _ <- events1
272+ _ <- events2
273+
274+ d1 <- holdDyn "d1" =<< events1
275+ d2 <- holdDyn "d2" =<< events2
276+
277+ d <- flip pushDyn d1 $ \a ->
278+ flip pushDyn d2 $ \b ->
279+ flip pushDyn d1 $ \c ->
280+ return (a <> b <> c)
281+
282+ d' <- pushDyn scanInnerDyns d >>= scanInnerDyns
283+ return $ current d'
284+
226 , testE "fan-1" $ do
285 , testE "fan-1" $ do
227 e <- fmap toMap <$> events1
286 e <- fmap toMap <$> events1
228 let es = select (fanMap e) . Const2 <$> values
287 let es = select (fanMap e) . Const2 <$> values
@@ -263,15 +322,25 @@ testCases =
263 let e = never <$ switch b
322 let e = never <$ switch b
264 return $ void e
323 return $ void e
265 lazyHold
324 lazyHold
266−
325+ , testE "now-1" $ do
326+ e1 <- events1
327+ switchHoldPromptly never . pushAlways (\a -> fmap (a <$) now) $ e1
328+ , testE "now-2" $ do
329+ e1 <- events1
330+ let e = pushAlways (\a -> if a == "a" then now else return never) e1
331+ x <- accumDyn (<>) never e
332+ return . coincidence $ updated x
267 ] where
333 ] where
268
334
269 events1, events2, events3 :: TestPlan t m => m (Event t String)
335 events1, events2, events3 :: TestPlan t m => m (Event t String)
270 events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
336 events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
271 events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
337 events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
272−
273 events3 = liftA2 mappend events1 events2
338 events3 = liftA2 mappend events1 events2
274
339
340+ eithers :: TestPlan t m => m (Event t (Either String String))
341+ eithers = plan [(1, Left "e"), (3, Left "d"), (4, Right "c"), (6, Right "b"), (7, Left "a")]
342+
343+
275 values = "abcde"
344 values = "abcde"
276 toMap str = Map.fromList $ map (\c -> (c, c)) str
345 toMap str = Map.fromList $ map (\c -> (c, c)) str
277
346
@@ -281,5 +350,3 @@ testCases =
281
350
282 deep e = leftmost [e, e]
351 deep e = leftmost [e, e]
283 leftmost2 e1 e2 = leftmost [e1, e2]
352 leftmost2 e1 e2 = leftmost [e1, e2]
284−
285−
test/Reflex/TestPlan.hs+2−2
@@ -26,8 +26,8 @@ import Reflex.Class
26import Prelude
26import Prelude
27
27
28class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
28class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
29− -- | Speicify a plan of an input Event firing
29+ -- | Specify a plan of an input Event firing
30− -- Occurances must be in the future (i.e. Time > 0)
30+ -- Occurrences must be in the future (i.e. Time > 0)
31 -- Initial specification is
31 -- Initial specification is
32
32
33 plan :: [(Word, a)] -> m (Event t a)
33 plan :: [(Word, a)] -> m (Event t a)
test/RequesterT.hs+214−49
@@ -1,70 +1,235 @@
1−{-# LANGUAGE FlexibleContexts, GADTs #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE LambdaCase #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE RecursiveDo #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TemplateHaskell #-}
11+{-# LANGUAGE TypeApplications #-}
12+{-# LANGUAGE TypeFamilies #-}
2module Main where
13module Main where
3
14
15+import Control.Lens hiding (has)
4import Control.Monad
16import Control.Monad
5−import Control.Monad.IO.Class
17+import Control.Monad.Fix
6−import Control.Monad.Ref
18+import Control.Monad.IO.Class (MonadIO)
19+import Data.Constraint.Extras
20+import Data.Constraint.Extras.TH
21+import Data.Constraint.Forall
7import qualified Data.Dependent.Map as DMap
22import qualified Data.Dependent.Map as DMap
8import Data.Dependent.Sum
23import Data.Dependent.Sum
9−import Data.IORef
24+import Data.Functor.Misc
10−import Data.List
25+import Data.List (words)
11−import Data.Functor.Identity
26+import Data.Map (Map)
27+import qualified Data.Map as M
28+#if !MIN_VERSION_these(4,11,0)
29+import Data.Semigroup ((<>))
30+#endif
31+import Data.Text (Text)
32+import Data.These
33+import Text.Read (readMaybe)
34+
35+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
36+import Data.These.Lens
37+#endif
12
38
13import Reflex
39import Reflex
14−import Reflex.Host.Class
15−import Reflex.PerformEvent.Base
16import Reflex.Requester.Base
40import Reflex.Requester.Base
17import Reflex.Requester.Class
41import Reflex.Requester.Class
18−
42+import Test.Run
19−import System.Exit (exitFailure, exitSuccess)
20
43
21data RequestInt a where
44data RequestInt a where
22 RequestInt :: Int -> RequestInt Int
45 RequestInt :: Int -> RequestInt Int
23
46
24main :: IO ()
47main :: IO ()
25main = do
48main = do
26− (Just out1, Nothing) <- runApp app1
49+ os1 <- runApp' (unwrapApp testOrdering) $
27− print out1
50+ [ Just ()
28− (Just out2, Just (out3, out4)) <- runApp app2
51+ ]
29− print out2
52+ print os1
30− print out3
53+ os2 <- runApp' (unwrapApp testSimultaneous) $ map Just $
31− print out4
54+ [ This ()
32− when (sort out1 /= out1 || map (+1) out2 /= out3 || out3 /= out4) exitFailure
55+ , That ()
33−
56+ , This ()
34−runApp :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
57+ , These () ()
35− => (Event t () -> RequesterT t RequestInt Identity (PerformEventT t m) (Maybe (Ref m (Maybe (EventTrigger t ())))))
58+ ]
36− -> IO (Maybe [Int], Maybe ([Int], [Int]))
59+ print os2
37−runApp x = runSpiderHost $ do
60+ os3 <- runApp' (unwrapApp testMoribundRequest) [Just ()]
38− (pulseE, pulseTriggerRef) <- newEventWithTriggerRef
61+ print os3
39− ((mactuateRef, e), FireCommand fire) <- hostPerformEventT $ runRequesterT (x pulseE) never
62+ os4 <- runApp' (unwrapApp testMoribundRequestDMap) [Just ()]
40− hnd <- subscribeEvent (map unwrapRequest . DMap.toList <$> e)
63+ print os4
41− out1 <- fireEventRefAndRead pulseTriggerRef () hnd
64+ os5 <- runApp' (unwrapApp testLiveRequestDMap) [Just ()]
42− out2 <- fmap join $ forM mactuateRef $ \actuateRef -> do
65+ print os5
43− let readPhase = do
66+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
44− mGetValue <- readEvent hnd
67+ print os6
45− case mGetValue of
68+ os7 <- runApp' testMatchRequestsWithResponses [ Just $ TestRequest_Increment 1 ]
46− Nothing -> return Nothing
69+ print os7
47− Just getValue -> fmap Just getValue
70+ os8 <- runApp' testMatchRequestsWithResponses [ Just $ TestRequest_Reverse "yoyo" ]
48− mactuate <- readRef actuateRef
71+ print os8
49− mpulse <- readRef pulseTriggerRef
72+ let ![[Just [1,2,3,4,5,6,7,8,9,10]]] = os1 -- The order is reversed here: see the documentation for 'runRequesterT'
50− forM ((,) <$> mactuate <*> mpulse) $ \(actuate, pulse) -> do
73+ let ![[Just [9,7,5,3,1]],[Nothing,Nothing],[Just [10,8,6,4,2]],[Just [10,8,6,4,2],Nothing]] = os2
51− _ <- fire [actuate :=> Identity ()] $ return ()
74+ let ![[Nothing, Just [2]]] = os3
52− [Just a] <- fire [pulse :=> Identity ()] $ readPhase
75+ let ![[Nothing, Just [2]]] = os4
53− [Just b, Nothing] <- fire [actuate :=> Identity (), pulse :=> Identity ()] $ readPhase
76+ let ![[Nothing, Just [1, 2]]] = os5
54− return (a,b)
77+ -- let ![[Nothing, Nothing]] = os6 -- TODO re-enable this test after issue #233 has been resolved
55− return (out1, out2)
78+ let !(Just [(1,"2")]) = M.toList <$> head (head os7)
79+ let !(Just [(1,"oyoy")]) = M.toList <$> head (head os8)
80+
81+ return ()
56
82
57unwrapRequest :: DSum tag RequestInt -> Int
83unwrapRequest :: DSum tag RequestInt -> Int
58unwrapRequest (_ :=> RequestInt i) = i
84unwrapRequest (_ :=> RequestInt i) = i
59
85
60−app1 :: (Reflex t, Ref m ~ IORef, Requester t m, Response m ~ Identity, Request m ~ RequestInt) => Event t () -> m (Maybe (Ref m (Maybe (EventTrigger t ()))))
86+unwrapApp :: ( Reflex t, Monad m )
61−app1 e = do
87+ => (a -> RequesterT t RequestInt Identity m ())
62− forM_ [1..10] $ \i -> requestingIdentity (RequestInt i <$ e)
88+ -> a
63− return Nothing
89+ -> m (Event t [Int])
90+unwrapApp x appIn = do
91+ ((), e) <- runRequesterT (x appIn) never
92+ return $ fmap (map unwrapRequest . requesterDataToList) e
93+
94+testOrdering :: ( Response m ~ Identity
95+ , Request m ~ RequestInt
96+ , Requester t m
97+ , Adjustable t m)
98+ => Event t ()
99+ -> m ()
100+testOrdering pulse = forM_ [10,9..1] $ \i ->
101+ requestingIdentity (RequestInt i <$ pulse)
102+
103+testSimultaneous :: ( Response m ~ Identity
104+ , Request m ~ RequestInt
105+ , Requester t m
106+ , Adjustable t m)
107+ => Event t (These () ())
108+ -> m ()
109+testSimultaneous pulse = do
110+ let tellE = fmapMaybe (^? here) pulse
111+ switchE = fmapMaybe (^? there) pulse
112+ forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
113+ requestingIdentity (RequestInt (i+1) <$ tellE)
114+
115+-- | Test that a widget requesting and event which fires at the same time it has been replaced
116+-- doesn't count along with the new widget.
117+testMoribundRequest
118+ :: forall t m
119+ . ( Reflex t
120+ , Adjustable t m
121+ , MonadHold t m
122+ , MonadFix m
123+ , Response m ~ Identity
124+ , Request m ~ RequestInt
125+ , Requester t m
126+ )
127+ => Event t ()
128+ -> m ()
129+testMoribundRequest pulse = do
130+ rec let requestIntOnReplace x = requestingIdentity $ RequestInt x <$ rwrFinished
131+ (_, rwrFinished) <- runWithReplace (requestIntOnReplace 1) $ requestIntOnReplace 2 <$ pulse
132+ return ()
133+
134+-- | The equivalent of 'testMoribundRequest' for 'traverseDMapWithKeyWithAdjust'.
135+testMoribundRequestDMap
136+ :: forall t m
137+ . ( Reflex t
138+ , Adjustable t m
139+ , MonadHold t m
140+ , MonadFix m
141+ , Response m ~ Identity
142+ , Request m ~ RequestInt
143+ , Requester t m
144+ )
145+ => Event t ()
146+ -> m ()
147+testMoribundRequestDMap pulse = do
148+ rec let requestIntOnReplace :: Int -> m ()
149+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
150+ (_, rwrFinished :: Event t (PatchDMap (Const2 () Int) Identity)) <-
151+ traverseDMapWithKeyWithAdjust
152+ (\(Const2 ()) (Identity v) -> Identity . const v <$> requestIntOnReplace v)
153+ (mapToDMap $ M.singleton () 1)
154+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton () 2) <$ pulse)
155+ return ()
156+
157+-- | Ensures that elements which are _not_ removed can still fire requests
158+-- during the same frame as other elements are updated.
159+testLiveRequestDMap
160+ :: forall t m
161+ . ( Reflex t
162+ , Adjustable t m
163+ , MonadHold t m
164+ , MonadFix m
165+ , Response m ~ Identity
166+ , Request m ~ RequestInt
167+ , Requester t m
168+ )
169+ => Event t ()
170+ -> m ()
171+testLiveRequestDMap pulse = do
172+ rec let requestIntOnReplace :: Int -> m ()
173+ requestIntOnReplace x = void $ requestingIdentity $ RequestInt x <$ rwrFinished
174+ (_, rwrFinished :: Event t (PatchDMap (Const2 Int ()) Identity)) <-
175+ traverseDMapWithKeyWithAdjust
176+ (\(Const2 k) (Identity ()) -> Identity <$> requestIntOnReplace k)
177+ (mapToDMap $ M.singleton 1 ())
178+ ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
179+ return ()
180+
181+delayedPulse
182+ :: forall t m
183+ . ( Reflex t
184+ , Adjustable t m
185+ , MonadHold t m
186+ , MonadFix m
187+ , Response m ~ Identity
188+ , Request m ~ RequestInt
189+ , PerformEvent t m
190+ , Requester t m
191+ )
192+ => Event t ()
193+ -> m ()
194+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
195+ -- This has the effect of delaying pulse' from pulse
196+ (_, pulse') <- runWithReplace (pure ()) $ pure (RequestInt 1) <$ pulse
197+ requestingIdentity pulse'
198+
199+data TestRequest a where
200+ TestRequest_Reverse :: String -> TestRequest String
201+ TestRequest_Increment :: Int -> TestRequest Int
202+
203+testMatchRequestsWithResponses
204+ :: forall m t req a
205+ . ( MonadFix m
206+ , MonadHold t m
207+ , Reflex t
208+ , PerformEvent t m
209+ , MonadIO (Performable m)
210+ , ForallF Show req
211+ , Has Read req
212+ )
213+ => Event t (req a) -> m (Event t (Map Int String))
214+testMatchRequestsWithResponses pulse = mdo
215+ (_, requests) <- runRequesterT (requesting pulse) responses
216+ let rawResponses = M.map (\v ->
217+ case words v of
218+ ["reverse", str] -> reverse str
219+ ["increment", i] -> show $ succ $ (read i :: Int)
220+ ) <$> rawRequestMap
221+ (rawRequestMap, responses) <- matchResponsesWithRequests reqEncoder requests (head . M.toList <$> rawResponses)
222+ pure rawResponses
223+ where
224+ reqEncoder :: forall a. req a -> (String, String -> Maybe a)
225+ reqEncoder r =
226+ ( whichever @Show @req @a $ show r
227+ , \x -> has @Read r $ readMaybe x
228+ )
64
229
65−app2 :: (Reflex t, Ref m ~ IORef, Requester t m, Response m ~ Identity, Request m ~ RequestInt, MonadAdjust t m, MonadReflexCreateTrigger t m, MonadRef m) => Event t () -> m (Maybe (Ref m (Maybe (EventTrigger t ()))))
230+deriveArgDict ''TestRequest
66−app2 e = do
67− (pulse, pulseTriggerRef) <- newEventWithTriggerRef
68− forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ e)) $ ffor pulse $ \_ -> requestingIdentity (RequestInt (i+1) <$ e)
69− return (Just pulseTriggerRef)
70
231
232+instance Show (TestRequest a) where
233+ show = \case
234+ TestRequest_Reverse str -> "reverse " <> str
235+ TestRequest_Increment i -> "increment " <> show i
test/Test/Run.hsnew file+74
@@ -0,0 +1,74 @@
1+{-# LANGUAGE GADTs #-}
2+{-# LANGUAGE LambdaCase #-}
3+module Test.Run where
4+
5+import Control.Monad
6+import Control.Monad.Ref
7+import Data.Dependent.Sum
8+import Data.Functor.Identity
9+import Data.These
10+
11+import Reflex
12+import Reflex.Host.Class
13+
14+data AppIn t b e = AppIn
15+ { _appIn_behavior :: Behavior t b
16+ , _appIn_event :: Event t e
17+ }
18+
19+data AppOut t b e = AppOut
20+ { _appOut_behavior :: Behavior t b
21+ , _appOut_event :: Event t e
22+ }
23+
24+runApp :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
25+ => (AppIn t bIn eIn -> PerformEventT t m (AppOut t bOut eOut))
26+ -> bIn
27+ -> [Maybe (These bIn eIn)]
28+ -> IO [[(bOut, Maybe eOut)]]
29+runApp app b0 input = runSpiderHost $ do
30+ (appInHoldE, pulseHoldTriggerRef) <- newEventWithTriggerRef
31+ (appInE, pulseEventTriggerRef) <- newEventWithTriggerRef
32+ appInB <- hold b0 appInHoldE
33+ (out, FireCommand fire) <- hostPerformEventT $ app $ AppIn
34+ { _appIn_event = appInE
35+ , _appIn_behavior = appInB
36+ }
37+ hnd <- subscribeEvent (_appOut_event out)
38+ mpulseB <- readRef pulseHoldTriggerRef
39+ mpulseE <- readRef pulseEventTriggerRef
40+ let readPhase = do
41+ b <- sample (_appOut_behavior out)
42+ frames <- sequence =<< readEvent hnd
43+ return (b, frames)
44+ forM input $ \case
45+ Nothing ->
46+ fire [] $ readPhase
47+ Just i -> case i of
48+ This b' -> case mpulseB of
49+ Nothing -> error "tried to fire in-behavior but ref was empty"
50+ Just pulseB -> fire [ pulseB :=> Identity b' ] $ readPhase
51+ That e' -> case mpulseE of
52+ Nothing -> error "tried to fire in-event but ref was empty"
53+ Just pulseE -> fire [ pulseE :=> Identity e' ] $ readPhase
54+ These b' e' -> case mpulseB of
55+ Nothing -> error "tried to fire in-behavior but ref was empty"
56+ Just pulseB -> case mpulseE of
57+ Nothing -> error "tried to fire in-event but ref was empty"
58+ Just pulseE -> fire [ pulseB :=> Identity b', pulseE :=> Identity e' ] $ readPhase
59+
60+runApp' :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
61+ => (Event t eIn -> PerformEventT t m (Event t eOut))
62+ -> [Maybe eIn]
63+ -> IO [[Maybe eOut]]
64+runApp' app input = do
65+ let app' = fmap (AppOut (pure ())) . app
66+ map (map snd) <$> runApp (app' . _appIn_event) () (map (fmap That) input)
67+
68+runAppB :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
69+ => (Event t eIn -> PerformEventT t m (Behavior t bOut))
70+ -> [Maybe eIn]
71+ -> IO [[bOut]]
72+runAppB app input = do
73+ let app' = fmap (flip AppOut never) . app
74+ map (map fst) <$> runApp (app' . _appIn_event) () (map (fmap That) input)
test/hlint.hs+34−13
@@ -1,18 +1,39 @@
1−import Language.Haskell.HLint3 (hlint)
1+module Main where
2+
3+import Control.Monad
4+import Language.Haskell.HLint (hlint)
5+import System.Directory
2import System.Exit (exitFailure, exitSuccess)
6import System.Exit (exitFailure, exitSuccess)
7+import System.FilePath
8+import System.FilePath.Find
3
9
4main :: IO ()
10main :: IO ()
5main = do
11main = do
6− ideas <- hlint
12+ pwd <- getCurrentDirectory
7− [ "."
13+ let runHlint f = hlint $ f:
8− , "--ignore=Redundant do"
14+ [ "--ignore=Redundant do"
9− , "--ignore=Use camelCase"
15+ , "--ignore=Use camelCase"
10− , "--ignore=Redundant $"
16+ , "--ignore=Redundant $"
11− , "--ignore=Use &&"
17+ , "--ignore=Use &&"
12− , "--ignore=Use &&&"
18+ , "--ignore=Use &&&"
13− , "--ignore=Use const"
19+ , "--ignore=Use const"
14− , "--ignore=Use >=>"
20+ , "--ignore=Use >=>"
15− , "--ignore=Use ."
21+ , "--ignore=Use ."
16− , "--cpp-define=USE_TEMPLATE_HASKELL"
22+ , "--ignore=Use unless"
17− ]
23+ , "--ignore=Reduce duplication"
24+ , "--cpp-define=USE_TEMPLATE_HASKELL"
25+ , "--cpp-define=DEBUG"
26+ , "--ignore=Use tuple-section"
27+ ]
28+ recurseInto = and <$> sequence
29+ [ fileType ==? Directory
30+ , fileName /=? ".git"
31+ ]
32+ matchFile = and <$> sequence
33+ [ extension ==? ".hs"
34+ ]
35+ files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
36+ ideas <- fmap concat $ forM files $ \f -> do
37+ putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
38+ runHlint f
18 if null ideas then exitSuccess else exitFailure
39 if null ideas then exitSuccess else exitFailure
test/rootCleanup.hsnew file+25
@@ -0,0 +1,25 @@
1+import Control.Concurrent
2+import Control.Monad
3+import Data.IORef
4+import Reflex
5+import Reflex.Host.Class
6+import System.Exit
7+import System.Mem
8+
9+main :: IO ()
10+main = do
11+ numSubscriptions <- newIORef 0
12+ replicateM_ 1000 $ do
13+ runSpiderHost $ do
14+ e <- newEventWithTrigger $ \_ -> do
15+ modifyIORef' numSubscriptions succ
16+ return $ modifyIORef' numSubscriptions pred
17+ _ <- hold () e
18+ return ()
19+ replicateM_ 100 $ do
20+ performMajorGC
21+ threadDelay 1
22+ n <- readIORef numSubscriptions
23+ if n == 0
24+ then putStrLn "Succeeded"
25+ else putStrLn "Failed" >> exitFailure
test/semantics.hs−2
@@ -45,5 +45,3 @@ main = do
45 ]
45 ]
46
46
47 makeGroup name tests = first (\test -> intercalate "/" [name, test]) <$> tests
47 makeGroup name tests = first (\test -> intercalate "/" [name, test]) <$> tests
48−
49−