on develop help sign in
77 files changed+3266−2506
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+41 CONTRIBUTING.md+66 ChangeLog.md+151 Quickref.md+22−18 README.md+15−11 cabal.haskell-ci+23 cabal.project+1 default.nix−39 dep/reflex-platform/default.nix+7 dep/reflex-platform/github.json+7 hydra.json−29 jobsets.nix−70 reflex-platform.nix−8 reflex.cabal+192−57 release.nix+56−7 src/Control/Monad/ReaderIO.hs+60 src/Data/AppendMap.hs+24−21 src/Data/FastMutableIntMap.hs+23−2 src/Data/FastWeakBag.hs+10−5 src/Data/Functor/Misc.hs−279 src/Data/Map/Misc.hs+1−1 src/Data/WeakBag.hs+8−3 src/Reflex.hs+1 src/Reflex/Adjustable/Class.hs+33−6 src/Reflex/BehaviorWriter/Base.hs+16−7 src/Reflex/BehaviorWriter/Class.hs+11−6 src/Reflex/Class.hs+467−126 src/Reflex/Collection.hs+16−11 src/Reflex/Dynamic.hs+34−169 src/Reflex/Dynamic/TH.hs+2−26 src/Reflex/DynamicWriter/Base.hs+22−8 src/Reflex/DynamicWriter/Class.hs+10−6 src/Reflex/EventWriter/Base.hs+19−8 src/Reflex/EventWriter/Class.hs−1 src/Reflex/FastWeak.hs+20−6 src/Reflex/FunctorMaybe.hs+25−21 src/Reflex/Host/Class.hs−1 src/Reflex/Host/Headless.hs+128 src/Reflex/Network.hs+10−4 src/Reflex/NotReady/Class.hs+10−1 src/Reflex/Optimizer.hs+8−4 src/Reflex/Patch.hs−39 src/Reflex/Patch/Class.hs−34 src/Reflex/Patch/DMap.hs−82 src/Reflex/Patch/DMapWithMove.hs−364 src/Reflex/Patch/IntMap.hs−67 src/Reflex/Patch/Map.hs−63 src/Reflex/Patch/MapWithMove.hs−270 src/Reflex/PerformEvent/Base.hs+3−1 src/Reflex/PerformEvent/Class.hs+6−2 src/Reflex/PostBuild/Base.hs+2−1 src/Reflex/PostBuild/Class.hs−2 src/Reflex/Profiled.hs+86−18 src/Reflex/Pure.hs+34−23 src/Reflex/Query/Base.hs+44−42 src/Reflex/Query/Class.hs+68−9 src/Reflex/Requester/Base.hs+191−18 src/Reflex/Requester/Class.hs−1 src/Reflex/Spider.hs+5−2 src/Reflex/Spider/Internal.hs+743−451 src/Reflex/Time.hs+24−14 src/Reflex/TriggerEvent/Base.hs+2 src/Reflex/TriggerEvent/Class.hs+6−1 src/Reflex/Widget/Basic.hs+1−1 src/Reflex/Workflow.hs+13−1 test/Adjustable.hs+62 test/DebugCycles.hs+171 test/EventWriterT.hs+24−4 test/GC.hs+6−5 test/Headless.hs+10 test/QueryT.hs+5−1 test/Reflex/Bench/Focused.hs+12 test/Reflex/Plan/Pure.hs+1 test/Reflex/Test/CrossImpl.hs+18−8 test/Reflex/Test/Micro.hs+8−2 test/RequesterT.hs+179−11 test/hlint.hs+3−8
.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
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+22−18
@@ -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
@@ -166,7 +167,7 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
166167-- Flatten Behavior-of-Event to Event. Old Event is used during switchover.
167168[ ] switch :: Behavior (Event a) -> Event a
168169
169−-- Flatten Dyanmic-of-Event to Event. New Event is used immediately.
170+-- Flatten Dynamic-of-Event to Event. New Event is used immediately.
170171[ ] switchDyn :: Dynamic (Event a) -> Event a
171172
172173-- Flatten Event-of-Event to Event that fires when both wrapper AND new Event fire.
@@ -198,7 +199,7 @@ For Events, the returned Event fires whenever the latest Event supplied by the w
198199The functions mentioned above are used to create a static FRP network.
199200There 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.
200201
201−Th typeclasses and their associated annotations include:
202+The typeclasses and their associated annotations include:
202203
203204- `PostBuild`
204205 Fire an Event when an FRP network has been set up.
@@ -206,7 +207,7 @@ Th typeclasses and their associated annotations include:
206207 [B] -- Function runs in any monad supporting PostBuild
207208 ```
208209
209−- `Adjustable`
210+- `Adjustable`
210211 Use Events to add or remove pieces of an FRP network.
211212 ```haskell
212213 [A] -- Function runs in any monad supporting Adjustable
@@ -271,7 +272,7 @@ Th typeclasses and their associated annotations include:
271272```haskell
272273-- Run side-effecting actions in Event when it occurs; returned Event contains
273274-- results. Side effects run in the (Performable m) monad which is associated with
274−-- the (PerformEvent t m) typeclass constraint.
275+-- the (PerformEvent t m) typeclass constraint.
275276-- This allows for working with IO when a ((MonadIO (Performable m)) constraint is available.
276277[P] performEvent :: Event (Performable m a ) -> m (Event a)
277278
@@ -295,17 +296,20 @@ Th typeclasses and their associated annotations include:
295296## Networks
296297
297298```haskell
298−-- Functions from Reflex.Network used to deal with Dynamics/Events carrying (m a)
299+-- Functions from Reflex.Adjustable / Reflex.Network used to deal with Dynamics/Events carrying (m a)
299300
300−-- Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
301−-- The returned Event of network results occurs when the Dynamic does. Note: Often, the type a is an Event,
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,
302305-- in which case the return value is an Event-of-Events that would typically be flattened (via switchHold).
303−[P,A] networkView :: Dynamic (m a) -> m (Event a)
306+[P,A] networkView :: Dynamic (m a) -> m (Event a)
304307
305−-- Given an initial network and an Event of network-creating actions, create a network that is recreated whenever the
306−-- Event fires. The returned Dynamic of network results occurs when the Event does. Note: Often, the type a is an
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
307310-- Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
308−[H,A] networkHold :: m a -> Event (m a) -> m (Dynamic a)
311+[H,A] networkHold :: m a -> Event (m a) -> m (Dynamic a)
309312
310313-- Render a placeholder network to be shown while another network is not yet done building
311−[P,A] untilReady :: m a -> m b -> m (a, Event b)
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.
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−39
@@ -1,39 +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−, monoidal-containers
10−, useTemplateHaskell ? true
11−}:
12−mkDerivation {
13− pname = "reflex";
14− version = "0.5";
15− src = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [ ".git" "dist" ])) ./.;
16− libraryHaskellDepends = [
17− base bifunctors containers dependent-map dependent-sum
18− exception-transformers lens
19− MemoTrie monad-control mtl primitive ref-tf semigroupoids
20− semigroups stm syb template-haskell these transformers
21− transformers-compat prim-uniq
22− base bifunctors containers deepseq dependent-map dependent-sum
23− mtl ref-tf split transformers data-default
24− random time unbounded-delays monoidal-containers
25− ] ++ (if ghc.isGhcjs or false then [
26− ghcjs-base
27− ] else []) ++ (if !useTemplateHaskell then [] else [
28− haskell-src-exts haskell-src-meta
29− ]);
30− testHaskellDepends = if ghc.isGhcjs or false then [] else [
31− hlint filepath directory filemanip
32− ];
33− configureFlags = if useTemplateHaskell then [] else [
34− "-f-use-template-haskell"
35− ];
36− homepage = "https://github.com/reflex-frp/reflex";
37− description = "Higher-order Functional Reactive Programming";
38− license = stdenv.lib.licenses.bsd3;
39−}
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+}
hydra.jsondeleted−29
@@ -1,29 +0,0 @@
1−{
2− "enabled": 1,
3− "hidden": true,
4− "description": "Jobsets",
5− "nixexprinput": "src",
6− "nixexprpath": "jobsets.nix",
7− "checkinterval": 300,
8− "schedulingshares": 100,
9− "enableemail": false,
10− "emailoverride": "",
11− "keepnr": 10,
12− "inputs": {
13− "src": {
14− "type": "git",
15− "value": "https://github.com/reflex-frp/reflex.git develop",
16− "emailresponsible": false
17− },
18− "nixpkgs": {
19− "type": "git",
20− "value": "https://github.com/NixOS/nixpkgs-channels nixos-unstable",
21− "emailresponsible": false
22− },
23− "prs": {
24− "type": "githubpulls",
25− "value": "reflex-frp reflex",
26− "emailresponsible": false
27− }
28− }
29−}
jobsets.nixdeleted−70
@@ -1,70 +0,0 @@
1−{ prs }:
2−
3−let
4− pkgs = (import ./reflex-platform.nix {}).nixpkgs;
5− mkFetchGithub = value: {
6− inherit value;
7− type = "git";
8− emailresponsible = false;
9− };
10−in
11−with pkgs.lib;
12−let
13− defaults = jobs: {
14− inherit (jobs) description;
15− enabled = 1;
16− hidden = false;
17− keepnr = 10;
18− schedulingshares = 100;
19− checkinterval = 120;
20− enableemail = false;
21− emailoverride = "";
22− nixexprinput = "reflex";
23− nixexprpath = "release.nix";
24− inputs = jobs.inputs // {
25− nixpkgs = {
26− type = "git";
27− value = "https://github.com/NixOS/nixpkgs-channels nixos-unstable";
28− emailresponsible = false;
29− };
30− config = {
31− type = "nix";
32− value = "{ android_sdk.accept_license = true; }";
33− emailresponsible = false;
34− };
35− };
36− };
37− branchJobset = branch: defaults {
38− description = "reflex-${branch}";
39− inputs = {
40− reflex = {
41− value = "https://github.com/reflex-frp/reflex ${branch}";
42− type = "git";
43− emailresponsible = false;
44− };
45− };
46− };
47− makePr = num: info: {
48− name = "reflex-pr-${num}";
49− value = defaults {
50− description = "#${num}: ${info.title}";
51− inputs = {
52− reflex = {
53− #NOTE: This should really use "pull/${num}/merge"; however, GitHub's
54− #status checks only operate on PR heads. This creates a race
55− #condition, which can currently only be solved by requiring PRs to be
56− #up to date before they're merged. See
57− #https://github.com/isaacs/github/issues/1002
58− value = "https://github.com/reflex-frp/reflex pull/${num}/head";
59− type = "git";
60− emailresponsible = false;
61− };
62− };
63− };
64− };
65− processedPrs = mapAttrs' makePr (builtins.fromJSON (builtins.readFile prs));
66− jobsetsAttrs = processedPrs //
67− genAttrs ["develop"] branchJobset;
68−in {
69− jobsets = pkgs.writeText "spec.json" (builtins.toJSON jobsetsAttrs);
70−}
reflex-platform.nixdeleted−8
@@ -1,8 +0,0 @@
1−let
2− reflex-platform-src = (import <nixpkgs> {}).fetchFromGitHub {
3− owner = "reflex-frp";
4− repo = "reflex-platform";
5− rev = "384cd850f3adf1d404bced2424b5f6efb0f415f2";
6− sha256 = "1ws77prqx8khmp8j6br1ij4k2v4dlgv170r9fmg0p1jivfbn8y9d";
7− };
8−in import reflex-platform-src
reflex.cabal+192−57
@@ -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,12 +19,17 @@ Maintainer: ryan.trinkle@gmail.com
919Stability: Experimental
1020Category: FRP
1121Build-type: Simple
12−Cabal-version: >=1.9.2
22+Cabal-version: 1.22
1323homepage: https://reflex-frp.org
1424bug-reports: https://github.com/reflex-frp/reflex/issues
1525extra-source-files:
1626 README.md
1727 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
1833
1934flag use-reflex-optimizer
2035 description: Use the GHC plugin Reflex.Optimizer on some of the modules in the package. This is still experimental.
@@ -36,42 +51,67 @@ flag fast-weak
3651 default: False
3752 manual: True
3853
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+
3969library
70+ default-language: Haskell2010
4071 hs-source-dirs: src
4172 build-depends:
4273 MemoTrie == 0.6.*,
43− base >= 4.9 && < 4.13,
74+ base >= 4.11 && < 4.15,
4475 bifunctors >= 5.2 && < 5.6,
45− comonad,
46− constraints-extras >= 0.2,
47− containers >= 0.5 && < 0.7,
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,
4880 data-default >= 0.5 && < 0.8,
49− dependent-map >= 0.2.4 && < 0.3,
81+ dependent-map >= 0.3 && < 0.5,
5082 exception-transformers == 0.4.*,
5183 lens >= 4.7 && < 5,
84+ mmorph >= 1.0 && < 1.2,
5285 monad-control >= 1.0.1 && < 1.1,
53− monoidal-containers == 0.4.*,
5486 mtl >= 2.1 && < 2.3,
55− prim-uniq >= 0.1.0.1 && < 0.2,
56− 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,
5791 random == 1.1.*,
5892 ref-tf == 0.4.*,
5993 reflection == 2.1.*,
6094 semigroupoids >= 4.0 && < 6,
61− semigroups >= 0.16 && < 0.19,
6295 stm >= 2.4 && < 2.6,
6396 syb >= 0.5 && < 0.8,
64− these >= 0.4 && < 0.7.6,
65− time >= 1.4 && < 1.9,
66− transformers >= 0.2,
67− transformers-compat >= 0.3,
68− 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
69109
70110 exposed-modules:
111+ Control.Monad.ReaderIO
71112 Data.AppendMap,
72113 Data.FastMutableIntMap,
73114 Data.FastWeakBag,
74− Data.Functor.Misc,
75115 Data.Map.Misc,
76116 Data.WeakBag,
77117 Reflex,
@@ -91,15 +131,9 @@ library
91131 Reflex.FastWeak,
92132 Reflex.FunctorMaybe,
93133 Reflex.Host.Class,
134+ Reflex.Host.Headless,
94135 Reflex.Network,
95136 Reflex.NotReady.Class,
96− Reflex.Patch,
97− Reflex.Patch.Class,
98− Reflex.Patch.DMap,
99− Reflex.Patch.DMapWithMove,
100− Reflex.Patch.IntMap,
101− Reflex.Patch.Map,
102− Reflex.Patch.MapWithMove,
103137 Reflex.PerformEvent.Base,
104138 Reflex.PerformEvent.Class,
105139 Reflex.PostBuild.Base,
@@ -118,38 +152,57 @@ library
118152 Reflex.Widget.Basic,
119153 Reflex.Workflow
120154
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+
121165 ghc-options: -Wall -fwarn-redundant-constraints -fwarn-tabs -funbox-strict-fields -O2 -fspecialise-aggressively
122166
123167 if flag(debug-trace-events)
124168 cpp-options: -DDEBUG_TRACE_EVENTS
125− build-depends: bytestring
169+ build-depends:
170+ bytestring >= 0.10.8 && < 0.11
126171
127172 if flag(use-reflex-optimizer)
128173 cpp-options: -DUSE_REFLEX_OPTIMIZER
129174 build-depends: ghc
130175 exposed-modules: Reflex.Optimizer
131176
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+
132183 if flag(use-template-haskell)
133184 cpp-options: -DUSE_TEMPLATE_HASKELL
134185 build-depends:
135− dependent-sum >= 0.5,
136− haskell-src-exts >= 1.16 && < 1.21,
186+ dependent-sum >= 0.6 && < 0.8,
187+ haskell-src-exts >= 1.16 && < 1.24,
137188 haskell-src-meta >= 0.6 && < 0.9,
138− template-haskell >= 2.9 && < 2.15
189+ template-haskell >= 2.9 && < 2.17
139190 exposed-modules:
140191 Reflex.Dynamic.TH
141192 other-extensions: TemplateHaskell
142193 else
143194 build-depends:
144− dependent-sum >= 0.5
195+ dependent-sum >= 0.6 && < 0.8
145196
146197 if flag(fast-weak) && impl(ghcjs)
147198 cpp-options: -DGHCJS_FAST_WEAK
148199
149200 if impl(ghcjs)
150− build-depends: ghcjs-base
201+ build-depends:
202+ ghcjs-base == 0.2.*
151203
152204test-suite semantics
205+ default-language: Haskell2010
153206 type: exitcode-stdio-1.0
154207 main-is: semantics.hs
155208 hs-source-dirs: test
@@ -158,14 +211,14 @@ test-suite semantics
158211 base,
159212 bifunctors,
160213 containers,
161− deepseq >= 1.3 && < 1.5,
214+ deepseq,
162215 dependent-map,
163216 dependent-sum,
164217 mtl,
165218 ref-tf,
166219 reflex,
167220 split,
168− transformers >= 0.3
221+ transformers
169222 other-modules:
170223 Reflex.Bench.Focused
171224 Reflex.Plan.Pure
@@ -175,6 +228,7 @@ test-suite semantics
175228 Reflex.TestPlan
176229
177230test-suite CrossImpl
231+ default-language: Haskell2010
178232 type: exitcode-stdio-1.0
179233 main-is: Reflex/Test/CrossImpl.hs
180234 hs-source-dirs: test
@@ -184,7 +238,7 @@ test-suite CrossImpl
184238 containers,
185239 dependent-map,
186240 dependent-sum,
187− deepseq >= 1.3 && < 1.5,
241+ deepseq,
188242 mtl,
189243 transformers,
190244 ref-tf,
@@ -196,6 +250,7 @@ test-suite CrossImpl
196250 Reflex.Plan.Pure
197251
198252test-suite hlint
253+ default-language: Haskell2010
199254 type: exitcode-stdio-1.0
200255 main-is: hlint.hs
201256 hs-source-dirs: test
@@ -203,17 +258,21 @@ test-suite hlint
203258 , directory
204259 , filepath
205260 , filemanip
206− , 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
207265 if impl(ghcjs)
208266 buildable: False
209267
210268test-suite EventWriterT
269+ default-language: Haskell2010
211270 type: exitcode-stdio-1.0
212271 main-is: EventWriterT.hs
213272 hs-source-dirs: test
214273 build-depends: base
215274 , containers
216− , deepseq >= 1.3 && < 1.5
275+ , deepseq
217276 , dependent-map
218277 , dependent-sum
219278 , lens
@@ -222,31 +281,96 @@ test-suite EventWriterT
222281 , transformers
223282 , reflex
224283 , ref-tf
284+
285+ if flag(split-these)
286+ build-depends: these-lens
287+
225288 other-modules:
226− Reflex.Test
227− Reflex.TestPlan
228− Reflex.Plan.Reflex
229− Reflex.Plan.Pure
230289 Test.Run
231290
232−test-suite RequesterT
291+
292+test-suite DebugCycles
293+ default-language: Haskell2010
233294 type: exitcode-stdio-1.0
234− main-is: RequesterT.hs
295+ main-is: DebugCycles.hs
235296 hs-source-dirs: test
297+ ghc-options: -threaded
236298 build-depends: base
237− , dependent-sum
299+ , containers
300+ , deepseq
238301 , dependent-map
302+ , dependent-sum
303+ , hspec
239304 , lens
305+ , mtl
240306 , these
241307 , transformers
242308 , reflex
243309 , ref-tf
244− buildable: False
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+
320+
321+test-suite RequesterT
322+ default-language: Haskell2010
323+ type: exitcode-stdio-1.0
324+ main-is: RequesterT.hs
325+ hs-source-dirs: test
326+ build-depends: base
327+ , constraints
328+ , constraints-extras
329+ , containers
330+ , deepseq
331+ , dependent-map
332+ , dependent-sum
333+ , lens
334+ , mtl
335+ , ref-tf
336+ , reflex
337+ , text
338+ , these
339+ , transformers
340+
341+ if flag(split-these)
342+ build-depends: these-lens
343+
245344 other-modules:
246345 Reflex.TestPlan
247346 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
365+ , reflex
366+ , ref-tf
367+ , these
368+
369+ other-modules:
370+ Test.Run
248371
249372test-suite QueryT
373+ default-language: Haskell2010
250374 type: exitcode-stdio-1.0
251375 main-is: QueryT.hs
252376 hs-source-dirs: test
@@ -254,15 +378,19 @@ test-suite QueryT
254378 , containers
255379 , dependent-map
256380 , dependent-sum
257− , deepseq >= 1.3 && < 1.5
381+ , deepseq
258382 , lens
259383 , monoidal-containers
260384 , mtl
385+ , patch
261386 , ref-tf
262387 , reflex
263− , semigroups
264388 , these
265389 , transformers
390+
391+ if flag(split-these)
392+ build-depends: semialign, these-lens
393+
266394 other-modules:
267395 Test.Run
268396 Reflex.TestPlan
@@ -270,6 +398,7 @@ test-suite QueryT
270398 Reflex.Plan.Pure
271399
272400test-suite GC-Semantics
401+ default-language: Haskell2010
273402 type: exitcode-stdio-1.0
274403 main-is: GC.hs
275404 hs-source-dirs: test
@@ -277,14 +406,17 @@ test-suite GC-Semantics
277406 , containers
278407 , dependent-sum
279408 , dependent-map
280− , deepseq >= 1.3 && < 1.5
409+ , deepseq
281410 , mtl
411+ , patch
282412 , these
283413 , transformers
284414 , reflex
285415 , ref-tf
286− if impl(ghc < 8)
287− build-depends: semigroups
416+
417+ if flag(split-these)
418+ build-depends: semialign
419+
288420 other-modules:
289421 Reflex.Plan.Pure
290422 Reflex.Plan.Reflex
@@ -292,12 +424,13 @@ test-suite GC-Semantics
292424 Test.Run
293425
294426test-suite rootCleanup
427+ default-language: Haskell2010
295428 type: exitcode-stdio-1.0
296429 main-is: rootCleanup.hs
297430 hs-source-dirs: test
298431 build-depends: base
299432 , containers
300− , deepseq >= 1.3 && < 1.5
433+ , deepseq
301434 , dependent-sum
302435 , mtl
303436 , reflex
@@ -309,6 +442,7 @@ test-suite rootCleanup
309442 Test.Run
310443
311444benchmark spider-bench
445+ default-language: Haskell2010
312446 type: exitcode-stdio-1.0
313447 hs-source-dirs: bench test
314448 main-is: Main.hs
@@ -316,8 +450,8 @@ benchmark spider-bench
316450 build-depends:
317451 base,
318452 containers,
319− criterion >= 1.1 && < 1.6,
320− deepseq >= 1.3 && < 1.5,
453+ criterion,
454+ deepseq,
321455 dependent-map,
322456 dependent-sum,
323457 ref-tf,
@@ -326,13 +460,14 @@ benchmark spider-bench
326460 reflex,
327461 split,
328462 stm,
329− transformers >= 0.3
463+ transformers
330464 other-modules:
331465 Reflex.TestPlan
332466 Reflex.Plan.Reflex
333467 Reflex.Bench.Focused
334468
335469benchmark saulzar-bench
470+ default-language: Haskell2010
336471 type: exitcode-stdio-1.0
337472 hs-source-dirs: bench test
338473 c-sources: bench-cbits/checkCapability.c
@@ -340,9 +475,9 @@ benchmark saulzar-bench
340475 ghc-options: -Wall -O2 -rtsopts -threaded
341476 build-depends:
342477 base,
343− containers >= 0.5 && < 0.7,
344− criterion >= 1.1 && < 1.6,
345− deepseq >= 1.3 && < 1.5,
478+ containers,
479+ criterion,
480+ deepseq,
346481 dependent-map,
347482 dependent-sum,
348483 loch-th,
@@ -354,7 +489,7 @@ benchmark saulzar-bench
354489 split,
355490 stm,
356491 time,
357− transformers >= 0.3
492+ transformers
358493 other-modules:
359494 Reflex.TestPlan
360495 Reflex.Plan.Reflex
release.nix+56−7
@@ -1,9 +1,58 @@
1−{ rp ? import ./reflex-platform.nix {}
1+{ reflex-platform-fun ? import ./dep/reflex-platform
2+, supportedSystems ? ["x86_64-linux" "x86_64-darwin"]
23}:
4+
35let
4− inherit (rp.nixpkgs) lib;
5− compilers = ["ghc8_4" "ghc8_0" "ghcjs8_4" "ghcjs8_0"];
6−in lib.genAttrs compilers (ghc: {
7− reflex-useTemplateHaskell = rp.${ghc}.callPackage ./. { useTemplateHaskell = true; };
8− reflex = rp.${ghc}.callPackage ./. { useTemplateHaskell = false; };
9−})
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+24−21
@@ -1,27 +1,26 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveGeneric #-}
4−{-# LANGUAGE DeriveTraversable #-}
52{-# LANGUAGE FlexibleContexts #-}
63{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
84{-# LANGUAGE MultiParamTypeClasses #-}
95{-# LANGUAGE PatternSynonyms #-}
106{-# LANGUAGE RoleAnnotations #-}
117{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE StandaloneDeriving #-}
138{-# LANGUAGE TypeFamilies #-}
149{-# OPTIONS_GHC -fno-warn-orphans #-}
15−-- | 'Data.Map' with a better 'Monoid' instance
16−--
17−-- 'Data.Map' has @mappend = union@, which is left-biased. AppendMap has
18−-- @mappend = unionWith mappend@ instead.
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.
1918module Data.AppendMap
2019 ( module Data.AppendMap
2120 , module Data.Map.Monoidal
2221 ) where
2322
24−import Prelude hiding (map, null)
23+import Prelude hiding (null)
2524
2625import Data.Coerce
2726import Data.Default
@@ -31,22 +30,28 @@ import qualified Data.Map.Internal.Debug as Map (showTree, showTreeWith)
3130#else
3231import qualified Data.Map as Map (showTree, showTreeWith)
3332#endif
33+import qualified Data.Witherable as W
3434import Data.Map.Monoidal
35−import Reflex.Class (FunctorMaybe (..))
36−import Reflex.Patch (Additive, Group (..))
35+import qualified Data.Map.Monoidal as MonoidalMap
36+
3737
3838{-# DEPRECATED AppendMap "Use 'MonoidalMap' instead" #-}
39+-- | AppendMap is a synonym for 'Data.Map.Monoidal.MonoidalMap'
3940type AppendMap = MonoidalMap
4041
4142{-# DEPRECATED _unAppendMap "Use 'getMonoidalMap' instead" #-}
43+-- | A synonym for 'getMonoidalMap'
4244_unAppendMap :: MonoidalMap k v -> Map k v
4345_unAppendMap = getMonoidalMap
4446
47+-- | Pattern synonym for 'MonoidalMap'
4548pattern AppendMap :: Map k v -> MonoidalMap k v
4649pattern AppendMap m = MonoidalMap m
4750
48−instance FunctorMaybe (MonoidalMap k) where
49− fmapMaybe = mapMaybe
51+#if !MIN_VERSION_witherable(0,3,2)
52+instance W.Filterable (MonoidalMap k) where
53+ mapMaybe = MonoidalMap.mapMaybe
54+#endif
5055
5156-- | Deletes a key, returning 'Nothing' if the result is empty.
5257nonEmptyDelete :: Ord k => k -> MonoidalMap k a -> Maybe (MonoidalMap k a)
@@ -56,24 +61,22 @@ nonEmptyDelete k vs =
5661 then Nothing
5762 else Just deleted
5863
64+-- | Like 'mapMaybe' but indicates whether the resulting container is empty
5965mapMaybeNoNull :: (a -> Maybe b)
6066 -> MonoidalMap token a
6167 -> Maybe (MonoidalMap token b)
6268mapMaybeNoNull f as =
63− let bs = fmapMaybe f as
69+ let bs = mapMaybe f as
6470 in if null bs
6571 then Nothing
6672 else Just bs
6773
68−-- TODO: Move instances to `Reflex.Patch`
69−instance (Ord k, Group q) => Group (MonoidalMap k q) where
70− negateG = map negateG
71−
72−instance (Ord k, Additive q) => Additive (MonoidalMap k q)
73−
74+-- TODO: Move instances to `Data.Patch`
75+-- | Displays a 'MonoidalMap' as a tree. See 'Data.Map.Lazy.showTree' for details.
7476showTree :: forall k a. (Show k, Show a) => MonoidalMap k a -> String
7577showTree = coerce (Map.showTree :: Map k a -> String)
7678
79+-- | Displays a 'MonoidalMap' as a tree, using the supplied function to convert nodes to string.
7780showTreeWith :: forall k a. (k -> a -> String) -> Bool -> Bool -> MonoidalMap k a -> String
7881showTreeWith = coerce (Map.showTreeWith :: (k -> a -> String) -> Bool -> Bool -> Map k a -> String)
7982
src/Data/FastMutableIntMap.hs+23−2
@@ -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,6 +21,7 @@ module Data.FastMutableIntMap
1621 , patchIntMapNewElements
1722 , patchIntMapNewElementsMap
1823 , getDeletions
24+ , toList
1925 ) where
2026
2127--TODO: Pure JS version
@@ -29,36 +35,46 @@ import Data.Foldable (traverse_)
2935import Data.IntMap.Strict (IntMap)
3036import qualified Data.IntMap.Strict as IntMap
3137import Data.IORef
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+10−5
@@ -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.
@@ -50,7 +51,7 @@ newtype FastWeakBag a = FastWeakBag JSVal
5051#else
5152data FastWeakBag a = FastWeakBag
5253 { _weakBag_nextId :: {-# UNPACK #-} !(IORef Int) --TODO: what if this wraps around?
53− , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a)))
54+ , _weakBag_children :: {-# UNPACK #-} !(IORef (IntMap (Weak a))) -- ^ Map of items contained by the 'FastWeakBag'
5455 }
5556#endif
5657
@@ -116,14 +117,14 @@ foreign import javascript unsafe "(function(){ for(var i = 0; i < $1.tickets.len
116117isEmpty bag = {-# SCC "isEmpty" #-} IntMap.null <$> readIORef (_weakBag_children bag)
117118#endif
118119
119−{-# INLINE traverse #-}
120+{-# INLINE traverse_ #-}
120121-- | Visit every node in the given list. If new nodes are appended during the
121122-- traversal, they will not be visited. Every live node that was in the list
122123-- when the traversal began will be visited exactly once; however, no guarantee
123124-- is made about the order of the traversal.
124−traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
125+traverse_ :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
125126#ifdef GHCJS_FAST_WEAK
126−traverse wb f = do
127+traverse_ wb f = do
127128 let go cursor = when (not $ js_isNull cursor) $ do
128129 val <- liftIO $ js_getTicketValue cursor
129130 f $ unsafeFromRawJSVal val
@@ -134,13 +135,17 @@ foreign import javascript unsafe "$r = $1.val;" js_getTicketValue :: JSVal -> IO
134135--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
135136foreign 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
136137#else
137−traverse (FastWeakBag _ children) f = {-# SCC "traverse" #-} do
138+traverse_ (FastWeakBag _ children) f = {-# SCC "traverse_" #-} do
138139 cs <- liftIO $ readIORef children
139140 forM_ cs $ \c -> do
140141 ma <- liftIO $ deRefWeak c
141142 mapM_ f ma
142143#endif
143144
145+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
146+traverse :: forall a m. MonadIO m => FastWeakBag a -> (a -> m ()) -> m ()
147+traverse = traverse_
148+
144149-- | Remove an item from the 'FastWeakBag'; does nothing if invoked multiple times
145150-- on the same 'FastWeakBagTicket'.
146151{-# INLINE remove #-}
src/Data/Functor/Misc.hsdeleted−279
@@ -1,279 +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 Eq k => GEq (Const2 k v) where
90− geq (Const2 a) (Const2 b) =
91− if a == b
92− then Just Refl
93− else Nothing
94−
95−instance Ord k => GCompare (Const2 k v) where
96− gcompare (Const2 a) (Const2 b) = case compare a b of
97− LT -> GLT
98− EQ -> GEQ
99− GT -> GGT
100−
101−-- | Convert a 'DMap' to a regular 'Map'
102−dmapToMap :: DMap (Const2 k v) Identity -> Map k v
103−dmapToMap = Map.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
104−
105−-- | Convert a 'DMap' to an 'IntMap'
106−dmapToIntMap :: DMap (Const2 IntMap.Key v) Identity -> IntMap v
107−dmapToIntMap = IntMap.fromDistinctAscList . map (\(Const2 k :=> Identity v) -> (k, v)) . DMap.toAscList
108−
109−-- | Convert a 'DMap' to a regular 'Map', applying the given function to remove
110−-- the wrapping 'Functor'
111−dmapToMapWith :: (f v -> v') -> DMap (Const2 k v) f -> Map k v'
112−dmapToMapWith f = Map.fromDistinctAscList . map (\(Const2 k :=> v) -> (k, f v)) . DMap.toAscList
113−
114−-- | Convert a regular 'Map' to a 'DMap'
115−mapToDMap :: Map k v -> DMap (Const2 k v) Identity
116−mapToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> Identity v) . Map.toAscList
117−
118−-- | Convert a regular 'Map', where the values are already wrapped in a functor,
119−-- to a 'DMap'
120−mapWithFunctorToDMap :: Map k (f v) -> DMap (Const2 k v) f
121−mapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . Map.toAscList
122−
123−-- | Convert a regular 'IntMap', where the values are already wrapped in a
124−-- functor, to a 'DMap'
125−intMapWithFunctorToDMap :: IntMap (f v) -> DMap (Const2 IntMap.Key v) f
126−intMapWithFunctorToDMap = DMap.fromDistinctAscList . map (\(k, v) -> Const2 k :=> v) . IntMap.toAscList
127−
128−-- | Convert a 'DMap' to a regular 'Map' by forgetting the types associated with
129−-- the keys, using a function to remove the wrapping 'Functor'
130−weakenDMapWith :: (forall a. v a -> v') -> DMap k v -> Map (Some k) v'
131−weakenDMapWith f = Map.fromDistinctAscList . map (\(k :=> v) -> (Some.This k, f v)) . DMap.toAscList
132−
133−--------------------------------------------------------------------------------
134−-- WrapArg
135−--------------------------------------------------------------------------------
136−
137−-- | 'WrapArg' can be used to tag a value in one functor with a type
138−-- representing another functor. This was primarily used with dependent-map <
139−-- 0.2, in which the value type was not wrapped in a separate functor.
140−data WrapArg :: (k -> *) -> (k -> *) -> * -> * where
141− WrapArg :: f a -> WrapArg g f (g a)
142−
143−deriving instance Eq (f a) => Eq (WrapArg g f (g' a))
144−deriving instance Ord (f a) => Ord (WrapArg g f (g' a))
145−deriving instance Show (f a) => Show (WrapArg g f (g' a))
146−deriving instance Read (f a) => Read (WrapArg g f (g a))
147−
148−instance GEq f => GEq (WrapArg g f) where
149− geq (WrapArg a) (WrapArg b) = (\Refl -> Refl) <$> geq a b
150−
151−instance GCompare f => GCompare (WrapArg g f) where
152− gcompare (WrapArg a) (WrapArg b) = case gcompare a b of
153− GLT -> GLT
154− GEQ -> GEQ
155− GGT -> GGT
156−
157−--------------------------------------------------------------------------------
158−-- Convenience functions for DMap
159−--------------------------------------------------------------------------------
160−
161−-- | Map over all key/value pairs in a 'DMap', potentially altering the key as
162−-- well as the value. The provided function MUST preserve the ordering of the
163−-- keys, or the resulting 'DMap' will be malformed.
164−mapKeyValuePairsMonotonic :: (DSum k v -> DSum k' v') -> DMap k v -> DMap k' v'
165−mapKeyValuePairsMonotonic f = DMap.fromDistinctAscList . map f . DMap.toAscList
166−
167−{-# INLINE combineDMapsWithKey #-}
168−-- | Union two 'DMap's of different types, yielding another type. Each key that
169−-- is present in either input map will be present in the output.
170−combineDMapsWithKey :: forall f g h i.
171− GCompare f
172− => (forall a. f a -> These (g a) (h a) -> i a)
173− -> DMap f g
174− -> DMap f h
175− -> DMap f i
176−combineDMapsWithKey f mg mh = DMap.fromList $ go (DMap.toList mg) (DMap.toList mh)
177− where go :: [DSum f g] -> [DSum f h] -> [DSum f i]
178− go [] hs = map (\(hk :=> hv) -> hk :=> f hk (That hv)) hs
179− go gs [] = map (\(gk :=> gv) -> gk :=> f gk (This gv)) gs
180− go gs@((gk :=> gv) : gs') hs@((hk :=> hv) : hs') = case gk `gcompare` hk of
181− GLT -> (gk :=> f gk (This gv)) : go gs' hs
182− GEQ -> (gk :=> f gk (These gv hv)) : go gs' hs'
183− GGT -> (hk :=> f hk (That hv)) : go gs hs'
184−
185−-- | Extract the values of a 'DMap' of 'EitherTag's.
186−dmapToThese :: DMap (EitherTag a b) Identity -> Maybe (These a b)
187−dmapToThese m = case (DMap.lookup LeftTag m, DMap.lookup RightTag m) of
188− (Nothing, Nothing) -> Nothing
189− (Just (Identity a), Nothing) -> Just $ This a
190− (Nothing, Just (Identity b)) -> Just $ That b
191− (Just (Identity a), Just (Identity b)) -> Just $ These a b
192−
193−-- | Tag type for 'Either' to use it as a 'DSum'.
194−data EitherTag l r a where
195− LeftTag :: EitherTag l r l
196− RightTag :: EitherTag l r r
197− deriving (Typeable)
198−
199−deriving instance Show (EitherTag l r a)
200−deriving instance Eq (EitherTag l r a)
201−deriving instance Ord (EitherTag l r a)
202−
203−instance GEq (EitherTag l r) where
204− geq a b = case (a, b) of
205− (LeftTag, LeftTag) -> Just Refl
206− (RightTag, RightTag) -> Just Refl
207− _ -> Nothing
208−
209−instance GCompare (EitherTag l r) where
210− gcompare a b = case (a, b) of
211− (LeftTag, LeftTag) -> GEQ
212− (LeftTag, RightTag) -> GLT
213− (RightTag, LeftTag) -> GGT
214− (RightTag, RightTag) -> GEQ
215−
216−instance GShow (EitherTag l r) where
217− gshowsPrec _ a = case a of
218− LeftTag -> showString "LeftTag"
219− RightTag -> showString "RightTag"
220−
221−-- | Convert 'Either' to a 'DSum'. Inverse of 'dsumToEither'.
222−eitherToDSum :: Either a b -> DSum (EitherTag a b) Identity
223−eitherToDSum = \case
224− Left a -> (LeftTag :=> Identity a)
225− Right b -> (RightTag :=> Identity b)
226−
227−-- | Convert 'DSum' to 'Either'. Inverse of 'eitherToDSum'.
228−dsumToEither :: DSum (EitherTag a b) Identity -> Either a b
229−dsumToEither = \case
230− (LeftTag :=> Identity a) -> Left a
231− (RightTag :=> Identity b) -> Right b
232−
233−--------------------------------------------------------------------------------
234−-- ComposeMaybe
235−--------------------------------------------------------------------------------
236−
237−-- | We can't use @Compose Maybe@ instead of 'ComposeMaybe', because that would
238−-- make the 'f' parameter have a nominal type role. We need f to be
239−-- representational so that we can use safe 'coerce'.
240−newtype ComposeMaybe f a =
241− ComposeMaybe { getComposeMaybe :: Maybe (f a) } deriving (Show, Eq, Ord)
242−
243−deriving instance Functor f => Functor (ComposeMaybe f)
244−
245−--------------------------------------------------------------------------------
246−-- Deprecated functions
247−--------------------------------------------------------------------------------
248−
249−{-# INLINE sequenceDmap #-}
250−{-# DEPRECATED sequenceDmap "Use 'Data.Dependent.Map.traverseWithKey (\\_ -> fmap Identity)' instead" #-}
251−-- | Run the actions contained in the 'DMap'
252−sequenceDmap :: Applicative t => DMap f t -> t (DMap f Identity)
253−sequenceDmap = DMap.traverseWithKey $ \_ t -> Identity <$> t
254−
255−{-# DEPRECATED wrapDMap "Use 'Data.Dependent.Map.map (f . runIdentity)' instead" #-}
256−-- | Replace the 'Identity' functor for a 'DMap''s values with a different functor
257−wrapDMap :: (forall a. a -> f a) -> DMap k Identity -> DMap k f
258−wrapDMap f = DMap.map $ f . runIdentity
259−
260−{-# DEPRECATED rewrapDMap "Use 'Data.Dependent.Map.map' instead" #-}
261−-- | Replace one functor for a 'DMap''s values with a different functor
262−rewrapDMap :: (forall (a :: *). f a -> g a) -> DMap k f -> DMap k g
263−rewrapDMap = DMap.map
264−
265−{-# DEPRECATED unwrapDMap "Use 'Data.Dependent.Map.map (Identity . f)' instead" #-}
266−-- | Replace one functor for a 'DMap''s values with the 'Identity' functor
267−unwrapDMap :: (forall a. f a -> a) -> DMap k f -> DMap k Identity
268−unwrapDMap f = DMap.map $ Identity . f
269−
270−{-# DEPRECATED unwrapDMapMaybe "Use 'Data.Dependent.Map.mapMaybeWithKey (\\_ a -> fmap Identity $ f a)' instead" #-}
271−-- | Like 'unwrapDMap', but possibly delete some values from the DMap
272−unwrapDMapMaybe :: GCompare k => (forall a. f a -> Maybe a) -> DMap k f -> DMap k Identity
273−unwrapDMapMaybe f = DMap.mapMaybeWithKey $ \_ a -> Identity <$> f a
274−
275−{-# DEPRECATED extractFunctorDMap "Use 'mapKeyValuePairsMonotonic (\\(Const2 k :=> Identity v) -> Const2 k :=> v)' instead" #-}
276−-- | Eliminate the 'Identity' functor in a 'DMap' and replace it with the
277−-- underlying functor
278−extractFunctorDMap :: DMap (Const2 k (f v)) Identity -> DMap (Const2 k v) f
279−extractFunctorDMap = mapKeyValuePairsMonotonic $ \(Const2 k :=> Identity v) -> Const2 k :=> v
src/Data/Map/Misc.hs+1−1
@@ -43,7 +43,7 @@ diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
4343
4444-- |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@.
4545--
46−-- See also 'Reflex.Patch.Map' and 'Reflex.Patch.MapWithMove'.
46+-- See also 'Data.Patch.Map' and 'Data.Patch.MapWithMove'.
4747applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
4848applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
4949 where (deletions, insertions) = Map.mapEither maybeToEither patch
src/Data/WeakBag.hs+8−3
@@ -15,6 +15,7 @@ module Data.WeakBag
1515 , singleton
1616 , insert
1717 , traverse
18+ , traverse_
1819 , remove
1920 -- * Internal functions
2021 -- These will not always be available.
@@ -99,18 +100,22 @@ singleton a wbRef finalizer = {-# SCC "singleton" #-} do
99100 ticket <- insert a bag wbRef finalizer
100101 return (bag, ticket)
101102
102−{-# INLINE traverse #-}
103+{-# INLINE traverse_ #-}
103104-- | Visit every node in the given list. If new nodes are appended during the
104105-- traversal, they will not be visited. Every live node that was in the list
105106-- when the traversal began will be visited exactly once; however, no guarantee
106107-- is made about the order of the traversal.
107−traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
108−traverse (WeakBag _ children) f = {-# SCC "traverse" #-} do
108+traverse_ :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
109+traverse_ (WeakBag _ children) f = {-# SCC "traverse" #-} do
109110 cs <- liftIO $ readIORef children
110111 forM_ cs $ \c -> do
111112 ma <- liftIO $ deRefWeak c
112113 mapM_ f ma
113114
115+{-# DEPRECATED traverse "Use 'traverse_' instead" #-}
116+traverse :: MonadIO m => WeakBag a -> (a -> m ()) -> m ()
117+traverse = traverse_
118+
114119-- | Remove an item from the 'WeakBag'; does nothing if invoked multiple times
115120-- on the same 'WeakBagTicket'.
116121{-# INLINE remove #-}
src/Reflex.hs+1
@@ -19,6 +19,7 @@ import Reflex.Dynamic.TH as X
1919import Reflex.Dynamic.Uniq as X
2020import Reflex.DynamicWriter.Base as X
2121import Reflex.DynamicWriter.Class as X
22+import Reflex.NotReady.Class as X
2223import Reflex.PerformEvent.Base as X
2324import Reflex.PerformEvent.Class as X
2425import Reflex.PostBuild.Base as X
src/Reflex/Adjustable/Class.hs+33−6
@@ -3,7 +3,6 @@
33{-# LANGUAGE FlexibleInstances #-}
44{-# LANGUAGE FunctionalDependencies #-}
55{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
76{-# LANGUAGE RankNTypes #-}
87{-# LANGUAGE ScopedTypeVariables #-}
98{-# LANGUAGE TypeFamilies #-}
@@ -11,6 +10,13 @@
1110#ifdef USE_REFLEX_OPTIMIZER
1211{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1312#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.
1420module Reflex.Adjustable.Class
1521 (
1622 -- * The Adjustable typeclass
@@ -24,7 +30,8 @@ module Reflex.Adjustable.Class
2430
2531import Control.Monad.Identity
2632import Control.Monad.Reader
27−import Data.Dependent.Map (DMap, GCompare (..))
33+import Data.Dependent.Map (DMap)
34+import Data.GADT.Compare (GCompare(..))
2835import qualified Data.Dependent.Map as DMap
2936import Data.Functor.Constant
3037import Data.Functor.Misc
@@ -33,7 +40,7 @@ import qualified Data.IntMap.Strict as IntMap
3340import Data.Map (Map)
3441
3542import Reflex.Class
36−import Reflex.Patch.DMapWithMove
43+import Data.Patch.DMapWithMove
3744
3845-- | A 'Monad' that supports adjustment over time. After an action has been
3946-- run, if the given events fire, it will adjust itself so that its net effect
@@ -94,13 +101,32 @@ instance Adjustable t m => Adjustable t (ReaderT r m) where
94101 r <- ask
95102 lift $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runReaderT (f k v) r) dm0 dm'
96103
97−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))
98111sequenceDMapWithAdjust = traverseDMapWithKeyWithAdjust $ \_ -> fmap Identity
99112
100−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))
101120sequenceDMapWithAdjustWithMove = traverseDMapWithKeyWithAdjustWithMove $ \_ -> fmap Identity
102121
103−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'))
104130mapMapWithAdjustWithMove f m0 m' = do
105131 (out0 :: DMap (Const2 k v) (Constant v'), out') <- traverseDMapWithKeyWithAdjustWithMove (\(Const2 k) (Identity v) -> Constant <$> f k v) (mapToDMap m0) (const2PatchDMapWithMoveWith Identity <$> m')
106132 return (dmapToMapWith (\(Constant v') -> v') out0, patchDMapWithMoveToPatchMapWithMoveWith (\(Constant v') -> v') <$> out')
@@ -110,4 +136,5 @@ mapMapWithAdjustWithMove f m0 m' = do
110136--------------------------------------------------------------------------------
111137
112138{-# DEPRECATED MonadAdjust "Use Adjustable instead" #-}
139+-- | Synonym for 'Adjustable'
113140type MonadAdjust = Adjustable
src/Reflex/BehaviorWriter/Base.hs+16−7
@@ -1,6 +1,6 @@
11{-|
22Module: Reflex.BehaviorWriter.Base
3−Description: Implementation of MonadBehaviorWriter
3+Description: Implementation of BehaviorWriter
44-}
55{-# LANGUAGE CPP #-}
66{-# LANGUAGE FlexibleInstances #-}
@@ -24,6 +24,7 @@ module Reflex.BehaviorWriter.Base
2424import Control.Monad.Exception
2525import Control.Monad.Identity
2626import Control.Monad.IO.Class
27+import Control.Monad.Morph
2728import Control.Monad.Reader
2829import Control.Monad.Ref
2930import Control.Monad.State.Strict
@@ -46,9 +47,20 @@ import Reflex.Query.Class
4647import Reflex.Requester.Class
4748import Reflex.TriggerEvent.Class
4849
49−-- | A basic implementation of 'MonadBehaviorWriter'.
50+-- | A basic implementation of 'BehaviorWriter'.
5051newtype BehaviorWriterT t w m a = BehaviorWriterT { unBehaviorWriterT :: StateT [Behavior t w] m a }
51− deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadAsyncException, MonadException) -- The list is kept in reverse order
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+ )
5264
5365-- | Run a 'BehaviorWriterT' action. The behavior writer output will be provided
5466-- along with the result of the action.
@@ -73,9 +85,6 @@ withBehaviorWriterT f dw = do
7385deriving instance MonadHold t m => MonadHold t (BehaviorWriterT t w m)
7486deriving instance MonadSample t m => MonadSample t (BehaviorWriterT t w m)
7587
76−instance MonadTrans (BehaviorWriterT t w) where
77− lift = BehaviorWriterT . lift
78−
7988instance MonadRef m => MonadRef (BehaviorWriterT t w m) where
8089 type Ref (BehaviorWriterT t w m) = Ref m
8190 newRef = lift . newRef
@@ -89,7 +98,7 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (BehaviorWri
8998 newEventWithTrigger = lift . newEventWithTrigger
9099 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
91100
92−instance (Monad m, Monoid w, Reflex t) => MonadBehaviorWriter t w (BehaviorWriterT t w m) where
101+instance (Monad m, Monoid w, Reflex t) => BehaviorWriter t w (BehaviorWriterT t w m) where
93102 tellBehavior w = BehaviorWriterT $ modify (w :)
94103
95104instance MonadReader r m => MonadReader r (BehaviorWriterT t w m) where
src/Reflex/BehaviorWriter/Class.hs+11−6
@@ -1,26 +1,31 @@
11{-|
22Module: Reflex.BehaviorWriter.Class
3−Description: This module defines the 'MonadBehaviorWriter' class
3+Description: This module defines the 'BehaviorWriter' class
44-}
55{-# LANGUAGE CPP #-}
6+{-# LANGUAGE ConstraintKinds #-}
67{-# LANGUAGE FlexibleInstances #-}
78{-# LANGUAGE FunctionalDependencies #-}
8−{-# LANGUAGE MultiParamTypeClasses #-}
99{-# LANGUAGE UndecidableInstances #-}
1010#ifdef USE_REFLEX_OPTIMIZER
1111{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
1212#endif
1313module Reflex.BehaviorWriter.Class
14− ( MonadBehaviorWriter (..)
14+ ( MonadBehaviorWriter
15+ , BehaviorWriter(..)
1516 ) where
1617
1718import Control.Monad.Reader (ReaderT, lift)
1819import Reflex.Class (Behavior)
1920
20−-- | 'MonadBehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
21+{-# DEPRECATED MonadBehaviorWriter "Use 'BehaviorWriter' instead" #-}
22+-- | Type synonym for 'BehaviorWriter'
23+type MonadBehaviorWriter = BehaviorWriter
24+
25+-- | 'BehaviorWriter' efficiently collects 'Behavior' values using 'tellBehavior'
2126-- and combines them monoidally to provide a 'Behavior' result.
22−class (Monad m, Monoid w) => MonadBehaviorWriter t w m | m -> t w where
27+class (Monad m, Monoid w) => BehaviorWriter t w m | m -> t w where
2328 tellBehavior :: Behavior t w -> m ()
2429
25−instance MonadBehaviorWriter t w m => MonadBehaviorWriter t w (ReaderT r m) where
30+instance BehaviorWriter t w m => BehaviorWriter t w (ReaderT r m) where
2631 tellBehavior = lift . tellBehavior
src/Reflex/Class.hs+467−126
@@ -7,7 +7,6 @@
77{-# LANGUAGE FunctionalDependencies #-}
88{-# LANGUAGE GADTs #-}
99{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
1110{-# LANGUAGE NoMonomorphismRestriction #-}
1211{-# LANGUAGE PolyKinds #-}
1312{-# LANGUAGE RankNTypes #-}
@@ -17,31 +16,41 @@
1716{-# LANGUAGE TypeFamilies #-}
1817{-# LANGUAGE TypeOperators #-}
1918{-# LANGUAGE UndecidableInstances #-}
19+{-# LANGUAGE Trustworthy #-}
2020#ifdef USE_REFLEX_OPTIMIZER
2121{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
2222#endif
2323
24−-- | This module contains the Reflex interface, as well as a variety of
25−-- convenience functions for working with 'Event's, 'Behavior's, and other
26−-- 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.
2731module Reflex.Class
28− ( module Reflex.Patch
32+ ( module Data.Patch
2933 -- * Primitives
3034 , Reflex (..)
3135 , mergeInt
3236 , coerceBehavior
3337 , coerceEvent
3438 , coerceDynamic
39+ , coerceIncremental
3540 , MonadSample (..)
3641 , MonadHold (..)
3742 -- ** 'fan' related types
3843 , EventSelector (..)
44+ , EventSelectorG (..)
3945 , EventSelectorInt (..)
4046 -- * Convenience functions
4147 , constDyn
4248 , pushAlways
4349 -- ** Combining 'Event's
4450 , leftmost
51+ , merge
52+ , mergeIncremental
53+ , mergeIncrementalWithMove
4554 , mergeMap
4655 , mergeIntMap
4756 , mergeMapIncremental
@@ -56,6 +65,7 @@ module Reflex.Class
5665 , alignEventWithMaybe
5766 -- ** Breaking up 'Event's
5867 , splitE
68+ , fan
5969 , fanEither
6070 , fanThese
6171 , fanMap
@@ -80,6 +90,7 @@ module Reflex.Class
8090 , gate
8191 -- ** Combining 'Dynamic's
8292 , distributeDMapOverDynPure
93+ , distributeDMapOverDynPureG
8394 , distributeListOverDyn
8495 , distributeListOverDynWith
8596 , zipDyn
@@ -133,8 +144,10 @@ module Reflex.Class
133144 -- * Unsafe functions
134145 , unsafeDynamic
135146 , unsafeMapIncremental
136− -- * 'FunctorMaybe'
137− , 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
138151 , fforMaybe
139152 , ffilter
140153 , filterLeft
@@ -144,10 +157,11 @@ module Reflex.Class
144157 , ffor2
145158 , ffor3
146159 -- * Deprecated functions
147− , appendEvents
148− , onceE
149− , sequenceThese
160+ , switchPromptly
161+ , switchPromptOnly
162+ -- * "Cheap" functions
150163 , fmapMaybeCheap
164+ , mapMaybeCheap
151165 , fmapCheap
152166 , fforCheap
153167 , fforMaybeCheap
@@ -155,12 +169,21 @@ module Reflex.Class
155169 , tagCheap
156170 , mergeWithCheap
157171 , mergeWithCheap'
158− , switchPromptly
159− , switchPromptOnly
160172 -- * Slow, but general, implementations
161173 , slowHeadE
162174 ) where
163175
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+
164187import Control.Applicative
165188import Control.Monad.Identity
166189import Control.Monad.Reader
@@ -173,11 +196,12 @@ import Data.Align
173196import Data.Bifunctor
174197import Data.Coerce
175198import Data.Default
176−import Data.Dependent.Map (DMap, DSum (..))
199+import Data.Dependent.Map (DMap)
200+import Data.Dependent.Sum (DSum (..))
177201import qualified Data.Dependent.Map as DMap
178202import Data.Functor.Compose
179203import Data.Functor.Product
180−import Data.GADT.Compare (GEq (..), GCompare (..), (:~:) (..))
204+import Data.GADT.Compare (GEq (..), GCompare (..))
181205import Data.FastMutableIntMap (PatchIntMap)
182206import Data.Foldable
183207import Data.Functor.Bind
@@ -187,15 +211,18 @@ import Data.IntMap.Strict (IntMap)
187211import qualified Data.IntMap.Strict as IntMap
188212import Data.List.NonEmpty (NonEmpty (..))
189213import Data.Map (Map)
190−import Data.Semigroup (Semigroup, sconcat, stimes, (<>))
191−import Data.Some (Some)
192−import qualified Data.Some as Some
214+import Data.Semigroup (Semigroup (..))
215+import Data.Some (Some(Some))
193216import Data.String
194217import Data.These
195218import Data.Type.Coercion
196−import Reflex.FunctorMaybe
197−import Reflex.Patch
198−import qualified Reflex.Patch.MapWithMove as PatchMapWithMove
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
199226
200227import Debug.Trace (trace)
201228
@@ -248,16 +275,21 @@ class ( MonadHold t (PushM t)
248275 -- | Merge a collection of events; the resulting 'Event' will only occur if at
249276 -- least one input event is occurring, and will contain all of the input keys
250277 -- that are occurring simultaneously
251− 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
252− -- | Efficiently fan-out an event to many destinations. This function should
253− -- be partially applied, and then the result applied repeatedly to create
254− -- child events
255− 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+
256288 -- | Create an 'Event' that will occur whenever the currently-selected input
257289 -- 'Event' occurs
258290 switch :: Behavior t (Event t a) -> Event t a
259− -- | Create an 'Event' that will occur whenever the input event is occurring
260− -- 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.
261293 coincidence :: Event t (Event t a) -> Event t a
262294 -- | Extract the 'Behavior' of a 'Dynamic'.
263295 current :: Dynamic t a -> Behavior t a
@@ -271,9 +303,14 @@ class ( MonadHold t (PushM t)
271303 -- that value.
272304 unsafeBuildIncremental :: Patch p => PullM t (PatchTarget p) -> Event t p -> Incremental t p
273305 -- | Create a merge whose parents can change over time
274− 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)
275310 -- | Experimental: Create a merge whose parents can change over time; changing the key of an Event is more efficient than with mergeIncremental
276− 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)
277314 -- | Extract the 'Behavior' component of an 'Incremental'
278315 currentIncremental :: Patch p => Incremental t p -> Behavior t (PatchTarget p)
279316 -- | Extract the 'Event' component of an 'Incremental'
@@ -289,10 +326,28 @@ class ( MonadHold t (PushM t)
289326 -- | Construct a 'Coercion' for a 'Dynamic' given an 'Coercion' for its
290327 -- occurrence type
291328 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)
292333 mergeIntIncremental :: Incremental t (PatchIntMap (Event t a)) -> Event t (IntMap a)
293334 fanInt :: Event t (IntMap a) -> EventSelectorInt t a
294335
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+
295348--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.
296351mergeInt :: Reflex t => IntMap (Event t a) -> Event t (IntMap a)
297352mergeInt m = mergeIntIncremental $ unsafeBuildIncremental (return m) never
298353
@@ -308,6 +363,12 @@ coerceEvent = coerceWith $ eventCoercion Coercion
308363coerceDynamic :: (Reflex t, Coercible a b) => Dynamic t a -> Dynamic t b
309364coerceDynamic = coerceWith $ dynamicCoercion Coercion
310365
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+
311372-- | Construct a 'Dynamic' from a 'Behavior' and an 'Event'. The 'Behavior'
312373-- __must__ change when and only when the 'Event' fires, such that the
313374-- 'Behavior''s value is always equal to the most recent firing of the 'Event';
@@ -360,27 +421,99 @@ class MonadSample t m => MonadHold t m where
360421 -- | Create a new 'Event' that only occurs only once, on the first occurrence of
361422 -- the supplied 'Event'.
362423 headE :: Event t a -> m (Event t a)
363−
364−accumIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> p) -> PatchTarget p -> Event t b -> m (Incremental t p)
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)
365440accumIncremental f = accumMaybeIncremental $ \v o -> Just $ f v o
366−accumMIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> PushM t p) -> PatchTarget p -> Event t b -> m (Incremental t p)
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)
367449accumMIncremental f = accumMaybeMIncremental $ \v o -> Just <$> f v o
368−accumMaybeIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> Maybe p) -> PatchTarget p -> Event t b -> m (Incremental t p)
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)
369459accumMaybeIncremental f = accumMaybeMIncremental $ \v o -> return $ f v o
370−accumMaybeMIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> PushM t (Maybe p)) -> PatchTarget p -> Event t b -> m (Incremental t p)
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)
371468accumMaybeMIncremental f z e = do
372469 rec let e' = flip push e $ \o -> do
373470 v <- sample $ currentIncremental d'
374471 f v o
375472 d' <- holdIncremental z e'
376473 return d'
377−mapAccumIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> (p, c)) -> PatchTarget p -> Event t b -> m (Incremental t p, Event t c)
474+
475+-- | Accumulate an 'Incremental' by folding occurrences of an 'Event'
476+-- with a function that both accumulates and produces a value to fire
477+-- as an 'Event'. Returns both the accumulated value and the constructed
478+-- 'Event'.
479+mapAccumIncremental
480+ :: (Reflex t, Patch p, MonadHold t m, MonadFix m)
481+ => (PatchTarget p -> b -> (p, c))
482+ -> PatchTarget p
483+ -> Event t b
484+ -> m (Incremental t p, Event t c)
378485mapAccumIncremental f = mapAccumMaybeIncremental $ \v o -> bimap Just Just $ f v o
379−mapAccumMIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> PushM t (p, c)) -> PatchTarget p -> Event t b -> m (Incremental t p, Event t c)
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)
380494mapAccumMIncremental f = mapAccumMaybeMIncremental $ \v o -> bimap Just Just <$> f v o
381−mapAccumMaybeIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> (Maybe p, Maybe c)) -> PatchTarget p -> Event t b -> m (Incremental t p, Event t c)
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)
382508mapAccumMaybeIncremental f = mapAccumMaybeMIncremental $ \v o -> return $ f v o
383−mapAccumMaybeMIncremental :: (Reflex t, Patch p, MonadHold t m, MonadFix m) => (PatchTarget p -> b -> PushM t (Maybe p, Maybe c)) -> PatchTarget p -> Event t b -> m (Incremental t p, Event t c)
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)
384517mapAccumMaybeMIncremental f z e = do
385518 rec let e' = flip push e $ \o -> do
386519 v <- sample $ currentIncremental d'
@@ -388,9 +521,10 @@ mapAccumMaybeMIncremental f z e = do
388521 return $ case result of
389522 (Nothing, Nothing) -> Nothing
390523 _ -> Just result
391− d' <- holdIncremental z $ fmapMaybe fst e'
392− return (d', fmapMaybe snd e')
524+ d' <- holdIncremental z $ mapMaybe fst e'
525+ return (d', mapMaybe snd e')
393526
527+-- | A somewhat slow implementation of 'headE'
394528slowHeadE :: (Reflex t, MonadHold t m, MonadFix m) => Event t a -> m (Event t a)
395529slowHeadE e = do
396530 rec be <- hold e $ fmapCheap (const never) e'
@@ -399,18 +533,31 @@ slowHeadE e = do
399533
400534-- | An 'EventSelector' allows you to efficiently 'select' an 'Event' based on a
401535-- key. This is much more efficient than filtering for each key with
402−-- 'fmapMaybe'.
536+-- 'mapMaybe'.
403537newtype EventSelector t k = EventSelector
404538 { -- | Retrieve the 'Event' for the given key. The type of the 'Event' is
405539 -- determined by the type of the key, so this can be used to fan-out
406540 -- 'Event's whose sub-'Event's have different types.
407541 --
408542 -- Using 'EventSelector's and the 'fan' primitive is far more efficient than
409− -- (but equivalent to) using 'fmapMaybe' to select only the relevant
543+ -- (but equivalent to) using 'mapMaybe' to select only the relevant
410544 -- occurrences of an 'Event'.
411545 select :: forall a. k a -> Event t a
412546 }
413547
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.
414561newtype EventSelectorInt t a = EventSelectorInt { selectInt :: Int -> Event t a }
415562
416563--------------------------------------------------------------------------------
@@ -426,6 +573,7 @@ instance MonadHold t m => MonadHold t (ReaderT r m) where
426573 holdIncremental a0 = lift . holdIncremental a0
427574 buildDynamic a0 = lift . buildDynamic a0
428575 headE = lift . headE
576+ now = lift now
429577
430578instance (MonadSample t m, Monoid r) => MonadSample t (WriterT r m) where
431579 sample = lift . sample
@@ -436,6 +584,7 @@ instance (MonadHold t m, Monoid r) => MonadHold t (WriterT r m) where
436584 holdIncremental a0 = lift . holdIncremental a0
437585 buildDynamic a0 = lift . buildDynamic a0
438586 headE = lift . headE
587+ now = lift now
439588
440589instance MonadSample t m => MonadSample t (StateT s m) where
441590 sample = lift . sample
@@ -446,6 +595,7 @@ instance MonadHold t m => MonadHold t (StateT s m) where
446595 holdIncremental a0 = lift . holdIncremental a0
447596 buildDynamic a0 = lift . buildDynamic a0
448597 headE = lift . headE
598+ now = lift now
449599
450600instance MonadSample t m => MonadSample t (ExceptT e m) where
451601 sample = lift . sample
@@ -456,6 +606,7 @@ instance MonadHold t m => MonadHold t (ExceptT e m) where
456606 holdIncremental a0 = lift . holdIncremental a0
457607 buildDynamic a0 = lift . buildDynamic a0
458608 headE = lift . headE
609+ now = lift now
459610
460611instance (MonadSample t m, Monoid w) => MonadSample t (RWST r w s m) where
461612 sample = lift . sample
@@ -466,6 +617,7 @@ instance (MonadHold t m, Monoid w) => MonadHold t (RWST r w s m) where
466617 holdIncremental a0 = lift . holdIncremental a0
467618 buildDynamic a0 = lift . buildDynamic a0
468619 headE = lift . headE
620+ now = lift now
469621
470622instance MonadSample t m => MonadSample t (ContT r m) where
471623 sample = lift . sample
@@ -476,6 +628,7 @@ instance MonadHold t m => MonadHold t (ContT r m) where
476628 holdIncremental a0 = lift . holdIncremental a0
477629 buildDynamic a0 = lift . buildDynamic a0
478630 headE = lift . headE
631+ now = lift now
479632
480633--------------------------------------------------------------------------------
481634-- Convenience functions
@@ -525,7 +678,9 @@ instance Reflex t => Monad (Behavior t) where
525678 a >>= f = pull $ sample a >>= sample . f
526679 -- 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.
527680 return = constant
681+#if !MIN_VERSION_base(4,13,0)
528682 fail = error "Monad (Behavior t) does not support fail"
683+#endif
529684
530685instance (Reflex t, Monoid a) => Monoid (Behavior t a) where
531686 mempty = constant mempty
@@ -541,40 +696,51 @@ instance (Reflex t, Num a) => Num (Behavior t a) where
541696 negate = fmap negate
542697 signum = fmap signum
543698
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+
544708instance (Reflex t, Semigroup a) => Semigroup (Behavior t a) where
545709 a <> b = pull $ liftM2 (<>) (sample a) (sample b)
546710 sconcat = pull . fmap sconcat . mapM sample
547−#if MIN_VERSION_semigroups(0,17,0)
548711 stimes n = fmap $ stimes n
549−#else
550− times1p n = fmap $ times1p n
551−#endif
552712
553−-- | Flipped version of 'fmapMaybe'.
554−fforMaybe :: FunctorMaybe f => f a -> (a -> Maybe b) -> f b
555−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
556720
557721-- | Filter 'f a' using the provided predicate.
558−-- Relies on 'fforMaybe'.
559−ffilter :: FunctorMaybe f => (a -> Bool) -> f a -> f a
560−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
561724
562725-- | Filter 'Left's from 'f (Either a b)' into 'a'.
563−filterLeft :: FunctorMaybe f => f (Either a b) -> f a
564−filterLeft = fmapMaybe (either Just (const Nothing))
726+filterLeft :: Filterable f => f (Either a b) -> f a
727+filterLeft = mapMaybe (either Just (const Nothing))
565728
566729-- | Filter 'Right's from 'f (Either a b)' into 'b'.
567−filterRight :: FunctorMaybe f => f (Either a b) -> f b
568−filterRight = fmapMaybe (either (const Nothing) Just)
730+filterRight :: Filterable f => f (Either a b) -> f b
731+filterRight = mapMaybe (either (const Nothing) Just)
569732
570733-- | Left-biased event union (prefers left event on simultaneous
571734-- occurrence).
572735instance Reflex t => Alt (Event t) where
573736 ev1 <!> ev2 = leftmost [ev1, ev2]
574737
575−-- | 'Event' intersection (convenient interface to 'coincidence').
738+-- | 'Event' intersection. Only occurs when both events are co-incident.
576739instance Reflex t => Apply (Event t) where
577− 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+
578744
579745-- | 'Event' intersection (convenient interface to 'coincidence').
580746instance Reflex t => Bind (Event t) where
@@ -583,13 +749,18 @@ instance Reflex t => Bind (Event t) where
583749
584750instance Reflex t => Functor (Event t) where
585751 {-# INLINE fmap #-}
586− fmap f = fmapMaybe $ Just . f
752+ fmap f = mapMaybe $ Just . f
587753 {-# INLINE (<$) #-}
588754 x <$ e = fmapCheap (const x) e
589755
756+-- TODO Remove this instance
590757instance Reflex t => FunctorMaybe (Event t) where
591758 {-# INLINE fmapMaybe #-}
592− 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
593764
594765-- | Never: @'zero' = 'never'@.
595766instance Reflex t => Plus (Event t) where
@@ -738,11 +909,7 @@ traceEventWith f = push $ \x -> trace (f x) $ return $ Just x
738909instance (Semigroup a, Reflex t) => Semigroup (Event t a) where
739910 (<>) = alignWith (mergeThese (<>))
740911 sconcat = fmap sconcat . mergeList . toList
741−#if MIN_VERSION_semigroups(0,17,0)
742912 stimes n = fmap $ stimes n
743−#else
744− times1p n = fmap $ times1p n
745−#endif
746913
747914instance (Semigroup a, Reflex t) => Monoid (Event t a) where
748915 mempty = never
@@ -777,7 +944,12 @@ mergeList :: Reflex t => [Event t a] -> Event t (NonEmpty a)
777944mergeList [] = never
778945mergeList es = mergeWithFoldCheap' id es
779946
780−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'
781953unsafeMapIncremental f g a = unsafeBuildIncremental (fmap f $ sample $ currentIncremental a) $ g <$> updatedIncremental a
782954
783955-- | Create a new 'Event' combining the map of 'Event's into an 'Event' that
@@ -807,7 +979,7 @@ fanEither :: Reflex t => Event t (Either a b) -> (Event t a, Event t b)
807979fanEither e =
808980 let justLeft = either Just (const Nothing)
809981 justRight = either (const Nothing) Just
810− in (fmapMaybe justLeft e, fmapMaybe justRight e)
982+ in (mapMaybe justLeft e, mapMaybe justRight e)
811983
812984-- | Split the event into separate events for 'This' and 'That' values,
813985-- allowing them to fire simultaneously when the input value is 'These'.
@@ -819,7 +991,7 @@ fanThese e =
819991 that (That y) = Just y
820992 that (These _ y) = Just y
821993 that _ = Nothing
822− in (fmapMaybe this e, fmapMaybe that e)
994+ in (mapMaybe this e, mapMaybe that e)
823995
824996-- | Split the event into an 'EventSelector' that allows efficient selection of
825997-- the individual 'Event's.
@@ -894,6 +1066,9 @@ coincidencePatchMapWithMove e = fmapCheap unsafePatchMapWithMove $ coincidence $
8941066 ni { PatchMapWithMove._nodeInfo_from = PatchMapWithMove.From_Delete }
8951067 ]
8961068
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.
8971072switchHoldPromptOnlyIncremental
8981073 :: forall t m p pt w
8991074 . ( Reflex t
@@ -918,8 +1093,25 @@ switchHoldPromptOnlyIncremental mergePatchIncremental coincidencePatch e0 e' = d
9181093
9191094instance Reflex t => Align (Event t) where
9201095 nil = never
1096+#if MIN_VERSION_these(0, 8, 0)
1097+instance Reflex t => Semialign (Event t) where
1098+#endif
9211099 align = alignEventWithMaybe Just
9221100
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+
9231115-- | Create a new 'Event' that only occurs if the supplied 'Event' occurs and
9241116-- the 'Behavior' is true at the time of occurrence.
9251117gate :: Reflex t => Behavior t Bool -> Event t a -> Event t a
@@ -959,11 +1151,7 @@ zipDynWith f da db =
9591151
9601152instance (Reflex t, Semigroup a) => Semigroup (Dynamic t a) where
9611153 (<>) = zipDynWith (<>)
962−#if MIN_VERSION_semigroups(0,17,0)
9631154 stimes n = fmap $ stimes n
964−#else
965− times1p n = fmap $ times1p n
966−#endif
9671155
9681156instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
9691157 mconcat = distributeListOverDynWith mconcat
@@ -974,12 +1162,21 @@ instance (Reflex t, Monoid a) => Monoid (Dynamic t a) where
9741162-- 'Dynamic' 'DMap'. Its implementation is more efficient than doing the same
9751163-- through the use of multiple uses of 'zipDynWith' or 'Applicative' operators.
9761164distributeDMapOverDynPure :: forall t k. (Reflex t, GCompare k) => DMap k (Dynamic t) -> Dynamic t (DMap k Identity)
977−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
9781175 [] -> constDyn DMap.empty
979− [k :=> v] -> fmap (DMap.singleton k . Identity) v
1176+ [k :=> v] -> DMap.singleton k <$> nt v
9801177 _ ->
981− let getInitial = DMap.traverseWithKey (\_ -> fmap Identity . sample . current) dm
982− 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
9831180 result = unsafeBuildDynamic getInitial $ flip pushAlways edmPre $ \news -> do
9841181 olds <- sample $ current result
9851182 return $ DMap.unionWithKey (\_ _ new -> new) olds news
@@ -991,21 +1188,32 @@ distributeListOverDyn = distributeListOverDynWith id
9911188
9921189-- | Create a new 'Dynamic' by applying a combining function to a list of 'Dynamic's
9931190distributeListOverDynWith :: Reflex t => ([a] -> b) -> [Dynamic t a] -> Dynamic t b
994−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
9951201
9961202-- | Create a new 'Event' that occurs when the first supplied 'Event' occurs
9971203-- unless the second supplied 'Event' occurs simultaneously.
9981204difference :: Reflex t => Event t a -> Event t b -> Event t a
9991205difference = alignEventWithMaybe $ \case
10001206 This a -> Just a
1001− _ -> Nothing
1207+ _ -> Nothing
10021208
1209+-- | Zips two values by taking the union of their shapes and combining with the provided function.
1210+-- 'Nothing' values are dropped.
10031211alignEventWithMaybe :: Reflex t => (These a b -> Maybe c) -> Event t a -> Event t b -> Event t c
1004−alignEventWithMaybe f ea eb =
1005− fmapMaybe (f <=< dmapToThese)
1006− $ merge
1007− $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
1212+alignEventWithMaybe f ea eb = mapMaybe (f <=< dmapToThese) $
1213+ merge $ DMap.fromList [LeftTag :=> ea, RightTag :=> eb]
10081214
1215+-- | Produces an 'Event' that fires only when the input event fires with a 'DSum' key that
1216+-- matches the provided key.
10091217filterEventKey
10101218 :: forall t m k v a.
10111219 ( Reflex t
@@ -1023,7 +1231,10 @@ filterEventKey k kv' = do
10231231 Nothing -> Nothing
10241232 takeWhileJustE f kv'
10251233
1026−
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.
10271238factorEvent
10281239 :: forall t m k v a.
10291240 ( Reflex t
@@ -1035,9 +1246,9 @@ factorEvent
10351246 -> Event t (DSum k v)
10361247 -> m (Event t (v a), Event t (DSum k (Product v (Compose (Event t) v))))
10371248factorEvent k0 kv' = do
1038− key :: Behavior t (Some k) <- hold (Some.This k0) $ fmapCheap (\(k :=> _) -> Some.This k) kv'
1249+ key :: Behavior t (Some k) <- hold (Some k0) $ fmapCheap (\(k :=> _) -> Some k) kv'
10391250 let update = flip push kv' $ \(newKey :=> newVal) -> sample key >>= \case
1040− Some.This oldKey -> case newKey `geq` oldKey of
1251+ Some oldKey -> case newKey `geq` oldKey of
10411252 Just Refl -> return Nothing
10421253 Nothing -> do
10431254 newInner <- filterEventKey newKey kv'
@@ -1073,26 +1284,94 @@ class Reflex t => Accumulator t f | f -> t where
10731284 mapAccumMaybe f = mapAccumMaybeM $ \v o -> return $ f v o
10741285 mapAccumMaybeM :: (MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a, Maybe c)) -> a -> Event t b -> m (f a, Event t c)
10751286
1076−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)
10771295accumDyn f = accumMaybeDyn $ \v o -> Just $ f v o
1078−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)
10791305accumMDyn f = accumMaybeMDyn $ \v o -> Just <$> f v o
1080−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)
10811315accumMaybeDyn f = accumMaybeMDyn $ \v o -> return $ f v o
1082−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)
10831325accumMaybeMDyn f z e = do
10841326 rec let e' = flip push e $ \o -> do
10851327 v <- sample $ current d'
10861328 f v o
10871329 d' <- holdDyn z e'
10881330 return d'
1089−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)
10901341mapAccumDyn f = mapAccumMaybeDyn $ \v o -> bimap Just Just $ f v o
1091−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)
10921351mapAccumMDyn f = mapAccumMaybeMDyn $ \v o -> bimap Just Just <$> f v o
1093−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)
10941365mapAccumMaybeDyn f = mapAccumMaybeMDyn $ \v o -> return $ f v o
1095−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)
10961375mapAccumMaybeMDyn f z e = do
10971376 rec let e' = flip push e $ \o -> do
10981377 v <- sample $ current d'
@@ -1100,18 +1379,42 @@ mapAccumMaybeMDyn f z e = do
11001379 return $ case result of
11011380 (Nothing, Nothing) -> Nothing
11021381 _ -> Just result
1103− d' <- holdDyn z $ fmapMaybe fst e'
1104− return (d', fmapMaybe snd e')
1382+ d' <- holdDyn z $ mapMaybe fst e'
1383+ return (d', mapMaybe snd e')
11051384
1385+-- | Accumulate a 'Behavior' by folding occurrences of an 'Event'
1386+-- with the provided function.
11061387{-# INLINE accumB #-}
1107−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)
11081394accumB f = accumMaybeB $ \v o -> Just $ f v o
1395+
1396+-- | Like 'accumB' except that the combining function is a 'PushM' action.
11091397{-# INLINE accumMB #-}
1110−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)
11111404accumMB 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.
11121408{-# INLINE accumMaybeB #-}
1113−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)
11141415accumMaybeB f = accumMaybeMB $ \v o -> return $ f v o
1416+
1417+-- | Like 'accumMaybeB' except that the combining function is a 'PushM' action.
11151418{-# INLINE accumMaybeMB #-}
11161419accumMaybeMB :: (Reflex t, MonadHold t m, MonadFix m) => (a -> b -> PushM t (Maybe a)) -> a -> Event t b -> m (Behavior t a)
11171420accumMaybeMB f z e = do
@@ -1120,16 +1423,42 @@ accumMaybeMB f z e = do
11201423 f v o
11211424 d' <- hold z e'
11221425 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'.
11231430{-# INLINE mapAccumB #-}
1124−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)
11251437mapAccumB f = mapAccumMaybeB $ \v o -> bimap Just Just $ f v o
1438+
1439+-- | Like 'mapAccumB' except that the combining function is a 'PushM' action.
11261440{-# INLINE mapAccumMB #-}
1127−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)
11281447mapAccumMB 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.
11291452{-# INLINE mapAccumMaybeB #-}
1130−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)
11311459mapAccumMaybeB f = mapAccumMaybeMB $ \v o -> return $ f v o
11321460
1461+-- | Like 'mapAccumMaybeB' except that the combining function is a 'PushM' action.
11331462{-# INLINE mapAccumMaybeMB #-}
11341463mapAccumMaybeMB :: (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)
11351464mapAccumMaybeMB f z e = do
@@ -1139,8 +1468,8 @@ mapAccumMaybeMB f z e = do
11391468 return $ case result of
11401469 (Nothing, Nothing) -> Nothing
11411470 _ -> Just result
1142− d' <- hold z $ fmapMaybe fst e'
1143− return (d', fmapMaybe snd e')
1471+ d' <- hold z $ mapMaybe fst e'
1472+ return (d', mapMaybe snd e')
11441473
11451474-- | Accumulate occurrences of an 'Event', producing an output occurrence each
11461475-- time. Discard the underlying 'Accumulator'.
@@ -1284,38 +1613,70 @@ infixl 4 <@
12841613-- Cheap Functions
12851614------------------
12861615
1616+-- | A "cheap" version of 'pushAlways'. See the performance note on 'pushCheap'.
12871617{-# INLINE pushAlwaysCheap #-}
12881618pushAlwaysCheap :: Reflex t => (a -> PushM t b) -> Event t a -> Event t b
12891619pushAlwaysCheap f = pushCheap (fmap Just . f)
12901620
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'
12911627{-# INLINE fmapMaybeCheap #-}
12921628fmapMaybeCheap :: Reflex t => (a -> Maybe b) -> Event t a -> Event t b
1293−fmapMaybeCheap f = pushCheap $ return . f
1629+fmapMaybeCheap = mapMaybeCheap
1630+
12941631
1632+-- | A "cheap" version of 'fforMaybe'. See the performance note on 'pushCheap'.
12951633{-# INLINE fforMaybeCheap #-}
12961634fforMaybeCheap :: Reflex t => Event t a -> (a -> Maybe b) -> Event t b
1297−fforMaybeCheap = flip fmapMaybeCheap
1635+fforMaybeCheap = flip mapMaybeCheap
12981636
1637+-- | A "cheap" version of 'ffor'. See the performance note on 'pushCheap'.
12991638{-# INLINE fforCheap #-}
13001639fforCheap :: Reflex t => Event t a -> (a -> b) -> Event t b
13011640fforCheap = flip fmapCheap
13021641
1642+-- | A "cheap" version of 'fmap'. See the performance note on 'pushCheap'.
13031643{-# INLINE fmapCheap #-}
13041644fmapCheap :: Reflex t => (a -> b) -> Event t a -> Event t b
13051645fmapCheap f = pushCheap $ return . Just . f
13061646
1647+-- | A "cheap" version of 'tag'. See the performance note on 'pushCheap'.
13071648{-# INLINE tagCheap #-}
13081649tagCheap :: Reflex t => Behavior t b -> Event t a -> Event t b
13091650tagCheap b = pushAlwaysCheap $ \_ -> sample b
13101651
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'.
13111670{-# INLINE mergeWithCheap #-}
13121671mergeWithCheap :: Reflex t => (a -> a -> a) -> [Event t a] -> Event t a
13131672mergeWithCheap = mergeWithCheap' id
13141673
1674+-- | A "cheap" version of 'mergeWithCheap''. See the performance note on 'pushCheap'.
13151675{-# INLINE mergeWithCheap' #-}
13161676mergeWithCheap' :: Reflex t => (a -> b) -> (b -> b -> b) -> [Event t a] -> Event t b
13171677mergeWithCheap' f g = mergeWithFoldCheap' $ foldl1 g . fmap f
13181678
1679+-- | A "cheap" version of 'mergeWithFoldCheap''. See the performance note on 'pushCheap'.
13191680{-# INLINE mergeWithFoldCheap' #-}
13201681mergeWithFoldCheap' :: Reflex t => (NonEmpty a -> b) -> [Event t a] -> Event t b
13211682mergeWithFoldCheap' f es =
@@ -1328,31 +1689,11 @@ mergeWithFoldCheap' f es =
13281689-- Deprecated functions
13291690--------------------------------------------------------------------------------
13301691
1331−-- | Create a new 'Event' that occurs if at least one of the supplied 'Event's
1332−-- occurs. If both occur at the same time they are combined using 'mappend'.
1333−{-# DEPRECATED appendEvents "If a 'Semigroup a' instance is available, use 'mappend'; otherwise, use 'alignWith (mergeThese mappend)' instead" #-}
1334−appendEvents :: (Reflex t, Monoid a) => Event t a -> Event t a -> Event t a
1335−appendEvents = alignWith $ mergeThese mappend
1336−
1337−-- | Alias for 'headE'
1338−{-# DEPRECATED onceE "Use 'headE' instead" #-}
1339−onceE :: MonadHold t m => Event t a -> m (Event t a)
1340−onceE = headE
1341−
1342−-- | Run both sides of a 'These' monadically, combining the results.
1343−{-# DEPRECATED sequenceThese "Use bisequenceA or bisequence from the bifunctors package instead" #-}
1344−#ifdef USE_TEMPLATE_HASKELL
1345−{-# ANN sequenceThese "HLint: ignore Use fmap" #-}
1346−#endif
1347−sequenceThese :: Monad m => These (m a) (m b) -> m (These a b)
1348−sequenceThese t = case t of
1349− This ma -> fmap This ma
1350− These ma mb -> liftM2 These ma mb
1351− That mb -> fmap That mb
1352−
13531692{-# 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'
13541694switchPromptly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
13551695switchPromptly = switchHoldPromptly
13561696{-# 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'
13571698switchPromptOnly :: (Reflex t, MonadHold t m) => Event t a -> Event t (Event t a) -> m (Event t a)
13581699switchPromptOnly = switchHoldPromptOnly
src/Reflex/Collection.hs+16−11
@@ -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,6 +27,13 @@ module Reflex.Collection
2527 , simpleList
2628 ) where
2729
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+
2837import Control.Monad.Identity
2938import Data.Align
3039import Data.Functor.Misc
@@ -38,6 +47,9 @@ import Reflex.Adjustable.Class
3847import Reflex.Dynamic
3948import Reflex.PostBuild.Class
4049
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.
4153listHoldWithKey
4254 :: forall t m k v a
4355 . (Ord k, Adjustable t m, MonadHold t m)
@@ -96,15 +108,6 @@ listWithKey vals mkChild = do
96108 listHoldWithKey Map.empty changeVals $ \k v ->
97109 mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
98110
99−{-# DEPRECATED listWithKey' "listWithKey' has been renamed to listWithKeyShallowDiff; also, its behavior has changed to fix a bug where children were always rebuilt (never updated)" #-}
100−listWithKey'
101− :: (Ord k, Adjustable t m, MonadFix m, MonadHold t m)
102− => Map k v
103− -> Event t (Map k (Maybe v))
104− -> (k -> v -> Event t v -> m a)
105− -> m (Dynamic t (Map k a))
106−listWithKey' = listWithKeyShallowDiff
107−
108111-- | Display the given map of items (in key order) using the builder
109112-- function provided, and update it with the given event. 'Nothing'
110113-- update entries will delete the corresponding children, and 'Just'
@@ -127,7 +130,7 @@ listWithKeyShallowDiff initialVals valsChanged mkChild = do
127130 Nothing -> Just Nothing
128131
129132 -- We don't want to let spurious re-creations of items through
130− Just _ -> Nothing
133+ Just _ -> Nothing
131134 listHoldWithKey
132135 initialVals
133136 (attachWith (flip (Map.differenceWith relevantPatch))
@@ -182,6 +185,8 @@ selectViewListWithKey selection vals mkChild = do
182185 return $ fmap ((,) k) selectSelf
183186 return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
184187
188+-- | Like 'selectViewListWithKey' but discards the value of the list
189+-- item widget's output 'Event'.
185190selectViewListWithKey_
186191 :: forall t m k v a
187192 . (Adjustable t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
src/Reflex/Dynamic.hs+34−169
@@ -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,10 +53,12 @@ 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
@@ -70,32 +76,12 @@ module Reflex.Dynamic
7076 , distributeFHListOverDynPure
7177 -- * Unsafe
7278 , unsafeDynamic
73− -- * Deprecated functions
74− , apDyn
75− , attachDyn
76− , attachDynWith
77− , attachDynWithMaybe
78− , collectDyn
79− , combineDyn
80− , distributeDMapOverDyn
81− , distributeFHListOverDyn
82− , forDyn
83− , getDemuxed
84− , joinDyn
85− , mapDyn
86− , mconcatDyn
87− , nubDyn
88− , splitDyn
89− , tagDyn
90− , uniqDyn
91− , uniqDynBy
9279 ) where
9380
9481import Data.Functor.Compose
9582import Data.Functor.Misc
9683import Reflex.Class
9784
98−import Control.Applicative ((<*>))
9985import Control.Monad
10086import Control.Monad.Fix
10187import Control.Monad.Identity
@@ -103,12 +89,14 @@ import Data.Align
10389import Data.Dependent.Map (DMap)
10490import qualified Data.Dependent.Map as DMap
10591import Data.Dependent.Sum (DSum (..))
106−import Data.Functor.Product
107−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
10895import Data.Map (Map)
10996import Data.Maybe
110−import Data.Monoid hiding (Product)
97+import Data.Monoid ((<>))
11198import Data.These
99+import Data.Type.Equality ((:~:) (..))
112100
113101import Debug.Trace
114102
@@ -218,25 +206,27 @@ splitDynPure d = (fmap fst d, fmap snd d)
218206distributeMapOverDynPure :: (Reflex t, Ord k) => Map k (Dynamic t v) -> Dynamic t (Map k v)
219207distributeMapOverDynPure = fmap dmapToMap . distributeDMapOverDynPure . mapWithFunctorToDMap
220208
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+
221214-- | Convert a list with 'Dynamic' elements into a 'Dynamic' of a list with
222215-- non-'Dynamic' elements, preserving the order of the elements.
216+{-# DEPRECATED distributeListOverDynPure "Use 'distributeListOverDyn' instead" #-}
223217distributeListOverDynPure :: Reflex t => [Dynamic t v] -> Dynamic t [v]
224−distributeListOverDynPure =
225− fmap (map fromDSum . DMap.toAscList) .
226− distributeDMapOverDynPure .
227− DMap.fromDistinctAscList .
228− zipWith toDSum [0..]
229− where
230− toDSum :: Int -> Dynamic t a -> DSum (Const2 Int a) (Dynamic t)
231− toDSum k v = Const2 k :=> v
232− fromDSum :: DSum (Const2 Int a) Identity -> a
233− fromDSum (Const2 _ :=> Identity v) = v
218+distributeListOverDynPure = distributeListOverDyn
234219
235220--TODO: Generalize this to functors other than Maps
236221-- | Combine a 'Dynamic' of a 'Map' of 'Dynamic's into a 'Dynamic'
237222-- with the current values of the 'Dynamic's in a map.
238223joinDynThroughMap :: forall t k a. (Reflex t, Ord k) => Dynamic t (Map k (Dynamic t a)) -> Dynamic t (Map k a)
239−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 =<<)
240230
241231-- | Print the value of the 'Dynamic' when it is first read and on each
242232-- subsequent change that is observed (as 'traceEvent'), prefixed with the
@@ -318,6 +308,8 @@ maybeDyn = fmap (fmap unpack) . eitherDyn . fmap pack
318308 Left _ -> Nothing
319309 Right a -> Just a
320310
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').
321313eitherDyn :: 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)))
322314eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
323315 where unpack :: DSum (EitherTag a b) (Compose (Dynamic t) Identity) -> Either (Dynamic t a) (Dynamic t b)
@@ -325,6 +317,9 @@ eitherDyn = fmap (fmap unpack) . factorDyn . fmap eitherToDSum
325317 LeftTag :=> Compose a -> Left $ coerceDynamic a
326318 RightTag :=> Compose b -> Right $ coerceDynamic b
327319
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.
328323factorDyn :: forall t m k v. (Reflex t, MonadHold t m, GEq k)
329324 => Dynamic t (DSum k v) -> m (Dynamic t (DSum k (Compose (Dynamic t) v)))
330325factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
@@ -339,6 +334,7 @@ factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
339334 inner' <- filterEventKey k (updated d)
340335 inner <- holdDyn v inner'
341336 return $ k :=> Compose inner
337+
342338--------------------------------------------------------------------------------
343339-- Demux
344340--------------------------------------------------------------------------------
@@ -352,7 +348,7 @@ factorDyn d = buildDynamic (sample (current d) >>= holdKey) update where
352348--
353349-- > demuxed (demux d) k === fmap (== k) d
354350--
355−-- However, the when getDemuxed is used multiple times, the complexity is only
351+-- However, when 'demuxed' is used multiple times, the complexity is only
356352-- /O(log(n))/, rather than /O(n)/ for fmap.
357353data Demux t k = Demux { demuxValue :: Behavior t k
358354 , demuxSelector :: EventSelector t (Const2 k Bool)
@@ -506,7 +502,7 @@ instance AllAreFunctors f t => AllAreFunctors f (h ': t) where
506502
507503-- | Convert a datastructure whose constituent parts are all 'Dynamic's into a
508504-- single 'Dynamic' whose value represents all the current values of the input's
509−-- consitutent 'Dynamic's.
505+-- constituent 'Dynamic's.
510506collectDynPure :: ( RebuildSortedHList (HListElems b)
511507 , IsHList a, IsHList b
512508 , AllAreFunctors (Dynamic t) (HListElems b)
@@ -547,134 +543,3 @@ instance IsHList (a, b, c, d, e, f) where
547543#if !defined(__GLASGOW_HASKELL__) || __GLASGOW_HASKELL__ < 800
548544 _ -> error "fromHList: impossible" -- Otherwise, GHC complains of a non-exhaustive pattern match; see https://ghc.haskell.org/trac/ghc/ticket/4139
549545#endif
550−
551−--------------------------------------------------------------------------------
552−-- Deprecated functions
553−--------------------------------------------------------------------------------
554−
555−-- | Map a function over a 'Dynamic'.
556−{-# DEPRECATED mapDyn "Use 'return . fmap f' instead of 'mapDyn f'; consider eliminating monadic style" #-}
557−mapDyn :: (Reflex t, Monad m) => (a -> b) -> Dynamic t a -> m (Dynamic t b)
558−mapDyn f = return . fmap f
559−
560−-- | Flipped version of 'mapDyn'.
561−{-# DEPRECATED forDyn "Use 'return . ffor a' instead of 'forDyn a'; consider eliminating monadic style" #-}
562−forDyn :: (Reflex t, Monad m) => Dynamic t a -> (a -> b) -> m (Dynamic t b)
563−forDyn a = return . ffor a
564−
565−-- | Split the 'Dynamic' into two 'Dynamic's, each taking the respective value
566−-- of the tuple.
567−{-# DEPRECATED splitDyn "Use 'return . splitDynPure' instead; consider eliminating monadic style" #-}
568−splitDyn :: (Reflex t, Monad m) => Dynamic t (a, b) -> m (Dynamic t a, Dynamic t b)
569−splitDyn = return . splitDynPure
570−
571−-- | Merge the 'Dynamic' values using their 'Monoid' instance.
572−{-# DEPRECATED mconcatDyn "Use 'return . mconcat' instead; consider eliminating monadic style" #-}
573−mconcatDyn :: forall t m a. (Reflex t, Monad m, Monoid a) => [Dynamic t a] -> m (Dynamic t a)
574−mconcatDyn = return . mconcat
575−
576−-- | This function no longer needs to be monadic; see 'distributeMapOverDynPure'.
577−{-# DEPRECATED distributeDMapOverDyn "Use 'return . distributeDMapOverDynPure' instead; consider eliminating monadic style" #-}
578−distributeDMapOverDyn :: (Reflex t, Monad m, GCompare k) => DMap k (Dynamic t) -> m (Dynamic t (DMap k Identity))
579−distributeDMapOverDyn = return . distributeDMapOverDynPure
580−
581−-- | Merge two 'Dynamic's into a new one using the provided function. The new
582−-- 'Dynamic' changes its value each time one of the original 'Dynamic's changes
583−-- its value.
584−{-# DEPRECATED combineDyn "Use 'return (zipDynWith f a b)' instead of 'combineDyn f a b'; consider eliminating monadic style" #-}
585−combineDyn :: forall t m a b c. (Reflex t, Monad m) => (a -> b -> c) -> Dynamic t a -> Dynamic t b -> m (Dynamic t c)
586−combineDyn f a b = return $ zipDynWith f a b
587−
588−-- | A psuedo applicative version of ap for 'Dynamic'. Example useage:
589−--
590−-- > do
591−-- > person <- Person `mapDyn` dynFirstName
592−-- > `apDyn` dynListName
593−-- > `apDyn` dynAge
594−-- > `apDyn` dynAddress
595−{-# 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" #-}
596−#ifdef USE_TEMPLATE_HASKELL
597−{-# ANN apDyn "HLint: ignore Use fmap" #-}
598−#endif
599−apDyn :: forall t m a b. (Reflex t, Monad m)
600− => m (Dynamic t (a -> b))
601− -> Dynamic t a
602− -> m (Dynamic t b)
603−apDyn m a = fmap (<*> a) m
604−
605−--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
606−-- | This function no longer needs to be monadic, so it has been replaced by
607−-- 'demuxed', which is pure.
608−{-# DEPRECATED getDemuxed "Use 'return . demuxed d' instead of 'getDemuxed d'; consider eliminating monadic style" #-}
609−getDemuxed :: (Reflex t, Monad m, Eq k) => Demux t k -> k -> m (Dynamic t Bool)
610−getDemuxed d = return . demuxed d
611−
612−-- | This function no longer needs to be monadic, so it has been replaced by
613−-- 'distributeFHListOverDynPure', which is pure.
614−{-# DEPRECATED distributeFHListOverDyn "Use 'return . distributeFHListOverDynPure' instead; consider eliminating monadic style" #-}
615−distributeFHListOverDyn :: forall t m l. (Reflex t, Monad m, RebuildSortedHList l) => FHList (Dynamic t) l -> m (Dynamic t (HList l))
616−distributeFHListOverDyn = return . distributeFHListOverDynPure
617−
618−-- | This function no longer needs to be monadic, so it has been replaced by
619−-- 'collectDynPure', which is pure.
620−{-# DEPRECATED collectDyn "Use 'return . collectDynPure' instead; consider eliminating monadic style" #-}
621−collectDyn :: ( RebuildSortedHList (HListElems b)
622− , IsHList a, IsHList b
623− , AllAreFunctors (Dynamic t) (HListElems b)
624− , Reflex t, Monad m
625− , HListElems a ~ FunctorList (Dynamic t) (HListElems b)
626− ) => a -> m (Dynamic t b)
627−collectDyn = return . collectDynPure
628−
629−-- | This function has been renamed to 'tagPromptlyDyn' to clarify its
630−-- semantics.
631−{-# DEPRECATED tagDyn "Use 'tagPromptlyDyn' instead" #-}
632−tagDyn :: Reflex t => Dynamic t a -> Event t b -> Event t a
633−tagDyn = tagPromptlyDyn
634−
635−-- | This function has been renamed to 'attachPromptlyDyn' to clarify its
636−-- semantics.
637−{-# DEPRECATED attachDyn "Use 'attachPromptlyDyn' instead" #-}
638−attachDyn :: Reflex t => Dynamic t a -> Event t b -> Event t (a, b)
639−attachDyn = attachPromptlyDyn
640−
641−-- | This function has been renamed to 'attachPromptlyDynWith' to clarify its
642−-- semantics.
643−{-# DEPRECATED attachDynWith "Use 'attachPromptlyDynWith' instead" #-}
644−attachDynWith :: Reflex t => (a -> b -> c) -> Dynamic t a -> Event t b -> Event t c
645−attachDynWith = attachPromptlyDynWith
646−
647−-- | This function has been renamed to 'attachPromptlyDynWithMaybe' to clarify
648−-- its semantics.
649−{-# DEPRECATED attachDynWithMaybe "Use 'attachPromptlyDynWithMaybe' instead" #-}
650−attachDynWithMaybe :: Reflex t => (a -> b -> Maybe c) -> Dynamic t a -> Event t b -> Event t c
651−attachDynWithMaybe = attachPromptlyDynWithMaybe
652−
653−-- | Combine an inner and outer 'Dynamic' such that the resulting 'Dynamic''s
654−-- current value will always be equal to the current value's current value, and
655−-- will change whenever either the inner or the outer (or both) values change.
656−{-# DEPRECATED joinDyn "Use 'join' instead" #-}
657−joinDyn :: Reflex t => Dynamic t (Dynamic t a) -> Dynamic t a
658−joinDyn = join
659−
660−-- | WARNING: This function is only pure if @a@'s 'Eq' instance tests
661−-- representational equality. Use 'holdUniqDyn' instead, which is pure in all
662−-- circumstances. Also, note that, unlike 'nub', this function does not prevent
663−-- all recurrences of a value, only consecutive recurrences.
664−{-# DEPRECATED nubDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
665−nubDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
666−nubDyn = uniqDyn
667−
668−-- | WARNING: This function is only pure if @a@'s 'Eq' instance tests
669−-- representational equality. Use 'holdUniqDyn' instead, which is pure in all
670−-- circumstances.
671−{-# DEPRECATED uniqDyn "Use 'holdUniqDyn' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
672−uniqDyn :: (Reflex t, Eq a) => Dynamic t a -> Dynamic t a
673−uniqDyn = uniqDynBy (==)
674−
675−-- | WARNING: This function is impure. Use 'holdUniqDynBy' instead.
676−{-# DEPRECATED uniqDynBy "Use 'holdUniqDynBy' instead; note that it returns a MonadHold action rather than a pure Dynamic" #-}
677−uniqDynBy :: Reflex t => (a -> a -> Bool) -> Dynamic t a -> Dynamic t a
678−uniqDynBy eq d =
679− let e' = attachWithMaybe (\x x' -> if x' `eq` x then Nothing else Just x') (current d) (updated d)
680− in unsafeDynamic (current d) e'
src/Reflex/Dynamic/TH.hs+2−26
@@ -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
@@ -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+22−8
@@ -22,6 +22,8 @@ module Reflex.DynamicWriter.Base
2222import Control.Monad.Exception
2323import Control.Monad.Identity
2424import Control.Monad.IO.Class
25+import Control.Monad.Morph
26+import Control.Monad.Primitive
2527import Control.Monad.Reader
2628import Control.Monad.Ref
2729import Control.Monad.State.Strict
@@ -34,7 +36,7 @@ import Data.IntMap (IntMap)
3436import qualified Data.IntMap as IntMap
3537import Data.Map (Map)
3638import qualified Data.Map as Map
37−import Data.Semigroup
39+import Data.Semigroup (Semigroup(..))
3840import Data.Some (Some)
3941import Data.These
4042
@@ -43,16 +45,13 @@ import Reflex.Class
4345import Reflex.DynamicWriter.Class
4446import Reflex.EventWriter.Class (EventWriter, tellEvent)
4547import Reflex.Host.Class
46−import qualified Reflex.Patch.MapWithMove as MapWithMove
48+import qualified Data.Patch.MapWithMove as MapWithMove
4749import Reflex.PerformEvent.Class
4850import Reflex.PostBuild.Class
4951import Reflex.Query.Class
5052import Reflex.Requester.Class
5153import Reflex.TriggerEvent.Class
5254
53−instance MonadTrans (DynamicWriterT t w) where
54− lift = DynamicWriterT . lift
55−
5655mapIncrementalMapValues :: (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')
5756mapIncrementalMapValues f = unsafeMapIncremental (fmap f) (fmap f)
5857
@@ -87,9 +86,20 @@ mergeDynIncrementalWithMove a = unsafeBuildIncremental (mapM (sample . current)
8786 noLongerMovedMap = Map.fromList $ fmap (, ()) noLongerMoved
8887 in Map.differenceWith (\e _ -> Just $ MapWithMove.nodeInfoSetTo Nothing e) pWithNewVals noLongerMovedMap --TODO: Check if any in the second map are not covered?
8988
90−-- | A basic implementation of 'MonadDynamicWriter'.
89+-- | A basic implementation of 'DynamicWriter'.
9190newtype DynamicWriterT t w m a = DynamicWriterT { unDynamicWriterT :: StateT [Dynamic t w] m a }
92− deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadAsyncException, MonadException) -- The list is kept in reverse order
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+ )
93103
94104deriving instance MonadHold t m => MonadHold t (DynamicWriterT t w m)
95105deriving instance MonadSample t m => MonadSample t (DynamicWriterT t w m)
@@ -115,7 +125,7 @@ runDynamicWriterT (DynamicWriterT a) = do
115125 (result, ws) <- runStateT a []
116126 return (result, mconcat $ reverse ws)
117127
118−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
119129 tellDyn w = DynamicWriterT $ modify (w :)
120130
121131instance MonadReader r m => MonadReader r (DynamicWriterT t w m) where
@@ -140,6 +150,10 @@ instance MonadState s m => MonadState s (DynamicWriterT t w m) where
140150 get = lift get
141151 put = lift . put
142152
153+instance PrimMonad m => PrimMonad (DynamicWriterT t w m) where
154+ type PrimState (DynamicWriterT t w m) = PrimState m
155+ primitive = lift . primitive
156+
143157newtype DynamicWriterTLoweredResult t w v a = DynamicWriterTLoweredResult (v a, Dynamic t w)
144158
145159-- | When the execution of a 'DynamicWriterT' action is adjusted using
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+19−8
@@ -25,7 +25,7 @@ module Reflex.EventWriter.Base
2525import Reflex.Adjustable.Class
2626import Reflex.Class
2727import Reflex.EventWriter.Class (EventWriter, tellEvent)
28−import Reflex.DynamicWriter.Class (MonadDynamicWriter, tellDyn)
28+import Reflex.DynamicWriter.Class (DynamicWriter, tellDyn)
2929import Reflex.Host.Class
3030import Reflex.PerformEvent.Class
3131import Reflex.PostBuild.Class
@@ -35,12 +35,14 @@ import Reflex.TriggerEvent.Class
3535
3636import Control.Monad.Exception
3737import Control.Monad.Identity
38+import Control.Monad.Morph
3839import Control.Monad.Primitive
3940import Control.Monad.Reader
4041import Control.Monad.Ref
4142import Control.Monad.State.Strict
42−import Data.Dependent.Map (DMap, DSum (..))
43+import Data.Dependent.Map (DMap)
4344import qualified Data.Dependent.Map as DMap
45+import Data.Dependent.Sum (DSum (..))
4446import Data.Functor.Compose
4547import Data.Functor.Misc
4648import Data.GADT.Compare (GCompare (..), GEq (..), GOrdering (..))
@@ -52,7 +54,7 @@ import qualified Data.Map as Map
5254import Data.Semigroup
5355import Data.Some (Some)
5456import Data.Tuple
55−import Data.Type.Equality hiding (apply)
57+import Data.Type.Equality
5658
5759import Unsafe.Coerce
5860
@@ -96,7 +98,17 @@ data EventWriterState t w = EventWriterState
9698
9799-- | A basic implementation of 'EventWriter'.
98100newtype EventWriterT t w m a = EventWriterT { unEventWriterT :: StateT (EventWriterState t w) m a }
99− 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+ )
100112
101113-- | Run a 'EventWriterT' action.
102114runEventWriterT :: forall t m w a. (Reflex t, Monad m, Semigroup w) => EventWriterT t w m a -> m (a, Event t w)
@@ -116,9 +128,6 @@ instance (Reflex t, Monad m, Semigroup w) => EventWriter t w (EventWriterT t w m
116128 , _eventWriterState_told = (tellId myId :=> w) : _eventWriterState_told old
117129 }
118130
119−instance MonadTrans (EventWriterT t w) where
120− lift = EventWriterT . lift
121−
122131instance MonadSample t m => MonadSample t (EventWriterT t w m) where
123132 sample = lift . sample
124133
@@ -133,6 +142,8 @@ instance MonadHold t m => MonadHold t (EventWriterT t w m) where
133142 buildDynamic a0 = lift . buildDynamic a0
134143 {-# INLINABLE headE #-}
135144 headE = lift . headE
145+ {-# INLINABLE now #-}
146+ now = lift now
136147
137148instance (Reflex t, Adjustable t m, MonadHold t m, Semigroup w) => Adjustable t (EventWriterT t w m) where
138149 runWithReplace = runWithReplaceEventWriterTWith $ \dm0 dm' -> lift $ runWithReplace dm0 dm'
@@ -278,7 +289,7 @@ instance (MonadQuery t q m, Monad m) => MonadQuery t q (EventWriterT t w m) wher
278289 askQueryResult = lift askQueryResult
279290 queryIncremental = lift . queryIncremental
280291
281−instance MonadDynamicWriter t w m => MonadDynamicWriter t w (EventWriterT t v m) where
292+instance DynamicWriter t w m => DynamicWriter t w (EventWriterT t v m) where
282293 tellDyn = lift . tellDyn
283294
284295instance PrimMonad m => PrimMonad (EventWriterT t w m) where
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+20−6
@@ -6,14 +6,18 @@
66{-# LANGUAGE JavaScriptFFI #-}
77#endif
88
9−-- | 'FastWeak' is a weak pointer to some value, and 'FastWeakTicket' ensures the value
10−-- referred to by a 'FastWeak' stays live while the ticket is held (live).
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).
1115--
12−-- On GHC or GHCJS when not built with the @fast-weak@ cabal flag, 'FastWeak' is a wrapper
13−-- around the simple version of 'System.Mem.Weak.Weak' where the key and value are the same.
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.
1418--
15−-- On GHCJS when built with the @fast-weak@ cabal flag, 'FastWeak' is implemented directly
16−-- in JS using @h$FastWeak@ and @h$FastWeakTicket@ which are a nonstandard part of the GHCJS RTS.
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.
1721module Reflex.FastWeak
1822 ( FastWeakTicket
1923 , FastWeak
@@ -147,6 +151,16 @@ getFastWeakTicket w = do
147151
148152-- | Create a 'FastWeakTicket' directly from a value, creating a 'FastWeak' in the process
149153-- 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 #-}
150164mkFastWeakTicket :: a -> IO (FastWeakTicket a)
151165-- 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
152166-- associated FastWeak to actually be weak
src/Reflex/FunctorMaybe.hs+25−21
@@ -1,43 +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
717import Data.IntMap (IntMap)
8−import qualified Data.IntMap as IntMap
918import Data.Map (Map)
10−import qualified Data.Map as Map
11−import Data.Maybe
19+#if MIN_VERSION_base(4,9,0)
20+import Data.Semigroup (Option(..))
21+#endif
22+import Data.Witherable
1223
1324--TODO: See if there's a better class in the standard libraries already
1425
1526-- | A class for values that combines filtering and mapping using 'Maybe'.
16−-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@. Also similar is the
17−-- @Witherable@ typeclass, but it requires @Foldable f@ and @Traverable f@,
18−-- and e.g. 'Event' is instance of neither.
19−--
20−-- A definition of 'fmapMaybe' must satisfy the following laws:
21−--
22−-- [/identity/]
23−-- @'fmapMaybe' 'Just' ≡ 'id'@
24−--
25−-- [/composition/]
26−-- @'fmapMaybe' (f <=< g) ≡ 'fmapMaybe' f . 'fmapMaybe' g@
27+-- Morally, @'FunctorMaybe' ~ KleisliFunctor 'Maybe'@.
28+{-# DEPRECATED FunctorMaybe "Use 'Filterable' from Data.Witherable instead" #-}
2729class FunctorMaybe f where
2830 -- | Combined mapping and filtering function.
2931 fmapMaybe :: (a -> Maybe b) -> f a -> f b
3032
31−-- | @fmapMaybe = (=<<)
3233instance FunctorMaybe Maybe where
33− fmapMaybe = (=<<)
34+ fmapMaybe = mapMaybe
35+
36+#if MIN_VERSION_base(4,9,0)
37+deriving instance FunctorMaybe Option
38+#endif
3439
35−-- | @fmapMaybe = mapMaybe@
3640instance FunctorMaybe [] where
3741 fmapMaybe = mapMaybe
3842
3943instance FunctorMaybe (Map k) where
40− fmapMaybe = Map.mapMaybe
44+ fmapMaybe = mapMaybe
4145
4246instance FunctorMaybe IntMap where
43− fmapMaybe = IntMap.mapMaybe
47+ fmapMaybe = mapMaybe
src/Reflex/Host/Class.hs−1
@@ -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 #-}
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+10−4
@@ -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
@@ -14,16 +19,17 @@ import Reflex.Adjustable.Class
1419import Reflex.NotReady.Class
1520import Reflex.PostBuild.Class
1621
17−-- | Given a Dynamic of network-creating actions, create a network that is recreated whenever the Dynamic updates.
18−-- The returned Event of network results occurs when the Dynamic does.
19−-- 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').
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').
2026networkView :: (NotReady t m, Adjustable t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
2127networkView child = do
2228 postBuild <- getPostBuild
2329 let newChild = leftmost [updated child, tagCheap (current child) postBuild]
2430 snd <$> runWithReplace notReady newChild
2531
26−-- | 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.
2733-- The returned Dynamic of network results occurs when the Event does.
2834-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
2935networkHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
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+8−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
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−34
@@ -1,34 +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−import Data.Semigroup
8−
9−-- | A 'Patch' type represents a kind of change made to a datastructure.
10−--
11−-- If an instance of 'Patch' is also an instance of 'Semigroup', it should obey
12−-- the law that @applyAlways (f <> g) == applyAlways f . applyAlways g@.
13−class Patch p where
14− type PatchTarget p :: *
15− -- | Apply the patch @p a@ to the value @a@. If no change is needed, return
16− -- 'Nothing'.
17− apply :: p -> PatchTarget p -> Maybe (PatchTarget p)
18−
19−-- | Apply a 'Patch'; if it does nothing, return the original value
20−applyAlways :: Patch p => p -> PatchTarget p -> PatchTarget p
21−applyAlways p t = fromMaybe t $ apply p t
22−
23−-- | 'Identity' can be used as a 'Patch' that always fully replaces the value
24−instance Patch (Identity a) where
25− type PatchTarget (Identity a) = a
26− apply (Identity a) _ = Just a
27−
28−-- | Like '(.)', but composes functions that return patches rather than
29−-- functions that return new values. The Semigroup instance for patches must
30−-- apply patches right-to-left, like '(.)'.
31−composePatchFunctions :: (Patch p, Semigroup p) => (PatchTarget p -> p) -> (PatchTarget p -> p) -> PatchTarget p -> p
32−composePatchFunctions g f a =
33− let fp = f a
34− in g (applyAlways fp a) <> fp
src/Reflex/Patch/DMap.hsdeleted−82
@@ -1,82 +0,0 @@
1−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE PolyKinds #-}
4−{-# LANGUAGE Rank2Types #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE StandaloneDeriving #-}
7−{-# LANGUAGE TypeFamilies #-}
8−-- | 'Patch'es on 'DMap' that consist only of insertions (or overwrites) and deletions.
9−module Reflex.Patch.DMap where
10−
11−import Reflex.Patch.Class
12−import Reflex.Patch.IntMap
13−import Reflex.Patch.Map
14−
15−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
16−import qualified Data.Dependent.Map as DMap
17−import Data.Functor.Constant
18−import Data.Functor.Misc
19−import qualified Data.IntMap as IntMap
20−import qualified Data.Map as Map
21−import Data.Semigroup (Semigroup (..))
22−import Data.Some (Some)
23−
24−-- | A set of changes to a 'DMap'. Any element may be inserted/updated or deleted.
25−-- Insertions are represented as @'ComposeMaybe' (Just value)@,
26−-- while deletions are represented as @'ComposeMaybe' Nothing@.
27−newtype PatchDMap k v = PatchDMap { unPatchDMap :: DMap k (ComposeMaybe v) }
28−
29−deriving instance GCompare k => Semigroup (PatchDMap k v)
30−
31−deriving instance GCompare k => Monoid (PatchDMap k v)
32−
33−-- | Apply the insertions or deletions to a given 'DMap'.
34−instance GCompare k => Patch (PatchDMap k v) where
35− type PatchTarget (PatchDMap k v) = DMap k v
36− 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?
37− where insertions = DMap.mapMaybeWithKey (const $ getComposeMaybe) diff
38− deletions = DMap.mapMaybeWithKey (const $ nothingToJust . getComposeMaybe) diff
39− nothingToJust = \case
40− Nothing -> Just $ Constant ()
41− Just _ -> Nothing
42−
43−-- | Map a function @v a -> v' a@ over any inserts/updates in the given
44−-- @'PatchDMap' k v@ to produce a @'PatchDMap' k v'@.
45−mapPatchDMap :: (forall a. v a -> v' a) -> PatchDMap k v -> PatchDMap k v'
46−mapPatchDMap f (PatchDMap p) = PatchDMap $ DMap.map (ComposeMaybe . fmap f . getComposeMaybe) p
47−
48−-- | Map an effectful function @v a -> f (v' a)@ over any inserts/updates in the given
49−-- @'PatchDMap' k v@ to produce a @'PatchDMap' k v'@.
50−traversePatchDMap :: Applicative f => (forall a. v a -> f (v' a)) -> PatchDMap k v -> f (PatchDMap k v')
51−traversePatchDMap f = traversePatchDMapWithKey $ const f
52−
53−-- | Map an effectful function @k a -> v a -> f (v' a)@ over any inserts/updates
54−-- in the given @'PatchDMap' k v@ to produce a @'PatchDMap' k v'@.
55−traversePatchDMapWithKey :: Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMap k v -> m (PatchDMap k v')
56−traversePatchDMapWithKey f (PatchDMap p) = PatchDMap <$> DMap.traverseWithKey (\k (ComposeMaybe v) -> ComposeMaybe <$> traverse (f k) v) p
57−
58−-- | Weaken a @'PatchDMap' k v@ to a @'PatchMap' (Some k) v'@ using a function
59−-- @v a -> v'@ to weaken each value contained in the patch.
60−weakenPatchDMapWith :: (forall a. v a -> v') -> PatchDMap k v -> PatchMap (Some k) v'
61−weakenPatchDMapWith f (PatchDMap p) = PatchMap $ weakenDMapWith (fmap f . getComposeMaybe) p
62−
63−-- | Convert a weak @'PatchDMap' ('Const2' k a) v@ where the @a@ is known by way of
64−-- the @Const2@ into a @'PatchMap' k v'@ using a rank 1 function @v a -> v'@.
65−patchDMapToPatchMapWith :: (v a -> v') -> PatchDMap (Const2 k a) v -> PatchMap k v'
66−patchDMapToPatchMapWith f (PatchDMap p) = PatchMap $ dmapToMapWith (fmap f . getComposeMaybe) p
67−
68−-- | Convert a @'PatchMap' k v@ into a @'PatchDMap' ('Const2' k a) v'@ using a function @v -> v' a@.
69−const2PatchDMapWith :: forall k v v' a. (v -> v' a) -> PatchMap k v -> PatchDMap (Const2 k a) v'
70−const2PatchDMapWith f (PatchMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
71− where g :: (k, Maybe v) -> DSum (Const2 k a) (ComposeMaybe v')
72− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
73−
74−-- | Convert a @'PatchIntMap' v@ into a @'PatchDMap' ('Const2' Int a) v'@ using a function @v -> v' a@.
75−const2IntPatchDMapWith :: forall v f a. (v -> f a) -> PatchIntMap v -> PatchDMap (Const2 IntMap.Key a) f
76−const2IntPatchDMapWith f (PatchIntMap p) = PatchDMap $ DMap.fromDistinctAscList $ g <$> IntMap.toAscList p
77− where g :: (IntMap.Key, Maybe v) -> DSum (Const2 IntMap.Key a) (ComposeMaybe f)
78− g (k, e) = Const2 k :=> ComposeMaybe (f <$> e)
79−
80−-- | Get the values that will be replaced or deleted if the given patch is applied to the given 'DMap'.
81−getDeletions :: GCompare k => PatchDMap k v -> DMap k v' -> DMap k v'
82−getDeletions (PatchDMap p) m = DMap.intersectionWithKey (\_ v _ -> v) m p
src/Reflex/Patch/DMapWithMove.hsdeleted−364
@@ -1,364 +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.Constraint.Extras
23−import Data.Dependent.Map (DMap, DSum (..), GCompare (..))
24−import qualified Data.Dependent.Map as DMap
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, 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, 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−-- |Test whether two @'PatchDMapWithMove' k v@ contain the same patch operations.
108−instance (GEq k, Has' Eq k (NodeInfo k v)) => Eq (PatchDMapWithMove k v) where
109− PatchDMapWithMove a == PatchDMapWithMove b = a == b
110−
111−-- |Higher kinded 2-tuple, identical to @Data.Functor.Product@ from base ≥ 4.9
112−data Pair1 f g a = Pair1 (f a) (g a)
113−
114−-- |Helper data structure used for composing patches using the monoid instance.
115−data Fixup k v a
116− = Fixup_Delete
117− | Fixup_Update (These (From k v a) (To k a))
118−
119−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
120−instance GCompare k => Semigroup (PatchDMapWithMove k v) where
121− PatchDMapWithMove ma <> PatchDMapWithMove mb = PatchDMapWithMove m
122− where
123− connections = DMap.toList $ DMap.intersectionWithKey (\_ a b -> Pair1 (_nodeInfo_to a) (_nodeInfo_from b)) ma mb
124− h :: DSum k (Pair1 (ComposeMaybe k) (From k v)) -> [DSum k (Fixup k v)]
125− h (_ :=> Pair1 (ComposeMaybe mToAfter) editBefore) = case (mToAfter, editBefore) of
126− (Just toAfter, From_Move fromBefore)
127− | isJust $ fromBefore `geq` toAfter
128− -> [toAfter :=> Fixup_Delete]
129− | otherwise
130− -> [ toAfter :=> Fixup_Update (This editBefore)
131− , fromBefore :=> Fixup_Update (That (ComposeMaybe mToAfter))
132− ]
133− (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
134− (Just toAfter, _) -> [toAfter :=> Fixup_Update (This editBefore)]
135− (Nothing, _) -> []
136− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
137− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
138− | This x <- a, That y <- b
139− = Fixup_Update $ These x y
140− | That y <- a, This x <- b
141− = Fixup_Update $ These x y
142− mergeFixups _ _ _ = error "PatchDMapWithMove: incompatible fixups"
143− fixups = DMap.fromListWithKey mergeFixups $ concatMap h connections
144− combineNodeInfos _ nia nib = NodeInfo
145− { _nodeInfo_from = _nodeInfo_from nia
146− , _nodeInfo_to = _nodeInfo_to nib
147− }
148− applyFixup _ ni = \case
149− Fixup_Delete -> Nothing
150− Fixup_Update u -> Just $ NodeInfo
151− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
152− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
153− }
154− m = DMap.differenceWithKey applyFixup (DMap.unionWithKey combineNodeInfos ma mb) fixups
155− getHere :: These a b -> Maybe a
156− getHere = \case
157− This a -> Just a
158− These a _ -> Just a
159− That _ -> Nothing
160− getThere :: These a b -> Maybe b
161− getThere = \case
162− This _ -> Nothing
163− These _ b -> Just b
164− That b -> Just b
165−
166−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
167−instance GCompare k => Monoid (PatchDMapWithMove k v) where
168− mempty = PatchDMapWithMove mempty
169− mappend = (<>)
170−
171−{-
172−mappendPatchDMapWithMoveSlow :: forall k v. (ShowTag k v, GCompare k) => PatchDMapWithMove k v -> PatchDMapWithMove k v -> PatchDMapWithMove k v
173−PatchDMapWithMove dstAfter srcAfter `mappendPatchDMapWithMoveSlow` PatchDMapWithMove dstBefore srcBefore = PatchDMapWithMove dst src
174− where
175− 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
176− removeRedundantDst toKey (From_Move fromKey) | isJust (toKey `geq` fromKey) = Nothing
177− removeRedundantDst _ a = Just a
178− f :: forall a. k a -> From k v a -> Maybe (From k v a)
179− f toKey _ = removeRedundantDst toKey $ case getDstAction toKey dstAfter of
180− From_Move fromKey -> getDstAction fromKey dstBefore
181− nonMove -> nonMove
182− dst = DMap.mapMaybeWithKey f $ DMap.union dstAfter dstBefore
183− getSrcAction k m = fromMaybe (ComposeMaybe $ Just k) $ DMap.lookup k m
184− removeRedundantSrc fromKey (ComposeMaybe (Just toKey)) | isJust (fromKey `geq` toKey) = Nothing
185− removeRedundantSrc _ a = Just a
186− g :: forall a. k a -> ComposeMaybe k a -> Maybe (ComposeMaybe k a)
187− g fromKey _ = removeRedundantSrc fromKey $ case getSrcAction fromKey srcBefore of
188− ComposeMaybe Nothing -> ComposeMaybe Nothing
189− ComposeMaybe (Just toKeyBefore) -> getSrcAction toKeyBefore srcAfter
190− src = DMap.mapMaybeWithKey g $ DMap.union srcAfter srcBefore
191−-}
192−
193−-- |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'.
194−insertDMapKey :: k a -> v a -> PatchDMapWithMove k v
195−insertDMapKey k v =
196− PatchDMapWithMove . DMap.singleton k $ NodeInfo (From_Insert v) (ComposeMaybe Nothing)
197−
198−-- |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:
199−--
200−-- @
201−-- 'DMap.delete' src (maybe dmap ('DMap.insert' dst) (DMap.lookup src dmap))
202−-- @
203−moveDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
204−moveDMapKey src dst = case src `geq` dst of
205− Nothing -> PatchDMapWithMove $ DMap.fromList
206− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe Nothing)
207− , src :=> NodeInfo From_Delete (ComposeMaybe $ Just dst)
208− ]
209− Just _ -> mempty
210−
211−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
212−--
213−-- @
214−-- let aMay = DMap.lookup a dmap
215−-- bMay = DMap.lookup b dmap
216−-- in maybe id (DMap.insert a) (bMay `mplus` aMay)
217−-- . maybe id (DMap.insert b) (aMay `mplus` bMay)
218−-- . DMap.delete a . DMap.delete b $ dmap
219−-- @
220−swapDMapKey :: GCompare k => k a -> k a -> PatchDMapWithMove k v
221−swapDMapKey src dst = case src `geq` dst of
222− Nothing -> PatchDMapWithMove $ DMap.fromList
223− [ dst :=> NodeInfo (From_Move src) (ComposeMaybe $ Just src)
224− , src :=> NodeInfo (From_Move dst) (ComposeMaybe $ Just dst)
225− ]
226− Just _ -> mempty
227−
228−-- |Make a @'PatchDMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'DMap.delete'.
229−deleteDMapKey :: k a -> PatchDMapWithMove k v
230−deleteDMapKey k = PatchDMapWithMove $ DMap.singleton k $ NodeInfo From_Delete $ ComposeMaybe Nothing
231−
232−{-
233−k1, k2 :: Const2 Int () ()
234−k1 = Const2 1
235−k2 = Const2 2
236−p1, p2 :: PatchDMapWithMove (Const2 Int ()) Identity
237−p1 = moveDMapKey k1 k2
238−p2 = moveDMapKey k2 k1
239−p12 = p1 <> p2
240−p21 = p2 <> p1
241−p12Slow = p1 `mappendPatchDMapWithMoveSlow` p2
242−p21Slow = p2 `mappendPatchDMapWithMoveSlow` p1
243−
244−testPatchDMapWithMove = do
245− print p1
246− print p2
247− print $ p12 == deleteDMapKey k1
248− print $ p21 == deleteDMapKey k2
249− print $ p12Slow == deleteDMapKey k1
250− print $ p21Slow == deleteDMapKey k2
251−
252−dst (PatchDMapWithMove x _) = x
253−src (PatchDMapWithMove _ x) = x
254−-}
255−
256−-- |Extract the 'DMap' representing the patch changes from the 'PatchDMapWithMove'.
257−unPatchDMapWithMove :: PatchDMapWithMove k v -> DMap k (NodeInfo k v)
258−unPatchDMapWithMove (PatchDMapWithMove p) = p
259−
260−-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove', without checking any invariants.
261−--
262−-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchDMapWithMove' are preserved; they will not be checked.
263−unsafePatchDMapWithMove :: DMap k (NodeInfo k v) -> PatchDMapWithMove k v
264−unsafePatchDMapWithMove = PatchDMapWithMove
265−
266−-- |Wrap a 'DMap' representing patch changes into a 'PatchDMapWithMove' while checking invariants. If the invariants are satisfied, @Right p@ is returned
267−-- otherwise @Left errors@.
268−patchDMapWithMove :: (GCompare k, GShow k) => DMap k (NodeInfo k v) -> Either [String] (PatchDMapWithMove k v)
269−patchDMapWithMove dm =
270− case validationErrorsForPatchDMapWithMove dm of
271− [] -> Right $ unsafePatchDMapWithMove dm
272− errs -> Left errs
273−
274−-- |Map a natural transform @v -> v'@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @'PatchDMapWithMove' k v'@.
275−mapPatchDMapWithMove :: forall k v v'. (forall a. v a -> v' a) -> PatchDMapWithMove k v -> PatchDMapWithMove k v'
276−mapPatchDMapWithMove f (PatchDMapWithMove p) = PatchDMapWithMove $
277− DMap.map (\ni -> ni { _nodeInfo_from = g $ _nodeInfo_from ni }) p
278− where g :: forall a. From k v a -> From k v' a
279− g = \case
280− From_Insert v -> From_Insert $ f v
281− From_Delete -> From_Delete
282− From_Move k -> From_Move k
283−
284−-- |Traverse an effectful function @forall a. v a -> m (v ' a)@ over the given patch, transforming @'PatchDMapWithMove' k v@ into @m ('PatchDMapWithMove' k v')@.
285−traversePatchDMapWithMove :: forall m k v v'. Applicative m => (forall a. v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
286−traversePatchDMapWithMove f = traversePatchDMapWithMoveWithKey $ const f
287−
288−-- |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')@.
289−traversePatchDMapWithMoveWithKey :: forall m k v v'. Applicative m => (forall a. k a -> v a -> m (v' a)) -> PatchDMapWithMove k v -> m (PatchDMapWithMove k v')
290−traversePatchDMapWithMoveWithKey f (PatchDMapWithMove p) = PatchDMapWithMove <$> DMap.traverseWithKey (nodeInfoMapFromM . g) p
291− where g :: forall a. k a -> From k v a -> m (From k v' a)
292− g k = \case
293− From_Insert v -> From_Insert <$> f k v
294− From_Delete -> pure From_Delete
295− From_Move fromKey -> pure $ From_Move fromKey
296−
297−-- |Map a function which transforms @'From' k v a@ into a @'From' k v' a@ over a @'NodeInfo' k v a@.
298−nodeInfoMapFrom :: (From k v a -> From k v' a) -> NodeInfo k v a -> NodeInfo k v' a
299−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
300−
301−-- |Map an effectful function which transforms @'From' k v a@ into a @f ('From' k v' a)@ over a @'NodeInfo' k v a@.
302−nodeInfoMapFromM :: Functor f => (From k v a -> f (From k v' a)) -> NodeInfo k v a -> f (NodeInfo k v' a)
303−nodeInfoMapFromM f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
304−
305−-- |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
306−-- values.
307−weakenPatchDMapWithMoveWith :: forall k v v'. (forall a. v a -> v') -> PatchDMapWithMove k v -> PatchMapWithMove (Some k) v'
308−weakenPatchDMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ weakenDMapWith g p
309− where g :: forall a. NodeInfo k v a -> MapWithMove.NodeInfo (Some k) v'
310− g ni = MapWithMove.NodeInfo
311− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
312− From_Insert v -> MapWithMove.From_Insert $ f v
313− From_Delete -> MapWithMove.From_Delete
314− From_Move k -> MapWithMove.From_Move $ Some.This k
315− , MapWithMove._nodeInfo_to = Some.This <$> getComposeMaybe (_nodeInfo_to ni)
316− }
317−
318−-- |"Weaken" a @'PatchDMapWithMove' (Const2 k a) v@ to a @'PatchMapWithMove' k v'@. Weaken is in scare quotes because the 'Const2' has already disabled any
319−-- dependency in the typing and all points are already @a@, hence the function to map each value to @v'@ is not higher rank.
320−patchDMapWithMoveToPatchMapWithMoveWith :: forall k v v' a. (v a -> v') -> PatchDMapWithMove (Const2 k a) v -> PatchMapWithMove k v'
321−patchDMapWithMoveToPatchMapWithMoveWith f (PatchDMapWithMove p) = PatchMapWithMove $ dmapToMapWith g p
322− where g :: NodeInfo (Const2 k a) v a -> MapWithMove.NodeInfo k v'
323− g ni = MapWithMove.NodeInfo
324− { MapWithMove._nodeInfo_from = case _nodeInfo_from ni of
325− From_Insert v -> MapWithMove.From_Insert $ f v
326− From_Delete -> MapWithMove.From_Delete
327− From_Move (Const2 k) -> MapWithMove.From_Move k
328− , MapWithMove._nodeInfo_to = unConst2 <$> getComposeMaybe (_nodeInfo_to ni)
329− }
330−
331−-- |"Strengthen" a @'PatchMapWithMove' k v@ into a @'PatchDMapWithMove ('Const2' k a)@; that is, turn a non-dependently-typed patch into a dependently typed
332−-- one but which always has a constant key type represented by 'Const2'. Apply the given function to each @v@ to produce a @v' a@.
333−-- Completemented by 'patchDMapWithMoveToPatchMapWithMoveWith'
334−const2PatchDMapWithMoveWith :: forall k v v' a. (v -> v' a) -> PatchMapWithMove k v -> PatchDMapWithMove (Const2 k a) v'
335−const2PatchDMapWithMoveWith f (PatchMapWithMove p) = PatchDMapWithMove $ DMap.fromDistinctAscList $ g <$> Map.toAscList p
336− where g :: (k, MapWithMove.NodeInfo k v) -> DSum (Const2 k a) (NodeInfo (Const2 k a) v')
337− g (k, ni) = Const2 k :=> NodeInfo
338− { _nodeInfo_from = case MapWithMove._nodeInfo_from ni of
339− MapWithMove.From_Insert v -> From_Insert $ f v
340− MapWithMove.From_Delete -> From_Delete
341− MapWithMove.From_Move fromKey -> From_Move $ Const2 fromKey
342− , _nodeInfo_to = ComposeMaybe $ Const2 <$> MapWithMove._nodeInfo_to ni
343− }
344−
345−-- | Apply the insertions, deletions, and moves to a given 'DMap'.
346−instance GCompare k => Patch (PatchDMapWithMove k v) where
347− type PatchTarget (PatchDMapWithMove k v) = DMap k v
348− 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?
349− where insertions = DMap.mapMaybeWithKey insertFunc p
350− insertFunc :: forall a. k a -> NodeInfo k v a -> Maybe (v a)
351− insertFunc _ ni = case _nodeInfo_from ni of
352− From_Insert v -> Just v
353− From_Move k -> DMap.lookup k old
354− From_Delete -> Nothing
355− deletions = DMap.mapMaybeWithKey deleteFunc p
356− deleteFunc :: forall a. k a -> NodeInfo k v a -> Maybe (Constant () a)
357− deleteFunc _ ni = case _nodeInfo_from ni of
358− From_Delete -> Just $ Constant ()
359− _ -> Nothing
360−
361−-- | Get the values that will be replaced, deleted, or moved if the given patch is applied to the given 'DMap'.
362−getDeletionsAndMoves :: GCompare k => PatchDMapWithMove k v -> DMap k v' -> DMap k (Product v' (ComposeMaybe k))
363−getDeletionsAndMoves (PatchDMapWithMove p) m = DMap.intersectionWithKey f m p
364− where f _ v ni = Pair v $ _nodeInfo_to ni
src/Reflex/Patch/IntMap.hsdeleted−67
@@ -1,67 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFoldable #-}
3−{-# LANGUAGE DeriveFunctor #-}
4−{-# LANGUAGE DeriveTraversable #-}
5−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6−{-# LANGUAGE TypeFamilies #-}
7−-- | Module containing 'PatchIntMap', a 'Patch' for 'IntMap' which allows for
8−-- insert/update or delete of associations.
9−module Reflex.Patch.IntMap where
10−
11−import Data.IntMap.Strict (IntMap)
12−import qualified Data.IntMap.Strict as IntMap
13−import Data.Maybe
14−import Data.Semigroup
15−import Reflex.Patch.Class
16−
17−-- | 'Patch' for 'IntMap' which represents insertion or deletion of keys in the mapping.
18−-- Internally represented by 'IntMap (Maybe a)', where @Just@ means insert/update
19−-- and @Nothing@ means delete.
20−newtype PatchIntMap a = PatchIntMap (IntMap (Maybe a)) deriving (Functor, Foldable, Traversable, Monoid)
21−
22−-- | Apply the insertions or deletions to a given 'IntMap'.
23−instance Patch (PatchIntMap a) where
24− type PatchTarget (PatchIntMap a) = IntMap a
25− apply (PatchIntMap p) v = if IntMap.null p then Nothing else Just $
26− let removes = IntMap.filter isNothing p
27− adds = IntMap.mapMaybe id p
28− in IntMap.union adds $ v `IntMap.difference` removes
29−
30−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
31−-- If the same key is modified by both patches, the one on the left will take
32−-- precedence.
33−instance Semigroup (PatchIntMap v) where
34− PatchIntMap a <> PatchIntMap b = PatchIntMap $ a `mappend` b --TODO: Add a semigroup instance for Map
35− -- PatchMap is idempotent, so stimes n is id for every n
36−#if MIN_VERSION_semigroups(0,17,0)
37− stimes = stimesIdempotentMonoid
38−#else
39− times1p n x = case compare n 0 of
40− LT -> error "stimesIdempotentMonoid: negative multiplier"
41− EQ -> mempty
42− GT -> x
43−#endif
44−
45−-- | Map a function @Int -> a -> b@ over all @a@s in the given @'PatchIntMap' a@
46−-- (that is, all inserts/updates), producing a @PatchIntMap b@.
47−mapIntMapPatchWithKey :: (Int -> a -> b) -> PatchIntMap a -> PatchIntMap b
48−mapIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap $ IntMap.mapWithKey (\ k mv -> f k <$> mv) m
49−
50−-- | Map an effectful function @Int -> a -> f b@ over all @a@s in the given @'PatchIntMap' a@
51−-- (that is, all inserts/updates), producing a @f (PatchIntMap b)@.
52−traverseIntMapPatchWithKey :: Applicative f => (Int -> a -> f b) -> PatchIntMap a -> f (PatchIntMap b)
53−traverseIntMapPatchWithKey f (PatchIntMap m) = PatchIntMap <$> IntMap.traverseWithKey (\k mv -> traverse (f k) mv) m
54−
55−-- | Extract all @a@s inserted/updated by the given @'PatchIntMap' a@.
56−patchIntMapNewElements :: PatchIntMap a -> [a]
57−patchIntMapNewElements (PatchIntMap m) = catMaybes $ IntMap.elems m
58−
59−-- | Convert the given @'PatchIntMap' a@ into an @'IntMap' a@ with all
60−-- the inserts/updates in the given patch.
61−patchIntMapNewElementsMap :: PatchIntMap a -> IntMap a
62−patchIntMapNewElementsMap (PatchIntMap m) = IntMap.mapMaybe id m
63−
64−-- | Subset the given @'IntMap' a@ to contain only the keys that would be
65−-- deleted by the given @'PatchIntMap' a@.
66−getDeletions :: PatchIntMap v -> IntMap v' -> IntMap v'
67−getDeletions (PatchIntMap m) v = IntMap.intersection v m
src/Reflex/Patch/Map.hsdeleted−63
@@ -1,63 +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−-- | Apply the insertions or deletions to a given 'Map'.
22−instance Ord k => Patch (PatchMap k v) where
23− type PatchTarget (PatchMap k v) = Map k v
24− {-# INLINABLE apply #-}
25− 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?
26− where insertions = Map.mapMaybeWithKey (const id) p
27− deletions = Map.mapMaybeWithKey (const nothingToJust) p
28− nothingToJust = \case
29− Nothing -> Just ()
30− Just _ -> Nothing
31−
32−-- | @a <> b@ will apply the changes of @b@ and then apply the changes of @a@.
33−-- If the same key is modified by both patches, the one on the left will take
34−-- precedence.
35−instance Ord k => Semigroup (PatchMap k v) where
36− PatchMap a <> PatchMap b = PatchMap $ a `mappend` b --TODO: Add a semigroup instance for Map
37− -- PatchMap is idempotent, so stimes n is id for every n
38−#if MIN_VERSION_semigroups(0,17,0)
39− stimes = stimesIdempotentMonoid
40−#else
41− times1p n x = case compare n 0 of
42− LT -> error "stimesIdempotentMonoid: negative multiplier"
43− EQ -> mempty
44− GT -> x
45−#endif
46−
47−-- | The empty 'PatchMap' contains no insertions or deletions
48−instance Ord k => Monoid (PatchMap k v) where
49− mempty = PatchMap mempty
50− mappend = (<>)
51−
52−-- | 'fmap'ping a 'PatchMap' will alter all of the values it will insert.
53−-- Deletions are unaffected.
54−instance Functor (PatchMap k) where
55− fmap f = PatchMap . fmap (fmap f) . unPatchMap
56−
57−-- | Returns all the new elements that will be added to the 'Map'
58−patchMapNewElements :: PatchMap k v -> [v]
59−patchMapNewElements (PatchMap p) = catMaybes $ Map.elems p
60−
61−-- | Returns all the new elements that will be added to the 'Map'
62−patchMapNewElementsMap :: PatchMap k v -> Map k v
63−patchMapNewElementsMap (PatchMap p) = Map.mapMaybe id p
src/Reflex/Patch/MapWithMove.hsdeleted−270
@@ -1,270 +0,0 @@
1−{-# LANGUAGE DeriveFoldable #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveTraversable #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE PatternGuards #-}
7−{-# LANGUAGE ScopedTypeVariables #-}
8−{-# LANGUAGE TypeFamilies #-}
9−-- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
10−-- another
11−module Reflex.Patch.MapWithMove where
12−
13−import Reflex.Patch.Class
14−
15−import Control.Arrow
16−import Control.Monad.State
17−import Data.Foldable
18−import Data.Function
19−import Data.List
20−import Data.Map (Map)
21−import qualified Data.Map as Map
22−import Data.Maybe
23−import Data.Semigroup (Semigroup (..), (<>))
24−import qualified Data.Set as Set
25−import Data.These
26−import Data.Tuple
27−
28−-- | Patch a DMap with additions, deletions, and moves. Invariant: If key @k1@
29−-- is coming from @From_Move k2@, then key @k2@ should be going to @Just k1@,
30−-- and vice versa. There should never be any unpaired From/To keys.
31−newtype PatchMapWithMove k v = PatchMapWithMove (Map k (NodeInfo k v)) deriving (Show, Eq, Ord, Functor, Foldable, Traversable)
32−
33−-- | Holds the information about each key: where its new value should come from,
34−-- and where its old value should go to
35−data NodeInfo k v = NodeInfo
36− { _nodeInfo_from :: !(From k v)
37− -- ^ Where do we get the new value for this key?
38− , _nodeInfo_to :: !(To k)
39− -- ^ If the old value is being kept (i.e. moved rather than deleted or
40− -- replaced), where is it going?
41− }
42− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
43−
44−-- | Describe how a key's new value should be produced
45−data From k v
46− = From_Insert v -- ^ Insert the given value here
47− | From_Delete -- ^ Delete the existing value, if any, from here
48− | From_Move !k -- ^ Move the value here from the given key
49− deriving (Show, Read, Eq, Ord, Functor, Foldable, Traversable)
50−
51−-- | Describe where a key's old value will go. If this is 'Just', that means
52−-- the key's old value will be moved to the given other key; if it is 'Nothing',
53−-- that means it will be deleted.
54−type To = Maybe
55−
56−-- | Create a 'PatchMapWithMove', validating it
57−patchMapWithMove :: Ord k => Map k (NodeInfo k v) -> Maybe (PatchMapWithMove k v)
58−patchMapWithMove m = if valid then Just $ PatchMapWithMove m else Nothing
59− where valid = forwardLinks == backwardLinks
60− forwardLinks = Map.mapMaybe _nodeInfo_to m
61− backwardLinks = Map.fromList $ catMaybes $ flip fmap (Map.toList m) $ \(to, v) ->
62− case _nodeInfo_from v of
63− From_Move from -> Just (from, to)
64− _ -> Nothing
65−
66−-- | Create a 'PatchMapWithMove' that inserts everything in the given 'Map'
67−patchMapWithMoveInsertAll :: Map k v -> PatchMapWithMove k v
68−patchMapWithMoveInsertAll m = PatchMapWithMove $ flip fmap m $ \v -> NodeInfo
69− { _nodeInfo_from = From_Insert v
70− , _nodeInfo_to = Nothing
71− }
72−
73−-- | Extract the internal representation of the 'PatchMapWithMove'
74−unPatchMapWithMove :: PatchMapWithMove k v -> Map k (NodeInfo k v)
75−unPatchMapWithMove (PatchMapWithMove p) = p
76−
77−-- | Make a @'PatchMapWithMove' k v@ which has the effect of inserting or updating a value @v@ to the given key @k@, like 'Map.insert'.
78−insertMapKey :: k -> v -> PatchMapWithMove k v
79−insertMapKey k v = PatchMapWithMove . Map.singleton k $ NodeInfo (From_Insert v) Nothing
80−
81−-- |Make a @'PatchMapWithMove' k v@ which has the effect of moving the value from the first key @k@ to the second key @k@, equivalent to:
82−--
83−-- @
84−-- 'Map.delete' src (maybe map ('Map.insert' dst) (Map.lookup src map))
85−-- @
86−moveMapKey :: Ord k => k -> k -> PatchMapWithMove k v
87−moveMapKey src dst
88− | src == dst = mempty
89− | otherwise =
90− PatchMapWithMove $ Map.fromList
91− [ (dst, NodeInfo (From_Move src) Nothing)
92− , (src, NodeInfo From_Delete (Just dst))
93− ]
94−
95−-- |Make a @'PatchMapWithMove' k v@ which has the effect of swapping two keys in the mapping, equivalent to:
96−--
97−-- @
98−-- let aMay = Map.lookup a map
99−-- bMay = Map.lookup b map
100−-- in maybe id (Map.insert a) (bMay `mplus` aMay)
101−-- . maybe id (Map.insert b) (aMay `mplus` bMay)
102−-- . Map.delete a . Map.delete b $ map
103−-- @
104−swapMapKey :: Ord k => k -> k -> PatchMapWithMove k v
105−swapMapKey src dst
106− | src == dst = mempty
107− | otherwise =
108− PatchMapWithMove $ Map.fromList
109− [ (dst, NodeInfo (From_Move src) (Just src))
110− , (src, NodeInfo (From_Move dst) (Just dst))
111− ]
112−
113−-- |Make a @'PatchMapWithMove' k v@ which has the effect of deleting a key in the mapping, equivalent to 'Map.delete'.
114−deleteMapKey :: k -> PatchMapWithMove k v
115−deleteMapKey k = PatchMapWithMove . Map.singleton k $ NodeInfo From_Delete Nothing
116−
117−-- | Wrap a @'Map' k (NodeInfo k v)@ representing patch changes into a @'PatchMapWithMove' k v@, without checking any invariants.
118−--
119−-- __Warning:__ when using this function, you must ensure that the invariants of 'PatchMapWithMove' are preserved; they will not be checked.
120−unsafePatchMapWithMove :: Map k (NodeInfo k v) -> PatchMapWithMove k v
121−unsafePatchMapWithMove = PatchMapWithMove
122−
123−-- | Apply the insertions, deletions, and moves to a given 'Map'
124−instance Ord k => Patch (PatchMapWithMove k v) where
125− type PatchTarget (PatchMapWithMove k v) = Map k v
126− 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?
127− where insertions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
128− From_Insert v -> Just v
129− From_Move k -> Map.lookup k old
130− From_Delete -> Nothing
131− deletions = flip Map.mapMaybeWithKey p $ \_ ni -> case _nodeInfo_from ni of
132− From_Delete -> Just ()
133− _ -> Nothing
134−
135−-- | Returns all the new elements that will be added to the 'Map'.
136−patchMapWithMoveNewElements :: PatchMapWithMove k v -> [v]
137−patchMapWithMoveNewElements = Map.elems . patchMapWithMoveNewElementsMap
138−
139−-- | Return a @'Map' k v@ with all the inserts/updates from the given @'PatchMapWithMove' k v@.
140−patchMapWithMoveNewElementsMap :: PatchMapWithMove k v -> Map k v
141−patchMapWithMoveNewElementsMap (PatchMapWithMove p) = Map.mapMaybe f p
142− where f ni = case _nodeInfo_from ni of
143− From_Insert v -> Just v
144− From_Move _ -> Nothing
145− From_Delete -> Nothing
146−
147−-- | Create a 'PatchMapWithMove' that, if applied to the given 'Map', will sort
148−-- its values using the given ordering function. The set keys of the 'Map' is
149−-- not changed.
150−patchThatSortsMapWith :: Ord k => (v -> v -> Ordering) -> Map k v -> PatchMapWithMove k v
151−patchThatSortsMapWith cmp m = PatchMapWithMove $ Map.fromList $ catMaybes $ zipWith g unsorted sorted
152− where unsorted = Map.toList m
153− sorted = sortBy (cmp `on` snd) unsorted
154− f (to, _) (from, _) = if to == from then Nothing else
155− Just (from, to)
156− reverseMapping = Map.fromList $ catMaybes $ zipWith f unsorted sorted
157− g (to, _) (from, _) = if to == from then Nothing else
158− let Just movingTo = Map.lookup from reverseMapping
159− in Just (to, NodeInfo (From_Move from) $ Just movingTo)
160−
161−-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
162−-- will produce a 'Map' with the same values as the second 'Map' but with the
163−-- values sorted with the given ordering function.
164−patchThatChangesAndSortsMapWith :: forall k v. (Ord k, Ord v) => (v -> v -> Ordering) -> Map k v -> Map k v -> PatchMapWithMove k v
165−patchThatChangesAndSortsMapWith cmp oldByIndex newByIndexUnsorted = patchThatChangesMap oldByIndex newByIndex
166− where newList = Map.toList newByIndexUnsorted
167− newByIndex = Map.fromList $ zip (fst <$> newList) $ sortBy cmp $ snd <$> newList
168−
169−-- | Create a 'PatchMapWithMove' that, if applied to the first 'Map' provided,
170−-- will produce the second 'Map'.
171−patchThatChangesMap :: (Ord k, Ord v) => Map k v -> Map k v -> PatchMapWithMove k v
172−patchThatChangesMap oldByIndex newByIndex = patch
173− where oldByValue = Map.fromListWith Set.union $ swap . first Set.singleton <$> Map.toList oldByIndex
174− (insertsAndMoves, unusedValuesByValue) = flip runState oldByValue $ do
175− let f k v = do
176− remainingValues <- get
177− let putRemainingKeys remainingKeys = put $ if Set.null remainingKeys
178− then Map.delete v remainingValues
179− else Map.insert v remainingKeys remainingValues
180− case Map.lookup v remainingValues of
181− Nothing -> return $ NodeInfo (From_Insert v) $ Just undefined -- There's no existing value we can take
182− Just fromKs ->
183− if k `Set.member` fromKs
184− then do
185− putRemainingKeys $ Set.delete k fromKs
186− return $ NodeInfo (From_Move k) $ Just undefined -- There's an existing value, and it's here, so no patch necessary
187− else do
188− (fromK, remainingKeys) <- return . fromJust $ Set.minView fromKs -- There's an existing value, but it's not here; move it here
189− putRemainingKeys remainingKeys
190− return $ NodeInfo (From_Move fromK) $ Just undefined
191− Map.traverseWithKey f newByIndex
192− unusedOldKeys = fold unusedValuesByValue
193− pointlessMove k = \case
194− From_Move k' | k == k' -> True
195− _ -> False
196− keyWasMoved k = if k `Map.member` oldByIndex && not (k `Set.member` unusedOldKeys)
197− then Just undefined
198− else Nothing
199− 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
200−
201−-- | Change the 'From' value of a 'NodeInfo'
202−nodeInfoMapFrom :: (From k v -> From k v) -> NodeInfo k v -> NodeInfo k v
203−nodeInfoMapFrom f ni = ni { _nodeInfo_from = f $ _nodeInfo_from ni }
204−
205−-- | Change the 'From' value of a 'NodeInfo', using a 'Functor' (or
206−-- 'Applicative', 'Monad', etc.) action to get the new value
207−nodeInfoMapMFrom :: Functor f => (From k v -> f (From k v)) -> NodeInfo k v -> f (NodeInfo k v)
208−nodeInfoMapMFrom f ni = fmap (\result -> ni { _nodeInfo_from = result }) $ f $ _nodeInfo_from ni
209−
210−-- | Set the 'To' field of a 'NodeInfo'
211−nodeInfoSetTo :: To k -> NodeInfo k v -> NodeInfo k v
212−nodeInfoSetTo to ni = ni { _nodeInfo_to = to }
213−
214−-- |Helper data structure used for composing patches using the monoid instance.
215−data Fixup k v
216− = Fixup_Delete
217− | Fixup_Update (These (From k v) (To k))
218−
219−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
220−instance Ord k => Semigroup (PatchMapWithMove k v) where
221− PatchMapWithMove ma <> PatchMapWithMove mb = PatchMapWithMove m
222− where
223− connections = Map.toList $ Map.intersectionWithKey (\_ a b -> (_nodeInfo_to a, _nodeInfo_from b)) ma mb
224− h :: (k, (Maybe k, From k v)) -> [(k, Fixup k v)]
225− h (_, (mToAfter, editBefore)) = case (mToAfter, editBefore) of
226− (Just toAfter, From_Move fromBefore)
227− | fromBefore == toAfter
228− -> [(toAfter, Fixup_Delete)]
229− | otherwise
230− -> [ (toAfter, Fixup_Update (This editBefore))
231− , (fromBefore, Fixup_Update (That mToAfter))
232− ]
233− (Nothing, From_Move fromBefore) -> [(fromBefore, Fixup_Update (That mToAfter))] -- The item is destroyed in the second patch, so indicate that it is destroyed in the source map
234− (Just toAfter, _) -> [(toAfter, Fixup_Update (This editBefore))]
235− (Nothing, _) -> []
236− mergeFixups _ Fixup_Delete Fixup_Delete = Fixup_Delete
237− mergeFixups _ (Fixup_Update a) (Fixup_Update b)
238− | This x <- a, That y <- b
239− = Fixup_Update $ These x y
240− | That y <- a, This x <- b
241− = Fixup_Update $ These x y
242− mergeFixups _ _ _ = error "PatchMapWithMove: incompatible fixups"
243− fixups = Map.fromListWithKey mergeFixups $ concatMap h connections
244− combineNodeInfos _ nia nib = NodeInfo
245− { _nodeInfo_from = _nodeInfo_from nia
246− , _nodeInfo_to = _nodeInfo_to nib
247− }
248− applyFixup _ ni = \case
249− Fixup_Delete -> Nothing
250− Fixup_Update u -> Just $ NodeInfo
251− { _nodeInfo_from = fromMaybe (_nodeInfo_from ni) $ getHere u
252− , _nodeInfo_to = fromMaybe (_nodeInfo_to ni) $ getThere u
253− }
254− m = Map.differenceWithKey applyFixup (Map.unionWithKey combineNodeInfos ma mb) fixups
255− getHere :: These a b -> Maybe a
256− getHere = \case
257− This a -> Just a
258− These a _ -> Just a
259− That _ -> Nothing
260− getThere :: These a b -> Maybe b
261− getThere = \case
262− This _ -> Nothing
263− These _ b -> Just b
264− That b -> Just b
265−
266−--TODO: Figure out how to implement this in terms of PatchDMapWithMove rather than duplicating it here
267−-- |Compose patches having the same effect as applying the patches in turn: @'applyAlways' (p <> q) == 'applyAlways' p . 'applyAlways' q@
268−instance Ord k => Monoid (PatchMapWithMove k v) where
269− mempty = PatchMapWithMove mempty
270− mappend = (<>)
src/Reflex/PerformEvent/Base.hs+3−1
@@ -141,7 +141,7 @@ hostPerformEventT a = do
141141 case mToPerform of
142142 Nothing -> return [result']
143143 Just toPerform -> do
144− responses <- runHostFrame $ traverseRequesterData (\v -> Identity <$> v) toPerform
144+ responses <- runHostFrame $ traverseRequesterData (fmap Identity) toPerform
145145 mrt <- readRef responseTrigger
146146 let followupEventTriggers = case mrt of
147147 Just rt -> [rt :=> Identity responses]
@@ -164,6 +164,8 @@ instance (ReflexHost t, MonadHold t m) => MonadHold t (PerformEventT t m) where
164164 buildDynamic getV0 v' = PerformEventT $ lift $ buildDynamic getV0 v'
165165 {-# INLINABLE headE #-}
166166 headE = PerformEventT . lift . headE
167+ {-# INLINABLE now #-}
168+ now = PerformEventT . lift $ now
167169
168170instance (MonadRef (HostFrame t), ReflexHost t) => MonadRef (PerformEventT t m) where
169171 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+2−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 #-}
@@ -84,6 +83,8 @@ instance MonadHold t m => MonadHold t (PostBuildT t m) where
8483 buildDynamic a0 = lift . buildDynamic a0
8584 {-# INLINABLE headE #-}
8685 headE = lift . headE
86+ {-# INLINABLE now #-}
87+ now = lift now
8788
8889instance PerformEvent t m => PerformEvent t (PostBuildT t m) where
8990 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+86−18
@@ -8,9 +8,17 @@
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
1523import Control.Monad.Exception
1624import Control.Monad.Fix
@@ -18,8 +26,10 @@ import Control.Monad.Primitive
1826import Control.Monad.Reader
1927import Control.Monad.Ref
2028import Control.Monad.State.Strict (StateT, execStateT, modify)
29+import Data.Bifunctor
2130import Data.Coerce
22−import Data.Dependent.Map (DMap, GCompare)
31+import Data.Dependent.Map (DMap)
32+import Data.GADT.Compare (GCompare)
2333import Data.FastMutableIntMap
2434import Data.IORef
2535import Data.List
@@ -27,18 +37,27 @@ import Data.Map (Map)
2737import qualified Data.Map.Strict as Map
2838import Data.Monoid ((<>))
2939import Data.Ord
40+import Data.Profunctor.Unsafe ((#.))
3041import qualified Data.Semigroup as S
3142import Data.Type.Coercion
3243import Foreign.Ptr
3344import GHC.Foreign
3445import GHC.IO.Encoding
3546import GHC.Stack
47+import Reflex.Adjustable.Class
48+import Reflex.BehaviorWriter.Class
3649import Reflex.Class
50+import Reflex.DynamicWriter.Class
51+import Reflex.EventWriter.Class
3752import Reflex.Host.Class
53+import Reflex.NotReady.Class
3854import Reflex.PerformEvent.Class
55+import Reflex.PostBuild.Class
56+import Reflex.Query.Class
57+import Reflex.Requester.Class
58+import Reflex.TriggerEvent.Class
3959
4060import System.IO.Unsafe
41−import Unsafe.Coerce
4261
4362data ProfiledTimeline t
4463
@@ -71,9 +90,9 @@ getCostCentreStack = go []
7190 go (cc : l) parent
7291
7392toCostCentreTree :: Ptr CostCentreStack -> Int -> IO CostCentreTree
74−toCostCentreTree ccs n = do
75− ccList <- getCostCentreStack ccs
76− 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
7796
7897getCostCentreTree :: IO CostCentreTree
7998getCostCentreTree = do
@@ -127,27 +146,32 @@ instance Reflex t => Reflex (ProfiledTimeline t) where
127146 push f (Event_Profiled e) = coerce $ push (coerce f) $ profileEvent e -- Profile before rather than after; this way fanout won't count against us
128147 pushCheap f (Event_Profiled e) = coerce $ pushCheap (coerce f) $ profileEvent e
129148 pull = Behavior_Profiled . pull . coerce
130− merge :: forall k. GCompare k => DMap k (Event (ProfiledTimeline t)) -> Event (ProfiledTimeline t) (DMap k Identity)
131− merge = Event_Profiled . merge . (unsafeCoerce :: DMap k (Event (ProfiledTimeline t)) -> DMap k (Event t))
132− 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)
133154 switch (Behavior_Profiled b) = coerce $ profileEvent $ switch (coerceBehavior b)
134155 coincidence (Event_Profiled e) = coerce $ profileEvent $ coincidence (coerceEvent e)
135156 current (Dynamic_Profiled d) = coerce $ current d
136157 updated (Dynamic_Profiled d) = coerce $ profileEvent $ updated d
137158 unsafeBuildDynamic (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildDynamic a0 a'
138159 unsafeBuildIncremental (ProfiledM a0) (Event_Profiled a') = coerce $ unsafeBuildIncremental a0 a'
139− mergeIncremental = Event_Profiled . mergeIncremental . (unsafeCoerce :: Incremental (ProfiledTimeline t) (PatchDMap k (Event (ProfiledTimeline t))) -> Incremental t (PatchDMap k (Event t)))
140− 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)
141162 currentIncremental (Incremental_Profiled i) = coerce $ currentIncremental i
142163 updatedIncremental (Incremental_Profiled i) = coerce $ profileEvent $ updatedIncremental i
143164 incrementalToDynamic (Incremental_Profiled i) = coerce $ incrementalToDynamic i
144− behaviorCoercion (c :: Coercion a b) = case behaviorCoercion c :: Coercion (Behavior t a) (Behavior t b) of
145− Coercion -> unsafeCoerce (Coercion :: Coercion (Behavior (ProfiledTimeline t) a) (Behavior (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
146− eventCoercion (c :: Coercion a b) = case eventCoercion c :: Coercion (Event t a) (Event t b) of
147− Coercion -> unsafeCoerce (Coercion :: Coercion (Event (ProfiledTimeline t) a) (Event (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
148− dynamicCoercion (c :: Coercion a b) = case dynamicCoercion c :: Coercion (Dynamic t a) (Dynamic t b) of
149− Coercion -> unsafeCoerce (Coercion :: Coercion (Dynamic (ProfiledTimeline t) a) (Dynamic (ProfiledTimeline t) a)) --TODO: Figure out how to make this typecheck without the unsafeCoerce
150− 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)
151175 fanInt (Event_Profiled e) = coerce $ fanInt $ profileEvent e
152176
153177deriving instance Functor (Dynamic t) => Functor (Dynamic (ProfiledTimeline t))
@@ -160,10 +184,21 @@ instance MonadHold t m => MonadHold (ProfiledTimeline t) (ProfiledM m) where
160184 holdIncremental v0 (Event_Profiled v') = ProfiledM $ Incremental_Profiled <$> holdIncremental v0 v'
161185 buildDynamic (ProfiledM v0) (Event_Profiled v') = ProfiledM $ Dynamic_Profiled <$> buildDynamic v0 v'
162186 headE (Event_Profiled e) = ProfiledM $ Event_Profiled <$> headE e
187+ now = ProfiledM $ Event_Profiled <$> now
163188
164189instance MonadSample t m => MonadSample (ProfiledTimeline t) (ProfiledM m) where
165190 sample (Behavior_Profiled b) = ProfiledM $ sample b
166191
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+
167202instance MonadTrans ProfiledM where
168203 lift = ProfiledM
169204
@@ -175,6 +210,39 @@ instance PerformEvent t m => PerformEvent (ProfiledTimeline t) (ProfiledM m) whe
175210 performEvent_ = lift . performEvent_ . coerce
176211 performEvent = lift . fmap coerce . performEvent . coerce
177212
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+
178246instance MonadRef m => MonadRef (ProfiledM m) where
179247 type Ref (ProfiledM m) = Ref m
180248 newRef = lift . newRef
src/Reflex/Pure.hs+34−23
@@ -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,10 +42,11 @@ 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
4648-- with the type @/t/@.
47−data Pure t
49+data Pure (t :: Type)
4850
4951-- | The 'Enum' instance of @/t/@ must be dense: for all @/x :: t/@, there must not exist
5052-- any @/y :: t/@ such that @/'pred' x < y < x/@. The 'HasTrie' instance will be used
@@ -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+44−42
@@ -1,7 +1,6 @@
11{-# LANGUAGE FlexibleInstances #-}
22{-# LANGUAGE GeneralizedNewtypeDeriving #-}
33{-# LANGUAGE InstanceSigs #-}
4−{-# LANGUAGE KindSignatures #-}
54{-# LANGUAGE LambdaCase #-}
65{-# LANGUAGE MultiParamTypeClasses #-}
76{-# LANGUAGE RankNTypes #-}
@@ -17,29 +16,32 @@ module Reflex.Query.Base
1716 , mapQueryResult
1817 , dynWithQueryT
1918 , withQueryT
19+ , mapQueryT
2020 ) where
2121
2222import Control.Applicative (liftA2)
2323import Control.Monad.Exception
2424import Control.Monad.Fix
25+import Control.Monad.Morph
2526import Control.Monad.Primitive
2627import Control.Monad.Reader
2728import Control.Monad.Ref
2829import Control.Monad.State.Strict
2930import Data.Align
30−import Data.Dependent.Map (DMap, DSum (..))
31+import Data.Dependent.Map (DMap)
3132import qualified Data.Dependent.Map as DMap
33+import Data.Dependent.Sum (DSum(..))
3234import Data.Foldable
3335import Data.Functor.Compose
3436import Data.Functor.Misc
37+import Data.GADT.Compare (GCompare)
3538import Data.IntMap (IntMap)
3639import qualified Data.IntMap as IntMap
3740import Data.Map (Map)
3841import qualified Data.Map as Map
3942import Data.Monoid ((<>))
4043import qualified Data.Semigroup as S
41−import Data.Some (Some)
42−import qualified Data.Some as Some
44+import Data.Some (Some(Some))
4345import Data.These
4446
4547import Reflex.Class
@@ -48,7 +50,7 @@ import Reflex.DynamicWriter.Class
4850import Reflex.EventWriter.Base
4951import Reflex.EventWriter.Class
5052import Reflex.Host.Class
51−import qualified Reflex.Patch.MapWithMove as MapWithMove
53+import qualified Data.Patch.MapWithMove as MapWithMove
5254import Reflex.PerformEvent.Class
5355import Reflex.PostBuild.Class
5456import Reflex.Query.Class
@@ -74,26 +76,19 @@ getQueryTLoweredResultValue (QueryTLoweredResult (v, _)) = v
7476getQueryTLoweredResultWritten :: QueryTLoweredResult t q v -> [Behavior t q]
7577getQueryTLoweredResultWritten (QueryTLoweredResult (_, w)) = w
7678
77−{-
78−let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
79− sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
80− bs' = fmapCheap snd $ r'
81− patches = unsafeBuildIncremental (sampleBs bs0) $
82− flip pushCheap bs' $ \bs -> do
83− p <- (~~) <$> sampleBs bs <*> sample (currentIncremental patches)
84− return (Just (AdditivePatch p))
85−-}
86−
87−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
8883 runWithReplace (QueryT a0) a' = do
8984 ((r0, bs0), r') <- QueryT $ lift $ runWithReplace (runStateT a0 []) $ fmapCheap (flip runStateT [] . unQueryT) a'
9085 let sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
9186 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
9287 bs' = fmapCheap snd $ r'
9388 bbs <- hold bs0 bs'
94− let patches = flip pushAlwaysCheap bs' $ \newBs -> do
89+ let patches = flip pushCheap bs' $ \newBs -> do
9590 oldBs <- sample bbs
96− (~~) <$> sampleBs newBs <*> sampleBs oldBs
91+ maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
9792 QueryT $ modify $ (:) $ pull $ sampleBs =<< sample bbs
9893 QueryT $ lift $ tellEvent patches
9994 return (r0, fmapCheap fst r')
@@ -143,7 +138,7 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
143138 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
144139 return (liftedResult0, liftedResult')
145140
146− 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'))
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'))
147142 traverseDMapWithKeyWithAdjust f dm0 dm' = do
148143 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
149144 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -152,10 +147,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
152147 liftedResult' = fforCheap result' $ \(PatchDMap p) -> PatchDMap $
153148 mapKeyValuePairsMonotonic (\(k :=> ComposeMaybe mr) -> k :=> ComposeMaybe (fmap (getQueryTLoweredResultValue . getCompose) mr)) p
154149 liftedBs0 :: Map (Some k) [Behavior t q]
155− 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
156151 liftedBs' :: Event t (PatchMap (Some k) [Behavior t q])
157152 liftedBs' = fforCheap result' $ \(PatchDMap p) -> PatchMap $
158− 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
159154 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
160155 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
161156 accumBehaviors :: forall m'. MonadHold t m'
@@ -171,24 +166,24 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
171166 let p k bs = case Map.lookup k bs0 of
172167 Nothing -> case bs of
173168 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
174− Nothing -> return mempty
169+ Nothing -> return Nothing
175170 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
176− Just newBs -> sampleBs newBs
171+ Just newBs -> maskMempty <$> sampleBs newBs
177172 Just oldBs -> case bs of
178173 -- 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
179− Nothing -> negateG <$> sampleBs oldBs
174+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
180175 -- 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
181176 -- composed with the sampling the child's new state.
182− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
177+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
183178 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
184179 -- child patches and wrap them in AdditivePatch.
185− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
186− return (apply pbs bs0, Just patch)
180+ patch <- fold <$> Map.traverseWithKey p bs'
181+ return (apply pbs bs0, AdditivePatch <$> patch)
187182 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors liftedBs0 liftedBs'
188183 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
189184 return (liftedResult0, liftedResult')
190185
191− 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'))
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'))
192187 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = do
193188 let f' :: forall a. k a -> v a -> EventWriterT t q (ReaderT (Dynamic t (QueryResult q)) m) (Compose (QueryTLoweredResult t q) v' a)
194189 f' k v = fmap (Compose . QueryTLoweredResult) $ flip runStateT [] $ unQueryT $ f k v
@@ -196,10 +191,10 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
196191 let liftedResult0 = mapKeyValuePairsMonotonic (\(k :=> Compose r) -> k :=> getQueryTLoweredResultValue r) result0
197192 liftedResult' = fforCheap result' $ mapPatchDMapWithMove (getQueryTLoweredResultValue . getCompose)
198193 liftedBs0 :: Map (Some k) [Behavior t q]
199− 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
200195 liftedBs' :: Event t (PatchMapWithMove (Some k) [Behavior t q])
201196 liftedBs' = fforCheap result' $ weakenPatchDMapWithMoveWith (getQueryTLoweredResultWritten . getCompose) {- \(PatchDMap p) -> PatchMapWithMove $
202− 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 -}
203198 sampleBs :: forall m'. MonadSample t m' => [Behavior t q] -> m' q
204199 sampleBs = foldlM (\b a -> (b <>) <$> sample a) mempty
205200 accumBehaviors' :: forall m'. MonadHold t m'
@@ -216,28 +211,28 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
216211 p k bs = case Map.lookup k bs0 of
217212 Nothing -> case MapWithMove._nodeInfo_from bs of
218213 -- If the update is to delete the state for a child that doesn't exist, the patch is mempty.
219− MapWithMove.From_Delete -> return mempty
214+ MapWithMove.From_Delete -> return Nothing
220215 -- If the update is to update the state for a child that doesn't exist, the patch is the sample of the new state.
221− MapWithMove.From_Insert newBs -> sampleBs newBs
216+ MapWithMove.From_Insert newBs -> maskMempty <$> sampleBs newBs
222217 MapWithMove.From_Move k' -> case Map.lookup k' bs0 of
223− Nothing -> return mempty
224− Just newBs -> sampleBs newBs
218+ Nothing -> return Nothing
219+ Just newBs -> maskMempty <$> sampleBs newBs
225220 Just oldBs -> case MapWithMove._nodeInfo_from bs of
226221 -- 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
227− MapWithMove.From_Delete -> negateG <$> sampleBs oldBs
222+ MapWithMove.From_Delete -> maskMempty . negateG <$> sampleBs oldBs
228223 -- 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
229224 -- composed with the sampling the child's new state.
230− MapWithMove.From_Insert newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
225+ MapWithMove.From_Insert newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
231226 MapWithMove.From_Move k'
232− | k' == k -> return mempty
227+ | k' == k -> return Nothing
233228 | otherwise -> case Map.lookup k' bs0 of
234229 -- If we are moving from a non-existent key, that is a delete
235− Nothing -> negateG <$> sampleBs oldBs
236− Just newBs -> (~~) <$> sampleBs newBs <*> sampleBs oldBs
230+ Nothing -> maskMempty . negateG <$> sampleBs oldBs
231+ Just newBs -> maskMempty <$> ((~~) <$> sampleBs newBs <*> sampleBs oldBs)
237232 -- we compute the patch by iterating over the update PatchMap and proceeding by cases. Then we fold over the
238233 -- child patches and wrap them in AdditivePatch.
239− patch <- AdditivePatch . fold <$> Map.traverseWithKey p bs'
240− return (apply pbs bs0, Just patch)
234+ patch <- fold <$> Map.traverseWithKey p bs'
235+ return (apply pbs bs0, AdditivePatch <$> patch)
241236 (qpatch :: Event t (AdditivePatch q)) <- mapAccumMaybeM_ accumBehaviors' liftedBs0 liftedBs'
242237 tellQueryIncremental $ unsafeBuildIncremental (fold <$> mapM sampleBs liftedBs0) qpatch
243238 return (liftedResult0, liftedResult')
@@ -245,6 +240,9 @@ instance (Reflex t, MonadFix m, Group q, Additive q, Query q, MonadHold t m, Adj
245240instance MonadTrans (QueryT t q) where
246241 lift = QueryT . lift . lift . lift
247242
243+instance MFunctor (QueryT t q) where
244+ hoist = mapQueryT
245+
248246instance PrimMonad m => PrimMonad (QueryT t q m) where
249247 type PrimState (QueryT t q m) = PrimState m
250248 primitive = lift . primitive
@@ -296,6 +294,10 @@ withQueryT f a = do
296294 (fmapCheap (AdditivePatch . mapQuery f . unAdditivePatch) $ updatedIncremental q)
297295 return result
298296
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+
299301-- | dynWithQueryT's (Dynamic t QueryMorphism) argument needs to be a group homomorphism at all times in order to behave correctly
300302dynWithQueryT :: (MonadFix m, PostBuild t m, Group q, Additive q, Group q', Additive q', Query q')
301303 => Dynamic t (QueryMorphism q q')
@@ -340,5 +342,5 @@ instance Requester t m => Requester t (QueryT t q m) where
340342instance EventWriter t w m => EventWriter t w (QueryT t q m) where
341343 tellEvent = lift . tellEvent
342344
343−instance MonadDynamicWriter t w m => MonadDynamicWriter t w (QueryT t q m) where
345+instance DynamicWriter t w m => DynamicWriter t w (QueryT t q m) where
344346 tellDyn = lift . tellDyn
src/Reflex/Query/Class.hs+68−9
@@ -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,6 +22,7 @@ module Reflex.Query.Class
1522 , MonadQuery (..)
1623 , tellQueryDyn
1724 , queryDyn
25+ , subQuery
1826 , mapQuery
1927 , mapQueryResult
2028 ) where
@@ -27,11 +35,18 @@ import Data.Data
2735import Data.Ix
2836import Data.Map.Monoidal (MonoidalMap)
2937import qualified Data.Map.Monoidal as MonoidalMap
30−import Data.Semigroup
38+import Data.Semigroup (Semigroup(..))
3139import Foreign.Storable
40+import Data.Void
41+import Data.Monoid hiding ((<>))
42+import Control.Applicative
3243
3344import Reflex.Class
3445
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'.
3550class (Monoid (QueryResult a), Semigroup (QueryResult a)) => Query a where
3651 type QueryResult a :: *
3752 crop :: a -> QueryResult a -> QueryResult a
@@ -40,8 +55,39 @@ instance (Ord k, Query v) => Query (MonoidalMap k v) where
4055 type QueryResult (MonoidalMap k v) = MonoidalMap k (QueryResult v)
4156 crop q r = MonoidalMap.intersectionWith (flip crop) r q
4257
43−-- | NB: QueryMorphism's must be group homomorphisms when acting on the query type
44−-- and compatible with the query relationship when acting on the query result
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.
4591data QueryMorphism q q' = QueryMorphism
4692 { _queryMorphism_mapQuery :: q -> q'
4793 , _queryMorphism_mapQueryResult :: QueryResult q' -> QueryResult q
@@ -54,13 +100,16 @@ instance Category QueryMorphism where
54100 , _queryMorphism_mapQueryResult = mapQueryResult qm' . mapQueryResult qm
55101 }
56102
103+-- | Apply a 'QueryMorphism' to a 'Query'
57104mapQuery :: QueryMorphism q q' -> q -> q'
58105mapQuery = _queryMorphism_mapQuery
59106
107+-- | Map a 'QueryMorphism' to a 'QueryResult'
60108mapQueryResult :: QueryMorphism q q' -> QueryResult q' -> QueryResult q
61109mapQueryResult = _queryMorphism_mapQueryResult
62110
63−-- | This type keeps track of the multiplicity of elements of the view selector that are being used by the app
111+-- | This type can be used to track of the frequency of interest in a given 'Query'. See note on
112+-- 'combineSelectedCounts'
64113newtype SelectedCount = SelectedCount { unSelectedCount :: Int }
65114 deriving (Eq, Ord, Show, Read, Integral, Num, Bounded, Enum, Real, Ix, Bits, FiniteBits, Storable, Data)
66115
@@ -76,24 +125,34 @@ instance Group SelectedCount where
76125
77126instance Additive SelectedCount
78127
79−-- | 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.
80131combineSelectedCounts :: SelectedCount -> SelectedCount -> Maybe SelectedCount
81132combineSelectedCounts (SelectedCount i) (SelectedCount j) = if i == negate j then Nothing else Just $ SelectedCount (i + j)
82133
83−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
84137 tellQueryIncremental :: Incremental t (AdditivePatch q) -> m ()
85138 askQueryResult :: m (Dynamic t (QueryResult q))
86139 queryIncremental :: Incremental t (AdditivePatch q) -> m (Dynamic t (QueryResult q))
87140
88−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
89142 tellQueryIncremental = lift . tellQueryIncremental
90143 askQueryResult = lift askQueryResult
91144 queryIncremental = lift . queryIncremental
92145
146+-- | Produce and send an 'Incremental' 'Query' from a 'Dynamic' 'Query'.
93147tellQueryDyn :: (Reflex t, MonadQuery t q m) => Dynamic t q -> m ()
94148tellQueryDyn d = tellQueryIncremental $ unsafeBuildIncremental (sample (current d)) $ attachWith (\old new -> AdditivePatch $ new ~~ old) (current d) (updated d)
95149
96−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))
97152queryDyn q = do
98153 tellQueryDyn q
99154 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+191−18
@@ -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,6 +22,7 @@
2122module Reflex.Requester.Base
2223 ( RequesterT (..)
2324 , runRequesterT
25+ , withRequesterT
2426 , runWithReplaceRequesterTWith
2527 , traverseIntMapWithKeyWithAdjustRequesterTWith
2628 , traverseDMapWithKeyWithAdjustRequesterTWith
@@ -30,6 +32,11 @@ module Reflex.Requester.Base
3032 , forRequesterData
3133 , requesterDataToList
3234 , singletonRequesterData
35+ , matchResponsesWithRequests
36+ , matchResponseMapWithRequests
37+ , multiEntry
38+ , unMultiEntry
39+ , requesting'
3340 ) where
3441
3542import Reflex.Class
@@ -44,13 +51,17 @@ import Reflex.TriggerEvent.Class
4451import Control.Applicative (liftA2)
4552import Control.Monad.Exception
4653import Control.Monad.Identity
54+import Control.Monad.Morph
55+import Control.Monad.Primitive
4756import Control.Monad.Reader
4857import Control.Monad.Ref
4958import Control.Monad.State.Strict
5059import Data.Bits
5160import Data.Coerce
52−import Data.Dependent.Map (DMap, DSum (..))
61+import Data.Constraint
62+import Data.Dependent.Map (DMap)
5363import qualified Data.Dependent.Map as DMap
64+import Data.Dependent.Sum (DSum (..))
5465import Data.Functor.Compose
5566import Data.Functor.Misc
5667import Data.IntMap.Strict (IntMap)
@@ -60,8 +71,7 @@ import qualified Data.Map as Map
6071import Data.Monoid ((<>))
6172import Data.Proxy
6273import qualified Data.Semigroup as S
63−import Data.Some (Some)
64−import qualified Data.Some as Some
74+import Data.Some (Some(Some))
6575import Data.Type.Equality
6676import Data.Unique.Tag
6777
@@ -74,19 +84,51 @@ newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
7484
7585newtype RequesterData f = RequesterData (TagMap (Entry f))
7686
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
7790data RequesterDataKey a where
7891 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
7992 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
80− 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
8194 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
8295
8396singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
8497singletonRequesterData rdk v = case rdk of
8598 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
8699 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
87− 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+ }
88104 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
89105
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+
90132requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
91133requesterDataToList (RequesterData m) = do
92134 k :=> Entry e <- tagMapToList m
@@ -96,11 +138,12 @@ requesterDataToList (RequesterData m) = do
96138 (k', e') <- IntMap.toList e
97139 k'' :=> e'' <- requesterDataToList e'
98140 return $ RequesterDataKey_Multi k k' k'' :=> e''
99− MyTagType_Multi2 -> do
100− (k', e') <- Map.toList e
101− (k'', e'') <- IntMap.toList e'
102− k''' :=> e''' <- requesterDataToList e''
103− 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'''
104147 MyTagType_Multi3 -> do
105148 (k', e') <- IntMap.toList e
106149 (k'', e'') <- IntMap.toList e'
@@ -128,7 +171,13 @@ traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWith
128171 go k (Entry request) = Entry <$> case myKeyType k of
129172 MyTagType_Single -> f request
130173 MyTagType_Multi -> traverse (traverseRequesterData f) request
131− 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+ }
132181 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
133182
134183-- | 'traverseRequesterData' with its arguments flipped
@@ -172,9 +221,14 @@ instance MyTagTypeOffset Multi3 where
172221type family EntryContents request a where
173222 EntryContents request (Single a) = request a
174223 EntryContents request Multi = IntMap (RequesterData request)
175− EntryContents request (Multi2 k) = Map (Some k) (IntMap (RequesterData request))
224+ EntryContents request (Multi2 k) = Multi2Contents k request
176225 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
177226
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+
178232newtype Entry request x = Entry { unEntry :: EntryContents request x }
179233
180234{-# INLINE singleEntry #-}
@@ -244,6 +298,10 @@ deriving instance MonadHold t m => MonadHold t (RequesterT t request response m)
244298deriving instance PostBuild t m => PostBuild t (RequesterT t request response m)
245299deriving instance TriggerEvent t m => TriggerEvent t (RequesterT t request response m)
246300
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+
247305-- TODO: Monoid and Semigroup can likely be derived once StateT has them.
248306instance (Monoid a, Monad m) => Monoid (RequesterT t request response m a) where
249307 mempty = pure mempty
@@ -257,7 +315,6 @@ instance (S.Semigroup a, Monad m) => S.Semigroup (RequesterT t request response
257315-- requests are made, and responses should be provided in the input 'Event'.
258316-- The 'Tag' keys will be used to return the responses to the same place the
259317-- requests were issued.
260−
261318runRequesterT :: (Reflex t, Monad m)
262319 => RequesterT t request response m a
263320 -> Event t (RequesterData response) --TODO: This DMap will be in reverse order, so we need to make sure the caller traverses it in reverse
@@ -267,6 +324,20 @@ runRequesterT (RequesterT a) responses = do
267324 coerceEvent responses
268325 return (result, fmapCheap (RequesterData . TagMap) $ mergeInt $ IntMap.fromDistinctAscList $ _requesterState_requests s)
269326
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+
270341instance (Reflex t, Monad m) => Requester t (RequesterT t request response m) where
271342 type Request (RequesterT t request response m) = request
272343 type Response (RequesterT t request response m) = response
@@ -286,7 +357,7 @@ tagRequest req = do
286357 return t
287358
288359{-# INLINE responseFromTag #-}
289−responseFromTag :: Monad m => 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))
290361responseFromTag (MyTagWrap t) = do
291362 responses :: EventSelectorInt t Any <- RequesterT ask
292363 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
@@ -294,6 +365,9 @@ responseFromTag (MyTagWrap t) = do
294365instance MonadTrans (RequesterT t request response) where
295366 lift = RequesterT . lift . lift
296367
368+instance MFunctor (RequesterT t request response) where
369+ hoist f = RequesterT . hoist (hoist f) . unRequesterT
370+
297371instance PerformEvent t m => PerformEvent t (RequesterT t request response m) where
298372 type Performable (RequesterT t request response m) = Performable m
299373 performEvent_ = lift . performEvent_
@@ -370,7 +444,7 @@ traverseIntMapWithKeyWithAdjustRequesterTWith base patchNewElements mergePatchIn
370444 pack = Entry
371445 f' :: IntMap.Key -> (Int, v) -> m (Event t (IntMap (RequesterData request)), v')
372446 f' k (n, v) = do
373− (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?
374448 return (fmapCheap (IntMap.singleton n) myRequests, result)
375449 ndm' <- numberOccurrencesFrom 1 dm'
376450 (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
@@ -413,12 +487,12 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
413487 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
414488 responses = fanMap $ fmapCheap unpack response
415489 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
416− unpack = unEntry
490+ unpack = _multi2Contents_values . unEntry
417491 pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
418− pack = Entry
492+ pack m = Entry $ Multi2Contents { _multi2Contents_values = m, _multi2Contents_dict = Dict }
419493 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
420494 f' k (Compose (n, v)) = do
421− (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))
422496 return $ Compose (fmapCheap (IntMap.singleton n) myRequests, result)
423497 ndm' <- numberOccurrencesFrom 1 dm'
424498 (children0, children') <- base f' (DMap.map (\v -> Compose (0, v)) dm0) $ fmap (\(n, dm) -> mapPatch (\v -> Compose (n, v)) dm) ndm'
@@ -432,3 +506,102 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
432506 promptRequests = coincidence $ fmapCheap (mergeMap . patchNewElements) requests' --TODO: Create a mergeIncrementalPromptly, and use that to eliminate this 'coincidence'
433507 requests <- holdIncremental requests0 requests'
434508 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+743−451
@@ -9,17 +9,22 @@
99{-# LANGUAGE GADTs #-}
1010{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1111{-# LANGUAGE LambdaCase #-}
12−{-# LANGUAGE MultiParamTypeClasses #-}
13−{-# LANGUAGE MultiWayIf #-}
1412{-# LANGUAGE RankNTypes #-}
1513{-# LANGUAGE RoleAnnotations #-}
1614{-# LANGUAGE ScopedTypeVariables #-}
1715{-# LANGUAGE TypeFamilies #-}
1816{-# LANGUAGE TypeOperators #-}
1917{-# LANGUAGE UndecidableInstances #-}
18+{-# LANGUAGE PolyKinds #-}
19+{-# LANGUAGE DeriveFunctor #-}
20+{-# LANGUAGE StandaloneDeriving #-}
21+{-# LANGUAGE InstanceSigs #-}
22+{-# LANGUAGE MultiWayIf #-}
23+
2024#ifdef USE_REFLEX_OPTIMIZER
2125{-# OPTIONS_GHC -fplugin=Reflex.Optimizer #-}
2226#endif
27+{-# OPTIONS_GHC -Wunused-binds #-}
2328-- | This module is the implementation of the 'Spider' 'Reflex' engine. It uses
2429-- a graph traversal algorithm to propagate 'Event's and 'Behavior's.
2530module Reflex.Spider.Internal (module Reflex.Spider.Internal) where
@@ -33,12 +38,17 @@ import Control.Monad hiding (forM, forM_, mapM, mapM_)
3338import Control.Monad.Exception
3439import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
3540import Control.Monad.Primitive
36−import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_)
41+import Control.Monad.Reader.Class
42+import Control.Monad.IO.Class
43+import Control.Monad.ReaderIO
3744import Control.Monad.Ref
45+import Control.Monad.Fail (MonadFail)
46+import qualified Control.Monad.Fail as MonadFail
3847import Data.Align
3948import Data.Coerce
40−import Data.Dependent.Map (DMap, DSum (..))
49+import Data.Dependent.Map (DMap)
4150import qualified Data.Dependent.Map as DMap
51+import Data.Dependent.Sum (DSum (..))
4252import Data.FastMutableIntMap (FastMutableIntMap, PatchIntMap (..))
4353import qualified Data.FastMutableIntMap as FastMutableIntMap
4454import Data.Foldable hiding (concat, elem, sequence_)
@@ -49,54 +59,73 @@ import Data.GADT.Compare
4959import Data.IntMap.Strict (IntMap)
5060import qualified Data.IntMap.Strict as IntMap
5161import Data.IORef
52−import Data.Maybe
53−import Data.Monoid ((<>))
62+import Data.Kind (Type)
63+import Data.Maybe hiding (mapMaybe)
64+import Data.Monoid (mempty, (<>))
5465import Data.Proxy
5566import Data.These
5667import Data.Traversable
57−import GHC.Exts
68+import Data.Type.Equality ((:~:)(Refl))
69+import Data.Witherable (Filterable, mapMaybe)
70+import GHC.Exts hiding (toList)
5871import GHC.IORef (IORef (..))
5972import GHC.Stack
6073import Reflex.FastWeak
61−import Reflex.FunctorMaybe
6274import System.IO.Unsafe
6375import System.Mem.Weak
6476import Unsafe.Coerce
6577
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+
6687#ifdef DEBUG_CYCLES
6788import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
89+#endif
90+
6891import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
6992import qualified Data.List.NonEmpty as NonEmpty
70−import Data.Monoid (mempty)
7193import Data.Tree (Forest, Tree (..), drawForest)
72−#endif
94+import Data.List (isPrefixOf)
7395
74−import Data.FastWeakBag (FastWeakBag)
96+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
7597import qualified Data.FastWeakBag as FastWeakBag
98+
7699import Data.Reflection
77−import Data.Some (Some)
78−import qualified Data.Some as Some
100+import Data.Some (Some(Some))
79101import Data.Type.Coercion
102+import Data.Profunctor.Unsafe ((#.), (.#))
80103import Data.WeakBag (WeakBag, WeakBagTicket, _weakBag_children)
81104import qualified Data.WeakBag as WeakBag
82105import qualified Reflex.Class
83106import qualified Reflex.Class as R
84107import qualified Reflex.Host.Class
85108import Reflex.NotReady.Class
86−import Reflex.Patch
87−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
109+import Data.Patch
110+import qualified Data.Patch.DMapWithMove as PatchDMapWithMove
111+import Reflex.PerformEvent.Base (PerformEventT)
88112
89113#ifdef DEBUG_TRACE_EVENTS
90114import qualified Data.ByteString.Char8 as BS8
91115import System.IO (stderr)
116+import Data.List (isPrefixOf)
92117#endif
93118
94−#ifdef DEBUG_TRACE_EVENTS
119+-- TODO stdout might not be the best channel for debug output
120+debugStrLn :: String -> IO ()
121+debugStrLn = putStrLn
95122
123+#ifdef DEBUG_TRACE_EVENTS
96124withStackOneLine :: (BS8.ByteString -> a) -> a
97125withStackOneLine expr = unsafePerformIO $ do
98126 stack <- currentCallStack
99− return (expr (BS8.pack (unwords (reverse stack))))
127+ return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
128+ where dropInternal = filterStack "Reflex.Spider.Internal"
100129
101130#endif
102131
@@ -107,28 +136,42 @@ debugInvalidateHeight :: Bool
107136debugInvalidate :: Bool
108137
109138#ifdef DEBUG
110−
111139#define DEBUG_NODEIDS
112140
141+#ifdef DEBUG_TRACE_PROPAGATION
113142debugPropagate = True
143+#else
144+debugPropagate = False
145+#endif
114146
147+#ifdef DEBUG_TRACE_HEIGHT
148+debugInvalidateHeight = True
149+#else
115150debugInvalidateHeight = False
151+#endif
116152
153+#ifdef DEBUG_TRACE_INVALIDATION
117154debugInvalidate = True
155+#else
156+debugInvalidate = False
157+#endif
118158
119159class HasNodeId a where
120160 getNodeId :: a -> Int
121161
122−instance HasNodeId (Hold x p a) where
123− 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
124167
125−instance HasNodeId (PushSubscribed x a b) where
126− getNodeId = pushSubscribedNodeId
168+instance HasNodeId (Hold x p) where
169+ getNodeId = holdNodeId
127170
128171instance HasNodeId (SwitchSubscribed x a) where
129172 getNodeId = switchSubscribedNodeId
130173
131−instance HasNodeId (FanSubscribed x a) where
174+instance HasNodeId (FanSubscribed x v a) where
132175 getNodeId = fanSubscribedNodeId
133176
134177instance HasNodeId (CoincidenceSubscribed x a) where
@@ -142,41 +185,16 @@ instance HasNodeId (Pull x a) where
142185
143186{-# INLINE showNodeId #-}
144187showNodeId :: HasNodeId a => a -> String
145−showNodeId = ("#"<>) . show . getNodeId
146−
147−showSubscriberType :: Subscriber x a -> String
148−showSubscriberType = \case
149− SubscriberPush _ _ -> "SubscriberPush"
150− SubscriberMerge _ _ -> "SubscriberMerge"
151− SubscriberFan _ -> "SubscriberFan"
152− SubscriberMergeChange _ -> "SubscriberMergeChange"
153− SubscriberHold _ -> "SubscriberHold"
154− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
155− SubscriberSwitch _ -> "SubscriberSwitch"
156− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
157− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
158− SubscriberHandle -> "SubscriberHandle"
159−
160−showEventType :: Event x a -> String
161−showEventType = \case
162− EventRoot _ _ -> "EventRoot"
163− EventNever -> "EventNever"
164− EventPush _ -> "EventPush"
165− EventMerge _ -> "EventMerge"
166− EventFan _ _ -> "EventFan"
167− EventSwitch _ -> "EventSwitch"
168− EventCoincidence _ -> "EventCoincidence"
169− EventHold _ -> "EventHold"
170− EventDyn _ -> "EventDyn"
171− EventHoldIdentity _ -> "EventHoldIdentity"
172− EventDynIdentity _ -> "EventDynIdentity"
188+showNodeId = showNodeId' . getNodeId
189+
190+showNodeId' :: Int -> String
191+showNodeId' = ("#"<>) . show
192+
173193
174194#else
175195
176196debugPropagate = False
177−
178197debugInvalidateHeight = False
179−
180198debugInvalidate = False
181199
182200-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -184,6 +202,10 @@ debugInvalidate = False
184202showNodeId :: a -> String
185203showNodeId _ = ""
186204
205+{-# INLINE showNodeId' #-}
206+showNodeId' :: Int -> String
207+showNodeId' _ = ""
208+
187209#endif
188210
189211#ifdef DEBUG_NODEIDS
@@ -193,12 +215,6 @@ nextNodeIdRef = unsafePerformIO $ newIORef 1
193215
194216newNodeId :: IO Int
195217newNodeId = atomicModifyIORef' nextNodeIdRef $ \n -> (succ n, n)
196−
197−{-# NOINLINE unsafeNodeId #-}
198−unsafeNodeId :: a -> Int
199−unsafeNodeId a = unsafePerformIO $ do
200− touch a
201− newNodeId
202218#endif
203219
204220--------------------------------------------------------------------------------
@@ -235,9 +251,9 @@ subscribeAndRead = unEvent
235251-- caching; if the computation function is very cheap, this is (much) more
236252-- efficient than 'push'
237253{-# INLINE [1] pushCheap #-}
238−pushCheap :: (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
254+pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
239255pushCheap !f e = Event $ \sub -> do
240− (subscription, occ) <- subscribeAndRead e $ sub
256+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
241257 { subscriberPropagate = \a -> do
242258 mb <- f a
243259 mapM_ (subscriberPropagate sub) mb
@@ -256,10 +272,10 @@ terminalSubscriber p = Subscriber
256272
257273-- | Subscribe to an Event only for the duration of one occurrence
258274{-# INLINE subscribeAndReadHead #-}
259−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)
260276subscribeAndReadHead e sub = do
261277 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
262− (subscription, occ) <- subscribeAndRead e $ sub
278+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
263279 { subscriberPropagate = \a -> do
264280 liftIO $ unsubscribe =<< readIORef subscriptionRef
265281 subscriberPropagate sub a
@@ -270,24 +286,42 @@ subscribeAndReadHead e sub = do
270286 return (subscription, occ)
271287
272288--TODO: Make this lazy in its input event
273−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)
274290headE originalE = do
275291 parent <- liftIO $ newIORef $ Just originalE
276292 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
277293 let clearParent = liftIO $ writeIORef parent Nothing
278− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
294+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
279295 when (isJust occ) clearParent
280− return $ Event $ \sub -> do
296+ return $ Event $ \sub ->
281297 liftIO (readIORef parent) >>= \case
282− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
298+ Nothing -> subscribeAndReadNever
283299 Just e -> subscribeAndReadHead e sub
284300
285301data CacheSubscribed x a
286302 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
287303 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
288304 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
305+#ifdef DEBUG_NODEIDS
306+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
307+#endif
289308 }
290309
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+
291325-- | Construct an 'Event' whose value is guaranteed not to be recomputed
292326-- repeatedly
293327--
@@ -302,27 +336,33 @@ cacheEvent e =
302336#else
303337 Event $
304338#endif
305− let mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
306− !mSubscribedRef = unsafeNewIORef e emptyFastWeak
307− in \sub -> {-# SCC "cacheEvent" #-} do
339+ unsafePerformIO $ do
340+ mSubscribedRef :: IORef (FastWeak (CacheSubscribed x a))
341+ <- newIORef emptyFastWeak
342+ pure $ \sub -> {-# SCC "cacheEvent" #-} do
308343#ifdef DEBUG_TRACE_EVENTS
309344 unless (BS8.null callSite) $ liftIO $ BS8.hPutStrLn stderr callSite
310345#endif
311346 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
312347 Just subscribedTicket -> return subscribedTicket
313348 Nothing -> do
349+#ifdef DEBUG_NODEIDS
350+ nodeId <- liftIO newNodeId
351+#endif
314352 subscribers <- liftIO FastWeakBag.empty
315353 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
316357 (parentSub, occ) <- subscribeAndRead e $ Subscriber
317− { subscriberPropagate = \a -> do
318− liftIO $ writeIORef occRef $ Just a
319− scheduleClear occRef
320− propagateFast a subscribers
321− , subscriberInvalidateHeight = \old -> do
322− FastWeakBag.traverse subscribers $ invalidateSubscriberHeight old
323− , subscriberRecalculateHeight = \new -> do
324− FastWeakBag.traverse subscribers $ recalculateSubscriberHeight new
325− }
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+ }
326366 when (isJust occ) $ do
327367 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
328368 scheduleClear occRef
@@ -330,29 +370,45 @@ cacheEvent e =
330370 { _cacheSubscribed_subscribers = subscribers
331371 , _cacheSubscribed_parent = parentSub
332372 , _cacheSubscribed_occurrence = occRef
373+#ifdef DEBUG_NODEIDS
374+ , _cacheSubscribed_nodeId = nodeId
375+#endif
333376 }
334377 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
335378 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
336379 return subscribedTicket
337− liftIO $ do
338− subscribed <- getFastWeakTicketValue subscribedTicket
339− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
340− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
341− let es = EventSubscription
342− { _eventSubscription_unsubscribe = do
343− FastWeakBag.remove ticket
344− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
345− when isEmpty $ do
346− writeIORef mSubscribedRef emptyFastWeak
347− unsubscribe $ _cacheSubscribed_parent subscribed
348− touch ticket
349− touch subscribedTicket
350− , _eventSubscription_subscribed = EventSubscribed
351− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
352− , eventSubscribedRetained = toAny subscribedTicket
353− }
354− }
355− 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+
356412
357413subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
358414subscribe e s = fst <$> subscribeAndRead e s
@@ -364,13 +420,16 @@ wrap tag getSpecificSubscribed sub = do
364420 let es = tag subd
365421 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
366422
367−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
368424eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
369425
426+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
427+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
428+
370429eventNever :: Event x a
371−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
430+eventNever = Event $ const subscribeAndReadNever
372431
373−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)
374433eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
375434
376435eventSwitch :: HasSpiderTimeline x => Switch x a -> Event x a
@@ -405,16 +464,6 @@ data Subscriber x a = Subscriber
405464 , subscriberRecalculateHeight :: !(Height -> IO ())
406465 }
407466
408−--TODO: Move this comment to WeakBag
409−-- These function are constructor functions that are marked NOINLINE so they are
410−-- opaque to GHC. If we do not do this, then GHC will sometimes fuse the constructor away
411−-- so any weak references that are attached to the constructors will have their
412−-- finalizer run. Using the opaque constructor, does not see the
413−-- constructor application, so it behaves like an IORef and cannot be fused away.
414−--
415−-- The result is also evaluated to WHNF, since forcing a thunk invalidates
416−-- the weak pointer to it in some cases.
417−
418467newSubscriberHold :: (HasSpiderTimeline x, Patch p) => Hold x p -> IO (Subscriber x p)
419468newSubscriberHold h = return $ Subscriber
420469 { subscriberPropagate = {-# SCC "traverseHold" #-} propagateSubscriberHold h
@@ -422,85 +471,68 @@ newSubscriberHold h = return $ Subscriber
422471 , subscriberRecalculateHeight = \_ -> return ()
423472 }
424473
425−newSubscriberFan :: forall x k. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k -> IO (Subscriber x (DMap k Identity))
426−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
427476 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
428477 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
429− 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"
430479 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
431480 scheduleClear $ fanSubscribedOccurrence subscribed
432− let f _ (Pair (Identity v) subsubs) = do
481+ let f _ (Pair v subsubs) = do
433482 propagate v $ _fanSubscribedChildren_list subsubs
434483 return $ Constant ()
435484 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
436485 return ()
437486 , subscriberInvalidateHeight = \old -> do
438− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
439487 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
440− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
441− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
488+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
442489 , subscriberRecalculateHeight = \new -> do
443− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
444490 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
445− forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
446− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
491+ forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
447492 }
448493
449494newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
450−newSubscriberSwitch subscribed = return $ Subscriber
495+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
451496 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
452− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
453497 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
454498 scheduleClear $ switchSubscribedOccurrence subscribed
455499 propagate a $ switchSubscribedSubscribers subscribed
456500 , subscriberInvalidateHeight = \_ -> do
457− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
458501 oldHeight <- readIORef $ switchSubscribedHeight subscribed
459502 when (oldHeight /= invalidHeight) $ do
460503 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
461− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
462− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
463− , subscriberRecalculateHeight = \new -> do
464− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
465− updateSwitchHeight new subscribed
466− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
467− }
504+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
505+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
506+ }
468507
469508newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
470−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
509+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
471510 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
472− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
473511 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
474512 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
475513 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
476514 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
477515 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
516+
478517 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
479518 scheduleClear $ coincidenceSubscribedInnerParent subscribed
480519 case occ of
481− Nothing -> do
520+ Nothing ->
482521 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
483522 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
484− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
485− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
523+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
524+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight innerHeight
486525 Just o -> do -- Since it's already firing, no need to adjust height
487526 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
488527 scheduleClear $ coincidenceSubscribedOccurrence subscribed
489528 propagate o $ coincidenceSubscribedSubscribers subscribed
490− , subscriberInvalidateHeight = \_ -> do
491− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
492− invalidateCoincidenceHeight subscribed
493− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
494− , subscriberRecalculateHeight = \_ -> do
495− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
496− recalculateCoincidenceHeight subscribed
497− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
529+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
530+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
498531 }
499532
500533newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
501−newSubscriberCoincidenceInner subscribed = return $ Subscriber
534+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
502535 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
503− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
504536 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
505537 case occ of
506538 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -508,14 +540,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
508540 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
509541 scheduleClear $ coincidenceSubscribedOccurrence subscribed
510542 propagate a $ coincidenceSubscribedSubscribers subscribed
511− , subscriberInvalidateHeight = \_ -> do
512− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
513− invalidateCoincidenceHeight subscribed
514− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
515− , subscriberRecalculateHeight = \_ -> do
516− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
517− recalculateCoincidenceHeight subscribed
518− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
543+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
544+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
519545 }
520546
521547invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -525,18 +551,18 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
525551recalculateSubscriberHeight = flip subscriberRecalculateHeight
526552
527553-- | Propagate everything at the current height
528−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
529−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) $
530556 -- 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
531557 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
532− WeakBag.traverse subscribers $ \s -> subscriberPropagate s a
558+ WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
533559
534560-- | Propagate everything at the current height
535−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
536−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) $
537563 -- 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
538564 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
539− FastWeakBag.traverse subscribers $ \s -> subscriberPropagate s a
565+ FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
540566
541567--------------------------------------------------------------------------------
542568-- EventSubscribed
@@ -545,11 +571,16 @@ propagateFast a subscribers = withIncreasedDepth $ do
545571toAny :: a -> Any
546572toAny = unsafeCoerce
547573
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.
548579data EventSubscribed x = EventSubscribed
549580 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
550581 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
551582#ifdef DEBUG_CYCLES
552− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
583+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
553584 , eventSubscribedHasOwnHeightRef :: !Bool
554585 , eventSubscribedWhoCreated :: !(IO [String])
555586#endif
@@ -576,13 +607,23 @@ eventSubscribedNever = EventSubscribed
576607 , eventSubscribedWhoCreated = return ["never"]
577608#endif
578609 }
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+ }
579620
580−eventSubscribedFan :: FanSubscribed x k -> EventSubscribed x
621+eventSubscribedFan :: FanSubscribed x k v -> EventSubscribed x
581622eventSubscribedFan !subscribed = EventSubscribed
582623 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
583624 , eventSubscribedRetained = toAny subscribed
584625#ifdef DEBUG_CYCLES
585− , eventSubscribedGetParents = return [Some.This $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
626+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
586627 , eventSubscribedHasOwnHeightRef = False
587628 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
588629#endif
@@ -595,7 +636,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
595636#ifdef DEBUG_CYCLES
596637 , eventSubscribedGetParents = do
597638 s <- readIORef $ switchSubscribedCurrentParent subscribed
598− return [Some.This $ _eventSubscription_subscribed s]
639+ return [_eventSubscription_subscribed s]
599640 , eventSubscribedHasOwnHeightRef = True
600641 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
601642#endif
@@ -608,8 +649,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
608649#ifdef DEBUG_CYCLES
609650 , eventSubscribedGetParents = do
610651 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
611− let outerParent = Some.This $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
612− innerParents = maybeToList $ fmap Some.This innerSubscription
652+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
653+ innerParents = maybeToList $ innerSubscription
613654 return $ outerParent : innerParents
614655 , eventSubscribedHasOwnHeightRef = True
615656 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -623,15 +664,15 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
623664whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
624665whoCreatedEventSubscribed = eventSubscribedWhoCreated
625666
626−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
667+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
627668walkInvalidHeightParents s0 = do
628− subscribers <- flip execStateT mempty $ ($ Some.This s0) $ fix $ \loop (Some.This s) -> do
669+ subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
629670 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
630671 when (h == invalidHeight) $ do
631672 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
632− modify (Some.This s :)
673+ modify (s :)
633674 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
634− forM_ subscribers $ \(Some.This s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
675+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
635676 return subscribers
636677#endif
637678
@@ -659,7 +700,7 @@ behaviorPull !p = Behavior $ do
659700 val <- liftIO $ readIORef $ pullValue p
660701 case val of
661702 Just subscribed -> do
662− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
703+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
663704 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (pullSubscribedInvalidators subscribed) (wi:))
664705 liftIO $ touch $ pullSubscribedOwnInvalidator subscribed
665706 return $ pullSubscribedValue subscribed
@@ -668,7 +709,7 @@ behaviorPull !p = Behavior $ do
668709 wi <- liftIO $ mkWeakPtrWithDebug i "InvalidatorPull"
669710 parentsRef <- liftIO $ newIORef []
670711 holdInits <- askBehaviorHoldInits
671− a <- liftIO $ runReaderT (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
712+ a <- liftIO $ runReaderIO (unBehaviorM $ pullCompute p) (Just (wi, parentsRef), holdInits)
672713 invsRef <- liftIO . newIORef . maybeToList =<< askInvalidator
673714 parents <- liftIO $ readIORef parentsRef
674715 let subscribed = PullSubscribed
@@ -678,7 +719,7 @@ behaviorPull !p = Behavior $ do
678719 , pullSubscribedParents = parents
679720 }
680721 liftIO $ writeIORef (pullValue p) $ Just subscribed
681− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedPull subscribed) :))
722+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedPull subscribed)) :))
682723 return a
683724
684725behaviorDyn :: Patch p => Dyn x p -> Behavior x (PatchTarget p)
@@ -689,7 +730,7 @@ readHoldTracked :: Hold x p -> BehaviorM x (PatchTarget p)
689730readHoldTracked h = do
690731 result <- liftIO $ readIORef $ holdValue h
691732 askInvalidator >>= mapM_ (\wi -> liftIO $ modifyIORef' (holdInvalidators h) (wi:))
692− askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (BehaviorSubscribedHold h) :))
733+ askParentsRef >>= mapM_ (\r -> liftIO $ modifyIORef' r (SomeBehaviorSubscribed (Some (BehaviorSubscribedHold h)) :))
693734 liftIO $ touch h -- Otherwise, if this gets inlined enough, the hold's parent reference may get collected
694735 return result
695736
@@ -703,42 +744,46 @@ readBehaviorUntracked b = do
703744-- Dynamic
704745--------------------------------------------------------------------------------
705746
706−data Dynamic x p = Dynamic
707− { dynamicCurrent :: !(Behavior x (PatchTarget p))
708− , 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`?
709752 }
710753
711−dynamicHold :: 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
712760dynamicHold !h = Dynamic
713761 { dynamicCurrent = behaviorHold h
714762 , dynamicUpdated = eventHold h
715763 }
716764
717−dynamicHoldIdentity :: Hold x (Identity a) -> Dynamic x (Identity a)
765+dynamicHoldIdentity :: Hold x (Identity a) -> DynamicS x (Identity a)
718766dynamicHoldIdentity = dynamicHold
719767
720−dynamicConst :: PatchTarget p -> Dynamic x p
768+dynamicConst :: PatchTarget p -> DynamicS x p
721769dynamicConst !a = Dynamic
722770 { dynamicCurrent = behaviorConst a
723771 , dynamicUpdated = eventNever
724772 }
725773
726−dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> Dynamic x p
774+dynamicDyn :: (HasSpiderTimeline x, Patch p) => Dyn x p -> DynamicS x p
727775dynamicDyn !d = Dynamic
728776 { dynamicCurrent = behaviorDyn d
729777 , dynamicUpdated = eventDyn d
730778 }
731779
732−dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> Dynamic x (Identity a)
780+dynamicDynIdentity :: HasSpiderTimeline x => Dyn x (Identity a) -> DynamicS x (Identity a)
733781dynamicDynIdentity = dynamicDyn
734782
735783--------------------------------------------------------------------------------
736784-- Combinators
737785--------------------------------------------------------------------------------
738786
739−--TODO: Figure out why certain things are not 'representational', then make them
740−--representational so we can use coerce
741−
742787--type role Hold representational
743788data Hold x p
744789 = Hold { holdValue :: !(IORef (PatchTarget p))
@@ -759,20 +804,25 @@ globalSpiderTimelineEnv = unsafePerformIO unsafeNewSpiderTimelineEnv
759804
760805-- | Stores all global data relevant to a particular Spider timeline; only one
761806-- value should exist for each type @x@
762−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
763813 { _spiderTimeline_lock :: {-# UNPACK #-} !(MVar ())
764814 , _spiderTimeline_eventEnv :: {-# UNPACK #-} !(EventEnv x)
765815#ifdef DEBUG
766816 , _spiderTimeline_depth :: {-# UNPACK #-} !(IORef Int)
767817#endif
768818 }
769−type role SpiderTimelineEnv nominal
819+type role SpiderTimelineEnv' phantom
770820
771821instance Eq (SpiderTimelineEnv x) where
772822 _ == _ = True -- Since only one exists of each type
773823
774824instance GEq SpiderTimelineEnv where
775− a `geq` b = if _spiderTimeline_lock a == _spiderTimeline_lock b
825+ a `geq` b = if _spiderTimeline_lock (unSTE a) == _spiderTimeline_lock (unSTE b)
776826 then Just $ unsafeCoerce Refl -- This unsafeCoerce is safe because the same SpiderTimelineEnv can't have two different 'x' arguments
777827 else Nothing
778828
@@ -782,9 +832,9 @@ data EventEnv x
782832 , eventEnvDynInits :: !(IORef [SomeDynInit x])
783833 , eventEnvMergeUpdates :: !(IORef [SomeMergeUpdate x])
784834 , eventEnvMergeInits :: !(IORef [SomeMergeInit x]) -- Needed for Subscribe
785− , eventEnvClears :: !(IORef [SomeClear]) -- Needed for Subscribe
786− , eventEnvIntClears :: !(IORef [SomeIntClear])
787− , eventEnvRootClears :: !(IORef [SomeRootClear])
835+ , eventEnvClears :: !(IORef [Some Clear]) -- Needed for Subscribe
836+ , eventEnvIntClears :: !(IORef [Some IntClear])
837+ , eventEnvRootClears :: !(IORef [Some RootClear])
788838 , eventEnvCurrentHeight :: !(IORef Height) -- Needed for Subscribe
789839 , eventEnvResetCoincidences :: !(IORef [SomeResetCoincidence x]) -- Needed for Subscribe
790840 , eventEnvDelayedMerges :: !(IORef (IntMap [EventM x ()]))
@@ -795,7 +845,7 @@ runEventM :: EventM x a -> IO a
795845runEventM = unEventM
796846
797847asksEventEnv :: forall x a. HasSpiderTimeline x => (EventEnv x -> a) -> EventM x a
798−asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
848+asksEventEnv f = return $ f $ _spiderTimeline_eventEnv (unSTE (spiderTimeline :: SpiderTimelineEnv x))
799849
800850class MonadIO m => Defer a m where
801851 getDeferralQueue :: m (IORef [a])
@@ -856,29 +906,29 @@ putCurrentHeight h = do
856906 heightRef <- asksEventEnv eventEnvCurrentHeight
857907 liftIO $ writeIORef heightRef $! h
858908
859−instance HasSpiderTimeline x => Defer SomeClear (EventM x) where
909+instance HasSpiderTimeline x => Defer (Some Clear) (EventM x) where
860910 {-# INLINE getDeferralQueue #-}
861911 getDeferralQueue = asksEventEnv eventEnvClears
862912
863913{-# INLINE scheduleClear #-}
864−scheduleClear :: Defer SomeClear m => IORef (Maybe a) -> m ()
865−scheduleClear r = defer $ SomeClear r
914+scheduleClear :: Defer (Some Clear) m => IORef (Maybe a) -> m ()
915+scheduleClear r = defer $ Some $ Clear r
866916
867−instance HasSpiderTimeline x => Defer SomeIntClear (EventM x) where
917+instance HasSpiderTimeline x => Defer (Some IntClear) (EventM x) where
868918 {-# INLINE getDeferralQueue #-}
869919 getDeferralQueue = asksEventEnv eventEnvIntClears
870920
871921{-# INLINE scheduleIntClear #-}
872−scheduleIntClear :: Defer SomeIntClear m => IORef (IntMap a) -> m ()
873−scheduleIntClear r = defer $ SomeIntClear r
922+scheduleIntClear :: Defer (Some IntClear) m => IORef (IntMap a) -> m ()
923+scheduleIntClear r = defer $ Some $ IntClear r
874924
875−instance HasSpiderTimeline x => Defer SomeRootClear (EventM x) where
925+instance HasSpiderTimeline x => Defer (Some RootClear) (EventM x) where
876926 {-# INLINE getDeferralQueue #-}
877927 getDeferralQueue = asksEventEnv eventEnvRootClears
878928
879929{-# INLINE scheduleRootClear #-}
880−scheduleRootClear :: Defer SomeRootClear m => IORef (DMap k Identity) -> m ()
881−scheduleRootClear r = defer $ SomeRootClear r
930+scheduleRootClear :: Defer (Some RootClear) m => IORef (DMap k Identity) -> m ()
931+scheduleRootClear r = defer $ Some $ RootClear r
882932
883933instance HasSpiderTimeline x => Defer (SomeResetCoincidence x) (EventM x) where
884934 {-# INLINE getDeferralQueue #-}
@@ -933,9 +983,9 @@ getHoldEventSubscription h = do
933983
934984type BehaviorEnv x = (Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]), IORef [SomeHoldInit x])
935985
936−--type role BehaviorM representational
937986-- BehaviorM can sample behaviors
938−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))
939989
940990instance Monad (BehaviorM x) where
941991 {-# INLINE (>>=) #-}
@@ -944,14 +994,16 @@ instance Monad (BehaviorM x) where
944994 BehaviorM x >> BehaviorM y = BehaviorM $ x >> y
945995 {-# INLINE return #-}
946996 return x = BehaviorM $ return x
997+#if !MIN_VERSION_base(4,13,0)
947998 {-# INLINE fail #-}
948999 fail s = BehaviorM $ fail s
1000+#endif
9491001
9501002data BehaviorSubscribed x a
9511003 = forall p. BehaviorSubscribedHold (Hold x p)
9521004 | BehaviorSubscribedPull (PullSubscribed x a)
9531005
954−data SomeBehaviorSubscribed x = forall a. SomeBehaviorSubscribed (BehaviorSubscribed x a)
1006+newtype SomeBehaviorSubscribed x = SomeBehaviorSubscribed (Some (BehaviorSubscribed x))
9551007
9561008--type role PullSubscribed representational
9571009data PullSubscribed x a
@@ -986,7 +1038,7 @@ data RootSubscribed x a = forall k. GCompare k => RootSubscribed
9861038#endif
9871039 }
9881040
989−data Root x (k :: * -> *)
1041+data Root x k
9901042 = Root { rootOccurrence :: !(IORef (DMap k Identity)) -- The currently-firing occurrence of this event
9911043 , rootSubscribed :: !(IORef (DMap k (RootSubscribed x)))
9921044 , rootInit :: !(forall a. k a -> RootTrigger x a -> IO (IO ()))
@@ -1005,7 +1057,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
10051057newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
10061058
10071059-- EventM can do everything BehaviorM can, plus create holds
1008−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)
10091061
10101062newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
10111063
@@ -1030,7 +1082,8 @@ heightBagFromList :: [Height] -> HeightBag
10301082heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
10311083
10321084heightBagAdd :: Height -> HeightBag -> HeightBag
1033−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
10341087
10351088heightBagRemove :: Height -> HeightBag -> HeightBag
10361089heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -1039,6 +1092,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
10391092 0 -> IntMap.delete h c
10401093 _ -> IntMap.insert h (pred old) c
10411094
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+
10421102heightBagMax :: HeightBag -> Height
10431103heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
10441104 Just ((h, _), _) -> Height h
@@ -1056,25 +1116,25 @@ heightBagVerify b@(HeightBag s c) = if
10561116heightBagVerify = id
10571117#endif
10581118
1059−data FanSubscribedChildren (x :: *) k a = FanSubscribedChildren
1060− { _fanSubscribedChildren_list :: !(WeakBag (Subscriber x a))
1061− , _fanSubscribedChildren_self :: {-# NOUNPACK #-} !(k a, FanSubscribed x k)
1062− , _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)))
10631123 }
10641124
1065−data FanSubscribed (x :: *) k
1066− = FanSubscribed { fanSubscribedCachedSubscribed :: !(IORef (Maybe (FanSubscribed x k)))
1067− , fanSubscribedOccurrence :: !(IORef (Maybe (DMap k Identity)))
1068− , 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
10691129 , fanSubscribedParent :: !(EventSubscription x)
10701130#ifdef DEBUG_NODEIDS
10711131 , fanSubscribedNodeId :: Int
10721132#endif
10731133 }
10741134
1075−data Fan x k
1076− = Fan { fanParent :: !(Event x (DMap k Identity))
1077− , 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)))
10781138 }
10791139
10801140data SwitchSubscribed x a
@@ -1128,24 +1188,35 @@ newInvalidatorSwitch subd = return $! InvalidatorSwitch subd
11281188newInvalidatorPull :: Pull x a -> IO (Invalidator x)
11291189newInvalidatorPull p = return $! InvalidatorPull p
11301190
1131−instance HasSpiderTimeline x => FunctorMaybe (Event x) where
1132− fmapMaybe f = push $ return . f
1191+instance HasSpiderTimeline x => Filterable (Event x) where
1192+ mapMaybe f = push $ return . f
11331193
11341194instance HasSpiderTimeline x => Align (Event x) where
11351195 nil = eventNever
1136− 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]
1201+
1202+#ifdef MIN_VERSION_semialign
1203+#if MIN_VERSION_semialign(1,1,0)
1204+instance HasSpiderTimeline x => Zip (Event x) where
1205+#endif
1206+ zip x y = mapMaybe justThese $ align x y
1207+#endif
11371208
11381209data DynType x p = UnsafeDyn !(BehaviorM x (PatchTarget p), Event x p)
11391210 | BuildDyn !(EventM x (PatchTarget p), Event x p)
11401211 | HoldDyn !(Hold x p)
11411212
1142−newtype Dyn x p = Dyn { unDyn :: IORef (DynType x p) }
1213+newtype Dyn (x :: Type) p = Dyn { unDyn :: IORef (DynType x p) }
11431214
1144−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)
11451216newMapDyn f d = dynamicDynIdentity $ unsafeBuildDynamic (fmap f $ readBehaviorTracked $ dynamicCurrent d) (Identity . f . runIdentity <$> dynamicUpdated d)
11461217
11471218--TODO: Avoid the duplication between this and R.zipDynWith
1148−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)
11491220zipDynWith f da db =
11501221 let eab = align (dynamicUpdated da) (dynamicUpdated db)
11511222 ec = flip push eab $ \o -> do
@@ -1168,18 +1239,12 @@ buildDynamic readV0 v' = do
11681239 return d
11691240
11701241unsafeBuildDynamic :: BehaviorM x (PatchTarget p) -> Event x p -> Dyn x p
1171−unsafeBuildDynamic readV0 v' = Dyn $ unsafeNewIORef x $ UnsafeDyn x
1172− where x = (readV0, v')
1242+unsafeBuildDynamic readV0 v' =
1243+ Dyn $ unsafePerformIO $ newIORef $ UnsafeDyn (readV0, v')
11731244
11741245-- ResultM can read behaviors and events
11751246type ResultM = EventM
11761247
1177−{-# NOINLINE unsafeNewIORef #-}
1178−unsafeNewIORef :: a -> b -> IORef b
1179−unsafeNewIORef a b = unsafePerformIO $ do
1180− touch a
1181− newIORef b
1182−
11831248instance HasSpiderTimeline x => Functor (Event x) where
11841249 fmap f = push $ return . Just . f
11851250
@@ -1192,33 +1257,42 @@ push f e = cacheEvent (pushCheap f e)
11921257
11931258{-# INLINABLE pull #-}
11941259pull :: BehaviorM x a -> Behavior x a
1195−pull a = behaviorPull $ Pull
1196− { pullCompute = a
1197− , pullValue = unsafeNewIORef a Nothing
1260+pull a = unsafePerformIO $ do
1261+ ref <- newIORef Nothing
11981262#ifdef DEBUG_NODEIDS
1199− , pullNodeId = unsafeNodeId a
1263+ nid <- newNodeId
12001264#endif
1201− }
1265+ pure $ behaviorPull $ Pull
1266+ { pullCompute = a
1267+ , pullValue = ref
1268+#ifdef DEBUG_NODEIDS
1269+ , pullNodeId = nid
1270+#endif
1271+ }
12021272
12031273{-# INLINABLE switch #-}
12041274switch :: HasSpiderTimeline x => Behavior x (Event x a) -> Event x a
1205−switch a = eventSwitch $ Switch
1206− { switchParent = a
1207− , switchSubscribed = unsafeNewIORef a Nothing
1208− }
1275+switch a = unsafePerformIO $ do
1276+ ref <- newIORef Nothing
1277+ pure $ eventSwitch $ Switch
1278+ { switchParent = a
1279+ , switchSubscribed = ref
1280+ }
12091281
12101282coincidence :: HasSpiderTimeline x => Event x (Event x a) -> Event x a
1211−coincidence a = eventCoincidence $ Coincidence
1212− { coincidenceParent = a
1213− , coincidenceSubscribed = unsafeNewIORef a Nothing
1214− }
1283+coincidence a = unsafePerformIO $ do
1284+ ref <- newIORef Nothing
1285+ pure $ eventCoincidence $ Coincidence
1286+ { coincidenceParent = a
1287+ , coincidenceSubscribed = ref
1288+ }
12151289
12161290-- Propagate the given event occurrence; before cleaning up, run the given action, which may read the state of events and behaviors
12171291run :: forall x b. HasSpiderTimeline x => [DSum (RootTrigger x) Identity] -> ResultM x b -> SpiderHost x b
12181292run roots after = do
12191293 tracePropagate (Proxy :: Proxy x) $ "Running an event frame with " <> show (length roots) <> " events"
12201294 let t = spiderTimeline :: SpiderTimelineEnv x
1221− result <- SpiderHost $ withMVar (_spiderTimeline_lock t) $ \_ -> unSpiderHost $ runFrame $ do
1295+ result <- SpiderHost $ withMVar (_spiderTimeline_lock (unSTE t)) $ \_ -> unSpiderHost $ runFrame $ do
12221296 rootsToPropagate <- forM roots $ \r@(RootTrigger (_, occRef, k) :=> a) -> do
12231297 occBefore <- liftIO $ do
12241298 occBefore <- readIORef occRef
@@ -1256,11 +1330,11 @@ scheduleMerge' initialHeight heightRef a = scheduleMerge initialHeight $ do
12561330 GT -> scheduleMerge' height heightRef a -- The height has been increased (by a coincidence event; TODO: is this the only way?)
12571331 EQ -> a
12581332
1259−data SomeClear = forall a. SomeClear {-# UNPACK #-} !(IORef (Maybe a))
1333+newtype Clear a = Clear (IORef (Maybe a))
12601334
1261−data SomeIntClear = forall a. SomeIntClear {-# UNPACK #-} !(IORef (IntMap a))
1335+newtype IntClear a = IntClear (IORef (IntMap a))
12621336
1263−data SomeRootClear = forall k. SomeRootClear {-# UNPACK #-} !(IORef (DMap k Identity))
1337+newtype RootClear k = RootClear (IORef (DMap k Identity))
12641338
12651339data SomeAssignment x = forall a. SomeAssignment {-# UNPACK #-} !(IORef a) {-# UNPACK #-} !(IORef [Weak (Invalidator x)]) a
12661340
@@ -1272,55 +1346,110 @@ mkWeakPtrWithDebug x debugNote = do
12721346 x' <- evaluate x
12731347 mkWeakPtr x' $
12741348 if debugFinalize
1275− then Just $ putStrLn $ "finalizing: " ++ debugNote
1349+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
12761350 else Nothing
12771351
12781352type WeakList a = [Weak a]
12791353
1280−{-# INLINE withIncreasedDepth #-}
1354+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1355+
1356+
1357+
1358+
12811359#ifdef DEBUG
1282−withIncreasedDepth :: CanTrace x m => m a -> m a
1283−withIncreasedDepth a = do
1284− spiderTimeline <- askSpiderTimelineEnv
1285− 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
12861385 result <- a
1287− liftIO $ modifyIORef' (_spiderTimeline_depth spiderTimeline) pred
1386+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
12881387 return result
1289−#else
1290−withIncreasedDepth :: m a -> m a
1291−withIncreasedDepth = id
1292−#endif
1293−
1294−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
12951388
12961389{-# INLINE tracePropagate #-}
12971390tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1298−tracePropagate p = traceWhen p debugPropagate
1391+tracePropagate p = when debugPropagate . trace p
12991392
13001393{-# INLINE traceInvalidate #-}
13011394traceInvalidate :: String -> IO ()
1302−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
13031400
1304−{-# INLINE traceWhen #-}
1305−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1306−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
13071404
1308−{-# INLINE traceMWhen #-}
1309−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1310−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
13111408 message <- getMessage
1312−#ifdef DEBUG
1313− spiderTimeline <- askSpiderTimelineEnv
1314− d <- liftIO $ readIORef $ _spiderTimeline_depth spiderTimeline
1409+ d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1410+ liftIO $ debugStrLn $ replicate d ' ' <> message
1411+
13151412#else
1316− 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+
13171448#endif
1318− liftIO $ putStrLn $ replicate d ' ' <> message
13191449
13201450whoCreatedIORef :: IORef a -> IO [String]
13211451whoCreatedIORef (IORef a) = whoCreated $! a
13221452
1323−#ifdef DEBUG_CYCLES
13241453groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
13251454groupByHead = \case
13261455 [] -> []
@@ -1331,20 +1460,54 @@ groupByHead = \case
13311460 | otherwise -> (x, xs :| []) : l
13321461
13331462listsToForest :: Eq a => [[a]] -> Forest a
1334−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+
13351495#endif
13361496
1497+
13371498{-# INLINE propagateSubscriberHold #-}
13381499propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
13391500propagateSubscriberHold h a = do
1340− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1501+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
13411502 invalidators <- liftIO $ readIORef $ holdInvalidators h
13421503 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1504+
13431505 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
13441506 case {-# SCC "apply" #-} apply a v of
13451507 Nothing -> return ()
13461508 Just v' -> do
1347− {-# 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)
13481511 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
13491512 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
13501513 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1352,25 +1515,25 @@ propagateSubscriberHold h a = do
13521515data SomeResetCoincidence x = forall a. SomeResetCoincidence !(EventSubscription x) !(Maybe (CoincidenceSubscribed x a)) -- The CoincidenceSubscriber will be present only if heights need to be reset
13531516
13541517runBehaviorM :: BehaviorM x a -> Maybe (Weak (Invalidator x), IORef [SomeBehaviorSubscribed x]) -> IORef [SomeHoldInit x] -> IO a
1355−runBehaviorM a mwi holdInits = runReaderT (unBehaviorM a) (mwi, holdInits)
1518+runBehaviorM a mwi holdInits = runReaderIO (unBehaviorM a) (mwi, holdInits)
13561519
13571520askInvalidator :: BehaviorM x (Maybe (Weak (Invalidator x)))
13581521askInvalidator = do
1359− (!m, _) <- BehaviorM ask
1522+ (!m, _) <- ask
13601523 case m of
13611524 Nothing -> return Nothing
13621525 Just (!wi, _) -> return $ Just wi
13631526
13641527askParentsRef :: BehaviorM x (Maybe (IORef [SomeBehaviorSubscribed x]))
13651528askParentsRef = do
1366− (!m, _) <- BehaviorM ask
1529+ (!m, _) <- ask
13671530 case m of
13681531 Nothing -> return Nothing
13691532 Just (_, !p) -> return $ Just p
13701533
13711534askBehaviorHoldInits :: BehaviorM x (IORef [SomeHoldInit x])
13721535askBehaviorHoldInits = do
1373− (_, !his) <- BehaviorM ask
1536+ (_, !his) <- ask
13741537 return his
13751538
13761539{-# INLINE getDynHold #-}
@@ -1398,7 +1561,7 @@ getDynHold d = do
13981561zeroRef :: IORef Height
13991562zeroRef = unsafePerformIO $ newIORef zeroHeight
14001563
1401−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)
14021565getRootSubscribed k r sub = do
14031566 mSubscribed <- readIORef $ rootSubscribed r
14041567 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1412,9 +1575,14 @@ getRootSubscribed k r sub = do
14121575 let !cached = rootSubscribed r
14131576 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
14141577 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1415− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1578+
1579+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1580+
14161581 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
14171582 writeIORef uninitRef $! uninit
1583+#ifdef DEBUG_NODEIDS
1584+ nid <- newNodeId
1585+#endif
14181586 let !subscribed = RootSubscribed
14191587 { rootSubscribedKey = k
14201588 , rootSubscribedCachedSubscribed = cached
@@ -1423,7 +1591,7 @@ getRootSubscribed k r sub = do
14231591 , rootSubscribedUninit = uninit
14241592 , rootSubscribedWeakSelf = weakSelf
14251593#ifdef DEBUG_NODEIDS
1426− , rootSubscribedNodeId = unsafeNodeId (k, r, subs)
1594+ , rootSubscribedNodeId = nid
14271595#endif
14281596 }
14291597 -- If we die at the same moment that all our children die, they will
@@ -1459,6 +1627,9 @@ data FanInt x a = FanInt
14591627 { _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
14601628 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
14611629 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1630+#ifdef DEBUG_NODEIDS
1631+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1632+#endif
14621633 }
14631634
14641635newFanInt :: IO (FanInt x a)
@@ -1466,38 +1637,39 @@ newFanInt = do
14661637 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
14671638 subscriptionRef <- newIORef $ error "fanInt: no subscription"
14681639 occRef <- newIORef $ error "fanInt: no occurrence"
1640+#ifdef DEBUG_NODEIDS
1641+ nodeId <- newNodeId
1642+#endif
14691643 return $ FanInt
14701644 { _fanInt_subscribers = subscribers
14711645 , _fanInt_subscriptionRef = subscriptionRef
14721646 , _fanInt_occRef = occRef
1647+#ifdef DEBUG_NODEIDS
1648+ , _fanInt_nodeId = nodeId
1649+#endif
14731650 }
14741651
1475−{-# NOINLINE unsafeNewFanInt #-}
1476−unsafeNewFanInt :: b -> FanInt x a
1477−unsafeNewFanInt b = unsafePerformIO $ do
1478− touch b
1479− newFanInt
1480−
14811652fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
1482−fanInt p =
1483− let self = unsafeNewFanInt p
1484− in EventSelectorInt $ \k -> Event $ \sub -> do
1653+fanInt p = unsafePerformIO $ do
1654+ self <- newFanInt
1655+ pure $ EventSelectorInt $ \k -> Event $ \sub -> do
14851656 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
14861657 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1487− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1658+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1659+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
14881660 { subscriberPropagate = \m -> do
14891661 liftIO $ writeIORef (_fanInt_occRef self) m
14901662 scheduleIntClear $ _fanInt_occRef self
1491− FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> do --TODO: Do we need to know that no subscribers are being added as we traverse?
1492− 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 ->
14931665 subscriberPropagate s v
1494− , subscriberInvalidateHeight = \old -> do
1495− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1496− FastWeakBag.traverse b $ \s -> do
1666+ , subscriberInvalidateHeight = \old ->
1667+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1668+ FastWeakBag.traverse_ b $ \s ->
14971669 subscriberInvalidateHeight s old
1498− , subscriberRecalculateHeight = \new -> do
1499− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1500− FastWeakBag.traverse b $ \s -> do
1670+ , subscriberRecalculateHeight = \new ->
1671+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1672+ FastWeakBag.traverse_ b $ \s ->
15011673 subscriberRecalculateHeight s new
15021674 }
15031675 liftIO $ do
@@ -1511,13 +1683,28 @@ fanInt p =
15111683 FastMutableIntMap.insert (_fanInt_subscribers self) k b
15121684 return b
15131685 Just b -> return b
1514− t <- liftIO $ FastWeakBag.insert sub b
1686+ ticket <- liftIO $ FastWeakBag.insert sub b
15151687 currentOcc <- readIORef (_fanInt_occRef self)
1516− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1517− 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+
15181705
15191706{-# INLINABLE getFanSubscribed #-}
1520−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))
15211708getFanSubscribed k f sub = do
15221709 mSubscribed <- liftIO $ readIORef $ fanSubscribed f
15231710 case mSubscribed of
@@ -1535,13 +1722,16 @@ getFanSubscribed k f sub = do
15351722 subscribersRef <- liftIO $ newIORef $ error "getFanSubscribed: subscribersRef not yet initialized"
15361723 occRef <- liftIO $ newIORef parentOcc
15371724 when (isJust parentOcc) $ scheduleClear occRef
1725+#ifdef DEBUG_NODEIDS
1726+ nid <- liftIO newNodeId
1727+#endif
15381728 let subscribed = FanSubscribed
15391729 { fanSubscribedCachedSubscribed = fanSubscribed f
15401730 , fanSubscribedOccurrence = occRef
15411731 , fanSubscribedParent = subscription
15421732 , fanSubscribedSubscribers = subscribersRef
15431733#ifdef DEBUG_NODEIDS
1544− , fanSubscribedNodeId = unsafeNodeId f
1734+ , fanSubscribedNodeId = nid
15451735#endif
15461736 }
15471737 let !self = (k, subscribed)
@@ -1551,7 +1741,7 @@ getFanSubscribed k f sub = do
15511741 liftIO $ writeIORef (fanSubscribed f) $ Just subscribed
15521742 return (slnForSub, subscribed, coerce $ DMap.lookup k =<< parentOcc)
15531743
1554−cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k) -> IO ()
1744+cleanupFanSubscribed :: GCompare k => (k a, FanSubscribed x k v) -> IO ()
15551745cleanupFanSubscribed (k, subscribed) = do
15561746 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15571747 let reducedSubscribers = DMap.delete k subscribers
@@ -1563,7 +1753,7 @@ cleanupFanSubscribed (k, subscribed) = do
15631753 else writeIORef (fanSubscribedSubscribers subscribed) $! reducedSubscribers
15641754
15651755{-# INLINE subscribeFanSubscribed #-}
1566−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
15671757subscribeFanSubscribed k subscribed sub = do
15681758 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
15691759 case DMap.lookup k subscribers of
@@ -1601,6 +1791,9 @@ getSwitchSubscribed s sub = do
16011791 when (isJust parentOcc) $ scheduleClear occRef
16021792 weakSelf <- liftIO $ newIORef $ error "getSwitchSubscribed: weakSelf not yet initialized"
16031793 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupSwitchSubscribed
1794+#ifdef DEBUG_NODEIDS
1795+ nid <- liftIO newNodeId
1796+#endif
16041797 let !subscribed = SwitchSubscribed
16051798 { switchSubscribedCachedSubscribed = switchSubscribed s
16061799 , switchSubscribedOccurrence = occRef
@@ -1613,7 +1806,7 @@ getSwitchSubscribed s sub = do
16131806 , switchSubscribedCurrentParent = subscriptionRef
16141807 , switchSubscribedWeakSelf = weakSelf
16151808#ifdef DEBUG_NODEIDS
1616− , switchSubscribedNodeId = unsafeNodeId s
1809+ , switchSubscribedNodeId = nid
16171810#endif
16181811 }
16191812 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "switchSubscribedWeakSelf"
@@ -1658,6 +1851,9 @@ getCoincidenceSubscribed c sub = do
16581851 scheduleClear innerSubdRef
16591852 weakSelf <- liftIO $ newIORef $ error "getCoincidenceSubscribed: weakSelf not yet implemented"
16601853 (subs, slnForSub) <- liftIO $ WeakBag.singleton sub weakSelf cleanupCoincidenceSubscribed
1854+#ifdef DEBUG_NODEIDS
1855+ nid <- liftIO newNodeId
1856+#endif
16611857 let subscribed = CoincidenceSubscribed
16621858 { coincidenceSubscribedCachedSubscribed = coincidenceSubscribed c
16631859 , coincidenceSubscribedOccurrence = occRef
@@ -1668,7 +1864,7 @@ getCoincidenceSubscribed c sub = do
16681864 , coincidenceSubscribedInnerParent = innerSubdRef
16691865 , coincidenceSubscribedWeakSelf = weakSelf
16701866#ifdef DEBUG_NODEIDS
1671− , coincidenceSubscribedNodeId = unsafeNodeId c
1867+ , coincidenceSubscribedNodeId = nid
16721868#endif
16731869 }
16741870 liftIO $ writeIORef weakSelf =<< evaluate =<< mkWeakPtrWithDebug subscribed "CoincidenceSubscribed"
@@ -1685,57 +1881,72 @@ cleanupCoincidenceSubscribed subscribed = do
16851881subscribeCoincidenceSubscribed :: CoincidenceSubscribed x a -> Subscriber x a -> IO WeakBagTicket
16861882subscribeCoincidenceSubscribed subscribed sub = WeakBag.insert sub (coincidenceSubscribedSubscribers subscribed) (coincidenceSubscribedWeakSelf subscribed) cleanupCoincidenceSubscribed
16871883
1688−{-# INLINE merge #-}
1689−merge :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1690−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)
16911889
16921890{-# INLINE mergeWithMove #-}
1693−mergeWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1694−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)
16951895
16961896{-# INLINE [1] mergeCheap #-}
1697−mergeCheap :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMap k (Event x)) -> Event x (DMap k Identity)
1698−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
16991903 where
1700− updateMe :: MergeUpdateFunc k x (PatchDMap k (Event x)) (MergeSubscribedParent x)
1904+ updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
17011905 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
17021906 let f (subscriptionsToKill, ps) (k :=> ComposeMaybe me) = do
17031907 (mOldSubd, newPs) <- case me of
17041908 Nothing -> return $ DMap.updateLookupWithKey (\_ _ -> Nothing) k ps
17051909 Just e -> do
17061910 let s = subscriber $ return k
1707− subscription@(EventSubscription _ subd) <- subscribe e s
1911+ subscription@(EventSubscription _ subd) <- subscribe (nt e) s
17081912 newParentHeight <- liftIO $ getEventSubscribedHeight subd
17091913 let newParent = MergeSubscribedParent subscription
17101914 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17111915 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
17121916 forM_ mOldSubd $ \oldSubd -> do
1713− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1917+ oldHeight <- liftIO $ getEventSubscribedHeight $
1918+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1919+
17141920 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17151921 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
17161922 foldM f ([], oldParents) $ DMap.toList p
1717− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParent x)
1923+
1924+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParent x)
17181925 getInitialSubscribers initialParents subscriber = do
17191926 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17201927 let s = subscriber $ return k
1721− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1928+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17221929 height <- liftIO $ getEventSubscribedHeight parentSubd
1723− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParent subscription)
1930+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParent subscription)
17241931 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17251932 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17261933 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17271934 )
1935+
17281936 destroy :: MergeDestroyFunc k (MergeSubscribedParent x)
17291937 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParent sub) -> unsubscribe sub
17301938
17311939{-# INLINE [1] mergeCheapWithMove #-}
1732−mergeCheapWithMove :: forall k x. (HasSpiderTimeline x, GCompare k) => Dynamic x (PatchDMapWithMove k (Event x)) -> Event x (DMap k Identity)
1733−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
17341945 where
1735− updateMe :: MergeUpdateFunc k x (PatchDMapWithMove k (Event x)) (MergeSubscribedParentWithMove x k)
1946+ updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
17361947 updateMe subscriber heightBagRef oldParents p = do
17371948 -- Prepare new parents for insertion
1738− 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)
17391950 subscribeParent k e = do
17401951 keyRef <- liftIO $ newIORef k
17411952 let s = subscriber $ liftIO $ readIORef keyRef
@@ -1744,73 +1955,82 @@ mergeCheapWithMove = mergeCheap' getInitialSubscribers updateMe destroy
17441955 newParentHeight <- getEventSubscribedHeight subd
17451956 modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17461957 return $ MergeSubscribedParentWithMove subscription keyRef
1747− p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey subscribeParent p
1958+ p' <- PatchDMapWithMove.traversePatchDMapWithMoveWithKey (\k q -> subscribeParent k (nt q)) p
17481959 -- Collect old parents for deletion and update the keys of moved parents
1749− 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
17501961 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
17511962 Nothing -> do
1752− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1963+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1964+ _mergeSubscribedParentWithMove_subscription parent
1965+
17531966 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17541967 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
17551968 Just toKey -> do
17561969 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
17571970 return Nothing
1758− 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+
17591974 return (toDelete, applyAlways p' oldParents)
1760− getInitialSubscribers :: MergeInitFunc k x (MergeSubscribedParentWithMove x k)
1975+ getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
17611976 getInitialSubscribers initialParents subscriber = do
17621977 subscribers <- forM (DMap.toList initialParents) $ \(k :=> e) -> do
17631978 keyRef <- liftIO $ newIORef k
17641979 let s = subscriber $ liftIO $ readIORef keyRef
1765− (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead e s
1980+ (subscription@(EventSubscription _ parentSubd), parentOcc) <- subscribeAndRead (nt e) s
17661981 height <- liftIO $ getEventSubscribedHeight parentSubd
1767− return (fmap (\x -> k :=> Identity x) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
1982+ return (fmap (k :=>) parentOcc, height, k :=> MergeSubscribedParentWithMove subscription keyRef)
17681983 return ( DMap.fromDistinctAscList $ mapMaybe (\(x, _, _) -> x) subscribers
17691984 , fmap (\(_, h, _) -> h) subscribers --TODO: Assert that there's no invalidHeight in here
17701985 , DMap.fromDistinctAscList $ map (\(_, _, x) -> x) subscribers
17711986 )
1987+
17721988 destroy :: MergeDestroyFunc k (MergeSubscribedParentWithMove x k)
17731989 destroy s = forM_ (DMap.toList s) $ \(_ :=> MergeSubscribedParentWithMove sub _) -> unsubscribe sub
17741990
1775−type MergeUpdateFunc k x p s
1776− = (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))
17771993 -> IORef HeightBag
17781994 -> DMap k s
17791995 -> p
17801996 -> EventM x ([EventSubscription x], DMap k s)
17811997
1782−type MergeInitFunc k x s
1783− = DMap k (Event x)
1784− -> (forall a. EventM x (k a) -> Subscriber x a)
1785− -> 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)
17862004
17872005type MergeDestroyFunc k s
17882006 = DMap k s
17892007 -> IO ()
17902008
1791−data Merge x k s = Merge
2009+data Merge x k v s = Merge
17922010 { _merge_parentsRef :: {-# UNPACK #-} !(IORef (DMap k s))
17932011 , _merge_heightBagRef :: {-# UNPACK #-} !(IORef HeightBag)
17942012 , _merge_heightRef :: {-# UNPACK #-} !(IORef Height)
1795− , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k Identity))
1796− , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k Identity))
2013+ , _merge_sub :: {-# UNPACK #-} !(Subscriber x (DMap k v))
2014+ , _merge_accumRef :: {-# UNPACK #-} !(IORef (DMap k v))
17972015 }
17982016
1799−invalidateMergeHeight :: Merge x k s -> IO ()
2017+invalidateMergeHeight :: Merge x k v s -> IO ()
18002018invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_sub m)
18012019
18022020invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
18032021invalidateMergeHeight' heightRef sub = do
18042022 oldHeight <- readIORef heightRef
1805− 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
18062025 writeIORef heightRef $! invalidHeight
18072026 subscriberInvalidateHeight sub oldHeight
18082027
1809−
1810−revalidateMergeHeight :: Merge x k s -> IO ()
2028+revalidateMergeHeight :: Merge x k v s -> IO ()
18112029revalidateMergeHeight m = do
18122030 currentHeight <- readIORef $ _merge_heightRef m
1813− 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
18142034 heights <- readIORef $ _merge_heightBagRef m
18152035 parents <- readIORef $ _merge_parentsRef m
18162036 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
@@ -1818,44 +2038,53 @@ revalidateMergeHeight m = do
18182038 LT -> return ()
18192039 EQ -> do
18202040 let height = succHeight $ heightBagMax heights
1821− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2041+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
18222042 writeIORef (_merge_heightRef m) $! height
18232043 subscriberRecalculateHeight (_merge_sub m) height
18242044 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
18252045
1826−scheduleMergeSelf :: HasSpiderTimeline x => Merge x k s -> Height -> EventM x ()
2046+scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
18272047scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
18282048 vals <- liftIO $ readIORef $ _merge_accumRef m
1829− 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
18302052 --TODO: Assert that m is not empty
18312053 subscriberPropagate (_merge_sub m) vals
18322054
1833−mergeSubscriber :: forall x k s a. (HasSpiderTimeline x, GCompare k) => Merge x k s -> EventM x (k a) -> Subscriber x a
1834−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
18352078 { subscriberPropagate = \a -> do
18362079 oldM <- liftIO $ readIORef $ _merge_accumRef m
18372080 k <- getKey
1838− 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
18392082 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
18402083 liftIO $ writeIORef (_merge_accumRef m) $! newM
18412084 when (DMap.null oldM) $ do -- Only schedule the firing once
18422085 height <- liftIO $ readIORef $ _merge_heightRef m
1843− --TODO: assertions about height
1844− currentHeight <- getCurrentHeight
1845− when (height <= currentHeight) $ do
1846− if height /= invalidHeight
1847− then do
1848− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1849− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1850− else liftIO $ do
1851−#ifdef DEBUG_CYCLES
1852− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
1853− stacks <- forM nodesInvolvedInCycle $ \(Some.This es) -> whoCreatedEventSubscribed es
1854− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
1855−#else
1856− let cycleInfo = ""
1857−#endif
1858− error $ "Causality loop found" <> cycleInfo
2086+ checkCycle subscribed
2087+
18592088 scheduleMergeSelf m height
18602089 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
18612090 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
@@ -1866,30 +2095,45 @@ mergeSubscriber m getKey = Subscriber
18662095 }
18672096
18682097--TODO: Be able to run as much of this as possible promptly
1869−updateMerge :: (HasSpiderTimeline x, GCompare k) => Merge x k s -> MergeUpdateFunc k x p s -> p -> SomeMergeUpdate x
1870−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)
18712100 where updateMe = do
18722101 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
1873− (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber m) (_merge_heightBagRef m) oldParents p
2102+ (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
18742103 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
18752104 return subscriptionsToKill
18762105
1877−{-# INLINE mergeCheap' #-}
1878−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)
1879−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
18802110 initialParents <- readBehaviorUntracked $ dynamicCurrent d
18812111 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
18822112 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
18832113 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
18842114 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1885− 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
18862130 { _merge_parentsRef = parentsRef
18872131 , _merge_heightBagRef = heightBagRef
18882132 , _merge_heightRef = heightRef
18892133 , _merge_sub = sub
18902134 , _merge_accumRef = accumRef
18912135 }
1892− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
2136+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
18932137 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
18942138 myHeight = if invalidHeight `elem` heights
18952139 then invalidHeight
@@ -1898,50 +2142,57 @@ mergeCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
18982142 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
18992143 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
19002144 else (Nothing, dm)
1901− unless (DMap.null accum) $ do
1902− scheduleMergeSelf m myHeight
2145+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
19032146 liftIO $ writeIORef accumRef $! accum
19042147 liftIO $ writeIORef heightRef $! myHeight
19052148 liftIO $ writeIORef heightBagRef $! myHeightBag
1906− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
19072149 liftIO $ writeIORef parentsRef $! initialParentState
19082150 defer $ SomeMergeInit $ do
1909− let s = Subscriber
2151+ let changeSubscriber = Subscriber
19102152 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1911− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
1912− defer $ updateMerge m updateFunc a
2153+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
2154+ defer $ updateMerge subscribed m updateFunc a
19132155 , subscriberInvalidateHeight = \_ -> return ()
19142156 , subscriberRecalculateHeight = \_ -> return ()
19152157 }
1916− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
1917− 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
19182160 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
19192161 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
19202162 -- its subscription.
1921− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2163+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
19222164 let unsubscribeAll = destroy =<< readIORef parentsRef
1923− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1924− , occ
1925− )
19262165
1927−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)
19282170mergeInt = cacheEvent . mergeIntCheap
19292171
19302172{-# INLINABLE mergeIntCheap #-}
1931−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)
19322174mergeIntCheap d = Event $ \sub -> do
19332175 initialParents <- readBehaviorUntracked $ dynamicCurrent d
19342176 accum <- liftIO $ FastMutableIntMap.newEmpty
19352177 heightRef <- liftIO $ newIORef zeroHeight
19362178 heightBagRef <- liftIO $ newIORef heightBagEmpty
19372179 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+ }
19382190 let scheduleSelf = do
19392191 height <- liftIO $ readIORef $ heightRef
19402192 scheduleMerge' height heightRef $ do
19412193 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
19422194 subscriberPropagate sub vals
1943− invalidateMyHeight = do
1944− invalidateMergeHeight' heightRef sub
2195+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
19452196 recalculateMyHeight = do
19462197 currentHeight <- readIORef heightRef
19472198 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?
@@ -1951,12 +2202,14 @@ mergeIntCheap d = Event $ \sub -> do
19512202 LT -> return ()
19522203 EQ -> do
19532204 let height = succHeight $ heightBagMax heights
1954− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2205+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
19552206 writeIORef heightRef $! height
19562207 subscriberRecalculateHeight sub height
19572208 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
19582209 mySubscriber k = Subscriber
19592210 { subscriberPropagate = \a -> do
2211+ checkCycle subscribed
2212+
19602213 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
19612214 liftIO $ FastMutableIntMap.insert accum k a
19622215 when wasEmpty scheduleSelf
@@ -1990,7 +2243,6 @@ mergeIntCheap d = Event $ \sub -> do
19902243 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
19912244 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
19922245 return Nothing
1993− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
19942246 defer $ SomeMergeInit $ do
19952247 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
19962248 where
@@ -2004,35 +2256,39 @@ mergeIntCheap d = Event $ \sub -> do
20042256 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
20052257 liftIO $ for_ oldParents $ \oldParent -> do
20062258 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2259+
2260+ print ("updateMe", oldParentHeight)
20072261 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
20082262 return $ IntMap.elems oldParents
2009− let s = Subscriber
2263+ let changeSubscriber = Subscriber
20102264 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
20112265 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
20122266 defer $ updateMe a
20132267 , subscriberInvalidateHeight = \_ -> return ()
20142268 , subscriberRecalculateHeight = \_ -> return ()
20152269 }
2016− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2270+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
20172271 forM_ change $ \c -> defer $ updateMe c
20182272 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
20192273 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
20202274 -- its subscription.
2021− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2275+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
20222276 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2023− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2024− , occ
2025− )
2277+
2278+
2279+ return (EventSubscription unsubscribeAll subscribed, occ)
20262280
20272281newtype 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) }
20282283
2029−fan :: (HasSpiderTimeline x, GCompare k) => Event x (DMap k Identity) -> EventSelector x k
2030−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
20312287 let f = Fan
20322288 { fanParent = e
2033− , fanSubscribed = unsafeNewIORef e Nothing
2289+ , fanSubscribed = ref
20342290 }
2035− in EventSelector $ \k -> eventFan k f
2291+ pure $ EventSelectorG $ \k -> eventFan k f
20362292
20372293runHoldInits :: HasSpiderTimeline x => IORef [SomeHoldInit x] -> IORef [SomeDynInit x] -> IORef [SomeMergeInit x] -> EventM x ()
20382294runHoldInits holdInitRef dynInitRef mergeInitRef = do
@@ -2086,36 +2342,36 @@ clearEventEnv (EventEnv toAssignRef holdInitRef dynInitRef mergeUpdateRef mergeI
20862342-- | Run an event action outside of a frame
20872343runFrame :: forall x a. HasSpiderTimeline x => EventM x a -> SpiderHost x a --TODO: This function also needs to hold the mutex
20882344runFrame a = SpiderHost $ do
2089− let env = _spiderTimeline_eventEnv (spiderTimeline :: SpiderTimelineEnv x)
2345+ let env = _spiderTimeline_eventEnv $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
20902346 let go = do
20912347 result <- a
20922348 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
20932349 return result
20942350 result <- runEventM go
20952351 toClear <- readIORef $ eventEnvClears env
2096− forM_ toClear $ \(SomeClear ref) -> {-# SCC "clear" #-} writeIORef ref Nothing
2352+ forM_ toClear $ \(Some (Clear ref)) -> {-# SCC "clear" #-} writeIORef ref Nothing
20972353 toClearInt <- readIORef $ eventEnvIntClears env
2098− forM_ toClearInt $ \(SomeIntClear ref) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
2354+ forM_ toClearInt $ \(Some (IntClear ref)) -> {-# SCC "intClear" #-} writeIORef ref $! IntMap.empty
20992355 toClearRoot <- readIORef $ eventEnvRootClears env
2100− forM_ toClearRoot $ \(SomeRootClear ref) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
2356+ forM_ toClearRoot $ \(Some (RootClear ref)) -> {-# SCC "rootClear" #-} writeIORef ref $! DMap.empty
21012357 toAssign <- readIORef $ eventEnvAssignments env
21022358 toReconnectRef <- newIORef []
21032359 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
21042360 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
21052361 writeIORef vRef v
2106− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2362+ traceInvalidate $ "Invalidating Hold"
21072363 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
21082364 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
21092365 writeIORef (eventEnvMergeUpdates env) []
2110− when debugPropagate $ putStrLn "Updating merges"
2366+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
21112367 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2112− when debugPropagate $ putStrLn "Updating merges done"
2368+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
21132369 toReconnect <- readIORef toReconnectRef
21142370 clearEventEnv env
21152371 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
21162372 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
21172373 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2118− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2374+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
21192375 finalize wi
21202376 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
21212377 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -2129,7 +2385,7 @@ runFrame a = SpiderHost $ do
21292385 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
21302386 {-
21312387 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2132− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2388+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
21332389 EventRoot _ -> "EventRoot"
21342390 EventNever -> "EventNever"
21352391 _ -> "something else"
@@ -2144,7 +2400,7 @@ runFrame a = SpiderHost $ do
21442400 myHeight <- readIORef $ switchSubscribedHeight subscribed
21452401 when (parentHeight /= myHeight) $ do
21462402 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
2147− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
2403+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight myHeight
21482404 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
21492405 forM_ coincidenceInfos $ \(SomeResetCoincidence subscription mcs) -> do
21502406 unsubscribe subscription
@@ -2185,7 +2441,7 @@ invalidateCoincidenceHeight subscribed = do
21852441 oldHeight <- readIORef $ coincidenceSubscribedHeight subscribed
21862442 when (oldHeight /= invalidHeight) $ do
21872443 writeIORef (coincidenceSubscribedHeight subscribed) $! invalidHeight
2188− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
2444+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
21892445
21902446updateSwitchHeight :: Height -> SwitchSubscribed x a -> IO ()
21912447updateSwitchHeight new subscribed = do
@@ -2193,7 +2449,7 @@ updateSwitchHeight new subscribed = do
21932449 when (oldHeight == invalidHeight) $ do --TODO: This 'when' should probably be an assertion
21942450 when (new /= invalidHeight) $ do --TODO: This 'when' should probably be an assertion
21952451 writeIORef (switchSubscribedHeight subscribed) $! new
2196− WeakBag.traverse (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
2452+ WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ recalculateSubscriberHeight new
21972453
21982454recalculateCoincidenceHeight :: CoincidenceSubscribed x a -> IO ()
21992455recalculateCoincidenceHeight subscribed = do
@@ -2202,7 +2458,7 @@ recalculateCoincidenceHeight subscribed = do
22022458 height <- calculateCoincidenceHeight subscribed
22032459 when (height /= invalidHeight) $ do
22042460 writeIORef (coincidenceSubscribedHeight subscribed) $! height
2205− WeakBag.traverse (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
2461+ WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ recalculateSubscriberHeight height
22062462
22072463calculateSwitchHeight :: SwitchSubscribed x a -> IO Height
22082464calculateSwitchHeight subscribed = getEventSubscribedHeight . _eventSubscription_subscribed =<< readIORef (switchSubscribedCurrentParent subscribed)
@@ -2264,6 +2520,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Event
22642520 {-# INLINABLE headE #-}
22652521 headE = R.slowHeadE
22662522-- headE (SpiderEvent e) = SpiderEvent <$> Reflex.Spider.Internal.headE e
2523+ {-# INLINABLE now #-}
2524+ now = nowSpiderEventM
22672525
22682526instance Reflex.Class.MonadSample (SpiderTimeline x) (SpiderPullM x) where
22692527 {-# INLINABLE sample #-}
@@ -2285,6 +2543,9 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
22852543 {-# INLINABLE headE #-}
22862544 headE = R.slowHeadE
22872545-- headE (SpiderEvent e) = SpiderPushM $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2546+ {-# INLINABLE now #-}
2547+ now = SpiderPushM nowSpiderEventM
2548+
22882549
22892550instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x)) where
22902551 {-# INLINE return #-}
@@ -2293,11 +2554,13 @@ instance HasSpiderTimeline x => Monad (Reflex.Class.Dynamic (SpiderTimeline x))
22932554 x >>= f = SpiderDynamic $ dynamicDynIdentity $ newJoinDyn $ newMapDyn (unSpiderDynamic . f) $ unSpiderDynamic x
22942555 {-# INLINE (>>) #-}
22952556 (>>) = (*>)
2557+#if !MIN_VERSION_base(4,13,0)
22962558 {-# INLINE fail #-}
22972559 fail _ = error "Dynamic does not support 'fail'"
2560+#endif
22982561
22992562{-# INLINABLE newJoinDyn #-}
2300−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)
23012564newJoinDyn d =
23022565 let readV0 = readBehaviorTracked . dynamicCurrent =<< readBehaviorTracked (dynamicCurrent d)
23032566 eOuter = Reflex.Spider.Internal.push (fmap (Just . Identity) . readBehaviorUntracked . dynamicCurrent . runIdentity) $ dynamicUpdated d
@@ -2346,6 +2609,9 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
23462609 buildDynamic getV0 e = runFrame . runSpiderHostFrame $ Reflex.Class.buildDynamic getV0 e
23472610 {-# INLINABLE headE #-}
23482611 headE e = runFrame . runSpiderHostFrame $ Reflex.Class.headE e
2612+ {-# INLINABLE now #-}
2613+ now = runFrame . runSpiderHostFrame $ Reflex.Class.now
2614+
23492615
23502616instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHostFrame x) where
23512617 sample = SpiderHostFrame . readBehaviorUntracked . unSpiderBehavior --TODO: This can cause problems with laziness, so we should get rid of it if we can
@@ -2362,6 +2628,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Spide
23622628 {-# INLINABLE headE #-}
23632629 headE = R.slowHeadE
23642630-- headE (SpiderEvent e) = SpiderHostFrame $ SpiderEvent <$> Reflex.Spider.Internal.headE e
2631+ {-# INLINABLE now #-}
2632+ now = SpiderHostFrame Reflex.Class.now
23652633
23662634instance HasSpiderTimeline x => Reflex.Class.MonadSample (SpiderTimeline x) (SpiderHost x) where
23672635 {-# INLINABLE sample #-}
@@ -2382,6 +2650,8 @@ instance HasSpiderTimeline x => Reflex.Class.MonadHold (SpiderTimeline x) (Refle
23822650 buildDynamic getV0 e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.buildDynamic getV0 e
23832651 {-# INLINABLE headE #-}
23842652 headE e = Reflex.Spider.Internal.ReadPhase $ Reflex.Class.headE e
2653+ {-# INLINABLE now #-}
2654+ now = Reflex.Spider.Internal.ReadPhase Reflex.Class.now
23852655
23862656--------------------------------------------------------------------------------
23872657-- Deprecated items
@@ -2419,13 +2689,13 @@ instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline
24192689 touch h
24202690 return result
24212691
2422−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2692+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
24232693 newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
24242694 newFanEventWithTrigger f = SpiderHost $ do
24252695 es <- newFanEventWithTriggerIO f
24262696 return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
24272697
2428−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2698+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
24292699 newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
24302700 newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
24312701 es <- newFanEventWithTriggerIO f
@@ -2447,7 +2717,7 @@ unsafeNewSpiderTimelineEnv = do
24472717#ifdef DEBUG
24482718 depthRef <- newIORef 0
24492719#endif
2450− return $ SpiderTimelineEnv
2720+ return $ STE $ SpiderTimelineEnv
24512721 { _spiderTimeline_lock = lock
24522722 , _spiderTimeline_eventEnv = env
24532723#ifdef DEBUG
@@ -2457,19 +2727,19 @@ unsafeNewSpiderTimelineEnv = do
24572727
24582728-- | Create a new SpiderTimelineEnv
24592729newSpiderTimeline :: IO (Some SpiderTimelineEnv)
2460−newSpiderTimeline = withSpiderTimeline (pure . Some.This)
2730+newSpiderTimeline = withSpiderTimeline (pure . Some)
24612731
2462−data LocalSpiderTimeline x s
2732+data LocalSpiderTimeline (x :: Type) s
24632733
24642734instance Reifies s (SpiderTimelineEnv x) =>
24652735 HasSpiderTimeline (LocalSpiderTimeline x s) where
2466− spiderTimeline = localSpiderTimeline (Proxy :: Proxy s) $ reflect (Proxy :: Proxy s)
2736+ spiderTimeline = localSpiderTimeline Proxy $ reflect (Proxy :: Proxy s)
24672737
24682738localSpiderTimeline
2469− :: Proxy s
2739+ :: proxy s
24702740 -> SpiderTimelineEnv x
24712741 -> SpiderTimelineEnv (LocalSpiderTimeline x s)
2472−localSpiderTimeline _ = unsafeCoerce
2742+localSpiderTimeline _ = coerce
24732743
24742744-- | Pass a new timeline to the given function.
24752745withSpiderTimeline :: (forall x. HasSpiderTimeline x => SpiderTimelineEnv x -> IO r) -> IO r
@@ -2477,18 +2747,18 @@ withSpiderTimeline k = do
24772747 env <- unsafeNewSpiderTimelineEnv
24782748 reify env $ \s -> k $ localSpiderTimeline s env
24792749
2480−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)
24812751
24822752type ComputeM = EventM
24832753
2484−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)
24852755
24862756instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
24872757 {-# SPECIALIZE instance R.Reflex (SpiderTimeline Global) #-}
24882758 newtype Behavior (SpiderTimeline x) a = SpiderBehavior { unSpiderBehavior :: Behavior x a }
24892759 newtype Event (SpiderTimeline x) a = SpiderEvent { unSpiderEvent :: Event x a }
2490− newtype Dynamic (SpiderTimeline x) a = SpiderDynamic { unSpiderDynamic :: Dynamic x (Identity a) } -- deriving (Functor, Applicative, Monad)
2491− 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 }
24922762 type PullM (SpiderTimeline x) = SpiderPullM x
24932763 type PushM (SpiderTimeline x) = SpiderPushM x
24942764 {-# INLINABLE never #-}
@@ -2501,10 +2771,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
25012771 pushCheap f = SpiderEvent . pushCheap (coerce f) . unSpiderEvent
25022772 {-# INLINABLE pull #-}
25032773 pull = SpiderBehavior . pull . coerce
2504− {-# INLINABLE merge #-}
2505− merge = SpiderEvent . merge . dynamicConst . (coerce :: DMap k (R.Event (SpiderTimeline x)) -> DMap k (Event x))
2506− {-# INLINABLE fan #-}
2507− 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
25082783 {-# INLINABLE switch #-}
25092784 switch = SpiderEvent . switch . (coerce :: Behavior x (R.Event (SpiderTimeline x) a) -> Behavior x (Event x a)) . unSpiderBehavior
25102785 {-# INLINABLE coincidence #-}
@@ -2512,15 +2787,15 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
25122787 {-# INLINABLE current #-}
25132788 current = SpiderBehavior . dynamicCurrent . unSpiderDynamic
25142789 {-# INLINABLE updated #-}
2515− updated = coerce $ SpiderEvent . dynamicUpdated . unSpiderDynamic
2790+ updated = SpiderEvent #. dynamicUpdated .# fmap coerce . unSpiderDynamic
25162791 {-# INLINABLE unsafeBuildDynamic #-}
25172792 unsafeBuildDynamic readV0 v' = SpiderDynamic $ dynamicDynIdentity $ unsafeBuildDynamic (coerce readV0) $ coerce $ unSpiderEvent v'
25182793 {-# INLINABLE unsafeBuildIncremental #-}
25192794 unsafeBuildIncremental readV0 dv = SpiderIncremental $ dynamicDyn $ unsafeBuildDynamic (coerce readV0) $ unSpiderEvent dv
2520− {-# INLINABLE mergeIncremental #-}
2521− mergeIncremental = SpiderEvent . merge . (unsafeCoerce :: Dynamic x (PatchDMap k (R.Event (SpiderTimeline x))) -> Dynamic x (PatchDMap k (Event x))) . unSpiderIncremental
2522− {-# INLINABLE mergeIncrementalWithMove #-}
2523− 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
25242799 {-# INLINABLE currentIncremental #-}
25252800 currentIncremental = SpiderBehavior . dynamicCurrent . unSpiderIncremental
25262801 {-# INLINABLE updatedIncremental #-}
@@ -2531,9 +2806,10 @@ instance HasSpiderTimeline x => R.Reflex (SpiderTimeline x) where
25312806 return $ Identity <$> apply p c --TODO: Avoid the redundant 'apply'
25322807 eventCoercion Coercion = Coercion
25332808 behaviorCoercion Coercion = Coercion
2534− 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
25352811 {-# INLINABLE mergeIntIncremental #-}
2536− mergeIntIncremental = SpiderEvent . mergeInt . (unsafeCoerce :: Dynamic x (PatchIntMap (R.Event (SpiderTimeline x) a)) -> Dynamic x (PatchIntMap (Event x a))) . unSpiderIncremental
2812+ mergeIntIncremental = SpiderEvent . mergeInt . coerce
25372813 {-# INLINABLE fanInt #-}
25382814 fanInt e = R.EventSelectorInt $ SpiderEvent . selectInt (fanInt (unSpiderEvent e))
25392815
@@ -2558,7 +2834,7 @@ instance MonadAtomicRef (EventM x) where
25582834 atomicModifyRef r f = liftIO $ atomicModifyRef r f
25592835
25602836-- | The monad for actions that manipulate a Spider timeline identified by @x@
2561−newtype SpiderHost x a = SpiderHost { unSpiderHost :: 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)
25622838
25632839instance Monad (SpiderHost x) where
25642840 {-# INLINABLE (>>=) #-}
@@ -2567,8 +2843,14 @@ instance Monad (SpiderHost x) where
25672843 SpiderHost x >> SpiderHost y = SpiderHost $ x >> y
25682844 {-# INLINABLE return #-}
25692845 return x = SpiderHost $ return x
2846+#if !MIN_VERSION_base(4,13,0)
25702847 {-# INLINABLE fail #-}
2571− 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
25722854
25732855-- | Run an action affecting the global Spider timeline; this will be guarded by
25742856-- a mutex for that timeline
@@ -2580,7 +2862,7 @@ runSpiderHost (SpiderHost a) = a
25802862runSpiderHostForTimeline :: SpiderHost x a -> SpiderTimelineEnv x -> IO a
25812863runSpiderHostForTimeline (SpiderHost a) _ = a
25822864
2583−newtype SpiderHostFrame x a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
2865+newtype SpiderHostFrame (x :: Type) a = SpiderHostFrame { runSpiderHostFrame :: EventM x a }
25842866 deriving (Functor, Applicative, MonadFix, MonadIO, MonadException, MonadAsyncException)
25852867
25862868instance Monad (SpiderHostFrame x) where
@@ -2590,19 +2872,21 @@ instance Monad (SpiderHostFrame x) where
25902872 SpiderHostFrame x >> SpiderHostFrame y = SpiderHostFrame $ x >> y
25912873 {-# INLINABLE return #-}
25922874 return x = SpiderHostFrame $ return x
2875+#if !MIN_VERSION_base(4,13,0)
25932876 {-# INLINABLE fail #-}
25942877 fail s = SpiderHostFrame $ fail s
2878+#endif
25952879
25962880instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
25972881 notReadyUntil _ = pure ()
25982882 notReady = pure ()
25992883
2600−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)
26012885newEventWithTriggerIO f = do
26022886 es <- newFanEventWithTriggerIO $ \Refl -> f
26032887 return $ select es Refl
26042888
2605−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)
26062890newFanEventWithTriggerIO f = do
26072891 occRef <- newIORef DMap.empty
26082892 subscribedRef <- newIORef DMap.empty
@@ -2636,3 +2920,11 @@ instance MonadAtomicRef (SpiderHostFrame x) where
26362920instance PrimMonad (SpiderHostFrame x) where
26372921 type PrimState (SpiderHostFrame x) = PrimState IO
26382922 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+24−14
@@ -11,6 +11,11 @@
1111#ifdef USE_TEMPLATE_HASKELL
1212{-# LANGUAGE TemplateHaskell #-}
1313#endif
14+-- |
15+-- Module:
16+-- Reflex.Time
17+-- Description:
18+-- Clocks, timers, and other time-related functions.
1419module Reflex.Time where
1520
1621import Reflex.Class
@@ -28,7 +33,7 @@ import Control.Monad.IO.Class
2833import Data.Align
2934import Data.Data (Data)
3035import Data.Fixed
31−import Data.Semigroup
36+import Data.Semigroup (Semigroup(..))
3237import Data.Sequence (Seq, (|>))
3338import qualified Data.Sequence as Seq
3439import Data.These
@@ -37,38 +42,39 @@ import Data.Typeable
3742import GHC.Generics (Generic)
3843import System.Random
3944
45+-- | Metadata associated with a timer "tick"
4046data TickInfo
4147 = TickInfo { _tickInfo_lastUTC :: UTCTime
4248 -- ^ UTC time immediately after the last tick.
4349 , _tickInfo_n :: Integer
44− -- ^ Number of time periods since t0
50+ -- ^ Number of time periods or ticks since the start of the timer
4551 , _tickInfo_alreadyElapsed :: NominalDiffTime
46− -- ^ Amount of time already elapsed in the current tick period.
52+ -- ^ Amount of time that has elapsed in the current tick period.
4753 }
4854 deriving (Eq, Ord, Show, Typeable)
4955
50−-- | Special case of 'tickLossyFrom' that uses the post-build event to start the
51−-- 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.
5259tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
5360tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
5461
55−-- | Special case of 'tickLossyFrom' that uses the post-build event to start the
56−-- 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.
5764tickLossyFromPostBuildTime :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> m (Event t TickInfo)
5865tickLossyFromPostBuildTime dt = do
5966 postBuild <- getPostBuild
6067 postBuildTime <- performEvent $ liftIO getCurrentTime <$ postBuild
6168 tickLossyFrom' $ (dt,) <$> postBuildTime
6269
63−-- | Send events over time with the given basis time and interval
64−-- If the system starts running behind, occurrences will be dropped rather than buffered
65−-- 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.
6672tickLossyFrom
6773 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
6874 => NominalDiffTime
6975 -- ^ The length of a tick interval
7076 -> UTCTime
71− -- ^ 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.
7278 -> Event t a
7379 -- ^ Event that starts a tick generation thread. Usually you want this to
7480 -- be something like the result of getPostBuild that only fires once. But
@@ -76,12 +82,12 @@ tickLossyFrom
7682 -> m (Event t TickInfo)
7783tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
7884
79−-- | 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'.
8086tickLossyFrom'
8187 :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
8288 => Event t (NominalDiffTime, UTCTime)
8389 -- ^ Event that starts a tick generation thread. Usually you want this to
84− -- 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
8591 -- there could be uses for starting multiple timer threads.
8692 -> m (Event t TickInfo)
8793tickLossyFrom' e = do
@@ -92,12 +98,16 @@ tickLossyFrom' e = do
9298 Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
9399 cb (tick, pair)
94100
101+-- | Like 'tickLossy', but immediately calculates the first tick and provides a 'Dynamic' that is updated as ticks fire.
95102clockLossy :: (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)
96103clockLossy dt t0 = do
97104 initial <- liftIO $ getCurrentTick dt t0
98105 e <- tickLossy dt t0
99106 holdDyn initial e
100107
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.
101111getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
102112getCurrentTick dt t0 = do
103113 t <- getCurrentTime
@@ -278,7 +288,7 @@ data ThrottleState b
278288
279289data ThrottleBuffer b
280290 = ThrottleBuffer_Empty -- Empty conflicts with lens, and hiding it would require turning
281− -- on PatternSynonyms
291+ -- on PatternSynonyms
282292 | ThrottleBuffer_Full b
283293 deriving (Eq, Ord, Show, Functor, Foldable, Traversable, Generic, Data, Typeable)
284294
src/Reflex/TriggerEvent/Base.hs+2
@@ -122,6 +122,8 @@ instance MonadHold t m => MonadHold t (TriggerEventT t m) where
122122 buildDynamic a0 = lift . buildDynamic a0
123123 {-# INLINABLE headE #-}
124124 headE = lift . headE
125+ {-# INLINABLE now #-}
126+ now = lift now
125127
126128instance Adjustable t m => Adjustable t (TriggerEventT t m) where
127129 {-# 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+1−1
@@ -13,7 +13,7 @@ import Data.Map (Map)
1313
1414import Reflex.Class
1515import Reflex.Adjustable.Class
16−import Reflex.Patch.MapWithMove
16+import Data.Patch.MapWithMove
1717
1818
1919-- | Build sortable content in such a way that re-sorting it can cause minimal
src/Reflex/Workflow.hs+13−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
@@ -18,21 +24,27 @@ import Reflex.Network
1824import Reflex.NotReady.Class
1925import Reflex.PostBuild.Class
2026
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.
2129newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
2230
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).
2332workflow :: forall t m a. (Reflex t, Adjustable t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
2433workflow w0 = do
2534 rec eResult <- networkHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
2635 return $ fmap fst eResult
2736
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'.
2838workflowView :: 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)
2939workflowView w0 = do
3040 rec eResult <- networkView . fmap unWorkflow =<< holdDyn w0 eReplace
3141 eReplace <- fmap switch $ hold never $ fmap snd eResult
3242 return $ fmap fst eResult
3343
44+-- | Map a function over a 'Workflow', possibly changing the return type.
3445mapWorkflow :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
3546mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
3647
48+-- | Map a "cheap" function over a 'Workflow'. Refer to the documentation for 'pushCheap' for more information and performance considerations.
3749mapWorkflowCheap :: (Reflex t, Functor m) => (a -> b) -> Workflow t m a -> Workflow t m b
3850mapWorkflowCheap f (Workflow x) = Workflow (fmap (f *** fmapCheap (mapWorkflowCheap f)) x)
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+24−4
@@ -1,3 +1,5 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE BangPatterns #-}
13{-# LANGUAGE FlexibleContexts #-}
24{-# LANGUAGE GADTs #-}
35{-# LANGUAGE RecursiveDo #-}
@@ -12,6 +14,10 @@ import Data.Functor.Misc
1214import qualified Data.Map as M
1315import Data.These
1416
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+
1521import Reflex
1622import Reflex.EventWriter.Base
1723import Test.Run
@@ -36,6 +42,9 @@ main = do
3642 print os4
3743 os5@[[Nothing, Just [1, 2]]] <- runApp' (unwrapApp testLiveTellEventDMap) [Just ()]
3844 print os5
45+ os6 <- runApp' (unwrapApp delayedPulse) [Just ()]
46+ print os6
47+ let ![[Nothing, Nothing]] = os6
3948 return ()
4049
4150unwrapApp :: (Reflex t, Monad m) => (a -> EventWriterT t [Int] m ()) -> a -> m (Event t [Int])
@@ -44,16 +53,13 @@ unwrapApp x appIn = do
4453 return e
4554
4655testOrdering :: (Reflex t, Monad m) => Event t () -> EventWriterT t [Int] m ()
47−testOrdering pulse = do
48− forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
49− return ()
56+testOrdering pulse = forM_ [10,9..1] $ \i -> tellEvent ([i] <$ pulse)
5057
5158testSimultaneous :: (Reflex t, Adjustable t m, MonadHold t m) => Event t (These () ()) -> EventWriterT t [Int] m ()
5259testSimultaneous pulse = do
5360 let e0 = fmapMaybe (^? here) pulse
5461 e1 = fmapMaybe (^? there) pulse
5562 forM_ [1,3..9] $ \i -> runWithReplace (tellEvent ([i] <$ e0)) $ ffor e1 $ \_ -> tellEvent ([i+1] <$ e0)
56− return ()
5763
5864-- | Test that a widget telling and event which fires at the same time it has been replaced
5965-- doesn't count along with the new widget.
@@ -112,3 +118,17 @@ testLiveTellEventDMap pulse = do
112118 (mapToDMap $ M.singleton 1 ())
113119 ((PatchDMap $ DMap.map (ComposeMaybe . Just) $ mapToDMap $ M.singleton 2 ()) <$ pulse)
114120 return ()
121+
122+delayedPulse
123+ :: forall t m
124+ . ( Reflex t
125+ , Adjustable t m
126+ , MonadHold t m
127+ , MonadFix m
128+ )
129+ => Event t ()
130+ -> EventWriterT t [Int] m ()
131+delayedPulse pulse = void $ flip runWithReplace (pure () <$ pulse) $ do
132+ -- This has the effect of delaying pulse' from pulse
133+ (_, pulse') <- runWithReplace (pure ()) $ pure [1] <$ pulse
134+ tellEvent pulse'
test/GC.hs+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+5−1
@@ -19,8 +19,12 @@ import Data.Map.Monoidal (MonoidalMap)
1919import Data.Semigroup
2020import Data.These
2121
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+
2226import Reflex
23−import Reflex.Patch.MapWithMove
27+import Data.Patch.MapWithMove
2428import Test.Run
2529
2630newtype MyQuery = MyQuery SelectedCount
test/Reflex/Bench/Focused.hs+12
@@ -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
@@ -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+1
@@ -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
test/Reflex/Test/CrossImpl.hs+18−8
@@ -21,11 +21,12 @@ import Reflex.Dynamic
2121import Reflex.Host.Class
2222import qualified Reflex.Pure as P
2323import qualified Reflex.Spider.Internal as S
24+import qualified Reflex.Profiled as Prof
2425
2526import Control.Arrow (second, (&&&))
2627import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
2728import Control.Monad.State.Strict hiding (forM, forM_, mapM, mapM_, sequence, sequence_)
28−import Data.Dependent.Map (DSum (..))
29+import Data.Dependent.Sum (DSum (..))
2930import Data.Foldable
3031import Data.Map.Strict (Map)
3132import qualified Data.Map.Strict as Map
@@ -35,8 +36,6 @@ import Data.Traversable
3536import System.Exit
3637import System.Mem
3738
38−import System.IO.Unsafe
39−
4039mapToPureBehavior :: Map Int a -> Behavior PureReflexDomain a
4140mapToPureBehavior m = P.Behavior $ \t -> case Map.lookupLE t m of
4241 Nothing -> error $ "mapToPureBehavior: no value for time " <> show t
@@ -73,11 +72,14 @@ instance MapMSignals (Event t a) (Event t' a) t t' where
7372instance (MapMSignals a a' t t', MapMSignals b b' t t') => MapMSignals (a, b) (a', b') t t' where
7473 mapMSignals fb fe (a, b) = liftM2 (,) (mapMSignals fb fe a) (mapMSignals fb fe b)
7574
76−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)
77−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
7880 (re, reTrigger) <- newEventWithTriggerRef
7981 (rb, rbTrigger) <- newEventWithTriggerRef
80− 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
8183 (b', e') <- runHostFrame $ builder (b, re)
8284 e'Handle <- subscribeEvent e' --TODO: This should be unnecessary
8385 let times = relevantTestingTimes (bMap, eMap)
@@ -102,9 +104,11 @@ testAgreement :: (Eq c, Eq d, Show c, Show d) => (forall m t. TestCaseConstraint
102104testAgreement builder inputs = do
103105 let identityResult = testPure builder inputs
104106 tracePerf "---------" $ return ()
105− let spiderResult = testSpider builder inputs
107+ spiderResult <- S.runSpiderHost $ testTimeline builder inputs
108+ tracePerf "---------" $ return ()
109+ profiledResult <- S.runSpiderHost $ Prof.runProfiledM $ testTimeline builder inputs
106110 tracePerf "---------" $ return ()
107− let resultsAgree = identityResult == spiderResult
111+ let resultsAgree = identityResult == spiderResult && identityResult == profiledResult
108112 if resultsAgree
109113 then do --putStrLn "Success:"
110114 --print identityResult
@@ -112,6 +116,7 @@ testAgreement builder inputs = do
112116 else do putStrLn "Failure:"
113117 putStrLn $ "Pure result: " <> show identityResult
114118 putStrLn $ "Spider result: " <> show spiderResult
119+ putStrLn $ "Profiled result: " <> show profiledResult
115120 return resultsAgree
116121
117122type TestCaseConstraint t m = (Reflex t, MonadSample t m, MonadHold t m, MonadFix m, MonadFix (PushM t))
@@ -218,6 +223,11 @@ testCases =
218223 bb <- hold b $ pushAlways (const $ hold "asdf" eo) eo
219224 let b' = pull $ sample =<< sample bb
220225 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)
221231 , (,) "joinDyn" $ TestCase (Map.singleton 0 (0 :: Int), Map.fromList [(1, "qwer"), (2, "lkj")]) $ \(b, e) -> do
222232 bb <- hold "b" e
223233 bd <- hold never . fmap (const e) =<< headE e
test/Reflex/Test/Micro.hs+8−2
@@ -322,8 +322,14 @@ testCases =
322322 let e = never <$ switch b
323323 return $ void e
324324 lazyHold
325−
326−
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
327333 ] where
328334
329335 events1, events2, events3 :: TestPlan t m => m (Event t String)
test/RequesterT.hs+179−11
@@ -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
@@ -65,3 +111,125 @@ testSimultaneous pulse = do
65111 switchE = fmapMaybe (^? there) pulse
66112 forM_ [1,3..9] $ \i -> runWithReplace (requestingIdentity (RequestInt i <$ tellE)) $ ffor switchE $ \_ ->
67113 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/hlint.hs+3−8
@@ -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
@@ -22,6 +22,8 @@ main = do
2222 , "--ignore=Use unless"
2323 , "--ignore=Reduce duplication"
2424 , "--cpp-define=USE_TEMPLATE_HASKELL"
25+ , "--cpp-define=DEBUG"
26+ , "--ignore=Use tuple-section"
2527 ]
2628 recurseInto = and <$> sequence
2729 [ fileType ==? Directory
@@ -29,16 +31,9 @@ main = do
2931 ]
3032 matchFile = and <$> sequence
3133 [ extension ==? ".hs"
32− , let notElem' = liftOp notElem
33− in filePath `notElem'` filePathExceptions pwd
3434 ]
3535 files <- find recurseInto matchFile (pwd </> "src") --TODO: Someday fix all hints in tests, etc.
3636 ideas <- fmap concat $ forM files $ \f -> do
3737 putStr $ "linting file " ++ drop (length pwd + 1) f ++ "... "
3838 runHlint f
3939 if null ideas then exitSuccess else exitFailure
40−
41−filePathExceptions :: FilePath -> [FilePath]
42−filePathExceptions pwd = map (pwd </>) $
43− [ "src/Data/AppendMap.hs" -- parse error when hlint runs
44− ]