on develop help sign in
83 files changed+4729−2969
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+41 .travis.yml−16 CONTRIBUTING.md+66 ChangeLog.md+151 Quickref.md+39−10 README.md+15−11 bench-cbits/checkCapability.c+11−12 bench/Main.hs+7−6 bench/RunAll.hs+1−1 cabal.haskell-ci+23 cabal.project+1 default.nix−38 dep/reflex-platform/default.nix+7 dep/reflex-platform/github.json+7 reflex.cabal+261−56 release.nix+58 src/Control/Monad/ReaderIO.hs+60 src/Data/AppendMap.hs+58−382 src/Data/FastMutableIntMap.hs+25−4 src/Data/FastWeakBag.hs+15−11 src/Data/Functor/Misc.hs−287 src/Data/Map/Misc.hs+26−10 src/Data/WeakBag.hs+13−11 src/Reflex.hs+4 src/Reflex/Adjustable/Class.hs+86−17 src/Reflex/BehaviorWriter/Base.hs+211 src/Reflex/BehaviorWriter/Class.hs+31 src/Reflex/Class.hs+722−215 src/Reflex/Collection.hs+159−54 src/Reflex/Dynamic.hs+66−207 src/Reflex/Dynamic/TH.hs+4−28 src/Reflex/DynamicWriter/Base.hs+42−9 src/Reflex/DynamicWriter/Class.hs+10−6 src/Reflex/EventWriter/Base.hs+99−63 src/Reflex/EventWriter/Class.hs−1 src/Reflex/FastWeak.hs+69−5 src/Reflex/FunctorMaybe.hs+32−18 src/Reflex/Host/Class.hs−7 src/Reflex/Host/Headless.hs+128 src/Reflex/Network.hs+14−7 src/Reflex/NotReady/Class.hs+10−1 src/Reflex/Optimizer.hs+13−4 src/Reflex/Patch.hs−39 src/Reflex/Patch/Class.hs−22 src/Reflex/Patch/DMap.hs−68 src/Reflex/Patch/DMapWithMove.hs−367 src/Reflex/Patch/IntMap.hs−50 src/Reflex/Patch/Map.hs−64 src/Reflex/Patch/MapWithMove.hs−156 src/Reflex/PerformEvent/Base.hs+7−4 src/Reflex/PerformEvent/Class.hs+6−2 src/Reflex/PostBuild/Base.hs+3−1 src/Reflex/PostBuild/Class.hs−2 src/Reflex/Profiled.hs+89−19 src/Reflex/Pure.hs+38−27 src/Reflex/Query/Base.hs+111−52 src/Reflex/Query/Class.hs+92−11 src/Reflex/Requester/Base.hs+198−19 src/Reflex/Requester/Class.hs−1 src/Reflex/Spider.hs+5−2 src/Reflex/Spider/Internal.hs+779−479 src/Reflex/Time.hs+115−15 src/Reflex/TriggerEvent/Base.hs+3 src/Reflex/TriggerEvent/Class.hs+6−1 src/Reflex/Widget/Basic.hs+3−1 src/Reflex/Workflow.hs+14−1 stylize+4 test/Adjustable.hs+62 test/DebugCycles.hs+171 test/EventWriterT.hs+92−3 test/GC.hs+6−5 test/Headless.hs+10 test/QueryT.hs+19−8 test/Reflex/Bench/Focused.hs+13−1 test/Reflex/Plan/Pure.hs+5−4 test/Reflex/Plan/Reflex.hs+2−2 test/Reflex/Test/CrossImpl.hs+24−15 test/Reflex/Test/Micro.hs+71−4 test/Reflex/TestPlan.hs+2−2 test/RequesterT.hs+181−14 test/Test/Run.hs+8 test/hlint.hs+5−9 test/semantics.hs−2
.github/workflows/haskell.ymlnew file+41
@@ -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
.travis.ymldeleted−16
@@ -1,16 +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=ghc821
10− - env: COMPILER=ghc802
11− - env: COMPILER=ghcjs
12−script:
13− - set -e
14− - nix-build -E "with (import <nixpkgs> {}); pkgs.haskell.packages.$COMPILER.callPackage ./default.nix { }"
15− - nix-collect-garbage -d # This is important to do right before 'script' ends so the cache gets GCed
16−
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+39−10
@@ -54,18 +54,19 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
5454[ ] difference :: Event a -> Event b -> Event a
5555[ ] align :: Event a -> Event b -> Event (These a b)
5656[ ] alignWith :: (These a b -> c) -> Event a -> Event b -> Event c
57+ -- Note align functions from Data.Align in semialign package
5758[ ] mergeWith :: (a -> a -> a) -> [Event a] -> Event a
5859[ ] leftmost :: [Event a] -> Event a
5960[ ] mergeList :: [Event a] -> Event (NonEmpty a)
60−[ ] merge :: GCompare k => DMap (WrapArg Event k) -> Event (DMap k)
61+[ ] merge :: GCompare k => DMap k Event -> Event (DMap k Identity)
6162[ ] mergeMap :: Ord k => Map k (Event a) -> Event (Map k a)
6263
6364-- Efficient one-to-many fanout
64−[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
65−[ ] fan :: GCompare k => Event (DMap k) -> EventSelector k
66−[ ] select :: EventSelector k -> k a -> Event a
67−[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
68−[ ] fanThese :: Event (These a b) -> (Event a, Event b)
65+[ ] fanMap :: Ord k => Event (Map k a) -> EventSelector (Const2 k a)
66+[ ] fan :: GCompare k => Event (DMap k Identity) -> EventSelector k
67+[ ] select :: EventSelector k -> k a -> Event a
68+[ ] fanEither :: Event (Either a b) -> (Event a, Event b)
69+[ ] fanThese :: Event (These a b) -> (Event a, Event b)
6970
7071-- Event to Event via function that can sample current values
7172[ ] push :: (a -> m (Maybe b)) -> Event a -> Event b
@@ -98,6 +99,10 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
9899[ ] <> :: Monoid a => Behavior a -> Behavior a -> Behavior a
99100-- ... plus many more due to typeclass membership
100101
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+
101106-- Behavior to Behavior by sampling current values
102107[S] sample :: Behavior a -> m a
103108[ ] pull :: m a -> Behavior a
@@ -135,6 +140,10 @@ Since MonadHold depends on MonadSample, any [S] function also runs in [H] contex
135140[ ] >>= :: Dynamic a -> (a -> Dynamic b) -> Dynamic b
136141[ ] zipDynWith :: (a -> b -> c) -> Dynamic a -> Dynamic b -> Dynamic c
137142
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+
138147-- Efficient one-to-many fanout
139148[ ] demux :: Ord k => Dynamic k -> Demux k
140149[ ] demuxed :: Eq k => Demux k -> k -> Dynamic Bool
@@ -158,7 +167,7 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
158167-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
159168[ ] switch :: Behavior (Event a) -> Event a
160169
161−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
170+-- Flatten Dynamic-of-Event to Event. New Event is used immediately.
162171[ ] switchDyn :: Dynamic (Event a) -> Event a
163172
164173-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
@@ -190,7 +199,7 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
190199The functions mentioned above are used to create a static FRP network.
191200There 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.
192201
193−Th typeclasses and their associated annotations include:
202+The typeclasses and their associated annotations include:
194203
195204- `PostBuild`
196205 Fire an Event when an FRP network has been set up.
@@ -198,7 +207,7 @@ Th typeclasses and their associated annotations include:
198207 [B] -- Function runs in any monad supporting PostBuild
199208 ```
200209
201−- `Adjustable`
210+- `Adjustable`
202211 Use Events to add or remove pieces of an FRP network.
203212 ```haskell
204213 [A] -- Function runs in any monad supporting Adjustable
@@ -263,7 +272,7 @@ Th typeclasses and their associated annotations include:
263272```haskell
264273-- Run side-effecting actions in Event when it occurs; returned Event contains
265274-- results. Side effects run in the (Performable m) monad which is associated with
266−-- the (PerformEvent t m) typeclass constraint.
275+-- the (PerformEvent t m) typeclass constraint.
267276-- This allows for working with IO when a ((MonadIO (Performable m)) constraint is available.
268277[P] performEvent :: Event (Performable m a ) -> m (Event a)
269278
@@ -284,3 +293,23 @@ Th typeclasses and their associated annotations include:
284293[P,T] delay :: NominalDiffTime -> Event t a -> m (Event t a)
285294```
286295
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)
315+```
README.md+15−11
@@ -1,19 +1,23 @@
1−## Reflex
2−### Practical Functional Reactive Programming
1+# [Reflex](https://reflex-frp.org/)
32
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)
54
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.
76
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.
98
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/).**
1110
12−### Additional resources
13−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
11+## Resources
1412
15−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
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)
18+* [/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
19+* [irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
1620
17−[hackage](https://hackage.haskell.org/package/reflex)
21+## Hacking
1822
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_ {
4242 // or just continue immediately. It's a workaround for the fact
4343 // that signalling a condition variable doesn't do anything if the
4444 // thread is already running, but we want it to be sticky.
45− rtsBool wakeup;
45+ HsBool wakeup;
4646#endif
4747
4848 // This points to the Capability that the Task "belongs" to. If
@@ -62,14 +62,14 @@ typedef struct Task_ {
6262 // The current top-of-stack InCall
6363 struct InCall_ *incall;
6464
65− nat n_spare_incalls;
65+ uint32_t n_spare_incalls;
6666 struct InCall_ *spare_incalls;
6767
68− rtsBool worker; // == rtsTrue if this is a worker Task
69− rtsBool stopped; // this task has stopped or exited Haskell
68+ HsBool worker; // == rtsTrue if this is a worker Task
69+ HsBool stopped; // this task has stopped or exited Haskell
7070
7171 // So that we can detect when a finalizer illegally calls back into Haskell
72− rtsBool running_finalizers;
72+ HsBool running_finalizers;
7373
7474 // Links tasks on the returning_tasks queue of a Capability, and
7575 // on spare_workers.
@@ -88,7 +88,7 @@ struct Capability_ {
8888 StgFunTable f;
8989 StgRegTable r;
9090
91− nat no; // capability number.
91+ uint32_t no; // capability number.
9292
9393 // The Task currently holding this Capability. This task has
9494 // exclusive access to the contents of this Capability (apart from
@@ -98,12 +98,12 @@ struct Capability_ {
9898
9999 // true if this Capability is running Haskell code, used for
100100 // catching unsafe call-ins.
101− rtsBool in_haskell;
101+ HsBool in_haskell;
102102
103103 // Has there been any activity on this Capability since the last GC?
104− nat idle;
104+ uint32_t idle;
105105
106− rtsBool disabled;
106+ HsBool disabled;
107107
108108 // The run queue. The Task owning this Capability has exclusive
109109 // access to its run queue, so can wake up threads without
@@ -159,7 +159,7 @@ struct Capability_ {
159159#if defined(THREADED_RTS)
160160 // Worker Tasks waiting in the wings. Singly-linked.
161161 Task *spare_workers;
162− nat n_spare_workers; // count of above
162+ uint32_t n_spare_workers; // count of above
163163
164164 // This lock protects:
165165 // running_task
@@ -192,10 +192,9 @@ struct Capability_ {
192192
193193 // Per-capability STM-related data
194194 StgTVarWatchQueue *free_tvar_watch_queues;
195− StgInvariantCheckQueue *free_invariant_check_queues;
196195 StgTRecChunk *free_trec_chunks;
197196 StgTRecHeader *free_trec_headers;
198− nat transaction_tokens;
197+ uint32_t transaction_tokens;
199198} // typedef Capability is defined in RtsAPI.h
200199 // We never want a Capability to overlap a cache line with anything
201200 // 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
2020import Data.Dependent.Sum
2121import Data.Functor.Misc
2222import Data.IORef
23+import Data.Maybe (fromJust)
2324import Reflex
2425import Reflex.Host.Class
2526
@@ -70,7 +71,7 @@ micros =
7071 , withSetupWHNF "fireEventsOnly"
7172 (newEventWithTriggerRef >>= subscribePair)
7273 (\(_, trigger) -> do
73− Just key <- liftIO $ readIORef trigger
74+ key <- fromJust <$> liftIO (readIORef trigger)
7475 fireEvents [key :=> Identity (42 :: Int)])
7576 , withSetupWHNF "fireEventsAndRead(head/merge1)"
7677 (setupMerge 1 >>= subscribePair)
@@ -84,14 +85,14 @@ micros =
8485 , withSetupWHNF "fireEventsOnly(head/merge100)"
8586 (setupMerge 100 >>= subscribePair)
8687 (\(_, t:_) -> do
87− Just key <- liftIO $ readIORef t
88+ key <- fromJust <$> liftIO (readIORef t)
8889 fireEvents [key :=> Identity (42 :: Int)])
8990 , withSetupWHNF "hold" newEventWithTriggerRef $ \(ev, _) -> hold (42 :: Int) ev
9091 , withSetupWHNF "sample" (newEventWithTriggerRef >>= hold (42 :: Int) . fst) sample
9192 ]
9293
9394setupMerge :: Int
94− -> SpiderHost Global ( Event (SpiderEnv Global) (DMap (Const2 Int a) Identity)
95+ -> SpiderHost Global ( Event (SpiderTimeline Global) (DMap (Const2 Int a) Identity)
9596 , [IORef (Maybe (EventTrigger Spider a))]
9697 )
9798setupMerge num = do
@@ -99,11 +100,11 @@ setupMerge num = do
99100 let !m = DMap.fromList [Const2 i :=> v | (i,v) <- zip [0..] evs]
100101 pure (merge m, triggers)
101102
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)
103104subscribePair (ev, b) = (,b) <$> subscribeEvent ev
104105
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
106107 -> SpiderHost Global (Maybe b)
107108fireAndRead trigger val subd = do
108− Just key <- liftIO $ readIORef trigger
109+ key <- fromJust <$> liftIO (readIORef trigger)
109110 fireEventsAndRead [key :=> Identity val] $ readEvent subd >>= sequence
bench/RunAll.hs+1−1
@@ -136,7 +136,7 @@ benchmarks = implGroup "spider" runSpiderHost cases
136136pattern RunTestCaseFlag = "--run-test-case"
137137
138138spawnBenchmark :: String -> Benchmark
139−spawnBenchmark name = Benchmark name $ Benchmarkable $ \n -> do
139+spawnBenchmark name = bench name . toBenchmarkable $ \n -> do
140140 self <- getExecutablePath
141141 callProcess self [RunTestCaseFlag, name, show n, "+RTS", "-N1"]
142142
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−38
@@ -1,38 +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, random, ref-tf
5−, semigroupoids , semigroups, split, stdenv, stm, syb
6−, template-haskell , these, time, transformers
7−, transformers-compat, unbounded-delays, prim-uniq
8−, data-default , filepath, directory, filemanip, ghcjs-base
9−, useTemplateHaskell ? true
10−}:
11−mkDerivation {
12− pname = "reflex";
13− version = "0.5.0";
14− src = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [ ".git" "dist" ])) ./.;
15− libraryHaskellDepends = [
16− base bifunctors containers dependent-map dependent-sum
17− exception-transformers lens
18− MemoTrie monad-control mtl primitive ref-tf semigroupoids
19− semigroups stm syb template-haskell these transformers
20− transformers-compat prim-uniq
21− base bifunctors containers deepseq dependent-map dependent-sum
22− mtl ref-tf split transformers data-default
23− random time unbounded-delays
24− ] ++ (if ghc.isGhcjs or false then [
25− ghcjs-base
26− ] else []) ++ (if !useTemplateHaskell then [] else [
27− haskell-src-exts haskell-src-meta
28− ]);
29− testHaskellDepends = if ghc.isGhcjs or false then [] else [
30− hlint filepath directory filemanip
31− ];
32− configureFlags = if useTemplateHaskell then [] else [
33− "-f-use-template-haskell"
34− ];
35− homepage = "https://github.com/reflex-frp/reflex";
36− description = "Higher-order Functional Reactive Programming";
37− license = stdenv.lib.licenses.bsd3;
38−}
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+261−56
@@ -1,7 +1,17 @@
11Name: reflex
2−Version: 0.5
2+Version: 0.8.2.0
33Synopsis: Higher-order Functional Reactive Programming
4−Description: Reflex is a high-performance, deterministic, higher-order Functional Reactive Programming system
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+ .
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>
515License: BSD3
616License-file: LICENSE
717Author: Ryan Trinkle
@@ -9,9 +19,17 @@ Maintainer: ryan.trinkle@gmail.com
919Stability: Experimental
1020Category: FRP
1121Build-type: Simple
12−Cabal-version: >=1.9.2
13−homepage: https://github.com/reflex-frp/reflex
22+Cabal-version: 1.22
23+homepage: https://reflex-frp.org
1424bug-reports: https://github.com/reflex-frp/reflex/issues
25+extra-source-files:
26+ README.md
27+ Quickref.md
28+ ChangeLog.md
29+
30+tested-with:
31+ GHC ==8.4.4 || ==8.6.5 || ==8.8.1 || ==8.10.2,
32+ GHCJS ==8.6
1533
1634flag use-reflex-optimizer
1735 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
@@ -33,44 +51,74 @@ flag fast-weak
3351 default: False
3452 manual: True
3553
54+flag debug-propagation
55+ description: Enable debugging of spider internals
56+ default: False
57+ manual: True
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+
3669library
70+ default-language: Haskell2010
3771 hs-source-dirs: src
3872 build-depends:
3973 MemoTrie == 0.6.*,
40− base >= 4.7 && < 4.12,
74+ base >= 4.11 && < 4.15,
4175 bifunctors >= 5.2 && < 5.6,
42− comonad,
43− containers == 0.5.*,
76+ comonad >= 5.0.4 && < 5.1,
77+ constraints >= 0.10 && <0.14,
78+ constraints-extras >= 0.3 && < 0.4,
79+ containers >= 0.6 && < 0.7,
4480 data-default >= 0.5 && < 0.8,
45− dependent-map >= 0.2.4 && < 0.3,
81+ dependent-map >= 0.3 && < 0.5,
4682 exception-transformers == 0.4.*,
4783 lens >= 4.7 && < 5,
84+ mmorph >= 1.0 && < 1.2,
4885 monad-control >= 1.0.1 && < 1.1,
4986 mtl >= 2.1 && < 2.3,
50− prim-uniq >= 0.1.0.1 && < 0.2,
51− primitive >= 0.5 && < 0.7,
87+ patch >= 0.0.1 && < 0.1,
88+ prim-uniq >= 0.1.0.1 && < 0.3,
89+ primitive >= 0.5 && < 0.8,
90+ profunctors >= 5.3 && < 5.7,
5291 random == 1.1.*,
5392 ref-tf == 0.4.*,
5493 reflection == 2.1.*,
5594 semigroupoids >= 4.0 && < 6,
56− semigroups >= 0.16 && < 0.19,
57− stm == 2.4.*,
95+ stm >= 2.4 && < 2.6,
5896 syb >= 0.5 && < 0.8,
59− these >= 0.4 && < 0.8,
60− time >= 1.4 && < 1.9,
61− transformers >= 0.2,
62− transformers-compat >= 0.3,
63− unbounded-delays >= 0.1.0.0 && < 0.2
97+ time >= 1.4 && < 1.10,
98+ transformers >= 0.5.6.0 && < 0.6,
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
64109
65110 exposed-modules:
111+ Control.Monad.ReaderIO
66112 Data.AppendMap,
67113 Data.FastMutableIntMap,
68114 Data.FastWeakBag,
69− Data.Functor.Misc,
70115 Data.Map.Misc,
71116 Data.WeakBag,
72117 Reflex,
73118 Reflex.Class,
119+ Reflex.Adjustable.Class,
120+ Reflex.BehaviorWriter.Base,
121+ Reflex.BehaviorWriter.Class,
74122 Reflex.Collection,
75123 Reflex.Dynamic,
76124 Reflex.Dynamic.Uniq,
@@ -83,15 +131,9 @@ library
83131 Reflex.FastWeak,
84132 Reflex.FunctorMaybe,
85133 Reflex.Host.Class,
134+ Reflex.Host.Headless,
86135 Reflex.Network,
87136 Reflex.NotReady.Class,
88− Reflex.Patch,
89− Reflex.Patch.Class,
90− Reflex.Patch.DMap,
91− Reflex.Patch.DMapWithMove,
92− Reflex.Patch.IntMap,
93− Reflex.Patch.Map,
94− Reflex.Patch.MapWithMove,
95137 Reflex.PerformEvent.Base,
96138 Reflex.PerformEvent.Class,
97139 Reflex.PostBuild.Base,
@@ -110,39 +152,57 @@ library
110152 Reflex.Widget.Basic,
111153 Reflex.Workflow
112154
113− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively -ddump-simpl -ddump-to-file -dsuppress-coercions -dsuppress-idinfo
114− ghc-prof-options: -fprof-auto
155+ reexported-modules:
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
164+
165+ ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
115166
116167 if flag(debug-trace-events)
117168 cpp-options: -DDEBUG_TRACE_EVENTS
118− build-depends: bytestring
169+ build-depends:
170+ bytestring >= 0.10.8 && < 0.11
119171
120172 if flag(use-reflex-optimizer)
121173 cpp-options: -DUSE_REFLEX_OPTIMIZER
122174 build-depends: ghc
123175 exposed-modules: Reflex.Optimizer
124176
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+
125183 if flag(use-template-haskell)
126184 cpp-options: -DUSE_TEMPLATE_HASKELL
127185 build-depends:
128− dependent-sum >= 0.3 && < 0.5,
129− haskell-src-exts >= 1.16 && < 1.21,
186+ dependent-sum >= 0.6 && < 0.8,
187+ haskell-src-exts >= 1.16 && < 1.24,
130188 haskell-src-meta >= 0.6 && < 0.9,
131− template-haskell >= 2.9 && < 2.14
189+ template-haskell >= 2.9 && < 2.17
132190 exposed-modules:
133191 Reflex.Dynamic.TH
134192 other-extensions: TemplateHaskell
135193 else
136194 build-depends:
137− dependent-sum == 0.4.*
195+ dependent-sum >= 0.6 && < 0.8
138196
139197 if flag(fast-weak) && impl(ghcjs)
140− ghc-options: -DGHCJS_FAST_WEAK
198+ cpp-options: -DGHCJS_FAST_WEAK
141199
142200 if impl(ghcjs)
143− build-depends: ghcjs-base
201+ build-depends:
202+ ghcjs-base == 0.2.*
144203
145204test-suite semantics
205+ default-language: Haskell2010
146206 type: exitcode-stdio-1.0
147207 main-is: semantics.hs
148208 hs-source-dirs: test
@@ -151,29 +211,46 @@ test-suite semantics
151211 base,
152212 bifunctors,
153213 containers,
154− deepseq >= 1.3 && < 1.5,
214+ deepseq,
155215 dependent-map,
156216 dependent-sum,
157217 mtl,
158218 ref-tf,
159219 reflex,
160220 split,
161− transformers >= 0.3
221+ transformers
222+ other-modules:
223+ Reflex.Bench.Focused
224+ Reflex.Plan.Pure
225+ Reflex.Plan.Reflex
226+ Reflex.Test
227+ Reflex.Test.Micro
228+ Reflex.TestPlan
162229
163230test-suite CrossImpl
231+ default-language: Haskell2010
164232 type: exitcode-stdio-1.0
165233 main-is: Reflex/Test/CrossImpl.hs
166234 hs-source-dirs: test
167− ghc-options: -O2 -Wall -rtsopts -main-is Reflex.Test.CrossImpl.test
235+ ghc-options: -O2 -Wall -rtsopts
168236 build-depends:
169237 base,
170238 containers,
171239 dependent-map,
240+ dependent-sum,
241+ deepseq,
172242 mtl,
243+ transformers,
173244 ref-tf,
174245 reflex
246+ other-modules:
247+ Reflex.Test
248+ Reflex.TestPlan
249+ Reflex.Plan.Reflex
250+ Reflex.Plan.Pure
175251
176252test-suite hlint
253+ default-language: Haskell2010
177254 type: exitcode-stdio-1.0
178255 main-is: hlint.hs
179256 hs-source-dirs: test
@@ -181,102 +258,226 @@ test-suite hlint
181258 , directory
182259 , filepath
183260 , filemanip
184− , hlint
261+ if impl(ghc >= 8.8)
262+ build-depends: hlint >= 3 && < 4
263+ else
264+ build-depends: hlint (< 2.1 || >= 2.2.2) && < 4
185265 if impl(ghcjs)
186266 buildable: False
187267
188268test-suite EventWriterT
269+ default-language: Haskell2010
189270 type: exitcode-stdio-1.0
190271 main-is: EventWriterT.hs
191272 hs-source-dirs: test
192273 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
193302 , dependent-sum
303+ , hspec
194304 , lens
305+ , mtl
195306 , these
196307 , transformers
197308 , reflex
198309 , 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+
199320
200321test-suite RequesterT
322+ default-language: Haskell2010
201323 type: exitcode-stdio-1.0
202324 main-is: RequesterT.hs
203325 hs-source-dirs: test
204326 build-depends: base
205− , dependent-sum
327+ , constraints
328+ , constraints-extras
329+ , containers
330+ , deepseq
206331 , dependent-map
332+ , dependent-sum
207333 , lens
334+ , mtl
335+ , ref-tf
336+ , reflex
337+ , text
208338 , these
209339 , 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
210365 , reflex
211366 , ref-tf
212− buildable: False
367+ , these
368+
369+ other-modules:
370+ Test.Run
213371
214372test-suite QueryT
373+ default-language: Haskell2010
215374 type: exitcode-stdio-1.0
216375 main-is: QueryT.hs
217376 hs-source-dirs: test
218377 build-depends: base
219378 , containers
220− , dependent-sum
221379 , dependent-map
380+ , dependent-sum
381+ , deepseq
222382 , lens
383+ , monoidal-containers
384+ , mtl
385+ , patch
386+ , ref-tf
387+ , reflex
223388 , these
224389 , transformers
225− , semigroups
226− , reflex
227− , ref-tf
228− other-modules: Test.Run
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
229399
230400test-suite GC-Semantics
401+ default-language: Haskell2010
231402 type: exitcode-stdio-1.0
232403 main-is: GC.hs
233404 hs-source-dirs: test
234405 build-depends: base
406+ , containers
235407 , dependent-sum
236408 , dependent-map
409+ , deepseq
410+ , mtl
411+ , patch
237412 , these
238413 , transformers
239414 , reflex
240415 , ref-tf
241− if impl(ghc < 8)
242− build-depends: semigroups
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
243425
244426test-suite rootCleanup
427+ default-language: Haskell2010
245428 type: exitcode-stdio-1.0
246429 main-is: rootCleanup.hs
247430 hs-source-dirs: test
248431 build-depends: base
432+ , containers
433+ , deepseq
434+ , dependent-sum
435+ , mtl
249436 , reflex
437+ , ref-tf
438+ , these
439+ other-modules:
440+ Reflex.Plan.Pure
441+ Reflex.TestPlan
442+ Test.Run
250443
251444benchmark spider-bench
445+ default-language: Haskell2010
252446 type: exitcode-stdio-1.0
253− hs-source-dirs: bench
447+ hs-source-dirs: bench test
254448 main-is: Main.hs
255449 ghc-options: -Wall -O2 -rtsopts
256450 build-depends:
257451 base,
258− criterion == 1.1.*,
259− deepseq >= 1.3 && < 1.5,
452+ containers,
453+ criterion,
454+ deepseq,
260455 dependent-map,
261456 dependent-sum,
457+ ref-tf,
262458 mtl,
263459 primitive,
264460 reflex,
461+ split,
265462 stm,
266− transformers >= 0.3
463+ transformers
464+ other-modules:
465+ Reflex.TestPlan
466+ Reflex.Plan.Reflex
467+ Reflex.Bench.Focused
267468
268469benchmark saulzar-bench
470+ default-language: Haskell2010
269471 type: exitcode-stdio-1.0
270472 hs-source-dirs: bench test
271473 c-sources: bench-cbits/checkCapability.c
272474 main-is: RunAll.hs
273475 ghc-options: -Wall -O2 -rtsopts -threaded
274− ghc-prof-options: -fprof-auto
275476 build-depends:
276477 base,
277− containers == 0.5.*,
278− criterion == 1.1.*,
279− deepseq >= 1.3 && < 1.5,
478+ containers,
479+ criterion,
480+ deepseq,
280481 dependent-map,
281482 dependent-sum,
282483 loch-th,
@@ -288,7 +489,11 @@ benchmark saulzar-bench
288489 split,
289490 stm,
290491 time,
291− transformers >= 0.3
492+ transformers
493+ other-modules:
494+ Reflex.TestPlan
495+ Reflex.Plan.Reflex
496+ Reflex.Bench.Focused
292497
293498source-repository head
294499 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.hs+58−382
@@ -1,408 +1,84 @@
1−{-# LANGUAGE DeriveFunctor #-}
2−{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE DeriveTraversable #-}
1+{-# LANGUAGE CPP #-}
42{-# LANGUAGE FlexibleContexts #-}
53{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
74{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE PatternSynonyms #-}
86{-# LANGUAGE RoleAnnotations #-}
97{-# LANGUAGE ScopedTypeVariables #-}
108{-# LANGUAGE TypeFamilies #-}
11−-- | 'Data.Map' with a better 'Monoid' instance
12−--
13−-- 'Data.Map' has @mappend = union@, which is left-biased. AppendMap has
14−-- @mappend = unionWith mappend@ instead.
15−module Data.AppendMap where
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)
1624
17−import Prelude hiding (map)
18−
19−import Control.Lens
20−import Data.Align
2125import Data.Coerce
2226import Data.Default
2327import Data.Map (Map)
24−import qualified Data.Map as Map
25−import Data.Semigroup
26−import Data.Set (Set)
27−import Data.Typeable
28−import GHC.Generics (Generic)
29−import Reflex.Class (FunctorMaybe (..))
30−import Reflex.Patch (Additive, Group (..))
31−
32−newtype AppendMap k m = AppendMap { _unAppendMap :: Map k m }
33− deriving (Eq, Ord, Show, Read, Typeable, Generic, Functor, Foldable, Traversable, Align)
34−
35−type instance (Index (AppendMap k m)) = k
36−type instance (IxValue (AppendMap k m)) = m
37−
38−instance Ord k => Ixed (AppendMap k m) where
39− ix i = _Wrapped . ix i
40−
41−instance Ord k => At (AppendMap k m) where
42− at i = _Wrapped . at i
43−
44−instance FunctorMaybe (AppendMap k) where
45− fmapMaybe = mapMaybe
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
4655
4756-- | Deletes a key, returning 'Nothing' if the result is empty.
48−nonEmptyDelete :: Ord k => k -> AppendMap k a -> Maybe (AppendMap k a)
57+nonEmptyDelete :: Ord k => k -> MonoidalMap k a -> Maybe (MonoidalMap k a)
4958nonEmptyDelete k vs =
5059 let deleted = delete k vs
51− in if Data.AppendMap.null deleted
60+ in if null deleted
5261 then Nothing
5362 else Just deleted
5463
64+-- | Like 'mapMaybe' but indicates whether the resulting container is empty
5565mapMaybeNoNull :: (a -> Maybe b)
56− -> AppendMap token a
57− -> Maybe (AppendMap token b)
66+ -> MonoidalMap token a
67+ -> Maybe (MonoidalMap token b)
5868mapMaybeNoNull f as =
59− let bs = fmapMaybe f as
60− in if Data.AppendMap.null bs
69+ let bs = mapMaybe f as
70+ in if null bs
6171 then Nothing
6272 else Just bs
6373
64−instance FunctorWithIndex k (AppendMap k) where
65− imap f = AppendMap . imap f . _unAppendMap
66− imapped = _Wrapped . imapped
67−
68−instance FoldableWithIndex k (AppendMap k) where
69− ifolded = _Wrapped . ifolded
70−
71−instance TraversableWithIndex k (AppendMap k) where
72− itraverse = itraverseOf itraversed
73− itraversed = _Wrapped . itraversed
74−
75−instance (Ord k, Semigroup m) => Semigroup (AppendMap k m) where
76− (AppendMap m0) <> (AppendMap m1) = AppendMap $ Map.unionWith (<>) m0 m1
77−
78−instance (Ord k, Semigroup m) => Monoid (AppendMap k m) where
79− mempty = empty
80− mappend = (<>)
81−
82−instance (Ord k, Group q) => Group (AppendMap k q) where
83− negateG = map negateG
84−
85−instance (Ord k, Additive q) => Additive (AppendMap k q)
86−
87−(!) :: forall k a. Ord k => AppendMap k a -> k -> a
88−(!) = coerce ((Map.!) :: Map k a -> k -> a)
89−infixl 9 !
90−
91−(\\) :: forall k a b. Ord k => AppendMap k a -> AppendMap k b -> AppendMap k a
92−(\\) = coerce ((Map.\\) :: Map k a -> Map k b -> Map k a)
93−infixl 9 \\
94−
95−null :: forall k a. AppendMap k a -> Bool
96−null = coerce (Map.null :: Map k a -> Bool)
97−
98−size :: forall k a. AppendMap k a -> Int
99−size = coerce (Map.size :: Map k a -> Int)
100−
101−member :: forall k a. Ord k => k -> AppendMap k a -> Bool
102−member = coerce (Map.member :: k -> Map k a -> Bool)
103−
104−notMember :: forall k a. Ord k => k -> AppendMap k a -> Bool
105−notMember = coerce (Map.notMember :: k -> Map k a -> Bool)
106−
107−lookup :: forall k a. Ord k => k -> AppendMap k a -> Maybe a
108−lookup = coerce (Map.lookup :: k -> Map k a -> Maybe a)
109−
110−findWithDefault :: forall k a. Ord k => a -> k -> AppendMap k a -> a
111−findWithDefault = coerce (Map.findWithDefault :: a -> k -> Map k a -> a)
112−
113−lookupLT :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
114−lookupLT = coerce (Map.lookupLT :: k -> Map k a -> Maybe (k,a))
115−
116−lookupGT :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
117−lookupGT = coerce (Map.lookupGT :: k -> Map k a -> Maybe (k,a))
118−
119−lookupLE :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
120−lookupLE = coerce (Map.lookupLE :: k -> Map k a -> Maybe (k,a))
121−
122−lookupGE :: forall k a. Ord k => k -> AppendMap k a -> Maybe (k, a)
123−lookupGE = coerce (Map.lookupGE :: k -> Map k a -> Maybe (k,a))
124−
125−empty :: forall k a. AppendMap k a
126−empty = coerce (Map.empty :: Map k a)
127−
128−singleton :: forall k a. k -> a -> AppendMap k a
129−singleton = coerce (Map.singleton :: k -> a -> Map k a)
130−
131−insert :: forall k a. Ord k => k -> a -> AppendMap k a -> AppendMap k a
132−insert = coerce (Map.insert :: k -> a -> Map k a -> Map k a)
133−
134−insertWith :: forall k a. Ord k => (a -> a -> a) -> k -> a -> AppendMap k a -> AppendMap k a
135−insertWith = coerce (Map.insertWith :: (a -> a -> a) -> k -> a -> Map k a -> Map k a)
136−
137−insertWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> k -> a -> AppendMap k a -> AppendMap k a
138−insertWithKey = coerce (Map.insertWithKey :: (k -> a -> a -> a) -> k -> a -> Map k a -> Map k a)
139−
140−insertLookupWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> k -> a -> AppendMap k a -> (Maybe a, AppendMap k a)
141−insertLookupWithKey = coerce (Map.insertLookupWithKey :: (k -> a -> a -> a) -> k -> a -> Map k a -> (Maybe a, Map k a))
142−
143−delete :: forall k a. Ord k => k -> AppendMap k a -> AppendMap k a
144−delete = coerce (Map.delete :: k -> Map k a -> Map k a)
145−
146−adjust :: forall k a. Ord k => (a -> a) -> k -> AppendMap k a -> AppendMap k a
147−adjust = coerce (Map.adjust :: (a -> a) -> k -> Map k a -> Map k a)
148−
149−adjustWithKey :: forall k a. Ord k => (k -> a -> a) -> k -> AppendMap k a -> AppendMap k a
150−adjustWithKey = coerce (Map.adjustWithKey :: (k -> a -> a) -> k -> Map k a -> Map k a)
151−
152−update :: forall k a. Ord k => (a -> Maybe a) -> k -> AppendMap k a -> AppendMap k a
153−update = coerce (Map.update :: (a -> Maybe a) -> k -> Map k a -> Map k a)
154−
155−updateWithKey :: forall k a. Ord k => (k -> a -> Maybe a) -> k -> AppendMap k a -> AppendMap k a
156−updateWithKey = coerce (Map.updateWithKey :: (k -> a -> Maybe a) -> k -> Map k a -> Map k a)
157−
158−updateLookupWithKey :: forall k a. Ord k => (k -> a -> Maybe a) -> k -> AppendMap k a -> (Maybe a, AppendMap k a)
159−updateLookupWithKey = coerce (Map.updateLookupWithKey :: (k -> a -> Maybe a) -> k -> Map k a -> (Maybe a, Map k a))
160−
161−alter :: forall k a. Ord k => (Maybe a -> Maybe a) -> k -> AppendMap k a -> AppendMap k a
162−alter = coerce (Map.alter :: (Maybe a -> Maybe a) -> k -> Map k a -> Map k a)
163−
164−unionWith :: forall k a. Ord k => (a -> a -> a) -> AppendMap k a -> AppendMap k a -> AppendMap k a
165−unionWith = coerce (Map.unionWith :: (a -> a -> a) -> Map k a -> Map k a -> Map k a)
166−
167−unionWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> AppendMap k a -> AppendMap k a -> AppendMap k a
168−unionWithKey = coerce (Map.unionWithKey :: (k -> a -> a -> a) -> Map k a -> Map k a -> Map k a)
169−
170−unionsWith :: forall k a. Ord k => (a -> a -> a) -> [AppendMap k a] -> AppendMap k a
171−unionsWith = coerce (Map.unionsWith :: (a -> a -> a) -> [Map k a] -> Map k a)
172−
173−difference :: forall k a b. Ord k => AppendMap k a -> AppendMap k b -> AppendMap k a
174−difference = (\\)
175−
176−differenceWith :: forall k a b. Ord k => (a -> b -> Maybe a) -> AppendMap k a -> AppendMap k b -> AppendMap k a
177−differenceWith = coerce (Map.differenceWith :: (a -> b -> Maybe a) -> Map k a -> Map k b -> Map k a)
178−
179−differenceWithKey :: forall k a b. Ord k => (k -> a -> b -> Maybe a) -> AppendMap k a -> AppendMap k b -> AppendMap k a
180−differenceWithKey = coerce (Map.differenceWithKey :: (k -> a -> b -> Maybe a) -> Map k a -> Map k b -> Map k a)
181−
182−intersectionWith :: forall k a b c. Ord k => (a -> b -> c) -> AppendMap k a -> AppendMap k b -> AppendMap k c
183−intersectionWith = coerce (Map.intersectionWith :: (a -> b -> c) -> Map k a -> Map k b -> Map k c)
184−
185−intersectionWithKey :: forall k a b c. Ord k => (k -> a -> b -> c) -> AppendMap k a -> AppendMap k b -> AppendMap k c
186−intersectionWithKey = coerce (Map.intersectionWithKey :: (k -> a -> b -> c) -> Map k a -> Map k b -> Map k c)
187−
188−mergeWithKey :: forall k a b c. Ord k => (k -> a -> b -> Maybe c) -> (AppendMap k a -> AppendMap k c) -> (AppendMap k b -> AppendMap k c) -> AppendMap k a -> AppendMap k b -> AppendMap k c
189−mergeWithKey = coerce (Map.mergeWithKey :: (k -> a -> b -> Maybe c) -> (Map k a -> Map k c) -> (Map k b -> Map k c) -> Map k a -> Map k b -> Map k c)
190−
191−map :: (a -> b) -> AppendMap k a -> AppendMap k b
192−map = fmap
193−
194−mapWithKey :: (k -> a -> b) -> AppendMap k a -> AppendMap k b
195−mapWithKey = imap
196−
197−traverseWithKey :: Applicative t => (k -> a -> t b) -> AppendMap k a -> t (AppendMap k b)
198−traverseWithKey = itraverse
199−
200−mapAccum :: forall k a b c. (a -> b -> (a, c)) -> a -> AppendMap k b -> (a, AppendMap k c)
201−mapAccum = coerce (Map.mapAccum :: (a -> b -> (a, c)) -> a -> Map k b -> (a, Map k c))
202−
203−mapAccumWithKey :: forall k a b c. (a -> k -> b -> (a, c)) -> a -> AppendMap k b -> (a, AppendMap k c)
204−mapAccumWithKey = coerce (Map.mapAccumWithKey :: (a -> k -> b -> (a, c)) -> a -> Map k b -> (a, Map k c))
205−
206−mapAccumRWithKey :: forall k a b c. (a -> k -> b -> (a, c)) -> a -> AppendMap k b -> (a, AppendMap k c)
207−mapAccumRWithKey = coerce (Map.mapAccumRWithKey :: (a -> k -> b -> (a, c)) -> a -> Map k b -> (a, Map k c))
208−
209−mapKeys :: forall k1 k2 a. Ord k2 => (k1 -> k2) -> AppendMap k1 a -> AppendMap k2 a
210−mapKeys = coerce (Map.mapKeys :: (k1 -> k2) -> Map k1 a -> Map k2 a)
211−
212−mapKeysWith :: forall k1 k2 a. Ord k2 => (a -> a -> a) -> (k1 -> k2) -> AppendMap k1 a -> AppendMap k2 a
213−mapKeysWith = coerce (Map.mapKeysWith :: (a -> a -> a) -> (k1 -> k2) -> Map k1 a -> Map k2 a)
214−
215−mapKeysMonotonic :: forall k1 k2 a. (k1 -> k2) -> AppendMap k1 a -> AppendMap k2 a
216−mapKeysMonotonic = coerce (Map.mapKeysMonotonic :: (k1 -> k2) -> Map k1 a -> Map k2 a)
217−
218−foldr :: forall k a b. (a -> b -> b) -> b -> AppendMap k a -> b
219−foldr = coerce (Map.foldr :: (a -> b -> b) -> b -> Map k a -> b)
220−
221−foldl :: forall k a b. (a -> b -> a) -> a -> AppendMap k b -> a
222−foldl = coerce (Map.foldl :: (a -> b -> a) -> a -> Map k b -> a)
223−
224−foldrWithKey :: forall k a b. (k -> a -> b -> b) -> b -> AppendMap k a -> b
225−foldrWithKey = coerce (Map.foldrWithKey :: (k -> a -> b -> b) -> b -> Map k a -> b)
226−
227−foldlWithKey :: forall k a b. (a -> k -> b -> a) -> a -> AppendMap k b -> a
228−foldlWithKey = coerce (Map.foldlWithKey :: (a -> k -> b -> a) -> a -> Map k b -> a)
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)
22978
230−foldMapWithKey :: forall k a m. Monoid m => (k -> a -> m) -> AppendMap k a -> m
231−foldMapWithKey = coerce (Map.foldMapWithKey :: Monoid m => (k -> a -> m) -> Map k a -> m)
232−
233−foldr' :: forall k a b. (a -> b -> b) -> b -> AppendMap k a -> b
234−foldr' = coerce (Map.foldr' :: (a -> b -> b) -> b -> Map k a -> b)
235−
236−foldl' :: forall k a b. (a -> b -> a) -> a -> AppendMap k b -> a
237−foldl' = coerce (Map.foldl' :: (a -> b -> a) -> a -> Map k b -> a)
238−
239−foldrWithKey' :: forall k a b. (k -> a -> b -> b) -> b -> AppendMap k a -> b
240−foldrWithKey' = coerce (Map.foldrWithKey' :: (k -> a -> b -> b) -> b -> Map k a -> b)
241−
242−foldlWithKey' :: forall k a b. (a -> k -> b -> a) -> a -> AppendMap k b -> a
243−foldlWithKey' = coerce (Map.foldlWithKey' :: (a -> k -> b -> a) -> a -> Map k b -> a)
244−
245−elems :: forall k a. AppendMap k a -> [a]
246−elems = coerce (Map.elems :: Map k a -> [a])
247−
248−keys :: forall k a. AppendMap k a -> [k]
249−keys = coerce (Map.keys :: Map k a -> [k])
250−
251−assocs :: forall k a. AppendMap k a -> [(k, a)]
252−assocs = coerce (Map.assocs :: Map k a -> [(k, a)])
253−
254−keysSet :: forall k a. AppendMap k a -> Set k
255−keysSet = coerce (Map.keysSet :: Map k a -> Set k)
256−
257−fromSet :: forall k a. (k -> a) -> Set k -> AppendMap k a
258−fromSet = coerce (Map.fromSet :: (k -> a) -> Set k -> Map k a)
259−
260−toList :: forall k a. AppendMap k a -> [(k, a)]
261−toList = coerce (Map.toList :: Map k a -> [(k, a)])
262−
263−fromList :: forall k a. Ord k => [(k, a)] -> AppendMap k a
264−fromList = coerce (Map.fromList :: [(k, a)] -> Map k a)
265−
266−fromListWith :: forall k a. Ord k => (a -> a -> a) -> [(k, a)] -> AppendMap k a
267−fromListWith = coerce (Map.fromListWith :: (a -> a -> a) -> [(k, a)] -> Map k a)
268−
269−fromListWithKey :: forall k a. Ord k => (k -> a -> a -> a) -> [(k, a)] -> AppendMap k a
270−fromListWithKey = coerce (Map.fromListWithKey :: (k -> a -> a -> a) -> [(k, a)] -> Map k a)
271−
272−toAscList :: forall k a. AppendMap k a -> [(k, a)]
273−toAscList = coerce (Map.toAscList :: Map k a -> [(k, a)])
274−
275−toDescList :: forall k a. AppendMap k a -> [(k, a)]
276−toDescList = coerce (Map.toDescList :: Map k a -> [(k, a)])
277−
278−fromAscList :: forall k a. Eq k => [(k, a)] -> AppendMap k a
279−fromAscList = coerce (Map.fromAscList :: [(k, a)] -> Map k a)
280−
281−fromAscListWith :: forall k a. Eq k => (a -> a -> a) -> [(k, a)] -> AppendMap k a
282−fromAscListWith = coerce (Map.fromAscListWith :: (a -> a -> a) -> [(k, a)] -> Map k a)
283−
284−fromAscListWithKey :: forall k a. Eq k => (k -> a -> a -> a) -> [(k, a)] -> AppendMap k a
285−fromAscListWithKey = coerce (Map.fromAscListWithKey :: (k -> a -> a -> a) -> [(k, a)] -> Map k a)
286−
287−fromDistinctAscList :: forall k a. [(k, a)] -> AppendMap k a
288−fromDistinctAscList = coerce (Map.fromDistinctAscList :: [(k, a)] -> Map k a)
289−
290−filter :: forall k a. (a -> Bool) -> AppendMap k a -> AppendMap k a
291−filter = coerce (Map.filter :: (a -> Bool) -> Map k a -> Map k a)
292−
293−filterWithKey :: forall k a. (k -> a -> Bool) -> AppendMap k a -> AppendMap k a
294−filterWithKey = coerce (Map.filterWithKey :: (k -> a -> Bool) -> Map k a -> Map k a)
295−
296−partition :: forall k a. (a -> Bool) -> AppendMap k a -> (AppendMap k a, AppendMap k a)
297−partition = coerce (Map.partition :: (a -> Bool) -> Map k a -> (Map k a, Map k a))
298−
299−partitionWithKey :: forall k a. (k -> a -> Bool) -> AppendMap k a -> (AppendMap k a, AppendMap k a)
300−partitionWithKey = coerce (Map.partitionWithKey :: (k -> a -> Bool) -> Map k a -> (Map k a, Map k a))
301−
302−mapMaybe :: forall k a b. (a -> Maybe b) -> AppendMap k a -> AppendMap k b
303−mapMaybe = coerce (Map.mapMaybe :: (a -> Maybe b) -> Map k a -> Map k b)
304−
305−mapMaybeWithKey :: forall k a b. (k -> a -> Maybe b) -> AppendMap k a -> AppendMap k b
306−mapMaybeWithKey = coerce (Map.mapMaybeWithKey :: (k -> a -> Maybe b) -> Map k a -> Map k b)
307−
308−mapEither :: forall k a b c. (a -> Either b c) -> AppendMap k a -> (AppendMap k b, AppendMap k c)
309−mapEither = coerce (Map.mapEither :: (a -> Either b c) -> Map k a -> (Map k b, Map k c))
310−
311−mapEitherWithKey :: forall k a b c. (k -> a -> Either b c) -> AppendMap k a -> (AppendMap k b, AppendMap k c)
312−mapEitherWithKey = coerce (Map.mapEitherWithKey :: (k -> a -> Either b c) -> Map k a -> (Map k b, Map k c))
313−
314−split :: forall k a. Ord k => k -> AppendMap k a -> (AppendMap k a, AppendMap k a)
315−split = coerce (Map.split :: k -> Map k a -> (Map k a, Map k a))
316−
317−splitLookup :: forall k a. Ord k => k -> AppendMap k a -> (AppendMap k a, Maybe a, AppendMap k a)
318−splitLookup = coerce (Map.splitLookup :: k -> Map k a -> (Map k a, Maybe a, Map k a))
319−
320−splitRoot :: forall k a. AppendMap k a -> [AppendMap k a]
321−splitRoot = coerce (Map.splitRoot :: Map k a -> [Map k a])
322−
323−isSubmapOf :: forall k a. (Ord k, Eq a) => AppendMap k a -> AppendMap k a -> Bool
324−isSubmapOf = coerce (Map.isSubmapOf :: Map k a -> Map k a -> Bool)
325−
326−isSubmapOfBy :: forall k a b. Ord k => (a -> b -> Bool) -> AppendMap k a -> AppendMap k b -> Bool
327−isSubmapOfBy = coerce (Map.isSubmapOfBy :: (a -> b -> Bool) -> Map k a -> Map k b -> Bool)
328−
329−isProperSubmapOf :: forall k a. (Ord k, Eq a) => AppendMap k a -> AppendMap k a -> Bool
330−isProperSubmapOf = coerce (Map.isProperSubmapOf :: Map k a -> Map k a -> Bool)
331−
332−isProperSubmapOfBy :: forall k a b. Ord k => (a -> b -> Bool) -> AppendMap k a -> AppendMap k b -> Bool
333−isProperSubmapOfBy = coerce (Map.isProperSubmapOfBy :: (a -> b -> Bool) -> Map k a -> Map k b -> Bool)
334−
335−lookupIndex :: forall k a. Ord k => k -> AppendMap k a -> Maybe Int
336−lookupIndex = coerce (Map.lookupIndex :: k -> Map k a -> Maybe Int)
337−
338−findIndex :: forall k a. Ord k => k -> AppendMap k a -> Int
339−findIndex = coerce (Map.findIndex :: k -> Map k a -> Int)
340−
341−elemAt :: forall k a. Int -> AppendMap k a -> (k, a)
342−elemAt = coerce (Map.elemAt :: Int -> Map k a -> (k, a))
343−
344−updateAt :: forall k a. (k -> a -> Maybe a) -> Int -> AppendMap k a -> AppendMap k a
345−updateAt = coerce (Map.updateAt :: (k -> a -> Maybe a) -> Int -> Map k a -> Map k a)
346−
347−deleteAt :: forall k a. Int -> AppendMap k a -> AppendMap k a
348−deleteAt = coerce (Map.deleteAt :: Int -> Map k a -> Map k a)
349−
350−findMin :: forall k a. AppendMap k a -> (k, a)
351−findMin = coerce (Map.findMin :: Map k a -> (k, a))
352−
353−findMax :: forall k a. AppendMap k a -> (k, a)
354−findMax = coerce (Map.findMax :: Map k a -> (k, a))
355−
356−deleteMin :: forall k a. AppendMap k a -> AppendMap k a
357−deleteMin = coerce (Map.deleteMin :: Map k a -> Map k a)
358−
359−deleteMax :: forall k a. AppendMap k a -> AppendMap k a
360−deleteMax = coerce (Map.deleteMax :: Map k a -> Map k a)
361−
362−deleteFindMin :: forall k a. AppendMap k a -> ((k, a), AppendMap k a)
363−deleteFindMin = coerce (Map.deleteFindMin :: Map k a -> ((k, a), Map k a))
364−
365−deleteFindMax :: forall k a. AppendMap k a -> ((k, a), AppendMap k a)
366−deleteFindMax = coerce (Map.deleteFindMax :: Map k a -> ((k, a), Map k a))
367−
368−updateMin :: forall k a. (a -> Maybe a) -> AppendMap k a -> AppendMap k a
369−updateMin = coerce (Map.updateMin :: (a -> Maybe a) -> Map k a -> Map k a)
370−
371−updateMax :: forall k a. (a -> Maybe a) -> AppendMap k a -> AppendMap k a
372−updateMax = coerce (Map.updateMax :: (a -> Maybe a) -> Map k a -> Map k a)
373−
374−updateMinWithKey :: forall k a. (k -> a -> Maybe a) -> AppendMap k a -> AppendMap k a
375−updateMinWithKey = coerce (Map.updateMinWithKey :: (k -> a -> Maybe a) -> Map k a -> Map k a)
376−
377−updateMaxWithKey :: forall k a. (k -> a -> Maybe a) -> AppendMap k a -> AppendMap k a
378−updateMaxWithKey = coerce (Map.updateMaxWithKey :: (k -> a -> Maybe a) -> Map k a -> Map k a)
379−
380−minView :: forall k a. AppendMap k a -> Maybe (a, AppendMap k a)
381−minView = coerce (Map.minView :: Map k a -> Maybe (a, Map k a))
382−
383−maxView :: forall k a. AppendMap k a -> Maybe (a, AppendMap k a)
384−maxView = coerce (Map.maxView :: Map k a -> Maybe (a, Map k a))
385−
386−minViewWithKey :: forall k a. AppendMap k a -> Maybe ((k, a), AppendMap k a)
387−minViewWithKey = coerce (Map.minViewWithKey :: Map k a -> Maybe ((k, a), Map k a))
388−
389−maxViewWithKey :: forall k a. AppendMap k a -> Maybe ((k, a), AppendMap k a)
390−maxViewWithKey = coerce (Map.maxViewWithKey :: Map k a -> Maybe ((k, a), Map k a))
391−
392−showTree :: forall k a. (Show k, Show a) => AppendMap k a -> String
393−showTree = coerce (Map.showTree :: (Show k, Show a) => Map k a -> String)
394−
395−showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> AppendMap k a -> String
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
39681showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
39782
398−valid :: forall k a. Ord k => AppendMap k a -> Bool
399−valid = coerce (Map.valid :: Ord k => Map k a -> Bool)
400−
401−instance Default (AppendMap k a) where
83+instance Default (MonoidalMap k a) where
40284 def = empty
403−
404−instance AppendMap k' v' ~ t => Rewrapped (AppendMap k a) t
405−
406−instance Wrapped (AppendMap k a) where
407− type Unwrapped (AppendMap k a) = Map k a
408− _Wrapped' = iso (\(AppendMap m) -> m) AppendMap
src/Data/FastMutableIntMap.hs+25−4
@@ -1,4 +1,9 @@
11{-# LANGUAGE TypeFamilies #-}
2+-- |
3+-- Module:
4+-- Data.FastMutableIntMap
5+-- Description:
6+-- A mutable version of 'IntMap'
27module Data.FastMutableIntMap
38 ( FastMutableIntMap
49 , new
@@ -16,49 +21,60 @@ module Data.FastMutableIntMap
1621 , patchIntMapNewElements
1722 , patchIntMapNewElementsMap
1823 , getDeletions
24+ , toList
1925 ) where
2026
2127--TODO: Pure JS version
2228--TODO: Fast copy to FastIntMap
2329--TODO: Fast patch type
2430
31+import Prelude hiding (lookup)
32+
2533import Control.Monad.IO.Class
2634import Data.Foldable (traverse_)
2735import Data.IntMap.Strict (IntMap)
2836import qualified Data.IntMap.Strict as IntMap
2937import Data.IORef
30−import Data.Maybe
31−import Prelude hiding (lookup)
32−import Reflex.Patch.Class
33−import Reflex.Patch.IntMap
38+import Data.Patch.Class
39+import Data.Patch.IntMap
3440
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.
3543newtype FastMutableIntMap a = FastMutableIntMap (IORef (IntMap a))
3644
45+-- | Create a new 'FastMutableIntMap' out of an 'IntMap'
3746new :: IntMap a -> IO (FastMutableIntMap a)
3847new m = FastMutableIntMap <$> newIORef m
3948
49+-- | Create a new empty 'FastMutableIntMap'
4050newEmpty :: IO (FastMutableIntMap a)
4151newEmpty = FastMutableIntMap <$> newIORef IntMap.empty
4252
53+-- | Insert an element into a 'FastMutableIntMap' at the given key
4354insert :: FastMutableIntMap a -> Int -> a -> IO ()
4455insert (FastMutableIntMap r) k v = modifyIORef' r $ IntMap.insert k v
4556
57+-- | Attempt to lookup an element by key in a 'FastMutableIntMap'
4658lookup :: FastMutableIntMap a -> Int -> IO (Maybe a)
4759lookup (FastMutableIntMap r) k = IntMap.lookup k <$> readIORef r
4860
61+-- | Runs the provided action over the intersection of a 'FastMutableIntMap' and an 'IntMap'
4962forIntersectionWithImmutable_ :: MonadIO m => FastMutableIntMap a -> IntMap b -> (a -> b -> m ()) -> m ()
5063forIntersectionWithImmutable_ (FastMutableIntMap r) b f = do
5164 a <- liftIO $ readIORef r
5265 traverse_ (uncurry f) $ IntMap.intersectionWith (,) a b
5366
67+-- | Runs the provided action over the values of a 'FastMutableIntMap'
5468for_ :: MonadIO m => FastMutableIntMap a -> (a -> m ()) -> m ()
5569for_ (FastMutableIntMap r) f = do
5670 a <- liftIO $ readIORef r
5771 traverse_ f a
5872
73+-- | Checks whether a 'FastMutableIntMap' is empty
5974isEmpty :: FastMutableIntMap a -> IO Bool
6075isEmpty (FastMutableIntMap r) = IntMap.null <$> readIORef r
6176
77+-- | Retrieves the size of a 'FastMutableIntMap'
6278size :: FastMutableIntMap a -> IO Int
6379size (FastMutableIntMap r) = IntMap.size <$> readIORef r
6480
@@ -69,8 +85,13 @@ getFrozenAndClear (FastMutableIntMap r) = do
6985 writeIORef r IntMap.empty
7086 return result
7187
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.
7290applyPatch :: FastMutableIntMap a -> PatchIntMap a -> IO (IntMap a)
7391applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
7492 v <- readIORef r
7593 writeIORef r $! applyAlways p v
7694 return $ IntMap.intersection v m
95+
96+toList :: FastMutableIntMap a -> IO [(Int, a)]
97+toList (FastMutableIntMap r) = IntMap.toList <$> readIORef r
src/Data/FastWeakBag.hs+15−11
@@ -18,6 +18,7 @@ module Data.FastWeakBag
1818 , isEmpty
1919 , insert
2020 , traverse
21+ , traverse_
2122 , remove
2223 -- * Internal functions
2324 -- These will not always be available.
@@ -26,7 +27,9 @@ module Data.FastWeakBag
2627#endif
2728 ) where
2829
29−import Control.Monad hiding (forM_, mapM_)
30+import Prelude hiding (traverse)
31+
32+import Control.Monad
3033import Control.Monad.IO.Class
3134
3235#ifdef GHCJS_FAST_WEAK
@@ -34,24 +37,21 @@ import GHCJS.Types
3437import Reflex.FastWeak (js_isNull, unsafeFromRawJSVal, unsafeToRawJSVal)
3538#else
3639import Control.Exception
37−import Data.Foldable (forM_, mapM_)
3840import Data.IntMap.Strict (IntMap)
3941import qualified Data.IntMap.Strict as IntMap
4042import Data.IORef
4143import System.Mem.Weak
4244#endif
4345
44−import Prelude hiding (mapM_, traverse)
45−
46−-- | A @FastWeakBag a@ 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@s remain
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
4848-- alive, the 'FastWeakBag' will continue to refer to them.
4949#ifdef GHCJS_FAST_WEAK
5050newtype FastWeakBag a = FastWeakBag JSVal
5151#else
5252data FastWeakBag a = FastWeakBag
5353 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
54− , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a)))
54+ , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a))) -- ^ Map of items contained by the 'FastWeakBag'
5555 }
5656#endif
5757
@@ -117,14 +117,14 @@ foreign import javascript unsafe "(function(){ for(var i = 0; i < $1.tickets.len
117117isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
118118#endif
119119
120−{-# INLINE traverse #-}
120+{-# INLINE traverse_ #-}
121121-- | Visit every node in the given list. If new nodes are appended during the
122122-- traversal, they will not be visited. Every live node that was in the list
123123-- when the traversal began will be visited exactly once; however, no guarantee
124124-- is made about the order of the traversal.
125−traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
125+traverse_ :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
126126#ifdef GHCJS_FAST_WEAK
127−traverse wb f = do
127+traverse_ wb f = do
128128 let go cursor = when (not $ js_isNull cursor) $ do
129129 val <- liftIO $ js_getTicketValue cursor
130130 f $ unsafeFromRawJSVal val
@@ -135,13 +135,17 @@ foreign import javascript unsafe "$r = $1.val;" js_getTicketValue :: JSVal -> IO
135135--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
136136foreign 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
137137#else
138−traverse (FastWeakBag _ children) f = {-# SCC "traverse" #-} do
138+traverse_ (FastWeakBag _ children) f = {-# SCC "traverse_" #-} do
139139 cs <- liftIO $ readIORef children
140140 forM_ cs $ \c -> do
141141 ma <- liftIO $ deRefWeak c
142142 mapM_ f ma
143143#endif
144144
145+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
146+traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
147+traverse = traverse_
148+
145149-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
146150-- on the same 'FastWeakBagTicket'.
147151{-# INLINE remove #-}
src/Data/Functor/Misc.hsdeleted−287
@@ -1,287 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE KindSignatures #-}
8−{-# LANGUAGE LambdaCase #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10−{-# LANGUAGE PatternSynonyms #-}
11−{-# LANGUAGE PolyKinds #-}
12−{-# LANGUAGE RankNTypes #-}
13−{-# LANGUAGE ScopedTypeVariables #-}
14−{-# LANGUAGE StandaloneDeriving #-}
15−#ifdef USE_REFLEX_OPTIMIZER
16−{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
17−#endif
18−-- | This module provides types and functions with no particular theme, but
19−-- which are relevant to the use of 'Functor'-based datastructures like
20−-- 'Data.Dependent.Map.DMap'.
21−module Data.Functor.Misc
22− ( -- * Const2
23− Const2 (..)
24− , unConst2
25− , dmapToMap
26− , dmapToIntMap
27− , dmapToMapWith
28− , mapToDMap
29− , weakenDMapWith
30− -- * WrapArg
31− , WrapArg (..)
32− -- * Convenience functions for DMap
33− , mapWithFunctorToDMap
34− , intMapWithFunctorToDMap
35− , mapKeyValuePairsMonotonic
36− , combineDMapsWithKey
37− , EitherTag (..)
38− , dmapToThese
39− , eitherToDSum
40− , dsumToEither
41− -- * Deprecated functions
42− , sequenceDmap
43− , wrapDMap
44− , rewrapDMap
45− , unwrapDMap
46− , unwrapDMapMaybe
47− , extractFunctorDMap
48− , ComposeMaybe (..)
49− ) where
50−
51−import Control.Applicative (Applicative, (<$>))
52−import Control.Monad.Identity
53−import Data.Dependent.Map (DMap)
54−import qualified Data.Dependent.Map as DMap
55−import Data.Dependent.Sum
56−import Data.GADT.Compare
57−import Data.GADT.Show
58−import Data.IntMap (IntMap)
59−import qualified Data.IntMap as IntMap
60−import Data.Map (Map)
61−import qualified Data.Map as Map
62−import Data.Some (Some)
63−import qualified Data.Some as Some
64−import Data.These
65−import Data.Typeable hiding (Refl)
66−
67−--------------------------------------------------------------------------------
68−-- Const2
69−--------------------------------------------------------------------------------
70−
71−-- | 'Const2' stores a value of a given type 'k' and ensures that a particular
72−-- type 'v' is always given for the last type parameter
73−data Const2 :: * -> x -> x -> * where
74− Const2 :: k -> Const2 k v v
75− deriving (Typeable)
76−
77−-- | Extract the value from a Const2
78−unConst2 :: Const2 k v v' -> k
79−unConst2 (Const2 k) = k
80−
81−deriving instance Eq k => Eq (Const2 k v v')
82−deriving instance Ord k => Ord (Const2 k v v')
83−deriving instance Show k => Show (Const2 k v v')
84−deriving instance Read k => Read (Const2 k v v)
85−
86−instance Show k => GShow (Const2 k v) where
87− gshowsPrec n x@(Const2 _) = showsPrec n x
88−
89−instance (Show k, Show (f v)) => ShowTag (Const2 k v) f where
90− showTaggedPrec (Const2 _) = showsPrec
91−
92−instance Eq k => GEq (Const2 k v) where
93− geq (Const2 a) (Const2 b) =
94− if a == b
95− then Just Refl
96− else Nothing
97−
98−instance Ord k => GCompare (Const2 k v) where
99− gcompare (Const2 a) (Const2 b) = case compare a b of
100− LT -> GLT
101− EQ -> GEQ
102− GT -> GGT
103−
104−-- | Convert a 'DMap' to a regular 'Map'
105−dmapToMap :: DMap (Const2 k v) Identity -> Map k v
106−dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
107−
108−-- | Convert a 'DMap' to an 'IntMap'
109−dmapToIntMap :: DMap (Const2 IntMap.Key v) Identity -> IntMap v
110−dmapToIntMap = IntMap.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
111−
112−-- | Convert a 'DMap' to a regular 'Map', applying the given function to remove
113−-- the wrapping 'Functor'
114−dmapToMapWith :: (f v -> v') -> DMap (Const2 k v) f -> Map k v'
115−dmapToMapWith f = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, f v)) . DMap.toAscList
116−
117−-- | Convert a regular 'Map' to a 'DMap'
118−mapToDMap :: Map k v -> DMap (Const2 k v) Identity
119−mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
120−
121−-- | Convert a regular 'Map', where the values are already wrapped in a functor,
122−-- to a 'DMap'
123−mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
124−mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
125−
126−-- | Convert a regular 'IntMap', where the values are already wrapped in a
127−-- functor, to a 'DMap'
128−intMapWithFunctorToDMap :: IntMap (f v) -> DMap (Const2 IntMap.Key v) f
129−intMapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . IntMap.toAscList
130−
131−-- | Convert a 'DMap' to a regular 'Map' by forgetting the types associated with
132−-- the keys, using a function to remove the wrapping 'Functor'
133−weakenDMapWith :: (forall a. v a -> v') -> DMap k v -> Map (Some k) v'
134−weakenDMapWith f = Map.fromDistinctAscList . map (\(k :=> v) -> (Some.This k, f v)) . DMap.toAscList
135−
136−--------------------------------------------------------------------------------
137−-- WrapArg
138−--------------------------------------------------------------------------------
139−
140−-- | 'WrapArg' can be used to tag a value in one functor with a type
141−-- representing another functor. This was primarily used with dependent-map <
142−-- 0.2, in which the value type was not wrapped in a separate functor.
143−data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
144− WrapArg :: f a -> WrapArg g f (g a)
145−
146−deriving instance Eq (f a) => Eq (WrapArg g f (g' a))
147−deriving instance Ord (f a) => Ord (WrapArg g f (g' a))
148−deriving instance Show (f a) => Show (WrapArg g f (g' a))
149−deriving instance Read (f a) => Read (WrapArg g f (g a))
150−
151−instance GEq f => GEq (WrapArg g f) where
152− geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
153−
154−instance GCompare f => GCompare (WrapArg g f) where
155− gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
156− GLT -> GLT
157− GEQ -> GEQ
158− GGT -> GGT
159−
160−--------------------------------------------------------------------------------
161−-- Convenience functions for DMap
162−--------------------------------------------------------------------------------
163−
164−-- | Map over all key/value pairs in a 'DMap', potentially altering the key as
165−-- well as the value. The provided function MUST preserve the ordering of the
166−-- keys, or the resulting 'DMap' will be malformed.
167−mapKeyValuePairsMonotonic :: (DSum k v -> DSum k' v') -> DMap k v -> DMap k' v'
168−mapKeyValuePairsMonotonic f = DMap.fromDistinctAscList . map f . DMap.toAscList
169−
170−{-# INLINE combineDMapsWithKey #-}
171−-- | Union two 'DMap's of different types, yielding another type. Each key that
172−-- is present in either input map will be present in the output.
173−combineDMapsWithKey :: forall f g h i.
174− GCompare f
175− => (forall a. f a -> These (g a) (h a) -> i a)
176− -> DMap f g
177− -> DMap f h
178− -> DMap f i
179−combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
180− where go :: [DSum f g] -> [DSum f h] -> [DSum f i]
181− go [] hs = map (\(hk :=> hv) -> hk :=> f hk (That hv)) hs
182− go gs [] = map (\(gk :=> gv) -> gk :=> f gk (This gv)) gs
183− go gs@((gk :=> gv) : gs') hs@((hk :=> hv) : hs') = case gk `gcompare` hk of
184− GLT -> (gk :=> f gk (This gv)) : go gs' hs
185− GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
186− GGT -> (hk :=> f hk (That hv)) : go gs hs'
187−
188−-- | Extract the values of a 'DMap' of 'EitherTag's.
189−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
190−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
191− (Nothing, Nothing) -> Nothing
192− (Just (Identity a), Nothing) -> Just $ This a
193− (Nothing, Just (Identity b)) -> Just $ That b
194− (Just (Identity a), Just (Identity b)) -> Just $ These a b
195−
196−-- | Tag type for 'Either' to use it as a 'DSum'.
197−data EitherTag l r a where
198− LeftTag :: EitherTag l r l
199− RightTag :: EitherTag l r r
200− deriving (Typeable)
201−
202−deriving instance Show (EitherTag l r a)
203−deriving instance Eq (EitherTag l r a)
204−deriving instance Ord (EitherTag l r a)
205−
206−instance GEq (EitherTag l r) where
207− geq a b = case (a, b) of
208− (LeftTag, LeftTag) -> Just Refl
209− (RightTag, RightTag) -> Just Refl
210− _ -> Nothing
211−
212−instance GCompare (EitherTag l r) where
213− gcompare a b = case (a, b) of
214− (LeftTag, LeftTag) -> GEQ
215− (LeftTag, RightTag) -> GLT
216− (RightTag, LeftTag) -> GGT
217− (RightTag, RightTag) -> GEQ
218−
219−instance GShow (EitherTag l r) where
220− gshowsPrec _ a = case a of
221− LeftTag -> showString "LeftTag"
222− RightTag -> showString "RightTag"
223−
224−instance (Show l, Show r) => ShowTag (EitherTag l r) Identity where
225− showTaggedPrec t n (Identity a) = case t of
226− LeftTag -> showsPrec n a
227− RightTag -> showsPrec n a
228−
229−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
230−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
231−eitherToDSum = \case
232− Left a -> (LeftTag :=> Identity a)
233− Right b -> (RightTag :=> Identity b)
234−
235−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
236−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
237−dsumToEither = \case
238− (LeftTag :=> Identity a) -> Left a
239− (RightTag :=> Identity b) -> Right b
240−
241−--------------------------------------------------------------------------------
242−-- ComposeMaybe
243−--------------------------------------------------------------------------------
244−
245−-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
246−-- make the 'f' parameter have a nominal type role. We need f to be
247−-- representational so that we can use safe 'coerce'.
248−newtype ComposeMaybe f a =
249− ComposeMaybe { getComposeMaybe :: Maybe (f a) } deriving (Show, Eq, Ord)
250−
251−deriving instance Functor f => Functor (ComposeMaybe f)
252−
253−--------------------------------------------------------------------------------
254−-- Deprecated functions
255−--------------------------------------------------------------------------------
256−
257−{-# INLINE sequenceDmap #-}
258−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ -> fmap Identity)' instead" #-}
259−-- | Run the actions contained in the 'DMap'
260−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
261−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
262−
263−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
264−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
265−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
266−wrapDMap f = DMap.map $ f . runIdentity
267−
268−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
269−-- | Replace one functor for a 'DMap''s values with a different functor
270−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
271−rewrapDMap = DMap.map
272−
273−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
274−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
275−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
276−unwrapDMap f = DMap.map $ Identity . f
277−
278−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
279−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
280−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
281−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
282−
283−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
284−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
285−-- underlying functor
286−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
287−extractFunctorDMap = mapKeyValuePairsMonotonic $ \(Const2 k :=> Identity v) -> Const2 k :=> v
src/Data/Map/Misc.hs+26−10
@@ -1,4 +1,5 @@
11{-# LANGUAGE LambdaCase #-}
2+-- | Additional functions for manipulating 'Map's.
23module Data.Map.Misc
34 (
45 -- * Working with Maps
@@ -10,7 +11,6 @@ module Data.Map.Misc
1011 ) where
1112
1213import Data.Align
13−import Data.Either
1414import Data.Map (Map)
1515import qualified Data.Map as Map
1616import Data.Maybe
@@ -18,12 +18,21 @@ import Data.Set (Set)
1818import qualified Data.Set as Set
1919import Data.These
2020
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.
2125diffMapNoEq :: (Ord k) => Map k v -> Map k v -> Map k (Maybe v)
2226diffMapNoEq olds news = flip Map.mapMaybe (align olds news) $ \case
2327 This _ -> Just Nothing
2428 These _ new -> Just $ Just new
2529 That new -> Just $ Just new
2630
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@.
2736diffMap :: (Ord k, Eq v) => Map k v -> Map k v -> Map k (Maybe v)
2837diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
2938 This _ -> Just Nothing
@@ -32,23 +41,30 @@ diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
3241 | otherwise -> Just $ Just new
3342 That new -> Just $ Just new
3443
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'.
3547applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
3648applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
37− where (deletions, insertions) = mapPartitionEithers $ maybeToEither <$> patch
49+ where (deletions, insertions) = Map.mapEither maybeToEither patch
3850 maybeToEither = \case
3951 Nothing -> Left ()
4052 Just r -> Right r
4153
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" #-}
4256mapPartitionEithers :: Map k (Either a b) -> (Map k a, Map k b)
43−mapPartitionEithers m = (fromLeft <$> ls, fromRight <$> rs)
44− where (ls, rs) = Map.partition isLeft m
45− fromLeft (Left l) = l
46− fromLeft _ = error "mapPartitionEithers: fromLeft received a Right value; this should be impossible"
47− fromRight (Right r) = r
48− fromRight _ = error "mapPartitionEithers: fromRight received a Left value; this should be impossible"
57+mapPartitionEithers = Map.mapEither id
4958
50−-- | Apply a map patch to a set
51−-- > applyMapKeysSet patch (Map.keysSet m) == Map.keysSet (applyMap patch m)
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.
5268applyMapKeysSet :: Ord k => Map k (Maybe v) -> Set k -> Set k
5369applyMapKeysSet patch old = Map.keysSet insertions `Set.union` (old `Set.difference` Map.keysSet deletions)
5470 where (insertions, deletions) = Map.partition isJust patch
src/Data/WeakBag.hs+13−11
@@ -15,25 +15,25 @@ module Data.WeakBag
1515 , singleton
1616 , insert
1717 , traverse
18+ , traverse_
1819 , remove
1920 -- * Internal functions
2021 -- These will not always be available.
2122 , _weakBag_children --TODO: Don't export this
2223 ) where
2324
25+import Prelude hiding (traverse)
26+
2427import Control.Exception
25−import Control.Monad hiding (forM_, mapM_)
28+import Control.Monad
2629import Control.Monad.IO.Class
27−import Data.Foldable (forM_, mapM_)
2830import Data.IntMap.Strict (IntMap)
2931import qualified Data.IntMap.Strict as IntMap
3032import Data.IORef
3133import System.Mem.Weak
3234
33−import Prelude hiding (mapM_, traverse)
34−
35−-- | A @WeakBag a@ holds a set of values of type @a@, but does not retain them -
36−-- that is, they can still be garbage-collected. As long as the @a@s remain
35+-- | A 'WeakBag' holds a set of values of type @/a/@, but does not retain them -
36+-- that is, they can still be garbage-collected. As long as the @/a/@ values remain
3737-- alive, the 'WeakBag' will continue to refer to them.
3838data WeakBag a = WeakBag
3939 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
@@ -72,8 +72,6 @@ insert a (WeakBag nextId children) wbRef finalizer = {-# SCC "insert" #-} do
7272 let !csWithoutMe = IntMap.delete myId cs
7373 in (csWithoutMe, csWithoutMe)
7474 when (IntMap.null csWithoutMe) $ finalizer b
75− return ()
76− return ()
7775 wa <- mkWeakPtr a' $ Just cleanup
7876 atomicModifyIORef' children $ \cs -> (IntMap.insert myId wa cs, ())
7977 return $ WeakBagTicket
@@ -102,18 +100,22 @@ singleton a wbRef finalizer = {-# SCC "singleton" #-} do
102100 ticket <- insert a bag wbRef finalizer
103101 return (bag, ticket)
104102
105−{-# INLINE traverse #-}
103+{-# INLINE traverse_ #-}
106104-- | Visit every node in the given list. If new nodes are appended during the
107105-- traversal, they will not be visited. Every live node that was in the list
108106-- when the traversal began will be visited exactly once; however, no guarantee
109107-- is made about the order of the traversal.
110−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
111−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
108+traverse_ :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
109+traverse_ (WeakBag _ children) f = {-# SCC "traverse" #-} do
112110 cs <- liftIO $ readIORef children
113111 forM_ cs $ \c -> do
114112 ma <- liftIO $ deRefWeak c
115113 mapM_ f ma
116114
115+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
116+traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
117+traverse = traverse_
118+
117119-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
118120-- on the same 'WeakBagTicket'.
119121{-# INLINE remove #-}
src/Reflex.hs+4
@@ -6,6 +6,9 @@ module Reflex
66 ) where
77
88import Reflex.Class as X
9+import Reflex.Adjustable.Class as X
10+import Reflex.BehaviorWriter.Base as X
11+import Reflex.BehaviorWriter.Class as X
912import Reflex.Collection as X
1013import Reflex.Dynamic as X
1114import Reflex.EventWriter.Base as X
@@ -16,6 +19,7 @@ import Reflex.Dynamic.TH as X
1619import Reflex.Dynamic.Uniq as X
1720import Reflex.DynamicWriter.Base as X
1821import Reflex.DynamicWriter.Class as X
22+import Reflex.NotReady.Class as X
1923import Reflex.PerformEvent.Base as X
2024import Reflex.PerformEvent.Class as X
2125import Reflex.PostBuild.Base as X
src/Reflex/Adjustable/Class.hs+86−17
@@ -1,7 +1,8 @@
11{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
23{-# LANGUAGE FlexibleInstances #-}
34{-# LANGUAGE FunctionalDependencies #-}
4−{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE LambdaCase #-}
56{-# LANGUAGE RankNTypes #-}
67{-# LANGUAGE ScopedTypeVariables #-}
78{-# LANGUAGE TypeFamilies #-}
@@ -9,6 +10,13 @@
910#ifdef USE_REFLEX_OPTIMIZER
1011{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1112#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.
1220module Reflex.Adjustable.Class
1321 (
1422 -- * The Adjustable typeclass
@@ -16,22 +24,23 @@ module Reflex.Adjustable.Class
1624 , sequenceDMapWithAdjust
1725 , sequenceDMapWithAdjustWithMove
1826 , mapMapWithAdjustWithMove
27+ -- * Deprecated aliases
28+ , MonadAdjust
1929 ) where
2030
21−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
22−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
23−import Data.Align
24−import Data.Dependent.Map (DMap, GCompare (..))
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
2536import Data.Functor.Constant
2637import Data.Functor.Misc
38+import Data.IntMap.Strict (IntMap)
39+import qualified Data.IntMap.Strict as IntMap
2740import Data.Map (Map)
28−import qualified Data.Map as Map
29−import Data.Map.Misc
30−import Data.These
3141
3242import Reflex.Class
33−import Reflex.Dynamic
34−import Reflex.PostBuild.Class
43+import Data.Patch.DMapWithMove
3544
3645-- | A 'Monad' that supports adjustment over time. After an action has been
3746-- run, if the given events fire, it will adjust itself so that its net effect
@@ -40,10 +49,43 @@ import Reflex.PostBuild.Class
4049-- other side-effects) cannot be undone, so it is up to the instance implementer
4150-- to determine what the best meaning for this class is in such cases.
4251class (Reflex t, Monad m) => Adjustable t m | m -> t where
43− runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
44− traverseIntMapWithKeyWithAdjust :: (IntMap.Key -> v -> m v') -> IntMap v -> Event t (PatchIntMap v) -> m (IntMap v', Event t (PatchIntMap v'))
45− 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'))
46− 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'))
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'))
4789
4890instance Adjustable t m => Adjustable t (ReaderT r m) where
4991 runWithReplace a0 a' = do
@@ -59,13 +101,40 @@ instance Adjustable t m => Adjustable t (ReaderT r m) where
59101 r <- ask
60102 lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
61103
62−sequenceDMapWithAdjust :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
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))
63111sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
64112
65−sequenceDMapWithAdjustWithMove :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMapWithMove k m) -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
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))
66120sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
67121
68−mapMapWithAdjustWithMove :: forall t m k v v'. (Adjustable 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'))
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'))
69130mapMapWithAdjustWithMove f m0 m' = do
70131 (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
71132 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+722−215
@@ -7,8 +7,8 @@
77{-# LANGUAGE FunctionalDependencies #-}
88{-# LANGUAGE GADTs #-}
99{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
1110{-# LANGUAGE NoMonomorphismRestriction #-}
11+{-# LANGUAGE PolyKinds #-}
1212{-# LANGUAGE RankNTypes #-}
1313{-# LANGUAGE RecursiveDo #-}
1414{-# LANGUAGE RoleAnnotations #-}
@@ -16,42 +16,56 @@
1616{-# LANGUAGE TypeFamilies #-}
1717{-# LANGUAGE TypeOperators #-}
1818{-# LANGUAGE UndecidableInstances #-}
19+{-# LANGUAGE Trustworthy #-}
1920#ifdef USE_REFLEX_OPTIMIZER
2021{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
2122#endif
2223
23−-- | This module contains the Reflex interface, as well as a variety of
24−-- convenience functions for working with 'Event's, 'Behavior's, and other
25−-- signals.
24+-- |
25+-- Module:
26+-- Reflex.Class
27+-- Description:
28+-- This module contains the Reflex interface, as well as a variety of
29+-- convenience functions for working with 'Event's, 'Behavior's, and other
30+-- signals.
2631module Reflex.Class
27− ( module Reflex.Patch
32+ ( module Data.Patch
2833 -- * Primitives
2934 , Reflex (..)
3035 , mergeInt
3136 , coerceBehavior
3237 , coerceEvent
3338 , coerceDynamic
39+ , coerceIncremental
3440 , MonadSample (..)
3541 , MonadHold (..)
36− -- ** 'fan'-related types
42+ -- ** 'fan' related types
3743 , EventSelector (..)
44+ , EventSelectorG (..)
3845 , EventSelectorInt (..)
39− -- ** 'Incremental'-related types
4046 -- * Convenience functions
4147 , constDyn
4248 , pushAlways
4349 -- ** Combining 'Event's
4450 , leftmost
51+ , merge
52+ , mergeIncremental
53+ , mergeIncrementalWithMove
4554 , mergeMap
55+ , mergeIntMap
4656 , mergeMapIncremental
4757 , mergeMapIncrementalWithMove
4858 , mergeIntMapIncremental
59+ , coincidencePatchMap
60+ , coincidencePatchMapWithMove
61+ , coincidencePatchIntMap
4962 , mergeList
5063 , mergeWith
5164 , difference
5265 , alignEventWithMaybe
5366 -- ** Breaking up 'Event's
5467 , splitE
68+ , fan
5569 , fanEither
5670 , fanThese
5771 , fanMap
@@ -59,12 +73,16 @@ module Reflex.Class
5973 , EitherTag (..)
6074 , eitherToDSum
6175 , dsumToEither
76+ , factorEvent
77+ , filterEventKey
6278 -- ** Collapsing 'Event . Event'
6379 , switchHold
6480 , switchHoldPromptly
6581 , switchHoldPromptOnly
82+ , switchHoldPromptOnlyIncremental
6683 -- ** Using 'Event's to sample 'Behavior's
6784 , tag
85+ , tagMaybe
6886 , attach
6987 , attachWith
7088 , attachWithMaybe
@@ -72,6 +90,7 @@ module Reflex.Class
7290 , gate
7391 -- ** Combining 'Dynamic's
7492 , distributeDMapOverDynPure
93+ , distributeDMapOverDynPureG
7594 , distributeListOverDyn
7695 , distributeListOverDynWith
7796 , zipDyn
@@ -98,6 +117,14 @@ module Reflex.Class
98117 , mapAccumM_
99118 , mapAccumMaybe_
100119 , mapAccumMaybeM_
120+ , accumIncremental
121+ , accumMIncremental
122+ , accumMaybeIncremental
123+ , accumMaybeMIncremental
124+ , mapAccumIncremental
125+ , mapAccumMIncremental
126+ , mapAccumMaybeIncremental
127+ , mapAccumMaybeMIncremental
101128 , zipListWithEvent
102129 , numberOccurrences
103130 , numberOccurrencesFrom
@@ -107,6 +134,9 @@ module Reflex.Class
107134 , tailE
108135 , headTailE
109136 , takeWhileE
137+ , takeWhileJustE
138+ , dropWhileE
139+ , takeDropWhileJustE
110140 , switcher
111141 -- * Debugging functions
112142 , traceEvent
@@ -114,25 +144,24 @@ module Reflex.Class
114144 -- * Unsafe functions
115145 , unsafeDynamic
116146 , unsafeMapIncremental
117− -- * 'FunctorMaybe'
118− , FunctorMaybe (..)
147+ -- * 'Filterable' convenience functions
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
119151 , fforMaybe
120152 , ffilter
121153 , filterLeft
122154 , filterRight
123− -- * 'Adjustable'
124− , Adjustable(..)
125− , sequenceDMapWithAdjust
126− , sequenceDMapWithAdjustWithMove
127− , mapMapWithAdjustWithMove
128155 -- * Miscellaneous convenience functions
129156 , ffor
157+ , ffor2
158+ , ffor3
130159 -- * Deprecated functions
131− , MonadAdjust
132− , appendEvents
133− , onceE
134− , sequenceThese
160+ , switchPromptly
161+ , switchPromptOnly
162+ -- * "Cheap" functions
135163 , fmapMaybeCheap
164+ , mapMaybeCheap
136165 , fmapCheap
137166 , fforCheap
138167 , fforMaybeCheap
@@ -140,16 +169,25 @@ module Reflex.Class
140169 , tagCheap
141170 , mergeWithCheap
142171 , mergeWithCheap'
143− , switchPromptly
144− , switchPromptOnly
145172 -- * Slow, but general, implementations
146173 , slowHeadE
147174 ) where
148175
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+
149187import Control.Applicative
150−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
151−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
152−import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
188+import Control.Monad.Identity
189+import Control.Monad.Reader
190+import Control.Monad.State.Strict
153191import Control.Monad.Trans.Cont (ContT)
154192import Control.Monad.Trans.Except (ExceptT)
155193import Control.Monad.Trans.RWS (RWST)
@@ -158,37 +196,38 @@ import Data.Align
158196import Data.Bifunctor
159197import Data.Coerce
160198import Data.Default
161−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
199+import Data.Dependent.Map (DMap)
200+import Data.Dependent.Sum (DSum (..))
162201import qualified Data.Dependent.Map as DMap
163−import Data.Either
202+import Data.Functor.Compose
203+import Data.Functor.Product
204+import Data.GADT.Compare (GEq (..), GCompare (..))
164205import Data.FastMutableIntMap (PatchIntMap)
165206import Data.Foldable
166−import Data.Functor.Bind hiding (join)
167−import qualified Data.Functor.Bind as Bind
168−import Data.Functor.Constant
207+import Data.Functor.Bind
169208import Data.Functor.Misc
170209import Data.Functor.Plus
171210import Data.IntMap.Strict (IntMap)
172211import qualified Data.IntMap.Strict as IntMap
173212import Data.List.NonEmpty (NonEmpty (..))
174213import Data.Map (Map)
175−import Data.Maybe
176−import Data.Monoid hiding (Alt, (<>))
177−import Data.Semigroup (Semigroup, sconcat, stimes, (<>))
214+import Data.Semigroup (Semigroup (..))
215+import Data.Some (Some(Some))
178216import Data.String
179217import Data.These
180−import Data.Traversable
181218import Data.Type.Coercion
182−import Reflex.FunctorMaybe
183−import Reflex.Patch
184−
185−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
186−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
219+import Data.Type.Equality ((:~:) (..))
220+import Data.Witherable (Filterable(..))
221+import qualified Data.Witherable as W
222+import Reflex.FunctorMaybe (FunctorMaybe)
223+import qualified Reflex.FunctorMaybe
224+import Data.Patch
225+import qualified Data.Patch.MapWithMove as PatchMapWithMove
187226
188227import Debug.Trace (trace)
189228
190229-- | The 'Reflex' class contains all the primitive functionality needed for
191−-- Functional Reactive Programming (FRP). The @t@ type parameter indicates
230+-- Functional Reactive Programming (FRP). The @/t/@ type parameter indicates
192231-- which "timeline" is in use. Timelines are fully-independent FRP contexts,
193232-- and the type of the timeline determines the FRP engine to be used. For most
194233-- purposes, the 'Reflex.Spider' implementation is recommended.
@@ -234,18 +273,23 @@ class ( MonadHold t (PushM t)
234273 -- recomputed whenever any of the read 'Behavior's changes
235274 pull :: PullM t a -> Behavior t a
236275 -- | Merge a collection of events; the resulting 'Event' will only occur if at
237− -- 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
238277 -- that are occurring simultaneously
239− 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
240− -- | Efficiently fan-out an event to many destinations. This function should
241− -- be partially applied, and then the result applied repeatedly to create
242− -- child events
243− 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
278+
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+
283+ -- | Efficiently fan-out an event to many destinations. You should save the
284+ -- result in a @let@-binding, and then repeatedly 'selectG' on the result to
285+ -- create child events
286+ fanG :: GCompare k => Event t (DMap k v) -> EventSelectorG t k v
287+
244288 -- | Create an 'Event' that will occur whenever the currently-selected input
245289 -- 'Event' occurs
246290 switch :: Behavior t (Event t a) -> Event t a
247− -- | Create an 'Event' that will occur whenever the input event is occurring
248− -- and its occurrence value, another 'Event', is also occurring
291+ -- | Create an 'Event' that will occur whenever the input event is occurring -- and its occurrence value, another 'Event', is also occurring.
292+ -- You maybe looking for '@switchHold@ @never@' instead.
249293 coincidence :: Event t (Event t a) -> Event t a
250294 -- | Extract the 'Behavior' of a 'Dynamic'.
251295 current :: Dynamic t a -> Behavior t a
@@ -254,14 +298,19 @@ class ( MonadHold t (PushM t)
254298 -- | Create a new 'Dynamic'. The given 'PullM' must always return the most
255299 -- recent firing of the given 'Event', if any.
256300 unsafeBuildDynamic :: PullM t a -> Event t a -> Dynamic t a
257− -- | 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
258302 -- in the same way that the accumulated application of patches would change
259303 -- that value.
260304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
261305 -- | Create a merge whose parents can change over time
262− mergeIncremental :: GCompare k => Incremental t (PatchDMap k (Event t)) -> Event t (DMap k Identity)
306+ mergeIncrementalG :: GCompare k
307+ => (forall a. q a -> Event t (v a))
308+ -> Incremental t (PatchDMap k q)
309+ -> Event t (DMap k v)
263310 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
264− mergeIncrementalWithMove :: GCompare k => Incremental t (PatchDMapWithMove k (Event t)) -> Event t (DMap k Identity)
311+ mergeIncrementalWithMoveG :: GCompare k
312+ => (forall a. q a -> Event t (v a))
313+ -> Incremental t (PatchDMapWithMove k q) -> Event t (DMap k v)
265314 -- | Extract the 'Behavior' component of an 'Incremental'
266315 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
267316 -- | Extract the 'Event' component of an 'Incremental'
@@ -277,10 +326,28 @@ class ( MonadHold t (PushM t)
277326 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
278327 -- occurrence type
279328 dynamicCoercion :: Coercion a b -> Coercion (Dynamic t a) (Dynamic t b)
329+ -- | Construct a 'Coercion' for an 'Incremental' given 'Coercion's for its
330+ -- patch target and patch types.
331+ incrementalCoercion
332+ :: Coercion (PatchTarget a) (PatchTarget b) -> Coercion a b -> Coercion (Incremental t a) (Incremental t b)
280333 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
281334 fanInt :: Event t (IntMap a) -> EventSelectorInt t a
282335
336+-- | Efficiently fan-out an event to many destinations. You should save the
337+-- result in a @let@-binding, and then repeatedly 'select' on the result to
338+-- create child events
339+fan :: forall t k. (Reflex t, GCompare k)
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+
283348--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.
284351mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
285352mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
286353
@@ -296,8 +363,14 @@ coerceEvent = coerceWith $ eventCoercion Coercion
296363coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
297364coerceDynamic = coerceWith $ dynamicCoercion Coercion
298365
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+
299372-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
300−-- _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
301374-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
302375-- if this is not the case, the resulting 'Dynamic' will behave
303376-- nondeterministically.
@@ -325,7 +398,7 @@ class MonadSample t m => MonadHold t m where
325398 -- value and will be updated whenever the given 'Event' occurs. The update
326399 -- takes effect immediately after the 'Event' occurs; if the occurrence that
327400 -- sets the 'Behavior' (or one that is simultaneous with it) is used to sample
328− -- 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
329402 -- one.
330403 hold :: a -> Event t a -> m (Behavior t a)
331404 default hold :: (m ~ f m', MonadTrans f, MonadHold t m') => a -> Event t a -> m (Behavior t a)
@@ -340,16 +413,118 @@ class MonadSample t m => MonadHold t m where
340413 holdIncremental :: Patch p => PatchTarget p -> Event t p -> m (Incremental t p)
341414 default holdIncremental :: (Patch p, m ~ f m', MonadTrans f, MonadHold t m') => PatchTarget p -> Event t p -> m (Incremental t p)
342415 holdIncremental v0 = lift . holdIncremental v0
343− buildDynamic :: PullM t a -> Event t a -> m (Dynamic t a)
416+ buildDynamic :: PushM t a -> Event t a -> m (Dynamic t a)
344417 {-
345418 default buildDynamic :: (m ~ f m', MonadTrans f, MonadHold t m') => PullM t a -> Event t a -> m (Dynamic t a)
346419 buildDynamic getV0 = lift . buildDynamic getV0
347420 -}
348− -- | Create a new 'Event' that only occurs only once, on the first occurence of
421+ -- | Create a new 'Event' that only occurs only once, on the first occurrence of
349422 -- the supplied 'Event'.
350423 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'
351474
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')
352526
527+-- | A somewhat slow implementation of 'headE'
353528slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
354529slowHeadE e = do
355530 rec be <- hold e $ fmapCheap (const never) e'
@@ -358,18 +533,31 @@ slowHeadE e = do
358533
359534-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
360535-- key. This is much more efficient than filtering for each key with
361−-- 'fmapMaybe'.
536+-- 'mapMaybe'.
362537newtype EventSelector t k = EventSelector
363538 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
364539 -- determined by the type of the key, so this can be used to fan-out
365540 -- 'Event's whose sub-'Event's have different types.
366541 --
367542 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
368− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
543+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
369544 -- occurrences of an 'Event'.
370545 select :: forall a. k a -> Event t a
371546 }
372547
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.
373561newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
374562
375563--------------------------------------------------------------------------------
@@ -385,6 +573,7 @@ instance MonadHold t m => MonadHold t (ReaderT r m) where
385573 holdIncremental a0 = lift . holdIncremental a0
386574 buildDynamic a0 = lift . buildDynamic a0
387575 headE = lift . headE
576+ now = lift now
388577
389578instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
390579 sample = lift . sample
@@ -395,6 +584,7 @@ instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
395584 holdIncremental a0 = lift . holdIncremental a0
396585 buildDynamic a0 = lift . buildDynamic a0
397586 headE = lift . headE
587+ now = lift now
398588
399589instance MonadSample t m => MonadSample t (StateT s m) where
400590 sample = lift . sample
@@ -405,6 +595,7 @@ instance MonadHold t m => MonadHold t (StateT s m) where
405595 holdIncremental a0 = lift . holdIncremental a0
406596 buildDynamic a0 = lift . buildDynamic a0
407597 headE = lift . headE
598+ now = lift now
408599
409600instance MonadSample t m => MonadSample t (ExceptT e m) where
410601 sample = lift . sample
@@ -415,6 +606,7 @@ instance MonadHold t m => MonadHold t (ExceptT e m) where
415606 holdIncremental a0 = lift . holdIncremental a0
416607 buildDynamic a0 = lift . buildDynamic a0
417608 headE = lift . headE
609+ now = lift now
418610
419611instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
420612 sample = lift . sample
@@ -425,6 +617,7 @@ instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
425617 holdIncremental a0 = lift . holdIncremental a0
426618 buildDynamic a0 = lift . buildDynamic a0
427619 headE = lift . headE
620+ now = lift now
428621
429622instance MonadSample t m => MonadSample t (ContT r m) where
430623 sample = lift . sample
@@ -435,6 +628,7 @@ instance MonadHold t m => MonadHold t (ContT r m) where
435628 holdIncremental a0 = lift . holdIncremental a0
436629 buildDynamic a0 = lift . buildDynamic a0
437630 headE = lift . headE
631+ now = lift now
438632
439633--------------------------------------------------------------------------------
440634-- Convenience functions
@@ -449,6 +643,14 @@ pushAlways f = push (fmap Just . f)
449643ffor :: Functor f => f a -> (a -> b) -> f b
450644ffor = flip fmap
451645
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+
452654instance Reflex t => Applicative (Behavior t) where
453655 pure = constant
454656 f <*> x = pull $ sample f `ap` sample x
@@ -476,7 +678,9 @@ instance Reflex t => Monad (Behavior t) where
476678 a >>= f = pull $ sample a >>= sample . f
477679 -- 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.
478680 return = constant
681+#if !MIN_VERSION_base(4,13,0)
479682 fail = error "Monad (Behavior t) does not support fail"
683+#endif
480684
481685instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
482686 mempty = constant mempty
@@ -492,40 +696,51 @@ instance (Reflex t, Num a) => Num (Behavior t a) where
492696 negate = fmap negate
493697 signum = fmap signum
494698
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+
495708instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
496709 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
497710 sconcat = pull . fmap sconcat . mapM sample
498−#if MIN_VERSION_semigroups(0,17,0)
499711 stimes n = fmap $ stimes n
500−#else
501− times1p n = fmap $ times1p n
502−#endif
503712
504−-- | Flipped version of 'fmapMaybe'.
505−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
506−fforMaybe = flip fmapMaybe
713+-- | Alias for 'mapMaybe'
714+fmapMaybe :: Filterable f => (a -> Maybe b) -> f a -> f b
715+fmapMaybe = mapMaybe
716+
717+-- | Flipped version of 'mapMaybe'.
718+fforMaybe :: Filterable f => f a -> (a -> Maybe b) -> f b
719+fforMaybe = flip mapMaybe
507720
508721-- | Filter 'f a' using the provided predicate.
509−-- Relies on 'fforMaybe'.
510−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
511−ffilter f = fmapMaybe $ \x -> if f x then Just x else Nothing
722+ffilter :: Filterable f => (a -> Bool) -> f a -> f a
723+ffilter = W.filter
512724
513725-- | Filter 'Left's from 'f (Either a b)' into 'a'.
514−filterLeft :: FunctorMaybe f => f (Either a b) -> f a
515−filterLeft = fmapMaybe (either Just (const Nothing))
726+filterLeft :: Filterable f => f (Either a b) -> f a
727+filterLeft = mapMaybe (either Just (const Nothing))
516728
517729-- | Filter 'Right's from 'f (Either a b)' into 'b'.
518−filterRight :: FunctorMaybe f => f (Either a b) -> f b
519−filterRight = fmapMaybe (either (const Nothing) Just)
730+filterRight :: Filterable f => f (Either a b) -> f b
731+filterRight = mapMaybe (either (const Nothing) Just)
520732
521733-- | Left-biased event union (prefers left event on simultaneous
522734-- occurrence).
523735instance Reflex t => Alt (Event t) where
524736 ev1 <!> ev2 = leftmost [ev1, ev2]
525737
526−-- | 'Event' intersection (convenient interface to 'coincidence').
738+-- | 'Event' intersection. Only occurs when both events are co-incident.
527739instance Reflex t => Apply (Event t) where
528− 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+
529744
530745-- | 'Event' intersection (convenient interface to 'coincidence').
531746instance Reflex t => Bind (Event t) where
@@ -534,13 +749,18 @@ instance Reflex t => Bind (Event t) where
534749
535750instance Reflex t => Functor (Event t) where
536751 {-# INLINE fmap #-}
537− fmap f = fmapMaybe $ Just . f
752+ fmap f = mapMaybe $ Just . f
538753 {-# INLINE (<$) #-}
539754 x <$ e = fmapCheap (const x) e
540755
756+-- TODO Remove this instance
541757instance Reflex t => FunctorMaybe (Event t) where
542758 {-# INLINE fmapMaybe #-}
543− fmapMaybe f = push $ return . f
759+ fmapMaybe = mapMaybe
760+
761+instance Reflex t => Filterable (Event t) where
762+ {-# INLINE mapMaybe #-}
763+ mapMaybe f = push $ return . f
544764
545765-- | Never: @'zero' = 'never'@.
546766instance Reflex t => Plus (Event t) where
@@ -551,7 +771,13 @@ instance Reflex t => Plus (Event t) where
551771tag :: Reflex t => Behavior t b -> Event t a -> Event t b
552772tag b = pushAlways $ \_ -> sample b
553773
554−-- | Create a new 'Event' that combines occurences of supplied 'Event' with the
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+
780+-- | Create a new 'Event' that combines occurrences of supplied 'Event' with the
555781-- current value of the 'Behavior'.
556782attach :: Reflex t => Behavior t a -> Event t b -> Event t (a, b)
557783attach = attachWith (,)
@@ -561,53 +787,118 @@ attach = attachWith (,)
561787attachWith :: Reflex t => (a -> b -> c) -> Behavior t a -> Event t b -> Event t c
562788attachWith f = attachWithMaybe $ \a b -> Just $ f a b
563789
564−-- | 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
565791-- the 'Behavior'. The occurrence is discarded if the combining function returns
566792-- Nothing
567793attachWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Behavior t a -> Event t b -> Event t c
568794attachWithMaybe f b e = flip push e $ \o -> (`f` o) <$> sample b
569795
570−-- | 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
571797-- supplied 'Event'.
572−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)
573799tailE e = snd <$> headTailE e
574800
575−-- | Create a tuple of two 'Event's with the first one occuring only the first
576−-- time the supplied 'Event' occurs and the second occuring on all but the first
577−-- occurence.
578−headTailE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a, Event t a)
801+-- | Create a tuple of two 'Event's with the first one occurring only the first
802+-- time the supplied 'Event' occurs and the second occurring on all but the first
803+-- occurrence.
804+headTailE :: (Reflex t, MonadHold t m) => Event t a -> m (Event t a, Event t a)
579805headTailE e = do
580806 eHead <- headE e
581807 be <- hold never $ fmap (const e) eHead
582808 return (eHead, switch be)
583809
584−-- | Starting at the current time, fire all the occurrences of the 'Event' for
585−-- which the given predicate returns 'True'. When 'False' is returned, do not
586−-- fire, and permanently stop firing, even if 'True' values are encountered
587−-- later.
588−takeWhileE :: forall t m a. (Reflex t, MonadFix m, MonadHold t m) => (a -> Bool) -> Event t a -> m (Event t a)
589−takeWhileE f e = do
590− rec let (eFalse, eTrue) = fanEither $ ffor e' $ \a -> if f a
591− then Right a
592− else Left never
593− be <- hold e eFalse
594− let e' = switch be
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
595844 return eTrue
596845
597−-- | Split the supplied 'Event' into two individual 'Event's occuring at the
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+
888+-- | Split the supplied 'Event' into two individual 'Event's occurring at the
598889-- same time with the respective values from the tuple.
599890splitE :: Reflex t => Event t (a, b) -> (Event t a, Event t b)
600891splitE e = (fmap fst e, fmap snd e)
601892
602893-- | Print the supplied 'String' and the value of the 'Event' on each
603−-- occurence. This should /only/ be used for debugging.
894+-- occurrence. This should /only/ be used for debugging.
604895--
605896-- Note: As with Debug.Trace.trace, the message will only be printed if the
606897-- 'Event' is actually used.
607898traceEvent :: (Reflex t, Show a) => String -> Event t a -> Event t a
608899traceEvent s = traceEventWith $ \x -> s <> ": " <> show x
609900
610−-- | 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
611902-- 'Event'. This should /only/ be used for debugging.
612903--
613904-- Note: As with Debug.Trace.trace, the message will only be printed if the
@@ -618,11 +909,7 @@ traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
618909instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
619910 (<>) = alignWith (mergeThese (<>))
620911 sconcat = fmap sconcat . mergeList . toList
621−#if MIN_VERSION_semigroups(0,17,0)
622912 stimes n = fmap $ stimes n
623−#else
624− times1p n = fmap $ times1p n
625−#endif
626913
627914instance (Semigroup a, Reflex t) => Monoid (Event t a) where
628915 mempty = never
@@ -651,21 +938,30 @@ leftmost :: Reflex t => [Event t a] -> Event t a
651938leftmost = mergeWith const
652939
653940-- | Create a new 'Event' that occurs if at least one of the 'Event's in the
654−-- 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
655942-- time.
656943mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
657944mergeList [] = never
658945mergeList es = mergeWithFoldCheap' id es
659946
660−unsafeMapIncremental :: (Reflex t, Patch p, Patch p') => (PatchTarget p -> PatchTarget p') -> (p -> p') -> Incremental t p -> Incremental t p'
947+unsafeMapIncremental
948+ :: (Reflex t, Patch p, Patch p')
949+ => (PatchTarget p -> PatchTarget p')
950+ -> (p -> p')
951+ -> Incremental t p
952+ -> Incremental t p'
661953unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
662954
663955-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
664956-- occurs if at least one of them occurs and has a map of values of all 'Event's
665−-- occuring at that time.
957+-- occurring at that time.
666958mergeMap :: (Reflex t, Ord k) => Map k (Event t a) -> Event t (Map k a)
667959mergeMap = fmap dmapToMap . merge . mapWithFunctorToDMap
668960
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+
669965-- | Create a merge whose parents can change over time
670966mergeMapIncremental :: (Reflex t, Ord k) => Incremental t (PatchMap k (Event t a)) -> Event t (Map k a)
671967mergeMapIncremental = fmap dmapToMap . mergeIncremental . unsafeMapIncremental mapWithFunctorToDMap (const2PatchDMapWith id)
@@ -683,7 +979,7 @@ fanEither :: Reflex t => Event t (Either a b) -> (Event t a, Event t b)
683979fanEither e =
684980 let justLeft = either Just (const Nothing)
685981 justRight = either (const Nothing) Just
686− in (fmapMaybe justLeft e, fmapMaybe justRight e)
982+ in (mapMaybe justLeft e, mapMaybe justRight e)
687983
688984-- | Split the event into separate events for 'This' and 'That' values,
689985-- allowing them to fire simultaneously when the input value is 'These'.
@@ -695,7 +991,7 @@ fanThese e =
695991 that (That y) = Just y
696992 that (These _ y) = Just y
697993 that _ = Nothing
698− in (fmapMaybe this e, fmapMaybe that e)
994+ in (mapMaybe this e, mapMaybe that e)
699995
700996-- | Split the event into an 'EventSelector' that allows efficient selection of
701997-- the individual 'Event's.
@@ -704,7 +1000,7 @@ fanMap = fan . fmap mapToDMap
7041000
7051001-- | Switches to the new event whenever it receives one. Only the old event is
7061002-- considered the moment a new one is switched in; the output event will fire at
707−-- that moment if only if the old event does.
1003+-- that moment only if the old event does.
7081004--
7091005-- Because the simultaneous firing case is irrelevant, this function imposes
7101006-- laxer "timing requirements" on the overall circuit, avoiding many potential
@@ -744,17 +1040,85 @@ switchHoldPromptOnly e0 e' = do
7441040 eLag <- switch <$> hold e0 e'
7451041 return $ coincidence $ leftmost [e', eLag <$ eLag]
7461042
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+
7471094instance Reflex t => Align (Event t) where
7481095 nil = never
1096+#if MIN_VERSION_these(0, 8, 0)
1097+instance Reflex t => Semialign (Event t) where
1098+#endif
7491099 align = alignEventWithMaybe Just
7501100
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
1114+
7511115-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
752−-- the 'Behavior' is true at the time of occurence.
1116+-- the 'Behavior' is true at the time of occurrence.
7531117gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
7541118gate = attachWithMaybe $ \allow a -> if allow then Just a else Nothing
7551119
756−-- | Create a new behavior given a starting behavior and switch to a the behvior
757−-- carried by the event when it fires.
1120+-- | Create a new behavior given a starting behavior and switch to the behavior
1121+-- carried by the event when it fires.
7581122switcher :: (Reflex t, MonadHold t m)
7591123 => Behavior t a -> Event t (Behavior t a) -> m (Behavior t a)
7601124switcher b eb = pull . (sample <=< sample) <$> hold b eb
@@ -769,7 +1133,7 @@ zipDyn = zipDynWith (,)
7691133
7701134-- | Combine two 'Dynamic's with a combining function. The result will change
7711135-- whenever either (or both) input 'Dynamic' changes.
772−-- More efficient than liftA2.
1136+-- More efficient than 'liftA2'.
7731137zipDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> Dynamic t c
7741138zipDynWith f da db =
7751139 let eab = align (updated da) (updated db)
@@ -787,11 +1151,7 @@ zipDynWith f da db =
7871151
7881152instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
7891153 (<>) = zipDynWith (<>)
790−#if MIN_VERSION_semigroups(0,17,0)
7911154 stimes n = fmap $ stimes n
792−#else
793− times1p n = fmap $ times1p n
794−#endif
7951155
7961156instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
7971157 mconcat = distributeListOverDynWith mconcat
@@ -800,14 +1160,23 @@ instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
8001160
8011161-- | This function converts a 'DMap' whose elements are 'Dynamic's into a
8021162-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
803−-- through the use of multiple uses of 'zipWithDyn' or 'Applicative' operators.
1163+-- through the use of multiple uses of 'zipDynWith' or 'Applicative' operators.
8041164distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
805−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
8061175 [] -> constDyn DMap.empty
807− [k :=> v] -> fmap (DMap.singleton k . Identity) v
1176+ [k :=> v] -> DMap.singleton k <$> nt v
8081177 _ ->
809− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
810− edmPre = merge $ DMap.map updated dm
1178+ let getInitial = DMap.traverseWithKey (\_ -> sample . current . nt) dm
1179+ edmPre = mergeG getCompose $ DMap.map (Compose . updated . nt) dm
8111180 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
8121181 olds <- sample $ current result
8131182 return $ DMap.unionWithKey (\_ _ new -> new) olds news
@@ -819,21 +1188,73 @@ distributeListOverDyn = distributeListOverDynWith id
8191188
8201189-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
8211190distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
822−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
8231201
8241202-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
8251203-- unless the second supplied 'Event' occurs simultaneously.
8261204difference :: Reflex t => Event t a -> Event t b -> Event t a
8271205difference = alignEventWithMaybe $ \case
8281206 This a -> Just a
829− _ -> Nothing
1207+ _ -> Nothing
8301208
1209+-- | Zips two values by taking the union of their shapes and combining with the provided function.
1210+-- 'Nothing' values are dropped.
8311211alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
832−alignEventWithMaybe f ea eb =
833− fmapMaybe (f <=< dmapToThese)
834− $ merge
835− $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
836−
1212+alignEventWithMaybe f ea eb = mapMaybe (f <=< dmapToThese) $
1213+ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
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)
8371258
8381259--------------------------------------------------------------------------------
8391260-- Accumulator
@@ -863,26 +1284,94 @@ class Reflex t => Accumulator t f | f -> t where
8631284 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
8641285 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
8651286
866−accumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Dynamic t a)
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)
8671295accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
868−accumMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Dynamic t a)
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)
8691305accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
870−accumMaybeDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Dynamic t a)
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)
8711315accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
872−accumMaybeMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Dynamic t a)
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)
8731325accumMaybeMDyn f z e = do
8741326 rec let e' = flip push e $ \o -> do
8751327 v <- sample $ current d'
8761328 f v o
8771329 d' <- holdDyn z e'
8781330 return d'
879−mapAccumDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
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)
8801341mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
881−mapAccumMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
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)
8821351mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
883−mapAccumMaybeDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
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)
8841365mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
885−mapAccumMaybeMDyn :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (Dynamic t a, Event t c)
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)
8861375mapAccumMaybeMDyn f z e = do
8871376 rec let e' = flip push e $ \o -> do
8881377 v <- sample $ current d'
@@ -890,18 +1379,42 @@ mapAccumMaybeMDyn f z e = do
8901379 return $ case result of
8911380 (Nothing, Nothing) -> Nothing
8921381 _ -> Just result
893− d' <- holdDyn z $ fmapMaybe fst e'
894− return (d', fmapMaybe snd e')
1382+ d' <- holdDyn z $ mapMaybe fst e'
1383+ return (d', mapMaybe snd e')
8951384
1385+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1386+-- with the provided function.
8961387{-# INLINE accumB #-}
897−accumB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> a) -> a -> Event t b -> m (Behavior t a)
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)
8981394accumB f = accumMaybeB $ \v o -> Just $ f v o
1395+
1396+-- | Like 'accumB' except that the combining function is a 'PushM' action.
8991397{-# INLINE accumMB #-}
900−accumMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t a) -> a -> Event t b -> m (Behavior t a)
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)
9011404accumMB 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.
9021408{-# INLINE accumMaybeB #-}
903−accumMaybeB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> Maybe a) -> a -> Event t b -> m (Behavior t a)
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)
9041415accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1416+
1417+-- | Like 'accumMaybeB' except that the combining function is a 'PushM' action.
9051418{-# INLINE accumMaybeMB #-}
9061419accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
9071420accumMaybeMB f z e = do
@@ -910,16 +1423,42 @@ accumMaybeMB f z e = do
9101423 f v o
9111424 d' <- hold z e'
9121425 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'.
9131430{-# INLINE mapAccumB #-}
914−mapAccumB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (a, c)) -> a -> Event t b -> m (Behavior t a, Event t c)
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)
9151437mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1438+
1439+-- | Like 'mapAccumB' except that the combining function is a 'PushM' action.
9161440{-# INLINE mapAccumMB #-}
917−mapAccumMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (a, c)) -> a -> Event t b -> m (Behavior t a, Event t c)
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)
9181447mapAccumMB 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.
9191452{-# INLINE mapAccumMaybeB #-}
920−mapAccumMaybeB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> (Maybe a, Maybe c)) -> a -> Event t b -> m (Behavior t a, Event t c)
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)
9211459mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
9221460
1461+-- | Like 'mapAccumMaybeB' except that the combining function is a 'PushM' action.
9231462{-# INLINE mapAccumMaybeMB #-}
9241463mapAccumMaybeMB :: (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)
9251464mapAccumMaybeMB f z e = do
@@ -929,8 +1468,8 @@ mapAccumMaybeMB f z e = do
9291468 return $ case result of
9301469 (Nothing, Nothing) -> Nothing
9311470 _ -> Just result
932− d' <- hold z $ fmapMaybe fst e'
933− return (d', fmapMaybe snd e')
1471+ d' <- hold z $ mapMaybe fst e'
1472+ return (d', mapMaybe snd e')
9341473
9351474-- | Accumulate occurrences of an 'Event', producing an output occurrence each
9361475-- time. Discard the underlying 'Accumulator'.
@@ -977,7 +1516,7 @@ instance Reflex t => Accumulator t (Event t) where
9771516 accumMaybeM f z e = updated <$> accumMaybeM f z e
9781517 mapAccumMaybeM f z e = first updated <$> mapAccumMaybeM f z e
9791518
980−-- | 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
9811520-- list using the supplied function. If the list runs out of items, all
9821521-- subsequent 'Event' occurrences will be ignored.
9831522zipListWithEvent :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> c) -> [a] -> Event t b -> m (Event t c)
@@ -987,17 +1526,17 @@ zipListWithEvent f l e = do
9871526 _ -> (Nothing, Nothing) --TODO: Unsubscribe the event?
9881527 mapAccumMaybe_ f' l e
9891528
990−-- | Assign a number to each occurence of the given 'Event', starting from 0
1529+-- | Assign a number to each occurrence of the given 'Event', starting from 0
9911530{-# INLINE numberOccurrences #-}
9921531numberOccurrences :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Event t (b, a))
9931532numberOccurrences = numberOccurrencesFrom 0
9941533
995−-- | Assign a number to each occurence of the given 'Event'
1534+-- | Assign a number to each occurrence of the given 'Event'
9961535{-# INLINE numberOccurrencesFrom #-}
9971536numberOccurrencesFrom :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t (b, a))
9981537numberOccurrencesFrom = mapAccum_ (\n a -> let !next = n + 1 in (next, (n, a)))
9991538
1000−-- | Assign a number to each occurence of the given 'Event'; discard the occurrences' values
1539+-- | Assign a number to each occurrence of the given 'Event'; discard the occurrences' values
10011540{-# INLINE numberOccurrencesFrom_ #-}
10021541numberOccurrencesFrom_ :: (Reflex t, MonadHold t m, MonadFix m, Num b) => b -> Event t a -> m (Event t b)
10031542numberOccurrencesFrom_ = mapAccum_ (\n _ -> let !next = n + 1 in (next, n))
@@ -1070,83 +1609,74 @@ infixl 4 <@>
10701609(<@) = tag
10711610infixl 4 <@
10721611
1073−------------------
1074−-- Adjustable
1075−------------------
1076−
1077−-- | A 'Monad' that supports adjustment over time. After an action has been
1078−-- run, if the given events fire, it will adjust itself so that its net effect
1079−-- is as though it had originally been run with the new value. Note that there
1080−-- is some issue here with persistent side-effects: obviously, IO (and some
1081−-- other side-effects) cannot be undone, so it is up to the instance implementer
1082−-- to determine what the best meaning for this class is in such cases.
1083−class (Reflex t, Monad m) => Adjustable t m | m -> t where
1084− runWithReplace :: m a -> Event t (m b) -> m (a, Event t b)
1085− traverseIntMapWithKeyWithAdjust :: (IntMap.Key -> v -> m v') -> IntMap v -> Event t (PatchIntMap v) -> m (IntMap v', Event t (PatchIntMap v'))
1086− 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'))
1087− 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'))
1088−
1089−instance Adjustable t m => Adjustable t (ReaderT r m) where
1090− runWithReplace a0 a' = do
1091− r <- ask
1092− lift $ runWithReplace (runReaderT a0 r) $ fmap (`runReaderT` r) a'
1093− traverseIntMapWithKeyWithAdjust f dm0 dm' = do
1094− r <- ask
1095− lift $ traverseIntMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
1096− traverseDMapWithKeyWithAdjust f dm0 dm' = do
1097− r <- ask
1098− lift $ traverseDMapWithKeyWithAdjust (\k v -> runReaderT (f k v) r) dm0 dm'
1099− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
1100− r <- ask
1101− lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
1102−
1103−sequenceDMapWithAdjust :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMap k m) -> m (DMap k Identity, Event t (PatchDMap k Identity))
1104−sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
1105−
1106−sequenceDMapWithAdjustWithMove :: (GCompare k, Adjustable t m) => DMap k m -> Event t (PatchDMapWithMove k m) -> m (DMap k Identity, Event t (PatchDMapWithMove k Identity))
1107−sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
1108−
1109−mapMapWithAdjustWithMove :: forall t m k v v'. (Adjustable 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'))
1110−mapMapWithAdjustWithMove f m0 m' = do
1111− (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
1112− return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
1113−
11141612------------------
11151613-- Cheap Functions
11161614------------------
11171615
1616+-- | A "cheap" version of 'pushAlways'. See the performance note on 'pushCheap'.
11181617{-# INLINE pushAlwaysCheap #-}
11191618pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
11201619pushAlwaysCheap f = pushCheap (fmap Just . f)
11211620
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'
11221627{-# INLINE fmapMaybeCheap #-}
11231628fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1124−fmapMaybeCheap f = pushCheap $ return . f
1629+fmapMaybeCheap = mapMaybeCheap
1630+
11251631
1632+-- | A "cheap" version of 'fforMaybe'. See the performance note on 'pushCheap'.
11261633{-# INLINE fforMaybeCheap #-}
11271634fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1128−fforMaybeCheap = flip fmapMaybeCheap
1635+fforMaybeCheap = flip mapMaybeCheap
11291636
1637+-- | A "cheap" version of 'ffor'. See the performance note on 'pushCheap'.
11301638{-# INLINE fforCheap #-}
11311639fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
11321640fforCheap = flip fmapCheap
11331641
1642+-- | A "cheap" version of 'fmap'. See the performance note on 'pushCheap'.
11341643{-# INLINE fmapCheap #-}
11351644fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
11361645fmapCheap f = pushCheap $ return . Just . f
11371646
1647+-- | A "cheap" version of 'tag'. See the performance note on 'pushCheap'.
11381648{-# INLINE tagCheap #-}
11391649tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
11401650tagCheap b = pushAlwaysCheap $ \_ -> sample b
11411651
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'.
11421670{-# INLINE mergeWithCheap #-}
11431671mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
11441672mergeWithCheap = mergeWithCheap' id
11451673
1674+-- | A "cheap" version of 'mergeWithCheap''. See the performance note on 'pushCheap'.
11461675{-# INLINE mergeWithCheap' #-}
11471676mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
11481677mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
11491678
1679+-- | A "cheap" version of 'mergeWithFoldCheap''. See the performance note on 'pushCheap'.
11501680{-# INLINE mergeWithFoldCheap' #-}
11511681mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
11521682mergeWithFoldCheap' f es =
@@ -1159,34 +1689,11 @@ mergeWithFoldCheap' f es =
11591689-- Deprecated functions
11601690--------------------------------------------------------------------------------
11611691
1162−{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
1163−type MonadAdjust = Adjustable
1164−
1165−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
1166−-- occurs. If both occur at the same time they are combined using 'mappend'.
1167−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
1168−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
1169−appendEvents = alignWith $ mergeThese mappend
1170−
1171−-- | Alias for 'headE'
1172−{-# DEPRECATED onceE "Use 'headE' instead" #-}
1173−onceE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
1174−onceE = headE
1175−
1176−-- | Run both sides of a 'These' monadically, combining the results.
1177−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
1178−#ifdef USE_TEMPLATE_HASKELL
1179−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
1180−#endif
1181−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
1182−sequenceThese t = case t of
1183− This ma -> fmap This ma
1184− These ma mb -> liftM2 These ma mb
1185− That mb -> fmap That mb
1186−
11871692{-# 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'. " #-}
1693+-- | See 'switchHoldPromptly'
11881694switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
11891695switchPromptly = switchHoldPromptly
11901696{-# 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'. " #-}
1697+-- | See 'switchHoldPromptOnly'
11911698switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
11921699switchPromptOnly = switchHoldPromptOnly
src/Reflex/Collection.hs+159−54
@@ -10,12 +10,14 @@
1010#ifdef USE_REFLEX_OPTIMIZER
1111{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1212#endif
13+-- |
14+-- Module:
15+-- Reflex.Collection
1316module Reflex.Collection
1417 (
1518 -- * Widgets on Collections
1619 listHoldWithKey
1720 , listWithKey
18− , listWithKey'
1921 , listWithKeyShallowDiff
2022 , listViewWithKey
2123 , selectViewListWithKey
@@ -25,7 +27,14 @@ module Reflex.Collection
2527 , simpleList
2628 ) where
2729
28−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
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
2938import Data.Align
3039import Data.Functor.Misc
3140import Data.Map (Map)
@@ -34,87 +43,183 @@ import Data.Map.Misc
3443import Data.These
3544
3645import Reflex.Class
46+import Reflex.Adjustable.Class
3747import Reflex.Dynamic
3848import Reflex.PostBuild.Class
3949
40−listHoldWithKey :: forall t m k v a. (Ord k, Adjustable t m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> m a) -> m (Dynamic t (Map k a))
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))
4160listHoldWithKey m0 m' f = do
4261 let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
43− dm' = fmap (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey (\k v -> ComposeMaybe $ fmap (f k) v)) m'
62+ dm' = fmap
63+ (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey
64+ (\k v -> ComposeMaybe $ fmap (f k) v)
65+ )
66+ m'
4467 (a0, a') <- sequenceDMapWithAdjust dm0 dm'
45− fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a' --TODO: Move the dmapToMap to the righthand side so it doesn't get fully redone every time
4668
47−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
48−listWithKey :: forall t k v m a. (Ord k, Adjustable t m, PostBuild t m, MonadFix m, MonadHold t m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m a) -> m (Dynamic t (Map k a))
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))
4981listWithKey vals mkChild = do
5082 postBuild <- getPostBuild
5183 let childValChangedSelector = fanMap $ updated vals
52− -- We keep track of changes to children values in the mkChild function we pass to listHoldWithKey
53− -- The other changes we need to keep track of are child insertions and deletions. diffOnlyKeyChanges
54− -- keeps track of insertions and deletions but ignores value changes, since they're already accounted for.
55− diffOnlyKeyChanges olds news = flip Map.mapMaybe (align olds news) $ \case
56− This _ -> Just Nothing
57− These _ _ -> Nothing
58− That new -> Just $ Just new
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
5996 rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
6097 let changeVals :: Event t (Map k (Maybe v))
61− changeVals = attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
62− [ updated vals
63− , tag (current vals) postBuild --TODO: This should probably be added to the attachWith, not to the updated; if we were using diffMap instead of diffMapNoEq, I think it might not work
64− ]
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+ ]
65108 listHoldWithKey Map.empty changeVals $ \k v ->
66109 mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
67110
68−{-# DEPRECATED listWithKey' "listWithKey' has been renamed to listWithKeyShallowDiff; also, its behavior has changed to fix a bug where children were always rebuilt (never updated)" #-}
69−listWithKey' :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> Event t v -> m a) -> m (Dynamic t (Map k a))
70−listWithKey' = listWithKeyShallowDiff
71−
72−-- | Display the given map of items (in key order) using the builder function provided, and update it with the given event. 'Nothing' update entries will delete the corresponding children, and 'Just' entries will create them if they do not exist or send an update event to them if they do.
73−listWithKeyShallowDiff :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> Event t v -> m a) -> m (Dynamic t (Map k a))
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))
74122listWithKeyShallowDiff initialVals valsChanged mkChild = do
75123 let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
76124 sentVals <- foldDyn applyMap (void initialVals) $ fmap (fmap void) valsChanged
77125 let relevantPatch patch _ = case patch of
78− Nothing -> Just Nothing -- Even if we let a Nothing through when the element doesn't already exist, this doesn't cause a problem because it is ignored
79− Just _ -> Nothing -- We don't want to let spurious re-creations of items through
80− listHoldWithKey initialVals (attachWith (flip (Map.differenceWith relevantPatch)) (current sentVals) valsChanged) $ \k v ->
81− mkChild k v $ select childValChangedSelector $ Const2 k
82−
83−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
84−-- | Create a dynamically-changing set of Event-valued widgets.
85−-- This is like listWithKey, specialized for widgets returning (Event t a). listWithKey would return 'Dynamic t (Map k (Event t a))' in this scenario, but listViewWithKey flattens this to 'Event t (Map k a)' via 'switch'.
86−listViewWithKey :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m (Event t a)) -> m (Event t (Map k a))
87−listViewWithKey vals mkChild = switch . fmap mergeMap <$> listViewWithKey' vals mkChild
88−
89−listViewWithKey' :: (Ord k, Adjustable t m, PostBuild t m, MonadHold t m, MonadFix m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m a) -> m (Behavior t (Map k a))
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))
90162listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
91163
92−-- | Create a dynamically-changing set of widgets, one of which is selected at any time.
93−selectViewListWithKey :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
94− => Dynamic t k -- ^ Current selection key
95− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
96− -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a)) -- ^ Function to create a widget for a given key from Dynamic value and Dynamic Bool indicating if this widget is currently selected
97− -> m (Event t (k, a)) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
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.
98179selectViewListWithKey selection vals mkChild = do
99− let selectionDemux = demux selection -- For good performance, this value must be shared across all children
180+ -- For good performance, this value must be shared across all children
181+ let selectionDemux = demux selection
100182 selectChild <- listWithKey vals $ \k v -> do
101183 let selected = demuxed selectionDemux k
102184 selectSelf <- mkChild k v selected
103185 return $ fmap ((,) k) selectSelf
104186 return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
105187
106−selectViewListWithKey_ :: forall t m k v a. (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
107− => Dynamic t k -- ^ Current selection key
108− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
109− -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a)) -- ^ Function to create a widget for a given key from Dynamic value and Dynamic Bool indicating if this widget is currently selected
110− -> m (Event t k) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
111−selectViewListWithKey_ selection vals mkChild = fmap fst <$> selectViewListWithKey selection vals mkChild
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
112205
113−-- | Create a dynamically-changing set of widgets from a Dynamic key/value map.
114−-- Unlike the 'withKey' variants, the child widgets are insensitive to which key they're associated with.
115−list :: (Ord k, Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m) => Dynamic t (Map k v) -> (Dynamic t v -> m a) -> m (Dynamic t (Map k a))
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))
116214list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
117215
118216-- | Create a dynamically-changing set of widgets from a Dynamic list.
119−simpleList :: (Adjustable t m, MonadHold t m, PostBuild t m, MonadFix m) => Dynamic t [v] -> (Dynamic t v -> m a) -> m (Dynamic t [a])
120−simpleList xs mkChild = fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap (Map.fromList . zip [(1::Int)..]) xs
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+66−207
@@ -17,8 +17,12 @@
1717#ifdef USE_REFLEX_OPTIMIZER
1818{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1919#endif
20−-- | This module contains various functions for working with 'Dynamic' values.
21−-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
20+-- |
21+-- Module:
22+-- Reflex.Dynamic
23+-- Description:
24+-- This module contains various functions for working with 'Dynamic' values.
25+-- 'Dynamic' and its primitives have been moved to the 'Reflex' class.
2226module Reflex.Dynamic
2327 ( -- * Basics
2428 Dynamic -- Abstract so we can preserve the law that the current value is always equal to the most recent update
@@ -49,15 +53,18 @@ module Reflex.Dynamic
4953 , foldDynMaybe
5054 , foldDynMaybeM
5155 , joinDynThroughMap
56+ , joinDynThroughIntMap
5257 , traceDyn
5358 , traceDynWith
5459 , splitDynPure
5560 , distributeMapOverDynPure
61+ , distributeIntMapOverDynPure
5662 , distributeDMapOverDynPure
5763 , distributeListOverDynPure
5864 , Demux
5965 , demux
6066 , demuxed
67+ -- * Miscellaneous
6168 -- Things that probably aren't very useful:
6269 , HList (..)
6370 , FHList (..)
@@ -67,34 +74,14 @@ module Reflex.Dynamic
6774 , AllAreFunctors (..)
6875 , HListPtr (..)
6976 , distributeFHListOverDynPure
70− -- Unsafe
77+ -- * Unsafe
7178 , unsafeDynamic
72− -- * Deprecated functions
73− , apDyn
74− , attachDyn
75− , attachDynWith
76− , attachDynWithMaybe
77− , collectDyn
78− , combineDyn
79− , distributeDMapOverDyn
80− , distributeFHListOverDyn
81− , forDyn
82− , getDemuxed
83− , joinDyn
84− , mapDyn
85− , mconcatDyn
86− , nubDyn
87− , splitDyn
88− , tagDyn
89− , uniqDyn
90− , uniqDynBy
9179 ) where
9280
9381import Data.Functor.Compose
9482import Data.Functor.Misc
9583import Reflex.Class
9684
97−import Control.Applicative ((<*>))
9885import Control.Monad
9986import Control.Monad.Fix
10087import Control.Monad.Identity
@@ -102,11 +89,14 @@ import Data.Align
10289import Data.Dependent.Map (DMap)
10390import qualified Data.Dependent.Map as DMap
10491import Data.Dependent.Sum (DSum (..))
105−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
10695import Data.Map (Map)
10796import Data.Maybe
108−import Data.Monoid
97+import Data.Monoid ((<>))
10998import Data.These
99+import Data.Type.Equality ((:~:) (..))
110100
111101import Debug.Trace
112102
@@ -129,7 +119,7 @@ holdUniqDyn = holdUniqDynBy (==)
129119holdUniqDynBy :: (Reflex t, MonadHold t m, MonadFix m) => (a -> a -> Bool) -> Dynamic t a -> m (Dynamic t a)
130120holdUniqDynBy eq = scanDynMaybe id (\new old -> if new `eq` old then Nothing else Just new)
131121
132−-- | Dynamic Maybe that can only update from Nothing to Just or Just to Just (i.e., cannot revert to Nothing)
122+-- | @/Dynamic Maybe/@ that can only update from @/Nothing/@ to @/Just/@ or @/Just/@ to @/Just/@ (i.e., cannot revert to @/Nothing/@)
133123improvingMaybe :: (Reflex t, MonadHold t m, MonadFix m) => Dynamic t (Maybe a) -> m (Dynamic t (Maybe a))
134124improvingMaybe = scanDynMaybe id (\new _ -> if isJust new then Just new else Nothing)
135125
@@ -173,7 +163,7 @@ foldDynMaybe = accumMaybeDyn . flip
173163foldDynMaybeM :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe b)) -> b -> Event t a -> m (Dynamic t b)
174164foldDynMaybeM = accumMaybeMDyn . flip
175165
176−-- | Create a new 'Dynamic' that counts the occurences of the 'Event'.
166+-- | Create a new 'Dynamic' that counts the occurrences of the 'Event'.
177167count :: (Reflex t, MonadHold t m, MonadFix m, Num b) => Event t a -> m (Dynamic t b)
178168count e = holdDyn 0 =<< zipListWithEvent const (iterate (+1) 1) e
179169
@@ -194,9 +184,9 @@ switchDyn :: forall t a. Reflex t => Dynamic t (Event t a) -> Event t a
194184switchDyn d = switch (current d)
195185
196186-- | Switches to the new 'Event' whenever it receives one. Switching occurs
197−-- *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
198188-- old and new inner Events fire simultaneously, the output will fire with the
199−-- value of the *new* 'Event'.
189+-- value of the __new__ 'Event'.
200190--
201191-- Prefer 'switchDyn' to this where possible. The timing requirements that
202192-- switching before imposes are likely to bring down your app unless you are
@@ -216,28 +206,30 @@ splitDynPure d = (fmap fst d, fmap snd d)
216206distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
217207distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
218208
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+
219214-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
220215-- non-'Dynamic' elements, preserving the order of the elements.
216+{-# DEPRECATED distributeListOverDynPure "Use 'distributeListOverDyn' instead" #-}
221217distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
222−distributeListOverDynPure =
223− fmap (map fromDSum . DMap.toAscList) .
224− distributeDMapOverDynPure .
225− DMap.fromDistinctAscList .
226− zipWith toDSum [0..]
227− where
228− toDSum :: Int -> Dynamic t a -> DSum (Const2 Int a) (Dynamic t)
229− toDSum k v = Const2 k :=> v
230− fromDSum :: DSum (Const2 Int a) Identity -> a
231− fromDSum (Const2 _ :=> Identity v) = v
218+distributeListOverDynPure = distributeListOverDyn
232219
233220--TODO: Generalize this to functors other than Maps
234221-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
235222-- with the current values of the 'Dynamic's in a map.
236223joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
237−joinDynThroughMap = joinDyn . fmap distributeMapOverDynPure
224+joinDynThroughMap = (distributeMapOverDynPure =<<)
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 =<<)
238230
239231-- | Print the value of the 'Dynamic' when it is first read and on each
240−-- subsequent change that is observed (as traceEvent), prefixed with the
232+-- subsequent change that is observed (as 'traceEvent'), prefixed with the
241233-- provided string. This should /only/ be used for debugging.
242234--
243235-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -247,7 +239,7 @@ traceDyn s = traceDynWith $ \x -> s <> ": " <> show x
247239
248240-- | Print the result of applying the provided function to the value
249241-- of the 'Dynamic' when it is first read and on each subsequent change
250−-- that is observed (as traceEvent). This should /only/ be used for
242+-- that is observed (as 'traceEvent'). This should /only/ be used for
251243-- debugging.
252244--
253245-- Note: Just like Debug.Trace.trace, the value will only be shown if something
@@ -263,36 +255,35 @@ traceDynWith f d =
263255-- | Replace the value of the 'Event' with the current value of the 'Dynamic'
264256-- each time the 'Event' occurs.
265257--
266−-- Note: `tagPromptlyDyn d e` differs from `tag (current d) e` in the case that `e` is firing
267−-- at the same time that `d` is changing. With `tagPromptlyDyn d e`, the *new* value of `d`
268−-- will replace the value of `e`, whereas with `tag (current d) e`, the *old* value
258+-- Note: @/tagPromptlyDyn d e/@ differs from @/tag (current d) e/@ in the case that @/e/@ is firing
259+-- at the same time that @/d/@ is changing. With @/tagPromptlyDyn d e/@, the __new__ value of @/d/@
260+-- will replace the value of @/e/@, whereas with @/tag (current d) e/@, the __old__ value
269261-- will be used, since the 'Behavior' won't be updated until the end of the frame.
270262-- Additionally, this means that the output 'Event' may not be used to directly change
271−-- the input 'Dynamic', because that would mean its value depends on itself. When creating
272−-- cyclic data flows, generally `tag (current d) e` is preferred.
263+-- the input 'Dynamic', because that would mean its value depends on itself. __When creating__
264+-- __cyclic data flows, generally @/tag (current d) e/@ is preferred.__
273265tagPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
274266tagPromptlyDyn = attachPromptlyDynWith const
275267
276268-- | Attach the current value of the 'Dynamic' to the value of the
277269-- 'Event' each time it occurs.
278270--
279−-- 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.
280272attachPromptlyDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
281273attachPromptlyDyn = attachPromptlyDynWith (,)
282274
283275-- | Combine the current value of the 'Dynamic' with the value of the
284276-- 'Event' each time it occurs.
285277--
286−-- 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.
287279attachPromptlyDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
288280attachPromptlyDynWith f = attachPromptlyDynWithMaybe $ \a b -> Just $ f a b
289281
290−-- | 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
291283-- current value of the 'Dynamic' value and possibly filtering if the combining
292284-- function returns 'Nothing'.
293285--
294−-- Note: `attachPromptlyDynWithMaybe f d` is not the same as `attachWithMaybe f
295−-- (current d)`. See 'tagPromptlyDyn' for details.
286+-- Note: @/attachPromptlyDynWithMaybe f d/@ is not the same as @/attachWithMaybe f (current d)/@. See 'tagPromptlyDyn' for details.
296287attachPromptlyDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
297288attachPromptlyDynWithMaybe f d e =
298289 let e' = attach (current d) e
@@ -301,8 +292,8 @@ attachPromptlyDynWithMaybe f d e =
301292 These (_, b) a -> f a b -- Both events are firing, so use the newer value
302293 That _ -> Nothing -- The tagging event isn't firing, so don't fire
303294
304−-- | Factor a @Dynamic t (Maybe a)@ into a @Dynamic t (Maybe (Dynamic t a))@,
305−-- such that the outer 'Dynamic' is updated only when the 'Maybe''s constructor
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
306297-- chages from 'Nothing' to 'Just' or vice-versa. Whenever the constructor
307298-- becomes 'Just', an inner 'Dynamic' will be provided, whose value will track
308299-- the 'a' inside the 'Just'; when the constructor becomes 'Nothing', the
@@ -317,6 +308,8 @@ maybeDyn = fmap (fmap unpack) . eitherDyn . fmap pack
317308 Left _ -> Nothing
318309 Right a -> Just a
319310
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').
320313eitherDyn :: 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)))
321314eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
322315 where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
@@ -324,26 +317,23 @@ eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
324317 LeftTag :=> Compose a -> Left $ coerceDynamic a
325318 RightTag :=> Compose b -> Right $ coerceDynamic b
326319
327−factorDyn :: forall t m k v. (Reflex t, MonadFix m, MonadHold t m, GEq k) => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
328−factorDyn d = do
329− let inner :: forall m' a. (MonadFix m', MonadHold t m') => k a -> v a -> m' (Dynamic t (v a))
330− inner k v0 = holdDyn v0 . fmapMaybe id =<< takeWhileE isJust newVal
331− where newVal = ffor (updated d) $ \(newK :=> newV) -> case newK `geq` k of
332− Just Refl -> Just newV
333− Nothing -> Nothing
334− getInitial = do
335− k0 :=> (v0 :: v a) <- sample $ current d
336− i0 <- inner k0 v0
337− return $ k0 :=> Compose i0
338− update = flip push (updated d) $ \(newKey :=> newVal) -> do
339− (oldKey :=> _) <- sample $ current d
340− case newKey `geq` oldKey of
341− Just Refl -> return Nothing
342− Nothing -> do
343− newInner <- inner newKey newVal
344− return $ Just $ newKey :=> Compose newInner
345− o0 <- getInitial --TODO: Figure out how to get this to run inside something like the first argument to buildDynamic
346− holdDyn o0 update
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
347337
348338--------------------------------------------------------------------------------
349339-- Demux
@@ -358,7 +348,7 @@ factorDyn d = do
358348--
359349-- > demuxed (demux d) k === fmap (== k) d
360350--
361−-- However, the when getDemuxed is used multiple times, the complexity is only
351+-- However, when 'demuxed' is used multiple times, the complexity is only
362352-- /O(log(n))/, rather than /O(n)/ for fmap.
363353data Demux t k = Demux { demuxValue :: Behavior t k
364354 , demuxSelector :: EventSelector t (Const2 k Bool)
@@ -512,7 +502,7 @@ instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
512502
513503-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
514504-- single 'Dynamic' whose value represents all the current values of the input's
515−-- consitutent 'Dynamic's.
505+-- constituent 'Dynamic's.
516506collectDynPure :: ( RebuildSortedHList (HListElems b)
517507 , IsHList a, IsHList b
518508 , AllAreFunctors (Dynamic t) (HListElems b)
@@ -553,134 +543,3 @@ instance IsHList (a, b, c, d, e, f) where
553543#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
554544 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
555545#endif
556−
557−--------------------------------------------------------------------------------
558−-- Deprecated functions
559−--------------------------------------------------------------------------------
560−
561−-- | Map a function over a 'Dynamic'.
562−{-# DEPRECATED mapDyn "Use 'return . fmap f' instead of 'mapDyn f'; consider eliminating monadic style" #-}
563−mapDyn :: (Reflex t, Monad m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
564−mapDyn f = return . fmap f
565−
566−-- | Flipped version of 'mapDyn'.
567−{-# DEPRECATED forDyn "Use 'return . ffor a' instead of 'forDyn a'; consider eliminating monadic style" #-}
568−forDyn :: (Reflex t, Monad m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
569−forDyn a = return . ffor a
570−
571−-- | Split the 'Dynamic' into two 'Dynamic's, each taking the respective value
572−-- of the tuple.
573−{-# DEPRECATED splitDyn "Use 'return . splitDynPure' instead; consider eliminating monadic style" #-}
574−splitDyn :: (Reflex t, Monad m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
575−splitDyn = return . splitDynPure
576−
577−-- | Merge the 'Dynamic' values using their 'Monoid' instance.
578−{-# DEPRECATED mconcatDyn "Use 'return . mconcat' instead; consider eliminating monadic style" #-}
579−mconcatDyn :: forall t m a. (Reflex t, Monad m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
580−mconcatDyn = return . mconcat
581−
582−-- | This function no longer needs to be monadic; see 'distributeMapOverDynPure'.
583−{-# DEPRECATED distributeDMapOverDyn "Use 'return . distributeDMapOverDynPure' instead; consider eliminating monadic style" #-}
584−distributeDMapOverDyn :: (Reflex t, Monad m, GCompare k) => DMap k (Dynamic t) -> m (Dynamic t (DMap k Identity))
585−distributeDMapOverDyn = return . distributeDMapOverDynPure
586−
587−-- | Merge two 'Dynamic's into a new one using the provided function. The new
588−-- 'Dynamic' changes its value each time one of the original 'Dynamic's changes
589−-- its value.
590−{-# DEPRECATED combineDyn "Use 'return (zipDynWith f a b)' instead of 'combineDyn f a b'; consider eliminating monadic style" #-}
591−combineDyn :: forall t m a b c. (Reflex t, Monad m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
592−combineDyn f a b = return $ zipDynWith f a b
593−
594−-- | A psuedo applicative version of ap for 'Dynamic'. Example useage:
595−--
596−-- > do
597−-- > person <- Person `mapDyn` dynFirstName
598−-- > `apDyn` dynListName
599−-- > `apDyn` dynAge
600−-- > `apDyn` dynAddress
601−{-# 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" #-}
602−#ifdef USE_TEMPLATE_HASKELL
603−{-# ANN apDyn "HLint: ignore Use fmap" #-}
604−#endif
605−apDyn :: forall t m a b. (Reflex t, Monad m)
606− => m (Dynamic t (a -> b))
607− -> Dynamic t a
608− -> m (Dynamic t b)
609−apDyn m a = fmap (<*> a) m
610−
611−--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
612−-- | This function no longer needs to be monadic, so it has been replaced by
613−-- 'demuxed', which is pure.
614−{-# DEPRECATED getDemuxed "Use 'return . demuxed d' instead of 'getDemuxed d'; consider eliminating monadic style" #-}
615−getDemuxed :: (Reflex t, Monad m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
616−getDemuxed d = return . demuxed d
617−
618−-- | This function no longer needs to be monadic, so it has been replaced by
619−-- 'distributeFHListOverDynPure', which is pure.
620−{-# DEPRECATED distributeFHListOverDyn "Use 'return . distributeFHListOverDynPure' instead; consider eliminating monadic style" #-}
621−distributeFHListOverDyn :: forall t m l. (Reflex t, Monad m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
622−distributeFHListOverDyn = return . distributeFHListOverDynPure
623−
624−-- | This function no longer needs to be monadic, so it has been replaced by
625−-- 'collectDynPure', which is pure.
626−{-# DEPRECATED collectDyn "Use 'return . collectDynPure' instead; consider eliminating monadic style" #-}
627−collectDyn :: ( RebuildSortedHList (HListElems b)
628− , IsHList a, IsHList b
629− , AllAreFunctors (Dynamic t) (HListElems b)
630− , Reflex t, Monad m
631− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
632− ) => a -> m (Dynamic t b)
633−collectDyn = return . collectDynPure
634−
635−-- | This function has been renamed to 'tagPromptlyDyn' to clarify its
636−-- semantics.
637−{-# DEPRECATED tagDyn "Use 'tagPromptlyDyn' instead" #-}
638−tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
639−tagDyn = tagPromptlyDyn
640−
641−-- | This function has been renamed to 'attachPromptlyDyn' to clarify its
642−-- semantics.
643−{-# DEPRECATED attachDyn "Use 'attachPromptlyDyn' instead" #-}
644−attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
645−attachDyn = attachPromptlyDyn
646−
647−-- | This function has been renamed to 'attachPromptlyDynWith' to clarify its
648−-- semantics.
649−{-# DEPRECATED attachDynWith "Use 'attachPromptlyDynWith' instead" #-}
650−attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
651−attachDynWith = attachPromptlyDynWith
652−
653−-- | This function has been renamed to 'attachPromptlyDynWithMaybe' to clarify
654−-- its semantics.
655−{-# DEPRECATED attachDynWithMaybe "Use 'attachPromptlyDynWithMaybe' instead" #-}
656−attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
657−attachDynWithMaybe = attachPromptlyDynWithMaybe
658−
659−-- | Combine an inner and outer 'Dynamic' such that the resulting 'Dynamic''s
660−-- current value will always be equal to the current value's current value, and
661−-- will change whenever either the inner or the outer (or both) values change.
662−{-# DEPRECATED joinDyn "Use 'join' instead" #-}
663−joinDyn :: Reflex t => Dynamic t (Dynamic t a) -> Dynamic t a
664−joinDyn = join
665−
666−-- | WARNING: This function is only pure if @a@'s 'Eq' instance tests
667−-- representational equality. Use 'holdUniqDyn' instead, which is pure in all
668−-- circumstances. Also, note that, unlike 'nub', this function does not prevent
669−-- all recurrences of a value, only consecutive recurrences.
670−{-# DEPRECATED nubDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
671−nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
672−nubDyn = uniqDyn
673−
674−-- | WARNING: This function is only pure if @a@'s 'Eq' instance tests
675−-- representational equality. Use 'holdUniqDyn' instead, which is pure in all
676−-- circumstances.
677−{-# DEPRECATED uniqDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
678−uniqDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
679−uniqDyn = uniqDynBy (==)
680−
681−-- | WARNING: This function is impure. Use 'holdUniqDynBy' instead.
682−{-# DEPRECATED uniqDynBy "Use 'holdUniqDynBy' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
683−uniqDynBy :: Reflex t => (a -> a -> Bool) -> Dynamic t a -> Dynamic t a
684−uniqDynBy eq d =
685− let e' = attachWithMaybe (\x x' -> if x' `eq` x then Nothing else Just x') (current d) (updated d)
686− in unsafeDynamic (current d) e'
src/Reflex/Dynamic/TH.hs+4−28
@@ -13,9 +13,6 @@ module Reflex.Dynamic.TH
1313 ( qDynPure
1414 , unqDyn
1515 , mkDynPure
16− -- * Deprecated functions
17− , qDyn
18− , mkDyn
1916 ) where
2017
2118import Reflex.Dynamic
@@ -23,7 +20,7 @@ import Reflex.Dynamic
2320import Control.Monad.State
2421import Data.Data
2522import Data.Generics
26−import Data.Monoid
23+import Data.Monoid ((<>))
2724import qualified Language.Haskell.Exts as Hs
2825import qualified Language.Haskell.Meta.Syntax.Translate as Hs
2926import Language.Haskell.TH
@@ -47,8 +44,8 @@ qDynPure qe = do
4744 _ -> gmapM f d
4845 (e', exprsReversed) <- runStateT (gmapM f e) []
4946 let exprs = reverse exprsReversed
50− arg = foldr (\a b -> ConE 'FHCons `AppE` a `AppE` b) (ConE 'FHNil) $ map snd exprs
51− param = foldr (\a b -> ConP 'HCons [VarP a, b]) (ConP 'HNil []) $ map fst exprs
47+ arg = foldr (\a b -> ConE 'FHCons `AppE` snd a `AppE` b) (ConE 'FHNil) exprs
48+ param = foldr (\a b -> ConP 'HCons [VarP (fst a), b]) (ConP 'HNil []) exprs
5249 [| $(return $ LamE [param] e') <$> distributeFHListOverDynPure $(return arg) |]
5350
5451-- | Antiquote a 'Dynamic' expression. This can /only/ be used inside of a
@@ -84,7 +81,7 @@ mkDynPure = QuasiQuoter
8481 }
8582
8683mkDynExp :: 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
8885 Hs.ParseFailed (Hs.SrcLoc _ l c) err -> fail $ "mkDyn:" <> show l <> ":" <> show c <> ": " <> err
8986 Hs.ParseOk e -> qDynPure $ return $ everywhere (id `extT` reinstateUnqDyn) $ Hs.toExp $ everywhere (id `extT` antiE) e
9087 where TH.Name (TH.OccName occName) (TH.NameG _ _ (TH.ModName modName)) = 'unqMarker
@@ -107,24 +104,3 @@ mkDynExp s = case Hs.parseExpWithMode (Hs.defaultParseMode { Hs.extensions = [ H
107104 reinstateUnqDyn (TH.Name (TH.OccName occName') (TH.NameQ (TH.ModName modName')))
108105 | modName == modName' && occName == occName' = 'unqMarker
109106 reinstateUnqDyn x = x
110−
111−--------------------------------------------------------------------------------
112−-- Deprecated
113−--------------------------------------------------------------------------------
114−
115−{-# DEPRECATED qDyn "Instead of $(qDyn x), use return $(qDynPure x)" #-}
116−-- | Like 'qDynPure', but wraps its result monadically using 'return'. This is
117−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
118−qDyn :: Q Exp -> Q Exp
119−qDyn qe = [| return $(qDynPure qe) |]
120−
121−{-# DEPRECATED mkDyn "Instead of [mkDyn| x |], use return [mkDynPure| x |]" #-}
122−-- | Like 'mkDynPure', but wraps its result monadically using 'return'. This is
123−-- no longer necessary, due to 'Dynamic' being an instance of 'Functor'.
124−mkDyn :: QuasiQuoter
125−mkDyn = QuasiQuoter
126− { quoteExp = \s -> [| return $(mkDynExp s) |]
127− , quotePat = error "mkDyn: pattern splices are not supported"
128− , quoteType = error "mkDyn: type splices are not supported"
129− , quoteDec = error "mkDyn: declaration splices are not supported"
130− }
src/Reflex/DynamicWriter/Base.hs+42−9
@@ -6,8 +6,10 @@
66{-# LANGUAGE MultiParamTypeClasses #-}
77{-# LANGUAGE RankNTypes #-}
88{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TupleSections #-}
910{-# LANGUAGE TypeFamilies #-}
1011{-# LANGUAGE UndecidableInstances #-}
12+{-# LANGUAGE StandaloneDeriving #-}
1113#ifdef USE_REFLEX_OPTIMIZER
1214{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1315#endif
@@ -20,6 +22,8 @@ module Reflex.DynamicWriter.Base
2022import Control.Monad.Exception
2123import Control.Monad.Identity
2224import Control.Monad.IO.Class
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
2327import Control.Monad.Reader
2428import Control.Monad.Ref
2529import Control.Monad.State.Strict
@@ -32,21 +36,22 @@ import Data.IntMap (IntMap)
3236import qualified Data.IntMap as IntMap
3337import Data.Map (Map)
3438import qualified Data.Map as Map
35−import Data.Semigroup
39+import Data.Semigroup (Semigroup(..))
3640import Data.Some (Some)
3741import Data.These
42+
43+import Reflex.Adjustable.Class
3844import Reflex.Class
3945import Reflex.DynamicWriter.Class
46+import Reflex.EventWriter.Class (EventWriter, tellEvent)
4047import Reflex.Host.Class
41−import qualified Reflex.Patch.MapWithMove as MapWithMove
48+import qualified Data.Patch.MapWithMove as MapWithMove
4249import Reflex.PerformEvent.Class
4350import Reflex.PostBuild.Class
51+import Reflex.Query.Class
4452import Reflex.Requester.Class
4553import Reflex.TriggerEvent.Class
4654
47−instance MonadTrans (DynamicWriterT t w) where
48− lift = DynamicWriterT . lift
49−
5055mapIncrementalMapValues :: (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')
5156mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
5257
@@ -78,11 +83,27 @@ mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current)
7883 Just v -> do
7984 modify (k:)
8085 return $ MapWithMove.From_Insert v
81− noLongerMovedMap = Map.fromList $ fmap (\k -> (k, ())) noLongerMoved
86+ noLongerMovedMap = Map.fromList $ fmap (, ()) noLongerMoved
8287 in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
8388
84−-- | A basic implementation of 'MonadDynamicWriter'.
85−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
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+
86107
87108instance MonadRef m => MonadRef (DynamicWriterT t w m) where
88109 type Ref (DynamicWriterT t w m) = Ref m
@@ -104,7 +125,7 @@ runDynamicWriterT (DynamicWriterT a) = do
104125 (result, ws) <- runStateT a []
105126 return (result, mconcat $ reverse ws)
106127
107−instance (Monad m, Monoid w, Reflex t) => MonadDynamicWriter t w (DynamicWriterT t w m) where
128+instance (Monad m, Monoid w, Reflex t) => DynamicWriter t w (DynamicWriterT t w m) where
108129 tellDyn w = DynamicWriterT $ modify (w :)
109130
110131instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
@@ -129,6 +150,10 @@ instance MonadState s m => MonadState s (DynamicWriterT t w m) where
129150 get = lift get
130151 put = lift . put
131152
153+instance PrimMonad m => PrimMonad (DynamicWriterT t w m) where
154+ type PrimState (DynamicWriterT t w m) = PrimState m
155+ primitive = lift . primitive
156+
132157newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
133158
134159-- | When the execution of a 'DynamicWriterT' action is adjusted using
@@ -211,3 +236,11 @@ instance Requester t m => Requester t (DynamicWriterT t w m) where
211236 type Response (DynamicWriterT t w m) = Response m
212237 requesting = lift . requesting
213238 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.hs+10−6
@@ -1,24 +1,28 @@
1−-- | This module defines the 'MonadDynamicWriter' class.
1+-- | This module defines the 'DynamicWriter' class.
2+{-# LANGUAGE ConstraintKinds #-}
23{-# LANGUAGE CPP #-}
34{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
66{-# LANGUAGE UndecidableInstances #-}
77#ifdef USE_REFLEX_OPTIMIZER
88{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
99#endif
1010module Reflex.DynamicWriter.Class
11− ( MonadDynamicWriter (..)
11+ ( MonadDynamicWriter
12+ , DynamicWriter(..)
1213 ) where
1314
1415import Control.Monad.Reader (ReaderT, lift)
1516import Reflex.Class (Dynamic)
1617
18+{-# DEPRECATED MonadDynamicWriter "Use 'DynamicWriter' instead" #-}
19+-- | Type synonym for 'DynamicWriter'
20+type MonadDynamicWriter = DynamicWriter
21+
1722-- | 'MonadDynamicWriter' efficiently collects 'Dynamic' values using 'tellDyn'
1823-- and combines them monoidally to provide a 'Dynamic' result.
19−class (Monad m, Monoid w) => MonadDynamicWriter t w m | m -> t w where
24+class (Monad m, Monoid w) => DynamicWriter t w m | m -> t w where
2025 tellDyn :: Dynamic t w -> m ()
2126
22−instance MonadDynamicWriter t w m => MonadDynamicWriter t w (ReaderT r m) where
27+instance DynamicWriter t w m => DynamicWriter t w (ReaderT r m) where
2328 tellDyn = lift . tellDyn
24−
src/Reflex/EventWriter/Base.hs+99−63
@@ -18,11 +18,14 @@ module Reflex.EventWriter.Base
1818 , runEventWriterT
1919 , runWithReplaceEventWriterTWith
2020 , sequenceDMapWithAdjustEventWriterTWith
21+ , mapEventWriterT
2122 , withEventWriterT
2223 ) where
2324
25+import Reflex.Adjustable.Class
2426import Reflex.Class
2527import Reflex.EventWriter.Class (EventWriter, tellEvent)
28+import Reflex.DynamicWriter.Class (DynamicWriter, tellDyn)
2629import Reflex.Host.Class
2730import Reflex.PerformEvent.Class
2831import Reflex.PostBuild.Class
@@ -32,12 +35,14 @@ import Reflex.TriggerEvent.Class
3235
3336import Control.Monad.Exception
3437import Control.Monad.Identity
38+import Control.Monad.Morph
39+import Control.Monad.Primitive
3540import Control.Monad.Reader
3641import Control.Monad.Ref
3742import Control.Monad.State.Strict
38−import Data.Dependent.Map (DMap, DSum (..))
43+import Data.Dependent.Map (DMap)
3944import qualified Data.Dependent.Map as DMap
40−import Data.Foldable
45+import Data.Dependent.Sum (DSum (..))
4146import Data.Functor.Compose
4247import Data.Functor.Misc
4348import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
@@ -45,6 +50,7 @@ import Data.IntMap.Strict (IntMap)
4550import qualified Data.IntMap.Strict as IntMap
4651import Data.List.NonEmpty (NonEmpty (..))
4752import Data.Map (Map)
53+import qualified Data.Map as Map
4854import Data.Semigroup
4955import Data.Some (Some)
5056import Data.Tuple
@@ -54,7 +60,7 @@ import Unsafe.Coerce
5460
5561{-# DEPRECATED TellId "Do not construct this directly; use tellId instead" #-}
5662newtype TellId w x
57− = TellId Int -- ^ WARNING: Do not construct this directly; use 'TellId' instead
63+ = TellId Int -- ^ WARNING: Do not construct this directly; use 'tellId' instead
5864 deriving (Show, Eq, Ord, Enum)
5965
6066tellId :: Int -> TellId w w
@@ -92,7 +98,17 @@ data EventWriterState t w = EventWriterState
9298
9399-- | A basic implementation of 'EventWriter'.
94100newtype EventWriterT t w m a = EventWriterT { unEventWriterT :: StateT (EventWriterState t w) m a }
95− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException, MonadAsyncException)
101+ deriving
102+ ( Functor
103+ , Applicative
104+ , Monad
105+ , MonadTrans
106+ , MFunctor
107+ , MonadFix
108+ , MonadIO
109+ , MonadException
110+ , MonadAsyncException
111+ )
96112
97113-- | Run a 'EventWriterT' action.
98114runEventWriterT :: forall t m w a. (Reflex t, Monad m, Semigroup w) => EventWriterT t w m a -> m (a, Event t w)
@@ -112,9 +128,6 @@ instance (Reflex t, Monad m, Semigroup w) => EventWriter t w (EventWriterT t w m
112128 , _eventWriterState_told = (tellId myId :=> w) : _eventWriterState_told old
113129 }
114130
115−instance MonadTrans (EventWriterT t w) where
116− lift = EventWriterT . lift
117−
118131instance MonadSample t m => MonadSample t (EventWriterT t w m) where
119132 sample = lift . sample
120133
@@ -129,12 +142,14 @@ instance MonadHold t m => MonadHold t (EventWriterT t w m) where
129142 buildDynamic a0 = lift . buildDynamic a0
130143 {-# INLINABLE headE #-}
131144 headE = lift . headE
145+ {-# INLINABLE now #-}
146+ now = lift now
132147
133148instance (Reflex t, Adjustable t m, MonadHold t m, Semigroup w) => Adjustable t (EventWriterT t w m) where
134149 runWithReplace = runWithReplaceEventWriterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
135− traverseIntMapWithKeyWithAdjust = sequenceIntMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseIntMapWithKeyWithAdjust f dm0 dm') patchIntMapNewElements mergeIntIncremental
136− traverseDMapWithKeyWithAdjust = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElements mergeMapIncremental
137− traverseDMapWithKeyWithAdjustWithMove = sequenceDMapWithAdjustEventWriterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElements mergeMapIncrementalWithMove
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
138153
139154instance Requester t m => Requester t (EventWriterT t w m) where
140155 type Request (EventWriterT t w m) = Request m
@@ -153,26 +168,33 @@ runWithReplaceEventWriterTWith :: forall m t w a b. (Reflex t, MonadHold t m, Se
153168 -> EventWriterT t w m (a, Event t b)
154169runWithReplaceEventWriterTWith f a0 a' = do
155170 (result0, result') <- f (runEventWriterT a0) $ fmapCheap runEventWriterT a'
156− request <- holdDyn (snd result0) $ fmapCheap snd result'
157− -- 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.)
158− tellEvent $ coincidence $ updated request
159− tellEvent $ switch $ current request
171+ tellEvent =<< switchHoldPromptOnly (snd result0) (fmapCheap snd result')
160172 return (fst result0, fmapCheap fst result')
161173
162174-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceIntMapWithAdjust'.
163−sequenceIntMapWithAdjustEventWriterTWith :: forall t m p w v v'. (Reflex t, MonadHold t m, Semigroup w, Semigroup w, Functor p, Patch (p (Event t w)), PatchTarget (p (Event t w)) ~ IntMap (Event t w))
164− => ( (IntMap.Key -> v -> m (Event t w, v'))
165− -> IntMap v
166− -> Event t (p v)
167− -> EventWriterT t w m (IntMap (Event t w, v'), Event t (p (Event t w, v')))
168− )
169− -> (p (Event t w) -> [Event t w])
170− -> (Incremental t (p (Event t w)) -> Event t (IntMap w))
171− -> (IntMap.Key -> v -> EventWriterT t w m v')
172− -> IntMap v
173− -> Event t (p v)
174− -> EventWriterT t w m (IntMap v', Event t (p v'))
175−sequenceIntMapWithAdjustEventWriterTWith base patchNewElements mergePatchIncremental f dm0 dm' = do
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
176198 let f' :: IntMap.Key -> v -> m (Event t w, v')
177199 f' k v = swap <$> runEventWriterT (f k v)
178200 (children0, children') <- base f' dm0 dm'
@@ -182,26 +204,39 @@ sequenceIntMapWithAdjustEventWriterTWith base patchNewElements mergePatchIncreme
182204 requests0 = fmap fst children0
183205 requests' :: Event t (p (Event t w))
184206 requests' = fmapCheap (fmap fst) children'
185− childRequestMap :: Incremental t (p (Event t w)) <- holdIncremental requests0 requests'
186− tellEventsPromptly requests' patchNewElements $ mergePatchIncremental childRequestMap
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
187212 return (result0, result')
188213
189214-- | Like 'runWithReplaceEventWriterTWith', but for 'sequenceDMapWithAdjust'.
190−sequenceDMapWithAdjustEventWriterTWith :: forall t m p p' w k v v'. (Reflex t, MonadHold t m, Semigroup w, Patch (p' (Some k) (Event t w)), PatchTarget (p' (Some k) (Event t w)) ~ Map (Some k) (Event t w))
191− => ( (forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a))
192− -> DMap k v
193− -> Event t (p k v)
194− -> EventWriterT t w m (DMap k (Compose ((,) (Event t w)) v'), Event t (p k (Compose ((,) (Event t w)) v')))
195− )
196− -> ((forall a. Compose ((,) (Event t w)) v' a -> v' a) -> p k (Compose ((,) (Event t w)) v') -> p k v')
197− -> ((forall a. Compose ((,) (Event t w)) v' a -> Event t w) -> p k (Compose ((,) (Event t w)) v') -> p' (Some k) (Event t w))
198− -> (p' (Some k) (Event t w) -> [Event t w])
199− -> (Incremental t (p' (Some k) (Event t w)) -> Event t (Map (Some k) w))
200− -> (forall a. k a -> v a -> EventWriterT t w m (v' a))
201− -> DMap k v
202− -> Event t (p k v)
203− -> EventWriterT t w m (DMap k v', Event t (p k v'))
204−sequenceDMapWithAdjustEventWriterTWith base mapPatch weakenPatchWith patchNewElements mergePatchIncremental f dm0 dm' = do
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
205240 let f' :: forall a. k a -> v a -> m (Compose ((,) (Event t w)) v' a)
206241 f' k v = Compose . swap <$> runEventWriterT (f k v)
207242 (children0, children') <- base f' dm0 dm'
@@ -211,26 +246,13 @@ sequenceDMapWithAdjustEventWriterTWith base mapPatch weakenPatchWith patchNewEle
211246 requests0 = weakenDMapWith (fst . getCompose) children0
212247 requests' :: Event t (p' (Some k) (Event t w))
213248 requests' = fforCheap children' $ weakenPatchWith $ fst . getCompose
214− childRequestMap :: Incremental t (p' (Some k) (Event t w)) <- holdIncremental requests0 requests'
215− tellEventsPromptly requests' patchNewElements $ mergePatchIncremental childRequestMap
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
216254 return (result0, result')
217255
218−tellEventsPromptly
219− :: ( Foldable f
220− , Reflex t
221− , EventWriter t w m
222− )
223− => Event t a
224− -> (a -> [Event t w])
225− -> Event t (f w)
226− -> m ()
227−tellEventsPromptly requests' patchNewElements mergedChildRequestMap = do
228− -- 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.)
229− tellEvent $ coincidence $ fmapCheap (mconcat . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
230− tellEvent $ fforMaybeCheap mergedChildRequestMap $ \m -> case toList m of
231− [] -> Nothing
232− h : t -> Just $ sconcat $ h :| t
233−
234256instance PerformEvent t m => PerformEvent t (EventWriterT t w m) where
235257 type Performable (EventWriterT t w m) = Performable m
236258 performEvent_ = lift . performEvent_
@@ -267,8 +289,15 @@ instance (MonadQuery t q m, Monad m) => MonadQuery t q (EventWriterT t w m) wher
267289 askQueryResult = lift askQueryResult
268290 queryIncremental = lift . queryIncremental
269291
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+
270299-- | Map a function over the output of a 'EventWriterT'.
271−withEventWriterT :: (Semigroup w, Semigroup w', Reflex t, MonadHold t m, MonadFix m)
300+withEventWriterT :: (Semigroup w, Semigroup w', Reflex t, MonadHold t m)
272301 => (w -> w')
273302 -> EventWriterT t w m a
274303 -> EventWriterT t w' m a
@@ -279,3 +308,10 @@ withEventWriterT f ew = do
279308 return (r, e')
280309 tellEvent e
281310 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.hs−1
@@ -2,7 +2,6 @@
22{-# LANGUAGE CPP #-}
33{-# LANGUAGE FlexibleInstances #-}
44{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
65{-# LANGUAGE UndecidableInstances #-}
76#ifdef USE_REFLEX_OPTIMIZER
87{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
src/Reflex/FastWeak.hs+69−5
@@ -5,6 +5,19 @@
55{-# LANGUAGE ForeignFunctionInterface #-}
66{-# LANGUAGE JavaScriptFFI #-}
77#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.
821module Reflex.FastWeak
922 ( FastWeakTicket
1023 , FastWeak
@@ -35,29 +48,57 @@ import System.Mem.Weak
3548
3649
3750#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@.
3856newtype FastWeakTicket a = FastWeakTicket JSVal
3957
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@.
4067newtype FastWeak a = FastWeak JSVal
4168
4269-- Just designed to mirror JSVal, so that we can unsafeCoerce between the two
4370data Val a = Val { unVal :: a }
4471
45−-- | Coerce a JSVal that represents the heap object of a value of type 'a' into a value of type 'a'
72+-- | Coerce a JSVal that represents the heap object of a value of type @a@ into a value of type @a@
4673unsafeFromRawJSVal :: JSVal -> a
4774unsafeFromRawJSVal v = unVal (unsafeCoerce v)
4875
76+-- | Coerce a heap object of type @a@ into a 'JSVal' which represents that object.
4977unsafeToRawJSVal :: a -> JSVal
5078unsafeToRawJSVal v = unsafeCoerce (Val v)
5179#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.
5283data FastWeakTicket a = FastWeakTicket
5384 { _fastWeakTicket_val :: !a
5485 , _fastWeakTicket_weak :: {-# UNPACK #-} !(Weak a)
5586 }
5687
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'.
5796type FastWeak a = Weak a
5897#endif
5998
60−-- This needs to be in IO so we know that we've relinquished the ticket
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.
61102getFastWeakTicketValue :: FastWeakTicket a -> IO a
62103#ifdef GHCJS_FAST_WEAK
63104getFastWeakTicketValue t = do
@@ -69,6 +110,8 @@ foreign import javascript unsafe "$r = $1.val;" js_ticketVal :: FastWeakTicket a
69110getFastWeakTicketValue = return . _fastWeakTicket_val
70111#endif
71112
113+-- | Get the value referred to by a 'FastWeak' if it hasn't yet been collected,
114+-- or @Nothing@ if it has been collected.
72115getFastWeakValue :: FastWeak a -> IO (Maybe a)
73116#ifdef GHCJS_FAST_WEAK
74117getFastWeakValue w = do
@@ -84,6 +127,9 @@ foreign import javascript unsafe "$r = ($1.ticket === null) ? null : $1.ticket.v
84127getFastWeakValue = deRefWeak
85128#endif
86129
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.
87133getFastWeakTicket :: forall a. FastWeak a -> IO (Maybe (FastWeakTicket a))
88134#ifdef GHCJS_FAST_WEAK
89135getFastWeakTicket w = do
@@ -103,8 +149,21 @@ getFastWeakTicket w = do
103149 }
104150#endif
105151
106−-- 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 associated FastWeak to actually be weak
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 #-}
107164mkFastWeakTicket :: 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
108167#ifdef GHCJS_FAST_WEAK
109168mkFastWeakTicket v = js_fastWeakTicket (unsafeToRawJSVal v)
110169
@@ -119,11 +178,16 @@ mkFastWeakTicket v = do
119178 }
120179#endif
121180
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)
122185-- Needs IO so that it can force the value - otherwise, could end up with a reference to the Ticket, which would retain the value
123186#ifdef GHCJS_FAST_WEAK
124−foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
187+foreign import javascript unsafe "$r = $1.weak;" getFastWeakTicketWeak' :: FastWeakTicket a -> IO (FastWeak a)
188+{-# INLINE getFastWeakTicketWeak #-}
189+getFastWeakTicketWeak = getFastWeakTicketWeak'
125190#else
126−getFastWeakTicketWeak :: FastWeakTicket a -> IO (FastWeak a)
127191getFastWeakTicketWeak = return . _fastWeakTicket_weak
128192#endif
129193
src/Reflex/FunctorMaybe.hs+32−18
@@ -1,33 +1,47 @@
1−-- | This module defines the FunctorMaybe class, which extends Functors with the
2−-- ability to delete values.
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:
11+-- This module defines the FunctorMaybe class, which extends Functors with the
12+-- ability to delete values.
313module Reflex.FunctorMaybe
414 ( FunctorMaybe (..)
515 ) where
616
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
823
924--TODO: See if there's a better class in the standard libraries already
1025
1126-- | A class for values that combines filtering and mapping using 'Maybe'.
12−-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@. Also similar is the
13−-- @Witherable@ typeclass, but it requires @Foldable f@ and @Traverable f@,
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@
27+-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@.
28+{-# DEPRECATED FunctorMaybe "Use 'Filterable' from Data.Witherable instead" #-}
2329class FunctorMaybe f where
2430 -- | Combined mapping and filtering function.
2531 fmapMaybe :: (a -> Maybe b) -> f a -> f b
2632
27−-- | @fmapMaybe = (=<<)
2833instance FunctorMaybe Maybe where
29− fmapMaybe = (=<<)
34+ fmapMaybe = mapMaybe
35+
36+#if MIN_VERSION_base(4,9,0)
37+deriving instance FunctorMaybe Option
38+#endif
3039
31−-- | @fmapMaybe f = catMaybes . fmap f@
3240instance FunctorMaybe [] where
33− 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−7
@@ -4,7 +4,6 @@
44{-# LANGUAGE FlexibleInstances #-}
55{-# LANGUAGE FunctionalDependencies #-}
66{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
87{-# LANGUAGE RankNTypes #-}
98{-# LANGUAGE RoleAnnotations #-}
109{-# LANGUAGE ScopedTypeVariables #-}
@@ -30,8 +29,6 @@ module Reflex.Host.Class
3029
3130import Reflex.Class
3231
33−import Control.Applicative
34−import Control.Monad
3532import Control.Monad.Fix
3633import Control.Monad.Identity
3734import Control.Monad.Ref
@@ -45,10 +42,6 @@ import qualified Control.Monad.Trans.State.Strict as Strict
4542import Control.Monad.Trans.Writer (WriterT)
4643import Data.Dependent.Sum (DSum (..))
4744import Data.GADT.Compare
48−import Data.Monoid
49−
50−-- Note: this import must come last to silence warnings from AMP
51−import Prelude hiding (foldl, mapM, mapM_, sequence, sequence_)
5245
5346-- | Framework implementation support class for the reflex implementation
5447-- 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.hs+14−7
@@ -3,6 +3,11 @@
33#ifdef USE_REFLEX_OPTIMIZER
44{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
55#endif
6+-- |
7+-- Module:
8+-- Reflex.Network
9+-- Description:
10+-- This module provides combinators for building FRP graphs/networks and modifying them dynamically.
611module Reflex.Network
712 ( networkView
813 , networkHold
@@ -10,29 +15,31 @@ module Reflex.Network
1015 ) where
1116
1217import Reflex.Class
18+import Reflex.Adjustable.Class
1319import Reflex.NotReady.Class
1420import Reflex.PostBuild.Class
1521
16−-- | Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
17−-- The returned Event of network results occurs when the Dynamic does.
18−-- Note: Often, the type 'a' is an Event, in which case the return value is an Event-of-Events that would typically be flattened (via 'switchPromptly').
19−networkView :: (Reflex t, NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
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)
2027networkView child = do
2128 postBuild <- getPostBuild
2229 let newChild = leftmost [updated child, tagCheap (current child) postBuild]
2330 snd <$> runWithReplace notReady newChild
2431
25−-- | Given an initial network and an Event of network-creating actions, create a network that is recreated whenever the Event fires.
32+-- | Given an initial "network" and an 'Event' of network-creating actions, create a network that is recreated whenever the Event fires.
2633-- The returned Dynamic of network results occurs when the Event does.
2734-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
28−networkHold :: (Reflex t, Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
35+networkHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
2936networkHold child0 newChild = do
3037 (result0, newResult) <- runWithReplace child0 newChild
3138 holdDyn result0 newResult
3239
3340-- | Render a placeholder network to be shown while another network is not yet
3441-- done building
35−untilReady :: (Reflex t, Adjustable t m, PostBuild t m) => m a -> m b -> m (a, Event t b)
42+untilReady :: (Adjustable t m, PostBuild t m) => m a -> m b -> m (a, Event t b)
3643untilReady a b = do
3744 postBuild <- getPostBuild
3845 runWithReplace a $ b <$ postBuild
src/Reflex/NotReady/Class.hs+10−1
@@ -3,7 +3,6 @@
33{-# LANGUAGE FlexibleContexts #-}
44{-# LANGUAGE FlexibleInstances #-}
55{-# LANGUAGE FunctionalDependencies #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
76{-# LANGUAGE TypeFamilies #-}
87{-# LANGUAGE UndecidableInstances #-}
98#ifdef USE_REFLEX_OPTIMIZER
@@ -15,7 +14,9 @@ module Reflex.NotReady.Class
1514
1615import Control.Monad.Reader (ReaderT)
1716import Control.Monad.Trans
17+import Control.Monad.Trans.Writer (WriterT)
1818
19+import Reflex.BehaviorWriter.Base (BehaviorWriterT)
1920import Reflex.Class
2021import Reflex.DynamicWriter.Base (DynamicWriterT)
2122import Reflex.EventWriter.Base (EventWriterT)
@@ -39,6 +40,10 @@ instance NotReady t m => NotReady t (ReaderT r m) where
3940 notReadyUntil = lift . notReadyUntil
4041 notReady = lift notReady
4142
43+instance (NotReady t m, Monoid w) => NotReady t (WriterT w m) where
44+ notReadyUntil = lift . notReadyUntil
45+ notReady = lift notReady
46+
4247instance NotReady t m => NotReady t (PostBuildT t m) where
4348 notReadyUntil = lift . notReadyUntil
4449 notReady = lift notReady
@@ -51,6 +56,10 @@ instance NotReady t m => NotReady t (DynamicWriterT t w m) where
5156 notReadyUntil = lift . notReadyUntil
5257 notReady = lift notReady
5358
59+instance NotReady t m => NotReady t (BehaviorWriterT t w m) where
60+ notReadyUntil = lift . notReadyUntil
61+ notReady = lift notReady
62+
5463instance NotReady t m => NotReady t (QueryT t q m) where
5564 notReadyUntil = lift . notReadyUntil
5665 notReady = lift notReady
src/Reflex/Optimizer.hs+13−4
@@ -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.
51{-# LANGUAGE CPP #-}
62{-# LANGUAGE LambdaCase #-}
73{-# 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.
812module Reflex.Optimizer
913 ( plugin
1014 ) where
@@ -16,6 +20,11 @@ import Control.Arrow
1620import CoreMonad
1721import Data.String
1822import GhcPlugins
23+
24+#if MIN_VERSION_base(4,9,0)
25+import Prelude hiding ((<>))
26+#endif
27+
1928#endif
2029
2130#ifdef ghcjs_HOST_OS
src/Reflex/Patch.hsdeleted−39
@@ -1,39 +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 TypeFamilies #-}
4−module Reflex.Patch
5− ( module Reflex.Patch
6− , module X
7− ) where
8−
9−import Reflex.Patch.Class as X
10−import Reflex.Patch.DMap as X hiding (getDeletions)
11−import Reflex.Patch.DMapWithMove as X (PatchDMapWithMove, const2PatchDMapWithMoveWith, mapPatchDMapWithMove,
12− patchDMapWithMoveToPatchMapWithMoveWith,
13− traversePatchDMapWithMoveWithKey, unPatchDMapWithMove,
14− unsafePatchDMapWithMove, weakenPatchDMapWithMoveWith)
15−import Reflex.Patch.IntMap as X hiding (getDeletions)
16−import Reflex.Patch.Map as X
17−import Reflex.Patch.MapWithMove as X (PatchMapWithMove, patchMapWithMoveNewElements,
18− patchMapWithMoveNewElementsMap, unPatchMapWithMove,
19− unsafePatchMapWithMove)
20−
21−import Data.Semigroup (Semigroup (..), (<>))
22−
23−---- Patches based on commutative groups
24−
25−-- | A 'Group' is a 'Monoid' where every element has an inverse.
26−class (Semigroup q, Monoid q) => Group q where
27− negateG :: q -> q
28− (~~) :: q -> q -> q
29− r ~~ s = r <> negateG s
30−
31−-- | An 'Additive' 'Semigroup' is one where (<>) is commutative
32−class Semigroup q => Additive q where
33−
34−-- | The elements of an 'Additive' 'Semigroup' can be considered as patches of their own type.
35−newtype AdditivePatch p = AdditivePatch { unAdditivePatch :: p }
36−
37−instance Additive p => Patch (AdditivePatch p) where
38− type PatchTarget (AdditivePatch p) = p
39− apply (AdditivePatch p) q = Just $ p <> q
src/Reflex/Patch/Class.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE TypeFamilies #-}
2−-- | The interface for types which represent changes made to other types
3−module Reflex.Patch.Class where
4−
5−import Control.Monad.Identity
6−import Data.Maybe
7−
8−-- | A 'Patch' type represents a kind of change made to a datastructure.
9−class Patch p where
10− type PatchTarget p :: *
11− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
12− -- 'Nothing'.
13− apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
14−
15−-- | Apply a 'Patch'; if it does nothing, return the original value
16−applyAlways :: Patch p => p -> PatchTarget p -> PatchTarget p
17−applyAlways p t = fromMaybe t $ apply p t
18−
19−-- | 'Identity' can be used as a 'Patch' that always fully replaces the value
20−instance Patch (Identity a) where
21− type PatchTarget (Identity a) = a
22− apply (Identity a) _ = Just a
src/Reflex/Patch/DMap.hsdeleted−68
@@ -1,68 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE PolyKinds #-}
4−{-# LANGUAGE Rank2Types #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE StandaloneDeriving #-}
7−{-# LANGUAGE TypeFamilies #-}
8−module Reflex.Patch.DMap where
9−
10−import Reflex.Patch.Class
11−import Reflex.Patch.IntMap
12−import Reflex.Patch.Map
13−
14−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
15−import qualified Data.Dependent.Map as DMap
16−import Data.Functor.Constant
17−import Data.Functor.Misc
18−import qualified Data.IntMap as IntMap
19−import qualified Data.Map as Map
20−import Data.Semigroup (Semigroup (..))
21−import Data.Some (Some)
22−
23−-- | A set of changes to a 'DMap'. Any element may be inserted/updated or
24−-- deleted.
25−newtype PatchDMap k v = PatchDMap { unPatchDMap :: DMap k (ComposeMaybe v) }
26−
27−deriving instance GCompare k => Semigroup (PatchDMap k v)
28−
29−deriving instance GCompare k => Monoid (PatchDMap k v)
30−
31−instance GCompare k => Patch (PatchDMap k v) where
32− type PatchTarget (PatchDMap k v) = DMap k v
33− 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?
34− where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
35− deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
36− nothingToJust = \case
37− Nothing -> Just $ Constant ()
38− Just _ -> Nothing
39−
40−mapPatchDMap :: (forall a. v a -> v' a) -> PatchDMap k v -> PatchDMap k v'
41−mapPatchDMap f (PatchDMap p) = PatchDMap $ DMap.map (ComposeMaybe . fmap f . getComposeMaybe) p
42−
43−traversePatchDMap :: Applicative m => (forall a. v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
44−traversePatchDMap f = traversePatchDMapWithKey $ const f
45−
46−traversePatchDMapWithKey :: Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
47−traversePatchDMapWithKey f (PatchDMap p) = PatchDMap <$> DMap.traverseWithKey (\k (ComposeMaybe v) -> ComposeMaybe <$> traverse (f k) v) p
48−
49−weakenPatchDMapWith :: (forall a. v a -> v') -> PatchDMap k v -> PatchMap (Some k) v'
50−weakenPatchDMapWith f (PatchDMap p) = PatchMap $ weakenDMapWith (fmap f . getComposeMaybe) p
51−
52−patchDMapToPatchMapWith :: (f v -> v') -> PatchDMap (Const2 k v) f -> PatchMap k v'
53−patchDMapToPatchMapWith f (PatchDMap p) = PatchMap $ dmapToMapWith (fmap f . getComposeMaybe) p
54−
55−const2PatchDMapWith :: forall k v f a. (v -> f a) -> PatchMap k v -> PatchDMap (Const2 k a) f
56−const2PatchDMapWith f (PatchMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
57− where g :: (k, Maybe v) -> DSum (Const2 k a) (ComposeMaybe f)
58− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
59−
60−const2IntPatchDMapWith :: forall v f a. (v -> f a) -> PatchIntMap v -> PatchDMap (Const2 IntMap.Key a) f
61−const2IntPatchDMapWith f (PatchIntMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> IntMap.toAscList p
62− where g :: (IntMap.Key, Maybe v) -> DSum (Const2 IntMap.Key a) (ComposeMaybe f)
63− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
64−
65−-- | Get the values that will be deleted if the given patch is applied to the
66−-- given 'DMap'. Includes values that will be replaced.
67−getDeletions :: GCompare k => PatchDMap k v -> DMap k v' -> DMap k v'
68−getDeletions (PatchDMap p) m = DMap.intersectionWithKey (\_ v _ -> v) m p
src/Reflex/Patch/DMapWithMove.hsdeleted−367
@@ -1,367 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE Rank2Types #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE UndecidableInstances #-}
13−
14−-- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
15−-- move values between keys.
16−module Reflex.Patch.DMapWithMove where
17−
18−import Reflex.Patch.Class
19−import Reflex.Patch.MapWithMove (PatchMapWithMove (..))
20−import qualified Reflex.Patch.MapWithMove as MapWithMove
21−
22−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
23−import qualified Data.Dependent.Map as DMap
24−import Data.Dependent.Sum (EqTag (..))
25−import Data.Functor.Constant
26−import Data.Functor.Misc
27−import Data.Functor.Product
28−import Data.GADT.Compare (GEq (..))
29−import Data.GADT.Show (GShow, gshow)
30−import qualified Data.Map as Map
31−import Data.Maybe
32−import Data.Semigroup (Semigroup (..), (<>))
33−import Data.Some (Some)
34−import qualified Data.Some as Some
35−import Data.These
36−
37−-- | Like 'PatchMapWithMove', but for 'DMap'. Each key carries a 'NodeInfo' which describes how it will be changed by the patch and connects move sources and
38−-- destinations.
39−--
40−-- Invariants:
41−--
42−-- * A key should not move to itself.
43−-- * A move should always be represented with both the destination key (as a 'From_Move') and the source key (as a @'ComposeMaybe' ('Just' destination)@)
44−newtype PatchDMapWithMove k v = PatchDMapWithMove (DMap k (NodeInfo k v))
45−
46−-- |Structure which represents what changes apply to a particular key. @_nodeInfo_from@ specifies what happens to this key, and in particular what other key
47−-- the current key is moving from, while @_nodeInfo_to@ specifies what key the current key is moving to if involved in a move.
48−data NodeInfo k v a = NodeInfo
49− { _nodeInfo_from :: !(From k v a)
50− -- ^Change applying to the current key, be it an insert, move, or delete.
51− , _nodeInfo_to :: !(To k a)
52− -- ^Where this key is moving to, if involved in a move. Should only be @ComposeMaybe (Just k)@ when there is a corresponding 'From_Move'.
53− }
54− deriving (Show)
55−
56−-- |Structure describing a particular change to a key, be it inserting a new key (@From_Insert@), updating an existing key (@From_Insert@ again), deleting a
57−-- key (@From_Delete@), or moving a key (@From_Move@).
58−data From (k :: a -> *) (v :: a -> *) :: a -> * where
59− -- |Insert a new or update an existing key with the given value @v a@
60− From_Insert :: v a -> From k v a
61− -- |Delete the existing key
62− From_Delete :: From k v a
63− -- |Move the value from the given key @k a@ to this key. The source key should also have an entry in the patch giving the current key as @_nodeInfo_to@,
64− -- usually but not necessarily with @From_Delete@.
65− From_Move :: !(k a) -> From k v a
66− deriving (Show, Read, Eq, Ord)
67−
68−-- |Type alias for the "to" part of a 'NodeInfo'. @'ComposeMaybe' ('Just' k)@ means the key is moving to another key, @ComposeMaybe Nothing@ for any other
69−-- operation.
70−type To = ComposeMaybe
71−
72−-- |Test whether a 'PatchDMapWithMove' satisfies its invariants.
73−validPatchDMapWithMove :: forall k v. (GCompare k, GEq k, GShow k) => DMap k (NodeInfo k v) -> Bool
74−validPatchDMapWithMove = not . null . validationErrorsForPatchDMapWithMove
75−
76−-- |Enumerate what reasons a 'PatchDMapWithMove' doesn't satisfy its invariants, returning @[]@ if it's valid.
77−validationErrorsForPatchDMapWithMove :: forall k v. (GCompare k, GEq k, GShow k) => DMap k (NodeInfo k v) -> [String]
78−validationErrorsForPatchDMapWithMove m =
79− noSelfMoves <> movesBalanced
80− where
81− noSelfMoves = mapMaybe selfMove . DMap.toAscList $ m
82− selfMove (dst :=> NodeInfo (From_Move src) _) | Just _ <- dst `geq` src = Just $ "self move of key " <> gshow src <> " at destination side"
83− selfMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) | Just _ <- src `geq` dst = Just $ "self move of key " <> gshow dst <> " at source side"
84− selfMove _ = Nothing
85− movesBalanced = mapMaybe unbalancedMove . DMap.toAscList $ m
86− unbalancedMove (dst :=> NodeInfo (From_Move src) _) =
87− case DMap.lookup src m of
88− Nothing -> Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key is not in the patch"
89− Just (NodeInfo _ (ComposeMaybe (Just dst'))) ->
90− if isNothing (dst' `geq` dst)
91− then Just $ "unbalanced move at destination key " <> gshow dst <> " from " <> gshow src <> " is going to " <> gshow dst' <> " instead"
92− else Nothing
93− _ ->
94− Just $ "unbalanced move at destination key " <> gshow dst <> " supposedly from " <> gshow src <> " but source key has no move to key"
95− unbalancedMove (src :=> NodeInfo _ (ComposeMaybe (Just dst))) =
96− case DMap.lookup dst m of
97− Nothing -> Just $ " unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not in the patch"
98− Just (NodeInfo (From_Move src') _) ->
99− if isNothing (src' `geq` src)
100− then Just $ "unbalanced move at source key " <> gshow src <> " to " <> gshow dst <> " is coming from " <> gshow src' <> " instead"
101− else Nothing
102−
103− _ ->
104− Just $ "unbalanced move at source key " <> gshow src <> " supposedly going to " <> gshow dst <> " but destination key is not moving"
105− unbalancedMove _ = Nothing
106−
107−instance EqTag k (NodeInfo k v) => Eq (PatchDMapWithMove k v) where
108− PatchDMapWithMove a == PatchDMapWithMove b = a == b
109−
110−-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
111−data Pair1 f g a = Pair1 (f a) (g a)
112−
113−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
114−instance GCompare k => Semigroup (PatchDMapWithMove k v) where
115− (<>) = mappend
116−
117−-- |Helper data structure used for composing patches using the monoid instance.
118−data Fixup k v a
119− = Fixup_Delete
120− | Fixup_Update (These (From k v a) (To k a))
121−
122−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
123−instance GCompare k => Monoid (PatchDMapWithMove k v) where
124− mempty = PatchDMapWithMove mempty
125− PatchDMapWithMove ma `mappend` PatchDMapWithMove mb = PatchDMapWithMove m
126− where
127− connections = DMap.toList $ DMap.intersectionWithKey (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b)) ma mb
128− h :: DSum k (Pair1 (ComposeMaybe k) (From k v)) -> [DSum k (Fixup k v)]
129− h (_ :=> Pair1 (ComposeMaybe mToAfter) editBefore) = case (mToAfter, editBefore) of
130− (Just toAfter, From_Move fromBefore)
131− | isJust $ fromBefore `geq` toAfter
132− -> [toAfter :=> Fixup_Delete]
133− | otherwise
134− -> [ toAfter :=> Fixup_Update (This editBefore)
135− , fromBefore :=> Fixup_Update (That (ComposeMaybe mToAfter))
136− ]
137− (Nothing, From_Move fromBefore) -> [fromBefore :=> Fixup_Update (That (ComposeMaybe mToAfter))] -- The item is destroyed in the second patch, so indicate that it is destroyed in the source map
138− (Just toAfter, _) -> [toAfter :=> Fixup_Update (This editBefore)]
139− (Nothing, _) -> []
140− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
141− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
142− | This x <- a, That y <- b
143− = Fixup_Update $ These x y
144− | That y <- a, This x <- b
145− = Fixup_Update $ These x y
146− mergeFixups _ _ _ = error "PatchDMapWithMove: incompatible fixups"
147− fixups = DMap.fromListWithKey mergeFixups $ concatMap h connections
148− combineNodeInfos _ nia nib = NodeInfo
149− { _nodeInfo_from = _nodeInfo_from nia
150− , _nodeInfo_to = _nodeInfo_to nib
151− }
152− applyFixup _ ni = \case
153− Fixup_Delete -> Nothing
154− Fixup_Update u -> Just $ NodeInfo
155− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
156− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
157− }
158− m = DMap.differenceWithKey applyFixup (DMap.unionWithKey combineNodeInfos ma mb) fixups
159−
160−-- |Project the @a@ from a @'These' a b@, identical to @preview '_Here'@ but without using preview
161−getHere :: These a b -> Maybe a
162−getHere = \case
163− This a -> Just a
164− These a _ -> Just a
165− That _ -> Nothing
166−
167−-- |Project the @b@ from a @'These' a b@, identical to @preview '_There'@ but without using preview
168−getThere :: These a b -> Maybe b
169−getThere = \case
170− This _ -> Nothing
171− These _ b -> Just b
172− That b -> Just b
173−
174−{-
175−mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
176−PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
177− where
178− getDstAction k m = fromMaybe (From_Move k) $ DMap.lookup k m -- Any key that isn't present is treated as that key moving to itself
179− removeRedundantDst toKey (From_Move fromKey) | isJust (toKey `geq` fromKey) = Nothing
180− removeRedundantDst _ a = Just a
181− f :: forall a. k a -> From k v a -> Maybe (From k v a)
182− f toKey _ = removeRedundantDst toKey $ case getDstAction toKey dstAfter of
183− From_Move fromKey -> getDstAction fromKey dstBefore
184− nonMove -> nonMove
185− dst = DMap.mapMaybeWithKey f $ DMap.union dstAfter dstBefore
186− getSrcAction k m = fromMaybe (ComposeMaybe $ Just k) $ DMap.lookup k m
187− removeRedundantSrc fromKey (ComposeMaybe (Just toKey)) | isJust (fromKey `geq` toKey) = Nothing
188− removeRedundantSrc _ a = Just a
189− g :: forall a. k a -> ComposeMaybe k a -> Maybe (ComposeMaybe k a)
190− g fromKey _ = removeRedundantSrc fromKey $ case getSrcAction fromKey srcBefore of
191− ComposeMaybe Nothing -> ComposeMaybe Nothing
192− ComposeMaybe (Just toKeyBefore) -> getSrcAction toKeyBefore srcAfter
193− src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
194−-}
195−
196−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of inserting or updating a value @v a@ to the given key @k a@, like 'DMap.insert'.
197−insertDMapKey :: k a -> v a -> PatchDMapWithMove k v
198−insertDMapKey k v =
199− PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) (ComposeMaybe Nothing)
200−
201−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of moving the value from the first key @k a@ to the second key @k a@, equivalent to:
202−--
203−-- @
204−-- 'DMap.delete' src (maybe dmap ('DMap.insert' dst) (DMap.lookup src dmap))
205−-- @
206−moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
207−moveDMapKey src dst = case src `geq` dst of
208− Nothing -> PatchDMapWithMove $ DMap.fromList
209− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
210− , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
211− ]
212− Just _ -> mempty
213−
214−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
215−--
216−-- @
217−-- let aMay = DMap.lookup a dmap
218−-- bMay = DMap.lookup b dmap
219−-- in maybe id (DMap.insert a) (bMay `mplus` aMay)
220−-- . maybe id (DMap.insert b) (aMay `mplus` bMay)
221−-- . DMap.delete a . DMap.delete b $ dmap
222−-- @
223−swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
224−swapDMapKey src dst = case src `geq` dst of
225− Nothing -> PatchDMapWithMove $ DMap.fromList
226− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe $ Just src)
227− , src :=> NodeInfo (From_Move dst) (ComposeMaybe $ Just dst)
228− ]
229− Just _ -> mempty
230−
231−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'DMap.delete'.
232−deleteDMapKey :: k a -> PatchDMapWithMove k v
233−deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete $ ComposeMaybe Nothing
234−
235−{-
236−k1, k2 :: Const2 Int () ()
237−k1 = Const2 1
238−k2 = Const2 2
239−p1, p2 :: PatchDMapWithMove (Const2 Int ()) Identity
240−p1 = moveDMapKey k1 k2
241−p2 = moveDMapKey k2 k1
242−p12 = p1 <> p2
243−p21 = p2 <> p1
244−p12Slow = p1 `mappendPatchDMapWithMoveSlow` p2
245−p21Slow = p2 `mappendPatchDMapWithMoveSlow` p1
246−
247−testPatchDMapWithMove = do
248− print p1
249− print p2
250− print $ p12 == deleteDMapKey k1
251− print $ p21 == deleteDMapKey k2
252− print $ p12Slow == deleteDMapKey k1
253− print $ p21Slow == deleteDMapKey k2
254−
255−dst (PatchDMapWithMove x _) = x
256−src (PatchDMapWithMove _ x) = x
257−-}
258−
259−-- |Extract the 'DMap' representing the patch changes from the 'PatchDMapWithMove'.
260−unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (NodeInfo k v)
261−unPatchDMapWithMove (PatchDMapWithMove p) = p
262−
263−-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove', without checking any invariants.
264−--
265−-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchDMapWithMove' are preserved; they will not be checked.
266−unsafePatchDMapWithMove :: DMap k (NodeInfo k v) -> PatchDMapWithMove k v
267−unsafePatchDMapWithMove = PatchDMapWithMove
268−
269−-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove' while checking invariants. If the invariants are satisfied, @Right p@ is returned
270−-- otherwise @Left errors@.
271−patchDMapWithMove :: (GCompare k, GEq k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithMove k v)
272−patchDMapWithMove dm =
273− case validationErrorsForPatchDMapWithMove dm of
274− [] -> Right $ unsafePatchDMapWithMove dm
275− errs -> Left errs
276−
277−-- |Map a natural transform @v -> v'@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @'PatchDMapWithMove' k v'@.
278−mapPatchDMapWithMove :: forall k v v'. (forall a. v a -> v' a) -> PatchDMapWithMove k v -> PatchDMapWithMove k v'
279−mapPatchDMapWithMove f (PatchDMapWithMove p) = PatchDMapWithMove $
280− DMap.map (\ni -> ni { _nodeInfo_from = g $ _nodeInfo_from ni }) p
281− where g :: forall a. From k v a -> From k v' a
282− g = \case
283− From_Insert v -> From_Insert $ f v
284− From_Delete -> From_Delete
285− From_Move k -> From_Move k
286−
287−-- |Traverse an effectful function @forall a. v a -> m (v ' a)@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @m ('PatchDMapWithMove' k v')@.
288−traversePatchDMapWithMove :: forall m k v v'. Applicative m => (forall a. v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
289−traversePatchDMapWithMove f = traversePatchDMapWithMoveWithKey $ const f
290−
291−-- |Map an effectful function @forall a. k a -> v a -> m (v ' a)@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @m ('PatchDMapWithMove' k v')@.
292−traversePatchDMapWithMoveWithKey :: forall m k v v'. Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
293−traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) = PatchDMapWithMove <$> DMap.traverseWithKey (nodeInfoMapFromM . g) p
294− where g :: forall a. k a -> From k v a -> m (From k v' a)
295− g k = \case
296− From_Insert v -> From_Insert <$> f k v
297− From_Delete -> pure From_Delete
298− From_Move fromKey -> pure $ From_Move fromKey
299−
300−-- |Map a function which transforms @'From' k v a@ into a @'From' k v' a@ over a @'NodeInfo' k v a@.
301−nodeInfoMapFrom :: (From k v a -> From k v' a) -> NodeInfo k v a -> NodeInfo k v' a
302−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
303−
304−-- |Map an effectful function which transforms @'From' k v a@ into a @f ('From' k v' a)@ over a @'NodeInfo' k v a@.
305−nodeInfoMapFromM :: Functor f => (From k v a -> f (From k v' a)) -> NodeInfo k v a -> f (NodeInfo k v' a)
306−nodeInfoMapFromM f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
307−
308−-- |Weaken a 'PatchDMapWithMove' to a 'PatchMapWithMove' by weakening the keys from @k a@ to @'Some' k@ and applying a given weakening function @v a -> v'@ to
309−-- values.
310−weakenPatchDMapWithMoveWith :: forall k v v'. (forall a. v a -> v') -> PatchDMapWithMove k v -> PatchMapWithMove (Some k) v'
311−weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenDMapWith g p
312− where g :: forall a. NodeInfo k v a -> MapWithMove.NodeInfo (Some k) v'
313− g ni = MapWithMove.NodeInfo
314− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
315− From_Insert v -> MapWithMove.From_Insert $ f v
316− From_Delete -> MapWithMove.From_Delete
317− From_Move k -> MapWithMove.From_Move $ Some.This k
318− , MapWithMove._nodeInfo_to = Some.This <$> getComposeMaybe (_nodeInfo_to ni)
319− }
320−
321−-- |"Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithMove' k v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
322−-- dependency in the typing and all points are already @a@, hence the function to map each value to @v'@ is not higher rank.
323−patchDMapWithMoveToPatchMapWithMoveWith :: forall k v v' a. (v a -> v') -> PatchDMapWithMove (Const2 k a) v -> PatchMapWithMove k v'
324−patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ dmapToMapWith g p
325− where g :: NodeInfo (Const2 k a) v a -> MapWithMove.NodeInfo k v'
326− g ni = MapWithMove.NodeInfo
327− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
328− From_Insert v -> MapWithMove.From_Insert $ f v
329− From_Delete -> MapWithMove.From_Delete
330− From_Move (Const2 k) -> MapWithMove.From_Move k
331− , MapWithMove._nodeInfo_to = unConst2 <$> getComposeMaybe (_nodeInfo_to ni)
332− }
333−
334−-- |"Strengthen" a @'PatchMapWithMove' k v@ into a @'PatchDMapWithMove ('Const2' k a)@; that is, turn a non-dependently-typed patch into a dependently typed
335−-- one but which always has a constant key type represented by 'Const2'. Apply the given function to each @v@ to produce a @v' a@.
336−-- Completemented by 'patchDMapWithMoveToPatchMapWithMoveWith'
337−const2PatchDMapWithMoveWith :: forall k v v' a. (v -> v' a) -> PatchMapWithMove k v -> PatchDMapWithMove (Const2 k a) v'
338−const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
339− where g :: (k, MapWithMove.NodeInfo k v) -> DSum (Const2 k a) (NodeInfo (Const2 k a) v')
340− g (k, ni) = Const2 k :=> NodeInfo
341− { _nodeInfo_from = case MapWithMove._nodeInfo_from ni of
342− MapWithMove.From_Insert v -> From_Insert $ f v
343− MapWithMove.From_Delete -> From_Delete
344− MapWithMove.From_Move fromKey -> From_Move $ Const2 fromKey
345− , _nodeInfo_to = ComposeMaybe $ Const2 <$> MapWithMove._nodeInfo_to ni
346− }
347−
348−instance GCompare k => Patch (PatchDMapWithMove k v) where
349− type PatchTarget (PatchDMapWithMove k v) = DMap k v
350− 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?
351− where insertions = DMap.mapMaybeWithKey insertFunc p
352− insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
353− insertFunc _ ni = case _nodeInfo_from ni of
354− From_Insert v -> Just v
355− From_Move k -> DMap.lookup k old
356− From_Delete -> Nothing
357− deletions = DMap.mapMaybeWithKey deleteFunc p
358− deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
359− deleteFunc _ ni = case _nodeInfo_from ni of
360− From_Delete -> Just $ Constant ()
361− _ -> Nothing
362−
363−-- | Get the values that will be deleted or moved if the given patch is applied
364−-- to the given 'DMap'.
365−getDeletionsAndMoves :: GCompare k => PatchDMapWithMove k v -> DMap k v' -> DMap k (Product v' (ComposeMaybe k))
366−getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
367− where f _ v ni = Pair v $ _nodeInfo_to ni
src/Reflex/Patch/IntMap.hsdeleted−50
@@ -1,50 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFoldable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE DeriveTraversable #-}
5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE TypeFamilies #-}
7−module Reflex.Patch.IntMap where
8−
9−import Data.IntMap.Strict (IntMap)
10−import qualified Data.IntMap.Strict as IntMap
11−import Data.Maybe
12−import Data.Semigroup
13−import Prelude hiding (lookup)
14−import Reflex.Patch.Class
15−
16−newtype PatchIntMap a = PatchIntMap (IntMap (Maybe a)) deriving (Functor, Foldable, Traversable, Monoid)
17−
18−instance Patch (PatchIntMap a) where
19− type PatchTarget (PatchIntMap a) = IntMap a
20− apply (PatchIntMap p) v = if IntMap.null p then Nothing else Just $
21− let removes = IntMap.filter isNothing p
22− adds = IntMap.mapMaybe id p
23− in IntMap.union adds $ v `IntMap.difference` removes
24−
25−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
26−-- If the same key is modified by both patches, the one on the left will take
27−-- precedence.
28−instance Semigroup (PatchIntMap v) where
29− PatchIntMap a <> PatchIntMap b = PatchIntMap $ a `mappend` b --TODO: Add a semigroup instance for Map
30− -- PatchMap is idempotent, so stimes n is id for every n
31−#if MIN_VERSION_semigroups(0,17,0)
32− stimes = stimesIdempotentMonoid
33−#else
34− times1p n x = case compare n 0 of
35− LT -> error "stimesIdempotentMonoid: negative multiplier"
36− EQ -> mempty
37− GT -> x
38−#endif
39−
40−traverseIntMapPatchWithKey :: Applicative t => (Int -> a -> t b) -> PatchIntMap a -> t (PatchIntMap b)
41−traverseIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap <$> IntMap.traverseWithKey (\k mv -> traverse (f k) mv) m
42−
43−patchIntMapNewElements :: PatchIntMap a -> [a]
44−patchIntMapNewElements (PatchIntMap m) = catMaybes $ IntMap.elems m
45−
46−patchIntMapNewElementsMap :: PatchIntMap a -> IntMap a
47−patchIntMapNewElementsMap (PatchIntMap m) = IntMap.mapMaybe id m
48−
49−getDeletions :: PatchIntMap v -> IntMap v' -> IntMap v'
50−getDeletions (PatchIntMap m) v = IntMap.intersection v m
src/Reflex/Patch/Map.hsdeleted−64
@@ -1,64 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE TypeFamilies #-}
4−-- | 'Patch'es on 'Map' that consist only of insertions (including overwrites)
5−-- and deletions
6−module Reflex.Patch.Map where
7−
8−import Reflex.Patch.Class
9−
10−import Data.Map (Map)
11−import qualified Data.Map as Map
12−import Data.Maybe
13−import Data.Semigroup
14−
15−-- | A set of changes to a 'Map'. Any element may be inserted/updated or
16−-- deleted. Insertions are represented as values wrapped in 'Just', while
17−-- deletions are represented as 'Nothing's
18−newtype PatchMap k v = PatchMap { unPatchMap :: Map k (Maybe v) }
19− deriving (Show, Read, Eq, Ord)
20−
21−-- | Applying a 'PatchMap' will update the 'Map' by performing the insertions
22−-- and deletions specified
23−instance Ord k => Patch (PatchMap k v) where
24− type PatchTarget (PatchMap k v) = Map k v
25− {-# INLINABLE apply #-}
26− 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?
27− where insertions = Map.mapMaybeWithKey (const id) p
28− deletions = Map.mapMaybeWithKey (const nothingToJust) p
29− nothingToJust = \case
30− Nothing -> Just ()
31− Just _ -> Nothing
32−
33−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
34−-- If the same key is modified by both patches, the one on the left will take
35−-- precedence.
36−instance Ord k => Semigroup (PatchMap k v) where
37− PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
38− -- PatchMap is idempotent, so stimes n is id for every n
39−#if MIN_VERSION_semigroups(0,17,0)
40− stimes = stimesIdempotentMonoid
41−#else
42− times1p n x = case compare n 0 of
43− LT -> error "stimesIdempotentMonoid: negative multiplier"
44− EQ -> mempty
45− GT -> x
46−#endif
47−
48−-- | The empty 'PatchMap' contains no insertions or deletions
49−instance Ord k => Monoid (PatchMap k v) where
50− mempty = PatchMap mempty
51− mappend = (<>)
52−
53−-- | 'fmap'ping a 'PatchMap' will alter all of the values it will insert.
54−-- Deletions are unaffected.
55−instance Functor (PatchMap k) where
56− fmap f = PatchMap . fmap (fmap f) . unPatchMap
57−
58−-- | Returns all the new elements that will be added to the 'Map'
59−patchMapNewElements :: PatchMap k v -> [v]
60−patchMapNewElements (PatchMap p) = catMaybes $ Map.elems p
61−
62−-- | Returns all the new elements that will be added to the 'Map'
63−patchMapNewElementsMap :: PatchMap k v -> Map k v
64−patchMapNewElementsMap (PatchMap p) = Map.mapMaybe id p
src/Reflex/Patch/MapWithMove.hsdeleted−156
@@ -1,156 +0,0 @@
1−{-# LANGUAGE DeriveFoldable #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveTraversable #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TypeFamilies #-}
8−-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
9−-- another
10−module Reflex.Patch.MapWithMove where
11−
12−import Reflex.Patch.Class
13−
14−import Control.Arrow
15−import Control.Monad.State
16−import Data.Foldable
17−import Data.Function
18−import Data.List
19−import Data.Map (Map)
20−import qualified Data.Map as Map
21−import Data.Maybe
22−import qualified Data.Set as Set
23−import Data.Tuple
24−
25−-- | Patch a DMap with additions, deletions, and moves. Invariant: If key @k1@
26−-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
27−-- and vice versa. There should never be any unpaired From/To keys.
28−newtype PatchMapWithMove k v = PatchMapWithMove (Map k (NodeInfo k v)) deriving (Show, Eq, Ord, Functor, Foldable, Traversable)
29−
30−-- | Holds the information about each key: where its new value should come from,
31−-- and where its old value should go to
32−data NodeInfo k v = NodeInfo
33− { _nodeInfo_from :: !(From k v)
34− -- ^ Where do we get the new value for this key?
35− , _nodeInfo_to :: !(To k)
36− -- ^ If the old value is being kept (i.e. moved rather than deleted or
37− -- replaced), where is it going?
38− }
39− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
40−
41−-- | Create a 'PatchMapWithMove', validating it
42−patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
43−patchMapWithMove m = if valid then Just $ PatchMapWithMove m else Nothing
44− where valid = forwardLinks == backwardLinks
45− forwardLinks = Map.mapMaybe _nodeInfo_to m
46− backwardLinks = Map.fromList $ catMaybes $ flip fmap (Map.toList m) $ \(to, v) ->
47− case _nodeInfo_from v of
48− From_Move from -> Just (from, to)
49− _ -> Nothing
50−
51−-- | Extract the internal representation of the 'PatchMapWithMove'
52−unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
53−unPatchMapWithMove (PatchMapWithMove p) = p
54−
55−-- | Warning: when using this function, you must ensure that the invariants of
56−-- 'PatchMapWithMove' are preserved; they will not be checked.
57−unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
58−unsafePatchMapWithMove = PatchMapWithMove
59−
60−-- | Describe how a key's new value should be produced
61−data From k v
62− = From_Insert v -- ^ Insert the given value here
63− | From_Delete -- ^ Delete the existing value, if any, from here
64− | From_Move !k -- ^ Move the value here from the given key
65− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
66−
67−-- | Describe where a key's old value will go. If this is 'Just', that means
68−-- the key's old value will be moved to the given other key; if it is 'Nothing',
69−-- that means it will be deleted.
70−type To = Maybe
71−
72−-- | Apply the insertions, deletions, and moves to a given 'Map'
73−instance Ord k => Patch (PatchMapWithMove k v) where
74− type PatchTarget (PatchMapWithMove k v) = Map k v
75− 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?
76− where insertions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
77− From_Insert v -> Just v
78− From_Move k -> Map.lookup k old
79− From_Delete -> Nothing
80− deletions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
81− From_Delete -> Just ()
82− _ -> Nothing
83−
84−-- | Returns all the new elements that will be added to the 'Map'
85−patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
86−patchMapWithMoveNewElements = Map.elems . patchMapWithMoveNewElementsMap
87−
88−patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
89−patchMapWithMoveNewElementsMap (PatchMapWithMove p) = Map.mapMaybe f p
90− where f ni = case _nodeInfo_from ni of
91− From_Insert v -> Just v
92− From_Move _ -> Nothing
93− From_Delete -> Nothing
94−
95−-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
96−-- its values using the given ordering function. The set keys of the 'Map' is
97−-- not changed.
98−patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
99−patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
100− where unsorted = Map.toList m
101− sorted = sortBy (cmp `on` snd) unsorted
102− f (to, _) (from, _) = if to == from then Nothing else
103− Just (from, to)
104− reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
105− g (to, _) (from, _) = if to == from then Nothing else
106− let Just movingTo = Map.lookup from reverseMapping
107− in Just (to, NodeInfo (From_Move from) $ Just movingTo)
108−
109−-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
110−-- will produce a 'Map' with the same values as the second 'Map' but with the
111−-- values sorted with the given ordering function.
112−patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
113−patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patch
114− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
115− newList = Map.toList newByIndexUnsorted
116− newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
117− insertsAndMoves :: Map k (NodeInfo k v)
118− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
119− let f k v = do
120− remainingValues <- get
121− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
122− then Map.delete v remainingValues
123− else Map.insert v remainingKeys remainingValues
124− case Map.lookup v remainingValues of
125− Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
126− Just fromKs ->
127− if k `Set.member` fromKs
128− then do
129− putRemainingKeys $ Set.delete k fromKs
130− return $ NodeInfo (From_Move k) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
131− else do
132− Just (fromK, remainingKeys) <- return $ Set.minView fromKs -- There's an existing value, but it's not here; move it here
133− putRemainingKeys remainingKeys
134− return $ NodeInfo (From_Move fromK) $ Just undefined
135− Map.traverseWithKey f newByIndex
136− unusedOldKeys = fold unusedValuesByValue
137− pointlessMove k = \case
138− From_Move k' | k == k' -> True
139− _ -> False
140− keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
141− then Just undefined
142− else Nothing
143− patch = unsafePatchMapWithMove $ Map.filterWithKey (\k -> not . pointlessMove k . _nodeInfo_from) $ Map.mergeWithKey (\k a _ -> Just $ nodeInfoSetTo (keyWasMoved k) a) (Map.mapWithKey $ \k -> nodeInfoSetTo $ keyWasMoved k) (Map.mapWithKey $ \k _ -> NodeInfo From_Delete $ keyWasMoved k) insertsAndMoves oldByIndex
144−
145−-- | Change the 'From' value of a 'NodeInfo'
146−nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
147−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
148−
149−-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
150−-- 'Applicative', 'Monad', etc.) action to get the new value
151−nodeInfoMapMFrom :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
152−nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
153−
154−-- | Set the 'To' field of a 'NodeInfo'
155−nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
156−nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
src/Reflex/PerformEvent/Base.hs+7−4
@@ -25,6 +25,7 @@ module Reflex.PerformEvent.Base
2525 ) where
2626
2727import Reflex.Class
28+import Reflex.Adjustable.Class
2829import Reflex.Host.Class
2930import Reflex.PerformEvent.Class
3031import Reflex.Requester.Base
@@ -60,14 +61,14 @@ deriving instance ReflexHost t => Monad (PerformEventT t m)
6061deriving instance ReflexHost t => MonadFix (PerformEventT t m)
6162deriving instance (ReflexHost t, MonadIO (HostFrame t)) => MonadIO (PerformEventT t m)
6263deriving instance (ReflexHost t, MonadException (HostFrame t)) => MonadException (PerformEventT t m)
63−deriving instance (ReflexHost t, Applicative m, Monoid a) => Monoid (PerformEventT t m a)
64−deriving instance (ReflexHost t, Applicative m, S.Semigroup a) => S.Semigroup (PerformEventT t m a)
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)
6566
6667instance (PrimMonad (HostFrame t), ReflexHost t) => PrimMonad (PerformEventT t m) where
6768 type PrimState (PerformEventT t m) = PrimState (HostFrame t)
6869 primitive = PerformEventT . lift . primitive
6970
70−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
7172 type Performable (PerformEventT t m) = HostFrame t
7273 {-# INLINABLE performEvent_ #-}
7374 performEvent_ = PerformEventT . requesting_
@@ -140,7 +141,7 @@ hostPerformEventT a = do
140141 case mToPerform of
141142 Nothing -> return [result']
142143 Just toPerform -> do
143− responses <- runHostFrame $ traverseRequesterData (\v -> Identity <$> v) toPerform
144+ responses <- runHostFrame $ traverseRequesterData (fmap Identity) toPerform
144145 mrt <- readRef responseTrigger
145146 let followupEventTriggers = case mrt of
146147 Just rt -> [rt :=> Identity responses]
@@ -163,6 +164,8 @@ instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
163164 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
164165 {-# INLINABLE headE #-}
165166 headE = PerformEventT . lift . headE
167+ {-# INLINABLE now #-}
168+ now = PerformEventT . lift $ now
166169
167170instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
168171 type Ref (PerformEventT t m) = Ref (HostFrame t)
src/Reflex/PerformEvent/Class.hs+6−2
@@ -5,11 +5,9 @@
55{-# LANGUAGE FlexibleContexts #-}
66{-# LANGUAGE FlexibleInstances #-}
77{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
98{-# LANGUAGE RankNTypes #-}
109{-# LANGUAGE ScopedTypeVariables #-}
1110{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
1311{-# LANGUAGE UndecidableInstances #-}
1412#ifdef USE_REFLEX_OPTIMIZER
1513{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,6 +21,7 @@ import Reflex.Class
2321import Reflex.TriggerEvent.Class
2422
2523import Control.Monad.Reader
24+import Control.Monad.Trans.Maybe (MaybeT (..))
2625
2726-- | 'PerformEvent' represents actions that can trigger other actions based on
2827-- 'Event's.
@@ -62,3 +61,8 @@ instance PerformEvent t m => PerformEvent t (ReaderT r m) where
6261 performEvent e = do
6362 r <- ask
6463 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+3−1
@@ -9,7 +9,6 @@
99{-# LANGUAGE RecursiveDo #-}
1010{-# LANGUAGE ScopedTypeVariables #-}
1111{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
1312{-# LANGUAGE UndecidableInstances #-}
1413#ifdef USE_REFLEX_OPTIMIZER
1514{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
@@ -23,6 +22,7 @@ module Reflex.PostBuild.Base
2322 ) where
2423
2524import Reflex.Class
25+import Reflex.Adjustable.Class
2626import Reflex.Host.Class
2727import Reflex.PerformEvent.Class
2828import Reflex.PostBuild.Class
@@ -83,6 +83,8 @@ instance MonadHold t m => MonadHold t (PostBuildT t m) where
8383 buildDynamic a0 = lift . buildDynamic a0
8484 {-# INLINABLE headE #-}
8585 headE = lift . headE
86+ {-# INLINABLE now #-}
87+ now = lift now
8688
8789instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
8890 type Performable (PostBuildT t m) = Performable m
src/Reflex/PostBuild/Class.hs−2
@@ -4,10 +4,8 @@
44{-# LANGUAGE DataKinds #-}
55{-# LANGUAGE FlexibleInstances #-}
66{-# LANGUAGE FunctionalDependencies #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
87{-# LANGUAGE ScopedTypeVariables #-}
98{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeOperators #-}
119{-# LANGUAGE UndecidableInstances #-}
1210#ifdef USE_REFLEX_OPTIMIZER
1311{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
src/Reflex/Profiled.hs+89−19
@@ -8,17 +8,28 @@
88{-# LANGUAGE StandaloneDeriving #-}
99{-# LANGUAGE TypeFamilies #-}
1010{-# 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.
1120module Reflex.Profiled where
1221
13−import Control.Lens hiding (children)
1422import Control.Monad
23+import Control.Monad.Exception
1524import Control.Monad.Fix
1625import Control.Monad.Primitive
1726import Control.Monad.Reader
1827import Control.Monad.Ref
1928import Control.Monad.State.Strict (StateT, execStateT, modify)
29+import Data.Bifunctor
2030import Data.Coerce
21−import Data.Dependent.Map (DMap, GCompare)
31+import Data.Dependent.Map (DMap)
32+import Data.GADT.Compare (GCompare)
2233import Data.FastMutableIntMap
2334import Data.IORef
2435import Data.List
@@ -26,18 +37,27 @@ import Data.Map (Map)
2637import qualified Data.Map.Strict as Map
2738import Data.Monoid ((<>))
2839import Data.Ord
40+import Data.Profunctor.Unsafe ((#.))
2941import qualified Data.Semigroup as S
3042import Data.Type.Coercion
3143import Foreign.Ptr
3244import GHC.Foreign
3345import GHC.IO.Encoding
3446import GHC.Stack
47+import Reflex.Adjustable.Class
48+import Reflex.BehaviorWriter.Class
3549import Reflex.Class
50+import Reflex.DynamicWriter.Class
51+import Reflex.EventWriter.Class
3652import Reflex.Host.Class
53+import Reflex.NotReady.Class
3754import Reflex.PerformEvent.Class
55+import Reflex.PostBuild.Class
56+import Reflex.Query.Class
57+import Reflex.Requester.Class
58+import Reflex.TriggerEvent.Class
3859
3960import System.IO.Unsafe
40−import Unsafe.Coerce
4161
4262data ProfiledTimeline t
4363
@@ -70,9 +90,9 @@ getCostCentreStack = go []
7090 go (cc : l) parent
7191
7292toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
73−toCostCentreTree ccs n = do
74− ccList <- getCostCentreStack ccs
75− return $ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty) ccList
93+toCostCentreTree ccs n =
94+ foldr (\cc child -> CostCentreTree 0 n $ Map.singleton cc child) (CostCentreTree n n mempty)
95+ <$> getCostCentreStack ccs
7696
7797getCostCentreTree :: IO CostCentreTree
7898getCostCentreTree = do
@@ -101,7 +121,8 @@ writeProfilingData :: FilePath -> IO ()
101121writeProfilingData p = do
102122 writeFile p =<< formatCostCentreTree =<< getCostCentreTree
103123
104−newtype ProfiledM m a = ProfiledM { runProfiledM :: m a } deriving (Functor, Applicative, Monad, MonadFix)
124+newtype ProfiledM m a = ProfiledM { runProfiledM :: m a }
125+ deriving (Functor, Applicative, Monad, MonadFix, MonadException, MonadAsyncException)
105126
106127profileEvent :: Reflex t => Event t a -> Event t a
107128profileEvent e = unsafePerformIO $ do
@@ -125,27 +146,32 @@ instance Reflex t => Reflex (ProfiledTimeline t) where
125146 push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
126147 pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
127148 pull = Behavior_Profiled . pull . coerce
128− merge :: forall k. GCompare k => DMap k (Event (ProfiledTimeline t)) -> Event (ProfiledTimeline t) (DMap k Identity)
129− merge = Event_Profiled . merge . (unsafeCoerce :: DMap k (Event (ProfiledTimeline t)) -> DMap k (Event t))
130− fan (Event_Profiled e) = EventSelector $ coerce $ select (fan $ profileEvent e)
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)
131154 switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
132155 coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
133156 current (Dynamic_Profiled d) = coerce $ current d
134157 updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
135158 unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
136159 unsafeBuildIncremental (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildIncremental a0 a'
137− mergeIncremental = Event_Profiled . mergeIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMap k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMap k (Event t)))
138− mergeIncrementalWithMove = Event_Profiled . mergeIncrementalWithMove . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMapWithMove k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMapWithMove k (Event t)))
160+ mergeIncrementalG nt res = Event_Profiled $ mergeIncrementalG (coerce nt) (coerce res)
161+ mergeIncrementalWithMoveG nt res = Event_Profiled $ mergeIncrementalWithMoveG (coerce nt) (coerce res)
139162 currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
140163 updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
141164 incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
142− behaviorCoercion (c :: Coercion a b) = case behaviorCoercion c :: Coercion (Behavior t a) (Behavior t b) of
143− Coercion -> unsafeCoerce (Coercion :: Coercion (Behavior (ProfiledTimeline t) a) (Behavior (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
144− eventCoercion (c :: Coercion a b) = case eventCoercion c :: Coercion (Event t a) (Event t b) of
145− Coercion -> unsafeCoerce (Coercion :: Coercion (Event (ProfiledTimeline t) a) (Event (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
146− dynamicCoercion (c :: Coercion a b) = case dynamicCoercion c :: Coercion (Dynamic t a) (Dynamic t b) of
147− Coercion -> unsafeCoerce (Coercion :: Coercion (Dynamic (ProfiledTimeline t) a) (Dynamic (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
148− mergeIntIncremental = Event_Profiled . mergeIntIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchIntMap (Event (ProfiledTimeline t) a)) -> Incremental t (PatchIntMap (Event t a)))
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)
149175 fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
150176
151177deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
@@ -158,10 +184,21 @@ instance MonadHold t m => MonadHold (ProfiledTimeline t) (ProfiledM m) where
158184 holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
159185 buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
160186 headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
187+ now = ProfiledM $ Event_Profiled <$> now
161188
162189instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
163190 sample (Behavior_Profiled b) = ProfiledM $ sample b
164191
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+
165202instance MonadTrans ProfiledM where
166203 lift = ProfiledM
167204
@@ -173,6 +210,39 @@ instance PerformEvent t m => PerformEvent (ProfiledTimeline t) (ProfiledM m) whe
173210 performEvent_ = lift . performEvent_ . coerce
174211 performEvent = lift . fmap coerce . performEvent . coerce
175212
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+
176246instance MonadRef m => MonadRef (ProfiledM m) where
177247 type Ref (ProfiledM m) = Ref m
178248 newRef = lift . newRef
src/Reflex/Pure.hs+38−27
@@ -5,6 +5,9 @@
55{-# LANGUAGE MultiParamTypeClasses #-}
66{-# LANGUAGE ScopedTypeVariables #-}
77{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE RankNTypes #-}
9+{-# LANGUAGE PolyKinds #-}
10+
811#ifdef USE_REFLEX_OPTIMIZER
912{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1013#endif
@@ -13,11 +16,13 @@
1316-- * MonadSample (Pure t) ((->) t)
1417-- * MonadHold (Pure t) ((->) t)
1518{-# OPTIONS_GHC -fno-warn-orphans #-}
16−
17−-- | 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
19−-- implementations of Reflex should produce the same results as this
20−-- implementation, although performance and laziness/strictness may differ.
19+-- |
20+-- Module: Reflex.Pure
21+-- Description:
22+-- This module provides a pure implementation of Reflex, which is intended to
23+-- serve as a reference for the semantics of the Reflex class. All
24+-- implementations of Reflex should produce the same results as this
25+-- implementation, although performance and laziness/strictness may differ.
2126module Reflex.Pure
2227 ( Pure
2328 , Behavior (..)
@@ -26,14 +31,10 @@ module Reflex.Pure
2631 , Incremental (..)
2732 ) where
2833
29−#if !MIN_VERSION_base(4,8,0)
30−import Control.Applicative
31−#endif
32−
3334import Control.Monad
34−import Data.Dependent.Map (DMap, GCompare)
35+import Data.Dependent.Map (DMap)
36+import Data.GADT.Compare (GCompare)
3537import qualified Data.Dependent.Map as DMap
36−import Data.Functor.Identity
3738import Data.IntMap (IntMap)
3839import qualified Data.IntMap as IntMap
3940import Data.Maybe
@@ -41,14 +42,15 @@ import Data.MemoTrie
4142import Data.Monoid
4243import Data.Type.Coercion
4344import Reflex.Class
45+import Data.Kind (Type)
4446
4547-- | A completely pure-functional 'Reflex' timeline, identifying moments in time
46−-- with the type @t@.
47−data Pure t
48+-- with the type @/t/@.
49+data Pure (t :: Type)
4850
49−-- | The Enum instance of t must be dense: for all x :: t, there must not exist
50−-- any y :: t such that pred x < y < x. The HasTrie instance will be used
51−-- exclusively to memoize functions of t, not for any of its other capabilities.
51+-- | The 'Enum' instance of @/t/@ must be dense: for all @/x :: t/@, there must not exist
52+-- any @/y :: t/@ such that @/'pred' x < y < x/@. The 'HasTrie' instance will be used
53+-- exclusively to memoize functions of @/t/@, not for any of its other capabilities.
5254instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
5355
5456 newtype Behavior (Pure t) a = Behavior { unBehavior :: t -> a }
@@ -77,17 +79,19 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
7779 -- [UNUSED_CONSTRAINT]: The following type signature for merge will produce a
7880 -- warning because the GCompare instance is not used; however, removing the
7981 -- GCompare instance produces a different warning, due to that constraint
80− -- being present in the original class definition
82+ -- being present in the original class definition.
8183
82− --merge :: GCompare k => DMap k (Event (Pure t)) -> Event (Pure t) (DMap k Identity)
83− merge events = Event $ memo $ \t ->
84− let currentOccurrences = DMap.mapMaybeWithKey (\_ (Event a) -> Identity <$> a t) events
84+ --mergeG :: GCompare k => (forall a. q a -> Event (Pure t) (v a))
85+ -- -> DMap k q -> Event (Pure t) (DMap k v)
86+ mergeG nt events = Event $ memo $ \t ->
87+ let currentOccurrences = DMap.mapMaybeWithKey (\_ q -> case nt q of Event a -> a t) events
8588 in if DMap.null currentOccurrences
8689 then Nothing
8790 else Just currentOccurrences
8891
89− fan :: GCompare k => Event (Pure t) (DMap k Identity) -> EventSelector (Pure t) k
90− fan e = EventSelector $ \k -> Event $ \t -> unEvent e t >>= fmap runIdentity . DMap.lookup k
92+-- The instance signature doeesn't compile, leave commented for documentation
93+-- fanG :: GCompare k => Event (Pure t) (DMap k v) -> EventSelectorG (Pure t) k v
94+ fanG e = EventSelectorG $ \k -> Event $ \t -> unEvent e t >>= DMap.lookup k
9195
9296 switch :: Behavior (Pure t) (Event (Pure t) a) -> Event (Pure t) a
9397 switch b = Event $ memo $ \t -> unEvent (unBehavior b t) t
@@ -110,8 +114,8 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
110114 --a) -> Incremental (Pure t) p a
111115 unsafeBuildIncremental readV0 p = Incremental $ \t -> (readV0 t, unEvent p t)
112116
113− mergeIncremental = mergeIncrementalImpl
114− mergeIncrementalWithMove = mergeIncrementalImpl
117+ mergeIncrementalG = mergeIncrementalImpl
118+ mergeIncrementalWithMoveG = mergeIncrementalImpl
115119
116120 currentIncremental i = Behavior $ \t -> fst $ unIncremental i t
117121
@@ -126,14 +130,17 @@ instance (Enum t, HasTrie t, Ord t) => Reflex (Pure t) where
126130 behaviorCoercion Coercion = Coercion
127131 eventCoercion Coercion = Coercion
128132 dynamicCoercion Coercion = Coercion
133+ incrementalCoercion Coercion Coercion = Coercion
129134
130135 fanInt e = EventSelectorInt $ \k -> Event $ \t -> unEvent e t >>= IntMap.lookup k
131136
132137 mergeIntIncremental = mergeIntIncrementalImpl
133138
134−mergeIncrementalImpl :: (PatchTarget p ~ DMap k (Event (Pure t)), GCompare k) => Incremental (Pure t) p -> Event (Pure t) (DMap k Identity)
135−mergeIncrementalImpl i = Event $ \t ->
136− let results = DMap.mapMaybeWithKey (\_ (Event e) -> Identity <$> e t) $ fst $ unIncremental i t
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)
142+mergeIncrementalImpl nt i = Event $ \t ->
143+ let results = DMap.mapMaybeWithKey (\_ q -> case nt q of Event e -> e t) $ fst $ unIncremental i t
137144 in if DMap.null results
138145 then Nothing
139146 else Just results
@@ -204,3 +211,7 @@ instance (Enum t, HasTrie t, Ord t) => MonadHold (Pure t) ((->) t) where
204211 Just x -> fromMaybe lastValue $ apply x lastValue
205212
206213 headE = slowHeadE
214+ now t = Event $ guard . (t ==)
215+
216+
217+
src/Reflex/Query/Base.hs+111−52
@@ -1,12 +1,14 @@
11{-# LANGUAGE FlexibleInstances #-}
22{-# LANGUAGE GeneralizedNewtypeDeriving #-}
33{-# LANGUAGE InstanceSigs #-}
4−{-# LANGUAGE KindSignatures #-}
4+{-# LANGUAGE LambdaCase #-}
55{-# LANGUAGE MultiParamTypeClasses #-}
66{-# LANGUAGE RankNTypes #-}
77{-# LANGUAGE ScopedTypeVariables #-}
88{-# LANGUAGE TypeFamilies #-}
99{-# LANGUAGE UndecidableInstances #-}
10+{-# LANGUAGE StandaloneDeriving #-}
11+
1012module Reflex.Query.Base
1113 ( QueryT (..)
1214 , runQueryT
@@ -14,33 +16,41 @@ module Reflex.Query.Base
1416 , mapQueryResult
1517 , dynWithQueryT
1618 , withQueryT
19+ , mapQueryT
1720 ) where
1821
1922import Control.Applicative (liftA2)
2023import Control.Monad.Exception
2124import Control.Monad.Fix
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
2227import Control.Monad.Reader
2328import Control.Monad.Ref
2429import Control.Monad.State.Strict
2530import Data.Align
26−import Data.Dependent.Map (DMap, DSum (..))
31+import Data.Dependent.Map (DMap)
2732import qualified Data.Dependent.Map as DMap
33+import Data.Dependent.Sum (DSum(..))
2834import Data.Foldable
2935import Data.Functor.Compose
3036import Data.Functor.Misc
37+import Data.GADT.Compare (GCompare)
38+import Data.IntMap (IntMap)
39+import qualified Data.IntMap as IntMap
3140import Data.Map (Map)
3241import qualified Data.Map as Map
3342import Data.Monoid ((<>))
3443import qualified Data.Semigroup as S
35−import Data.Some (Some)
36−import qualified Data.Some as Some
44+import Data.Some (Some(Some))
3745import Data.These
3846
3947import Reflex.Class
48+import Reflex.Adjustable.Class
49+import Reflex.DynamicWriter.Class
4050import Reflex.EventWriter.Base
4151import Reflex.EventWriter.Class
4252import Reflex.Host.Class
43−import qualified Reflex.Patch.MapWithMove as MapWithMove
53+import qualified Data.Patch.MapWithMove as MapWithMove
4454import Reflex.PerformEvent.Class
4555import Reflex.PostBuild.Class
4656import Reflex.Query.Class
@@ -48,7 +58,10 @@ import Reflex.Requester.Class
4858import Reflex.TriggerEvent.Class
4959
5060newtype QueryT t q m a = QueryT { unQueryT :: StateT [Behavior t q] (EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m)) a }
51− deriving (Functor, Applicative, Monad, MonadException, MonadFix, MonadIO, MonadHold t, MonadSample t, MonadAtomicRef)
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)
5265
5366runQueryT :: (MonadFix m, Additive q, Group q, Reflex t) => QueryT t q m a -> Dynamic t (QueryResult q) -> m (a, Incremental t (AdditivePatch q))
5467runQueryT (QueryT a) qr = do
@@ -63,30 +76,69 @@ getQueryTLoweredResultValue (QueryTLoweredResult (v, _)) = v
6376getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
6477getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
6578
66−{-
67−let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
68− sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
69− bs' = fmapCheap snd $ r'
70− patches = unsafeBuildIncremental (sampleBs bs0) $
71− flip pushCheap bs' $ \bs -> do
72− p <- (~~) <$> sampleBs bs <*> sample (currentIncremental patches)
73− return (Just (AdditivePatch p))
74−-}
75−
76−instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adjustable t m) => Adjustable t (QueryT t q m) where
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
7783 runWithReplace (QueryT a0) a' = do
7884 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
7985 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
8086 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
8187 bs' = fmapCheap snd $ r'
8288 bbs <- hold bs0 bs'
83− let patches = flip pushAlwaysCheap bs' $ \newBs -> do
89+ let patches = flip pushCheap bs' $ \newBs -> do
8490 oldBs <- sample bbs
85− (~~) <$> sampleBs newBs <*> sampleBs oldBs
91+ maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
8692 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
8793 QueryT $ lift $ tellEvent patches
8894 return (r0, fmapCheap fst r')
89− traverseDMapWithKeyWithAdjust :: forall (k :: * -> *) v v'. (DMap.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'))
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'))
90142 traverseDMapWithKeyWithAdjust f dm0 dm' = do
91143 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
92144 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -95,10 +147,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
95147 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
96148 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
97149 liftedBs0 :: Map (Some k) [Behavior t q]
98− liftedBs0 = Map.fromDistinctAscList $ (\(k :=> Compose r) -> (Some.This k, getQueryTLoweredResultWritten r)) <$> DMap.toList result0
150+ liftedBs0 = Map.fromDistinctAscList $ (\(k :=> Compose r) -> (Some k, getQueryTLoweredResultWritten r)) <$> DMap.toList result0
99151 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
100152 liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
101− Map.fromDistinctAscList $ (\(k :=> ComposeMaybe mr) -> (Some.This k, fmap (getQueryTLoweredResultWritten . getCompose) mr)) <$> DMap.toList p
153+ Map.fromDistinctAscList $ (\(k :=> ComposeMaybe mr) -> (Some k, fmap (getQueryTLoweredResultWritten . getCompose) mr)) <$> DMap.toList p
102154 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
103155 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
104156 accumBehaviors :: forall m'. MonadHold t m'
@@ -114,23 +166,24 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
114166 let p k bs = case Map.lookup k bs0 of
115167 Nothing -> case bs of
116168 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
117− Nothing -> return mempty
169+ Nothing -> return Nothing
118170 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
119− Just newBs -> sampleBs newBs
171+ Just newBs -> maskMempty <$> sampleBs newBs
120172 Just oldBs -> case bs of
121173 -- 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
122− Nothing -> negateG <$> sampleBs oldBs
174+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
123175 -- 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
124176 -- composed with the sampling the child's new state.
125− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
177+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
126178 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
127179 -- child patches and wrap them in AdditivePatch.
128− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
129− return (apply pbs bs0, Just patch)
180+ patch <- fold <$> Map.traverseWithKey p bs'
181+ return (apply pbs bs0, AdditivePatch <$> patch)
130182 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
131183 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
132184 return (liftedResult0, liftedResult')
133− traverseDMapWithKeyWithAdjustWithMove :: forall (k :: * -> *) v v'. (DMap.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'))
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'))
134187 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
135188 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
136189 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -138,10 +191,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
138191 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
139192 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
140193 liftedBs0 :: Map (Some k) [Behavior t q]
141− liftedBs0 = Map.fromDistinctAscList $ (\(k :=> Compose r) -> (Some.This k, getQueryTLoweredResultWritten r)) <$> DMap.toList result0
194+ liftedBs0 = Map.fromDistinctAscList $ (\(k :=> Compose r) -> (Some k, getQueryTLoweredResultWritten r)) <$> DMap.toList result0
142195 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
143196 liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
144− Map.fromDistinctAscList $ (\(k :=> mr) -> (Some.This k, fmap (fmap (getQueryTLoweredResultWritten . getCompose)) mr)) <$> DMap.toList p -}
197+ Map.fromDistinctAscList $ (\(k :=> mr) -> (Some k, fmap (fmap (getQueryTLoweredResultWritten . getCompose)) mr)) <$> DMap.toList p -}
145198 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
146199 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
147200 accumBehaviors' :: forall m'. MonadHold t m'
@@ -158,28 +211,28 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
158211 p k bs = case Map.lookup k bs0 of
159212 Nothing -> case MapWithMove._nodeInfo_from bs of
160213 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
161− MapWithMove.From_Delete -> return mempty
214+ MapWithMove.From_Delete -> return Nothing
162215 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
163− MapWithMove.From_Insert newBs -> sampleBs newBs
216+ MapWithMove.From_Insert newBs -> maskMempty <$> sampleBs newBs
164217 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
165− Nothing -> return mempty
166− Just newBs -> sampleBs newBs
218+ Nothing -> return Nothing
219+ Just newBs -> maskMempty <$> sampleBs newBs
167220 Just oldBs -> case MapWithMove._nodeInfo_from bs of
168221 -- 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
169− MapWithMove.From_Delete -> negateG <$> sampleBs oldBs
222+ MapWithMove.From_Delete -> maskMempty . negateG <$> sampleBs oldBs
170223 -- 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
171224 -- composed with the sampling the child's new state.
172− MapWithMove.From_Insert newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
225+ MapWithMove.From_Insert newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
173226 MapWithMove.From_Move k'
174− | k' == k -> return mempty
227+ | k' == k -> return Nothing
175228 | otherwise -> case Map.lookup k' bs0 of
176229 -- If we are moving from a non-existent key, that is a delete
177− Nothing -> negateG <$> sampleBs oldBs
178− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
230+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
231+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
179232 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
180233 -- child patches and wrap them in AdditivePatch.
181− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
182− return (apply pbs bs0, Just patch)
234+ patch <- fold <$> Map.traverseWithKey p bs'
235+ return (apply pbs bs0, AdditivePatch <$> patch)
183236 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
184237 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
185238 return (liftedResult0, liftedResult')
@@ -187,6 +240,13 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
187240instance MonadTrans (QueryT t q) where
188241 lift = QueryT . lift . lift . lift
189242
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+
190250instance PostBuild t m => PostBuild t (QueryT t q m) where
191251 getPostBuild = lift getPostBuild
192252
@@ -221,13 +281,6 @@ instance (Monoid a, Monad m) => Monoid (QueryT t q m a) where
221281instance (S.Semigroup a, Monad m) => S.Semigroup (QueryT t q m a) where
222282 (<>) = liftA2 (S.<>)
223283
224−
225−mapQuery :: QueryMorphism q q' -> q -> q'
226−mapQuery = _queryMorphism_mapQuery
227−
228−mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
229−mapQueryResult = _queryMorphism_mapQueryResult
230−
231284-- | withQueryT's QueryMorphism argument needs to be a group homomorphism in order to behave correctly
232285withQueryT :: (MonadFix m, PostBuild t m, Group q, Group q', Additive q, Additive q', Query q')
233286 => QueryMorphism q q'
@@ -241,6 +294,10 @@ withQueryT f a = do
241294 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
242295 return result
243296
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+
244301-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
245302dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
246303 => Dynamic t (QueryMorphism q q')
@@ -253,7 +310,7 @@ dynWithQueryT f q = do
253310 return result
254311 where zipDynIncrementalWith g da ib =
255312 let eab = align (updated da) (updatedIncremental ib)
256− ec = flip push eab $ \o -> case o of
313+ ec = flip push eab $ \case
257314 This a -> do
258315 aOld <- sample $ current da
259316 b <- sample $ currentIncremental ib
@@ -274,8 +331,7 @@ instance (Monad m, Group q, Additive q, Query q, Reflex t) => MonadQuery t q (Qu
274331 askQueryResult = QueryT ask
275332 queryIncremental q = do
276333 tellQueryIncremental q
277− r <- askQueryResult
278− return $ zipDynWith crop (incrementalToDynamic q) r
334+ zipDynWith crop (incrementalToDynamic q) <$> askQueryResult
279335
280336instance Requester t m => Requester t (QueryT t q m) where
281337 type Request (QueryT t q m) = Request m
@@ -285,3 +341,6 @@ instance Requester t m => Requester t (QueryT t q m) where
285341
286342instance EventWriter t w m => EventWriter t w (QueryT t q m) where
287343 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.hs+92−11
@@ -1,11 +1,18 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveDataTypeable #-}
23{-# LANGUAGE FlexibleContexts #-}
34{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE FunctionalDependencies #-}
56{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
77{-# LANGUAGE TypeFamilies #-}
88{-# 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.
916module Reflex.Query.Class
1017 ( Query (..)
1118 , QueryMorphism (..)
@@ -15,29 +22,94 @@ module Reflex.Query.Class
1522 , MonadQuery (..)
1623 , tellQueryDyn
1724 , queryDyn
25+ , subQuery
26+ , mapQuery
27+ , mapQueryResult
1828 ) where
1929
30+import Control.Category (Category)
31+import qualified Control.Category as Cat
2032import Control.Monad.Reader
2133import Data.Bits
2234import Data.Data
2335import Data.Ix
24−import Data.Semigroup
36+import Data.Map.Monoidal (MonoidalMap)
37+import qualified Data.Map.Monoidal as MonoidalMap
38+import Data.Semigroup (Semigroup(..))
2539import Foreign.Storable
40+import Data.Void
41+import Data.Monoid hiding ((<>))
42+import Control.Applicative
2643
2744import Reflex.Class
2845
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'.
2950class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
3051 type QueryResult a :: *
3152 crop :: a -> QueryResult a -> QueryResult a
3253
33−-- | NB: QueryMorphism's must be group homomorphisms when acting on the query type
34−-- and compatible with the query relationship when acting on the query result
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.
3591data QueryMorphism q q' = QueryMorphism
3692 { _queryMorphism_mapQuery :: q -> q'
3793 , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
3894 }
3995
40−-- | This type keeps track of the multiplicity of elements of the view selector that are being used by the app
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'
41113newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
42114 deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
43115
@@ -53,25 +125,34 @@ instance Group SelectedCount where
53125
54126instance Additive SelectedCount
55127
56−-- | The Semigroup/Monoid/Group instances for a ViewSelector should use this function which returns Nothing if the result is 0. This allows the pruning of leaves that are no longer wanted.
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.
57131combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
58132combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
59133
60−class (Group q, Additive q, Query q) => MonadQuery t q m | m -> q t where
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
61137 tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
62138 askQueryResult :: m (Dynamic t (QueryResult q))
63139 queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
64140
65−instance (Monad m, MonadQuery t q m) => MonadQuery t q (ReaderT r m) where
141+instance MonadQuery t q m => MonadQuery t q (ReaderT r m) where
66142 tellQueryIncremental = lift . tellQueryIncremental
67143 askQueryResult = lift askQueryResult
68144 queryIncremental = lift . queryIncremental
69145
146+-- | Produce and send an 'Incremental' 'Query' from a 'Dynamic' 'Query'.
70147tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
71148tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
72149
73−queryDyn :: (Reflex t, Monad m, MonadQuery t q m) => Dynamic t q -> m (Dynamic t (QueryResult q))
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))
74152queryDyn q = do
75153 tellQueryDyn q
76− r <- askQueryResult
77− return $ zipDynWith crop q r
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+198−19
@@ -1,6 +1,7 @@
11-- | This module provides 'RequesterT', the standard implementation of
22-- 'Requester'.
33{-# LANGUAGE AllowAmbiguousTypes #-}
4+{-# LANGUAGE ApplicativeDo #-}
45{-# LANGUAGE CPP #-}
56{-# LANGUAGE EmptyDataDecls #-}
67{-# LANGUAGE ExistentialQuantification #-}
@@ -21,17 +22,25 @@
2122module Reflex.Requester.Base
2223 ( RequesterT (..)
2324 , runRequesterT
25+ , withRequesterT
2426 , runWithReplaceRequesterTWith
2527 , traverseIntMapWithKeyWithAdjustRequesterTWith
2628 , traverseDMapWithKeyWithAdjustRequesterTWith
2729 , RequesterData
2830 , RequesterDataKey
2931 , traverseRequesterData
32+ , forRequesterData
3033 , requesterDataToList
3134 , singletonRequesterData
35+ , matchResponsesWithRequests
36+ , matchResponseMapWithRequests
37+ , multiEntry
38+ , unMultiEntry
39+ , requesting'
3240 ) where
3341
3442import Reflex.Class
43+import Reflex.Adjustable.Class
3544import Reflex.Dynamic
3645import Reflex.Host.Class
3746import Reflex.PerformEvent.Class
@@ -42,13 +51,17 @@ import Reflex.TriggerEvent.Class
4251import Control.Applicative (liftA2)
4352import Control.Monad.Exception
4453import Control.Monad.Identity
54+import Control.Monad.Morph
55+import Control.Monad.Primitive
4556import Control.Monad.Reader
4657import Control.Monad.Ref
4758import Control.Monad.State.Strict
4859import Data.Bits
4960import Data.Coerce
50−import Data.Dependent.Map (DMap, DSum (..))
61+import Data.Constraint
62+import Data.Dependent.Map (DMap)
5163import qualified Data.Dependent.Map as DMap
64+import Data.Dependent.Sum (DSum (..))
5265import Data.Functor.Compose
5366import Data.Functor.Misc
5467import Data.IntMap.Strict (IntMap)
@@ -58,8 +71,7 @@ import qualified Data.Map as Map
5871import Data.Monoid ((<>))
5972import Data.Proxy
6073import qualified Data.Semigroup as S
61−import Data.Some (Some)
62−import qualified Data.Some as Some
74+import Data.Some (Some(Some))
6375import Data.Type.Equality
6476import Data.Unique.Tag
6577
@@ -72,19 +84,51 @@ newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
7284
7385newtype RequesterData f = RequesterData (TagMap (Entry f))
7486
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
7590data RequesterDataKey a where
7691 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
7792 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
78− RequesterDataKey_Multi2 :: {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
93+ RequesterDataKey_Multi2 :: GCompare k => {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
7994 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
8095
8196singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
8297singletonRequesterData rdk v = case rdk of
8398 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
8499 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
85− RequesterDataKey_Multi2 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ Map.singleton k' $ 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+ }
86104 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
87105
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+
88132requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
89133requesterDataToList (RequesterData m) = do
90134 k :=> Entry e <- tagMapToList m
@@ -94,11 +138,12 @@ requesterDataToList (RequesterData m) = do
94138 (k', e') <- IntMap.toList e
95139 k'' :=> e'' <- requesterDataToList e'
96140 return $ RequesterDataKey_Multi k k' k'' :=> e''
97− MyTagType_Multi2 -> do
98− (k', e') <- Map.toList e
99− (k'', e'') <- IntMap.toList e'
100− k''' :=> e''' <- requesterDataToList e''
101− return $ RequesterDataKey_Multi2 k 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'''
102147 MyTagType_Multi3 -> do
103148 (k', e') <- IntMap.toList e
104149 (k'', e'') <- IntMap.toList e'
@@ -126,9 +171,19 @@ traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWith
126171 go k (Entry request) = Entry <$> case myKeyType k of
127172 MyTagType_Single -> f request
128173 MyTagType_Multi -> traverse (traverseRequesterData f) request
129− MyTagType_Multi2 -> traverse (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+ }
130181 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
131182
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+
132187data MyTagType :: * -> * where
133188 MyTagType_Single :: MyTagType (Single a)
134189 MyTagType_Multi :: MyTagType Multi
@@ -166,9 +221,14 @@ instance MyTagTypeOffset Multi3 where
166221type family EntryContents request a where
167222 EntryContents request (Single a) = request a
168223 EntryContents request Multi = IntMap (RequesterData request)
169− EntryContents request (Multi2 k) = Map (Some k) (IntMap (RequesterData request))
224+ EntryContents request (Multi2 k) = Multi2Contents k request
170225 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
171226
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+
172232newtype Entry request x = Entry { unEntry :: EntryContents request x }
173233
174234{-# INLINE singleEntry #-}
@@ -238,6 +298,10 @@ deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
238298deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
239299deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
240300
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+
241305-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
242306instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
243307 mempty = pure mempty
@@ -251,7 +315,6 @@ instance (S.Semigroup a, Monad m) => S.Semigroup (RequesterT t request response
251315-- requests are made, and responses should be provided in the input 'Event'.
252316-- The 'Tag' keys will be used to return the responses to the same place the
253317-- requests were issued.
254−
255318runRequesterT :: (Reflex t, Monad m)
256319 => RequesterT t request response m a
257320 -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
@@ -261,6 +324,20 @@ runRequesterT (RequesterT a) responses = do
261324 coerceEvent responses
262325 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
263326
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
340+
264341instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
265342 type Request (RequesterT t request response m) = request
266343 type Response (RequesterT t request response m) = response
@@ -280,7 +357,7 @@ tagRequest req = do
280357 return t
281358
282359{-# INLINE responseFromTag #-}
283−responseFromTag :: (Monad m, Reflex t) => MyTagWrap response (Entry response x) -> RequesterT t request response m (Event t (Entry response x))
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))
284361responseFromTag (MyTagWrap t) = do
285362 responses :: EventSelectorInt t Any <- RequesterT ask
286363 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
@@ -288,6 +365,9 @@ responseFromTag (MyTagWrap t) = do
288365instance MonadTrans (RequesterT t request response) where
289366 lift = RequesterT . lift . lift
290367
368+instance MFunctor (RequesterT t request response) where
369+ hoist f = RequesterT . hoist (hoist f) . unRequesterT
370+
291371instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
292372 type Performable (RequesterT t request response m) = Performable m
293373 performEvent_ = lift . performEvent_
@@ -315,7 +395,7 @@ instance (Reflex t, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (
315395 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjust f dm0 dm') mapPatchDMap weakenPatchDMapWith patchMapNewElementsMap mergeMapIncremental
316396 traverseDMapWithKeyWithAdjustWithMove = traverseDMapWithKeyWithAdjustRequesterTWith (\f dm0 dm' -> lift $ traverseDMapWithKeyWithAdjustWithMove f dm0 dm') mapPatchDMapWithMove weakenPatchDMapWithMoveWith patchMapWithMoveNewElementsMap mergeMapIncrementalWithMove
317397
318−requesting' :: (MyTagTypeOffset x, Monad m, Reflex t) => Event t (Entry request x) -> RequesterT t request response m (Event t (Entry response x))
398+requesting' :: (MyTagTypeOffset x, Monad m) => Event t (Entry request x) -> RequesterT t request response m (Event t (Entry response x))
319399requesting' = responseFromTag . castMyTagWrap <=< tagRequest
320400
321401{-# INLINABLE runWithReplaceRequesterTWith #-}
@@ -364,7 +444,7 @@ traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIn
364444 pack = Entry
365445 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
366446 f' k (n, v) = do
367− (result, myRequests) <- runRequesterT (f k v) $ fmapMaybeCheap (IntMap.lookup n) $ selectInt responses k --TODO: Instead of doing fmapMaybeCheap, can we share a fanInt across all instances of a given key, or at least the ones that are adjacent in time?
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?
368448 return (fmapCheap (IntMap.singleton n) myRequests, result)
369449 ndm' <- numberOccurrencesFrom 1 dm'
370450 (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
@@ -407,12 +487,12 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
407487 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
408488 responses = fanMap $ fmapCheap unpack response
409489 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
410− unpack = unEntry
490+ unpack = _multi2Contents_values . unEntry
411491 pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
412− pack = Entry
492+ pack m = Entry $ Multi2Contents { _multi2Contents_values = m, _multi2Contents_dict = Dict }
413493 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
414494 f' k (Compose (n, v)) = do
415− (result, myRequests) <- runRequesterT (f k v) $ fmapMaybeCheap (IntMap.lookup n) $ select responses (Const2 (Some.This k))
495+ (result, myRequests) <- runRequesterT (f k v) $ mapMaybeCheap (IntMap.lookup n) $ select responses (Const2 (Some k))
416496 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
417497 ndm' <- numberOccurrencesFrom 1 dm'
418498 (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
@@ -426,3 +506,102 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
426506 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
427507 requests <- holdIncremental requests0 requests'
428508 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−1
@@ -6,7 +6,6 @@
66{-# LANGUAGE CPP #-}
77{-# LANGUAGE FlexibleInstances #-}
88{-# LANGUAGE FunctionalDependencies #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
109{-# LANGUAGE RecursiveDo #-}
1110{-# LANGUAGE TypeFamilies #-}
1211{-# LANGUAGE UndecidableInstances #-}
src/Reflex/Spider.hs+5−2
@@ -1,6 +1,9 @@
11{-# LANGUAGE CPP #-}
2−-- | This module exports all of the user-facing functionality of the 'Spider'
3−-- 'Reflex' engine
2+-- |
3+-- Module:
4+-- Reflex.Spider
5+-- Description:
6+-- This module exports all of the user-facing functionality of the 'Spider' 'Reflex' engine
47module Reflex.Spider
58 ( Spider
69 , SpiderTimeline
src/Reflex/Spider/Internal.hs+779−479
@@ -9,39 +9,49 @@
99{-# LANGUAGE GADTs #-}
1010{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1111{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MagicHash #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE MultiWayIf #-}
1512{-# LANGUAGE RankNTypes #-}
1613{-# LANGUAGE RoleAnnotations #-}
1714{-# LANGUAGE ScopedTypeVariables #-}
1815{-# LANGUAGE TypeFamilies #-}
1916{-# LANGUAGE TypeOperators #-}
2017{-# LANGUAGE UndecidableInstances #-}
18+{-# LANGUAGE PolyKinds #-}
19+{-# LANGUAGE DeriveFunctor #-}
20+{-# LANGUAGE StandaloneDeriving #-}
21+{-# LANGUAGE InstanceSigs #-}
22+{-# LANGUAGE MultiWayIf #-}
23+
2124#ifdef USE_REFLEX_OPTIMIZER
2225{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
2326#endif
27+{-# OPTIONS_GHC -Wunused-binds #-}
2428-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
2529-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
2630module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
2731
28−import Control.Applicative
32+#if MIN_VERSION_base(4,10,0)
33+import Control.Applicative (liftA2)
34+#endif
2935import Control.Concurrent
3036import Control.Exception
31−import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
37+import Control.Monad hiding (forM, forM_, mapM, mapM_)
3238import Control.Monad.Exception
33−import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence)
39+import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
3440import Control.Monad.Primitive
35−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
3644import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
3747import Data.Align
3848import Data.Coerce
39−import Data.Dependent.Map (DMap, DSum (..))
49+import Data.Dependent.Map (DMap)
4050import qualified Data.Dependent.Map as DMap
51+import Data.Dependent.Sum (DSum (..))
4152import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
4253import qualified Data.FastMutableIntMap as FastMutableIntMap
4354import Data.Foldable hiding (concat, elem, sequence_)
44−import Data.Function
4555import Data.Functor.Constant
4656import Data.Functor.Misc
4757import Data.Functor.Product
@@ -49,59 +59,73 @@ import Data.GADT.Compare
4959import Data.IntMap.Strict (IntMap)
5060import qualified Data.IntMap.Strict as IntMap
5161import Data.IORef
52−import Data.List hiding (foldl')
53−import Data.Maybe
54−import Data.Monoid ((<>))
62+import Data.Kind (Type)
63+import Data.Maybe hiding (mapMaybe)
64+import Data.Monoid (mempty, (<>))
5565import Data.Proxy
5666import Data.These
5767import Data.Traversable
58−import Data.Word
59−import GHC.Exts
68+import Data.Type.Equality ((:~:)(Refl))
69+import Data.Witherable (Filterable, mapMaybe)
70+import GHC.Exts hiding (toList)
6071import GHC.IORef (IORef (..))
6172import GHC.Stack
6273import Reflex.FastWeak
63−import Reflex.FunctorMaybe
6474import System.IO.Unsafe
6575import System.Mem.Weak
6676import Unsafe.Coerce
6777
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+
6887#ifdef DEBUG_CYCLES
6988import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
89+#endif
90+
7091import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
7192import qualified Data.List.NonEmpty as NonEmpty
72−import Data.Monoid (mempty)
7393import Data.Tree (Forest, Tree (..), drawForest)
74−#endif
94+import Data.List (isPrefixOf)
7595
76−import Data.FastWeakBag (FastWeakBag)
96+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
7797import qualified Data.FastWeakBag as FastWeakBag
98+
7899import Data.Reflection
79−import Data.Some (Some)
80−import qualified Data.Some as Some
100+import Data.Some (Some(Some))
81101import Data.Type.Coercion
102+import Data.Profunctor.Unsafe ((#.), (.#))
82103import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
83104import qualified Data.WeakBag as WeakBag
84105import qualified Reflex.Class
85106import qualified Reflex.Class as R
86107import qualified Reflex.Host.Class
87108import Reflex.NotReady.Class
88−import Reflex.Patch
89−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
90−
91−-- Note: must come last to silence warnings due to AMP on GHC < 7.10
92−import Prelude hiding (any, concat, mapM, mapM_, sequence)
109+import Data.Patch
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
111+import Reflex.PerformEvent.Base (PerformEventT)
93112
94113#ifdef DEBUG_TRACE_EVENTS
95114import qualified Data.ByteString.Char8 as BS8
96115import System.IO (stderr)
116+import Data.List (isPrefixOf)
97117#endif
98118
99−#ifdef DEBUG_TRACE_EVENTS
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
100122
123+#ifdef DEBUG_TRACE_EVENTS
101124withStackOneLine :: (BS8.ByteString -> a) -> a
102125withStackOneLine expr = unsafePerformIO $ do
103126 stack <- currentCallStack
104− return (expr (BS8.pack (unwords (reverse stack))))
127+ return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
128+ where dropInternal = filterStack "Reflex.Spider.Internal"
105129
106130#endif
107131
@@ -112,28 +136,42 @@ debugInvalidateHeight :: Bool
112136debugInvalidate :: Bool
113137
114138#ifdef DEBUG
115−
116139#define DEBUG_NODEIDS
117140
141+#ifdef DEBUG_TRACE_PROPAGATION
118142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
119146
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
120150debugInvalidateHeight = False
151+#endif
121152
153+#ifdef DEBUG_TRACE_INVALIDATION
122154debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
123158
124159class HasNodeId a where
125160 getNodeId :: a -> Int
126161
127−instance HasNodeId (Hold x p a) where
128− getNodeId = holdNodeId
162+instance HasNodeId (CacheSubscribed x a) where
163+ getNodeId = _cacheSubscribed_nodeId
164+
165+instance HasNodeId (FanInt x a) where
166+ getNodeId = _fanInt_nodeId
129167
130−instance HasNodeId (PushSubscribed x a b) where
131− getNodeId = pushSubscribedNodeId
168+instance HasNodeId (Hold x p) where
169+ getNodeId = holdNodeId
132170
133171instance HasNodeId (SwitchSubscribed x a) where
134172 getNodeId = switchSubscribedNodeId
135173
136−instance HasNodeId (FanSubscribed x a) where
174+instance HasNodeId (FanSubscribed x v a) where
137175 getNodeId = fanSubscribedNodeId
138176
139177instance HasNodeId (CoincidenceSubscribed x a) where
@@ -147,41 +185,16 @@ instance HasNodeId (Pull x a) where
147185
148186{-# INLINE showNodeId #-}
149187showNodeId :: HasNodeId a => a -> String
150−showNodeId = ("#"<>) . show . getNodeId
151−
152−showSubscriberType :: Subscriber x a -> String
153−showSubscriberType = \case
154− SubscriberPush _ _ -> "SubscriberPush"
155− SubscriberMerge _ _ -> "SubscriberMerge"
156− SubscriberFan _ -> "SubscriberFan"
157− SubscriberMergeChange _ -> "SubscriberMergeChange"
158− SubscriberHold _ -> "SubscriberHold"
159− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
160− SubscriberSwitch _ -> "SubscriberSwitch"
161− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
162− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
163− SubscriberHandle -> "SubscriberHandle"
164−
165−showEventType :: Event x a -> String
166−showEventType = \case
167− EventRoot _ _ -> "EventRoot"
168− EventNever -> "EventNever"
169− EventPush _ -> "EventPush"
170− EventMerge _ -> "EventMerge"
171− EventFan _ _ -> "EventFan"
172− EventSwitch _ -> "EventSwitch"
173− EventCoincidence _ -> "EventCoincidence"
174− EventHold _ -> "EventHold"
175− EventDyn _ -> "EventDyn"
176− EventHoldIdentity _ -> "EventHoldIdentity"
177− EventDynIdentity _ -> "EventDynIdentity"
188+showNodeId = showNodeId' . getNodeId
189+
190+showNodeId' :: Int -> String
191+showNodeId' = ("#"<>) . show
192+
178193
179194#else
180195
181196debugPropagate = False
182−
183197debugInvalidateHeight = False
184−
185198debugInvalidate = False
186199
187200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -189,6 +202,10 @@ debugInvalidate = False
189202showNodeId :: a -> String
190203showNodeId _ = ""
191204
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
208+
192209#endif
193210
194211#ifdef DEBUG_NODEIDS
@@ -198,12 +215,6 @@ nextNodeIdRef = unsafePerformIO $ newIORef 1
198215
199216newNodeId :: IO Int
200217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
201−
202−{-# NOINLINE unsafeNodeId #-}
203−unsafeNodeId :: a -> Int
204−unsafeNodeId a = unsafePerformIO $ do
205− touch a
206− newNodeId
207218#endif
208219
209220--------------------------------------------------------------------------------
@@ -242,7 +253,7 @@ subscribeAndRead = unEvent
242253{-# INLINE [1] pushCheap #-}
243254pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
244255pushCheap !f e = Event $ \sub -> do
245− (subscription, occ) <- subscribeAndRead e $ sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
246257 { subscriberPropagate = \a -> do
247258 mb <- f a
248259 mapM_ (subscriberPropagate sub) mb
@@ -261,10 +272,10 @@ terminalSubscriber p = Subscriber
261272
262273-- | Subscribe to an Event only for the duration of one occurrence
263274{-# INLINE subscribeAndReadHead #-}
264−subscribeAndReadHead :: Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
275+subscribeAndReadHead :: HasSpiderTimeline x => Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
265276subscribeAndReadHead e sub = do
266277 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
267− (subscription, occ) <- subscribeAndRead e $ sub
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
268279 { subscriberPropagate = \a -> do
269280 liftIO $ unsubscribe =<< readIORef subscriptionRef
270281 subscriberPropagate sub a
@@ -275,24 +286,42 @@ subscribeAndReadHead e sub = do
275286 return (subscription, occ)
276287
277288--TODO: Make this lazy in its input event
278−headE :: (MonadIO m, Defer (SomeMergeInit x) m) => Event x a -> m (Event x a)
289+headE :: (MonadIO m, Defer (SomeMergeInit x) m, HasSpiderTimeline x) => Event x a -> m (Event x a)
279290headE originalE = do
280291 parent <- liftIO $ newIORef $ Just originalE
281292 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
282293 let clearParent = liftIO $ writeIORef parent Nothing
283− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
284295 when (isJust occ) clearParent
285− return $ Event $ \sub -> do
296+ return $ Event $ \sub ->
286297 liftIO (readIORef parent) >>= \case
287− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
298+ Nothing -> subscribeAndReadNever
288299 Just e -> subscribeAndReadHead e sub
289300
290301data CacheSubscribed x a
291302 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
292303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
293304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
294308 }
295309
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+
296325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
297326-- repeatedly
298327--
@@ -307,27 +336,33 @@ cacheEvent e =
307336#else
308337 Event $
309338#endif
310− let mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
311− !mSubscribedRef = unsafeNewIORef e emptyFastWeak
312− in \sub -> {-# SCC "cacheEvent" #-} do
339+ unsafePerformIO $ do
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
341+ <- newIORef emptyFastWeak
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
313343#ifdef DEBUG_TRACE_EVENTS
314344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
315345#endif
316346 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
317347 Just subscribedTicket -> return subscribedTicket
318348 Nothing -> do
349+#ifdef DEBUG_NODEIDS
350+ nodeId <- liftIO newNodeId
351+#endif
319352 subscribers <- liftIO FastWeakBag.empty
320353 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
321357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
322− { subscriberPropagate = \a -> do
323− liftIO $ writeIORef occRef $ Just a
324− scheduleClear occRef
325− propagateFast a subscribers
326− , subscriberInvalidateHeight = \old -> do
327− FastWeakBag.traverse subscribers $ invalidateSubscriberHeight old
328− , subscriberRecalculateHeight = \new -> do
329− FastWeakBag.traverse subscribers $ recalculateSubscriberHeight new
330− }
358+#endif
359+ { subscriberPropagate = \a -> do
360+ liftIO $ writeIORef occRef (Just a)
361+ scheduleClear occRef
362+ propagateFast a subscribers
363+ , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
364+ , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
365+ }
331366 when (isJust occ) $ do
332367 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
333368 scheduleClear occRef
@@ -335,29 +370,45 @@ cacheEvent e =
335370 { _cacheSubscribed_subscribers = subscribers
336371 , _cacheSubscribed_parent = parentSub
337372 , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
338376 }
339377 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
340378 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
341379 return subscribedTicket
342− liftIO $ do
343− subscribed <- getFastWeakTicketValue subscribedTicket
344− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
345− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
346− let es = EventSubscription
347− { _eventSubscription_unsubscribe = do
348− FastWeakBag.remove ticket
349− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
350− when isEmpty $ do
351− writeIORef mSubscribedRef emptyFastWeak
352− unsubscribe $ _cacheSubscribed_parent subscribed
353− touch ticket
354− touch subscribedTicket
355− , _eventSubscription_subscribed = EventSubscribed
356− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
357− , eventSubscribedRetained = toAny subscribedTicket
358− }
359− }
360− return (es, occ)
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
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)
411+
361412
362413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
363414subscribe e s = fst <$> subscribeAndRead e s
@@ -369,13 +420,16 @@ wrap tag getSpecificSubscribed sub = do
369420 let es = tag subd
370421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
371422
372−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
373424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
374425
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
375429eventNever :: Event x a
376−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
430+eventNever = Event $ const subscribeAndReadNever
377431
378−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)
379433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
380434
381435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
@@ -384,7 +438,7 @@ eventSwitch !s = Event $ wrap eventSubscribedSwitch $ getSwitchSubscribed s
384438eventCoincidence :: HasSpiderTimeline x => Coincidence x a -> Event x a
385439eventCoincidence !c = Event $ wrap eventSubscribedCoincidence $ getCoincidenceSubscribed c
386440
387−eventHold :: HasSpiderTimeline x => Hold x p -> Event x p
441+eventHold :: Hold x p -> Event x p
388442eventHold !h = Event $ subscribeHoldEvent h
389443
390444eventDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Event x p
@@ -410,16 +464,6 @@ data Subscriber x a = Subscriber
410464 , subscriberRecalculateHeight :: !(Height -> IO ())
411465 }
412466
413−--TODO: Move this comment to WeakBag
414−-- These function are constructor functions that are marked NOINLINE so they are
415−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
416−-- so any weak references that are attached to the constructors will have their
417−-- finalizer run. Using the opaque constructor, does not see the
418−-- constructor application, so it behaves like an IORef and cannot be fused away.
419−--
420−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
421−-- the weak pointer to it in some cases.
422−
423467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
424468newSubscriberHold h = return $ Subscriber
425469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -427,85 +471,68 @@ newSubscriberHold h = return $ Subscriber
427471 , subscriberRecalculateHeight = \_ -> return ()
428472 }
429473
430−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
431−newSubscriberFan subscribed = return $ Subscriber
474+newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
475+newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
432476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
433477 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
434− 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"
435479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
436480 scheduleClear $ fanSubscribedOccurrence subscribed
437− let f _ (Pair (Identity v) subsubs) = do
481+ let f _ (Pair v subsubs) = do
438482 propagate v $ _fanSubscribedChildren_list subsubs
439483 return $ Constant ()
440484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
441485 return ()
442486 , subscriberInvalidateHeight = \old -> do
443− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
444487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
445− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
446− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
447489 , subscriberRecalculateHeight = \new -> do
448− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
449490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
450− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
451− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
452492 }
453493
454494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
455−newSubscriberSwitch subscribed = return $ Subscriber
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
456496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
457− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
458497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
459498 scheduleClear $ switchSubscribedOccurrence subscribed
460499 propagate a $ switchSubscribedSubscribers subscribed
461500 , subscriberInvalidateHeight = \_ -> do
462− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
463501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
464502 when (oldHeight /= invalidHeight) $ do
465503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
466− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
467− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
468− , subscriberRecalculateHeight = \new -> do
469− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
470− updateSwitchHeight new subscribed
471− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
472− }
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
506+ }
473507
474508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
475−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
476510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
477− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
478511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
479512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
480513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
481514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
482515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
483517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
484518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
485519 case occ of
486− Nothing -> do
520+ Nothing ->
487521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
488522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
489− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
490− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
491525 Just o -> do -- Since it's already firing, no need to adjust height
492526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
493527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
494528 propagate o $ coincidenceSubscribedSubscribers subscribed
495− , subscriberInvalidateHeight = \_ -> do
496− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
497− invalidateCoincidenceHeight subscribed
498− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
499− , subscriberRecalculateHeight = \_ -> do
500− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
501− recalculateCoincidenceHeight subscribed
502− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
529+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
503531 }
504532
505533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
506−newSubscriberCoincidenceInner subscribed = return $ Subscriber
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
507535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
508− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
509536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
510537 case occ of
511538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -513,14 +540,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
513540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
514541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
515542 propagate a $ coincidenceSubscribedSubscribers subscribed
516− , subscriberInvalidateHeight = \_ -> do
517− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
518− invalidateCoincidenceHeight subscribed
519− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
520− , subscriberRecalculateHeight = \_ -> do
521− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
522− recalculateCoincidenceHeight subscribed
523− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
543+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
524545 }
525546
526547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -530,18 +551,18 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
530551recalculateSubscriberHeight = flip subscriberRecalculateHeight
531552
532553-- | Propagate everything at the current height
533−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
534−propagate a subscribers = withIncreasedDepth $ do
554+propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
555+propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
535556 -- 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
536557 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
537− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
558+ WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
538559
539560-- | Propagate everything at the current height
540−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
541−propagateFast a subscribers = withIncreasedDepth $ do
561+propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
562+propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
542563 -- 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
543564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
544− FastWeakBag.traverse subscribers $ \s -> subscriberPropagate s a
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
545566
546567--------------------------------------------------------------------------------
547568-- EventSubscribed
@@ -550,11 +571,16 @@ propagateFast a subscribers = withIncreasedDepth $ do
550571toAny :: a -> Any
551572toAny = unsafeCoerce
552573
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.
553579data EventSubscribed x = EventSubscribed
554580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
555581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
556582#ifdef DEBUG_CYCLES
557− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
558584 , eventSubscribedHasOwnHeightRef :: !Bool
559585 , eventSubscribedWhoCreated :: !(IO [String])
560586#endif
@@ -581,13 +607,23 @@ eventSubscribedNever = EventSubscribed
581607 , eventSubscribedWhoCreated = return ["never"]
582608#endif
583609 }
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+ }
584620
585−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
586622eventSubscribedFan !subscribed = EventSubscribed
587623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
588624 , eventSubscribedRetained = toAny subscribed
589625#ifdef DEBUG_CYCLES
590− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
591627 , eventSubscribedHasOwnHeightRef = False
592628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
593629#endif
@@ -600,7 +636,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
600636#ifdef DEBUG_CYCLES
601637 , eventSubscribedGetParents = do
602638 s <- readIORef $ switchSubscribedCurrentParent subscribed
603− return [Some.This $ _eventSubscription_subscribed s]
639+ return [_eventSubscription_subscribed s]
604640 , eventSubscribedHasOwnHeightRef = True
605641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
606642#endif
@@ -613,8 +649,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
613649#ifdef DEBUG_CYCLES
614650 , eventSubscribedGetParents = do
615651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
616− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
617− innerParents = maybeToList $ fmap Some.This innerSubscription
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
653+ innerParents = maybeToList $ innerSubscription
618654 return $ outerParent : innerParents
619655 , eventSubscribedHasOwnHeightRef = True
620656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -628,20 +664,20 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
628664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
629665whoCreatedEventSubscribed = eventSubscribedWhoCreated
630666
631−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
632668walkInvalidHeightParents s0 = do
633− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
669+ subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
634670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
635671 when (h == invalidHeight) $ do
636672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
637− modify (Some.This s :)
673+ modify (s :)
638674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
639− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
640676 return subscribers
641677#endif
642678
643679{-# INLINE subscribeHoldEvent #-}
644−subscribeHoldEvent :: HasSpiderTimeline x => Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
680+subscribeHoldEvent :: Hold x p -> Subscriber x p -> EventM x (EventSubscription x, Maybe p)
645681subscribeHoldEvent = subscribeAndRead . holdEvent
646682
647683--------------------------------------------------------------------------------
@@ -664,7 +700,7 @@ behaviorPull !p = Behavior $ do
664700 val <- liftIO $ readIORef $ pullValue p
665701 case val of
666702 Just subscribed -> do
667− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
668704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
669705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
670706 return $ pullSubscribedValue subscribed
@@ -673,7 +709,7 @@ behaviorPull !p = Behavior $ do
673709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
674710 parentsRef <- liftIO $ newIORef []
675711 holdInits <- askBehaviorHoldInits
676− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
677713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
678714 parents <- liftIO $ readIORef parentsRef
679715 let subscribed = PullSubscribed
@@ -683,7 +719,7 @@ behaviorPull !p = Behavior $ do
683719 , pullSubscribedParents = parents
684720 }
685721 liftIO $ writeIORef (pullValue p) $ Just subscribed
686− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
722+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
687723 return a
688724
689725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
@@ -694,7 +730,7 @@ readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
694730readHoldTracked h = do
695731 result <- liftIO $ readIORef $ holdValue h
696732 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
697− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
733+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedHold h)) :))
698734 liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
699735 return result
700736
@@ -708,42 +744,46 @@ readBehaviorUntracked b = do
708744-- Dynamic
709745--------------------------------------------------------------------------------
710746
711−data Dynamic x p = Dynamic
712− { dynamicCurrent :: !(Behavior x (PatchTarget p))
713− , dynamicUpdated :: !(Event x p)
747+type DynamicS x p = Dynamic x (PatchTarget p) p
748+
749+data Dynamic x target p = Dynamic
750+ { dynamicCurrent :: !(Behavior x target)
751+ , dynamicUpdated :: Event x p -- This must be lazy; see the comment on holdEvent --TODO: Would this let us eliminate `Dyn`?
714752 }
715753
716−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
717760dynamicHold !h = Dynamic
718761 { dynamicCurrent = behaviorHold h
719762 , dynamicUpdated = eventHold h
720763 }
721764
722−dynamicHoldIdentity :: HasSpiderTimeline x => Hold x (Identity a) -> Dynamic x (Identity a)
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
723766dynamicHoldIdentity = dynamicHold
724767
725−dynamicConst :: PatchTarget p -> Dynamic x p
768+dynamicConst :: PatchTarget p -> DynamicS x p
726769dynamicConst !a = Dynamic
727770 { dynamicCurrent = behaviorConst a
728771 , dynamicUpdated = eventNever
729772 }
730773
731−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
732775dynamicDyn !d = Dynamic
733776 { dynamicCurrent = behaviorDyn d
734777 , dynamicUpdated = eventDyn d
735778 }
736779
737−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
738781dynamicDynIdentity = dynamicDyn
739782
740783--------------------------------------------------------------------------------
741784-- Combinators
742785--------------------------------------------------------------------------------
743786
744−--TODO: Figure out why certain things are not 'representational', then make them
745−--representational so we can use coerce
746−
747787--type role Hold representational
748788data Hold x p
749789 = Hold { holdValue :: !(IORef (PatchTarget p))
@@ -764,20 +804,25 @@ globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
764804
765805-- | Stores all global data relevant to a particular Spider timeline; only one
766806-- value should exist for each type @x@
767−data SpiderTimelineEnv x = SpiderTimelineEnv
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+
812+data SpiderTimelineEnv' x = SpiderTimelineEnv
768813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
769814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
770815#ifdef DEBUG
771816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
772817#endif
773818 }
774−type role SpiderTimelineEnv nominal
819+type role SpiderTimelineEnv' phantom
775820
776821instance Eq (SpiderTimelineEnv x) where
777822 _ == _ = True -- Since only one exists of each type
778823
779824instance GEq SpiderTimelineEnv where
780− a `geq` b = if _spiderTimeline_lock a == _spiderTimeline_lock b
825+ a `geq` b = if _spiderTimeline_lock (unSTE a) == _spiderTimeline_lock (unSTE b)
781826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
782827 else Nothing
783828
@@ -787,9 +832,9 @@ data EventEnv x
787832 , eventEnvDynInits :: !(IORef [SomeDynInit x])
788833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
789834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
790− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
791− , eventEnvIntClears :: !(IORef [SomeIntClear])
792− , eventEnvRootClears :: !(IORef [SomeRootClear])
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
793838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
794839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
795840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
@@ -800,7 +845,7 @@ runEventM :: EventM x a -> IO a
800845runEventM = unEventM
801846
802847asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
803−asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
848+asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (unSTE (spiderTimeline :: SpiderTimelineEnv x))
804849
805850class MonadIO m => Defer a m where
806851 getDeferralQueue :: m (IORef [a])
@@ -861,29 +906,29 @@ putCurrentHeight h = do
861906 heightRef <- asksEventEnv eventEnvCurrentHeight
862907 liftIO $ writeIORef heightRef $! h
863908
864−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
865910 {-# INLINE getDeferralQueue #-}
866911 getDeferralQueue = asksEventEnv eventEnvClears
867912
868913{-# INLINE scheduleClear #-}
869−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
870−scheduleClear r = defer $ SomeClear r
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
915+scheduleClear r = defer $ Some $ Clear r
871916
872−instance HasSpiderTimeline x => Defer SomeIntClear (EventM x) where
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
873918 {-# INLINE getDeferralQueue #-}
874919 getDeferralQueue = asksEventEnv eventEnvIntClears
875920
876921{-# INLINE scheduleIntClear #-}
877−scheduleIntClear :: Defer SomeIntClear m => IORef (IntMap a) -> m ()
878−scheduleIntClear r = defer $ SomeIntClear r
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
923+scheduleIntClear r = defer $ Some $ IntClear r
879924
880−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
881926 {-# INLINE getDeferralQueue #-}
882927 getDeferralQueue = asksEventEnv eventEnvRootClears
883928
884929{-# INLINE scheduleRootClear #-}
885−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
886−scheduleRootClear r = defer $ SomeRootClear r
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
931+scheduleRootClear r = defer $ Some $ RootClear r
887932
888933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
889934 {-# INLINE getDeferralQueue #-}
@@ -938,9 +983,9 @@ getHoldEventSubscription h = do
938983
939984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
940985
941−--type role BehaviorM representational
942986-- BehaviorM can sample behaviors
943−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))
944989
945990instance Monad (BehaviorM x) where
946991 {-# INLINE (>>=) #-}
@@ -949,14 +994,16 @@ instance Monad (BehaviorM x) where
949994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
950995 {-# INLINE return #-}
951996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
952998 {-# INLINE fail #-}
953999 fail s = BehaviorM $ fail s
1000+#endif
9541001
9551002data BehaviorSubscribed x a
9561003 = forall p. BehaviorSubscribedHold (Hold x p)
9571004 | BehaviorSubscribedPull (PullSubscribed x a)
9581005
959−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
9601007
9611008--type role PullSubscribed representational
9621009data PullSubscribed x a
@@ -991,7 +1038,7 @@ data RootSubscribed x a = forall k. GCompare k => RootSubscribed
9911038#endif
9921039 }
9931040
994−data Root x (k :: * -> *)
1041+data Root x k
9951042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
9961043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
9971044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
@@ -1010,7 +1057,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
10101057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
10111058
10121059-- EventM can do everything BehaviorM can, plus create holds
1013−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)
10141061
10151062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
10161063
@@ -1035,7 +1082,8 @@ heightBagFromList :: [Height] -> HeightBag
10351082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
10361083
10371084heightBagAdd :: Height -> HeightBag -> HeightBag
1038−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
10391087
10401088heightBagRemove :: Height -> HeightBag -> HeightBag
10411089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -1044,6 +1092,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
10441092 0 -> IntMap.delete h c
10451093 _ -> IntMap.insert h (pred old) c
10461094
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+
10471102heightBagMax :: HeightBag -> Height
10481103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
10491104 Just ((h, _), _) -> Height h
@@ -1061,25 +1116,25 @@ heightBagVerify b@(HeightBag s c) = if
10611116heightBagVerify = id
10621117#endif
10631118
1064−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1065− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1066− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1067− , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k)))
1119+data FanSubscribedChildren x k v a = FanSubscribedChildren
1120+ { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x (v a)))
1121+ , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k v)
1122+ , _fanSubscribedChildren_weakSelf :: !(IORef (Weak (k a, FanSubscribed x k v)))
10681123 }
10691124
1070−data FanSubscribed (x :: *) k
1071− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1072− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1073− , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k))) -- This DMap should never be empty
1125+data FanSubscribed x k v
1126+ = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
1127+ , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k v)))
1128+ , fanSubscribedSubscribers :: !(IORef (DMap k (FanSubscribedChildren x k v))) -- This DMap should never be empty
10741129 , fanSubscribedParent :: !(EventSubscription x)
10751130#ifdef DEBUG_NODEIDS
10761131 , fanSubscribedNodeId :: Int
10771132#endif
10781133 }
10791134
1080−data Fan x k
1081− = Fan { fanParent :: !(Event x (DMap k Identity))
1082− , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1135+data Fan x k v
1136+ = Fan { fanParent :: !(Event x (DMap k v))
1137+ , fanSubscribed :: !(IORef (Maybe (FanSubscribed x k v)))
10831138 }
10841139
10851140data SwitchSubscribed x a
@@ -1133,20 +1188,35 @@ newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
11331188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
11341189newInvalidatorPull p = return $! InvalidatorPull p
11351190
1136−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1137− fmapMaybe f = push $ return . f
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1192+ mapMaybe f = push $ return . f
11381193
11391194instance HasSpiderTimeline x => Align (Event x) where
11401195 nil = eventNever
1141− align ea eb = fmapMaybe dmapToThese $ merge $ dynamicConst $ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
1196+#if MIN_VERSION_these(0, 8, 0)
1197+instance HasSpiderTimeline x => Semialign (Event x) where
1198+#endif
1199+ align ea eb = mapMaybe dmapToThese $ mergeG coerce $ dynamicConst $
1200+ DMap.fromDistinctAscList [LeftTag :=> ea, RightTag :=> eb]
11421201
1143−newtype Dyn x p = Dyn { unDyn :: IORef (Either (BehaviorM x (PatchTarget p), Event x p) (Hold x p)) }
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)
1212+
1213+newtype Dyn (x :: Type) p = Dyn { unDyn :: IORef (DynType x p) }
11441214
1145−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)
11461216newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
11471217
11481218--TODO: Avoid the duplication between this and R.zipDynWith
1149−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)
11501220zipDynWith f da db =
11511221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
11521222 ec = flip push eab $ \o -> do
@@ -1161,26 +1231,20 @@ zipDynWith f da db =
11611231 return $ Just $ Identity $ f a b
11621232 in dynamicDynIdentity $ unsafeBuildDynamic (f <$> readBehaviorUntracked (dynamicCurrent da) <*> readBehaviorUntracked (dynamicCurrent db)) ec
11631233
1164−buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => BehaviorM x (PatchTarget p) -> Event x p -> m (Dyn x p)
1234+buildDynamic :: (Defer (SomeDynInit x) m, Patch p) => EventM x (PatchTarget p) -> Event x p -> m (Dyn x p)
11651235buildDynamic readV0 v' = do
1166− result <- liftIO $ newIORef $ Left (readV0, v')
1236+ result <- liftIO $ newIORef $ BuildDyn (readV0, v')
11671237 let !d = Dyn result
11681238 defer $ SomeDynInit d
11691239 return d
11701240
11711241unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1172−unsafeBuildDynamic readV0 v' = Dyn $ unsafeNewIORef x $ Left x
1173− where x = (readV0, v')
1242+unsafeBuildDynamic readV0 v' =
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
11741244
11751245-- ResultM can read behaviors and events
11761246type ResultM = EventM
11771247
1178−{-# NOINLINE unsafeNewIORef #-}
1179−unsafeNewIORef :: a -> b -> IORef b
1180−unsafeNewIORef a b = unsafePerformIO $ do
1181− touch a
1182− newIORef b
1183−
11841248instance HasSpiderTimeline x => Functor (Event x) where
11851249 fmap f = push $ return . Just . f
11861250
@@ -1193,33 +1257,42 @@ push f e = cacheEvent (pushCheap f e)
11931257
11941258{-# INLINABLE pull #-}
11951259pull :: BehaviorM x a -> Behavior x a
1196−pull a = behaviorPull $ Pull
1197− { pullCompute = a
1198− , pullValue = unsafeNewIORef a Nothing
1260+pull a = unsafePerformIO $ do
1261+ ref <- newIORef Nothing
11991262#ifdef DEBUG_NODEIDS
1200− , pullNodeId = unsafeNodeId a
1263+ nid <- newNodeId
12011264#endif
1202− }
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
1271+ }
12031272
12041273{-# INLINABLE switch #-}
12051274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1206−switch a = eventSwitch $ Switch
1207− { switchParent = a
1208− , switchSubscribed = unsafeNewIORef a Nothing
1209− }
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1277+ pure $ eventSwitch $ Switch
1278+ { switchParent = a
1279+ , switchSubscribed = ref
1280+ }
12101281
12111282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1212−coincidence a = eventCoincidence $ Coincidence
1213− { coincidenceParent = a
1214− , coincidenceSubscribed = unsafeNewIORef a Nothing
1215− }
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1285+ pure $ eventCoincidence $ Coincidence
1286+ { coincidenceParent = a
1287+ , coincidenceSubscribed = ref
1288+ }
12161289
12171290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
12181291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
12191292run roots after = do
12201293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
1221− t <- SpiderHost ask
1222− result <- SpiderHost $ lift $ withMVar (_spiderTimeline_lock t) $ \_ -> flip runReaderT t $ unSpiderHost $ runFrame $ do
1294+ let t = spiderTimeline :: SpiderTimelineEnv x
1295+ result <- SpiderHost $ withMVar (_spiderTimeline_lock (unSTE t)) $ \_ -> unSpiderHost $ runFrame $ do
12231296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
12241297 occBefore <- liftIO $ do
12251298 occBefore <- readIORef occRef
@@ -1257,11 +1330,11 @@ scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
12571330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
12581331 EQ -> a
12591332
1260−data SomeClear = forall a. SomeClear {-# UNPACK #-} !(IORef (Maybe a))
1333+newtype Clear a = Clear (IORef (Maybe a))
12611334
1262−data SomeIntClear = forall a. SomeIntClear {-# UNPACK #-} !(IORef (IntMap a))
1335+newtype IntClear a = IntClear (IORef (IntMap a))
12631336
1264−data SomeRootClear = forall k. SomeRootClear {-# UNPACK #-} !(IORef (DMap k Identity))
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
12651338
12661339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
12671340
@@ -1273,55 +1346,110 @@ mkWeakPtrWithDebug x debugNote = do
12731346 x' <- evaluate x
12741347 mkWeakPtr x' $
12751348 if debugFinalize
1276− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
12771350 else Nothing
12781351
12791352type WeakList a = [Weak a]
12801353
1281−{-# INLINE withIncreasedDepth #-}
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1355+
1356+
1357+
1358+
12821359#ifdef DEBUG
1283−withIncreasedDepth :: CanTrace x m => m a -> m a
1284−withIncreasedDepth a = do
1285− spiderTimeline <- askSpiderTimelineEnv
1286− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) succ
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+
1381+{-# INLINE withIncreasedDepth #-}
1382+withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1383+withIncreasedDepth _ a = do
1384+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
12871385 result <- a
1288− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
12891387 return result
1290−#else
1291−withIncreasedDepth :: m a -> m a
1292−withIncreasedDepth = id
1293−#endif
1294−
1295−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
12961388
12971389{-# INLINE tracePropagate #-}
12981390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1299−tracePropagate p = traceWhen p debugPropagate
1391+tracePropagate p = when debugPropagate . trace p
13001392
13011393{-# INLINE traceInvalidate #-}
13021394traceInvalidate :: String -> IO ()
1303−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
13041400
1305−{-# INLINE traceWhen #-}
1306−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1307−traceWhen p b message = traceMWhen p b $ return message
1401+{-# INLINE trace #-}
1402+trace :: (CanTrace x m) => proxy x -> String -> m ()
1403+trace p message = traceM p $ return message
13081404
1309−{-# INLINE traceMWhen #-}
1310−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1311−traceMWhen _ b getMessage = when b $ do
1405+{-# INLINE traceM #-}
1406+traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
1407+traceM _ getMessage = do
13121408 message <- getMessage
1313−#ifdef DEBUG
1314− spiderTimeline <- askSpiderTimelineEnv
1315− d <- liftIO $ readIORef $ _spiderTimeline_depth spiderTimeline
1409+ d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1410+ liftIO $ debugStrLn $ replicate d ' ' <> message
1411+
13161412#else
1317− 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+
13181448#endif
1319− liftIO $ putStrLn $ replicate d ' ' <> message
13201449
13211450whoCreatedIORef :: IORef a -> IO [String]
13221451whoCreatedIORef (IORef a) = whoCreated $! a
13231452
1324−#ifdef DEBUG_CYCLES
13251453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
13261454groupByHead = \case
13271455 [] -> []
@@ -1332,20 +1460,54 @@ groupByHead = \case
13321460 | otherwise -> (x, xs :| []) : l
13331461
13341462listsToForest :: Eq a => [[a]] -> Forest a
1335−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+
13361495#endif
13371496
1497+
13381498{-# INLINE propagateSubscriberHold #-}
13391499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
13401500propagateSubscriberHold h a = do
1341− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
13421502 invalidators <- liftIO $ readIORef $ holdInvalidators h
13431503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
13441505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
13451506 case {-# SCC "apply" #-} apply a v of
13461507 Nothing -> return ()
13471508 Just v' -> do
1348− {-# 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)
13491511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
13501512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
13511513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1353,25 +1515,25 @@ propagateSubscriberHold h a = do
13531515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
13541516
13551517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1356−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
13571519
13581520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
13591521askInvalidator = do
1360− (!m, _) <- BehaviorM ask
1522+ (!m, _) <- ask
13611523 case m of
13621524 Nothing -> return Nothing
13631525 Just (!wi, _) -> return $ Just wi
13641526
13651527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
13661528askParentsRef = do
1367− (!m, _) <- BehaviorM ask
1529+ (!m, _) <- ask
13681530 case m of
13691531 Nothing -> return Nothing
13701532 Just (_, !p) -> return $ Just p
13711533
13721534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
13731535askBehaviorHoldInits = do
1374− (_, !his) <- BehaviorM ask
1536+ (_, !his) <- ask
13751537 return his
13761538
13771539{-# INLINE getDynHold #-}
@@ -1379,20 +1541,27 @@ getDynHold :: (Defer (SomeHoldInit x) m, Patch p) => Dyn x p -> m (Hold x p)
13791541getDynHold d = do
13801542 mh <- liftIO $ readIORef $ unDyn d
13811543 case mh of
1382− Right h -> return h
1383− Left (readV0, v') -> do
1544+ HoldDyn h -> return h
1545+ UnsafeDyn (readV0, v') -> do
13841546 holdInits <- getDeferralQueue
13851547 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
13861554 h <- hold v0 v'
1387− liftIO $ writeIORef (unDyn d) $ Right h
1555+ liftIO $ writeIORef (unDyn d) $ HoldDyn h
13881556 return h
13891557
1558+
13901559-- Always refers to 0
13911560{-# NOINLINE zeroRef #-}
13921561zeroRef :: IORef Height
13931562zeroRef = unsafePerformIO $ newIORef zeroHeight
13941563
1395−getRootSubscribed :: GCompare k => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
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)
13961565getRootSubscribed k r sub = do
13971566 mSubscribed <- readIORef $ rootSubscribed r
13981567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1406,9 +1575,14 @@ getRootSubscribed k r sub = do
14061575 let !cached = rootSubscribed r
14071576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
14081577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1409− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1578+
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
14101581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
14111582 writeIORef uninitRef $! uninit
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
14121586 let !subscribed = RootSubscribed
14131587 { rootSubscribedKey = k
14141588 , rootSubscribedCachedSubscribed = cached
@@ -1417,7 +1591,7 @@ getRootSubscribed k r sub = do
14171591 , rootSubscribedUninit = uninit
14181592 , rootSubscribedWeakSelf = weakSelf
14191593#ifdef DEBUG_NODEIDS
1420− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1594+ , rootSubscribedNodeId = nid
14211595#endif
14221596 }
14231597 -- If we die at the same moment that all our children die, they will
@@ -1453,6 +1627,9 @@ data FanInt x a = FanInt
14531627 { _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
14541628 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
14551629 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1630+#ifdef DEBUG_NODEIDS
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1632+#endif
14561633 }
14571634
14581635newFanInt :: IO (FanInt x a)
@@ -1460,38 +1637,39 @@ newFanInt = do
14601637 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
14611638 subscriptionRef <- newIORef $ error "fanInt: no subscription"
14621639 occRef <- newIORef $ error "fanInt: no occurrence"
1640+#ifdef DEBUG_NODEIDS
1641+ nodeId <- newNodeId
1642+#endif
14631643 return $ FanInt
14641644 { _fanInt_subscribers = subscribers
14651645 , _fanInt_subscriptionRef = subscriptionRef
14661646 , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
14671650 }
14681651
1469−{-# NOINLINE unsafeNewFanInt #-}
1470−unsafeNewFanInt :: b -> FanInt x a
1471−unsafeNewFanInt b = unsafePerformIO $ do
1472− touch b
1473− newFanInt
1474−
14751652fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1476−fanInt p =
1477− let self = unsafeNewFanInt p
1478− in EventSelectorInt $ \k -> Event $ \sub -> do
1653+fanInt p = unsafePerformIO $ do
1654+ self <- newFanInt
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
14791656 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
14801657 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1481− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
14821660 { subscriberPropagate = \m -> do
14831661 liftIO $ writeIORef (_fanInt_occRef self) m
14841662 scheduleIntClear $ _fanInt_occRef self
1485− FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> do --TODO: Do we need to know that no subscribers are being added as we traverse?
1486− FastWeakBag.traverse b $ \s -> do
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 ->
14871665 subscriberPropagate s v
1488− , subscriberInvalidateHeight = \old -> do
1489− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1490− FastWeakBag.traverse b $ \s -> do
1666+ , subscriberInvalidateHeight = \old ->
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1668+ FastWeakBag.traverse_ b $ \s ->
14911669 subscriberInvalidateHeight s old
1492− , subscriberRecalculateHeight = \new -> do
1493− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1494− FastWeakBag.traverse b $ \s -> do
1670+ , subscriberRecalculateHeight = \new ->
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1672+ FastWeakBag.traverse_ b $ \s ->
14951673 subscriberRecalculateHeight s new
14961674 }
14971675 liftIO $ do
@@ -1505,13 +1683,28 @@ fanInt p =
15051683 FastMutableIntMap.insert (_fanInt_subscribers self) k b
15061684 return b
15071685 Just b -> return b
1508− t <- liftIO $ FastWeakBag.insert sub b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
15091687 currentOcc <- readIORef (_fanInt_occRef self)
1510− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1511− return (EventSubscription (FastWeakBag.remove t) $! EventSubscribed heightRef $! toAny (_fanInt_subscriptionRef self, t), IntMap.lookup k currentOcc)
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+
15121705
15131706{-# INLINABLE getFanSubscribed #-}
1514−getFanSubscribed :: (HasSpiderTimeline x, GCompare k) => k a -> Fan x k -> Subscriber x a -> EventM x (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))
15151708getFanSubscribed k f sub = do
15161709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
15171710 case mSubscribed of
@@ -1529,13 +1722,16 @@ getFanSubscribed k f sub = do
15291722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
15301723 occRef <- liftIO $ newIORef parentOcc
15311724 when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
15321728 let subscribed = FanSubscribed
15331729 { fanSubscribedCachedSubscribed = fanSubscribed f
15341730 , fanSubscribedOccurrence = occRef
15351731 , fanSubscribedParent = subscription
15361732 , fanSubscribedSubscribers = subscribersRef
15371733#ifdef DEBUG_NODEIDS
1538− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
15391735#endif
15401736 }
15411737 let !self = (k, subscribed)
@@ -1545,7 +1741,7 @@ getFanSubscribed k f sub = do
15451741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
15461742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
15471743
1548−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
15491745cleanupFanSubscribed (k, subscribed) = do
15501746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15511747 let reducedSubscribers = DMap.delete k subscribers
@@ -1557,7 +1753,7 @@ cleanupFanSubscribed (k, subscribed) = do
15571753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
15581754
15591755{-# INLINE subscribeFanSubscribed #-}
1560−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
15611757subscribeFanSubscribed k subscribed sub = do
15621758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15631759 case DMap.lookup k subscribers of
@@ -1595,6 +1791,9 @@ getSwitchSubscribed s sub = do
15951791 when (isJust parentOcc) $ scheduleClear occRef
15961792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
15971793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
15981797 let !subscribed = SwitchSubscribed
15991798 { switchSubscribedCachedSubscribed = switchSubscribed s
16001799 , switchSubscribedOccurrence = occRef
@@ -1607,7 +1806,7 @@ getSwitchSubscribed s sub = do
16071806 , switchSubscribedCurrentParent = subscriptionRef
16081807 , switchSubscribedWeakSelf = weakSelf
16091808#ifdef DEBUG_NODEIDS
1610− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
16111810#endif
16121811 }
16131812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
@@ -1652,6 +1851,9 @@ getCoincidenceSubscribed c sub = do
16521851 scheduleClear innerSubdRef
16531852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
16541853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
16551857 let subscribed = CoincidenceSubscribed
16561858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
16571859 , coincidenceSubscribedOccurrence = occRef
@@ -1662,7 +1864,7 @@ getCoincidenceSubscribed c sub = do
16621864 , coincidenceSubscribedInnerParent = innerSubdRef
16631865 , coincidenceSubscribedWeakSelf = weakSelf
16641866#ifdef DEBUG_NODEIDS
1665− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
16661868#endif
16671869 }
16681870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
@@ -1679,57 +1881,72 @@ cleanupCoincidenceSubscribed subscribed = do
16791881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
16801882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
16811883
1682−{-# INLINE merge #-}
1683−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1684−merge d = cacheEvent (mergeCheap d)
1884+{-# INLINE mergeG #-}
1885+mergeG :: forall k q x v. (HasSpiderTimeline x, GCompare k)
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)
16851889
16861890{-# INLINE mergeWithMove #-}
1687−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1688−mergeWithMove d = cacheEvent (mergeCheapWithMove d)
1891+mergeWithMove :: forall k v q x. (HasSpiderTimeline x, GCompare k)
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)
16891895
16901896{-# INLINE [1] mergeCheap #-}
1691−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1692−mergeCheap = mergeCheap' getInitialSubscribers updateMe destroy
1897+mergeCheap
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
16931903 where
1694− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
16951905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
16961906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
16971907 (mOldSubd, newPs) <- case me of
16981908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
16991909 Just e -> do
17001910 let s = subscriber $ return k
1701− subscription@(EventSubscription _ subd) <- subscribe e s
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
17021912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
17031913 let newParent = MergeSubscribedParent subscription
17041914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17051915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
17061916 forM_ mOldSubd $ \oldSubd -> do
1707− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
17081920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17091921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
17101922 foldM f ([], oldParents) $ DMap.toList p
1711− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1923+
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
17121925 getInitialSubscribers initialParents subscriber = do
17131926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17141927 let s = subscriber $ return k
1715− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17161929 height <- liftIO $ getEventSubscribedHeight parentSubd
1717− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription)
1930+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParent subscription)
17181931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17191932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17201933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17211934 )
1935+
17221936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
17231937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
17241938
17251939{-# INLINE [1] mergeCheapWithMove #-}
1726−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1727−mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
1940+mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
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
17281945 where
1729− updateMe :: MergeUpdateFunc k x (PatchDMapWithMove k (Event x)) (MergeSubscribedParentWithMove x k)
1946+ updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
17301947 updateMe subscriber heightBagRef oldParents p = do
17311948 -- Prepare new parents for insertion
1732− let subscribeParent :: forall a. k a -> Event x a -> EventM x (MergeSubscribedParentWithMove x k a)
1949+ let subscribeParent :: forall a. k a -> Event x (v a) -> EventM x (MergeSubscribedParentWithMove x k a)
17331950 subscribeParent k e = do
17341951 keyRef <- liftIO $ newIORef k
17351952 let s = subscriber $ liftIO $ readIORef keyRef
@@ -1738,73 +1955,82 @@ mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
17381955 newParentHeight <- getEventSubscribedHeight subd
17391956 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17401957 return $ MergeSubscribedParentWithMove subscription keyRef
1741− p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey subscribeParent p
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
17421959 -- Collect old parents for deletion and update the keys of moved parents
1743− let moveOrDelete :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Event x) a -> MergeSubscribedParentWithMove x k a -> Constant (EventM x (Maybe (EventSubscription x))) a
1960+ let moveOrDelete :: forall a. k a -> PatchDMapWithMove.NodeInfo k q a -> MergeSubscribedParentWithMove x k a -> Constant (EventM x (Maybe (EventSubscription x))) a
17441961 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
17451962 Nothing -> do
1746− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964+ _mergeSubscribedParentWithMove_subscription parent
1965+
17471966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17481967 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
17491968 Just toKey -> do
17501969 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
17511970 return Nothing
1752− toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1971+ toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1972+ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1973+
17531974 return (toDelete, applyAlways p' oldParents)
1754− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
17551976 getInitialSubscribers initialParents subscriber = do
17561977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17571978 keyRef <- liftIO $ newIORef k
17581979 let s = subscriber $ liftIO $ readIORef keyRef
1759− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17601981 height <- liftIO $ getEventSubscribedHeight parentSubd
1761− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1982+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
17621983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17631984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17641985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17651986 )
1987+
17661988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
17671989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
17681990
1769−type MergeUpdateFunc k x p s
1770− = (forall a. EventM x (k a) -> Subscriber x a)
1991+type MergeUpdateFunc k v x p s
1992+ = (forall a. EventM x (k a) -> Subscriber x (v a))
17711993 -> IORef HeightBag
17721994 -> DMap k s
17731995 -> p
17741996 -> EventM x ([EventSubscription x], DMap k s)
17751997
1776−type MergeInitFunc k x s
1777− = DMap k (Event x)
1778− -> (forall a. EventM x (k a) -> Subscriber x a)
1779− -> EventM x (DMap k Identity, [Height], DMap k s)
1998+type MergeGetSubscription x s = forall a. s a -> EventSubscription x
1999+
2000+type MergeInitFunc k v q x 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)
17802004
17812005type MergeDestroyFunc k s
17822006 = DMap k s
17832007 -> IO ()
17842008
1785−data Merge x k s = Merge
2009+data Merge x k v s = Merge
17862010 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
17872011 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
17882012 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
1789− , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k Identity))
1790− , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k Identity))
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
17912015 }
17922016
1793−invalidateMergeHeight :: Merge x k s -> IO ()
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
17942018invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
17952019
17962020invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
17972021invalidateMergeHeight' heightRef sub = do
17982022 oldHeight <- readIORef heightRef
1799− 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
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
18002025 writeIORef heightRef $! invalidHeight
18012026 subscriberInvalidateHeight sub oldHeight
18022027
1803−
1804−revalidateMergeHeight :: Merge x k s -> IO ()
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
18052029revalidateMergeHeight m = do
18062030 currentHeight <- readIORef $ _merge_heightRef m
1807− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
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
18082034 heights <- readIORef $ _merge_heightBagRef m
18092035 parents <- readIORef $ _merge_parentsRef m
18102036 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
@@ -1812,44 +2038,53 @@ revalidateMergeHeight m = do
18122038 LT -> return ()
18132039 EQ -> do
18142040 let height = succHeight $ heightBagMax heights
1815− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
18162042 writeIORef (_merge_heightRef m) $! height
18172043 subscriberRecalculateHeight (_merge_sub m) height
18182044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
18192045
1820−scheduleMergeSelf :: HasSpiderTimeline x => Merge x k s -> Height -> EventM x ()
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
18212047scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
18222048 vals <- liftIO $ readIORef $ _merge_accumRef m
1823− liftIO $ writeIORef (_merge_accumRef m) $! DMap.empty -- Once we're done with this, we can clear it immediately, because if there's a cacheEvent in front of us, it'll handle subsequent subscribers, and if not, we won't get subsequent subscribers
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
18242052 --TODO: Assert that m is not empty
18252053 subscriberPropagate (_merge_sub m) vals
18262054
1827−mergeSubscriber :: forall x k s a. (HasSpiderTimeline x, GCompare k) => Merge x k s -> EventM x (k a) -> Subscriber x a
1828−mergeSubscriber m getKey = Subscriber
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
18292078 { subscriberPropagate = \a -> do
18302079 oldM <- liftIO $ readIORef $ _merge_accumRef m
18312080 k <- getKey
1832− let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge") k (Identity a) oldM
2081+ let newM = DMap.insertWith (error "Same key fired multiple times for Merge") k a oldM
18332082 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
18342083 liftIO $ writeIORef (_merge_accumRef m) $! newM
18352084 when (DMap.null oldM) $ do -- Only schedule the firing once
18362085 height <- liftIO $ readIORef $ _merge_heightRef m
1837− --TODO: assertions about height
1838− currentHeight <- getCurrentHeight
1839− when (height <= currentHeight) $ do
1840− if height /= invalidHeight
1841− then do
1842− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1843− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1844− else liftIO $ do
1845−#ifdef DEBUG_CYCLES
1846− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
1847− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
1848− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
1849−#else
1850− let cycleInfo = ""
1851−#endif
1852− error $ "Causality loop found" <> cycleInfo
2086+ checkCycle subscribed
2087+
18532088 scheduleMergeSelf m height
18542089 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
18552090 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
@@ -1860,30 +2095,45 @@ mergeSubscriber m getKey = Subscriber
18602095 }
18612096
18622097--TODO: Be able to run as much of this as possible promptly
1863−updateMerge :: (HasSpiderTimeline x, GCompare k) => Merge x k s -> MergeUpdateFunc k x p s -> p -> SomeMergeUpdate x
1864−updateMerge m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
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)
18652100 where updateMe = do
18662101 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
1867− (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber m) (_merge_heightBagRef m) oldParents p
2102+ (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
18682103 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
18692104 return subscriptionsToKill
18702105
1871−{-# INLINE mergeCheap' #-}
1872−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 -> Dynamic x p -> Event x (DMap k Identity)
1873−mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
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
18742110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
18752111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
18762112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
18772113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
18782114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1879− let m = Merge
2115+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2116+
2117+ let subscribed = EventSubscribed
2118+ { eventSubscribedHeightRef = heightRef
2119+ , eventSubscribedRetained = toAny (parentsRef, changeSubdRef)
2120+#ifdef DEBUG_CYCLES
2121+ , eventSubscribedGetParents = do
2122+ let getParent' (_ :=> v) = _eventSubscription_subscribed (getParent v)
2123+ fmap getParent' . DMap.toList <$> readIORef parentsRef
2124+ , eventSubscribedHasOwnHeightRef = False
2125+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2126+#endif
2127+ }
2128+
2129+ m = Merge
18802130 { _merge_parentsRef = parentsRef
18812131 , _merge_heightBagRef = heightBagRef
18822132 , _merge_heightRef = heightRef
18832133 , _merge_sub = sub
18842134 , _merge_accumRef = accumRef
18852135 }
1886− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
18872137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
18882138 myHeight = if invalidHeight `elem` heights
18892139 then invalidHeight
@@ -1892,50 +2142,57 @@ mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
18922142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
18932143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
18942144 else (Nothing, dm)
1895− unless (DMap.null accum) $ do
1896− scheduleMergeSelf m myHeight
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
18972146 liftIO $ writeIORef accumRef $! accum
18982147 liftIO $ writeIORef heightRef $! myHeight
18992148 liftIO $ writeIORef heightBagRef $! myHeightBag
1900− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
19012149 liftIO $ writeIORef parentsRef $! initialParentState
19022150 defer $ SomeMergeInit $ do
1903− let s = Subscriber
2151+ let changeSubscriber = Subscriber
19042152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1905− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
1906− defer $ updateMerge m updateFunc a
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
2154+ defer $ updateMerge subscribed m updateFunc a
19072155 , subscriberInvalidateHeight = \_ -> return ()
19082156 , subscriberRecalculateHeight = \_ -> return ()
19092157 }
1910− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
1911− forM_ change $ \c -> defer $ updateMerge m updateFunc c
2158+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2159+ forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
19122160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
19132161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
19142162 -- its subscription.
1915− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
19162164 let unsubscribeAll = destroy =<< readIORef parentsRef
1917− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1918− , occ
1919− )
19202165
1921−mergeInt :: forall x a. (HasSpiderTimeline x) => Dynamic x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2166+ return (EventSubscription unsubscribeAll subscribed, occ)
2167+
2168+
2169+mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
19222170mergeInt = cacheEvent . mergeIntCheap
19232171
19242172{-# INLINABLE mergeIntCheap #-}
1925−mergeIntCheap :: forall x a. (HasSpiderTimeline x) => Dynamic x (PatchIntMap (Event x a)) -> Event x (IntMap a)
2173+mergeIntCheap :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
19262174mergeIntCheap d = Event $ \sub -> do
19272175 initialParents <- readBehaviorUntracked $ dynamicCurrent d
19282176 accum <- liftIO $ FastMutableIntMap.newEmpty
19292177 heightRef <- liftIO $ newIORef zeroHeight
19302178 heightBagRef <- liftIO $ newIORef heightBagEmpty
19312179 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+ }
19322190 let scheduleSelf = do
19332191 height <- liftIO $ readIORef $ heightRef
19342192 scheduleMerge' height heightRef $ do
19352193 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
19362194 subscriberPropagate sub vals
1937− invalidateMyHeight = do
1938− invalidateMergeHeight' heightRef sub
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
19392196 recalculateMyHeight = do
19402197 currentHeight <- readIORef heightRef
19412198 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?
@@ -1945,12 +2202,14 @@ mergeIntCheap d = Event $ \sub -> do
19452202 LT -> return ()
19462203 EQ -> do
19472204 let height = succHeight $ heightBagMax heights
1948− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
19492206 writeIORef heightRef $! height
19502207 subscriberRecalculateHeight sub height
19512208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
19522209 mySubscriber k = Subscriber
19532210 { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
19542213 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
19552214 liftIO $ FastMutableIntMap.insert accum k a
19562215 when wasEmpty scheduleSelf
@@ -1984,7 +2243,6 @@ mergeIntCheap d = Event $ \sub -> do
19842243 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
19852244 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
19862245 return Nothing
1987− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
19882246 defer $ SomeMergeInit $ do
19892247 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
19902248 where
@@ -1998,35 +2256,39 @@ mergeIntCheap d = Event $ \sub -> do
19982256 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
19992257 liftIO $ for_ oldParents $ \oldParent -> do
20002258 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
20012261 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
20022262 return $ IntMap.elems oldParents
2003− let s = Subscriber
2263+ let changeSubscriber = Subscriber
20042264 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
20052265 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
20062266 defer $ updateMe a
20072267 , subscriberInvalidateHeight = \_ -> return ()
20082268 , subscriberRecalculateHeight = \_ -> return ()
20092269 }
2010− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
20112271 forM_ change $ \c -> defer $ updateMe c
20122272 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
20132273 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
20142274 -- its subscription.
2015− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
20162276 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2017− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2018− , occ
2019− )
2277+
2278+
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
20202280
20212281newtype 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) }
20222283
2023−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2024−fan e =
2284+fanG :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k v) -> EventSelectorG x k v
2285+fanG e = unsafePerformIO $ do
2286+ ref <- newIORef Nothing
20252287 let f = Fan
20262288 { fanParent = e
2027− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
20282290 }
2029− in EventSelector $ \k -> eventFan k f
2291+ pure $ EventSelectorG $ \k -> eventFan k f
20302292
20312293runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
20322294runHoldInits holdInitRef dynInitRef mergeInitRef = do
@@ -2079,37 +2341,37 @@ clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeI
20792341
20802342-- | Run an event action outside of a frame
20812343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
2082−runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
2083− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2344+runFrame a = SpiderHost $ do
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
20842346 let go = do
20852347 result <- a
20862348 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
20872349 return result
20882350 result <- runEventM go
20892351 toClear <- readIORef $ eventEnvClears env
2090− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
2352+ forM_ toClear $ \(Some (Clear ref)) -> {-# SCC "clear" #-} writeIORef ref Nothing
20912353 toClearInt <- readIORef $ eventEnvIntClears env
2092− forM_ toClearInt $ \(SomeIntClear ref) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
2354+ forM_ toClearInt $ \(Some (IntClear ref)) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
20932355 toClearRoot <- readIORef $ eventEnvRootClears env
2094− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2356+ forM_ toClearRoot $ \(Some (RootClear ref)) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
20952357 toAssign <- readIORef $ eventEnvAssignments env
20962358 toReconnectRef <- newIORef []
20972359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
20982360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
20992361 writeIORef vRef v
2100− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2362+ traceInvalidate $ "Invalidating Hold"
21012363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
21022364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
21032365 writeIORef (eventEnvMergeUpdates env) []
2104− when debugPropagate $ putStrLn "Updating merges"
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
21052367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2106− when debugPropagate $ putStrLn "Updating merges done"
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
21072369 toReconnect <- readIORef toReconnectRef
21082370 clearEventEnv env
21092371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
21102372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
21112373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2112− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
21132375 finalize wi
21142376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
21152377 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -2120,10 +2382,10 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
21202382 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
21212383 --TODO: Make sure we touch the pieces of the SwitchSubscribed at the appropriate times
21222384 sub <- newSubscriberSwitch subscribed
2123− 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
21242386 {-
21252387 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2126− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2388+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
21272389 EventRoot _ -> "EventRoot"
21282390 EventNever -> "EventNever"
21292391 _ -> "something else"
@@ -2138,7 +2400,7 @@ runFrame a = SpiderHost $ ask >>= \_ -> lift $ do
21382400 myHeight <- readIORef $ switchSubscribedHeight subscribed
21392401 when (parentHeight /= myHeight) $ do
21402402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2141− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
21422404 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
21432405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
21442406 unsubscribe subscription
@@ -2179,7 +2441,7 @@ invalidateCoincidenceHeight subscribed = do
21792441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
21802442 when (oldHeight /= invalidHeight) $ do
21812443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2182− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
21832445
21842446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
21852447updateSwitchHeight new subscribed = do
@@ -2187,7 +2449,7 @@ updateSwitchHeight new subscribed = do
21872449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
21882450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
21892451 writeIORef (switchSubscribedHeight subscribed) $! new
2190− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
21912453
21922454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
21932455recalculateCoincidenceHeight subscribed = do
@@ -2196,7 +2458,7 @@ recalculateCoincidenceHeight subscribed = do
21962458 height <- calculateCoincidenceHeight subscribed
21972459 when (height /= invalidHeight) $ do
21982460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2199− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
22002462
22012463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
22022464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
@@ -2235,9 +2497,6 @@ invalidate toReconnectRef wis = do
22352497-- Reflex integration
22362498--------------------------------------------------------------------------------
22372499
2238−-- When we're specializing, we include this from Reflex.Class instead, because
2239−-- it needs access to these types; when we're not, we want them here, so our
2240−-- instance isn't an orphan instance.
22412500-- | Designates the default, global Spider timeline
22422501data SpiderTimeline x
22432502type role SpiderTimeline nominal
@@ -2261,6 +2520,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Event
22612520 {-# INLINABLE headE #-}
22622521 headE = R.slowHeadE
22632522-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523+ {-# INLINABLE now #-}
2524+ now = nowSpiderEventM
22642525
22652526instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
22662527 {-# INLINABLE sample #-}
@@ -2282,6 +2543,9 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
22822543 {-# INLINABLE headE #-}
22832544 headE = R.slowHeadE
22842545-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546+ {-# INLINABLE now #-}
2547+ now = SpiderPushM nowSpiderEventM
2548+
22852549
22862550instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
22872551 {-# INLINE return #-}
@@ -2290,11 +2554,13 @@ instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x))
22902554 x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
22912555 {-# INLINE (>>) #-}
22922556 (>>) = (*>)
2557+#if !MIN_VERSION_base(4,13,0)
22932558 {-# INLINE fail #-}
22942559 fail _ = error "Dynamic does not support 'fail'"
2560+#endif
22952561
22962562{-# INLINABLE newJoinDyn #-}
2297−newJoinDyn :: HasSpiderTimeline x => Reflex.Spider.Internal.Dynamic x (Identity (Reflex.Spider.Internal.Dynamic x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
2563+newJoinDyn :: HasSpiderTimeline x => DynamicS x (Identity (DynamicS x (Identity a))) -> Reflex.Spider.Internal.Dyn x (Identity a)
22982564newJoinDyn d =
22992565 let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
23002566 eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
@@ -2304,9 +2570,13 @@ newJoinDyn d =
23042570 in Reflex.Spider.Internal.unsafeBuildDynamic readV0 v'
23052571
23062572instance HasSpiderTimeline x => Functor (Reflex.Class.Dynamic (SpiderTimeline x)) where
2307− fmap f = SpiderDynamic . newMapDyn f . unSpiderDynamic
2573+ fmap = mapDynamicSpider
23082574 x <$ d = R.unsafeBuildDynamic (return x) $ x <$ R.updated d
23092575
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+
23102580instance HasSpiderTimeline x => Applicative (Reflex.Class.Dynamic (SpiderTimeline x)) where
23112581 pure = SpiderDynamic . dynamicConst
23122582#if MIN_VERSION_base(4,10,0)
@@ -2325,7 +2595,7 @@ holdDynSpiderEventM v0 e = fmap (SpiderDynamic . dynamicHoldIdentity) $ Reflex.S
23252595holdIncrementalSpiderEventM :: (HasSpiderTimeline x, Patch p) => PatchTarget p -> Reflex.Class.Event (SpiderTimeline x) p -> EventM x (Reflex.Class.Incremental (SpiderTimeline x) p)
23262596holdIncrementalSpiderEventM v0 e = fmap (SpiderIncremental . dynamicHold) $ Reflex.Spider.Internal.hold v0 $ unSpiderEvent e
23272597
2328−buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPullM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
2598+buildDynamicSpiderEventM :: HasSpiderTimeline x => SpiderPushM x a -> Reflex.Class.Event (SpiderTimeline x) a -> EventM x (Reflex.Class.Dynamic (SpiderTimeline x) a)
23292599buildDynamicSpiderEventM getV0 e = fmap (SpiderDynamic . dynamicDynIdentity) $ Reflex.Spider.Internal.buildDynamic (coerce getV0) $ coerce $ unSpiderEvent e
23302600
23312601instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (SpiderHost x) where
@@ -2339,6 +2609,9 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
23392609 buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
23402610 {-# INLINABLE headE #-}
23412611 headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
23422615
23432616instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
23442617 sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
@@ -2355,6 +2628,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
23552628 {-# INLINABLE headE #-}
23562629 headE = R.slowHeadE
23572630-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
23582633
23592634instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
23602635 {-# INLINABLE sample #-}
@@ -2375,6 +2650,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Refle
23752650 buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
23762651 {-# INLINABLE headE #-}
23772652 headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
23782655
23792656--------------------------------------------------------------------------------
23802657-- Deprecated items
@@ -2412,13 +2689,13 @@ instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline
24122689 touch h
24132690 return result
24142691
2415−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2416− newEventWithTrigger = SpiderHost . lift . fmap SpiderEvent . newEventWithTriggerIO
2417− newFanEventWithTrigger f = SpiderHost $ lift $ do
2692+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2693+ newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
2694+ newFanEventWithTrigger f = SpiderHost $ do
24182695 es <- newFanEventWithTriggerIO f
24192696 return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
24202697
2421−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2698+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
24222699 newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
24232700 newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
24242701 es <- newFanEventWithTriggerIO f
@@ -2440,7 +2717,7 @@ unsafeNewSpiderTimelineEnv = do
24402717#ifdef DEBUG
24412718 depthRef <- newIORef 0
24422719#endif
2443− return $ SpiderTimelineEnv
2720+ return $ STE $ SpiderTimelineEnv
24442721 { _spiderTimeline_lock = lock
24452722 , _spiderTimeline_eventEnv = env
24462723#ifdef DEBUG
@@ -2450,19 +2727,19 @@ unsafeNewSpiderTimelineEnv = do
24502727
24512728-- | Create a new SpiderTimelineEnv
24522729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2453−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
24542731
2455−data LocalSpiderTimeline x s
2732+data LocalSpiderTimeline (x :: Type) s
24562733
24572734instance Reifies s (SpiderTimelineEnv x) =>
24582735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2459− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
24602737
24612738localSpiderTimeline
2462− :: Proxy s
2739+ :: proxy s
24632740 -> SpiderTimelineEnv x
24642741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2465−localSpiderTimeline _ = unsafeCoerce
2742+localSpiderTimeline _ = coerce
24662743
24672744-- | Pass a new timeline to the given function.
24682745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
@@ -2470,18 +2747,18 @@ withSpiderTimeline k = do
24702747 env <- unsafeNewSpiderTimelineEnv
24712748 reify env $ \s -> k $ localSpiderTimeline s env
24722749
2473−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)
24742751
24752752type ComputeM = EventM
24762753
2477−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)
24782755
24792756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
24802757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
24812758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
24822759 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2483− newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x (Identity a) } -- deriving (Functor, Applicative, Monad)
2484− newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: Dynamic x p }
2760+ newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: DynamicS x (Identity a) } -- deriving (Functor, Applicative, Monad)
2761+ newtype Incremental (SpiderTimeline x) p = SpiderIncremental { unSpiderIncremental :: DynamicS x p }
24852762 type PullM (SpiderTimeline x) = SpiderPullM x
24862763 type PushM (SpiderTimeline x) = SpiderPushM x
24872764 {-# INLINABLE never #-}
@@ -2494,10 +2771,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
24942771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
24952772 {-# INLINABLE pull #-}
24962773 pull = SpiderBehavior . pull . coerce
2497− {-# INLINABLE merge #-}
2498− merge = SpiderEvent . merge . dynamicConst . (coerce :: DMap k (R.Event (SpiderTimeline x)) -> DMap k (Event x))
2499− {-# INLINABLE fan #-}
2500− fan e = R.EventSelector $ SpiderEvent . select (fan (unSpiderEvent e))
2774+ {-# INLINABLE fanG #-}
2775+ fanG e = R.EventSelectorG $ SpiderEvent . selectG (fanG (unSpiderEvent e))
2776+ {-# INLINABLE mergeG #-}
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
25012783 {-# INLINABLE switch #-}
25022784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
25032785 {-# INLINABLE coincidence #-}
@@ -2505,15 +2787,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
25052787 {-# INLINABLE current #-}
25062788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
25072789 {-# INLINABLE updated #-}
2508− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
25092791 {-# INLINABLE unsafeBuildDynamic #-}
25102792 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
25112793 {-# INLINABLE unsafeBuildIncremental #-}
25122794 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2513− {-# INLINABLE mergeIncremental #-}
2514− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2515− {-# INLINABLE mergeIncrementalWithMove #-}
2516− mergeIncrementalWithMove = SpiderEvent . mergeWithMove . (unsafeCoerce :: Dynamic x (PatchDMapWithMove k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMapWithMove k (Event x))) . unSpiderIncremental
2795+ {-# INLINABLE mergeIncrementalG #-}
2796+ mergeIncrementalG nt = SpiderEvent #. mergeG (coerce #. nt) .# unSpiderIncremental
2797+ {-# INLINABLE mergeIncrementalWithMoveG #-}
2798+ mergeIncrementalWithMoveG nt = SpiderEvent #. mergeWithMove (coerce #. nt) .# unSpiderIncremental
25172799 {-# INLINABLE currentIncremental #-}
25182800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
25192801 {-# INLINABLE updatedIncremental #-}
@@ -2524,9 +2806,10 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
25242806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
25252807 eventCoercion Coercion = Coercion
25262808 behaviorCoercion Coercion = Coercion
2527− 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
2810+ incrementalCoercion Coercion Coercion = Coercion
25282811 {-# INLINABLE mergeIntIncremental #-}
2529− mergeIntIncremental = SpiderEvent . mergeInt . (unsafeCoerce :: Dynamic x (PatchIntMap (R.Event (SpiderTimeline x) a)) -> Dynamic x (PatchIntMap (Event x a))) . unSpiderIncremental
2812+ mergeIntIncremental = SpiderEvent . mergeInt . coerce
25302813 {-# INLINABLE fanInt #-}
25312814 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
25322815
@@ -2551,7 +2834,7 @@ instance MonadAtomicRef (EventM x) where
25512834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
25522835
25532836-- | The monad for actions that manipulate a Spider timeline identified by @x@
2554−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)
25552838
25562839instance Monad (SpiderHost x) where
25572840 {-# INLINABLE (>>=) #-}
@@ -2560,20 +2843,27 @@ instance Monad (SpiderHost x) where
25602843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
25612844 {-# INLINABLE return #-}
25622845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
25632847 {-# INLINABLE fail #-}
2564− 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
25652854
25662855-- | Run an action affecting the global Spider timeline; this will be guarded by
25672856-- a mutex for that timeline
25682857runSpiderHost :: SpiderHost Global a -> IO a
2569−runSpiderHost (SpiderHost a) = runReaderT a globalSpiderTimelineEnv
2858+runSpiderHost (SpiderHost a) = a
25702859
25712860-- | Run an action affecting a given Spider timeline; this will be guarded by a
25722861-- mutex for that timeline
25732862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
2574−runSpiderHostForTimeline (SpiderHost a) = runReaderT a
2863+runSpiderHostForTimeline (SpiderHost a) _ = a
25752864
2576−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)
25772867
25782868instance Monad (SpiderHostFrame x) where
25792869 {-# INLINABLE (>>=) #-}
@@ -2582,19 +2872,21 @@ instance Monad (SpiderHostFrame x) where
25822872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
25832873 {-# INLINABLE return #-}
25842874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
25852876 {-# INLINABLE fail #-}
25862877 fail s = SpiderHostFrame $ fail s
2878+#endif
25872879
25882880instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
25892881 notReadyUntil _ = pure ()
25902882 notReady = pure ()
25912883
2592−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)
25932885newEventWithTriggerIO f = do
25942886 es <- newFanEventWithTriggerIO $ \Refl -> f
25952887 return $ select es Refl
25962888
2597−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)
25982890newFanEventWithTriggerIO f = do
25992891 occRef <- newIORef DMap.empty
26002892 subscribedRef <- newIORef DMap.empty
@@ -2628,3 +2920,11 @@ instance MonadAtomicRef (SpiderHostFrame x) where
26282920instance PrimMonad (SpiderHostFrame x) where
26292921 type PrimState (SpiderHostFrame x) = PrimState IO
26302922 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/Time.hs+115−15
@@ -1,5 +1,7 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE DeriveGeneric #-}
4+{-# LANGUAGE DeriveTraversable #-}
35{-# LANGUAGE FlexibleContexts #-}
46{-# LANGUAGE MultiParamTypeClasses #-}
57{-# LANGUAGE RecursiveDo #-}
@@ -9,6 +11,11 @@
911#ifdef USE_TEMPLATE_HASKELL
1012{-# LANGUAGE TemplateHaskell #-}
1113#endif
14+-- |
15+-- Module:
16+-- Reflex.Time
17+-- Description:
18+-- Clocks, timers, and other time-related functions.
1219module Reflex.Time where
1320
1421import Reflex.Class
@@ -24,46 +31,50 @@ import Control.Monad
2431import Control.Monad.Fix
2532import Control.Monad.IO.Class
2633import Data.Align
34+import Data.Data (Data)
2735import Data.Fixed
36+import Data.Semigroup (Semigroup(..))
2837import Data.Sequence (Seq, (|>))
2938import qualified Data.Sequence as Seq
3039import Data.These
3140import Data.Time.Clock
3241import Data.Typeable
42+import GHC.Generics (Generic)
3343import System.Random
3444
45+-- | Metadata associated with a timer "tick"
3546data TickInfo
3647 = TickInfo { _tickInfo_lastUTC :: UTCTime
3748 -- ^ UTC time immediately after the last tick.
3849 , _tickInfo_n :: Integer
39− -- ^ Number of time periods since t0
50+ -- ^ Number of time periods or ticks since the start of the timer
4051 , _tickInfo_alreadyElapsed :: NominalDiffTime
41− -- ^ Amount of time already elapsed in the current tick period.
52+ -- ^ Amount of time that has elapsed in the current tick period.
4253 }
4354 deriving (Eq, Ord, Show, Typeable)
4455
45−-- | Special case of 'tickLossyFrom' that uses the post-build event to start the
46−-- tick thread.
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.
4759tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
4860tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
4961
50−-- | Special case of 'tickLossyFrom' that uses the post-build event to start the
51−-- tick thread and the time of the post-build as the tick basis time.
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.
5264tickLossyFromPostBuildTime :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> m (Event t TickInfo)
5365tickLossyFromPostBuildTime dt = do
5466 postBuild <- getPostBuild
5567 postBuildTime <- performEvent $ liftIO getCurrentTime <$ postBuild
5668 tickLossyFrom' $ (dt,) <$> postBuildTime
5769
58−-- | Send events over time with the given basis time and interval
59−-- If the system starts running behind, occurrences will be dropped rather than buffered
60−-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the basis time
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.
6172tickLossyFrom
6273 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
6374 => NominalDiffTime
6475 -- ^ The length of a tick interval
6576 -> UTCTime
66− -- ^ The basis time from which intervals count
77+ -- ^ The basis time from which intervals count and with which the initial calculation of elapsed time will be made.
6778 -> Event t a
6879 -- ^ Event that starts a tick generation thread. Usually you want this to
6980 -- be something like the result of getPostBuild that only fires once. But
@@ -71,12 +82,12 @@ tickLossyFrom
7182 -> m (Event t TickInfo)
7283tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
7384
74−-- | Generalization of tickLossyFrom that takes dt and t0 in the event.
85+-- | Generalization of tickLossyFrom that takes the delay and initial time as an 'Event'.
7586tickLossyFrom'
7687 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
7788 => Event t (NominalDiffTime, UTCTime)
7889 -- ^ Event that starts a tick generation thread. Usually you want this to
79− -- be something like the result of getPostBuild that only fires once. But
90+ -- be something like the result of 'getPostBuild' that only fires once. But
8091 -- there could be uses for starting multiple timer threads.
8192 -> m (Event t TickInfo)
8293tickLossyFrom' e = do
@@ -87,12 +98,16 @@ tickLossyFrom' e = do
8798 Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
8899 cb (tick, pair)
89100
101+-- | Like 'tickLossy', but immediately calculates the first tick and provides a 'Dynamic' that is updated as ticks fire.
90102clockLossy :: (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)
91103clockLossy dt t0 = do
92104 initial <- liftIO $ getCurrentTick dt t0
93105 e <- tickLossy dt t0
94106 holdDyn initial e
95107
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.
96111getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
97112getCurrentTick dt t0 = do
98113 t <- getCurrentTime
@@ -107,7 +122,7 @@ delay dt e = performEventAsync $ ffor e $ \a cb -> liftIO $ void $ forkIO $ do
107122 cb a
108123
109124-- | Send events with Poisson timing with the given basis and rate
110−-- Each occurence of the resulting event will contain the index of
125+-- Each occurrence of the resulting event will contain the index of
111126-- the current interval, with 0 representing the basis time
112127poissonLossyFrom
113128 :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
@@ -126,7 +141,7 @@ poissonLossyFrom rnd rate = inhomogeneousPoissonFrom rnd (constant rate) rate
126141
127142
128143-- | Send events with Poisson timing with the given basis and rate
129−-- Each occurence of the resulting event will contain the index of
144+-- Each occurrence of the resulting event will contain the index of
130145-- the current interval, with 0 representing the basis time.
131146-- Automatically begin sending events when the DOM is built
132147poissonLossy
@@ -266,6 +281,92 @@ throttle t e = do
266281 delayed <- delay t outE
267282 return outE
268283
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+
269370#ifdef USE_TEMPLATE_HASKELL
270371makeLensesWith (lensRules & simpleLenses .~ True) ''TickInfo
271372#else
@@ -281,4 +382,3 @@ tickInfo_alreadyElapsed :: Lens' TickInfo NominalDiffTime
281382tickInfo_alreadyElapsed f (TickInfo x1 x2 x3) = (\y -> TickInfo x1 x2 y) <$> f x3
282383{-# INLINE tickInfo_alreadyElapsed #-}
283384#endif
284−
src/Reflex/TriggerEvent/Base.hs+3
@@ -25,6 +25,7 @@ import Data.IORef
2525import Data.Monoid ((<>))
2626import qualified Data.Semigroup as S
2727import Reflex.Class
28+import Reflex.Adjustable.Class
2829import Reflex.Host.Class
2930import Reflex.PerformEvent.Class
3031import Reflex.PostBuild.Class
@@ -121,6 +122,8 @@ instance MonadHold t m => MonadHold t (TriggerEventT t m) where
121122 buildDynamic a0 = lift . buildDynamic a0
122123 {-# INLINABLE headE #-}
123124 headE = lift . headE
125+ {-# INLINABLE now #-}
126+ now = lift now
124127
125128instance Adjustable t m => Adjustable t (TriggerEventT t m) where
126129 {-# INLINABLE runWithReplace #-}
src/Reflex/TriggerEvent/Class.hs+6−1
@@ -2,7 +2,6 @@
22-- new 'Event's that can be triggered from 'IO'.
33{-# LANGUAGE FlexibleInstances #-}
44{-# LANGUAGE FunctionalDependencies #-}
5−{-# LANGUAGE MultiParamTypeClasses #-}
65{-# LANGUAGE UndecidableInstances #-}
76module Reflex.TriggerEvent.Class
87 ( TriggerEvent (..)
@@ -13,6 +12,7 @@ import Reflex.Class
1312import Control.Monad.Reader
1413import Control.Monad.State
1514import qualified Control.Monad.State.Strict as Strict
15+import Control.Monad.Trans.Maybe (MaybeT)
1616
1717--TODO: Shouldn't have IO hard-coded
1818-- | 'TriggerEvent' represents actions that can create 'Event's that can be
@@ -48,3 +48,8 @@ instance TriggerEvent t m => TriggerEvent t (Strict.StateT s m) where
4848 newTriggerEvent = lift newTriggerEvent
4949 newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
5050 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.hs+3−1
@@ -10,8 +10,10 @@ module Reflex.Widget.Basic where
1010
1111import Control.Monad.Fix (MonadFix)
1212import Data.Map (Map)
13+
1314import Reflex.Class
14−import Reflex.Patch.MapWithMove
15+import Reflex.Adjustable.Class
16+import Data.Patch.MapWithMove
1517
1618
1719-- | Build sortable content in such a way that re-sorting it can cause minimal
src/Reflex/Workflow.hs+14−1
@@ -1,7 +1,13 @@
11{-# LANGUAGE RecursiveDo #-}
22{-# 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."
310module Reflex.Workflow (
4− -- * Workflows
511 Workflow (..)
612 , workflow
713 , workflowView
@@ -13,25 +19,32 @@ import Control.Arrow ((***))
1319import Control.Monad.Fix (MonadFix)
1420
1521import Reflex.Class
22+import Reflex.Adjustable.Class
1623import Reflex.Network
1724import Reflex.NotReady.Class
1825import Reflex.PostBuild.Class
1926
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.
2029newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
2130
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).
2232workflow :: forall t m a. (Reflex t, Adjustable t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
2333workflow w0 = do
2434 rec eResult <- networkHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
2535 return $ fmap fst eResult
2636
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'.
2738workflowView :: 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)
2839workflowView w0 = do
2940 rec eResult <- networkView . fmap unWorkflow =<< holdDyn w0 eReplace
3041 eReplace <- fmap switch $ hold never $ fmap snd eResult
3142 return $ fmap fst eResult
3243
44+-- | Map a function over a 'Workflow', possibly changing the return type.
3345mapWorkflow :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
3446mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
3547
48+-- | Map a "cheap" function over a 'Workflow'. Refer to the documentation for 'pushCheap' for more information and performance considerations.
3649mapWorkflowCheap :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
3750mapWorkflowCheap 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+92−3
@@ -1,11 +1,23 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
13{-# LANGUAGE FlexibleContexts #-}
24{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
37module Main where
48
59import Control.Lens
610import Control.Monad
11+import Control.Monad.Fix
12+import qualified Data.Dependent.Map as DMap
13+import Data.Functor.Misc
14+import qualified Data.Map as M
715import Data.These
816
17+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
18+import Data.These.Lens
19+#endif
20+
921import Reflex
1022import Reflex.EventWriter.Base
1123import Test.Run
@@ -24,6 +36,15 @@ main = do
2436 , These () ()
2537 ]
2638 print os2
39+ os3@[[Nothing, Just [2]]] <- runApp' (unwrapApp testMoribundTellEvent) [Just ()]
40+ print os3
41+ os4@[[Nothing, Just [2]]] <- runApp' (unwrapApp testMoribundTellEventDMap) [Just ()]
42+ print os4
43+ os5@[[Nothing, Just [1, 2]]] <- runApp' (unwrapApp testLiveTellEventDMap) [Just ()]
44+ print os5
45+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
46+ print os6
47+ let ![[Nothing, Nothing]] = os6
2748 return ()
2849
2950unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
@@ -32,14 +53,82 @@ unwrapApp x appIn = do
3253 return e
3354
3455testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
35−testOrdering pulse = do
36− forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
37− return ()
56+testOrdering pulse = forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
3857
3958testSimultaneous :: (Reflex t, Adjustable t m, MonadHold t m) => Event t (These () ()) -> EventWriterT t [Int] m ()
4059testSimultaneous pulse = do
4160 let e0 = fmapMaybe (^? here) pulse
4261 e1 = fmapMaybe (^? there) pulse
4362 forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
63+
64+-- | Test that a widget telling and event which fires at the same time it has been replaced
65+-- doesn't count along with the new widget.
66+testMoribundTellEvent
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)
44120 return ()
45121
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+6−5
@@ -18,15 +18,17 @@ import Data.GADT.Compare
1818import Data.IORef
1919import Data.Semigroup
2020import Data.These
21+import Data.Type.Equality ((:~:)(Refl))
2122
2223import Data.Functor.Misc
23−import Reflex.Patch
24+import Data.Patch
2425
2526import qualified Reflex.Host.Class as Host
2627import qualified Reflex.Spider.Internal as S
2728
2829import System.Exit
2930import System.Mem
31+import Data.Coerce
3032
3133main :: IO ()
3234main = do
@@ -46,7 +48,7 @@ hostPerf ref = S.runSpiderHost $ do
4648 eventToPerform <- Host.runHostFrame $ do
4749 (reqMap :: S.Event S.Global (DMap (Const2 Int (DMap Tell (S.SpiderHostFrame S.Global))) Identity))
4850 <- S.SpiderHostFrame
49− $ fmap ( S.merge
51+ $ fmap ( S.mergeG coerce
5052 . S.dynamicHold)
5153 $ S.hold DMap.empty
5254 -- Construct a new heap object for the subscriber, invalidating any weak references to the subscriber if they are not retained
@@ -55,8 +57,8 @@ hostPerf ref = S.runSpiderHost $ do
5557 { S.subscriberPropagate = S.subscriberPropagate sub
5658 }
5759 return (s, o))
58− $ runIdentity <$> S.select
59− (S.fan $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
60+ $ runIdentity . runIdentity <$> S.selectG
61+ (S.fanG $ S.pushCheap (return . Just . mapKeyValuePairsMonotonic (\(t :=> e) -> WrapArg t :=> Identity e)) response)
6062 (WrapArg Request)
6163 return $ alignWith (mergeThese (<>))
6264 (flip S.pushCheap eadd $ \_ -> return $ Just $ DMap.singleton Request $ do
@@ -82,7 +84,6 @@ hostPerf ref = S.runSpiderHost $ do
8284 Nothing -> []
8385 Host.fireEventsAndRead followupEventTriggers $ return ()
8486 return ()
85− return ()
8687
8788data Tell a where
8889 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.hs+19−8
@@ -1,23 +1,30 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveFunctor #-}
23{-# LANGUAGE FlexibleContexts #-}
34{-# LANGUAGE GeneralizedNewtypeDeriving #-}
45{-# LANGUAGE LambdaCase #-}
56{-# LANGUAGE RankNTypes #-}
7+{-# LANGUAGE StandaloneDeriving #-}
68{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE UndecidableInstances #-}
710
811import Control.Lens
912import Control.Monad.Fix
1013import Data.Align
11−import Data.AppendMap (AppendMap)
1214import qualified Data.AppendMap as AMap
1315import Data.Functor.Misc
1416import Data.Map (Map)
1517import qualified Data.Map as Map
18+import Data.Map.Monoidal (MonoidalMap)
1619import Data.Semigroup
1720import Data.These
1821
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+
1926import Reflex
20−import Reflex.Patch.MapWithMove
27+import Data.Patch.MapWithMove
2128import Test.Run
2229
2330newtype MyQuery = MyQuery SelectedCount
@@ -27,14 +34,18 @@ instance Query MyQuery where
2734 type QueryResult MyQuery = ()
2835 crop _ _ = ()
2936
30−instance (Ord k, Query a, Eq (QueryResult a)) => Query (Selector k a) where
37+instance (Ord k, Query a, Eq (QueryResult a), Align (MonoidalMap k)) => Query (Selector k a) where
3138 type QueryResult (Selector k a) = Selector k (QueryResult a)
3239 crop q r = undefined
3340
34−newtype Selector k a = Selector { unSelector :: AppendMap k a }
41+newtype Selector k a = Selector { unSelector :: MonoidalMap k a }
3542 deriving (Show, Read, Eq, Ord, Functor)
3643
37−instance (Ord k, Eq a, Monoid a) => Semigroup (Selector k a) where
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
3849 (Selector a) <> (Selector b) = Selector $ fmapMaybe id $ f a b
3950 where
4051 f = alignWith $ \case
@@ -44,14 +55,14 @@ instance (Ord k, Eq a, Monoid a) => Semigroup (Selector k a) where
4455 let z = x `mappend` y
4556 in if z == mempty then Nothing else Just z
4657
47−instance (Ord k, Eq a, Monoid a) => Monoid (Selector k a) where
58+instance (Ord k, Eq a, Monoid a, Align (MonoidalMap k)) => Monoid (Selector k a) where
4859 mempty = Selector AMap.empty
4960 mappend = (<>)
5061
51−instance (Eq a, Ord k, Group a) => Group (Selector k a) where
62+instance (Eq a, Ord k, Group a, Align (MonoidalMap k)) => Group (Selector k a) where
5263 negateG = fmap negateG
5364
54−instance (Eq a, Ord k, Group a) => Additive (Selector k a)
65+instance (Eq a, Ord k, Group a, Align (MonoidalMap k)) => Additive (Selector k a)
5566
5667main :: IO ()
5768main = do
test/Reflex/Bench/Focused.hs+13−1
@@ -130,6 +130,16 @@ mapDynChain = iterM (return . fmap (+1))
130130joinDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
131131joinDynChain = iterM (\d -> return $ join $ fmap (const d) d)
132132
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+
133143combineDynChain :: (Reflex t, MonadHold t m) => Word -> Dynamic t Word -> m (Dynamic t Word)
134144combineDynChain = iterM (\d -> return $ zipDynWith (+) d d)
135145
@@ -184,7 +194,7 @@ switchMergeBehaviors mapChanges = pull . joinMap <$> holdMap mapChanges
184194
185195-- | Turn an UpdatedMap into a Dynamic by applying the differences to the initial value
186196holdMapDyn :: (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
188198
189199 where
190200 modify k Nothing items = Map.delete k items
@@ -308,6 +318,8 @@ dynamics :: Word -> [(String, TestCase)]
308318dynamics n =
309319 [ testE "mapDynChain" $ fmap updated $ mapDynChain n =<< d
310320 , testE "joinDynChain" $ fmap updated $ joinDynChain n =<< d
321+ , testE "holdDynChain" $ fmap updated $ holdDynChain n =<< d
322+ , testE "buildDynChain" $ fmap updated $ buildDynChain n =<< d
311323 , testE "combineDynChain" $ fmap updated $ combineDynChain n =<< d
312324 , testE "dense mergeTree" $ fmap (updated . mergeTreeDyn 8) dense
313325 , testE "sparse mergeTree" $ fmap (updated . mergeTreeDyn 8) sparse
test/Reflex/Plan/Pure.hs+5−4
@@ -41,6 +41,7 @@ instance MonadHold (Pure Int) PurePlan where
4141 holdIncremental initial = liftPlan . holdIncremental initial
4242 buildDynamic getInitial = liftPlan . buildDynamic getInitial
4343 headE = liftPlan . headE
44+ now = liftPlan now
4445
4546instance MonadSample (Pure Int) PurePlan where
4647 sample = liftPlan . sample
@@ -55,15 +56,15 @@ instance TestPlan (Pure Int) PurePlan where
5556runPure :: PurePlan a -> (a, IntSet)
5657runPure (PurePlan p) = runStateT p mempty $ 0
5758
58−relavantTimes :: IntSet -> IntSet
59−relavantTimes occs = IntSet.fromList [0..l + 1]
59+relevantTimes :: IntSet -> IntSet
60+relevantTimes occs = IntSet.fromList [0..l + 1]
6061 where l = fromMaybe 0 (fst <$> IntSet.maxView occs)
6162
6263testBehavior :: (Behavior (Pure Int) a, IntSet) -> IntMap a
63−testBehavior (b, occs) = IntMap.fromSet (sample b) (relavantTimes occs)
64+testBehavior (b, occs) = IntMap.fromSet (sample b) (relevantTimes occs)
6465
6566testEvent :: (Event (Pure Int) a, IntSet) -> IntMap (Maybe a)
66−testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relavantTimes occs)
67+testEvent (Event readEvent, occs) = IntMap.fromSet readEvent (relevantTimes occs)
6768
6869
6970
test/Reflex/Plan/Reflex.hs+2−2
@@ -74,13 +74,13 @@ deriving instance ReflexHost t => MonadFix (Plan t)
7474
7575
7676instance (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
7878 (e, ref) <- newEventWithTriggerRef
7979 modify (IntMap.unionWith mappend (firings ref))
8080 return e
8181
8282 where
83− firings ref = IntMap.fromList (makeFiring ref <$> occurances)
83+ firings ref = IntMap.fromList (makeFiring ref <$> occurrences)
8484 makeFiring ref (t, a) = (fromIntegral t, [Firing ref a])
8585
8686
test/Reflex/Test/CrossImpl.hs+24−15
@@ -12,7 +12,6 @@
1212{-# LANGUAGE TypeFamilies #-}
1313{-# LANGUAGE TypeOperators #-}
1414{-# LANGUAGE UndecidableInstances #-}
15−module Reflex.Test.CrossImpl (test) where
1615
1716import Prelude hiding (and, foldl, mapM, mapM_, sequence, sequence_)
1817
@@ -20,27 +19,23 @@ import Control.Monad.Ref
2019import Reflex.Class
2120import Reflex.Dynamic
2221import Reflex.Host.Class
23−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
2422import qualified Reflex.Pure as P
2523import qualified Reflex.Spider.Internal as S
24+import qualified Reflex.Profiled as Prof
2625
2726import Control.Arrow (second, (&&&))
2827import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
2928import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
30−import Control.Monad.Writer hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
31−import Data.Dependent.Map (DMap, DSum (..))
32−import qualified Data.Dependent.Map as DMap
29+import Data.Dependent.Sum (DSum (..))
3330import Data.Foldable
34−import Data.Functor.Misc
3531import Data.Map.Strict (Map)
3632import qualified Data.Map.Strict as Map
3733import qualified Data.Set as Set
34+import Data.Monoid
3835import Data.Traversable
3936import System.Exit
4037import System.Mem
4138
42−import System.IO.Unsafe
43−
4439mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
4540mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
4641 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
@@ -77,11 +72,14 @@ instance MapMSignals (Event t a) (Event t' a) t t' where
7772instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
7873 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
7974
80−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)
81−testSpider builder (bMap, eMap) = unsafePerformIO $ S.runSpiderHost $ do
75+testTimeline
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
8280 (re, reTrigger) <- newEventWithTriggerRef
8381 (rb, rbTrigger) <- newEventWithTriggerRef
84− 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
8583 (b', e') <- runHostFrame $ builder (b, re)
8684 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
8785 let times = relevantTestingTimes (bMap, eMap)
@@ -106,9 +104,11 @@ testAgreement :: (Eq c, Eq d, Show c, Show d) => (forall m t. TestCaseConstraint
106104testAgreement builder inputs = do
107105 let identityResult = testPure builder inputs
108106 tracePerf "---------" $ return ()
109− let spiderResult = testSpider builder inputs
107+ spiderResult <- S.runSpiderHost $ testTimeline builder inputs
108+ tracePerf "---------" $ return ()
109+ profiledResult <- S.runSpiderHost $ Prof.runProfiledM $ testTimeline builder inputs
110110 tracePerf "---------" $ return ()
111− let resultsAgree = identityResult == spiderResult
111+ let resultsAgree = identityResult == spiderResult && identityResult == profiledResult
112112 if resultsAgree
113113 then do --putStrLn "Success:"
114114 --print identityResult
@@ -116,6 +116,7 @@ testAgreement builder inputs = do
116116 else do putStrLn "Failure:"
117117 putStrLn $ "Pure result: " <> show identityResult
118118 putStrLn $ "Spider result: " <> show spiderResult
119+ putStrLn $ "Profiled result: " <> show profiledResult
119120 return resultsAgree
120121
121122type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
@@ -222,6 +223,11 @@ testCases =
222223 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
223224 let b' = pull $ sample =<< sample bb
224225 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)
225231 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
226232 bb <- hold "b" e
227233 bd <- hold never . fmap (const e) =<< headE e
@@ -233,6 +239,9 @@ testCases =
233239 rec result <- holdUniqDyn d
234240 d <- holdDyn (0 :: Int) e
235241 return (current result, updated result)
242+
243+
244+
236245 {-
237246 , (,) "mergeIncrementalWithMove" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, PatchDMapWithMove.moveDMapKey LeftTag RightTag), (2, mempty)]) $ \(b, e :: Event t (PatchDMapWithMove (EitherTag () ()) (Const2 () ()))) -> do
238247 x <- holdIncremental (DMap.singleton LeftTag $ void e) $ PatchDMapWithMove.mapPatchDMapWithMove (\(Const2 _) -> void e) <$> e
@@ -248,8 +257,8 @@ splitRecombineEvent e =
248257 in leftmost [ea, eb]
249258
250259
251−test :: IO ()
252−test = do
260+main :: IO ()
261+main = do
253262 results <- forM testCases $ \(name, TestCase inputs builder) -> do
254263 putStrLn $ "Test: " <> name
255264 testAgreement builder inputs
test/Reflex/Test/Micro.hs+71−4
@@ -3,6 +3,7 @@
33{-# LANGUAGE FlexibleContexts #-}
44{-# LANGUAGE FlexibleInstances #-}
55{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
67{-# LANGUAGE MultiParamTypeClasses #-}
78{-# LANGUAGE RankNTypes #-}
89{-# LANGUAGE RecursiveDo #-}
@@ -23,6 +24,24 @@ import Data.Monoid
2324
2425import Prelude
2526
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+
2645{-# ANN testCases "HLint: ignore Functor law" #-}
2746testCases :: [(String, TestCase)]
2847testCases =
@@ -201,6 +220,14 @@ testCases =
201220 bb <- hold (constant "x") $ pushAlways (const $ hold "a" eo) eo
202221 return $ pull $ sample =<< sample bb
203222
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+
204231 , testE "joinDyn" $ do
205232 e <- events1
206233 bb <- hold "b" e
@@ -223,6 +250,38 @@ testCases =
223250 d2 <- fmap (fmap (map toUpper)) $ foldDyn (++) "0" =<< events2
224251
225252 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+
226285 , testE "fan-1" $ do
227286 e <- fmap toMap <$> events1
228287 let es = select (fanMap e) . Const2 <$> values
@@ -263,15 +322,25 @@ testCases =
263322 let e = never <$ switch b
264323 return $ void e
265324 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
267333 ] where
268334
269335 events1, events2, events3 :: TestPlan t m => m (Event t String)
270336 events1 = plan [(1, "a"), (2, "b"), (5, "c"), (7, "d"), (8, "e")]
271337 events2 = plan [(1, "e"), (3, "d"), (4, "c"), (6, "b"), (7, "a")]
272−
273338 events3 = liftA2 mappend events1 events2
274339
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+
275344 values = "abcde"
276345 toMap str = Map.fromList $ map (\c -> (c, c)) str
277346
@@ -281,5 +350,3 @@ testCases =
281350
282351 deep e = leftmost [e, e]
283352 leftmost2 e1 e2 = leftmost [e1, e2]
284−
285−
test/Reflex/TestPlan.hs+2−2
@@ -26,8 +26,8 @@ import Reflex.Class
2626import Prelude
2727
2828class (Reflex t, MonadHold t m, MonadFix m) => TestPlan t m where
29− -- | Speicify a plan of an input Event firing
30− -- Occurances must be in the future (i.e. Time > 0)
29+ -- | Specify a plan of an input Event firing
30+ -- Occurrences must be in the future (i.e. Time > 0)
3131 -- Initial specification is
3232
3333 plan :: [(Word, a)] -> m (Event t a)
test/RequesterT.hs+181−14
@@ -1,14 +1,40 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
13{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
25{-# LANGUAGE GADTs #-}
3−{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE LambdaCase #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE RecursiveDo #-}
49{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TemplateHaskell #-}
11+{-# LANGUAGE TypeApplications #-}
12+{-# LANGUAGE TypeFamilies #-}
513module Main where
614
7−import Control.Lens
15+import Control.Lens hiding (has)
816import Control.Monad
17+import Control.Monad.Fix
18+import Control.Monad.IO.Class (MonadIO)
19+import Data.Constraint.Extras
20+import Data.Constraint.Extras.TH
21+import Data.Constraint.Forall
922import qualified Data.Dependent.Map as DMap
1023import Data.Dependent.Sum
24+import Data.Functor.Misc
25+import Data.List (words)
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)
1132import 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
1238
1339import Reflex
1440import Reflex.Requester.Base
@@ -20,18 +46,38 @@ data RequestInt a where
2046
2147main :: IO ()
2248main = do
23− os1@[[Just [10,9,8,7,6,5,4,3,2,1]]] <- runApp' (unwrapApp testOrdering) $
49+ os1 <- runApp' (unwrapApp testOrdering) $
2450 [ Just ()
2551 ]
2652 print os1
27− os2@[[Just [1,3,5,7,9]],[Nothing,Nothing],[Just [2,4,6,8,10]],[Just [2,4,6,8,10],Nothing]]
28− <- runApp' (unwrapApp testSimultaneous) $ map Just $
29− [ This ()
30− , That ()
31− , This ()
32− , These () ()
33− ]
53+ os2 <- runApp' (unwrapApp testSimultaneous) $ map Just $
54+ [ This ()
55+ , That ()
56+ , This ()
57+ , These () ()
58+ ]
3459 print os2
60+ os3 <- runApp' (unwrapApp testMoribundRequest) [Just ()]
61+ print os3
62+ os4 <- runApp' (unwrapApp testMoribundRequestDMap) [Just ()]
63+ print os4
64+ os5 <- runApp' (unwrapApp testLiveRequestDMap) [Just ()]
65+ print os5
66+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
67+ print os6
68+ os7 <- runApp' testMatchRequestsWithResponses [ Just $ TestRequest_Increment 1 ]
69+ print os7
70+ os8 <- runApp' testMatchRequestsWithResponses [ Just $ TestRequest_Reverse "yoyo" ]
71+ print os8
72+ let ![[Just [1,2,3,4,5,6,7,8,9,10]]] = os1 -- The order is reversed here: see the documentation for 'runRequesterT'
73+ let ![[Just [9,7,5,3,1]],[Nothing,Nothing],[Just [10,8,6,4,2]],[Just [10,8,6,4,2],Nothing]] = os2
74+ let ![[Nothing, Just [2]]] = os3
75+ let ![[Nothing, Just [2]]] = os4
76+ let ![[Nothing, Just [1, 2]]] = os5
77+ -- let ![[Nothing, Nothing]] = os6 -- TODO re-enable this test after issue #233 has been resolved
78+ let !(Just [(1,"2")]) = M.toList <$> head (head os7)
79+ let !(Just [(1,"oyoy")]) = M.toList <$> head (head os8)
80+
3581 return ()
3682
3783unwrapRequest :: DSum tag RequestInt -> Int
@@ -43,7 +89,7 @@ unwrapApp :: ( Reflex t, Monad m )
4389 -> m (Event t [Int])
4490unwrapApp x appIn = do
4591 ((), e) <- runRequesterT (x appIn) never
46− return $ fmap (map unwrapRequest . DMap.toList) e
92+ return $ fmap (map unwrapRequest . requesterDataToList) e
4793
4894testOrdering :: ( Response m ~ Identity
4995 , Request m ~ RequestInt
@@ -51,9 +97,8 @@ testOrdering :: ( Response m ~ Identity
5197 , Adjustable t m)
5298 => Event t ()
5399 -> m ()
54−testOrdering pulse = do
55− forM_ [10,9..1] $ \i -> requestingIdentity (RequestInt i <$ pulse)
56− return ()
100+testOrdering pulse = forM_ [10,9..1] $ \i ->
101+ requestingIdentity (RequestInt i <$ pulse)
57102
58103testSimultaneous :: ( Response m ~ Identity
59104 , Request m ~ RequestInt
@@ -66,3 +111,125 @@ testSimultaneous pulse = do
66111 switchE = fmapMaybe (^? there) pulse
67112 forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
68113 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+ )
229+
230+deriveArgDict ''TestRequest
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.hs+8
@@ -64,3 +64,11 @@ runApp' :: (t ~ SpiderTimeline Global, m ~ SpiderHost Global)
6464runApp' app input = do
6565 let app' = fmap (AppOut (pure ())) . app
6666 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+5−9
@@ -1,7 +1,7 @@
11module Main where
22
33import Control.Monad
4−import Language.Haskell.HLint3 (hlint)
4+import Language.Haskell.HLint (hlint)
55import System.Directory
66import System.Exit (exitFailure, exitSuccess)
77import System.FilePath
@@ -20,7 +20,10 @@ main = do
2020 , "--ignore=Use >=>"
2121 , "--ignore=Use ."
2222 , "--ignore=Use unless"
23+ , "--ignore=Reduce duplication"
2324 , "--cpp-define=USE_TEMPLATE_HASKELL"
25+ , "--cpp-define=DEBUG"
26+ , "--ignore=Use tuple-section"
2427 ]
2528 recurseInto = and <$> sequence
2629 [ fileType ==? Directory
@@ -28,16 +31,9 @@ main = do
2831 ]
2932 matchFile = and <$> sequence
3033 [ extension ==? ".hs"
31− , let notElem' = liftOp notElem
32− in filePath `notElem'` filePathExceptions pwd
3334 ]
34− files <- find recurseInto matchFile pwd
35+ files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
3536 ideas <- fmap concat $ forM files $ \f -> do
3637 putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
3738 runHlint f
3839 if null ideas then exitSuccess else exitFailure
39−
40−filePathExceptions :: FilePath -> [FilePath]
41−filePathExceptions pwd = map (pwd </>) $
42− [ "src/Data/AppendMap.hs" -- parse error when hlint runs
43− ]
test/semantics.hs−2
@@ -45,5 +45,3 @@ main = do
4545 ]
4646
4747 makeGroup name tests = first (\test -> intercalate "/" [name, test]) <$> tests
48−
49−